babylon.module.d.ts 6.6 MB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149101501015110152101531015410155101561015710158101591016010161101621016310164101651016610167101681016910170101711017210173101741017510176101771017810179101801018110182101831018410185101861018710188101891019010191101921019310194101951019610197101981019910200102011020210203102041020510206102071020810209102101021110212102131021410215102161021710218102191022010221102221022310224102251022610227102281022910230102311023210233102341023510236102371023810239102401024110242102431024410245102461024710248102491025010251102521025310254102551025610257102581025910260102611026210263102641026510266102671026810269102701027110272102731027410275102761027710278102791028010281102821028310284102851028610287102881028910290102911029210293102941029510296102971029810299103001030110302103031030410305103061030710308103091031010311103121031310314103151031610317103181031910320103211032210323103241032510326103271032810329103301033110332103331033410335103361033710338103391034010341103421034310344103451034610347103481034910350103511035210353103541035510356103571035810359103601036110362103631036410365103661036710368103691037010371103721037310374103751037610377103781037910380103811038210383103841038510386103871038810389103901039110392103931039410395103961039710398103991040010401104021040310404104051040610407104081040910410104111041210413104141041510416104171041810419104201042110422104231042410425104261042710428104291043010431104321043310434104351043610437104381043910440104411044210443104441044510446104471044810449104501045110452104531045410455104561045710458104591046010461104621046310464104651046610467104681046910470104711047210473104741047510476104771047810479104801048110482104831048410485104861048710488104891049010491104921049310494104951049610497104981049910500105011050210503105041050510506105071050810509105101051110512105131051410515105161051710518105191052010521105221052310524105251052610527105281052910530105311053210533105341053510536105371053810539105401054110542105431054410545105461054710548105491055010551105521055310554105551055610557105581055910560105611056210563105641056510566105671056810569105701057110572105731057410575105761057710578105791058010581105821058310584105851058610587105881058910590105911059210593105941059510596105971059810599106001060110602106031060410605106061060710608106091061010611106121061310614106151061610617106181061910620106211062210623106241062510626106271062810629106301063110632106331063410635106361063710638106391064010641106421064310644106451064610647106481064910650106511065210653106541065510656106571065810659106601066110662106631066410665106661066710668106691067010671106721067310674106751067610677106781067910680106811068210683106841068510686106871068810689106901069110692106931069410695106961069710698106991070010701107021070310704107051070610707107081070910710107111071210713107141071510716107171071810719107201072110722107231072410725107261072710728107291073010731107321073310734107351073610737107381073910740107411074210743107441074510746107471074810749107501075110752107531075410755107561075710758107591076010761107621076310764107651076610767107681076910770107711077210773107741077510776107771077810779107801078110782107831078410785107861078710788107891079010791107921079310794107951079610797107981079910800108011080210803108041080510806108071080810809108101081110812108131081410815108161081710818108191082010821108221082310824108251082610827108281082910830108311083210833108341083510836108371083810839108401084110842108431084410845108461084710848108491085010851108521085310854108551085610857108581085910860108611086210863108641086510866108671086810869108701087110872108731087410875108761087710878108791088010881108821088310884108851088610887108881088910890108911089210893108941089510896108971089810899109001090110902109031090410905109061090710908109091091010911109121091310914109151091610917109181091910920109211092210923109241092510926109271092810929109301093110932109331093410935109361093710938109391094010941109421094310944109451094610947109481094910950109511095210953109541095510956109571095810959109601096110962109631096410965109661096710968109691097010971109721097310974109751097610977109781097910980109811098210983109841098510986109871098810989109901099110992109931099410995109961099710998109991100011001110021100311004110051100611007110081100911010110111101211013110141101511016110171101811019110201102111022110231102411025110261102711028110291103011031110321103311034110351103611037110381103911040110411104211043110441104511046110471104811049110501105111052110531105411055110561105711058110591106011061110621106311064110651106611067110681106911070110711107211073110741107511076110771107811079110801108111082110831108411085110861108711088110891109011091110921109311094110951109611097110981109911100111011110211103111041110511106111071110811109111101111111112111131111411115111161111711118111191112011121111221112311124111251112611127111281112911130111311113211133111341113511136111371113811139111401114111142111431114411145111461114711148111491115011151111521115311154111551115611157111581115911160111611116211163111641116511166111671116811169111701117111172111731117411175111761117711178111791118011181111821118311184111851118611187111881118911190111911119211193111941119511196111971119811199112001120111202112031120411205112061120711208112091121011211112121121311214112151121611217112181121911220112211122211223112241122511226112271122811229112301123111232112331123411235112361123711238112391124011241112421124311244112451124611247112481124911250112511125211253112541125511256112571125811259112601126111262112631126411265112661126711268112691127011271112721127311274112751127611277112781127911280112811128211283112841128511286112871128811289112901129111292112931129411295112961129711298112991130011301113021130311304113051130611307113081130911310113111131211313113141131511316113171131811319113201132111322113231132411325113261132711328113291133011331113321133311334113351133611337113381133911340113411134211343113441134511346113471134811349113501135111352113531135411355113561135711358113591136011361113621136311364113651136611367113681136911370113711137211373113741137511376113771137811379113801138111382113831138411385113861138711388113891139011391113921139311394113951139611397113981139911400114011140211403114041140511406114071140811409114101141111412114131141411415114161141711418114191142011421114221142311424114251142611427114281142911430114311143211433114341143511436114371143811439114401144111442114431144411445114461144711448114491145011451114521145311454114551145611457114581145911460114611146211463114641146511466114671146811469114701147111472114731147411475114761147711478114791148011481114821148311484114851148611487114881148911490114911149211493114941149511496114971149811499115001150111502115031150411505115061150711508115091151011511115121151311514115151151611517115181151911520115211152211523115241152511526115271152811529115301153111532115331153411535115361153711538115391154011541115421154311544115451154611547115481154911550115511155211553115541155511556115571155811559115601156111562115631156411565115661156711568115691157011571115721157311574115751157611577115781157911580115811158211583115841158511586115871158811589115901159111592115931159411595115961159711598115991160011601116021160311604116051160611607116081160911610116111161211613116141161511616116171161811619116201162111622116231162411625116261162711628116291163011631116321163311634116351163611637116381163911640116411164211643116441164511646116471164811649116501165111652116531165411655116561165711658116591166011661116621166311664116651166611667116681166911670116711167211673116741167511676116771167811679116801168111682116831168411685116861168711688116891169011691116921169311694116951169611697116981169911700117011170211703117041170511706117071170811709117101171111712117131171411715117161171711718117191172011721117221172311724117251172611727117281172911730117311173211733117341173511736117371173811739117401174111742117431174411745117461174711748117491175011751117521175311754117551175611757117581175911760117611176211763117641176511766117671176811769117701177111772117731177411775117761177711778117791178011781117821178311784117851178611787117881178911790117911179211793117941179511796117971179811799118001180111802118031180411805118061180711808118091181011811118121181311814118151181611817118181181911820118211182211823118241182511826118271182811829118301183111832118331183411835118361183711838118391184011841118421184311844118451184611847118481184911850118511185211853118541185511856118571185811859118601186111862118631186411865118661186711868118691187011871118721187311874118751187611877118781187911880118811188211883118841188511886118871188811889118901189111892118931189411895118961189711898118991190011901119021190311904119051190611907119081190911910119111191211913119141191511916119171191811919119201192111922119231192411925119261192711928119291193011931119321193311934119351193611937119381193911940119411194211943119441194511946119471194811949119501195111952119531195411955119561195711958119591196011961119621196311964119651196611967119681196911970119711197211973119741197511976119771197811979119801198111982119831198411985119861198711988119891199011991119921199311994119951199611997119981199912000120011200212003120041200512006120071200812009120101201112012120131201412015120161201712018120191202012021120221202312024120251202612027120281202912030120311203212033120341203512036120371203812039120401204112042120431204412045120461204712048120491205012051120521205312054120551205612057120581205912060120611206212063120641206512066120671206812069120701207112072120731207412075120761207712078120791208012081120821208312084120851208612087120881208912090120911209212093120941209512096120971209812099121001210112102121031210412105121061210712108121091211012111121121211312114121151211612117121181211912120121211212212123121241212512126121271212812129121301213112132121331213412135121361213712138121391214012141121421214312144121451214612147121481214912150121511215212153121541215512156121571215812159121601216112162121631216412165121661216712168121691217012171121721217312174121751217612177121781217912180121811218212183121841218512186121871218812189121901219112192121931219412195121961219712198121991220012201122021220312204122051220612207122081220912210122111221212213122141221512216122171221812219122201222112222122231222412225122261222712228122291223012231122321223312234122351223612237122381223912240122411224212243122441224512246122471224812249122501225112252122531225412255122561225712258122591226012261122621226312264122651226612267122681226912270122711227212273122741227512276122771227812279122801228112282122831228412285122861228712288122891229012291122921229312294122951229612297122981229912300123011230212303123041230512306123071230812309123101231112312123131231412315123161231712318123191232012321123221232312324123251232612327123281232912330123311233212333123341233512336123371233812339123401234112342123431234412345123461234712348123491235012351123521235312354123551235612357123581235912360123611236212363123641236512366123671236812369123701237112372123731237412375123761237712378123791238012381123821238312384123851238612387123881238912390123911239212393123941239512396123971239812399124001240112402124031240412405124061240712408124091241012411124121241312414124151241612417124181241912420124211242212423124241242512426124271242812429124301243112432124331243412435124361243712438124391244012441124421244312444124451244612447124481244912450124511245212453124541245512456124571245812459124601246112462124631246412465124661246712468124691247012471124721247312474124751247612477124781247912480124811248212483124841248512486124871248812489124901249112492124931249412495124961249712498124991250012501125021250312504125051250612507125081250912510125111251212513125141251512516125171251812519125201252112522125231252412525125261252712528125291253012531125321253312534125351253612537125381253912540125411254212543125441254512546125471254812549125501255112552125531255412555125561255712558125591256012561125621256312564125651256612567125681256912570125711257212573125741257512576125771257812579125801258112582125831258412585125861258712588125891259012591125921259312594125951259612597125981259912600126011260212603126041260512606126071260812609126101261112612126131261412615126161261712618126191262012621126221262312624126251262612627126281262912630126311263212633126341263512636126371263812639126401264112642126431264412645126461264712648126491265012651126521265312654126551265612657126581265912660126611266212663126641266512666126671266812669126701267112672126731267412675126761267712678126791268012681126821268312684126851268612687126881268912690126911269212693126941269512696126971269812699127001270112702127031270412705127061270712708127091271012711127121271312714127151271612717127181271912720127211272212723127241272512726127271272812729127301273112732127331273412735127361273712738127391274012741127421274312744127451274612747127481274912750127511275212753127541275512756127571275812759127601276112762127631276412765127661276712768127691277012771127721277312774127751277612777127781277912780127811278212783127841278512786127871278812789127901279112792127931279412795127961279712798127991280012801128021280312804128051280612807128081280912810128111281212813128141281512816128171281812819128201282112822128231282412825128261282712828128291283012831128321283312834128351283612837128381283912840128411284212843128441284512846128471284812849128501285112852128531285412855128561285712858128591286012861128621286312864128651286612867128681286912870128711287212873128741287512876128771287812879128801288112882128831288412885128861288712888128891289012891128921289312894128951289612897128981289912900129011290212903129041290512906129071290812909129101291112912129131291412915129161291712918129191292012921129221292312924129251292612927129281292912930129311293212933129341293512936129371293812939129401294112942129431294412945129461294712948129491295012951129521295312954129551295612957129581295912960129611296212963129641296512966129671296812969129701297112972129731297412975129761297712978129791298012981129821298312984129851298612987129881298912990129911299212993129941299512996129971299812999130001300113002130031300413005130061300713008130091301013011130121301313014130151301613017130181301913020130211302213023130241302513026130271302813029130301303113032130331303413035130361303713038130391304013041130421304313044130451304613047130481304913050130511305213053130541305513056130571305813059130601306113062130631306413065130661306713068130691307013071130721307313074130751307613077130781307913080130811308213083130841308513086130871308813089130901309113092130931309413095130961309713098130991310013101131021310313104131051310613107131081310913110131111311213113131141311513116131171311813119131201312113122131231312413125131261312713128131291313013131131321313313134131351313613137131381313913140131411314213143131441314513146131471314813149131501315113152131531315413155131561315713158131591316013161131621316313164131651316613167131681316913170131711317213173131741317513176131771317813179131801318113182131831318413185131861318713188131891319013191131921319313194131951319613197131981319913200132011320213203132041320513206132071320813209132101321113212132131321413215132161321713218132191322013221132221322313224132251322613227132281322913230132311323213233132341323513236132371323813239132401324113242132431324413245132461324713248132491325013251132521325313254132551325613257132581325913260132611326213263132641326513266132671326813269132701327113272132731327413275132761327713278132791328013281132821328313284132851328613287132881328913290132911329213293132941329513296132971329813299133001330113302133031330413305133061330713308133091331013311133121331313314133151331613317133181331913320133211332213323133241332513326133271332813329133301333113332133331333413335133361333713338133391334013341133421334313344133451334613347133481334913350133511335213353133541335513356133571335813359133601336113362133631336413365133661336713368133691337013371133721337313374133751337613377133781337913380133811338213383133841338513386133871338813389133901339113392133931339413395133961339713398133991340013401134021340313404134051340613407134081340913410134111341213413134141341513416134171341813419134201342113422134231342413425134261342713428134291343013431134321343313434134351343613437134381343913440134411344213443134441344513446134471344813449134501345113452134531345413455134561345713458134591346013461134621346313464134651346613467134681346913470134711347213473134741347513476134771347813479134801348113482134831348413485134861348713488134891349013491134921349313494134951349613497134981349913500135011350213503135041350513506135071350813509135101351113512135131351413515135161351713518135191352013521135221352313524135251352613527135281352913530135311353213533135341353513536135371353813539135401354113542135431354413545135461354713548135491355013551135521355313554135551355613557135581355913560135611356213563135641356513566135671356813569135701357113572135731357413575135761357713578135791358013581135821358313584135851358613587135881358913590135911359213593135941359513596135971359813599136001360113602136031360413605136061360713608136091361013611136121361313614136151361613617136181361913620136211362213623136241362513626136271362813629136301363113632136331363413635136361363713638136391364013641136421364313644136451364613647136481364913650136511365213653136541365513656136571365813659136601366113662136631366413665136661366713668136691367013671136721367313674136751367613677136781367913680136811368213683136841368513686136871368813689136901369113692136931369413695136961369713698136991370013701137021370313704137051370613707137081370913710137111371213713137141371513716137171371813719137201372113722137231372413725137261372713728137291373013731137321373313734137351373613737137381373913740137411374213743137441374513746137471374813749137501375113752137531375413755137561375713758137591376013761137621376313764137651376613767137681376913770137711377213773137741377513776137771377813779137801378113782137831378413785137861378713788137891379013791137921379313794137951379613797137981379913800138011380213803138041380513806138071380813809138101381113812138131381413815138161381713818138191382013821138221382313824138251382613827138281382913830138311383213833138341383513836138371383813839138401384113842138431384413845138461384713848138491385013851138521385313854138551385613857138581385913860138611386213863138641386513866138671386813869138701387113872138731387413875138761387713878138791388013881138821388313884138851388613887138881388913890138911389213893138941389513896138971389813899139001390113902139031390413905139061390713908139091391013911139121391313914139151391613917139181391913920139211392213923139241392513926139271392813929139301393113932139331393413935139361393713938139391394013941139421394313944139451394613947139481394913950139511395213953139541395513956139571395813959139601396113962139631396413965139661396713968139691397013971139721397313974139751397613977139781397913980139811398213983139841398513986139871398813989139901399113992139931399413995139961399713998139991400014001140021400314004140051400614007140081400914010140111401214013140141401514016140171401814019140201402114022140231402414025140261402714028140291403014031140321403314034140351403614037140381403914040140411404214043140441404514046140471404814049140501405114052140531405414055140561405714058140591406014061140621406314064140651406614067140681406914070140711407214073140741407514076140771407814079140801408114082140831408414085140861408714088140891409014091140921409314094140951409614097140981409914100141011410214103141041410514106141071410814109141101411114112141131411414115141161411714118141191412014121141221412314124141251412614127141281412914130141311413214133141341413514136141371413814139141401414114142141431414414145141461414714148141491415014151141521415314154141551415614157141581415914160141611416214163141641416514166141671416814169141701417114172141731417414175141761417714178141791418014181141821418314184141851418614187141881418914190141911419214193141941419514196141971419814199142001420114202142031420414205142061420714208142091421014211142121421314214142151421614217142181421914220142211422214223142241422514226142271422814229142301423114232142331423414235142361423714238142391424014241142421424314244142451424614247142481424914250142511425214253142541425514256142571425814259142601426114262142631426414265142661426714268142691427014271142721427314274142751427614277142781427914280142811428214283142841428514286142871428814289142901429114292142931429414295142961429714298142991430014301143021430314304143051430614307143081430914310143111431214313143141431514316143171431814319143201432114322143231432414325143261432714328143291433014331143321433314334143351433614337143381433914340143411434214343143441434514346143471434814349143501435114352143531435414355143561435714358143591436014361143621436314364143651436614367143681436914370143711437214373143741437514376143771437814379143801438114382143831438414385143861438714388143891439014391143921439314394143951439614397143981439914400144011440214403144041440514406144071440814409144101441114412144131441414415144161441714418144191442014421144221442314424144251442614427144281442914430144311443214433144341443514436144371443814439144401444114442144431444414445144461444714448144491445014451144521445314454144551445614457144581445914460144611446214463144641446514466144671446814469144701447114472144731447414475144761447714478144791448014481144821448314484144851448614487144881448914490144911449214493144941449514496144971449814499145001450114502145031450414505145061450714508145091451014511145121451314514145151451614517145181451914520145211452214523145241452514526145271452814529145301453114532145331453414535145361453714538145391454014541145421454314544145451454614547145481454914550145511455214553145541455514556145571455814559145601456114562145631456414565145661456714568145691457014571145721457314574145751457614577145781457914580145811458214583145841458514586145871458814589145901459114592145931459414595145961459714598145991460014601146021460314604146051460614607146081460914610146111461214613146141461514616146171461814619146201462114622146231462414625146261462714628146291463014631146321463314634146351463614637146381463914640146411464214643146441464514646146471464814649146501465114652146531465414655146561465714658146591466014661146621466314664146651466614667146681466914670146711467214673146741467514676146771467814679146801468114682146831468414685146861468714688146891469014691146921469314694146951469614697146981469914700147011470214703147041470514706147071470814709147101471114712147131471414715147161471714718147191472014721147221472314724147251472614727147281472914730147311473214733147341473514736147371473814739147401474114742147431474414745147461474714748147491475014751147521475314754147551475614757147581475914760147611476214763147641476514766147671476814769147701477114772147731477414775147761477714778147791478014781147821478314784147851478614787147881478914790147911479214793147941479514796147971479814799148001480114802148031480414805148061480714808148091481014811148121481314814148151481614817148181481914820148211482214823148241482514826148271482814829148301483114832148331483414835148361483714838148391484014841148421484314844148451484614847148481484914850148511485214853148541485514856148571485814859148601486114862148631486414865148661486714868148691487014871148721487314874148751487614877148781487914880148811488214883148841488514886148871488814889148901489114892148931489414895148961489714898148991490014901149021490314904149051490614907149081490914910149111491214913149141491514916149171491814919149201492114922149231492414925149261492714928149291493014931149321493314934149351493614937149381493914940149411494214943149441494514946149471494814949149501495114952149531495414955149561495714958149591496014961149621496314964149651496614967149681496914970149711497214973149741497514976149771497814979149801498114982149831498414985149861498714988149891499014991149921499314994149951499614997149981499915000150011500215003150041500515006150071500815009150101501115012150131501415015150161501715018150191502015021150221502315024150251502615027150281502915030150311503215033150341503515036150371503815039150401504115042150431504415045150461504715048150491505015051150521505315054150551505615057150581505915060150611506215063150641506515066150671506815069150701507115072150731507415075150761507715078150791508015081150821508315084150851508615087150881508915090150911509215093150941509515096150971509815099151001510115102151031510415105151061510715108151091511015111151121511315114151151511615117151181511915120151211512215123151241512515126151271512815129151301513115132151331513415135151361513715138151391514015141151421514315144151451514615147151481514915150151511515215153151541515515156151571515815159151601516115162151631516415165151661516715168151691517015171151721517315174151751517615177151781517915180151811518215183151841518515186151871518815189151901519115192151931519415195151961519715198151991520015201152021520315204152051520615207152081520915210152111521215213152141521515216152171521815219152201522115222152231522415225152261522715228152291523015231152321523315234152351523615237152381523915240152411524215243152441524515246152471524815249152501525115252152531525415255152561525715258152591526015261152621526315264152651526615267152681526915270152711527215273152741527515276152771527815279152801528115282152831528415285152861528715288152891529015291152921529315294152951529615297152981529915300153011530215303153041530515306153071530815309153101531115312153131531415315153161531715318153191532015321153221532315324153251532615327153281532915330153311533215333153341533515336153371533815339153401534115342153431534415345153461534715348153491535015351153521535315354153551535615357153581535915360153611536215363153641536515366153671536815369153701537115372153731537415375153761537715378153791538015381153821538315384153851538615387153881538915390153911539215393153941539515396153971539815399154001540115402154031540415405154061540715408154091541015411154121541315414154151541615417154181541915420154211542215423154241542515426154271542815429154301543115432154331543415435154361543715438154391544015441154421544315444154451544615447154481544915450154511545215453154541545515456154571545815459154601546115462154631546415465154661546715468154691547015471154721547315474154751547615477154781547915480154811548215483154841548515486154871548815489154901549115492154931549415495154961549715498154991550015501155021550315504155051550615507155081550915510155111551215513155141551515516155171551815519155201552115522155231552415525155261552715528155291553015531155321553315534155351553615537155381553915540155411554215543155441554515546155471554815549155501555115552155531555415555155561555715558155591556015561155621556315564155651556615567155681556915570155711557215573155741557515576155771557815579155801558115582155831558415585155861558715588155891559015591155921559315594155951559615597155981559915600156011560215603156041560515606156071560815609156101561115612156131561415615156161561715618156191562015621156221562315624156251562615627156281562915630156311563215633156341563515636156371563815639156401564115642156431564415645156461564715648156491565015651156521565315654156551565615657156581565915660156611566215663156641566515666156671566815669156701567115672156731567415675156761567715678156791568015681156821568315684156851568615687156881568915690156911569215693156941569515696156971569815699157001570115702157031570415705157061570715708157091571015711157121571315714157151571615717157181571915720157211572215723157241572515726157271572815729157301573115732157331573415735157361573715738157391574015741157421574315744157451574615747157481574915750157511575215753157541575515756157571575815759157601576115762157631576415765157661576715768157691577015771157721577315774157751577615777157781577915780157811578215783157841578515786157871578815789157901579115792157931579415795157961579715798157991580015801158021580315804158051580615807158081580915810158111581215813158141581515816158171581815819158201582115822158231582415825158261582715828158291583015831158321583315834158351583615837158381583915840158411584215843158441584515846158471584815849158501585115852158531585415855158561585715858158591586015861158621586315864158651586615867158681586915870158711587215873158741587515876158771587815879158801588115882158831588415885158861588715888158891589015891158921589315894158951589615897158981589915900159011590215903159041590515906159071590815909159101591115912159131591415915159161591715918159191592015921159221592315924159251592615927159281592915930159311593215933159341593515936159371593815939159401594115942159431594415945159461594715948159491595015951159521595315954159551595615957159581595915960159611596215963159641596515966159671596815969159701597115972159731597415975159761597715978159791598015981159821598315984159851598615987159881598915990159911599215993159941599515996159971599815999160001600116002160031600416005160061600716008160091601016011160121601316014160151601616017160181601916020160211602216023160241602516026160271602816029160301603116032160331603416035160361603716038160391604016041160421604316044160451604616047160481604916050160511605216053160541605516056160571605816059160601606116062160631606416065160661606716068160691607016071160721607316074160751607616077160781607916080160811608216083160841608516086160871608816089160901609116092160931609416095160961609716098160991610016101161021610316104161051610616107161081610916110161111611216113161141611516116161171611816119161201612116122161231612416125161261612716128161291613016131161321613316134161351613616137161381613916140161411614216143161441614516146161471614816149161501615116152161531615416155161561615716158161591616016161161621616316164161651616616167161681616916170161711617216173161741617516176161771617816179161801618116182161831618416185161861618716188161891619016191161921619316194161951619616197161981619916200162011620216203162041620516206162071620816209162101621116212162131621416215162161621716218162191622016221162221622316224162251622616227162281622916230162311623216233162341623516236162371623816239162401624116242162431624416245162461624716248162491625016251162521625316254162551625616257162581625916260162611626216263162641626516266162671626816269162701627116272162731627416275162761627716278162791628016281162821628316284162851628616287162881628916290162911629216293162941629516296162971629816299163001630116302163031630416305163061630716308163091631016311163121631316314163151631616317163181631916320163211632216323163241632516326163271632816329163301633116332163331633416335163361633716338163391634016341163421634316344163451634616347163481634916350163511635216353163541635516356163571635816359163601636116362163631636416365163661636716368163691637016371163721637316374163751637616377163781637916380163811638216383163841638516386163871638816389163901639116392163931639416395163961639716398163991640016401164021640316404164051640616407164081640916410164111641216413164141641516416164171641816419164201642116422164231642416425164261642716428164291643016431164321643316434164351643616437164381643916440164411644216443164441644516446164471644816449164501645116452164531645416455164561645716458164591646016461164621646316464164651646616467164681646916470164711647216473164741647516476164771647816479164801648116482164831648416485164861648716488164891649016491164921649316494164951649616497164981649916500165011650216503165041650516506165071650816509165101651116512165131651416515165161651716518165191652016521165221652316524165251652616527165281652916530165311653216533165341653516536165371653816539165401654116542165431654416545165461654716548165491655016551165521655316554165551655616557165581655916560165611656216563165641656516566165671656816569165701657116572165731657416575165761657716578165791658016581165821658316584165851658616587165881658916590165911659216593165941659516596165971659816599166001660116602166031660416605166061660716608166091661016611166121661316614166151661616617166181661916620166211662216623166241662516626166271662816629166301663116632166331663416635166361663716638166391664016641166421664316644166451664616647166481664916650166511665216653166541665516656166571665816659166601666116662166631666416665166661666716668166691667016671166721667316674166751667616677166781667916680166811668216683166841668516686166871668816689166901669116692166931669416695166961669716698166991670016701167021670316704167051670616707167081670916710167111671216713167141671516716167171671816719167201672116722167231672416725167261672716728167291673016731167321673316734167351673616737167381673916740167411674216743167441674516746167471674816749167501675116752167531675416755167561675716758167591676016761167621676316764167651676616767167681676916770167711677216773167741677516776167771677816779167801678116782167831678416785167861678716788167891679016791167921679316794167951679616797167981679916800168011680216803168041680516806168071680816809168101681116812168131681416815168161681716818168191682016821168221682316824168251682616827168281682916830168311683216833168341683516836168371683816839168401684116842168431684416845168461684716848168491685016851168521685316854168551685616857168581685916860168611686216863168641686516866168671686816869168701687116872168731687416875168761687716878168791688016881168821688316884168851688616887168881688916890168911689216893168941689516896168971689816899169001690116902169031690416905169061690716908169091691016911169121691316914169151691616917169181691916920169211692216923169241692516926169271692816929169301693116932169331693416935169361693716938169391694016941169421694316944169451694616947169481694916950169511695216953169541695516956169571695816959169601696116962169631696416965169661696716968169691697016971169721697316974169751697616977169781697916980169811698216983169841698516986169871698816989169901699116992169931699416995169961699716998169991700017001170021700317004170051700617007170081700917010170111701217013170141701517016170171701817019170201702117022170231702417025170261702717028170291703017031170321703317034170351703617037170381703917040170411704217043170441704517046170471704817049170501705117052170531705417055170561705717058170591706017061170621706317064170651706617067170681706917070170711707217073170741707517076170771707817079170801708117082170831708417085170861708717088170891709017091170921709317094170951709617097170981709917100171011710217103171041710517106171071710817109171101711117112171131711417115171161711717118171191712017121171221712317124171251712617127171281712917130171311713217133171341713517136171371713817139171401714117142171431714417145171461714717148171491715017151171521715317154171551715617157171581715917160171611716217163171641716517166171671716817169171701717117172171731717417175171761717717178171791718017181171821718317184171851718617187171881718917190171911719217193171941719517196171971719817199172001720117202172031720417205172061720717208172091721017211172121721317214172151721617217172181721917220172211722217223172241722517226172271722817229172301723117232172331723417235172361723717238172391724017241172421724317244172451724617247172481724917250172511725217253172541725517256172571725817259172601726117262172631726417265172661726717268172691727017271172721727317274172751727617277172781727917280172811728217283172841728517286172871728817289172901729117292172931729417295172961729717298172991730017301173021730317304173051730617307173081730917310173111731217313173141731517316173171731817319173201732117322173231732417325173261732717328173291733017331173321733317334173351733617337173381733917340173411734217343173441734517346173471734817349173501735117352173531735417355173561735717358173591736017361173621736317364173651736617367173681736917370173711737217373173741737517376173771737817379173801738117382173831738417385173861738717388173891739017391173921739317394173951739617397173981739917400174011740217403174041740517406174071740817409174101741117412174131741417415174161741717418174191742017421174221742317424174251742617427174281742917430174311743217433174341743517436174371743817439174401744117442174431744417445174461744717448174491745017451174521745317454174551745617457174581745917460174611746217463174641746517466174671746817469174701747117472174731747417475174761747717478174791748017481174821748317484174851748617487174881748917490174911749217493174941749517496174971749817499175001750117502175031750417505175061750717508175091751017511175121751317514175151751617517175181751917520175211752217523175241752517526175271752817529175301753117532175331753417535175361753717538175391754017541175421754317544175451754617547175481754917550175511755217553175541755517556175571755817559175601756117562175631756417565175661756717568175691757017571175721757317574175751757617577175781757917580175811758217583175841758517586175871758817589175901759117592175931759417595175961759717598175991760017601176021760317604176051760617607176081760917610176111761217613176141761517616176171761817619176201762117622176231762417625176261762717628176291763017631176321763317634176351763617637176381763917640176411764217643176441764517646176471764817649176501765117652176531765417655176561765717658176591766017661176621766317664176651766617667176681766917670176711767217673176741767517676176771767817679176801768117682176831768417685176861768717688176891769017691176921769317694176951769617697176981769917700177011770217703177041770517706177071770817709177101771117712177131771417715177161771717718177191772017721177221772317724177251772617727177281772917730177311773217733177341773517736177371773817739177401774117742177431774417745177461774717748177491775017751177521775317754177551775617757177581775917760177611776217763177641776517766177671776817769177701777117772177731777417775177761777717778177791778017781177821778317784177851778617787177881778917790177911779217793177941779517796177971779817799178001780117802178031780417805178061780717808178091781017811178121781317814178151781617817178181781917820178211782217823178241782517826178271782817829178301783117832178331783417835178361783717838178391784017841178421784317844178451784617847178481784917850178511785217853178541785517856178571785817859178601786117862178631786417865178661786717868178691787017871178721787317874178751787617877178781787917880178811788217883178841788517886178871788817889178901789117892178931789417895178961789717898178991790017901179021790317904179051790617907179081790917910179111791217913179141791517916179171791817919179201792117922179231792417925179261792717928179291793017931179321793317934179351793617937179381793917940179411794217943179441794517946179471794817949179501795117952179531795417955179561795717958179591796017961179621796317964179651796617967179681796917970179711797217973179741797517976179771797817979179801798117982179831798417985179861798717988179891799017991179921799317994179951799617997179981799918000180011800218003180041800518006180071800818009180101801118012180131801418015180161801718018180191802018021180221802318024180251802618027180281802918030180311803218033180341803518036180371803818039180401804118042180431804418045180461804718048180491805018051180521805318054180551805618057180581805918060180611806218063180641806518066180671806818069180701807118072180731807418075180761807718078180791808018081180821808318084180851808618087180881808918090180911809218093180941809518096180971809818099181001810118102181031810418105181061810718108181091811018111181121811318114181151811618117181181811918120181211812218123181241812518126181271812818129181301813118132181331813418135181361813718138181391814018141181421814318144181451814618147181481814918150181511815218153181541815518156181571815818159181601816118162181631816418165181661816718168181691817018171181721817318174181751817618177181781817918180181811818218183181841818518186181871818818189181901819118192181931819418195181961819718198181991820018201182021820318204182051820618207182081820918210182111821218213182141821518216182171821818219182201822118222182231822418225182261822718228182291823018231182321823318234182351823618237182381823918240182411824218243182441824518246182471824818249182501825118252182531825418255182561825718258182591826018261182621826318264182651826618267182681826918270182711827218273182741827518276182771827818279182801828118282182831828418285182861828718288182891829018291182921829318294182951829618297182981829918300183011830218303183041830518306183071830818309183101831118312183131831418315183161831718318183191832018321183221832318324183251832618327183281832918330183311833218333183341833518336183371833818339183401834118342183431834418345183461834718348183491835018351183521835318354183551835618357183581835918360183611836218363183641836518366183671836818369183701837118372183731837418375183761837718378183791838018381183821838318384183851838618387183881838918390183911839218393183941839518396183971839818399184001840118402184031840418405184061840718408184091841018411184121841318414184151841618417184181841918420184211842218423184241842518426184271842818429184301843118432184331843418435184361843718438184391844018441184421844318444184451844618447184481844918450184511845218453184541845518456184571845818459184601846118462184631846418465184661846718468184691847018471184721847318474184751847618477184781847918480184811848218483184841848518486184871848818489184901849118492184931849418495184961849718498184991850018501185021850318504185051850618507185081850918510185111851218513185141851518516185171851818519185201852118522185231852418525185261852718528185291853018531185321853318534185351853618537185381853918540185411854218543185441854518546185471854818549185501855118552185531855418555185561855718558185591856018561185621856318564185651856618567185681856918570185711857218573185741857518576185771857818579185801858118582185831858418585185861858718588185891859018591185921859318594185951859618597185981859918600186011860218603186041860518606186071860818609186101861118612186131861418615186161861718618186191862018621186221862318624186251862618627186281862918630186311863218633186341863518636186371863818639186401864118642186431864418645186461864718648186491865018651186521865318654186551865618657186581865918660186611866218663186641866518666186671866818669186701867118672186731867418675186761867718678186791868018681186821868318684186851868618687186881868918690186911869218693186941869518696186971869818699187001870118702187031870418705187061870718708187091871018711187121871318714187151871618717187181871918720187211872218723187241872518726187271872818729187301873118732187331873418735187361873718738187391874018741187421874318744187451874618747187481874918750187511875218753187541875518756187571875818759187601876118762187631876418765187661876718768187691877018771187721877318774187751877618777187781877918780187811878218783187841878518786187871878818789187901879118792187931879418795187961879718798187991880018801188021880318804188051880618807188081880918810188111881218813188141881518816188171881818819188201882118822188231882418825188261882718828188291883018831188321883318834188351883618837188381883918840188411884218843188441884518846188471884818849188501885118852188531885418855188561885718858188591886018861188621886318864188651886618867188681886918870188711887218873188741887518876188771887818879188801888118882188831888418885188861888718888188891889018891188921889318894188951889618897188981889918900189011890218903189041890518906189071890818909189101891118912189131891418915189161891718918189191892018921189221892318924189251892618927189281892918930189311893218933189341893518936189371893818939189401894118942189431894418945189461894718948189491895018951189521895318954189551895618957189581895918960189611896218963189641896518966189671896818969189701897118972189731897418975189761897718978189791898018981189821898318984189851898618987189881898918990189911899218993189941899518996189971899818999190001900119002190031900419005190061900719008190091901019011190121901319014190151901619017190181901919020190211902219023190241902519026190271902819029190301903119032190331903419035190361903719038190391904019041190421904319044190451904619047190481904919050190511905219053190541905519056190571905819059190601906119062190631906419065190661906719068190691907019071190721907319074190751907619077190781907919080190811908219083190841908519086190871908819089190901909119092190931909419095190961909719098190991910019101191021910319104191051910619107191081910919110191111911219113191141911519116191171911819119191201912119122191231912419125191261912719128191291913019131191321913319134191351913619137191381913919140191411914219143191441914519146191471914819149191501915119152191531915419155191561915719158191591916019161191621916319164191651916619167191681916919170191711917219173191741917519176191771917819179191801918119182191831918419185191861918719188191891919019191191921919319194191951919619197191981919919200192011920219203192041920519206192071920819209192101921119212192131921419215192161921719218192191922019221192221922319224192251922619227192281922919230192311923219233192341923519236192371923819239192401924119242192431924419245192461924719248192491925019251192521925319254192551925619257192581925919260192611926219263192641926519266192671926819269192701927119272192731927419275192761927719278192791928019281192821928319284192851928619287192881928919290192911929219293192941929519296192971929819299193001930119302193031930419305193061930719308193091931019311193121931319314193151931619317193181931919320193211932219323193241932519326193271932819329193301933119332193331933419335193361933719338193391934019341193421934319344193451934619347193481934919350193511935219353193541935519356193571935819359193601936119362193631936419365193661936719368193691937019371193721937319374193751937619377193781937919380193811938219383193841938519386193871938819389193901939119392193931939419395193961939719398193991940019401194021940319404194051940619407194081940919410194111941219413194141941519416194171941819419194201942119422194231942419425194261942719428194291943019431194321943319434194351943619437194381943919440194411944219443194441944519446194471944819449194501945119452194531945419455194561945719458194591946019461194621946319464194651946619467194681946919470194711947219473194741947519476194771947819479194801948119482194831948419485194861948719488194891949019491194921949319494194951949619497194981949919500195011950219503195041950519506195071950819509195101951119512195131951419515195161951719518195191952019521195221952319524195251952619527195281952919530195311953219533195341953519536195371953819539195401954119542195431954419545195461954719548195491955019551195521955319554195551955619557195581955919560195611956219563195641956519566195671956819569195701957119572195731957419575195761957719578195791958019581195821958319584195851958619587195881958919590195911959219593195941959519596195971959819599196001960119602196031960419605196061960719608196091961019611196121961319614196151961619617196181961919620196211962219623196241962519626196271962819629196301963119632196331963419635196361963719638196391964019641196421964319644196451964619647196481964919650196511965219653196541965519656196571965819659196601966119662196631966419665196661966719668196691967019671196721967319674196751967619677196781967919680196811968219683196841968519686196871968819689196901969119692196931969419695196961969719698196991970019701197021970319704197051970619707197081970919710197111971219713197141971519716197171971819719197201972119722197231972419725197261972719728197291973019731197321973319734197351973619737197381973919740197411974219743197441974519746197471974819749197501975119752197531975419755197561975719758197591976019761197621976319764197651976619767197681976919770197711977219773197741977519776197771977819779197801978119782197831978419785197861978719788197891979019791197921979319794197951979619797197981979919800198011980219803198041980519806198071980819809198101981119812198131981419815198161981719818198191982019821198221982319824198251982619827198281982919830198311983219833198341983519836198371983819839198401984119842198431984419845198461984719848198491985019851198521985319854198551985619857198581985919860198611986219863198641986519866198671986819869198701987119872198731987419875198761987719878198791988019881198821988319884198851988619887198881988919890198911989219893198941989519896198971989819899199001990119902199031990419905199061990719908199091991019911199121991319914199151991619917199181991919920199211992219923199241992519926199271992819929199301993119932199331993419935199361993719938199391994019941199421994319944199451994619947199481994919950199511995219953199541995519956199571995819959199601996119962199631996419965199661996719968199691997019971199721997319974199751997619977199781997919980199811998219983199841998519986199871998819989199901999119992199931999419995199961999719998199992000020001200022000320004200052000620007200082000920010200112001220013200142001520016200172001820019200202002120022200232002420025200262002720028200292003020031200322003320034200352003620037200382003920040200412004220043200442004520046200472004820049200502005120052200532005420055200562005720058200592006020061200622006320064200652006620067200682006920070200712007220073200742007520076200772007820079200802008120082200832008420085200862008720088200892009020091200922009320094200952009620097200982009920100201012010220103201042010520106201072010820109201102011120112201132011420115201162011720118201192012020121201222012320124201252012620127201282012920130201312013220133201342013520136201372013820139201402014120142201432014420145201462014720148201492015020151201522015320154201552015620157201582015920160201612016220163201642016520166201672016820169201702017120172201732017420175201762017720178201792018020181201822018320184201852018620187201882018920190201912019220193201942019520196201972019820199202002020120202202032020420205202062020720208202092021020211202122021320214202152021620217202182021920220202212022220223202242022520226202272022820229202302023120232202332023420235202362023720238202392024020241202422024320244202452024620247202482024920250202512025220253202542025520256202572025820259202602026120262202632026420265202662026720268202692027020271202722027320274202752027620277202782027920280202812028220283202842028520286202872028820289202902029120292202932029420295202962029720298202992030020301203022030320304203052030620307203082030920310203112031220313203142031520316203172031820319203202032120322203232032420325203262032720328203292033020331203322033320334203352033620337203382033920340203412034220343203442034520346203472034820349203502035120352203532035420355203562035720358203592036020361203622036320364203652036620367203682036920370203712037220373203742037520376203772037820379203802038120382203832038420385203862038720388203892039020391203922039320394203952039620397203982039920400204012040220403204042040520406204072040820409204102041120412204132041420415204162041720418204192042020421204222042320424204252042620427204282042920430204312043220433204342043520436204372043820439204402044120442204432044420445204462044720448204492045020451204522045320454204552045620457204582045920460204612046220463204642046520466204672046820469204702047120472204732047420475204762047720478204792048020481204822048320484204852048620487204882048920490204912049220493204942049520496204972049820499205002050120502205032050420505205062050720508205092051020511205122051320514205152051620517205182051920520205212052220523205242052520526205272052820529205302053120532205332053420535205362053720538205392054020541205422054320544205452054620547205482054920550205512055220553205542055520556205572055820559205602056120562205632056420565205662056720568205692057020571205722057320574205752057620577205782057920580205812058220583205842058520586205872058820589205902059120592205932059420595205962059720598205992060020601206022060320604206052060620607206082060920610206112061220613206142061520616206172061820619206202062120622206232062420625206262062720628206292063020631206322063320634206352063620637206382063920640206412064220643206442064520646206472064820649206502065120652206532065420655206562065720658206592066020661206622066320664206652066620667206682066920670206712067220673206742067520676206772067820679206802068120682206832068420685206862068720688206892069020691206922069320694206952069620697206982069920700207012070220703207042070520706207072070820709207102071120712207132071420715207162071720718207192072020721207222072320724207252072620727207282072920730207312073220733207342073520736207372073820739207402074120742207432074420745207462074720748207492075020751207522075320754207552075620757207582075920760207612076220763207642076520766207672076820769207702077120772207732077420775207762077720778207792078020781207822078320784207852078620787207882078920790207912079220793207942079520796207972079820799208002080120802208032080420805208062080720808208092081020811208122081320814208152081620817208182081920820208212082220823208242082520826208272082820829208302083120832208332083420835208362083720838208392084020841208422084320844208452084620847208482084920850208512085220853208542085520856208572085820859208602086120862208632086420865208662086720868208692087020871208722087320874208752087620877208782087920880208812088220883208842088520886208872088820889208902089120892208932089420895208962089720898208992090020901209022090320904209052090620907209082090920910209112091220913209142091520916209172091820919209202092120922209232092420925209262092720928209292093020931209322093320934209352093620937209382093920940209412094220943209442094520946209472094820949209502095120952209532095420955209562095720958209592096020961209622096320964209652096620967209682096920970209712097220973209742097520976209772097820979209802098120982209832098420985209862098720988209892099020991209922099320994209952099620997209982099921000210012100221003210042100521006210072100821009210102101121012210132101421015210162101721018210192102021021210222102321024210252102621027210282102921030210312103221033210342103521036210372103821039210402104121042210432104421045210462104721048210492105021051210522105321054210552105621057210582105921060210612106221063210642106521066210672106821069210702107121072210732107421075210762107721078210792108021081210822108321084210852108621087210882108921090210912109221093210942109521096210972109821099211002110121102211032110421105211062110721108211092111021111211122111321114211152111621117211182111921120211212112221123211242112521126211272112821129211302113121132211332113421135211362113721138211392114021141211422114321144211452114621147211482114921150211512115221153211542115521156211572115821159211602116121162211632116421165211662116721168211692117021171211722117321174211752117621177211782117921180211812118221183211842118521186211872118821189211902119121192211932119421195211962119721198211992120021201212022120321204212052120621207212082120921210212112121221213212142121521216212172121821219212202122121222212232122421225212262122721228212292123021231212322123321234212352123621237212382123921240212412124221243212442124521246212472124821249212502125121252212532125421255212562125721258212592126021261212622126321264212652126621267212682126921270212712127221273212742127521276212772127821279212802128121282212832128421285212862128721288212892129021291212922129321294212952129621297212982129921300213012130221303213042130521306213072130821309213102131121312213132131421315213162131721318213192132021321213222132321324213252132621327213282132921330213312133221333213342133521336213372133821339213402134121342213432134421345213462134721348213492135021351213522135321354213552135621357213582135921360213612136221363213642136521366213672136821369213702137121372213732137421375213762137721378213792138021381213822138321384213852138621387213882138921390213912139221393213942139521396213972139821399214002140121402214032140421405214062140721408214092141021411214122141321414214152141621417214182141921420214212142221423214242142521426214272142821429214302143121432214332143421435214362143721438214392144021441214422144321444214452144621447214482144921450214512145221453214542145521456214572145821459214602146121462214632146421465214662146721468214692147021471214722147321474214752147621477214782147921480214812148221483214842148521486214872148821489214902149121492214932149421495214962149721498214992150021501215022150321504215052150621507215082150921510215112151221513215142151521516215172151821519215202152121522215232152421525215262152721528215292153021531215322153321534215352153621537215382153921540215412154221543215442154521546215472154821549215502155121552215532155421555215562155721558215592156021561215622156321564215652156621567215682156921570215712157221573215742157521576215772157821579215802158121582215832158421585215862158721588215892159021591215922159321594215952159621597215982159921600216012160221603216042160521606216072160821609216102161121612216132161421615216162161721618216192162021621216222162321624216252162621627216282162921630216312163221633216342163521636216372163821639216402164121642216432164421645216462164721648216492165021651216522165321654216552165621657216582165921660216612166221663216642166521666216672166821669216702167121672216732167421675216762167721678216792168021681216822168321684216852168621687216882168921690216912169221693216942169521696216972169821699217002170121702217032170421705217062170721708217092171021711217122171321714217152171621717217182171921720217212172221723217242172521726217272172821729217302173121732217332173421735217362173721738217392174021741217422174321744217452174621747217482174921750217512175221753217542175521756217572175821759217602176121762217632176421765217662176721768217692177021771217722177321774217752177621777217782177921780217812178221783217842178521786217872178821789217902179121792217932179421795217962179721798217992180021801218022180321804218052180621807218082180921810218112181221813218142181521816218172181821819218202182121822218232182421825218262182721828218292183021831218322183321834218352183621837218382183921840218412184221843218442184521846218472184821849218502185121852218532185421855218562185721858218592186021861218622186321864218652186621867218682186921870218712187221873218742187521876218772187821879218802188121882218832188421885218862188721888218892189021891218922189321894218952189621897218982189921900219012190221903219042190521906219072190821909219102191121912219132191421915219162191721918219192192021921219222192321924219252192621927219282192921930219312193221933219342193521936219372193821939219402194121942219432194421945219462194721948219492195021951219522195321954219552195621957219582195921960219612196221963219642196521966219672196821969219702197121972219732197421975219762197721978219792198021981219822198321984219852198621987219882198921990219912199221993219942199521996219972199821999220002200122002220032200422005220062200722008220092201022011220122201322014220152201622017220182201922020220212202222023220242202522026220272202822029220302203122032220332203422035220362203722038220392204022041220422204322044220452204622047220482204922050220512205222053220542205522056220572205822059220602206122062220632206422065220662206722068220692207022071220722207322074220752207622077220782207922080220812208222083220842208522086220872208822089220902209122092220932209422095220962209722098220992210022101221022210322104221052210622107221082210922110221112211222113221142211522116221172211822119221202212122122221232212422125221262212722128221292213022131221322213322134221352213622137221382213922140221412214222143221442214522146221472214822149221502215122152221532215422155221562215722158221592216022161221622216322164221652216622167221682216922170221712217222173221742217522176221772217822179221802218122182221832218422185221862218722188221892219022191221922219322194221952219622197221982219922200222012220222203222042220522206222072220822209222102221122212222132221422215222162221722218222192222022221222222222322224222252222622227222282222922230222312223222233222342223522236222372223822239222402224122242222432224422245222462224722248222492225022251222522225322254222552225622257222582225922260222612226222263222642226522266222672226822269222702227122272222732227422275222762227722278222792228022281222822228322284222852228622287222882228922290222912229222293222942229522296222972229822299223002230122302223032230422305223062230722308223092231022311223122231322314223152231622317223182231922320223212232222323223242232522326223272232822329223302233122332223332233422335223362233722338223392234022341223422234322344223452234622347223482234922350223512235222353223542235522356223572235822359223602236122362223632236422365223662236722368223692237022371223722237322374223752237622377223782237922380223812238222383223842238522386223872238822389223902239122392223932239422395223962239722398223992240022401224022240322404224052240622407224082240922410224112241222413224142241522416224172241822419224202242122422224232242422425224262242722428224292243022431224322243322434224352243622437224382243922440224412244222443224442244522446224472244822449224502245122452224532245422455224562245722458224592246022461224622246322464224652246622467224682246922470224712247222473224742247522476224772247822479224802248122482224832248422485224862248722488224892249022491224922249322494224952249622497224982249922500225012250222503225042250522506225072250822509225102251122512225132251422515225162251722518225192252022521225222252322524225252252622527225282252922530225312253222533225342253522536225372253822539225402254122542225432254422545225462254722548225492255022551225522255322554225552255622557225582255922560225612256222563225642256522566225672256822569225702257122572225732257422575225762257722578225792258022581225822258322584225852258622587225882258922590225912259222593225942259522596225972259822599226002260122602226032260422605226062260722608226092261022611226122261322614226152261622617226182261922620226212262222623226242262522626226272262822629226302263122632226332263422635226362263722638226392264022641226422264322644226452264622647226482264922650226512265222653226542265522656226572265822659226602266122662226632266422665226662266722668226692267022671226722267322674226752267622677226782267922680226812268222683226842268522686226872268822689226902269122692226932269422695226962269722698226992270022701227022270322704227052270622707227082270922710227112271222713227142271522716227172271822719227202272122722227232272422725227262272722728227292273022731227322273322734227352273622737227382273922740227412274222743227442274522746227472274822749227502275122752227532275422755227562275722758227592276022761227622276322764227652276622767227682276922770227712277222773227742277522776227772277822779227802278122782227832278422785227862278722788227892279022791227922279322794227952279622797227982279922800228012280222803228042280522806228072280822809228102281122812228132281422815228162281722818228192282022821228222282322824228252282622827228282282922830228312283222833228342283522836228372283822839228402284122842228432284422845228462284722848228492285022851228522285322854228552285622857228582285922860228612286222863228642286522866228672286822869228702287122872228732287422875228762287722878228792288022881228822288322884228852288622887228882288922890228912289222893228942289522896228972289822899229002290122902229032290422905229062290722908229092291022911229122291322914229152291622917229182291922920229212292222923229242292522926229272292822929229302293122932229332293422935229362293722938229392294022941229422294322944229452294622947229482294922950229512295222953229542295522956229572295822959229602296122962229632296422965229662296722968229692297022971229722297322974229752297622977229782297922980229812298222983229842298522986229872298822989229902299122992229932299422995229962299722998229992300023001230022300323004230052300623007230082300923010230112301223013230142301523016230172301823019230202302123022230232302423025230262302723028230292303023031230322303323034230352303623037230382303923040230412304223043230442304523046230472304823049230502305123052230532305423055230562305723058230592306023061230622306323064230652306623067230682306923070230712307223073230742307523076230772307823079230802308123082230832308423085230862308723088230892309023091230922309323094230952309623097230982309923100231012310223103231042310523106231072310823109231102311123112231132311423115231162311723118231192312023121231222312323124231252312623127231282312923130231312313223133231342313523136231372313823139231402314123142231432314423145231462314723148231492315023151231522315323154231552315623157231582315923160231612316223163231642316523166231672316823169231702317123172231732317423175231762317723178231792318023181231822318323184231852318623187231882318923190231912319223193231942319523196231972319823199232002320123202232032320423205232062320723208232092321023211232122321323214232152321623217232182321923220232212322223223232242322523226232272322823229232302323123232232332323423235232362323723238232392324023241232422324323244232452324623247232482324923250232512325223253232542325523256232572325823259232602326123262232632326423265232662326723268232692327023271232722327323274232752327623277232782327923280232812328223283232842328523286232872328823289232902329123292232932329423295232962329723298232992330023301233022330323304233052330623307233082330923310233112331223313233142331523316233172331823319233202332123322233232332423325233262332723328233292333023331233322333323334233352333623337233382333923340233412334223343233442334523346233472334823349233502335123352233532335423355233562335723358233592336023361233622336323364233652336623367233682336923370233712337223373233742337523376233772337823379233802338123382233832338423385233862338723388233892339023391233922339323394233952339623397233982339923400234012340223403234042340523406234072340823409234102341123412234132341423415234162341723418234192342023421234222342323424234252342623427234282342923430234312343223433234342343523436234372343823439234402344123442234432344423445234462344723448234492345023451234522345323454234552345623457234582345923460234612346223463234642346523466234672346823469234702347123472234732347423475234762347723478234792348023481234822348323484234852348623487234882348923490234912349223493234942349523496234972349823499235002350123502235032350423505235062350723508235092351023511235122351323514235152351623517235182351923520235212352223523235242352523526235272352823529235302353123532235332353423535235362353723538235392354023541235422354323544235452354623547235482354923550235512355223553235542355523556235572355823559235602356123562235632356423565235662356723568235692357023571235722357323574235752357623577235782357923580235812358223583235842358523586235872358823589235902359123592235932359423595235962359723598235992360023601236022360323604236052360623607236082360923610236112361223613236142361523616236172361823619236202362123622236232362423625236262362723628236292363023631236322363323634236352363623637236382363923640236412364223643236442364523646236472364823649236502365123652236532365423655236562365723658236592366023661236622366323664236652366623667236682366923670236712367223673236742367523676236772367823679236802368123682236832368423685236862368723688236892369023691236922369323694236952369623697236982369923700237012370223703237042370523706237072370823709237102371123712237132371423715237162371723718237192372023721237222372323724237252372623727237282372923730237312373223733237342373523736237372373823739237402374123742237432374423745237462374723748237492375023751237522375323754237552375623757237582375923760237612376223763237642376523766237672376823769237702377123772237732377423775237762377723778237792378023781237822378323784237852378623787237882378923790237912379223793237942379523796237972379823799238002380123802238032380423805238062380723808238092381023811238122381323814238152381623817238182381923820238212382223823238242382523826238272382823829238302383123832238332383423835238362383723838238392384023841238422384323844238452384623847238482384923850238512385223853238542385523856238572385823859238602386123862238632386423865238662386723868238692387023871238722387323874238752387623877238782387923880238812388223883238842388523886238872388823889238902389123892238932389423895238962389723898238992390023901239022390323904239052390623907239082390923910239112391223913239142391523916239172391823919239202392123922239232392423925239262392723928239292393023931239322393323934239352393623937239382393923940239412394223943239442394523946239472394823949239502395123952239532395423955239562395723958239592396023961239622396323964239652396623967239682396923970239712397223973239742397523976239772397823979239802398123982239832398423985239862398723988239892399023991239922399323994239952399623997239982399924000240012400224003240042400524006240072400824009240102401124012240132401424015240162401724018240192402024021240222402324024240252402624027240282402924030240312403224033240342403524036240372403824039240402404124042240432404424045240462404724048240492405024051240522405324054240552405624057240582405924060240612406224063240642406524066240672406824069240702407124072240732407424075240762407724078240792408024081240822408324084240852408624087240882408924090240912409224093240942409524096240972409824099241002410124102241032410424105241062410724108241092411024111241122411324114241152411624117241182411924120241212412224123241242412524126241272412824129241302413124132241332413424135241362413724138241392414024141241422414324144241452414624147241482414924150241512415224153241542415524156241572415824159241602416124162241632416424165241662416724168241692417024171241722417324174241752417624177241782417924180241812418224183241842418524186241872418824189241902419124192241932419424195241962419724198241992420024201242022420324204242052420624207242082420924210242112421224213242142421524216242172421824219242202422124222242232422424225242262422724228242292423024231242322423324234242352423624237242382423924240242412424224243242442424524246242472424824249242502425124252242532425424255242562425724258242592426024261242622426324264242652426624267242682426924270242712427224273242742427524276242772427824279242802428124282242832428424285242862428724288242892429024291242922429324294242952429624297242982429924300243012430224303243042430524306243072430824309243102431124312243132431424315243162431724318243192432024321243222432324324243252432624327243282432924330243312433224333243342433524336243372433824339243402434124342243432434424345243462434724348243492435024351243522435324354243552435624357243582435924360243612436224363243642436524366243672436824369243702437124372243732437424375243762437724378243792438024381243822438324384243852438624387243882438924390243912439224393243942439524396243972439824399244002440124402244032440424405244062440724408244092441024411244122441324414244152441624417244182441924420244212442224423244242442524426244272442824429244302443124432244332443424435244362443724438244392444024441244422444324444244452444624447244482444924450244512445224453244542445524456244572445824459244602446124462244632446424465244662446724468244692447024471244722447324474244752447624477244782447924480244812448224483244842448524486244872448824489244902449124492244932449424495244962449724498244992450024501245022450324504245052450624507245082450924510245112451224513245142451524516245172451824519245202452124522245232452424525245262452724528245292453024531245322453324534245352453624537245382453924540245412454224543245442454524546245472454824549245502455124552245532455424555245562455724558245592456024561245622456324564245652456624567245682456924570245712457224573245742457524576245772457824579245802458124582245832458424585245862458724588245892459024591245922459324594245952459624597245982459924600246012460224603246042460524606246072460824609246102461124612246132461424615246162461724618246192462024621246222462324624246252462624627246282462924630246312463224633246342463524636246372463824639246402464124642246432464424645246462464724648246492465024651246522465324654246552465624657246582465924660246612466224663246642466524666246672466824669246702467124672246732467424675246762467724678246792468024681246822468324684246852468624687246882468924690246912469224693246942469524696246972469824699247002470124702247032470424705247062470724708247092471024711247122471324714247152471624717247182471924720247212472224723247242472524726247272472824729247302473124732247332473424735247362473724738247392474024741247422474324744247452474624747247482474924750247512475224753247542475524756247572475824759247602476124762247632476424765247662476724768247692477024771247722477324774247752477624777247782477924780247812478224783247842478524786247872478824789247902479124792247932479424795247962479724798247992480024801248022480324804248052480624807248082480924810248112481224813248142481524816248172481824819248202482124822248232482424825248262482724828248292483024831248322483324834248352483624837248382483924840248412484224843248442484524846248472484824849248502485124852248532485424855248562485724858248592486024861248622486324864248652486624867248682486924870248712487224873248742487524876248772487824879248802488124882248832488424885248862488724888248892489024891248922489324894248952489624897248982489924900249012490224903249042490524906249072490824909249102491124912249132491424915249162491724918249192492024921249222492324924249252492624927249282492924930249312493224933249342493524936249372493824939249402494124942249432494424945249462494724948249492495024951249522495324954249552495624957249582495924960249612496224963249642496524966249672496824969249702497124972249732497424975249762497724978249792498024981249822498324984249852498624987249882498924990249912499224993249942499524996249972499824999250002500125002250032500425005250062500725008250092501025011250122501325014250152501625017250182501925020250212502225023250242502525026250272502825029250302503125032250332503425035250362503725038250392504025041250422504325044250452504625047250482504925050250512505225053250542505525056250572505825059250602506125062250632506425065250662506725068250692507025071250722507325074250752507625077250782507925080250812508225083250842508525086250872508825089250902509125092250932509425095250962509725098250992510025101251022510325104251052510625107251082510925110251112511225113251142511525116251172511825119251202512125122251232512425125251262512725128251292513025131251322513325134251352513625137251382513925140251412514225143251442514525146251472514825149251502515125152251532515425155251562515725158251592516025161251622516325164251652516625167251682516925170251712517225173251742517525176251772517825179251802518125182251832518425185251862518725188251892519025191251922519325194251952519625197251982519925200252012520225203252042520525206252072520825209252102521125212252132521425215252162521725218252192522025221252222522325224252252522625227252282522925230252312523225233252342523525236252372523825239252402524125242252432524425245252462524725248252492525025251252522525325254252552525625257252582525925260252612526225263252642526525266252672526825269252702527125272252732527425275252762527725278252792528025281252822528325284252852528625287252882528925290252912529225293252942529525296252972529825299253002530125302253032530425305253062530725308253092531025311253122531325314253152531625317253182531925320253212532225323253242532525326253272532825329253302533125332253332533425335253362533725338253392534025341253422534325344253452534625347253482534925350253512535225353253542535525356253572535825359253602536125362253632536425365253662536725368253692537025371253722537325374253752537625377253782537925380253812538225383253842538525386253872538825389253902539125392253932539425395253962539725398253992540025401254022540325404254052540625407254082540925410254112541225413254142541525416254172541825419254202542125422254232542425425254262542725428254292543025431254322543325434254352543625437254382543925440254412544225443254442544525446254472544825449254502545125452254532545425455254562545725458254592546025461254622546325464254652546625467254682546925470254712547225473254742547525476254772547825479254802548125482254832548425485254862548725488254892549025491254922549325494254952549625497254982549925500255012550225503255042550525506255072550825509255102551125512255132551425515255162551725518255192552025521255222552325524255252552625527255282552925530255312553225533255342553525536255372553825539255402554125542255432554425545255462554725548255492555025551255522555325554255552555625557255582555925560255612556225563255642556525566255672556825569255702557125572255732557425575255762557725578255792558025581255822558325584255852558625587255882558925590255912559225593255942559525596255972559825599256002560125602256032560425605256062560725608256092561025611256122561325614256152561625617256182561925620256212562225623256242562525626256272562825629256302563125632256332563425635256362563725638256392564025641256422564325644256452564625647256482564925650256512565225653256542565525656256572565825659256602566125662256632566425665256662566725668256692567025671256722567325674256752567625677256782567925680256812568225683256842568525686256872568825689256902569125692256932569425695256962569725698256992570025701257022570325704257052570625707257082570925710257112571225713257142571525716257172571825719257202572125722257232572425725257262572725728257292573025731257322573325734257352573625737257382573925740257412574225743257442574525746257472574825749257502575125752257532575425755257562575725758257592576025761257622576325764257652576625767257682576925770257712577225773257742577525776257772577825779257802578125782257832578425785257862578725788257892579025791257922579325794257952579625797257982579925800258012580225803258042580525806258072580825809258102581125812258132581425815258162581725818258192582025821258222582325824258252582625827258282582925830258312583225833258342583525836258372583825839258402584125842258432584425845258462584725848258492585025851258522585325854258552585625857258582585925860258612586225863258642586525866258672586825869258702587125872258732587425875258762587725878258792588025881258822588325884258852588625887258882588925890258912589225893258942589525896258972589825899259002590125902259032590425905259062590725908259092591025911259122591325914259152591625917259182591925920259212592225923259242592525926259272592825929259302593125932259332593425935259362593725938259392594025941259422594325944259452594625947259482594925950259512595225953259542595525956259572595825959259602596125962259632596425965259662596725968259692597025971259722597325974259752597625977259782597925980259812598225983259842598525986259872598825989259902599125992259932599425995259962599725998259992600026001260022600326004260052600626007260082600926010260112601226013260142601526016260172601826019260202602126022260232602426025260262602726028260292603026031260322603326034260352603626037260382603926040260412604226043260442604526046260472604826049260502605126052260532605426055260562605726058260592606026061260622606326064260652606626067260682606926070260712607226073260742607526076260772607826079260802608126082260832608426085260862608726088260892609026091260922609326094260952609626097260982609926100261012610226103261042610526106261072610826109261102611126112261132611426115261162611726118261192612026121261222612326124261252612626127261282612926130261312613226133261342613526136261372613826139261402614126142261432614426145261462614726148261492615026151261522615326154261552615626157261582615926160261612616226163261642616526166261672616826169261702617126172261732617426175261762617726178261792618026181261822618326184261852618626187261882618926190261912619226193261942619526196261972619826199262002620126202262032620426205262062620726208262092621026211262122621326214262152621626217262182621926220262212622226223262242622526226262272622826229262302623126232262332623426235262362623726238262392624026241262422624326244262452624626247262482624926250262512625226253262542625526256262572625826259262602626126262262632626426265262662626726268262692627026271262722627326274262752627626277262782627926280262812628226283262842628526286262872628826289262902629126292262932629426295262962629726298262992630026301263022630326304263052630626307263082630926310263112631226313263142631526316263172631826319263202632126322263232632426325263262632726328263292633026331263322633326334263352633626337263382633926340263412634226343263442634526346263472634826349263502635126352263532635426355263562635726358263592636026361263622636326364263652636626367263682636926370263712637226373263742637526376263772637826379263802638126382263832638426385263862638726388263892639026391263922639326394263952639626397263982639926400264012640226403264042640526406264072640826409264102641126412264132641426415264162641726418264192642026421264222642326424264252642626427264282642926430264312643226433264342643526436264372643826439264402644126442264432644426445264462644726448264492645026451264522645326454264552645626457264582645926460264612646226463264642646526466264672646826469264702647126472264732647426475264762647726478264792648026481264822648326484264852648626487264882648926490264912649226493264942649526496264972649826499265002650126502265032650426505265062650726508265092651026511265122651326514265152651626517265182651926520265212652226523265242652526526265272652826529265302653126532265332653426535265362653726538265392654026541265422654326544265452654626547265482654926550265512655226553265542655526556265572655826559265602656126562265632656426565265662656726568265692657026571265722657326574265752657626577265782657926580265812658226583265842658526586265872658826589265902659126592265932659426595265962659726598265992660026601266022660326604266052660626607266082660926610266112661226613266142661526616266172661826619266202662126622266232662426625266262662726628266292663026631266322663326634266352663626637266382663926640266412664226643266442664526646266472664826649266502665126652266532665426655266562665726658266592666026661266622666326664266652666626667266682666926670266712667226673266742667526676266772667826679266802668126682266832668426685266862668726688266892669026691266922669326694266952669626697266982669926700267012670226703267042670526706267072670826709267102671126712267132671426715267162671726718267192672026721267222672326724267252672626727267282672926730267312673226733267342673526736267372673826739267402674126742267432674426745267462674726748267492675026751267522675326754267552675626757267582675926760267612676226763267642676526766267672676826769267702677126772267732677426775267762677726778267792678026781267822678326784267852678626787267882678926790267912679226793267942679526796267972679826799268002680126802268032680426805268062680726808268092681026811268122681326814268152681626817268182681926820268212682226823268242682526826268272682826829268302683126832268332683426835268362683726838268392684026841268422684326844268452684626847268482684926850268512685226853268542685526856268572685826859268602686126862268632686426865268662686726868268692687026871268722687326874268752687626877268782687926880268812688226883268842688526886268872688826889268902689126892268932689426895268962689726898268992690026901269022690326904269052690626907269082690926910269112691226913269142691526916269172691826919269202692126922269232692426925269262692726928269292693026931269322693326934269352693626937269382693926940269412694226943269442694526946269472694826949269502695126952269532695426955269562695726958269592696026961269622696326964269652696626967269682696926970269712697226973269742697526976269772697826979269802698126982269832698426985269862698726988269892699026991269922699326994269952699626997269982699927000270012700227003270042700527006270072700827009270102701127012270132701427015270162701727018270192702027021270222702327024270252702627027270282702927030270312703227033270342703527036270372703827039270402704127042270432704427045270462704727048270492705027051270522705327054270552705627057270582705927060270612706227063270642706527066270672706827069270702707127072270732707427075270762707727078270792708027081270822708327084270852708627087270882708927090270912709227093270942709527096270972709827099271002710127102271032710427105271062710727108271092711027111271122711327114271152711627117271182711927120271212712227123271242712527126271272712827129271302713127132271332713427135271362713727138271392714027141271422714327144271452714627147271482714927150271512715227153271542715527156271572715827159271602716127162271632716427165271662716727168271692717027171271722717327174271752717627177271782717927180271812718227183271842718527186271872718827189271902719127192271932719427195271962719727198271992720027201272022720327204272052720627207272082720927210272112721227213272142721527216272172721827219272202722127222272232722427225272262722727228272292723027231272322723327234272352723627237272382723927240272412724227243272442724527246272472724827249272502725127252272532725427255272562725727258272592726027261272622726327264272652726627267272682726927270272712727227273272742727527276272772727827279272802728127282272832728427285272862728727288272892729027291272922729327294272952729627297272982729927300273012730227303273042730527306273072730827309273102731127312273132731427315273162731727318273192732027321273222732327324273252732627327273282732927330273312733227333273342733527336273372733827339273402734127342273432734427345273462734727348273492735027351273522735327354273552735627357273582735927360273612736227363273642736527366273672736827369273702737127372273732737427375273762737727378273792738027381273822738327384273852738627387273882738927390273912739227393273942739527396273972739827399274002740127402274032740427405274062740727408274092741027411274122741327414274152741627417274182741927420274212742227423274242742527426274272742827429274302743127432274332743427435274362743727438274392744027441274422744327444274452744627447274482744927450274512745227453274542745527456274572745827459274602746127462274632746427465274662746727468274692747027471274722747327474274752747627477274782747927480274812748227483274842748527486274872748827489274902749127492274932749427495274962749727498274992750027501275022750327504275052750627507275082750927510275112751227513275142751527516275172751827519275202752127522275232752427525275262752727528275292753027531275322753327534275352753627537275382753927540275412754227543275442754527546275472754827549275502755127552275532755427555275562755727558275592756027561275622756327564275652756627567275682756927570275712757227573275742757527576275772757827579275802758127582275832758427585275862758727588275892759027591275922759327594275952759627597275982759927600276012760227603276042760527606276072760827609276102761127612276132761427615276162761727618276192762027621276222762327624276252762627627276282762927630276312763227633276342763527636276372763827639276402764127642276432764427645276462764727648276492765027651276522765327654276552765627657276582765927660276612766227663276642766527666276672766827669276702767127672276732767427675276762767727678276792768027681276822768327684276852768627687276882768927690276912769227693276942769527696276972769827699277002770127702277032770427705277062770727708277092771027711277122771327714277152771627717277182771927720277212772227723277242772527726277272772827729277302773127732277332773427735277362773727738277392774027741277422774327744277452774627747277482774927750277512775227753277542775527756277572775827759277602776127762277632776427765277662776727768277692777027771277722777327774277752777627777277782777927780277812778227783277842778527786277872778827789277902779127792277932779427795277962779727798277992780027801278022780327804278052780627807278082780927810278112781227813278142781527816278172781827819278202782127822278232782427825278262782727828278292783027831278322783327834278352783627837278382783927840278412784227843278442784527846278472784827849278502785127852278532785427855278562785727858278592786027861278622786327864278652786627867278682786927870278712787227873278742787527876278772787827879278802788127882278832788427885278862788727888278892789027891278922789327894278952789627897278982789927900279012790227903279042790527906279072790827909279102791127912279132791427915279162791727918279192792027921279222792327924279252792627927279282792927930279312793227933279342793527936279372793827939279402794127942279432794427945279462794727948279492795027951279522795327954279552795627957279582795927960279612796227963279642796527966279672796827969279702797127972279732797427975279762797727978279792798027981279822798327984279852798627987279882798927990279912799227993279942799527996279972799827999280002800128002280032800428005280062800728008280092801028011280122801328014280152801628017280182801928020280212802228023280242802528026280272802828029280302803128032280332803428035280362803728038280392804028041280422804328044280452804628047280482804928050280512805228053280542805528056280572805828059280602806128062280632806428065280662806728068280692807028071280722807328074280752807628077280782807928080280812808228083280842808528086280872808828089280902809128092280932809428095280962809728098280992810028101281022810328104281052810628107281082810928110281112811228113281142811528116281172811828119281202812128122281232812428125281262812728128281292813028131281322813328134281352813628137281382813928140281412814228143281442814528146281472814828149281502815128152281532815428155281562815728158281592816028161281622816328164281652816628167281682816928170281712817228173281742817528176281772817828179281802818128182281832818428185281862818728188281892819028191281922819328194281952819628197281982819928200282012820228203282042820528206282072820828209282102821128212282132821428215282162821728218282192822028221282222822328224282252822628227282282822928230282312823228233282342823528236282372823828239282402824128242282432824428245282462824728248282492825028251282522825328254282552825628257282582825928260282612826228263282642826528266282672826828269282702827128272282732827428275282762827728278282792828028281282822828328284282852828628287282882828928290282912829228293282942829528296282972829828299283002830128302283032830428305283062830728308283092831028311283122831328314283152831628317283182831928320283212832228323283242832528326283272832828329283302833128332283332833428335283362833728338283392834028341283422834328344283452834628347283482834928350283512835228353283542835528356283572835828359283602836128362283632836428365283662836728368283692837028371283722837328374283752837628377283782837928380283812838228383283842838528386283872838828389283902839128392283932839428395283962839728398283992840028401284022840328404284052840628407284082840928410284112841228413284142841528416284172841828419284202842128422284232842428425284262842728428284292843028431284322843328434284352843628437284382843928440284412844228443284442844528446284472844828449284502845128452284532845428455284562845728458284592846028461284622846328464284652846628467284682846928470284712847228473284742847528476284772847828479284802848128482284832848428485284862848728488284892849028491284922849328494284952849628497284982849928500285012850228503285042850528506285072850828509285102851128512285132851428515285162851728518285192852028521285222852328524285252852628527285282852928530285312853228533285342853528536285372853828539285402854128542285432854428545285462854728548285492855028551285522855328554285552855628557285582855928560285612856228563285642856528566285672856828569285702857128572285732857428575285762857728578285792858028581285822858328584285852858628587285882858928590285912859228593285942859528596285972859828599286002860128602286032860428605286062860728608286092861028611286122861328614286152861628617286182861928620286212862228623286242862528626286272862828629286302863128632286332863428635286362863728638286392864028641286422864328644286452864628647286482864928650286512865228653286542865528656286572865828659286602866128662286632866428665286662866728668286692867028671286722867328674286752867628677286782867928680286812868228683286842868528686286872868828689286902869128692286932869428695286962869728698286992870028701287022870328704287052870628707287082870928710287112871228713287142871528716287172871828719287202872128722287232872428725287262872728728287292873028731287322873328734287352873628737287382873928740287412874228743287442874528746287472874828749287502875128752287532875428755287562875728758287592876028761287622876328764287652876628767287682876928770287712877228773287742877528776287772877828779287802878128782287832878428785287862878728788287892879028791287922879328794287952879628797287982879928800288012880228803288042880528806288072880828809288102881128812288132881428815288162881728818288192882028821288222882328824288252882628827288282882928830288312883228833288342883528836288372883828839288402884128842288432884428845288462884728848288492885028851288522885328854288552885628857288582885928860288612886228863288642886528866288672886828869288702887128872288732887428875288762887728878288792888028881288822888328884288852888628887288882888928890288912889228893288942889528896288972889828899289002890128902289032890428905289062890728908289092891028911289122891328914289152891628917289182891928920289212892228923289242892528926289272892828929289302893128932289332893428935289362893728938289392894028941289422894328944289452894628947289482894928950289512895228953289542895528956289572895828959289602896128962289632896428965289662896728968289692897028971289722897328974289752897628977289782897928980289812898228983289842898528986289872898828989289902899128992289932899428995289962899728998289992900029001290022900329004290052900629007290082900929010290112901229013290142901529016290172901829019290202902129022290232902429025290262902729028290292903029031290322903329034290352903629037290382903929040290412904229043290442904529046290472904829049290502905129052290532905429055290562905729058290592906029061290622906329064290652906629067290682906929070290712907229073290742907529076290772907829079290802908129082290832908429085290862908729088290892909029091290922909329094290952909629097290982909929100291012910229103291042910529106291072910829109291102911129112291132911429115291162911729118291192912029121291222912329124291252912629127291282912929130291312913229133291342913529136291372913829139291402914129142291432914429145291462914729148291492915029151291522915329154291552915629157291582915929160291612916229163291642916529166291672916829169291702917129172291732917429175291762917729178291792918029181291822918329184291852918629187291882918929190291912919229193291942919529196291972919829199292002920129202292032920429205292062920729208292092921029211292122921329214292152921629217292182921929220292212922229223292242922529226292272922829229292302923129232292332923429235292362923729238292392924029241292422924329244292452924629247292482924929250292512925229253292542925529256292572925829259292602926129262292632926429265292662926729268292692927029271292722927329274292752927629277292782927929280292812928229283292842928529286292872928829289292902929129292292932929429295292962929729298292992930029301293022930329304293052930629307293082930929310293112931229313293142931529316293172931829319293202932129322293232932429325293262932729328293292933029331293322933329334293352933629337293382933929340293412934229343293442934529346293472934829349293502935129352293532935429355293562935729358293592936029361293622936329364293652936629367293682936929370293712937229373293742937529376293772937829379293802938129382293832938429385293862938729388293892939029391293922939329394293952939629397293982939929400294012940229403294042940529406294072940829409294102941129412294132941429415294162941729418294192942029421294222942329424294252942629427294282942929430294312943229433294342943529436294372943829439294402944129442294432944429445294462944729448294492945029451294522945329454294552945629457294582945929460294612946229463294642946529466294672946829469294702947129472294732947429475294762947729478294792948029481294822948329484294852948629487294882948929490294912949229493294942949529496294972949829499295002950129502295032950429505295062950729508295092951029511295122951329514295152951629517295182951929520295212952229523295242952529526295272952829529295302953129532295332953429535295362953729538295392954029541295422954329544295452954629547295482954929550295512955229553295542955529556295572955829559295602956129562295632956429565295662956729568295692957029571295722957329574295752957629577295782957929580295812958229583295842958529586295872958829589295902959129592295932959429595295962959729598295992960029601296022960329604296052960629607296082960929610296112961229613296142961529616296172961829619296202962129622296232962429625296262962729628296292963029631296322963329634296352963629637296382963929640296412964229643296442964529646296472964829649296502965129652296532965429655296562965729658296592966029661296622966329664296652966629667296682966929670296712967229673296742967529676296772967829679296802968129682296832968429685296862968729688296892969029691296922969329694296952969629697296982969929700297012970229703297042970529706297072970829709297102971129712297132971429715297162971729718297192972029721297222972329724297252972629727297282972929730297312973229733297342973529736297372973829739297402974129742297432974429745297462974729748297492975029751297522975329754297552975629757297582975929760297612976229763297642976529766297672976829769297702977129772297732977429775297762977729778297792978029781297822978329784297852978629787297882978929790297912979229793297942979529796297972979829799298002980129802298032980429805298062980729808298092981029811298122981329814298152981629817298182981929820298212982229823298242982529826298272982829829298302983129832298332983429835298362983729838298392984029841298422984329844298452984629847298482984929850298512985229853298542985529856298572985829859298602986129862298632986429865298662986729868298692987029871298722987329874298752987629877298782987929880298812988229883298842988529886298872988829889298902989129892298932989429895298962989729898298992990029901299022990329904299052990629907299082990929910299112991229913299142991529916299172991829919299202992129922299232992429925299262992729928299292993029931299322993329934299352993629937299382993929940299412994229943299442994529946299472994829949299502995129952299532995429955299562995729958299592996029961299622996329964299652996629967299682996929970299712997229973299742997529976299772997829979299802998129982299832998429985299862998729988299892999029991299922999329994299952999629997299982999930000300013000230003300043000530006300073000830009300103001130012300133001430015300163001730018300193002030021300223002330024300253002630027300283002930030300313003230033300343003530036300373003830039300403004130042300433004430045300463004730048300493005030051300523005330054300553005630057300583005930060300613006230063300643006530066300673006830069300703007130072300733007430075300763007730078300793008030081300823008330084300853008630087300883008930090300913009230093300943009530096300973009830099301003010130102301033010430105301063010730108301093011030111301123011330114301153011630117301183011930120301213012230123301243012530126301273012830129301303013130132301333013430135301363013730138301393014030141301423014330144301453014630147301483014930150301513015230153301543015530156301573015830159301603016130162301633016430165301663016730168301693017030171301723017330174301753017630177301783017930180301813018230183301843018530186301873018830189301903019130192301933019430195301963019730198301993020030201302023020330204302053020630207302083020930210302113021230213302143021530216302173021830219302203022130222302233022430225302263022730228302293023030231302323023330234302353023630237302383023930240302413024230243302443024530246302473024830249302503025130252302533025430255302563025730258302593026030261302623026330264302653026630267302683026930270302713027230273302743027530276302773027830279302803028130282302833028430285302863028730288302893029030291302923029330294302953029630297302983029930300303013030230303303043030530306303073030830309303103031130312303133031430315303163031730318303193032030321303223032330324303253032630327303283032930330303313033230333303343033530336303373033830339303403034130342303433034430345303463034730348303493035030351303523035330354303553035630357303583035930360303613036230363303643036530366303673036830369303703037130372303733037430375303763037730378303793038030381303823038330384303853038630387303883038930390303913039230393303943039530396303973039830399304003040130402304033040430405304063040730408304093041030411304123041330414304153041630417304183041930420304213042230423304243042530426304273042830429304303043130432304333043430435304363043730438304393044030441304423044330444304453044630447304483044930450304513045230453304543045530456304573045830459304603046130462304633046430465304663046730468304693047030471304723047330474304753047630477304783047930480304813048230483304843048530486304873048830489304903049130492304933049430495304963049730498304993050030501305023050330504305053050630507305083050930510305113051230513305143051530516305173051830519305203052130522305233052430525305263052730528305293053030531305323053330534305353053630537305383053930540305413054230543305443054530546305473054830549305503055130552305533055430555305563055730558305593056030561305623056330564305653056630567305683056930570305713057230573305743057530576305773057830579305803058130582305833058430585305863058730588305893059030591305923059330594305953059630597305983059930600306013060230603306043060530606306073060830609306103061130612306133061430615306163061730618306193062030621306223062330624306253062630627306283062930630306313063230633306343063530636306373063830639306403064130642306433064430645306463064730648306493065030651306523065330654306553065630657306583065930660306613066230663306643066530666306673066830669306703067130672306733067430675306763067730678306793068030681306823068330684306853068630687306883068930690306913069230693306943069530696306973069830699307003070130702307033070430705307063070730708307093071030711307123071330714307153071630717307183071930720307213072230723307243072530726307273072830729307303073130732307333073430735307363073730738307393074030741307423074330744307453074630747307483074930750307513075230753307543075530756307573075830759307603076130762307633076430765307663076730768307693077030771307723077330774307753077630777307783077930780307813078230783307843078530786307873078830789307903079130792307933079430795307963079730798307993080030801308023080330804308053080630807308083080930810308113081230813308143081530816308173081830819308203082130822308233082430825308263082730828308293083030831308323083330834308353083630837308383083930840308413084230843308443084530846308473084830849308503085130852308533085430855308563085730858308593086030861308623086330864308653086630867308683086930870308713087230873308743087530876308773087830879308803088130882308833088430885308863088730888308893089030891308923089330894308953089630897308983089930900309013090230903309043090530906309073090830909309103091130912309133091430915309163091730918309193092030921309223092330924309253092630927309283092930930309313093230933309343093530936309373093830939309403094130942309433094430945309463094730948309493095030951309523095330954309553095630957309583095930960309613096230963309643096530966309673096830969309703097130972309733097430975309763097730978309793098030981309823098330984309853098630987309883098930990309913099230993309943099530996309973099830999310003100131002310033100431005310063100731008310093101031011310123101331014310153101631017310183101931020310213102231023310243102531026310273102831029310303103131032310333103431035310363103731038310393104031041310423104331044310453104631047310483104931050310513105231053310543105531056310573105831059310603106131062310633106431065310663106731068310693107031071310723107331074310753107631077310783107931080310813108231083310843108531086310873108831089310903109131092310933109431095310963109731098310993110031101311023110331104311053110631107311083110931110311113111231113311143111531116311173111831119311203112131122311233112431125311263112731128311293113031131311323113331134311353113631137311383113931140311413114231143311443114531146311473114831149311503115131152311533115431155311563115731158311593116031161311623116331164311653116631167311683116931170311713117231173311743117531176311773117831179311803118131182311833118431185311863118731188311893119031191311923119331194311953119631197311983119931200312013120231203312043120531206312073120831209312103121131212312133121431215312163121731218312193122031221312223122331224312253122631227312283122931230312313123231233312343123531236312373123831239312403124131242312433124431245312463124731248312493125031251312523125331254312553125631257312583125931260312613126231263312643126531266312673126831269312703127131272312733127431275312763127731278312793128031281312823128331284312853128631287312883128931290312913129231293312943129531296312973129831299313003130131302313033130431305313063130731308313093131031311313123131331314313153131631317313183131931320313213132231323313243132531326313273132831329313303133131332313333133431335313363133731338313393134031341313423134331344313453134631347313483134931350313513135231353313543135531356313573135831359313603136131362313633136431365313663136731368313693137031371313723137331374313753137631377313783137931380313813138231383313843138531386313873138831389313903139131392313933139431395313963139731398313993140031401314023140331404314053140631407314083140931410314113141231413314143141531416314173141831419314203142131422314233142431425314263142731428314293143031431314323143331434314353143631437314383143931440314413144231443314443144531446314473144831449314503145131452314533145431455314563145731458314593146031461314623146331464314653146631467314683146931470314713147231473314743147531476314773147831479314803148131482314833148431485314863148731488314893149031491314923149331494314953149631497314983149931500315013150231503315043150531506315073150831509315103151131512315133151431515315163151731518315193152031521315223152331524315253152631527315283152931530315313153231533315343153531536315373153831539315403154131542315433154431545315463154731548315493155031551315523155331554315553155631557315583155931560315613156231563315643156531566315673156831569315703157131572315733157431575315763157731578315793158031581315823158331584315853158631587315883158931590315913159231593315943159531596315973159831599316003160131602316033160431605316063160731608316093161031611316123161331614316153161631617316183161931620316213162231623316243162531626316273162831629316303163131632316333163431635316363163731638316393164031641316423164331644316453164631647316483164931650316513165231653316543165531656316573165831659316603166131662316633166431665316663166731668316693167031671316723167331674316753167631677316783167931680316813168231683316843168531686316873168831689316903169131692316933169431695316963169731698316993170031701317023170331704317053170631707317083170931710317113171231713317143171531716317173171831719317203172131722317233172431725317263172731728317293173031731317323173331734317353173631737317383173931740317413174231743317443174531746317473174831749317503175131752317533175431755317563175731758317593176031761317623176331764317653176631767317683176931770317713177231773317743177531776317773177831779317803178131782317833178431785317863178731788317893179031791317923179331794317953179631797317983179931800318013180231803318043180531806318073180831809318103181131812318133181431815318163181731818318193182031821318223182331824318253182631827318283182931830318313183231833318343183531836318373183831839318403184131842318433184431845318463184731848318493185031851318523185331854318553185631857318583185931860318613186231863318643186531866318673186831869318703187131872318733187431875318763187731878318793188031881318823188331884318853188631887318883188931890318913189231893318943189531896318973189831899319003190131902319033190431905319063190731908319093191031911319123191331914319153191631917319183191931920319213192231923319243192531926319273192831929319303193131932319333193431935319363193731938319393194031941319423194331944319453194631947319483194931950319513195231953319543195531956319573195831959319603196131962319633196431965319663196731968319693197031971319723197331974319753197631977319783197931980319813198231983319843198531986319873198831989319903199131992319933199431995319963199731998319993200032001320023200332004320053200632007320083200932010320113201232013320143201532016320173201832019320203202132022320233202432025320263202732028320293203032031320323203332034320353203632037320383203932040320413204232043320443204532046320473204832049320503205132052320533205432055320563205732058320593206032061320623206332064320653206632067320683206932070320713207232073320743207532076320773207832079320803208132082320833208432085320863208732088320893209032091320923209332094320953209632097320983209932100321013210232103321043210532106321073210832109321103211132112321133211432115321163211732118321193212032121321223212332124321253212632127321283212932130321313213232133321343213532136321373213832139321403214132142321433214432145321463214732148321493215032151321523215332154321553215632157321583215932160321613216232163321643216532166321673216832169321703217132172321733217432175321763217732178321793218032181321823218332184321853218632187321883218932190321913219232193321943219532196321973219832199322003220132202322033220432205322063220732208322093221032211322123221332214322153221632217322183221932220322213222232223322243222532226322273222832229322303223132232322333223432235322363223732238322393224032241322423224332244322453224632247322483224932250322513225232253322543225532256322573225832259322603226132262322633226432265322663226732268322693227032271322723227332274322753227632277322783227932280322813228232283322843228532286322873228832289322903229132292322933229432295322963229732298322993230032301323023230332304323053230632307323083230932310323113231232313323143231532316323173231832319323203232132322323233232432325323263232732328323293233032331323323233332334323353233632337323383233932340323413234232343323443234532346323473234832349323503235132352323533235432355323563235732358323593236032361323623236332364323653236632367323683236932370323713237232373323743237532376323773237832379323803238132382323833238432385323863238732388323893239032391323923239332394323953239632397323983239932400324013240232403324043240532406324073240832409324103241132412324133241432415324163241732418324193242032421324223242332424324253242632427324283242932430324313243232433324343243532436324373243832439324403244132442324433244432445324463244732448324493245032451324523245332454324553245632457324583245932460324613246232463324643246532466324673246832469324703247132472324733247432475324763247732478324793248032481324823248332484324853248632487324883248932490324913249232493324943249532496324973249832499325003250132502325033250432505325063250732508325093251032511325123251332514325153251632517325183251932520325213252232523325243252532526325273252832529325303253132532325333253432535325363253732538325393254032541325423254332544325453254632547325483254932550325513255232553325543255532556325573255832559325603256132562325633256432565325663256732568325693257032571325723257332574325753257632577325783257932580325813258232583325843258532586325873258832589325903259132592325933259432595325963259732598325993260032601326023260332604326053260632607326083260932610326113261232613326143261532616326173261832619326203262132622326233262432625326263262732628326293263032631326323263332634326353263632637326383263932640326413264232643326443264532646326473264832649326503265132652326533265432655326563265732658326593266032661326623266332664326653266632667326683266932670326713267232673326743267532676326773267832679326803268132682326833268432685326863268732688326893269032691326923269332694326953269632697326983269932700327013270232703327043270532706327073270832709327103271132712327133271432715327163271732718327193272032721327223272332724327253272632727327283272932730327313273232733327343273532736327373273832739327403274132742327433274432745327463274732748327493275032751327523275332754327553275632757327583275932760327613276232763327643276532766327673276832769327703277132772327733277432775327763277732778327793278032781327823278332784327853278632787327883278932790327913279232793327943279532796327973279832799328003280132802328033280432805328063280732808328093281032811328123281332814328153281632817328183281932820328213282232823328243282532826328273282832829328303283132832328333283432835328363283732838328393284032841328423284332844328453284632847328483284932850328513285232853328543285532856328573285832859328603286132862328633286432865328663286732868328693287032871328723287332874328753287632877328783287932880328813288232883328843288532886328873288832889328903289132892328933289432895328963289732898328993290032901329023290332904329053290632907329083290932910329113291232913329143291532916329173291832919329203292132922329233292432925329263292732928329293293032931329323293332934329353293632937329383293932940329413294232943329443294532946329473294832949329503295132952329533295432955329563295732958329593296032961329623296332964329653296632967329683296932970329713297232973329743297532976329773297832979329803298132982329833298432985329863298732988329893299032991329923299332994329953299632997329983299933000330013300233003330043300533006330073300833009330103301133012330133301433015330163301733018330193302033021330223302333024330253302633027330283302933030330313303233033330343303533036330373303833039330403304133042330433304433045330463304733048330493305033051330523305333054330553305633057330583305933060330613306233063330643306533066330673306833069330703307133072330733307433075330763307733078330793308033081330823308333084330853308633087330883308933090330913309233093330943309533096330973309833099331003310133102331033310433105331063310733108331093311033111331123311333114331153311633117331183311933120331213312233123331243312533126331273312833129331303313133132331333313433135331363313733138331393314033141331423314333144331453314633147331483314933150331513315233153331543315533156331573315833159331603316133162331633316433165331663316733168331693317033171331723317333174331753317633177331783317933180331813318233183331843318533186331873318833189331903319133192331933319433195331963319733198331993320033201332023320333204332053320633207332083320933210332113321233213332143321533216332173321833219332203322133222332233322433225332263322733228332293323033231332323323333234332353323633237332383323933240332413324233243332443324533246332473324833249332503325133252332533325433255332563325733258332593326033261332623326333264332653326633267332683326933270332713327233273332743327533276332773327833279332803328133282332833328433285332863328733288332893329033291332923329333294332953329633297332983329933300333013330233303333043330533306333073330833309333103331133312333133331433315333163331733318333193332033321333223332333324333253332633327333283332933330333313333233333333343333533336333373333833339333403334133342333433334433345333463334733348333493335033351333523335333354333553335633357333583335933360333613336233363333643336533366333673336833369333703337133372333733337433375333763337733378333793338033381333823338333384333853338633387333883338933390333913339233393333943339533396333973339833399334003340133402334033340433405334063340733408334093341033411334123341333414334153341633417334183341933420334213342233423334243342533426334273342833429334303343133432334333343433435334363343733438334393344033441334423344333444334453344633447334483344933450334513345233453334543345533456334573345833459334603346133462334633346433465334663346733468334693347033471334723347333474334753347633477334783347933480334813348233483334843348533486334873348833489334903349133492334933349433495334963349733498334993350033501335023350333504335053350633507335083350933510335113351233513335143351533516335173351833519335203352133522335233352433525335263352733528335293353033531335323353333534335353353633537335383353933540335413354233543335443354533546335473354833549335503355133552335533355433555335563355733558335593356033561335623356333564335653356633567335683356933570335713357233573335743357533576335773357833579335803358133582335833358433585335863358733588335893359033591335923359333594335953359633597335983359933600336013360233603336043360533606336073360833609336103361133612336133361433615336163361733618336193362033621336223362333624336253362633627336283362933630336313363233633336343363533636336373363833639336403364133642336433364433645336463364733648336493365033651336523365333654336553365633657336583365933660336613366233663336643366533666336673366833669336703367133672336733367433675336763367733678336793368033681336823368333684336853368633687336883368933690336913369233693336943369533696336973369833699337003370133702337033370433705337063370733708337093371033711337123371333714337153371633717337183371933720337213372233723337243372533726337273372833729337303373133732337333373433735337363373733738337393374033741337423374333744337453374633747337483374933750337513375233753337543375533756337573375833759337603376133762337633376433765337663376733768337693377033771337723377333774337753377633777337783377933780337813378233783337843378533786337873378833789337903379133792337933379433795337963379733798337993380033801338023380333804338053380633807338083380933810338113381233813338143381533816338173381833819338203382133822338233382433825338263382733828338293383033831338323383333834338353383633837338383383933840338413384233843338443384533846338473384833849338503385133852338533385433855338563385733858338593386033861338623386333864338653386633867338683386933870338713387233873338743387533876338773387833879338803388133882338833388433885338863388733888338893389033891338923389333894338953389633897338983389933900339013390233903339043390533906339073390833909339103391133912339133391433915339163391733918339193392033921339223392333924339253392633927339283392933930339313393233933339343393533936339373393833939339403394133942339433394433945339463394733948339493395033951339523395333954339553395633957339583395933960339613396233963339643396533966339673396833969339703397133972339733397433975339763397733978339793398033981339823398333984339853398633987339883398933990339913399233993339943399533996339973399833999340003400134002340033400434005340063400734008340093401034011340123401334014340153401634017340183401934020340213402234023340243402534026340273402834029340303403134032340333403434035340363403734038340393404034041340423404334044340453404634047340483404934050340513405234053340543405534056340573405834059340603406134062340633406434065340663406734068340693407034071340723407334074340753407634077340783407934080340813408234083340843408534086340873408834089340903409134092340933409434095340963409734098340993410034101341023410334104341053410634107341083410934110341113411234113341143411534116341173411834119341203412134122341233412434125341263412734128341293413034131341323413334134341353413634137341383413934140341413414234143341443414534146341473414834149341503415134152341533415434155341563415734158341593416034161341623416334164341653416634167341683416934170341713417234173341743417534176341773417834179341803418134182341833418434185341863418734188341893419034191341923419334194341953419634197341983419934200342013420234203342043420534206342073420834209342103421134212342133421434215342163421734218342193422034221342223422334224342253422634227342283422934230342313423234233342343423534236342373423834239342403424134242342433424434245342463424734248342493425034251342523425334254342553425634257342583425934260342613426234263342643426534266342673426834269342703427134272342733427434275342763427734278342793428034281342823428334284342853428634287342883428934290342913429234293342943429534296342973429834299343003430134302343033430434305343063430734308343093431034311343123431334314343153431634317343183431934320343213432234323343243432534326343273432834329343303433134332343333433434335343363433734338343393434034341343423434334344343453434634347343483434934350343513435234353343543435534356343573435834359343603436134362343633436434365343663436734368343693437034371343723437334374343753437634377343783437934380343813438234383343843438534386343873438834389343903439134392343933439434395343963439734398343993440034401344023440334404344053440634407344083440934410344113441234413344143441534416344173441834419344203442134422344233442434425344263442734428344293443034431344323443334434344353443634437344383443934440344413444234443344443444534446344473444834449344503445134452344533445434455344563445734458344593446034461344623446334464344653446634467344683446934470344713447234473344743447534476344773447834479344803448134482344833448434485344863448734488344893449034491344923449334494344953449634497344983449934500345013450234503345043450534506345073450834509345103451134512345133451434515345163451734518345193452034521345223452334524345253452634527345283452934530345313453234533345343453534536345373453834539345403454134542345433454434545345463454734548345493455034551345523455334554345553455634557345583455934560345613456234563345643456534566345673456834569345703457134572345733457434575345763457734578345793458034581345823458334584345853458634587345883458934590345913459234593345943459534596345973459834599346003460134602346033460434605346063460734608346093461034611346123461334614346153461634617346183461934620346213462234623346243462534626346273462834629346303463134632346333463434635346363463734638346393464034641346423464334644346453464634647346483464934650346513465234653346543465534656346573465834659346603466134662346633466434665346663466734668346693467034671346723467334674346753467634677346783467934680346813468234683346843468534686346873468834689346903469134692346933469434695346963469734698346993470034701347023470334704347053470634707347083470934710347113471234713347143471534716347173471834719347203472134722347233472434725347263472734728347293473034731347323473334734347353473634737347383473934740347413474234743347443474534746347473474834749347503475134752347533475434755347563475734758347593476034761347623476334764347653476634767347683476934770347713477234773347743477534776347773477834779347803478134782347833478434785347863478734788347893479034791347923479334794347953479634797347983479934800348013480234803348043480534806348073480834809348103481134812348133481434815348163481734818348193482034821348223482334824348253482634827348283482934830348313483234833348343483534836348373483834839348403484134842348433484434845348463484734848348493485034851348523485334854348553485634857348583485934860348613486234863348643486534866348673486834869348703487134872348733487434875348763487734878348793488034881348823488334884348853488634887348883488934890348913489234893348943489534896348973489834899349003490134902349033490434905349063490734908349093491034911349123491334914349153491634917349183491934920349213492234923349243492534926349273492834929349303493134932349333493434935349363493734938349393494034941349423494334944349453494634947349483494934950349513495234953349543495534956349573495834959349603496134962349633496434965349663496734968349693497034971349723497334974349753497634977349783497934980349813498234983349843498534986349873498834989349903499134992349933499434995349963499734998349993500035001350023500335004350053500635007350083500935010350113501235013350143501535016350173501835019350203502135022350233502435025350263502735028350293503035031350323503335034350353503635037350383503935040350413504235043350443504535046350473504835049350503505135052350533505435055350563505735058350593506035061350623506335064350653506635067350683506935070350713507235073350743507535076350773507835079350803508135082350833508435085350863508735088350893509035091350923509335094350953509635097350983509935100351013510235103351043510535106351073510835109351103511135112351133511435115351163511735118351193512035121351223512335124351253512635127351283512935130351313513235133351343513535136351373513835139351403514135142351433514435145351463514735148351493515035151351523515335154351553515635157351583515935160351613516235163351643516535166351673516835169351703517135172351733517435175351763517735178351793518035181351823518335184351853518635187351883518935190351913519235193351943519535196351973519835199352003520135202352033520435205352063520735208352093521035211352123521335214352153521635217352183521935220352213522235223352243522535226352273522835229352303523135232352333523435235352363523735238352393524035241352423524335244352453524635247352483524935250352513525235253352543525535256352573525835259352603526135262352633526435265352663526735268352693527035271352723527335274352753527635277352783527935280352813528235283352843528535286352873528835289352903529135292352933529435295352963529735298352993530035301353023530335304353053530635307353083530935310353113531235313353143531535316353173531835319353203532135322353233532435325353263532735328353293533035331353323533335334353353533635337353383533935340353413534235343353443534535346353473534835349353503535135352353533535435355353563535735358353593536035361353623536335364353653536635367353683536935370353713537235373353743537535376353773537835379353803538135382353833538435385353863538735388353893539035391353923539335394353953539635397353983539935400354013540235403354043540535406354073540835409354103541135412354133541435415354163541735418354193542035421354223542335424354253542635427354283542935430354313543235433354343543535436354373543835439354403544135442354433544435445354463544735448354493545035451354523545335454354553545635457354583545935460354613546235463354643546535466354673546835469354703547135472354733547435475354763547735478354793548035481354823548335484354853548635487354883548935490354913549235493354943549535496354973549835499355003550135502355033550435505355063550735508355093551035511355123551335514355153551635517355183551935520355213552235523355243552535526355273552835529355303553135532355333553435535355363553735538355393554035541355423554335544355453554635547355483554935550355513555235553355543555535556355573555835559355603556135562355633556435565355663556735568355693557035571355723557335574355753557635577355783557935580355813558235583355843558535586355873558835589355903559135592355933559435595355963559735598355993560035601356023560335604356053560635607356083560935610356113561235613356143561535616356173561835619356203562135622356233562435625356263562735628356293563035631356323563335634356353563635637356383563935640356413564235643356443564535646356473564835649356503565135652356533565435655356563565735658356593566035661356623566335664356653566635667356683566935670356713567235673356743567535676356773567835679356803568135682356833568435685356863568735688356893569035691356923569335694356953569635697356983569935700357013570235703357043570535706357073570835709357103571135712357133571435715357163571735718357193572035721357223572335724357253572635727357283572935730357313573235733357343573535736357373573835739357403574135742357433574435745357463574735748357493575035751357523575335754357553575635757357583575935760357613576235763357643576535766357673576835769357703577135772357733577435775357763577735778357793578035781357823578335784357853578635787357883578935790357913579235793357943579535796357973579835799358003580135802358033580435805358063580735808358093581035811358123581335814358153581635817358183581935820358213582235823358243582535826358273582835829358303583135832358333583435835358363583735838358393584035841358423584335844358453584635847358483584935850358513585235853358543585535856358573585835859358603586135862358633586435865358663586735868358693587035871358723587335874358753587635877358783587935880358813588235883358843588535886358873588835889358903589135892358933589435895358963589735898358993590035901359023590335904359053590635907359083590935910359113591235913359143591535916359173591835919359203592135922359233592435925359263592735928359293593035931359323593335934359353593635937359383593935940359413594235943359443594535946359473594835949359503595135952359533595435955359563595735958359593596035961359623596335964359653596635967359683596935970359713597235973359743597535976359773597835979359803598135982359833598435985359863598735988359893599035991359923599335994359953599635997359983599936000360013600236003360043600536006360073600836009360103601136012360133601436015360163601736018360193602036021360223602336024360253602636027360283602936030360313603236033360343603536036360373603836039360403604136042360433604436045360463604736048360493605036051360523605336054360553605636057360583605936060360613606236063360643606536066360673606836069360703607136072360733607436075360763607736078360793608036081360823608336084360853608636087360883608936090360913609236093360943609536096360973609836099361003610136102361033610436105361063610736108361093611036111361123611336114361153611636117361183611936120361213612236123361243612536126361273612836129361303613136132361333613436135361363613736138361393614036141361423614336144361453614636147361483614936150361513615236153361543615536156361573615836159361603616136162361633616436165361663616736168361693617036171361723617336174361753617636177361783617936180361813618236183361843618536186361873618836189361903619136192361933619436195361963619736198361993620036201362023620336204362053620636207362083620936210362113621236213362143621536216362173621836219362203622136222362233622436225362263622736228362293623036231362323623336234362353623636237362383623936240362413624236243362443624536246362473624836249362503625136252362533625436255362563625736258362593626036261362623626336264362653626636267362683626936270362713627236273362743627536276362773627836279362803628136282362833628436285362863628736288362893629036291362923629336294362953629636297362983629936300363013630236303363043630536306363073630836309363103631136312363133631436315363163631736318363193632036321363223632336324363253632636327363283632936330363313633236333363343633536336363373633836339363403634136342363433634436345363463634736348363493635036351363523635336354363553635636357363583635936360363613636236363363643636536366363673636836369363703637136372363733637436375363763637736378363793638036381363823638336384363853638636387363883638936390363913639236393363943639536396363973639836399364003640136402364033640436405364063640736408364093641036411364123641336414364153641636417364183641936420364213642236423364243642536426364273642836429364303643136432364333643436435364363643736438364393644036441364423644336444364453644636447364483644936450364513645236453364543645536456364573645836459364603646136462364633646436465364663646736468364693647036471364723647336474364753647636477364783647936480364813648236483364843648536486364873648836489364903649136492364933649436495364963649736498364993650036501365023650336504365053650636507365083650936510365113651236513365143651536516365173651836519365203652136522365233652436525365263652736528365293653036531365323653336534365353653636537365383653936540365413654236543365443654536546365473654836549365503655136552365533655436555365563655736558365593656036561365623656336564365653656636567365683656936570365713657236573365743657536576365773657836579365803658136582365833658436585365863658736588365893659036591365923659336594365953659636597365983659936600366013660236603366043660536606366073660836609366103661136612366133661436615366163661736618366193662036621366223662336624366253662636627366283662936630366313663236633366343663536636366373663836639366403664136642366433664436645366463664736648366493665036651366523665336654366553665636657366583665936660366613666236663366643666536666366673666836669366703667136672366733667436675366763667736678366793668036681366823668336684366853668636687366883668936690366913669236693366943669536696366973669836699367003670136702367033670436705367063670736708367093671036711367123671336714367153671636717367183671936720367213672236723367243672536726367273672836729367303673136732367333673436735367363673736738367393674036741367423674336744367453674636747367483674936750367513675236753367543675536756367573675836759367603676136762367633676436765367663676736768367693677036771367723677336774367753677636777367783677936780367813678236783367843678536786367873678836789367903679136792367933679436795367963679736798367993680036801368023680336804368053680636807368083680936810368113681236813368143681536816368173681836819368203682136822368233682436825368263682736828368293683036831368323683336834368353683636837368383683936840368413684236843368443684536846368473684836849368503685136852368533685436855368563685736858368593686036861368623686336864368653686636867368683686936870368713687236873368743687536876368773687836879368803688136882368833688436885368863688736888368893689036891368923689336894368953689636897368983689936900369013690236903369043690536906369073690836909369103691136912369133691436915369163691736918369193692036921369223692336924369253692636927369283692936930369313693236933369343693536936369373693836939369403694136942369433694436945369463694736948369493695036951369523695336954369553695636957369583695936960369613696236963369643696536966369673696836969369703697136972369733697436975369763697736978369793698036981369823698336984369853698636987369883698936990369913699236993369943699536996369973699836999370003700137002370033700437005370063700737008370093701037011370123701337014370153701637017370183701937020370213702237023370243702537026370273702837029370303703137032370333703437035370363703737038370393704037041370423704337044370453704637047370483704937050370513705237053370543705537056370573705837059370603706137062370633706437065370663706737068370693707037071370723707337074370753707637077370783707937080370813708237083370843708537086370873708837089370903709137092370933709437095370963709737098370993710037101371023710337104371053710637107371083710937110371113711237113371143711537116371173711837119371203712137122371233712437125371263712737128371293713037131371323713337134371353713637137371383713937140371413714237143371443714537146371473714837149371503715137152371533715437155371563715737158371593716037161371623716337164371653716637167371683716937170371713717237173371743717537176371773717837179371803718137182371833718437185371863718737188371893719037191371923719337194371953719637197371983719937200372013720237203372043720537206372073720837209372103721137212372133721437215372163721737218372193722037221372223722337224372253722637227372283722937230372313723237233372343723537236372373723837239372403724137242372433724437245372463724737248372493725037251372523725337254372553725637257372583725937260372613726237263372643726537266372673726837269372703727137272372733727437275372763727737278372793728037281372823728337284372853728637287372883728937290372913729237293372943729537296372973729837299373003730137302373033730437305373063730737308373093731037311373123731337314373153731637317373183731937320373213732237323373243732537326373273732837329373303733137332373333733437335373363733737338373393734037341373423734337344373453734637347373483734937350373513735237353373543735537356373573735837359373603736137362373633736437365373663736737368373693737037371373723737337374373753737637377373783737937380373813738237383373843738537386373873738837389373903739137392373933739437395373963739737398373993740037401374023740337404374053740637407374083740937410374113741237413374143741537416374173741837419374203742137422374233742437425374263742737428374293743037431374323743337434374353743637437374383743937440374413744237443374443744537446374473744837449374503745137452374533745437455374563745737458374593746037461374623746337464374653746637467374683746937470374713747237473374743747537476374773747837479374803748137482374833748437485374863748737488374893749037491374923749337494374953749637497374983749937500375013750237503375043750537506375073750837509375103751137512375133751437515375163751737518375193752037521375223752337524375253752637527375283752937530375313753237533375343753537536375373753837539375403754137542375433754437545375463754737548375493755037551375523755337554375553755637557375583755937560375613756237563375643756537566375673756837569375703757137572375733757437575375763757737578375793758037581375823758337584375853758637587375883758937590375913759237593375943759537596375973759837599376003760137602376033760437605376063760737608376093761037611376123761337614376153761637617376183761937620376213762237623376243762537626376273762837629376303763137632376333763437635376363763737638376393764037641376423764337644376453764637647376483764937650376513765237653376543765537656376573765837659376603766137662376633766437665376663766737668376693767037671376723767337674376753767637677376783767937680376813768237683376843768537686376873768837689376903769137692376933769437695376963769737698376993770037701377023770337704377053770637707377083770937710377113771237713377143771537716377173771837719377203772137722377233772437725377263772737728377293773037731377323773337734377353773637737377383773937740377413774237743377443774537746377473774837749377503775137752377533775437755377563775737758377593776037761377623776337764377653776637767377683776937770377713777237773377743777537776377773777837779377803778137782377833778437785377863778737788377893779037791377923779337794377953779637797377983779937800378013780237803378043780537806378073780837809378103781137812378133781437815378163781737818378193782037821378223782337824378253782637827378283782937830378313783237833378343783537836378373783837839378403784137842378433784437845378463784737848378493785037851378523785337854378553785637857378583785937860378613786237863378643786537866378673786837869378703787137872378733787437875378763787737878378793788037881378823788337884378853788637887378883788937890378913789237893378943789537896378973789837899379003790137902379033790437905379063790737908379093791037911379123791337914379153791637917379183791937920379213792237923379243792537926379273792837929379303793137932379333793437935379363793737938379393794037941379423794337944379453794637947379483794937950379513795237953379543795537956379573795837959379603796137962379633796437965379663796737968379693797037971379723797337974379753797637977379783797937980379813798237983379843798537986379873798837989379903799137992379933799437995379963799737998379993800038001380023800338004380053800638007380083800938010380113801238013380143801538016380173801838019380203802138022380233802438025380263802738028380293803038031380323803338034380353803638037380383803938040380413804238043380443804538046380473804838049380503805138052380533805438055380563805738058380593806038061380623806338064380653806638067380683806938070380713807238073380743807538076380773807838079380803808138082380833808438085380863808738088380893809038091380923809338094380953809638097380983809938100381013810238103381043810538106381073810838109381103811138112381133811438115381163811738118381193812038121381223812338124381253812638127381283812938130381313813238133381343813538136381373813838139381403814138142381433814438145381463814738148381493815038151381523815338154381553815638157381583815938160381613816238163381643816538166381673816838169381703817138172381733817438175381763817738178381793818038181381823818338184381853818638187381883818938190381913819238193381943819538196381973819838199382003820138202382033820438205382063820738208382093821038211382123821338214382153821638217382183821938220382213822238223382243822538226382273822838229382303823138232382333823438235382363823738238382393824038241382423824338244382453824638247382483824938250382513825238253382543825538256382573825838259382603826138262382633826438265382663826738268382693827038271382723827338274382753827638277382783827938280382813828238283382843828538286382873828838289382903829138292382933829438295382963829738298382993830038301383023830338304383053830638307383083830938310383113831238313383143831538316383173831838319383203832138322383233832438325383263832738328383293833038331383323833338334383353833638337383383833938340383413834238343383443834538346383473834838349383503835138352383533835438355383563835738358383593836038361383623836338364383653836638367383683836938370383713837238373383743837538376383773837838379383803838138382383833838438385383863838738388383893839038391383923839338394383953839638397383983839938400384013840238403384043840538406384073840838409384103841138412384133841438415384163841738418384193842038421384223842338424384253842638427384283842938430384313843238433384343843538436384373843838439384403844138442384433844438445384463844738448384493845038451384523845338454384553845638457384583845938460384613846238463384643846538466384673846838469384703847138472384733847438475384763847738478384793848038481384823848338484384853848638487384883848938490384913849238493384943849538496384973849838499385003850138502385033850438505385063850738508385093851038511385123851338514385153851638517385183851938520385213852238523385243852538526385273852838529385303853138532385333853438535385363853738538385393854038541385423854338544385453854638547385483854938550385513855238553385543855538556385573855838559385603856138562385633856438565385663856738568385693857038571385723857338574385753857638577385783857938580385813858238583385843858538586385873858838589385903859138592385933859438595385963859738598385993860038601386023860338604386053860638607386083860938610386113861238613386143861538616386173861838619386203862138622386233862438625386263862738628386293863038631386323863338634386353863638637386383863938640386413864238643386443864538646386473864838649386503865138652386533865438655386563865738658386593866038661386623866338664386653866638667386683866938670386713867238673386743867538676386773867838679386803868138682386833868438685386863868738688386893869038691386923869338694386953869638697386983869938700387013870238703387043870538706387073870838709387103871138712387133871438715387163871738718387193872038721387223872338724387253872638727387283872938730387313873238733387343873538736387373873838739387403874138742387433874438745387463874738748387493875038751387523875338754387553875638757387583875938760387613876238763387643876538766387673876838769387703877138772387733877438775387763877738778387793878038781387823878338784387853878638787387883878938790387913879238793387943879538796387973879838799388003880138802388033880438805388063880738808388093881038811388123881338814388153881638817388183881938820388213882238823388243882538826388273882838829388303883138832388333883438835388363883738838388393884038841388423884338844388453884638847388483884938850388513885238853388543885538856388573885838859388603886138862388633886438865388663886738868388693887038871388723887338874388753887638877388783887938880388813888238883388843888538886388873888838889388903889138892388933889438895388963889738898388993890038901389023890338904389053890638907389083890938910389113891238913389143891538916389173891838919389203892138922389233892438925389263892738928389293893038931389323893338934389353893638937389383893938940389413894238943389443894538946389473894838949389503895138952389533895438955389563895738958389593896038961389623896338964389653896638967389683896938970389713897238973389743897538976389773897838979389803898138982389833898438985389863898738988389893899038991389923899338994389953899638997389983899939000390013900239003390043900539006390073900839009390103901139012390133901439015390163901739018390193902039021390223902339024390253902639027390283902939030390313903239033390343903539036390373903839039390403904139042390433904439045390463904739048390493905039051390523905339054390553905639057390583905939060390613906239063390643906539066390673906839069390703907139072390733907439075390763907739078390793908039081390823908339084390853908639087390883908939090390913909239093390943909539096390973909839099391003910139102391033910439105391063910739108391093911039111391123911339114391153911639117391183911939120391213912239123391243912539126391273912839129391303913139132391333913439135391363913739138391393914039141391423914339144391453914639147391483914939150391513915239153391543915539156391573915839159391603916139162391633916439165391663916739168391693917039171391723917339174391753917639177391783917939180391813918239183391843918539186391873918839189391903919139192391933919439195391963919739198391993920039201392023920339204392053920639207392083920939210392113921239213392143921539216392173921839219392203922139222392233922439225392263922739228392293923039231392323923339234392353923639237392383923939240392413924239243392443924539246392473924839249392503925139252392533925439255392563925739258392593926039261392623926339264392653926639267392683926939270392713927239273392743927539276392773927839279392803928139282392833928439285392863928739288392893929039291392923929339294392953929639297392983929939300393013930239303393043930539306393073930839309393103931139312393133931439315393163931739318393193932039321393223932339324393253932639327393283932939330393313933239333393343933539336393373933839339393403934139342393433934439345393463934739348393493935039351393523935339354393553935639357393583935939360393613936239363393643936539366393673936839369393703937139372393733937439375393763937739378393793938039381393823938339384393853938639387393883938939390393913939239393393943939539396393973939839399394003940139402394033940439405394063940739408394093941039411394123941339414394153941639417394183941939420394213942239423394243942539426394273942839429394303943139432394333943439435394363943739438394393944039441394423944339444394453944639447394483944939450394513945239453394543945539456394573945839459394603946139462394633946439465394663946739468394693947039471394723947339474394753947639477394783947939480394813948239483394843948539486394873948839489394903949139492394933949439495394963949739498394993950039501395023950339504395053950639507395083950939510395113951239513395143951539516395173951839519395203952139522395233952439525395263952739528395293953039531395323953339534395353953639537395383953939540395413954239543395443954539546395473954839549395503955139552395533955439555395563955739558395593956039561395623956339564395653956639567395683956939570395713957239573395743957539576395773957839579395803958139582395833958439585395863958739588395893959039591395923959339594395953959639597395983959939600396013960239603396043960539606396073960839609396103961139612396133961439615396163961739618396193962039621396223962339624396253962639627396283962939630396313963239633396343963539636396373963839639396403964139642396433964439645396463964739648396493965039651396523965339654396553965639657396583965939660396613966239663396643966539666396673966839669396703967139672396733967439675396763967739678396793968039681396823968339684396853968639687396883968939690396913969239693396943969539696396973969839699397003970139702397033970439705397063970739708397093971039711397123971339714397153971639717397183971939720397213972239723397243972539726397273972839729397303973139732397333973439735397363973739738397393974039741397423974339744397453974639747397483974939750397513975239753397543975539756397573975839759397603976139762397633976439765397663976739768397693977039771397723977339774397753977639777397783977939780397813978239783397843978539786397873978839789397903979139792397933979439795397963979739798397993980039801398023980339804398053980639807398083980939810398113981239813398143981539816398173981839819398203982139822398233982439825398263982739828398293983039831398323983339834398353983639837398383983939840398413984239843398443984539846398473984839849398503985139852398533985439855398563985739858398593986039861398623986339864398653986639867398683986939870398713987239873398743987539876398773987839879398803988139882398833988439885398863988739888398893989039891398923989339894398953989639897398983989939900399013990239903399043990539906399073990839909399103991139912399133991439915399163991739918399193992039921399223992339924399253992639927399283992939930399313993239933399343993539936399373993839939399403994139942399433994439945399463994739948399493995039951399523995339954399553995639957399583995939960399613996239963399643996539966399673996839969399703997139972399733997439975399763997739978399793998039981399823998339984399853998639987399883998939990399913999239993399943999539996399973999839999400004000140002400034000440005400064000740008400094001040011400124001340014400154001640017400184001940020400214002240023400244002540026400274002840029400304003140032400334003440035400364003740038400394004040041400424004340044400454004640047400484004940050400514005240053400544005540056400574005840059400604006140062400634006440065400664006740068400694007040071400724007340074400754007640077400784007940080400814008240083400844008540086400874008840089400904009140092400934009440095400964009740098400994010040101401024010340104401054010640107401084010940110401114011240113401144011540116401174011840119401204012140122401234012440125401264012740128401294013040131401324013340134401354013640137401384013940140401414014240143401444014540146401474014840149401504015140152401534015440155401564015740158401594016040161401624016340164401654016640167401684016940170401714017240173401744017540176401774017840179401804018140182401834018440185401864018740188401894019040191401924019340194401954019640197401984019940200402014020240203402044020540206402074020840209402104021140212402134021440215402164021740218402194022040221402224022340224402254022640227402284022940230402314023240233402344023540236402374023840239402404024140242402434024440245402464024740248402494025040251402524025340254402554025640257402584025940260402614026240263402644026540266402674026840269402704027140272402734027440275402764027740278402794028040281402824028340284402854028640287402884028940290402914029240293402944029540296402974029840299403004030140302403034030440305403064030740308403094031040311403124031340314403154031640317403184031940320403214032240323403244032540326403274032840329403304033140332403334033440335403364033740338403394034040341403424034340344403454034640347403484034940350403514035240353403544035540356403574035840359403604036140362403634036440365403664036740368403694037040371403724037340374403754037640377403784037940380403814038240383403844038540386403874038840389403904039140392403934039440395403964039740398403994040040401404024040340404404054040640407404084040940410404114041240413404144041540416404174041840419404204042140422404234042440425404264042740428404294043040431404324043340434404354043640437404384043940440404414044240443404444044540446404474044840449404504045140452404534045440455404564045740458404594046040461404624046340464404654046640467404684046940470404714047240473404744047540476404774047840479404804048140482404834048440485404864048740488404894049040491404924049340494404954049640497404984049940500405014050240503405044050540506405074050840509405104051140512405134051440515405164051740518405194052040521405224052340524405254052640527405284052940530405314053240533405344053540536405374053840539405404054140542405434054440545405464054740548405494055040551405524055340554405554055640557405584055940560405614056240563405644056540566405674056840569405704057140572405734057440575405764057740578405794058040581405824058340584405854058640587405884058940590405914059240593405944059540596405974059840599406004060140602406034060440605406064060740608406094061040611406124061340614406154061640617406184061940620406214062240623406244062540626406274062840629406304063140632406334063440635406364063740638406394064040641406424064340644406454064640647406484064940650406514065240653406544065540656406574065840659406604066140662406634066440665406664066740668406694067040671406724067340674406754067640677406784067940680406814068240683406844068540686406874068840689406904069140692406934069440695406964069740698406994070040701407024070340704407054070640707407084070940710407114071240713407144071540716407174071840719407204072140722407234072440725407264072740728407294073040731407324073340734407354073640737407384073940740407414074240743407444074540746407474074840749407504075140752407534075440755407564075740758407594076040761407624076340764407654076640767407684076940770407714077240773407744077540776407774077840779407804078140782407834078440785407864078740788407894079040791407924079340794407954079640797407984079940800408014080240803408044080540806408074080840809408104081140812408134081440815408164081740818408194082040821408224082340824408254082640827408284082940830408314083240833408344083540836408374083840839408404084140842408434084440845408464084740848408494085040851408524085340854408554085640857408584085940860408614086240863408644086540866408674086840869408704087140872408734087440875408764087740878408794088040881408824088340884408854088640887408884088940890408914089240893408944089540896408974089840899409004090140902409034090440905409064090740908409094091040911409124091340914409154091640917409184091940920409214092240923409244092540926409274092840929409304093140932409334093440935409364093740938409394094040941409424094340944409454094640947409484094940950409514095240953409544095540956409574095840959409604096140962409634096440965409664096740968409694097040971409724097340974409754097640977409784097940980409814098240983409844098540986409874098840989409904099140992409934099440995409964099740998409994100041001410024100341004410054100641007410084100941010410114101241013410144101541016410174101841019410204102141022410234102441025410264102741028410294103041031410324103341034410354103641037410384103941040410414104241043410444104541046410474104841049410504105141052410534105441055410564105741058410594106041061410624106341064410654106641067410684106941070410714107241073410744107541076410774107841079410804108141082410834108441085410864108741088410894109041091410924109341094410954109641097410984109941100411014110241103411044110541106411074110841109411104111141112411134111441115411164111741118411194112041121411224112341124411254112641127411284112941130411314113241133411344113541136411374113841139411404114141142411434114441145411464114741148411494115041151411524115341154411554115641157411584115941160411614116241163411644116541166411674116841169411704117141172411734117441175411764117741178411794118041181411824118341184411854118641187411884118941190411914119241193411944119541196411974119841199412004120141202412034120441205412064120741208412094121041211412124121341214412154121641217412184121941220412214122241223412244122541226412274122841229412304123141232412334123441235412364123741238412394124041241412424124341244412454124641247412484124941250412514125241253412544125541256412574125841259412604126141262412634126441265412664126741268412694127041271412724127341274412754127641277412784127941280412814128241283412844128541286412874128841289412904129141292412934129441295412964129741298412994130041301413024130341304413054130641307413084130941310413114131241313413144131541316413174131841319413204132141322413234132441325413264132741328413294133041331413324133341334413354133641337413384133941340413414134241343413444134541346413474134841349413504135141352413534135441355413564135741358413594136041361413624136341364413654136641367413684136941370413714137241373413744137541376413774137841379413804138141382413834138441385413864138741388413894139041391413924139341394413954139641397413984139941400414014140241403414044140541406414074140841409414104141141412414134141441415414164141741418414194142041421414224142341424414254142641427414284142941430414314143241433414344143541436414374143841439414404144141442414434144441445414464144741448414494145041451414524145341454414554145641457414584145941460414614146241463414644146541466414674146841469414704147141472414734147441475414764147741478414794148041481414824148341484414854148641487414884148941490414914149241493414944149541496414974149841499415004150141502415034150441505415064150741508415094151041511415124151341514415154151641517415184151941520415214152241523415244152541526415274152841529415304153141532415334153441535415364153741538415394154041541415424154341544415454154641547415484154941550415514155241553415544155541556415574155841559415604156141562415634156441565415664156741568415694157041571415724157341574415754157641577415784157941580415814158241583415844158541586415874158841589415904159141592415934159441595415964159741598415994160041601416024160341604416054160641607416084160941610416114161241613416144161541616416174161841619416204162141622416234162441625416264162741628416294163041631416324163341634416354163641637416384163941640416414164241643416444164541646416474164841649416504165141652416534165441655416564165741658416594166041661416624166341664416654166641667416684166941670416714167241673416744167541676416774167841679416804168141682416834168441685416864168741688416894169041691416924169341694416954169641697416984169941700417014170241703417044170541706417074170841709417104171141712417134171441715417164171741718417194172041721417224172341724417254172641727417284172941730417314173241733417344173541736417374173841739417404174141742417434174441745417464174741748417494175041751417524175341754417554175641757417584175941760417614176241763417644176541766417674176841769417704177141772417734177441775417764177741778417794178041781417824178341784417854178641787417884178941790417914179241793417944179541796417974179841799418004180141802418034180441805418064180741808418094181041811418124181341814418154181641817418184181941820418214182241823418244182541826418274182841829418304183141832418334183441835418364183741838418394184041841418424184341844418454184641847418484184941850418514185241853418544185541856418574185841859418604186141862418634186441865418664186741868418694187041871418724187341874418754187641877418784187941880418814188241883418844188541886418874188841889418904189141892418934189441895418964189741898418994190041901419024190341904419054190641907419084190941910419114191241913419144191541916419174191841919419204192141922419234192441925419264192741928419294193041931419324193341934419354193641937419384193941940419414194241943419444194541946419474194841949419504195141952419534195441955419564195741958419594196041961419624196341964419654196641967419684196941970419714197241973419744197541976419774197841979419804198141982419834198441985419864198741988419894199041991419924199341994419954199641997419984199942000420014200242003420044200542006420074200842009420104201142012420134201442015420164201742018420194202042021420224202342024420254202642027420284202942030420314203242033420344203542036420374203842039420404204142042420434204442045420464204742048420494205042051420524205342054420554205642057420584205942060420614206242063420644206542066420674206842069420704207142072420734207442075420764207742078420794208042081420824208342084420854208642087420884208942090420914209242093420944209542096420974209842099421004210142102421034210442105421064210742108421094211042111421124211342114421154211642117421184211942120421214212242123421244212542126421274212842129421304213142132421334213442135421364213742138421394214042141421424214342144421454214642147421484214942150421514215242153421544215542156421574215842159421604216142162421634216442165421664216742168421694217042171421724217342174421754217642177421784217942180421814218242183421844218542186421874218842189421904219142192421934219442195421964219742198421994220042201422024220342204422054220642207422084220942210422114221242213422144221542216422174221842219422204222142222422234222442225422264222742228422294223042231422324223342234422354223642237422384223942240422414224242243422444224542246422474224842249422504225142252422534225442255422564225742258422594226042261422624226342264422654226642267422684226942270422714227242273422744227542276422774227842279422804228142282422834228442285422864228742288422894229042291422924229342294422954229642297422984229942300423014230242303423044230542306423074230842309423104231142312423134231442315423164231742318423194232042321423224232342324423254232642327423284232942330423314233242333423344233542336423374233842339423404234142342423434234442345423464234742348423494235042351423524235342354423554235642357423584235942360423614236242363423644236542366423674236842369423704237142372423734237442375423764237742378423794238042381423824238342384423854238642387423884238942390423914239242393423944239542396423974239842399424004240142402424034240442405424064240742408424094241042411424124241342414424154241642417424184241942420424214242242423424244242542426424274242842429424304243142432424334243442435424364243742438424394244042441424424244342444424454244642447424484244942450424514245242453424544245542456424574245842459424604246142462424634246442465424664246742468424694247042471424724247342474424754247642477424784247942480424814248242483424844248542486424874248842489424904249142492424934249442495424964249742498424994250042501425024250342504425054250642507425084250942510425114251242513425144251542516425174251842519425204252142522425234252442525425264252742528425294253042531425324253342534425354253642537425384253942540425414254242543425444254542546425474254842549425504255142552425534255442555425564255742558425594256042561425624256342564425654256642567425684256942570425714257242573425744257542576425774257842579425804258142582425834258442585425864258742588425894259042591425924259342594425954259642597425984259942600426014260242603426044260542606426074260842609426104261142612426134261442615426164261742618426194262042621426224262342624426254262642627426284262942630426314263242633426344263542636426374263842639426404264142642426434264442645426464264742648426494265042651426524265342654426554265642657426584265942660426614266242663426644266542666426674266842669426704267142672426734267442675426764267742678426794268042681426824268342684426854268642687426884268942690426914269242693426944269542696426974269842699427004270142702427034270442705427064270742708427094271042711427124271342714427154271642717427184271942720427214272242723427244272542726427274272842729427304273142732427334273442735427364273742738427394274042741427424274342744427454274642747427484274942750427514275242753427544275542756427574275842759427604276142762427634276442765427664276742768427694277042771427724277342774427754277642777427784277942780427814278242783427844278542786427874278842789427904279142792427934279442795427964279742798427994280042801428024280342804428054280642807428084280942810428114281242813428144281542816428174281842819428204282142822428234282442825428264282742828428294283042831428324283342834428354283642837428384283942840428414284242843428444284542846428474284842849428504285142852428534285442855428564285742858428594286042861428624286342864428654286642867428684286942870428714287242873428744287542876428774287842879428804288142882428834288442885428864288742888428894289042891428924289342894428954289642897428984289942900429014290242903429044290542906429074290842909429104291142912429134291442915429164291742918429194292042921429224292342924429254292642927429284292942930429314293242933429344293542936429374293842939429404294142942429434294442945429464294742948429494295042951429524295342954429554295642957429584295942960429614296242963429644296542966429674296842969429704297142972429734297442975429764297742978429794298042981429824298342984429854298642987429884298942990429914299242993429944299542996429974299842999430004300143002430034300443005430064300743008430094301043011430124301343014430154301643017430184301943020430214302243023430244302543026430274302843029430304303143032430334303443035430364303743038430394304043041430424304343044430454304643047430484304943050430514305243053430544305543056430574305843059430604306143062430634306443065430664306743068430694307043071430724307343074430754307643077430784307943080430814308243083430844308543086430874308843089430904309143092430934309443095430964309743098430994310043101431024310343104431054310643107431084310943110431114311243113431144311543116431174311843119431204312143122431234312443125431264312743128431294313043131431324313343134431354313643137431384313943140431414314243143431444314543146431474314843149431504315143152431534315443155431564315743158431594316043161431624316343164431654316643167431684316943170431714317243173431744317543176431774317843179431804318143182431834318443185431864318743188431894319043191431924319343194431954319643197431984319943200432014320243203432044320543206432074320843209432104321143212432134321443215432164321743218432194322043221432224322343224432254322643227432284322943230432314323243233432344323543236432374323843239432404324143242432434324443245432464324743248432494325043251432524325343254432554325643257432584325943260432614326243263432644326543266432674326843269432704327143272432734327443275432764327743278432794328043281432824328343284432854328643287432884328943290432914329243293432944329543296432974329843299433004330143302433034330443305433064330743308433094331043311433124331343314433154331643317433184331943320433214332243323433244332543326433274332843329433304333143332433334333443335433364333743338433394334043341433424334343344433454334643347433484334943350433514335243353433544335543356433574335843359433604336143362433634336443365433664336743368433694337043371433724337343374433754337643377433784337943380433814338243383433844338543386433874338843389433904339143392433934339443395433964339743398433994340043401434024340343404434054340643407434084340943410434114341243413434144341543416434174341843419434204342143422434234342443425434264342743428434294343043431434324343343434434354343643437434384343943440434414344243443434444344543446434474344843449434504345143452434534345443455434564345743458434594346043461434624346343464434654346643467434684346943470434714347243473434744347543476434774347843479434804348143482434834348443485434864348743488434894349043491434924349343494434954349643497434984349943500435014350243503435044350543506435074350843509435104351143512435134351443515435164351743518435194352043521435224352343524435254352643527435284352943530435314353243533435344353543536435374353843539435404354143542435434354443545435464354743548435494355043551435524355343554435554355643557435584355943560435614356243563435644356543566435674356843569435704357143572435734357443575435764357743578435794358043581435824358343584435854358643587435884358943590435914359243593435944359543596435974359843599436004360143602436034360443605436064360743608436094361043611436124361343614436154361643617436184361943620436214362243623436244362543626436274362843629436304363143632436334363443635436364363743638436394364043641436424364343644436454364643647436484364943650436514365243653436544365543656436574365843659436604366143662436634366443665436664366743668436694367043671436724367343674436754367643677436784367943680436814368243683436844368543686436874368843689436904369143692436934369443695436964369743698436994370043701437024370343704437054370643707437084370943710437114371243713437144371543716437174371843719437204372143722437234372443725437264372743728437294373043731437324373343734437354373643737437384373943740437414374243743437444374543746437474374843749437504375143752437534375443755437564375743758437594376043761437624376343764437654376643767437684376943770437714377243773437744377543776437774377843779437804378143782437834378443785437864378743788437894379043791437924379343794437954379643797437984379943800438014380243803438044380543806438074380843809438104381143812438134381443815438164381743818438194382043821438224382343824438254382643827438284382943830438314383243833438344383543836438374383843839438404384143842438434384443845438464384743848438494385043851438524385343854438554385643857438584385943860438614386243863438644386543866438674386843869438704387143872438734387443875438764387743878438794388043881438824388343884438854388643887438884388943890438914389243893438944389543896438974389843899439004390143902439034390443905439064390743908439094391043911439124391343914439154391643917439184391943920439214392243923439244392543926439274392843929439304393143932439334393443935439364393743938439394394043941439424394343944439454394643947439484394943950439514395243953439544395543956439574395843959439604396143962439634396443965439664396743968439694397043971439724397343974439754397643977439784397943980439814398243983439844398543986439874398843989439904399143992439934399443995439964399743998439994400044001440024400344004440054400644007440084400944010440114401244013440144401544016440174401844019440204402144022440234402444025440264402744028440294403044031440324403344034440354403644037440384403944040440414404244043440444404544046440474404844049440504405144052440534405444055440564405744058440594406044061440624406344064440654406644067440684406944070440714407244073440744407544076440774407844079440804408144082440834408444085440864408744088440894409044091440924409344094440954409644097440984409944100441014410244103441044410544106441074410844109441104411144112441134411444115441164411744118441194412044121441224412344124441254412644127441284412944130441314413244133441344413544136441374413844139441404414144142441434414444145441464414744148441494415044151441524415344154441554415644157441584415944160441614416244163441644416544166441674416844169441704417144172441734417444175441764417744178441794418044181441824418344184441854418644187441884418944190441914419244193441944419544196441974419844199442004420144202442034420444205442064420744208442094421044211442124421344214442154421644217442184421944220442214422244223442244422544226442274422844229442304423144232442334423444235442364423744238442394424044241442424424344244442454424644247442484424944250442514425244253442544425544256442574425844259442604426144262442634426444265442664426744268442694427044271442724427344274442754427644277442784427944280442814428244283442844428544286442874428844289442904429144292442934429444295442964429744298442994430044301443024430344304443054430644307443084430944310443114431244313443144431544316443174431844319443204432144322443234432444325443264432744328443294433044331443324433344334443354433644337443384433944340443414434244343443444434544346443474434844349443504435144352443534435444355443564435744358443594436044361443624436344364443654436644367443684436944370443714437244373443744437544376443774437844379443804438144382443834438444385443864438744388443894439044391443924439344394443954439644397443984439944400444014440244403444044440544406444074440844409444104441144412444134441444415444164441744418444194442044421444224442344424444254442644427444284442944430444314443244433444344443544436444374443844439444404444144442444434444444445444464444744448444494445044451444524445344454444554445644457444584445944460444614446244463444644446544466444674446844469444704447144472444734447444475444764447744478444794448044481444824448344484444854448644487444884448944490444914449244493444944449544496444974449844499445004450144502445034450444505445064450744508445094451044511445124451344514445154451644517445184451944520445214452244523445244452544526445274452844529445304453144532445334453444535445364453744538445394454044541445424454344544445454454644547445484454944550445514455244553445544455544556445574455844559445604456144562445634456444565445664456744568445694457044571445724457344574445754457644577445784457944580445814458244583445844458544586445874458844589445904459144592445934459444595445964459744598445994460044601446024460344604446054460644607446084460944610446114461244613446144461544616446174461844619446204462144622446234462444625446264462744628446294463044631446324463344634446354463644637446384463944640446414464244643446444464544646446474464844649446504465144652446534465444655446564465744658446594466044661446624466344664446654466644667446684466944670446714467244673446744467544676446774467844679446804468144682446834468444685446864468744688446894469044691446924469344694446954469644697446984469944700447014470244703447044470544706447074470844709447104471144712447134471444715447164471744718447194472044721447224472344724447254472644727447284472944730447314473244733447344473544736447374473844739447404474144742447434474444745447464474744748447494475044751447524475344754447554475644757447584475944760447614476244763447644476544766447674476844769447704477144772447734477444775447764477744778447794478044781447824478344784447854478644787447884478944790447914479244793447944479544796447974479844799448004480144802448034480444805448064480744808448094481044811448124481344814448154481644817448184481944820448214482244823448244482544826448274482844829448304483144832448334483444835448364483744838448394484044841448424484344844448454484644847448484484944850448514485244853448544485544856448574485844859448604486144862448634486444865448664486744868448694487044871448724487344874448754487644877448784487944880448814488244883448844488544886448874488844889448904489144892448934489444895448964489744898448994490044901449024490344904449054490644907449084490944910449114491244913449144491544916449174491844919449204492144922449234492444925449264492744928449294493044931449324493344934449354493644937449384493944940449414494244943449444494544946449474494844949449504495144952449534495444955449564495744958449594496044961449624496344964449654496644967449684496944970449714497244973449744497544976449774497844979449804498144982449834498444985449864498744988449894499044991449924499344994449954499644997449984499945000450014500245003450044500545006450074500845009450104501145012450134501445015450164501745018450194502045021450224502345024450254502645027450284502945030450314503245033450344503545036450374503845039450404504145042450434504445045450464504745048450494505045051450524505345054450554505645057450584505945060450614506245063450644506545066450674506845069450704507145072450734507445075450764507745078450794508045081450824508345084450854508645087450884508945090450914509245093450944509545096450974509845099451004510145102451034510445105451064510745108451094511045111451124511345114451154511645117451184511945120451214512245123451244512545126451274512845129451304513145132451334513445135451364513745138451394514045141451424514345144451454514645147451484514945150451514515245153451544515545156451574515845159451604516145162451634516445165451664516745168451694517045171451724517345174451754517645177451784517945180451814518245183451844518545186451874518845189451904519145192451934519445195451964519745198451994520045201452024520345204452054520645207452084520945210452114521245213452144521545216452174521845219452204522145222452234522445225452264522745228452294523045231452324523345234452354523645237452384523945240452414524245243452444524545246452474524845249452504525145252452534525445255452564525745258452594526045261452624526345264452654526645267452684526945270452714527245273452744527545276452774527845279452804528145282452834528445285452864528745288452894529045291452924529345294452954529645297452984529945300453014530245303453044530545306453074530845309453104531145312453134531445315453164531745318453194532045321453224532345324453254532645327453284532945330453314533245333453344533545336453374533845339453404534145342453434534445345453464534745348453494535045351453524535345354453554535645357453584535945360453614536245363453644536545366453674536845369453704537145372453734537445375453764537745378453794538045381453824538345384453854538645387453884538945390453914539245393453944539545396453974539845399454004540145402454034540445405454064540745408454094541045411454124541345414454154541645417454184541945420454214542245423454244542545426454274542845429454304543145432454334543445435454364543745438454394544045441454424544345444454454544645447454484544945450454514545245453454544545545456454574545845459454604546145462454634546445465454664546745468454694547045471454724547345474454754547645477454784547945480454814548245483454844548545486454874548845489454904549145492454934549445495454964549745498454994550045501455024550345504455054550645507455084550945510455114551245513455144551545516455174551845519455204552145522455234552445525455264552745528455294553045531455324553345534455354553645537455384553945540455414554245543455444554545546455474554845549455504555145552455534555445555455564555745558455594556045561455624556345564455654556645567455684556945570455714557245573455744557545576455774557845579455804558145582455834558445585455864558745588455894559045591455924559345594455954559645597455984559945600456014560245603456044560545606456074560845609456104561145612456134561445615456164561745618456194562045621456224562345624456254562645627456284562945630456314563245633456344563545636456374563845639456404564145642456434564445645456464564745648456494565045651456524565345654456554565645657456584565945660456614566245663456644566545666456674566845669456704567145672456734567445675456764567745678456794568045681456824568345684456854568645687456884568945690456914569245693456944569545696456974569845699457004570145702457034570445705457064570745708457094571045711457124571345714457154571645717457184571945720457214572245723457244572545726457274572845729457304573145732457334573445735457364573745738457394574045741457424574345744457454574645747457484574945750457514575245753457544575545756457574575845759457604576145762457634576445765457664576745768457694577045771457724577345774457754577645777457784577945780457814578245783457844578545786457874578845789457904579145792457934579445795457964579745798457994580045801458024580345804458054580645807458084580945810458114581245813458144581545816458174581845819458204582145822458234582445825458264582745828458294583045831458324583345834458354583645837458384583945840458414584245843458444584545846458474584845849458504585145852458534585445855458564585745858458594586045861458624586345864458654586645867458684586945870458714587245873458744587545876458774587845879458804588145882458834588445885458864588745888458894589045891458924589345894458954589645897458984589945900459014590245903459044590545906459074590845909459104591145912459134591445915459164591745918459194592045921459224592345924459254592645927459284592945930459314593245933459344593545936459374593845939459404594145942459434594445945459464594745948459494595045951459524595345954459554595645957459584595945960459614596245963459644596545966459674596845969459704597145972459734597445975459764597745978459794598045981459824598345984459854598645987459884598945990459914599245993459944599545996459974599845999460004600146002460034600446005460064600746008460094601046011460124601346014460154601646017460184601946020460214602246023460244602546026460274602846029460304603146032460334603446035460364603746038460394604046041460424604346044460454604646047460484604946050460514605246053460544605546056460574605846059460604606146062460634606446065460664606746068460694607046071460724607346074460754607646077460784607946080460814608246083460844608546086460874608846089460904609146092460934609446095460964609746098460994610046101461024610346104461054610646107461084610946110461114611246113461144611546116461174611846119461204612146122461234612446125461264612746128461294613046131461324613346134461354613646137461384613946140461414614246143461444614546146461474614846149461504615146152461534615446155461564615746158461594616046161461624616346164461654616646167461684616946170461714617246173461744617546176461774617846179461804618146182461834618446185461864618746188461894619046191461924619346194461954619646197461984619946200462014620246203462044620546206462074620846209462104621146212462134621446215462164621746218462194622046221462224622346224462254622646227462284622946230462314623246233462344623546236462374623846239462404624146242462434624446245462464624746248462494625046251462524625346254462554625646257462584625946260462614626246263462644626546266462674626846269462704627146272462734627446275462764627746278462794628046281462824628346284462854628646287462884628946290462914629246293462944629546296462974629846299463004630146302463034630446305463064630746308463094631046311463124631346314463154631646317463184631946320463214632246323463244632546326463274632846329463304633146332463334633446335463364633746338463394634046341463424634346344463454634646347463484634946350463514635246353463544635546356463574635846359463604636146362463634636446365463664636746368463694637046371463724637346374463754637646377463784637946380463814638246383463844638546386463874638846389463904639146392463934639446395463964639746398463994640046401464024640346404464054640646407464084640946410464114641246413464144641546416464174641846419464204642146422464234642446425464264642746428464294643046431464324643346434464354643646437464384643946440464414644246443464444644546446464474644846449464504645146452464534645446455464564645746458464594646046461464624646346464464654646646467464684646946470464714647246473464744647546476464774647846479464804648146482464834648446485464864648746488464894649046491464924649346494464954649646497464984649946500465014650246503465044650546506465074650846509465104651146512465134651446515465164651746518465194652046521465224652346524465254652646527465284652946530465314653246533465344653546536465374653846539465404654146542465434654446545465464654746548465494655046551465524655346554465554655646557465584655946560465614656246563465644656546566465674656846569465704657146572465734657446575465764657746578465794658046581465824658346584465854658646587465884658946590465914659246593465944659546596465974659846599466004660146602466034660446605466064660746608466094661046611466124661346614466154661646617466184661946620466214662246623466244662546626466274662846629466304663146632466334663446635466364663746638466394664046641466424664346644466454664646647466484664946650466514665246653466544665546656466574665846659466604666146662466634666446665466664666746668466694667046671466724667346674466754667646677466784667946680466814668246683466844668546686466874668846689466904669146692466934669446695466964669746698466994670046701467024670346704467054670646707467084670946710467114671246713467144671546716467174671846719467204672146722467234672446725467264672746728467294673046731467324673346734467354673646737467384673946740467414674246743467444674546746467474674846749467504675146752467534675446755467564675746758467594676046761467624676346764467654676646767467684676946770467714677246773467744677546776467774677846779467804678146782467834678446785467864678746788467894679046791467924679346794467954679646797467984679946800468014680246803468044680546806468074680846809468104681146812468134681446815468164681746818468194682046821468224682346824468254682646827468284682946830468314683246833468344683546836468374683846839468404684146842468434684446845468464684746848468494685046851468524685346854468554685646857468584685946860468614686246863468644686546866468674686846869468704687146872468734687446875468764687746878468794688046881468824688346884468854688646887468884688946890468914689246893468944689546896468974689846899469004690146902469034690446905469064690746908469094691046911469124691346914469154691646917469184691946920469214692246923469244692546926469274692846929469304693146932469334693446935469364693746938469394694046941469424694346944469454694646947469484694946950469514695246953469544695546956469574695846959469604696146962469634696446965469664696746968469694697046971469724697346974469754697646977469784697946980469814698246983469844698546986469874698846989469904699146992469934699446995469964699746998469994700047001470024700347004470054700647007470084700947010470114701247013470144701547016470174701847019470204702147022470234702447025470264702747028470294703047031470324703347034470354703647037470384703947040470414704247043470444704547046470474704847049470504705147052470534705447055470564705747058470594706047061470624706347064470654706647067470684706947070470714707247073470744707547076470774707847079470804708147082470834708447085470864708747088470894709047091470924709347094470954709647097470984709947100471014710247103471044710547106471074710847109471104711147112471134711447115471164711747118471194712047121471224712347124471254712647127471284712947130471314713247133471344713547136471374713847139471404714147142471434714447145471464714747148471494715047151471524715347154471554715647157471584715947160471614716247163471644716547166471674716847169471704717147172471734717447175471764717747178471794718047181471824718347184471854718647187471884718947190471914719247193471944719547196471974719847199472004720147202472034720447205472064720747208472094721047211472124721347214472154721647217472184721947220472214722247223472244722547226472274722847229472304723147232472334723447235472364723747238472394724047241472424724347244472454724647247472484724947250472514725247253472544725547256472574725847259472604726147262472634726447265472664726747268472694727047271472724727347274472754727647277472784727947280472814728247283472844728547286472874728847289472904729147292472934729447295472964729747298472994730047301473024730347304473054730647307473084730947310473114731247313473144731547316473174731847319473204732147322473234732447325473264732747328473294733047331473324733347334473354733647337473384733947340473414734247343473444734547346473474734847349473504735147352473534735447355473564735747358473594736047361473624736347364473654736647367473684736947370473714737247373473744737547376473774737847379473804738147382473834738447385473864738747388473894739047391473924739347394473954739647397473984739947400474014740247403474044740547406474074740847409474104741147412474134741447415474164741747418474194742047421474224742347424474254742647427474284742947430474314743247433474344743547436474374743847439474404744147442474434744447445474464744747448474494745047451474524745347454474554745647457474584745947460474614746247463474644746547466474674746847469474704747147472474734747447475474764747747478474794748047481474824748347484474854748647487474884748947490474914749247493474944749547496474974749847499475004750147502475034750447505475064750747508475094751047511475124751347514475154751647517475184751947520475214752247523475244752547526475274752847529475304753147532475334753447535475364753747538475394754047541475424754347544475454754647547475484754947550475514755247553475544755547556475574755847559475604756147562475634756447565475664756747568475694757047571475724757347574475754757647577475784757947580475814758247583475844758547586475874758847589475904759147592475934759447595475964759747598475994760047601476024760347604476054760647607476084760947610476114761247613476144761547616476174761847619476204762147622476234762447625476264762747628476294763047631476324763347634476354763647637476384763947640476414764247643476444764547646476474764847649476504765147652476534765447655476564765747658476594766047661476624766347664476654766647667476684766947670476714767247673476744767547676476774767847679476804768147682476834768447685476864768747688476894769047691476924769347694476954769647697476984769947700477014770247703477044770547706477074770847709477104771147712477134771447715477164771747718477194772047721477224772347724477254772647727477284772947730477314773247733477344773547736477374773847739477404774147742477434774447745477464774747748477494775047751477524775347754477554775647757477584775947760477614776247763477644776547766477674776847769477704777147772477734777447775477764777747778477794778047781477824778347784477854778647787477884778947790477914779247793477944779547796477974779847799478004780147802478034780447805478064780747808478094781047811478124781347814478154781647817478184781947820478214782247823478244782547826478274782847829478304783147832478334783447835478364783747838478394784047841478424784347844478454784647847478484784947850478514785247853478544785547856478574785847859478604786147862478634786447865478664786747868478694787047871478724787347874478754787647877478784787947880478814788247883478844788547886478874788847889478904789147892478934789447895478964789747898478994790047901479024790347904479054790647907479084790947910479114791247913479144791547916479174791847919479204792147922479234792447925479264792747928479294793047931479324793347934479354793647937479384793947940479414794247943479444794547946479474794847949479504795147952479534795447955479564795747958479594796047961479624796347964479654796647967479684796947970479714797247973479744797547976479774797847979479804798147982479834798447985479864798747988479894799047991479924799347994479954799647997479984799948000480014800248003480044800548006480074800848009480104801148012480134801448015480164801748018480194802048021480224802348024480254802648027480284802948030480314803248033480344803548036480374803848039480404804148042480434804448045480464804748048480494805048051480524805348054480554805648057480584805948060480614806248063480644806548066480674806848069480704807148072480734807448075480764807748078480794808048081480824808348084480854808648087480884808948090480914809248093480944809548096480974809848099481004810148102481034810448105481064810748108481094811048111481124811348114481154811648117481184811948120481214812248123481244812548126481274812848129481304813148132481334813448135481364813748138481394814048141481424814348144481454814648147481484814948150481514815248153481544815548156481574815848159481604816148162481634816448165481664816748168481694817048171481724817348174481754817648177481784817948180481814818248183481844818548186481874818848189481904819148192481934819448195481964819748198481994820048201482024820348204482054820648207482084820948210482114821248213482144821548216482174821848219482204822148222482234822448225482264822748228482294823048231482324823348234482354823648237482384823948240482414824248243482444824548246482474824848249482504825148252482534825448255482564825748258482594826048261482624826348264482654826648267482684826948270482714827248273482744827548276482774827848279482804828148282482834828448285482864828748288482894829048291482924829348294482954829648297482984829948300483014830248303483044830548306483074830848309483104831148312483134831448315483164831748318483194832048321483224832348324483254832648327483284832948330483314833248333483344833548336483374833848339483404834148342483434834448345483464834748348483494835048351483524835348354483554835648357483584835948360483614836248363483644836548366483674836848369483704837148372483734837448375483764837748378483794838048381483824838348384483854838648387483884838948390483914839248393483944839548396483974839848399484004840148402484034840448405484064840748408484094841048411484124841348414484154841648417484184841948420484214842248423484244842548426484274842848429484304843148432484334843448435484364843748438484394844048441484424844348444484454844648447484484844948450484514845248453484544845548456484574845848459484604846148462484634846448465484664846748468484694847048471484724847348474484754847648477484784847948480484814848248483484844848548486484874848848489484904849148492484934849448495484964849748498484994850048501485024850348504485054850648507485084850948510485114851248513485144851548516485174851848519485204852148522485234852448525485264852748528485294853048531485324853348534485354853648537485384853948540485414854248543485444854548546485474854848549485504855148552485534855448555485564855748558485594856048561485624856348564485654856648567485684856948570485714857248573485744857548576485774857848579485804858148582485834858448585485864858748588485894859048591485924859348594485954859648597485984859948600486014860248603486044860548606486074860848609486104861148612486134861448615486164861748618486194862048621486224862348624486254862648627486284862948630486314863248633486344863548636486374863848639486404864148642486434864448645486464864748648486494865048651486524865348654486554865648657486584865948660486614866248663486644866548666486674866848669486704867148672486734867448675486764867748678486794868048681486824868348684486854868648687486884868948690486914869248693486944869548696486974869848699487004870148702487034870448705487064870748708487094871048711487124871348714487154871648717487184871948720487214872248723487244872548726487274872848729487304873148732487334873448735487364873748738487394874048741487424874348744487454874648747487484874948750487514875248753487544875548756487574875848759487604876148762487634876448765487664876748768487694877048771487724877348774487754877648777487784877948780487814878248783487844878548786487874878848789487904879148792487934879448795487964879748798487994880048801488024880348804488054880648807488084880948810488114881248813488144881548816488174881848819488204882148822488234882448825488264882748828488294883048831488324883348834488354883648837488384883948840488414884248843488444884548846488474884848849488504885148852488534885448855488564885748858488594886048861488624886348864488654886648867488684886948870488714887248873488744887548876488774887848879488804888148882488834888448885488864888748888488894889048891488924889348894488954889648897488984889948900489014890248903489044890548906489074890848909489104891148912489134891448915489164891748918489194892048921489224892348924489254892648927489284892948930489314893248933489344893548936489374893848939489404894148942489434894448945489464894748948489494895048951489524895348954489554895648957489584895948960489614896248963489644896548966489674896848969489704897148972489734897448975489764897748978489794898048981489824898348984489854898648987489884898948990489914899248993489944899548996489974899848999490004900149002490034900449005490064900749008490094901049011490124901349014490154901649017490184901949020490214902249023490244902549026490274902849029490304903149032490334903449035490364903749038490394904049041490424904349044490454904649047490484904949050490514905249053490544905549056490574905849059490604906149062490634906449065490664906749068490694907049071490724907349074490754907649077490784907949080490814908249083490844908549086490874908849089490904909149092490934909449095490964909749098490994910049101491024910349104491054910649107491084910949110491114911249113491144911549116491174911849119491204912149122491234912449125491264912749128491294913049131491324913349134491354913649137491384913949140491414914249143491444914549146491474914849149491504915149152491534915449155491564915749158491594916049161491624916349164491654916649167491684916949170491714917249173491744917549176491774917849179491804918149182491834918449185491864918749188491894919049191491924919349194491954919649197491984919949200492014920249203492044920549206492074920849209492104921149212492134921449215492164921749218492194922049221492224922349224492254922649227492284922949230492314923249233492344923549236492374923849239492404924149242492434924449245492464924749248492494925049251492524925349254492554925649257492584925949260492614926249263492644926549266492674926849269492704927149272492734927449275492764927749278492794928049281492824928349284492854928649287492884928949290492914929249293492944929549296492974929849299493004930149302493034930449305493064930749308493094931049311493124931349314493154931649317493184931949320493214932249323493244932549326493274932849329493304933149332493334933449335493364933749338493394934049341493424934349344493454934649347493484934949350493514935249353493544935549356493574935849359493604936149362493634936449365493664936749368493694937049371493724937349374493754937649377493784937949380493814938249383493844938549386493874938849389493904939149392493934939449395493964939749398493994940049401494024940349404494054940649407494084940949410494114941249413494144941549416494174941849419494204942149422494234942449425494264942749428494294943049431494324943349434494354943649437494384943949440494414944249443494444944549446494474944849449494504945149452494534945449455494564945749458494594946049461494624946349464494654946649467494684946949470494714947249473494744947549476494774947849479494804948149482494834948449485494864948749488494894949049491494924949349494494954949649497494984949949500495014950249503495044950549506495074950849509495104951149512495134951449515495164951749518495194952049521495224952349524495254952649527495284952949530495314953249533495344953549536495374953849539495404954149542495434954449545495464954749548495494955049551495524955349554495554955649557495584955949560495614956249563495644956549566495674956849569495704957149572495734957449575495764957749578495794958049581495824958349584495854958649587495884958949590495914959249593495944959549596495974959849599496004960149602496034960449605496064960749608496094961049611496124961349614496154961649617496184961949620496214962249623496244962549626496274962849629496304963149632496334963449635496364963749638496394964049641496424964349644496454964649647496484964949650496514965249653496544965549656496574965849659496604966149662496634966449665496664966749668496694967049671496724967349674496754967649677496784967949680496814968249683496844968549686496874968849689496904969149692496934969449695496964969749698496994970049701497024970349704497054970649707497084970949710497114971249713497144971549716497174971849719497204972149722497234972449725497264972749728497294973049731497324973349734497354973649737497384973949740497414974249743497444974549746497474974849749497504975149752497534975449755497564975749758497594976049761497624976349764497654976649767497684976949770497714977249773497744977549776497774977849779497804978149782497834978449785497864978749788497894979049791497924979349794497954979649797497984979949800498014980249803498044980549806498074980849809498104981149812498134981449815498164981749818498194982049821498224982349824498254982649827498284982949830498314983249833498344983549836498374983849839498404984149842498434984449845498464984749848498494985049851498524985349854498554985649857498584985949860498614986249863498644986549866498674986849869498704987149872498734987449875498764987749878498794988049881498824988349884498854988649887498884988949890498914989249893498944989549896498974989849899499004990149902499034990449905499064990749908499094991049911499124991349914499154991649917499184991949920499214992249923499244992549926499274992849929499304993149932499334993449935499364993749938499394994049941499424994349944499454994649947499484994949950499514995249953499544995549956499574995849959499604996149962499634996449965499664996749968499694997049971499724997349974499754997649977499784997949980499814998249983499844998549986499874998849989499904999149992499934999449995499964999749998499995000050001500025000350004500055000650007500085000950010500115001250013500145001550016500175001850019500205002150022500235002450025500265002750028500295003050031500325003350034500355003650037500385003950040500415004250043500445004550046500475004850049500505005150052500535005450055500565005750058500595006050061500625006350064500655006650067500685006950070500715007250073500745007550076500775007850079500805008150082500835008450085500865008750088500895009050091500925009350094500955009650097500985009950100501015010250103501045010550106501075010850109501105011150112501135011450115501165011750118501195012050121501225012350124501255012650127501285012950130501315013250133501345013550136501375013850139501405014150142501435014450145501465014750148501495015050151501525015350154501555015650157501585015950160501615016250163501645016550166501675016850169501705017150172501735017450175501765017750178501795018050181501825018350184501855018650187501885018950190501915019250193501945019550196501975019850199502005020150202502035020450205502065020750208502095021050211502125021350214502155021650217502185021950220502215022250223502245022550226502275022850229502305023150232502335023450235502365023750238502395024050241502425024350244502455024650247502485024950250502515025250253502545025550256502575025850259502605026150262502635026450265502665026750268502695027050271502725027350274502755027650277502785027950280502815028250283502845028550286502875028850289502905029150292502935029450295502965029750298502995030050301503025030350304503055030650307503085030950310503115031250313503145031550316503175031850319503205032150322503235032450325503265032750328503295033050331503325033350334503355033650337503385033950340503415034250343503445034550346503475034850349503505035150352503535035450355503565035750358503595036050361503625036350364503655036650367503685036950370503715037250373503745037550376503775037850379503805038150382503835038450385503865038750388503895039050391503925039350394503955039650397503985039950400504015040250403504045040550406504075040850409504105041150412504135041450415504165041750418504195042050421504225042350424504255042650427504285042950430504315043250433504345043550436504375043850439504405044150442504435044450445504465044750448504495045050451504525045350454504555045650457504585045950460504615046250463504645046550466504675046850469504705047150472504735047450475504765047750478504795048050481504825048350484504855048650487504885048950490504915049250493504945049550496504975049850499505005050150502505035050450505505065050750508505095051050511505125051350514505155051650517505185051950520505215052250523505245052550526505275052850529505305053150532505335053450535505365053750538505395054050541505425054350544505455054650547505485054950550505515055250553505545055550556505575055850559505605056150562505635056450565505665056750568505695057050571505725057350574505755057650577505785057950580505815058250583505845058550586505875058850589505905059150592505935059450595505965059750598505995060050601506025060350604506055060650607506085060950610506115061250613506145061550616506175061850619506205062150622506235062450625506265062750628506295063050631506325063350634506355063650637506385063950640506415064250643506445064550646506475064850649506505065150652506535065450655506565065750658506595066050661506625066350664506655066650667506685066950670506715067250673506745067550676506775067850679506805068150682506835068450685506865068750688506895069050691506925069350694506955069650697506985069950700507015070250703507045070550706507075070850709507105071150712507135071450715507165071750718507195072050721507225072350724507255072650727507285072950730507315073250733507345073550736507375073850739507405074150742507435074450745507465074750748507495075050751507525075350754507555075650757507585075950760507615076250763507645076550766507675076850769507705077150772507735077450775507765077750778507795078050781507825078350784507855078650787507885078950790507915079250793507945079550796507975079850799508005080150802508035080450805508065080750808508095081050811508125081350814508155081650817508185081950820508215082250823508245082550826508275082850829508305083150832508335083450835508365083750838508395084050841508425084350844508455084650847508485084950850508515085250853508545085550856508575085850859508605086150862508635086450865508665086750868508695087050871508725087350874508755087650877508785087950880508815088250883508845088550886508875088850889508905089150892508935089450895508965089750898508995090050901509025090350904509055090650907509085090950910509115091250913509145091550916509175091850919509205092150922509235092450925509265092750928509295093050931509325093350934509355093650937509385093950940509415094250943509445094550946509475094850949509505095150952509535095450955509565095750958509595096050961509625096350964509655096650967509685096950970509715097250973509745097550976509775097850979509805098150982509835098450985509865098750988509895099050991509925099350994509955099650997509985099951000510015100251003510045100551006510075100851009510105101151012510135101451015510165101751018510195102051021510225102351024510255102651027510285102951030510315103251033510345103551036510375103851039510405104151042510435104451045510465104751048510495105051051510525105351054510555105651057510585105951060510615106251063510645106551066510675106851069510705107151072510735107451075510765107751078510795108051081510825108351084510855108651087510885108951090510915109251093510945109551096510975109851099511005110151102511035110451105511065110751108511095111051111511125111351114511155111651117511185111951120511215112251123511245112551126511275112851129511305113151132511335113451135511365113751138511395114051141511425114351144511455114651147511485114951150511515115251153511545115551156511575115851159511605116151162511635116451165511665116751168511695117051171511725117351174511755117651177511785117951180511815118251183511845118551186511875118851189511905119151192511935119451195511965119751198511995120051201512025120351204512055120651207512085120951210512115121251213512145121551216512175121851219512205122151222512235122451225512265122751228512295123051231512325123351234512355123651237512385123951240512415124251243512445124551246512475124851249512505125151252512535125451255512565125751258512595126051261512625126351264512655126651267512685126951270512715127251273512745127551276512775127851279512805128151282512835128451285512865128751288512895129051291512925129351294512955129651297512985129951300513015130251303513045130551306513075130851309513105131151312513135131451315513165131751318513195132051321513225132351324513255132651327513285132951330513315133251333513345133551336513375133851339513405134151342513435134451345513465134751348513495135051351513525135351354513555135651357513585135951360513615136251363513645136551366513675136851369513705137151372513735137451375513765137751378513795138051381513825138351384513855138651387513885138951390513915139251393513945139551396513975139851399514005140151402514035140451405514065140751408514095141051411514125141351414514155141651417514185141951420514215142251423514245142551426514275142851429514305143151432514335143451435514365143751438514395144051441514425144351444514455144651447514485144951450514515145251453514545145551456514575145851459514605146151462514635146451465514665146751468514695147051471514725147351474514755147651477514785147951480514815148251483514845148551486514875148851489514905149151492514935149451495514965149751498514995150051501515025150351504515055150651507515085150951510515115151251513515145151551516515175151851519515205152151522515235152451525515265152751528515295153051531515325153351534515355153651537515385153951540515415154251543515445154551546515475154851549515505155151552515535155451555515565155751558515595156051561515625156351564515655156651567515685156951570515715157251573515745157551576515775157851579515805158151582515835158451585515865158751588515895159051591515925159351594515955159651597515985159951600516015160251603516045160551606516075160851609516105161151612516135161451615516165161751618516195162051621516225162351624516255162651627516285162951630516315163251633516345163551636516375163851639516405164151642516435164451645516465164751648516495165051651516525165351654516555165651657516585165951660516615166251663516645166551666516675166851669516705167151672516735167451675516765167751678516795168051681516825168351684516855168651687516885168951690516915169251693516945169551696516975169851699517005170151702517035170451705517065170751708517095171051711517125171351714517155171651717517185171951720517215172251723517245172551726517275172851729517305173151732517335173451735517365173751738517395174051741517425174351744517455174651747517485174951750517515175251753517545175551756517575175851759517605176151762517635176451765517665176751768517695177051771517725177351774517755177651777517785177951780517815178251783517845178551786517875178851789517905179151792517935179451795517965179751798517995180051801518025180351804518055180651807518085180951810518115181251813518145181551816518175181851819518205182151822518235182451825518265182751828518295183051831518325183351834518355183651837518385183951840518415184251843518445184551846518475184851849518505185151852518535185451855518565185751858518595186051861518625186351864518655186651867518685186951870518715187251873518745187551876518775187851879518805188151882518835188451885518865188751888518895189051891518925189351894518955189651897518985189951900519015190251903519045190551906519075190851909519105191151912519135191451915519165191751918519195192051921519225192351924519255192651927519285192951930519315193251933519345193551936519375193851939519405194151942519435194451945519465194751948519495195051951519525195351954519555195651957519585195951960519615196251963519645196551966519675196851969519705197151972519735197451975519765197751978519795198051981519825198351984519855198651987519885198951990519915199251993519945199551996519975199851999520005200152002520035200452005520065200752008520095201052011520125201352014520155201652017520185201952020520215202252023520245202552026520275202852029520305203152032520335203452035520365203752038520395204052041520425204352044520455204652047520485204952050520515205252053520545205552056520575205852059520605206152062520635206452065520665206752068520695207052071520725207352074520755207652077520785207952080520815208252083520845208552086520875208852089520905209152092520935209452095520965209752098520995210052101521025210352104521055210652107521085210952110521115211252113521145211552116521175211852119521205212152122521235212452125521265212752128521295213052131521325213352134521355213652137521385213952140521415214252143521445214552146521475214852149521505215152152521535215452155521565215752158521595216052161521625216352164521655216652167521685216952170521715217252173521745217552176521775217852179521805218152182521835218452185521865218752188521895219052191521925219352194521955219652197521985219952200522015220252203522045220552206522075220852209522105221152212522135221452215522165221752218522195222052221522225222352224522255222652227522285222952230522315223252233522345223552236522375223852239522405224152242522435224452245522465224752248522495225052251522525225352254522555225652257522585225952260522615226252263522645226552266522675226852269522705227152272522735227452275522765227752278522795228052281522825228352284522855228652287522885228952290522915229252293522945229552296522975229852299523005230152302523035230452305523065230752308523095231052311523125231352314523155231652317523185231952320523215232252323523245232552326523275232852329523305233152332523335233452335523365233752338523395234052341523425234352344523455234652347523485234952350523515235252353523545235552356523575235852359523605236152362523635236452365523665236752368523695237052371523725237352374523755237652377523785237952380523815238252383523845238552386523875238852389523905239152392523935239452395523965239752398523995240052401524025240352404524055240652407524085240952410524115241252413524145241552416524175241852419524205242152422524235242452425524265242752428524295243052431524325243352434524355243652437524385243952440524415244252443524445244552446524475244852449524505245152452524535245452455524565245752458524595246052461524625246352464524655246652467524685246952470524715247252473524745247552476524775247852479524805248152482524835248452485524865248752488524895249052491524925249352494524955249652497524985249952500525015250252503525045250552506525075250852509525105251152512525135251452515525165251752518525195252052521525225252352524525255252652527525285252952530525315253252533525345253552536525375253852539525405254152542525435254452545525465254752548525495255052551525525255352554525555255652557525585255952560525615256252563525645256552566525675256852569525705257152572525735257452575525765257752578525795258052581525825258352584525855258652587525885258952590525915259252593525945259552596525975259852599526005260152602526035260452605526065260752608526095261052611526125261352614526155261652617526185261952620526215262252623526245262552626526275262852629526305263152632526335263452635526365263752638526395264052641526425264352644526455264652647526485264952650526515265252653526545265552656526575265852659526605266152662526635266452665526665266752668526695267052671526725267352674526755267652677526785267952680526815268252683526845268552686526875268852689526905269152692526935269452695526965269752698526995270052701527025270352704527055270652707527085270952710527115271252713527145271552716527175271852719527205272152722527235272452725527265272752728527295273052731527325273352734527355273652737527385273952740527415274252743527445274552746527475274852749527505275152752527535275452755527565275752758527595276052761527625276352764527655276652767527685276952770527715277252773527745277552776527775277852779527805278152782527835278452785527865278752788527895279052791527925279352794527955279652797527985279952800528015280252803528045280552806528075280852809528105281152812528135281452815528165281752818528195282052821528225282352824528255282652827528285282952830528315283252833528345283552836528375283852839528405284152842528435284452845528465284752848528495285052851528525285352854528555285652857528585285952860528615286252863528645286552866528675286852869528705287152872528735287452875528765287752878528795288052881528825288352884528855288652887528885288952890528915289252893528945289552896528975289852899529005290152902529035290452905529065290752908529095291052911529125291352914529155291652917529185291952920529215292252923529245292552926529275292852929529305293152932529335293452935529365293752938529395294052941529425294352944529455294652947529485294952950529515295252953529545295552956529575295852959529605296152962529635296452965529665296752968529695297052971529725297352974529755297652977529785297952980529815298252983529845298552986529875298852989529905299152992529935299452995529965299752998529995300053001530025300353004530055300653007530085300953010530115301253013530145301553016530175301853019530205302153022530235302453025530265302753028530295303053031530325303353034530355303653037530385303953040530415304253043530445304553046530475304853049530505305153052530535305453055530565305753058530595306053061530625306353064530655306653067530685306953070530715307253073530745307553076530775307853079530805308153082530835308453085530865308753088530895309053091530925309353094530955309653097530985309953100531015310253103531045310553106531075310853109531105311153112531135311453115531165311753118531195312053121531225312353124531255312653127531285312953130531315313253133531345313553136531375313853139531405314153142531435314453145531465314753148531495315053151531525315353154531555315653157531585315953160531615316253163531645316553166531675316853169531705317153172531735317453175531765317753178531795318053181531825318353184531855318653187531885318953190531915319253193531945319553196531975319853199532005320153202532035320453205532065320753208532095321053211532125321353214532155321653217532185321953220532215322253223532245322553226532275322853229532305323153232532335323453235532365323753238532395324053241532425324353244532455324653247532485324953250532515325253253532545325553256532575325853259532605326153262532635326453265532665326753268532695327053271532725327353274532755327653277532785327953280532815328253283532845328553286532875328853289532905329153292532935329453295532965329753298532995330053301533025330353304533055330653307533085330953310533115331253313533145331553316533175331853319533205332153322533235332453325533265332753328533295333053331533325333353334533355333653337533385333953340533415334253343533445334553346533475334853349533505335153352533535335453355533565335753358533595336053361533625336353364533655336653367533685336953370533715337253373533745337553376533775337853379533805338153382533835338453385533865338753388533895339053391533925339353394533955339653397533985339953400534015340253403534045340553406534075340853409534105341153412534135341453415534165341753418534195342053421534225342353424534255342653427534285342953430534315343253433534345343553436534375343853439534405344153442534435344453445534465344753448534495345053451534525345353454534555345653457534585345953460534615346253463534645346553466534675346853469534705347153472534735347453475534765347753478534795348053481534825348353484534855348653487534885348953490534915349253493534945349553496534975349853499535005350153502535035350453505535065350753508535095351053511535125351353514535155351653517535185351953520535215352253523535245352553526535275352853529535305353153532535335353453535535365353753538535395354053541535425354353544535455354653547535485354953550535515355253553535545355553556535575355853559535605356153562535635356453565535665356753568535695357053571535725357353574535755357653577535785357953580535815358253583535845358553586535875358853589535905359153592535935359453595535965359753598535995360053601536025360353604536055360653607536085360953610536115361253613536145361553616536175361853619536205362153622536235362453625536265362753628536295363053631536325363353634536355363653637536385363953640536415364253643536445364553646536475364853649536505365153652536535365453655536565365753658536595366053661536625366353664536655366653667536685366953670536715367253673536745367553676536775367853679536805368153682536835368453685536865368753688536895369053691536925369353694536955369653697536985369953700537015370253703537045370553706537075370853709537105371153712537135371453715537165371753718537195372053721537225372353724537255372653727537285372953730537315373253733537345373553736537375373853739537405374153742537435374453745537465374753748537495375053751537525375353754537555375653757537585375953760537615376253763537645376553766537675376853769537705377153772537735377453775537765377753778537795378053781537825378353784537855378653787537885378953790537915379253793537945379553796537975379853799538005380153802538035380453805538065380753808538095381053811538125381353814538155381653817538185381953820538215382253823538245382553826538275382853829538305383153832538335383453835538365383753838538395384053841538425384353844538455384653847538485384953850538515385253853538545385553856538575385853859538605386153862538635386453865538665386753868538695387053871538725387353874538755387653877538785387953880538815388253883538845388553886538875388853889538905389153892538935389453895538965389753898538995390053901539025390353904539055390653907539085390953910539115391253913539145391553916539175391853919539205392153922539235392453925539265392753928539295393053931539325393353934539355393653937539385393953940539415394253943539445394553946539475394853949539505395153952539535395453955539565395753958539595396053961539625396353964539655396653967539685396953970539715397253973539745397553976539775397853979539805398153982539835398453985539865398753988539895399053991539925399353994539955399653997539985399954000540015400254003540045400554006540075400854009540105401154012540135401454015540165401754018540195402054021540225402354024540255402654027540285402954030540315403254033540345403554036540375403854039540405404154042540435404454045540465404754048540495405054051540525405354054540555405654057540585405954060540615406254063540645406554066540675406854069540705407154072540735407454075540765407754078540795408054081540825408354084540855408654087540885408954090540915409254093540945409554096540975409854099541005410154102541035410454105541065410754108541095411054111541125411354114541155411654117541185411954120541215412254123541245412554126541275412854129541305413154132541335413454135541365413754138541395414054141541425414354144541455414654147541485414954150541515415254153541545415554156541575415854159541605416154162541635416454165541665416754168541695417054171541725417354174541755417654177541785417954180541815418254183541845418554186541875418854189541905419154192541935419454195541965419754198541995420054201542025420354204542055420654207542085420954210542115421254213542145421554216542175421854219542205422154222542235422454225542265422754228542295423054231542325423354234542355423654237542385423954240542415424254243542445424554246542475424854249542505425154252542535425454255542565425754258542595426054261542625426354264542655426654267542685426954270542715427254273542745427554276542775427854279542805428154282542835428454285542865428754288542895429054291542925429354294542955429654297542985429954300543015430254303543045430554306543075430854309543105431154312543135431454315543165431754318543195432054321543225432354324543255432654327543285432954330543315433254333543345433554336543375433854339543405434154342543435434454345543465434754348543495435054351543525435354354543555435654357543585435954360543615436254363543645436554366543675436854369543705437154372543735437454375543765437754378543795438054381543825438354384543855438654387543885438954390543915439254393543945439554396543975439854399544005440154402544035440454405544065440754408544095441054411544125441354414544155441654417544185441954420544215442254423544245442554426544275442854429544305443154432544335443454435544365443754438544395444054441544425444354444544455444654447544485444954450544515445254453544545445554456544575445854459544605446154462544635446454465544665446754468544695447054471544725447354474544755447654477544785447954480544815448254483544845448554486544875448854489544905449154492544935449454495544965449754498544995450054501545025450354504545055450654507545085450954510545115451254513545145451554516545175451854519545205452154522545235452454525545265452754528545295453054531545325453354534545355453654537545385453954540545415454254543545445454554546545475454854549545505455154552545535455454555545565455754558545595456054561545625456354564545655456654567545685456954570545715457254573545745457554576545775457854579545805458154582545835458454585545865458754588545895459054591545925459354594545955459654597545985459954600546015460254603546045460554606546075460854609546105461154612546135461454615546165461754618546195462054621546225462354624546255462654627546285462954630546315463254633546345463554636546375463854639546405464154642546435464454645546465464754648546495465054651546525465354654546555465654657546585465954660546615466254663546645466554666546675466854669546705467154672546735467454675546765467754678546795468054681546825468354684546855468654687546885468954690546915469254693546945469554696546975469854699547005470154702547035470454705547065470754708547095471054711547125471354714547155471654717547185471954720547215472254723547245472554726547275472854729547305473154732547335473454735547365473754738547395474054741547425474354744547455474654747547485474954750547515475254753547545475554756547575475854759547605476154762547635476454765547665476754768547695477054771547725477354774547755477654777547785477954780547815478254783547845478554786547875478854789547905479154792547935479454795547965479754798547995480054801548025480354804548055480654807548085480954810548115481254813548145481554816548175481854819548205482154822548235482454825548265482754828548295483054831548325483354834548355483654837548385483954840548415484254843548445484554846548475484854849548505485154852548535485454855548565485754858548595486054861548625486354864548655486654867548685486954870548715487254873548745487554876548775487854879548805488154882548835488454885548865488754888548895489054891548925489354894548955489654897548985489954900549015490254903549045490554906549075490854909549105491154912549135491454915549165491754918549195492054921549225492354924549255492654927549285492954930549315493254933549345493554936549375493854939549405494154942549435494454945549465494754948549495495054951549525495354954549555495654957549585495954960549615496254963549645496554966549675496854969549705497154972549735497454975549765497754978549795498054981549825498354984549855498654987549885498954990549915499254993549945499554996549975499854999550005500155002550035500455005550065500755008550095501055011550125501355014550155501655017550185501955020550215502255023550245502555026550275502855029550305503155032550335503455035550365503755038550395504055041550425504355044550455504655047550485504955050550515505255053550545505555056550575505855059550605506155062550635506455065550665506755068550695507055071550725507355074550755507655077550785507955080550815508255083550845508555086550875508855089550905509155092550935509455095550965509755098550995510055101551025510355104551055510655107551085510955110551115511255113551145511555116551175511855119551205512155122551235512455125551265512755128551295513055131551325513355134551355513655137551385513955140551415514255143551445514555146551475514855149551505515155152551535515455155551565515755158551595516055161551625516355164551655516655167551685516955170551715517255173551745517555176551775517855179551805518155182551835518455185551865518755188551895519055191551925519355194551955519655197551985519955200552015520255203552045520555206552075520855209552105521155212552135521455215552165521755218552195522055221552225522355224552255522655227552285522955230552315523255233552345523555236552375523855239552405524155242552435524455245552465524755248552495525055251552525525355254552555525655257552585525955260552615526255263552645526555266552675526855269552705527155272552735527455275552765527755278552795528055281552825528355284552855528655287552885528955290552915529255293552945529555296552975529855299553005530155302553035530455305553065530755308553095531055311553125531355314553155531655317553185531955320553215532255323553245532555326553275532855329553305533155332553335533455335553365533755338553395534055341553425534355344553455534655347553485534955350553515535255353553545535555356553575535855359553605536155362553635536455365553665536755368553695537055371553725537355374553755537655377553785537955380553815538255383553845538555386553875538855389553905539155392553935539455395553965539755398553995540055401554025540355404554055540655407554085540955410554115541255413554145541555416554175541855419554205542155422554235542455425554265542755428554295543055431554325543355434554355543655437554385543955440554415544255443554445544555446554475544855449554505545155452554535545455455554565545755458554595546055461554625546355464554655546655467554685546955470554715547255473554745547555476554775547855479554805548155482554835548455485554865548755488554895549055491554925549355494554955549655497554985549955500555015550255503555045550555506555075550855509555105551155512555135551455515555165551755518555195552055521555225552355524555255552655527555285552955530555315553255533555345553555536555375553855539555405554155542555435554455545555465554755548555495555055551555525555355554555555555655557555585555955560555615556255563555645556555566555675556855569555705557155572555735557455575555765557755578555795558055581555825558355584555855558655587555885558955590555915559255593555945559555596555975559855599556005560155602556035560455605556065560755608556095561055611556125561355614556155561655617556185561955620556215562255623556245562555626556275562855629556305563155632556335563455635556365563755638556395564055641556425564355644556455564655647556485564955650556515565255653556545565555656556575565855659556605566155662556635566455665556665566755668556695567055671556725567355674556755567655677556785567955680556815568255683556845568555686556875568855689556905569155692556935569455695556965569755698556995570055701557025570355704557055570655707557085570955710557115571255713557145571555716557175571855719557205572155722557235572455725557265572755728557295573055731557325573355734557355573655737557385573955740557415574255743557445574555746557475574855749557505575155752557535575455755557565575755758557595576055761557625576355764557655576655767557685576955770557715577255773557745577555776557775577855779557805578155782557835578455785557865578755788557895579055791557925579355794557955579655797557985579955800558015580255803558045580555806558075580855809558105581155812558135581455815558165581755818558195582055821558225582355824558255582655827558285582955830558315583255833558345583555836558375583855839558405584155842558435584455845558465584755848558495585055851558525585355854558555585655857558585585955860558615586255863558645586555866558675586855869558705587155872558735587455875558765587755878558795588055881558825588355884558855588655887558885588955890558915589255893558945589555896558975589855899559005590155902559035590455905559065590755908559095591055911559125591355914559155591655917559185591955920559215592255923559245592555926559275592855929559305593155932559335593455935559365593755938559395594055941559425594355944559455594655947559485594955950559515595255953559545595555956559575595855959559605596155962559635596455965559665596755968559695597055971559725597355974559755597655977559785597955980559815598255983559845598555986559875598855989559905599155992559935599455995559965599755998559995600056001560025600356004560055600656007560085600956010560115601256013560145601556016560175601856019560205602156022560235602456025560265602756028560295603056031560325603356034560355603656037560385603956040560415604256043560445604556046560475604856049560505605156052560535605456055560565605756058560595606056061560625606356064560655606656067560685606956070560715607256073560745607556076560775607856079560805608156082560835608456085560865608756088560895609056091560925609356094560955609656097560985609956100561015610256103561045610556106561075610856109561105611156112561135611456115561165611756118561195612056121561225612356124561255612656127561285612956130561315613256133561345613556136561375613856139561405614156142561435614456145561465614756148561495615056151561525615356154561555615656157561585615956160561615616256163561645616556166561675616856169561705617156172561735617456175561765617756178561795618056181561825618356184561855618656187561885618956190561915619256193561945619556196561975619856199562005620156202562035620456205562065620756208562095621056211562125621356214562155621656217562185621956220562215622256223562245622556226562275622856229562305623156232562335623456235562365623756238562395624056241562425624356244562455624656247562485624956250562515625256253562545625556256562575625856259562605626156262562635626456265562665626756268562695627056271562725627356274562755627656277562785627956280562815628256283562845628556286562875628856289562905629156292562935629456295562965629756298562995630056301563025630356304563055630656307563085630956310563115631256313563145631556316563175631856319563205632156322563235632456325563265632756328563295633056331563325633356334563355633656337563385633956340563415634256343563445634556346563475634856349563505635156352563535635456355563565635756358563595636056361563625636356364563655636656367563685636956370563715637256373563745637556376563775637856379563805638156382563835638456385563865638756388563895639056391563925639356394563955639656397563985639956400564015640256403564045640556406564075640856409564105641156412564135641456415564165641756418564195642056421564225642356424564255642656427564285642956430564315643256433564345643556436564375643856439564405644156442564435644456445564465644756448564495645056451564525645356454564555645656457564585645956460564615646256463564645646556466564675646856469564705647156472564735647456475564765647756478564795648056481564825648356484564855648656487564885648956490564915649256493564945649556496564975649856499565005650156502565035650456505565065650756508565095651056511565125651356514565155651656517565185651956520565215652256523565245652556526565275652856529565305653156532565335653456535565365653756538565395654056541565425654356544565455654656547565485654956550565515655256553565545655556556565575655856559565605656156562565635656456565565665656756568565695657056571565725657356574565755657656577565785657956580565815658256583565845658556586565875658856589565905659156592565935659456595565965659756598565995660056601566025660356604566055660656607566085660956610566115661256613566145661556616566175661856619566205662156622566235662456625566265662756628566295663056631566325663356634566355663656637566385663956640566415664256643566445664556646566475664856649566505665156652566535665456655566565665756658566595666056661566625666356664566655666656667566685666956670566715667256673566745667556676566775667856679566805668156682566835668456685566865668756688566895669056691566925669356694566955669656697566985669956700567015670256703567045670556706567075670856709567105671156712567135671456715567165671756718567195672056721567225672356724567255672656727567285672956730567315673256733567345673556736567375673856739567405674156742567435674456745567465674756748567495675056751567525675356754567555675656757567585675956760567615676256763567645676556766567675676856769567705677156772567735677456775567765677756778567795678056781567825678356784567855678656787567885678956790567915679256793567945679556796567975679856799568005680156802568035680456805568065680756808568095681056811568125681356814568155681656817568185681956820568215682256823568245682556826568275682856829568305683156832568335683456835568365683756838568395684056841568425684356844568455684656847568485684956850568515685256853568545685556856568575685856859568605686156862568635686456865568665686756868568695687056871568725687356874568755687656877568785687956880568815688256883568845688556886568875688856889568905689156892568935689456895568965689756898568995690056901569025690356904569055690656907569085690956910569115691256913569145691556916569175691856919569205692156922569235692456925569265692756928569295693056931569325693356934569355693656937569385693956940569415694256943569445694556946569475694856949569505695156952569535695456955569565695756958569595696056961569625696356964569655696656967569685696956970569715697256973569745697556976569775697856979569805698156982569835698456985569865698756988569895699056991569925699356994569955699656997569985699957000570015700257003570045700557006570075700857009570105701157012570135701457015570165701757018570195702057021570225702357024570255702657027570285702957030570315703257033570345703557036570375703857039570405704157042570435704457045570465704757048570495705057051570525705357054570555705657057570585705957060570615706257063570645706557066570675706857069570705707157072570735707457075570765707757078570795708057081570825708357084570855708657087570885708957090570915709257093570945709557096570975709857099571005710157102571035710457105571065710757108571095711057111571125711357114571155711657117571185711957120571215712257123571245712557126571275712857129571305713157132571335713457135571365713757138571395714057141571425714357144571455714657147571485714957150571515715257153571545715557156571575715857159571605716157162571635716457165571665716757168571695717057171571725717357174571755717657177571785717957180571815718257183571845718557186571875718857189571905719157192571935719457195571965719757198571995720057201572025720357204572055720657207572085720957210572115721257213572145721557216572175721857219572205722157222572235722457225572265722757228572295723057231572325723357234572355723657237572385723957240572415724257243572445724557246572475724857249572505725157252572535725457255572565725757258572595726057261572625726357264572655726657267572685726957270572715727257273572745727557276572775727857279572805728157282572835728457285572865728757288572895729057291572925729357294572955729657297572985729957300573015730257303573045730557306573075730857309573105731157312573135731457315573165731757318573195732057321573225732357324573255732657327573285732957330573315733257333573345733557336573375733857339573405734157342573435734457345573465734757348573495735057351573525735357354573555735657357573585735957360573615736257363573645736557366573675736857369573705737157372573735737457375573765737757378573795738057381573825738357384573855738657387573885738957390573915739257393573945739557396573975739857399574005740157402574035740457405574065740757408574095741057411574125741357414574155741657417574185741957420574215742257423574245742557426574275742857429574305743157432574335743457435574365743757438574395744057441574425744357444574455744657447574485744957450574515745257453574545745557456574575745857459574605746157462574635746457465574665746757468574695747057471574725747357474574755747657477574785747957480574815748257483574845748557486574875748857489574905749157492574935749457495574965749757498574995750057501575025750357504575055750657507575085750957510575115751257513575145751557516575175751857519575205752157522575235752457525575265752757528575295753057531575325753357534575355753657537575385753957540575415754257543575445754557546575475754857549575505755157552575535755457555575565755757558575595756057561575625756357564575655756657567575685756957570575715757257573575745757557576575775757857579575805758157582575835758457585575865758757588575895759057591575925759357594575955759657597575985759957600576015760257603576045760557606576075760857609576105761157612576135761457615576165761757618576195762057621576225762357624576255762657627576285762957630576315763257633576345763557636576375763857639576405764157642576435764457645576465764757648576495765057651576525765357654576555765657657576585765957660576615766257663576645766557666576675766857669576705767157672576735767457675576765767757678576795768057681576825768357684576855768657687576885768957690576915769257693576945769557696576975769857699577005770157702577035770457705577065770757708577095771057711577125771357714577155771657717577185771957720577215772257723577245772557726577275772857729577305773157732577335773457735577365773757738577395774057741577425774357744577455774657747577485774957750577515775257753577545775557756577575775857759577605776157762577635776457765577665776757768577695777057771577725777357774577755777657777577785777957780577815778257783577845778557786577875778857789577905779157792577935779457795577965779757798577995780057801578025780357804578055780657807578085780957810578115781257813578145781557816578175781857819578205782157822578235782457825578265782757828578295783057831578325783357834578355783657837578385783957840578415784257843578445784557846578475784857849578505785157852578535785457855578565785757858578595786057861578625786357864578655786657867578685786957870578715787257873578745787557876578775787857879578805788157882578835788457885578865788757888578895789057891578925789357894578955789657897578985789957900579015790257903579045790557906579075790857909579105791157912579135791457915579165791757918579195792057921579225792357924579255792657927579285792957930579315793257933579345793557936579375793857939579405794157942579435794457945579465794757948579495795057951579525795357954579555795657957579585795957960579615796257963579645796557966579675796857969579705797157972579735797457975579765797757978579795798057981579825798357984579855798657987579885798957990579915799257993579945799557996579975799857999580005800158002580035800458005580065800758008580095801058011580125801358014580155801658017580185801958020580215802258023580245802558026580275802858029580305803158032580335803458035580365803758038580395804058041580425804358044580455804658047580485804958050580515805258053580545805558056580575805858059580605806158062580635806458065580665806758068580695807058071580725807358074580755807658077580785807958080580815808258083580845808558086580875808858089580905809158092580935809458095580965809758098580995810058101581025810358104581055810658107581085810958110581115811258113581145811558116581175811858119581205812158122581235812458125581265812758128581295813058131581325813358134581355813658137581385813958140581415814258143581445814558146581475814858149581505815158152581535815458155581565815758158581595816058161581625816358164581655816658167581685816958170581715817258173581745817558176581775817858179581805818158182581835818458185581865818758188581895819058191581925819358194581955819658197581985819958200582015820258203582045820558206582075820858209582105821158212582135821458215582165821758218582195822058221582225822358224582255822658227582285822958230582315823258233582345823558236582375823858239582405824158242582435824458245582465824758248582495825058251582525825358254582555825658257582585825958260582615826258263582645826558266582675826858269582705827158272582735827458275582765827758278582795828058281582825828358284582855828658287582885828958290582915829258293582945829558296582975829858299583005830158302583035830458305583065830758308583095831058311583125831358314583155831658317583185831958320583215832258323583245832558326583275832858329583305833158332583335833458335583365833758338583395834058341583425834358344583455834658347583485834958350583515835258353583545835558356583575835858359583605836158362583635836458365583665836758368583695837058371583725837358374583755837658377583785837958380583815838258383583845838558386583875838858389583905839158392583935839458395583965839758398583995840058401584025840358404584055840658407584085840958410584115841258413584145841558416584175841858419584205842158422584235842458425584265842758428584295843058431584325843358434584355843658437584385843958440584415844258443584445844558446584475844858449584505845158452584535845458455584565845758458584595846058461584625846358464584655846658467584685846958470584715847258473584745847558476584775847858479584805848158482584835848458485584865848758488584895849058491584925849358494584955849658497584985849958500585015850258503585045850558506585075850858509585105851158512585135851458515585165851758518585195852058521585225852358524585255852658527585285852958530585315853258533585345853558536585375853858539585405854158542585435854458545585465854758548585495855058551585525855358554585555855658557585585855958560585615856258563585645856558566585675856858569585705857158572585735857458575585765857758578585795858058581585825858358584585855858658587585885858958590585915859258593585945859558596585975859858599586005860158602586035860458605586065860758608586095861058611586125861358614586155861658617586185861958620586215862258623586245862558626586275862858629586305863158632586335863458635586365863758638586395864058641586425864358644586455864658647586485864958650586515865258653586545865558656586575865858659586605866158662586635866458665586665866758668586695867058671586725867358674586755867658677586785867958680586815868258683586845868558686586875868858689586905869158692586935869458695586965869758698586995870058701587025870358704587055870658707587085870958710587115871258713587145871558716587175871858719587205872158722587235872458725587265872758728587295873058731587325873358734587355873658737587385873958740587415874258743587445874558746587475874858749587505875158752587535875458755587565875758758587595876058761587625876358764587655876658767587685876958770587715877258773587745877558776587775877858779587805878158782587835878458785587865878758788587895879058791587925879358794587955879658797587985879958800588015880258803588045880558806588075880858809588105881158812588135881458815588165881758818588195882058821588225882358824588255882658827588285882958830588315883258833588345883558836588375883858839588405884158842588435884458845588465884758848588495885058851588525885358854588555885658857588585885958860588615886258863588645886558866588675886858869588705887158872588735887458875588765887758878588795888058881588825888358884588855888658887588885888958890588915889258893588945889558896588975889858899589005890158902589035890458905589065890758908589095891058911589125891358914589155891658917589185891958920589215892258923589245892558926589275892858929589305893158932589335893458935589365893758938589395894058941589425894358944589455894658947589485894958950589515895258953589545895558956589575895858959589605896158962589635896458965589665896758968589695897058971589725897358974589755897658977589785897958980589815898258983589845898558986589875898858989589905899158992589935899458995589965899758998589995900059001590025900359004590055900659007590085900959010590115901259013590145901559016590175901859019590205902159022590235902459025590265902759028590295903059031590325903359034590355903659037590385903959040590415904259043590445904559046590475904859049590505905159052590535905459055590565905759058590595906059061590625906359064590655906659067590685906959070590715907259073590745907559076590775907859079590805908159082590835908459085590865908759088590895909059091590925909359094590955909659097590985909959100591015910259103591045910559106591075910859109591105911159112591135911459115591165911759118591195912059121591225912359124591255912659127591285912959130591315913259133591345913559136591375913859139591405914159142591435914459145591465914759148591495915059151591525915359154591555915659157591585915959160591615916259163591645916559166591675916859169591705917159172591735917459175591765917759178591795918059181591825918359184591855918659187591885918959190591915919259193591945919559196591975919859199592005920159202592035920459205592065920759208592095921059211592125921359214592155921659217592185921959220592215922259223592245922559226592275922859229592305923159232592335923459235592365923759238592395924059241592425924359244592455924659247592485924959250592515925259253592545925559256592575925859259592605926159262592635926459265592665926759268592695927059271592725927359274592755927659277592785927959280592815928259283592845928559286592875928859289592905929159292592935929459295592965929759298592995930059301593025930359304593055930659307593085930959310593115931259313593145931559316593175931859319593205932159322593235932459325593265932759328593295933059331593325933359334593355933659337593385933959340593415934259343593445934559346593475934859349593505935159352593535935459355593565935759358593595936059361593625936359364593655936659367593685936959370593715937259373593745937559376593775937859379593805938159382593835938459385593865938759388593895939059391593925939359394593955939659397593985939959400594015940259403594045940559406594075940859409594105941159412594135941459415594165941759418594195942059421594225942359424594255942659427594285942959430594315943259433594345943559436594375943859439594405944159442594435944459445594465944759448594495945059451594525945359454594555945659457594585945959460594615946259463594645946559466594675946859469594705947159472594735947459475594765947759478594795948059481594825948359484594855948659487594885948959490594915949259493594945949559496594975949859499595005950159502595035950459505595065950759508595095951059511595125951359514595155951659517595185951959520595215952259523595245952559526595275952859529595305953159532595335953459535595365953759538595395954059541595425954359544595455954659547595485954959550595515955259553595545955559556595575955859559595605956159562595635956459565595665956759568595695957059571595725957359574595755957659577595785957959580595815958259583595845958559586595875958859589595905959159592595935959459595595965959759598595995960059601596025960359604596055960659607596085960959610596115961259613596145961559616596175961859619596205962159622596235962459625596265962759628596295963059631596325963359634596355963659637596385963959640596415964259643596445964559646596475964859649596505965159652596535965459655596565965759658596595966059661596625966359664596655966659667596685966959670596715967259673596745967559676596775967859679596805968159682596835968459685596865968759688596895969059691596925969359694596955969659697596985969959700597015970259703597045970559706597075970859709597105971159712597135971459715597165971759718597195972059721597225972359724597255972659727597285972959730597315973259733597345973559736597375973859739597405974159742597435974459745597465974759748597495975059751597525975359754597555975659757597585975959760597615976259763597645976559766597675976859769597705977159772597735977459775597765977759778597795978059781597825978359784597855978659787597885978959790597915979259793597945979559796597975979859799598005980159802598035980459805598065980759808598095981059811598125981359814598155981659817598185981959820598215982259823598245982559826598275982859829598305983159832598335983459835598365983759838598395984059841598425984359844598455984659847598485984959850598515985259853598545985559856598575985859859598605986159862598635986459865598665986759868598695987059871598725987359874598755987659877598785987959880598815988259883598845988559886598875988859889598905989159892598935989459895598965989759898598995990059901599025990359904599055990659907599085990959910599115991259913599145991559916599175991859919599205992159922599235992459925599265992759928599295993059931599325993359934599355993659937599385993959940599415994259943599445994559946599475994859949599505995159952599535995459955599565995759958599595996059961599625996359964599655996659967599685996959970599715997259973599745997559976599775997859979599805998159982599835998459985599865998759988599895999059991599925999359994599955999659997599985999960000600016000260003600046000560006600076000860009600106001160012600136001460015600166001760018600196002060021600226002360024600256002660027600286002960030600316003260033600346003560036600376003860039600406004160042600436004460045600466004760048600496005060051600526005360054600556005660057600586005960060600616006260063600646006560066600676006860069600706007160072600736007460075600766007760078600796008060081600826008360084600856008660087600886008960090600916009260093600946009560096600976009860099601006010160102601036010460105601066010760108601096011060111601126011360114601156011660117601186011960120601216012260123601246012560126601276012860129601306013160132601336013460135601366013760138601396014060141601426014360144601456014660147601486014960150601516015260153601546015560156601576015860159601606016160162601636016460165601666016760168601696017060171601726017360174601756017660177601786017960180601816018260183601846018560186601876018860189601906019160192601936019460195601966019760198601996020060201602026020360204602056020660207602086020960210602116021260213602146021560216602176021860219602206022160222602236022460225602266022760228602296023060231602326023360234602356023660237602386023960240602416024260243602446024560246602476024860249602506025160252602536025460255602566025760258602596026060261602626026360264602656026660267602686026960270602716027260273602746027560276602776027860279602806028160282602836028460285602866028760288602896029060291602926029360294602956029660297602986029960300603016030260303603046030560306603076030860309603106031160312603136031460315603166031760318603196032060321603226032360324603256032660327603286032960330603316033260333603346033560336603376033860339603406034160342603436034460345603466034760348603496035060351603526035360354603556035660357603586035960360603616036260363603646036560366603676036860369603706037160372603736037460375603766037760378603796038060381603826038360384603856038660387603886038960390603916039260393603946039560396603976039860399604006040160402604036040460405604066040760408604096041060411604126041360414604156041660417604186041960420604216042260423604246042560426604276042860429604306043160432604336043460435604366043760438604396044060441604426044360444604456044660447604486044960450604516045260453604546045560456604576045860459604606046160462604636046460465604666046760468604696047060471604726047360474604756047660477604786047960480604816048260483604846048560486604876048860489604906049160492604936049460495604966049760498604996050060501605026050360504605056050660507605086050960510605116051260513605146051560516605176051860519605206052160522605236052460525605266052760528605296053060531605326053360534605356053660537605386053960540605416054260543605446054560546605476054860549605506055160552605536055460555605566055760558605596056060561605626056360564605656056660567605686056960570605716057260573605746057560576605776057860579605806058160582605836058460585605866058760588605896059060591605926059360594605956059660597605986059960600606016060260603606046060560606606076060860609606106061160612606136061460615606166061760618606196062060621606226062360624606256062660627606286062960630606316063260633606346063560636606376063860639606406064160642606436064460645606466064760648606496065060651606526065360654606556065660657606586065960660606616066260663606646066560666606676066860669606706067160672606736067460675606766067760678606796068060681606826068360684606856068660687606886068960690606916069260693606946069560696606976069860699607006070160702607036070460705607066070760708607096071060711607126071360714607156071660717607186071960720607216072260723607246072560726607276072860729607306073160732607336073460735607366073760738607396074060741607426074360744607456074660747607486074960750607516075260753607546075560756607576075860759607606076160762607636076460765607666076760768607696077060771607726077360774607756077660777607786077960780607816078260783607846078560786607876078860789607906079160792607936079460795607966079760798607996080060801608026080360804608056080660807608086080960810608116081260813608146081560816608176081860819608206082160822608236082460825608266082760828608296083060831608326083360834608356083660837608386083960840608416084260843608446084560846608476084860849608506085160852608536085460855608566085760858608596086060861608626086360864608656086660867608686086960870608716087260873608746087560876608776087860879608806088160882608836088460885608866088760888608896089060891608926089360894608956089660897608986089960900609016090260903609046090560906609076090860909609106091160912609136091460915609166091760918609196092060921609226092360924609256092660927609286092960930609316093260933609346093560936609376093860939609406094160942609436094460945609466094760948609496095060951609526095360954609556095660957609586095960960609616096260963609646096560966609676096860969609706097160972609736097460975609766097760978609796098060981609826098360984609856098660987609886098960990609916099260993609946099560996609976099860999610006100161002610036100461005610066100761008610096101061011610126101361014610156101661017610186101961020610216102261023610246102561026610276102861029610306103161032610336103461035610366103761038610396104061041610426104361044610456104661047610486104961050610516105261053610546105561056610576105861059610606106161062610636106461065610666106761068610696107061071610726107361074610756107661077610786107961080610816108261083610846108561086610876108861089610906109161092610936109461095610966109761098610996110061101611026110361104611056110661107611086110961110611116111261113611146111561116611176111861119611206112161122611236112461125611266112761128611296113061131611326113361134611356113661137611386113961140611416114261143611446114561146611476114861149611506115161152611536115461155611566115761158611596116061161611626116361164611656116661167611686116961170611716117261173611746117561176611776117861179611806118161182611836118461185611866118761188611896119061191611926119361194611956119661197611986119961200612016120261203612046120561206612076120861209612106121161212612136121461215612166121761218612196122061221612226122361224612256122661227612286122961230612316123261233612346123561236612376123861239612406124161242612436124461245612466124761248612496125061251612526125361254612556125661257612586125961260612616126261263612646126561266612676126861269612706127161272612736127461275612766127761278612796128061281612826128361284612856128661287612886128961290612916129261293612946129561296612976129861299613006130161302613036130461305613066130761308613096131061311613126131361314613156131661317613186131961320613216132261323613246132561326613276132861329613306133161332613336133461335613366133761338613396134061341613426134361344613456134661347613486134961350613516135261353613546135561356613576135861359613606136161362613636136461365613666136761368613696137061371613726137361374613756137661377613786137961380613816138261383613846138561386613876138861389613906139161392613936139461395613966139761398613996140061401614026140361404614056140661407614086140961410614116141261413614146141561416614176141861419614206142161422614236142461425614266142761428614296143061431614326143361434614356143661437614386143961440614416144261443614446144561446614476144861449614506145161452614536145461455614566145761458614596146061461614626146361464614656146661467614686146961470614716147261473614746147561476614776147861479614806148161482614836148461485614866148761488614896149061491614926149361494614956149661497614986149961500615016150261503615046150561506615076150861509615106151161512615136151461515615166151761518615196152061521615226152361524615256152661527615286152961530615316153261533615346153561536615376153861539615406154161542615436154461545615466154761548615496155061551615526155361554615556155661557615586155961560615616156261563615646156561566615676156861569615706157161572615736157461575615766157761578615796158061581615826158361584615856158661587615886158961590615916159261593615946159561596615976159861599616006160161602616036160461605616066160761608616096161061611616126161361614616156161661617616186161961620616216162261623616246162561626616276162861629616306163161632616336163461635616366163761638616396164061641616426164361644616456164661647616486164961650616516165261653616546165561656616576165861659616606166161662616636166461665616666166761668616696167061671616726167361674616756167661677616786167961680616816168261683616846168561686616876168861689616906169161692616936169461695616966169761698616996170061701617026170361704617056170661707617086170961710617116171261713617146171561716617176171861719617206172161722617236172461725617266172761728617296173061731617326173361734617356173661737617386173961740617416174261743617446174561746617476174861749617506175161752617536175461755617566175761758617596176061761617626176361764617656176661767617686176961770617716177261773617746177561776617776177861779617806178161782617836178461785617866178761788617896179061791617926179361794617956179661797617986179961800618016180261803618046180561806618076180861809618106181161812618136181461815618166181761818618196182061821618226182361824618256182661827618286182961830618316183261833618346183561836618376183861839618406184161842618436184461845618466184761848618496185061851618526185361854618556185661857618586185961860618616186261863618646186561866618676186861869618706187161872618736187461875618766187761878618796188061881618826188361884618856188661887618886188961890618916189261893618946189561896618976189861899619006190161902619036190461905619066190761908619096191061911619126191361914619156191661917619186191961920619216192261923619246192561926619276192861929619306193161932619336193461935619366193761938619396194061941619426194361944619456194661947619486194961950619516195261953619546195561956619576195861959619606196161962619636196461965619666196761968619696197061971619726197361974619756197661977619786197961980619816198261983619846198561986619876198861989619906199161992619936199461995619966199761998619996200062001620026200362004620056200662007620086200962010620116201262013620146201562016620176201862019620206202162022620236202462025620266202762028620296203062031620326203362034620356203662037620386203962040620416204262043620446204562046620476204862049620506205162052620536205462055620566205762058620596206062061620626206362064620656206662067620686206962070620716207262073620746207562076620776207862079620806208162082620836208462085620866208762088620896209062091620926209362094620956209662097620986209962100621016210262103621046210562106621076210862109621106211162112621136211462115621166211762118621196212062121621226212362124621256212662127621286212962130621316213262133621346213562136621376213862139621406214162142621436214462145621466214762148621496215062151621526215362154621556215662157621586215962160621616216262163621646216562166621676216862169621706217162172621736217462175621766217762178621796218062181621826218362184621856218662187621886218962190621916219262193621946219562196621976219862199622006220162202622036220462205622066220762208622096221062211622126221362214622156221662217622186221962220622216222262223622246222562226622276222862229622306223162232622336223462235622366223762238622396224062241622426224362244622456224662247622486224962250622516225262253622546225562256622576225862259622606226162262622636226462265622666226762268622696227062271622726227362274622756227662277622786227962280622816228262283622846228562286622876228862289622906229162292622936229462295622966229762298622996230062301623026230362304623056230662307623086230962310623116231262313623146231562316623176231862319623206232162322623236232462325623266232762328623296233062331623326233362334623356233662337623386233962340623416234262343623446234562346623476234862349623506235162352623536235462355623566235762358623596236062361623626236362364623656236662367623686236962370623716237262373623746237562376623776237862379623806238162382623836238462385623866238762388623896239062391623926239362394623956239662397623986239962400624016240262403624046240562406624076240862409624106241162412624136241462415624166241762418624196242062421624226242362424624256242662427624286242962430624316243262433624346243562436624376243862439624406244162442624436244462445624466244762448624496245062451624526245362454624556245662457624586245962460624616246262463624646246562466624676246862469624706247162472624736247462475624766247762478624796248062481624826248362484624856248662487624886248962490624916249262493624946249562496624976249862499625006250162502625036250462505625066250762508625096251062511625126251362514625156251662517625186251962520625216252262523625246252562526625276252862529625306253162532625336253462535625366253762538625396254062541625426254362544625456254662547625486254962550625516255262553625546255562556625576255862559625606256162562625636256462565625666256762568625696257062571625726257362574625756257662577625786257962580625816258262583625846258562586625876258862589625906259162592625936259462595625966259762598625996260062601626026260362604626056260662607626086260962610626116261262613626146261562616626176261862619626206262162622626236262462625626266262762628626296263062631626326263362634626356263662637626386263962640626416264262643626446264562646626476264862649626506265162652626536265462655626566265762658626596266062661626626266362664626656266662667626686266962670626716267262673626746267562676626776267862679626806268162682626836268462685626866268762688626896269062691626926269362694626956269662697626986269962700627016270262703627046270562706627076270862709627106271162712627136271462715627166271762718627196272062721627226272362724627256272662727627286272962730627316273262733627346273562736627376273862739627406274162742627436274462745627466274762748627496275062751627526275362754627556275662757627586275962760627616276262763627646276562766627676276862769627706277162772627736277462775627766277762778627796278062781627826278362784627856278662787627886278962790627916279262793627946279562796627976279862799628006280162802628036280462805628066280762808628096281062811628126281362814628156281662817628186281962820628216282262823628246282562826628276282862829628306283162832628336283462835628366283762838628396284062841628426284362844628456284662847628486284962850628516285262853628546285562856628576285862859628606286162862628636286462865628666286762868628696287062871628726287362874628756287662877628786287962880628816288262883628846288562886628876288862889628906289162892628936289462895628966289762898628996290062901629026290362904629056290662907629086290962910629116291262913629146291562916629176291862919629206292162922629236292462925629266292762928629296293062931629326293362934629356293662937629386293962940629416294262943629446294562946629476294862949629506295162952629536295462955629566295762958629596296062961629626296362964629656296662967629686296962970629716297262973629746297562976629776297862979629806298162982629836298462985629866298762988629896299062991629926299362994629956299662997629986299963000630016300263003630046300563006630076300863009630106301163012630136301463015630166301763018630196302063021630226302363024630256302663027630286302963030630316303263033630346303563036630376303863039630406304163042630436304463045630466304763048630496305063051630526305363054630556305663057630586305963060630616306263063630646306563066630676306863069630706307163072630736307463075630766307763078630796308063081630826308363084630856308663087630886308963090630916309263093630946309563096630976309863099631006310163102631036310463105631066310763108631096311063111631126311363114631156311663117631186311963120631216312263123631246312563126631276312863129631306313163132631336313463135631366313763138631396314063141631426314363144631456314663147631486314963150631516315263153631546315563156631576315863159631606316163162631636316463165631666316763168631696317063171631726317363174631756317663177631786317963180631816318263183631846318563186631876318863189631906319163192631936319463195631966319763198631996320063201632026320363204632056320663207632086320963210632116321263213632146321563216632176321863219632206322163222632236322463225632266322763228632296323063231632326323363234632356323663237632386323963240632416324263243632446324563246632476324863249632506325163252632536325463255632566325763258632596326063261632626326363264632656326663267632686326963270632716327263273632746327563276632776327863279632806328163282632836328463285632866328763288632896329063291632926329363294632956329663297632986329963300633016330263303633046330563306633076330863309633106331163312633136331463315633166331763318633196332063321633226332363324633256332663327633286332963330633316333263333633346333563336633376333863339633406334163342633436334463345633466334763348633496335063351633526335363354633556335663357633586335963360633616336263363633646336563366633676336863369633706337163372633736337463375633766337763378633796338063381633826338363384633856338663387633886338963390633916339263393633946339563396633976339863399634006340163402634036340463405634066340763408634096341063411634126341363414634156341663417634186341963420634216342263423634246342563426634276342863429634306343163432634336343463435634366343763438634396344063441634426344363444634456344663447634486344963450634516345263453634546345563456634576345863459634606346163462634636346463465634666346763468634696347063471634726347363474634756347663477634786347963480634816348263483634846348563486634876348863489634906349163492634936349463495634966349763498634996350063501635026350363504635056350663507635086350963510635116351263513635146351563516635176351863519635206352163522635236352463525635266352763528635296353063531635326353363534635356353663537635386353963540635416354263543635446354563546635476354863549635506355163552635536355463555635566355763558635596356063561635626356363564635656356663567635686356963570635716357263573635746357563576635776357863579635806358163582635836358463585635866358763588635896359063591635926359363594635956359663597635986359963600636016360263603636046360563606636076360863609636106361163612636136361463615636166361763618636196362063621636226362363624636256362663627636286362963630636316363263633636346363563636636376363863639636406364163642636436364463645636466364763648636496365063651636526365363654636556365663657636586365963660636616366263663636646366563666636676366863669636706367163672636736367463675636766367763678636796368063681636826368363684636856368663687636886368963690636916369263693636946369563696636976369863699637006370163702637036370463705637066370763708637096371063711637126371363714637156371663717637186371963720637216372263723637246372563726637276372863729637306373163732637336373463735637366373763738637396374063741637426374363744637456374663747637486374963750637516375263753637546375563756637576375863759637606376163762637636376463765637666376763768637696377063771637726377363774637756377663777637786377963780637816378263783637846378563786637876378863789637906379163792637936379463795637966379763798637996380063801638026380363804638056380663807638086380963810638116381263813638146381563816638176381863819638206382163822638236382463825638266382763828638296383063831638326383363834638356383663837638386383963840638416384263843638446384563846638476384863849638506385163852638536385463855638566385763858638596386063861638626386363864638656386663867638686386963870638716387263873638746387563876638776387863879638806388163882638836388463885638866388763888638896389063891638926389363894638956389663897638986389963900639016390263903639046390563906639076390863909639106391163912639136391463915639166391763918639196392063921639226392363924639256392663927639286392963930639316393263933639346393563936639376393863939639406394163942639436394463945639466394763948639496395063951639526395363954639556395663957639586395963960639616396263963639646396563966639676396863969639706397163972639736397463975639766397763978639796398063981639826398363984639856398663987639886398963990639916399263993639946399563996639976399863999640006400164002640036400464005640066400764008640096401064011640126401364014640156401664017640186401964020640216402264023640246402564026640276402864029640306403164032640336403464035640366403764038640396404064041640426404364044640456404664047640486404964050640516405264053640546405564056640576405864059640606406164062640636406464065640666406764068640696407064071640726407364074640756407664077640786407964080640816408264083640846408564086640876408864089640906409164092640936409464095640966409764098640996410064101641026410364104641056410664107641086410964110641116411264113641146411564116641176411864119641206412164122641236412464125641266412764128641296413064131641326413364134641356413664137641386413964140641416414264143641446414564146641476414864149641506415164152641536415464155641566415764158641596416064161641626416364164641656416664167641686416964170641716417264173641746417564176641776417864179641806418164182641836418464185641866418764188641896419064191641926419364194641956419664197641986419964200642016420264203642046420564206642076420864209642106421164212642136421464215642166421764218642196422064221642226422364224642256422664227642286422964230642316423264233642346423564236642376423864239642406424164242642436424464245642466424764248642496425064251642526425364254642556425664257642586425964260642616426264263642646426564266642676426864269642706427164272642736427464275642766427764278642796428064281642826428364284642856428664287642886428964290642916429264293642946429564296642976429864299643006430164302643036430464305643066430764308643096431064311643126431364314643156431664317643186431964320643216432264323643246432564326643276432864329643306433164332643336433464335643366433764338643396434064341643426434364344643456434664347643486434964350643516435264353643546435564356643576435864359643606436164362643636436464365643666436764368643696437064371643726437364374643756437664377643786437964380643816438264383643846438564386643876438864389643906439164392643936439464395643966439764398643996440064401644026440364404644056440664407644086440964410644116441264413644146441564416644176441864419644206442164422644236442464425644266442764428644296443064431644326443364434644356443664437644386443964440644416444264443644446444564446644476444864449644506445164452644536445464455644566445764458644596446064461644626446364464644656446664467644686446964470644716447264473644746447564476644776447864479644806448164482644836448464485644866448764488644896449064491644926449364494644956449664497644986449964500645016450264503645046450564506645076450864509645106451164512645136451464515645166451764518645196452064521645226452364524645256452664527645286452964530645316453264533645346453564536645376453864539645406454164542645436454464545645466454764548645496455064551645526455364554645556455664557645586455964560645616456264563645646456564566645676456864569645706457164572645736457464575645766457764578645796458064581645826458364584645856458664587645886458964590645916459264593645946459564596645976459864599646006460164602646036460464605646066460764608646096461064611646126461364614646156461664617646186461964620646216462264623646246462564626646276462864629646306463164632646336463464635646366463764638646396464064641646426464364644646456464664647646486464964650646516465264653646546465564656646576465864659646606466164662646636466464665646666466764668646696467064671646726467364674646756467664677646786467964680646816468264683646846468564686646876468864689646906469164692646936469464695646966469764698646996470064701647026470364704647056470664707647086470964710647116471264713647146471564716647176471864719647206472164722647236472464725647266472764728647296473064731647326473364734647356473664737647386473964740647416474264743647446474564746647476474864749647506475164752647536475464755647566475764758647596476064761647626476364764647656476664767647686476964770647716477264773647746477564776647776477864779647806478164782647836478464785647866478764788647896479064791647926479364794647956479664797647986479964800648016480264803648046480564806648076480864809648106481164812648136481464815648166481764818648196482064821648226482364824648256482664827648286482964830648316483264833648346483564836648376483864839648406484164842648436484464845648466484764848648496485064851648526485364854648556485664857648586485964860648616486264863648646486564866648676486864869648706487164872648736487464875648766487764878648796488064881648826488364884648856488664887648886488964890648916489264893648946489564896648976489864899649006490164902649036490464905649066490764908649096491064911649126491364914649156491664917649186491964920649216492264923649246492564926649276492864929649306493164932649336493464935649366493764938649396494064941649426494364944649456494664947649486494964950649516495264953649546495564956649576495864959649606496164962649636496464965649666496764968649696497064971649726497364974649756497664977649786497964980649816498264983649846498564986649876498864989649906499164992649936499464995649966499764998649996500065001650026500365004650056500665007650086500965010650116501265013650146501565016650176501865019650206502165022650236502465025650266502765028650296503065031650326503365034650356503665037650386503965040650416504265043650446504565046650476504865049650506505165052650536505465055650566505765058650596506065061650626506365064650656506665067650686506965070650716507265073650746507565076650776507865079650806508165082650836508465085650866508765088650896509065091650926509365094650956509665097650986509965100651016510265103651046510565106651076510865109651106511165112651136511465115651166511765118651196512065121651226512365124651256512665127651286512965130651316513265133651346513565136651376513865139651406514165142651436514465145651466514765148651496515065151651526515365154651556515665157651586515965160651616516265163651646516565166651676516865169651706517165172651736517465175651766517765178651796518065181651826518365184651856518665187651886518965190651916519265193651946519565196651976519865199652006520165202652036520465205652066520765208652096521065211652126521365214652156521665217652186521965220652216522265223652246522565226652276522865229652306523165232652336523465235652366523765238652396524065241652426524365244652456524665247652486524965250652516525265253652546525565256652576525865259652606526165262652636526465265652666526765268652696527065271652726527365274652756527665277652786527965280652816528265283652846528565286652876528865289652906529165292652936529465295652966529765298652996530065301653026530365304653056530665307653086530965310653116531265313653146531565316653176531865319653206532165322653236532465325653266532765328653296533065331653326533365334653356533665337653386533965340653416534265343653446534565346653476534865349653506535165352653536535465355653566535765358653596536065361653626536365364653656536665367653686536965370653716537265373653746537565376653776537865379653806538165382653836538465385653866538765388653896539065391653926539365394653956539665397653986539965400654016540265403654046540565406654076540865409654106541165412654136541465415654166541765418654196542065421654226542365424654256542665427654286542965430654316543265433654346543565436654376543865439654406544165442654436544465445654466544765448654496545065451654526545365454654556545665457654586545965460654616546265463654646546565466654676546865469654706547165472654736547465475654766547765478654796548065481654826548365484654856548665487654886548965490654916549265493654946549565496654976549865499655006550165502655036550465505655066550765508655096551065511655126551365514655156551665517655186551965520655216552265523655246552565526655276552865529655306553165532655336553465535655366553765538655396554065541655426554365544655456554665547655486554965550655516555265553655546555565556655576555865559655606556165562655636556465565655666556765568655696557065571655726557365574655756557665577655786557965580655816558265583655846558565586655876558865589655906559165592655936559465595655966559765598655996560065601656026560365604656056560665607656086560965610656116561265613656146561565616656176561865619656206562165622656236562465625656266562765628656296563065631656326563365634656356563665637656386563965640656416564265643656446564565646656476564865649656506565165652656536565465655656566565765658656596566065661656626566365664656656566665667656686566965670656716567265673656746567565676656776567865679656806568165682656836568465685656866568765688656896569065691656926569365694656956569665697656986569965700657016570265703657046570565706657076570865709657106571165712657136571465715657166571765718657196572065721657226572365724657256572665727657286572965730657316573265733657346573565736657376573865739657406574165742657436574465745657466574765748657496575065751657526575365754657556575665757657586575965760657616576265763657646576565766657676576865769657706577165772657736577465775657766577765778657796578065781657826578365784657856578665787657886578965790657916579265793657946579565796657976579865799658006580165802658036580465805658066580765808658096581065811658126581365814658156581665817658186581965820658216582265823658246582565826658276582865829658306583165832658336583465835658366583765838658396584065841658426584365844658456584665847658486584965850658516585265853658546585565856658576585865859658606586165862658636586465865658666586765868658696587065871658726587365874658756587665877658786587965880658816588265883658846588565886658876588865889658906589165892658936589465895658966589765898658996590065901659026590365904659056590665907659086590965910659116591265913659146591565916659176591865919659206592165922659236592465925659266592765928659296593065931659326593365934659356593665937659386593965940659416594265943659446594565946659476594865949659506595165952659536595465955659566595765958659596596065961659626596365964659656596665967659686596965970659716597265973659746597565976659776597865979659806598165982659836598465985659866598765988659896599065991659926599365994659956599665997659986599966000660016600266003660046600566006660076600866009660106601166012660136601466015660166601766018660196602066021660226602366024660256602666027660286602966030660316603266033660346603566036660376603866039660406604166042660436604466045660466604766048660496605066051660526605366054660556605666057660586605966060660616606266063660646606566066660676606866069660706607166072660736607466075660766607766078660796608066081660826608366084660856608666087660886608966090660916609266093660946609566096660976609866099661006610166102661036610466105661066610766108661096611066111661126611366114661156611666117661186611966120661216612266123661246612566126661276612866129661306613166132661336613466135661366613766138661396614066141661426614366144661456614666147661486614966150661516615266153661546615566156661576615866159661606616166162661636616466165661666616766168661696617066171661726617366174661756617666177661786617966180661816618266183661846618566186661876618866189661906619166192661936619466195661966619766198661996620066201662026620366204662056620666207662086620966210662116621266213662146621566216662176621866219662206622166222662236622466225662266622766228662296623066231662326623366234662356623666237662386623966240662416624266243662446624566246662476624866249662506625166252662536625466255662566625766258662596626066261662626626366264662656626666267662686626966270662716627266273662746627566276662776627866279662806628166282662836628466285662866628766288662896629066291662926629366294662956629666297662986629966300663016630266303663046630566306663076630866309663106631166312663136631466315663166631766318663196632066321663226632366324663256632666327663286632966330663316633266333663346633566336663376633866339663406634166342663436634466345663466634766348663496635066351663526635366354663556635666357663586635966360663616636266363663646636566366663676636866369663706637166372663736637466375663766637766378663796638066381663826638366384663856638666387663886638966390663916639266393663946639566396663976639866399664006640166402664036640466405664066640766408664096641066411664126641366414664156641666417664186641966420664216642266423664246642566426664276642866429664306643166432664336643466435664366643766438664396644066441664426644366444664456644666447664486644966450664516645266453664546645566456664576645866459664606646166462664636646466465664666646766468664696647066471664726647366474664756647666477664786647966480664816648266483664846648566486664876648866489664906649166492664936649466495664966649766498664996650066501665026650366504665056650666507665086650966510665116651266513665146651566516665176651866519665206652166522665236652466525665266652766528665296653066531665326653366534665356653666537665386653966540665416654266543665446654566546665476654866549665506655166552665536655466555665566655766558665596656066561665626656366564665656656666567665686656966570665716657266573665746657566576665776657866579665806658166582665836658466585665866658766588665896659066591665926659366594665956659666597665986659966600666016660266603666046660566606666076660866609666106661166612666136661466615666166661766618666196662066621666226662366624666256662666627666286662966630666316663266633666346663566636666376663866639666406664166642666436664466645666466664766648666496665066651666526665366654666556665666657666586665966660666616666266663666646666566666666676666866669666706667166672666736667466675666766667766678666796668066681666826668366684666856668666687666886668966690666916669266693666946669566696666976669866699667006670166702667036670466705667066670766708667096671066711667126671366714667156671666717667186671966720667216672266723667246672566726667276672866729667306673166732667336673466735667366673766738667396674066741667426674366744667456674666747667486674966750667516675266753667546675566756667576675866759667606676166762667636676466765667666676766768667696677066771667726677366774667756677666777667786677966780667816678266783667846678566786667876678866789667906679166792667936679466795667966679766798667996680066801668026680366804668056680666807668086680966810668116681266813668146681566816668176681866819668206682166822668236682466825668266682766828668296683066831668326683366834668356683666837668386683966840668416684266843668446684566846668476684866849668506685166852668536685466855668566685766858668596686066861668626686366864668656686666867668686686966870668716687266873668746687566876668776687866879668806688166882668836688466885668866688766888668896689066891668926689366894668956689666897668986689966900669016690266903669046690566906669076690866909669106691166912669136691466915669166691766918669196692066921669226692366924669256692666927669286692966930669316693266933669346693566936669376693866939669406694166942669436694466945669466694766948669496695066951669526695366954669556695666957669586695966960669616696266963669646696566966669676696866969669706697166972669736697466975669766697766978669796698066981669826698366984669856698666987669886698966990669916699266993669946699566996669976699866999670006700167002670036700467005670066700767008670096701067011670126701367014670156701667017670186701967020670216702267023670246702567026670276702867029670306703167032670336703467035670366703767038670396704067041670426704367044670456704667047670486704967050670516705267053670546705567056670576705867059670606706167062670636706467065670666706767068670696707067071670726707367074670756707667077670786707967080670816708267083670846708567086670876708867089670906709167092670936709467095670966709767098670996710067101671026710367104671056710667107671086710967110671116711267113671146711567116671176711867119671206712167122671236712467125671266712767128671296713067131671326713367134671356713667137671386713967140671416714267143671446714567146671476714867149671506715167152671536715467155671566715767158671596716067161671626716367164671656716667167671686716967170671716717267173671746717567176671776717867179671806718167182671836718467185671866718767188671896719067191671926719367194671956719667197671986719967200672016720267203672046720567206672076720867209672106721167212672136721467215672166721767218672196722067221672226722367224672256722667227672286722967230672316723267233672346723567236672376723867239672406724167242672436724467245672466724767248672496725067251672526725367254672556725667257672586725967260672616726267263672646726567266672676726867269672706727167272672736727467275672766727767278672796728067281672826728367284672856728667287672886728967290672916729267293672946729567296672976729867299673006730167302673036730467305673066730767308673096731067311673126731367314673156731667317673186731967320673216732267323673246732567326673276732867329673306733167332673336733467335673366733767338673396734067341673426734367344673456734667347673486734967350673516735267353673546735567356673576735867359673606736167362673636736467365673666736767368673696737067371673726737367374673756737667377673786737967380673816738267383673846738567386673876738867389673906739167392673936739467395673966739767398673996740067401674026740367404674056740667407674086740967410674116741267413674146741567416674176741867419674206742167422674236742467425674266742767428674296743067431674326743367434674356743667437674386743967440674416744267443674446744567446674476744867449674506745167452674536745467455674566745767458674596746067461674626746367464674656746667467674686746967470674716747267473674746747567476674776747867479674806748167482674836748467485674866748767488674896749067491674926749367494674956749667497674986749967500675016750267503675046750567506675076750867509675106751167512675136751467515675166751767518675196752067521675226752367524675256752667527675286752967530675316753267533675346753567536675376753867539675406754167542675436754467545675466754767548675496755067551675526755367554675556755667557675586755967560675616756267563675646756567566675676756867569675706757167572675736757467575675766757767578675796758067581675826758367584675856758667587675886758967590675916759267593675946759567596675976759867599676006760167602676036760467605676066760767608676096761067611676126761367614676156761667617676186761967620676216762267623676246762567626676276762867629676306763167632676336763467635676366763767638676396764067641676426764367644676456764667647676486764967650676516765267653676546765567656676576765867659676606766167662676636766467665676666766767668676696767067671676726767367674676756767667677676786767967680676816768267683676846768567686676876768867689676906769167692676936769467695676966769767698676996770067701677026770367704677056770667707677086770967710677116771267713677146771567716677176771867719677206772167722677236772467725677266772767728677296773067731677326773367734677356773667737677386773967740677416774267743677446774567746677476774867749677506775167752677536775467755677566775767758677596776067761677626776367764677656776667767677686776967770677716777267773677746777567776677776777867779677806778167782677836778467785677866778767788677896779067791677926779367794677956779667797677986779967800678016780267803678046780567806678076780867809678106781167812678136781467815678166781767818678196782067821678226782367824678256782667827678286782967830678316783267833678346783567836678376783867839678406784167842678436784467845678466784767848678496785067851678526785367854678556785667857678586785967860678616786267863678646786567866678676786867869678706787167872678736787467875678766787767878678796788067881678826788367884678856788667887678886788967890678916789267893678946789567896678976789867899679006790167902679036790467905679066790767908679096791067911679126791367914679156791667917679186791967920679216792267923679246792567926679276792867929679306793167932679336793467935679366793767938679396794067941679426794367944679456794667947679486794967950679516795267953679546795567956679576795867959679606796167962679636796467965679666796767968679696797067971679726797367974679756797667977679786797967980679816798267983679846798567986679876798867989679906799167992679936799467995679966799767998679996800068001680026800368004680056800668007680086800968010680116801268013680146801568016680176801868019680206802168022680236802468025680266802768028680296803068031680326803368034680356803668037680386803968040680416804268043680446804568046680476804868049680506805168052680536805468055680566805768058680596806068061680626806368064680656806668067680686806968070680716807268073680746807568076680776807868079680806808168082680836808468085680866808768088680896809068091680926809368094680956809668097680986809968100681016810268103681046810568106681076810868109681106811168112681136811468115681166811768118681196812068121681226812368124681256812668127681286812968130681316813268133681346813568136681376813868139681406814168142681436814468145681466814768148681496815068151681526815368154681556815668157681586815968160681616816268163681646816568166681676816868169681706817168172681736817468175681766817768178681796818068181681826818368184681856818668187681886818968190681916819268193681946819568196681976819868199682006820168202682036820468205682066820768208682096821068211682126821368214682156821668217682186821968220682216822268223682246822568226682276822868229682306823168232682336823468235682366823768238682396824068241682426824368244682456824668247682486824968250682516825268253682546825568256682576825868259682606826168262682636826468265682666826768268682696827068271682726827368274682756827668277682786827968280682816828268283682846828568286682876828868289682906829168292682936829468295682966829768298682996830068301683026830368304683056830668307683086830968310683116831268313683146831568316683176831868319683206832168322683236832468325683266832768328683296833068331683326833368334683356833668337683386833968340683416834268343683446834568346683476834868349683506835168352683536835468355683566835768358683596836068361683626836368364683656836668367683686836968370683716837268373683746837568376683776837868379683806838168382683836838468385683866838768388683896839068391683926839368394683956839668397683986839968400684016840268403684046840568406684076840868409684106841168412684136841468415684166841768418684196842068421684226842368424684256842668427684286842968430684316843268433684346843568436684376843868439684406844168442684436844468445684466844768448684496845068451684526845368454684556845668457684586845968460684616846268463684646846568466684676846868469684706847168472684736847468475684766847768478684796848068481684826848368484684856848668487684886848968490684916849268493684946849568496684976849868499685006850168502685036850468505685066850768508685096851068511685126851368514685156851668517685186851968520685216852268523685246852568526685276852868529685306853168532685336853468535685366853768538685396854068541685426854368544685456854668547685486854968550685516855268553685546855568556685576855868559685606856168562685636856468565685666856768568685696857068571685726857368574685756857668577685786857968580685816858268583685846858568586685876858868589685906859168592685936859468595685966859768598685996860068601686026860368604686056860668607686086860968610686116861268613686146861568616686176861868619686206862168622686236862468625686266862768628686296863068631686326863368634686356863668637686386863968640686416864268643686446864568646686476864868649686506865168652686536865468655686566865768658686596866068661686626866368664686656866668667686686866968670686716867268673686746867568676686776867868679686806868168682686836868468685686866868768688686896869068691686926869368694686956869668697686986869968700687016870268703687046870568706687076870868709687106871168712687136871468715687166871768718687196872068721687226872368724687256872668727687286872968730687316873268733687346873568736687376873868739687406874168742687436874468745687466874768748687496875068751687526875368754687556875668757687586875968760687616876268763687646876568766687676876868769687706877168772687736877468775687766877768778687796878068781687826878368784687856878668787687886878968790687916879268793687946879568796687976879868799688006880168802688036880468805688066880768808688096881068811688126881368814688156881668817688186881968820688216882268823688246882568826688276882868829688306883168832688336883468835688366883768838688396884068841688426884368844688456884668847688486884968850688516885268853688546885568856688576885868859688606886168862688636886468865688666886768868688696887068871688726887368874688756887668877688786887968880688816888268883688846888568886688876888868889688906889168892688936889468895688966889768898688996890068901689026890368904689056890668907689086890968910689116891268913689146891568916689176891868919689206892168922689236892468925689266892768928689296893068931689326893368934689356893668937689386893968940689416894268943689446894568946689476894868949689506895168952689536895468955689566895768958689596896068961689626896368964689656896668967689686896968970689716897268973689746897568976689776897868979689806898168982689836898468985689866898768988689896899068991689926899368994689956899668997689986899969000690016900269003690046900569006690076900869009690106901169012690136901469015690166901769018690196902069021690226902369024690256902669027690286902969030690316903269033690346903569036690376903869039690406904169042690436904469045690466904769048690496905069051690526905369054690556905669057690586905969060690616906269063690646906569066690676906869069690706907169072690736907469075690766907769078690796908069081690826908369084690856908669087690886908969090690916909269093690946909569096690976909869099691006910169102691036910469105691066910769108691096911069111691126911369114691156911669117691186911969120691216912269123691246912569126691276912869129691306913169132691336913469135691366913769138691396914069141691426914369144691456914669147691486914969150691516915269153691546915569156691576915869159691606916169162691636916469165691666916769168691696917069171691726917369174691756917669177691786917969180691816918269183691846918569186691876918869189691906919169192691936919469195691966919769198691996920069201692026920369204692056920669207692086920969210692116921269213692146921569216692176921869219692206922169222692236922469225692266922769228692296923069231692326923369234692356923669237692386923969240692416924269243692446924569246692476924869249692506925169252692536925469255692566925769258692596926069261692626926369264692656926669267692686926969270692716927269273692746927569276692776927869279692806928169282692836928469285692866928769288692896929069291692926929369294692956929669297692986929969300693016930269303693046930569306693076930869309693106931169312693136931469315693166931769318693196932069321693226932369324693256932669327693286932969330693316933269333693346933569336693376933869339693406934169342693436934469345693466934769348693496935069351693526935369354693556935669357693586935969360693616936269363693646936569366693676936869369693706937169372693736937469375693766937769378693796938069381693826938369384693856938669387693886938969390693916939269393693946939569396693976939869399694006940169402694036940469405694066940769408694096941069411694126941369414694156941669417694186941969420694216942269423694246942569426694276942869429694306943169432694336943469435694366943769438694396944069441694426944369444694456944669447694486944969450694516945269453694546945569456694576945869459694606946169462694636946469465694666946769468694696947069471694726947369474694756947669477694786947969480694816948269483694846948569486694876948869489694906949169492694936949469495694966949769498694996950069501695026950369504695056950669507695086950969510695116951269513695146951569516695176951869519695206952169522695236952469525695266952769528695296953069531695326953369534695356953669537695386953969540695416954269543695446954569546695476954869549695506955169552695536955469555695566955769558695596956069561695626956369564695656956669567695686956969570695716957269573695746957569576695776957869579695806958169582695836958469585695866958769588695896959069591695926959369594695956959669597695986959969600696016960269603696046960569606696076960869609696106961169612696136961469615696166961769618696196962069621696226962369624696256962669627696286962969630696316963269633696346963569636696376963869639696406964169642696436964469645696466964769648696496965069651696526965369654696556965669657696586965969660696616966269663696646966569666696676966869669696706967169672696736967469675696766967769678696796968069681696826968369684696856968669687696886968969690696916969269693696946969569696696976969869699697006970169702697036970469705697066970769708697096971069711697126971369714697156971669717697186971969720697216972269723697246972569726697276972869729697306973169732697336973469735697366973769738697396974069741697426974369744697456974669747697486974969750697516975269753697546975569756697576975869759697606976169762697636976469765697666976769768697696977069771697726977369774697756977669777697786977969780697816978269783697846978569786697876978869789697906979169792697936979469795697966979769798697996980069801698026980369804698056980669807698086980969810698116981269813698146981569816698176981869819698206982169822698236982469825698266982769828698296983069831698326983369834698356983669837698386983969840698416984269843698446984569846698476984869849698506985169852698536985469855698566985769858698596986069861698626986369864698656986669867698686986969870698716987269873698746987569876698776987869879698806988169882698836988469885698866988769888698896989069891698926989369894698956989669897698986989969900699016990269903699046990569906699076990869909699106991169912699136991469915699166991769918699196992069921699226992369924699256992669927699286992969930699316993269933699346993569936699376993869939699406994169942699436994469945699466994769948699496995069951699526995369954699556995669957699586995969960699616996269963699646996569966699676996869969699706997169972699736997469975699766997769978699796998069981699826998369984699856998669987699886998969990699916999269993699946999569996699976999869999700007000170002700037000470005700067000770008700097001070011700127001370014700157001670017700187001970020700217002270023700247002570026700277002870029700307003170032700337003470035700367003770038700397004070041700427004370044700457004670047700487004970050700517005270053700547005570056700577005870059700607006170062700637006470065700667006770068700697007070071700727007370074700757007670077700787007970080700817008270083700847008570086700877008870089700907009170092700937009470095700967009770098700997010070101701027010370104701057010670107701087010970110701117011270113701147011570116701177011870119701207012170122701237012470125701267012770128701297013070131701327013370134701357013670137701387013970140701417014270143701447014570146701477014870149701507015170152701537015470155701567015770158701597016070161701627016370164701657016670167701687016970170701717017270173701747017570176701777017870179701807018170182701837018470185701867018770188701897019070191701927019370194701957019670197701987019970200702017020270203702047020570206702077020870209702107021170212702137021470215702167021770218702197022070221702227022370224702257022670227702287022970230702317023270233702347023570236702377023870239702407024170242702437024470245702467024770248702497025070251702527025370254702557025670257702587025970260702617026270263702647026570266702677026870269702707027170272702737027470275702767027770278702797028070281702827028370284702857028670287702887028970290702917029270293702947029570296702977029870299703007030170302703037030470305703067030770308703097031070311703127031370314703157031670317703187031970320703217032270323703247032570326703277032870329703307033170332703337033470335703367033770338703397034070341703427034370344703457034670347703487034970350703517035270353703547035570356703577035870359703607036170362703637036470365703667036770368703697037070371703727037370374703757037670377703787037970380703817038270383703847038570386703877038870389703907039170392703937039470395703967039770398703997040070401704027040370404704057040670407704087040970410704117041270413704147041570416704177041870419704207042170422704237042470425704267042770428704297043070431704327043370434704357043670437704387043970440704417044270443704447044570446704477044870449704507045170452704537045470455704567045770458704597046070461704627046370464704657046670467704687046970470704717047270473704747047570476704777047870479704807048170482704837048470485704867048770488704897049070491704927049370494704957049670497704987049970500705017050270503705047050570506705077050870509705107051170512705137051470515705167051770518705197052070521705227052370524705257052670527705287052970530705317053270533705347053570536705377053870539705407054170542705437054470545705467054770548705497055070551705527055370554705557055670557705587055970560705617056270563705647056570566705677056870569705707057170572705737057470575705767057770578705797058070581705827058370584705857058670587705887058970590705917059270593705947059570596705977059870599706007060170602706037060470605706067060770608706097061070611706127061370614706157061670617706187061970620706217062270623706247062570626706277062870629706307063170632706337063470635706367063770638706397064070641706427064370644706457064670647706487064970650706517065270653706547065570656706577065870659706607066170662706637066470665706667066770668706697067070671706727067370674706757067670677706787067970680706817068270683706847068570686706877068870689706907069170692706937069470695706967069770698706997070070701707027070370704707057070670707707087070970710707117071270713707147071570716707177071870719707207072170722707237072470725707267072770728707297073070731707327073370734707357073670737707387073970740707417074270743707447074570746707477074870749707507075170752707537075470755707567075770758707597076070761707627076370764707657076670767707687076970770707717077270773707747077570776707777077870779707807078170782707837078470785707867078770788707897079070791707927079370794707957079670797707987079970800708017080270803708047080570806708077080870809708107081170812708137081470815708167081770818708197082070821708227082370824708257082670827708287082970830708317083270833708347083570836708377083870839708407084170842708437084470845708467084770848708497085070851708527085370854708557085670857708587085970860708617086270863708647086570866708677086870869708707087170872708737087470875708767087770878708797088070881708827088370884708857088670887708887088970890708917089270893708947089570896708977089870899709007090170902709037090470905709067090770908709097091070911709127091370914709157091670917709187091970920709217092270923709247092570926709277092870929709307093170932709337093470935709367093770938709397094070941709427094370944709457094670947709487094970950709517095270953709547095570956709577095870959709607096170962709637096470965709667096770968709697097070971709727097370974709757097670977709787097970980709817098270983709847098570986709877098870989709907099170992709937099470995709967099770998709997100071001710027100371004710057100671007710087100971010710117101271013710147101571016710177101871019710207102171022710237102471025710267102771028710297103071031710327103371034710357103671037710387103971040710417104271043710447104571046710477104871049710507105171052710537105471055710567105771058710597106071061710627106371064710657106671067710687106971070710717107271073710747107571076710777107871079710807108171082710837108471085710867108771088710897109071091710927109371094710957109671097710987109971100711017110271103711047110571106711077110871109711107111171112711137111471115711167111771118711197112071121711227112371124711257112671127711287112971130711317113271133711347113571136711377113871139711407114171142711437114471145711467114771148711497115071151711527115371154711557115671157711587115971160711617116271163711647116571166711677116871169711707117171172711737117471175711767117771178711797118071181711827118371184711857118671187711887118971190711917119271193711947119571196711977119871199712007120171202712037120471205712067120771208712097121071211712127121371214712157121671217712187121971220712217122271223712247122571226712277122871229712307123171232712337123471235712367123771238712397124071241712427124371244712457124671247712487124971250712517125271253712547125571256712577125871259712607126171262712637126471265712667126771268712697127071271712727127371274712757127671277712787127971280712817128271283712847128571286712877128871289712907129171292712937129471295712967129771298712997130071301713027130371304713057130671307713087130971310713117131271313713147131571316713177131871319713207132171322713237132471325713267132771328713297133071331713327133371334713357133671337713387133971340713417134271343713447134571346713477134871349713507135171352713537135471355713567135771358713597136071361713627136371364713657136671367713687136971370713717137271373713747137571376713777137871379713807138171382713837138471385713867138771388713897139071391713927139371394713957139671397713987139971400714017140271403714047140571406714077140871409714107141171412714137141471415714167141771418714197142071421714227142371424714257142671427714287142971430714317143271433714347143571436714377143871439714407144171442714437144471445714467144771448714497145071451714527145371454714557145671457714587145971460714617146271463714647146571466714677146871469714707147171472714737147471475714767147771478714797148071481714827148371484714857148671487714887148971490714917149271493714947149571496714977149871499715007150171502715037150471505715067150771508715097151071511715127151371514715157151671517715187151971520715217152271523715247152571526715277152871529715307153171532715337153471535715367153771538715397154071541715427154371544715457154671547715487154971550715517155271553715547155571556715577155871559715607156171562715637156471565715667156771568715697157071571715727157371574715757157671577715787157971580715817158271583715847158571586715877158871589715907159171592715937159471595715967159771598715997160071601716027160371604716057160671607716087160971610716117161271613716147161571616716177161871619716207162171622716237162471625716267162771628716297163071631716327163371634716357163671637716387163971640716417164271643716447164571646716477164871649716507165171652716537165471655716567165771658716597166071661716627166371664716657166671667716687166971670716717167271673716747167571676716777167871679716807168171682716837168471685716867168771688716897169071691716927169371694716957169671697716987169971700717017170271703717047170571706717077170871709717107171171712717137171471715717167171771718717197172071721717227172371724717257172671727717287172971730717317173271733717347173571736717377173871739717407174171742717437174471745717467174771748717497175071751717527175371754717557175671757717587175971760717617176271763717647176571766717677176871769717707177171772717737177471775717767177771778717797178071781717827178371784717857178671787717887178971790717917179271793717947179571796717977179871799718007180171802718037180471805718067180771808718097181071811718127181371814718157181671817718187181971820718217182271823718247182571826718277182871829718307183171832718337183471835718367183771838718397184071841718427184371844718457184671847718487184971850718517185271853718547185571856718577185871859718607186171862718637186471865718667186771868718697187071871718727187371874718757187671877718787187971880718817188271883718847188571886718877188871889718907189171892718937189471895718967189771898718997190071901719027190371904719057190671907719087190971910719117191271913719147191571916719177191871919719207192171922719237192471925719267192771928719297193071931719327193371934719357193671937719387193971940719417194271943719447194571946719477194871949719507195171952719537195471955719567195771958719597196071961719627196371964719657196671967719687196971970719717197271973719747197571976719777197871979719807198171982719837198471985719867198771988719897199071991719927199371994719957199671997719987199972000720017200272003720047200572006720077200872009720107201172012720137201472015720167201772018720197202072021720227202372024720257202672027720287202972030720317203272033720347203572036720377203872039720407204172042720437204472045720467204772048720497205072051720527205372054720557205672057720587205972060720617206272063720647206572066720677206872069720707207172072720737207472075720767207772078720797208072081720827208372084720857208672087720887208972090720917209272093720947209572096720977209872099721007210172102721037210472105721067210772108721097211072111721127211372114721157211672117721187211972120721217212272123721247212572126721277212872129721307213172132721337213472135721367213772138721397214072141721427214372144721457214672147721487214972150721517215272153721547215572156721577215872159721607216172162721637216472165721667216772168721697217072171721727217372174721757217672177721787217972180721817218272183721847218572186721877218872189721907219172192721937219472195721967219772198721997220072201722027220372204722057220672207722087220972210722117221272213722147221572216722177221872219722207222172222722237222472225722267222772228722297223072231722327223372234722357223672237722387223972240722417224272243722447224572246722477224872249722507225172252722537225472255722567225772258722597226072261722627226372264722657226672267722687226972270722717227272273722747227572276722777227872279722807228172282722837228472285722867228772288722897229072291722927229372294722957229672297722987229972300723017230272303723047230572306723077230872309723107231172312723137231472315723167231772318723197232072321723227232372324723257232672327723287232972330723317233272333723347233572336723377233872339723407234172342723437234472345723467234772348723497235072351723527235372354723557235672357723587235972360723617236272363723647236572366723677236872369723707237172372723737237472375723767237772378723797238072381723827238372384723857238672387723887238972390723917239272393723947239572396723977239872399724007240172402724037240472405724067240772408724097241072411724127241372414724157241672417724187241972420724217242272423724247242572426724277242872429724307243172432724337243472435724367243772438724397244072441724427244372444724457244672447724487244972450724517245272453724547245572456724577245872459724607246172462724637246472465724667246772468724697247072471724727247372474724757247672477724787247972480724817248272483724847248572486724877248872489724907249172492724937249472495724967249772498724997250072501725027250372504725057250672507725087250972510725117251272513725147251572516725177251872519725207252172522725237252472525725267252772528725297253072531725327253372534725357253672537725387253972540725417254272543725447254572546725477254872549725507255172552725537255472555725567255772558725597256072561725627256372564725657256672567725687256972570725717257272573725747257572576725777257872579725807258172582725837258472585725867258772588725897259072591725927259372594725957259672597725987259972600726017260272603726047260572606726077260872609726107261172612726137261472615726167261772618726197262072621726227262372624726257262672627726287262972630726317263272633726347263572636726377263872639726407264172642726437264472645726467264772648726497265072651726527265372654726557265672657726587265972660726617266272663726647266572666726677266872669726707267172672726737267472675726767267772678726797268072681726827268372684726857268672687726887268972690726917269272693726947269572696726977269872699727007270172702727037270472705727067270772708727097271072711727127271372714727157271672717727187271972720727217272272723727247272572726727277272872729727307273172732727337273472735727367273772738727397274072741727427274372744727457274672747727487274972750727517275272753727547275572756727577275872759727607276172762727637276472765727667276772768727697277072771727727277372774727757277672777727787277972780727817278272783727847278572786727877278872789727907279172792727937279472795727967279772798727997280072801728027280372804728057280672807728087280972810728117281272813728147281572816728177281872819728207282172822728237282472825728267282772828728297283072831728327283372834728357283672837728387283972840728417284272843728447284572846728477284872849728507285172852728537285472855728567285772858728597286072861728627286372864728657286672867728687286972870728717287272873728747287572876728777287872879728807288172882728837288472885728867288772888728897289072891728927289372894728957289672897728987289972900729017290272903729047290572906729077290872909729107291172912729137291472915729167291772918729197292072921729227292372924729257292672927729287292972930729317293272933729347293572936729377293872939729407294172942729437294472945729467294772948729497295072951729527295372954729557295672957729587295972960729617296272963729647296572966729677296872969729707297172972729737297472975729767297772978729797298072981729827298372984729857298672987729887298972990729917299272993729947299572996729977299872999730007300173002730037300473005730067300773008730097301073011730127301373014730157301673017730187301973020730217302273023730247302573026730277302873029730307303173032730337303473035730367303773038730397304073041730427304373044730457304673047730487304973050730517305273053730547305573056730577305873059730607306173062730637306473065730667306773068730697307073071730727307373074730757307673077730787307973080730817308273083730847308573086730877308873089730907309173092730937309473095730967309773098730997310073101731027310373104731057310673107731087310973110731117311273113731147311573116731177311873119731207312173122731237312473125731267312773128731297313073131731327313373134731357313673137731387313973140731417314273143731447314573146731477314873149731507315173152731537315473155731567315773158731597316073161731627316373164731657316673167731687316973170731717317273173731747317573176731777317873179731807318173182731837318473185731867318773188731897319073191731927319373194731957319673197731987319973200732017320273203732047320573206732077320873209732107321173212732137321473215732167321773218732197322073221732227322373224732257322673227732287322973230732317323273233732347323573236732377323873239732407324173242732437324473245732467324773248732497325073251732527325373254732557325673257732587325973260732617326273263732647326573266732677326873269732707327173272732737327473275732767327773278732797328073281732827328373284732857328673287732887328973290732917329273293732947329573296732977329873299733007330173302733037330473305733067330773308733097331073311733127331373314733157331673317733187331973320733217332273323733247332573326733277332873329733307333173332733337333473335733367333773338733397334073341733427334373344733457334673347733487334973350733517335273353733547335573356733577335873359733607336173362733637336473365733667336773368733697337073371733727337373374733757337673377733787337973380733817338273383733847338573386733877338873389733907339173392733937339473395733967339773398733997340073401734027340373404734057340673407734087340973410734117341273413734147341573416734177341873419734207342173422734237342473425734267342773428734297343073431734327343373434734357343673437734387343973440734417344273443734447344573446734477344873449734507345173452734537345473455734567345773458734597346073461734627346373464734657346673467734687346973470734717347273473734747347573476734777347873479734807348173482734837348473485734867348773488734897349073491734927349373494734957349673497734987349973500735017350273503735047350573506735077350873509735107351173512735137351473515735167351773518735197352073521735227352373524735257352673527735287352973530735317353273533735347353573536735377353873539735407354173542735437354473545735467354773548735497355073551735527355373554735557355673557735587355973560735617356273563735647356573566735677356873569735707357173572735737357473575735767357773578735797358073581735827358373584735857358673587735887358973590735917359273593735947359573596735977359873599736007360173602736037360473605736067360773608736097361073611736127361373614736157361673617736187361973620736217362273623736247362573626736277362873629736307363173632736337363473635736367363773638736397364073641736427364373644736457364673647736487364973650736517365273653736547365573656736577365873659736607366173662736637366473665736667366773668736697367073671736727367373674736757367673677736787367973680736817368273683736847368573686736877368873689736907369173692736937369473695736967369773698736997370073701737027370373704737057370673707737087370973710737117371273713737147371573716737177371873719737207372173722737237372473725737267372773728737297373073731737327373373734737357373673737737387373973740737417374273743737447374573746737477374873749737507375173752737537375473755737567375773758737597376073761737627376373764737657376673767737687376973770737717377273773737747377573776737777377873779737807378173782737837378473785737867378773788737897379073791737927379373794737957379673797737987379973800738017380273803738047380573806738077380873809738107381173812738137381473815738167381773818738197382073821738227382373824738257382673827738287382973830738317383273833738347383573836738377383873839738407384173842738437384473845738467384773848738497385073851738527385373854738557385673857738587385973860738617386273863738647386573866738677386873869738707387173872738737387473875738767387773878738797388073881738827388373884738857388673887738887388973890738917389273893738947389573896738977389873899739007390173902739037390473905739067390773908739097391073911739127391373914739157391673917739187391973920739217392273923739247392573926739277392873929739307393173932739337393473935739367393773938739397394073941739427394373944739457394673947739487394973950739517395273953739547395573956739577395873959739607396173962739637396473965739667396773968739697397073971739727397373974739757397673977739787397973980739817398273983739847398573986739877398873989739907399173992739937399473995739967399773998739997400074001740027400374004740057400674007740087400974010740117401274013740147401574016740177401874019740207402174022740237402474025740267402774028740297403074031740327403374034740357403674037740387403974040740417404274043740447404574046740477404874049740507405174052740537405474055740567405774058740597406074061740627406374064740657406674067740687406974070740717407274073740747407574076740777407874079740807408174082740837408474085740867408774088740897409074091740927409374094740957409674097740987409974100741017410274103741047410574106741077410874109741107411174112741137411474115741167411774118741197412074121741227412374124741257412674127741287412974130741317413274133741347413574136741377413874139741407414174142741437414474145741467414774148741497415074151741527415374154741557415674157741587415974160741617416274163741647416574166741677416874169741707417174172741737417474175741767417774178741797418074181741827418374184741857418674187741887418974190741917419274193741947419574196741977419874199742007420174202742037420474205742067420774208742097421074211742127421374214742157421674217742187421974220742217422274223742247422574226742277422874229742307423174232742337423474235742367423774238742397424074241742427424374244742457424674247742487424974250742517425274253742547425574256742577425874259742607426174262742637426474265742667426774268742697427074271742727427374274742757427674277742787427974280742817428274283742847428574286742877428874289742907429174292742937429474295742967429774298742997430074301743027430374304743057430674307743087430974310743117431274313743147431574316743177431874319743207432174322743237432474325743267432774328743297433074331743327433374334743357433674337743387433974340743417434274343743447434574346743477434874349743507435174352743537435474355743567435774358743597436074361743627436374364743657436674367743687436974370743717437274373743747437574376743777437874379743807438174382743837438474385743867438774388743897439074391743927439374394743957439674397743987439974400744017440274403744047440574406744077440874409744107441174412744137441474415744167441774418744197442074421744227442374424744257442674427744287442974430744317443274433744347443574436744377443874439744407444174442744437444474445744467444774448744497445074451744527445374454744557445674457744587445974460744617446274463744647446574466744677446874469744707447174472744737447474475744767447774478744797448074481744827448374484744857448674487744887448974490744917449274493744947449574496744977449874499745007450174502745037450474505745067450774508745097451074511745127451374514745157451674517745187451974520745217452274523745247452574526745277452874529745307453174532745337453474535745367453774538745397454074541745427454374544745457454674547745487454974550745517455274553745547455574556745577455874559745607456174562745637456474565745667456774568745697457074571745727457374574745757457674577745787457974580745817458274583745847458574586745877458874589745907459174592745937459474595745967459774598745997460074601746027460374604746057460674607746087460974610746117461274613746147461574616746177461874619746207462174622746237462474625746267462774628746297463074631746327463374634746357463674637746387463974640746417464274643746447464574646746477464874649746507465174652746537465474655746567465774658746597466074661746627466374664746657466674667746687466974670746717467274673746747467574676746777467874679746807468174682746837468474685746867468774688746897469074691746927469374694746957469674697746987469974700747017470274703747047470574706747077470874709747107471174712747137471474715747167471774718747197472074721747227472374724747257472674727747287472974730747317473274733747347473574736747377473874739747407474174742747437474474745747467474774748747497475074751747527475374754747557475674757747587475974760747617476274763747647476574766747677476874769747707477174772747737477474775747767477774778747797478074781747827478374784747857478674787747887478974790747917479274793747947479574796747977479874799748007480174802748037480474805748067480774808748097481074811748127481374814748157481674817748187481974820748217482274823748247482574826748277482874829748307483174832748337483474835748367483774838748397484074841748427484374844748457484674847748487484974850748517485274853748547485574856748577485874859748607486174862748637486474865748667486774868748697487074871748727487374874748757487674877748787487974880748817488274883748847488574886748877488874889748907489174892748937489474895748967489774898748997490074901749027490374904749057490674907749087490974910749117491274913749147491574916749177491874919749207492174922749237492474925749267492774928749297493074931749327493374934749357493674937749387493974940749417494274943749447494574946749477494874949749507495174952749537495474955749567495774958749597496074961749627496374964749657496674967749687496974970749717497274973749747497574976749777497874979749807498174982749837498474985749867498774988749897499074991749927499374994749957499674997749987499975000750017500275003750047500575006750077500875009750107501175012750137501475015750167501775018750197502075021750227502375024750257502675027750287502975030750317503275033750347503575036750377503875039750407504175042750437504475045750467504775048750497505075051750527505375054750557505675057750587505975060750617506275063750647506575066750677506875069750707507175072750737507475075750767507775078750797508075081750827508375084750857508675087750887508975090750917509275093750947509575096750977509875099751007510175102751037510475105751067510775108751097511075111751127511375114751157511675117751187511975120751217512275123751247512575126751277512875129751307513175132751337513475135751367513775138751397514075141751427514375144751457514675147751487514975150751517515275153751547515575156751577515875159751607516175162751637516475165751667516775168751697517075171751727517375174751757517675177751787517975180751817518275183751847518575186751877518875189751907519175192751937519475195751967519775198751997520075201752027520375204752057520675207752087520975210752117521275213752147521575216752177521875219752207522175222752237522475225752267522775228752297523075231752327523375234752357523675237752387523975240752417524275243752447524575246752477524875249752507525175252752537525475255752567525775258752597526075261752627526375264752657526675267752687526975270752717527275273752747527575276752777527875279752807528175282752837528475285752867528775288752897529075291752927529375294752957529675297752987529975300753017530275303753047530575306753077530875309753107531175312753137531475315753167531775318753197532075321753227532375324753257532675327753287532975330753317533275333753347533575336753377533875339753407534175342753437534475345753467534775348753497535075351753527535375354753557535675357753587535975360753617536275363753647536575366753677536875369753707537175372753737537475375753767537775378753797538075381753827538375384753857538675387753887538975390753917539275393753947539575396753977539875399754007540175402754037540475405754067540775408754097541075411754127541375414754157541675417754187541975420754217542275423754247542575426754277542875429754307543175432754337543475435754367543775438754397544075441754427544375444754457544675447754487544975450754517545275453754547545575456754577545875459754607546175462754637546475465754667546775468754697547075471754727547375474754757547675477754787547975480754817548275483754847548575486754877548875489754907549175492754937549475495754967549775498754997550075501755027550375504755057550675507755087550975510755117551275513755147551575516755177551875519755207552175522755237552475525755267552775528755297553075531755327553375534755357553675537755387553975540755417554275543755447554575546755477554875549755507555175552755537555475555755567555775558755597556075561755627556375564755657556675567755687556975570755717557275573755747557575576755777557875579755807558175582755837558475585755867558775588755897559075591755927559375594755957559675597755987559975600756017560275603756047560575606756077560875609756107561175612756137561475615756167561775618756197562075621756227562375624756257562675627756287562975630756317563275633756347563575636756377563875639756407564175642756437564475645756467564775648756497565075651756527565375654756557565675657756587565975660756617566275663756647566575666756677566875669756707567175672756737567475675756767567775678756797568075681756827568375684756857568675687756887568975690756917569275693756947569575696756977569875699757007570175702757037570475705757067570775708757097571075711757127571375714757157571675717757187571975720757217572275723757247572575726757277572875729757307573175732757337573475735757367573775738757397574075741757427574375744757457574675747757487574975750757517575275753757547575575756757577575875759757607576175762757637576475765757667576775768757697577075771757727577375774757757577675777757787577975780757817578275783757847578575786757877578875789757907579175792757937579475795757967579775798757997580075801758027580375804758057580675807758087580975810758117581275813758147581575816758177581875819758207582175822758237582475825758267582775828758297583075831758327583375834758357583675837758387583975840758417584275843758447584575846758477584875849758507585175852758537585475855758567585775858758597586075861758627586375864758657586675867758687586975870758717587275873758747587575876758777587875879758807588175882758837588475885758867588775888758897589075891758927589375894758957589675897758987589975900759017590275903759047590575906759077590875909759107591175912759137591475915759167591775918759197592075921759227592375924759257592675927759287592975930759317593275933759347593575936759377593875939759407594175942759437594475945759467594775948759497595075951759527595375954759557595675957759587595975960759617596275963759647596575966759677596875969759707597175972759737597475975759767597775978759797598075981759827598375984759857598675987759887598975990759917599275993759947599575996759977599875999760007600176002760037600476005760067600776008760097601076011760127601376014760157601676017760187601976020760217602276023760247602576026760277602876029760307603176032760337603476035760367603776038760397604076041760427604376044760457604676047760487604976050760517605276053760547605576056760577605876059760607606176062760637606476065760667606776068760697607076071760727607376074760757607676077760787607976080760817608276083760847608576086760877608876089760907609176092760937609476095760967609776098760997610076101761027610376104761057610676107761087610976110761117611276113761147611576116761177611876119761207612176122761237612476125761267612776128761297613076131761327613376134761357613676137761387613976140761417614276143761447614576146761477614876149761507615176152761537615476155761567615776158761597616076161761627616376164761657616676167761687616976170761717617276173761747617576176761777617876179761807618176182761837618476185761867618776188761897619076191761927619376194761957619676197761987619976200762017620276203762047620576206762077620876209762107621176212762137621476215762167621776218762197622076221762227622376224762257622676227762287622976230762317623276233762347623576236762377623876239762407624176242762437624476245762467624776248762497625076251762527625376254762557625676257762587625976260762617626276263762647626576266762677626876269762707627176272762737627476275762767627776278762797628076281762827628376284762857628676287762887628976290762917629276293762947629576296762977629876299763007630176302763037630476305763067630776308763097631076311763127631376314763157631676317763187631976320763217632276323763247632576326763277632876329763307633176332763337633476335763367633776338763397634076341763427634376344763457634676347763487634976350763517635276353763547635576356763577635876359763607636176362763637636476365763667636776368763697637076371763727637376374763757637676377763787637976380763817638276383763847638576386763877638876389763907639176392763937639476395763967639776398763997640076401764027640376404764057640676407764087640976410764117641276413764147641576416764177641876419764207642176422764237642476425764267642776428764297643076431764327643376434764357643676437764387643976440764417644276443764447644576446764477644876449764507645176452764537645476455764567645776458764597646076461764627646376464764657646676467764687646976470764717647276473764747647576476764777647876479764807648176482764837648476485764867648776488764897649076491764927649376494764957649676497764987649976500765017650276503765047650576506765077650876509765107651176512765137651476515765167651776518765197652076521765227652376524765257652676527765287652976530765317653276533765347653576536765377653876539765407654176542765437654476545765467654776548765497655076551765527655376554765557655676557765587655976560765617656276563765647656576566765677656876569765707657176572765737657476575765767657776578765797658076581765827658376584765857658676587765887658976590765917659276593765947659576596765977659876599766007660176602766037660476605766067660776608766097661076611766127661376614766157661676617766187661976620766217662276623766247662576626766277662876629766307663176632766337663476635766367663776638766397664076641766427664376644766457664676647766487664976650766517665276653766547665576656766577665876659766607666176662766637666476665766667666776668766697667076671766727667376674766757667676677766787667976680766817668276683766847668576686766877668876689766907669176692766937669476695766967669776698766997670076701767027670376704767057670676707767087670976710767117671276713767147671576716767177671876719767207672176722767237672476725767267672776728767297673076731767327673376734767357673676737767387673976740767417674276743767447674576746767477674876749767507675176752767537675476755767567675776758767597676076761767627676376764767657676676767767687676976770767717677276773767747677576776767777677876779767807678176782767837678476785767867678776788767897679076791767927679376794767957679676797767987679976800768017680276803768047680576806768077680876809768107681176812768137681476815768167681776818768197682076821768227682376824768257682676827768287682976830768317683276833768347683576836768377683876839768407684176842768437684476845768467684776848768497685076851768527685376854768557685676857768587685976860768617686276863768647686576866768677686876869768707687176872768737687476875768767687776878768797688076881768827688376884768857688676887768887688976890768917689276893768947689576896768977689876899769007690176902769037690476905769067690776908769097691076911769127691376914769157691676917769187691976920769217692276923769247692576926769277692876929769307693176932769337693476935769367693776938769397694076941769427694376944769457694676947769487694976950769517695276953769547695576956769577695876959769607696176962769637696476965769667696776968769697697076971769727697376974769757697676977769787697976980769817698276983769847698576986769877698876989769907699176992769937699476995769967699776998769997700077001770027700377004770057700677007770087700977010770117701277013770147701577016770177701877019770207702177022770237702477025770267702777028770297703077031770327703377034770357703677037770387703977040770417704277043770447704577046770477704877049770507705177052770537705477055770567705777058770597706077061770627706377064770657706677067770687706977070770717707277073770747707577076770777707877079770807708177082770837708477085770867708777088770897709077091770927709377094770957709677097770987709977100771017710277103771047710577106771077710877109771107711177112771137711477115771167711777118771197712077121771227712377124771257712677127771287712977130771317713277133771347713577136771377713877139771407714177142771437714477145771467714777148771497715077151771527715377154771557715677157771587715977160771617716277163771647716577166771677716877169771707717177172771737717477175771767717777178771797718077181771827718377184771857718677187771887718977190771917719277193771947719577196771977719877199772007720177202772037720477205772067720777208772097721077211772127721377214772157721677217772187721977220772217722277223772247722577226772277722877229772307723177232772337723477235772367723777238772397724077241772427724377244772457724677247772487724977250772517725277253772547725577256772577725877259772607726177262772637726477265772667726777268772697727077271772727727377274772757727677277772787727977280772817728277283772847728577286772877728877289772907729177292772937729477295772967729777298772997730077301773027730377304773057730677307773087730977310773117731277313773147731577316773177731877319773207732177322773237732477325773267732777328773297733077331773327733377334773357733677337773387733977340773417734277343773447734577346773477734877349773507735177352773537735477355773567735777358773597736077361773627736377364773657736677367773687736977370773717737277373773747737577376773777737877379773807738177382773837738477385773867738777388773897739077391773927739377394773957739677397773987739977400774017740277403774047740577406774077740877409774107741177412774137741477415774167741777418774197742077421774227742377424774257742677427774287742977430774317743277433774347743577436774377743877439774407744177442774437744477445774467744777448774497745077451774527745377454774557745677457774587745977460774617746277463774647746577466774677746877469774707747177472774737747477475774767747777478774797748077481774827748377484774857748677487774887748977490774917749277493774947749577496774977749877499775007750177502775037750477505775067750777508775097751077511775127751377514775157751677517775187751977520775217752277523775247752577526775277752877529775307753177532775337753477535775367753777538775397754077541775427754377544775457754677547775487754977550775517755277553775547755577556775577755877559775607756177562775637756477565775667756777568775697757077571775727757377574775757757677577775787757977580775817758277583775847758577586775877758877589775907759177592775937759477595775967759777598775997760077601776027760377604776057760677607776087760977610776117761277613776147761577616776177761877619776207762177622776237762477625776267762777628776297763077631776327763377634776357763677637776387763977640776417764277643776447764577646776477764877649776507765177652776537765477655776567765777658776597766077661776627766377664776657766677667776687766977670776717767277673776747767577676776777767877679776807768177682776837768477685776867768777688776897769077691776927769377694776957769677697776987769977700777017770277703777047770577706777077770877709777107771177712777137771477715777167771777718777197772077721777227772377724777257772677727777287772977730777317773277733777347773577736777377773877739777407774177742777437774477745777467774777748777497775077751777527775377754777557775677757777587775977760777617776277763777647776577766777677776877769777707777177772777737777477775777767777777778777797778077781777827778377784777857778677787777887778977790777917779277793777947779577796777977779877799778007780177802778037780477805778067780777808778097781077811778127781377814778157781677817778187781977820778217782277823778247782577826778277782877829778307783177832778337783477835778367783777838778397784077841778427784377844778457784677847778487784977850778517785277853778547785577856778577785877859778607786177862778637786477865778667786777868778697787077871778727787377874778757787677877778787787977880778817788277883778847788577886778877788877889778907789177892778937789477895778967789777898778997790077901779027790377904779057790677907779087790977910779117791277913779147791577916779177791877919779207792177922779237792477925779267792777928779297793077931779327793377934779357793677937779387793977940779417794277943779447794577946779477794877949779507795177952779537795477955779567795777958779597796077961779627796377964779657796677967779687796977970779717797277973779747797577976779777797877979779807798177982779837798477985779867798777988779897799077991779927799377994779957799677997779987799978000780017800278003780047800578006780077800878009780107801178012780137801478015780167801778018780197802078021780227802378024780257802678027780287802978030780317803278033780347803578036780377803878039780407804178042780437804478045780467804778048780497805078051780527805378054780557805678057780587805978060780617806278063780647806578066780677806878069780707807178072780737807478075780767807778078780797808078081780827808378084780857808678087780887808978090780917809278093780947809578096780977809878099781007810178102781037810478105781067810778108781097811078111781127811378114781157811678117781187811978120781217812278123781247812578126781277812878129781307813178132781337813478135781367813778138781397814078141781427814378144781457814678147781487814978150781517815278153781547815578156781577815878159781607816178162781637816478165781667816778168781697817078171781727817378174781757817678177781787817978180781817818278183781847818578186781877818878189781907819178192781937819478195781967819778198781997820078201782027820378204782057820678207782087820978210782117821278213782147821578216782177821878219782207822178222782237822478225782267822778228782297823078231782327823378234782357823678237782387823978240782417824278243782447824578246782477824878249782507825178252782537825478255782567825778258782597826078261782627826378264782657826678267782687826978270782717827278273782747827578276782777827878279782807828178282782837828478285782867828778288782897829078291782927829378294782957829678297782987829978300783017830278303783047830578306783077830878309783107831178312783137831478315783167831778318783197832078321783227832378324783257832678327783287832978330783317833278333783347833578336783377833878339783407834178342783437834478345783467834778348783497835078351783527835378354783557835678357783587835978360783617836278363783647836578366783677836878369783707837178372783737837478375783767837778378783797838078381783827838378384783857838678387783887838978390783917839278393783947839578396783977839878399784007840178402784037840478405784067840778408784097841078411784127841378414784157841678417784187841978420784217842278423784247842578426784277842878429784307843178432784337843478435784367843778438784397844078441784427844378444784457844678447784487844978450784517845278453784547845578456784577845878459784607846178462784637846478465784667846778468784697847078471784727847378474784757847678477784787847978480784817848278483784847848578486784877848878489784907849178492784937849478495784967849778498784997850078501785027850378504785057850678507785087850978510785117851278513785147851578516785177851878519785207852178522785237852478525785267852778528785297853078531785327853378534785357853678537785387853978540785417854278543785447854578546785477854878549785507855178552785537855478555785567855778558785597856078561785627856378564785657856678567785687856978570785717857278573785747857578576785777857878579785807858178582785837858478585785867858778588785897859078591785927859378594785957859678597785987859978600786017860278603786047860578606786077860878609786107861178612786137861478615786167861778618786197862078621786227862378624786257862678627786287862978630786317863278633786347863578636786377863878639786407864178642786437864478645786467864778648786497865078651786527865378654786557865678657786587865978660786617866278663786647866578666786677866878669786707867178672786737867478675786767867778678786797868078681786827868378684786857868678687786887868978690786917869278693786947869578696786977869878699787007870178702787037870478705787067870778708787097871078711787127871378714787157871678717787187871978720787217872278723787247872578726787277872878729787307873178732787337873478735787367873778738787397874078741787427874378744787457874678747787487874978750787517875278753787547875578756787577875878759787607876178762787637876478765787667876778768787697877078771787727877378774787757877678777787787877978780787817878278783787847878578786787877878878789787907879178792787937879478795787967879778798787997880078801788027880378804788057880678807788087880978810788117881278813788147881578816788177881878819788207882178822788237882478825788267882778828788297883078831788327883378834788357883678837788387883978840788417884278843788447884578846788477884878849788507885178852788537885478855788567885778858788597886078861788627886378864788657886678867788687886978870788717887278873788747887578876788777887878879788807888178882788837888478885788867888778888788897889078891788927889378894788957889678897788987889978900789017890278903789047890578906789077890878909789107891178912789137891478915789167891778918789197892078921789227892378924789257892678927789287892978930789317893278933789347893578936789377893878939789407894178942789437894478945789467894778948789497895078951789527895378954789557895678957789587895978960789617896278963789647896578966789677896878969789707897178972789737897478975789767897778978789797898078981789827898378984789857898678987789887898978990789917899278993789947899578996789977899878999790007900179002790037900479005790067900779008790097901079011790127901379014790157901679017790187901979020790217902279023790247902579026790277902879029790307903179032790337903479035790367903779038790397904079041790427904379044790457904679047790487904979050790517905279053790547905579056790577905879059790607906179062790637906479065790667906779068790697907079071790727907379074790757907679077790787907979080790817908279083790847908579086790877908879089790907909179092790937909479095790967909779098790997910079101791027910379104791057910679107791087910979110791117911279113791147911579116791177911879119791207912179122791237912479125791267912779128791297913079131791327913379134791357913679137791387913979140791417914279143791447914579146791477914879149791507915179152791537915479155791567915779158791597916079161791627916379164791657916679167791687916979170791717917279173791747917579176791777917879179791807918179182791837918479185791867918779188791897919079191791927919379194791957919679197791987919979200792017920279203792047920579206792077920879209792107921179212792137921479215792167921779218792197922079221792227922379224792257922679227792287922979230792317923279233792347923579236792377923879239792407924179242792437924479245792467924779248792497925079251792527925379254792557925679257792587925979260792617926279263792647926579266792677926879269792707927179272792737927479275792767927779278792797928079281792827928379284792857928679287792887928979290792917929279293792947929579296792977929879299793007930179302793037930479305793067930779308793097931079311793127931379314793157931679317793187931979320793217932279323793247932579326793277932879329793307933179332793337933479335793367933779338793397934079341793427934379344793457934679347793487934979350793517935279353793547935579356793577935879359793607936179362793637936479365793667936779368793697937079371793727937379374793757937679377793787937979380793817938279383793847938579386793877938879389793907939179392793937939479395793967939779398793997940079401794027940379404794057940679407794087940979410794117941279413794147941579416794177941879419794207942179422794237942479425794267942779428794297943079431794327943379434794357943679437794387943979440794417944279443794447944579446794477944879449794507945179452794537945479455794567945779458794597946079461794627946379464794657946679467794687946979470794717947279473794747947579476794777947879479794807948179482794837948479485794867948779488794897949079491794927949379494794957949679497794987949979500795017950279503795047950579506795077950879509795107951179512795137951479515795167951779518795197952079521795227952379524795257952679527795287952979530795317953279533795347953579536795377953879539795407954179542795437954479545795467954779548795497955079551795527955379554795557955679557795587955979560795617956279563795647956579566795677956879569795707957179572795737957479575795767957779578795797958079581795827958379584795857958679587795887958979590795917959279593795947959579596795977959879599796007960179602796037960479605796067960779608796097961079611796127961379614796157961679617796187961979620796217962279623796247962579626796277962879629796307963179632796337963479635796367963779638796397964079641796427964379644796457964679647796487964979650796517965279653796547965579656796577965879659796607966179662796637966479665796667966779668796697967079671796727967379674796757967679677796787967979680796817968279683796847968579686796877968879689796907969179692796937969479695796967969779698796997970079701797027970379704797057970679707797087970979710797117971279713797147971579716797177971879719797207972179722797237972479725797267972779728797297973079731797327973379734797357973679737797387973979740797417974279743797447974579746797477974879749797507975179752797537975479755797567975779758797597976079761797627976379764797657976679767797687976979770797717977279773797747977579776797777977879779797807978179782797837978479785797867978779788797897979079791797927979379794797957979679797797987979979800798017980279803798047980579806798077980879809798107981179812798137981479815798167981779818798197982079821798227982379824798257982679827798287982979830798317983279833798347983579836798377983879839798407984179842798437984479845798467984779848798497985079851798527985379854798557985679857798587985979860798617986279863798647986579866798677986879869798707987179872798737987479875798767987779878798797988079881798827988379884798857988679887798887988979890798917989279893798947989579896798977989879899799007990179902799037990479905799067990779908799097991079911799127991379914799157991679917799187991979920799217992279923799247992579926799277992879929799307993179932799337993479935799367993779938799397994079941799427994379944799457994679947799487994979950799517995279953799547995579956799577995879959799607996179962799637996479965799667996779968799697997079971799727997379974799757997679977799787997979980799817998279983799847998579986799877998879989799907999179992799937999479995799967999779998799998000080001800028000380004800058000680007800088000980010800118001280013800148001580016800178001880019800208002180022800238002480025800268002780028800298003080031800328003380034800358003680037800388003980040800418004280043800448004580046800478004880049800508005180052800538005480055800568005780058800598006080061800628006380064800658006680067800688006980070800718007280073800748007580076800778007880079800808008180082800838008480085800868008780088800898009080091800928009380094800958009680097800988009980100801018010280103801048010580106801078010880109801108011180112801138011480115801168011780118801198012080121801228012380124801258012680127801288012980130801318013280133801348013580136801378013880139801408014180142801438014480145801468014780148801498015080151801528015380154801558015680157801588015980160801618016280163801648016580166801678016880169801708017180172801738017480175801768017780178801798018080181801828018380184801858018680187801888018980190801918019280193801948019580196801978019880199802008020180202802038020480205802068020780208802098021080211802128021380214802158021680217802188021980220802218022280223802248022580226802278022880229802308023180232802338023480235802368023780238802398024080241802428024380244802458024680247802488024980250802518025280253802548025580256802578025880259802608026180262802638026480265802668026780268802698027080271802728027380274802758027680277802788027980280802818028280283802848028580286802878028880289802908029180292802938029480295802968029780298802998030080301803028030380304803058030680307803088030980310803118031280313803148031580316803178031880319803208032180322803238032480325803268032780328803298033080331803328033380334803358033680337803388033980340803418034280343803448034580346803478034880349803508035180352803538035480355803568035780358803598036080361803628036380364803658036680367803688036980370803718037280373803748037580376803778037880379803808038180382803838038480385803868038780388803898039080391803928039380394803958039680397803988039980400804018040280403804048040580406804078040880409804108041180412804138041480415804168041780418804198042080421804228042380424804258042680427804288042980430804318043280433804348043580436804378043880439804408044180442804438044480445804468044780448804498045080451804528045380454804558045680457804588045980460804618046280463804648046580466804678046880469804708047180472804738047480475804768047780478804798048080481804828048380484804858048680487804888048980490804918049280493804948049580496804978049880499805008050180502805038050480505805068050780508805098051080511805128051380514805158051680517805188051980520805218052280523805248052580526805278052880529805308053180532805338053480535805368053780538805398054080541805428054380544805458054680547805488054980550805518055280553805548055580556805578055880559805608056180562805638056480565805668056780568805698057080571805728057380574805758057680577805788057980580805818058280583805848058580586805878058880589805908059180592805938059480595805968059780598805998060080601806028060380604806058060680607806088060980610806118061280613806148061580616806178061880619806208062180622806238062480625806268062780628806298063080631806328063380634806358063680637806388063980640806418064280643806448064580646806478064880649806508065180652806538065480655806568065780658806598066080661806628066380664806658066680667806688066980670806718067280673806748067580676806778067880679806808068180682806838068480685806868068780688806898069080691806928069380694806958069680697806988069980700807018070280703807048070580706807078070880709807108071180712807138071480715807168071780718807198072080721807228072380724807258072680727807288072980730807318073280733807348073580736807378073880739807408074180742807438074480745807468074780748807498075080751807528075380754807558075680757807588075980760807618076280763807648076580766807678076880769807708077180772807738077480775807768077780778807798078080781807828078380784807858078680787807888078980790807918079280793807948079580796807978079880799808008080180802808038080480805808068080780808808098081080811808128081380814808158081680817808188081980820808218082280823808248082580826808278082880829808308083180832808338083480835808368083780838808398084080841808428084380844808458084680847808488084980850808518085280853808548085580856808578085880859808608086180862808638086480865808668086780868808698087080871808728087380874808758087680877808788087980880808818088280883808848088580886808878088880889808908089180892808938089480895808968089780898808998090080901809028090380904809058090680907809088090980910809118091280913809148091580916809178091880919809208092180922809238092480925809268092780928809298093080931809328093380934809358093680937809388093980940809418094280943809448094580946809478094880949809508095180952809538095480955809568095780958809598096080961809628096380964809658096680967809688096980970809718097280973809748097580976809778097880979809808098180982809838098480985809868098780988809898099080991809928099380994809958099680997809988099981000810018100281003810048100581006810078100881009810108101181012810138101481015810168101781018810198102081021810228102381024810258102681027810288102981030810318103281033810348103581036810378103881039810408104181042810438104481045810468104781048810498105081051810528105381054810558105681057810588105981060810618106281063810648106581066810678106881069810708107181072810738107481075810768107781078810798108081081810828108381084810858108681087810888108981090810918109281093810948109581096810978109881099811008110181102811038110481105811068110781108811098111081111811128111381114811158111681117811188111981120811218112281123811248112581126811278112881129811308113181132811338113481135811368113781138811398114081141811428114381144811458114681147811488114981150811518115281153811548115581156811578115881159811608116181162811638116481165811668116781168811698117081171811728117381174811758117681177811788117981180811818118281183811848118581186811878118881189811908119181192811938119481195811968119781198811998120081201812028120381204812058120681207812088120981210812118121281213812148121581216812178121881219812208122181222812238122481225812268122781228812298123081231812328123381234812358123681237812388123981240812418124281243812448124581246812478124881249812508125181252812538125481255812568125781258812598126081261812628126381264812658126681267812688126981270812718127281273812748127581276812778127881279812808128181282812838128481285812868128781288812898129081291812928129381294812958129681297812988129981300813018130281303813048130581306813078130881309813108131181312813138131481315813168131781318813198132081321813228132381324813258132681327813288132981330813318133281333813348133581336813378133881339813408134181342813438134481345813468134781348813498135081351813528135381354813558135681357813588135981360813618136281363813648136581366813678136881369813708137181372813738137481375813768137781378813798138081381813828138381384813858138681387813888138981390813918139281393813948139581396813978139881399814008140181402814038140481405814068140781408814098141081411814128141381414814158141681417814188141981420814218142281423814248142581426814278142881429814308143181432814338143481435814368143781438814398144081441814428144381444814458144681447814488144981450814518145281453814548145581456814578145881459814608146181462814638146481465814668146781468814698147081471814728147381474814758147681477814788147981480814818148281483814848148581486814878148881489814908149181492814938149481495814968149781498814998150081501815028150381504815058150681507815088150981510815118151281513815148151581516815178151881519815208152181522815238152481525815268152781528815298153081531815328153381534815358153681537815388153981540815418154281543815448154581546815478154881549815508155181552815538155481555815568155781558815598156081561815628156381564815658156681567815688156981570815718157281573815748157581576815778157881579815808158181582815838158481585815868158781588815898159081591815928159381594815958159681597815988159981600816018160281603816048160581606816078160881609816108161181612816138161481615816168161781618816198162081621816228162381624816258162681627816288162981630816318163281633816348163581636816378163881639816408164181642816438164481645816468164781648816498165081651816528165381654816558165681657816588165981660816618166281663816648166581666816678166881669816708167181672816738167481675816768167781678816798168081681816828168381684816858168681687816888168981690816918169281693816948169581696816978169881699817008170181702817038170481705817068170781708817098171081711817128171381714817158171681717817188171981720817218172281723817248172581726817278172881729817308173181732817338173481735817368173781738817398174081741817428174381744817458174681747817488174981750817518175281753817548175581756817578175881759817608176181762817638176481765817668176781768817698177081771817728177381774817758177681777817788177981780817818178281783817848178581786817878178881789817908179181792817938179481795817968179781798817998180081801818028180381804818058180681807818088180981810818118181281813818148181581816818178181881819818208182181822818238182481825818268182781828818298183081831818328183381834818358183681837818388183981840818418184281843818448184581846818478184881849818508185181852818538185481855818568185781858818598186081861818628186381864818658186681867818688186981870818718187281873818748187581876818778187881879818808188181882818838188481885818868188781888818898189081891818928189381894818958189681897818988189981900819018190281903819048190581906819078190881909819108191181912819138191481915819168191781918819198192081921819228192381924819258192681927819288192981930819318193281933819348193581936819378193881939819408194181942819438194481945819468194781948819498195081951819528195381954819558195681957819588195981960819618196281963819648196581966819678196881969819708197181972819738197481975819768197781978819798198081981819828198381984819858198681987819888198981990819918199281993819948199581996819978199881999820008200182002820038200482005820068200782008820098201082011820128201382014820158201682017820188201982020820218202282023820248202582026820278202882029820308203182032820338203482035820368203782038820398204082041820428204382044820458204682047820488204982050820518205282053820548205582056820578205882059820608206182062820638206482065820668206782068820698207082071820728207382074820758207682077820788207982080820818208282083820848208582086820878208882089820908209182092820938209482095820968209782098820998210082101821028210382104821058210682107821088210982110821118211282113821148211582116821178211882119821208212182122821238212482125821268212782128821298213082131821328213382134821358213682137821388213982140821418214282143821448214582146821478214882149821508215182152821538215482155821568215782158821598216082161821628216382164821658216682167821688216982170821718217282173821748217582176821778217882179821808218182182821838218482185821868218782188821898219082191821928219382194821958219682197821988219982200822018220282203822048220582206822078220882209822108221182212822138221482215822168221782218822198222082221822228222382224822258222682227822288222982230822318223282233822348223582236822378223882239822408224182242822438224482245822468224782248822498225082251822528225382254822558225682257822588225982260822618226282263822648226582266822678226882269822708227182272822738227482275822768227782278822798228082281822828228382284822858228682287822888228982290822918229282293822948229582296822978229882299823008230182302823038230482305823068230782308823098231082311823128231382314823158231682317823188231982320823218232282323823248232582326823278232882329823308233182332823338233482335823368233782338823398234082341823428234382344823458234682347823488234982350823518235282353823548235582356823578235882359823608236182362823638236482365823668236782368823698237082371823728237382374823758237682377823788237982380823818238282383823848238582386823878238882389823908239182392823938239482395823968239782398823998240082401824028240382404824058240682407824088240982410824118241282413824148241582416824178241882419824208242182422824238242482425824268242782428824298243082431824328243382434824358243682437824388243982440824418244282443824448244582446824478244882449824508245182452824538245482455824568245782458824598246082461824628246382464824658246682467824688246982470824718247282473824748247582476824778247882479824808248182482824838248482485824868248782488824898249082491824928249382494824958249682497824988249982500825018250282503825048250582506825078250882509825108251182512825138251482515825168251782518825198252082521825228252382524825258252682527825288252982530825318253282533825348253582536825378253882539825408254182542825438254482545825468254782548825498255082551825528255382554825558255682557825588255982560825618256282563825648256582566825678256882569825708257182572825738257482575825768257782578825798258082581825828258382584825858258682587825888258982590825918259282593825948259582596825978259882599826008260182602826038260482605826068260782608826098261082611826128261382614826158261682617826188261982620826218262282623826248262582626826278262882629826308263182632826338263482635826368263782638826398264082641826428264382644826458264682647826488264982650826518265282653826548265582656826578265882659826608266182662826638266482665826668266782668826698267082671826728267382674826758267682677826788267982680826818268282683826848268582686826878268882689826908269182692826938269482695826968269782698826998270082701827028270382704827058270682707827088270982710827118271282713827148271582716827178271882719827208272182722827238272482725827268272782728827298273082731827328273382734827358273682737827388273982740827418274282743827448274582746827478274882749827508275182752827538275482755827568275782758827598276082761827628276382764827658276682767827688276982770827718277282773827748277582776827778277882779827808278182782827838278482785827868278782788827898279082791827928279382794827958279682797827988279982800828018280282803828048280582806828078280882809828108281182812828138281482815828168281782818828198282082821828228282382824828258282682827828288282982830828318283282833828348283582836828378283882839828408284182842828438284482845828468284782848828498285082851828528285382854828558285682857828588285982860828618286282863828648286582866828678286882869828708287182872828738287482875828768287782878828798288082881828828288382884828858288682887828888288982890828918289282893828948289582896828978289882899829008290182902829038290482905829068290782908829098291082911829128291382914829158291682917829188291982920829218292282923829248292582926829278292882929829308293182932829338293482935829368293782938829398294082941829428294382944829458294682947829488294982950829518295282953829548295582956829578295882959829608296182962829638296482965829668296782968829698297082971829728297382974829758297682977829788297982980829818298282983829848298582986829878298882989829908299182992829938299482995829968299782998829998300083001830028300383004830058300683007830088300983010830118301283013830148301583016830178301883019830208302183022830238302483025830268302783028830298303083031830328303383034830358303683037830388303983040830418304283043830448304583046830478304883049830508305183052830538305483055830568305783058830598306083061830628306383064830658306683067830688306983070830718307283073830748307583076830778307883079830808308183082830838308483085830868308783088830898309083091830928309383094830958309683097830988309983100831018310283103831048310583106831078310883109831108311183112831138311483115831168311783118831198312083121831228312383124831258312683127831288312983130831318313283133831348313583136831378313883139831408314183142831438314483145831468314783148831498315083151831528315383154831558315683157831588315983160831618316283163831648316583166831678316883169831708317183172831738317483175831768317783178831798318083181831828318383184831858318683187831888318983190831918319283193831948319583196831978319883199832008320183202832038320483205832068320783208832098321083211832128321383214832158321683217832188321983220832218322283223832248322583226832278322883229832308323183232832338323483235832368323783238832398324083241832428324383244832458324683247832488324983250832518325283253832548325583256832578325883259832608326183262832638326483265832668326783268832698327083271832728327383274832758327683277832788327983280832818328283283832848328583286832878328883289832908329183292832938329483295832968329783298832998330083301833028330383304833058330683307833088330983310833118331283313833148331583316833178331883319833208332183322833238332483325833268332783328833298333083331833328333383334833358333683337833388333983340833418334283343833448334583346833478334883349833508335183352833538335483355833568335783358833598336083361833628336383364833658336683367833688336983370833718337283373833748337583376833778337883379833808338183382833838338483385833868338783388833898339083391833928339383394833958339683397833988339983400834018340283403834048340583406834078340883409834108341183412834138341483415834168341783418834198342083421834228342383424834258342683427834288342983430834318343283433834348343583436834378343883439834408344183442834438344483445834468344783448834498345083451834528345383454834558345683457834588345983460834618346283463834648346583466834678346883469834708347183472834738347483475834768347783478834798348083481834828348383484834858348683487834888348983490834918349283493834948349583496834978349883499835008350183502835038350483505835068350783508835098351083511835128351383514835158351683517835188351983520835218352283523835248352583526835278352883529835308353183532835338353483535835368353783538835398354083541835428354383544835458354683547835488354983550835518355283553835548355583556835578355883559835608356183562835638356483565835668356783568835698357083571835728357383574835758357683577835788357983580835818358283583835848358583586835878358883589835908359183592835938359483595835968359783598835998360083601836028360383604836058360683607836088360983610836118361283613836148361583616836178361883619836208362183622836238362483625836268362783628836298363083631836328363383634836358363683637836388363983640836418364283643836448364583646836478364883649836508365183652836538365483655836568365783658836598366083661836628366383664836658366683667836688366983670836718367283673836748367583676836778367883679836808368183682836838368483685836868368783688836898369083691836928369383694836958369683697836988369983700837018370283703837048370583706837078370883709837108371183712837138371483715837168371783718837198372083721837228372383724837258372683727837288372983730837318373283733837348373583736837378373883739837408374183742837438374483745837468374783748837498375083751837528375383754837558375683757837588375983760837618376283763837648376583766837678376883769837708377183772837738377483775837768377783778837798378083781837828378383784837858378683787837888378983790837918379283793837948379583796837978379883799838008380183802838038380483805838068380783808838098381083811838128381383814838158381683817838188381983820838218382283823838248382583826838278382883829838308383183832838338383483835838368383783838838398384083841838428384383844838458384683847838488384983850838518385283853838548385583856838578385883859838608386183862838638386483865838668386783868838698387083871838728387383874838758387683877838788387983880838818388283883838848388583886838878388883889838908389183892838938389483895838968389783898838998390083901839028390383904839058390683907839088390983910839118391283913839148391583916839178391883919839208392183922839238392483925839268392783928839298393083931839328393383934839358393683937839388393983940839418394283943839448394583946839478394883949839508395183952839538395483955839568395783958839598396083961839628396383964839658396683967839688396983970839718397283973839748397583976839778397883979839808398183982839838398483985839868398783988839898399083991839928399383994839958399683997839988399984000840018400284003840048400584006840078400884009840108401184012840138401484015840168401784018840198402084021840228402384024840258402684027840288402984030840318403284033840348403584036840378403884039840408404184042840438404484045840468404784048840498405084051840528405384054840558405684057840588405984060840618406284063840648406584066840678406884069840708407184072840738407484075840768407784078840798408084081840828408384084840858408684087840888408984090840918409284093840948409584096840978409884099841008410184102841038410484105841068410784108841098411084111841128411384114841158411684117841188411984120841218412284123841248412584126841278412884129841308413184132841338413484135841368413784138841398414084141841428414384144841458414684147841488414984150841518415284153841548415584156841578415884159841608416184162841638416484165841668416784168841698417084171841728417384174841758417684177841788417984180841818418284183841848418584186841878418884189841908419184192841938419484195841968419784198841998420084201842028420384204842058420684207842088420984210842118421284213842148421584216842178421884219842208422184222842238422484225842268422784228842298423084231842328423384234842358423684237842388423984240842418424284243842448424584246842478424884249842508425184252842538425484255842568425784258842598426084261842628426384264842658426684267842688426984270842718427284273842748427584276842778427884279842808428184282842838428484285842868428784288842898429084291842928429384294842958429684297842988429984300843018430284303843048430584306843078430884309843108431184312843138431484315843168431784318843198432084321843228432384324843258432684327843288432984330843318433284333843348433584336843378433884339843408434184342843438434484345843468434784348843498435084351843528435384354843558435684357843588435984360843618436284363843648436584366843678436884369843708437184372843738437484375843768437784378843798438084381843828438384384843858438684387843888438984390843918439284393843948439584396843978439884399844008440184402844038440484405844068440784408844098441084411844128441384414844158441684417844188441984420844218442284423844248442584426844278442884429844308443184432844338443484435844368443784438844398444084441844428444384444844458444684447844488444984450844518445284453844548445584456844578445884459844608446184462844638446484465844668446784468844698447084471844728447384474844758447684477844788447984480844818448284483844848448584486844878448884489844908449184492844938449484495844968449784498844998450084501845028450384504845058450684507845088450984510845118451284513845148451584516845178451884519845208452184522845238452484525845268452784528845298453084531845328453384534845358453684537845388453984540845418454284543845448454584546845478454884549845508455184552845538455484555845568455784558845598456084561845628456384564845658456684567845688456984570845718457284573845748457584576845778457884579845808458184582845838458484585845868458784588845898459084591845928459384594845958459684597845988459984600846018460284603846048460584606846078460884609846108461184612846138461484615846168461784618846198462084621846228462384624846258462684627846288462984630846318463284633846348463584636846378463884639846408464184642846438464484645846468464784648846498465084651846528465384654846558465684657846588465984660846618466284663846648466584666846678466884669846708467184672846738467484675846768467784678846798468084681846828468384684846858468684687846888468984690846918469284693846948469584696846978469884699847008470184702847038470484705847068470784708847098471084711847128471384714847158471684717847188471984720847218472284723847248472584726847278472884729847308473184732847338473484735847368473784738847398474084741847428474384744847458474684747847488474984750847518475284753847548475584756847578475884759847608476184762847638476484765847668476784768847698477084771847728477384774847758477684777847788477984780847818478284783847848478584786847878478884789847908479184792847938479484795847968479784798847998480084801848028480384804848058480684807848088480984810848118481284813848148481584816848178481884819848208482184822848238482484825848268482784828848298483084831848328483384834848358483684837848388483984840848418484284843848448484584846848478484884849848508485184852848538485484855848568485784858848598486084861848628486384864848658486684867848688486984870848718487284873848748487584876848778487884879848808488184882848838488484885848868488784888848898489084891848928489384894848958489684897848988489984900849018490284903849048490584906849078490884909849108491184912849138491484915849168491784918849198492084921849228492384924849258492684927849288492984930849318493284933849348493584936849378493884939849408494184942849438494484945849468494784948849498495084951849528495384954849558495684957849588495984960849618496284963849648496584966849678496884969849708497184972849738497484975849768497784978849798498084981849828498384984849858498684987849888498984990849918499284993849948499584996849978499884999850008500185002850038500485005850068500785008850098501085011850128501385014850158501685017850188501985020850218502285023850248502585026850278502885029850308503185032850338503485035850368503785038850398504085041850428504385044850458504685047850488504985050850518505285053850548505585056850578505885059850608506185062850638506485065850668506785068850698507085071850728507385074850758507685077850788507985080850818508285083850848508585086850878508885089850908509185092850938509485095850968509785098850998510085101851028510385104851058510685107851088510985110851118511285113851148511585116851178511885119851208512185122851238512485125851268512785128851298513085131851328513385134851358513685137851388513985140851418514285143851448514585146851478514885149851508515185152851538515485155851568515785158851598516085161851628516385164851658516685167851688516985170851718517285173851748517585176851778517885179851808518185182851838518485185851868518785188851898519085191851928519385194851958519685197851988519985200852018520285203852048520585206852078520885209852108521185212852138521485215852168521785218852198522085221852228522385224852258522685227852288522985230852318523285233852348523585236852378523885239852408524185242852438524485245852468524785248852498525085251852528525385254852558525685257852588525985260852618526285263852648526585266852678526885269852708527185272852738527485275852768527785278852798528085281852828528385284852858528685287852888528985290852918529285293852948529585296852978529885299853008530185302853038530485305853068530785308853098531085311853128531385314853158531685317853188531985320853218532285323853248532585326853278532885329853308533185332853338533485335853368533785338853398534085341853428534385344853458534685347853488534985350853518535285353853548535585356853578535885359853608536185362853638536485365853668536785368853698537085371853728537385374853758537685377853788537985380853818538285383853848538585386853878538885389853908539185392853938539485395853968539785398853998540085401854028540385404854058540685407854088540985410854118541285413854148541585416854178541885419854208542185422854238542485425854268542785428854298543085431854328543385434854358543685437854388543985440854418544285443854448544585446854478544885449854508545185452854538545485455854568545785458854598546085461854628546385464854658546685467854688546985470854718547285473854748547585476854778547885479854808548185482854838548485485854868548785488854898549085491854928549385494854958549685497854988549985500855018550285503855048550585506855078550885509855108551185512855138551485515855168551785518855198552085521855228552385524855258552685527855288552985530855318553285533855348553585536855378553885539855408554185542855438554485545855468554785548855498555085551855528555385554855558555685557855588555985560855618556285563855648556585566855678556885569855708557185572855738557485575855768557785578855798558085581855828558385584855858558685587855888558985590855918559285593855948559585596855978559885599856008560185602856038560485605856068560785608856098561085611856128561385614856158561685617856188561985620856218562285623856248562585626856278562885629856308563185632856338563485635856368563785638856398564085641856428564385644856458564685647856488564985650856518565285653856548565585656856578565885659856608566185662856638566485665856668566785668856698567085671856728567385674856758567685677856788567985680856818568285683856848568585686856878568885689856908569185692856938569485695856968569785698856998570085701857028570385704857058570685707857088570985710857118571285713857148571585716857178571885719857208572185722857238572485725857268572785728857298573085731857328573385734857358573685737857388573985740857418574285743857448574585746857478574885749857508575185752857538575485755857568575785758857598576085761857628576385764857658576685767857688576985770857718577285773857748577585776857778577885779857808578185782857838578485785857868578785788857898579085791857928579385794857958579685797857988579985800858018580285803858048580585806858078580885809858108581185812858138581485815858168581785818858198582085821858228582385824858258582685827858288582985830858318583285833858348583585836858378583885839858408584185842858438584485845858468584785848858498585085851858528585385854858558585685857858588585985860858618586285863858648586585866858678586885869858708587185872858738587485875858768587785878858798588085881858828588385884858858588685887858888588985890858918589285893858948589585896858978589885899859008590185902859038590485905859068590785908859098591085911859128591385914859158591685917859188591985920859218592285923859248592585926859278592885929859308593185932859338593485935859368593785938859398594085941859428594385944859458594685947859488594985950859518595285953859548595585956859578595885959859608596185962859638596485965859668596785968859698597085971859728597385974859758597685977859788597985980859818598285983859848598585986859878598885989859908599185992859938599485995859968599785998859998600086001860028600386004860058600686007860088600986010860118601286013860148601586016860178601886019860208602186022860238602486025860268602786028860298603086031860328603386034860358603686037860388603986040860418604286043860448604586046860478604886049860508605186052860538605486055860568605786058860598606086061860628606386064860658606686067860688606986070860718607286073860748607586076860778607886079860808608186082860838608486085860868608786088860898609086091860928609386094860958609686097860988609986100861018610286103861048610586106861078610886109861108611186112861138611486115861168611786118861198612086121861228612386124861258612686127861288612986130861318613286133861348613586136861378613886139861408614186142861438614486145861468614786148861498615086151861528615386154861558615686157861588615986160861618616286163861648616586166861678616886169861708617186172861738617486175861768617786178861798618086181861828618386184861858618686187861888618986190861918619286193861948619586196861978619886199862008620186202862038620486205862068620786208862098621086211862128621386214862158621686217862188621986220862218622286223862248622586226862278622886229862308623186232862338623486235862368623786238862398624086241862428624386244862458624686247862488624986250862518625286253862548625586256862578625886259862608626186262862638626486265862668626786268862698627086271862728627386274862758627686277862788627986280862818628286283862848628586286862878628886289862908629186292862938629486295862968629786298862998630086301863028630386304863058630686307863088630986310863118631286313863148631586316863178631886319863208632186322863238632486325863268632786328863298633086331863328633386334863358633686337863388633986340863418634286343863448634586346863478634886349863508635186352863538635486355863568635786358863598636086361863628636386364863658636686367863688636986370863718637286373863748637586376863778637886379863808638186382863838638486385863868638786388863898639086391863928639386394863958639686397863988639986400864018640286403864048640586406864078640886409864108641186412864138641486415864168641786418864198642086421864228642386424864258642686427864288642986430864318643286433864348643586436864378643886439864408644186442864438644486445864468644786448864498645086451864528645386454864558645686457864588645986460864618646286463864648646586466864678646886469864708647186472864738647486475864768647786478864798648086481864828648386484864858648686487864888648986490864918649286493864948649586496864978649886499865008650186502865038650486505865068650786508865098651086511865128651386514865158651686517865188651986520865218652286523865248652586526865278652886529865308653186532865338653486535865368653786538865398654086541865428654386544865458654686547865488654986550865518655286553865548655586556865578655886559865608656186562865638656486565865668656786568865698657086571865728657386574865758657686577865788657986580865818658286583865848658586586865878658886589865908659186592865938659486595865968659786598865998660086601866028660386604866058660686607866088660986610866118661286613866148661586616866178661886619866208662186622866238662486625866268662786628866298663086631866328663386634866358663686637866388663986640866418664286643866448664586646866478664886649866508665186652866538665486655866568665786658866598666086661866628666386664866658666686667866688666986670866718667286673866748667586676866778667886679866808668186682866838668486685866868668786688866898669086691866928669386694866958669686697866988669986700867018670286703867048670586706867078670886709867108671186712867138671486715867168671786718867198672086721867228672386724867258672686727867288672986730867318673286733867348673586736867378673886739867408674186742867438674486745867468674786748867498675086751867528675386754867558675686757867588675986760867618676286763867648676586766867678676886769867708677186772867738677486775867768677786778867798678086781867828678386784867858678686787867888678986790867918679286793867948679586796867978679886799868008680186802868038680486805868068680786808868098681086811868128681386814868158681686817868188681986820868218682286823868248682586826868278682886829868308683186832868338683486835868368683786838868398684086841868428684386844868458684686847868488684986850868518685286853868548685586856868578685886859868608686186862868638686486865868668686786868868698687086871868728687386874868758687686877868788687986880868818688286883868848688586886868878688886889868908689186892868938689486895868968689786898868998690086901869028690386904869058690686907869088690986910869118691286913869148691586916869178691886919869208692186922869238692486925869268692786928869298693086931869328693386934869358693686937869388693986940869418694286943869448694586946869478694886949869508695186952869538695486955869568695786958869598696086961869628696386964869658696686967869688696986970869718697286973869748697586976869778697886979869808698186982869838698486985869868698786988869898699086991869928699386994869958699686997869988699987000870018700287003870048700587006870078700887009870108701187012870138701487015870168701787018870198702087021870228702387024870258702687027870288702987030870318703287033870348703587036870378703887039870408704187042870438704487045870468704787048870498705087051870528705387054870558705687057870588705987060870618706287063870648706587066870678706887069870708707187072870738707487075870768707787078870798708087081870828708387084870858708687087870888708987090870918709287093870948709587096870978709887099871008710187102871038710487105871068710787108871098711087111871128711387114871158711687117871188711987120871218712287123871248712587126871278712887129871308713187132871338713487135871368713787138871398714087141871428714387144871458714687147871488714987150871518715287153871548715587156871578715887159871608716187162871638716487165871668716787168871698717087171871728717387174871758717687177871788717987180871818718287183871848718587186871878718887189871908719187192871938719487195871968719787198871998720087201872028720387204872058720687207872088720987210872118721287213872148721587216872178721887219872208722187222872238722487225872268722787228872298723087231872328723387234872358723687237872388723987240872418724287243872448724587246872478724887249872508725187252872538725487255872568725787258872598726087261872628726387264872658726687267872688726987270872718727287273872748727587276872778727887279872808728187282872838728487285872868728787288872898729087291872928729387294872958729687297872988729987300873018730287303873048730587306873078730887309873108731187312873138731487315873168731787318873198732087321873228732387324873258732687327873288732987330873318733287333873348733587336873378733887339873408734187342873438734487345873468734787348873498735087351873528735387354873558735687357873588735987360873618736287363873648736587366873678736887369873708737187372873738737487375873768737787378873798738087381873828738387384873858738687387873888738987390873918739287393873948739587396873978739887399874008740187402874038740487405874068740787408874098741087411874128741387414874158741687417874188741987420874218742287423874248742587426874278742887429874308743187432874338743487435874368743787438874398744087441874428744387444874458744687447874488744987450874518745287453874548745587456874578745887459874608746187462874638746487465874668746787468874698747087471874728747387474874758747687477874788747987480874818748287483874848748587486874878748887489874908749187492874938749487495874968749787498874998750087501875028750387504875058750687507875088750987510875118751287513875148751587516875178751887519875208752187522875238752487525875268752787528875298753087531875328753387534875358753687537875388753987540875418754287543875448754587546875478754887549875508755187552875538755487555875568755787558875598756087561875628756387564875658756687567875688756987570875718757287573875748757587576875778757887579875808758187582875838758487585875868758787588875898759087591875928759387594875958759687597875988759987600876018760287603876048760587606876078760887609876108761187612876138761487615876168761787618876198762087621876228762387624876258762687627876288762987630876318763287633876348763587636876378763887639876408764187642876438764487645876468764787648876498765087651876528765387654876558765687657876588765987660876618766287663876648766587666876678766887669876708767187672876738767487675876768767787678876798768087681876828768387684876858768687687876888768987690876918769287693876948769587696876978769887699877008770187702877038770487705877068770787708877098771087711877128771387714877158771687717877188771987720877218772287723877248772587726877278772887729877308773187732877338773487735877368773787738877398774087741877428774387744877458774687747877488774987750877518775287753877548775587756877578775887759877608776187762877638776487765877668776787768877698777087771877728777387774877758777687777877788777987780877818778287783877848778587786877878778887789877908779187792877938779487795877968779787798877998780087801878028780387804878058780687807878088780987810878118781287813878148781587816878178781887819878208782187822878238782487825878268782787828878298783087831878328783387834878358783687837878388783987840878418784287843878448784587846878478784887849878508785187852878538785487855878568785787858878598786087861878628786387864878658786687867878688786987870878718787287873878748787587876878778787887879878808788187882878838788487885878868788787888878898789087891878928789387894878958789687897878988789987900879018790287903879048790587906879078790887909879108791187912879138791487915879168791787918879198792087921879228792387924879258792687927879288792987930879318793287933879348793587936879378793887939879408794187942879438794487945879468794787948879498795087951879528795387954879558795687957879588795987960879618796287963879648796587966879678796887969879708797187972879738797487975879768797787978879798798087981879828798387984879858798687987879888798987990879918799287993879948799587996879978799887999880008800188002880038800488005880068800788008880098801088011880128801388014880158801688017880188801988020880218802288023880248802588026880278802888029880308803188032880338803488035880368803788038880398804088041880428804388044880458804688047880488804988050880518805288053880548805588056880578805888059880608806188062880638806488065880668806788068880698807088071880728807388074880758807688077880788807988080880818808288083880848808588086880878808888089880908809188092880938809488095880968809788098880998810088101881028810388104881058810688107881088810988110881118811288113881148811588116881178811888119881208812188122881238812488125881268812788128881298813088131881328813388134881358813688137881388813988140881418814288143881448814588146881478814888149881508815188152881538815488155881568815788158881598816088161881628816388164881658816688167881688816988170881718817288173881748817588176881778817888179881808818188182881838818488185881868818788188881898819088191881928819388194881958819688197881988819988200882018820288203882048820588206882078820888209882108821188212882138821488215882168821788218882198822088221882228822388224882258822688227882288822988230882318823288233882348823588236882378823888239882408824188242882438824488245882468824788248882498825088251882528825388254882558825688257882588825988260882618826288263882648826588266882678826888269882708827188272882738827488275882768827788278882798828088281882828828388284882858828688287882888828988290882918829288293882948829588296882978829888299883008830188302883038830488305883068830788308883098831088311883128831388314883158831688317883188831988320883218832288323883248832588326883278832888329883308833188332883338833488335883368833788338883398834088341883428834388344883458834688347883488834988350883518835288353883548835588356883578835888359883608836188362883638836488365883668836788368883698837088371883728837388374883758837688377883788837988380883818838288383883848838588386883878838888389883908839188392883938839488395883968839788398883998840088401884028840388404884058840688407884088840988410884118841288413884148841588416884178841888419884208842188422884238842488425884268842788428884298843088431884328843388434884358843688437884388843988440884418844288443884448844588446884478844888449884508845188452884538845488455884568845788458884598846088461884628846388464884658846688467884688846988470884718847288473884748847588476884778847888479884808848188482884838848488485884868848788488884898849088491884928849388494884958849688497884988849988500885018850288503885048850588506885078850888509885108851188512885138851488515885168851788518885198852088521885228852388524885258852688527885288852988530885318853288533885348853588536885378853888539885408854188542885438854488545885468854788548885498855088551885528855388554885558855688557885588855988560885618856288563885648856588566885678856888569885708857188572885738857488575885768857788578885798858088581885828858388584885858858688587885888858988590885918859288593885948859588596885978859888599886008860188602886038860488605886068860788608886098861088611886128861388614886158861688617886188861988620886218862288623886248862588626886278862888629886308863188632886338863488635886368863788638886398864088641886428864388644886458864688647886488864988650886518865288653886548865588656886578865888659886608866188662886638866488665886668866788668886698867088671886728867388674886758867688677886788867988680886818868288683886848868588686886878868888689886908869188692886938869488695886968869788698886998870088701887028870388704887058870688707887088870988710887118871288713887148871588716887178871888719887208872188722887238872488725887268872788728887298873088731887328873388734887358873688737887388873988740887418874288743887448874588746887478874888749887508875188752887538875488755887568875788758887598876088761887628876388764887658876688767887688876988770887718877288773887748877588776887778877888779887808878188782887838878488785887868878788788887898879088791887928879388794887958879688797887988879988800888018880288803888048880588806888078880888809888108881188812888138881488815888168881788818888198882088821888228882388824888258882688827888288882988830888318883288833888348883588836888378883888839888408884188842888438884488845888468884788848888498885088851888528885388854888558885688857888588885988860888618886288863888648886588866888678886888869888708887188872888738887488875888768887788878888798888088881888828888388884888858888688887888888888988890888918889288893888948889588896888978889888899889008890188902889038890488905889068890788908889098891088911889128891388914889158891688917889188891988920889218892288923889248892588926889278892888929889308893188932889338893488935889368893788938889398894088941889428894388944889458894688947889488894988950889518895288953889548895588956889578895888959889608896188962889638896488965889668896788968889698897088971889728897388974889758897688977889788897988980889818898288983889848898588986889878898888989889908899188992889938899488995889968899788998889998900089001890028900389004890058900689007890088900989010890118901289013890148901589016890178901889019890208902189022890238902489025890268902789028890298903089031890328903389034890358903689037890388903989040890418904289043890448904589046890478904889049890508905189052890538905489055890568905789058890598906089061890628906389064890658906689067890688906989070890718907289073890748907589076890778907889079890808908189082890838908489085890868908789088890898909089091890928909389094890958909689097890988909989100891018910289103891048910589106891078910889109891108911189112891138911489115891168911789118891198912089121891228912389124891258912689127891288912989130891318913289133891348913589136891378913889139891408914189142891438914489145891468914789148891498915089151891528915389154891558915689157891588915989160891618916289163891648916589166891678916889169891708917189172891738917489175891768917789178891798918089181891828918389184891858918689187891888918989190891918919289193891948919589196891978919889199892008920189202892038920489205892068920789208892098921089211892128921389214892158921689217892188921989220892218922289223892248922589226892278922889229892308923189232892338923489235892368923789238892398924089241892428924389244892458924689247892488924989250892518925289253892548925589256892578925889259892608926189262892638926489265892668926789268892698927089271892728927389274892758927689277892788927989280892818928289283892848928589286892878928889289892908929189292892938929489295892968929789298892998930089301893028930389304893058930689307893088930989310893118931289313893148931589316893178931889319893208932189322893238932489325893268932789328893298933089331893328933389334893358933689337893388933989340893418934289343893448934589346893478934889349893508935189352893538935489355893568935789358893598936089361893628936389364893658936689367893688936989370893718937289373893748937589376893778937889379893808938189382893838938489385893868938789388893898939089391893928939389394893958939689397893988939989400894018940289403894048940589406894078940889409894108941189412894138941489415894168941789418894198942089421894228942389424894258942689427894288942989430894318943289433894348943589436894378943889439894408944189442894438944489445894468944789448894498945089451894528945389454894558945689457894588945989460894618946289463894648946589466894678946889469894708947189472894738947489475894768947789478894798948089481894828948389484894858948689487894888948989490894918949289493894948949589496894978949889499895008950189502895038950489505895068950789508895098951089511895128951389514895158951689517895188951989520895218952289523895248952589526895278952889529895308953189532895338953489535895368953789538895398954089541895428954389544895458954689547895488954989550895518955289553895548955589556895578955889559895608956189562895638956489565895668956789568895698957089571895728957389574895758957689577895788957989580895818958289583895848958589586895878958889589895908959189592895938959489595895968959789598895998960089601896028960389604896058960689607896088960989610896118961289613896148961589616896178961889619896208962189622896238962489625896268962789628896298963089631896328963389634896358963689637896388963989640896418964289643896448964589646896478964889649896508965189652896538965489655896568965789658896598966089661896628966389664896658966689667896688966989670896718967289673896748967589676896778967889679896808968189682896838968489685896868968789688896898969089691896928969389694896958969689697896988969989700897018970289703897048970589706897078970889709897108971189712897138971489715897168971789718897198972089721897228972389724897258972689727897288972989730897318973289733897348973589736897378973889739897408974189742897438974489745897468974789748897498975089751897528975389754897558975689757897588975989760897618976289763897648976589766897678976889769897708977189772897738977489775897768977789778897798978089781897828978389784897858978689787897888978989790897918979289793897948979589796897978979889799898008980189802898038980489805898068980789808898098981089811898128981389814898158981689817898188981989820898218982289823898248982589826898278982889829898308983189832898338983489835898368983789838898398984089841898428984389844898458984689847898488984989850898518985289853898548985589856898578985889859898608986189862898638986489865898668986789868898698987089871898728987389874898758987689877898788987989880898818988289883898848988589886898878988889889898908989189892898938989489895898968989789898898998990089901899028990389904899058990689907899088990989910899118991289913899148991589916899178991889919899208992189922899238992489925899268992789928899298993089931899328993389934899358993689937899388993989940899418994289943899448994589946899478994889949899508995189952899538995489955899568995789958899598996089961899628996389964899658996689967899688996989970899718997289973899748997589976899778997889979899808998189982899838998489985899868998789988899898999089991899928999389994899958999689997899988999990000900019000290003900049000590006900079000890009900109001190012900139001490015900169001790018900199002090021900229002390024900259002690027900289002990030900319003290033900349003590036900379003890039900409004190042900439004490045900469004790048900499005090051900529005390054900559005690057900589005990060900619006290063900649006590066900679006890069900709007190072900739007490075900769007790078900799008090081900829008390084900859008690087900889008990090900919009290093900949009590096900979009890099901009010190102901039010490105901069010790108901099011090111901129011390114901159011690117901189011990120901219012290123901249012590126901279012890129901309013190132901339013490135901369013790138901399014090141901429014390144901459014690147901489014990150901519015290153901549015590156901579015890159901609016190162901639016490165901669016790168901699017090171901729017390174901759017690177901789017990180901819018290183901849018590186901879018890189901909019190192901939019490195901969019790198901999020090201902029020390204902059020690207902089020990210902119021290213902149021590216902179021890219902209022190222902239022490225902269022790228902299023090231902329023390234902359023690237902389023990240902419024290243902449024590246902479024890249902509025190252902539025490255902569025790258902599026090261902629026390264902659026690267902689026990270902719027290273902749027590276902779027890279902809028190282902839028490285902869028790288902899029090291902929029390294902959029690297902989029990300903019030290303903049030590306903079030890309903109031190312903139031490315903169031790318903199032090321903229032390324903259032690327903289032990330903319033290333903349033590336903379033890339903409034190342903439034490345903469034790348903499035090351903529035390354903559035690357903589035990360903619036290363903649036590366903679036890369903709037190372903739037490375903769037790378903799038090381903829038390384903859038690387903889038990390903919039290393903949039590396903979039890399904009040190402904039040490405904069040790408904099041090411904129041390414904159041690417904189041990420904219042290423904249042590426904279042890429904309043190432904339043490435904369043790438904399044090441904429044390444904459044690447904489044990450904519045290453904549045590456904579045890459904609046190462904639046490465904669046790468904699047090471904729047390474904759047690477904789047990480904819048290483904849048590486904879048890489904909049190492904939049490495904969049790498904999050090501905029050390504905059050690507905089050990510905119051290513905149051590516905179051890519905209052190522905239052490525905269052790528905299053090531905329053390534905359053690537905389053990540905419054290543905449054590546905479054890549905509055190552905539055490555905569055790558905599056090561905629056390564905659056690567905689056990570905719057290573905749057590576905779057890579905809058190582905839058490585905869058790588905899059090591905929059390594905959059690597905989059990600906019060290603906049060590606906079060890609906109061190612906139061490615906169061790618906199062090621906229062390624906259062690627906289062990630906319063290633906349063590636906379063890639906409064190642906439064490645906469064790648906499065090651906529065390654906559065690657906589065990660906619066290663906649066590666906679066890669906709067190672906739067490675906769067790678906799068090681906829068390684906859068690687906889068990690906919069290693906949069590696906979069890699907009070190702907039070490705907069070790708907099071090711907129071390714907159071690717907189071990720907219072290723907249072590726907279072890729907309073190732907339073490735907369073790738907399074090741907429074390744907459074690747907489074990750907519075290753907549075590756907579075890759907609076190762907639076490765907669076790768907699077090771907729077390774907759077690777907789077990780907819078290783907849078590786907879078890789907909079190792907939079490795907969079790798907999080090801908029080390804908059080690807908089080990810908119081290813908149081590816908179081890819908209082190822908239082490825908269082790828908299083090831908329083390834908359083690837908389083990840908419084290843908449084590846908479084890849908509085190852908539085490855908569085790858908599086090861908629086390864908659086690867908689086990870908719087290873908749087590876908779087890879908809088190882908839088490885908869088790888908899089090891908929089390894908959089690897908989089990900909019090290903909049090590906909079090890909909109091190912909139091490915909169091790918909199092090921909229092390924909259092690927909289092990930909319093290933909349093590936909379093890939909409094190942909439094490945909469094790948909499095090951909529095390954909559095690957909589095990960909619096290963909649096590966909679096890969909709097190972909739097490975909769097790978909799098090981909829098390984909859098690987909889098990990909919099290993909949099590996909979099890999910009100191002910039100491005910069100791008910099101091011910129101391014910159101691017910189101991020910219102291023910249102591026910279102891029910309103191032910339103491035910369103791038910399104091041910429104391044910459104691047910489104991050910519105291053910549105591056910579105891059910609106191062910639106491065910669106791068910699107091071910729107391074910759107691077910789107991080910819108291083910849108591086910879108891089910909109191092910939109491095910969109791098910999110091101911029110391104911059110691107911089110991110911119111291113911149111591116911179111891119911209112191122911239112491125911269112791128911299113091131911329113391134911359113691137911389113991140911419114291143911449114591146911479114891149911509115191152911539115491155911569115791158911599116091161911629116391164911659116691167911689116991170911719117291173911749117591176911779117891179911809118191182911839118491185911869118791188911899119091191911929119391194911959119691197911989119991200912019120291203912049120591206912079120891209912109121191212912139121491215912169121791218912199122091221912229122391224912259122691227912289122991230912319123291233912349123591236912379123891239912409124191242912439124491245912469124791248912499125091251912529125391254912559125691257912589125991260912619126291263912649126591266912679126891269912709127191272912739127491275912769127791278912799128091281912829128391284912859128691287912889128991290912919129291293912949129591296912979129891299913009130191302913039130491305913069130791308913099131091311913129131391314913159131691317913189131991320913219132291323913249132591326913279132891329913309133191332913339133491335913369133791338913399134091341913429134391344913459134691347913489134991350913519135291353913549135591356913579135891359913609136191362913639136491365913669136791368913699137091371913729137391374913759137691377913789137991380913819138291383913849138591386913879138891389913909139191392913939139491395913969139791398913999140091401914029140391404914059140691407914089140991410914119141291413914149141591416914179141891419914209142191422914239142491425914269142791428914299143091431914329143391434914359143691437914389143991440914419144291443914449144591446914479144891449914509145191452914539145491455914569145791458914599146091461914629146391464914659146691467914689146991470914719147291473914749147591476914779147891479914809148191482914839148491485914869148791488914899149091491914929149391494914959149691497914989149991500915019150291503915049150591506915079150891509915109151191512915139151491515915169151791518915199152091521915229152391524915259152691527915289152991530915319153291533915349153591536915379153891539915409154191542915439154491545915469154791548915499155091551915529155391554915559155691557915589155991560915619156291563915649156591566915679156891569915709157191572915739157491575915769157791578915799158091581915829158391584915859158691587915889158991590915919159291593915949159591596915979159891599916009160191602916039160491605916069160791608916099161091611916129161391614916159161691617916189161991620916219162291623916249162591626916279162891629916309163191632916339163491635916369163791638916399164091641916429164391644916459164691647916489164991650916519165291653916549165591656916579165891659916609166191662916639166491665916669166791668916699167091671916729167391674916759167691677916789167991680916819168291683916849168591686916879168891689916909169191692916939169491695916969169791698916999170091701917029170391704917059170691707917089170991710917119171291713917149171591716917179171891719917209172191722917239172491725917269172791728917299173091731917329173391734917359173691737917389173991740917419174291743917449174591746917479174891749917509175191752917539175491755917569175791758917599176091761917629176391764917659176691767917689176991770917719177291773917749177591776917779177891779917809178191782917839178491785917869178791788917899179091791917929179391794917959179691797917989179991800918019180291803918049180591806918079180891809918109181191812918139181491815918169181791818918199182091821918229182391824918259182691827918289182991830918319183291833918349183591836918379183891839918409184191842918439184491845918469184791848918499185091851918529185391854918559185691857918589185991860918619186291863918649186591866918679186891869918709187191872918739187491875918769187791878918799188091881918829188391884918859188691887918889188991890918919189291893918949189591896918979189891899919009190191902919039190491905919069190791908919099191091911919129191391914919159191691917919189191991920919219192291923919249192591926919279192891929919309193191932919339193491935919369193791938919399194091941919429194391944919459194691947919489194991950919519195291953919549195591956919579195891959919609196191962919639196491965919669196791968919699197091971919729197391974919759197691977919789197991980919819198291983919849198591986919879198891989919909199191992919939199491995919969199791998919999200092001920029200392004920059200692007920089200992010920119201292013920149201592016920179201892019920209202192022920239202492025920269202792028920299203092031920329203392034920359203692037920389203992040920419204292043920449204592046920479204892049920509205192052920539205492055920569205792058920599206092061920629206392064920659206692067920689206992070920719207292073920749207592076920779207892079920809208192082920839208492085920869208792088920899209092091920929209392094920959209692097920989209992100921019210292103921049210592106921079210892109921109211192112921139211492115921169211792118921199212092121921229212392124921259212692127921289212992130921319213292133921349213592136921379213892139921409214192142921439214492145921469214792148921499215092151921529215392154921559215692157921589215992160921619216292163921649216592166921679216892169921709217192172921739217492175921769217792178921799218092181921829218392184921859218692187921889218992190921919219292193921949219592196921979219892199922009220192202922039220492205922069220792208922099221092211922129221392214922159221692217922189221992220922219222292223922249222592226922279222892229922309223192232922339223492235922369223792238922399224092241922429224392244922459224692247922489224992250922519225292253922549225592256922579225892259922609226192262922639226492265922669226792268922699227092271922729227392274922759227692277922789227992280922819228292283922849228592286922879228892289922909229192292922939229492295922969229792298922999230092301923029230392304923059230692307923089230992310923119231292313923149231592316923179231892319923209232192322923239232492325923269232792328923299233092331923329233392334923359233692337923389233992340923419234292343923449234592346923479234892349923509235192352923539235492355923569235792358923599236092361923629236392364923659236692367923689236992370923719237292373923749237592376923779237892379923809238192382923839238492385923869238792388923899239092391923929239392394923959239692397923989239992400924019240292403924049240592406924079240892409924109241192412924139241492415924169241792418924199242092421924229242392424924259242692427924289242992430924319243292433924349243592436924379243892439924409244192442924439244492445924469244792448924499245092451924529245392454924559245692457924589245992460924619246292463924649246592466924679246892469924709247192472924739247492475924769247792478924799248092481924829248392484924859248692487924889248992490924919249292493924949249592496924979249892499925009250192502925039250492505925069250792508925099251092511925129251392514925159251692517925189251992520925219252292523925249252592526925279252892529925309253192532925339253492535925369253792538925399254092541925429254392544925459254692547925489254992550925519255292553925549255592556925579255892559925609256192562925639256492565925669256792568925699257092571925729257392574925759257692577925789257992580925819258292583925849258592586925879258892589925909259192592925939259492595925969259792598925999260092601926029260392604926059260692607926089260992610926119261292613926149261592616926179261892619926209262192622926239262492625926269262792628926299263092631926329263392634926359263692637926389263992640926419264292643926449264592646926479264892649926509265192652926539265492655926569265792658926599266092661926629266392664926659266692667926689266992670926719267292673926749267592676926779267892679926809268192682926839268492685926869268792688926899269092691926929269392694926959269692697926989269992700927019270292703927049270592706927079270892709927109271192712927139271492715927169271792718927199272092721927229272392724927259272692727927289272992730927319273292733927349273592736927379273892739927409274192742927439274492745927469274792748927499275092751927529275392754927559275692757927589275992760927619276292763927649276592766927679276892769927709277192772927739277492775927769277792778927799278092781927829278392784927859278692787927889278992790927919279292793927949279592796927979279892799928009280192802928039280492805928069280792808928099281092811928129281392814928159281692817928189281992820928219282292823928249282592826928279282892829928309283192832928339283492835928369283792838928399284092841928429284392844928459284692847928489284992850928519285292853928549285592856928579285892859928609286192862928639286492865928669286792868928699287092871928729287392874928759287692877928789287992880928819288292883928849288592886928879288892889928909289192892928939289492895928969289792898928999290092901929029290392904929059290692907929089290992910929119291292913929149291592916929179291892919929209292192922929239292492925929269292792928929299293092931929329293392934929359293692937929389293992940929419294292943929449294592946929479294892949929509295192952929539295492955929569295792958929599296092961929629296392964929659296692967929689296992970929719297292973929749297592976929779297892979929809298192982929839298492985929869298792988929899299092991929929299392994929959299692997929989299993000930019300293003930049300593006930079300893009930109301193012930139301493015930169301793018930199302093021930229302393024930259302693027930289302993030930319303293033930349303593036930379303893039930409304193042930439304493045930469304793048930499305093051930529305393054930559305693057930589305993060930619306293063930649306593066930679306893069930709307193072930739307493075930769307793078930799308093081930829308393084930859308693087930889308993090930919309293093930949309593096930979309893099931009310193102931039310493105931069310793108931099311093111931129311393114931159311693117931189311993120931219312293123931249312593126931279312893129931309313193132931339313493135931369313793138931399314093141931429314393144931459314693147931489314993150931519315293153931549315593156931579315893159931609316193162931639316493165931669316793168931699317093171931729317393174931759317693177931789317993180931819318293183931849318593186931879318893189931909319193192931939319493195931969319793198931999320093201932029320393204932059320693207932089320993210932119321293213932149321593216932179321893219932209322193222932239322493225932269322793228932299323093231932329323393234932359323693237932389323993240932419324293243932449324593246932479324893249932509325193252932539325493255932569325793258932599326093261932629326393264932659326693267932689326993270932719327293273932749327593276932779327893279932809328193282932839328493285932869328793288932899329093291932929329393294932959329693297932989329993300933019330293303933049330593306933079330893309933109331193312933139331493315933169331793318933199332093321933229332393324933259332693327933289332993330933319333293333933349333593336933379333893339933409334193342933439334493345933469334793348933499335093351933529335393354933559335693357933589335993360933619336293363933649336593366933679336893369933709337193372933739337493375933769337793378933799338093381933829338393384933859338693387933889338993390933919339293393933949339593396933979339893399934009340193402934039340493405934069340793408934099341093411934129341393414934159341693417934189341993420934219342293423934249342593426934279342893429934309343193432934339343493435934369343793438934399344093441934429344393444934459344693447934489344993450934519345293453934549345593456934579345893459934609346193462934639346493465934669346793468934699347093471934729347393474934759347693477934789347993480934819348293483934849348593486934879348893489934909349193492934939349493495934969349793498934999350093501935029350393504935059350693507935089350993510935119351293513935149351593516935179351893519935209352193522935239352493525935269352793528935299353093531935329353393534935359353693537935389353993540935419354293543935449354593546935479354893549935509355193552935539355493555935569355793558935599356093561935629356393564935659356693567935689356993570935719357293573935749357593576935779357893579935809358193582935839358493585935869358793588935899359093591935929359393594935959359693597935989359993600936019360293603936049360593606936079360893609936109361193612936139361493615936169361793618936199362093621936229362393624936259362693627936289362993630936319363293633936349363593636936379363893639936409364193642936439364493645936469364793648936499365093651936529365393654936559365693657936589365993660936619366293663936649366593666936679366893669936709367193672936739367493675936769367793678936799368093681936829368393684936859368693687936889368993690936919369293693936949369593696936979369893699937009370193702937039370493705937069370793708937099371093711937129371393714937159371693717937189371993720937219372293723937249372593726937279372893729937309373193732937339373493735937369373793738937399374093741937429374393744937459374693747937489374993750937519375293753937549375593756937579375893759937609376193762937639376493765937669376793768937699377093771937729377393774937759377693777937789377993780937819378293783937849378593786937879378893789937909379193792937939379493795937969379793798937999380093801938029380393804938059380693807938089380993810938119381293813938149381593816938179381893819938209382193822938239382493825938269382793828938299383093831938329383393834938359383693837938389383993840938419384293843938449384593846938479384893849938509385193852938539385493855938569385793858938599386093861938629386393864938659386693867938689386993870938719387293873938749387593876938779387893879938809388193882938839388493885938869388793888938899389093891938929389393894938959389693897938989389993900939019390293903939049390593906939079390893909939109391193912939139391493915939169391793918939199392093921939229392393924939259392693927939289392993930939319393293933939349393593936939379393893939939409394193942939439394493945939469394793948939499395093951939529395393954939559395693957939589395993960939619396293963939649396593966939679396893969939709397193972939739397493975939769397793978939799398093981939829398393984939859398693987939889398993990939919399293993939949399593996939979399893999940009400194002940039400494005940069400794008940099401094011940129401394014940159401694017940189401994020940219402294023940249402594026940279402894029940309403194032940339403494035940369403794038940399404094041940429404394044940459404694047940489404994050940519405294053940549405594056940579405894059940609406194062940639406494065940669406794068940699407094071940729407394074940759407694077940789407994080940819408294083940849408594086940879408894089940909409194092940939409494095940969409794098940999410094101941029410394104941059410694107941089410994110941119411294113941149411594116941179411894119941209412194122941239412494125941269412794128941299413094131941329413394134941359413694137941389413994140941419414294143941449414594146941479414894149941509415194152941539415494155941569415794158941599416094161941629416394164941659416694167941689416994170941719417294173941749417594176941779417894179941809418194182941839418494185941869418794188941899419094191941929419394194941959419694197941989419994200942019420294203942049420594206942079420894209942109421194212942139421494215942169421794218942199422094221942229422394224942259422694227942289422994230942319423294233942349423594236942379423894239942409424194242942439424494245942469424794248942499425094251942529425394254942559425694257942589425994260942619426294263942649426594266942679426894269942709427194272942739427494275942769427794278942799428094281942829428394284942859428694287942889428994290942919429294293942949429594296942979429894299943009430194302943039430494305943069430794308943099431094311943129431394314943159431694317943189431994320943219432294323943249432594326943279432894329943309433194332943339433494335943369433794338943399434094341943429434394344943459434694347943489434994350943519435294353943549435594356943579435894359943609436194362943639436494365943669436794368943699437094371943729437394374943759437694377943789437994380943819438294383943849438594386943879438894389943909439194392943939439494395943969439794398943999440094401944029440394404944059440694407944089440994410944119441294413944149441594416944179441894419944209442194422944239442494425944269442794428944299443094431944329443394434944359443694437944389443994440944419444294443944449444594446944479444894449944509445194452944539445494455944569445794458944599446094461944629446394464944659446694467944689446994470944719447294473944749447594476944779447894479944809448194482944839448494485944869448794488944899449094491944929449394494944959449694497944989449994500945019450294503945049450594506945079450894509945109451194512945139451494515945169451794518945199452094521945229452394524945259452694527945289452994530945319453294533945349453594536945379453894539945409454194542945439454494545945469454794548945499455094551945529455394554945559455694557945589455994560945619456294563945649456594566945679456894569945709457194572945739457494575945769457794578945799458094581945829458394584945859458694587945889458994590945919459294593945949459594596945979459894599946009460194602946039460494605946069460794608946099461094611946129461394614946159461694617946189461994620946219462294623946249462594626946279462894629946309463194632946339463494635946369463794638946399464094641946429464394644946459464694647946489464994650946519465294653946549465594656946579465894659946609466194662946639466494665946669466794668946699467094671946729467394674946759467694677946789467994680946819468294683946849468594686946879468894689946909469194692946939469494695946969469794698946999470094701947029470394704947059470694707947089470994710947119471294713947149471594716947179471894719947209472194722947239472494725947269472794728947299473094731947329473394734947359473694737947389473994740947419474294743947449474594746947479474894749947509475194752947539475494755947569475794758947599476094761947629476394764947659476694767947689476994770947719477294773947749477594776947779477894779947809478194782947839478494785947869478794788947899479094791947929479394794947959479694797947989479994800948019480294803948049480594806948079480894809948109481194812948139481494815948169481794818948199482094821948229482394824948259482694827948289482994830948319483294833948349483594836948379483894839948409484194842948439484494845948469484794848948499485094851948529485394854948559485694857948589485994860948619486294863948649486594866948679486894869948709487194872948739487494875948769487794878948799488094881948829488394884948859488694887948889488994890948919489294893948949489594896948979489894899949009490194902949039490494905949069490794908949099491094911949129491394914949159491694917949189491994920949219492294923949249492594926949279492894929949309493194932949339493494935949369493794938949399494094941949429494394944949459494694947949489494994950949519495294953949549495594956949579495894959949609496194962949639496494965949669496794968949699497094971949729497394974949759497694977949789497994980949819498294983949849498594986949879498894989949909499194992949939499494995949969499794998949999500095001950029500395004950059500695007950089500995010950119501295013950149501595016950179501895019950209502195022950239502495025950269502795028950299503095031950329503395034950359503695037950389503995040950419504295043950449504595046950479504895049950509505195052950539505495055950569505795058950599506095061950629506395064950659506695067950689506995070950719507295073950749507595076950779507895079950809508195082950839508495085950869508795088950899509095091950929509395094950959509695097950989509995100951019510295103951049510595106951079510895109951109511195112951139511495115951169511795118951199512095121951229512395124951259512695127951289512995130951319513295133951349513595136951379513895139951409514195142951439514495145951469514795148951499515095151951529515395154951559515695157951589515995160951619516295163951649516595166951679516895169951709517195172951739517495175951769517795178951799518095181951829518395184951859518695187951889518995190951919519295193951949519595196951979519895199952009520195202952039520495205952069520795208952099521095211952129521395214952159521695217952189521995220952219522295223952249522595226952279522895229952309523195232952339523495235952369523795238952399524095241952429524395244952459524695247952489524995250952519525295253952549525595256952579525895259952609526195262952639526495265952669526795268952699527095271952729527395274952759527695277952789527995280952819528295283952849528595286952879528895289952909529195292952939529495295952969529795298952999530095301953029530395304953059530695307953089530995310953119531295313953149531595316953179531895319953209532195322953239532495325953269532795328953299533095331953329533395334953359533695337953389533995340953419534295343953449534595346953479534895349953509535195352953539535495355953569535795358953599536095361953629536395364953659536695367953689536995370953719537295373953749537595376953779537895379953809538195382953839538495385953869538795388953899539095391953929539395394953959539695397953989539995400954019540295403954049540595406954079540895409954109541195412954139541495415954169541795418954199542095421954229542395424954259542695427954289542995430954319543295433954349543595436954379543895439954409544195442954439544495445954469544795448954499545095451954529545395454954559545695457954589545995460954619546295463954649546595466954679546895469954709547195472954739547495475954769547795478954799548095481954829548395484954859548695487954889548995490954919549295493954949549595496954979549895499955009550195502955039550495505955069550795508955099551095511955129551395514955159551695517955189551995520955219552295523955249552595526955279552895529955309553195532955339553495535955369553795538955399554095541955429554395544955459554695547955489554995550955519555295553955549555595556955579555895559955609556195562955639556495565955669556795568955699557095571955729557395574955759557695577955789557995580955819558295583955849558595586955879558895589955909559195592955939559495595955969559795598955999560095601956029560395604956059560695607956089560995610956119561295613956149561595616956179561895619956209562195622956239562495625956269562795628956299563095631956329563395634956359563695637956389563995640956419564295643956449564595646956479564895649956509565195652956539565495655956569565795658956599566095661956629566395664956659566695667956689566995670956719567295673956749567595676956779567895679956809568195682956839568495685956869568795688956899569095691956929569395694956959569695697956989569995700957019570295703957049570595706957079570895709957109571195712957139571495715957169571795718957199572095721957229572395724957259572695727957289572995730957319573295733957349573595736957379573895739957409574195742957439574495745957469574795748957499575095751957529575395754957559575695757957589575995760957619576295763957649576595766957679576895769957709577195772957739577495775957769577795778957799578095781957829578395784957859578695787957889578995790957919579295793957949579595796957979579895799958009580195802958039580495805958069580795808958099581095811958129581395814958159581695817958189581995820958219582295823958249582595826958279582895829958309583195832958339583495835958369583795838958399584095841958429584395844958459584695847958489584995850958519585295853958549585595856958579585895859958609586195862958639586495865958669586795868958699587095871958729587395874958759587695877958789587995880958819588295883958849588595886958879588895889958909589195892958939589495895958969589795898958999590095901959029590395904959059590695907959089590995910959119591295913959149591595916959179591895919959209592195922959239592495925959269592795928959299593095931959329593395934959359593695937959389593995940959419594295943959449594595946959479594895949959509595195952959539595495955959569595795958959599596095961959629596395964959659596695967959689596995970959719597295973959749597595976959779597895979959809598195982959839598495985959869598795988959899599095991959929599395994959959599695997959989599996000960019600296003960049600596006960079600896009960109601196012960139601496015960169601796018960199602096021960229602396024960259602696027960289602996030960319603296033960349603596036960379603896039960409604196042960439604496045960469604796048960499605096051960529605396054960559605696057960589605996060960619606296063960649606596066960679606896069960709607196072960739607496075960769607796078960799608096081960829608396084960859608696087960889608996090960919609296093960949609596096960979609896099961009610196102961039610496105961069610796108961099611096111961129611396114961159611696117961189611996120961219612296123961249612596126961279612896129961309613196132961339613496135961369613796138961399614096141961429614396144961459614696147961489614996150961519615296153961549615596156961579615896159961609616196162961639616496165961669616796168961699617096171961729617396174961759617696177961789617996180961819618296183961849618596186961879618896189961909619196192961939619496195961969619796198961999620096201962029620396204962059620696207962089620996210962119621296213962149621596216962179621896219962209622196222962239622496225962269622796228962299623096231962329623396234962359623696237962389623996240962419624296243962449624596246962479624896249962509625196252962539625496255962569625796258962599626096261962629626396264962659626696267962689626996270962719627296273962749627596276962779627896279962809628196282962839628496285962869628796288962899629096291962929629396294962959629696297962989629996300963019630296303963049630596306963079630896309963109631196312963139631496315963169631796318963199632096321963229632396324963259632696327963289632996330963319633296333963349633596336963379633896339963409634196342963439634496345963469634796348963499635096351963529635396354963559635696357963589635996360963619636296363963649636596366963679636896369963709637196372963739637496375963769637796378963799638096381963829638396384963859638696387963889638996390963919639296393963949639596396963979639896399964009640196402964039640496405964069640796408964099641096411964129641396414964159641696417964189641996420964219642296423964249642596426964279642896429964309643196432964339643496435964369643796438964399644096441964429644396444964459644696447964489644996450964519645296453964549645596456964579645896459964609646196462964639646496465964669646796468964699647096471964729647396474964759647696477964789647996480964819648296483964849648596486964879648896489964909649196492964939649496495964969649796498964999650096501965029650396504965059650696507965089650996510965119651296513965149651596516965179651896519965209652196522965239652496525965269652796528965299653096531965329653396534965359653696537965389653996540965419654296543965449654596546965479654896549965509655196552965539655496555965569655796558965599656096561965629656396564965659656696567965689656996570965719657296573965749657596576965779657896579965809658196582965839658496585965869658796588965899659096591965929659396594965959659696597965989659996600966019660296603966049660596606966079660896609966109661196612966139661496615966169661796618966199662096621966229662396624966259662696627966289662996630966319663296633966349663596636966379663896639966409664196642966439664496645966469664796648966499665096651966529665396654966559665696657966589665996660966619666296663966649666596666966679666896669966709667196672966739667496675966769667796678966799668096681966829668396684966859668696687966889668996690966919669296693966949669596696966979669896699967009670196702967039670496705967069670796708967099671096711967129671396714967159671696717967189671996720967219672296723967249672596726967279672896729967309673196732967339673496735967369673796738967399674096741967429674396744967459674696747967489674996750967519675296753967549675596756967579675896759967609676196762967639676496765967669676796768967699677096771967729677396774967759677696777967789677996780967819678296783967849678596786967879678896789967909679196792967939679496795967969679796798967999680096801968029680396804968059680696807968089680996810968119681296813968149681596816968179681896819968209682196822968239682496825968269682796828968299683096831968329683396834968359683696837968389683996840968419684296843968449684596846968479684896849968509685196852968539685496855968569685796858968599686096861968629686396864968659686696867968689686996870968719687296873968749687596876968779687896879968809688196882968839688496885968869688796888968899689096891968929689396894968959689696897968989689996900969019690296903969049690596906969079690896909969109691196912969139691496915969169691796918969199692096921969229692396924969259692696927969289692996930969319693296933969349693596936969379693896939969409694196942969439694496945969469694796948969499695096951969529695396954969559695696957969589695996960969619696296963969649696596966969679696896969969709697196972969739697496975969769697796978969799698096981969829698396984969859698696987969889698996990969919699296993969949699596996969979699896999970009700197002970039700497005970069700797008970099701097011970129701397014970159701697017970189701997020970219702297023970249702597026970279702897029970309703197032970339703497035970369703797038970399704097041970429704397044970459704697047970489704997050970519705297053970549705597056970579705897059970609706197062970639706497065970669706797068970699707097071970729707397074970759707697077970789707997080970819708297083970849708597086970879708897089970909709197092970939709497095970969709797098970999710097101971029710397104971059710697107971089710997110971119711297113971149711597116971179711897119971209712197122971239712497125971269712797128971299713097131971329713397134971359713697137971389713997140971419714297143971449714597146971479714897149971509715197152971539715497155971569715797158971599716097161971629716397164971659716697167971689716997170971719717297173971749717597176971779717897179971809718197182971839718497185971869718797188971899719097191971929719397194971959719697197971989719997200972019720297203972049720597206972079720897209972109721197212972139721497215972169721797218972199722097221972229722397224972259722697227972289722997230972319723297233972349723597236972379723897239972409724197242972439724497245972469724797248972499725097251972529725397254972559725697257972589725997260972619726297263972649726597266972679726897269972709727197272972739727497275972769727797278972799728097281972829728397284972859728697287972889728997290972919729297293972949729597296972979729897299973009730197302973039730497305973069730797308973099731097311973129731397314973159731697317973189731997320973219732297323973249732597326973279732897329973309733197332973339733497335973369733797338973399734097341973429734397344973459734697347973489734997350973519735297353973549735597356973579735897359973609736197362973639736497365973669736797368973699737097371973729737397374973759737697377973789737997380973819738297383973849738597386973879738897389973909739197392973939739497395973969739797398973999740097401974029740397404974059740697407974089740997410974119741297413974149741597416974179741897419974209742197422974239742497425974269742797428974299743097431974329743397434974359743697437974389743997440974419744297443974449744597446974479744897449974509745197452974539745497455974569745797458974599746097461974629746397464974659746697467974689746997470974719747297473974749747597476974779747897479974809748197482974839748497485974869748797488974899749097491974929749397494974959749697497974989749997500975019750297503975049750597506975079750897509975109751197512975139751497515975169751797518975199752097521975229752397524975259752697527975289752997530975319753297533975349753597536975379753897539975409754197542975439754497545975469754797548975499755097551975529755397554975559755697557975589755997560975619756297563975649756597566975679756897569975709757197572975739757497575975769757797578975799758097581975829758397584975859758697587975889758997590975919759297593975949759597596975979759897599976009760197602976039760497605976069760797608976099761097611976129761397614976159761697617976189761997620976219762297623976249762597626976279762897629976309763197632976339763497635976369763797638976399764097641976429764397644976459764697647976489764997650976519765297653976549765597656976579765897659976609766197662976639766497665976669766797668976699767097671976729767397674976759767697677976789767997680976819768297683976849768597686976879768897689976909769197692976939769497695976969769797698976999770097701977029770397704977059770697707977089770997710977119771297713977149771597716977179771897719977209772197722977239772497725977269772797728977299773097731977329773397734977359773697737977389773997740977419774297743977449774597746977479774897749977509775197752977539775497755977569775797758977599776097761977629776397764977659776697767977689776997770977719777297773977749777597776977779777897779977809778197782977839778497785977869778797788977899779097791977929779397794977959779697797977989779997800978019780297803978049780597806978079780897809978109781197812978139781497815978169781797818978199782097821978229782397824978259782697827978289782997830978319783297833978349783597836978379783897839978409784197842978439784497845978469784797848978499785097851978529785397854978559785697857978589785997860978619786297863978649786597866978679786897869978709787197872978739787497875978769787797878978799788097881978829788397884978859788697887978889788997890978919789297893978949789597896978979789897899979009790197902979039790497905979069790797908979099791097911979129791397914979159791697917979189791997920979219792297923979249792597926979279792897929979309793197932979339793497935979369793797938979399794097941979429794397944979459794697947979489794997950979519795297953979549795597956979579795897959979609796197962979639796497965979669796797968979699797097971979729797397974979759797697977979789797997980979819798297983979849798597986979879798897989979909799197992979939799497995979969799797998979999800098001980029800398004980059800698007980089800998010980119801298013980149801598016980179801898019980209802198022980239802498025980269802798028980299803098031980329803398034980359803698037980389803998040980419804298043980449804598046980479804898049980509805198052980539805498055980569805798058980599806098061980629806398064980659806698067980689806998070980719807298073980749807598076980779807898079980809808198082980839808498085980869808798088980899809098091980929809398094980959809698097980989809998100981019810298103981049810598106981079810898109981109811198112981139811498115981169811798118981199812098121981229812398124981259812698127981289812998130981319813298133981349813598136981379813898139981409814198142981439814498145981469814798148981499815098151981529815398154981559815698157981589815998160981619816298163981649816598166981679816898169981709817198172981739817498175981769817798178981799818098181981829818398184981859818698187981889818998190981919819298193981949819598196981979819898199982009820198202982039820498205982069820798208982099821098211982129821398214982159821698217982189821998220982219822298223982249822598226982279822898229982309823198232982339823498235982369823798238982399824098241982429824398244982459824698247982489824998250982519825298253982549825598256982579825898259982609826198262982639826498265982669826798268982699827098271982729827398274982759827698277982789827998280982819828298283982849828598286982879828898289982909829198292982939829498295982969829798298982999830098301983029830398304983059830698307983089830998310983119831298313983149831598316983179831898319983209832198322983239832498325983269832798328983299833098331983329833398334983359833698337983389833998340983419834298343983449834598346983479834898349983509835198352983539835498355983569835798358983599836098361983629836398364983659836698367983689836998370983719837298373983749837598376983779837898379983809838198382983839838498385983869838798388983899839098391983929839398394983959839698397983989839998400984019840298403984049840598406984079840898409984109841198412984139841498415984169841798418984199842098421984229842398424984259842698427984289842998430984319843298433984349843598436984379843898439984409844198442984439844498445984469844798448984499845098451984529845398454984559845698457984589845998460984619846298463984649846598466984679846898469984709847198472984739847498475984769847798478984799848098481984829848398484984859848698487984889848998490984919849298493984949849598496984979849898499985009850198502985039850498505985069850798508985099851098511985129851398514985159851698517985189851998520985219852298523985249852598526985279852898529985309853198532985339853498535985369853798538985399854098541985429854398544985459854698547985489854998550985519855298553985549855598556985579855898559985609856198562985639856498565985669856798568985699857098571985729857398574985759857698577985789857998580985819858298583985849858598586985879858898589985909859198592985939859498595985969859798598985999860098601986029860398604986059860698607986089860998610986119861298613986149861598616986179861898619986209862198622986239862498625986269862798628986299863098631986329863398634986359863698637986389863998640986419864298643986449864598646986479864898649986509865198652986539865498655986569865798658986599866098661986629866398664986659866698667986689866998670986719867298673986749867598676986779867898679986809868198682986839868498685986869868798688986899869098691986929869398694986959869698697986989869998700987019870298703987049870598706987079870898709987109871198712987139871498715987169871798718987199872098721987229872398724987259872698727987289872998730987319873298733987349873598736987379873898739987409874198742987439874498745987469874798748987499875098751987529875398754987559875698757987589875998760987619876298763987649876598766987679876898769987709877198772987739877498775987769877798778987799878098781987829878398784987859878698787987889878998790987919879298793987949879598796987979879898799988009880198802988039880498805988069880798808988099881098811988129881398814988159881698817988189881998820988219882298823988249882598826988279882898829988309883198832988339883498835988369883798838988399884098841988429884398844988459884698847988489884998850988519885298853988549885598856988579885898859988609886198862988639886498865988669886798868988699887098871988729887398874988759887698877988789887998880988819888298883988849888598886988879888898889988909889198892988939889498895988969889798898988999890098901989029890398904989059890698907989089890998910989119891298913989149891598916989179891898919989209892198922989239892498925989269892798928989299893098931989329893398934989359893698937989389893998940989419894298943989449894598946989479894898949989509895198952989539895498955989569895798958989599896098961989629896398964989659896698967989689896998970989719897298973989749897598976989779897898979989809898198982989839898498985989869898798988989899899098991989929899398994989959899698997989989899999000990019900299003990049900599006990079900899009990109901199012990139901499015990169901799018990199902099021990229902399024990259902699027990289902999030990319903299033990349903599036990379903899039990409904199042990439904499045990469904799048990499905099051990529905399054990559905699057990589905999060990619906299063990649906599066990679906899069990709907199072990739907499075990769907799078990799908099081990829908399084990859908699087990889908999090990919909299093990949909599096990979909899099991009910199102991039910499105991069910799108991099911099111991129911399114991159911699117991189911999120991219912299123991249912599126991279912899129991309913199132991339913499135991369913799138991399914099141991429914399144991459914699147991489914999150991519915299153991549915599156991579915899159991609916199162991639916499165991669916799168991699917099171991729917399174991759917699177991789917999180991819918299183991849918599186991879918899189991909919199192991939919499195991969919799198991999920099201992029920399204992059920699207992089920999210992119921299213992149921599216992179921899219992209922199222992239922499225992269922799228992299923099231992329923399234992359923699237992389923999240992419924299243992449924599246992479924899249992509925199252992539925499255992569925799258992599926099261992629926399264992659926699267992689926999270992719927299273992749927599276992779927899279992809928199282992839928499285992869928799288992899929099291992929929399294992959929699297992989929999300993019930299303993049930599306993079930899309993109931199312993139931499315993169931799318993199932099321993229932399324993259932699327993289932999330993319933299333993349933599336993379933899339993409934199342993439934499345993469934799348993499935099351993529935399354993559935699357993589935999360993619936299363993649936599366993679936899369993709937199372993739937499375993769937799378993799938099381993829938399384993859938699387993889938999390993919939299393993949939599396993979939899399994009940199402994039940499405994069940799408994099941099411994129941399414994159941699417994189941999420994219942299423994249942599426994279942899429994309943199432994339943499435994369943799438994399944099441994429944399444994459944699447994489944999450994519945299453994549945599456994579945899459994609946199462994639946499465994669946799468994699947099471994729947399474994759947699477994789947999480994819948299483994849948599486994879948899489994909949199492994939949499495994969949799498994999950099501995029950399504995059950699507995089950999510995119951299513995149951599516995179951899519995209952199522995239952499525995269952799528995299953099531995329953399534995359953699537995389953999540995419954299543995449954599546995479954899549995509955199552995539955499555995569955799558995599956099561995629956399564995659956699567995689956999570995719957299573995749957599576995779957899579995809958199582995839958499585995869958799588995899959099591995929959399594995959959699597995989959999600996019960299603996049960599606996079960899609996109961199612996139961499615996169961799618996199962099621996229962399624996259962699627996289962999630996319963299633996349963599636996379963899639996409964199642996439964499645996469964799648996499965099651996529965399654996559965699657996589965999660996619966299663996649966599666996679966899669996709967199672996739967499675996769967799678996799968099681996829968399684996859968699687996889968999690996919969299693996949969599696996979969899699997009970199702997039970499705997069970799708997099971099711997129971399714997159971699717997189971999720997219972299723997249972599726997279972899729997309973199732997339973499735997369973799738997399974099741997429974399744997459974699747997489974999750997519975299753997549975599756997579975899759997609976199762997639976499765997669976799768997699977099771997729977399774997759977699777997789977999780997819978299783997849978599786997879978899789997909979199792997939979499795997969979799798997999980099801998029980399804998059980699807998089980999810998119981299813998149981599816998179981899819998209982199822998239982499825998269982799828998299983099831998329983399834998359983699837998389983999840998419984299843998449984599846998479984899849998509985199852998539985499855998569985799858998599986099861998629986399864998659986699867998689986999870998719987299873998749987599876998779987899879998809988199882998839988499885998869988799888998899989099891998929989399894998959989699897998989989999900999019990299903999049990599906999079990899909999109991199912999139991499915999169991799918999199992099921999229992399924999259992699927999289992999930999319993299933999349993599936999379993899939999409994199942999439994499945999469994799948999499995099951999529995399954999559995699957999589995999960999619996299963999649996599966999679996899969999709997199972999739997499975999769997799978999799998099981999829998399984999859998699987999889998999990999919999299993999949999599996999979999899999100000100001100002100003100004100005100006100007100008100009100010100011100012100013100014100015100016100017100018100019100020100021100022100023100024100025100026100027100028100029100030100031100032100033100034100035100036100037100038100039100040100041100042100043100044100045100046100047100048100049100050100051100052100053100054100055100056100057100058100059100060100061100062100063100064100065100066100067100068100069100070100071100072100073100074100075100076100077100078100079100080100081100082100083100084100085100086100087100088100089100090100091100092100093100094100095100096100097100098100099100100100101100102100103100104100105100106100107100108100109100110100111100112100113100114100115100116100117100118100119100120100121100122100123100124100125100126100127100128100129100130100131100132100133100134100135100136100137100138100139100140100141100142100143100144100145100146100147100148100149100150100151100152100153100154100155100156100157100158100159100160100161100162100163100164100165100166100167100168100169100170100171100172100173100174100175100176100177100178100179100180100181100182100183100184100185100186100187100188100189100190100191100192100193100194100195100196100197100198100199100200100201100202100203100204100205100206100207100208100209100210100211100212100213100214100215100216100217100218100219100220100221100222100223100224100225100226100227100228100229100230100231100232100233100234100235100236100237100238100239100240100241100242100243100244100245100246100247100248100249100250100251100252100253100254100255100256100257100258100259100260100261100262100263100264100265100266100267100268100269100270100271100272100273100274100275100276100277100278100279100280100281100282100283100284100285100286100287100288100289100290100291100292100293100294100295100296100297100298100299100300100301100302100303100304100305100306100307100308100309100310100311100312100313100314100315100316100317100318100319100320100321100322100323100324100325100326100327100328100329100330100331100332100333100334100335100336100337100338100339100340100341100342100343100344100345100346100347100348100349100350100351100352100353100354100355100356100357100358100359100360100361100362100363100364100365100366100367100368100369100370100371100372100373100374100375100376100377100378100379100380100381100382100383100384100385100386100387100388100389100390100391100392100393100394100395100396100397100398100399100400100401100402100403100404100405100406100407100408100409100410100411100412100413100414100415100416100417100418100419100420100421100422100423100424100425100426100427100428100429100430100431100432100433100434100435100436100437100438100439100440100441100442100443100444100445100446100447100448100449100450100451100452100453100454100455100456100457100458100459100460100461100462100463100464100465100466100467100468100469100470100471100472100473100474100475100476100477100478100479100480100481100482100483100484100485100486100487100488100489100490100491100492100493100494100495100496100497100498100499100500100501100502100503100504100505100506100507100508100509100510100511100512100513100514100515100516100517100518100519100520100521100522100523100524100525100526100527100528100529100530100531100532100533100534100535100536100537100538100539100540100541100542100543100544100545100546100547100548100549100550100551100552100553100554100555100556100557100558100559100560100561100562100563100564100565100566100567100568100569100570100571100572100573100574100575100576100577100578100579100580100581100582100583100584100585100586100587100588100589100590100591100592100593100594100595100596100597100598100599100600100601100602100603100604100605100606100607100608100609100610100611100612100613100614100615100616100617100618100619100620100621100622100623100624100625100626100627100628100629100630100631100632100633100634100635100636100637100638100639100640100641100642100643100644100645100646100647100648100649100650100651100652100653100654100655100656100657100658100659100660100661100662100663100664100665100666100667100668100669100670100671100672100673100674100675100676100677100678100679100680100681100682100683100684100685100686100687100688100689100690100691100692100693100694100695100696100697100698100699100700100701100702100703100704100705100706100707100708100709100710100711100712100713100714100715100716100717100718100719100720100721100722100723100724100725100726100727100728100729100730100731100732100733100734100735100736100737100738100739100740100741100742100743100744100745100746100747100748100749100750100751100752100753100754100755100756100757100758100759100760100761100762100763100764100765100766100767100768100769100770100771100772100773100774100775100776100777100778100779100780100781100782100783100784100785100786100787100788100789100790100791100792100793100794100795100796100797100798100799100800100801100802100803100804100805100806100807100808100809100810100811100812100813100814100815100816100817100818100819100820100821100822100823100824100825100826100827100828100829100830100831100832100833100834100835100836100837100838100839100840100841100842100843100844100845100846100847100848100849100850100851100852100853100854100855100856100857100858100859100860100861100862100863100864100865100866100867100868100869100870100871100872100873100874100875100876100877100878100879100880100881100882100883100884100885100886100887100888100889100890100891100892100893100894100895100896100897100898100899100900100901100902100903100904100905100906100907100908100909100910100911100912100913100914100915100916100917100918100919100920100921100922100923100924100925100926100927100928100929100930100931100932100933100934100935100936100937100938100939100940100941100942100943100944100945100946100947100948100949100950100951100952100953100954100955100956100957100958100959100960100961100962100963100964100965100966100967100968100969100970100971100972100973100974100975100976100977100978100979100980100981100982100983100984100985100986100987100988100989100990100991100992100993100994100995100996100997100998100999101000101001101002101003101004101005101006101007101008101009101010101011101012101013101014101015101016101017101018101019101020101021101022101023101024101025101026101027101028101029101030101031101032101033101034101035101036101037101038101039101040101041101042101043101044101045101046101047101048101049101050101051101052101053101054101055101056101057101058101059101060101061101062101063101064101065101066101067101068101069101070101071101072101073101074101075101076101077101078101079101080101081101082101083101084101085101086101087101088101089101090101091101092101093101094101095101096101097101098101099101100101101101102101103101104101105101106101107101108101109101110101111101112101113101114101115101116101117101118101119101120101121101122101123101124101125101126101127101128101129101130101131101132101133101134101135101136101137101138101139101140101141101142101143101144101145101146101147101148101149101150101151101152101153101154101155101156101157101158101159101160101161101162101163101164101165101166101167101168101169101170101171101172101173101174101175101176101177101178101179101180101181101182101183101184101185101186101187101188101189101190101191101192101193101194101195101196101197101198101199101200101201101202101203101204101205101206101207101208101209101210101211101212101213101214101215101216101217101218101219101220101221101222101223101224101225101226101227101228101229101230101231101232101233101234101235101236101237101238101239101240101241101242101243101244101245101246101247101248101249101250101251101252101253101254101255101256101257101258101259101260101261101262101263101264101265101266101267101268101269101270101271101272101273101274101275101276101277101278101279101280101281101282101283101284101285101286101287101288101289101290101291101292101293101294101295101296101297101298101299101300101301101302101303101304101305101306101307101308101309101310101311101312101313101314101315101316101317101318101319101320101321101322101323101324101325101326101327101328101329101330101331101332101333101334101335101336101337101338101339101340101341101342101343101344101345101346101347101348101349101350101351101352101353101354101355101356101357101358101359101360101361101362101363101364101365101366101367101368101369101370101371101372101373101374101375101376101377101378101379101380101381101382101383101384101385101386101387101388101389101390101391101392101393101394101395101396101397101398101399101400101401101402101403101404101405101406101407101408101409101410101411101412101413101414101415101416101417101418101419101420101421101422101423101424101425101426101427101428101429101430101431101432101433101434101435101436101437101438101439101440101441101442101443101444101445101446101447101448101449101450101451101452101453101454101455101456101457101458101459101460101461101462101463101464101465101466101467101468101469101470101471101472101473101474101475101476101477101478101479101480101481101482101483101484101485101486101487101488101489101490101491101492101493101494101495101496101497101498101499101500101501101502101503101504101505101506101507101508101509101510101511101512101513101514101515101516101517101518101519101520101521101522101523101524101525101526101527101528101529101530101531101532101533101534101535101536101537101538101539101540101541101542101543101544101545101546101547101548101549101550101551101552101553101554101555101556101557101558101559101560101561101562101563101564101565101566101567101568101569101570101571101572101573101574101575101576101577101578101579101580101581101582101583101584101585101586101587101588101589101590101591101592101593101594101595101596101597101598101599101600101601101602101603101604101605101606101607101608101609101610101611101612101613101614101615101616101617101618101619101620101621101622101623101624101625101626101627101628101629101630101631101632101633101634101635101636101637101638101639101640101641101642101643101644101645101646101647101648101649101650101651101652101653101654101655101656101657101658101659101660101661101662101663101664101665101666101667101668101669101670101671101672101673101674101675101676101677101678101679101680101681101682101683101684101685101686101687101688101689101690101691101692101693101694101695101696101697101698101699101700101701101702101703101704101705101706101707101708101709101710101711101712101713101714101715101716101717101718101719101720101721101722101723101724101725101726101727101728101729101730101731101732101733101734101735101736101737101738101739101740101741101742101743101744101745101746101747101748101749101750101751101752101753101754101755101756101757101758101759101760101761101762101763101764101765101766101767101768101769101770101771101772101773101774101775101776101777101778101779101780101781101782101783101784101785101786101787101788101789101790101791101792101793101794101795101796101797101798101799101800101801101802101803101804101805101806101807101808101809101810101811101812101813101814101815101816101817101818101819101820101821101822101823101824101825101826101827101828101829101830101831101832101833101834101835101836101837101838101839101840101841101842101843101844101845101846101847101848101849101850101851101852101853101854101855101856101857101858101859101860101861101862101863101864101865101866101867101868101869101870101871101872101873101874101875101876101877101878101879101880101881101882101883101884101885101886101887101888101889101890101891101892101893101894101895101896101897101898101899101900101901101902101903101904101905101906101907101908101909101910101911101912101913101914101915101916101917101918101919101920101921101922101923101924101925101926101927101928101929101930101931101932101933101934101935101936101937101938101939101940101941101942101943101944101945101946101947101948101949101950101951101952101953101954101955101956101957101958101959101960101961101962101963101964101965101966101967101968101969101970101971101972101973101974101975101976101977101978101979101980101981101982101983101984101985101986101987101988101989101990101991101992101993101994101995101996101997101998101999102000102001102002102003102004102005102006102007102008102009102010102011102012102013102014102015102016102017102018102019102020102021102022102023102024102025102026102027102028102029102030102031102032102033102034102035102036102037102038102039102040102041102042102043102044102045102046102047102048102049102050102051102052102053102054102055102056102057102058102059102060102061102062102063102064102065102066102067102068102069102070102071102072102073102074102075102076102077102078102079102080102081102082102083102084102085102086102087102088102089102090102091102092102093102094102095102096102097102098102099102100102101102102102103102104102105102106102107102108102109102110102111102112102113102114102115102116102117102118102119102120102121102122102123102124102125102126102127102128102129102130102131102132102133102134102135102136102137102138102139102140102141102142102143102144102145102146102147102148102149102150102151102152102153102154102155102156102157102158102159102160102161102162102163102164102165102166102167102168102169102170102171102172102173102174102175102176102177102178102179102180102181102182102183102184102185102186102187102188102189102190102191102192102193102194102195102196102197102198102199102200102201102202102203102204102205102206102207102208102209102210102211102212102213102214102215102216102217102218102219102220102221102222102223102224102225102226102227102228102229102230102231102232102233102234102235102236102237102238102239102240102241102242102243102244102245102246102247102248102249102250102251102252102253102254102255102256102257102258102259102260102261102262102263102264102265102266102267102268102269102270102271102272102273102274102275102276102277102278102279102280102281102282102283102284102285102286102287102288102289102290102291102292102293102294102295102296102297102298102299102300102301102302102303102304102305102306102307102308102309102310102311102312102313102314102315102316102317102318102319102320102321102322102323102324102325102326102327102328102329102330102331102332102333102334102335102336102337102338102339102340102341102342102343102344102345102346102347102348102349102350102351102352102353102354102355102356102357102358102359102360102361102362102363102364102365102366102367102368102369102370102371102372102373102374102375102376102377102378102379102380102381102382102383102384102385102386102387102388102389102390102391102392102393102394102395102396102397102398102399102400102401102402102403102404102405102406102407102408102409102410102411102412102413102414102415102416102417102418102419102420102421102422102423102424102425102426102427102428102429102430102431102432102433102434102435102436102437102438102439102440102441102442102443102444102445102446102447102448102449102450102451102452102453102454102455102456102457102458102459102460102461102462102463102464102465102466102467102468102469102470102471102472102473102474102475102476102477102478102479102480102481102482102483102484102485102486102487102488102489102490102491102492102493102494102495102496102497102498102499102500102501102502102503102504102505102506102507102508102509102510102511102512102513102514102515102516102517102518102519102520102521102522102523102524102525102526102527102528102529102530102531102532102533102534102535102536102537102538102539102540102541102542102543102544102545102546102547102548102549102550102551102552102553102554102555102556102557102558102559102560102561102562102563102564102565102566102567102568102569102570102571102572102573102574102575102576102577102578102579102580102581102582102583102584102585102586102587102588102589102590102591102592102593102594102595102596102597102598102599102600102601102602102603102604102605102606102607102608102609102610102611102612102613102614102615102616102617102618102619102620102621102622102623102624102625102626102627102628102629102630102631102632102633102634102635102636102637102638102639102640102641102642102643102644102645102646102647102648102649102650102651102652102653102654102655102656102657102658102659102660102661102662102663102664102665102666102667102668102669102670102671102672102673102674102675102676102677102678102679102680102681102682102683102684102685102686102687102688102689102690102691102692102693102694102695102696102697102698102699102700102701102702102703102704102705102706102707102708102709102710102711102712102713102714102715102716102717102718102719102720102721102722102723102724102725102726102727102728102729102730102731102732102733102734102735102736102737102738102739102740102741102742102743102744102745102746102747102748102749102750102751102752102753102754102755102756102757102758102759102760102761102762102763102764102765102766102767102768102769102770102771102772102773102774102775102776102777102778102779102780102781102782102783102784102785102786102787102788102789102790102791102792102793102794102795102796102797102798102799102800102801102802102803102804102805102806102807102808102809102810102811102812102813102814102815102816102817102818102819102820102821102822102823102824102825102826102827102828102829102830102831102832102833102834102835102836102837102838102839102840102841102842102843102844102845102846102847102848102849102850102851102852102853102854102855102856102857102858102859102860102861102862102863102864102865102866102867102868102869102870102871102872102873102874102875102876102877102878102879102880102881102882102883102884102885102886102887102888102889102890102891102892102893102894102895102896102897102898102899102900102901102902102903102904102905102906102907102908102909102910102911102912102913102914102915102916102917102918102919102920102921102922102923102924102925102926102927102928102929102930102931102932102933102934102935102936102937102938102939102940102941102942102943102944102945102946102947102948102949102950102951102952102953102954102955102956102957102958102959102960102961102962102963102964102965102966102967102968102969102970102971102972102973102974102975102976102977102978102979102980102981102982102983102984102985102986102987102988102989102990102991102992102993102994102995102996102997102998102999103000103001103002103003103004103005103006103007103008103009103010103011103012103013103014103015103016103017103018103019103020103021103022103023103024103025103026103027103028103029103030103031103032103033103034103035103036103037103038103039103040103041103042103043103044103045103046103047103048103049103050103051103052103053103054103055103056103057103058103059103060103061103062103063103064103065103066103067103068103069103070103071103072103073103074103075103076103077103078103079103080103081103082103083103084103085103086103087103088103089103090103091103092103093103094103095103096103097103098103099103100103101103102103103103104103105103106103107103108103109103110103111103112103113103114103115103116103117103118103119103120103121103122103123103124103125103126103127103128103129103130103131103132103133103134103135103136103137103138103139103140103141103142103143103144103145103146103147103148103149103150103151103152103153103154103155103156103157103158103159103160103161103162103163103164103165103166103167103168103169103170103171103172103173103174103175103176103177103178103179103180103181103182103183103184103185103186103187103188103189103190103191103192103193103194103195103196103197103198103199103200103201103202103203103204103205103206103207103208103209103210103211103212103213103214103215103216103217103218103219103220103221103222103223103224103225103226103227103228103229103230103231103232103233103234103235103236103237103238103239103240103241103242103243103244103245103246103247103248103249103250103251103252103253103254103255103256103257103258103259103260103261103262103263103264103265103266103267103268103269103270103271103272103273103274103275103276103277103278103279103280103281103282103283103284103285103286103287103288103289103290103291103292103293103294103295103296103297103298103299103300103301103302103303103304103305103306103307103308103309103310103311103312103313103314103315103316103317103318103319103320103321103322103323103324103325103326103327103328103329103330103331103332103333103334103335103336103337103338103339103340103341103342103343103344103345103346103347103348103349103350103351103352103353103354103355103356103357103358103359103360103361103362103363103364103365103366103367103368103369103370103371103372103373103374103375103376103377103378103379103380103381103382103383103384103385103386103387103388103389103390103391103392103393103394103395103396103397103398103399103400103401103402103403103404103405103406103407103408103409103410103411103412103413103414103415103416103417103418103419103420103421103422103423103424103425103426103427103428103429103430103431103432103433103434103435103436103437103438103439103440103441103442103443103444103445103446103447103448103449103450103451103452103453103454103455103456103457103458103459103460103461103462103463103464103465103466103467103468103469103470103471103472103473103474103475103476103477103478103479103480103481103482103483103484103485103486103487103488103489103490103491103492103493103494103495103496103497103498103499103500103501103502103503103504103505103506103507103508103509103510103511103512103513103514103515103516103517103518103519103520103521103522103523103524103525103526103527103528103529103530103531103532103533103534103535103536103537103538103539103540103541103542103543103544103545103546103547103548103549103550103551103552103553103554103555103556103557103558103559103560103561103562103563103564103565103566103567103568103569103570103571103572103573103574103575103576103577103578103579103580103581103582103583103584103585103586103587103588103589103590103591103592103593103594103595103596103597103598103599103600103601103602103603103604103605103606103607103608103609103610103611103612103613103614103615103616103617103618103619103620103621103622103623103624103625103626103627103628103629103630103631103632103633103634103635103636103637103638103639103640103641103642103643103644103645103646103647103648103649103650103651103652103653103654103655103656103657103658103659103660103661103662103663103664103665103666103667103668103669103670103671103672103673103674103675103676103677103678103679103680103681103682103683103684103685103686103687103688103689103690103691103692103693103694103695103696103697103698103699103700103701103702103703103704103705103706103707103708103709103710103711103712103713103714103715103716103717103718103719103720103721103722103723103724103725103726103727103728103729103730103731103732103733103734103735103736103737103738103739103740103741103742103743103744103745103746103747103748103749103750103751103752103753103754103755103756103757103758103759103760103761103762103763103764103765103766103767103768103769103770103771103772103773103774103775103776103777103778103779103780103781103782103783103784103785103786103787103788103789103790103791103792103793103794103795103796103797103798103799103800103801103802103803103804103805103806103807103808103809103810103811103812103813103814103815103816103817103818103819103820103821103822103823103824103825103826103827103828103829103830103831103832103833103834103835103836103837103838103839103840103841103842103843103844103845103846103847103848103849103850103851103852103853103854103855103856103857103858103859103860103861103862103863103864103865103866103867103868103869103870103871103872103873103874103875103876103877103878103879103880103881103882103883103884103885103886103887103888103889103890103891103892103893103894103895103896103897103898103899103900103901103902103903103904103905103906103907103908103909103910103911103912103913103914103915103916103917103918103919103920103921103922103923103924103925103926103927103928103929103930103931103932103933103934103935103936103937103938103939103940103941103942103943103944103945103946103947103948103949103950103951103952103953103954103955103956103957103958103959103960103961103962103963103964103965103966103967103968103969103970103971103972103973103974103975103976103977103978103979103980103981103982103983103984103985103986103987103988103989103990103991103992103993103994103995103996103997103998103999104000104001104002104003104004104005104006104007104008104009104010104011104012104013104014104015104016104017104018104019104020104021104022104023104024104025104026104027104028104029104030104031104032104033104034104035104036104037104038104039104040104041104042104043104044104045104046104047104048104049104050104051104052104053104054104055104056104057104058104059104060104061104062104063104064104065104066104067104068104069104070104071104072104073104074104075104076104077104078104079104080104081104082104083104084104085104086104087104088104089104090104091104092104093104094104095104096104097104098104099104100104101104102104103104104104105104106104107104108104109104110104111104112104113104114104115104116104117104118104119104120104121104122104123104124104125104126104127104128104129104130104131104132104133104134104135104136104137104138104139104140104141104142104143104144104145104146104147104148104149104150104151104152104153104154104155104156104157104158104159104160104161104162104163104164104165104166104167104168104169104170104171104172104173104174104175104176104177104178104179104180104181104182104183104184104185104186104187104188104189104190104191104192104193104194104195104196104197104198104199104200104201104202104203104204104205104206104207104208104209104210104211104212104213104214104215104216104217104218104219104220104221104222104223104224104225104226104227104228104229104230104231104232104233104234104235104236104237104238104239104240104241104242104243104244104245104246104247104248104249104250104251104252104253104254104255104256104257104258104259104260104261104262104263104264104265104266104267104268104269104270104271104272104273104274104275104276104277104278104279104280104281104282104283104284104285104286104287104288104289104290104291104292104293104294104295104296104297104298104299104300104301104302104303104304104305104306104307104308104309104310104311104312104313104314104315104316104317104318104319104320104321104322104323104324104325104326104327104328104329104330104331104332104333104334104335104336104337104338104339104340104341104342104343104344104345104346104347104348104349104350104351104352104353104354104355104356104357104358104359104360104361104362104363104364104365104366104367104368104369104370104371104372104373104374104375104376104377104378104379104380104381104382104383104384104385104386104387104388104389104390104391104392104393104394104395104396104397104398104399104400104401104402104403104404104405104406104407104408104409104410104411104412104413104414104415104416104417104418104419104420104421104422104423104424104425104426104427104428104429104430104431104432104433104434104435104436104437104438104439104440104441104442104443104444104445104446104447104448104449104450104451104452104453104454104455104456104457104458104459104460104461104462104463104464104465104466104467104468104469104470104471104472104473104474104475104476104477104478104479104480104481104482104483104484104485104486104487104488104489104490104491104492104493104494104495104496104497104498104499104500104501104502104503104504104505104506104507104508104509104510104511104512104513104514104515104516104517104518104519104520104521104522104523104524104525104526104527104528104529104530104531104532104533104534104535104536104537104538104539104540104541104542104543104544104545104546104547104548104549104550104551104552104553104554104555104556104557104558104559104560104561104562104563104564104565104566104567104568104569104570104571104572104573104574104575104576104577104578104579104580104581104582104583104584104585104586104587104588104589104590104591104592104593104594104595104596104597104598104599104600104601104602104603104604104605104606104607104608104609104610104611104612104613104614104615104616104617104618104619104620104621104622104623104624104625104626104627104628104629104630104631104632104633104634104635104636104637104638104639104640104641104642104643104644104645104646104647104648104649104650104651104652104653104654104655104656104657104658104659104660104661104662104663104664104665104666104667104668104669104670104671104672104673104674104675104676104677104678104679104680104681104682104683104684104685104686104687104688104689104690104691104692104693104694104695104696104697104698104699104700104701104702104703104704104705104706104707104708104709104710104711104712104713104714104715104716104717104718104719104720104721104722104723104724104725104726104727104728104729104730104731104732104733104734104735104736104737104738104739104740104741104742104743104744104745104746104747104748104749104750104751104752104753104754104755104756104757104758104759104760104761104762104763104764104765104766104767104768104769104770104771104772104773104774104775104776104777104778104779104780104781104782104783104784104785104786104787104788104789104790104791104792104793104794104795104796104797104798104799104800104801104802104803104804104805104806104807104808104809104810104811104812104813104814104815104816104817104818104819104820104821104822104823104824104825104826104827104828104829104830104831104832104833104834104835104836104837104838104839104840104841104842104843104844104845104846104847104848104849104850104851104852104853104854104855104856104857104858104859104860104861104862104863104864104865104866104867104868104869104870104871104872104873104874104875104876104877104878104879104880104881104882104883104884104885104886104887104888104889104890104891104892104893104894104895104896104897104898104899104900104901104902104903104904104905104906104907104908104909104910104911104912104913104914104915104916104917104918104919104920104921104922104923104924104925104926104927104928104929104930104931104932104933104934104935104936104937104938104939104940104941104942104943104944104945104946104947104948104949104950104951104952104953104954104955104956104957104958104959104960104961104962104963104964104965104966104967104968104969104970104971104972104973104974104975104976104977104978104979104980104981104982104983104984104985104986104987104988104989104990104991104992104993104994104995104996104997104998104999105000105001105002105003105004105005105006105007105008105009105010105011105012105013105014105015105016105017105018105019105020105021105022105023105024105025105026105027105028105029105030105031105032105033105034105035105036105037105038105039105040105041105042105043105044105045105046105047105048105049105050105051105052105053105054105055105056105057105058105059105060105061105062105063105064105065105066105067105068105069105070105071105072105073105074105075105076105077105078105079105080105081105082105083105084105085105086105087105088105089105090105091105092105093105094105095105096105097105098105099105100105101105102105103105104105105105106105107105108105109105110105111105112105113105114105115105116105117105118105119105120105121105122105123105124105125105126105127105128105129105130105131105132105133105134105135105136105137105138105139105140105141105142105143105144105145105146105147105148105149105150105151105152105153105154105155105156105157105158105159105160105161105162105163105164105165105166105167105168105169105170105171105172105173105174105175105176105177105178105179105180105181105182105183105184105185105186105187105188105189105190105191105192105193105194105195105196105197105198105199105200105201105202105203105204105205105206105207105208105209105210105211105212105213105214105215105216105217105218105219105220105221105222105223105224105225105226105227105228105229105230105231105232105233105234105235105236105237105238105239105240105241105242105243105244105245105246105247105248105249105250105251105252105253105254105255105256105257105258105259105260105261105262105263105264105265105266105267105268105269105270105271105272105273105274105275105276105277105278105279105280105281105282105283105284105285105286105287105288105289105290105291105292105293105294105295105296105297105298105299105300105301105302105303105304105305105306105307105308105309105310105311105312105313105314105315105316105317105318105319105320105321105322105323105324105325105326105327105328105329105330105331105332105333105334105335105336105337105338105339105340105341105342105343105344105345105346105347105348105349105350105351105352105353105354105355105356105357105358105359105360105361105362105363105364105365105366105367105368105369105370105371105372105373105374105375105376105377105378105379105380105381105382105383105384105385105386105387105388105389105390105391105392105393105394105395105396105397105398105399105400105401105402105403105404105405105406105407105408105409105410105411105412105413105414105415105416105417105418105419105420105421105422105423105424105425105426105427105428105429105430105431105432105433105434105435105436105437105438105439105440105441105442105443105444105445105446105447105448105449105450105451105452105453105454105455105456105457105458105459105460105461105462105463105464105465105466105467105468105469105470105471105472105473105474105475105476105477105478105479105480105481105482105483105484105485105486105487105488105489105490105491105492105493105494105495105496105497105498105499105500105501105502105503105504105505105506105507105508105509105510105511105512105513105514105515105516105517105518105519105520105521105522105523105524105525105526105527105528105529105530105531105532105533105534105535105536105537105538105539105540105541105542105543105544105545105546105547105548105549105550105551105552105553105554105555105556105557105558105559105560105561105562105563105564105565105566105567105568105569105570105571105572105573105574105575105576105577105578105579105580105581105582105583105584105585105586105587105588105589105590105591105592105593105594105595105596105597105598105599105600105601105602105603105604105605105606105607105608105609105610105611105612105613105614105615105616105617105618105619105620105621105622105623105624105625105626105627105628105629105630105631105632105633105634105635105636105637105638105639105640105641105642105643105644105645105646105647105648105649105650105651105652105653105654105655105656105657105658105659105660105661105662105663105664105665105666105667105668105669105670105671105672105673105674105675105676105677105678105679105680105681105682105683105684105685105686105687105688105689105690105691105692105693105694105695105696105697105698105699105700105701105702105703105704105705105706105707105708105709105710105711105712105713105714105715105716105717105718105719105720105721105722105723105724105725105726105727105728105729105730105731105732105733105734105735105736105737105738105739105740105741105742105743105744105745105746105747105748105749105750105751105752105753105754105755105756105757105758105759105760105761105762105763105764105765105766105767105768105769105770105771105772105773105774105775105776105777105778105779105780105781105782105783105784105785105786105787105788105789105790105791105792105793105794105795105796105797105798105799105800105801105802105803105804105805105806105807105808105809105810105811105812105813105814105815105816105817105818105819105820105821105822105823105824105825105826105827105828105829105830105831105832105833105834105835105836105837105838105839105840105841105842105843105844105845105846105847105848105849105850105851105852105853105854105855105856105857105858105859105860105861105862105863105864105865105866105867105868105869105870105871105872105873105874105875105876105877105878105879105880105881105882105883105884105885105886105887105888105889105890105891105892105893105894105895105896105897105898105899105900105901105902105903105904105905105906105907105908105909105910105911105912105913105914105915105916105917105918105919105920105921105922105923105924105925105926105927105928105929105930105931105932105933105934105935105936105937105938105939105940105941105942105943105944105945105946105947105948105949105950105951105952105953105954105955105956105957105958105959105960105961105962105963105964105965105966105967105968105969105970105971105972105973105974105975105976105977105978105979105980105981105982105983105984105985105986105987105988105989105990105991105992105993105994105995105996105997105998105999106000106001106002106003106004106005106006106007106008106009106010106011106012106013106014106015106016106017106018106019106020106021106022106023106024106025106026106027106028106029106030106031106032106033106034106035106036106037106038106039106040106041106042106043106044106045106046106047106048106049106050106051106052106053106054106055106056106057106058106059106060106061106062106063106064106065106066106067106068106069106070106071106072106073106074106075106076106077106078106079106080106081106082106083106084106085106086106087106088106089106090106091106092106093106094106095106096106097106098106099106100106101106102106103106104106105106106106107106108106109106110106111106112106113106114106115106116106117106118106119106120106121106122106123106124106125106126106127106128106129106130106131106132106133106134106135106136106137106138106139106140106141106142106143106144106145106146106147106148106149106150106151106152106153106154106155106156106157106158106159106160106161106162106163106164106165106166106167106168106169106170106171106172106173106174106175106176106177106178106179106180106181106182106183106184106185106186106187106188106189106190106191106192106193106194106195106196106197106198106199106200106201106202106203106204106205106206106207106208106209106210106211106212106213106214106215106216106217106218106219106220106221106222106223106224106225106226106227106228106229106230106231106232106233106234106235106236106237106238106239106240106241106242106243106244106245106246106247106248106249106250106251106252106253106254106255106256106257106258106259106260106261106262106263106264106265106266106267106268106269106270106271106272106273106274106275106276106277106278106279106280106281106282106283106284106285106286106287106288106289106290106291106292106293106294106295106296106297106298106299106300106301106302106303106304106305106306106307106308106309106310106311106312106313106314106315106316106317106318106319106320106321106322106323106324106325106326106327106328106329106330106331106332106333106334106335106336106337106338106339106340106341106342106343106344106345106346106347106348106349106350106351106352106353106354106355106356106357106358106359106360106361106362106363106364106365106366106367106368106369106370106371106372106373106374106375106376106377106378106379106380106381106382106383106384106385106386106387106388106389106390106391106392106393106394106395106396106397106398106399106400106401106402106403106404106405106406106407106408106409106410106411106412106413106414106415106416106417106418106419106420106421106422106423106424106425106426106427106428106429106430106431106432106433106434106435106436106437106438106439106440106441106442106443106444106445106446106447106448106449106450106451106452106453106454106455106456106457106458106459106460106461106462106463106464106465106466106467106468106469106470106471106472106473106474106475106476106477106478106479106480106481106482106483106484106485106486106487106488106489106490106491106492106493106494106495106496106497106498106499106500106501106502106503106504106505106506106507106508106509106510106511106512106513106514106515106516106517106518106519106520106521106522106523106524106525106526106527106528106529106530106531106532106533106534106535106536106537106538106539106540106541106542106543106544106545106546106547106548106549106550106551106552106553106554106555106556106557106558106559106560106561106562106563106564106565106566106567106568106569106570106571106572106573106574106575106576106577106578106579106580106581106582106583106584106585106586106587106588106589106590106591106592106593106594106595106596106597106598106599106600106601106602106603106604106605106606106607106608106609106610106611106612106613106614106615106616106617106618106619106620106621106622106623106624106625106626106627106628106629106630106631106632106633106634106635106636106637106638106639106640106641106642106643106644106645106646106647106648106649106650106651106652106653106654106655106656106657106658106659106660106661106662106663106664106665106666106667106668106669106670106671106672106673106674106675106676106677106678106679106680106681106682106683106684106685106686106687106688106689106690106691106692106693106694106695106696106697106698106699106700106701106702106703106704106705106706106707106708106709106710106711106712106713106714106715106716106717106718106719106720106721106722106723106724106725106726106727106728106729106730106731106732106733106734106735106736106737106738106739106740106741106742106743106744106745106746106747106748106749106750106751106752106753106754106755106756106757106758106759106760106761106762106763106764106765106766106767106768106769106770106771106772106773106774106775106776106777106778106779106780106781106782106783106784106785106786106787106788106789106790106791106792106793106794106795106796106797106798106799106800106801106802106803106804106805106806106807106808106809106810106811106812106813106814106815106816106817106818106819106820106821106822106823106824106825106826106827106828106829106830106831106832106833106834106835106836106837106838106839106840106841106842106843106844106845106846106847106848106849106850106851106852106853106854106855106856106857106858106859106860106861106862106863106864106865106866106867106868106869106870106871106872106873106874106875106876106877106878106879106880106881106882106883106884106885106886106887106888106889106890106891106892106893106894106895106896106897106898106899106900106901106902106903106904106905106906106907106908106909106910106911106912106913106914106915106916106917106918106919106920106921106922106923106924106925106926106927106928106929106930106931106932106933106934106935106936106937106938106939106940106941106942106943106944106945106946106947106948106949106950106951106952106953106954106955106956106957106958106959106960106961106962106963106964106965106966106967106968106969106970106971106972106973106974106975106976106977106978106979106980106981106982106983106984106985106986106987106988106989106990106991106992106993106994106995106996106997106998106999107000107001107002107003107004107005107006107007107008107009107010107011107012107013107014107015107016107017107018107019107020107021107022107023107024107025107026107027107028107029107030107031107032107033107034107035107036107037107038107039107040107041107042107043107044107045107046107047107048107049107050107051107052107053107054107055107056107057107058107059107060107061107062107063107064107065107066107067107068107069107070107071107072107073107074107075107076107077107078107079107080107081107082107083107084107085107086107087107088107089107090107091107092107093107094107095107096107097107098107099107100107101107102107103107104107105107106107107107108107109107110107111107112107113107114107115107116107117107118107119107120107121107122107123107124107125107126107127107128107129107130107131107132107133107134107135107136107137107138107139107140107141107142107143107144107145107146107147107148107149107150107151107152107153107154107155107156107157107158107159107160107161107162107163107164107165107166107167107168107169107170107171107172107173107174107175107176107177107178107179107180107181107182107183107184107185107186107187107188107189107190107191107192107193107194107195107196107197107198107199107200107201107202107203107204107205107206107207107208107209107210107211107212107213107214107215107216107217107218107219107220107221107222107223107224107225107226107227107228107229107230107231107232107233107234107235107236107237107238107239107240107241107242107243107244107245107246107247107248107249107250107251107252107253107254107255107256107257107258107259107260107261107262107263107264107265107266107267107268107269107270107271107272107273107274107275107276107277107278107279107280107281107282107283107284107285107286107287107288107289107290107291107292107293107294107295107296107297107298107299107300107301107302107303107304107305107306107307107308107309107310107311107312107313107314107315107316107317107318107319107320107321107322107323107324107325107326107327107328107329107330107331107332107333107334107335107336107337107338107339107340107341107342107343107344107345107346107347107348107349107350107351107352107353107354107355107356107357107358107359107360107361107362107363107364107365107366107367107368107369107370107371107372107373107374107375107376107377107378107379107380107381107382107383107384107385107386107387107388107389107390107391107392107393107394107395107396107397107398107399107400107401107402107403107404107405107406107407107408107409107410107411107412107413107414107415107416107417107418107419107420107421107422107423107424107425107426107427107428107429107430107431107432107433107434107435107436107437107438107439107440107441107442107443107444107445107446107447107448107449107450107451107452107453107454107455107456107457107458107459107460107461107462107463107464107465107466107467107468107469107470107471107472107473107474107475107476107477107478107479107480107481107482107483107484107485107486107487107488107489107490107491107492107493107494107495107496107497107498107499107500107501107502107503107504107505107506107507107508107509107510107511107512107513107514107515107516107517107518107519107520107521107522107523107524107525107526107527107528107529107530107531107532107533107534107535107536107537107538107539107540107541107542107543107544107545107546107547107548107549107550107551107552107553107554107555107556107557107558107559107560107561107562107563107564107565107566107567107568107569107570107571107572107573107574107575107576107577107578107579107580107581107582107583107584107585107586107587107588107589107590107591107592107593107594107595107596107597107598107599107600107601107602107603107604107605107606107607107608107609107610107611107612107613107614107615107616107617107618107619107620107621107622107623107624107625107626107627107628107629107630107631107632107633107634107635107636107637107638107639107640107641107642107643107644107645107646107647107648107649107650107651107652107653107654107655107656107657107658107659107660107661107662107663107664107665107666107667107668107669107670107671107672107673107674107675107676107677107678107679107680107681107682107683107684107685107686107687107688107689107690107691107692107693107694107695107696107697107698107699107700107701107702107703107704107705107706107707107708107709107710107711107712107713107714107715107716107717107718107719107720107721107722107723107724107725107726107727107728107729107730107731107732107733107734107735107736107737107738107739107740107741107742107743107744107745107746107747107748107749107750107751107752107753107754107755107756107757107758107759107760107761107762107763107764107765107766107767107768107769107770107771107772107773107774107775107776107777107778107779107780107781107782107783107784107785107786107787107788107789107790107791107792107793107794107795107796107797107798107799107800107801107802107803107804107805107806107807107808107809107810107811107812107813107814107815107816107817107818107819107820107821107822107823107824107825107826107827107828107829107830107831107832107833107834107835107836107837107838107839107840107841107842107843107844107845107846107847107848107849107850107851107852107853107854107855107856107857107858107859107860107861107862107863107864107865107866107867107868107869107870107871107872107873107874107875107876107877107878107879107880107881107882107883107884107885107886107887107888107889107890107891107892107893107894107895107896107897107898107899107900107901107902107903107904107905107906107907107908107909107910107911107912107913107914107915107916107917107918107919107920107921107922107923107924107925107926107927107928107929107930107931107932107933107934107935107936107937107938107939107940107941107942107943107944107945107946107947107948107949107950107951107952107953107954107955107956107957107958107959107960107961107962107963107964107965107966107967107968107969107970107971107972107973107974107975107976107977107978107979107980107981107982107983107984107985107986107987107988107989107990107991107992107993107994107995107996107997107998107999108000108001108002108003108004108005108006108007108008108009108010108011108012108013108014108015108016108017108018108019108020108021108022108023108024108025108026108027108028108029108030108031108032108033108034108035108036108037108038108039108040108041108042108043108044108045108046108047108048108049108050108051108052108053108054108055108056108057108058108059108060108061108062108063108064108065108066108067108068108069108070108071108072108073108074108075108076108077108078108079108080108081108082108083108084108085108086108087108088108089108090108091108092108093108094108095108096108097108098108099108100108101108102108103108104108105108106108107108108108109108110108111108112108113108114108115108116108117108118108119108120108121108122108123108124108125108126108127108128108129108130108131108132108133108134108135108136108137108138108139108140108141108142108143108144108145108146108147108148108149108150108151108152108153108154108155108156108157108158108159108160108161108162108163108164108165108166108167108168108169108170108171108172108173108174108175108176108177108178108179108180108181108182108183108184108185108186108187108188108189108190108191108192108193108194108195108196108197108198108199108200108201108202108203108204108205108206108207108208108209108210108211108212108213108214108215108216108217108218108219108220108221108222108223108224108225108226108227108228108229108230108231108232108233108234108235108236108237108238108239108240108241108242108243108244108245108246108247108248108249108250108251108252108253108254108255108256108257108258108259108260108261108262108263108264108265108266108267108268108269108270108271108272108273108274108275108276108277108278108279108280108281108282108283108284108285108286108287108288108289108290108291108292108293108294108295108296108297108298108299108300108301108302108303108304108305108306108307108308108309108310108311108312108313108314108315108316108317108318108319108320108321108322108323108324108325108326108327108328108329108330108331108332108333108334108335108336108337108338108339108340108341108342108343108344108345108346108347108348108349108350108351108352108353108354108355108356108357108358108359108360108361108362108363108364108365108366108367108368108369108370108371108372108373108374108375108376108377108378108379108380108381108382108383108384108385108386108387108388108389108390108391108392108393108394108395108396108397108398108399108400108401108402108403108404108405108406108407108408108409108410108411108412108413108414108415108416108417108418108419108420108421108422108423108424108425108426108427108428108429108430108431108432108433108434108435108436108437108438108439108440108441108442108443108444108445108446108447108448108449108450108451108452108453108454108455108456108457108458108459108460108461108462108463108464108465108466108467108468108469108470108471108472108473108474108475108476108477108478108479108480108481108482108483108484108485108486108487108488108489108490108491108492108493108494108495108496108497108498108499108500108501108502108503108504108505108506108507108508108509108510108511108512108513108514108515108516108517108518108519108520108521108522108523108524108525108526108527108528108529108530108531108532108533108534108535108536108537108538108539108540108541108542108543108544108545108546108547108548108549108550108551108552108553108554108555108556108557108558108559108560108561108562108563108564108565108566108567108568108569108570108571108572108573108574108575108576108577108578108579108580108581108582108583108584108585108586108587108588108589108590108591108592108593108594108595108596108597108598108599108600108601108602108603108604108605108606108607108608108609108610108611108612108613108614108615108616108617108618108619108620108621108622108623108624108625108626108627108628108629108630108631108632108633108634108635108636108637108638108639108640108641108642108643108644108645108646108647108648108649108650108651108652108653108654108655108656108657108658108659108660108661108662108663108664108665108666108667108668108669108670108671108672108673108674108675108676108677108678108679108680108681108682108683108684108685108686108687108688108689108690108691108692108693108694108695108696108697108698108699108700108701108702108703108704108705108706108707108708108709108710108711108712108713108714108715108716108717108718108719108720108721108722108723108724108725108726108727108728108729108730108731108732108733108734108735108736108737108738108739108740108741108742108743108744108745108746108747108748108749108750108751108752108753108754108755108756108757108758108759108760108761108762108763108764108765108766108767108768108769108770108771108772108773108774108775108776108777108778108779108780108781108782108783108784108785108786108787108788108789108790108791108792108793108794108795108796108797108798108799108800108801108802108803108804108805108806108807108808108809108810108811108812108813108814108815108816108817108818108819108820108821108822108823108824108825108826108827108828108829108830108831108832108833108834108835108836108837108838108839108840108841108842108843108844108845108846108847108848108849108850108851108852108853108854108855108856108857108858108859108860108861108862108863108864108865108866108867108868108869108870108871108872108873108874108875108876108877108878108879108880108881108882108883108884108885108886108887108888108889108890108891108892108893108894108895108896108897108898108899108900108901108902108903108904108905108906108907108908108909108910108911108912108913108914108915108916108917108918108919108920108921108922108923108924108925108926108927108928108929108930108931108932108933108934108935108936108937108938108939108940108941108942108943108944108945108946108947108948108949108950108951108952108953108954108955108956108957108958108959108960108961108962108963108964108965108966108967108968108969108970108971108972108973108974108975108976108977108978108979108980108981108982108983108984108985108986108987108988108989108990108991108992108993108994108995108996108997108998108999109000109001109002109003109004109005109006109007109008109009109010109011109012109013109014109015109016109017109018109019109020109021109022109023109024109025109026109027109028109029109030109031109032109033109034109035109036109037109038109039109040109041109042109043109044109045109046109047109048109049109050109051109052109053109054109055109056109057109058109059109060109061109062109063109064109065109066109067109068109069109070109071109072109073109074109075109076109077109078109079109080109081109082109083109084109085109086109087109088109089109090109091109092109093109094109095109096109097109098109099109100109101109102109103109104109105109106109107109108109109109110109111109112109113109114109115109116109117109118109119109120109121109122109123109124109125109126109127109128109129109130109131109132109133109134109135109136109137109138109139109140109141109142109143109144109145109146109147109148109149109150109151109152109153109154109155109156109157109158109159109160109161109162109163109164109165109166109167109168109169109170109171109172109173109174109175109176109177109178109179109180109181109182109183109184109185109186109187109188109189109190109191109192109193109194109195109196109197109198109199109200109201109202109203109204109205109206109207109208109209109210109211109212109213109214109215109216109217109218109219109220109221109222109223109224109225109226109227109228109229109230109231109232109233109234109235109236109237109238109239109240109241109242109243109244109245109246109247109248109249109250109251109252109253109254109255109256109257109258109259109260109261109262109263109264109265109266109267109268109269109270109271109272109273109274109275109276109277109278109279109280109281109282109283109284109285109286109287109288109289109290109291109292109293109294109295109296109297109298109299109300109301109302109303109304109305109306109307109308109309109310109311109312109313109314109315109316109317109318109319109320109321109322109323109324109325109326109327109328109329109330109331109332109333109334109335109336109337109338109339109340109341109342109343109344109345109346109347109348109349109350109351109352109353109354109355109356109357109358109359109360109361109362109363109364109365109366109367109368109369109370109371109372109373109374109375109376109377109378109379109380109381109382109383109384109385109386109387109388109389109390109391109392109393109394109395109396109397109398109399109400109401109402109403109404109405109406109407109408109409109410109411109412109413109414109415109416109417109418109419109420109421109422109423109424109425109426109427109428109429109430109431109432109433109434109435109436109437109438109439109440109441109442109443109444109445109446109447109448109449109450109451109452109453109454109455109456109457109458109459109460109461109462109463109464109465109466109467109468109469109470109471109472109473109474109475109476109477109478109479109480109481109482109483109484109485109486109487109488109489109490109491109492109493109494109495109496109497109498109499109500109501109502109503109504109505109506109507109508109509109510109511109512109513109514109515109516109517109518109519109520109521109522109523109524109525109526109527109528109529109530109531109532109533109534109535109536109537109538109539109540109541109542109543109544109545109546109547109548109549109550109551109552109553109554109555109556109557109558109559109560109561109562109563109564109565109566109567109568109569109570109571109572109573109574109575109576109577109578109579109580109581109582109583109584109585109586109587109588109589109590109591109592109593109594109595109596109597109598109599109600109601109602109603109604109605109606109607109608109609109610109611109612109613109614109615109616109617109618109619109620109621109622109623109624109625109626109627109628109629109630109631109632109633109634109635109636109637109638109639109640109641109642109643109644109645109646109647109648109649109650109651109652109653109654109655109656109657109658109659109660109661109662109663109664109665109666109667109668109669109670109671109672109673109674109675109676109677109678109679109680109681109682109683109684109685109686109687109688109689109690109691109692109693109694109695109696109697109698109699109700109701109702109703109704109705109706109707109708109709109710109711109712109713109714109715109716109717109718109719109720109721109722109723109724109725109726109727109728109729109730109731109732109733109734109735109736109737109738109739109740109741109742109743109744109745109746109747109748109749109750109751109752109753109754109755109756109757109758109759109760109761109762109763109764109765109766109767109768109769109770109771109772109773109774109775109776109777109778109779109780109781109782109783109784109785109786109787109788109789109790109791109792109793109794109795109796109797109798109799109800109801109802109803109804109805109806109807109808109809109810109811109812109813109814109815109816109817109818109819109820109821109822109823109824109825109826109827109828109829109830109831109832109833109834109835109836109837109838109839109840109841109842109843109844109845109846109847109848109849109850109851109852109853109854109855109856109857109858109859109860109861109862109863109864109865109866109867109868109869109870109871109872109873109874109875109876109877109878109879109880109881109882109883109884109885109886109887109888109889109890109891109892109893109894109895109896109897109898109899109900109901109902109903109904109905109906109907109908109909109910109911109912109913109914109915109916109917109918109919109920109921109922109923109924109925109926109927109928109929109930109931109932109933109934109935109936109937109938109939109940109941109942109943109944109945109946109947109948109949109950109951109952109953109954109955109956109957109958109959109960109961109962109963109964109965109966109967109968109969109970109971109972109973109974109975109976109977109978109979109980109981109982109983109984109985109986109987109988109989109990109991109992109993109994109995109996109997109998109999110000110001110002110003110004110005110006110007110008110009110010110011110012110013110014110015110016110017110018110019110020110021110022110023110024110025110026110027110028110029110030110031110032110033110034110035110036110037110038110039110040110041110042110043110044110045110046110047110048110049110050110051110052110053110054110055110056110057110058110059110060110061110062110063110064110065110066110067110068110069110070110071110072110073110074110075110076110077110078110079110080110081110082110083110084110085110086110087110088110089110090110091110092110093110094110095110096110097110098110099110100110101110102110103110104110105110106110107110108110109110110110111110112110113110114110115110116110117110118110119110120110121110122110123110124110125110126110127110128110129110130110131110132110133110134110135110136110137110138110139110140110141110142110143110144110145110146110147110148110149110150110151110152110153110154110155110156110157110158110159110160110161110162110163110164110165110166110167110168110169110170110171110172110173110174110175110176110177110178110179110180110181110182110183110184110185110186110187110188110189110190110191110192110193110194110195110196110197110198110199110200110201110202110203110204110205110206110207110208110209110210110211110212110213110214110215110216110217110218110219110220110221110222110223110224110225110226110227110228110229110230110231110232110233110234110235110236110237110238110239110240110241110242110243110244110245110246110247110248110249110250110251110252110253110254110255110256110257110258110259110260110261110262110263110264110265110266110267110268110269110270110271110272110273110274110275110276110277110278110279110280110281110282110283110284110285110286110287110288110289110290110291110292110293110294110295110296110297110298110299110300110301110302110303110304110305110306110307110308110309110310110311110312110313110314110315110316110317110318110319110320110321110322110323110324110325110326110327110328110329110330110331110332110333110334110335110336110337110338110339110340110341110342110343110344110345110346110347110348110349110350110351110352110353110354110355110356110357110358110359110360110361110362110363110364110365110366110367110368110369110370110371110372110373110374110375110376110377110378110379110380110381110382110383110384110385110386110387110388110389110390110391110392110393110394110395110396110397110398110399110400110401110402110403110404110405110406110407110408110409110410110411110412110413110414110415110416110417110418110419110420110421110422110423110424110425110426110427110428110429110430110431110432110433110434110435110436110437110438110439110440110441110442110443110444110445110446110447110448110449110450110451110452110453110454110455110456110457110458110459110460110461110462110463110464110465110466110467110468110469110470110471110472110473110474110475110476110477110478110479110480110481110482110483110484110485110486110487110488110489110490110491110492110493110494110495110496110497110498110499110500110501110502110503110504110505110506110507110508110509110510110511110512110513110514110515110516110517110518110519110520110521110522110523110524110525110526110527110528110529110530110531110532110533110534110535110536110537110538110539110540110541110542110543110544110545110546110547110548110549110550110551110552110553110554110555110556110557110558110559110560110561110562110563110564110565110566110567110568110569110570110571110572110573110574110575110576110577110578110579110580110581110582110583110584110585110586110587110588110589110590110591110592110593110594110595110596110597110598110599110600110601110602110603110604110605110606110607110608110609110610110611110612110613110614110615110616110617110618110619110620110621110622110623110624110625110626110627110628110629110630110631110632110633110634110635110636110637110638110639110640110641110642110643110644110645110646110647110648110649110650110651110652110653110654110655110656110657110658110659110660110661110662110663110664110665110666110667110668110669110670110671110672110673110674110675110676110677110678110679110680110681110682110683110684110685110686110687110688110689110690110691110692110693110694110695110696110697110698110699110700110701110702110703110704110705110706110707110708110709110710110711110712110713110714110715110716110717110718110719110720110721110722110723110724110725110726110727110728110729110730110731110732110733110734110735110736110737110738110739110740110741110742110743110744110745110746110747110748110749110750110751110752110753110754110755110756110757110758110759110760110761110762110763110764110765110766110767110768110769110770110771110772110773110774110775110776110777110778110779110780110781110782110783110784110785110786110787110788110789110790110791110792110793110794110795110796110797110798110799110800110801110802110803110804110805110806110807110808110809110810110811110812110813110814110815110816110817110818110819110820110821110822110823110824110825110826110827110828110829110830110831110832110833110834110835110836110837110838110839110840110841110842110843110844110845110846110847110848110849110850110851110852110853110854110855110856110857110858110859110860110861110862110863110864110865110866110867110868110869110870110871110872110873110874110875110876110877110878110879110880110881110882110883110884110885110886110887110888110889110890110891110892110893110894110895110896110897110898110899110900110901110902110903110904110905110906110907110908110909110910110911110912110913110914110915110916110917110918110919110920110921110922110923110924110925110926110927110928110929110930110931110932110933110934110935110936110937110938110939110940110941110942110943110944110945110946110947110948110949110950110951110952110953110954110955110956110957110958110959110960110961110962110963110964110965110966110967110968110969110970110971110972110973110974110975110976110977110978110979110980110981110982110983110984110985110986110987110988110989110990110991110992110993110994110995110996110997110998110999111000111001111002111003111004111005111006111007111008111009111010111011111012111013111014111015111016111017111018111019111020111021111022111023111024111025111026111027111028111029111030111031111032111033111034111035111036111037111038111039111040111041111042111043111044111045111046111047111048111049111050111051111052111053111054111055111056111057111058111059111060111061111062111063111064111065111066111067111068111069111070111071111072111073111074111075111076111077111078111079111080111081111082111083111084111085111086111087111088111089111090111091111092111093111094111095111096111097111098111099111100111101111102111103111104111105111106111107111108111109111110111111111112111113111114111115111116111117111118111119111120111121111122111123111124111125111126111127111128111129111130111131111132111133111134111135111136111137111138111139111140111141111142111143111144111145111146111147111148111149111150111151111152111153111154111155111156111157111158111159111160111161111162111163111164111165111166111167111168111169111170111171111172111173111174111175111176111177111178111179111180111181111182111183111184111185111186111187111188111189111190111191111192111193111194111195111196111197111198111199111200111201111202111203111204111205111206111207111208111209111210111211111212111213111214111215111216111217111218111219111220111221111222111223111224111225111226111227111228111229111230111231111232111233111234111235111236111237111238111239111240111241111242111243111244111245111246111247111248111249111250111251111252111253111254111255111256111257111258111259111260111261111262111263111264111265111266111267111268111269111270111271111272111273111274111275111276111277111278111279111280111281111282111283111284111285111286111287111288111289111290111291111292111293111294111295111296111297111298111299111300111301111302111303111304111305111306111307111308111309111310111311111312111313111314111315111316111317111318111319111320111321111322111323111324111325111326111327111328111329111330111331111332111333111334111335111336111337111338111339111340111341111342111343111344111345111346111347111348111349111350111351111352111353111354111355111356111357111358111359111360111361111362111363111364111365111366111367111368111369111370111371111372111373111374111375111376111377111378111379111380111381111382111383111384111385111386111387111388111389111390111391111392111393111394111395111396111397111398111399111400111401111402111403111404111405111406111407111408111409111410111411111412111413111414111415111416111417111418111419111420111421111422111423111424111425111426111427111428111429111430111431111432111433111434111435111436111437111438111439111440111441111442111443111444111445111446111447111448111449111450111451111452111453111454111455111456111457111458111459111460111461111462111463111464111465111466111467111468111469111470111471111472111473111474111475111476111477111478111479111480111481111482111483111484111485111486111487111488111489111490111491111492111493111494111495111496111497111498111499111500111501111502111503111504111505111506111507111508111509111510111511111512111513111514111515111516111517111518111519111520111521111522111523111524111525111526111527111528111529111530111531111532111533111534111535111536111537111538111539111540111541111542111543111544111545111546111547111548111549111550111551111552111553111554111555111556111557111558111559111560111561111562111563111564111565111566111567111568111569111570111571111572111573111574111575111576111577111578111579111580111581111582111583111584111585111586111587111588111589111590111591111592111593111594111595111596111597111598111599111600111601111602111603111604111605111606111607111608111609111610111611111612111613111614111615111616111617111618111619111620111621111622111623111624111625111626111627111628111629111630111631111632111633111634111635111636111637111638111639111640111641111642111643111644111645111646111647111648111649111650111651111652111653111654111655111656111657111658111659111660111661111662111663111664111665111666111667111668111669111670111671111672111673111674111675111676111677111678111679111680111681111682111683111684111685111686111687111688111689111690111691111692111693111694111695111696111697111698111699111700111701111702111703111704111705111706111707111708111709111710111711111712111713111714111715111716111717111718111719111720111721111722111723111724111725111726111727111728111729111730111731111732111733111734111735111736111737111738111739111740111741111742111743111744111745111746111747111748111749111750111751111752111753111754111755111756111757111758111759111760111761111762111763111764111765111766111767111768111769111770111771111772111773111774111775111776111777111778111779111780111781111782111783111784111785111786111787111788111789111790111791111792111793111794111795111796111797111798111799111800111801111802111803111804111805111806111807111808111809111810111811111812111813111814111815111816111817111818111819111820111821111822111823111824111825111826111827111828111829111830111831111832111833111834111835111836111837111838111839111840111841111842111843111844111845111846111847111848111849111850111851111852111853111854111855111856111857111858111859111860111861111862111863111864111865111866111867111868111869111870111871111872111873111874111875111876111877111878111879111880111881111882111883111884111885111886111887111888111889111890111891111892111893111894111895111896111897111898111899111900111901111902111903111904111905111906111907111908111909111910111911111912111913111914111915111916111917111918111919111920111921111922111923111924111925111926111927111928111929111930111931111932111933111934111935111936111937111938111939111940111941111942111943111944111945111946111947111948111949111950111951111952111953111954111955111956111957111958111959111960111961111962111963111964111965111966111967111968111969111970111971111972111973111974111975111976111977111978111979111980111981111982111983111984111985111986111987111988111989111990111991111992111993111994111995111996111997111998111999112000112001112002112003112004112005112006112007112008112009112010112011112012112013112014112015112016112017112018112019112020112021112022112023112024112025112026112027112028112029112030112031112032112033112034112035112036112037112038112039112040112041112042112043112044112045112046112047112048112049112050112051112052112053112054112055112056112057112058112059112060112061112062112063112064112065112066112067112068112069112070112071112072112073112074112075112076112077112078112079112080112081112082112083112084112085112086112087112088112089112090112091112092112093112094112095112096112097112098112099112100112101112102112103112104112105112106112107112108112109112110112111112112112113112114112115112116112117112118112119112120112121112122112123112124112125112126112127112128112129112130112131112132112133112134112135112136112137112138112139112140112141112142112143112144112145112146112147112148112149112150112151112152112153112154112155112156112157112158112159112160112161112162112163112164112165112166112167112168112169112170112171112172112173112174112175112176112177112178112179112180112181112182112183112184112185112186112187112188112189112190112191112192112193112194112195112196112197112198112199112200112201112202112203112204112205112206112207112208112209112210112211112212112213112214112215112216112217112218112219112220112221112222112223112224112225112226112227112228112229112230112231112232112233112234112235112236112237112238112239112240112241112242112243112244112245112246112247112248112249112250112251112252112253112254112255112256112257112258112259112260112261112262112263112264112265112266112267112268112269112270112271112272112273112274112275112276112277112278112279112280112281112282112283112284112285112286112287112288112289112290112291112292112293112294112295112296112297112298112299112300112301112302112303112304112305112306112307112308112309112310112311112312112313112314112315112316112317112318112319112320112321112322112323112324112325112326112327112328112329112330112331112332112333112334112335112336112337112338112339112340112341112342112343112344112345112346112347112348112349112350112351112352112353112354112355112356112357112358112359112360112361112362112363112364112365112366112367112368112369112370112371112372112373112374112375112376112377112378112379112380112381112382112383112384112385112386112387112388112389112390112391112392112393112394112395112396112397112398112399112400112401112402112403112404112405112406112407112408112409112410112411112412112413112414112415112416112417112418112419112420112421112422112423112424112425112426112427112428112429112430112431112432112433112434112435112436112437112438112439112440112441112442112443112444112445112446112447112448112449112450112451112452112453112454112455112456112457112458112459112460112461112462112463112464112465112466112467112468112469112470112471112472112473112474112475112476112477112478112479112480112481112482112483112484112485112486112487112488112489112490112491112492112493112494112495112496112497112498112499112500112501112502112503112504112505112506112507112508112509112510112511112512112513112514112515112516112517112518112519112520112521112522112523112524112525112526112527112528112529112530112531112532112533112534112535112536112537112538112539112540112541112542112543112544112545112546112547112548112549112550112551112552112553112554112555112556112557112558112559112560112561112562112563112564112565112566112567112568112569112570112571112572112573112574112575112576112577112578112579112580112581112582112583112584112585112586112587112588112589112590112591112592112593112594112595112596112597112598112599112600112601112602112603112604112605112606112607112608112609112610112611112612112613112614112615112616112617112618112619112620112621112622112623112624112625112626112627112628112629112630112631112632112633112634112635112636112637112638112639112640112641112642112643112644112645112646112647112648112649112650112651112652112653112654112655112656112657112658112659112660112661112662112663112664112665112666112667112668112669112670112671112672112673112674112675112676112677112678112679112680112681112682112683112684112685112686112687112688112689112690112691112692112693112694112695112696112697112698112699112700112701112702112703112704112705112706112707112708112709112710112711112712112713112714112715112716112717112718112719112720112721112722112723112724112725112726112727112728112729112730112731112732112733112734112735112736112737112738112739112740112741112742112743112744112745112746112747112748112749112750112751112752112753112754112755112756112757112758112759112760112761112762112763112764112765112766112767112768112769112770112771112772112773112774112775112776112777112778112779112780112781112782112783112784112785112786112787112788112789112790112791112792112793112794112795112796112797112798112799112800112801112802112803112804112805112806112807112808112809112810112811112812112813112814112815112816112817112818112819112820112821112822112823112824112825112826112827112828112829112830112831112832112833112834112835112836112837112838112839112840112841112842112843112844112845112846112847112848112849112850112851112852112853112854112855112856112857112858112859112860112861112862112863112864112865112866112867112868112869112870112871112872112873112874112875112876112877112878112879112880112881112882112883112884112885112886112887112888112889112890112891112892112893112894112895112896112897112898112899112900112901112902112903112904112905112906112907112908112909112910112911112912112913112914112915112916112917112918112919112920112921112922112923112924112925112926112927112928112929112930112931112932112933112934112935112936112937112938112939112940112941112942112943112944112945112946112947112948112949112950112951112952112953112954112955112956112957112958112959112960112961112962112963112964112965112966112967112968112969112970112971112972112973112974112975112976112977112978112979112980112981112982112983112984112985112986112987112988112989112990112991112992112993112994112995112996112997112998112999113000113001113002113003113004113005113006113007113008113009113010113011113012113013113014113015113016113017113018113019113020113021113022113023113024113025113026113027113028113029113030113031113032113033113034113035113036113037113038113039113040113041113042113043113044113045113046113047113048113049113050113051113052113053113054113055113056113057113058113059113060113061113062113063113064113065113066113067113068113069113070113071113072113073113074113075113076113077113078113079113080113081113082113083113084113085113086113087113088113089113090113091113092113093113094113095113096113097113098113099113100113101113102113103113104113105113106113107113108113109113110113111113112113113113114113115113116113117113118113119113120113121113122113123113124113125113126113127113128113129113130113131113132113133113134113135113136113137113138113139113140113141113142113143113144113145113146113147113148113149113150113151113152113153113154113155113156113157113158113159113160113161113162113163113164113165113166113167113168113169113170113171113172113173113174113175113176113177113178113179113180113181113182113183113184113185113186113187113188113189113190113191113192113193113194113195113196113197113198113199113200113201113202113203113204113205113206113207113208113209113210113211113212113213113214113215113216113217113218113219113220113221113222113223113224113225113226113227113228113229113230113231113232113233113234113235113236113237113238113239113240113241113242113243113244113245113246113247113248113249113250113251113252113253113254113255113256113257113258113259113260113261113262113263113264113265113266113267113268113269113270113271113272113273113274113275113276113277113278113279113280113281113282113283113284113285113286113287113288113289113290113291113292113293113294113295113296113297113298113299113300113301113302113303113304113305113306113307113308113309113310113311113312113313113314113315113316113317113318113319113320113321113322113323113324113325113326113327113328113329113330113331113332113333113334113335113336113337113338113339113340113341113342113343113344113345113346113347113348113349113350113351113352113353113354113355113356113357113358113359113360113361113362113363113364113365113366113367113368113369113370113371113372113373113374113375113376113377113378113379113380113381113382113383113384113385113386113387113388113389113390113391113392113393113394113395113396113397113398113399113400113401113402113403113404113405113406113407113408113409113410113411113412113413113414113415113416113417113418113419113420113421113422113423113424113425113426113427113428113429113430113431113432113433113434113435113436113437113438113439113440113441113442113443113444113445113446113447113448113449113450113451113452113453113454113455113456113457113458113459113460113461113462113463113464113465113466113467113468113469113470113471113472113473113474113475113476113477113478113479113480113481113482113483113484113485113486113487113488113489113490113491113492113493113494113495113496113497113498113499113500113501113502113503113504113505113506113507113508113509113510113511113512113513113514113515113516113517113518113519113520113521113522113523113524113525113526113527113528113529113530113531113532113533113534113535113536113537113538113539113540113541113542113543113544113545113546113547113548113549113550113551113552113553113554113555113556113557113558113559113560113561113562113563113564113565113566113567113568113569113570113571113572113573113574113575113576113577113578113579113580113581113582113583113584113585113586113587113588113589113590113591113592113593113594113595113596113597113598113599113600113601113602113603113604113605113606113607113608113609113610113611113612113613113614113615113616113617113618113619113620113621113622113623113624113625113626113627113628113629113630113631113632113633113634113635113636113637113638113639113640113641113642113643113644113645113646113647113648113649113650113651113652113653113654113655113656113657113658113659113660113661113662113663113664113665113666113667113668113669113670113671113672113673113674113675113676113677113678113679113680113681113682113683113684113685113686113687113688113689113690113691113692113693113694113695113696113697113698113699113700113701113702113703113704113705113706113707113708113709113710113711113712113713113714113715113716113717113718113719113720113721113722113723113724113725113726113727113728113729113730113731113732113733113734113735113736113737113738113739113740113741113742113743113744113745113746113747113748113749113750113751113752113753113754113755113756113757113758113759113760113761113762113763113764113765113766113767113768113769113770113771113772113773113774113775113776113777113778113779113780113781113782113783113784113785113786113787113788113789113790113791113792113793113794113795113796113797113798113799113800113801113802113803113804113805113806113807113808113809113810113811113812113813113814113815113816113817113818113819113820113821113822113823113824113825113826113827113828113829113830113831113832113833113834113835113836113837113838113839113840113841113842113843113844113845113846113847113848113849113850113851113852113853113854113855113856113857113858113859113860113861113862113863113864113865113866113867113868113869113870113871113872113873113874113875113876113877113878113879113880113881113882113883113884113885113886113887113888113889113890113891113892113893113894113895113896113897113898113899113900113901113902113903113904113905113906113907113908113909113910113911113912113913113914113915113916113917113918113919113920113921113922113923113924113925113926113927113928113929113930113931113932113933113934113935113936113937113938113939113940113941113942113943113944113945113946113947113948113949113950113951113952113953113954113955113956113957113958113959113960113961113962113963113964113965113966113967113968113969113970113971113972113973113974113975113976113977113978113979113980113981113982113983113984113985113986113987113988113989113990113991113992113993113994113995113996113997113998113999114000114001114002114003114004114005114006114007114008114009114010114011114012114013114014114015114016114017114018114019114020114021114022114023114024114025114026114027114028114029114030114031114032114033114034114035114036114037114038114039114040114041114042114043114044114045114046114047114048114049114050114051114052114053114054114055114056114057114058114059114060114061114062114063114064114065114066114067114068114069114070114071114072114073114074114075114076114077114078114079114080114081114082114083114084114085114086114087114088114089114090114091114092114093114094114095114096114097114098114099114100114101114102114103114104114105114106114107114108114109114110114111114112114113114114114115114116114117114118114119114120114121114122114123114124114125114126114127114128114129114130114131114132114133114134114135114136114137114138114139114140114141114142114143114144114145114146114147114148114149114150114151114152114153114154114155114156114157114158114159114160114161114162114163114164114165114166114167114168114169114170114171114172114173114174114175114176114177114178114179114180114181114182114183114184114185114186114187114188114189114190114191114192114193114194114195114196114197114198114199114200114201114202114203114204114205114206114207114208114209114210114211114212114213114214114215114216114217114218114219114220114221114222114223114224114225114226114227114228114229114230114231114232114233114234114235114236114237114238114239114240114241114242114243114244114245114246114247114248114249114250114251114252114253114254114255114256114257114258114259114260114261114262114263114264114265114266114267114268114269114270114271114272114273114274114275114276114277114278114279114280114281114282114283114284114285114286114287114288114289114290114291114292114293114294114295114296114297114298114299114300114301114302114303114304114305114306114307114308114309114310114311114312114313114314114315114316114317114318114319114320114321114322114323114324114325114326114327114328114329114330114331114332114333114334114335114336114337114338114339114340114341114342114343114344114345114346114347114348114349114350114351114352114353114354114355114356114357114358114359114360114361114362114363114364114365114366114367114368114369114370114371114372114373114374114375114376114377114378114379114380114381114382114383114384114385114386114387114388114389114390114391114392114393114394114395114396114397114398114399114400114401114402114403114404114405114406114407114408114409114410114411114412114413114414114415114416114417114418114419114420114421114422114423114424114425114426114427114428114429114430114431114432114433114434114435114436114437114438114439114440114441114442114443114444114445114446114447114448114449114450114451114452114453114454114455114456114457114458114459114460114461114462114463114464114465114466114467114468114469114470114471114472114473114474114475114476114477114478114479114480114481114482114483114484114485114486114487114488114489114490114491114492114493114494114495114496114497114498114499114500114501114502114503114504114505114506114507114508114509114510114511114512114513114514114515114516114517114518114519114520114521114522114523114524114525114526114527114528114529114530114531114532114533114534114535114536114537114538114539114540114541114542114543114544114545114546114547114548114549114550114551114552114553114554114555114556114557114558114559114560114561114562114563114564114565114566114567114568114569114570114571114572114573114574114575114576114577114578114579114580114581114582114583114584114585114586114587114588114589114590114591114592114593114594114595114596114597114598114599114600114601114602114603114604114605114606114607114608114609114610114611114612114613114614114615114616114617114618114619114620114621114622114623114624114625114626114627114628114629114630114631114632114633114634114635114636114637114638114639114640114641114642114643114644114645114646114647114648114649114650114651114652114653114654114655114656114657114658114659114660114661114662114663114664114665114666114667114668114669114670114671114672114673114674114675114676114677114678114679114680114681114682114683114684114685114686114687114688114689114690114691114692114693114694114695114696114697114698114699114700114701114702114703114704114705114706114707114708114709114710114711114712114713114714114715114716114717114718114719114720114721114722114723114724114725114726114727114728114729114730114731114732114733114734114735114736114737114738114739114740114741114742114743114744114745114746114747114748114749114750114751114752114753114754114755114756114757114758114759114760114761114762114763114764114765114766114767114768114769114770114771114772114773114774114775114776114777114778114779114780114781114782114783114784114785114786114787114788114789114790114791114792114793114794114795114796114797114798114799114800114801114802114803114804114805114806114807114808114809114810114811114812114813114814114815114816114817114818114819114820114821114822114823114824114825114826114827114828114829114830114831114832114833114834114835114836114837114838114839114840114841114842114843114844114845114846114847114848114849114850114851114852114853114854114855114856114857114858114859114860114861114862114863114864114865114866114867114868114869114870114871114872114873114874114875114876114877114878114879114880114881114882114883114884114885114886114887114888114889114890114891114892114893114894114895114896114897114898114899114900114901114902114903114904114905114906114907114908114909114910114911114912114913114914114915114916114917114918114919114920114921114922114923114924114925114926114927114928114929114930114931114932114933114934114935114936114937114938114939114940114941114942114943114944114945114946114947114948114949114950114951114952114953114954114955114956114957114958114959114960114961114962114963114964114965114966114967114968114969114970114971114972114973114974114975114976114977114978114979114980114981114982114983114984114985114986114987114988114989114990114991114992114993114994114995114996114997114998114999115000115001115002115003115004115005115006115007115008115009115010115011115012115013115014115015115016115017115018115019115020115021115022115023115024115025115026115027115028115029115030115031115032115033115034115035115036115037115038115039115040115041115042115043115044115045115046115047115048115049115050115051115052115053115054115055115056115057115058115059115060115061115062115063115064115065115066115067115068115069115070115071115072115073115074115075115076115077115078115079115080115081115082115083115084115085115086115087115088115089115090115091115092115093115094115095115096115097115098115099115100115101115102115103115104115105115106115107115108115109115110115111115112115113115114115115115116115117115118115119115120115121115122115123115124115125115126115127115128115129115130115131115132115133115134115135115136115137115138115139115140115141115142115143115144115145115146115147115148115149115150115151115152115153115154115155115156115157115158115159115160115161115162115163115164115165115166115167115168115169115170115171115172115173115174115175115176115177115178115179115180115181115182115183115184115185115186115187115188115189115190115191115192115193115194115195115196115197115198115199115200115201115202115203115204115205115206115207115208115209115210115211115212115213115214115215115216115217115218115219115220115221115222115223115224115225115226115227115228115229115230115231115232115233115234115235115236115237115238115239115240115241115242115243115244115245115246115247115248115249115250115251115252115253115254115255115256115257115258115259115260115261115262115263115264115265115266115267115268115269115270115271115272115273115274115275115276115277115278115279115280115281115282115283115284115285115286115287115288115289115290115291115292115293115294115295115296115297115298115299115300115301115302115303115304115305115306115307115308115309115310115311115312115313115314115315115316115317115318115319115320115321115322115323115324115325115326115327115328115329115330115331115332115333115334115335115336115337115338115339115340115341115342115343115344115345115346115347115348115349115350115351115352115353115354115355115356115357115358115359115360115361115362115363115364115365115366115367115368115369115370115371115372115373115374115375115376115377115378115379115380115381115382115383115384115385115386115387115388115389115390115391115392115393115394115395115396115397115398115399115400115401115402115403115404115405115406115407115408115409115410115411115412115413115414115415115416115417115418115419115420115421115422115423115424115425115426115427115428115429115430115431115432115433115434115435115436115437115438115439115440115441115442115443115444115445115446115447115448115449115450115451115452115453115454115455115456115457115458115459115460115461115462115463115464115465115466115467115468115469115470115471115472115473115474115475115476115477115478115479115480115481115482115483115484115485115486115487115488115489115490115491115492115493115494115495115496115497115498115499115500115501115502115503115504115505115506115507115508115509115510115511115512115513115514115515115516115517115518115519115520115521115522115523115524115525115526115527115528115529115530115531115532115533115534115535115536115537115538115539115540115541115542115543115544115545115546115547115548115549115550115551115552115553115554115555115556115557115558115559115560115561115562115563115564115565115566115567115568115569115570115571115572115573115574115575115576115577115578115579115580115581115582115583115584115585115586115587115588115589115590115591115592115593115594115595115596115597115598115599115600115601115602115603115604115605115606115607115608115609115610115611115612115613115614115615115616115617115618115619115620115621115622115623115624115625115626115627115628115629115630115631115632115633115634115635115636115637115638115639115640115641115642115643115644115645115646115647115648115649115650115651115652115653115654115655115656115657115658115659115660115661115662115663115664115665115666115667115668115669115670115671115672115673115674115675115676115677115678115679115680115681115682115683115684115685115686115687115688115689115690115691115692115693115694115695115696115697115698115699115700115701115702115703115704115705115706115707115708115709115710115711115712115713115714115715115716115717115718115719115720115721115722115723115724115725115726115727115728115729115730115731115732115733115734115735115736115737115738115739115740115741115742115743115744115745115746115747115748115749115750115751115752115753115754115755115756115757115758115759115760115761115762115763115764115765115766115767115768115769115770115771115772115773115774115775115776115777115778115779115780115781115782115783115784115785115786115787115788115789115790115791115792115793115794115795115796115797115798115799115800115801115802115803115804115805115806115807115808115809115810115811115812115813115814115815115816115817115818115819115820115821115822115823115824115825115826115827115828115829115830115831115832115833115834115835115836115837115838115839115840115841115842115843115844115845115846115847115848115849115850115851115852115853115854115855115856115857115858115859115860115861115862115863115864115865115866115867115868115869115870115871115872115873115874115875115876115877115878115879115880115881115882115883115884115885115886115887115888115889115890115891115892115893115894115895115896115897115898115899115900115901115902115903115904115905115906115907115908115909115910115911115912115913115914115915115916115917115918115919115920115921115922115923115924115925115926115927115928115929115930115931115932115933115934115935115936115937115938115939115940115941115942115943115944115945115946115947115948115949115950115951115952115953115954115955115956115957115958115959115960115961115962115963115964115965115966115967115968115969115970115971115972115973115974115975115976115977115978115979115980115981115982115983115984115985115986115987115988115989115990115991115992115993115994115995115996115997115998115999116000116001116002116003116004116005116006116007116008116009116010116011116012116013116014116015116016116017116018116019116020116021116022116023116024116025116026116027116028116029116030116031116032116033116034116035116036116037116038116039116040116041116042116043116044116045116046116047116048116049116050116051116052116053116054116055116056116057116058116059116060116061116062116063116064116065116066116067116068116069116070116071116072116073116074116075116076116077116078116079116080116081116082116083116084116085116086116087116088116089116090116091116092116093116094116095116096116097116098116099116100116101116102116103116104116105116106116107116108116109116110116111116112116113116114116115116116116117116118116119116120116121116122116123116124116125116126116127116128116129116130116131116132116133116134116135116136116137116138116139116140116141116142116143116144116145116146116147116148116149116150116151116152116153116154116155116156116157116158116159116160116161116162116163116164116165116166116167116168116169116170116171116172116173116174116175116176116177116178116179116180116181116182116183116184116185116186116187116188116189116190116191116192116193116194116195116196116197116198116199116200116201116202116203116204116205116206116207116208116209116210116211116212116213116214116215116216116217116218116219116220116221116222116223116224116225116226116227116228116229116230116231116232116233116234116235116236116237116238116239116240116241116242116243116244116245116246116247116248116249116250116251116252116253116254116255116256116257116258116259116260116261116262116263116264116265116266116267116268116269116270116271116272116273116274116275116276116277116278116279116280116281116282116283116284116285116286116287116288116289116290116291116292116293116294116295116296116297116298116299116300116301116302116303116304116305116306116307116308116309116310116311116312116313116314116315116316116317116318116319116320116321116322116323116324116325116326116327116328116329116330116331116332116333116334116335116336116337116338116339116340116341116342116343116344116345116346116347116348116349116350116351116352116353116354116355116356116357116358116359116360116361116362116363116364116365116366116367116368116369116370116371116372116373116374116375116376116377116378116379116380116381116382116383116384116385116386116387116388116389116390116391116392116393116394116395116396116397116398116399116400116401116402116403116404116405116406116407116408116409116410116411116412116413116414116415116416116417116418116419116420116421116422116423116424116425116426116427116428116429116430116431116432116433116434116435116436116437116438116439116440116441116442116443116444116445116446116447116448116449116450116451116452116453116454116455116456116457116458116459116460116461116462116463116464116465116466116467116468116469116470116471116472116473116474116475116476116477116478116479116480116481116482116483116484116485116486116487116488116489116490116491116492116493116494116495116496116497116498116499116500116501116502116503116504116505116506116507116508116509116510116511116512116513116514116515116516116517116518116519116520116521116522116523116524116525116526116527116528116529116530116531116532116533116534116535116536116537116538116539116540116541116542116543116544116545116546116547116548116549116550116551116552116553116554116555116556116557116558116559116560116561116562116563116564116565116566116567116568116569116570116571116572116573116574116575116576116577116578116579116580116581116582116583116584116585116586116587116588116589116590116591116592116593116594116595116596116597116598116599116600116601116602116603116604116605116606116607116608116609116610116611116612116613116614116615116616116617116618116619116620116621116622116623116624116625116626116627116628116629116630116631116632116633116634116635116636116637116638116639116640116641116642116643116644116645116646116647116648116649116650116651116652116653116654116655116656116657116658116659116660116661116662116663116664116665116666116667116668116669116670116671116672116673116674116675116676116677116678116679116680116681116682116683116684116685116686116687116688116689116690116691116692116693116694116695116696116697116698116699116700116701116702116703116704116705116706116707116708116709116710116711116712116713116714116715116716116717116718116719116720116721116722116723116724116725116726116727116728116729116730116731116732116733116734116735116736116737116738116739116740116741116742116743116744116745116746116747116748116749116750116751116752116753116754116755116756116757116758116759116760116761116762116763116764116765116766116767116768116769116770116771116772116773116774116775116776116777116778116779116780116781116782116783116784116785116786116787116788116789116790116791116792116793116794116795116796116797116798116799116800116801116802116803116804116805116806116807116808116809116810116811116812116813116814116815116816116817116818116819116820116821116822116823116824116825116826116827116828116829116830116831116832116833116834116835116836116837116838116839116840116841116842116843116844116845116846116847116848116849116850116851116852116853116854116855116856116857116858116859116860116861116862116863116864116865116866116867116868116869116870116871116872116873116874116875116876116877116878116879116880116881116882116883116884116885116886116887116888116889116890116891116892116893116894116895116896116897116898116899116900116901116902116903116904116905116906116907116908116909116910116911116912116913116914116915116916116917116918116919116920116921116922116923116924116925116926116927116928116929116930116931116932116933116934116935116936116937116938116939116940116941116942116943116944116945116946116947116948116949116950116951116952116953116954116955116956116957116958116959116960116961116962116963116964116965116966116967116968116969116970116971116972116973116974116975116976116977116978116979116980116981116982116983116984116985116986116987116988116989116990116991116992116993116994116995116996116997116998116999117000117001117002117003117004117005117006117007117008117009117010117011117012117013117014117015117016117017117018117019117020117021117022117023117024117025117026117027117028117029117030117031117032117033117034117035117036117037117038117039117040117041117042117043117044117045117046117047117048117049117050117051117052117053117054117055117056117057117058117059117060117061117062117063117064117065117066117067117068117069117070117071117072117073117074117075117076117077117078117079117080117081117082117083117084117085117086117087117088117089117090117091117092117093117094117095117096117097117098117099117100117101117102117103117104117105117106117107117108117109117110117111117112117113117114117115117116117117117118117119117120117121117122117123117124117125117126117127117128117129117130117131117132117133117134117135117136117137117138117139117140117141117142117143117144117145117146117147117148117149117150117151117152117153117154117155117156117157117158117159117160117161117162117163117164117165117166117167117168117169117170117171117172117173117174117175117176117177117178117179117180117181117182117183117184117185117186117187117188117189117190117191117192117193117194117195117196117197117198117199117200117201117202117203117204117205117206117207117208117209117210117211117212117213117214117215117216117217117218117219117220117221117222117223117224117225117226117227117228117229117230117231117232117233117234117235117236117237117238117239117240117241117242117243117244117245117246117247117248117249117250117251117252117253117254117255117256117257117258117259117260117261117262117263117264117265117266117267117268117269117270117271117272117273117274117275117276117277117278117279117280117281117282117283117284117285117286117287117288117289117290117291117292117293117294117295117296117297117298117299117300117301117302117303117304117305117306117307117308117309117310117311117312117313117314117315117316117317117318117319117320117321117322117323117324117325117326117327117328117329117330117331117332117333117334117335117336117337117338117339117340117341117342117343117344117345117346117347117348117349117350117351117352117353117354117355117356117357117358117359117360117361117362117363117364117365117366117367117368117369117370117371117372117373117374117375117376117377117378117379117380117381117382117383117384117385117386117387117388117389117390117391117392117393117394117395117396117397117398117399117400117401117402117403117404117405117406117407117408117409117410117411117412117413117414117415117416117417117418117419117420117421117422117423117424117425117426117427117428117429117430117431117432117433117434117435117436117437117438117439117440117441117442117443117444117445117446117447117448117449117450117451117452117453117454117455117456117457117458117459117460117461117462117463117464117465117466117467117468117469117470117471117472117473117474117475117476117477117478117479117480117481117482117483117484117485117486117487117488117489117490117491117492117493117494117495117496117497117498117499117500117501117502117503117504117505117506117507117508117509117510117511117512117513117514117515117516117517117518117519117520117521117522117523117524117525117526117527117528117529117530117531117532117533117534117535117536117537117538117539117540117541117542117543117544117545117546117547117548117549117550117551117552117553117554117555117556117557117558117559117560117561117562117563117564117565117566117567117568117569117570117571117572117573117574117575117576117577117578117579117580117581117582117583117584117585117586117587117588117589117590117591117592117593117594117595117596117597117598117599117600117601117602117603117604117605117606117607117608117609117610117611117612117613117614117615117616117617117618117619117620117621117622117623117624117625117626117627117628117629117630117631117632117633117634117635117636117637117638117639117640117641117642117643117644117645117646117647117648117649117650117651117652117653117654117655117656117657117658117659117660117661117662117663117664117665117666117667117668117669117670117671117672117673117674117675117676117677117678117679117680117681117682117683117684117685117686117687117688117689117690117691117692117693117694117695117696117697117698117699117700117701117702117703117704117705117706117707117708117709117710117711117712117713117714117715117716117717117718117719117720117721117722117723117724117725117726117727117728117729117730117731117732117733117734117735117736117737117738117739117740117741117742117743117744117745117746117747117748117749117750117751117752117753117754117755117756117757117758117759117760117761117762117763117764117765117766117767117768117769117770117771117772117773117774117775117776117777117778117779117780117781117782117783117784117785117786117787117788117789117790117791117792117793117794117795117796117797117798117799117800117801117802117803117804117805117806117807117808117809117810117811117812117813117814117815117816117817117818117819117820117821117822117823117824117825117826117827117828117829117830117831117832117833117834117835117836117837117838117839117840117841117842117843117844117845117846117847117848117849117850117851117852117853117854117855117856117857117858117859117860117861117862117863117864117865117866117867117868117869117870117871117872117873117874117875117876117877117878117879117880117881117882117883117884117885117886117887117888117889117890117891117892117893117894117895117896117897117898117899117900117901117902117903117904117905117906117907117908117909117910117911117912117913117914117915117916117917117918117919117920117921117922117923117924117925117926117927117928117929117930117931117932117933117934117935117936117937117938117939117940117941117942117943117944117945117946117947117948117949117950117951117952117953117954117955117956117957117958117959117960117961117962117963117964117965117966117967117968117969117970117971117972117973117974117975117976117977117978117979117980117981117982117983117984117985117986117987117988117989117990117991117992117993117994117995117996117997117998117999118000118001118002118003118004118005118006118007118008118009118010118011118012118013118014118015118016118017118018118019118020118021118022118023118024118025118026118027118028118029118030118031118032118033118034118035118036118037118038118039118040118041118042118043118044118045118046118047118048118049118050118051118052118053118054118055118056118057118058118059118060118061118062118063118064118065118066118067118068118069118070118071118072118073118074118075118076118077118078118079118080118081118082118083118084118085118086118087118088118089118090118091118092118093118094118095118096118097118098118099118100118101118102118103118104118105118106118107118108118109118110118111118112118113118114118115118116118117118118118119118120118121118122118123118124118125118126118127118128118129118130118131118132118133118134118135118136118137118138118139118140118141118142118143118144118145118146118147118148118149118150118151118152118153118154118155118156118157118158118159118160118161118162118163118164118165118166118167118168118169118170118171118172118173118174118175118176118177118178118179118180118181118182118183118184118185118186118187118188118189118190118191118192118193118194118195118196118197118198118199118200118201118202118203118204118205118206118207118208118209118210118211118212118213118214118215118216118217118218118219118220118221118222118223118224118225118226118227118228118229118230118231118232118233118234118235118236118237118238118239118240118241118242118243118244118245118246118247118248118249118250118251118252118253118254118255118256118257118258118259118260118261118262118263118264118265118266118267118268118269118270118271118272118273118274118275118276118277118278118279118280118281118282118283118284118285118286118287118288118289118290118291118292118293118294118295118296118297118298118299118300118301118302118303118304118305118306118307118308118309118310118311118312118313118314118315118316118317118318118319118320118321118322118323118324118325118326118327118328118329118330118331118332118333118334118335118336118337118338118339118340118341118342118343118344118345118346118347118348118349118350118351118352118353118354118355118356118357118358118359118360118361118362118363118364118365118366118367118368118369118370118371118372118373118374118375118376118377118378118379118380118381118382118383118384118385118386118387118388118389118390118391118392118393118394118395118396118397118398118399118400118401118402118403118404118405118406118407118408118409118410118411118412118413118414118415118416118417118418118419118420118421118422118423118424118425118426118427118428118429118430118431118432118433118434118435118436118437118438118439118440118441118442118443118444118445118446118447118448118449118450118451118452118453118454118455118456118457118458118459118460118461118462118463118464118465118466118467118468118469118470118471118472118473118474118475118476118477118478118479118480118481118482118483118484118485118486118487118488118489118490118491118492118493118494118495118496118497118498118499118500118501118502118503118504118505118506118507118508118509118510118511118512118513118514118515118516118517118518118519118520118521118522118523118524118525118526118527118528118529118530118531118532118533118534118535118536118537118538118539118540118541118542118543118544118545118546118547118548118549118550118551118552118553118554118555118556118557118558118559118560118561118562118563118564118565118566118567118568118569118570118571118572118573118574118575118576118577118578118579118580118581118582118583118584118585118586118587118588118589118590118591118592118593118594118595118596118597118598118599118600118601118602118603118604118605118606118607118608118609118610118611118612118613118614118615118616118617118618118619118620118621118622118623118624118625118626118627118628118629118630118631118632118633118634118635118636118637118638118639118640118641118642118643118644118645118646118647118648118649118650118651118652118653118654118655118656118657118658118659118660118661118662118663118664118665118666118667118668118669118670118671118672118673118674118675118676118677118678118679118680118681118682118683118684118685118686118687118688118689118690118691118692118693118694118695118696118697118698118699118700118701118702118703118704118705118706118707118708118709118710118711118712118713118714118715118716118717118718118719118720118721118722118723118724118725118726118727118728118729118730118731118732118733118734118735118736118737118738118739118740118741118742118743118744118745118746118747118748118749118750118751118752118753118754118755118756118757118758118759118760118761118762118763118764118765118766118767118768118769118770118771118772118773118774118775118776118777118778118779118780118781118782118783118784118785118786118787118788118789118790118791118792118793118794118795118796118797118798118799118800118801118802118803118804118805118806118807118808118809118810118811118812118813118814118815118816118817118818118819118820118821118822118823118824118825118826118827118828118829118830118831118832118833118834118835118836118837118838118839118840118841118842118843118844118845118846118847118848118849118850118851118852118853118854118855118856118857118858118859118860118861118862118863118864118865118866118867118868118869118870118871118872118873118874118875118876118877118878118879118880118881118882118883118884118885118886118887118888118889118890118891118892118893118894118895118896118897118898118899118900118901118902118903118904118905118906118907118908118909118910118911118912118913118914118915118916118917118918118919118920118921118922118923118924118925118926118927118928118929118930118931118932118933118934118935118936118937118938118939118940118941118942118943118944118945118946118947118948118949118950118951118952118953118954118955118956118957118958118959118960118961118962118963118964118965118966118967118968118969118970118971118972118973118974118975118976118977118978118979118980118981118982118983118984118985118986118987118988118989118990118991118992118993118994118995118996118997118998118999119000119001119002119003119004119005119006119007119008119009119010119011119012119013119014119015119016119017119018119019119020119021119022119023119024119025119026119027119028119029119030119031119032119033119034119035119036119037119038119039119040119041119042119043119044119045119046119047119048119049119050119051119052119053119054119055119056119057119058119059119060119061119062119063119064119065119066119067119068119069119070119071119072119073119074119075119076119077119078119079119080119081119082119083119084119085119086119087119088119089119090119091119092119093119094119095119096119097119098119099119100119101119102119103119104119105119106119107119108119109119110119111119112119113119114119115119116119117119118119119119120119121119122119123119124119125119126119127119128119129119130119131119132119133119134119135119136119137119138119139119140119141119142119143119144119145119146119147119148119149119150119151119152119153119154119155119156119157119158119159119160119161119162119163119164119165119166119167119168119169119170119171119172119173119174119175119176119177119178119179119180119181119182119183119184119185119186119187119188119189119190119191119192119193119194119195119196119197119198119199119200119201119202119203119204119205119206119207119208119209119210119211119212119213119214119215119216119217119218119219119220119221119222119223119224119225119226119227119228119229119230119231119232119233119234119235119236119237119238119239119240119241119242119243119244119245119246119247119248119249119250119251119252119253119254119255119256119257119258119259119260119261119262119263119264119265119266119267119268119269119270119271119272119273119274119275119276119277119278119279119280119281119282119283119284119285119286119287119288119289119290119291119292119293119294119295119296119297119298119299119300119301119302119303119304119305119306119307119308119309119310119311119312119313119314119315119316119317119318119319119320119321119322119323119324119325119326119327119328119329119330119331119332119333119334119335119336119337119338119339119340119341119342119343119344119345119346119347119348119349119350119351119352119353119354119355119356119357119358119359119360119361119362119363119364119365119366119367119368119369119370119371119372119373119374119375119376119377119378119379119380119381119382119383119384119385119386119387119388119389119390119391119392119393119394119395119396119397119398119399119400119401119402119403119404119405119406119407119408119409119410119411119412119413119414119415119416119417119418119419119420119421119422119423119424119425119426119427119428119429119430119431119432119433119434119435119436119437119438119439119440119441119442119443119444119445119446119447119448119449119450119451119452119453119454119455119456119457119458119459119460119461119462119463119464119465119466119467119468119469119470119471119472119473119474119475119476119477119478119479119480119481119482119483119484119485119486119487119488119489119490119491119492119493119494119495119496119497119498119499119500119501119502119503119504119505119506119507119508119509119510119511119512119513119514119515119516119517119518119519119520119521119522119523119524119525119526119527119528119529119530119531119532119533119534119535119536119537119538119539119540119541119542119543119544119545119546119547119548119549119550119551119552119553119554119555119556119557119558119559119560119561119562119563119564119565119566119567119568119569119570119571119572119573119574119575119576119577119578119579119580119581119582119583119584119585119586119587119588119589119590119591119592119593119594119595119596119597119598119599119600119601119602119603119604119605119606119607119608119609119610119611119612119613119614119615119616119617119618119619119620119621119622119623119624119625119626119627119628119629119630119631119632119633119634119635119636119637119638119639119640119641119642119643119644119645119646119647119648119649119650119651119652119653119654119655119656119657119658119659119660119661119662119663119664119665119666119667119668119669119670119671119672119673119674119675119676119677119678119679119680119681119682119683119684119685119686119687119688119689119690119691119692119693119694119695119696119697119698119699119700119701119702119703119704119705119706119707119708119709119710119711119712119713119714119715119716119717119718119719119720119721119722119723119724119725119726119727119728119729119730119731119732119733119734119735119736119737119738119739119740119741119742119743119744119745119746119747119748119749119750119751119752119753119754119755119756119757119758119759119760119761119762119763119764119765119766119767119768119769119770119771119772119773119774119775119776119777119778119779119780119781119782119783119784119785119786119787119788119789119790119791119792119793119794119795119796119797119798119799119800119801119802119803119804119805119806119807119808119809119810119811119812119813119814119815119816119817119818119819119820119821119822119823119824119825119826119827119828119829119830119831119832119833119834119835119836119837119838119839119840119841119842119843119844119845119846119847119848119849119850119851119852119853119854119855119856119857119858119859119860119861119862119863119864119865119866119867119868119869119870119871119872119873119874119875119876119877119878119879119880119881119882119883119884119885119886119887119888119889119890119891119892119893119894119895119896119897119898119899119900119901119902119903119904119905119906119907119908119909119910119911119912119913119914119915119916119917119918119919119920119921119922119923119924119925119926119927119928119929119930119931119932119933119934119935119936119937119938119939119940119941119942119943119944119945119946119947119948119949119950119951119952119953119954119955119956119957119958119959119960119961119962119963119964119965119966119967119968119969119970119971119972119973119974119975119976119977119978119979119980119981119982119983119984119985119986119987119988119989119990119991119992119993119994119995119996119997119998119999120000120001120002120003120004120005120006120007120008120009120010120011120012120013120014120015120016120017120018120019120020120021120022120023120024120025120026120027120028120029120030120031120032120033120034120035120036120037120038120039120040120041120042120043120044120045120046120047120048120049120050120051120052120053120054120055120056120057120058120059120060120061120062120063120064120065120066120067120068120069120070120071120072120073120074120075120076120077120078120079120080120081120082120083120084120085120086120087120088120089120090120091120092120093120094120095120096120097120098120099120100120101120102120103120104120105120106120107120108120109120110120111120112120113120114120115120116120117120118120119120120120121120122120123120124120125120126120127120128120129120130120131120132120133120134120135120136120137120138120139120140120141120142120143120144120145120146120147120148120149120150120151120152120153120154120155120156120157120158120159120160120161120162120163120164120165120166120167120168120169120170120171120172120173120174120175120176120177120178120179120180120181120182120183120184120185120186120187120188120189120190120191120192120193120194120195120196120197120198120199120200120201120202120203120204120205120206120207120208120209120210120211120212120213120214120215120216120217120218120219120220120221120222120223120224120225120226120227120228120229120230120231120232120233120234120235120236120237120238120239120240120241120242120243120244120245120246120247120248120249120250120251120252120253120254120255120256120257120258120259120260120261120262120263120264120265120266120267120268120269120270120271120272120273120274120275120276120277120278120279120280120281120282120283120284120285120286120287120288120289120290120291120292120293120294120295120296120297120298120299120300120301120302120303120304120305120306120307120308120309120310120311120312120313120314120315120316120317120318120319120320120321120322120323120324120325120326120327120328120329120330120331120332120333120334120335120336120337120338120339120340120341120342120343120344120345120346120347120348120349120350120351120352120353120354120355120356120357120358120359120360120361120362120363120364120365120366120367120368120369120370120371120372120373120374120375120376120377120378120379120380120381120382120383120384120385120386120387120388120389120390120391120392120393120394120395120396120397120398120399120400120401120402120403120404120405120406120407120408120409120410120411120412120413120414120415120416120417120418120419120420120421120422120423120424120425120426120427120428120429120430120431120432120433120434120435120436120437120438120439120440120441120442120443120444120445120446120447120448120449120450120451120452120453120454120455120456120457120458120459120460120461120462120463120464120465120466120467120468120469120470120471120472120473120474120475120476120477120478120479120480120481120482120483120484120485120486120487120488120489120490120491120492120493120494120495120496120497120498120499120500120501120502120503120504120505120506120507120508120509120510120511120512120513120514120515120516120517120518120519120520120521120522120523120524120525120526120527120528120529120530120531120532120533120534120535120536120537120538120539120540120541120542120543120544120545120546120547120548120549120550120551120552120553120554120555120556120557120558120559120560120561120562120563120564120565120566120567120568120569120570120571120572120573120574120575120576120577120578120579120580120581120582120583120584120585120586120587120588120589120590120591120592120593120594120595120596120597120598120599120600120601120602120603120604120605120606120607120608120609120610120611120612120613120614120615120616120617120618120619120620120621120622120623120624120625120626120627120628120629120630120631120632120633120634120635120636120637120638120639120640120641120642120643120644120645120646120647120648120649120650120651120652120653120654120655120656120657120658120659120660120661120662120663120664120665120666120667120668120669120670120671120672120673120674120675120676120677120678120679120680120681120682120683120684120685120686120687120688120689120690120691120692120693120694120695120696120697120698120699120700120701120702120703120704120705120706120707120708120709120710120711120712120713120714120715120716120717120718120719120720120721120722120723120724120725120726120727120728120729120730120731120732120733120734120735120736120737120738120739120740120741120742120743120744120745120746120747120748120749120750120751120752120753120754120755120756120757120758120759120760120761120762120763120764120765120766120767120768120769120770120771120772120773120774120775120776120777120778120779120780120781120782120783120784120785120786120787120788120789120790120791120792120793120794120795120796120797120798120799120800120801120802120803120804120805120806120807120808120809120810120811120812120813120814120815120816120817120818120819120820120821120822120823120824120825120826120827120828120829120830120831120832120833120834120835120836120837120838120839120840120841120842120843120844120845120846120847120848120849120850120851120852120853120854120855120856120857120858120859120860120861120862120863120864120865120866120867120868120869120870120871120872120873120874120875120876120877120878120879120880120881120882120883120884120885120886120887120888120889120890120891120892120893120894120895120896120897120898120899120900120901120902120903120904120905120906120907120908120909120910120911120912120913120914120915120916120917120918120919120920120921120922120923120924120925120926120927120928120929120930120931120932120933120934120935120936120937120938120939120940120941120942120943120944120945120946120947120948120949120950120951120952120953120954120955120956120957120958120959120960120961120962120963120964120965120966120967120968120969120970120971120972120973120974120975120976120977120978120979120980120981120982120983120984120985120986120987120988120989120990120991120992120993120994120995120996120997120998120999121000121001121002121003121004121005121006121007121008121009121010121011121012121013121014121015121016121017121018121019121020121021121022121023121024121025121026121027121028121029121030121031121032121033121034121035121036121037121038121039121040121041121042121043121044121045121046121047121048121049121050121051121052121053121054121055121056121057121058121059121060121061121062121063121064121065121066121067121068121069121070121071121072121073121074121075121076121077121078121079121080121081121082121083121084121085121086121087121088121089121090121091121092121093121094121095121096121097121098121099121100121101121102121103121104121105121106121107121108121109121110121111121112121113121114121115121116121117121118121119121120121121121122121123121124121125121126121127121128121129121130121131121132121133121134121135121136121137121138121139121140121141121142121143121144121145121146121147121148121149121150121151121152121153121154121155121156121157121158121159121160121161121162121163121164121165121166121167121168121169121170121171121172121173121174121175121176121177121178121179121180121181121182121183121184121185121186121187121188121189121190121191121192121193121194121195121196121197121198121199121200121201121202121203121204121205121206121207121208121209121210121211121212121213121214121215121216121217121218121219121220121221121222121223121224121225121226121227121228121229121230121231121232121233121234121235121236121237121238121239121240121241121242121243121244121245121246121247121248121249121250121251121252121253121254121255121256121257121258121259121260121261121262121263121264121265121266121267121268121269121270121271121272121273121274121275121276121277121278121279121280121281121282121283121284121285121286121287121288121289121290121291121292121293121294121295121296121297121298121299121300121301121302121303121304121305121306121307121308121309121310121311121312121313121314121315121316121317121318121319121320121321121322121323121324121325121326121327121328121329121330121331121332121333121334121335121336121337121338121339121340121341121342121343121344121345121346121347121348121349121350121351121352121353121354121355121356121357121358121359121360121361121362121363121364121365121366121367121368121369121370121371121372121373121374121375121376121377121378121379121380121381121382121383121384121385121386121387121388121389121390121391121392121393121394121395121396121397121398121399121400121401121402121403121404121405121406121407121408121409121410121411121412121413121414121415121416121417121418121419121420121421121422121423121424121425121426121427121428121429121430121431121432121433121434121435121436121437121438121439121440121441121442121443121444121445121446121447121448121449121450121451121452121453121454121455121456121457121458121459121460121461121462121463121464121465121466121467121468121469121470121471121472121473121474121475121476121477121478121479121480121481121482121483121484121485121486121487121488121489121490121491121492121493121494121495121496121497121498121499121500121501121502121503121504121505121506121507121508121509121510121511121512121513121514121515121516121517121518121519121520121521121522121523121524121525121526121527121528121529121530121531121532121533121534121535121536121537121538121539121540121541121542121543121544121545121546121547121548121549121550121551121552121553121554121555121556121557121558121559121560121561121562121563121564121565121566121567121568121569121570121571121572121573121574121575121576121577121578121579121580121581121582121583121584121585121586121587121588121589121590121591121592121593121594121595121596121597121598121599121600121601121602121603121604121605121606121607121608121609121610121611121612121613121614121615121616121617121618121619121620121621121622121623121624121625121626121627121628121629121630121631121632121633121634121635121636121637121638121639121640121641121642121643121644121645121646121647121648121649121650121651121652121653121654121655121656121657121658121659121660121661121662121663121664121665121666121667121668121669121670121671121672121673121674121675121676121677121678121679121680121681121682121683121684121685121686121687121688121689121690121691121692121693121694121695121696121697121698121699121700121701121702121703121704121705121706121707121708121709121710121711121712121713121714121715121716121717121718121719121720121721121722121723121724121725121726121727121728121729121730121731121732121733121734121735121736121737121738121739121740121741121742121743121744121745121746121747121748121749121750121751121752121753121754121755121756121757121758121759121760121761121762121763121764121765121766121767121768121769121770121771121772121773121774121775121776121777121778121779121780121781121782121783121784121785121786121787121788121789121790121791121792121793121794121795121796121797121798121799121800121801121802121803121804121805121806121807121808121809121810121811121812121813121814121815121816121817121818121819121820121821121822121823121824121825121826121827121828121829121830121831121832121833121834121835121836121837121838121839121840121841121842121843121844121845121846121847121848121849121850121851121852121853121854121855121856121857121858121859121860121861121862121863121864121865121866121867121868121869121870121871121872121873121874121875121876121877121878121879121880121881121882121883121884121885121886121887121888121889121890121891121892121893121894121895121896121897121898121899121900121901121902121903121904121905121906121907121908121909121910121911121912121913121914121915121916121917121918121919121920121921121922121923121924121925121926121927121928121929121930121931121932121933121934121935121936121937121938121939121940121941121942121943121944121945121946121947121948121949121950121951121952121953121954121955121956121957121958121959121960121961121962121963121964121965121966121967121968121969121970121971121972121973121974121975121976121977121978121979121980121981121982121983121984121985121986121987121988121989121990121991121992121993121994121995121996121997121998121999122000122001122002122003122004122005122006122007122008122009122010122011122012122013122014122015122016122017122018122019122020122021122022122023122024122025122026122027122028122029122030122031122032122033122034122035122036122037122038122039122040122041122042122043122044122045122046122047122048122049122050122051122052122053122054122055122056122057122058122059122060122061122062122063122064122065122066122067122068122069122070122071122072122073122074122075122076122077122078122079122080122081122082122083122084122085122086122087122088122089122090122091122092122093122094122095122096122097122098122099122100122101122102122103122104122105122106122107122108122109122110122111122112122113122114122115122116122117122118122119122120122121122122122123122124122125122126122127122128122129122130122131122132122133122134122135122136122137122138122139122140122141122142122143122144122145122146122147122148122149122150122151122152122153122154122155122156122157122158122159122160122161122162122163122164122165122166122167122168122169122170122171122172122173122174122175122176122177122178122179122180122181122182122183122184122185122186122187122188122189122190122191122192122193122194122195122196122197122198122199122200122201122202122203122204122205122206122207122208122209122210122211122212122213122214122215122216122217122218122219122220122221122222122223122224122225122226122227122228122229122230122231122232122233122234122235122236122237122238122239122240122241122242122243122244122245122246122247122248122249122250122251122252122253122254122255122256122257122258122259122260122261122262122263122264122265122266122267122268122269122270122271122272122273122274122275122276122277122278122279122280122281122282122283122284122285122286122287122288122289122290122291122292122293122294122295122296122297122298122299122300122301122302122303122304122305122306122307122308122309122310122311122312122313122314122315122316122317122318122319122320122321122322122323122324122325122326122327122328122329122330122331122332122333122334122335122336122337122338122339122340122341122342122343122344122345122346122347122348122349122350122351122352122353122354122355122356122357122358122359122360122361122362122363122364122365122366122367122368122369122370122371122372122373122374122375122376122377122378122379122380122381122382122383122384122385122386122387122388122389122390122391122392122393122394122395122396122397122398122399122400122401122402122403122404122405122406122407122408122409122410122411122412122413122414122415122416122417122418122419122420122421122422122423122424122425122426122427122428122429122430122431122432122433122434122435122436122437122438122439122440122441122442122443122444122445122446122447122448122449122450122451122452122453122454122455122456122457122458122459122460122461122462122463122464122465122466122467122468122469122470122471122472122473122474122475122476122477122478122479122480122481122482122483122484122485122486122487122488122489122490122491122492122493122494122495122496122497122498122499122500122501122502122503122504122505122506122507122508122509122510122511122512122513122514122515122516122517122518122519122520122521122522122523122524122525122526122527122528122529122530122531122532122533122534122535122536122537122538122539122540122541122542122543122544122545122546122547122548122549122550122551122552122553122554122555122556122557122558122559122560122561122562122563122564122565122566122567122568122569122570122571122572122573122574122575122576122577122578122579122580122581122582122583122584122585122586122587122588122589122590122591122592122593122594122595122596122597122598122599122600122601122602122603122604122605122606122607122608122609122610122611122612122613122614122615122616122617122618122619122620122621122622122623122624122625122626122627122628122629122630122631122632122633122634122635122636122637122638122639122640122641122642122643122644122645122646122647122648122649122650122651122652122653122654122655122656122657122658122659122660122661122662122663122664122665122666122667122668122669122670122671122672122673122674122675122676122677122678122679122680122681122682122683122684122685122686122687122688122689122690122691122692122693122694122695122696122697122698122699122700122701122702122703122704122705122706122707122708122709122710122711122712122713122714122715122716122717122718122719122720122721122722122723122724122725122726122727122728122729122730122731122732122733122734122735122736122737122738122739122740122741122742122743122744122745122746122747122748122749122750122751122752122753122754122755122756122757122758122759122760122761122762122763122764122765122766122767122768122769122770122771122772122773122774122775122776122777122778122779122780122781122782122783122784122785122786122787122788122789122790122791122792122793122794122795122796122797122798122799122800122801122802122803122804122805122806122807122808122809122810122811122812122813122814122815122816122817122818122819122820122821122822122823122824122825122826122827122828122829122830122831122832122833122834122835122836122837122838122839122840122841122842122843122844122845122846122847122848122849122850122851122852122853122854122855122856122857122858122859122860122861122862122863122864122865122866122867122868122869122870122871122872122873122874122875122876122877122878122879122880122881122882122883122884122885122886122887122888122889122890122891122892122893122894122895122896122897122898122899122900122901122902122903122904122905122906122907122908122909122910122911122912122913122914122915122916122917122918122919122920122921122922122923122924122925122926122927122928122929122930122931122932122933122934122935122936122937122938122939122940122941122942122943122944122945122946122947122948122949122950122951122952122953122954122955122956122957122958122959122960122961122962122963122964122965122966122967122968122969122970122971122972122973122974122975122976122977122978122979122980122981122982122983122984122985122986122987122988122989122990122991122992122993122994122995122996122997122998122999123000123001123002123003123004123005123006123007123008123009123010123011123012123013123014123015123016123017123018123019123020123021123022123023123024123025123026123027123028123029123030123031123032123033123034123035123036123037123038123039123040123041123042123043123044123045123046123047123048123049123050123051123052123053123054123055123056123057123058123059123060123061123062123063123064123065123066123067123068123069123070123071123072123073123074123075123076123077123078123079123080123081123082123083123084123085123086123087123088123089123090123091123092123093123094123095123096123097123098123099123100123101123102123103123104123105123106123107123108123109123110123111123112123113123114123115123116123117123118123119123120123121123122123123123124123125123126123127123128123129123130123131123132123133123134123135123136123137123138123139123140123141123142123143123144123145123146123147123148123149123150123151123152123153123154123155123156123157123158123159123160123161123162123163123164123165123166123167123168123169123170123171123172123173123174123175123176123177123178123179123180123181123182123183123184123185123186123187123188123189123190123191123192123193123194123195123196123197123198123199123200123201123202123203123204123205123206123207123208123209123210123211123212123213123214123215123216123217123218123219123220123221123222123223123224123225123226123227123228123229123230123231123232123233123234123235123236123237123238123239123240123241123242123243123244123245123246123247123248123249123250123251123252123253123254123255123256123257123258123259123260123261123262123263123264123265123266123267123268123269123270123271123272123273123274123275123276123277123278123279123280123281123282123283123284123285123286123287123288123289123290123291123292123293123294123295123296123297123298123299123300123301123302123303123304123305123306123307123308123309123310123311123312123313123314123315123316123317123318123319123320123321123322123323123324123325123326123327123328123329123330123331123332123333123334123335123336123337123338123339123340123341123342123343123344123345123346123347123348123349123350123351123352123353123354123355123356123357123358123359123360123361123362123363123364123365123366123367123368123369123370123371123372123373123374123375123376123377123378123379123380123381123382123383123384123385123386123387123388123389123390123391123392123393123394123395123396123397123398123399123400123401123402123403123404123405123406123407123408123409123410123411123412123413123414123415123416123417123418123419123420123421123422123423123424123425123426123427123428123429123430123431123432123433123434123435123436123437123438123439123440123441123442123443123444123445123446123447123448123449123450123451123452123453123454123455123456123457123458123459123460123461123462123463123464123465123466123467123468123469123470123471123472123473123474123475123476123477123478123479123480123481123482123483123484123485123486123487123488123489123490123491123492123493123494123495123496123497123498123499123500123501123502123503123504123505123506123507123508123509123510123511123512123513123514123515123516123517123518123519123520123521123522123523123524123525123526123527123528123529123530123531123532123533123534123535123536123537123538123539123540123541123542123543123544123545123546123547123548123549123550123551123552123553123554123555123556123557123558123559123560123561123562123563123564123565123566123567123568123569123570123571123572123573123574123575123576123577123578123579123580123581123582123583123584123585123586123587123588123589123590123591123592123593123594123595123596123597123598123599123600123601123602123603123604123605123606123607123608123609123610123611123612123613123614123615123616123617123618123619123620123621123622123623123624123625123626123627123628123629123630123631123632123633123634123635123636123637123638123639123640123641123642123643123644123645123646123647123648123649123650123651123652123653123654123655123656123657123658123659123660123661123662123663123664123665123666123667123668123669123670123671123672123673123674123675123676123677123678123679123680123681123682123683123684123685123686123687123688123689123690123691123692123693123694123695123696123697123698123699123700123701123702123703123704123705123706123707123708123709123710123711123712123713123714123715123716123717123718123719123720123721123722123723123724123725123726123727123728123729123730123731123732123733123734123735123736123737123738123739123740123741123742123743123744123745123746123747123748123749123750123751123752123753123754123755123756123757123758123759123760123761123762123763123764123765123766123767123768123769123770123771123772123773123774123775123776123777123778123779123780123781123782123783123784123785123786123787123788123789123790123791123792123793123794123795123796123797123798123799123800123801123802123803123804123805123806123807123808123809123810123811123812123813123814123815123816123817123818123819123820123821123822123823123824123825123826123827123828123829123830123831123832123833123834123835123836123837123838123839123840123841123842123843123844123845123846123847123848123849123850123851123852123853123854123855123856123857123858123859123860123861123862123863123864123865123866123867123868123869123870123871123872123873123874123875123876123877123878123879123880123881123882123883123884123885123886123887123888123889123890123891123892123893123894123895123896123897123898123899123900123901123902123903123904123905123906123907123908123909123910123911123912123913123914123915123916123917123918123919123920123921123922123923123924123925123926123927123928123929123930123931123932123933123934123935123936123937123938123939123940123941123942123943123944123945123946123947123948123949123950123951123952123953123954123955123956123957123958123959123960123961123962123963123964123965123966123967123968123969123970123971123972123973123974123975123976123977123978123979123980123981123982123983123984123985123986123987123988123989123990123991123992123993123994123995123996123997123998123999124000124001124002124003124004124005124006124007124008124009124010124011124012124013124014124015124016124017124018124019124020124021124022124023124024124025124026124027124028124029124030124031124032124033124034124035124036124037124038124039124040124041124042124043124044124045124046124047124048124049124050124051124052124053124054124055124056124057124058124059124060124061124062124063124064124065124066124067124068124069124070124071124072124073124074124075124076124077124078124079124080124081124082124083124084124085124086124087124088124089124090124091124092124093124094124095124096124097124098124099124100124101124102124103124104124105124106124107124108124109124110124111124112124113124114124115124116124117124118124119124120124121124122124123124124124125124126124127124128124129124130124131124132124133124134124135124136124137124138124139124140124141124142124143124144124145124146124147124148124149124150124151124152124153124154124155124156124157124158124159124160124161124162124163124164124165124166124167124168124169124170124171124172124173124174124175124176124177124178124179124180124181124182124183124184124185124186124187124188124189124190124191124192124193124194124195124196124197124198124199124200124201124202124203124204124205124206124207124208124209124210124211124212124213124214124215124216124217124218124219124220124221124222124223124224124225124226124227124228124229124230124231124232124233124234124235124236124237124238124239124240124241124242124243124244124245124246124247124248124249124250124251124252124253124254124255124256124257124258124259124260124261124262124263124264124265124266124267124268124269124270124271124272124273124274124275124276124277124278124279124280124281124282124283124284124285124286124287124288124289124290124291124292124293124294124295124296124297124298124299124300124301124302124303124304124305124306124307124308124309124310124311124312124313124314124315124316124317124318124319124320124321124322124323124324124325124326124327124328124329124330124331124332124333124334124335124336124337124338124339124340124341124342124343124344124345124346124347124348124349124350124351124352124353124354124355124356124357124358124359124360124361124362124363124364124365124366124367124368124369124370124371124372124373124374124375124376124377124378124379124380124381124382124383124384124385124386124387124388124389124390124391124392124393124394124395124396124397124398124399124400124401124402124403124404124405124406124407124408124409124410124411124412124413124414124415124416124417124418124419124420124421124422124423124424124425124426124427124428124429124430124431124432124433124434124435124436124437124438124439124440124441124442124443124444124445124446124447124448124449124450124451124452124453124454124455124456124457124458124459124460124461124462124463124464124465124466124467124468124469124470124471124472124473124474124475124476124477124478124479124480124481124482124483124484124485124486124487124488124489124490124491124492124493124494124495124496124497124498124499124500124501124502124503124504124505124506124507124508124509124510124511124512124513124514124515124516124517124518124519124520124521124522124523124524124525124526124527124528124529124530124531124532124533124534124535124536124537124538124539124540124541124542124543124544124545124546124547124548124549124550124551124552124553124554124555124556124557124558124559124560124561124562124563124564124565124566124567124568124569124570124571124572124573124574124575124576124577124578124579124580124581124582124583124584124585124586124587124588124589124590124591124592124593124594124595124596124597124598124599124600124601124602124603124604124605124606124607124608124609124610124611124612124613124614124615124616124617124618124619124620124621124622124623124624124625124626124627124628124629124630124631124632124633124634124635124636124637124638124639124640124641124642124643124644124645124646124647124648124649124650124651124652124653124654124655124656124657124658124659124660124661124662124663124664124665124666124667124668124669124670124671124672124673124674124675124676124677124678124679124680124681124682124683124684124685124686124687124688124689124690124691124692124693124694124695124696124697124698124699124700124701124702124703124704124705124706124707124708124709124710124711124712124713124714124715124716124717124718124719124720124721124722124723124724124725124726124727124728124729124730124731124732124733124734124735124736124737124738124739124740124741124742124743124744124745124746124747124748124749124750124751124752124753124754124755124756124757124758124759124760124761124762124763124764124765124766124767124768124769124770124771124772124773124774124775124776124777124778124779124780124781124782124783124784124785124786124787124788124789124790124791124792124793124794124795124796124797124798124799124800124801124802124803124804124805124806124807124808124809124810124811124812124813124814124815124816124817124818124819124820124821124822124823124824124825124826124827124828124829124830124831124832124833124834124835124836124837124838124839124840124841124842124843124844124845124846124847124848124849124850124851124852124853124854124855124856124857124858124859124860124861124862124863124864124865124866124867124868124869124870124871124872124873124874124875124876124877124878124879124880124881124882124883124884124885124886124887124888124889124890124891124892124893124894124895124896124897124898124899124900124901124902124903124904124905124906124907124908124909124910124911124912124913124914124915124916124917124918124919124920124921124922124923124924124925124926124927124928124929124930124931124932124933124934124935124936124937124938124939124940124941124942124943124944124945124946124947124948124949124950124951124952124953124954124955124956124957124958124959124960124961124962124963124964124965124966124967124968124969124970124971124972124973124974124975124976124977124978124979124980124981124982124983124984124985124986124987124988124989124990124991124992124993124994124995124996124997124998124999125000125001125002125003125004125005125006125007125008125009125010125011125012125013125014125015125016125017125018125019125020125021125022125023125024125025125026125027125028125029125030125031125032125033125034125035125036125037125038125039125040125041125042125043125044125045125046125047125048125049125050125051125052125053125054125055125056125057125058125059125060125061125062125063125064125065125066125067125068125069125070125071125072125073125074125075125076125077125078125079125080125081125082125083125084125085125086125087125088125089125090125091125092125093125094125095125096125097125098125099125100125101125102125103125104125105125106125107125108125109125110125111125112125113125114125115125116125117125118125119125120125121125122125123125124125125125126125127125128125129125130125131125132125133125134125135125136125137125138125139125140125141125142125143125144125145125146125147125148125149125150125151125152125153125154125155125156125157125158125159125160125161125162125163125164125165125166125167125168125169125170125171125172125173125174125175125176125177125178125179125180125181125182125183125184125185125186125187125188125189125190125191125192125193125194125195125196125197125198125199125200125201125202125203125204125205125206125207125208125209125210125211125212125213125214125215125216125217125218125219125220125221125222125223125224125225125226125227125228125229125230125231125232125233125234125235125236125237125238125239125240125241125242125243125244125245125246125247125248125249125250125251125252125253125254125255125256125257125258125259125260125261125262125263125264125265125266125267125268125269125270125271125272125273125274125275125276125277125278125279125280125281125282125283125284125285125286125287125288125289125290125291125292125293125294125295125296125297125298125299125300125301125302125303125304125305125306125307125308125309125310125311125312125313125314125315125316125317125318125319125320125321125322125323125324125325125326125327125328125329125330125331125332125333125334125335125336125337125338125339125340125341125342125343125344125345125346125347125348125349125350125351125352125353125354125355125356125357125358125359125360125361125362125363125364125365125366125367125368125369125370125371125372125373125374125375125376125377125378125379125380125381125382125383125384125385125386125387125388125389125390125391125392125393125394125395125396125397125398125399125400125401125402125403125404125405125406125407125408125409125410125411125412125413125414125415125416125417125418125419125420125421125422125423125424125425125426125427125428125429125430125431125432125433125434125435125436125437125438125439125440125441125442125443125444125445125446125447125448125449125450125451125452125453125454125455125456125457125458125459125460125461125462125463125464125465125466125467125468125469125470125471125472125473125474125475125476125477125478125479125480125481125482125483125484125485125486125487125488125489125490125491125492125493125494125495125496125497125498125499125500125501125502125503125504125505125506125507125508125509125510125511125512125513125514125515125516125517125518125519125520125521125522125523125524125525125526125527125528125529125530125531125532125533125534125535125536125537125538125539125540125541125542125543125544125545125546125547125548125549125550125551125552125553125554125555125556125557125558125559125560125561125562125563125564125565125566125567125568125569125570125571125572125573125574125575125576125577125578125579125580125581125582125583125584125585125586125587125588125589125590125591125592125593125594125595125596125597125598125599125600125601125602125603125604125605125606125607125608125609125610125611125612125613125614125615125616125617125618125619125620125621125622125623125624125625125626125627125628125629125630125631125632125633125634125635125636125637125638125639125640125641125642125643125644125645125646125647125648125649125650125651125652125653125654125655125656125657125658125659125660125661125662125663125664125665125666125667125668125669125670125671125672125673125674125675125676125677125678125679125680125681125682125683125684125685125686125687125688125689125690125691125692125693125694125695125696125697125698125699125700125701125702125703125704125705125706125707125708125709125710125711125712125713125714125715125716125717125718125719125720125721125722125723125724125725125726125727125728125729125730125731125732125733125734125735125736125737125738125739125740125741125742125743125744125745125746125747125748125749125750125751125752125753125754125755125756125757125758125759125760125761125762125763125764125765125766125767125768125769125770125771125772125773125774125775125776125777125778125779125780125781125782125783125784125785125786125787125788125789125790125791125792125793125794125795125796125797125798125799125800125801125802125803125804125805125806125807125808125809125810125811125812125813125814125815125816125817125818125819125820125821125822125823125824125825125826125827125828125829125830125831125832125833125834125835125836125837125838125839125840125841125842125843125844125845125846125847125848125849125850125851125852125853125854125855125856125857125858125859125860125861125862125863125864125865125866125867125868125869125870125871125872125873125874125875125876125877125878125879125880125881125882125883125884125885125886125887125888125889125890125891125892125893125894125895125896125897125898125899125900125901125902125903125904125905125906125907125908125909125910125911125912125913125914125915125916125917125918125919125920125921125922125923125924125925125926125927125928125929125930125931125932125933125934125935125936125937125938125939125940125941125942125943125944125945125946125947125948125949125950125951125952125953125954125955125956125957125958125959125960125961125962125963125964125965125966125967125968125969125970125971125972125973125974125975125976125977125978125979125980125981125982125983125984125985125986125987125988125989125990125991125992125993125994125995125996125997125998125999126000126001126002126003126004126005126006126007126008126009126010126011126012126013126014126015126016126017126018126019126020126021126022126023126024126025126026126027126028126029126030126031126032126033126034126035126036126037126038126039126040126041126042126043126044126045126046126047126048126049126050126051126052126053126054126055126056126057126058126059126060126061126062126063126064126065126066126067126068126069126070126071126072126073126074126075126076126077126078126079126080126081126082126083126084126085126086126087126088126089126090126091126092126093126094126095126096126097126098126099126100126101126102126103126104126105126106126107126108126109126110126111126112126113126114126115126116126117126118126119126120126121126122126123126124126125126126126127126128126129126130126131126132126133126134126135126136126137126138126139126140126141126142126143126144126145126146126147126148126149126150126151126152126153126154126155126156126157126158126159126160126161126162126163126164126165126166126167126168126169126170126171126172126173126174126175126176126177126178126179126180126181126182126183126184126185126186126187126188126189126190126191126192126193126194126195126196126197126198126199126200126201126202126203126204126205126206126207126208126209126210126211126212126213126214126215126216126217126218126219126220126221126222126223126224126225126226126227126228126229126230126231126232126233126234126235126236126237126238126239126240126241126242126243126244126245126246126247126248126249126250126251126252126253126254126255126256126257126258126259126260126261126262126263126264126265126266126267126268126269126270126271126272126273126274126275126276126277126278126279126280126281126282126283126284126285126286126287126288126289126290126291126292126293126294126295126296126297126298126299126300126301126302126303126304126305126306126307126308126309126310126311126312126313126314126315126316126317126318126319126320126321126322126323126324126325126326126327126328126329126330126331126332126333126334126335126336126337126338126339126340126341126342126343126344126345126346126347126348126349126350126351126352126353126354126355126356126357126358126359126360126361126362126363126364126365126366126367126368126369126370126371126372126373126374126375126376126377126378126379126380126381126382126383126384126385126386126387126388126389126390126391126392126393126394126395126396126397126398126399126400126401126402126403126404126405126406126407126408126409126410126411126412126413126414126415126416126417126418126419126420126421126422126423126424126425126426126427126428126429126430126431126432126433126434126435126436126437126438126439126440126441126442126443126444126445126446126447126448126449126450126451126452126453126454126455126456126457126458126459126460126461126462126463126464126465126466126467126468126469126470126471126472126473126474126475126476126477126478126479126480126481126482126483126484126485126486126487126488126489126490126491126492126493126494126495126496126497126498126499126500126501126502126503126504126505126506126507126508126509126510126511126512126513126514126515126516126517126518126519126520126521126522126523126524126525126526126527126528126529126530126531126532126533126534126535126536126537126538126539126540126541126542126543126544126545126546126547126548126549126550126551126552126553126554126555126556126557126558126559126560126561126562126563126564126565126566126567126568126569126570126571126572126573126574126575126576126577126578126579126580126581126582126583126584126585126586126587126588126589126590126591126592126593126594126595126596126597126598126599126600126601126602126603126604126605126606126607126608126609126610126611126612126613126614126615126616126617126618126619126620126621126622126623126624126625126626126627126628126629126630126631126632126633126634126635126636126637126638126639126640126641126642126643126644126645126646126647126648126649126650126651126652126653126654126655126656126657126658126659126660126661126662126663126664126665126666126667126668126669126670126671126672126673126674126675126676126677126678126679126680126681126682126683126684126685126686126687126688126689126690126691126692126693126694126695126696126697126698126699126700126701126702126703126704126705126706126707126708126709126710126711126712126713126714126715126716126717126718126719126720126721126722126723126724126725126726126727126728126729126730126731126732126733126734126735126736126737126738126739126740126741126742126743126744126745126746126747126748126749126750126751126752126753126754126755126756126757126758126759126760126761126762126763126764126765126766126767126768126769126770126771126772126773126774126775126776126777126778126779126780126781126782126783126784126785126786126787126788126789126790126791126792126793126794126795126796126797126798126799126800126801126802126803126804126805126806126807126808126809126810126811126812126813126814126815126816126817126818126819126820126821126822126823126824126825126826126827126828126829126830126831126832126833126834126835126836126837126838126839126840126841126842126843126844126845126846126847126848126849126850126851126852126853126854126855126856126857126858126859126860126861126862126863126864126865126866126867126868126869126870126871126872126873126874126875126876126877126878126879126880126881126882126883126884126885126886126887126888126889126890126891126892126893126894126895126896126897126898126899126900126901126902126903126904126905126906126907126908126909126910126911126912126913126914126915126916126917126918126919126920126921126922126923126924126925126926126927126928126929126930126931126932126933126934126935126936126937126938126939126940126941126942126943126944126945126946126947126948126949126950126951126952126953126954126955126956126957126958126959126960126961126962126963126964126965126966126967126968126969126970126971126972126973126974126975126976126977126978126979126980126981126982126983126984126985126986126987126988126989126990126991126992126993126994126995126996126997126998126999127000127001127002127003127004127005127006127007127008127009127010127011127012127013127014127015127016127017127018127019127020127021127022127023127024127025127026127027127028127029127030127031127032127033127034127035127036127037127038127039127040127041127042127043127044127045127046127047127048127049127050127051127052127053127054127055127056127057127058127059127060127061127062127063127064127065127066127067127068127069127070127071127072127073127074127075127076127077127078127079127080127081127082127083127084127085127086127087127088127089127090127091127092127093127094127095127096127097127098127099127100127101127102127103127104127105127106127107127108127109127110127111127112127113127114127115127116127117127118127119127120127121127122127123127124127125127126127127127128127129127130127131127132127133127134127135127136127137127138127139127140127141127142127143127144127145127146127147127148127149127150127151127152127153127154127155127156127157127158127159127160127161127162127163127164127165127166127167127168127169127170127171127172127173127174127175127176127177127178127179127180127181127182127183127184127185127186127187127188127189127190127191127192127193127194127195127196127197127198127199127200127201127202127203127204127205127206127207127208127209127210127211127212127213127214127215127216127217127218127219127220127221127222127223127224127225127226127227127228127229127230127231127232127233127234127235127236127237127238127239127240127241127242127243127244127245127246127247127248127249127250127251127252127253127254127255127256127257127258127259127260127261127262127263127264127265127266127267127268127269127270127271127272127273127274127275127276127277127278127279127280127281127282127283127284127285127286127287127288127289127290127291127292127293127294127295127296127297127298127299127300127301127302127303127304127305127306127307127308127309127310127311127312127313127314127315127316127317127318127319127320127321127322127323127324127325127326127327127328127329127330127331127332127333127334127335127336127337127338127339127340127341127342127343127344127345127346127347127348127349127350127351127352127353127354127355127356127357127358127359127360127361127362127363127364127365127366127367127368127369127370127371127372127373127374127375127376127377127378127379127380127381127382127383127384127385127386127387127388127389127390127391127392127393127394127395127396127397127398127399127400127401127402127403127404127405127406127407127408127409127410127411127412127413127414127415127416127417127418127419127420127421127422127423127424127425127426127427127428127429127430127431127432127433127434127435127436127437127438127439127440127441127442127443127444127445127446127447127448127449127450127451127452127453127454127455127456127457127458127459127460127461127462127463127464127465127466127467127468127469127470127471127472127473127474127475127476127477127478127479127480127481127482127483127484127485127486127487127488127489127490127491127492127493127494127495127496127497127498127499127500127501127502127503127504127505127506127507127508127509127510127511127512127513127514127515127516127517127518127519127520127521127522127523127524127525127526127527127528127529127530127531127532127533127534127535127536127537127538127539127540127541127542127543127544127545127546127547127548127549127550127551127552127553127554127555127556127557127558127559127560127561127562127563127564127565127566127567127568127569127570127571127572127573127574127575127576127577127578127579127580127581127582127583127584127585127586127587127588127589127590127591127592127593127594127595127596127597127598127599127600127601127602127603127604127605127606127607127608127609127610127611127612127613127614127615127616127617127618127619127620127621127622127623127624127625127626127627127628127629127630127631127632127633127634127635127636127637127638127639127640127641127642127643127644127645127646127647127648127649127650127651127652127653127654127655127656127657127658127659127660127661127662127663127664127665127666127667127668127669127670127671127672127673127674127675127676127677127678127679127680127681127682127683127684127685127686127687127688127689127690127691127692127693127694127695127696127697127698127699127700127701127702127703127704127705127706127707127708127709127710127711127712127713127714127715127716127717127718127719127720127721127722127723127724127725127726127727127728127729127730127731127732127733127734127735127736127737127738127739127740127741127742127743127744127745127746127747127748127749127750127751127752127753127754127755127756127757127758127759127760127761127762127763127764127765127766127767127768127769127770127771127772127773127774127775127776127777127778127779127780127781127782127783127784127785127786127787127788127789127790127791127792127793127794127795127796127797127798127799127800127801127802127803127804127805127806127807127808127809127810127811127812127813127814127815127816127817127818127819127820127821127822127823127824127825127826127827127828127829127830127831127832127833127834127835127836127837127838127839127840127841127842127843127844127845127846127847127848127849127850127851127852127853127854127855127856127857127858127859127860127861127862127863127864127865127866127867127868127869127870127871127872127873127874127875127876127877127878127879127880127881127882127883127884127885127886127887127888127889127890127891127892127893127894127895127896127897127898127899127900127901127902127903127904127905127906127907127908127909127910127911127912127913127914127915127916127917127918127919127920127921127922127923127924127925127926127927127928127929127930127931127932127933127934127935127936127937127938127939127940127941127942127943127944127945127946127947127948127949127950127951127952127953127954127955127956127957127958127959127960127961127962127963127964127965127966127967127968127969127970127971127972127973127974127975127976127977127978127979127980127981127982127983127984127985127986127987127988127989127990127991127992127993127994127995127996127997127998127999128000128001128002128003128004128005128006128007128008128009128010128011128012128013128014128015128016128017128018128019128020128021128022128023128024128025128026128027128028128029128030128031128032128033128034128035128036128037128038128039128040128041128042128043128044128045128046128047128048128049128050128051128052128053128054128055128056128057128058128059128060128061128062128063128064128065128066128067128068128069128070128071128072128073128074128075128076128077128078128079128080128081128082128083128084128085128086128087128088128089128090128091128092128093128094128095128096128097128098128099128100128101128102128103128104128105128106128107128108128109128110128111128112128113128114128115128116128117128118128119128120128121128122128123128124128125128126128127128128128129128130128131128132128133128134128135128136128137128138128139128140128141128142128143128144128145128146128147128148128149128150128151128152128153128154128155128156128157128158128159128160128161128162128163128164128165128166128167128168128169128170128171128172128173128174128175128176128177128178128179128180128181128182128183128184128185128186128187128188128189128190128191128192128193128194128195128196128197128198128199128200128201128202128203128204128205128206128207128208128209128210128211128212128213128214128215128216128217128218128219128220128221128222128223128224128225128226128227128228128229128230128231128232128233128234128235128236128237128238128239128240128241128242128243128244128245128246128247128248128249128250128251128252128253128254128255128256128257128258128259128260128261128262128263128264128265128266128267128268128269128270128271128272128273128274128275128276128277128278128279128280128281128282128283128284128285128286128287128288128289128290128291128292128293128294128295128296128297128298128299128300128301128302128303128304128305128306128307128308128309128310128311128312128313128314128315128316128317128318128319128320128321128322128323128324128325128326128327128328128329128330128331128332128333128334128335128336128337128338128339128340128341128342128343128344128345128346128347128348128349128350128351128352128353128354128355128356128357128358128359128360128361128362128363128364128365128366128367128368128369128370128371128372128373128374128375128376128377128378128379128380128381128382128383128384128385128386128387128388128389128390128391128392128393128394128395128396128397128398128399128400128401128402128403128404128405128406128407128408128409128410128411128412128413128414128415128416128417128418128419128420128421128422128423128424128425128426128427128428128429128430128431128432128433128434128435128436128437128438128439128440128441128442128443128444128445128446128447128448128449128450128451128452128453128454128455128456128457128458128459128460128461128462128463128464128465128466128467128468128469128470128471128472128473128474128475128476128477128478128479128480128481128482128483128484128485128486128487128488128489128490128491128492128493128494128495128496128497128498128499128500128501128502128503128504128505128506128507128508128509128510128511128512128513128514128515128516128517128518128519128520128521128522128523128524128525128526128527128528128529128530128531128532128533128534128535128536128537128538128539128540128541128542128543128544128545128546128547128548128549128550128551128552128553128554128555128556128557128558128559128560128561128562128563128564128565128566128567128568128569128570128571128572128573128574128575128576128577128578128579128580128581128582128583128584128585128586128587128588128589128590128591128592128593128594128595128596128597128598128599128600128601128602128603128604128605128606128607128608128609128610128611128612128613128614128615128616128617128618128619128620128621128622128623128624128625128626128627128628128629128630128631128632128633128634128635128636128637128638128639128640128641128642128643128644128645128646128647128648128649128650128651128652128653128654128655128656128657128658128659128660128661128662128663128664128665128666128667128668128669128670128671128672128673128674128675128676128677128678128679128680128681128682128683128684128685128686128687128688128689128690128691128692128693128694128695128696128697128698128699128700128701128702128703128704128705128706128707128708128709128710128711128712128713128714128715128716128717128718128719128720128721128722128723128724128725128726128727128728128729128730128731128732128733128734128735128736128737128738128739128740128741128742128743128744128745128746128747128748128749128750128751128752128753128754128755128756128757128758128759128760128761128762128763128764128765128766128767128768128769128770128771128772128773128774128775128776128777128778128779128780128781128782128783128784128785128786128787128788128789128790128791128792128793128794128795128796128797128798128799128800128801128802128803128804128805128806128807128808128809128810128811128812128813128814128815128816128817128818128819128820128821128822128823128824128825128826128827128828128829128830128831128832128833128834128835128836128837128838128839128840128841128842128843128844128845128846128847128848128849128850128851128852128853128854128855128856128857128858128859128860128861128862128863128864128865128866128867128868128869128870128871128872128873128874128875128876128877128878128879128880128881128882128883128884128885128886128887128888128889128890128891128892128893128894128895128896128897128898128899128900128901128902128903128904128905128906128907128908128909128910128911128912128913128914128915128916128917128918128919128920128921128922128923128924128925128926128927128928128929128930128931128932128933128934128935128936128937128938128939128940128941128942128943128944128945128946128947128948128949128950128951128952128953128954128955128956128957128958128959128960128961128962128963128964128965128966128967128968128969128970128971128972128973128974128975128976128977128978128979128980128981128982128983128984128985128986128987128988128989128990128991128992128993128994128995128996128997128998128999129000129001129002129003129004129005129006129007129008129009129010129011129012129013129014129015129016129017129018129019129020129021129022129023129024129025129026129027129028129029129030129031129032129033129034129035129036129037129038129039129040129041129042129043129044129045129046129047129048129049129050129051129052129053129054129055129056129057129058129059129060129061129062129063129064129065129066129067129068129069129070129071129072129073129074129075129076129077129078129079129080129081129082129083129084129085129086129087129088129089129090129091129092129093129094129095129096129097129098129099129100129101129102129103129104129105129106129107129108129109129110129111129112129113129114129115129116129117129118129119129120129121129122129123129124129125129126129127129128129129129130129131129132129133129134129135129136129137129138129139129140129141129142129143129144129145129146129147129148129149129150129151129152129153129154129155129156129157129158129159129160129161129162129163129164129165129166129167129168129169129170129171129172129173129174129175129176129177129178129179129180129181129182129183129184129185129186129187129188129189129190129191129192129193129194129195129196129197129198129199129200129201129202129203129204129205129206129207129208129209129210129211129212129213129214129215129216129217129218129219129220129221129222129223129224129225129226129227129228129229129230129231129232129233129234129235129236129237129238129239129240129241129242129243129244129245129246129247129248129249129250129251129252129253129254129255129256129257129258129259129260129261129262129263129264129265129266129267129268129269129270129271129272129273129274129275129276129277129278129279129280129281129282129283129284129285129286129287129288129289129290129291129292129293129294129295129296129297129298129299129300129301129302129303129304129305129306129307129308129309129310129311129312129313129314129315129316129317129318129319129320129321129322129323129324129325129326129327129328129329129330129331129332129333129334129335129336129337129338129339129340129341129342129343129344129345129346129347129348129349129350129351129352129353129354129355129356129357129358129359129360129361129362129363129364129365129366129367129368129369129370129371129372129373129374129375129376129377129378129379129380129381129382129383129384129385129386129387129388129389129390129391129392129393129394129395129396129397129398129399129400129401129402129403129404129405129406129407129408129409129410129411129412129413129414129415129416129417129418129419129420129421129422129423129424129425129426129427129428129429129430129431129432129433129434129435129436129437129438129439129440129441129442129443129444129445129446129447129448129449129450129451129452129453129454129455129456129457129458129459129460129461129462129463129464129465129466129467129468129469129470129471129472129473129474129475129476129477129478129479129480129481129482129483129484129485129486129487129488129489129490129491129492129493129494129495129496129497129498129499129500129501129502129503129504129505129506129507129508129509129510129511129512129513129514129515129516129517129518129519129520129521129522129523129524129525129526129527129528129529129530129531129532129533129534129535129536129537129538129539129540129541129542129543129544129545129546129547129548129549129550129551129552129553129554129555129556129557129558129559129560129561129562129563129564129565129566129567129568129569129570129571129572129573129574129575129576129577129578129579129580129581129582129583129584129585129586129587129588129589129590129591129592129593129594129595129596129597129598129599129600129601129602129603129604129605129606129607129608129609129610129611129612129613129614129615129616129617129618129619129620129621129622129623129624129625129626129627129628129629129630129631129632129633129634129635129636129637129638129639129640129641129642129643129644129645129646129647129648129649129650129651129652129653129654129655129656129657129658129659129660129661129662129663129664129665129666129667129668129669129670129671129672129673129674129675129676129677129678129679129680129681129682129683129684129685129686129687129688129689129690129691129692129693129694129695129696129697129698129699129700129701129702129703129704129705129706129707129708129709129710129711129712129713129714129715129716129717129718129719129720129721129722129723129724129725129726129727129728129729129730129731129732129733129734129735129736129737129738129739129740129741129742129743129744129745129746129747129748129749129750129751129752129753129754129755129756129757129758129759129760129761129762129763129764129765129766129767129768129769129770129771129772129773129774129775129776129777129778129779129780129781129782129783129784129785129786129787129788129789129790129791129792129793129794129795129796129797129798129799129800129801129802129803129804129805129806129807129808129809129810129811129812129813129814129815129816129817129818129819129820129821129822129823129824129825129826129827129828129829129830129831129832129833129834129835129836129837129838129839129840129841129842129843129844129845129846129847129848129849129850129851129852129853129854129855129856129857129858129859129860129861129862129863129864129865129866129867129868129869129870129871129872129873129874129875129876129877129878129879129880129881129882129883129884129885129886129887129888129889129890129891129892129893129894129895129896129897129898129899129900129901129902129903129904129905129906129907129908129909129910129911129912129913129914129915129916129917129918129919129920129921129922129923129924129925129926129927129928129929129930129931129932129933129934129935129936129937129938129939129940129941129942129943129944129945129946129947129948129949129950129951129952129953129954129955129956129957129958129959129960129961129962129963129964129965129966129967129968129969129970129971129972129973129974129975129976129977129978129979129980129981129982129983129984129985129986129987129988129989129990129991129992129993129994129995129996129997129998129999130000130001130002130003130004130005130006130007130008130009130010130011130012130013130014130015130016130017130018130019130020130021130022130023130024130025130026130027130028130029130030130031130032130033130034130035130036130037130038130039130040130041130042130043130044130045130046130047130048130049130050130051130052130053130054130055130056130057130058130059130060130061130062130063130064130065130066130067130068130069130070130071130072130073130074130075130076130077130078130079130080130081130082130083130084130085130086130087130088130089130090130091130092130093130094130095130096130097130098130099130100130101130102130103130104130105130106130107130108130109130110130111130112130113130114130115130116130117130118130119130120130121130122130123130124130125130126130127130128130129130130130131130132130133130134130135130136130137130138130139130140130141130142130143130144130145130146130147130148130149130150130151130152130153130154130155130156130157130158130159130160130161130162130163130164130165130166130167130168130169130170130171130172130173130174130175130176130177130178130179130180130181130182130183130184130185130186130187130188130189130190130191130192130193130194130195130196130197130198130199130200130201130202130203130204130205130206130207130208130209130210130211130212130213130214130215130216130217130218130219130220130221130222130223130224130225130226130227130228130229130230130231130232130233130234130235130236130237130238130239130240130241130242130243130244130245130246130247130248130249130250130251130252130253130254130255130256130257130258130259130260130261130262130263130264130265130266130267130268130269130270130271130272130273130274130275130276130277130278130279130280130281130282130283130284130285130286130287130288130289130290130291130292130293130294130295130296130297130298130299130300130301130302130303130304130305130306130307130308130309130310130311130312130313130314130315130316130317130318130319130320130321130322130323130324130325130326130327130328130329130330130331130332130333130334130335130336130337130338130339130340130341130342130343130344130345130346130347130348130349130350130351130352130353130354130355130356130357130358130359130360130361130362130363130364130365130366130367130368130369130370130371130372130373130374130375130376130377130378130379130380130381130382130383130384130385130386130387130388130389130390130391130392130393130394130395130396130397130398130399130400130401130402130403130404130405130406130407130408130409130410130411130412130413130414130415130416130417130418130419130420130421130422130423130424130425130426130427130428130429130430130431130432130433130434130435130436130437130438130439130440130441130442130443130444130445130446130447130448130449130450130451130452130453130454130455130456130457130458130459130460130461130462130463130464130465130466130467130468130469130470130471130472130473130474130475130476130477130478130479130480130481130482130483130484130485130486130487130488130489130490130491130492130493130494130495130496130497130498130499130500130501130502130503130504130505130506130507130508130509130510130511130512130513130514130515130516130517130518130519130520130521130522130523130524130525130526130527130528130529130530130531130532130533130534130535130536130537130538130539130540130541130542130543130544130545130546130547130548130549130550130551130552130553130554130555130556130557130558130559130560130561130562130563130564130565130566130567130568130569130570130571130572130573130574130575130576130577130578130579130580130581130582130583130584130585130586130587130588130589130590130591130592130593130594130595130596130597130598130599130600130601130602130603130604130605130606130607130608130609130610130611130612130613130614130615130616130617130618130619130620130621130622130623130624130625130626130627130628130629130630130631130632130633130634130635130636130637130638130639130640130641130642130643130644130645130646130647130648130649130650130651130652130653130654130655130656130657130658130659130660130661130662130663130664130665130666130667130668130669130670130671130672130673130674130675130676130677130678130679130680130681130682130683130684130685130686130687130688130689130690130691130692130693130694130695130696130697130698130699130700130701130702130703130704130705130706130707130708130709130710130711130712130713130714130715130716130717130718130719130720130721130722130723130724130725130726130727130728130729130730130731130732130733130734130735130736130737130738130739130740130741130742130743130744130745130746130747130748130749130750130751130752130753130754130755130756130757130758130759130760130761130762130763130764130765130766130767130768130769130770130771130772130773130774130775130776130777130778130779130780130781130782130783130784130785130786130787130788130789130790130791130792130793130794130795130796130797130798130799130800130801130802130803130804130805130806130807130808130809130810130811130812130813130814130815130816130817130818130819130820130821130822130823130824130825130826130827130828130829130830130831130832130833130834130835130836130837130838130839130840130841130842130843130844130845130846130847130848130849130850130851130852130853130854130855130856130857130858130859130860130861130862130863130864130865130866130867130868130869130870130871130872130873130874130875130876130877130878130879130880130881130882130883130884130885130886130887130888130889130890130891130892130893130894130895130896130897130898130899130900130901130902130903130904130905130906130907130908130909130910130911130912130913130914130915130916130917130918130919130920130921130922130923130924130925130926130927130928130929130930130931130932130933130934130935130936130937130938130939130940130941130942130943130944130945130946130947130948130949130950130951130952130953130954130955130956130957130958130959130960130961130962130963130964130965130966130967130968130969130970130971130972130973130974130975130976130977130978130979130980130981130982130983130984130985130986130987130988130989130990130991130992130993130994130995130996130997130998130999131000131001131002131003131004131005131006131007131008131009131010131011131012131013131014131015131016131017131018131019131020131021131022131023131024131025131026131027131028131029131030131031131032131033131034131035131036131037131038131039131040131041131042131043131044131045131046131047131048131049131050131051131052131053131054131055131056131057131058131059131060131061131062131063131064131065131066131067131068131069131070131071131072131073131074131075131076131077131078131079131080131081131082131083131084131085131086131087131088131089131090131091131092131093131094131095131096131097131098131099131100131101131102131103131104131105131106131107131108131109131110131111131112131113131114131115131116131117131118131119131120131121131122131123131124131125131126131127131128131129131130131131131132131133131134131135131136131137131138131139131140131141131142131143131144131145131146131147131148131149131150131151131152131153131154131155131156131157131158131159131160131161131162131163131164131165131166131167131168131169131170131171131172131173131174131175131176131177131178131179131180131181131182131183131184131185131186131187131188131189131190131191131192131193131194131195131196131197131198131199131200131201131202131203131204131205131206131207131208131209131210131211131212131213131214131215131216131217131218131219131220131221131222131223131224131225131226131227131228131229131230131231131232131233131234131235131236131237131238131239131240131241131242131243131244131245131246131247131248131249131250131251131252131253131254131255131256131257131258131259131260131261131262131263131264131265131266131267131268131269131270131271131272131273131274131275131276131277131278131279131280131281131282131283131284131285131286131287131288131289131290131291131292131293131294131295131296131297131298131299131300131301131302131303131304131305131306131307131308131309131310131311131312131313131314131315131316131317131318131319131320131321131322131323131324131325131326131327131328131329131330131331131332131333131334131335131336131337131338131339131340131341131342131343131344131345131346131347131348131349131350131351131352131353131354131355131356131357131358131359131360131361131362131363131364131365131366131367131368131369131370131371131372131373131374131375131376131377131378131379131380131381131382131383131384131385131386131387131388131389131390131391131392131393131394131395131396131397131398131399131400131401131402131403131404131405131406131407131408131409131410131411131412131413131414131415131416131417131418131419131420131421131422131423131424131425131426131427131428131429131430131431131432131433131434131435131436131437131438131439131440131441131442131443131444131445131446131447131448131449131450131451131452131453131454131455131456131457131458131459131460131461131462131463131464131465131466131467131468131469131470131471131472131473131474131475131476131477131478131479131480131481131482131483131484131485131486131487131488131489131490131491131492131493131494131495131496131497131498131499131500131501131502131503131504131505131506131507131508131509131510131511131512131513131514131515131516131517131518131519131520131521131522131523131524131525131526131527131528131529131530131531131532131533131534131535131536131537131538131539131540131541131542131543131544131545131546131547131548131549131550131551131552131553131554131555131556131557131558131559131560131561131562131563131564131565131566131567131568131569131570131571131572131573131574131575131576131577131578131579131580131581131582131583131584131585131586131587131588131589131590131591131592131593131594131595131596131597131598131599131600131601131602131603131604131605131606131607131608131609131610131611131612131613131614131615131616131617131618131619131620131621131622131623131624131625131626131627131628131629131630131631131632131633131634131635131636131637131638131639131640131641131642131643131644131645131646131647131648131649131650131651131652131653131654131655131656131657131658131659131660131661131662131663131664131665131666131667131668131669131670131671131672131673131674131675131676131677131678131679131680131681131682131683131684131685131686131687131688131689131690131691131692131693131694131695131696131697131698131699131700131701131702131703131704131705131706131707131708131709131710131711131712131713131714131715131716131717131718131719131720131721131722131723131724131725131726131727131728131729131730131731131732131733131734131735131736131737131738131739131740131741131742131743131744131745131746131747131748131749131750131751131752131753131754131755131756131757131758131759131760131761131762131763131764131765131766131767131768131769131770131771131772131773131774131775131776131777131778131779131780131781131782131783131784131785131786131787131788131789131790131791131792131793131794131795131796131797131798131799131800131801131802131803131804131805131806131807131808131809131810131811131812131813131814131815131816131817131818131819131820131821131822131823131824131825131826131827131828131829131830131831131832131833131834131835131836131837131838131839131840131841131842131843131844131845131846131847131848131849131850131851131852131853131854131855131856131857131858131859131860131861131862131863131864131865131866131867131868131869131870131871131872131873131874131875131876131877131878131879131880131881131882131883131884131885131886131887131888131889131890131891131892131893131894131895131896131897131898131899131900131901131902131903131904131905131906131907131908131909131910131911131912131913131914131915131916131917131918131919131920131921131922131923131924131925131926131927131928131929131930131931131932131933131934131935131936131937131938131939131940131941131942131943131944131945131946131947131948131949131950131951131952131953131954131955131956131957131958131959131960131961131962131963131964131965131966131967131968131969131970131971131972131973131974131975131976131977131978131979131980131981131982131983131984131985131986131987131988131989131990131991131992131993131994131995131996131997131998131999132000132001132002132003132004132005132006132007132008132009132010132011132012132013132014132015132016132017132018132019132020132021132022132023132024132025132026132027132028132029132030132031132032132033132034132035132036132037132038132039132040132041132042132043132044132045132046132047132048132049132050132051132052132053132054132055132056132057132058132059132060132061132062132063132064132065132066132067132068132069132070132071132072132073132074132075132076132077132078132079132080132081132082132083132084132085132086132087132088132089132090132091132092132093132094132095132096132097132098132099132100132101132102132103132104132105132106132107132108132109132110132111132112132113132114132115132116132117132118132119132120132121132122132123132124132125132126132127132128132129132130132131132132132133132134132135132136132137132138132139132140132141132142132143132144132145132146132147132148132149132150132151132152132153132154132155132156132157132158132159132160132161132162132163132164132165132166132167132168132169132170132171132172132173132174132175132176132177132178132179132180132181132182132183132184132185132186132187132188132189132190132191132192132193132194132195132196132197132198132199132200132201132202132203132204132205132206132207132208132209132210132211132212132213132214132215132216132217132218132219132220132221132222132223132224132225132226132227132228132229132230132231132232132233132234132235132236132237132238132239132240132241132242132243132244132245132246132247132248132249132250132251132252132253132254132255132256132257132258132259132260132261132262132263132264132265132266132267132268132269132270132271132272132273132274132275132276132277132278132279132280132281132282132283132284132285132286132287132288132289132290132291132292132293132294132295132296132297132298132299132300132301132302132303132304132305132306132307132308132309132310132311132312132313132314132315132316132317132318132319132320132321132322132323132324132325132326132327132328132329132330132331132332132333132334132335132336132337132338132339132340132341132342132343132344132345132346132347132348132349132350132351132352132353132354132355132356132357132358132359132360132361132362132363132364132365132366132367132368132369132370132371132372132373132374132375132376132377132378132379132380132381132382132383132384132385132386132387132388132389132390132391132392132393132394132395132396132397132398132399132400132401132402132403132404132405132406132407132408132409132410132411132412132413132414132415132416132417132418132419132420132421132422132423132424132425132426132427132428132429132430132431132432132433132434132435132436132437132438132439132440132441132442132443132444132445132446132447132448132449132450132451132452132453132454132455132456132457132458132459132460132461132462132463132464132465132466132467132468132469132470132471132472132473132474132475132476132477132478132479132480132481132482132483132484132485132486132487132488132489132490132491132492132493132494132495132496132497132498132499132500132501132502132503132504132505132506132507132508132509132510132511132512132513132514132515132516132517132518132519132520132521132522132523132524132525132526132527132528132529132530132531132532132533132534132535132536132537132538132539132540132541132542132543132544132545132546132547132548132549132550132551132552132553132554132555132556132557132558132559132560132561132562132563132564132565132566132567132568132569132570132571132572132573132574132575132576132577132578132579132580132581132582132583132584132585132586132587132588132589132590132591132592132593132594132595132596132597132598132599132600132601132602132603132604132605132606132607132608132609132610132611132612132613132614132615132616132617132618132619132620132621132622132623132624132625132626132627132628132629132630132631132632132633132634132635132636132637132638132639132640132641132642132643132644132645132646132647132648132649132650132651132652132653132654132655132656132657132658132659132660132661132662132663132664132665132666132667132668132669132670132671132672132673132674132675132676132677132678132679132680132681132682132683132684132685132686132687132688132689132690132691132692132693132694132695132696132697132698132699132700132701132702132703132704132705132706132707132708132709132710132711132712132713132714132715132716132717132718132719132720132721132722132723132724132725132726132727132728132729132730132731132732132733132734132735132736132737132738132739132740132741132742132743132744132745132746132747132748132749132750132751132752132753132754132755132756132757132758132759132760132761132762132763132764132765132766132767132768132769132770132771132772132773132774132775132776132777132778132779132780132781132782132783132784132785132786132787132788132789132790132791132792132793132794132795132796132797132798132799132800132801132802132803132804132805132806132807132808132809132810132811132812132813132814132815132816132817132818132819132820132821132822132823132824132825132826132827132828132829132830132831132832132833132834132835132836132837132838132839132840132841132842132843132844132845132846132847132848132849132850132851132852132853132854132855132856132857132858132859132860132861132862132863132864132865132866132867132868132869132870132871132872132873132874132875132876132877132878132879132880132881132882132883132884132885132886132887132888132889132890132891132892132893132894132895132896132897132898132899132900132901132902132903132904132905132906132907132908132909132910132911132912132913132914132915132916132917132918132919132920132921132922132923132924132925132926132927132928132929132930132931132932132933132934132935132936132937132938132939132940132941132942132943132944132945132946132947132948132949132950132951132952132953132954132955132956132957132958132959132960132961132962132963132964132965132966132967132968132969132970132971132972132973132974132975132976132977132978132979132980132981132982132983132984132985132986132987132988132989132990132991132992132993132994132995132996132997132998132999133000133001133002133003133004133005133006133007133008133009133010133011133012133013133014133015133016133017133018133019133020133021133022133023133024133025133026133027133028133029133030133031133032133033133034133035133036133037133038133039133040133041133042133043133044133045133046133047133048133049133050133051133052133053133054133055133056133057133058133059133060133061133062133063133064133065133066133067133068133069133070133071133072133073133074133075133076133077133078133079133080133081133082133083133084133085133086133087133088133089133090133091133092133093133094133095133096133097133098133099133100133101133102133103133104133105133106133107133108133109133110133111133112133113133114133115133116133117133118133119133120133121133122133123133124133125133126133127133128133129133130133131133132133133133134133135133136133137133138133139133140133141133142133143133144133145133146133147133148133149133150133151133152133153133154133155133156133157133158133159133160133161133162133163133164133165133166133167133168133169133170133171133172133173133174133175133176133177133178133179133180133181133182133183133184133185133186133187133188133189133190133191133192133193133194133195133196133197133198133199133200133201133202133203133204133205133206133207133208133209133210133211133212133213133214133215133216133217133218133219133220133221133222133223133224133225133226133227133228133229133230133231133232133233133234133235133236133237133238133239133240133241133242133243133244133245133246133247133248133249133250133251133252133253133254133255133256133257133258133259133260133261133262133263133264133265133266133267133268133269133270133271133272133273133274133275133276133277133278133279133280133281133282133283133284133285133286133287133288133289133290133291133292133293133294133295133296133297133298133299133300133301133302133303133304133305133306133307133308133309133310133311133312133313133314133315133316133317133318133319133320133321133322133323133324133325133326133327133328133329133330133331133332133333133334133335133336133337133338133339133340133341133342133343133344133345133346133347133348133349133350133351133352133353133354133355133356133357133358133359133360133361133362133363133364133365133366133367133368133369133370133371133372133373133374133375133376133377133378133379133380133381133382133383133384133385133386133387133388133389133390133391133392133393133394133395133396133397133398133399133400133401133402133403133404133405133406133407133408133409133410133411133412133413133414133415133416133417133418133419133420133421133422133423133424133425133426133427133428133429133430133431133432133433133434133435133436133437133438133439133440133441133442133443133444133445133446133447133448133449133450133451133452133453133454133455133456133457133458133459133460133461133462133463133464133465133466133467133468133469133470133471133472133473133474133475133476133477133478133479133480133481133482133483133484133485133486133487133488133489133490133491133492133493133494133495133496133497133498133499133500133501133502133503133504133505133506133507133508133509133510133511133512133513133514133515133516133517133518133519133520133521133522133523133524133525133526133527133528133529133530133531133532133533133534133535133536133537133538133539133540133541133542133543133544133545133546133547133548133549133550133551133552133553133554133555133556133557133558133559133560133561133562133563133564133565133566133567133568133569133570133571133572133573133574133575133576133577133578133579133580133581133582133583133584133585133586133587133588133589133590133591133592133593133594133595133596133597133598133599133600133601133602133603133604133605133606133607133608133609133610133611133612133613133614133615133616133617133618133619133620133621133622133623133624133625133626133627133628133629133630133631133632133633133634133635133636133637133638133639133640133641133642133643133644133645133646133647133648133649133650133651133652133653133654133655133656133657133658133659133660133661133662133663133664133665133666133667133668133669133670133671133672133673133674133675133676133677133678133679133680133681133682133683133684133685133686133687133688133689133690133691133692133693133694133695133696133697133698133699133700133701133702133703133704133705133706133707133708133709133710133711133712133713133714133715133716133717133718133719133720133721133722133723133724133725133726133727133728133729133730133731133732133733133734133735133736133737133738133739133740133741133742133743133744133745133746133747133748133749133750133751133752133753133754133755133756133757133758133759133760133761133762133763133764133765133766133767133768133769133770133771133772133773133774133775133776133777133778133779133780133781133782133783133784133785133786133787133788133789133790133791133792133793133794133795133796133797133798133799133800133801133802133803133804133805133806133807133808133809133810133811133812133813133814133815133816133817133818133819133820133821133822133823133824133825133826133827133828133829133830133831133832133833133834133835133836133837133838133839133840133841133842133843133844133845133846133847133848133849133850133851133852133853133854133855133856133857133858133859133860133861133862133863133864133865133866133867133868133869133870133871133872133873133874133875133876133877133878133879133880133881133882133883133884133885133886133887133888133889133890133891133892133893133894133895133896133897133898133899133900133901133902133903133904133905133906133907133908133909133910133911133912133913133914133915133916133917133918133919133920133921133922133923133924133925133926133927133928133929133930133931133932133933133934133935133936133937133938133939133940133941133942133943133944133945133946133947133948133949133950133951133952133953133954133955133956133957133958133959133960133961133962133963133964133965133966133967133968133969133970133971133972133973133974133975133976133977133978133979133980133981133982133983133984133985133986133987133988133989133990133991133992133993133994133995133996133997133998133999134000134001134002134003134004134005134006134007134008134009134010134011134012134013134014134015134016134017134018134019134020134021134022134023134024134025134026134027134028134029134030134031134032134033134034134035134036134037134038134039134040134041134042134043134044134045134046134047134048134049134050134051134052134053134054134055134056134057134058134059134060134061134062134063134064134065134066134067134068134069134070134071134072134073134074134075134076134077134078134079134080134081134082134083134084134085134086134087134088134089134090134091134092134093134094134095134096134097134098134099134100134101134102134103134104134105134106134107134108134109134110134111134112134113134114134115134116134117134118134119134120134121134122134123134124134125134126134127134128134129134130134131134132134133134134134135134136134137134138134139134140134141134142134143134144134145134146134147134148134149134150134151134152134153134154134155134156134157134158134159134160134161134162134163134164134165134166134167134168134169134170134171134172134173134174134175134176134177134178134179134180134181134182134183134184134185134186134187134188134189134190134191134192134193134194134195134196134197134198134199134200134201134202134203134204134205134206134207134208134209134210134211134212134213134214134215134216134217134218134219134220134221134222134223134224134225134226134227134228134229134230134231134232134233134234134235134236134237134238134239134240134241134242134243134244134245134246134247134248134249134250134251134252134253134254134255134256134257134258134259134260134261134262134263134264134265134266134267134268134269134270134271134272134273134274134275134276134277134278134279134280134281134282134283134284134285134286134287134288134289134290134291134292134293134294134295134296134297134298134299134300134301134302134303134304134305134306134307134308134309134310134311134312134313134314134315134316134317134318134319134320134321134322134323134324134325134326134327134328134329134330134331134332134333134334134335134336134337134338134339134340134341134342134343134344134345134346134347134348134349134350134351134352134353134354134355134356134357134358134359134360134361134362134363134364134365134366134367134368134369134370134371134372134373134374134375134376134377134378134379134380134381134382134383134384134385134386134387134388134389134390134391134392134393134394134395134396134397134398134399134400134401134402134403134404134405134406134407134408134409134410134411134412134413134414134415134416134417134418134419134420134421134422134423134424134425134426134427134428134429134430134431134432134433134434134435134436134437134438134439134440134441134442134443134444134445134446134447134448134449134450134451134452134453134454134455134456134457134458134459134460134461134462134463134464134465134466134467134468134469134470134471134472134473134474134475134476134477134478134479134480134481134482134483134484134485134486134487134488134489134490134491134492134493134494134495134496134497134498134499134500134501134502134503134504134505134506134507134508134509134510134511134512134513134514134515134516134517134518134519134520134521134522134523134524134525134526134527134528134529134530134531134532134533134534134535134536134537134538134539134540134541134542134543134544134545134546134547134548134549134550134551134552134553134554134555134556134557134558134559134560134561134562134563134564134565134566134567134568134569134570134571134572134573134574134575134576134577134578134579134580134581134582134583134584134585134586134587134588134589134590134591134592134593134594134595134596134597134598134599134600134601134602134603134604134605134606134607134608134609134610134611134612134613134614134615134616134617134618134619134620134621134622134623134624134625134626134627134628134629134630134631134632134633134634134635134636134637134638134639134640134641134642134643134644134645134646134647134648134649134650134651134652134653134654134655134656134657134658134659134660134661134662134663134664134665134666134667134668134669134670134671134672134673134674134675134676134677134678134679134680134681134682134683134684134685134686134687134688134689134690134691134692134693134694134695134696134697134698134699134700134701134702134703134704134705134706134707134708134709134710134711134712134713134714134715134716134717134718134719134720134721134722134723134724134725134726134727134728134729134730134731134732134733134734134735134736134737134738134739134740134741134742134743134744134745134746134747134748134749134750134751134752134753134754134755134756134757134758134759134760134761134762134763134764134765134766134767134768134769134770134771134772134773134774134775134776134777134778134779134780134781134782134783134784134785134786134787134788134789134790134791134792134793134794134795134796134797134798134799134800134801134802134803134804134805134806134807134808134809134810134811134812134813134814134815134816134817134818134819134820134821134822134823134824134825134826134827134828134829134830134831134832134833134834134835134836134837134838134839134840134841134842134843134844134845134846134847134848134849134850134851134852134853134854134855134856134857134858134859134860134861134862134863134864134865134866134867134868134869134870134871134872134873134874134875134876134877134878134879134880134881134882134883134884134885134886134887134888134889134890134891134892134893134894134895134896134897134898134899134900134901134902134903134904134905134906134907134908134909134910134911134912134913134914134915134916134917134918134919134920134921134922134923134924134925134926134927134928134929134930134931134932134933134934134935134936134937134938134939134940134941134942134943134944134945134946134947134948134949134950134951134952134953134954134955134956134957134958134959134960134961134962134963134964134965134966134967134968134969134970134971134972134973134974134975134976134977134978134979134980134981134982134983134984134985134986134987134988134989134990134991134992134993134994134995134996134997134998134999135000135001135002135003135004135005135006135007135008135009135010135011135012135013135014135015135016135017135018135019135020135021135022135023135024135025135026135027135028135029135030135031135032135033135034135035135036135037135038135039135040135041135042135043135044135045135046135047135048135049135050135051135052135053135054135055135056135057135058135059135060135061135062135063135064135065135066135067135068135069135070135071135072135073135074135075135076135077135078135079135080135081135082135083135084135085135086135087135088135089135090135091135092135093135094135095135096135097135098135099135100135101135102135103135104135105135106135107135108135109135110135111135112135113135114135115135116135117135118135119135120135121135122135123135124135125135126135127135128135129135130135131135132135133135134135135135136135137135138135139135140135141135142135143135144135145135146135147135148135149135150135151135152135153135154135155135156135157135158135159135160135161135162135163135164135165135166135167135168135169135170135171135172135173135174135175135176135177135178135179135180135181135182135183135184135185135186135187135188135189135190135191135192135193135194135195135196135197135198135199135200135201135202135203135204135205135206135207135208135209135210135211135212135213135214135215135216135217135218135219135220135221135222135223135224135225135226135227135228135229135230135231135232135233135234135235135236135237135238135239135240135241135242135243135244135245135246135247135248135249135250135251135252135253135254135255135256135257135258135259135260135261135262135263135264135265135266135267135268135269135270135271135272135273135274135275135276135277135278135279135280135281135282135283135284135285135286135287135288135289135290135291135292135293135294135295135296135297135298135299135300135301135302135303135304135305135306135307135308135309135310135311135312135313135314135315135316135317135318135319135320135321135322135323135324135325135326135327135328135329135330135331135332135333135334135335135336135337135338135339135340135341135342135343135344135345135346135347135348135349135350135351135352135353135354135355135356135357135358135359135360135361135362135363135364135365135366135367135368135369135370135371135372135373135374135375135376135377135378135379135380135381135382135383135384135385135386135387135388135389135390135391135392135393135394135395135396135397135398135399135400135401135402135403135404135405135406135407135408135409135410135411135412135413135414135415135416135417135418135419135420135421135422135423135424135425135426135427135428135429135430135431135432135433135434135435135436135437135438135439135440135441135442135443135444135445135446135447135448135449135450135451135452135453135454135455135456135457135458135459135460135461135462135463135464135465135466135467135468135469135470135471135472135473135474135475135476135477135478135479135480135481135482135483135484135485135486135487135488135489135490135491135492135493135494135495135496135497135498135499135500135501135502135503135504135505135506135507135508135509135510135511135512135513135514135515135516135517135518135519135520135521135522135523135524135525135526135527135528135529135530135531135532135533135534135535135536135537135538135539135540135541135542135543135544135545135546135547135548135549135550135551135552135553135554135555135556135557135558135559135560135561135562135563135564135565135566135567135568135569135570135571135572135573135574135575135576135577135578135579135580135581135582135583135584135585135586135587135588135589135590135591135592135593135594135595135596135597135598135599135600135601135602135603135604135605135606135607135608135609135610135611135612135613135614135615135616135617135618135619135620135621135622135623135624135625135626135627135628135629135630135631135632135633135634135635135636135637135638135639135640135641135642135643135644135645135646135647135648135649135650135651135652135653135654135655135656135657135658135659135660135661135662135663135664135665135666135667135668135669135670135671135672135673135674135675135676135677135678135679135680135681135682135683135684135685135686135687135688135689135690135691135692135693135694135695135696135697135698135699135700135701135702135703135704135705135706135707135708135709135710135711135712135713135714135715135716135717135718135719135720135721135722135723135724135725135726135727135728135729135730135731135732135733135734135735135736135737135738135739135740135741135742135743135744135745135746135747135748135749135750135751135752135753135754135755135756135757135758135759135760135761135762135763135764135765135766135767135768135769135770135771135772135773135774135775135776135777135778135779135780135781135782135783135784135785135786135787135788135789135790135791135792135793135794135795135796135797135798135799135800135801135802135803135804135805135806135807135808135809135810135811135812135813135814135815135816135817135818135819135820135821135822135823135824135825135826135827135828135829135830135831135832135833135834135835135836135837135838135839135840135841135842135843135844135845135846135847135848135849135850135851135852135853135854135855135856135857135858135859135860135861135862135863135864135865135866135867135868135869135870135871135872135873135874135875135876135877135878135879135880135881135882135883135884135885135886135887135888135889135890135891135892135893135894135895135896135897135898135899135900135901135902135903135904135905135906135907135908135909135910135911135912135913135914135915135916135917135918135919135920135921135922135923135924135925135926135927135928135929135930135931135932135933135934135935135936135937135938135939135940135941135942135943135944135945135946135947135948135949135950135951135952135953135954135955135956135957135958135959135960135961135962135963135964135965135966135967135968135969135970135971135972135973135974135975135976135977135978135979135980135981135982135983135984135985135986135987135988135989135990135991135992135993135994135995135996135997135998135999136000136001136002136003136004136005136006136007136008136009136010136011136012136013136014136015136016136017136018136019136020136021136022136023136024136025136026136027136028136029136030136031136032136033136034136035136036136037136038136039136040136041136042136043136044136045136046136047136048136049136050136051136052136053136054136055136056136057136058136059136060136061136062136063136064136065136066136067136068136069136070136071136072136073136074136075136076136077136078136079136080136081136082136083136084136085136086136087136088136089136090136091136092136093136094136095136096136097136098136099136100136101136102136103136104136105136106136107136108136109136110136111136112136113136114136115136116136117136118136119136120136121136122136123136124136125136126136127136128136129136130136131136132136133136134136135136136136137136138136139136140136141136142136143136144136145136146136147136148136149136150136151136152136153136154136155136156136157136158136159136160136161136162136163136164136165136166136167136168136169136170136171136172136173136174136175136176136177136178136179136180136181136182136183136184136185136186136187136188136189136190136191136192136193136194136195136196136197136198136199136200136201136202136203136204136205136206136207136208136209136210136211136212136213136214136215136216136217136218136219136220136221136222136223136224136225136226136227136228136229136230136231136232136233136234136235136236136237136238136239136240136241136242136243136244136245136246136247136248136249136250136251136252136253136254136255136256136257136258136259136260136261136262136263136264136265136266136267136268136269136270136271136272136273136274136275136276136277136278136279136280136281136282136283136284136285136286136287136288136289136290136291136292136293136294136295136296136297136298136299136300136301136302136303136304136305136306136307136308136309136310136311136312136313136314136315136316136317136318136319136320136321136322136323136324136325136326136327136328136329136330136331136332136333136334136335136336136337136338136339136340136341136342136343136344136345136346136347136348136349136350136351136352136353136354136355136356136357136358136359136360136361136362136363136364136365136366136367136368136369136370136371136372136373136374136375136376136377136378136379136380136381136382136383136384136385136386136387136388136389136390136391136392136393136394136395136396136397136398136399136400136401136402136403136404136405136406136407136408136409136410136411136412136413136414136415136416136417136418136419136420136421136422136423136424136425136426136427136428136429136430136431136432136433136434136435136436136437136438136439136440136441136442136443136444136445136446136447136448136449136450136451136452136453136454136455136456136457136458136459136460136461136462136463136464136465136466136467136468136469136470136471136472136473136474136475136476136477136478136479136480136481136482136483136484136485136486136487136488136489136490136491136492136493136494136495136496136497136498136499136500136501136502136503136504136505136506136507136508136509136510136511136512136513136514136515136516136517136518136519136520136521136522136523136524136525136526136527136528136529136530136531136532136533136534136535136536136537136538136539136540136541136542136543136544136545136546136547136548136549136550136551136552136553136554136555136556136557136558136559136560136561136562136563136564136565136566136567136568136569136570136571136572136573136574136575136576136577136578136579136580136581136582136583136584136585136586136587136588136589136590136591136592136593136594136595136596136597136598136599136600136601136602136603136604136605136606136607136608136609136610136611136612136613136614136615136616136617136618136619136620136621136622136623136624136625136626136627136628136629136630136631136632136633136634136635136636136637136638136639136640136641136642136643136644136645136646136647136648136649136650136651136652136653136654136655136656136657136658136659136660136661136662136663136664136665136666136667136668136669136670136671136672136673136674136675136676136677136678136679136680136681136682136683136684136685136686136687136688136689136690136691136692136693136694136695136696136697136698136699136700136701136702136703136704136705136706136707136708136709136710136711136712136713136714136715136716136717136718136719136720136721136722136723136724136725136726136727136728136729136730136731136732136733136734136735136736136737136738136739136740136741136742136743136744136745136746136747136748136749136750136751136752136753136754136755136756136757136758136759136760136761136762136763136764136765136766136767136768136769136770136771136772136773136774136775136776136777136778136779136780136781136782136783136784136785136786136787136788136789136790136791136792136793136794136795136796136797136798136799136800136801136802136803136804136805136806136807136808136809136810136811136812136813136814136815136816136817136818136819136820136821136822136823136824136825136826136827136828136829136830136831136832136833136834136835136836136837136838136839136840136841136842136843136844136845136846136847136848136849136850136851136852136853136854136855136856136857136858136859136860136861136862136863136864136865136866136867136868136869136870136871136872136873136874136875136876136877136878136879136880136881136882136883136884136885136886136887136888136889136890136891136892136893136894136895136896136897136898136899136900136901136902136903136904136905136906136907136908136909136910136911136912136913136914136915136916136917136918136919136920136921136922136923136924136925136926136927136928136929136930136931136932136933136934136935136936136937136938136939136940136941136942136943136944136945136946136947136948136949136950136951136952136953136954136955136956136957136958136959136960136961136962136963136964136965136966136967136968136969136970136971136972136973136974136975136976136977136978136979136980136981136982136983136984136985136986136987136988136989136990136991136992136993136994136995136996136997136998136999137000137001137002137003137004137005137006137007137008137009137010137011137012137013137014137015137016137017137018137019137020137021137022137023137024137025137026137027137028137029137030137031137032137033137034137035137036137037137038137039137040137041137042137043137044137045137046137047137048137049137050137051137052137053137054137055137056137057137058137059137060137061137062137063137064137065137066137067137068137069137070137071137072137073137074137075137076137077137078137079137080137081137082137083137084137085137086137087137088137089137090137091137092137093137094137095137096137097137098137099137100137101137102137103137104137105137106137107137108137109137110137111137112137113137114137115137116137117137118137119137120137121137122137123137124137125137126137127137128137129137130137131137132137133137134137135137136137137137138137139137140137141137142137143137144137145137146137147137148137149137150137151137152137153137154137155137156137157137158137159137160137161137162137163137164137165137166137167137168137169137170137171137172137173137174137175137176137177137178137179137180137181137182137183137184137185137186137187137188137189137190137191137192137193137194137195137196137197137198137199137200137201137202137203137204137205137206137207137208137209137210137211137212137213137214137215137216137217137218137219137220137221137222137223137224137225137226137227137228137229137230137231137232137233137234137235137236137237137238137239137240137241137242137243137244137245137246137247137248137249137250137251137252137253137254137255137256137257137258137259137260137261137262137263137264137265137266137267137268137269137270137271137272137273137274137275137276137277137278137279137280137281137282137283137284137285137286137287137288137289137290137291137292137293137294137295137296137297137298137299137300137301137302137303137304137305137306137307137308137309137310137311137312137313137314137315137316137317137318137319137320137321137322137323137324137325137326137327137328137329137330137331137332137333137334137335137336137337137338137339137340137341137342137343137344137345137346137347137348137349137350137351137352137353137354137355137356137357137358137359137360137361137362137363137364137365137366137367137368137369137370137371137372137373137374137375137376137377137378137379137380137381137382137383137384137385137386137387137388137389137390137391137392137393137394137395137396137397137398137399137400137401137402137403137404137405137406137407137408137409137410137411137412137413137414137415137416137417137418137419137420137421137422137423137424137425137426137427137428137429137430137431137432137433137434137435137436137437137438137439137440137441137442137443137444137445137446137447137448137449137450137451137452137453137454137455137456137457137458137459137460137461137462137463137464137465137466137467137468137469137470137471137472137473137474137475137476137477137478137479137480137481137482137483137484137485137486137487137488137489137490137491137492137493137494137495137496137497137498137499137500137501137502137503137504137505137506137507137508137509137510137511137512137513137514137515137516137517137518137519137520137521137522137523137524137525137526137527137528137529137530137531137532137533137534137535137536137537137538137539137540137541137542137543137544137545137546137547137548137549137550137551137552137553137554137555137556137557137558137559137560137561137562137563137564137565137566137567137568137569137570137571137572137573137574137575137576137577137578137579137580137581137582137583137584137585137586137587137588137589137590137591137592137593137594137595137596137597137598137599137600137601137602137603137604137605137606137607137608137609137610137611137612137613137614137615137616137617137618137619137620137621137622137623137624137625137626137627137628137629137630137631137632137633137634137635137636137637137638137639137640137641137642137643137644137645137646137647137648137649137650137651137652137653137654137655137656137657137658137659137660137661137662137663137664137665137666137667137668137669137670137671137672137673137674137675137676137677137678137679137680137681137682137683137684137685137686137687137688137689137690137691137692137693137694137695137696137697137698137699137700137701137702137703137704137705137706137707137708137709137710137711137712137713137714137715137716137717137718137719137720137721137722137723137724137725137726137727137728137729137730137731137732137733137734137735137736137737137738137739137740137741137742137743137744137745137746137747137748137749137750137751137752137753137754137755137756137757137758137759137760137761137762137763137764137765137766137767137768137769137770137771137772137773137774137775137776137777137778137779137780137781137782137783137784137785137786137787137788137789137790137791137792137793137794137795137796137797137798137799137800137801137802137803137804137805137806137807137808137809137810137811137812137813137814137815137816137817137818137819137820137821137822137823137824137825137826137827137828137829137830137831137832137833137834137835137836137837137838137839137840137841137842137843137844137845137846137847137848137849137850137851137852137853137854137855137856137857137858137859137860137861137862137863137864137865137866137867137868137869137870137871137872137873137874137875137876137877137878137879137880137881137882137883137884137885137886137887137888137889137890137891137892137893137894137895137896137897137898137899137900137901137902137903137904137905137906137907137908137909137910137911137912137913137914137915137916137917137918137919137920137921137922137923137924137925137926137927137928137929137930137931137932137933137934137935137936137937137938137939137940137941137942137943137944137945137946137947137948137949137950137951137952137953137954137955137956137957137958137959137960137961137962137963137964137965137966137967137968137969137970137971137972137973137974137975137976137977137978137979137980137981137982137983137984137985137986137987137988137989137990137991137992137993137994137995137996137997137998137999138000138001138002138003138004138005138006138007138008138009138010138011138012138013138014138015138016138017138018138019138020138021138022138023138024138025138026138027138028138029138030138031138032138033138034138035138036138037138038138039138040138041138042138043138044138045138046138047138048138049138050138051138052138053138054138055138056138057138058138059138060138061138062138063138064138065138066138067138068138069138070138071138072138073138074138075138076138077138078138079138080138081138082138083138084138085138086138087138088138089138090138091138092138093138094138095138096138097138098138099138100138101138102138103138104138105138106138107138108138109138110138111138112138113138114138115138116138117138118138119138120138121138122138123138124138125138126138127138128138129138130138131138132138133138134138135138136138137138138138139138140138141138142138143138144138145138146138147138148138149138150138151138152138153138154138155138156138157138158138159138160138161138162138163138164138165138166138167138168138169138170138171138172138173138174138175138176138177138178138179138180138181138182138183138184138185138186138187138188138189138190138191138192138193138194138195138196138197138198138199138200138201138202138203138204138205138206138207138208138209138210138211138212138213138214138215138216138217138218138219138220138221138222138223138224138225138226138227138228138229138230138231138232138233138234138235138236138237138238138239138240138241138242138243138244138245138246138247138248138249138250138251138252138253138254138255138256138257138258138259138260138261138262138263138264138265138266138267138268138269138270138271138272138273138274138275138276138277138278138279138280138281138282138283138284138285138286138287138288138289138290138291138292138293138294138295138296138297138298138299138300138301138302138303138304138305138306138307138308138309138310138311138312138313138314138315138316138317138318138319138320138321138322138323138324138325138326138327138328138329138330138331138332138333138334138335138336138337138338138339138340138341138342138343138344138345138346138347138348138349138350138351138352138353138354138355138356138357138358138359138360138361138362138363138364138365138366138367138368138369138370138371138372138373138374138375138376138377138378138379138380138381138382138383138384138385138386138387138388138389138390138391138392138393138394138395138396138397138398138399138400138401138402138403138404138405138406138407138408138409138410138411138412138413138414138415138416138417138418138419138420138421138422138423138424138425138426138427138428138429138430138431138432138433138434138435138436138437138438138439138440138441138442138443138444138445138446138447138448138449138450138451138452138453138454138455138456138457138458138459138460138461138462138463138464138465138466138467138468138469138470138471138472138473138474138475138476138477138478138479138480138481138482138483138484138485138486138487138488138489138490138491138492138493138494138495138496138497138498138499138500138501138502138503138504138505138506138507138508138509138510138511138512138513138514138515138516138517138518138519138520138521138522138523138524138525138526138527138528138529138530138531138532138533138534138535138536138537138538138539138540138541138542138543138544138545138546138547138548138549138550138551138552138553138554138555138556138557138558138559138560138561138562138563138564138565138566138567138568138569138570138571138572138573138574138575138576138577138578138579138580138581138582138583138584138585138586138587138588138589138590138591138592138593138594138595138596138597138598138599138600138601138602138603138604138605138606138607138608138609138610138611138612138613138614138615138616138617138618138619138620138621138622138623138624138625138626138627138628138629138630138631138632138633138634138635138636138637138638138639138640138641138642138643138644138645138646138647138648138649138650138651138652138653138654138655138656138657138658138659138660138661138662138663138664138665138666138667138668138669138670138671138672138673138674138675138676138677138678138679138680138681138682138683138684138685138686138687138688138689138690138691138692138693138694138695138696138697138698138699138700138701138702138703138704138705138706138707138708138709138710138711138712138713138714138715138716138717138718138719138720138721138722138723138724138725138726138727138728138729138730138731138732138733138734138735138736138737138738138739138740138741138742138743138744138745138746138747138748138749138750138751138752138753138754138755138756138757138758138759138760138761138762138763138764138765138766138767138768138769138770138771138772138773138774138775138776138777138778138779138780138781138782138783138784138785138786138787138788138789138790138791138792138793138794138795138796138797138798138799138800138801138802138803138804138805138806138807138808138809138810138811138812138813138814138815138816138817138818138819138820138821138822138823138824138825138826138827138828138829138830138831138832138833138834138835138836138837138838138839138840138841138842138843138844138845138846138847138848138849138850138851138852138853138854138855138856138857138858138859138860138861138862138863138864138865138866138867138868138869138870138871138872138873138874138875138876138877138878138879138880138881138882138883138884138885138886138887138888138889138890138891138892138893138894138895138896138897138898138899138900138901138902138903138904138905138906138907138908138909138910138911138912138913138914138915138916138917138918138919138920138921138922138923138924138925138926138927138928138929138930138931138932138933138934138935138936138937138938138939138940138941138942138943138944138945138946138947138948138949138950138951138952138953138954138955138956138957138958138959138960138961138962138963138964138965138966138967138968138969138970138971138972138973138974138975138976138977138978138979138980138981138982138983138984138985138986138987138988138989138990138991138992138993138994138995138996138997138998138999139000139001139002139003139004139005139006139007139008139009139010139011139012139013139014139015139016139017139018139019139020139021139022139023139024139025139026139027139028139029139030139031139032139033139034139035139036139037139038139039139040139041139042139043139044139045139046139047139048139049139050139051139052139053139054139055139056139057139058139059139060139061139062139063139064139065139066139067139068139069139070139071139072139073139074139075139076139077139078139079139080139081139082139083139084139085139086139087139088139089139090139091139092139093139094139095139096139097139098139099139100139101139102139103139104139105139106139107139108139109139110139111139112139113139114139115139116139117139118139119139120139121139122139123139124139125139126139127139128139129139130139131139132139133139134139135139136139137139138139139139140139141139142139143139144139145139146139147139148139149139150139151139152139153139154139155139156139157139158139159139160139161139162139163139164139165139166139167139168139169139170139171139172139173139174139175139176139177139178139179139180139181139182139183139184139185139186139187139188139189139190139191139192139193139194139195139196139197139198139199139200139201139202139203139204139205139206139207139208139209139210139211139212139213139214139215139216139217139218139219139220139221139222139223139224139225139226139227139228139229139230139231139232139233139234139235139236139237139238139239139240139241139242139243139244139245139246139247139248139249139250139251139252139253139254139255139256139257139258139259139260139261139262139263139264139265139266139267139268139269139270139271139272139273139274139275139276139277139278139279139280139281139282139283139284139285139286139287139288139289139290139291139292139293139294139295139296139297139298139299139300139301139302139303139304139305139306139307139308139309139310139311139312139313139314139315139316139317139318139319139320139321139322139323139324139325139326139327139328139329139330139331139332139333139334139335139336139337139338139339139340139341139342139343139344139345139346139347139348139349139350139351139352139353139354139355139356139357139358139359139360139361139362139363139364139365139366139367139368139369139370139371139372139373139374139375139376139377139378139379139380139381139382139383139384139385139386139387139388139389139390139391139392139393139394139395139396139397139398139399139400139401139402139403139404139405139406139407139408139409139410139411139412139413139414139415139416139417139418139419139420139421139422139423139424139425139426139427139428139429139430139431139432139433139434139435139436139437139438139439139440139441139442139443139444139445139446139447139448139449139450139451139452139453139454139455139456139457139458139459139460139461139462139463139464139465139466139467139468139469139470139471139472139473139474139475139476139477139478139479139480139481139482139483139484139485139486139487139488139489139490139491139492139493139494139495139496139497139498139499139500139501139502139503139504139505139506139507139508139509139510139511139512139513139514139515139516139517139518139519139520139521139522139523139524139525139526139527139528139529139530139531139532139533139534139535139536139537139538139539139540139541139542139543139544139545139546139547139548139549139550139551139552139553139554139555139556139557139558139559139560139561139562139563139564139565139566139567139568139569139570139571139572139573139574139575139576139577139578139579139580139581139582139583139584139585139586139587139588139589139590139591139592139593139594139595139596139597139598139599139600139601139602139603139604139605139606139607139608139609139610139611139612139613139614139615139616139617139618139619139620139621139622139623139624139625139626139627139628139629139630139631139632139633139634139635139636139637139638139639139640139641139642139643139644139645139646139647139648139649139650139651139652139653139654139655139656139657139658139659139660139661139662139663139664139665139666139667139668139669139670139671139672139673139674139675139676139677139678139679139680139681139682139683139684139685139686139687139688139689139690139691139692139693139694139695139696139697139698139699139700139701139702139703139704139705139706139707139708139709139710139711139712139713139714139715139716139717139718139719139720139721139722139723139724139725139726139727139728139729139730139731139732139733139734139735139736139737139738139739139740139741139742139743139744139745139746139747139748139749139750139751139752139753139754139755139756139757139758139759139760139761139762139763139764139765139766139767139768139769139770139771139772139773139774139775139776139777139778139779139780139781139782139783139784139785139786139787139788139789139790139791139792139793139794139795139796139797139798139799139800139801139802139803139804139805139806139807139808139809139810139811139812139813139814139815139816139817139818139819139820139821139822139823139824139825139826139827139828139829139830139831139832139833139834139835139836139837139838139839139840139841139842139843139844139845139846139847139848139849139850139851139852139853139854139855139856139857139858139859139860139861139862139863139864139865139866139867139868139869139870139871139872139873139874139875139876139877139878139879139880139881139882139883139884139885139886139887139888139889139890139891139892139893139894139895139896139897139898139899139900139901139902139903139904139905139906139907139908139909139910139911139912139913139914139915139916139917139918139919139920139921139922139923139924139925139926139927139928139929139930139931139932139933139934139935139936139937139938139939139940139941139942139943139944139945139946139947139948139949139950139951139952139953139954139955139956139957139958139959139960139961139962139963139964139965139966139967139968139969139970139971139972139973139974139975139976139977139978139979139980139981139982139983139984139985139986139987139988139989139990139991139992139993139994139995139996139997139998139999140000140001140002140003140004140005140006140007140008140009140010140011140012140013140014140015140016140017140018140019140020140021140022140023140024140025140026140027140028140029140030140031140032140033140034140035140036140037140038140039140040140041140042140043140044140045140046140047140048140049140050140051140052140053140054140055140056140057140058140059140060140061140062140063140064140065140066140067140068140069140070140071140072140073140074140075140076140077140078140079140080140081140082140083140084140085140086140087140088140089140090140091140092140093140094140095140096140097140098140099140100140101140102140103140104140105140106140107140108140109140110140111140112140113140114140115140116140117140118140119140120140121140122140123140124140125140126140127140128140129140130140131140132140133140134140135140136140137140138140139140140140141140142140143140144140145140146140147140148140149140150140151140152140153140154140155140156140157140158140159140160140161140162140163140164140165140166140167140168140169140170140171140172140173140174140175140176140177140178140179140180140181140182140183140184140185140186140187140188140189140190140191140192140193140194140195140196140197140198140199140200140201140202140203140204140205140206140207140208140209140210140211140212140213140214140215140216140217140218140219140220140221140222140223140224140225140226140227140228140229140230140231140232140233140234140235140236140237140238140239140240140241140242140243140244140245140246140247140248140249140250140251140252140253140254140255140256140257140258140259140260140261140262140263140264140265140266140267140268140269140270140271140272140273140274140275140276140277140278140279140280140281140282140283140284140285140286140287140288140289140290140291140292140293140294140295140296140297140298140299140300140301140302140303140304140305140306140307140308140309140310140311140312140313140314140315140316140317140318140319140320140321140322140323140324140325140326140327140328140329140330140331140332140333140334140335140336140337140338140339140340140341140342140343140344140345140346140347140348140349140350140351140352140353140354140355140356140357140358140359140360140361140362140363140364140365140366140367140368140369140370140371140372140373140374140375140376140377140378140379140380140381140382140383140384140385140386140387140388140389140390140391140392140393140394140395140396140397140398140399140400140401140402140403140404140405140406140407140408140409140410140411140412140413140414140415140416140417140418140419140420140421140422140423140424140425140426140427140428140429140430140431140432140433140434140435140436140437140438140439140440140441140442140443140444140445140446140447140448140449140450140451140452140453140454140455140456140457140458140459140460140461140462140463140464140465140466140467140468140469140470140471140472140473140474140475140476140477140478140479140480140481140482140483140484140485140486140487140488140489140490140491140492140493140494140495140496140497140498140499140500140501140502140503140504140505140506140507140508140509140510140511140512140513140514140515140516140517140518140519140520140521140522140523140524140525140526140527140528140529140530140531140532140533140534140535140536140537140538140539140540140541140542140543140544140545140546140547140548140549140550140551140552140553140554140555140556140557140558140559140560140561140562140563140564140565140566140567140568140569140570140571140572140573140574140575140576140577140578140579140580140581140582140583140584140585140586140587140588140589140590140591140592140593140594140595140596140597140598140599140600140601140602140603140604140605140606140607140608140609140610140611140612140613140614140615140616140617140618140619140620140621140622140623140624140625140626140627140628140629140630140631140632140633140634140635140636140637140638140639140640140641140642140643140644140645140646140647140648140649140650140651140652140653140654140655140656140657140658140659140660140661140662140663140664140665140666140667140668140669140670140671140672140673140674140675140676140677140678140679140680140681140682140683140684140685140686140687140688140689140690140691140692140693140694140695140696140697140698140699140700140701140702140703140704140705140706140707140708140709140710140711140712140713140714140715140716140717140718140719140720140721140722140723140724140725140726140727140728140729140730140731140732140733140734140735140736140737140738140739140740140741140742140743140744140745140746140747140748140749140750140751140752140753140754140755140756140757140758140759140760140761140762140763140764140765140766140767140768140769140770140771140772140773140774140775140776140777140778140779140780140781140782140783140784140785140786140787140788140789140790140791140792140793140794140795140796140797140798140799140800140801140802140803140804140805140806140807140808140809140810140811140812140813140814140815140816140817140818140819140820140821140822140823140824140825140826140827140828140829140830140831140832140833140834140835140836140837140838140839140840140841140842140843140844140845140846140847140848140849140850140851140852140853140854140855140856140857140858140859140860140861140862140863140864140865140866140867140868140869140870140871140872140873140874140875140876140877140878140879140880140881140882140883140884140885140886140887140888140889140890140891140892140893140894140895140896140897140898140899140900140901140902140903140904140905140906140907140908140909140910140911140912140913140914140915140916140917140918140919140920140921140922140923140924140925140926140927140928140929140930140931140932140933140934140935140936140937140938140939140940140941140942140943140944140945140946140947140948140949140950140951140952140953140954140955140956140957140958140959140960140961140962140963140964140965140966140967140968140969140970140971140972140973140974140975140976140977140978140979140980140981140982140983140984140985140986140987140988140989140990140991140992140993140994140995140996140997140998140999141000141001141002141003141004141005141006141007141008141009141010141011141012141013141014141015141016141017141018141019141020141021141022141023141024141025141026141027141028141029141030141031141032141033141034141035141036141037141038141039141040141041141042141043141044141045141046141047141048141049141050141051141052141053141054141055141056141057141058141059141060141061141062141063141064141065141066141067141068141069141070141071141072141073141074141075141076141077141078141079141080141081141082141083141084141085141086141087141088141089141090141091141092141093141094141095141096141097141098141099141100141101141102141103141104141105141106141107141108141109141110141111141112141113141114141115141116141117141118141119141120141121141122141123141124141125141126141127141128141129141130141131141132141133141134141135141136141137141138141139141140141141141142141143141144141145141146141147141148141149141150141151141152141153141154141155141156141157141158141159141160141161141162141163141164141165141166141167141168141169141170141171141172141173141174141175141176141177141178141179141180141181141182141183141184141185141186141187141188141189141190141191141192141193141194141195141196141197141198141199141200141201141202141203141204141205141206141207141208141209141210141211141212141213141214141215141216141217141218141219141220141221141222141223141224141225141226141227141228141229141230141231141232141233141234141235141236141237141238141239141240141241141242141243141244141245141246141247141248141249141250141251141252141253141254141255141256141257141258141259141260141261141262141263141264141265141266141267141268141269141270141271141272141273141274141275141276141277141278141279141280141281141282141283141284141285141286141287141288141289141290141291141292141293141294141295141296141297141298141299141300141301141302141303141304141305141306141307141308141309141310141311141312141313141314141315141316141317141318141319141320141321141322141323141324141325141326141327141328141329141330141331141332141333141334141335141336141337141338141339141340141341141342141343141344141345141346141347141348141349141350141351141352141353141354141355141356141357141358141359141360141361141362141363141364141365141366141367141368141369141370141371141372141373141374141375141376141377141378141379141380141381141382141383141384141385141386141387141388141389141390141391141392141393141394141395141396141397141398141399141400141401141402141403141404141405141406141407141408141409141410141411141412141413141414141415141416141417141418141419141420141421141422141423141424141425141426141427141428141429141430141431141432141433141434141435141436141437141438141439141440141441141442141443141444141445141446141447141448141449141450141451141452141453141454141455141456141457141458141459141460141461141462141463141464141465141466141467141468141469141470141471141472141473141474141475141476141477141478141479141480141481141482141483141484141485141486141487141488141489141490141491141492141493141494141495141496141497141498141499141500141501141502141503141504141505141506141507141508141509141510141511141512141513141514141515141516141517141518141519141520141521141522141523141524141525141526141527141528141529141530141531141532141533141534141535141536141537141538141539141540141541141542141543141544141545141546141547141548141549141550141551141552141553141554141555141556141557141558141559141560141561141562141563141564141565141566141567141568141569141570141571141572141573141574141575141576141577141578141579141580141581141582141583141584141585141586141587141588141589141590141591141592141593141594141595141596141597141598141599141600141601141602141603141604141605141606141607141608141609141610141611141612141613141614141615141616141617141618141619141620141621141622141623141624141625141626141627141628141629141630141631141632141633141634141635141636141637141638141639141640141641141642141643141644141645141646141647141648141649141650141651141652141653141654141655141656141657141658141659141660141661141662141663141664141665141666141667141668141669141670141671141672141673141674141675141676141677141678141679141680141681141682141683141684141685141686141687141688141689141690141691141692141693141694141695141696141697141698141699141700141701141702141703141704141705141706141707141708141709141710141711141712141713141714141715141716141717141718141719141720141721141722141723141724141725141726141727141728141729141730141731141732141733141734141735141736141737141738141739141740141741141742141743141744141745141746141747141748141749141750141751141752141753141754141755141756141757141758141759141760141761141762141763141764141765141766141767141768141769141770141771141772141773141774141775141776141777141778141779141780141781141782141783141784141785141786141787141788141789141790141791141792141793141794141795141796141797141798141799141800141801141802141803141804141805141806141807141808141809141810141811141812141813141814141815141816141817141818141819141820141821141822141823141824141825141826141827141828141829141830141831141832141833141834141835141836141837141838141839141840141841141842141843141844141845141846141847141848141849141850141851141852141853141854141855141856141857141858141859141860141861141862141863141864141865141866141867141868141869141870141871141872141873141874141875141876141877141878141879141880141881141882141883141884141885141886141887141888141889141890141891141892141893141894141895141896141897141898141899141900141901141902141903141904141905141906141907141908141909141910141911141912141913141914141915141916141917141918141919141920141921141922141923141924141925141926141927141928141929141930141931141932141933141934141935141936141937141938141939141940141941141942141943141944141945141946141947141948141949141950141951141952141953141954141955141956141957141958141959141960141961141962141963141964141965141966141967141968141969141970141971141972141973141974141975141976141977141978141979141980141981141982141983141984141985141986141987141988141989141990141991141992141993141994141995141996141997141998141999142000142001142002142003142004142005142006142007142008142009142010142011142012142013142014142015142016142017142018142019142020142021142022142023142024142025142026142027142028142029142030142031142032142033142034142035142036142037142038142039142040142041142042142043142044142045142046142047142048142049142050142051142052142053142054142055142056142057142058142059142060142061142062142063142064142065142066142067142068142069142070142071142072142073142074142075142076142077142078142079142080142081142082142083142084142085142086142087142088142089142090142091142092142093142094142095142096142097142098142099142100142101142102142103142104142105142106142107142108142109142110142111142112142113142114142115142116142117142118142119142120142121142122142123142124142125142126142127142128142129142130142131142132142133142134142135142136142137142138142139142140142141142142142143142144142145142146142147142148142149142150142151142152142153142154142155142156142157142158142159142160142161142162142163142164142165142166142167142168142169142170142171142172142173142174142175142176142177142178142179142180142181142182142183142184142185142186142187142188142189142190142191142192142193142194142195142196142197142198142199142200142201142202142203142204142205142206142207142208142209142210142211142212142213142214142215142216142217142218142219142220142221142222142223142224142225142226142227142228142229142230142231142232142233142234142235142236142237142238142239142240142241142242142243142244142245142246142247142248142249142250142251142252142253142254142255142256142257142258142259142260142261142262142263142264142265142266142267142268142269142270142271142272142273142274142275142276142277142278142279142280142281142282142283142284142285142286142287142288142289142290142291142292142293142294142295142296142297142298142299142300142301142302142303142304142305142306142307142308142309142310142311142312142313142314142315142316142317142318142319142320142321142322142323142324142325142326142327142328142329142330142331142332142333142334142335142336142337142338142339142340142341142342142343142344142345142346142347142348142349142350142351142352142353142354142355142356142357142358142359142360142361142362142363142364142365142366142367142368142369142370142371142372142373142374142375142376142377142378142379142380142381142382142383142384142385142386142387142388142389142390142391142392142393142394142395142396142397142398142399142400142401142402142403142404142405142406142407142408142409142410142411142412142413142414142415142416142417142418142419142420142421142422142423142424142425142426142427142428142429142430142431142432142433142434142435142436142437142438142439142440142441142442142443142444142445142446142447142448142449142450142451142452142453142454142455142456142457142458142459142460142461142462142463142464142465142466142467142468142469142470142471142472142473142474142475142476142477142478142479142480142481142482142483142484142485142486142487142488142489142490142491142492142493142494142495142496142497142498142499142500142501142502142503142504142505142506142507142508142509142510142511142512142513142514142515142516142517142518142519142520142521142522142523142524142525142526142527142528142529142530142531142532142533142534142535142536142537142538142539142540142541142542142543142544142545142546142547142548142549142550142551142552142553142554142555142556142557142558142559142560142561142562142563142564142565142566142567142568142569142570142571142572142573142574142575142576142577142578142579142580142581142582142583142584142585142586142587142588142589142590142591142592142593142594142595142596142597142598142599142600142601142602142603142604142605142606142607142608142609142610142611142612142613142614142615142616142617142618142619142620142621142622142623142624142625142626142627142628142629142630142631142632142633142634142635142636142637142638142639142640142641142642142643142644142645142646142647142648142649142650142651142652142653142654142655142656142657142658142659142660142661142662142663142664142665142666142667142668142669142670142671142672142673142674142675142676142677142678142679142680142681142682142683142684142685142686142687142688142689142690142691142692142693142694142695142696142697142698142699142700142701142702142703142704142705142706142707142708142709142710142711142712142713142714142715142716142717142718142719142720142721142722142723142724142725142726142727142728142729142730142731142732142733142734142735142736142737142738142739142740142741142742142743142744142745142746142747142748142749142750142751142752142753142754142755142756142757142758142759142760142761142762142763142764142765142766142767142768142769142770142771142772142773142774142775142776142777142778142779142780142781142782142783142784142785142786142787142788142789142790142791142792142793142794142795142796142797142798142799142800142801142802142803142804142805142806142807142808142809142810142811142812142813142814142815142816142817142818142819142820142821142822142823142824142825142826142827142828142829142830142831142832142833142834142835142836142837142838142839142840142841142842142843142844142845142846142847142848142849142850142851142852142853142854142855142856142857142858142859142860142861142862142863142864142865142866142867142868142869142870142871142872142873142874142875142876142877142878142879142880142881142882142883142884142885142886142887142888142889142890142891142892142893142894142895142896142897142898142899142900142901142902142903142904142905142906142907142908142909142910142911142912142913142914142915142916142917142918142919142920142921142922142923142924142925142926142927142928142929142930142931142932142933142934142935142936142937142938142939142940142941142942142943142944142945142946142947142948142949142950142951142952142953142954142955142956142957142958142959142960142961142962142963142964142965142966142967142968142969142970142971142972142973142974142975142976142977142978142979142980142981142982142983142984142985142986142987142988142989142990142991142992142993142994142995142996142997142998142999143000143001143002143003143004143005143006143007143008143009143010143011143012143013143014143015143016143017143018143019143020143021143022143023143024143025143026143027143028143029143030143031143032143033143034143035143036143037143038143039143040143041143042143043143044143045143046143047143048143049143050143051143052143053143054143055143056143057143058143059143060143061143062143063143064143065143066143067143068143069143070143071143072143073143074143075143076143077143078143079143080143081143082143083143084143085143086143087143088143089143090143091143092143093143094143095143096143097143098143099143100143101143102143103143104143105143106143107143108143109143110143111143112143113143114143115143116143117143118143119143120143121143122143123143124143125143126143127143128143129143130143131143132143133143134143135143136143137143138143139143140143141143142143143143144143145143146143147143148143149143150143151143152143153143154143155143156143157143158143159143160143161143162143163143164143165143166143167143168143169143170143171143172143173143174143175143176143177143178143179143180143181143182143183143184143185143186143187143188143189143190143191143192143193143194143195143196143197143198143199143200143201143202143203143204143205143206143207143208143209143210143211143212143213143214143215143216143217143218143219143220143221143222143223143224143225143226143227143228143229143230143231143232143233143234143235143236143237143238143239143240143241143242143243143244143245143246143247143248143249143250143251143252143253143254143255143256143257143258143259143260143261143262143263143264143265143266143267143268143269143270143271143272143273143274143275143276143277143278143279143280143281143282143283143284143285143286143287143288143289143290143291143292143293143294143295143296143297143298143299143300143301143302143303143304143305143306143307143308143309143310143311143312143313143314143315143316143317143318143319143320143321143322143323143324143325143326143327143328143329143330143331143332143333143334143335143336143337143338143339143340143341143342143343143344143345143346143347143348143349143350143351143352143353143354143355143356143357143358143359143360143361143362143363143364143365143366143367143368143369143370143371143372143373143374143375143376143377143378143379143380143381143382143383143384143385143386143387143388143389143390143391143392143393143394143395143396143397143398143399143400143401143402143403143404143405143406143407143408143409143410143411143412143413143414143415143416143417143418143419143420143421143422143423143424143425143426143427143428143429143430143431143432143433143434143435143436143437143438143439143440143441143442143443143444143445143446143447143448143449143450143451143452143453143454143455143456143457143458143459143460143461143462143463143464143465143466143467143468143469143470143471143472143473143474143475143476143477143478143479143480143481143482143483143484143485143486143487143488143489143490143491143492143493143494143495143496143497143498143499143500143501143502143503143504143505143506143507143508143509143510143511143512143513143514143515143516143517143518143519143520143521143522143523143524143525143526143527143528143529143530143531143532143533143534143535143536143537143538143539143540143541143542143543143544143545143546143547143548143549143550143551143552143553143554143555143556143557143558143559143560143561143562143563143564143565143566143567143568143569143570143571143572143573143574143575143576143577143578143579143580143581143582143583143584143585143586143587143588143589143590143591143592143593143594143595143596143597143598143599143600143601143602143603143604143605143606143607143608143609143610143611143612143613143614143615143616143617143618143619143620143621143622143623143624143625143626143627143628143629143630143631143632143633143634143635143636143637143638143639143640143641143642143643143644143645143646143647143648143649143650143651143652143653143654143655143656143657143658143659143660143661143662143663143664143665143666143667143668143669143670143671143672143673143674143675143676143677143678143679143680143681143682143683143684143685143686143687143688143689143690143691143692143693143694143695143696143697143698143699143700143701143702143703143704143705143706143707143708143709143710143711143712143713143714143715143716143717143718143719143720143721143722143723143724143725143726143727143728143729143730143731143732143733143734143735143736143737143738143739143740143741143742143743143744143745143746143747143748143749143750143751143752143753143754143755143756143757143758143759143760143761143762143763143764143765143766143767143768143769143770143771143772143773143774143775143776143777143778143779143780143781143782143783143784143785143786143787143788143789143790143791143792143793143794143795143796143797143798143799143800143801143802143803143804143805143806143807143808143809143810143811143812143813143814143815143816143817143818143819143820143821143822143823143824143825143826143827143828143829143830143831143832143833143834143835143836143837143838143839143840143841143842143843143844143845143846143847143848143849143850143851143852143853143854143855143856143857143858143859143860143861143862143863143864143865143866143867143868143869143870143871143872143873143874143875143876143877143878143879143880143881143882143883143884143885143886143887143888143889143890143891143892143893143894143895143896143897143898143899143900143901143902143903143904143905143906143907143908143909143910143911143912143913143914143915143916143917143918143919143920143921143922143923143924143925143926143927143928143929143930143931143932143933143934143935143936143937143938143939143940143941143942143943143944143945143946143947143948143949143950143951143952143953143954143955143956143957143958143959143960143961143962143963143964143965143966143967143968143969143970143971143972143973143974143975143976143977143978143979143980143981143982143983143984143985143986143987143988143989143990143991143992143993143994143995143996143997143998143999144000144001144002144003144004144005144006144007144008144009144010144011144012144013144014144015144016144017144018144019144020144021144022144023144024144025144026144027144028144029144030144031144032144033144034144035144036144037144038144039144040144041144042144043144044144045144046144047144048144049144050144051144052144053144054144055144056144057144058144059144060144061144062144063144064144065144066144067144068144069144070144071144072144073144074144075144076144077144078144079144080144081144082144083144084144085144086144087144088144089144090144091144092144093144094144095144096144097144098144099144100144101144102144103144104144105144106144107144108144109144110144111144112144113144114144115144116144117144118144119144120144121144122144123144124144125144126144127144128144129144130144131144132144133144134144135144136144137144138144139144140144141144142144143144144144145144146144147144148144149144150144151144152144153144154144155144156144157144158144159144160144161144162144163144164144165144166144167144168144169144170144171144172144173144174144175144176144177144178144179144180144181144182144183144184144185144186144187144188144189144190144191144192144193144194144195144196144197144198144199144200144201144202144203144204144205144206144207144208144209144210144211144212144213144214144215144216144217144218144219144220144221144222144223144224144225144226144227144228144229144230144231144232144233144234144235144236144237144238144239144240144241144242144243144244144245144246144247144248144249144250144251144252144253144254144255144256144257144258144259144260144261144262144263144264144265144266144267144268144269144270144271144272144273144274144275144276144277144278144279144280144281144282144283144284144285144286144287144288144289144290144291144292144293144294144295144296144297144298144299144300144301144302144303144304144305144306144307144308144309144310144311144312144313144314144315144316144317144318144319144320144321144322144323144324144325144326144327144328144329144330144331144332144333144334144335144336144337144338144339144340144341144342144343144344144345144346144347144348144349144350144351144352144353144354144355144356144357144358144359144360144361144362144363144364144365144366144367144368144369144370144371144372144373144374144375144376144377144378144379144380144381144382144383144384144385144386144387144388144389144390144391144392144393144394144395144396144397144398144399144400144401144402144403144404144405144406144407144408144409144410144411144412144413144414144415144416144417144418144419144420144421144422144423144424144425144426144427144428144429144430144431144432144433144434144435144436144437144438144439144440144441144442144443144444144445144446144447144448144449144450144451144452144453144454144455144456144457144458144459144460144461144462144463144464144465144466144467144468144469144470144471144472144473144474144475144476144477144478144479144480144481144482144483144484144485144486144487144488144489144490144491144492144493144494144495144496144497144498144499144500144501144502144503144504144505144506144507144508144509144510144511144512144513144514144515144516144517144518144519144520144521144522144523144524144525144526144527144528144529144530144531144532144533144534144535144536144537144538144539144540144541144542144543144544144545144546144547144548144549144550144551144552144553144554144555144556144557144558144559144560144561144562144563144564144565144566144567144568144569144570144571144572144573144574144575144576144577144578144579144580144581144582144583144584144585144586144587144588144589144590144591144592144593144594144595144596144597144598144599144600144601144602144603144604144605144606144607144608144609144610144611144612144613144614144615144616144617144618144619144620144621144622144623144624144625144626144627144628144629144630144631144632144633144634144635144636144637144638144639144640144641144642144643144644144645144646144647144648144649144650144651144652144653144654144655144656144657144658144659144660144661144662144663144664144665144666144667144668144669144670144671144672144673144674144675144676144677144678144679144680144681144682144683144684144685144686144687144688144689144690144691144692144693144694144695144696144697144698144699144700144701144702144703144704144705144706144707144708144709144710144711144712144713144714144715144716144717144718144719144720144721144722144723144724144725144726144727144728144729144730144731144732144733144734144735144736144737144738144739144740144741144742144743144744144745144746144747144748144749144750144751144752144753144754144755144756144757144758144759144760144761144762144763144764144765144766144767144768144769144770144771144772144773144774144775144776144777144778144779144780144781144782144783144784144785144786144787144788144789144790144791144792144793144794144795144796144797144798144799144800144801144802144803144804144805144806144807144808144809144810144811144812144813144814144815144816144817144818144819144820144821144822144823144824144825144826144827144828144829144830144831144832144833144834144835144836144837144838144839144840144841144842144843144844144845144846144847144848144849144850144851144852144853144854144855144856144857144858144859144860144861144862144863144864144865144866144867144868144869144870144871144872144873144874144875144876144877144878144879144880144881144882144883144884144885144886144887144888144889144890144891144892144893144894144895144896144897144898144899144900144901144902144903144904144905144906144907144908144909144910144911144912144913144914144915144916144917144918144919144920144921144922144923144924144925144926144927144928144929144930144931144932144933144934144935144936144937144938144939144940144941144942144943144944144945144946144947144948144949144950144951144952144953144954144955144956144957144958144959144960144961144962144963144964144965144966144967144968144969144970144971144972144973144974144975144976144977144978144979144980144981144982144983144984144985144986144987144988144989144990144991144992144993144994144995144996144997144998144999145000145001145002145003145004145005145006145007145008145009145010145011145012145013145014145015145016145017145018145019145020145021145022145023145024145025145026145027145028145029145030145031145032145033145034145035145036145037145038145039145040145041145042145043145044145045145046145047145048145049145050145051145052145053145054145055145056145057145058145059145060145061145062145063145064145065145066145067145068145069145070145071145072145073145074145075145076145077145078145079145080145081145082145083145084145085145086145087145088145089145090145091145092145093145094145095145096145097145098145099145100145101145102145103145104145105145106145107145108145109145110145111145112145113145114145115145116145117145118145119145120145121145122145123145124145125145126145127145128145129145130145131145132145133145134145135145136145137145138145139145140145141145142145143145144145145145146145147145148145149145150145151145152145153145154145155145156145157145158145159145160145161145162145163145164145165145166145167145168145169145170145171145172145173145174145175145176145177145178145179145180145181145182145183145184145185145186145187145188145189145190145191145192145193145194145195145196145197145198145199145200145201145202145203145204145205145206145207145208145209145210145211145212145213145214145215145216145217145218145219145220145221145222145223145224145225145226145227145228145229145230145231145232145233145234145235145236145237145238145239145240145241145242145243145244145245145246145247145248145249145250145251145252145253145254145255145256145257145258145259145260145261145262145263145264145265145266145267145268145269145270145271145272145273145274145275145276145277145278145279145280145281145282145283145284145285145286145287145288145289145290145291145292145293145294145295145296145297145298145299145300145301145302145303145304145305145306145307145308145309145310145311145312145313145314145315145316145317145318145319145320145321145322145323145324145325145326145327145328145329145330145331145332145333145334145335145336145337145338145339145340145341145342145343145344145345145346145347145348145349145350145351145352145353145354145355145356145357145358145359145360145361145362145363145364145365145366145367145368145369145370145371145372145373145374145375145376145377145378145379145380145381145382145383145384145385145386145387145388145389145390145391145392145393145394145395145396145397145398145399145400145401145402145403145404145405145406145407145408145409145410145411145412145413145414145415145416145417145418145419145420145421145422145423145424145425145426145427145428145429145430145431145432145433145434145435145436145437145438145439145440145441145442145443145444145445145446145447145448145449145450145451145452145453145454145455145456145457145458145459145460145461145462145463145464145465145466145467145468145469145470145471145472145473145474145475145476145477145478145479145480145481145482145483145484145485145486145487145488145489145490145491145492145493145494145495145496145497145498145499145500145501145502145503145504145505145506145507145508145509145510145511145512145513145514145515145516145517145518145519145520145521145522145523145524145525145526145527145528145529145530145531145532145533145534145535145536145537145538145539145540145541145542145543145544145545145546145547145548145549145550145551145552145553145554145555145556145557145558145559145560145561145562145563145564145565145566145567145568145569145570145571145572145573145574145575145576145577145578145579145580145581145582145583145584145585145586145587145588145589145590145591145592145593145594145595145596145597145598145599145600145601145602145603145604145605145606145607145608145609145610145611145612145613145614145615145616145617145618145619145620145621145622145623145624145625145626145627145628145629145630145631145632145633145634145635145636145637145638145639145640145641145642145643145644145645145646145647145648145649145650145651145652145653145654145655145656145657145658145659145660145661145662145663145664145665145666145667145668145669145670145671145672145673145674145675145676145677145678145679145680145681145682145683145684145685145686145687145688145689145690145691145692145693145694145695145696145697145698145699145700145701145702145703145704145705145706145707145708145709145710145711145712145713145714145715145716145717145718145719145720145721145722145723145724145725145726145727145728145729145730145731145732145733145734145735145736145737145738145739145740145741145742145743145744145745145746145747145748145749145750145751145752145753145754145755145756145757145758145759145760145761145762145763145764145765145766145767145768145769145770145771145772145773145774145775145776145777145778145779145780145781145782145783145784145785145786145787145788145789145790145791145792145793145794145795145796145797145798145799145800145801145802145803145804145805145806145807145808145809145810145811145812145813145814145815145816145817145818145819145820145821145822145823145824145825145826145827145828145829145830145831145832145833145834145835145836145837145838145839145840145841145842145843145844145845145846145847145848145849145850145851145852145853145854145855145856145857145858145859145860145861145862145863145864145865145866145867145868145869145870145871145872145873145874145875145876145877145878145879145880145881145882145883145884145885145886145887145888145889145890145891145892145893145894145895145896145897145898145899145900145901145902145903145904145905145906145907145908145909145910145911145912145913145914145915145916145917145918145919145920145921145922145923145924145925145926145927145928145929145930145931145932145933145934145935145936145937145938145939145940145941145942145943145944145945145946145947145948145949145950145951145952145953145954145955145956145957145958145959145960145961145962145963145964145965145966145967145968145969145970145971145972145973145974145975145976145977145978145979145980145981145982145983145984145985145986145987145988145989145990145991145992145993145994145995145996145997145998145999146000146001146002146003146004146005146006146007146008146009146010146011146012146013146014146015146016146017146018146019146020146021146022146023146024146025146026146027146028146029146030146031146032146033146034146035146036146037146038146039146040146041146042146043146044146045146046146047146048146049146050146051146052146053146054146055146056146057146058146059146060146061146062146063146064146065146066146067146068146069146070146071146072146073146074146075146076146077146078146079146080146081146082146083146084146085146086146087146088146089146090146091146092146093146094146095146096146097146098146099146100146101146102146103146104146105146106146107146108146109146110146111146112146113146114146115146116146117146118146119146120146121146122146123146124146125146126146127146128146129146130146131146132146133146134146135146136146137146138146139146140146141146142146143146144146145146146146147146148146149146150146151146152146153146154146155146156146157146158146159146160146161146162146163146164146165146166146167146168146169146170146171146172146173146174146175146176146177146178146179146180146181146182146183146184146185146186146187146188146189146190146191146192146193146194146195146196146197146198146199146200146201146202146203146204146205146206146207146208146209146210146211146212146213146214146215146216146217146218146219146220146221146222146223146224146225146226146227146228146229146230146231146232146233146234146235146236146237146238146239146240146241146242146243146244146245146246146247146248146249146250146251146252146253146254146255146256146257146258146259146260146261146262146263146264146265146266146267146268146269146270146271146272146273146274146275146276146277146278146279146280146281146282146283146284146285146286146287146288146289146290146291146292146293146294146295146296146297146298146299146300146301146302146303146304146305146306146307146308146309146310146311146312146313146314146315146316146317146318146319146320146321146322146323146324146325146326146327146328146329146330146331146332146333146334146335146336146337146338146339146340146341146342146343146344146345146346146347146348146349146350146351146352146353146354146355146356146357146358146359146360146361146362146363146364146365146366146367146368146369146370146371146372146373146374146375146376146377146378146379146380146381146382146383146384146385146386146387146388146389146390146391146392146393146394146395146396146397146398146399146400146401146402146403146404146405146406146407146408146409146410146411146412146413146414146415146416146417146418146419146420146421146422146423146424146425146426146427146428146429146430146431146432146433146434146435146436146437146438146439146440146441146442146443146444146445146446146447146448146449146450146451146452146453146454146455146456146457146458146459146460146461146462146463146464146465146466146467146468146469146470146471146472146473146474146475146476146477146478146479146480146481146482146483146484146485146486146487146488146489146490146491146492146493146494146495146496146497146498146499146500146501146502146503146504146505146506146507146508146509146510146511146512146513146514146515146516146517146518146519146520146521146522146523146524146525146526146527146528146529146530146531146532146533146534146535146536146537146538146539146540146541146542146543146544146545146546146547146548146549146550146551146552146553146554146555146556146557146558146559146560146561146562146563146564146565146566146567146568146569146570146571146572146573146574146575146576146577146578146579146580146581146582146583146584146585146586146587146588146589146590146591146592146593146594146595146596146597146598146599146600146601146602146603146604146605146606146607146608146609146610146611146612146613146614146615146616146617146618146619146620146621146622146623146624146625146626146627146628146629146630146631146632146633146634146635146636146637146638146639146640146641146642146643146644146645146646146647146648146649146650146651146652146653146654146655146656146657146658146659146660146661146662146663146664146665146666146667146668146669146670146671146672146673146674146675146676146677146678146679146680146681146682146683146684146685146686146687146688146689146690146691146692146693146694146695146696146697146698146699146700146701146702146703146704146705146706146707146708146709146710146711146712146713146714146715146716146717146718146719146720146721146722146723146724146725146726146727146728146729146730146731146732146733146734146735146736146737146738146739146740146741146742146743146744146745146746146747146748146749146750146751146752146753146754146755146756146757146758146759146760146761146762146763146764146765146766146767146768146769146770146771146772146773146774146775146776146777146778146779146780146781146782146783146784146785146786146787146788146789146790146791146792146793146794146795146796146797146798146799146800146801146802146803146804146805146806146807146808146809146810146811146812146813146814146815146816146817146818146819146820146821146822146823146824146825146826146827146828146829146830146831146832146833146834146835146836146837146838146839146840146841146842146843146844146845146846146847146848146849146850146851146852146853146854146855146856146857146858146859146860146861146862146863146864146865146866146867146868146869146870146871146872146873146874146875146876146877146878146879146880146881146882146883146884146885146886146887146888146889146890146891146892146893146894146895146896146897146898146899146900146901146902146903146904146905146906146907146908146909146910146911146912146913146914146915146916146917146918146919146920146921146922146923146924146925146926146927146928146929146930146931146932146933146934146935146936146937146938146939146940146941146942146943146944146945146946146947146948146949146950146951146952146953146954146955146956146957146958146959146960146961146962146963146964146965146966146967146968146969146970146971146972146973146974146975146976146977146978146979146980146981146982146983146984146985146986146987146988146989146990146991146992146993146994146995146996146997146998146999147000147001147002147003147004147005147006147007147008147009147010147011147012147013147014147015147016147017147018147019147020147021147022147023147024147025147026147027147028147029147030147031147032147033147034147035147036147037147038147039147040147041147042147043147044147045147046147047147048147049147050147051147052147053147054147055147056147057147058147059147060147061147062147063147064147065147066147067147068147069147070147071147072147073147074147075147076147077147078147079147080147081147082147083147084147085147086147087147088147089147090147091147092147093147094147095147096147097147098147099147100147101147102147103147104147105147106147107147108147109147110147111147112147113147114147115147116147117147118147119147120147121147122147123147124147125147126147127147128147129147130147131147132147133147134147135147136147137147138147139147140147141147142147143147144147145147146147147147148147149147150147151147152147153147154147155147156147157147158147159147160147161147162147163147164147165147166147167147168147169147170147171147172147173147174147175147176147177147178147179147180147181147182147183147184147185147186147187147188147189147190147191147192147193147194147195147196147197147198147199147200147201147202147203147204147205147206147207147208147209147210147211147212147213147214147215147216147217147218147219147220147221147222147223147224147225147226147227147228147229147230147231147232147233147234147235147236147237147238147239147240147241147242147243147244147245147246147247147248147249147250147251147252147253147254147255147256147257147258147259147260147261147262147263147264147265147266147267147268147269147270147271147272147273147274147275147276147277147278147279147280147281147282147283147284147285147286147287147288147289147290147291147292147293147294147295147296147297147298147299147300147301147302147303147304147305147306147307147308147309147310147311147312147313147314147315147316147317147318147319147320147321147322147323147324147325147326147327147328147329147330147331147332147333147334147335147336147337147338147339147340147341147342147343147344147345147346147347147348147349147350147351147352147353147354147355147356147357147358147359147360147361147362147363147364147365147366147367147368147369147370147371147372147373147374147375147376147377147378147379147380147381147382147383147384147385147386147387147388147389147390147391147392147393147394147395147396147397147398147399147400147401147402147403147404147405147406147407147408147409147410147411147412147413147414147415147416147417147418147419147420147421147422147423147424147425147426147427147428147429147430147431147432147433147434147435147436147437147438147439147440147441147442147443147444147445147446147447147448147449147450147451147452147453147454147455147456147457147458147459147460147461147462147463147464147465147466147467147468147469147470147471147472147473147474147475147476147477147478147479147480147481147482147483147484147485147486147487147488147489147490147491147492147493147494147495147496147497147498147499147500147501147502147503147504147505147506147507147508147509147510147511147512147513147514147515147516147517147518147519147520147521147522147523147524147525147526147527147528147529147530147531147532147533147534147535147536147537147538147539147540147541147542147543147544147545147546147547147548147549147550147551147552147553147554147555147556147557147558147559147560147561147562147563147564147565147566147567147568147569147570147571147572147573147574147575147576147577147578147579147580147581147582147583147584147585147586147587147588147589147590147591147592147593147594147595147596147597147598147599147600147601147602147603147604147605147606147607147608147609147610147611147612147613147614147615147616147617147618147619147620147621147622147623147624147625147626147627147628147629147630147631147632147633147634147635147636147637147638147639147640147641147642147643147644147645147646147647147648147649147650147651147652147653147654147655147656147657147658147659147660147661147662147663147664147665147666147667147668147669147670147671147672147673147674147675147676147677147678147679147680147681147682147683147684147685147686147687147688147689147690147691147692147693147694147695147696147697147698147699147700147701147702147703147704147705147706147707147708147709147710147711147712147713147714147715147716147717147718147719147720147721147722147723147724147725147726147727147728147729147730147731147732147733147734147735147736147737147738147739147740147741147742147743147744147745147746147747147748147749147750147751147752147753147754147755147756147757147758147759147760147761147762147763147764147765147766147767147768147769147770147771147772147773147774147775147776147777147778147779147780147781147782147783147784147785147786147787147788147789147790147791147792147793147794147795147796147797147798147799147800147801147802147803147804147805147806147807147808147809147810147811147812147813147814147815147816147817147818147819147820147821147822147823147824147825147826147827147828147829147830147831147832147833147834147835147836147837147838147839147840147841147842147843147844147845147846147847147848147849147850147851147852147853147854147855147856147857147858147859147860147861147862147863147864147865147866147867147868147869147870147871147872147873147874147875147876147877147878147879147880147881147882147883147884147885147886147887147888147889147890147891147892147893147894147895147896147897147898147899147900147901147902147903147904147905147906147907147908147909147910147911147912147913147914147915147916147917147918147919147920147921147922147923147924147925147926147927147928147929147930147931147932147933147934147935147936147937147938147939147940147941147942147943147944147945147946147947147948147949147950147951147952147953147954147955147956147957147958147959147960147961147962147963147964147965147966147967147968147969147970147971147972147973147974147975147976147977147978147979147980147981147982147983147984147985147986147987147988147989147990147991147992147993147994147995147996147997147998147999148000148001148002148003148004148005148006148007148008148009148010148011148012148013148014148015148016148017148018148019148020148021148022148023148024148025148026148027148028148029148030148031148032148033148034148035148036148037148038148039148040148041148042148043148044148045148046148047148048148049148050148051148052148053148054148055148056148057148058148059148060148061148062148063148064148065148066148067148068148069148070148071148072148073148074148075148076148077148078148079148080148081148082148083148084148085148086148087148088148089148090148091148092148093148094148095148096148097148098148099148100148101148102148103148104148105148106148107148108148109148110148111148112148113148114148115148116148117148118148119148120148121148122148123148124148125148126148127148128148129148130148131148132148133148134148135148136148137148138148139148140148141148142148143148144148145148146148147148148148149148150148151148152148153148154148155148156148157148158148159148160148161148162148163148164148165148166148167148168148169148170148171148172148173148174148175148176148177148178148179148180148181148182148183148184148185148186148187148188148189148190148191148192148193148194148195148196148197148198148199148200148201148202148203148204148205148206148207148208148209148210148211148212148213148214148215148216148217148218148219148220148221148222148223148224148225148226148227148228148229148230148231148232148233148234148235148236148237148238148239148240148241148242148243148244148245148246148247148248148249148250148251148252148253148254148255148256148257148258148259148260148261148262148263148264148265148266148267148268148269148270148271148272148273148274148275148276148277148278148279148280148281148282148283148284148285148286148287148288148289148290148291148292148293148294148295148296148297148298148299148300148301148302148303148304148305148306148307148308148309148310148311148312148313148314148315148316148317148318148319148320148321148322148323148324148325148326148327148328148329148330148331148332148333148334148335148336148337148338148339148340148341148342148343148344148345148346148347148348148349148350148351148352148353148354148355148356148357148358148359148360148361148362148363148364148365148366148367148368148369148370148371148372148373148374148375148376148377148378148379148380148381148382148383148384148385148386148387148388148389148390148391148392148393148394148395148396148397148398148399148400148401148402148403148404148405148406148407148408148409148410148411148412148413148414148415148416148417148418148419148420148421148422148423148424148425148426148427148428148429148430148431148432148433148434148435148436148437148438148439148440148441148442148443148444148445148446148447148448148449148450148451148452148453148454148455148456148457148458148459148460148461148462148463148464148465148466148467148468148469148470148471148472148473148474148475148476148477148478148479148480148481148482148483148484148485148486148487148488148489148490148491148492148493148494148495148496148497148498148499148500148501148502148503148504148505148506148507148508148509148510148511148512148513148514148515148516148517148518148519148520148521148522148523148524148525148526148527148528148529148530148531148532148533148534148535148536148537148538148539148540148541148542148543148544148545148546148547148548148549148550148551148552148553148554148555148556148557148558148559148560148561148562148563148564148565148566148567148568148569148570148571148572148573148574148575148576148577148578148579148580148581148582148583148584148585148586148587148588148589148590148591148592148593148594148595148596148597148598148599148600148601148602148603148604148605148606148607148608148609148610148611148612148613148614148615148616148617148618148619148620148621148622148623148624148625148626148627148628148629148630148631148632148633148634148635148636148637148638148639148640148641148642148643148644148645148646148647148648148649148650148651148652148653148654148655148656148657148658148659148660148661148662148663148664148665148666148667148668148669148670148671148672148673148674148675148676148677148678148679148680148681148682148683148684148685148686148687148688148689148690148691148692148693148694148695148696148697148698148699148700148701148702148703148704148705148706148707148708148709148710148711148712148713148714148715148716148717148718148719148720148721148722148723148724148725148726148727148728148729148730148731148732148733148734148735148736148737148738148739148740148741148742148743148744148745148746148747148748148749148750148751148752148753148754148755148756148757148758148759148760148761148762148763148764148765148766148767148768148769148770148771148772148773148774148775148776148777148778148779148780148781148782148783148784148785148786148787148788148789148790148791148792148793148794148795148796148797148798148799148800148801148802148803148804148805148806148807148808148809148810148811148812148813148814148815148816148817148818148819148820148821148822148823148824148825148826148827148828148829148830148831148832148833148834148835148836148837148838148839148840148841148842148843148844148845148846148847148848148849148850148851148852148853148854148855148856148857148858148859148860148861148862148863148864148865148866148867148868148869148870148871148872148873148874148875148876148877148878148879148880148881148882148883148884148885148886148887148888148889148890148891148892148893148894148895148896148897148898148899148900148901148902148903148904148905148906148907148908148909148910148911148912148913148914148915148916148917148918148919148920148921148922148923148924148925148926148927148928148929148930148931148932148933148934148935148936148937148938148939148940148941148942148943148944148945148946148947148948148949148950148951148952148953148954148955148956148957148958148959148960148961148962148963148964148965148966148967148968148969148970148971148972148973148974148975148976148977148978148979148980148981148982148983148984148985148986148987148988148989148990148991148992148993148994148995148996148997148998148999149000149001149002149003149004149005149006149007149008149009149010149011149012149013149014149015149016149017149018149019149020149021149022149023149024149025149026149027149028149029149030149031149032149033149034149035149036149037149038149039149040149041149042149043149044149045149046149047149048149049149050149051149052149053149054149055149056149057149058149059149060149061149062149063149064149065149066149067149068149069149070149071149072149073149074149075149076149077149078149079149080149081149082149083149084149085149086149087149088149089149090149091149092149093149094149095149096149097149098149099149100149101149102149103149104149105149106149107149108149109149110149111149112149113149114149115149116149117149118149119149120149121149122149123149124149125149126149127149128149129149130149131149132149133149134149135149136149137149138149139149140149141149142149143149144149145149146149147149148149149149150149151149152149153149154149155149156149157149158149159149160149161149162149163149164149165149166149167149168149169149170149171149172149173149174149175149176149177149178149179149180149181149182149183149184149185149186149187149188149189149190149191149192149193149194149195149196149197149198149199149200149201149202149203149204149205149206149207149208149209149210149211149212149213149214149215149216149217149218149219149220149221149222149223149224149225149226149227149228149229149230149231149232149233149234149235149236149237149238149239149240149241149242149243149244149245149246149247149248149249149250149251149252149253149254149255149256149257149258149259149260149261149262149263149264149265149266149267149268149269149270149271149272149273149274149275149276149277149278149279149280149281149282149283149284149285149286149287149288149289149290149291149292149293149294149295149296149297149298149299149300149301149302149303149304149305149306149307149308149309149310149311149312149313149314149315149316149317149318149319149320149321149322149323149324149325149326149327149328149329149330149331149332149333149334149335149336149337149338149339149340149341149342149343149344149345149346149347149348149349149350149351149352149353149354149355149356149357149358149359149360149361149362149363149364149365149366149367149368149369149370149371149372149373149374149375149376149377149378149379149380149381149382149383149384149385149386149387149388149389149390149391149392149393149394149395149396149397149398149399149400149401149402149403149404149405149406149407149408149409149410149411149412149413149414149415149416149417149418149419149420149421149422149423149424149425149426149427149428149429149430149431149432149433149434149435149436149437149438149439149440149441149442149443149444149445149446149447149448149449149450149451149452149453149454149455149456149457149458149459149460149461149462149463149464149465149466149467149468149469149470149471149472149473149474149475149476149477149478149479149480149481149482149483149484149485149486149487149488149489149490149491149492149493149494149495149496149497149498149499149500149501149502149503149504149505149506149507149508149509149510149511149512149513149514149515149516149517149518149519149520149521149522149523149524149525149526149527149528149529149530149531149532149533149534149535149536149537149538149539149540149541149542149543149544149545149546149547149548149549149550149551149552149553149554149555149556149557149558149559149560149561149562149563149564149565149566149567149568149569149570149571149572149573149574149575149576149577149578149579149580149581149582149583149584149585149586149587149588149589149590149591149592149593149594149595149596149597149598149599149600149601149602149603149604149605149606149607149608149609149610149611149612149613149614149615149616149617149618149619149620149621149622149623149624149625149626149627149628149629149630149631149632149633149634149635149636149637149638149639149640149641149642149643149644149645149646149647149648149649149650149651149652149653149654149655149656149657149658149659149660149661149662149663149664149665149666149667149668149669149670149671149672149673149674149675149676149677149678149679149680149681149682149683149684149685149686149687149688149689149690149691149692149693149694149695149696149697149698149699149700149701149702149703149704149705149706149707149708149709149710149711149712149713149714149715149716149717149718149719149720149721149722149723149724149725149726149727149728149729149730149731149732149733149734149735149736149737149738149739149740149741149742149743149744149745149746149747149748149749149750149751149752149753149754149755149756149757149758149759149760149761149762149763149764149765149766149767149768149769149770149771149772149773149774149775149776149777149778149779149780149781149782149783149784149785149786149787149788149789149790149791149792149793149794149795149796149797149798149799149800149801149802149803149804149805149806149807149808149809149810149811149812149813149814149815149816149817149818149819149820149821149822149823149824149825149826149827149828149829149830149831149832149833149834149835149836149837149838149839149840149841149842149843149844149845149846149847149848149849149850149851149852149853149854149855149856149857149858149859149860149861149862149863149864149865149866149867149868149869149870149871149872149873149874149875149876149877149878149879149880149881149882149883149884149885149886149887149888149889149890149891149892149893149894149895149896149897149898149899149900149901149902149903149904149905149906149907149908149909149910149911149912149913149914149915149916149917149918149919149920149921149922149923149924149925149926149927149928149929149930149931149932149933149934149935149936149937149938149939149940149941149942149943149944149945149946149947149948149949149950149951149952149953149954149955149956149957149958149959149960149961149962149963149964149965149966149967149968149969149970149971149972149973149974149975149976149977149978149979149980149981149982149983149984149985149986149987149988149989149990149991149992149993149994149995149996149997149998149999150000150001150002150003150004150005150006150007150008150009150010150011150012150013150014150015150016150017150018150019150020150021150022150023150024150025150026150027150028150029150030150031150032150033150034150035150036150037150038150039150040150041150042150043150044150045150046150047150048150049150050150051150052150053150054150055150056150057150058150059150060150061150062150063150064150065150066150067150068150069150070150071150072150073150074150075150076150077150078150079150080150081150082150083150084150085150086150087150088150089150090150091150092150093150094150095150096150097150098150099150100150101150102150103150104150105150106150107150108150109150110150111150112150113150114150115150116150117150118150119150120150121150122150123150124150125150126150127150128150129150130150131150132150133150134150135150136150137150138150139150140150141150142150143150144150145150146150147150148150149150150150151150152150153150154150155150156150157150158150159150160150161150162150163150164150165150166150167150168150169150170150171150172150173150174150175150176150177150178150179150180150181150182150183150184150185150186150187150188150189150190150191150192150193150194150195150196150197150198150199150200150201150202150203150204150205150206150207150208150209150210150211150212150213150214150215150216150217150218150219150220150221150222150223150224150225150226150227150228150229150230150231150232150233150234150235150236150237150238150239150240150241150242150243150244150245150246150247150248150249150250150251150252150253150254150255150256150257150258150259150260150261150262150263150264150265150266150267150268150269150270150271150272150273150274150275150276150277150278150279150280150281150282150283150284150285150286150287150288150289150290150291150292150293150294150295150296150297150298150299150300150301150302150303150304150305150306150307150308150309150310150311150312150313150314150315150316150317150318150319150320150321150322150323150324150325150326150327150328150329150330150331150332150333150334150335150336150337150338150339150340150341150342150343150344150345150346150347150348150349150350150351150352150353150354150355150356150357150358150359150360150361150362150363150364150365150366150367150368150369150370150371150372150373150374150375150376150377150378150379150380150381150382150383150384150385150386150387150388150389150390150391150392150393150394150395150396150397150398150399150400150401150402150403150404150405150406150407150408150409150410150411150412150413150414150415150416150417150418150419150420150421150422150423150424150425150426150427150428150429150430150431150432150433150434150435150436150437150438150439150440150441150442150443150444150445150446150447150448150449150450150451150452150453150454150455150456150457150458150459150460150461150462150463150464150465150466150467150468150469150470150471150472150473150474150475150476150477150478150479150480150481150482150483150484150485150486150487150488150489150490150491150492150493150494150495150496150497150498150499150500150501150502150503150504150505150506150507150508150509150510150511150512150513150514150515150516150517150518150519150520150521150522150523150524150525150526150527150528150529150530150531150532150533150534150535150536150537150538150539150540150541150542150543150544150545150546150547150548150549150550150551150552150553150554150555150556150557150558150559150560150561150562150563150564150565150566150567150568150569150570150571150572150573150574150575150576150577150578150579150580150581150582150583150584150585150586150587150588150589150590150591150592150593150594150595150596150597150598150599150600150601150602150603150604150605150606150607150608150609150610150611150612150613150614150615150616150617150618150619150620150621150622150623150624150625150626150627150628150629150630150631150632150633150634150635150636150637150638150639150640150641150642150643150644150645150646150647150648150649150650150651150652150653150654150655150656150657150658150659150660150661150662150663150664150665150666150667150668150669150670150671150672150673150674150675150676150677150678150679150680150681150682150683150684150685150686150687150688150689150690150691150692150693150694150695150696150697150698150699150700150701150702150703150704150705150706150707150708150709150710150711150712150713150714150715150716150717150718150719150720150721150722150723150724150725150726150727150728150729150730150731150732150733150734150735150736150737150738150739150740150741150742150743150744150745150746150747150748150749150750150751150752150753150754150755150756150757150758150759150760150761150762150763150764150765150766150767150768150769150770150771150772150773150774150775150776150777150778150779150780150781150782150783150784150785150786150787150788150789150790150791150792150793150794150795150796150797150798150799150800150801150802150803150804150805150806150807150808150809150810150811150812150813150814150815150816150817150818150819150820150821150822150823150824150825150826150827150828150829150830150831150832150833150834150835150836150837150838150839150840150841150842150843150844150845150846150847150848150849150850150851150852150853150854150855150856150857150858150859150860150861150862150863150864150865150866150867150868150869150870150871150872150873150874150875150876150877150878150879150880150881150882150883150884150885150886150887150888150889150890150891150892150893150894150895150896150897150898150899150900150901150902150903150904150905150906150907150908150909150910150911150912150913150914150915150916150917150918150919150920150921150922150923150924150925150926150927150928150929150930150931150932150933150934150935150936150937150938150939150940150941150942150943150944150945150946150947150948150949150950150951150952150953150954150955150956150957150958150959150960150961150962150963150964150965150966150967150968150969150970150971150972150973150974150975150976150977150978150979150980150981150982150983150984150985150986150987150988150989150990150991150992150993150994150995150996150997150998150999151000151001151002151003151004151005151006151007151008151009151010151011151012151013151014151015151016151017151018151019151020151021151022151023151024151025151026151027151028151029151030151031151032151033151034151035151036151037151038151039151040151041151042151043151044151045151046151047151048151049151050151051151052151053151054151055151056151057151058151059151060151061151062151063151064151065151066151067151068151069151070151071151072151073151074151075151076151077151078151079151080151081151082151083151084151085151086151087151088151089151090151091151092151093151094151095151096151097151098151099151100151101151102151103151104151105151106151107151108151109151110151111151112151113151114151115151116151117151118151119151120151121151122151123151124151125151126151127151128151129151130151131151132151133151134151135151136151137151138151139151140151141151142151143151144151145151146151147151148151149151150151151151152151153151154151155151156151157151158151159151160151161151162151163151164151165151166151167151168151169151170151171151172151173151174151175151176151177151178151179151180151181151182151183151184151185151186151187151188151189151190151191151192151193151194151195151196151197151198151199151200151201151202151203151204151205151206151207151208151209151210151211151212151213151214151215151216151217151218151219151220151221151222151223151224151225151226151227151228151229151230151231151232151233151234151235151236151237151238151239151240151241151242151243151244151245151246151247151248151249151250151251151252151253151254151255151256151257151258151259151260151261151262151263151264151265151266151267151268151269151270151271151272151273151274151275151276151277151278151279151280151281151282151283151284151285151286151287151288151289151290151291151292151293151294151295151296151297151298151299151300151301151302151303151304151305151306151307151308151309151310151311151312151313151314151315151316151317151318151319151320151321151322151323151324151325151326151327151328151329151330151331151332151333151334151335151336151337151338151339151340151341151342151343151344151345151346151347151348151349151350151351151352151353151354151355151356151357151358151359151360151361151362151363151364151365151366151367151368151369151370151371151372151373151374151375151376151377151378151379151380151381151382151383151384151385151386151387151388151389151390151391151392151393151394151395151396151397151398151399151400151401151402151403151404151405151406151407151408151409151410151411151412151413151414151415151416151417151418151419151420151421151422151423151424151425151426151427151428151429151430151431151432151433151434151435151436151437151438151439151440151441151442151443151444151445151446151447151448151449151450151451151452151453151454151455151456151457151458151459151460151461151462151463151464151465151466151467151468151469151470151471151472151473151474151475151476151477151478151479151480151481151482151483151484151485151486151487151488151489151490151491151492151493151494151495151496151497151498151499151500151501151502151503151504151505151506151507151508151509151510151511151512151513151514151515151516151517151518151519151520151521151522151523151524151525151526151527151528151529151530151531151532151533151534151535151536151537151538151539151540151541151542151543151544151545151546151547151548151549151550151551151552151553151554151555151556151557151558151559151560151561151562151563151564151565151566151567151568151569151570151571151572151573151574151575151576151577151578151579151580151581151582151583151584151585151586151587151588151589151590151591151592151593151594151595151596151597151598151599151600151601151602151603151604151605151606151607151608151609151610151611151612151613151614151615151616151617151618151619151620151621151622151623151624151625151626151627151628151629151630151631151632151633151634151635151636151637151638151639151640151641151642151643151644151645151646151647151648151649151650151651151652151653151654151655151656151657151658151659151660151661151662151663151664151665151666151667151668151669151670151671151672151673151674151675151676151677151678151679151680151681151682151683151684151685151686151687151688151689151690151691151692151693151694151695151696151697151698151699151700151701151702151703151704151705151706151707151708151709151710151711151712151713151714151715151716151717151718151719151720151721151722151723151724151725151726151727151728151729151730151731151732151733151734151735151736151737151738151739151740151741151742151743151744151745151746151747151748151749151750151751151752151753151754151755151756151757151758151759151760151761151762151763151764151765151766151767151768151769151770151771151772151773151774151775151776151777151778151779151780151781151782151783151784151785151786151787151788151789151790151791151792151793151794151795151796151797151798151799151800151801151802151803151804151805151806151807151808151809151810151811151812151813151814151815151816151817151818151819151820151821151822151823151824151825151826151827151828151829151830151831151832151833151834151835151836151837151838151839151840151841151842151843151844151845151846151847151848151849151850151851151852151853151854151855151856151857151858151859151860151861151862151863151864151865151866151867151868151869151870151871151872151873151874151875151876151877151878151879151880151881151882151883151884151885151886151887151888151889151890151891151892151893151894151895151896151897151898151899151900151901151902151903151904151905151906151907151908151909151910151911151912151913151914151915151916151917151918151919151920151921151922151923151924151925151926151927151928151929151930151931151932151933151934151935151936151937151938151939151940151941151942151943151944151945151946151947151948151949151950151951151952151953151954151955151956151957151958151959151960151961151962151963151964151965151966151967151968151969151970151971151972151973151974151975151976151977151978151979151980151981151982151983151984151985151986151987151988151989151990151991151992151993151994151995151996151997151998151999152000152001152002152003152004152005152006152007152008152009152010152011152012152013152014152015152016152017152018152019152020152021152022152023152024152025152026152027152028152029152030152031152032152033152034152035152036152037152038152039152040152041152042152043152044152045152046152047152048152049152050152051152052152053152054152055152056152057152058152059152060152061152062152063152064152065152066152067152068152069152070152071152072152073152074152075152076152077152078152079152080152081152082152083152084152085152086152087152088152089152090152091152092152093152094152095152096152097152098152099152100152101152102152103152104152105152106152107152108152109152110152111152112152113152114152115152116152117152118152119152120152121152122152123152124152125152126152127152128152129152130152131152132152133152134152135152136152137152138152139152140152141152142152143152144152145152146152147152148152149152150152151152152152153152154152155152156152157152158152159152160152161152162152163152164152165152166152167152168152169152170152171152172152173152174152175152176152177152178152179152180152181152182152183152184152185152186152187152188152189152190152191152192152193152194152195152196152197152198152199152200152201152202152203152204152205152206152207152208152209152210152211152212152213152214152215152216152217152218152219152220152221152222152223152224152225152226152227152228152229152230152231152232152233152234152235152236152237152238152239152240152241152242152243152244152245152246152247152248152249152250152251152252152253152254152255152256152257152258152259152260152261152262152263152264152265152266152267152268152269152270152271152272152273152274152275152276152277152278152279152280152281152282152283152284152285152286152287152288152289152290152291152292152293152294152295152296152297152298152299152300152301152302152303152304152305152306152307152308152309152310152311152312152313152314152315152316152317152318152319152320152321152322152323152324152325152326152327152328152329152330152331152332152333152334152335152336152337152338152339152340152341152342152343152344152345152346152347152348152349152350152351152352152353152354152355152356152357152358152359152360152361152362152363152364152365152366152367152368152369152370152371152372152373152374152375152376152377152378152379152380152381152382152383152384152385152386152387152388152389152390152391152392152393152394152395152396152397152398152399152400152401152402152403152404152405152406152407152408152409152410152411152412152413152414152415152416152417152418152419152420152421152422152423152424152425152426152427152428152429152430152431152432152433152434152435152436152437152438152439152440152441152442152443152444152445152446152447152448152449152450152451152452152453152454152455152456152457152458152459152460152461152462152463152464152465152466152467152468152469152470152471152472152473152474152475152476152477152478152479152480152481152482152483152484152485152486152487152488152489152490152491152492152493152494152495152496152497152498152499152500152501152502152503152504152505152506152507152508152509152510152511152512152513152514152515152516152517152518152519152520152521152522152523152524152525152526152527152528152529152530152531152532152533152534152535152536152537152538152539152540152541152542152543152544152545152546152547152548152549152550152551152552152553152554152555152556152557152558152559152560152561152562152563152564152565152566152567152568152569152570152571152572152573152574152575152576152577152578152579152580152581152582152583152584152585152586152587152588152589152590152591152592152593152594152595152596152597152598152599152600152601152602152603152604152605152606152607152608152609152610152611152612152613152614152615152616152617152618152619152620152621152622152623152624152625152626152627152628152629152630152631152632152633152634152635152636152637152638152639152640152641152642152643152644152645152646152647152648152649152650152651152652152653152654152655152656152657152658152659152660152661152662152663152664152665152666152667152668152669152670152671152672152673152674152675152676152677152678152679152680152681152682152683152684152685152686152687152688152689152690152691152692152693152694152695152696152697152698152699152700152701152702152703152704152705152706152707152708152709152710152711152712152713152714152715152716152717152718152719152720152721152722152723152724152725152726152727152728152729152730152731152732152733152734152735152736152737152738152739152740152741152742152743152744152745152746152747152748152749152750152751152752152753152754152755152756152757152758152759152760152761152762152763152764152765152766152767152768152769152770152771152772152773152774152775152776152777152778152779152780152781152782152783152784152785152786152787152788152789152790152791152792152793152794152795152796152797152798152799152800152801152802152803152804152805152806152807152808152809152810152811152812152813152814152815152816152817152818152819152820152821152822152823152824152825152826152827152828152829152830152831152832152833152834152835152836152837152838152839152840152841152842152843152844152845152846152847152848152849152850152851152852152853152854152855152856152857152858152859152860152861152862152863152864152865152866152867152868152869152870152871152872152873152874152875152876152877152878152879152880152881152882152883152884152885152886152887152888152889152890152891152892152893152894152895152896152897152898152899152900152901152902152903152904152905152906152907152908152909152910152911152912152913152914152915152916152917152918152919152920152921152922152923152924152925152926152927152928152929152930152931152932152933152934152935152936152937152938152939152940152941152942152943152944152945152946152947152948152949152950152951152952152953152954152955152956152957152958152959152960152961152962152963152964152965152966152967152968152969152970152971152972152973152974152975152976152977152978152979152980152981152982152983152984152985152986152987152988152989152990152991152992152993152994152995152996152997152998152999153000153001153002153003153004153005153006153007153008153009153010153011153012153013153014153015153016153017153018153019153020153021153022153023153024153025153026153027153028153029153030153031153032153033153034153035153036153037153038153039153040153041153042153043153044153045153046153047153048153049153050153051153052153053153054153055153056153057153058153059153060153061153062153063153064153065153066153067153068153069153070153071153072153073153074153075153076153077153078153079153080153081153082153083153084153085153086153087153088153089153090153091153092153093153094153095153096153097153098153099153100153101153102153103153104153105153106153107153108153109153110153111153112153113153114153115153116153117153118153119153120153121153122153123153124153125153126153127153128153129153130153131153132153133153134153135153136153137153138153139153140153141153142153143153144153145153146153147153148153149153150153151153152153153153154153155153156153157153158153159153160153161153162153163153164153165153166153167153168153169153170153171153172153173153174153175153176153177153178153179153180153181153182153183153184153185153186153187153188153189153190153191153192153193153194153195153196153197153198153199153200153201153202153203153204153205153206153207153208153209153210153211153212153213153214153215153216153217153218153219153220153221153222153223153224153225153226153227153228153229153230153231153232153233153234153235153236153237153238153239153240153241153242153243153244153245153246153247153248153249153250153251153252153253153254153255153256153257153258153259153260153261153262153263153264153265153266153267153268153269153270153271153272153273153274153275153276153277153278153279153280153281153282153283153284153285153286153287153288153289153290153291153292153293153294153295153296153297153298153299153300153301153302153303153304153305153306153307153308153309153310153311153312153313153314153315153316153317153318153319153320153321153322153323153324153325153326153327153328153329153330153331153332153333153334153335153336153337153338153339153340153341153342153343153344153345153346153347153348153349153350153351153352153353153354153355153356153357153358153359153360153361153362153363153364153365153366153367153368153369153370153371153372153373153374153375153376153377153378153379153380153381153382153383153384153385153386153387153388153389153390153391153392153393153394153395153396153397153398153399153400153401153402153403153404153405153406153407153408153409153410153411153412153413153414153415153416153417153418153419153420153421153422153423153424153425153426153427153428153429153430153431153432153433153434153435153436153437153438153439153440153441153442153443153444153445153446153447153448153449153450153451153452153453153454153455153456153457153458153459153460153461153462153463153464153465153466153467153468153469153470153471153472153473153474153475153476153477153478153479153480153481153482153483153484153485153486153487153488153489153490153491153492153493153494153495153496153497153498153499153500153501153502153503153504153505153506153507153508153509153510153511153512153513153514153515153516153517153518153519153520153521153522153523153524153525153526153527153528153529153530153531153532153533153534153535153536153537153538153539153540153541153542153543153544153545153546153547153548153549153550153551153552153553153554153555153556153557153558153559153560153561153562153563153564153565153566153567153568153569153570153571153572153573153574153575153576153577153578153579153580153581153582153583153584153585153586153587153588153589153590153591153592153593153594153595153596153597153598153599153600153601153602153603153604153605153606153607153608153609153610153611153612153613153614153615153616153617153618153619153620153621153622153623153624153625153626153627153628153629153630153631153632153633153634153635153636153637153638153639153640153641153642153643153644153645153646153647153648153649153650153651153652153653153654153655153656153657153658153659153660153661153662153663153664153665153666153667153668153669153670153671153672153673153674153675153676153677153678153679153680153681153682153683153684153685153686153687153688153689153690153691153692153693153694153695153696153697153698153699153700153701153702153703153704153705153706153707153708153709153710153711153712153713153714153715153716153717153718153719153720153721153722153723153724153725153726153727153728153729153730153731153732153733153734153735153736153737153738153739153740153741153742153743153744153745153746153747153748153749153750153751153752153753153754153755153756153757153758153759153760153761153762153763153764153765153766153767153768153769153770153771153772153773153774153775153776153777153778153779153780153781153782153783153784153785153786153787153788153789153790153791153792153793153794153795153796153797153798153799153800153801153802153803153804153805153806153807153808153809153810153811153812153813153814153815153816153817153818153819153820153821153822153823153824153825153826153827153828153829153830153831153832153833153834153835153836153837153838153839153840153841153842153843153844153845153846153847153848153849153850153851153852153853153854153855153856153857153858153859153860153861153862153863153864153865153866153867153868153869153870153871153872153873153874153875153876153877153878153879153880153881153882153883153884153885153886153887153888153889153890153891153892153893153894153895153896153897153898153899153900153901153902153903153904153905153906153907153908153909153910153911153912153913153914153915153916153917153918153919153920153921153922153923153924153925153926153927153928153929153930153931153932153933153934153935153936153937153938153939153940153941153942153943153944153945153946153947153948153949153950153951153952153953153954153955153956153957153958153959153960153961153962153963153964153965153966153967153968153969153970153971153972153973153974153975153976153977153978153979153980153981153982153983153984153985153986153987153988153989153990153991153992153993153994153995153996153997153998153999154000154001154002154003154004154005154006154007154008154009154010154011154012154013154014154015154016154017154018154019154020154021154022154023154024154025154026154027154028154029154030154031154032154033154034154035154036154037154038154039154040154041154042154043154044154045154046154047154048154049154050154051154052154053154054154055154056154057154058154059154060154061154062154063154064154065154066154067154068154069154070154071154072154073154074154075154076154077154078154079154080154081154082154083154084154085154086154087154088154089154090154091154092154093154094154095154096154097154098154099154100154101154102154103154104154105154106154107154108154109154110154111154112154113154114154115154116154117154118154119154120154121154122154123154124154125154126154127154128154129154130154131154132154133154134154135154136154137154138154139154140154141154142154143154144154145154146154147154148154149154150154151154152154153154154154155154156154157154158154159154160154161154162154163154164154165154166154167154168154169154170154171154172154173154174154175154176154177154178154179154180154181154182154183154184154185154186154187154188154189154190154191154192154193154194154195154196154197154198154199154200154201154202154203154204154205154206154207154208154209154210154211154212154213154214154215154216154217154218154219154220154221154222154223154224154225154226154227154228154229154230154231154232154233154234154235154236154237154238154239154240154241154242154243154244154245154246154247154248154249154250154251154252154253154254154255154256154257154258154259154260154261154262154263154264154265154266154267154268154269154270154271154272154273154274154275154276154277154278154279154280154281154282154283154284154285154286154287154288154289154290154291154292154293154294154295154296154297154298154299154300154301154302154303154304154305154306154307154308154309154310154311154312154313154314154315154316154317154318154319154320154321154322154323154324154325154326154327154328154329154330154331154332154333154334154335154336154337154338154339154340154341154342154343154344154345154346154347154348154349154350154351154352154353154354154355154356154357154358154359154360154361154362154363154364154365154366154367154368154369154370154371154372154373154374154375154376154377154378154379154380154381154382154383154384154385154386154387154388154389154390154391154392154393154394154395154396154397154398154399154400154401154402154403154404154405154406154407154408154409154410154411154412154413154414154415154416154417154418154419154420154421154422154423154424154425154426154427154428154429154430154431154432154433154434154435154436154437154438154439154440154441154442154443154444154445154446154447154448154449154450154451154452154453154454154455154456154457154458154459154460154461154462154463154464154465154466154467154468154469154470154471154472154473154474154475154476154477154478154479154480154481154482154483154484154485154486154487154488154489154490154491154492154493154494154495154496154497154498154499154500154501154502154503154504154505154506154507154508154509154510154511154512154513154514154515154516154517154518154519154520154521154522154523154524154525154526154527154528154529154530154531154532154533154534154535154536154537154538154539154540154541154542154543154544154545154546154547154548154549154550154551154552154553154554154555154556154557154558154559154560154561154562154563154564154565154566154567154568154569154570154571154572154573154574154575154576154577154578154579154580154581154582154583154584154585154586154587154588154589154590154591154592154593154594154595154596154597154598154599154600154601154602154603154604154605154606154607154608154609154610154611154612154613154614154615154616154617154618154619154620154621154622154623154624154625154626154627154628154629154630154631154632154633154634154635154636154637154638154639154640154641154642154643154644154645154646154647154648154649154650154651154652154653154654154655154656154657154658154659154660154661154662154663154664154665154666154667154668154669154670154671154672154673154674154675154676154677154678154679154680154681154682154683154684154685154686154687154688154689154690154691154692154693154694154695154696154697154698154699154700154701154702154703154704154705154706154707154708154709154710154711154712154713154714154715154716154717154718154719154720154721154722154723154724154725154726154727154728154729154730154731154732154733154734154735154736154737154738154739154740154741154742154743154744154745154746154747154748154749154750154751154752154753154754154755154756154757154758154759154760154761154762154763154764154765154766154767154768154769154770154771154772154773154774154775154776154777154778154779154780154781154782154783154784154785154786154787154788154789154790154791154792154793154794154795154796154797154798154799154800154801154802154803154804154805154806154807154808154809154810154811154812154813154814154815154816154817154818154819154820154821154822154823154824154825154826154827154828154829154830154831154832154833154834154835154836154837154838154839154840154841154842154843154844154845154846154847154848154849154850154851154852154853154854154855154856154857154858154859154860154861154862154863154864154865154866154867154868154869154870154871154872154873154874154875154876154877154878154879154880154881154882154883154884154885154886154887154888154889154890154891154892154893154894154895154896154897154898154899154900154901154902154903154904154905154906154907154908154909154910154911154912154913154914154915154916154917154918154919154920154921154922154923154924154925154926154927154928154929154930154931154932154933154934154935154936154937154938154939154940154941154942154943154944154945154946154947154948154949154950154951154952154953154954154955154956154957154958154959154960154961154962154963154964154965154966154967154968154969154970154971154972154973154974154975154976154977154978154979154980154981154982154983154984154985154986154987154988154989154990154991154992154993154994154995154996154997154998154999155000155001155002155003155004155005155006155007155008155009155010155011155012155013155014155015155016155017155018155019155020155021155022155023155024155025155026155027155028155029155030155031155032155033155034155035155036155037155038155039155040155041155042155043155044155045155046155047155048155049155050155051155052155053155054155055155056155057155058155059155060155061155062155063155064155065155066155067155068155069155070155071155072155073155074155075155076155077155078155079155080155081155082155083155084155085155086155087155088155089155090155091155092155093155094155095155096155097155098155099155100155101155102155103155104155105155106155107155108155109155110155111155112155113155114155115155116155117155118155119155120155121155122155123155124155125155126155127155128155129155130155131155132155133155134155135155136155137155138155139155140155141155142155143155144155145155146155147155148155149155150155151155152155153155154155155155156155157155158155159155160155161155162155163155164155165155166155167155168155169155170155171155172155173155174155175155176155177155178155179155180155181155182155183155184155185155186155187155188155189155190155191155192155193155194155195155196155197155198155199155200155201155202155203155204155205155206155207155208155209155210155211155212155213155214155215155216155217155218155219155220155221155222
  1. declare module "babylonjs/types" {
  2. /** Alias type for value that can be null */
  3. export type Nullable<T> = T | null;
  4. /**
  5. * Alias type for number that are floats
  6. * @ignorenaming
  7. */
  8. export type float = number;
  9. /**
  10. * Alias type for number that are doubles.
  11. * @ignorenaming
  12. */
  13. export type double = number;
  14. /**
  15. * Alias type for number that are integer
  16. * @ignorenaming
  17. */
  18. export type int = number;
  19. /** Alias type for number array or Float32Array */
  20. export type FloatArray = number[] | Float32Array;
  21. /** Alias type for number array or Float32Array or Int32Array or Uint32Array or Uint16Array */
  22. export type IndicesArray = number[] | Int32Array | Uint32Array | Uint16Array;
  23. /**
  24. * Alias for types that can be used by a Buffer or VertexBuffer.
  25. */
  26. export type DataArray = number[] | ArrayBuffer | ArrayBufferView;
  27. /**
  28. * Alias type for primitive types
  29. * @ignorenaming
  30. */
  31. type Primitive = undefined | null | boolean | string | number | Function;
  32. /**
  33. * Type modifier to make all the properties of an object Readonly
  34. */
  35. export type Immutable<T> = T extends Primitive ? T : T extends Array<infer U> ? ReadonlyArray<U> : DeepImmutable<T>;
  36. /**
  37. * Type modifier to make all the properties of an object Readonly recursively
  38. */
  39. export type DeepImmutable<T> = T extends Primitive ? T : T extends Array<infer U> ? DeepImmutableArray<U> : DeepImmutableObject<T>;
  40. /**
  41. * Type modifier to make object properties readonly.
  42. */
  43. export type DeepImmutableObject<T> = {
  44. readonly [K in keyof T]: DeepImmutable<T[K]>;
  45. };
  46. /** @hidden */
  47. interface DeepImmutableArray<T> extends ReadonlyArray<DeepImmutable<T>> {
  48. }
  49. }
  50. declare module "babylonjs/Misc/observable" {
  51. import { Nullable } from "babylonjs/types";
  52. /**
  53. * A class serves as a medium between the observable and its observers
  54. */
  55. export class EventState {
  56. /**
  57. * Create a new EventState
  58. * @param mask defines the mask associated with this state
  59. * @param skipNextObservers defines a flag which will instruct the observable to skip following observers when set to true
  60. * @param target defines the original target of the state
  61. * @param currentTarget defines the current target of the state
  62. */
  63. constructor(mask: number, skipNextObservers?: boolean, target?: any, currentTarget?: any);
  64. /**
  65. * Initialize the current event state
  66. * @param mask defines the mask associated with this state
  67. * @param skipNextObservers defines a flag which will instruct the observable to skip following observers when set to true
  68. * @param target defines the original target of the state
  69. * @param currentTarget defines the current target of the state
  70. * @returns the current event state
  71. */
  72. initalize(mask: number, skipNextObservers?: boolean, target?: any, currentTarget?: any): EventState;
  73. /**
  74. * An Observer can set this property to true to prevent subsequent observers of being notified
  75. */
  76. skipNextObservers: boolean;
  77. /**
  78. * Get the mask value that were used to trigger the event corresponding to this EventState object
  79. */
  80. mask: number;
  81. /**
  82. * The object that originally notified the event
  83. */
  84. target?: any;
  85. /**
  86. * The current object in the bubbling phase
  87. */
  88. currentTarget?: any;
  89. /**
  90. * This will be populated with the return value of the last function that was executed.
  91. * If it is the first function in the callback chain it will be the event data.
  92. */
  93. lastReturnValue?: any;
  94. }
  95. /**
  96. * Represent an Observer registered to a given Observable object.
  97. */
  98. export class Observer<T> {
  99. /**
  100. * Defines the callback to call when the observer is notified
  101. */
  102. callback: (eventData: T, eventState: EventState) => void;
  103. /**
  104. * Defines the mask of the observer (used to filter notifications)
  105. */
  106. mask: number;
  107. /**
  108. * Defines the current scope used to restore the JS context
  109. */
  110. scope: any;
  111. /** @hidden */
  112. _willBeUnregistered: boolean;
  113. /**
  114. * Gets or sets a property defining that the observer as to be unregistered after the next notification
  115. */
  116. unregisterOnNextCall: boolean;
  117. /**
  118. * Creates a new observer
  119. * @param callback defines the callback to call when the observer is notified
  120. * @param mask defines the mask of the observer (used to filter notifications)
  121. * @param scope defines the current scope used to restore the JS context
  122. */
  123. constructor(
  124. /**
  125. * Defines the callback to call when the observer is notified
  126. */
  127. callback: (eventData: T, eventState: EventState) => void,
  128. /**
  129. * Defines the mask of the observer (used to filter notifications)
  130. */
  131. mask: number,
  132. /**
  133. * Defines the current scope used to restore the JS context
  134. */
  135. scope?: any);
  136. }
  137. /**
  138. * Represent a list of observers registered to multiple Observables object.
  139. */
  140. export class MultiObserver<T> {
  141. private _observers;
  142. private _observables;
  143. /**
  144. * Release associated resources
  145. */
  146. dispose(): void;
  147. /**
  148. * Raise a callback when one of the observable will notify
  149. * @param observables defines a list of observables to watch
  150. * @param callback defines the callback to call on notification
  151. * @param mask defines the mask used to filter notifications
  152. * @param scope defines the current scope used to restore the JS context
  153. * @returns the new MultiObserver
  154. */
  155. static Watch<T>(observables: Observable<T>[], callback: (eventData: T, eventState: EventState) => void, mask?: number, scope?: any): MultiObserver<T>;
  156. }
  157. /**
  158. * The Observable class is a simple implementation of the Observable pattern.
  159. *
  160. * There's one slight particularity though: a given Observable can notify its observer using a particular mask value, only the Observers registered with this mask value will be notified.
  161. * This enable a more fine grained execution without having to rely on multiple different Observable objects.
  162. * For instance you may have a given Observable that have four different types of notifications: Move (mask = 0x01), Stop (mask = 0x02), Turn Right (mask = 0X04), Turn Left (mask = 0X08).
  163. * A given observer can register itself with only Move and Stop (mask = 0x03), then it will only be notified when one of these two occurs and will never be for Turn Left/Right.
  164. */
  165. export class Observable<T> {
  166. private _observers;
  167. private _eventState;
  168. private _onObserverAdded;
  169. /**
  170. * Gets the list of observers
  171. */
  172. get observers(): Array<Observer<T>>;
  173. /**
  174. * Creates a new observable
  175. * @param onObserverAdded defines a callback to call when a new observer is added
  176. */
  177. constructor(onObserverAdded?: (observer: Observer<T>) => void);
  178. /**
  179. * Create a new Observer with the specified callback
  180. * @param callback the callback that will be executed for that Observer
  181. * @param mask the mask used to filter observers
  182. * @param insertFirst if true the callback will be inserted at the first position, hence executed before the others ones. If false (default behavior) the callback will be inserted at the last position, executed after all the others already present.
  183. * @param scope optional scope for the callback to be called from
  184. * @param unregisterOnFirstCall defines if the observer as to be unregistered after the next notification
  185. * @returns the new observer created for the callback
  186. */
  187. add(callback: (eventData: T, eventState: EventState) => void, mask?: number, insertFirst?: boolean, scope?: any, unregisterOnFirstCall?: boolean): Nullable<Observer<T>>;
  188. /**
  189. * Create a new Observer with the specified callback and unregisters after the next notification
  190. * @param callback the callback that will be executed for that Observer
  191. * @returns the new observer created for the callback
  192. */
  193. addOnce(callback: (eventData: T, eventState: EventState) => void): Nullable<Observer<T>>;
  194. /**
  195. * Remove an Observer from the Observable object
  196. * @param observer the instance of the Observer to remove
  197. * @returns false if it doesn't belong to this Observable
  198. */
  199. remove(observer: Nullable<Observer<T>>): boolean;
  200. /**
  201. * Remove a callback from the Observable object
  202. * @param callback the callback to remove
  203. * @param scope optional scope. If used only the callbacks with this scope will be removed
  204. * @returns false if it doesn't belong to this Observable
  205. */
  206. removeCallback(callback: (eventData: T, eventState: EventState) => void, scope?: any): boolean;
  207. private _deferUnregister;
  208. private _remove;
  209. /**
  210. * Moves the observable to the top of the observer list making it get called first when notified
  211. * @param observer the observer to move
  212. */
  213. makeObserverTopPriority(observer: Observer<T>): void;
  214. /**
  215. * Moves the observable to the bottom of the observer list making it get called last when notified
  216. * @param observer the observer to move
  217. */
  218. makeObserverBottomPriority(observer: Observer<T>): void;
  219. /**
  220. * Notify all Observers by calling their respective callback with the given data
  221. * Will return true if all observers were executed, false if an observer set skipNextObservers to true, then prevent the subsequent ones to execute
  222. * @param eventData defines the data to send to all observers
  223. * @param mask defines the mask of the current notification (observers with incompatible mask (ie mask & observer.mask === 0) will not be notified)
  224. * @param target defines the original target of the state
  225. * @param currentTarget defines the current target of the state
  226. * @returns false if the complete observer chain was not processed (because one observer set the skipNextObservers to true)
  227. */
  228. notifyObservers(eventData: T, mask?: number, target?: any, currentTarget?: any): boolean;
  229. /**
  230. * Calling this will execute each callback, expecting it to be a promise or return a value.
  231. * If at any point in the chain one function fails, the promise will fail and the execution will not continue.
  232. * This is useful when a chain of events (sometimes async events) is needed to initialize a certain object
  233. * and it is crucial that all callbacks will be executed.
  234. * The order of the callbacks is kept, callbacks are not executed parallel.
  235. *
  236. * @param eventData The data to be sent to each callback
  237. * @param mask is used to filter observers defaults to -1
  238. * @param target defines the callback target (see EventState)
  239. * @param currentTarget defines he current object in the bubbling phase
  240. * @returns {Promise<T>} will return a Promise than resolves when all callbacks executed successfully.
  241. */
  242. notifyObserversWithPromise(eventData: T, mask?: number, target?: any, currentTarget?: any): Promise<T>;
  243. /**
  244. * Notify a specific observer
  245. * @param observer defines the observer to notify
  246. * @param eventData defines the data to be sent to each callback
  247. * @param mask is used to filter observers defaults to -1
  248. */
  249. notifyObserver(observer: Observer<T>, eventData: T, mask?: number): void;
  250. /**
  251. * Gets a boolean indicating if the observable has at least one observer
  252. * @returns true is the Observable has at least one Observer registered
  253. */
  254. hasObservers(): boolean;
  255. /**
  256. * Clear the list of observers
  257. */
  258. clear(): void;
  259. /**
  260. * Clone the current observable
  261. * @returns a new observable
  262. */
  263. clone(): Observable<T>;
  264. /**
  265. * Does this observable handles observer registered with a given mask
  266. * @param mask defines the mask to be tested
  267. * @return whether or not one observer registered with the given mask is handeled
  268. **/
  269. hasSpecificMask(mask?: number): boolean;
  270. }
  271. }
  272. declare module "babylonjs/Misc/domManagement" {
  273. /**
  274. * Sets of helpers dealing with the DOM and some of the recurrent functions needed in
  275. * Babylon.js
  276. */
  277. export class DomManagement {
  278. /**
  279. * Checks if the window object exists
  280. * @returns true if the window object exists
  281. */
  282. static IsWindowObjectExist(): boolean;
  283. /**
  284. * Checks if the navigator object exists
  285. * @returns true if the navigator object exists
  286. */
  287. static IsNavigatorAvailable(): boolean;
  288. /**
  289. * Check if the document object exists
  290. * @returns true if the document object exists
  291. */
  292. static IsDocumentAvailable(): boolean;
  293. /**
  294. * Extracts text content from a DOM element hierarchy
  295. * @param element defines the root element
  296. * @returns a string
  297. */
  298. static GetDOMTextContent(element: HTMLElement): string;
  299. }
  300. }
  301. declare module "babylonjs/Misc/logger" {
  302. /**
  303. * Logger used througouht the application to allow configuration of
  304. * the log level required for the messages.
  305. */
  306. export class Logger {
  307. /**
  308. * No log
  309. */
  310. static readonly NoneLogLevel: number;
  311. /**
  312. * Only message logs
  313. */
  314. static readonly MessageLogLevel: number;
  315. /**
  316. * Only warning logs
  317. */
  318. static readonly WarningLogLevel: number;
  319. /**
  320. * Only error logs
  321. */
  322. static readonly ErrorLogLevel: number;
  323. /**
  324. * All logs
  325. */
  326. static readonly AllLogLevel: number;
  327. private static _LogCache;
  328. /**
  329. * Gets a value indicating the number of loading errors
  330. * @ignorenaming
  331. */
  332. static errorsCount: number;
  333. /**
  334. * Callback called when a new log is added
  335. */
  336. static OnNewCacheEntry: (entry: string) => void;
  337. private static _AddLogEntry;
  338. private static _FormatMessage;
  339. private static _LogDisabled;
  340. private static _LogEnabled;
  341. private static _WarnDisabled;
  342. private static _WarnEnabled;
  343. private static _ErrorDisabled;
  344. private static _ErrorEnabled;
  345. /**
  346. * Log a message to the console
  347. */
  348. static Log: (message: string) => void;
  349. /**
  350. * Write a warning message to the console
  351. */
  352. static Warn: (message: string) => void;
  353. /**
  354. * Write an error message to the console
  355. */
  356. static Error: (message: string) => void;
  357. /**
  358. * Gets current log cache (list of logs)
  359. */
  360. static get LogCache(): string;
  361. /**
  362. * Clears the log cache
  363. */
  364. static ClearLogCache(): void;
  365. /**
  366. * Sets the current log level (MessageLogLevel / WarningLogLevel / ErrorLogLevel)
  367. */
  368. static set LogLevels(level: number);
  369. }
  370. }
  371. declare module "babylonjs/Misc/typeStore" {
  372. /** @hidden */
  373. export class _TypeStore {
  374. /** @hidden */
  375. static RegisteredTypes: {
  376. [key: string]: Object;
  377. };
  378. /** @hidden */
  379. static GetClass(fqdn: string): any;
  380. }
  381. }
  382. declare module "babylonjs/Misc/stringTools" {
  383. /**
  384. * Helper to manipulate strings
  385. */
  386. export class StringTools {
  387. /**
  388. * Checks for a matching suffix at the end of a string (for ES5 and lower)
  389. * @param str Source string
  390. * @param suffix Suffix to search for in the source string
  391. * @returns Boolean indicating whether the suffix was found (true) or not (false)
  392. */
  393. static EndsWith(str: string, suffix: string): boolean;
  394. /**
  395. * Checks for a matching suffix at the beginning of a string (for ES5 and lower)
  396. * @param str Source string
  397. * @param suffix Suffix to search for in the source string
  398. * @returns Boolean indicating whether the suffix was found (true) or not (false)
  399. */
  400. static StartsWith(str: string, suffix: string): boolean;
  401. /**
  402. * Decodes a buffer into a string
  403. * @param buffer The buffer to decode
  404. * @returns The decoded string
  405. */
  406. static Decode(buffer: Uint8Array | Uint16Array): string;
  407. /**
  408. * Encode a buffer to a base64 string
  409. * @param buffer defines the buffer to encode
  410. * @returns the encoded string
  411. */
  412. static EncodeArrayBufferToBase64(buffer: ArrayBuffer | ArrayBufferView): string;
  413. /**
  414. * Converts a number to string and pads with preceeding zeroes until it is of specified length.
  415. * @param num the number to convert and pad
  416. * @param length the expected length of the string
  417. * @returns the padded string
  418. */
  419. static PadNumber(num: number, length: number): string;
  420. }
  421. }
  422. declare module "babylonjs/Misc/deepCopier" {
  423. /**
  424. * Class containing a set of static utilities functions for deep copy.
  425. */
  426. export class DeepCopier {
  427. /**
  428. * Tries to copy an object by duplicating every property
  429. * @param source defines the source object
  430. * @param destination defines the target object
  431. * @param doNotCopyList defines a list of properties to avoid
  432. * @param mustCopyList defines a list of properties to copy (even if they start with _)
  433. */
  434. static DeepCopy(source: any, destination: any, doNotCopyList?: string[], mustCopyList?: string[]): void;
  435. }
  436. }
  437. declare module "babylonjs/Misc/precisionDate" {
  438. /**
  439. * Class containing a set of static utilities functions for precision date
  440. */
  441. export class PrecisionDate {
  442. /**
  443. * Gets either window.performance.now() if supported or Date.now() else
  444. */
  445. static get Now(): number;
  446. }
  447. }
  448. declare module "babylonjs/Misc/devTools" {
  449. /** @hidden */
  450. export class _DevTools {
  451. static WarnImport(name: string): string;
  452. }
  453. }
  454. declare module "babylonjs/Misc/interfaces/iWebRequest" {
  455. /**
  456. * Interface used to define the mechanism to get data from the network
  457. */
  458. export interface IWebRequest {
  459. /**
  460. * Returns client's response url
  461. */
  462. responseURL: string;
  463. /**
  464. * Returns client's status
  465. */
  466. status: number;
  467. /**
  468. * Returns client's status as a text
  469. */
  470. statusText: string;
  471. }
  472. }
  473. declare module "babylonjs/Misc/webRequest" {
  474. import { IWebRequest } from "babylonjs/Misc/interfaces/iWebRequest";
  475. import { Nullable } from "babylonjs/types";
  476. /**
  477. * Extended version of XMLHttpRequest with support for customizations (headers, ...)
  478. */
  479. export class WebRequest implements IWebRequest {
  480. private _xhr;
  481. /**
  482. * Custom HTTP Request Headers to be sent with XMLHttpRequests
  483. * i.e. when loading files, where the server/service expects an Authorization header
  484. */
  485. static CustomRequestHeaders: {
  486. [key: string]: string;
  487. };
  488. /**
  489. * Add callback functions in this array to update all the requests before they get sent to the network
  490. */
  491. static CustomRequestModifiers: ((request: XMLHttpRequest, url: string) => void)[];
  492. private _injectCustomRequestHeaders;
  493. /**
  494. * Gets or sets a function to be called when loading progress changes
  495. */
  496. get onprogress(): ((this: XMLHttpRequest, ev: ProgressEvent) => any) | null;
  497. set onprogress(value: ((this: XMLHttpRequest, ev: ProgressEvent) => any) | null);
  498. /**
  499. * Returns client's state
  500. */
  501. get readyState(): number;
  502. /**
  503. * Returns client's status
  504. */
  505. get status(): number;
  506. /**
  507. * Returns client's status as a text
  508. */
  509. get statusText(): string;
  510. /**
  511. * Returns client's response
  512. */
  513. get response(): any;
  514. /**
  515. * Returns client's response url
  516. */
  517. get responseURL(): string;
  518. /**
  519. * Returns client's response as text
  520. */
  521. get responseText(): string;
  522. /**
  523. * Gets or sets the expected response type
  524. */
  525. get responseType(): XMLHttpRequestResponseType;
  526. set responseType(value: XMLHttpRequestResponseType);
  527. /** @hidden */
  528. addEventListener<K extends keyof XMLHttpRequestEventMap>(type: K, listener: (this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
  529. /** @hidden */
  530. removeEventListener<K extends keyof XMLHttpRequestEventMap>(type: K, listener: (this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
  531. /**
  532. * Cancels any network activity
  533. */
  534. abort(): void;
  535. /**
  536. * Initiates the request. The optional argument provides the request body. The argument is ignored if request method is GET or HEAD
  537. * @param body defines an optional request body
  538. */
  539. send(body?: Document | BodyInit | null): void;
  540. /**
  541. * Sets the request method, request URL
  542. * @param method defines the method to use (GET, POST, etc..)
  543. * @param url defines the url to connect with
  544. */
  545. open(method: string, url: string): void;
  546. /**
  547. * Sets the value of a request header.
  548. * @param name The name of the header whose value is to be set
  549. * @param value The value to set as the body of the header
  550. */
  551. setRequestHeader(name: string, value: string): void;
  552. /**
  553. * Get the string containing the text of a particular header's value.
  554. * @param name The name of the header
  555. * @returns The string containing the text of the given header name
  556. */
  557. getResponseHeader(name: string): Nullable<string>;
  558. }
  559. }
  560. declare module "babylonjs/Misc/fileRequest" {
  561. import { Observable } from "babylonjs/Misc/observable";
  562. /**
  563. * File request interface
  564. */
  565. export interface IFileRequest {
  566. /**
  567. * Raised when the request is complete (success or error).
  568. */
  569. onCompleteObservable: Observable<IFileRequest>;
  570. /**
  571. * Aborts the request for a file.
  572. */
  573. abort: () => void;
  574. }
  575. }
  576. declare module "babylonjs/Materials/Textures/renderTargetCreationOptions" {
  577. /**
  578. * Define options used to create a render target texture
  579. */
  580. export class RenderTargetCreationOptions {
  581. /**
  582. * Specifies is mipmaps must be generated
  583. */
  584. generateMipMaps?: boolean;
  585. /** Specifies whether or not a depth should be allocated in the texture (true by default) */
  586. generateDepthBuffer?: boolean;
  587. /** Specifies whether or not a stencil should be allocated in the texture (false by default)*/
  588. generateStencilBuffer?: boolean;
  589. /** Defines texture type (int by default) */
  590. type?: number;
  591. /** Defines sampling mode (trilinear by default) */
  592. samplingMode?: number;
  593. /** Defines format (RGBA by default) */
  594. format?: number;
  595. }
  596. }
  597. declare module "babylonjs/Engines/constants" {
  598. /** Defines the cross module used constants to avoid circular dependncies */
  599. export class Constants {
  600. /** Defines that alpha blending is disabled */
  601. static readonly ALPHA_DISABLE: number;
  602. /** Defines that alpha blending is SRC ALPHA * SRC + DEST */
  603. static readonly ALPHA_ADD: number;
  604. /** Defines that alpha blending is SRC ALPHA * SRC + (1 - SRC ALPHA) * DEST */
  605. static readonly ALPHA_COMBINE: number;
  606. /** Defines that alpha blending is DEST - SRC * DEST */
  607. static readonly ALPHA_SUBTRACT: number;
  608. /** Defines that alpha blending is SRC * DEST */
  609. static readonly ALPHA_MULTIPLY: number;
  610. /** Defines that alpha blending is SRC ALPHA * SRC + (1 - SRC) * DEST */
  611. static readonly ALPHA_MAXIMIZED: number;
  612. /** Defines that alpha blending is SRC + DEST */
  613. static readonly ALPHA_ONEONE: number;
  614. /** Defines that alpha blending is SRC + (1 - SRC ALPHA) * DEST */
  615. static readonly ALPHA_PREMULTIPLIED: number;
  616. /**
  617. * Defines that alpha blending is SRC + (1 - SRC ALPHA) * DEST
  618. * Alpha will be set to (1 - SRC ALPHA) * DEST ALPHA
  619. */
  620. static readonly ALPHA_PREMULTIPLIED_PORTERDUFF: number;
  621. /** Defines that alpha blending is CST * SRC + (1 - CST) * DEST */
  622. static readonly ALPHA_INTERPOLATE: number;
  623. /**
  624. * Defines that alpha blending is SRC + (1 - SRC) * DEST
  625. * Alpha will be set to SRC ALPHA + (1 - SRC ALPHA) * DEST ALPHA
  626. */
  627. static readonly ALPHA_SCREENMODE: number;
  628. /**
  629. * Defines that alpha blending is SRC + DST
  630. * Alpha will be set to SRC ALPHA + DST ALPHA
  631. */
  632. static readonly ALPHA_ONEONE_ONEONE: number;
  633. /**
  634. * Defines that alpha blending is SRC * DST ALPHA + DST
  635. * Alpha will be set to 0
  636. */
  637. static readonly ALPHA_ALPHATOCOLOR: number;
  638. /**
  639. * Defines that alpha blending is SRC * (1 - DST) + DST * (1 - SRC)
  640. */
  641. static readonly ALPHA_REVERSEONEMINUS: number;
  642. /**
  643. * Defines that alpha blending is SRC + DST * (1 - SRC ALPHA)
  644. * Alpha will be set to SRC ALPHA + DST ALPHA * (1 - SRC ALPHA)
  645. */
  646. static readonly ALPHA_SRC_DSTONEMINUSSRCALPHA: number;
  647. /**
  648. * Defines that alpha blending is SRC + DST
  649. * Alpha will be set to SRC ALPHA
  650. */
  651. static readonly ALPHA_ONEONE_ONEZERO: number;
  652. /**
  653. * Defines that alpha blending is SRC * (1 - DST) + DST * (1 - SRC)
  654. * Alpha will be set to DST ALPHA
  655. */
  656. static readonly ALPHA_EXCLUSION: number;
  657. /** Defines that alpha blending equation a SUM */
  658. static readonly ALPHA_EQUATION_ADD: number;
  659. /** Defines that alpha blending equation a SUBSTRACTION */
  660. static readonly ALPHA_EQUATION_SUBSTRACT: number;
  661. /** Defines that alpha blending equation a REVERSE SUBSTRACTION */
  662. static readonly ALPHA_EQUATION_REVERSE_SUBTRACT: number;
  663. /** Defines that alpha blending equation a MAX operation */
  664. static readonly ALPHA_EQUATION_MAX: number;
  665. /** Defines that alpha blending equation a MIN operation */
  666. static readonly ALPHA_EQUATION_MIN: number;
  667. /**
  668. * Defines that alpha blending equation a DARKEN operation:
  669. * It takes the min of the src and sums the alpha channels.
  670. */
  671. static readonly ALPHA_EQUATION_DARKEN: number;
  672. /** Defines that the ressource is not delayed*/
  673. static readonly DELAYLOADSTATE_NONE: number;
  674. /** Defines that the ressource was successfully delay loaded */
  675. static readonly DELAYLOADSTATE_LOADED: number;
  676. /** Defines that the ressource is currently delay loading */
  677. static readonly DELAYLOADSTATE_LOADING: number;
  678. /** Defines that the ressource is delayed and has not started loading */
  679. static readonly DELAYLOADSTATE_NOTLOADED: number;
  680. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will never pass. i.e. Nothing will be drawn */
  681. static readonly NEVER: number;
  682. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will always pass. i.e. Pixels will be drawn in the order they are drawn */
  683. static readonly ALWAYS: number;
  684. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than the stored value */
  685. static readonly LESS: number;
  686. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is equals to the stored value */
  687. static readonly EQUAL: number;
  688. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than or equal to the stored value */
  689. static readonly LEQUAL: number;
  690. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than the stored value */
  691. static readonly GREATER: number;
  692. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than or equal to the stored value */
  693. static readonly GEQUAL: number;
  694. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is not equal to the stored value */
  695. static readonly NOTEQUAL: number;
  696. /** Passed to stencilOperation to specify that stencil value must be kept */
  697. static readonly KEEP: number;
  698. /** Passed to stencilOperation to specify that stencil value must be replaced */
  699. static readonly REPLACE: number;
  700. /** Passed to stencilOperation to specify that stencil value must be incremented */
  701. static readonly INCR: number;
  702. /** Passed to stencilOperation to specify that stencil value must be decremented */
  703. static readonly DECR: number;
  704. /** Passed to stencilOperation to specify that stencil value must be inverted */
  705. static readonly INVERT: number;
  706. /** Passed to stencilOperation to specify that stencil value must be incremented with wrapping */
  707. static readonly INCR_WRAP: number;
  708. /** Passed to stencilOperation to specify that stencil value must be decremented with wrapping */
  709. static readonly DECR_WRAP: number;
  710. /** Texture is not repeating outside of 0..1 UVs */
  711. static readonly TEXTURE_CLAMP_ADDRESSMODE: number;
  712. /** Texture is repeating outside of 0..1 UVs */
  713. static readonly TEXTURE_WRAP_ADDRESSMODE: number;
  714. /** Texture is repeating and mirrored */
  715. static readonly TEXTURE_MIRROR_ADDRESSMODE: number;
  716. /** ALPHA */
  717. static readonly TEXTUREFORMAT_ALPHA: number;
  718. /** LUMINANCE */
  719. static readonly TEXTUREFORMAT_LUMINANCE: number;
  720. /** LUMINANCE_ALPHA */
  721. static readonly TEXTUREFORMAT_LUMINANCE_ALPHA: number;
  722. /** RGB */
  723. static readonly TEXTUREFORMAT_RGB: number;
  724. /** RGBA */
  725. static readonly TEXTUREFORMAT_RGBA: number;
  726. /** RED */
  727. static readonly TEXTUREFORMAT_RED: number;
  728. /** RED (2nd reference) */
  729. static readonly TEXTUREFORMAT_R: number;
  730. /** RG */
  731. static readonly TEXTUREFORMAT_RG: number;
  732. /** RED_INTEGER */
  733. static readonly TEXTUREFORMAT_RED_INTEGER: number;
  734. /** RED_INTEGER (2nd reference) */
  735. static readonly TEXTUREFORMAT_R_INTEGER: number;
  736. /** RG_INTEGER */
  737. static readonly TEXTUREFORMAT_RG_INTEGER: number;
  738. /** RGB_INTEGER */
  739. static readonly TEXTUREFORMAT_RGB_INTEGER: number;
  740. /** RGBA_INTEGER */
  741. static readonly TEXTUREFORMAT_RGBA_INTEGER: number;
  742. /** UNSIGNED_BYTE */
  743. static readonly TEXTURETYPE_UNSIGNED_BYTE: number;
  744. /** UNSIGNED_BYTE (2nd reference) */
  745. static readonly TEXTURETYPE_UNSIGNED_INT: number;
  746. /** FLOAT */
  747. static readonly TEXTURETYPE_FLOAT: number;
  748. /** HALF_FLOAT */
  749. static readonly TEXTURETYPE_HALF_FLOAT: number;
  750. /** BYTE */
  751. static readonly TEXTURETYPE_BYTE: number;
  752. /** SHORT */
  753. static readonly TEXTURETYPE_SHORT: number;
  754. /** UNSIGNED_SHORT */
  755. static readonly TEXTURETYPE_UNSIGNED_SHORT: number;
  756. /** INT */
  757. static readonly TEXTURETYPE_INT: number;
  758. /** UNSIGNED_INT */
  759. static readonly TEXTURETYPE_UNSIGNED_INTEGER: number;
  760. /** UNSIGNED_SHORT_4_4_4_4 */
  761. static readonly TEXTURETYPE_UNSIGNED_SHORT_4_4_4_4: number;
  762. /** UNSIGNED_SHORT_5_5_5_1 */
  763. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_5_5_1: number;
  764. /** UNSIGNED_SHORT_5_6_5 */
  765. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_6_5: number;
  766. /** UNSIGNED_INT_2_10_10_10_REV */
  767. static readonly TEXTURETYPE_UNSIGNED_INT_2_10_10_10_REV: number;
  768. /** UNSIGNED_INT_24_8 */
  769. static readonly TEXTURETYPE_UNSIGNED_INT_24_8: number;
  770. /** UNSIGNED_INT_10F_11F_11F_REV */
  771. static readonly TEXTURETYPE_UNSIGNED_INT_10F_11F_11F_REV: number;
  772. /** UNSIGNED_INT_5_9_9_9_REV */
  773. static readonly TEXTURETYPE_UNSIGNED_INT_5_9_9_9_REV: number;
  774. /** FLOAT_32_UNSIGNED_INT_24_8_REV */
  775. static readonly TEXTURETYPE_FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  776. /** nearest is mag = nearest and min = nearest and no mip */
  777. static readonly TEXTURE_NEAREST_SAMPLINGMODE: number;
  778. /** mag = nearest and min = nearest and mip = none */
  779. static readonly TEXTURE_NEAREST_NEAREST: number;
  780. /** Bilinear is mag = linear and min = linear and no mip */
  781. static readonly TEXTURE_BILINEAR_SAMPLINGMODE: number;
  782. /** mag = linear and min = linear and mip = none */
  783. static readonly TEXTURE_LINEAR_LINEAR: number;
  784. /** Trilinear is mag = linear and min = linear and mip = linear */
  785. static readonly TEXTURE_TRILINEAR_SAMPLINGMODE: number;
  786. /** Trilinear is mag = linear and min = linear and mip = linear */
  787. static readonly TEXTURE_LINEAR_LINEAR_MIPLINEAR: number;
  788. /** mag = nearest and min = nearest and mip = nearest */
  789. static readonly TEXTURE_NEAREST_NEAREST_MIPNEAREST: number;
  790. /** mag = nearest and min = linear and mip = nearest */
  791. static readonly TEXTURE_NEAREST_LINEAR_MIPNEAREST: number;
  792. /** mag = nearest and min = linear and mip = linear */
  793. static readonly TEXTURE_NEAREST_LINEAR_MIPLINEAR: number;
  794. /** mag = nearest and min = linear and mip = none */
  795. static readonly TEXTURE_NEAREST_LINEAR: number;
  796. /** nearest is mag = nearest and min = nearest and mip = linear */
  797. static readonly TEXTURE_NEAREST_NEAREST_MIPLINEAR: number;
  798. /** mag = linear and min = nearest and mip = nearest */
  799. static readonly TEXTURE_LINEAR_NEAREST_MIPNEAREST: number;
  800. /** mag = linear and min = nearest and mip = linear */
  801. static readonly TEXTURE_LINEAR_NEAREST_MIPLINEAR: number;
  802. /** Bilinear is mag = linear and min = linear and mip = nearest */
  803. static readonly TEXTURE_LINEAR_LINEAR_MIPNEAREST: number;
  804. /** mag = linear and min = nearest and mip = none */
  805. static readonly TEXTURE_LINEAR_NEAREST: number;
  806. /** Explicit coordinates mode */
  807. static readonly TEXTURE_EXPLICIT_MODE: number;
  808. /** Spherical coordinates mode */
  809. static readonly TEXTURE_SPHERICAL_MODE: number;
  810. /** Planar coordinates mode */
  811. static readonly TEXTURE_PLANAR_MODE: number;
  812. /** Cubic coordinates mode */
  813. static readonly TEXTURE_CUBIC_MODE: number;
  814. /** Projection coordinates mode */
  815. static readonly TEXTURE_PROJECTION_MODE: number;
  816. /** Skybox coordinates mode */
  817. static readonly TEXTURE_SKYBOX_MODE: number;
  818. /** Inverse Cubic coordinates mode */
  819. static readonly TEXTURE_INVCUBIC_MODE: number;
  820. /** Equirectangular coordinates mode */
  821. static readonly TEXTURE_EQUIRECTANGULAR_MODE: number;
  822. /** Equirectangular Fixed coordinates mode */
  823. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MODE: number;
  824. /** Equirectangular Fixed Mirrored coordinates mode */
  825. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  826. /** Offline (baking) quality for texture filtering */
  827. static readonly TEXTURE_FILTERING_QUALITY_OFFLINE: number;
  828. /** High quality for texture filtering */
  829. static readonly TEXTURE_FILTERING_QUALITY_HIGH: number;
  830. /** Medium quality for texture filtering */
  831. static readonly TEXTURE_FILTERING_QUALITY_MEDIUM: number;
  832. /** Low quality for texture filtering */
  833. static readonly TEXTURE_FILTERING_QUALITY_LOW: number;
  834. /** Defines that texture rescaling will use a floor to find the closer power of 2 size */
  835. static readonly SCALEMODE_FLOOR: number;
  836. /** Defines that texture rescaling will look for the nearest power of 2 size */
  837. static readonly SCALEMODE_NEAREST: number;
  838. /** Defines that texture rescaling will use a ceil to find the closer power of 2 size */
  839. static readonly SCALEMODE_CEILING: number;
  840. /**
  841. * The dirty texture flag value
  842. */
  843. static readonly MATERIAL_TextureDirtyFlag: number;
  844. /**
  845. * The dirty light flag value
  846. */
  847. static readonly MATERIAL_LightDirtyFlag: number;
  848. /**
  849. * The dirty fresnel flag value
  850. */
  851. static readonly MATERIAL_FresnelDirtyFlag: number;
  852. /**
  853. * The dirty attribute flag value
  854. */
  855. static readonly MATERIAL_AttributesDirtyFlag: number;
  856. /**
  857. * The dirty misc flag value
  858. */
  859. static readonly MATERIAL_MiscDirtyFlag: number;
  860. /**
  861. * The all dirty flag value
  862. */
  863. static readonly MATERIAL_AllDirtyFlag: number;
  864. /**
  865. * Returns the triangle fill mode
  866. */
  867. static readonly MATERIAL_TriangleFillMode: number;
  868. /**
  869. * Returns the wireframe mode
  870. */
  871. static readonly MATERIAL_WireFrameFillMode: number;
  872. /**
  873. * Returns the point fill mode
  874. */
  875. static readonly MATERIAL_PointFillMode: number;
  876. /**
  877. * Returns the point list draw mode
  878. */
  879. static readonly MATERIAL_PointListDrawMode: number;
  880. /**
  881. * Returns the line list draw mode
  882. */
  883. static readonly MATERIAL_LineListDrawMode: number;
  884. /**
  885. * Returns the line loop draw mode
  886. */
  887. static readonly MATERIAL_LineLoopDrawMode: number;
  888. /**
  889. * Returns the line strip draw mode
  890. */
  891. static readonly MATERIAL_LineStripDrawMode: number;
  892. /**
  893. * Returns the triangle strip draw mode
  894. */
  895. static readonly MATERIAL_TriangleStripDrawMode: number;
  896. /**
  897. * Returns the triangle fan draw mode
  898. */
  899. static readonly MATERIAL_TriangleFanDrawMode: number;
  900. /**
  901. * Stores the clock-wise side orientation
  902. */
  903. static readonly MATERIAL_ClockWiseSideOrientation: number;
  904. /**
  905. * Stores the counter clock-wise side orientation
  906. */
  907. static readonly MATERIAL_CounterClockWiseSideOrientation: number;
  908. /**
  909. * Nothing
  910. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  911. */
  912. static readonly ACTION_NothingTrigger: number;
  913. /**
  914. * On pick
  915. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  916. */
  917. static readonly ACTION_OnPickTrigger: number;
  918. /**
  919. * On left pick
  920. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  921. */
  922. static readonly ACTION_OnLeftPickTrigger: number;
  923. /**
  924. * On right pick
  925. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  926. */
  927. static readonly ACTION_OnRightPickTrigger: number;
  928. /**
  929. * On center pick
  930. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  931. */
  932. static readonly ACTION_OnCenterPickTrigger: number;
  933. /**
  934. * On pick down
  935. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  936. */
  937. static readonly ACTION_OnPickDownTrigger: number;
  938. /**
  939. * On double pick
  940. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  941. */
  942. static readonly ACTION_OnDoublePickTrigger: number;
  943. /**
  944. * On pick up
  945. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  946. */
  947. static readonly ACTION_OnPickUpTrigger: number;
  948. /**
  949. * On pick out.
  950. * This trigger will only be raised if you also declared a OnPickDown
  951. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  952. */
  953. static readonly ACTION_OnPickOutTrigger: number;
  954. /**
  955. * On long press
  956. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  957. */
  958. static readonly ACTION_OnLongPressTrigger: number;
  959. /**
  960. * On pointer over
  961. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  962. */
  963. static readonly ACTION_OnPointerOverTrigger: number;
  964. /**
  965. * On pointer out
  966. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  967. */
  968. static readonly ACTION_OnPointerOutTrigger: number;
  969. /**
  970. * On every frame
  971. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  972. */
  973. static readonly ACTION_OnEveryFrameTrigger: number;
  974. /**
  975. * On intersection enter
  976. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  977. */
  978. static readonly ACTION_OnIntersectionEnterTrigger: number;
  979. /**
  980. * On intersection exit
  981. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  982. */
  983. static readonly ACTION_OnIntersectionExitTrigger: number;
  984. /**
  985. * On key down
  986. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  987. */
  988. static readonly ACTION_OnKeyDownTrigger: number;
  989. /**
  990. * On key up
  991. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  992. */
  993. static readonly ACTION_OnKeyUpTrigger: number;
  994. /**
  995. * Billboard mode will only apply to Y axis
  996. */
  997. static readonly PARTICLES_BILLBOARDMODE_Y: number;
  998. /**
  999. * Billboard mode will apply to all axes
  1000. */
  1001. static readonly PARTICLES_BILLBOARDMODE_ALL: number;
  1002. /**
  1003. * Special billboard mode where the particle will be biilboard to the camera but rotated to align with direction
  1004. */
  1005. static readonly PARTICLES_BILLBOARDMODE_STRETCHED: number;
  1006. /** Default culling strategy : this is an exclusion test and it's the more accurate.
  1007. * Test order :
  1008. * Is the bounding sphere outside the frustum ?
  1009. * If not, are the bounding box vertices outside the frustum ?
  1010. * It not, then the cullable object is in the frustum.
  1011. */
  1012. static readonly MESHES_CULLINGSTRATEGY_STANDARD: number;
  1013. /** Culling strategy : Bounding Sphere Only.
  1014. * This is an exclusion test. It's faster than the standard strategy because the bounding box is not tested.
  1015. * It's also less accurate than the standard because some not visible objects can still be selected.
  1016. * Test : is the bounding sphere outside the frustum ?
  1017. * If not, then the cullable object is in the frustum.
  1018. */
  1019. static readonly MESHES_CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY: number;
  1020. /** Culling strategy : Optimistic Inclusion.
  1021. * This in an inclusion test first, then the standard exclusion test.
  1022. * This can be faster when a cullable object is expected to be almost always in the camera frustum.
  1023. * This could also be a little slower than the standard test when the tested object center is not the frustum but one of its bounding box vertex is still inside.
  1024. * Anyway, it's as accurate as the standard strategy.
  1025. * Test :
  1026. * Is the cullable object bounding sphere center in the frustum ?
  1027. * If not, apply the default culling strategy.
  1028. */
  1029. static readonly MESHES_CULLINGSTRATEGY_OPTIMISTIC_INCLUSION: number;
  1030. /** Culling strategy : Optimistic Inclusion then Bounding Sphere Only.
  1031. * This in an inclusion test first, then the bounding sphere only exclusion test.
  1032. * This can be the fastest test when a cullable object is expected to be almost always in the camera frustum.
  1033. * This could also be a little slower than the BoundingSphereOnly strategy when the tested object center is not in the frustum but its bounding sphere still intersects it.
  1034. * It's less accurate than the standard strategy and as accurate as the BoundingSphereOnly strategy.
  1035. * Test :
  1036. * Is the cullable object bounding sphere center in the frustum ?
  1037. * If not, apply the Bounding Sphere Only strategy. No Bounding Box is tested here.
  1038. */
  1039. static readonly MESHES_CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY: number;
  1040. /**
  1041. * No logging while loading
  1042. */
  1043. static readonly SCENELOADER_NO_LOGGING: number;
  1044. /**
  1045. * Minimal logging while loading
  1046. */
  1047. static readonly SCENELOADER_MINIMAL_LOGGING: number;
  1048. /**
  1049. * Summary logging while loading
  1050. */
  1051. static readonly SCENELOADER_SUMMARY_LOGGING: number;
  1052. /**
  1053. * Detailled logging while loading
  1054. */
  1055. static readonly SCENELOADER_DETAILED_LOGGING: number;
  1056. /**
  1057. * Prepass texture index for color
  1058. */
  1059. static readonly PREPASS_COLOR_INDEX: number;
  1060. /**
  1061. * Prepass texture index for irradiance
  1062. */
  1063. static readonly PREPASS_IRRADIANCE_INDEX: number;
  1064. /**
  1065. * Prepass texture index for depth + normal
  1066. */
  1067. static readonly PREPASS_DEPTHNORMAL_INDEX: number;
  1068. /**
  1069. * Prepass texture index for albedo
  1070. */
  1071. static readonly PREPASS_ALBEDO_INDEX: number;
  1072. }
  1073. }
  1074. declare module "babylonjs/Materials/Textures/internalTextureLoader" {
  1075. import { Nullable } from "babylonjs/types";
  1076. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  1077. /**
  1078. * This represents the required contract to create a new type of texture loader.
  1079. */
  1080. export interface IInternalTextureLoader {
  1081. /**
  1082. * Defines wether the loader supports cascade loading the different faces.
  1083. */
  1084. supportCascades: boolean;
  1085. /**
  1086. * This returns if the loader support the current file information.
  1087. * @param extension defines the file extension of the file being loaded
  1088. * @param mimeType defines the optional mime type of the file being loaded
  1089. * @returns true if the loader can load the specified file
  1090. */
  1091. canLoad(extension: string, mimeType?: string): boolean;
  1092. /**
  1093. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  1094. * @param data contains the texture data
  1095. * @param texture defines the BabylonJS internal texture
  1096. * @param createPolynomials will be true if polynomials have been requested
  1097. * @param onLoad defines the callback to trigger once the texture is ready
  1098. * @param onError defines the callback to trigger in case of error
  1099. */
  1100. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  1101. /**
  1102. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  1103. * @param data contains the texture data
  1104. * @param texture defines the BabylonJS internal texture
  1105. * @param callback defines the method to call once ready to upload
  1106. */
  1107. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void, loadFailed?: boolean) => void): void;
  1108. }
  1109. }
  1110. declare module "babylonjs/Engines/IPipelineContext" {
  1111. /**
  1112. * Class used to store and describe the pipeline context associated with an effect
  1113. */
  1114. export interface IPipelineContext {
  1115. /**
  1116. * Gets a boolean indicating that this pipeline context is supporting asynchronous creating
  1117. */
  1118. isAsync: boolean;
  1119. /**
  1120. * Gets a boolean indicating that the context is ready to be used (like shaders / pipelines are compiled and ready for instance)
  1121. */
  1122. isReady: boolean;
  1123. /** @hidden */
  1124. _getVertexShaderCode(): string | null;
  1125. /** @hidden */
  1126. _getFragmentShaderCode(): string | null;
  1127. /** @hidden */
  1128. _handlesSpectorRebuildCallback(onCompiled: (compiledObject: any) => void): void;
  1129. }
  1130. }
  1131. declare module "babylonjs/Meshes/dataBuffer" {
  1132. /**
  1133. * Class used to store gfx data (like WebGLBuffer)
  1134. */
  1135. export class DataBuffer {
  1136. /**
  1137. * Gets or sets the number of objects referencing this buffer
  1138. */
  1139. references: number;
  1140. /** Gets or sets the size of the underlying buffer */
  1141. capacity: number;
  1142. /**
  1143. * Gets or sets a boolean indicating if the buffer contains 32bits indices
  1144. */
  1145. is32Bits: boolean;
  1146. /**
  1147. * Gets the underlying buffer
  1148. */
  1149. get underlyingResource(): any;
  1150. }
  1151. }
  1152. declare module "babylonjs/Engines/Processors/iShaderProcessor" {
  1153. /** @hidden */
  1154. export interface IShaderProcessor {
  1155. attributeProcessor?: (attribute: string) => string;
  1156. varyingProcessor?: (varying: string, isFragment: boolean) => string;
  1157. uniformProcessor?: (uniform: string, isFragment: boolean) => string;
  1158. uniformBufferProcessor?: (uniformBuffer: string, isFragment: boolean) => string;
  1159. endOfUniformBufferProcessor?: (closingBracketLine: string, isFragment: boolean) => string;
  1160. lineProcessor?: (line: string, isFragment: boolean) => string;
  1161. preProcessor?: (code: string, defines: string[], isFragment: boolean) => string;
  1162. postProcessor?: (code: string, defines: string[], isFragment: boolean) => string;
  1163. }
  1164. }
  1165. declare module "babylonjs/Engines/Processors/shaderProcessingOptions" {
  1166. import { IShaderProcessor } from "babylonjs/Engines/Processors/iShaderProcessor";
  1167. /** @hidden */
  1168. export interface ProcessingOptions {
  1169. defines: string[];
  1170. indexParameters: any;
  1171. isFragment: boolean;
  1172. shouldUseHighPrecisionShader: boolean;
  1173. supportsUniformBuffers: boolean;
  1174. shadersRepository: string;
  1175. includesShadersStore: {
  1176. [key: string]: string;
  1177. };
  1178. processor?: IShaderProcessor;
  1179. version: string;
  1180. platformName: string;
  1181. lookForClosingBracketForUniformBuffer?: boolean;
  1182. }
  1183. }
  1184. declare module "babylonjs/Engines/Processors/shaderCodeNode" {
  1185. import { ProcessingOptions } from "babylonjs/Engines/Processors/shaderProcessingOptions";
  1186. /** @hidden */
  1187. export class ShaderCodeNode {
  1188. line: string;
  1189. children: ShaderCodeNode[];
  1190. additionalDefineKey?: string;
  1191. additionalDefineValue?: string;
  1192. isValid(preprocessors: {
  1193. [key: string]: string;
  1194. }): boolean;
  1195. process(preprocessors: {
  1196. [key: string]: string;
  1197. }, options: ProcessingOptions): string;
  1198. }
  1199. }
  1200. declare module "babylonjs/Engines/Processors/shaderCodeCursor" {
  1201. /** @hidden */
  1202. export class ShaderCodeCursor {
  1203. private _lines;
  1204. lineIndex: number;
  1205. get currentLine(): string;
  1206. get canRead(): boolean;
  1207. set lines(value: string[]);
  1208. }
  1209. }
  1210. declare module "babylonjs/Engines/Processors/shaderCodeConditionNode" {
  1211. import { ShaderCodeNode } from "babylonjs/Engines/Processors/shaderCodeNode";
  1212. import { ProcessingOptions } from "babylonjs/Engines/Processors/shaderProcessingOptions";
  1213. /** @hidden */
  1214. export class ShaderCodeConditionNode extends ShaderCodeNode {
  1215. process(preprocessors: {
  1216. [key: string]: string;
  1217. }, options: ProcessingOptions): string;
  1218. }
  1219. }
  1220. declare module "babylonjs/Engines/Processors/Expressions/shaderDefineExpression" {
  1221. /** @hidden */
  1222. export class ShaderDefineExpression {
  1223. isTrue(preprocessors: {
  1224. [key: string]: string;
  1225. }): boolean;
  1226. private static _OperatorPriority;
  1227. private static _Stack;
  1228. static postfixToInfix(postfix: string[]): string;
  1229. static infixToPostfix(infix: string): string[];
  1230. }
  1231. }
  1232. declare module "babylonjs/Engines/Processors/shaderCodeTestNode" {
  1233. import { ShaderCodeNode } from "babylonjs/Engines/Processors/shaderCodeNode";
  1234. import { ShaderDefineExpression } from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  1235. /** @hidden */
  1236. export class ShaderCodeTestNode extends ShaderCodeNode {
  1237. testExpression: ShaderDefineExpression;
  1238. isValid(preprocessors: {
  1239. [key: string]: string;
  1240. }): boolean;
  1241. }
  1242. }
  1243. declare module "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineIsDefinedOperator" {
  1244. import { ShaderDefineExpression } from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  1245. /** @hidden */
  1246. export class ShaderDefineIsDefinedOperator extends ShaderDefineExpression {
  1247. define: string;
  1248. not: boolean;
  1249. constructor(define: string, not?: boolean);
  1250. isTrue(preprocessors: {
  1251. [key: string]: string;
  1252. }): boolean;
  1253. }
  1254. }
  1255. declare module "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineOrOperator" {
  1256. import { ShaderDefineExpression } from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  1257. /** @hidden */
  1258. export class ShaderDefineOrOperator extends ShaderDefineExpression {
  1259. leftOperand: ShaderDefineExpression;
  1260. rightOperand: ShaderDefineExpression;
  1261. isTrue(preprocessors: {
  1262. [key: string]: string;
  1263. }): boolean;
  1264. }
  1265. }
  1266. declare module "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineAndOperator" {
  1267. import { ShaderDefineExpression } from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  1268. /** @hidden */
  1269. export class ShaderDefineAndOperator extends ShaderDefineExpression {
  1270. leftOperand: ShaderDefineExpression;
  1271. rightOperand: ShaderDefineExpression;
  1272. isTrue(preprocessors: {
  1273. [key: string]: string;
  1274. }): boolean;
  1275. }
  1276. }
  1277. declare module "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineArithmeticOperator" {
  1278. import { ShaderDefineExpression } from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  1279. /** @hidden */
  1280. export class ShaderDefineArithmeticOperator extends ShaderDefineExpression {
  1281. define: string;
  1282. operand: string;
  1283. testValue: string;
  1284. constructor(define: string, operand: string, testValue: string);
  1285. isTrue(preprocessors: {
  1286. [key: string]: string;
  1287. }): boolean;
  1288. }
  1289. }
  1290. declare module "babylonjs/Offline/IOfflineProvider" {
  1291. /**
  1292. * Class used to enable access to offline support
  1293. * @see https://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  1294. */
  1295. export interface IOfflineProvider {
  1296. /**
  1297. * Gets a boolean indicating if scene must be saved in the database
  1298. */
  1299. enableSceneOffline: boolean;
  1300. /**
  1301. * Gets a boolean indicating if textures must be saved in the database
  1302. */
  1303. enableTexturesOffline: boolean;
  1304. /**
  1305. * Open the offline support and make it available
  1306. * @param successCallback defines the callback to call on success
  1307. * @param errorCallback defines the callback to call on error
  1308. */
  1309. open(successCallback: () => void, errorCallback: () => void): void;
  1310. /**
  1311. * Loads an image from the offline support
  1312. * @param url defines the url to load from
  1313. * @param image defines the target DOM image
  1314. */
  1315. loadImage(url: string, image: HTMLImageElement): void;
  1316. /**
  1317. * Loads a file from offline support
  1318. * @param url defines the URL to load from
  1319. * @param sceneLoaded defines a callback to call on success
  1320. * @param progressCallBack defines a callback to call when progress changed
  1321. * @param errorCallback defines a callback to call on error
  1322. * @param useArrayBuffer defines a boolean to use array buffer instead of text string
  1323. */
  1324. loadFile(url: string, sceneLoaded: (data: any) => void, progressCallBack?: (data: any) => void, errorCallback?: () => void, useArrayBuffer?: boolean): void;
  1325. }
  1326. }
  1327. declare module "babylonjs/Misc/filesInputStore" {
  1328. /**
  1329. * Class used to help managing file picking and drag'n'drop
  1330. * File Storage
  1331. */
  1332. export class FilesInputStore {
  1333. /**
  1334. * List of files ready to be loaded
  1335. */
  1336. static FilesToLoad: {
  1337. [key: string]: File;
  1338. };
  1339. }
  1340. }
  1341. declare module "babylonjs/Misc/retryStrategy" {
  1342. import { WebRequest } from "babylonjs/Misc/webRequest";
  1343. /**
  1344. * Class used to define a retry strategy when error happens while loading assets
  1345. */
  1346. export class RetryStrategy {
  1347. /**
  1348. * Function used to defines an exponential back off strategy
  1349. * @param maxRetries defines the maximum number of retries (3 by default)
  1350. * @param baseInterval defines the interval between retries
  1351. * @returns the strategy function to use
  1352. */
  1353. static ExponentialBackoff(maxRetries?: number, baseInterval?: number): (url: string, request: WebRequest, retryIndex: number) => number;
  1354. }
  1355. }
  1356. declare module "babylonjs/Misc/baseError" {
  1357. /**
  1358. * @ignore
  1359. * Application error to support additional information when loading a file
  1360. */
  1361. export abstract class BaseError extends Error {
  1362. protected static _setPrototypeOf: (o: any, proto: object | null) => any;
  1363. }
  1364. }
  1365. declare module "babylonjs/Misc/fileTools" {
  1366. import { WebRequest } from "babylonjs/Misc/webRequest";
  1367. import { Nullable } from "babylonjs/types";
  1368. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  1369. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  1370. import { BaseError } from "babylonjs/Misc/baseError";
  1371. /** @ignore */
  1372. export class LoadFileError extends BaseError {
  1373. request?: WebRequest;
  1374. file?: File;
  1375. /**
  1376. * Creates a new LoadFileError
  1377. * @param message defines the message of the error
  1378. * @param request defines the optional web request
  1379. * @param file defines the optional file
  1380. */
  1381. constructor(message: string, object?: WebRequest | File);
  1382. }
  1383. /** @ignore */
  1384. export class RequestFileError extends BaseError {
  1385. request: WebRequest;
  1386. /**
  1387. * Creates a new LoadFileError
  1388. * @param message defines the message of the error
  1389. * @param request defines the optional web request
  1390. */
  1391. constructor(message: string, request: WebRequest);
  1392. }
  1393. /** @ignore */
  1394. export class ReadFileError extends BaseError {
  1395. file: File;
  1396. /**
  1397. * Creates a new ReadFileError
  1398. * @param message defines the message of the error
  1399. * @param file defines the optional file
  1400. */
  1401. constructor(message: string, file: File);
  1402. }
  1403. /**
  1404. * @hidden
  1405. */
  1406. export class FileTools {
  1407. /**
  1408. * Gets or sets the retry strategy to apply when an error happens while loading an asset
  1409. */
  1410. static DefaultRetryStrategy: (url: string, request: WebRequest, retryIndex: number) => number;
  1411. /**
  1412. * Gets or sets the base URL to use to load assets
  1413. */
  1414. static BaseUrl: string;
  1415. /**
  1416. * Default behaviour for cors in the application.
  1417. * It can be a string if the expected behavior is identical in the entire app.
  1418. * Or a callback to be able to set it per url or on a group of them (in case of Video source for instance)
  1419. */
  1420. static CorsBehavior: string | ((url: string | string[]) => string);
  1421. /**
  1422. * Gets or sets a function used to pre-process url before using them to load assets
  1423. */
  1424. static PreprocessUrl: (url: string) => string;
  1425. /**
  1426. * Removes unwanted characters from an url
  1427. * @param url defines the url to clean
  1428. * @returns the cleaned url
  1429. */
  1430. private static _CleanUrl;
  1431. /**
  1432. * Sets the cors behavior on a dom element. This will add the required Tools.CorsBehavior to the element.
  1433. * @param url define the url we are trying
  1434. * @param element define the dom element where to configure the cors policy
  1435. */
  1436. static SetCorsBehavior(url: string | string[], element: {
  1437. crossOrigin: string | null;
  1438. }): void;
  1439. /**
  1440. * Loads an image as an HTMLImageElement.
  1441. * @param input url string, ArrayBuffer, or Blob to load
  1442. * @param onLoad callback called when the image successfully loads
  1443. * @param onError callback called when the image fails to load
  1444. * @param offlineProvider offline provider for caching
  1445. * @param mimeType optional mime type
  1446. * @returns the HTMLImageElement of the loaded image
  1447. */
  1448. static LoadImage(input: string | ArrayBuffer | ArrayBufferView | Blob, onLoad: (img: HTMLImageElement | ImageBitmap) => void, onError: (message?: string, exception?: any) => void, offlineProvider: Nullable<IOfflineProvider>, mimeType?: string): Nullable<HTMLImageElement>;
  1449. /**
  1450. * Reads a file from a File object
  1451. * @param file defines the file to load
  1452. * @param onSuccess defines the callback to call when data is loaded
  1453. * @param onProgress defines the callback to call during loading process
  1454. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  1455. * @param onError defines the callback to call when an error occurs
  1456. * @returns a file request object
  1457. */
  1458. static ReadFile(file: File, onSuccess: (data: any) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  1459. /**
  1460. * Loads a file from a url
  1461. * @param url url to load
  1462. * @param onSuccess callback called when the file successfully loads
  1463. * @param onProgress callback called while file is loading (if the server supports this mode)
  1464. * @param offlineProvider defines the offline provider for caching
  1465. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  1466. * @param onError callback called when the file fails to load
  1467. * @returns a file request object
  1468. */
  1469. static LoadFile(url: string, onSuccess: (data: string | ArrayBuffer, responseURL?: string) => void, onProgress?: (ev: ProgressEvent) => void, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean, onError?: (request?: WebRequest, exception?: LoadFileError) => void): IFileRequest;
  1470. /**
  1471. * Loads a file
  1472. * @param url url to load
  1473. * @param onSuccess callback called when the file successfully loads
  1474. * @param onProgress callback called while file is loading (if the server supports this mode)
  1475. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  1476. * @param onError callback called when the file fails to load
  1477. * @param onOpened callback called when the web request is opened
  1478. * @returns a file request object
  1479. */
  1480. static RequestFile(url: string, onSuccess: (data: string | ArrayBuffer, request?: WebRequest) => void, onProgress?: (event: ProgressEvent) => void, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean, onError?: (error: RequestFileError) => void, onOpened?: (request: WebRequest) => void): IFileRequest;
  1481. /**
  1482. * Checks if the loaded document was accessed via `file:`-Protocol.
  1483. * @returns boolean
  1484. */
  1485. static IsFileURL(): boolean;
  1486. }
  1487. }
  1488. declare module "babylonjs/Engines/Processors/shaderProcessor" {
  1489. import { ProcessingOptions } from "babylonjs/Engines/Processors/shaderProcessingOptions";
  1490. import { WebRequest } from "babylonjs/Misc/webRequest";
  1491. import { LoadFileError } from "babylonjs/Misc/fileTools";
  1492. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  1493. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  1494. /** @hidden */
  1495. export class ShaderProcessor {
  1496. static Process(sourceCode: string, options: ProcessingOptions, callback: (migratedCode: string) => void): void;
  1497. private static _ProcessPrecision;
  1498. private static _ExtractOperation;
  1499. private static _BuildSubExpression;
  1500. private static _BuildExpression;
  1501. private static _MoveCursorWithinIf;
  1502. private static _MoveCursor;
  1503. private static _EvaluatePreProcessors;
  1504. private static _PreparePreProcessors;
  1505. private static _ProcessShaderConversion;
  1506. private static _ProcessIncludes;
  1507. /**
  1508. * Loads a file from a url
  1509. * @param url url to load
  1510. * @param onSuccess callback called when the file successfully loads
  1511. * @param onProgress callback called while file is loading (if the server supports this mode)
  1512. * @param offlineProvider defines the offline provider for caching
  1513. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  1514. * @param onError callback called when the file fails to load
  1515. * @returns a file request object
  1516. * @hidden
  1517. */
  1518. static _FileToolsLoadFile(url: string, onSuccess: (data: string | ArrayBuffer, responseURL?: string) => void, onProgress?: (ev: ProgressEvent) => void, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean, onError?: (request?: WebRequest, exception?: LoadFileError) => void): IFileRequest;
  1519. }
  1520. }
  1521. declare module "babylonjs/Maths/math.like" {
  1522. import { float, int, DeepImmutable } from "babylonjs/types";
  1523. /**
  1524. * @hidden
  1525. */
  1526. export interface IColor4Like {
  1527. r: float;
  1528. g: float;
  1529. b: float;
  1530. a: float;
  1531. }
  1532. /**
  1533. * @hidden
  1534. */
  1535. export interface IColor3Like {
  1536. r: float;
  1537. g: float;
  1538. b: float;
  1539. }
  1540. /**
  1541. * @hidden
  1542. */
  1543. export interface IVector4Like {
  1544. x: float;
  1545. y: float;
  1546. z: float;
  1547. w: float;
  1548. }
  1549. /**
  1550. * @hidden
  1551. */
  1552. export interface IVector3Like {
  1553. x: float;
  1554. y: float;
  1555. z: float;
  1556. }
  1557. /**
  1558. * @hidden
  1559. */
  1560. export interface IVector2Like {
  1561. x: float;
  1562. y: float;
  1563. }
  1564. /**
  1565. * @hidden
  1566. */
  1567. export interface IMatrixLike {
  1568. toArray(): DeepImmutable<Float32Array | Array<number>>;
  1569. updateFlag: int;
  1570. }
  1571. /**
  1572. * @hidden
  1573. */
  1574. export interface IViewportLike {
  1575. x: float;
  1576. y: float;
  1577. width: float;
  1578. height: float;
  1579. }
  1580. /**
  1581. * @hidden
  1582. */
  1583. export interface IPlaneLike {
  1584. normal: IVector3Like;
  1585. d: float;
  1586. normalize(): void;
  1587. }
  1588. }
  1589. declare module "babylonjs/Materials/iEffectFallbacks" {
  1590. import { Effect } from "babylonjs/Materials/effect";
  1591. /**
  1592. * Interface used to define common properties for effect fallbacks
  1593. */
  1594. export interface IEffectFallbacks {
  1595. /**
  1596. * Removes the defines that should be removed when falling back.
  1597. * @param currentDefines defines the current define statements for the shader.
  1598. * @param effect defines the current effect we try to compile
  1599. * @returns The resulting defines with defines of the current rank removed.
  1600. */
  1601. reduce(currentDefines: string, effect: Effect): string;
  1602. /**
  1603. * Removes the fallback from the bound mesh.
  1604. */
  1605. unBindMesh(): void;
  1606. /**
  1607. * Checks to see if more fallbacks are still availible.
  1608. */
  1609. hasMoreFallbacks: boolean;
  1610. }
  1611. }
  1612. declare module "babylonjs/Misc/andOrNotEvaluator" {
  1613. /**
  1614. * Class used to evalaute queries containing `and` and `or` operators
  1615. */
  1616. export class AndOrNotEvaluator {
  1617. /**
  1618. * Evaluate a query
  1619. * @param query defines the query to evaluate
  1620. * @param evaluateCallback defines the callback used to filter result
  1621. * @returns true if the query matches
  1622. */
  1623. static Eval(query: string, evaluateCallback: (val: any) => boolean): boolean;
  1624. private static _HandleParenthesisContent;
  1625. private static _SimplifyNegation;
  1626. }
  1627. }
  1628. declare module "babylonjs/Misc/tags" {
  1629. /**
  1630. * Class used to store custom tags
  1631. */
  1632. export class Tags {
  1633. /**
  1634. * Adds support for tags on the given object
  1635. * @param obj defines the object to use
  1636. */
  1637. static EnableFor(obj: any): void;
  1638. /**
  1639. * Removes tags support
  1640. * @param obj defines the object to use
  1641. */
  1642. static DisableFor(obj: any): void;
  1643. /**
  1644. * Gets a boolean indicating if the given object has tags
  1645. * @param obj defines the object to use
  1646. * @returns a boolean
  1647. */
  1648. static HasTags(obj: any): boolean;
  1649. /**
  1650. * Gets the tags available on a given object
  1651. * @param obj defines the object to use
  1652. * @param asString defines if the tags must be returned as a string instead of an array of strings
  1653. * @returns the tags
  1654. */
  1655. static GetTags(obj: any, asString?: boolean): any;
  1656. /**
  1657. * Adds tags to an object
  1658. * @param obj defines the object to use
  1659. * @param tagsString defines the tag string. The tags 'true' and 'false' are reserved and cannot be used as tags.
  1660. * A tag cannot start with '||', '&&', and '!'. It cannot contain whitespaces
  1661. */
  1662. static AddTagsTo(obj: any, tagsString: string): void;
  1663. /**
  1664. * @hidden
  1665. */
  1666. static _AddTagTo(obj: any, tag: string): void;
  1667. /**
  1668. * Removes specific tags from a specific object
  1669. * @param obj defines the object to use
  1670. * @param tagsString defines the tags to remove
  1671. */
  1672. static RemoveTagsFrom(obj: any, tagsString: string): void;
  1673. /**
  1674. * @hidden
  1675. */
  1676. static _RemoveTagFrom(obj: any, tag: string): void;
  1677. /**
  1678. * Defines if tags hosted on an object match a given query
  1679. * @param obj defines the object to use
  1680. * @param tagsQuery defines the tag query
  1681. * @returns a boolean
  1682. */
  1683. static MatchesQuery(obj: any, tagsQuery: string): boolean;
  1684. }
  1685. }
  1686. declare module "babylonjs/Maths/math.scalar" {
  1687. /**
  1688. * Scalar computation library
  1689. */
  1690. export class Scalar {
  1691. /**
  1692. * Two pi constants convenient for computation.
  1693. */
  1694. static TwoPi: number;
  1695. /**
  1696. * Boolean : true if the absolute difference between a and b is lower than epsilon (default = 1.401298E-45)
  1697. * @param a number
  1698. * @param b number
  1699. * @param epsilon (default = 1.401298E-45)
  1700. * @returns true if the absolute difference between a and b is lower than epsilon (default = 1.401298E-45)
  1701. */
  1702. static WithinEpsilon(a: number, b: number, epsilon?: number): boolean;
  1703. /**
  1704. * Returns a string : the upper case translation of the number i to hexadecimal.
  1705. * @param i number
  1706. * @returns the upper case translation of the number i to hexadecimal.
  1707. */
  1708. static ToHex(i: number): string;
  1709. /**
  1710. * Returns -1 if value is negative and +1 is value is positive.
  1711. * @param value the value
  1712. * @returns the value itself if it's equal to zero.
  1713. */
  1714. static Sign(value: number): number;
  1715. /**
  1716. * Returns the value itself if it's between min and max.
  1717. * Returns min if the value is lower than min.
  1718. * Returns max if the value is greater than max.
  1719. * @param value the value to clmap
  1720. * @param min the min value to clamp to (default: 0)
  1721. * @param max the max value to clamp to (default: 1)
  1722. * @returns the clamped value
  1723. */
  1724. static Clamp(value: number, min?: number, max?: number): number;
  1725. /**
  1726. * the log2 of value.
  1727. * @param value the value to compute log2 of
  1728. * @returns the log2 of value.
  1729. */
  1730. static Log2(value: number): number;
  1731. /**
  1732. * Loops the value, so that it is never larger than length and never smaller than 0.
  1733. *
  1734. * This is similar to the modulo operator but it works with floating point numbers.
  1735. * For example, using 3.0 for t and 2.5 for length, the result would be 0.5.
  1736. * With t = 5 and length = 2.5, the result would be 0.0.
  1737. * Note, however, that the behaviour is not defined for negative numbers as it is for the modulo operator
  1738. * @param value the value
  1739. * @param length the length
  1740. * @returns the looped value
  1741. */
  1742. static Repeat(value: number, length: number): number;
  1743. /**
  1744. * Normalize the value between 0.0 and 1.0 using min and max values
  1745. * @param value value to normalize
  1746. * @param min max to normalize between
  1747. * @param max min to normalize between
  1748. * @returns the normalized value
  1749. */
  1750. static Normalize(value: number, min: number, max: number): number;
  1751. /**
  1752. * Denormalize the value from 0.0 and 1.0 using min and max values
  1753. * @param normalized value to denormalize
  1754. * @param min max to denormalize between
  1755. * @param max min to denormalize between
  1756. * @returns the denormalized value
  1757. */
  1758. static Denormalize(normalized: number, min: number, max: number): number;
  1759. /**
  1760. * Calculates the shortest difference between two given angles given in degrees.
  1761. * @param current current angle in degrees
  1762. * @param target target angle in degrees
  1763. * @returns the delta
  1764. */
  1765. static DeltaAngle(current: number, target: number): number;
  1766. /**
  1767. * PingPongs the value t, so that it is never larger than length and never smaller than 0.
  1768. * @param tx value
  1769. * @param length length
  1770. * @returns The returned value will move back and forth between 0 and length
  1771. */
  1772. static PingPong(tx: number, length: number): number;
  1773. /**
  1774. * Interpolates between min and max with smoothing at the limits.
  1775. *
  1776. * This function interpolates between min and max in a similar way to Lerp. However, the interpolation will gradually speed up
  1777. * from the start and slow down toward the end. This is useful for creating natural-looking animation, fading and other transitions.
  1778. * @param from from
  1779. * @param to to
  1780. * @param tx value
  1781. * @returns the smooth stepped value
  1782. */
  1783. static SmoothStep(from: number, to: number, tx: number): number;
  1784. /**
  1785. * Moves a value current towards target.
  1786. *
  1787. * This is essentially the same as Mathf.Lerp but instead the function will ensure that the speed never exceeds maxDelta.
  1788. * Negative values of maxDelta pushes the value away from target.
  1789. * @param current current value
  1790. * @param target target value
  1791. * @param maxDelta max distance to move
  1792. * @returns resulting value
  1793. */
  1794. static MoveTowards(current: number, target: number, maxDelta: number): number;
  1795. /**
  1796. * Same as MoveTowards but makes sure the values interpolate correctly when they wrap around 360 degrees.
  1797. *
  1798. * Variables current and target are assumed to be in degrees. For optimization reasons, negative values of maxDelta
  1799. * are not supported and may cause oscillation. To push current away from a target angle, add 180 to that angle instead.
  1800. * @param current current value
  1801. * @param target target value
  1802. * @param maxDelta max distance to move
  1803. * @returns resulting angle
  1804. */
  1805. static MoveTowardsAngle(current: number, target: number, maxDelta: number): number;
  1806. /**
  1807. * Creates a new scalar with values linearly interpolated of "amount" between the start scalar and the end scalar.
  1808. * @param start start value
  1809. * @param end target value
  1810. * @param amount amount to lerp between
  1811. * @returns the lerped value
  1812. */
  1813. static Lerp(start: number, end: number, amount: number): number;
  1814. /**
  1815. * Same as Lerp but makes sure the values interpolate correctly when they wrap around 360 degrees.
  1816. * The parameter t is clamped to the range [0, 1]. Variables a and b are assumed to be in degrees.
  1817. * @param start start value
  1818. * @param end target value
  1819. * @param amount amount to lerp between
  1820. * @returns the lerped value
  1821. */
  1822. static LerpAngle(start: number, end: number, amount: number): number;
  1823. /**
  1824. * Calculates the linear parameter t that produces the interpolant value within the range [a, b].
  1825. * @param a start value
  1826. * @param b target value
  1827. * @param value value between a and b
  1828. * @returns the inverseLerp value
  1829. */
  1830. static InverseLerp(a: number, b: number, value: number): number;
  1831. /**
  1832. * Returns a new scalar located for "amount" (float) on the Hermite spline defined by the scalars "value1", "value3", "tangent1", "tangent2".
  1833. * @see http://mathworld.wolfram.com/HermitePolynomial.html
  1834. * @param value1 spline value
  1835. * @param tangent1 spline value
  1836. * @param value2 spline value
  1837. * @param tangent2 spline value
  1838. * @param amount input value
  1839. * @returns hermite result
  1840. */
  1841. static Hermite(value1: number, tangent1: number, value2: number, tangent2: number, amount: number): number;
  1842. /**
  1843. * Returns a random float number between and min and max values
  1844. * @param min min value of random
  1845. * @param max max value of random
  1846. * @returns random value
  1847. */
  1848. static RandomRange(min: number, max: number): number;
  1849. /**
  1850. * This function returns percentage of a number in a given range.
  1851. *
  1852. * RangeToPercent(40,20,60) will return 0.5 (50%)
  1853. * RangeToPercent(34,0,100) will return 0.34 (34%)
  1854. * @param number to convert to percentage
  1855. * @param min min range
  1856. * @param max max range
  1857. * @returns the percentage
  1858. */
  1859. static RangeToPercent(number: number, min: number, max: number): number;
  1860. /**
  1861. * This function returns number that corresponds to the percentage in a given range.
  1862. *
  1863. * PercentToRange(0.34,0,100) will return 34.
  1864. * @param percent to convert to number
  1865. * @param min min range
  1866. * @param max max range
  1867. * @returns the number
  1868. */
  1869. static PercentToRange(percent: number, min: number, max: number): number;
  1870. /**
  1871. * Returns the angle converted to equivalent value between -Math.PI and Math.PI radians.
  1872. * @param angle The angle to normalize in radian.
  1873. * @return The converted angle.
  1874. */
  1875. static NormalizeRadians(angle: number): number;
  1876. }
  1877. }
  1878. declare module "babylonjs/Maths/math.constants" {
  1879. /**
  1880. * Constant used to convert a value to gamma space
  1881. * @ignorenaming
  1882. */
  1883. export const ToGammaSpace: number;
  1884. /**
  1885. * Constant used to convert a value to linear space
  1886. * @ignorenaming
  1887. */
  1888. export const ToLinearSpace = 2.2;
  1889. /**
  1890. * Constant used to define the minimal number value in Babylon.js
  1891. * @ignorenaming
  1892. */
  1893. let Epsilon: number;
  1894. export { Epsilon };
  1895. }
  1896. declare module "babylonjs/Maths/math.viewport" {
  1897. /**
  1898. * Class used to represent a viewport on screen
  1899. */
  1900. export class Viewport {
  1901. /** viewport left coordinate */
  1902. x: number;
  1903. /** viewport top coordinate */
  1904. y: number;
  1905. /**viewport width */
  1906. width: number;
  1907. /** viewport height */
  1908. height: number;
  1909. /**
  1910. * Creates a Viewport object located at (x, y) and sized (width, height)
  1911. * @param x defines viewport left coordinate
  1912. * @param y defines viewport top coordinate
  1913. * @param width defines the viewport width
  1914. * @param height defines the viewport height
  1915. */
  1916. constructor(
  1917. /** viewport left coordinate */
  1918. x: number,
  1919. /** viewport top coordinate */
  1920. y: number,
  1921. /**viewport width */
  1922. width: number,
  1923. /** viewport height */
  1924. height: number);
  1925. /**
  1926. * Creates a new viewport using absolute sizing (from 0-> width, 0-> height instead of 0->1)
  1927. * @param renderWidth defines the rendering width
  1928. * @param renderHeight defines the rendering height
  1929. * @returns a new Viewport
  1930. */
  1931. toGlobal(renderWidth: number, renderHeight: number): Viewport;
  1932. /**
  1933. * Stores absolute viewport value into a target viewport (from 0-> width, 0-> height instead of 0->1)
  1934. * @param renderWidth defines the rendering width
  1935. * @param renderHeight defines the rendering height
  1936. * @param ref defines the target viewport
  1937. * @returns the current viewport
  1938. */
  1939. toGlobalToRef(renderWidth: number, renderHeight: number, ref: Viewport): Viewport;
  1940. /**
  1941. * Returns a new Viewport copied from the current one
  1942. * @returns a new Viewport
  1943. */
  1944. clone(): Viewport;
  1945. }
  1946. }
  1947. declare module "babylonjs/Misc/arrayTools" {
  1948. /**
  1949. * Class containing a set of static utilities functions for arrays.
  1950. */
  1951. export class ArrayTools {
  1952. /**
  1953. * Returns an array of the given size filled with element built from the given constructor and the paramters
  1954. * @param size the number of element to construct and put in the array
  1955. * @param itemBuilder a callback responsible for creating new instance of item. Called once per array entry.
  1956. * @returns a new array filled with new objects
  1957. */
  1958. static BuildArray<T>(size: number, itemBuilder: () => T): Array<T>;
  1959. }
  1960. }
  1961. declare module "babylonjs/Maths/math.plane" {
  1962. import { DeepImmutable } from "babylonjs/types";
  1963. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  1964. /**
  1965. * Represents a plane by the equation ax + by + cz + d = 0
  1966. */
  1967. export class Plane {
  1968. private static _TmpMatrix;
  1969. /**
  1970. * Normal of the plane (a,b,c)
  1971. */
  1972. normal: Vector3;
  1973. /**
  1974. * d component of the plane
  1975. */
  1976. d: number;
  1977. /**
  1978. * Creates a Plane object according to the given floats a, b, c, d and the plane equation : ax + by + cz + d = 0
  1979. * @param a a component of the plane
  1980. * @param b b component of the plane
  1981. * @param c c component of the plane
  1982. * @param d d component of the plane
  1983. */
  1984. constructor(a: number, b: number, c: number, d: number);
  1985. /**
  1986. * @returns the plane coordinates as a new array of 4 elements [a, b, c, d].
  1987. */
  1988. asArray(): number[];
  1989. /**
  1990. * @returns a new plane copied from the current Plane.
  1991. */
  1992. clone(): Plane;
  1993. /**
  1994. * @returns the string "Plane".
  1995. */
  1996. getClassName(): string;
  1997. /**
  1998. * @returns the Plane hash code.
  1999. */
  2000. getHashCode(): number;
  2001. /**
  2002. * Normalize the current Plane in place.
  2003. * @returns the updated Plane.
  2004. */
  2005. normalize(): Plane;
  2006. /**
  2007. * Applies a transformation the plane and returns the result
  2008. * @param transformation the transformation matrix to be applied to the plane
  2009. * @returns a new Plane as the result of the transformation of the current Plane by the given matrix.
  2010. */
  2011. transform(transformation: DeepImmutable<Matrix>): Plane;
  2012. /**
  2013. * Compute the dot product between the point and the plane normal
  2014. * @param point point to calculate the dot product with
  2015. * @returns the dot product (float) of the point coordinates and the plane normal.
  2016. */
  2017. dotCoordinate(point: DeepImmutable<Vector3>): number;
  2018. /**
  2019. * Updates the current Plane from the plane defined by the three given points.
  2020. * @param point1 one of the points used to contruct the plane
  2021. * @param point2 one of the points used to contruct the plane
  2022. * @param point3 one of the points used to contruct the plane
  2023. * @returns the updated Plane.
  2024. */
  2025. copyFromPoints(point1: DeepImmutable<Vector3>, point2: DeepImmutable<Vector3>, point3: DeepImmutable<Vector3>): Plane;
  2026. /**
  2027. * Checks if the plane is facing a given direction
  2028. * @param direction the direction to check if the plane is facing
  2029. * @param epsilon value the dot product is compared against (returns true if dot <= epsilon)
  2030. * @returns True is the vector "direction" is the same side than the plane normal.
  2031. */
  2032. isFrontFacingTo(direction: DeepImmutable<Vector3>, epsilon: number): boolean;
  2033. /**
  2034. * Calculates the distance to a point
  2035. * @param point point to calculate distance to
  2036. * @returns the signed distance (float) from the given point to the Plane.
  2037. */
  2038. signedDistanceTo(point: DeepImmutable<Vector3>): number;
  2039. /**
  2040. * Creates a plane from an array
  2041. * @param array the array to create a plane from
  2042. * @returns a new Plane from the given array.
  2043. */
  2044. static FromArray(array: DeepImmutable<ArrayLike<number>>): Plane;
  2045. /**
  2046. * Creates a plane from three points
  2047. * @param point1 point used to create the plane
  2048. * @param point2 point used to create the plane
  2049. * @param point3 point used to create the plane
  2050. * @returns a new Plane defined by the three given points.
  2051. */
  2052. static FromPoints(point1: DeepImmutable<Vector3>, point2: DeepImmutable<Vector3>, point3: DeepImmutable<Vector3>): Plane;
  2053. /**
  2054. * Creates a plane from an origin point and a normal
  2055. * @param origin origin of the plane to be constructed
  2056. * @param normal normal of the plane to be constructed
  2057. * @returns a new Plane the normal vector to this plane at the given origin point.
  2058. * Note : the vector "normal" is updated because normalized.
  2059. */
  2060. static FromPositionAndNormal(origin: DeepImmutable<Vector3>, normal: Vector3): Plane;
  2061. /**
  2062. * Calculates the distance from a plane and a point
  2063. * @param origin origin of the plane to be constructed
  2064. * @param normal normal of the plane to be constructed
  2065. * @param point point to calculate distance to
  2066. * @returns the signed distance between the plane defined by the normal vector at the "origin"" point and the given other point.
  2067. */
  2068. static SignedDistanceToPlaneFromPositionAndNormal(origin: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>, point: DeepImmutable<Vector3>): number;
  2069. }
  2070. }
  2071. declare module "babylonjs/Engines/performanceConfigurator" {
  2072. /** @hidden */
  2073. export class PerformanceConfigurator {
  2074. /** @hidden */
  2075. static MatrixUse64Bits: boolean;
  2076. /** @hidden */
  2077. static MatrixTrackPrecisionChange: boolean;
  2078. /** @hidden */
  2079. static MatrixCurrentType: any;
  2080. /** @hidden */
  2081. static MatrixTrackedMatrices: Array<any> | null;
  2082. /** @hidden */
  2083. static SetMatrixPrecision(use64bits: boolean): void;
  2084. }
  2085. }
  2086. declare module "babylonjs/Maths/math.vector" {
  2087. import { Viewport } from "babylonjs/Maths/math.viewport";
  2088. import { DeepImmutable, Nullable, FloatArray, float } from "babylonjs/types";
  2089. import { IPlaneLike } from "babylonjs/Maths/math.like";
  2090. import { Plane } from "babylonjs/Maths/math.plane";
  2091. /**
  2092. * Class representing a vector containing 2 coordinates
  2093. */
  2094. export class Vector2 {
  2095. /** defines the first coordinate */
  2096. x: number;
  2097. /** defines the second coordinate */
  2098. y: number;
  2099. /**
  2100. * Creates a new Vector2 from the given x and y coordinates
  2101. * @param x defines the first coordinate
  2102. * @param y defines the second coordinate
  2103. */
  2104. constructor(
  2105. /** defines the first coordinate */
  2106. x?: number,
  2107. /** defines the second coordinate */
  2108. y?: number);
  2109. /**
  2110. * Gets a string with the Vector2 coordinates
  2111. * @returns a string with the Vector2 coordinates
  2112. */
  2113. toString(): string;
  2114. /**
  2115. * Gets class name
  2116. * @returns the string "Vector2"
  2117. */
  2118. getClassName(): string;
  2119. /**
  2120. * Gets current vector hash code
  2121. * @returns the Vector2 hash code as a number
  2122. */
  2123. getHashCode(): number;
  2124. /**
  2125. * Sets the Vector2 coordinates in the given array or Float32Array from the given index.
  2126. * @param array defines the source array
  2127. * @param index defines the offset in source array
  2128. * @returns the current Vector2
  2129. */
  2130. toArray(array: FloatArray, index?: number): Vector2;
  2131. /**
  2132. * Update the current vector from an array
  2133. * @param array defines the destination array
  2134. * @param index defines the offset in the destination array
  2135. * @returns the current Vector3
  2136. */
  2137. fromArray(array: FloatArray, index?: number): Vector2;
  2138. /**
  2139. * Copy the current vector to an array
  2140. * @returns a new array with 2 elements: the Vector2 coordinates.
  2141. */
  2142. asArray(): number[];
  2143. /**
  2144. * Sets the Vector2 coordinates with the given Vector2 coordinates
  2145. * @param source defines the source Vector2
  2146. * @returns the current updated Vector2
  2147. */
  2148. copyFrom(source: DeepImmutable<Vector2>): Vector2;
  2149. /**
  2150. * Sets the Vector2 coordinates with the given floats
  2151. * @param x defines the first coordinate
  2152. * @param y defines the second coordinate
  2153. * @returns the current updated Vector2
  2154. */
  2155. copyFromFloats(x: number, y: number): Vector2;
  2156. /**
  2157. * Sets the Vector2 coordinates with the given floats
  2158. * @param x defines the first coordinate
  2159. * @param y defines the second coordinate
  2160. * @returns the current updated Vector2
  2161. */
  2162. set(x: number, y: number): Vector2;
  2163. /**
  2164. * Add another vector with the current one
  2165. * @param otherVector defines the other vector
  2166. * @returns a new Vector2 set with the addition of the current Vector2 and the given one coordinates
  2167. */
  2168. add(otherVector: DeepImmutable<Vector2>): Vector2;
  2169. /**
  2170. * Sets the "result" coordinates with the addition of the current Vector2 and the given one coordinates
  2171. * @param otherVector defines the other vector
  2172. * @param result defines the target vector
  2173. * @returns the unmodified current Vector2
  2174. */
  2175. addToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  2176. /**
  2177. * Set the Vector2 coordinates by adding the given Vector2 coordinates
  2178. * @param otherVector defines the other vector
  2179. * @returns the current updated Vector2
  2180. */
  2181. addInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  2182. /**
  2183. * Gets a new Vector2 by adding the current Vector2 coordinates to the given Vector3 x, y coordinates
  2184. * @param otherVector defines the other vector
  2185. * @returns a new Vector2
  2186. */
  2187. addVector3(otherVector: Vector3): Vector2;
  2188. /**
  2189. * Gets a new Vector2 set with the subtracted coordinates of the given one from the current Vector2
  2190. * @param otherVector defines the other vector
  2191. * @returns a new Vector2
  2192. */
  2193. subtract(otherVector: Vector2): Vector2;
  2194. /**
  2195. * Sets the "result" coordinates with the subtraction of the given one from the current Vector2 coordinates.
  2196. * @param otherVector defines the other vector
  2197. * @param result defines the target vector
  2198. * @returns the unmodified current Vector2
  2199. */
  2200. subtractToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  2201. /**
  2202. * Sets the current Vector2 coordinates by subtracting from it the given one coordinates
  2203. * @param otherVector defines the other vector
  2204. * @returns the current updated Vector2
  2205. */
  2206. subtractInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  2207. /**
  2208. * Multiplies in place the current Vector2 coordinates by the given ones
  2209. * @param otherVector defines the other vector
  2210. * @returns the current updated Vector2
  2211. */
  2212. multiplyInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  2213. /**
  2214. * Returns a new Vector2 set with the multiplication of the current Vector2 and the given one coordinates
  2215. * @param otherVector defines the other vector
  2216. * @returns a new Vector2
  2217. */
  2218. multiply(otherVector: DeepImmutable<Vector2>): Vector2;
  2219. /**
  2220. * Sets "result" coordinates with the multiplication of the current Vector2 and the given one coordinates
  2221. * @param otherVector defines the other vector
  2222. * @param result defines the target vector
  2223. * @returns the unmodified current Vector2
  2224. */
  2225. multiplyToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  2226. /**
  2227. * Gets a new Vector2 set with the Vector2 coordinates multiplied by the given floats
  2228. * @param x defines the first coordinate
  2229. * @param y defines the second coordinate
  2230. * @returns a new Vector2
  2231. */
  2232. multiplyByFloats(x: number, y: number): Vector2;
  2233. /**
  2234. * Returns a new Vector2 set with the Vector2 coordinates divided by the given one coordinates
  2235. * @param otherVector defines the other vector
  2236. * @returns a new Vector2
  2237. */
  2238. divide(otherVector: Vector2): Vector2;
  2239. /**
  2240. * Sets the "result" coordinates with the Vector2 divided by the given one coordinates
  2241. * @param otherVector defines the other vector
  2242. * @param result defines the target vector
  2243. * @returns the unmodified current Vector2
  2244. */
  2245. divideToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  2246. /**
  2247. * Divides the current Vector2 coordinates by the given ones
  2248. * @param otherVector defines the other vector
  2249. * @returns the current updated Vector2
  2250. */
  2251. divideInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  2252. /**
  2253. * Gets a new Vector2 with current Vector2 negated coordinates
  2254. * @returns a new Vector2
  2255. */
  2256. negate(): Vector2;
  2257. /**
  2258. * Negate this vector in place
  2259. * @returns this
  2260. */
  2261. negateInPlace(): Vector2;
  2262. /**
  2263. * Negate the current Vector2 and stores the result in the given vector "result" coordinates
  2264. * @param result defines the Vector3 object where to store the result
  2265. * @returns the current Vector2
  2266. */
  2267. negateToRef(result: Vector2): Vector2;
  2268. /**
  2269. * Multiply the Vector2 coordinates by scale
  2270. * @param scale defines the scaling factor
  2271. * @returns the current updated Vector2
  2272. */
  2273. scaleInPlace(scale: number): Vector2;
  2274. /**
  2275. * Returns a new Vector2 scaled by "scale" from the current Vector2
  2276. * @param scale defines the scaling factor
  2277. * @returns a new Vector2
  2278. */
  2279. scale(scale: number): Vector2;
  2280. /**
  2281. * Scale the current Vector2 values by a factor to a given Vector2
  2282. * @param scale defines the scale factor
  2283. * @param result defines the Vector2 object where to store the result
  2284. * @returns the unmodified current Vector2
  2285. */
  2286. scaleToRef(scale: number, result: Vector2): Vector2;
  2287. /**
  2288. * Scale the current Vector2 values by a factor and add the result to a given Vector2
  2289. * @param scale defines the scale factor
  2290. * @param result defines the Vector2 object where to store the result
  2291. * @returns the unmodified current Vector2
  2292. */
  2293. scaleAndAddToRef(scale: number, result: Vector2): Vector2;
  2294. /**
  2295. * Gets a boolean if two vectors are equals
  2296. * @param otherVector defines the other vector
  2297. * @returns true if the given vector coordinates strictly equal the current Vector2 ones
  2298. */
  2299. equals(otherVector: DeepImmutable<Vector2>): boolean;
  2300. /**
  2301. * Gets a boolean if two vectors are equals (using an epsilon value)
  2302. * @param otherVector defines the other vector
  2303. * @param epsilon defines the minimal distance to consider equality
  2304. * @returns true if the given vector coordinates are close to the current ones by a distance of epsilon.
  2305. */
  2306. equalsWithEpsilon(otherVector: DeepImmutable<Vector2>, epsilon?: number): boolean;
  2307. /**
  2308. * Gets a new Vector2 from current Vector2 floored values
  2309. * @returns a new Vector2
  2310. */
  2311. floor(): Vector2;
  2312. /**
  2313. * Gets a new Vector2 from current Vector2 floored values
  2314. * @returns a new Vector2
  2315. */
  2316. fract(): Vector2;
  2317. /**
  2318. * Gets the length of the vector
  2319. * @returns the vector length (float)
  2320. */
  2321. length(): number;
  2322. /**
  2323. * Gets the vector squared length
  2324. * @returns the vector squared length (float)
  2325. */
  2326. lengthSquared(): number;
  2327. /**
  2328. * Normalize the vector
  2329. * @returns the current updated Vector2
  2330. */
  2331. normalize(): Vector2;
  2332. /**
  2333. * Gets a new Vector2 copied from the Vector2
  2334. * @returns a new Vector2
  2335. */
  2336. clone(): Vector2;
  2337. /**
  2338. * Gets a new Vector2(0, 0)
  2339. * @returns a new Vector2
  2340. */
  2341. static Zero(): Vector2;
  2342. /**
  2343. * Gets a new Vector2(1, 1)
  2344. * @returns a new Vector2
  2345. */
  2346. static One(): Vector2;
  2347. /**
  2348. * Gets a new Vector2 set from the given index element of the given array
  2349. * @param array defines the data source
  2350. * @param offset defines the offset in the data source
  2351. * @returns a new Vector2
  2352. */
  2353. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector2;
  2354. /**
  2355. * Sets "result" from the given index element of the given array
  2356. * @param array defines the data source
  2357. * @param offset defines the offset in the data source
  2358. * @param result defines the target vector
  2359. */
  2360. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector2): void;
  2361. /**
  2362. * Gets a new Vector2 located for "amount" (float) on the CatmullRom spline defined by the given four Vector2
  2363. * @param value1 defines 1st point of control
  2364. * @param value2 defines 2nd point of control
  2365. * @param value3 defines 3rd point of control
  2366. * @param value4 defines 4th point of control
  2367. * @param amount defines the interpolation factor
  2368. * @returns a new Vector2
  2369. */
  2370. static CatmullRom(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>, value3: DeepImmutable<Vector2>, value4: DeepImmutable<Vector2>, amount: number): Vector2;
  2371. /**
  2372. * Returns a new Vector2 set with same the coordinates than "value" ones if the vector "value" is in the square defined by "min" and "max".
  2373. * If a coordinate of "value" is lower than "min" coordinates, the returned Vector2 is given this "min" coordinate.
  2374. * If a coordinate of "value" is greater than "max" coordinates, the returned Vector2 is given this "max" coordinate
  2375. * @param value defines the value to clamp
  2376. * @param min defines the lower limit
  2377. * @param max defines the upper limit
  2378. * @returns a new Vector2
  2379. */
  2380. static Clamp(value: DeepImmutable<Vector2>, min: DeepImmutable<Vector2>, max: DeepImmutable<Vector2>): Vector2;
  2381. /**
  2382. * Returns a new Vector2 located for "amount" (float) on the Hermite spline defined by the vectors "value1", "value3", "tangent1", "tangent2"
  2383. * @param value1 defines the 1st control point
  2384. * @param tangent1 defines the outgoing tangent
  2385. * @param value2 defines the 2nd control point
  2386. * @param tangent2 defines the incoming tangent
  2387. * @param amount defines the interpolation factor
  2388. * @returns a new Vector2
  2389. */
  2390. static Hermite(value1: DeepImmutable<Vector2>, tangent1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>, tangent2: DeepImmutable<Vector2>, amount: number): Vector2;
  2391. /**
  2392. * Returns a new Vector2 located for "amount" (float) on the linear interpolation between the vector "start" adn the vector "end".
  2393. * @param start defines the start vector
  2394. * @param end defines the end vector
  2395. * @param amount defines the interpolation factor
  2396. * @returns a new Vector2
  2397. */
  2398. static Lerp(start: DeepImmutable<Vector2>, end: DeepImmutable<Vector2>, amount: number): Vector2;
  2399. /**
  2400. * Gets the dot product of the vector "left" and the vector "right"
  2401. * @param left defines first vector
  2402. * @param right defines second vector
  2403. * @returns the dot product (float)
  2404. */
  2405. static Dot(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): number;
  2406. /**
  2407. * Returns a new Vector2 equal to the normalized given vector
  2408. * @param vector defines the vector to normalize
  2409. * @returns a new Vector2
  2410. */
  2411. static Normalize(vector: DeepImmutable<Vector2>): Vector2;
  2412. /**
  2413. * Gets a new Vector2 set with the minimal coordinate values from the "left" and "right" vectors
  2414. * @param left defines 1st vector
  2415. * @param right defines 2nd vector
  2416. * @returns a new Vector2
  2417. */
  2418. static Minimize(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): Vector2;
  2419. /**
  2420. * Gets a new Vecto2 set with the maximal coordinate values from the "left" and "right" vectors
  2421. * @param left defines 1st vector
  2422. * @param right defines 2nd vector
  2423. * @returns a new Vector2
  2424. */
  2425. static Maximize(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): Vector2;
  2426. /**
  2427. * Gets a new Vector2 set with the transformed coordinates of the given vector by the given transformation matrix
  2428. * @param vector defines the vector to transform
  2429. * @param transformation defines the matrix to apply
  2430. * @returns a new Vector2
  2431. */
  2432. static Transform(vector: DeepImmutable<Vector2>, transformation: DeepImmutable<Matrix>): Vector2;
  2433. /**
  2434. * Transforms the given vector coordinates by the given transformation matrix and stores the result in the vector "result" coordinates
  2435. * @param vector defines the vector to transform
  2436. * @param transformation defines the matrix to apply
  2437. * @param result defines the target vector
  2438. */
  2439. static TransformToRef(vector: DeepImmutable<Vector2>, transformation: DeepImmutable<Matrix>, result: Vector2): void;
  2440. /**
  2441. * Determines if a given vector is included in a triangle
  2442. * @param p defines the vector to test
  2443. * @param p0 defines 1st triangle point
  2444. * @param p1 defines 2nd triangle point
  2445. * @param p2 defines 3rd triangle point
  2446. * @returns true if the point "p" is in the triangle defined by the vertors "p0", "p1", "p2"
  2447. */
  2448. static PointInTriangle(p: DeepImmutable<Vector2>, p0: DeepImmutable<Vector2>, p1: DeepImmutable<Vector2>, p2: DeepImmutable<Vector2>): boolean;
  2449. /**
  2450. * Gets the distance between the vectors "value1" and "value2"
  2451. * @param value1 defines first vector
  2452. * @param value2 defines second vector
  2453. * @returns the distance between vectors
  2454. */
  2455. static Distance(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): number;
  2456. /**
  2457. * Returns the squared distance between the vectors "value1" and "value2"
  2458. * @param value1 defines first vector
  2459. * @param value2 defines second vector
  2460. * @returns the squared distance between vectors
  2461. */
  2462. static DistanceSquared(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): number;
  2463. /**
  2464. * Gets a new Vector2 located at the center of the vectors "value1" and "value2"
  2465. * @param value1 defines first vector
  2466. * @param value2 defines second vector
  2467. * @returns a new Vector2
  2468. */
  2469. static Center(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): Vector2;
  2470. /**
  2471. * Gets the shortest distance (float) between the point "p" and the segment defined by the two points "segA" and "segB".
  2472. * @param p defines the middle point
  2473. * @param segA defines one point of the segment
  2474. * @param segB defines the other point of the segment
  2475. * @returns the shortest distance
  2476. */
  2477. static DistanceOfPointFromSegment(p: DeepImmutable<Vector2>, segA: DeepImmutable<Vector2>, segB: DeepImmutable<Vector2>): number;
  2478. }
  2479. /**
  2480. * Class used to store (x,y,z) vector representation
  2481. * A Vector3 is the main object used in 3D geometry
  2482. * It can represent etiher the coordinates of a point the space, either a direction
  2483. * Reminder: js uses a left handed forward facing system
  2484. */
  2485. export class Vector3 {
  2486. private static _UpReadOnly;
  2487. private static _ZeroReadOnly;
  2488. /** @hidden */
  2489. _x: number;
  2490. /** @hidden */
  2491. _y: number;
  2492. /** @hidden */
  2493. _z: number;
  2494. /** @hidden */
  2495. _isDirty: boolean;
  2496. /** Gets or sets the x coordinate */
  2497. get x(): number;
  2498. set x(value: number);
  2499. /** Gets or sets the y coordinate */
  2500. get y(): number;
  2501. set y(value: number);
  2502. /** Gets or sets the z coordinate */
  2503. get z(): number;
  2504. set z(value: number);
  2505. /**
  2506. * Creates a new Vector3 object from the given x, y, z (floats) coordinates.
  2507. * @param x defines the first coordinates (on X axis)
  2508. * @param y defines the second coordinates (on Y axis)
  2509. * @param z defines the third coordinates (on Z axis)
  2510. */
  2511. constructor(x?: number, y?: number, z?: number);
  2512. /**
  2513. * Creates a string representation of the Vector3
  2514. * @returns a string with the Vector3 coordinates.
  2515. */
  2516. toString(): string;
  2517. /**
  2518. * Gets the class name
  2519. * @returns the string "Vector3"
  2520. */
  2521. getClassName(): string;
  2522. /**
  2523. * Creates the Vector3 hash code
  2524. * @returns a number which tends to be unique between Vector3 instances
  2525. */
  2526. getHashCode(): number;
  2527. /**
  2528. * Creates an array containing three elements : the coordinates of the Vector3
  2529. * @returns a new array of numbers
  2530. */
  2531. asArray(): number[];
  2532. /**
  2533. * Populates the given array or Float32Array from the given index with the successive coordinates of the Vector3
  2534. * @param array defines the destination array
  2535. * @param index defines the offset in the destination array
  2536. * @returns the current Vector3
  2537. */
  2538. toArray(array: FloatArray, index?: number): Vector3;
  2539. /**
  2540. * Update the current vector from an array
  2541. * @param array defines the destination array
  2542. * @param index defines the offset in the destination array
  2543. * @returns the current Vector3
  2544. */
  2545. fromArray(array: FloatArray, index?: number): Vector3;
  2546. /**
  2547. * Converts the current Vector3 into a quaternion (considering that the Vector3 contains Euler angles representation of a rotation)
  2548. * @returns a new Quaternion object, computed from the Vector3 coordinates
  2549. */
  2550. toQuaternion(): Quaternion;
  2551. /**
  2552. * Adds the given vector to the current Vector3
  2553. * @param otherVector defines the second operand
  2554. * @returns the current updated Vector3
  2555. */
  2556. addInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  2557. /**
  2558. * Adds the given coordinates to the current Vector3
  2559. * @param x defines the x coordinate of the operand
  2560. * @param y defines the y coordinate of the operand
  2561. * @param z defines the z coordinate of the operand
  2562. * @returns the current updated Vector3
  2563. */
  2564. addInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  2565. /**
  2566. * Gets a new Vector3, result of the addition the current Vector3 and the given vector
  2567. * @param otherVector defines the second operand
  2568. * @returns the resulting Vector3
  2569. */
  2570. add(otherVector: DeepImmutable<Vector3>): Vector3;
  2571. /**
  2572. * Adds the current Vector3 to the given one and stores the result in the vector "result"
  2573. * @param otherVector defines the second operand
  2574. * @param result defines the Vector3 object where to store the result
  2575. * @returns the current Vector3
  2576. */
  2577. addToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  2578. /**
  2579. * Subtract the given vector from the current Vector3
  2580. * @param otherVector defines the second operand
  2581. * @returns the current updated Vector3
  2582. */
  2583. subtractInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  2584. /**
  2585. * Returns a new Vector3, result of the subtraction of the given vector from the current Vector3
  2586. * @param otherVector defines the second operand
  2587. * @returns the resulting Vector3
  2588. */
  2589. subtract(otherVector: DeepImmutable<Vector3>): Vector3;
  2590. /**
  2591. * Subtracts the given vector from the current Vector3 and stores the result in the vector "result".
  2592. * @param otherVector defines the second operand
  2593. * @param result defines the Vector3 object where to store the result
  2594. * @returns the current Vector3
  2595. */
  2596. subtractToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  2597. /**
  2598. * Returns a new Vector3 set with the subtraction of the given floats from the current Vector3 coordinates
  2599. * @param x defines the x coordinate of the operand
  2600. * @param y defines the y coordinate of the operand
  2601. * @param z defines the z coordinate of the operand
  2602. * @returns the resulting Vector3
  2603. */
  2604. subtractFromFloats(x: number, y: number, z: number): Vector3;
  2605. /**
  2606. * Subtracts the given floats from the current Vector3 coordinates and set the given vector "result" with this result
  2607. * @param x defines the x coordinate of the operand
  2608. * @param y defines the y coordinate of the operand
  2609. * @param z defines the z coordinate of the operand
  2610. * @param result defines the Vector3 object where to store the result
  2611. * @returns the current Vector3
  2612. */
  2613. subtractFromFloatsToRef(x: number, y: number, z: number, result: Vector3): Vector3;
  2614. /**
  2615. * Gets a new Vector3 set with the current Vector3 negated coordinates
  2616. * @returns a new Vector3
  2617. */
  2618. negate(): Vector3;
  2619. /**
  2620. * Negate this vector in place
  2621. * @returns this
  2622. */
  2623. negateInPlace(): Vector3;
  2624. /**
  2625. * Negate the current Vector3 and stores the result in the given vector "result" coordinates
  2626. * @param result defines the Vector3 object where to store the result
  2627. * @returns the current Vector3
  2628. */
  2629. negateToRef(result: Vector3): Vector3;
  2630. /**
  2631. * Multiplies the Vector3 coordinates by the float "scale"
  2632. * @param scale defines the multiplier factor
  2633. * @returns the current updated Vector3
  2634. */
  2635. scaleInPlace(scale: number): Vector3;
  2636. /**
  2637. * Returns a new Vector3 set with the current Vector3 coordinates multiplied by the float "scale"
  2638. * @param scale defines the multiplier factor
  2639. * @returns a new Vector3
  2640. */
  2641. scale(scale: number): Vector3;
  2642. /**
  2643. * Multiplies the current Vector3 coordinates by the float "scale" and stores the result in the given vector "result" coordinates
  2644. * @param scale defines the multiplier factor
  2645. * @param result defines the Vector3 object where to store the result
  2646. * @returns the current Vector3
  2647. */
  2648. scaleToRef(scale: number, result: Vector3): Vector3;
  2649. /**
  2650. * Scale the current Vector3 values by a factor and add the result to a given Vector3
  2651. * @param scale defines the scale factor
  2652. * @param result defines the Vector3 object where to store the result
  2653. * @returns the unmodified current Vector3
  2654. */
  2655. scaleAndAddToRef(scale: number, result: Vector3): Vector3;
  2656. /**
  2657. * Projects the current vector3 to a plane along a ray starting from a specified origin and directed towards the point.
  2658. * @param origin defines the origin of the projection ray
  2659. * @param plane defines the plane to project to
  2660. * @returns the projected vector3
  2661. */
  2662. projectOnPlane(plane: Plane, origin: Vector3): Vector3;
  2663. /**
  2664. * Projects the current vector3 to a plane along a ray starting from a specified origin and directed towards the point.
  2665. * @param origin defines the origin of the projection ray
  2666. * @param plane defines the plane to project to
  2667. * @param result defines the Vector3 where to store the result
  2668. */
  2669. projectOnPlaneToRef(plane: Plane, origin: Vector3, result: Vector3): void;
  2670. /**
  2671. * Returns true if the current Vector3 and the given vector coordinates are strictly equal
  2672. * @param otherVector defines the second operand
  2673. * @returns true if both vectors are equals
  2674. */
  2675. equals(otherVector: DeepImmutable<Vector3>): boolean;
  2676. /**
  2677. * Returns true if the current Vector3 and the given vector coordinates are distant less than epsilon
  2678. * @param otherVector defines the second operand
  2679. * @param epsilon defines the minimal distance to define values as equals
  2680. * @returns true if both vectors are distant less than epsilon
  2681. */
  2682. equalsWithEpsilon(otherVector: DeepImmutable<Vector3>, epsilon?: number): boolean;
  2683. /**
  2684. * Returns true if the current Vector3 coordinates equals the given floats
  2685. * @param x defines the x coordinate of the operand
  2686. * @param y defines the y coordinate of the operand
  2687. * @param z defines the z coordinate of the operand
  2688. * @returns true if both vectors are equals
  2689. */
  2690. equalsToFloats(x: number, y: number, z: number): boolean;
  2691. /**
  2692. * Multiplies the current Vector3 coordinates by the given ones
  2693. * @param otherVector defines the second operand
  2694. * @returns the current updated Vector3
  2695. */
  2696. multiplyInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  2697. /**
  2698. * Returns a new Vector3, result of the multiplication of the current Vector3 by the given vector
  2699. * @param otherVector defines the second operand
  2700. * @returns the new Vector3
  2701. */
  2702. multiply(otherVector: DeepImmutable<Vector3>): Vector3;
  2703. /**
  2704. * Multiplies the current Vector3 by the given one and stores the result in the given vector "result"
  2705. * @param otherVector defines the second operand
  2706. * @param result defines the Vector3 object where to store the result
  2707. * @returns the current Vector3
  2708. */
  2709. multiplyToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  2710. /**
  2711. * Returns a new Vector3 set with the result of the mulliplication of the current Vector3 coordinates by the given floats
  2712. * @param x defines the x coordinate of the operand
  2713. * @param y defines the y coordinate of the operand
  2714. * @param z defines the z coordinate of the operand
  2715. * @returns the new Vector3
  2716. */
  2717. multiplyByFloats(x: number, y: number, z: number): Vector3;
  2718. /**
  2719. * Returns a new Vector3 set with the result of the division of the current Vector3 coordinates by the given ones
  2720. * @param otherVector defines the second operand
  2721. * @returns the new Vector3
  2722. */
  2723. divide(otherVector: DeepImmutable<Vector3>): Vector3;
  2724. /**
  2725. * Divides the current Vector3 coordinates by the given ones and stores the result in the given vector "result"
  2726. * @param otherVector defines the second operand
  2727. * @param result defines the Vector3 object where to store the result
  2728. * @returns the current Vector3
  2729. */
  2730. divideToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  2731. /**
  2732. * Divides the current Vector3 coordinates by the given ones.
  2733. * @param otherVector defines the second operand
  2734. * @returns the current updated Vector3
  2735. */
  2736. divideInPlace(otherVector: Vector3): Vector3;
  2737. /**
  2738. * Updates the current Vector3 with the minimal coordinate values between its and the given vector ones
  2739. * @param other defines the second operand
  2740. * @returns the current updated Vector3
  2741. */
  2742. minimizeInPlace(other: DeepImmutable<Vector3>): Vector3;
  2743. /**
  2744. * Updates the current Vector3 with the maximal coordinate values between its and the given vector ones.
  2745. * @param other defines the second operand
  2746. * @returns the current updated Vector3
  2747. */
  2748. maximizeInPlace(other: DeepImmutable<Vector3>): Vector3;
  2749. /**
  2750. * Updates the current Vector3 with the minimal coordinate values between its and the given coordinates
  2751. * @param x defines the x coordinate of the operand
  2752. * @param y defines the y coordinate of the operand
  2753. * @param z defines the z coordinate of the operand
  2754. * @returns the current updated Vector3
  2755. */
  2756. minimizeInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  2757. /**
  2758. * Updates the current Vector3 with the maximal coordinate values between its and the given coordinates.
  2759. * @param x defines the x coordinate of the operand
  2760. * @param y defines the y coordinate of the operand
  2761. * @param z defines the z coordinate of the operand
  2762. * @returns the current updated Vector3
  2763. */
  2764. maximizeInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  2765. /**
  2766. * Due to float precision, scale of a mesh could be uniform but float values are off by a small fraction
  2767. * Check if is non uniform within a certain amount of decimal places to account for this
  2768. * @param epsilon the amount the values can differ
  2769. * @returns if the the vector is non uniform to a certain number of decimal places
  2770. */
  2771. isNonUniformWithinEpsilon(epsilon: number): boolean;
  2772. /**
  2773. * Gets a boolean indicating that the vector is non uniform meaning x, y or z are not all the same
  2774. */
  2775. get isNonUniform(): boolean;
  2776. /**
  2777. * Gets a new Vector3 from current Vector3 floored values
  2778. * @returns a new Vector3
  2779. */
  2780. floor(): Vector3;
  2781. /**
  2782. * Gets a new Vector3 from current Vector3 floored values
  2783. * @returns a new Vector3
  2784. */
  2785. fract(): Vector3;
  2786. /**
  2787. * Gets the length of the Vector3
  2788. * @returns the length of the Vector3
  2789. */
  2790. length(): number;
  2791. /**
  2792. * Gets the squared length of the Vector3
  2793. * @returns squared length of the Vector3
  2794. */
  2795. lengthSquared(): number;
  2796. /**
  2797. * Normalize the current Vector3.
  2798. * Please note that this is an in place operation.
  2799. * @returns the current updated Vector3
  2800. */
  2801. normalize(): Vector3;
  2802. /**
  2803. * Reorders the x y z properties of the vector in place
  2804. * @param order new ordering of the properties (eg. for vector 1,2,3 with "ZYX" will produce 3,2,1)
  2805. * @returns the current updated vector
  2806. */
  2807. reorderInPlace(order: string): this;
  2808. /**
  2809. * Rotates the vector around 0,0,0 by a quaternion
  2810. * @param quaternion the rotation quaternion
  2811. * @param result vector to store the result
  2812. * @returns the resulting vector
  2813. */
  2814. rotateByQuaternionToRef(quaternion: Quaternion, result: Vector3): Vector3;
  2815. /**
  2816. * Rotates a vector around a given point
  2817. * @param quaternion the rotation quaternion
  2818. * @param point the point to rotate around
  2819. * @param result vector to store the result
  2820. * @returns the resulting vector
  2821. */
  2822. rotateByQuaternionAroundPointToRef(quaternion: Quaternion, point: Vector3, result: Vector3): Vector3;
  2823. /**
  2824. * Returns a new Vector3 as the cross product of the current vector and the "other" one
  2825. * The cross product is then orthogonal to both current and "other"
  2826. * @param other defines the right operand
  2827. * @returns the cross product
  2828. */
  2829. cross(other: Vector3): Vector3;
  2830. /**
  2831. * Normalize the current Vector3 with the given input length.
  2832. * Please note that this is an in place operation.
  2833. * @param len the length of the vector
  2834. * @returns the current updated Vector3
  2835. */
  2836. normalizeFromLength(len: number): Vector3;
  2837. /**
  2838. * Normalize the current Vector3 to a new vector
  2839. * @returns the new Vector3
  2840. */
  2841. normalizeToNew(): Vector3;
  2842. /**
  2843. * Normalize the current Vector3 to the reference
  2844. * @param reference define the Vector3 to update
  2845. * @returns the updated Vector3
  2846. */
  2847. normalizeToRef(reference: Vector3): Vector3;
  2848. /**
  2849. * Creates a new Vector3 copied from the current Vector3
  2850. * @returns the new Vector3
  2851. */
  2852. clone(): Vector3;
  2853. /**
  2854. * Copies the given vector coordinates to the current Vector3 ones
  2855. * @param source defines the source Vector3
  2856. * @returns the current updated Vector3
  2857. */
  2858. copyFrom(source: DeepImmutable<Vector3>): Vector3;
  2859. /**
  2860. * Copies the given floats to the current Vector3 coordinates
  2861. * @param x defines the x coordinate of the operand
  2862. * @param y defines the y coordinate of the operand
  2863. * @param z defines the z coordinate of the operand
  2864. * @returns the current updated Vector3
  2865. */
  2866. copyFromFloats(x: number, y: number, z: number): Vector3;
  2867. /**
  2868. * Copies the given floats to the current Vector3 coordinates
  2869. * @param x defines the x coordinate of the operand
  2870. * @param y defines the y coordinate of the operand
  2871. * @param z defines the z coordinate of the operand
  2872. * @returns the current updated Vector3
  2873. */
  2874. set(x: number, y: number, z: number): Vector3;
  2875. /**
  2876. * Copies the given float to the current Vector3 coordinates
  2877. * @param v defines the x, y and z coordinates of the operand
  2878. * @returns the current updated Vector3
  2879. */
  2880. setAll(v: number): Vector3;
  2881. /**
  2882. * Get the clip factor between two vectors
  2883. * @param vector0 defines the first operand
  2884. * @param vector1 defines the second operand
  2885. * @param axis defines the axis to use
  2886. * @param size defines the size along the axis
  2887. * @returns the clip factor
  2888. */
  2889. static GetClipFactor(vector0: DeepImmutable<Vector3>, vector1: DeepImmutable<Vector3>, axis: DeepImmutable<Vector3>, size: number): number;
  2890. /**
  2891. * Get angle between two vectors
  2892. * @param vector0 angle between vector0 and vector1
  2893. * @param vector1 angle between vector0 and vector1
  2894. * @param normal direction of the normal
  2895. * @return the angle between vector0 and vector1
  2896. */
  2897. static GetAngleBetweenVectors(vector0: DeepImmutable<Vector3>, vector1: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>): number;
  2898. /**
  2899. * Returns a new Vector3 set from the index "offset" of the given array
  2900. * @param array defines the source array
  2901. * @param offset defines the offset in the source array
  2902. * @returns the new Vector3
  2903. */
  2904. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector3;
  2905. /**
  2906. * Returns a new Vector3 set from the index "offset" of the given Float32Array
  2907. * @param array defines the source array
  2908. * @param offset defines the offset in the source array
  2909. * @returns the new Vector3
  2910. * @deprecated Please use FromArray instead.
  2911. */
  2912. static FromFloatArray(array: DeepImmutable<Float32Array>, offset?: number): Vector3;
  2913. /**
  2914. * Sets the given vector "result" with the element values from the index "offset" of the given array
  2915. * @param array defines the source array
  2916. * @param offset defines the offset in the source array
  2917. * @param result defines the Vector3 where to store the result
  2918. */
  2919. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector3): void;
  2920. /**
  2921. * Sets the given vector "result" with the element values from the index "offset" of the given Float32Array
  2922. * @param array defines the source array
  2923. * @param offset defines the offset in the source array
  2924. * @param result defines the Vector3 where to store the result
  2925. * @deprecated Please use FromArrayToRef instead.
  2926. */
  2927. static FromFloatArrayToRef(array: DeepImmutable<Float32Array>, offset: number, result: Vector3): void;
  2928. /**
  2929. * Sets the given vector "result" with the given floats.
  2930. * @param x defines the x coordinate of the source
  2931. * @param y defines the y coordinate of the source
  2932. * @param z defines the z coordinate of the source
  2933. * @param result defines the Vector3 where to store the result
  2934. */
  2935. static FromFloatsToRef(x: number, y: number, z: number, result: Vector3): void;
  2936. /**
  2937. * Returns a new Vector3 set to (0.0, 0.0, 0.0)
  2938. * @returns a new empty Vector3
  2939. */
  2940. static Zero(): Vector3;
  2941. /**
  2942. * Returns a new Vector3 set to (1.0, 1.0, 1.0)
  2943. * @returns a new unit Vector3
  2944. */
  2945. static One(): Vector3;
  2946. /**
  2947. * Returns a new Vector3 set to (0.0, 1.0, 0.0)
  2948. * @returns a new up Vector3
  2949. */
  2950. static Up(): Vector3;
  2951. /**
  2952. * Gets a up Vector3 that must not be updated
  2953. */
  2954. static get UpReadOnly(): DeepImmutable<Vector3>;
  2955. /**
  2956. * Gets a zero Vector3 that must not be updated
  2957. */
  2958. static get ZeroReadOnly(): DeepImmutable<Vector3>;
  2959. /**
  2960. * Returns a new Vector3 set to (0.0, -1.0, 0.0)
  2961. * @returns a new down Vector3
  2962. */
  2963. static Down(): Vector3;
  2964. /**
  2965. * Returns a new Vector3 set to (0.0, 0.0, 1.0)
  2966. * @param rightHandedSystem is the scene right-handed (negative z)
  2967. * @returns a new forward Vector3
  2968. */
  2969. static Forward(rightHandedSystem?: boolean): Vector3;
  2970. /**
  2971. * Returns a new Vector3 set to (0.0, 0.0, -1.0)
  2972. * @param rightHandedSystem is the scene right-handed (negative-z)
  2973. * @returns a new forward Vector3
  2974. */
  2975. static Backward(rightHandedSystem?: boolean): Vector3;
  2976. /**
  2977. * Returns a new Vector3 set to (1.0, 0.0, 0.0)
  2978. * @returns a new right Vector3
  2979. */
  2980. static Right(): Vector3;
  2981. /**
  2982. * Returns a new Vector3 set to (-1.0, 0.0, 0.0)
  2983. * @returns a new left Vector3
  2984. */
  2985. static Left(): Vector3;
  2986. /**
  2987. * Returns a new Vector3 set with the result of the transformation by the given matrix of the given vector.
  2988. * This method computes tranformed coordinates only, not transformed direction vectors (ie. it takes translation in account)
  2989. * @param vector defines the Vector3 to transform
  2990. * @param transformation defines the transformation matrix
  2991. * @returns the transformed Vector3
  2992. */
  2993. static TransformCoordinates(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>): Vector3;
  2994. /**
  2995. * Sets the given vector "result" coordinates with the result of the transformation by the given matrix of the given vector
  2996. * This method computes tranformed coordinates only, not transformed direction vectors (ie. it takes translation in account)
  2997. * @param vector defines the Vector3 to transform
  2998. * @param transformation defines the transformation matrix
  2999. * @param result defines the Vector3 where to store the result
  3000. */
  3001. static TransformCoordinatesToRef(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  3002. /**
  3003. * Sets the given vector "result" coordinates with the result of the transformation by the given matrix of the given floats (x, y, z)
  3004. * This method computes tranformed coordinates only, not transformed direction vectors
  3005. * @param x define the x coordinate of the source vector
  3006. * @param y define the y coordinate of the source vector
  3007. * @param z define the z coordinate of the source vector
  3008. * @param transformation defines the transformation matrix
  3009. * @param result defines the Vector3 where to store the result
  3010. */
  3011. static TransformCoordinatesFromFloatsToRef(x: number, y: number, z: number, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  3012. /**
  3013. * Returns a new Vector3 set with the result of the normal transformation by the given matrix of the given vector
  3014. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  3015. * @param vector defines the Vector3 to transform
  3016. * @param transformation defines the transformation matrix
  3017. * @returns the new Vector3
  3018. */
  3019. static TransformNormal(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>): Vector3;
  3020. /**
  3021. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given vector
  3022. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  3023. * @param vector defines the Vector3 to transform
  3024. * @param transformation defines the transformation matrix
  3025. * @param result defines the Vector3 where to store the result
  3026. */
  3027. static TransformNormalToRef(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  3028. /**
  3029. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given floats (x, y, z)
  3030. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  3031. * @param x define the x coordinate of the source vector
  3032. * @param y define the y coordinate of the source vector
  3033. * @param z define the z coordinate of the source vector
  3034. * @param transformation defines the transformation matrix
  3035. * @param result defines the Vector3 where to store the result
  3036. */
  3037. static TransformNormalFromFloatsToRef(x: number, y: number, z: number, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  3038. /**
  3039. * Returns a new Vector3 located for "amount" on the CatmullRom interpolation spline defined by the vectors "value1", "value2", "value3", "value4"
  3040. * @param value1 defines the first control point
  3041. * @param value2 defines the second control point
  3042. * @param value3 defines the third control point
  3043. * @param value4 defines the fourth control point
  3044. * @param amount defines the amount on the spline to use
  3045. * @returns the new Vector3
  3046. */
  3047. static CatmullRom(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>, value3: DeepImmutable<Vector3>, value4: DeepImmutable<Vector3>, amount: number): Vector3;
  3048. /**
  3049. * Returns a new Vector3 set with the coordinates of "value", if the vector "value" is in the cube defined by the vectors "min" and "max"
  3050. * If a coordinate value of "value" is lower than one of the "min" coordinate, then this "value" coordinate is set with the "min" one
  3051. * If a coordinate value of "value" is greater than one of the "max" coordinate, then this "value" coordinate is set with the "max" one
  3052. * @param value defines the current value
  3053. * @param min defines the lower range value
  3054. * @param max defines the upper range value
  3055. * @returns the new Vector3
  3056. */
  3057. static Clamp(value: DeepImmutable<Vector3>, min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>): Vector3;
  3058. /**
  3059. * Sets the given vector "result" with the coordinates of "value", if the vector "value" is in the cube defined by the vectors "min" and "max"
  3060. * If a coordinate value of "value" is lower than one of the "min" coordinate, then this "value" coordinate is set with the "min" one
  3061. * If a coordinate value of "value" is greater than one of the "max" coordinate, then this "value" coordinate is set with the "max" one
  3062. * @param value defines the current value
  3063. * @param min defines the lower range value
  3064. * @param max defines the upper range value
  3065. * @param result defines the Vector3 where to store the result
  3066. */
  3067. static ClampToRef(value: DeepImmutable<Vector3>, min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, result: Vector3): void;
  3068. /**
  3069. * Checks if a given vector is inside a specific range
  3070. * @param v defines the vector to test
  3071. * @param min defines the minimum range
  3072. * @param max defines the maximum range
  3073. */
  3074. static CheckExtends(v: Vector3, min: Vector3, max: Vector3): void;
  3075. /**
  3076. * Returns a new Vector3 located for "amount" (float) on the Hermite interpolation spline defined by the vectors "value1", "tangent1", "value2", "tangent2"
  3077. * @param value1 defines the first control point
  3078. * @param tangent1 defines the first tangent vector
  3079. * @param value2 defines the second control point
  3080. * @param tangent2 defines the second tangent vector
  3081. * @param amount defines the amount on the interpolation spline (between 0 and 1)
  3082. * @returns the new Vector3
  3083. */
  3084. static Hermite(value1: DeepImmutable<Vector3>, tangent1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>, tangent2: DeepImmutable<Vector3>, amount: number): Vector3;
  3085. /**
  3086. * Returns a new Vector3 located for "amount" (float) on the linear interpolation between the vectors "start" and "end"
  3087. * @param start defines the start value
  3088. * @param end defines the end value
  3089. * @param amount max defines amount between both (between 0 and 1)
  3090. * @returns the new Vector3
  3091. */
  3092. static Lerp(start: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, amount: number): Vector3;
  3093. /**
  3094. * Sets the given vector "result" with the result of the linear interpolation from the vector "start" for "amount" to the vector "end"
  3095. * @param start defines the start value
  3096. * @param end defines the end value
  3097. * @param amount max defines amount between both (between 0 and 1)
  3098. * @param result defines the Vector3 where to store the result
  3099. */
  3100. static LerpToRef(start: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, amount: number, result: Vector3): void;
  3101. /**
  3102. * Returns the dot product (float) between the vectors "left" and "right"
  3103. * @param left defines the left operand
  3104. * @param right defines the right operand
  3105. * @returns the dot product
  3106. */
  3107. static Dot(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): number;
  3108. /**
  3109. * Returns a new Vector3 as the cross product of the vectors "left" and "right"
  3110. * The cross product is then orthogonal to both "left" and "right"
  3111. * @param left defines the left operand
  3112. * @param right defines the right operand
  3113. * @returns the cross product
  3114. */
  3115. static Cross(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  3116. /**
  3117. * Sets the given vector "result" with the cross product of "left" and "right"
  3118. * The cross product is then orthogonal to both "left" and "right"
  3119. * @param left defines the left operand
  3120. * @param right defines the right operand
  3121. * @param result defines the Vector3 where to store the result
  3122. */
  3123. static CrossToRef(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>, result: Vector3): void;
  3124. /**
  3125. * Returns a new Vector3 as the normalization of the given vector
  3126. * @param vector defines the Vector3 to normalize
  3127. * @returns the new Vector3
  3128. */
  3129. static Normalize(vector: DeepImmutable<Vector3>): Vector3;
  3130. /**
  3131. * Sets the given vector "result" with the normalization of the given first vector
  3132. * @param vector defines the Vector3 to normalize
  3133. * @param result defines the Vector3 where to store the result
  3134. */
  3135. static NormalizeToRef(vector: DeepImmutable<Vector3>, result: Vector3): void;
  3136. /**
  3137. * Project a Vector3 onto screen space
  3138. * @param vector defines the Vector3 to project
  3139. * @param world defines the world matrix to use
  3140. * @param transform defines the transform (view x projection) matrix to use
  3141. * @param viewport defines the screen viewport to use
  3142. * @returns the new Vector3
  3143. */
  3144. static Project(vector: DeepImmutable<Vector3>, world: DeepImmutable<Matrix>, transform: DeepImmutable<Matrix>, viewport: DeepImmutable<Viewport>): Vector3;
  3145. /** @hidden */
  3146. static _UnprojectFromInvertedMatrixToRef(source: DeepImmutable<Vector3>, matrix: DeepImmutable<Matrix>, result: Vector3): void;
  3147. /**
  3148. * Unproject from screen space to object space
  3149. * @param source defines the screen space Vector3 to use
  3150. * @param viewportWidth defines the current width of the viewport
  3151. * @param viewportHeight defines the current height of the viewport
  3152. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  3153. * @param transform defines the transform (view x projection) matrix to use
  3154. * @returns the new Vector3
  3155. */
  3156. static UnprojectFromTransform(source: Vector3, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, transform: DeepImmutable<Matrix>): Vector3;
  3157. /**
  3158. * Unproject from screen space to object space
  3159. * @param source defines the screen space Vector3 to use
  3160. * @param viewportWidth defines the current width of the viewport
  3161. * @param viewportHeight defines the current height of the viewport
  3162. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  3163. * @param view defines the view matrix to use
  3164. * @param projection defines the projection matrix to use
  3165. * @returns the new Vector3
  3166. */
  3167. static Unproject(source: DeepImmutable<Vector3>, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Vector3;
  3168. /**
  3169. * Unproject from screen space to object space
  3170. * @param source defines the screen space Vector3 to use
  3171. * @param viewportWidth defines the current width of the viewport
  3172. * @param viewportHeight defines the current height of the viewport
  3173. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  3174. * @param view defines the view matrix to use
  3175. * @param projection defines the projection matrix to use
  3176. * @param result defines the Vector3 where to store the result
  3177. */
  3178. static UnprojectToRef(source: DeepImmutable<Vector3>, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, result: Vector3): void;
  3179. /**
  3180. * Unproject from screen space to object space
  3181. * @param sourceX defines the screen space x coordinate to use
  3182. * @param sourceY defines the screen space y coordinate to use
  3183. * @param sourceZ defines the screen space z coordinate to use
  3184. * @param viewportWidth defines the current width of the viewport
  3185. * @param viewportHeight defines the current height of the viewport
  3186. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  3187. * @param view defines the view matrix to use
  3188. * @param projection defines the projection matrix to use
  3189. * @param result defines the Vector3 where to store the result
  3190. */
  3191. static UnprojectFloatsToRef(sourceX: float, sourceY: float, sourceZ: float, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, result: Vector3): void;
  3192. /**
  3193. * Gets the minimal coordinate values between two Vector3
  3194. * @param left defines the first operand
  3195. * @param right defines the second operand
  3196. * @returns the new Vector3
  3197. */
  3198. static Minimize(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  3199. /**
  3200. * Gets the maximal coordinate values between two Vector3
  3201. * @param left defines the first operand
  3202. * @param right defines the second operand
  3203. * @returns the new Vector3
  3204. */
  3205. static Maximize(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  3206. /**
  3207. * Returns the distance between the vectors "value1" and "value2"
  3208. * @param value1 defines the first operand
  3209. * @param value2 defines the second operand
  3210. * @returns the distance
  3211. */
  3212. static Distance(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): number;
  3213. /**
  3214. * Returns the squared distance between the vectors "value1" and "value2"
  3215. * @param value1 defines the first operand
  3216. * @param value2 defines the second operand
  3217. * @returns the squared distance
  3218. */
  3219. static DistanceSquared(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): number;
  3220. /**
  3221. * Returns a new Vector3 located at the center between "value1" and "value2"
  3222. * @param value1 defines the first operand
  3223. * @param value2 defines the second operand
  3224. * @returns the new Vector3
  3225. */
  3226. static Center(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): Vector3;
  3227. /**
  3228. * Given three orthogonal normalized left-handed oriented Vector3 axis in space (target system),
  3229. * RotationFromAxis() returns the rotation Euler angles (ex : rotation.x, rotation.y, rotation.z) to apply
  3230. * to something in order to rotate it from its local system to the given target system
  3231. * Note: axis1, axis2 and axis3 are normalized during this operation
  3232. * @param axis1 defines the first axis
  3233. * @param axis2 defines the second axis
  3234. * @param axis3 defines the third axis
  3235. * @returns a new Vector3
  3236. */
  3237. static RotationFromAxis(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>): Vector3;
  3238. /**
  3239. * The same than RotationFromAxis but updates the given ref Vector3 parameter instead of returning a new Vector3
  3240. * @param axis1 defines the first axis
  3241. * @param axis2 defines the second axis
  3242. * @param axis3 defines the third axis
  3243. * @param ref defines the Vector3 where to store the result
  3244. */
  3245. static RotationFromAxisToRef(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>, ref: Vector3): void;
  3246. }
  3247. /**
  3248. * Vector4 class created for EulerAngle class conversion to Quaternion
  3249. */
  3250. export class Vector4 {
  3251. /** x value of the vector */
  3252. x: number;
  3253. /** y value of the vector */
  3254. y: number;
  3255. /** z value of the vector */
  3256. z: number;
  3257. /** w value of the vector */
  3258. w: number;
  3259. /**
  3260. * Creates a Vector4 object from the given floats.
  3261. * @param x x value of the vector
  3262. * @param y y value of the vector
  3263. * @param z z value of the vector
  3264. * @param w w value of the vector
  3265. */
  3266. constructor(
  3267. /** x value of the vector */
  3268. x: number,
  3269. /** y value of the vector */
  3270. y: number,
  3271. /** z value of the vector */
  3272. z: number,
  3273. /** w value of the vector */
  3274. w: number);
  3275. /**
  3276. * Returns the string with the Vector4 coordinates.
  3277. * @returns a string containing all the vector values
  3278. */
  3279. toString(): string;
  3280. /**
  3281. * Returns the string "Vector4".
  3282. * @returns "Vector4"
  3283. */
  3284. getClassName(): string;
  3285. /**
  3286. * Returns the Vector4 hash code.
  3287. * @returns a unique hash code
  3288. */
  3289. getHashCode(): number;
  3290. /**
  3291. * Returns a new array populated with 4 elements : the Vector4 coordinates.
  3292. * @returns the resulting array
  3293. */
  3294. asArray(): number[];
  3295. /**
  3296. * Populates the given array from the given index with the Vector4 coordinates.
  3297. * @param array array to populate
  3298. * @param index index of the array to start at (default: 0)
  3299. * @returns the Vector4.
  3300. */
  3301. toArray(array: FloatArray, index?: number): Vector4;
  3302. /**
  3303. * Update the current vector from an array
  3304. * @param array defines the destination array
  3305. * @param index defines the offset in the destination array
  3306. * @returns the current Vector3
  3307. */
  3308. fromArray(array: FloatArray, index?: number): Vector4;
  3309. /**
  3310. * Adds the given vector to the current Vector4.
  3311. * @param otherVector the vector to add
  3312. * @returns the updated Vector4.
  3313. */
  3314. addInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  3315. /**
  3316. * Returns a new Vector4 as the result of the addition of the current Vector4 and the given one.
  3317. * @param otherVector the vector to add
  3318. * @returns the resulting vector
  3319. */
  3320. add(otherVector: DeepImmutable<Vector4>): Vector4;
  3321. /**
  3322. * Updates the given vector "result" with the result of the addition of the current Vector4 and the given one.
  3323. * @param otherVector the vector to add
  3324. * @param result the vector to store the result
  3325. * @returns the current Vector4.
  3326. */
  3327. addToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  3328. /**
  3329. * Subtract in place the given vector from the current Vector4.
  3330. * @param otherVector the vector to subtract
  3331. * @returns the updated Vector4.
  3332. */
  3333. subtractInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  3334. /**
  3335. * Returns a new Vector4 with the result of the subtraction of the given vector from the current Vector4.
  3336. * @param otherVector the vector to add
  3337. * @returns the new vector with the result
  3338. */
  3339. subtract(otherVector: DeepImmutable<Vector4>): Vector4;
  3340. /**
  3341. * Sets the given vector "result" with the result of the subtraction of the given vector from the current Vector4.
  3342. * @param otherVector the vector to subtract
  3343. * @param result the vector to store the result
  3344. * @returns the current Vector4.
  3345. */
  3346. subtractToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  3347. /**
  3348. * Returns a new Vector4 set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  3349. */
  3350. /**
  3351. * Returns a new Vector4 set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  3352. * @param x value to subtract
  3353. * @param y value to subtract
  3354. * @param z value to subtract
  3355. * @param w value to subtract
  3356. * @returns new vector containing the result
  3357. */
  3358. subtractFromFloats(x: number, y: number, z: number, w: number): Vector4;
  3359. /**
  3360. * Sets the given vector "result" set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  3361. * @param x value to subtract
  3362. * @param y value to subtract
  3363. * @param z value to subtract
  3364. * @param w value to subtract
  3365. * @param result the vector to store the result in
  3366. * @returns the current Vector4.
  3367. */
  3368. subtractFromFloatsToRef(x: number, y: number, z: number, w: number, result: Vector4): Vector4;
  3369. /**
  3370. * Returns a new Vector4 set with the current Vector4 negated coordinates.
  3371. * @returns a new vector with the negated values
  3372. */
  3373. negate(): Vector4;
  3374. /**
  3375. * Negate this vector in place
  3376. * @returns this
  3377. */
  3378. negateInPlace(): Vector4;
  3379. /**
  3380. * Negate the current Vector4 and stores the result in the given vector "result" coordinates
  3381. * @param result defines the Vector3 object where to store the result
  3382. * @returns the current Vector4
  3383. */
  3384. negateToRef(result: Vector4): Vector4;
  3385. /**
  3386. * Multiplies the current Vector4 coordinates by scale (float).
  3387. * @param scale the number to scale with
  3388. * @returns the updated Vector4.
  3389. */
  3390. scaleInPlace(scale: number): Vector4;
  3391. /**
  3392. * Returns a new Vector4 set with the current Vector4 coordinates multiplied by scale (float).
  3393. * @param scale the number to scale with
  3394. * @returns a new vector with the result
  3395. */
  3396. scale(scale: number): Vector4;
  3397. /**
  3398. * Sets the given vector "result" with the current Vector4 coordinates multiplied by scale (float).
  3399. * @param scale the number to scale with
  3400. * @param result a vector to store the result in
  3401. * @returns the current Vector4.
  3402. */
  3403. scaleToRef(scale: number, result: Vector4): Vector4;
  3404. /**
  3405. * Scale the current Vector4 values by a factor and add the result to a given Vector4
  3406. * @param scale defines the scale factor
  3407. * @param result defines the Vector4 object where to store the result
  3408. * @returns the unmodified current Vector4
  3409. */
  3410. scaleAndAddToRef(scale: number, result: Vector4): Vector4;
  3411. /**
  3412. * Boolean : True if the current Vector4 coordinates are stricly equal to the given ones.
  3413. * @param otherVector the vector to compare against
  3414. * @returns true if they are equal
  3415. */
  3416. equals(otherVector: DeepImmutable<Vector4>): boolean;
  3417. /**
  3418. * Boolean : True if the current Vector4 coordinates are each beneath the distance "epsilon" from the given vector ones.
  3419. * @param otherVector vector to compare against
  3420. * @param epsilon (Default: very small number)
  3421. * @returns true if they are equal
  3422. */
  3423. equalsWithEpsilon(otherVector: DeepImmutable<Vector4>, epsilon?: number): boolean;
  3424. /**
  3425. * Boolean : True if the given floats are strictly equal to the current Vector4 coordinates.
  3426. * @param x x value to compare against
  3427. * @param y y value to compare against
  3428. * @param z z value to compare against
  3429. * @param w w value to compare against
  3430. * @returns true if equal
  3431. */
  3432. equalsToFloats(x: number, y: number, z: number, w: number): boolean;
  3433. /**
  3434. * Multiplies in place the current Vector4 by the given one.
  3435. * @param otherVector vector to multiple with
  3436. * @returns the updated Vector4.
  3437. */
  3438. multiplyInPlace(otherVector: Vector4): Vector4;
  3439. /**
  3440. * Returns a new Vector4 set with the multiplication result of the current Vector4 and the given one.
  3441. * @param otherVector vector to multiple with
  3442. * @returns resulting new vector
  3443. */
  3444. multiply(otherVector: DeepImmutable<Vector4>): Vector4;
  3445. /**
  3446. * Updates the given vector "result" with the multiplication result of the current Vector4 and the given one.
  3447. * @param otherVector vector to multiple with
  3448. * @param result vector to store the result
  3449. * @returns the current Vector4.
  3450. */
  3451. multiplyToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  3452. /**
  3453. * Returns a new Vector4 set with the multiplication result of the given floats and the current Vector4 coordinates.
  3454. * @param x x value multiply with
  3455. * @param y y value multiply with
  3456. * @param z z value multiply with
  3457. * @param w w value multiply with
  3458. * @returns resulting new vector
  3459. */
  3460. multiplyByFloats(x: number, y: number, z: number, w: number): Vector4;
  3461. /**
  3462. * Returns a new Vector4 set with the division result of the current Vector4 by the given one.
  3463. * @param otherVector vector to devide with
  3464. * @returns resulting new vector
  3465. */
  3466. divide(otherVector: DeepImmutable<Vector4>): Vector4;
  3467. /**
  3468. * Updates the given vector "result" with the division result of the current Vector4 by the given one.
  3469. * @param otherVector vector to devide with
  3470. * @param result vector to store the result
  3471. * @returns the current Vector4.
  3472. */
  3473. divideToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  3474. /**
  3475. * Divides the current Vector3 coordinates by the given ones.
  3476. * @param otherVector vector to devide with
  3477. * @returns the updated Vector3.
  3478. */
  3479. divideInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  3480. /**
  3481. * Updates the Vector4 coordinates with the minimum values between its own and the given vector ones
  3482. * @param other defines the second operand
  3483. * @returns the current updated Vector4
  3484. */
  3485. minimizeInPlace(other: DeepImmutable<Vector4>): Vector4;
  3486. /**
  3487. * Updates the Vector4 coordinates with the maximum values between its own and the given vector ones
  3488. * @param other defines the second operand
  3489. * @returns the current updated Vector4
  3490. */
  3491. maximizeInPlace(other: DeepImmutable<Vector4>): Vector4;
  3492. /**
  3493. * Gets a new Vector4 from current Vector4 floored values
  3494. * @returns a new Vector4
  3495. */
  3496. floor(): Vector4;
  3497. /**
  3498. * Gets a new Vector4 from current Vector3 floored values
  3499. * @returns a new Vector4
  3500. */
  3501. fract(): Vector4;
  3502. /**
  3503. * Returns the Vector4 length (float).
  3504. * @returns the length
  3505. */
  3506. length(): number;
  3507. /**
  3508. * Returns the Vector4 squared length (float).
  3509. * @returns the length squared
  3510. */
  3511. lengthSquared(): number;
  3512. /**
  3513. * Normalizes in place the Vector4.
  3514. * @returns the updated Vector4.
  3515. */
  3516. normalize(): Vector4;
  3517. /**
  3518. * Returns a new Vector3 from the Vector4 (x, y, z) coordinates.
  3519. * @returns this converted to a new vector3
  3520. */
  3521. toVector3(): Vector3;
  3522. /**
  3523. * Returns a new Vector4 copied from the current one.
  3524. * @returns the new cloned vector
  3525. */
  3526. clone(): Vector4;
  3527. /**
  3528. * Updates the current Vector4 with the given one coordinates.
  3529. * @param source the source vector to copy from
  3530. * @returns the updated Vector4.
  3531. */
  3532. copyFrom(source: DeepImmutable<Vector4>): Vector4;
  3533. /**
  3534. * Updates the current Vector4 coordinates with the given floats.
  3535. * @param x float to copy from
  3536. * @param y float to copy from
  3537. * @param z float to copy from
  3538. * @param w float to copy from
  3539. * @returns the updated Vector4.
  3540. */
  3541. copyFromFloats(x: number, y: number, z: number, w: number): Vector4;
  3542. /**
  3543. * Updates the current Vector4 coordinates with the given floats.
  3544. * @param x float to set from
  3545. * @param y float to set from
  3546. * @param z float to set from
  3547. * @param w float to set from
  3548. * @returns the updated Vector4.
  3549. */
  3550. set(x: number, y: number, z: number, w: number): Vector4;
  3551. /**
  3552. * Copies the given float to the current Vector3 coordinates
  3553. * @param v defines the x, y, z and w coordinates of the operand
  3554. * @returns the current updated Vector3
  3555. */
  3556. setAll(v: number): Vector4;
  3557. /**
  3558. * Returns a new Vector4 set from the starting index of the given array.
  3559. * @param array the array to pull values from
  3560. * @param offset the offset into the array to start at
  3561. * @returns the new vector
  3562. */
  3563. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector4;
  3564. /**
  3565. * Updates the given vector "result" from the starting index of the given array.
  3566. * @param array the array to pull values from
  3567. * @param offset the offset into the array to start at
  3568. * @param result the vector to store the result in
  3569. */
  3570. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector4): void;
  3571. /**
  3572. * Updates the given vector "result" from the starting index of the given Float32Array.
  3573. * @param array the array to pull values from
  3574. * @param offset the offset into the array to start at
  3575. * @param result the vector to store the result in
  3576. */
  3577. static FromFloatArrayToRef(array: DeepImmutable<Float32Array>, offset: number, result: Vector4): void;
  3578. /**
  3579. * Updates the given vector "result" coordinates from the given floats.
  3580. * @param x float to set from
  3581. * @param y float to set from
  3582. * @param z float to set from
  3583. * @param w float to set from
  3584. * @param result the vector to the floats in
  3585. */
  3586. static FromFloatsToRef(x: number, y: number, z: number, w: number, result: Vector4): void;
  3587. /**
  3588. * Returns a new Vector4 set to (0.0, 0.0, 0.0, 0.0)
  3589. * @returns the new vector
  3590. */
  3591. static Zero(): Vector4;
  3592. /**
  3593. * Returns a new Vector4 set to (1.0, 1.0, 1.0, 1.0)
  3594. * @returns the new vector
  3595. */
  3596. static One(): Vector4;
  3597. /**
  3598. * Returns a new normalized Vector4 from the given one.
  3599. * @param vector the vector to normalize
  3600. * @returns the vector
  3601. */
  3602. static Normalize(vector: DeepImmutable<Vector4>): Vector4;
  3603. /**
  3604. * Updates the given vector "result" from the normalization of the given one.
  3605. * @param vector the vector to normalize
  3606. * @param result the vector to store the result in
  3607. */
  3608. static NormalizeToRef(vector: DeepImmutable<Vector4>, result: Vector4): void;
  3609. /**
  3610. * Returns a vector with the minimum values from the left and right vectors
  3611. * @param left left vector to minimize
  3612. * @param right right vector to minimize
  3613. * @returns a new vector with the minimum of the left and right vector values
  3614. */
  3615. static Minimize(left: DeepImmutable<Vector4>, right: DeepImmutable<Vector4>): Vector4;
  3616. /**
  3617. * Returns a vector with the maximum values from the left and right vectors
  3618. * @param left left vector to maximize
  3619. * @param right right vector to maximize
  3620. * @returns a new vector with the maximum of the left and right vector values
  3621. */
  3622. static Maximize(left: DeepImmutable<Vector4>, right: DeepImmutable<Vector4>): Vector4;
  3623. /**
  3624. * Returns the distance (float) between the vectors "value1" and "value2".
  3625. * @param value1 value to calulate the distance between
  3626. * @param value2 value to calulate the distance between
  3627. * @return the distance between the two vectors
  3628. */
  3629. static Distance(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): number;
  3630. /**
  3631. * Returns the squared distance (float) between the vectors "value1" and "value2".
  3632. * @param value1 value to calulate the distance between
  3633. * @param value2 value to calulate the distance between
  3634. * @return the distance between the two vectors squared
  3635. */
  3636. static DistanceSquared(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): number;
  3637. /**
  3638. * Returns a new Vector4 located at the center between the vectors "value1" and "value2".
  3639. * @param value1 value to calulate the center between
  3640. * @param value2 value to calulate the center between
  3641. * @return the center between the two vectors
  3642. */
  3643. static Center(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): Vector4;
  3644. /**
  3645. * Returns a new Vector4 set with the result of the normal transformation by the given matrix of the given vector.
  3646. * This methods computes transformed normalized direction vectors only.
  3647. * @param vector the vector to transform
  3648. * @param transformation the transformation matrix to apply
  3649. * @returns the new vector
  3650. */
  3651. static TransformNormal(vector: DeepImmutable<Vector4>, transformation: DeepImmutable<Matrix>): Vector4;
  3652. /**
  3653. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given vector.
  3654. * This methods computes transformed normalized direction vectors only.
  3655. * @param vector the vector to transform
  3656. * @param transformation the transformation matrix to apply
  3657. * @param result the vector to store the result in
  3658. */
  3659. static TransformNormalToRef(vector: DeepImmutable<Vector4>, transformation: DeepImmutable<Matrix>, result: Vector4): void;
  3660. /**
  3661. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given floats (x, y, z, w).
  3662. * This methods computes transformed normalized direction vectors only.
  3663. * @param x value to transform
  3664. * @param y value to transform
  3665. * @param z value to transform
  3666. * @param w value to transform
  3667. * @param transformation the transformation matrix to apply
  3668. * @param result the vector to store the results in
  3669. */
  3670. static TransformNormalFromFloatsToRef(x: number, y: number, z: number, w: number, transformation: DeepImmutable<Matrix>, result: Vector4): void;
  3671. /**
  3672. * Creates a new Vector4 from a Vector3
  3673. * @param source defines the source data
  3674. * @param w defines the 4th component (default is 0)
  3675. * @returns a new Vector4
  3676. */
  3677. static FromVector3(source: Vector3, w?: number): Vector4;
  3678. }
  3679. /**
  3680. * Class used to store quaternion data
  3681. * @see https://en.wikipedia.org/wiki/Quaternion
  3682. * @see https://doc.babylonjs.com/features/position,_rotation,_scaling
  3683. */
  3684. export class Quaternion {
  3685. /** @hidden */
  3686. _x: number;
  3687. /** @hidden */
  3688. _y: number;
  3689. /** @hidden */
  3690. _z: number;
  3691. /** @hidden */
  3692. _w: number;
  3693. /** @hidden */
  3694. _isDirty: boolean;
  3695. /** Gets or sets the x coordinate */
  3696. get x(): number;
  3697. set x(value: number);
  3698. /** Gets or sets the y coordinate */
  3699. get y(): number;
  3700. set y(value: number);
  3701. /** Gets or sets the z coordinate */
  3702. get z(): number;
  3703. set z(value: number);
  3704. /** Gets or sets the w coordinate */
  3705. get w(): number;
  3706. set w(value: number);
  3707. /**
  3708. * Creates a new Quaternion from the given floats
  3709. * @param x defines the first component (0 by default)
  3710. * @param y defines the second component (0 by default)
  3711. * @param z defines the third component (0 by default)
  3712. * @param w defines the fourth component (1.0 by default)
  3713. */
  3714. constructor(x?: number, y?: number, z?: number, w?: number);
  3715. /**
  3716. * Gets a string representation for the current quaternion
  3717. * @returns a string with the Quaternion coordinates
  3718. */
  3719. toString(): string;
  3720. /**
  3721. * Gets the class name of the quaternion
  3722. * @returns the string "Quaternion"
  3723. */
  3724. getClassName(): string;
  3725. /**
  3726. * Gets a hash code for this quaternion
  3727. * @returns the quaternion hash code
  3728. */
  3729. getHashCode(): number;
  3730. /**
  3731. * Copy the quaternion to an array
  3732. * @returns a new array populated with 4 elements from the quaternion coordinates
  3733. */
  3734. asArray(): number[];
  3735. /**
  3736. * Check if two quaternions are equals
  3737. * @param otherQuaternion defines the second operand
  3738. * @return true if the current quaternion and the given one coordinates are strictly equals
  3739. */
  3740. equals(otherQuaternion: DeepImmutable<Quaternion>): boolean;
  3741. /**
  3742. * Gets a boolean if two quaternions are equals (using an epsilon value)
  3743. * @param otherQuaternion defines the other quaternion
  3744. * @param epsilon defines the minimal distance to consider equality
  3745. * @returns true if the given quaternion coordinates are close to the current ones by a distance of epsilon.
  3746. */
  3747. equalsWithEpsilon(otherQuaternion: DeepImmutable<Quaternion>, epsilon?: number): boolean;
  3748. /**
  3749. * Clone the current quaternion
  3750. * @returns a new quaternion copied from the current one
  3751. */
  3752. clone(): Quaternion;
  3753. /**
  3754. * Copy a quaternion to the current one
  3755. * @param other defines the other quaternion
  3756. * @returns the updated current quaternion
  3757. */
  3758. copyFrom(other: DeepImmutable<Quaternion>): Quaternion;
  3759. /**
  3760. * Updates the current quaternion with the given float coordinates
  3761. * @param x defines the x coordinate
  3762. * @param y defines the y coordinate
  3763. * @param z defines the z coordinate
  3764. * @param w defines the w coordinate
  3765. * @returns the updated current quaternion
  3766. */
  3767. copyFromFloats(x: number, y: number, z: number, w: number): Quaternion;
  3768. /**
  3769. * Updates the current quaternion from the given float coordinates
  3770. * @param x defines the x coordinate
  3771. * @param y defines the y coordinate
  3772. * @param z defines the z coordinate
  3773. * @param w defines the w coordinate
  3774. * @returns the updated current quaternion
  3775. */
  3776. set(x: number, y: number, z: number, w: number): Quaternion;
  3777. /**
  3778. * Adds two quaternions
  3779. * @param other defines the second operand
  3780. * @returns a new quaternion as the addition result of the given one and the current quaternion
  3781. */
  3782. add(other: DeepImmutable<Quaternion>): Quaternion;
  3783. /**
  3784. * Add a quaternion to the current one
  3785. * @param other defines the quaternion to add
  3786. * @returns the current quaternion
  3787. */
  3788. addInPlace(other: DeepImmutable<Quaternion>): Quaternion;
  3789. /**
  3790. * Subtract two quaternions
  3791. * @param other defines the second operand
  3792. * @returns a new quaternion as the subtraction result of the given one from the current one
  3793. */
  3794. subtract(other: Quaternion): Quaternion;
  3795. /**
  3796. * Multiplies the current quaternion by a scale factor
  3797. * @param value defines the scale factor
  3798. * @returns a new quaternion set by multiplying the current quaternion coordinates by the float "scale"
  3799. */
  3800. scale(value: number): Quaternion;
  3801. /**
  3802. * Scale the current quaternion values by a factor and stores the result to a given quaternion
  3803. * @param scale defines the scale factor
  3804. * @param result defines the Quaternion object where to store the result
  3805. * @returns the unmodified current quaternion
  3806. */
  3807. scaleToRef(scale: number, result: Quaternion): Quaternion;
  3808. /**
  3809. * Multiplies in place the current quaternion by a scale factor
  3810. * @param value defines the scale factor
  3811. * @returns the current modified quaternion
  3812. */
  3813. scaleInPlace(value: number): Quaternion;
  3814. /**
  3815. * Scale the current quaternion values by a factor and add the result to a given quaternion
  3816. * @param scale defines the scale factor
  3817. * @param result defines the Quaternion object where to store the result
  3818. * @returns the unmodified current quaternion
  3819. */
  3820. scaleAndAddToRef(scale: number, result: Quaternion): Quaternion;
  3821. /**
  3822. * Multiplies two quaternions
  3823. * @param q1 defines the second operand
  3824. * @returns a new quaternion set as the multiplication result of the current one with the given one "q1"
  3825. */
  3826. multiply(q1: DeepImmutable<Quaternion>): Quaternion;
  3827. /**
  3828. * Sets the given "result" as the the multiplication result of the current one with the given one "q1"
  3829. * @param q1 defines the second operand
  3830. * @param result defines the target quaternion
  3831. * @returns the current quaternion
  3832. */
  3833. multiplyToRef(q1: DeepImmutable<Quaternion>, result: Quaternion): Quaternion;
  3834. /**
  3835. * Updates the current quaternion with the multiplication of itself with the given one "q1"
  3836. * @param q1 defines the second operand
  3837. * @returns the currentupdated quaternion
  3838. */
  3839. multiplyInPlace(q1: DeepImmutable<Quaternion>): Quaternion;
  3840. /**
  3841. * Conjugates (1-q) the current quaternion and stores the result in the given quaternion
  3842. * @param ref defines the target quaternion
  3843. * @returns the current quaternion
  3844. */
  3845. conjugateToRef(ref: Quaternion): Quaternion;
  3846. /**
  3847. * Conjugates in place (1-q) the current quaternion
  3848. * @returns the current updated quaternion
  3849. */
  3850. conjugateInPlace(): Quaternion;
  3851. /**
  3852. * Conjugates in place (1-q) the current quaternion
  3853. * @returns a new quaternion
  3854. */
  3855. conjugate(): Quaternion;
  3856. /**
  3857. * Gets length of current quaternion
  3858. * @returns the quaternion length (float)
  3859. */
  3860. length(): number;
  3861. /**
  3862. * Normalize in place the current quaternion
  3863. * @returns the current updated quaternion
  3864. */
  3865. normalize(): Quaternion;
  3866. /**
  3867. * Returns a new Vector3 set with the Euler angles translated from the current quaternion
  3868. * @param order is a reserved parameter and is ignore for now
  3869. * @returns a new Vector3 containing the Euler angles
  3870. */
  3871. toEulerAngles(order?: string): Vector3;
  3872. /**
  3873. * Sets the given vector3 "result" with the Euler angles translated from the current quaternion
  3874. * @param result defines the vector which will be filled with the Euler angles
  3875. * @param order is a reserved parameter and is ignore for now
  3876. * @returns the current unchanged quaternion
  3877. */
  3878. toEulerAnglesToRef(result: Vector3): Quaternion;
  3879. /**
  3880. * Updates the given rotation matrix with the current quaternion values
  3881. * @param result defines the target matrix
  3882. * @returns the current unchanged quaternion
  3883. */
  3884. toRotationMatrix(result: Matrix): Quaternion;
  3885. /**
  3886. * Updates the current quaternion from the given rotation matrix values
  3887. * @param matrix defines the source matrix
  3888. * @returns the current updated quaternion
  3889. */
  3890. fromRotationMatrix(matrix: DeepImmutable<Matrix>): Quaternion;
  3891. /**
  3892. * Creates a new quaternion from a rotation matrix
  3893. * @param matrix defines the source matrix
  3894. * @returns a new quaternion created from the given rotation matrix values
  3895. */
  3896. static FromRotationMatrix(matrix: DeepImmutable<Matrix>): Quaternion;
  3897. /**
  3898. * Updates the given quaternion with the given rotation matrix values
  3899. * @param matrix defines the source matrix
  3900. * @param result defines the target quaternion
  3901. */
  3902. static FromRotationMatrixToRef(matrix: DeepImmutable<Matrix>, result: Quaternion): void;
  3903. /**
  3904. * Returns the dot product (float) between the quaternions "left" and "right"
  3905. * @param left defines the left operand
  3906. * @param right defines the right operand
  3907. * @returns the dot product
  3908. */
  3909. static Dot(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>): number;
  3910. /**
  3911. * Checks if the two quaternions are close to each other
  3912. * @param quat0 defines the first quaternion to check
  3913. * @param quat1 defines the second quaternion to check
  3914. * @returns true if the two quaternions are close to each other
  3915. */
  3916. static AreClose(quat0: DeepImmutable<Quaternion>, quat1: DeepImmutable<Quaternion>): boolean;
  3917. /**
  3918. * Creates an empty quaternion
  3919. * @returns a new quaternion set to (0.0, 0.0, 0.0)
  3920. */
  3921. static Zero(): Quaternion;
  3922. /**
  3923. * Inverse a given quaternion
  3924. * @param q defines the source quaternion
  3925. * @returns a new quaternion as the inverted current quaternion
  3926. */
  3927. static Inverse(q: DeepImmutable<Quaternion>): Quaternion;
  3928. /**
  3929. * Inverse a given quaternion
  3930. * @param q defines the source quaternion
  3931. * @param result the quaternion the result will be stored in
  3932. * @returns the result quaternion
  3933. */
  3934. static InverseToRef(q: Quaternion, result: Quaternion): Quaternion;
  3935. /**
  3936. * Creates an identity quaternion
  3937. * @returns the identity quaternion
  3938. */
  3939. static Identity(): Quaternion;
  3940. /**
  3941. * Gets a boolean indicating if the given quaternion is identity
  3942. * @param quaternion defines the quaternion to check
  3943. * @returns true if the quaternion is identity
  3944. */
  3945. static IsIdentity(quaternion: DeepImmutable<Quaternion>): boolean;
  3946. /**
  3947. * Creates a quaternion from a rotation around an axis
  3948. * @param axis defines the axis to use
  3949. * @param angle defines the angle to use
  3950. * @returns a new quaternion created from the given axis (Vector3) and angle in radians (float)
  3951. */
  3952. static RotationAxis(axis: DeepImmutable<Vector3>, angle: number): Quaternion;
  3953. /**
  3954. * Creates a rotation around an axis and stores it into the given quaternion
  3955. * @param axis defines the axis to use
  3956. * @param angle defines the angle to use
  3957. * @param result defines the target quaternion
  3958. * @returns the target quaternion
  3959. */
  3960. static RotationAxisToRef(axis: DeepImmutable<Vector3>, angle: number, result: Quaternion): Quaternion;
  3961. /**
  3962. * Creates a new quaternion from data stored into an array
  3963. * @param array defines the data source
  3964. * @param offset defines the offset in the source array where the data starts
  3965. * @returns a new quaternion
  3966. */
  3967. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Quaternion;
  3968. /**
  3969. * Updates the given quaternion "result" from the starting index of the given array.
  3970. * @param array the array to pull values from
  3971. * @param offset the offset into the array to start at
  3972. * @param result the quaternion to store the result in
  3973. */
  3974. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Quaternion): void;
  3975. /**
  3976. * Create a quaternion from Euler rotation angles
  3977. * @param x Pitch
  3978. * @param y Yaw
  3979. * @param z Roll
  3980. * @returns the new Quaternion
  3981. */
  3982. static FromEulerAngles(x: number, y: number, z: number): Quaternion;
  3983. /**
  3984. * Updates a quaternion from Euler rotation angles
  3985. * @param x Pitch
  3986. * @param y Yaw
  3987. * @param z Roll
  3988. * @param result the quaternion to store the result
  3989. * @returns the updated quaternion
  3990. */
  3991. static FromEulerAnglesToRef(x: number, y: number, z: number, result: Quaternion): Quaternion;
  3992. /**
  3993. * Create a quaternion from Euler rotation vector
  3994. * @param vec the Euler vector (x Pitch, y Yaw, z Roll)
  3995. * @returns the new Quaternion
  3996. */
  3997. static FromEulerVector(vec: DeepImmutable<Vector3>): Quaternion;
  3998. /**
  3999. * Updates a quaternion from Euler rotation vector
  4000. * @param vec the Euler vector (x Pitch, y Yaw, z Roll)
  4001. * @param result the quaternion to store the result
  4002. * @returns the updated quaternion
  4003. */
  4004. static FromEulerVectorToRef(vec: DeepImmutable<Vector3>, result: Quaternion): Quaternion;
  4005. /**
  4006. * Creates a new quaternion from the given Euler float angles (y, x, z)
  4007. * @param yaw defines the rotation around Y axis
  4008. * @param pitch defines the rotation around X axis
  4009. * @param roll defines the rotation around Z axis
  4010. * @returns the new quaternion
  4011. */
  4012. static RotationYawPitchRoll(yaw: number, pitch: number, roll: number): Quaternion;
  4013. /**
  4014. * Creates a new rotation from the given Euler float angles (y, x, z) and stores it in the target quaternion
  4015. * @param yaw defines the rotation around Y axis
  4016. * @param pitch defines the rotation around X axis
  4017. * @param roll defines the rotation around Z axis
  4018. * @param result defines the target quaternion
  4019. */
  4020. static RotationYawPitchRollToRef(yaw: number, pitch: number, roll: number, result: Quaternion): void;
  4021. /**
  4022. * Creates a new quaternion from the given Euler float angles expressed in z-x-z orientation
  4023. * @param alpha defines the rotation around first axis
  4024. * @param beta defines the rotation around second axis
  4025. * @param gamma defines the rotation around third axis
  4026. * @returns the new quaternion
  4027. */
  4028. static RotationAlphaBetaGamma(alpha: number, beta: number, gamma: number): Quaternion;
  4029. /**
  4030. * Creates a new quaternion from the given Euler float angles expressed in z-x-z orientation and stores it in the target quaternion
  4031. * @param alpha defines the rotation around first axis
  4032. * @param beta defines the rotation around second axis
  4033. * @param gamma defines the rotation around third axis
  4034. * @param result defines the target quaternion
  4035. */
  4036. static RotationAlphaBetaGammaToRef(alpha: number, beta: number, gamma: number, result: Quaternion): void;
  4037. /**
  4038. * Creates a new quaternion containing the rotation value to reach the target (axis1, axis2, axis3) orientation as a rotated XYZ system (axis1, axis2 and axis3 are normalized during this operation)
  4039. * @param axis1 defines the first axis
  4040. * @param axis2 defines the second axis
  4041. * @param axis3 defines the third axis
  4042. * @returns the new quaternion
  4043. */
  4044. static RotationQuaternionFromAxis(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>): Quaternion;
  4045. /**
  4046. * Creates a rotation value to reach the target (axis1, axis2, axis3) orientation as a rotated XYZ system (axis1, axis2 and axis3 are normalized during this operation) and stores it in the target quaternion
  4047. * @param axis1 defines the first axis
  4048. * @param axis2 defines the second axis
  4049. * @param axis3 defines the third axis
  4050. * @param ref defines the target quaternion
  4051. */
  4052. static RotationQuaternionFromAxisToRef(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>, ref: Quaternion): void;
  4053. /**
  4054. * Interpolates between two quaternions
  4055. * @param left defines first quaternion
  4056. * @param right defines second quaternion
  4057. * @param amount defines the gradient to use
  4058. * @returns the new interpolated quaternion
  4059. */
  4060. static Slerp(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>, amount: number): Quaternion;
  4061. /**
  4062. * Interpolates between two quaternions and stores it into a target quaternion
  4063. * @param left defines first quaternion
  4064. * @param right defines second quaternion
  4065. * @param amount defines the gradient to use
  4066. * @param result defines the target quaternion
  4067. */
  4068. static SlerpToRef(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>, amount: number, result: Quaternion): void;
  4069. /**
  4070. * Interpolate between two quaternions using Hermite interpolation
  4071. * @param value1 defines first quaternion
  4072. * @param tangent1 defines the incoming tangent
  4073. * @param value2 defines second quaternion
  4074. * @param tangent2 defines the outgoing tangent
  4075. * @param amount defines the target quaternion
  4076. * @returns the new interpolated quaternion
  4077. */
  4078. static Hermite(value1: DeepImmutable<Quaternion>, tangent1: DeepImmutable<Quaternion>, value2: DeepImmutable<Quaternion>, tangent2: DeepImmutable<Quaternion>, amount: number): Quaternion;
  4079. }
  4080. /**
  4081. * Class used to store matrix data (4x4)
  4082. */
  4083. export class Matrix {
  4084. /**
  4085. * Gets the precision of matrix computations
  4086. */
  4087. static get Use64Bits(): boolean;
  4088. private static _updateFlagSeed;
  4089. private static _identityReadOnly;
  4090. private _isIdentity;
  4091. private _isIdentityDirty;
  4092. private _isIdentity3x2;
  4093. private _isIdentity3x2Dirty;
  4094. /**
  4095. * Gets the update flag of the matrix which is an unique number for the matrix.
  4096. * It will be incremented every time the matrix data change.
  4097. * You can use it to speed the comparison between two versions of the same matrix.
  4098. */
  4099. updateFlag: number;
  4100. private readonly _m;
  4101. /**
  4102. * Gets the internal data of the matrix
  4103. */
  4104. get m(): DeepImmutable<Float32Array | Array<number>>;
  4105. /** @hidden */
  4106. _markAsUpdated(): void;
  4107. /** @hidden */
  4108. private _updateIdentityStatus;
  4109. /**
  4110. * Creates an empty matrix (filled with zeros)
  4111. */
  4112. constructor();
  4113. /**
  4114. * Check if the current matrix is identity
  4115. * @returns true is the matrix is the identity matrix
  4116. */
  4117. isIdentity(): boolean;
  4118. /**
  4119. * Check if the current matrix is identity as a texture matrix (3x2 store in 4x4)
  4120. * @returns true is the matrix is the identity matrix
  4121. */
  4122. isIdentityAs3x2(): boolean;
  4123. /**
  4124. * Gets the determinant of the matrix
  4125. * @returns the matrix determinant
  4126. */
  4127. determinant(): number;
  4128. /**
  4129. * Returns the matrix as a Float32Array or Array<number>
  4130. * @returns the matrix underlying array
  4131. */
  4132. toArray(): DeepImmutable<Float32Array | Array<number>>;
  4133. /**
  4134. * Returns the matrix as a Float32Array or Array<number>
  4135. * @returns the matrix underlying array.
  4136. */
  4137. asArray(): DeepImmutable<Float32Array | Array<number>>;
  4138. /**
  4139. * Inverts the current matrix in place
  4140. * @returns the current inverted matrix
  4141. */
  4142. invert(): Matrix;
  4143. /**
  4144. * Sets all the matrix elements to zero
  4145. * @returns the current matrix
  4146. */
  4147. reset(): Matrix;
  4148. /**
  4149. * Adds the current matrix with a second one
  4150. * @param other defines the matrix to add
  4151. * @returns a new matrix as the addition of the current matrix and the given one
  4152. */
  4153. add(other: DeepImmutable<Matrix>): Matrix;
  4154. /**
  4155. * Sets the given matrix "result" to the addition of the current matrix and the given one
  4156. * @param other defines the matrix to add
  4157. * @param result defines the target matrix
  4158. * @returns the current matrix
  4159. */
  4160. addToRef(other: DeepImmutable<Matrix>, result: Matrix): Matrix;
  4161. /**
  4162. * Adds in place the given matrix to the current matrix
  4163. * @param other defines the second operand
  4164. * @returns the current updated matrix
  4165. */
  4166. addToSelf(other: DeepImmutable<Matrix>): Matrix;
  4167. /**
  4168. * Sets the given matrix to the current inverted Matrix
  4169. * @param other defines the target matrix
  4170. * @returns the unmodified current matrix
  4171. */
  4172. invertToRef(other: Matrix): Matrix;
  4173. /**
  4174. * add a value at the specified position in the current Matrix
  4175. * @param index the index of the value within the matrix. between 0 and 15.
  4176. * @param value the value to be added
  4177. * @returns the current updated matrix
  4178. */
  4179. addAtIndex(index: number, value: number): Matrix;
  4180. /**
  4181. * mutiply the specified position in the current Matrix by a value
  4182. * @param index the index of the value within the matrix. between 0 and 15.
  4183. * @param value the value to be added
  4184. * @returns the current updated matrix
  4185. */
  4186. multiplyAtIndex(index: number, value: number): Matrix;
  4187. /**
  4188. * Inserts the translation vector (using 3 floats) in the current matrix
  4189. * @param x defines the 1st component of the translation
  4190. * @param y defines the 2nd component of the translation
  4191. * @param z defines the 3rd component of the translation
  4192. * @returns the current updated matrix
  4193. */
  4194. setTranslationFromFloats(x: number, y: number, z: number): Matrix;
  4195. /**
  4196. * Adds the translation vector (using 3 floats) in the current matrix
  4197. * @param x defines the 1st component of the translation
  4198. * @param y defines the 2nd component of the translation
  4199. * @param z defines the 3rd component of the translation
  4200. * @returns the current updated matrix
  4201. */
  4202. addTranslationFromFloats(x: number, y: number, z: number): Matrix;
  4203. /**
  4204. * Inserts the translation vector in the current matrix
  4205. * @param vector3 defines the translation to insert
  4206. * @returns the current updated matrix
  4207. */
  4208. setTranslation(vector3: DeepImmutable<Vector3>): Matrix;
  4209. /**
  4210. * Gets the translation value of the current matrix
  4211. * @returns a new Vector3 as the extracted translation from the matrix
  4212. */
  4213. getTranslation(): Vector3;
  4214. /**
  4215. * Fill a Vector3 with the extracted translation from the matrix
  4216. * @param result defines the Vector3 where to store the translation
  4217. * @returns the current matrix
  4218. */
  4219. getTranslationToRef(result: Vector3): Matrix;
  4220. /**
  4221. * Remove rotation and scaling part from the matrix
  4222. * @returns the updated matrix
  4223. */
  4224. removeRotationAndScaling(): Matrix;
  4225. /**
  4226. * Multiply two matrices
  4227. * @param other defines the second operand
  4228. * @returns a new matrix set with the multiplication result of the current Matrix and the given one
  4229. */
  4230. multiply(other: DeepImmutable<Matrix>): Matrix;
  4231. /**
  4232. * Copy the current matrix from the given one
  4233. * @param other defines the source matrix
  4234. * @returns the current updated matrix
  4235. */
  4236. copyFrom(other: DeepImmutable<Matrix>): Matrix;
  4237. /**
  4238. * Populates the given array from the starting index with the current matrix values
  4239. * @param array defines the target array
  4240. * @param offset defines the offset in the target array where to start storing values
  4241. * @returns the current matrix
  4242. */
  4243. copyToArray(array: Float32Array | Array<number>, offset?: number): Matrix;
  4244. /**
  4245. * Sets the given matrix "result" with the multiplication result of the current Matrix and the given one
  4246. * @param other defines the second operand
  4247. * @param result defines the matrix where to store the multiplication
  4248. * @returns the current matrix
  4249. */
  4250. multiplyToRef(other: DeepImmutable<Matrix>, result: Matrix): Matrix;
  4251. /**
  4252. * Sets the Float32Array "result" from the given index "offset" with the multiplication of the current matrix and the given one
  4253. * @param other defines the second operand
  4254. * @param result defines the array where to store the multiplication
  4255. * @param offset defines the offset in the target array where to start storing values
  4256. * @returns the current matrix
  4257. */
  4258. multiplyToArray(other: DeepImmutable<Matrix>, result: Float32Array | Array<number>, offset: number): Matrix;
  4259. /**
  4260. * Check equality between this matrix and a second one
  4261. * @param value defines the second matrix to compare
  4262. * @returns true is the current matrix and the given one values are strictly equal
  4263. */
  4264. equals(value: DeepImmutable<Matrix>): boolean;
  4265. /**
  4266. * Clone the current matrix
  4267. * @returns a new matrix from the current matrix
  4268. */
  4269. clone(): Matrix;
  4270. /**
  4271. * Returns the name of the current matrix class
  4272. * @returns the string "Matrix"
  4273. */
  4274. getClassName(): string;
  4275. /**
  4276. * Gets the hash code of the current matrix
  4277. * @returns the hash code
  4278. */
  4279. getHashCode(): number;
  4280. /**
  4281. * Decomposes the current Matrix into a translation, rotation and scaling components
  4282. * @param scale defines the scale vector3 given as a reference to update
  4283. * @param rotation defines the rotation quaternion given as a reference to update
  4284. * @param translation defines the translation vector3 given as a reference to update
  4285. * @returns true if operation was successful
  4286. */
  4287. decompose(scale?: Vector3, rotation?: Quaternion, translation?: Vector3): boolean;
  4288. /**
  4289. * Gets specific row of the matrix
  4290. * @param index defines the number of the row to get
  4291. * @returns the index-th row of the current matrix as a new Vector4
  4292. */
  4293. getRow(index: number): Nullable<Vector4>;
  4294. /**
  4295. * Sets the index-th row of the current matrix to the vector4 values
  4296. * @param index defines the number of the row to set
  4297. * @param row defines the target vector4
  4298. * @returns the updated current matrix
  4299. */
  4300. setRow(index: number, row: Vector4): Matrix;
  4301. /**
  4302. * Compute the transpose of the matrix
  4303. * @returns the new transposed matrix
  4304. */
  4305. transpose(): Matrix;
  4306. /**
  4307. * Compute the transpose of the matrix and store it in a given matrix
  4308. * @param result defines the target matrix
  4309. * @returns the current matrix
  4310. */
  4311. transposeToRef(result: Matrix): Matrix;
  4312. /**
  4313. * Sets the index-th row of the current matrix with the given 4 x float values
  4314. * @param index defines the row index
  4315. * @param x defines the x component to set
  4316. * @param y defines the y component to set
  4317. * @param z defines the z component to set
  4318. * @param w defines the w component to set
  4319. * @returns the updated current matrix
  4320. */
  4321. setRowFromFloats(index: number, x: number, y: number, z: number, w: number): Matrix;
  4322. /**
  4323. * Compute a new matrix set with the current matrix values multiplied by scale (float)
  4324. * @param scale defines the scale factor
  4325. * @returns a new matrix
  4326. */
  4327. scale(scale: number): Matrix;
  4328. /**
  4329. * Scale the current matrix values by a factor to a given result matrix
  4330. * @param scale defines the scale factor
  4331. * @param result defines the matrix to store the result
  4332. * @returns the current matrix
  4333. */
  4334. scaleToRef(scale: number, result: Matrix): Matrix;
  4335. /**
  4336. * Scale the current matrix values by a factor and add the result to a given matrix
  4337. * @param scale defines the scale factor
  4338. * @param result defines the Matrix to store the result
  4339. * @returns the current matrix
  4340. */
  4341. scaleAndAddToRef(scale: number, result: Matrix): Matrix;
  4342. /**
  4343. * Writes to the given matrix a normal matrix, computed from this one (using values from identity matrix for fourth row and column).
  4344. * @param ref matrix to store the result
  4345. */
  4346. toNormalMatrix(ref: Matrix): void;
  4347. /**
  4348. * Gets only rotation part of the current matrix
  4349. * @returns a new matrix sets to the extracted rotation matrix from the current one
  4350. */
  4351. getRotationMatrix(): Matrix;
  4352. /**
  4353. * Extracts the rotation matrix from the current one and sets it as the given "result"
  4354. * @param result defines the target matrix to store data to
  4355. * @returns the current matrix
  4356. */
  4357. getRotationMatrixToRef(result: Matrix): Matrix;
  4358. /**
  4359. * Toggles model matrix from being right handed to left handed in place and vice versa
  4360. */
  4361. toggleModelMatrixHandInPlace(): void;
  4362. /**
  4363. * Toggles projection matrix from being right handed to left handed in place and vice versa
  4364. */
  4365. toggleProjectionMatrixHandInPlace(): void;
  4366. /**
  4367. * Creates a matrix from an array
  4368. * @param array defines the source array
  4369. * @param offset defines an offset in the source array
  4370. * @returns a new Matrix set from the starting index of the given array
  4371. */
  4372. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Matrix;
  4373. /**
  4374. * Copy the content of an array into a given matrix
  4375. * @param array defines the source array
  4376. * @param offset defines an offset in the source array
  4377. * @param result defines the target matrix
  4378. */
  4379. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Matrix): void;
  4380. /**
  4381. * Stores an array into a matrix after having multiplied each component by a given factor
  4382. * @param array defines the source array
  4383. * @param offset defines the offset in the source array
  4384. * @param scale defines the scaling factor
  4385. * @param result defines the target matrix
  4386. */
  4387. static FromFloat32ArrayToRefScaled(array: DeepImmutable<Float32Array | Array<number>>, offset: number, scale: number, result: Matrix): void;
  4388. /**
  4389. * Gets an identity matrix that must not be updated
  4390. */
  4391. static get IdentityReadOnly(): DeepImmutable<Matrix>;
  4392. /**
  4393. * Stores a list of values (16) inside a given matrix
  4394. * @param initialM11 defines 1st value of 1st row
  4395. * @param initialM12 defines 2nd value of 1st row
  4396. * @param initialM13 defines 3rd value of 1st row
  4397. * @param initialM14 defines 4th value of 1st row
  4398. * @param initialM21 defines 1st value of 2nd row
  4399. * @param initialM22 defines 2nd value of 2nd row
  4400. * @param initialM23 defines 3rd value of 2nd row
  4401. * @param initialM24 defines 4th value of 2nd row
  4402. * @param initialM31 defines 1st value of 3rd row
  4403. * @param initialM32 defines 2nd value of 3rd row
  4404. * @param initialM33 defines 3rd value of 3rd row
  4405. * @param initialM34 defines 4th value of 3rd row
  4406. * @param initialM41 defines 1st value of 4th row
  4407. * @param initialM42 defines 2nd value of 4th row
  4408. * @param initialM43 defines 3rd value of 4th row
  4409. * @param initialM44 defines 4th value of 4th row
  4410. * @param result defines the target matrix
  4411. */
  4412. static FromValuesToRef(initialM11: number, initialM12: number, initialM13: number, initialM14: number, initialM21: number, initialM22: number, initialM23: number, initialM24: number, initialM31: number, initialM32: number, initialM33: number, initialM34: number, initialM41: number, initialM42: number, initialM43: number, initialM44: number, result: Matrix): void;
  4413. /**
  4414. * Creates new matrix from a list of values (16)
  4415. * @param initialM11 defines 1st value of 1st row
  4416. * @param initialM12 defines 2nd value of 1st row
  4417. * @param initialM13 defines 3rd value of 1st row
  4418. * @param initialM14 defines 4th value of 1st row
  4419. * @param initialM21 defines 1st value of 2nd row
  4420. * @param initialM22 defines 2nd value of 2nd row
  4421. * @param initialM23 defines 3rd value of 2nd row
  4422. * @param initialM24 defines 4th value of 2nd row
  4423. * @param initialM31 defines 1st value of 3rd row
  4424. * @param initialM32 defines 2nd value of 3rd row
  4425. * @param initialM33 defines 3rd value of 3rd row
  4426. * @param initialM34 defines 4th value of 3rd row
  4427. * @param initialM41 defines 1st value of 4th row
  4428. * @param initialM42 defines 2nd value of 4th row
  4429. * @param initialM43 defines 3rd value of 4th row
  4430. * @param initialM44 defines 4th value of 4th row
  4431. * @returns the new matrix
  4432. */
  4433. static FromValues(initialM11: number, initialM12: number, initialM13: number, initialM14: number, initialM21: number, initialM22: number, initialM23: number, initialM24: number, initialM31: number, initialM32: number, initialM33: number, initialM34: number, initialM41: number, initialM42: number, initialM43: number, initialM44: number): Matrix;
  4434. /**
  4435. * Creates a new matrix composed by merging scale (vector3), rotation (quaternion) and translation (vector3)
  4436. * @param scale defines the scale vector3
  4437. * @param rotation defines the rotation quaternion
  4438. * @param translation defines the translation vector3
  4439. * @returns a new matrix
  4440. */
  4441. static Compose(scale: DeepImmutable<Vector3>, rotation: DeepImmutable<Quaternion>, translation: DeepImmutable<Vector3>): Matrix;
  4442. /**
  4443. * Sets a matrix to a value composed by merging scale (vector3), rotation (quaternion) and translation (vector3)
  4444. * @param scale defines the scale vector3
  4445. * @param rotation defines the rotation quaternion
  4446. * @param translation defines the translation vector3
  4447. * @param result defines the target matrix
  4448. */
  4449. static ComposeToRef(scale: DeepImmutable<Vector3>, rotation: DeepImmutable<Quaternion>, translation: DeepImmutable<Vector3>, result: Matrix): void;
  4450. /**
  4451. * Creates a new identity matrix
  4452. * @returns a new identity matrix
  4453. */
  4454. static Identity(): Matrix;
  4455. /**
  4456. * Creates a new identity matrix and stores the result in a given matrix
  4457. * @param result defines the target matrix
  4458. */
  4459. static IdentityToRef(result: Matrix): void;
  4460. /**
  4461. * Creates a new zero matrix
  4462. * @returns a new zero matrix
  4463. */
  4464. static Zero(): Matrix;
  4465. /**
  4466. * Creates a new rotation matrix for "angle" radians around the X axis
  4467. * @param angle defines the angle (in radians) to use
  4468. * @return the new matrix
  4469. */
  4470. static RotationX(angle: number): Matrix;
  4471. /**
  4472. * Creates a new matrix as the invert of a given matrix
  4473. * @param source defines the source matrix
  4474. * @returns the new matrix
  4475. */
  4476. static Invert(source: DeepImmutable<Matrix>): Matrix;
  4477. /**
  4478. * Creates a new rotation matrix for "angle" radians around the X axis and stores it in a given matrix
  4479. * @param angle defines the angle (in radians) to use
  4480. * @param result defines the target matrix
  4481. */
  4482. static RotationXToRef(angle: number, result: Matrix): void;
  4483. /**
  4484. * Creates a new rotation matrix for "angle" radians around the Y axis
  4485. * @param angle defines the angle (in radians) to use
  4486. * @return the new matrix
  4487. */
  4488. static RotationY(angle: number): Matrix;
  4489. /**
  4490. * Creates a new rotation matrix for "angle" radians around the Y axis and stores it in a given matrix
  4491. * @param angle defines the angle (in radians) to use
  4492. * @param result defines the target matrix
  4493. */
  4494. static RotationYToRef(angle: number, result: Matrix): void;
  4495. /**
  4496. * Creates a new rotation matrix for "angle" radians around the Z axis
  4497. * @param angle defines the angle (in radians) to use
  4498. * @return the new matrix
  4499. */
  4500. static RotationZ(angle: number): Matrix;
  4501. /**
  4502. * Creates a new rotation matrix for "angle" radians around the Z axis and stores it in a given matrix
  4503. * @param angle defines the angle (in radians) to use
  4504. * @param result defines the target matrix
  4505. */
  4506. static RotationZToRef(angle: number, result: Matrix): void;
  4507. /**
  4508. * Creates a new rotation matrix for "angle" radians around the given axis
  4509. * @param axis defines the axis to use
  4510. * @param angle defines the angle (in radians) to use
  4511. * @return the new matrix
  4512. */
  4513. static RotationAxis(axis: DeepImmutable<Vector3>, angle: number): Matrix;
  4514. /**
  4515. * Creates a new rotation matrix for "angle" radians around the given axis and stores it in a given matrix
  4516. * @param axis defines the axis to use
  4517. * @param angle defines the angle (in radians) to use
  4518. * @param result defines the target matrix
  4519. */
  4520. static RotationAxisToRef(axis: DeepImmutable<Vector3>, angle: number, result: Matrix): void;
  4521. /**
  4522. * Takes normalised vectors and returns a rotation matrix to align "from" with "to".
  4523. * Taken from http://www.iquilezles.org/www/articles/noacos/noacos.htm
  4524. * @param from defines the vector to align
  4525. * @param to defines the vector to align to
  4526. * @param result defines the target matrix
  4527. */
  4528. static RotationAlignToRef(from: DeepImmutable<Vector3>, to: DeepImmutable<Vector3>, result: Matrix): void;
  4529. /**
  4530. * Creates a rotation matrix
  4531. * @param yaw defines the yaw angle in radians (Y axis)
  4532. * @param pitch defines the pitch angle in radians (X axis)
  4533. * @param roll defines the roll angle in radians (Z axis)
  4534. * @returns the new rotation matrix
  4535. */
  4536. static RotationYawPitchRoll(yaw: number, pitch: number, roll: number): Matrix;
  4537. /**
  4538. * Creates a rotation matrix and stores it in a given matrix
  4539. * @param yaw defines the yaw angle in radians (Y axis)
  4540. * @param pitch defines the pitch angle in radians (X axis)
  4541. * @param roll defines the roll angle in radians (Z axis)
  4542. * @param result defines the target matrix
  4543. */
  4544. static RotationYawPitchRollToRef(yaw: number, pitch: number, roll: number, result: Matrix): void;
  4545. /**
  4546. * Creates a scaling matrix
  4547. * @param x defines the scale factor on X axis
  4548. * @param y defines the scale factor on Y axis
  4549. * @param z defines the scale factor on Z axis
  4550. * @returns the new matrix
  4551. */
  4552. static Scaling(x: number, y: number, z: number): Matrix;
  4553. /**
  4554. * Creates a scaling matrix and stores it in a given matrix
  4555. * @param x defines the scale factor on X axis
  4556. * @param y defines the scale factor on Y axis
  4557. * @param z defines the scale factor on Z axis
  4558. * @param result defines the target matrix
  4559. */
  4560. static ScalingToRef(x: number, y: number, z: number, result: Matrix): void;
  4561. /**
  4562. * Creates a translation matrix
  4563. * @param x defines the translation on X axis
  4564. * @param y defines the translation on Y axis
  4565. * @param z defines the translationon Z axis
  4566. * @returns the new matrix
  4567. */
  4568. static Translation(x: number, y: number, z: number): Matrix;
  4569. /**
  4570. * Creates a translation matrix and stores it in a given matrix
  4571. * @param x defines the translation on X axis
  4572. * @param y defines the translation on Y axis
  4573. * @param z defines the translationon Z axis
  4574. * @param result defines the target matrix
  4575. */
  4576. static TranslationToRef(x: number, y: number, z: number, result: Matrix): void;
  4577. /**
  4578. * Returns a new Matrix whose values are the interpolated values for "gradient" (float) between the ones of the matrices "startValue" and "endValue".
  4579. * @param startValue defines the start value
  4580. * @param endValue defines the end value
  4581. * @param gradient defines the gradient factor
  4582. * @returns the new matrix
  4583. */
  4584. static Lerp(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number): Matrix;
  4585. /**
  4586. * Set the given matrix "result" as the interpolated values for "gradient" (float) between the ones of the matrices "startValue" and "endValue".
  4587. * @param startValue defines the start value
  4588. * @param endValue defines the end value
  4589. * @param gradient defines the gradient factor
  4590. * @param result defines the Matrix object where to store data
  4591. */
  4592. static LerpToRef(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number, result: Matrix): void;
  4593. /**
  4594. * Builds a new matrix whose values are computed by:
  4595. * * decomposing the the "startValue" and "endValue" matrices into their respective scale, rotation and translation matrices
  4596. * * interpolating for "gradient" (float) the values between each of these decomposed matrices between the start and the end
  4597. * * recomposing a new matrix from these 3 interpolated scale, rotation and translation matrices
  4598. * @param startValue defines the first matrix
  4599. * @param endValue defines the second matrix
  4600. * @param gradient defines the gradient between the two matrices
  4601. * @returns the new matrix
  4602. */
  4603. static DecomposeLerp(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number): Matrix;
  4604. /**
  4605. * Update a matrix to values which are computed by:
  4606. * * decomposing the the "startValue" and "endValue" matrices into their respective scale, rotation and translation matrices
  4607. * * interpolating for "gradient" (float) the values between each of these decomposed matrices between the start and the end
  4608. * * recomposing a new matrix from these 3 interpolated scale, rotation and translation matrices
  4609. * @param startValue defines the first matrix
  4610. * @param endValue defines the second matrix
  4611. * @param gradient defines the gradient between the two matrices
  4612. * @param result defines the target matrix
  4613. */
  4614. static DecomposeLerpToRef(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number, result: Matrix): void;
  4615. /**
  4616. * Gets a new rotation matrix used to rotate an entity so as it looks at the target vector3, from the eye vector3 position, the up vector3 being oriented like "up"
  4617. * This function works in left handed mode
  4618. * @param eye defines the final position of the entity
  4619. * @param target defines where the entity should look at
  4620. * @param up defines the up vector for the entity
  4621. * @returns the new matrix
  4622. */
  4623. static LookAtLH(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>): Matrix;
  4624. /**
  4625. * Sets the given "result" Matrix to a rotation matrix used to rotate an entity so that it looks at the target vector3, from the eye vector3 position, the up vector3 being oriented like "up".
  4626. * This function works in left handed mode
  4627. * @param eye defines the final position of the entity
  4628. * @param target defines where the entity should look at
  4629. * @param up defines the up vector for the entity
  4630. * @param result defines the target matrix
  4631. */
  4632. static LookAtLHToRef(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>, result: Matrix): void;
  4633. /**
  4634. * Gets a new rotation matrix used to rotate an entity so as it looks at the target vector3, from the eye vector3 position, the up vector3 being oriented like "up"
  4635. * This function works in right handed mode
  4636. * @param eye defines the final position of the entity
  4637. * @param target defines where the entity should look at
  4638. * @param up defines the up vector for the entity
  4639. * @returns the new matrix
  4640. */
  4641. static LookAtRH(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>): Matrix;
  4642. /**
  4643. * Sets the given "result" Matrix to a rotation matrix used to rotate an entity so that it looks at the target vector3, from the eye vector3 position, the up vector3 being oriented like "up".
  4644. * This function works in right handed mode
  4645. * @param eye defines the final position of the entity
  4646. * @param target defines where the entity should look at
  4647. * @param up defines the up vector for the entity
  4648. * @param result defines the target matrix
  4649. */
  4650. static LookAtRHToRef(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>, result: Matrix): void;
  4651. /**
  4652. * Create a left-handed orthographic projection matrix
  4653. * @param width defines the viewport width
  4654. * @param height defines the viewport height
  4655. * @param znear defines the near clip plane
  4656. * @param zfar defines the far clip plane
  4657. * @returns a new matrix as a left-handed orthographic projection matrix
  4658. */
  4659. static OrthoLH(width: number, height: number, znear: number, zfar: number): Matrix;
  4660. /**
  4661. * Store a left-handed orthographic projection to a given matrix
  4662. * @param width defines the viewport width
  4663. * @param height defines the viewport height
  4664. * @param znear defines the near clip plane
  4665. * @param zfar defines the far clip plane
  4666. * @param result defines the target matrix
  4667. */
  4668. static OrthoLHToRef(width: number, height: number, znear: number, zfar: number, result: Matrix): void;
  4669. /**
  4670. * Create a left-handed orthographic projection matrix
  4671. * @param left defines the viewport left coordinate
  4672. * @param right defines the viewport right coordinate
  4673. * @param bottom defines the viewport bottom coordinate
  4674. * @param top defines the viewport top coordinate
  4675. * @param znear defines the near clip plane
  4676. * @param zfar defines the far clip plane
  4677. * @returns a new matrix as a left-handed orthographic projection matrix
  4678. */
  4679. static OrthoOffCenterLH(left: number, right: number, bottom: number, top: number, znear: number, zfar: number): Matrix;
  4680. /**
  4681. * Stores a left-handed orthographic projection into a given matrix
  4682. * @param left defines the viewport left coordinate
  4683. * @param right defines the viewport right coordinate
  4684. * @param bottom defines the viewport bottom coordinate
  4685. * @param top defines the viewport top coordinate
  4686. * @param znear defines the near clip plane
  4687. * @param zfar defines the far clip plane
  4688. * @param result defines the target matrix
  4689. */
  4690. static OrthoOffCenterLHToRef(left: number, right: number, bottom: number, top: number, znear: number, zfar: number, result: Matrix): void;
  4691. /**
  4692. * Creates a right-handed orthographic projection matrix
  4693. * @param left defines the viewport left coordinate
  4694. * @param right defines the viewport right coordinate
  4695. * @param bottom defines the viewport bottom coordinate
  4696. * @param top defines the viewport top coordinate
  4697. * @param znear defines the near clip plane
  4698. * @param zfar defines the far clip plane
  4699. * @returns a new matrix as a right-handed orthographic projection matrix
  4700. */
  4701. static OrthoOffCenterRH(left: number, right: number, bottom: number, top: number, znear: number, zfar: number): Matrix;
  4702. /**
  4703. * Stores a right-handed orthographic projection into a given matrix
  4704. * @param left defines the viewport left coordinate
  4705. * @param right defines the viewport right coordinate
  4706. * @param bottom defines the viewport bottom coordinate
  4707. * @param top defines the viewport top coordinate
  4708. * @param znear defines the near clip plane
  4709. * @param zfar defines the far clip plane
  4710. * @param result defines the target matrix
  4711. */
  4712. static OrthoOffCenterRHToRef(left: number, right: number, bottom: number, top: number, znear: number, zfar: number, result: Matrix): void;
  4713. /**
  4714. * Creates a left-handed perspective projection matrix
  4715. * @param width defines the viewport width
  4716. * @param height defines the viewport height
  4717. * @param znear defines the near clip plane
  4718. * @param zfar defines the far clip plane
  4719. * @returns a new matrix as a left-handed perspective projection matrix
  4720. */
  4721. static PerspectiveLH(width: number, height: number, znear: number, zfar: number): Matrix;
  4722. /**
  4723. * Creates a left-handed perspective projection matrix
  4724. * @param fov defines the horizontal field of view
  4725. * @param aspect defines the aspect ratio
  4726. * @param znear defines the near clip plane
  4727. * @param zfar defines the far clip plane
  4728. * @returns a new matrix as a left-handed perspective projection matrix
  4729. */
  4730. static PerspectiveFovLH(fov: number, aspect: number, znear: number, zfar: number): Matrix;
  4731. /**
  4732. * Stores a left-handed perspective projection into a given matrix
  4733. * @param fov defines the horizontal field of view
  4734. * @param aspect defines the aspect ratio
  4735. * @param znear defines the near clip plane
  4736. * @param zfar defines the far clip plane
  4737. * @param result defines the target matrix
  4738. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  4739. */
  4740. static PerspectiveFovLHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  4741. /**
  4742. * Stores a left-handed perspective projection into a given matrix with depth reversed
  4743. * @param fov defines the horizontal field of view
  4744. * @param aspect defines the aspect ratio
  4745. * @param znear defines the near clip plane
  4746. * @param zfar not used as infinity is used as far clip
  4747. * @param result defines the target matrix
  4748. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  4749. */
  4750. static PerspectiveFovReverseLHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  4751. /**
  4752. * Creates a right-handed perspective projection matrix
  4753. * @param fov defines the horizontal field of view
  4754. * @param aspect defines the aspect ratio
  4755. * @param znear defines the near clip plane
  4756. * @param zfar defines the far clip plane
  4757. * @returns a new matrix as a right-handed perspective projection matrix
  4758. */
  4759. static PerspectiveFovRH(fov: number, aspect: number, znear: number, zfar: number): Matrix;
  4760. /**
  4761. * Stores a right-handed perspective projection into a given matrix
  4762. * @param fov defines the horizontal field of view
  4763. * @param aspect defines the aspect ratio
  4764. * @param znear defines the near clip plane
  4765. * @param zfar defines the far clip plane
  4766. * @param result defines the target matrix
  4767. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  4768. */
  4769. static PerspectiveFovRHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  4770. /**
  4771. * Stores a right-handed perspective projection into a given matrix
  4772. * @param fov defines the horizontal field of view
  4773. * @param aspect defines the aspect ratio
  4774. * @param znear defines the near clip plane
  4775. * @param zfar not used as infinity is used as far clip
  4776. * @param result defines the target matrix
  4777. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  4778. */
  4779. static PerspectiveFovReverseRHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  4780. /**
  4781. * Stores a perspective projection for WebVR info a given matrix
  4782. * @param fov defines the field of view
  4783. * @param znear defines the near clip plane
  4784. * @param zfar defines the far clip plane
  4785. * @param result defines the target matrix
  4786. * @param rightHanded defines if the matrix must be in right-handed mode (false by default)
  4787. */
  4788. static PerspectiveFovWebVRToRef(fov: {
  4789. upDegrees: number;
  4790. downDegrees: number;
  4791. leftDegrees: number;
  4792. rightDegrees: number;
  4793. }, znear: number, zfar: number, result: Matrix, rightHanded?: boolean): void;
  4794. /**
  4795. * Computes a complete transformation matrix
  4796. * @param viewport defines the viewport to use
  4797. * @param world defines the world matrix
  4798. * @param view defines the view matrix
  4799. * @param projection defines the projection matrix
  4800. * @param zmin defines the near clip plane
  4801. * @param zmax defines the far clip plane
  4802. * @returns the transformation matrix
  4803. */
  4804. static GetFinalMatrix(viewport: DeepImmutable<Viewport>, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, zmin: number, zmax: number): Matrix;
  4805. /**
  4806. * Extracts a 2x2 matrix from a given matrix and store the result in a Float32Array
  4807. * @param matrix defines the matrix to use
  4808. * @returns a new Float32Array array with 4 elements : the 2x2 matrix extracted from the given matrix
  4809. */
  4810. static GetAsMatrix2x2(matrix: DeepImmutable<Matrix>): Float32Array | Array<number>;
  4811. /**
  4812. * Extracts a 3x3 matrix from a given matrix and store the result in a Float32Array
  4813. * @param matrix defines the matrix to use
  4814. * @returns a new Float32Array array with 9 elements : the 3x3 matrix extracted from the given matrix
  4815. */
  4816. static GetAsMatrix3x3(matrix: DeepImmutable<Matrix>): Float32Array | Array<number>;
  4817. /**
  4818. * Compute the transpose of a given matrix
  4819. * @param matrix defines the matrix to transpose
  4820. * @returns the new matrix
  4821. */
  4822. static Transpose(matrix: DeepImmutable<Matrix>): Matrix;
  4823. /**
  4824. * Compute the transpose of a matrix and store it in a target matrix
  4825. * @param matrix defines the matrix to transpose
  4826. * @param result defines the target matrix
  4827. */
  4828. static TransposeToRef(matrix: DeepImmutable<Matrix>, result: Matrix): void;
  4829. /**
  4830. * Computes a reflection matrix from a plane
  4831. * @param plane defines the reflection plane
  4832. * @returns a new matrix
  4833. */
  4834. static Reflection(plane: DeepImmutable<IPlaneLike>): Matrix;
  4835. /**
  4836. * Computes a reflection matrix from a plane
  4837. * @param plane defines the reflection plane
  4838. * @param result defines the target matrix
  4839. */
  4840. static ReflectionToRef(plane: DeepImmutable<IPlaneLike>, result: Matrix): void;
  4841. /**
  4842. * Sets the given matrix as a rotation matrix composed from the 3 left handed axes
  4843. * @param xaxis defines the value of the 1st axis
  4844. * @param yaxis defines the value of the 2nd axis
  4845. * @param zaxis defines the value of the 3rd axis
  4846. * @param result defines the target matrix
  4847. */
  4848. static FromXYZAxesToRef(xaxis: DeepImmutable<Vector3>, yaxis: DeepImmutable<Vector3>, zaxis: DeepImmutable<Vector3>, result: Matrix): void;
  4849. /**
  4850. * Creates a rotation matrix from a quaternion and stores it in a target matrix
  4851. * @param quat defines the quaternion to use
  4852. * @param result defines the target matrix
  4853. */
  4854. static FromQuaternionToRef(quat: DeepImmutable<Quaternion>, result: Matrix): void;
  4855. }
  4856. /**
  4857. * @hidden
  4858. */
  4859. export class TmpVectors {
  4860. static Vector2: Vector2[];
  4861. static Vector3: Vector3[];
  4862. static Vector4: Vector4[];
  4863. static Quaternion: Quaternion[];
  4864. static Matrix: Matrix[];
  4865. }
  4866. }
  4867. declare module "babylonjs/Maths/math.path" {
  4868. import { DeepImmutable, Nullable } from "babylonjs/types";
  4869. import { Vector2, Vector3 } from "babylonjs/Maths/math.vector";
  4870. /**
  4871. * Defines potential orientation for back face culling
  4872. */
  4873. export enum Orientation {
  4874. /**
  4875. * Clockwise
  4876. */
  4877. CW = 0,
  4878. /** Counter clockwise */
  4879. CCW = 1
  4880. }
  4881. /** Class used to represent a Bezier curve */
  4882. export class BezierCurve {
  4883. /**
  4884. * Returns the cubic Bezier interpolated value (float) at "t" (float) from the given x1, y1, x2, y2 floats
  4885. * @param t defines the time
  4886. * @param x1 defines the left coordinate on X axis
  4887. * @param y1 defines the left coordinate on Y axis
  4888. * @param x2 defines the right coordinate on X axis
  4889. * @param y2 defines the right coordinate on Y axis
  4890. * @returns the interpolated value
  4891. */
  4892. static Interpolate(t: number, x1: number, y1: number, x2: number, y2: number): number;
  4893. }
  4894. /**
  4895. * Defines angle representation
  4896. */
  4897. export class Angle {
  4898. private _radians;
  4899. /**
  4900. * Creates an Angle object of "radians" radians (float).
  4901. * @param radians the angle in radians
  4902. */
  4903. constructor(radians: number);
  4904. /**
  4905. * Get value in degrees
  4906. * @returns the Angle value in degrees (float)
  4907. */
  4908. degrees(): number;
  4909. /**
  4910. * Get value in radians
  4911. * @returns the Angle value in radians (float)
  4912. */
  4913. radians(): number;
  4914. /**
  4915. * Gets a new Angle object valued with the gradient angle, in radians, of the line joining two points
  4916. * @param a defines first point as the origin
  4917. * @param b defines point
  4918. * @returns a new Angle
  4919. */
  4920. static BetweenTwoPoints(a: DeepImmutable<Vector2>, b: DeepImmutable<Vector2>): Angle;
  4921. /**
  4922. * Gets a new Angle object from the given float in radians
  4923. * @param radians defines the angle value in radians
  4924. * @returns a new Angle
  4925. */
  4926. static FromRadians(radians: number): Angle;
  4927. /**
  4928. * Gets a new Angle object from the given float in degrees
  4929. * @param degrees defines the angle value in degrees
  4930. * @returns a new Angle
  4931. */
  4932. static FromDegrees(degrees: number): Angle;
  4933. }
  4934. /**
  4935. * This represents an arc in a 2d space.
  4936. */
  4937. export class Arc2 {
  4938. /** Defines the start point of the arc */
  4939. startPoint: Vector2;
  4940. /** Defines the mid point of the arc */
  4941. midPoint: Vector2;
  4942. /** Defines the end point of the arc */
  4943. endPoint: Vector2;
  4944. /**
  4945. * Defines the center point of the arc.
  4946. */
  4947. centerPoint: Vector2;
  4948. /**
  4949. * Defines the radius of the arc.
  4950. */
  4951. radius: number;
  4952. /**
  4953. * Defines the angle of the arc (from mid point to end point).
  4954. */
  4955. angle: Angle;
  4956. /**
  4957. * Defines the start angle of the arc (from start point to middle point).
  4958. */
  4959. startAngle: Angle;
  4960. /**
  4961. * Defines the orientation of the arc (clock wise/counter clock wise).
  4962. */
  4963. orientation: Orientation;
  4964. /**
  4965. * Creates an Arc object from the three given points : start, middle and end.
  4966. * @param startPoint Defines the start point of the arc
  4967. * @param midPoint Defines the midlle point of the arc
  4968. * @param endPoint Defines the end point of the arc
  4969. */
  4970. constructor(
  4971. /** Defines the start point of the arc */
  4972. startPoint: Vector2,
  4973. /** Defines the mid point of the arc */
  4974. midPoint: Vector2,
  4975. /** Defines the end point of the arc */
  4976. endPoint: Vector2);
  4977. }
  4978. /**
  4979. * Represents a 2D path made up of multiple 2D points
  4980. */
  4981. export class Path2 {
  4982. private _points;
  4983. private _length;
  4984. /**
  4985. * If the path start and end point are the same
  4986. */
  4987. closed: boolean;
  4988. /**
  4989. * Creates a Path2 object from the starting 2D coordinates x and y.
  4990. * @param x the starting points x value
  4991. * @param y the starting points y value
  4992. */
  4993. constructor(x: number, y: number);
  4994. /**
  4995. * Adds a new segment until the given coordinates (x, y) to the current Path2.
  4996. * @param x the added points x value
  4997. * @param y the added points y value
  4998. * @returns the updated Path2.
  4999. */
  5000. addLineTo(x: number, y: number): Path2;
  5001. /**
  5002. * Adds _numberOfSegments_ segments according to the arc definition (middle point coordinates, end point coordinates, the arc start point being the current Path2 last point) to the current Path2.
  5003. * @param midX middle point x value
  5004. * @param midY middle point y value
  5005. * @param endX end point x value
  5006. * @param endY end point y value
  5007. * @param numberOfSegments (default: 36)
  5008. * @returns the updated Path2.
  5009. */
  5010. addArcTo(midX: number, midY: number, endX: number, endY: number, numberOfSegments?: number): Path2;
  5011. /**
  5012. * Closes the Path2.
  5013. * @returns the Path2.
  5014. */
  5015. close(): Path2;
  5016. /**
  5017. * Gets the sum of the distance between each sequential point in the path
  5018. * @returns the Path2 total length (float).
  5019. */
  5020. length(): number;
  5021. /**
  5022. * Gets the points which construct the path
  5023. * @returns the Path2 internal array of points.
  5024. */
  5025. getPoints(): Vector2[];
  5026. /**
  5027. * Retreives the point at the distance aways from the starting point
  5028. * @param normalizedLengthPosition the length along the path to retreive the point from
  5029. * @returns a new Vector2 located at a percentage of the Path2 total length on this path.
  5030. */
  5031. getPointAtLengthPosition(normalizedLengthPosition: number): Vector2;
  5032. /**
  5033. * Creates a new path starting from an x and y position
  5034. * @param x starting x value
  5035. * @param y starting y value
  5036. * @returns a new Path2 starting at the coordinates (x, y).
  5037. */
  5038. static StartingAt(x: number, y: number): Path2;
  5039. }
  5040. /**
  5041. * Represents a 3D path made up of multiple 3D points
  5042. */
  5043. export class Path3D {
  5044. /**
  5045. * an array of Vector3, the curve axis of the Path3D
  5046. */
  5047. path: Vector3[];
  5048. private _curve;
  5049. private _distances;
  5050. private _tangents;
  5051. private _normals;
  5052. private _binormals;
  5053. private _raw;
  5054. private _alignTangentsWithPath;
  5055. private readonly _pointAtData;
  5056. /**
  5057. * new Path3D(path, normal, raw)
  5058. * Creates a Path3D. A Path3D is a logical math object, so not a mesh.
  5059. * please read the description in the tutorial : https://doc.babylonjs.com/how_to/how_to_use_path3d
  5060. * @param path an array of Vector3, the curve axis of the Path3D
  5061. * @param firstNormal (options) Vector3, the first wanted normal to the curve. Ex (0, 1, 0) for a vertical normal.
  5062. * @param raw (optional, default false) : boolean, if true the returned Path3D isn't normalized. Useful to depict path acceleration or speed.
  5063. * @param alignTangentsWithPath (optional, default false) : boolean, if true the tangents will be aligned with the path.
  5064. */
  5065. constructor(
  5066. /**
  5067. * an array of Vector3, the curve axis of the Path3D
  5068. */
  5069. path: Vector3[], firstNormal?: Nullable<Vector3>, raw?: boolean, alignTangentsWithPath?: boolean);
  5070. /**
  5071. * Returns the Path3D array of successive Vector3 designing its curve.
  5072. * @returns the Path3D array of successive Vector3 designing its curve.
  5073. */
  5074. getCurve(): Vector3[];
  5075. /**
  5076. * Returns the Path3D array of successive Vector3 designing its curve.
  5077. * @returns the Path3D array of successive Vector3 designing its curve.
  5078. */
  5079. getPoints(): Vector3[];
  5080. /**
  5081. * @returns the computed length (float) of the path.
  5082. */
  5083. length(): number;
  5084. /**
  5085. * Returns an array populated with tangent vectors on each Path3D curve point.
  5086. * @returns an array populated with tangent vectors on each Path3D curve point.
  5087. */
  5088. getTangents(): Vector3[];
  5089. /**
  5090. * Returns an array populated with normal vectors on each Path3D curve point.
  5091. * @returns an array populated with normal vectors on each Path3D curve point.
  5092. */
  5093. getNormals(): Vector3[];
  5094. /**
  5095. * Returns an array populated with binormal vectors on each Path3D curve point.
  5096. * @returns an array populated with binormal vectors on each Path3D curve point.
  5097. */
  5098. getBinormals(): Vector3[];
  5099. /**
  5100. * Returns an array populated with distances (float) of the i-th point from the first curve point.
  5101. * @returns an array populated with distances (float) of the i-th point from the first curve point.
  5102. */
  5103. getDistances(): number[];
  5104. /**
  5105. * Returns an interpolated point along this path
  5106. * @param position the position of the point along this path, from 0.0 to 1.0
  5107. * @returns a new Vector3 as the point
  5108. */
  5109. getPointAt(position: number): Vector3;
  5110. /**
  5111. * Returns the tangent vector of an interpolated Path3D curve point at the specified position along this path.
  5112. * @param position the position of the point along this path, from 0.0 to 1.0
  5113. * @param interpolated (optional, default false) : boolean, if true returns an interpolated tangent instead of the tangent of the previous path point.
  5114. * @returns a tangent vector corresponding to the interpolated Path3D curve point, if not interpolated, the tangent is taken from the precomputed tangents array.
  5115. */
  5116. getTangentAt(position: number, interpolated?: boolean): Vector3;
  5117. /**
  5118. * Returns the tangent vector of an interpolated Path3D curve point at the specified position along this path.
  5119. * @param position the position of the point along this path, from 0.0 to 1.0
  5120. * @param interpolated (optional, default false) : boolean, if true returns an interpolated normal instead of the normal of the previous path point.
  5121. * @returns a normal vector corresponding to the interpolated Path3D curve point, if not interpolated, the normal is taken from the precomputed normals array.
  5122. */
  5123. getNormalAt(position: number, interpolated?: boolean): Vector3;
  5124. /**
  5125. * Returns the binormal vector of an interpolated Path3D curve point at the specified position along this path.
  5126. * @param position the position of the point along this path, from 0.0 to 1.0
  5127. * @param interpolated (optional, default false) : boolean, if true returns an interpolated binormal instead of the binormal of the previous path point.
  5128. * @returns a binormal vector corresponding to the interpolated Path3D curve point, if not interpolated, the binormal is taken from the precomputed binormals array.
  5129. */
  5130. getBinormalAt(position: number, interpolated?: boolean): Vector3;
  5131. /**
  5132. * Returns the distance (float) of an interpolated Path3D curve point at the specified position along this path.
  5133. * @param position the position of the point along this path, from 0.0 to 1.0
  5134. * @returns the distance of the interpolated Path3D curve point at the specified position along this path.
  5135. */
  5136. getDistanceAt(position: number): number;
  5137. /**
  5138. * Returns the array index of the previous point of an interpolated point along this path
  5139. * @param position the position of the point to interpolate along this path, from 0.0 to 1.0
  5140. * @returns the array index
  5141. */
  5142. getPreviousPointIndexAt(position: number): number;
  5143. /**
  5144. * Returns the position of an interpolated point relative to the two path points it lies between, from 0.0 (point A) to 1.0 (point B)
  5145. * @param position the position of the point to interpolate along this path, from 0.0 to 1.0
  5146. * @returns the sub position
  5147. */
  5148. getSubPositionAt(position: number): number;
  5149. /**
  5150. * Returns the position of the closest virtual point on this path to an arbitrary Vector3, from 0.0 to 1.0
  5151. * @param target the vector of which to get the closest position to
  5152. * @returns the position of the closest virtual point on this path to the target vector
  5153. */
  5154. getClosestPositionTo(target: Vector3): number;
  5155. /**
  5156. * Returns a sub path (slice) of this path
  5157. * @param start the position of the fist path point, from 0.0 to 1.0, or a negative value, which will get wrapped around from the end of the path to 0.0 to 1.0 values
  5158. * @param end the position of the last path point, from 0.0 to 1.0, or a negative value, which will get wrapped around from the end of the path to 0.0 to 1.0 values
  5159. * @returns a sub path (slice) of this path
  5160. */
  5161. slice(start?: number, end?: number): Path3D;
  5162. /**
  5163. * Forces the Path3D tangent, normal, binormal and distance recomputation.
  5164. * @param path path which all values are copied into the curves points
  5165. * @param firstNormal which should be projected onto the curve
  5166. * @param alignTangentsWithPath (optional, default false) : boolean, if true the tangents will be aligned with the path
  5167. * @returns the same object updated.
  5168. */
  5169. update(path: Vector3[], firstNormal?: Nullable<Vector3>, alignTangentsWithPath?: boolean): Path3D;
  5170. private _compute;
  5171. private _getFirstNonNullVector;
  5172. private _getLastNonNullVector;
  5173. private _normalVector;
  5174. /**
  5175. * Updates the point at data for an interpolated point along this curve
  5176. * @param position the position of the point along this curve, from 0.0 to 1.0
  5177. * @interpolateTNB wether to compute the interpolated tangent, normal and binormal
  5178. * @returns the (updated) point at data
  5179. */
  5180. private _updatePointAtData;
  5181. /**
  5182. * Updates the point at data from the specified parameters
  5183. * @param position where along the path the interpolated point is, from 0.0 to 1.0
  5184. * @param point the interpolated point
  5185. * @param parentIndex the index of an existing curve point that is on, or else positionally the first behind, the interpolated point
  5186. */
  5187. private _setPointAtData;
  5188. /**
  5189. * Updates the point at interpolation matrix for the tangents, normals and binormals
  5190. */
  5191. private _updateInterpolationMatrix;
  5192. }
  5193. /**
  5194. * A Curve3 object is a logical object, so not a mesh, to handle curves in the 3D geometric space.
  5195. * A Curve3 is designed from a series of successive Vector3.
  5196. * @see https://doc.babylonjs.com/how_to/how_to_use_curve3
  5197. */
  5198. export class Curve3 {
  5199. private _points;
  5200. private _length;
  5201. /**
  5202. * Returns a Curve3 object along a Quadratic Bezier curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#quadratic-bezier-curve
  5203. * @param v0 (Vector3) the origin point of the Quadratic Bezier
  5204. * @param v1 (Vector3) the control point
  5205. * @param v2 (Vector3) the end point of the Quadratic Bezier
  5206. * @param nbPoints (integer) the wanted number of points in the curve
  5207. * @returns the created Curve3
  5208. */
  5209. static CreateQuadraticBezier(v0: DeepImmutable<Vector3>, v1: DeepImmutable<Vector3>, v2: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  5210. /**
  5211. * Returns a Curve3 object along a Cubic Bezier curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#cubic-bezier-curve
  5212. * @param v0 (Vector3) the origin point of the Cubic Bezier
  5213. * @param v1 (Vector3) the first control point
  5214. * @param v2 (Vector3) the second control point
  5215. * @param v3 (Vector3) the end point of the Cubic Bezier
  5216. * @param nbPoints (integer) the wanted number of points in the curve
  5217. * @returns the created Curve3
  5218. */
  5219. static CreateCubicBezier(v0: DeepImmutable<Vector3>, v1: DeepImmutable<Vector3>, v2: DeepImmutable<Vector3>, v3: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  5220. /**
  5221. * Returns a Curve3 object along a Hermite Spline curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#hermite-spline
  5222. * @param p1 (Vector3) the origin point of the Hermite Spline
  5223. * @param t1 (Vector3) the tangent vector at the origin point
  5224. * @param p2 (Vector3) the end point of the Hermite Spline
  5225. * @param t2 (Vector3) the tangent vector at the end point
  5226. * @param nbPoints (integer) the wanted number of points in the curve
  5227. * @returns the created Curve3
  5228. */
  5229. static CreateHermiteSpline(p1: DeepImmutable<Vector3>, t1: DeepImmutable<Vector3>, p2: DeepImmutable<Vector3>, t2: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  5230. /**
  5231. * Returns a Curve3 object along a CatmullRom Spline curve :
  5232. * @param points (array of Vector3) the points the spline must pass through. At least, four points required
  5233. * @param nbPoints (integer) the wanted number of points between each curve control points
  5234. * @param closed (boolean) optional with default false, when true forms a closed loop from the points
  5235. * @returns the created Curve3
  5236. */
  5237. static CreateCatmullRomSpline(points: DeepImmutable<Vector3[]>, nbPoints: number, closed?: boolean): Curve3;
  5238. /**
  5239. * A Curve3 object is a logical object, so not a mesh, to handle curves in the 3D geometric space.
  5240. * A Curve3 is designed from a series of successive Vector3.
  5241. * Tuto : https://doc.babylonjs.com/how_to/how_to_use_curve3#curve3-object
  5242. * @param points points which make up the curve
  5243. */
  5244. constructor(points: Vector3[]);
  5245. /**
  5246. * @returns the Curve3 stored array of successive Vector3
  5247. */
  5248. getPoints(): Vector3[];
  5249. /**
  5250. * @returns the computed length (float) of the curve.
  5251. */
  5252. length(): number;
  5253. /**
  5254. * Returns a new instance of Curve3 object : var curve = curveA.continue(curveB);
  5255. * This new Curve3 is built by translating and sticking the curveB at the end of the curveA.
  5256. * curveA and curveB keep unchanged.
  5257. * @param curve the curve to continue from this curve
  5258. * @returns the newly constructed curve
  5259. */
  5260. continue(curve: DeepImmutable<Curve3>): Curve3;
  5261. private _computeLength;
  5262. }
  5263. }
  5264. declare module "babylonjs/Animations/easing" {
  5265. /**
  5266. * This represents the main contract an easing function should follow.
  5267. * Easing functions are used throughout the animation system.
  5268. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5269. */
  5270. export interface IEasingFunction {
  5271. /**
  5272. * Given an input gradient between 0 and 1, this returns the corrseponding value
  5273. * of the easing function.
  5274. * The link below provides some of the most common examples of easing functions.
  5275. * @see https://easings.net/
  5276. * @param gradient Defines the value between 0 and 1 we want the easing value for
  5277. * @returns the corresponding value on the curve defined by the easing function
  5278. */
  5279. ease(gradient: number): number;
  5280. }
  5281. /**
  5282. * Base class used for every default easing function.
  5283. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5284. */
  5285. export class EasingFunction implements IEasingFunction {
  5286. /**
  5287. * Interpolation follows the mathematical formula associated with the easing function.
  5288. */
  5289. static readonly EASINGMODE_EASEIN: number;
  5290. /**
  5291. * Interpolation follows 100% interpolation minus the output of the formula associated with the easing function.
  5292. */
  5293. static readonly EASINGMODE_EASEOUT: number;
  5294. /**
  5295. * Interpolation uses EaseIn for the first half of the animation and EaseOut for the second half.
  5296. */
  5297. static readonly EASINGMODE_EASEINOUT: number;
  5298. private _easingMode;
  5299. /**
  5300. * Sets the easing mode of the current function.
  5301. * @param easingMode Defines the willing mode (EASINGMODE_EASEIN, EASINGMODE_EASEOUT or EASINGMODE_EASEINOUT)
  5302. */
  5303. setEasingMode(easingMode: number): void;
  5304. /**
  5305. * Gets the current easing mode.
  5306. * @returns the easing mode
  5307. */
  5308. getEasingMode(): number;
  5309. /**
  5310. * @hidden
  5311. */
  5312. easeInCore(gradient: number): number;
  5313. /**
  5314. * Given an input gradient between 0 and 1, this returns the corresponding value
  5315. * of the easing function.
  5316. * @param gradient Defines the value between 0 and 1 we want the easing value for
  5317. * @returns the corresponding value on the curve defined by the easing function
  5318. */
  5319. ease(gradient: number): number;
  5320. }
  5321. /**
  5322. * Easing function with a circle shape (see link below).
  5323. * @see https://easings.net/#easeInCirc
  5324. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5325. */
  5326. export class CircleEase extends EasingFunction implements IEasingFunction {
  5327. /** @hidden */
  5328. easeInCore(gradient: number): number;
  5329. }
  5330. /**
  5331. * Easing function with a ease back shape (see link below).
  5332. * @see https://easings.net/#easeInBack
  5333. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5334. */
  5335. export class BackEase extends EasingFunction implements IEasingFunction {
  5336. /** Defines the amplitude of the function */
  5337. amplitude: number;
  5338. /**
  5339. * Instantiates a back ease easing
  5340. * @see https://easings.net/#easeInBack
  5341. * @param amplitude Defines the amplitude of the function
  5342. */
  5343. constructor(
  5344. /** Defines the amplitude of the function */
  5345. amplitude?: number);
  5346. /** @hidden */
  5347. easeInCore(gradient: number): number;
  5348. }
  5349. /**
  5350. * Easing function with a bouncing shape (see link below).
  5351. * @see https://easings.net/#easeInBounce
  5352. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5353. */
  5354. export class BounceEase extends EasingFunction implements IEasingFunction {
  5355. /** Defines the number of bounces */
  5356. bounces: number;
  5357. /** Defines the amplitude of the bounce */
  5358. bounciness: number;
  5359. /**
  5360. * Instantiates a bounce easing
  5361. * @see https://easings.net/#easeInBounce
  5362. * @param bounces Defines the number of bounces
  5363. * @param bounciness Defines the amplitude of the bounce
  5364. */
  5365. constructor(
  5366. /** Defines the number of bounces */
  5367. bounces?: number,
  5368. /** Defines the amplitude of the bounce */
  5369. bounciness?: number);
  5370. /** @hidden */
  5371. easeInCore(gradient: number): number;
  5372. }
  5373. /**
  5374. * Easing function with a power of 3 shape (see link below).
  5375. * @see https://easings.net/#easeInCubic
  5376. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5377. */
  5378. export class CubicEase extends EasingFunction implements IEasingFunction {
  5379. /** @hidden */
  5380. easeInCore(gradient: number): number;
  5381. }
  5382. /**
  5383. * Easing function with an elastic shape (see link below).
  5384. * @see https://easings.net/#easeInElastic
  5385. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5386. */
  5387. export class ElasticEase extends EasingFunction implements IEasingFunction {
  5388. /** Defines the number of oscillations*/
  5389. oscillations: number;
  5390. /** Defines the amplitude of the oscillations*/
  5391. springiness: number;
  5392. /**
  5393. * Instantiates an elastic easing function
  5394. * @see https://easings.net/#easeInElastic
  5395. * @param oscillations Defines the number of oscillations
  5396. * @param springiness Defines the amplitude of the oscillations
  5397. */
  5398. constructor(
  5399. /** Defines the number of oscillations*/
  5400. oscillations?: number,
  5401. /** Defines the amplitude of the oscillations*/
  5402. springiness?: number);
  5403. /** @hidden */
  5404. easeInCore(gradient: number): number;
  5405. }
  5406. /**
  5407. * Easing function with an exponential shape (see link below).
  5408. * @see https://easings.net/#easeInExpo
  5409. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5410. */
  5411. export class ExponentialEase extends EasingFunction implements IEasingFunction {
  5412. /** Defines the exponent of the function */
  5413. exponent: number;
  5414. /**
  5415. * Instantiates an exponential easing function
  5416. * @see https://easings.net/#easeInExpo
  5417. * @param exponent Defines the exponent of the function
  5418. */
  5419. constructor(
  5420. /** Defines the exponent of the function */
  5421. exponent?: number);
  5422. /** @hidden */
  5423. easeInCore(gradient: number): number;
  5424. }
  5425. /**
  5426. * Easing function with a power shape (see link below).
  5427. * @see https://easings.net/#easeInQuad
  5428. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5429. */
  5430. export class PowerEase extends EasingFunction implements IEasingFunction {
  5431. /** Defines the power of the function */
  5432. power: number;
  5433. /**
  5434. * Instantiates an power base easing function
  5435. * @see https://easings.net/#easeInQuad
  5436. * @param power Defines the power of the function
  5437. */
  5438. constructor(
  5439. /** Defines the power of the function */
  5440. power?: number);
  5441. /** @hidden */
  5442. easeInCore(gradient: number): number;
  5443. }
  5444. /**
  5445. * Easing function with a power of 2 shape (see link below).
  5446. * @see https://easings.net/#easeInQuad
  5447. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5448. */
  5449. export class QuadraticEase extends EasingFunction implements IEasingFunction {
  5450. /** @hidden */
  5451. easeInCore(gradient: number): number;
  5452. }
  5453. /**
  5454. * Easing function with a power of 4 shape (see link below).
  5455. * @see https://easings.net/#easeInQuart
  5456. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5457. */
  5458. export class QuarticEase extends EasingFunction implements IEasingFunction {
  5459. /** @hidden */
  5460. easeInCore(gradient: number): number;
  5461. }
  5462. /**
  5463. * Easing function with a power of 5 shape (see link below).
  5464. * @see https://easings.net/#easeInQuint
  5465. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5466. */
  5467. export class QuinticEase extends EasingFunction implements IEasingFunction {
  5468. /** @hidden */
  5469. easeInCore(gradient: number): number;
  5470. }
  5471. /**
  5472. * Easing function with a sin shape (see link below).
  5473. * @see https://easings.net/#easeInSine
  5474. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5475. */
  5476. export class SineEase extends EasingFunction implements IEasingFunction {
  5477. /** @hidden */
  5478. easeInCore(gradient: number): number;
  5479. }
  5480. /**
  5481. * Easing function with a bezier shape (see link below).
  5482. * @see http://cubic-bezier.com/#.17,.67,.83,.67
  5483. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5484. */
  5485. export class BezierCurveEase extends EasingFunction implements IEasingFunction {
  5486. /** Defines the x component of the start tangent in the bezier curve */
  5487. x1: number;
  5488. /** Defines the y component of the start tangent in the bezier curve */
  5489. y1: number;
  5490. /** Defines the x component of the end tangent in the bezier curve */
  5491. x2: number;
  5492. /** Defines the y component of the end tangent in the bezier curve */
  5493. y2: number;
  5494. /**
  5495. * Instantiates a bezier function
  5496. * @see http://cubic-bezier.com/#.17,.67,.83,.67
  5497. * @param x1 Defines the x component of the start tangent in the bezier curve
  5498. * @param y1 Defines the y component of the start tangent in the bezier curve
  5499. * @param x2 Defines the x component of the end tangent in the bezier curve
  5500. * @param y2 Defines the y component of the end tangent in the bezier curve
  5501. */
  5502. constructor(
  5503. /** Defines the x component of the start tangent in the bezier curve */
  5504. x1?: number,
  5505. /** Defines the y component of the start tangent in the bezier curve */
  5506. y1?: number,
  5507. /** Defines the x component of the end tangent in the bezier curve */
  5508. x2?: number,
  5509. /** Defines the y component of the end tangent in the bezier curve */
  5510. y2?: number);
  5511. /** @hidden */
  5512. easeInCore(gradient: number): number;
  5513. }
  5514. }
  5515. declare module "babylonjs/Maths/math.color" {
  5516. import { DeepImmutable, FloatArray } from "babylonjs/types";
  5517. /**
  5518. * Class used to hold a RBG color
  5519. */
  5520. export class Color3 {
  5521. /**
  5522. * Defines the red component (between 0 and 1, default is 0)
  5523. */
  5524. r: number;
  5525. /**
  5526. * Defines the green component (between 0 and 1, default is 0)
  5527. */
  5528. g: number;
  5529. /**
  5530. * Defines the blue component (between 0 and 1, default is 0)
  5531. */
  5532. b: number;
  5533. /**
  5534. * Creates a new Color3 object from red, green, blue values, all between 0 and 1
  5535. * @param r defines the red component (between 0 and 1, default is 0)
  5536. * @param g defines the green component (between 0 and 1, default is 0)
  5537. * @param b defines the blue component (between 0 and 1, default is 0)
  5538. */
  5539. constructor(
  5540. /**
  5541. * Defines the red component (between 0 and 1, default is 0)
  5542. */
  5543. r?: number,
  5544. /**
  5545. * Defines the green component (between 0 and 1, default is 0)
  5546. */
  5547. g?: number,
  5548. /**
  5549. * Defines the blue component (between 0 and 1, default is 0)
  5550. */
  5551. b?: number);
  5552. /**
  5553. * Creates a string with the Color3 current values
  5554. * @returns the string representation of the Color3 object
  5555. */
  5556. toString(): string;
  5557. /**
  5558. * Returns the string "Color3"
  5559. * @returns "Color3"
  5560. */
  5561. getClassName(): string;
  5562. /**
  5563. * Compute the Color3 hash code
  5564. * @returns an unique number that can be used to hash Color3 objects
  5565. */
  5566. getHashCode(): number;
  5567. /**
  5568. * Stores in the given array from the given starting index the red, green, blue values as successive elements
  5569. * @param array defines the array where to store the r,g,b components
  5570. * @param index defines an optional index in the target array to define where to start storing values
  5571. * @returns the current Color3 object
  5572. */
  5573. toArray(array: FloatArray, index?: number): Color3;
  5574. /**
  5575. * Update the current color with values stored in an array from the starting index of the given array
  5576. * @param array defines the source array
  5577. * @param offset defines an offset in the source array
  5578. * @returns the current Color3 object
  5579. */
  5580. fromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color3;
  5581. /**
  5582. * Returns a new Color4 object from the current Color3 and the given alpha
  5583. * @param alpha defines the alpha component on the new Color4 object (default is 1)
  5584. * @returns a new Color4 object
  5585. */
  5586. toColor4(alpha?: number): Color4;
  5587. /**
  5588. * Returns a new array populated with 3 numeric elements : red, green and blue values
  5589. * @returns the new array
  5590. */
  5591. asArray(): number[];
  5592. /**
  5593. * Returns the luminance value
  5594. * @returns a float value
  5595. */
  5596. toLuminance(): number;
  5597. /**
  5598. * Multiply each Color3 rgb values by the given Color3 rgb values in a new Color3 object
  5599. * @param otherColor defines the second operand
  5600. * @returns the new Color3 object
  5601. */
  5602. multiply(otherColor: DeepImmutable<Color3>): Color3;
  5603. /**
  5604. * Multiply the rgb values of the Color3 and the given Color3 and stores the result in the object "result"
  5605. * @param otherColor defines the second operand
  5606. * @param result defines the Color3 object where to store the result
  5607. * @returns the current Color3
  5608. */
  5609. multiplyToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  5610. /**
  5611. * Determines equality between Color3 objects
  5612. * @param otherColor defines the second operand
  5613. * @returns true if the rgb values are equal to the given ones
  5614. */
  5615. equals(otherColor: DeepImmutable<Color3>): boolean;
  5616. /**
  5617. * Determines equality between the current Color3 object and a set of r,b,g values
  5618. * @param r defines the red component to check
  5619. * @param g defines the green component to check
  5620. * @param b defines the blue component to check
  5621. * @returns true if the rgb values are equal to the given ones
  5622. */
  5623. equalsFloats(r: number, g: number, b: number): boolean;
  5624. /**
  5625. * Multiplies in place each rgb value by scale
  5626. * @param scale defines the scaling factor
  5627. * @returns the updated Color3
  5628. */
  5629. scale(scale: number): Color3;
  5630. /**
  5631. * Multiplies the rgb values by scale and stores the result into "result"
  5632. * @param scale defines the scaling factor
  5633. * @param result defines the Color3 object where to store the result
  5634. * @returns the unmodified current Color3
  5635. */
  5636. scaleToRef(scale: number, result: Color3): Color3;
  5637. /**
  5638. * Scale the current Color3 values by a factor and add the result to a given Color3
  5639. * @param scale defines the scale factor
  5640. * @param result defines color to store the result into
  5641. * @returns the unmodified current Color3
  5642. */
  5643. scaleAndAddToRef(scale: number, result: Color3): Color3;
  5644. /**
  5645. * Clamps the rgb values by the min and max values and stores the result into "result"
  5646. * @param min defines minimum clamping value (default is 0)
  5647. * @param max defines maximum clamping value (default is 1)
  5648. * @param result defines color to store the result into
  5649. * @returns the original Color3
  5650. */
  5651. clampToRef(min: number | undefined, max: number | undefined, result: Color3): Color3;
  5652. /**
  5653. * Creates a new Color3 set with the added values of the current Color3 and of the given one
  5654. * @param otherColor defines the second operand
  5655. * @returns the new Color3
  5656. */
  5657. add(otherColor: DeepImmutable<Color3>): Color3;
  5658. /**
  5659. * Stores the result of the addition of the current Color3 and given one rgb values into "result"
  5660. * @param otherColor defines the second operand
  5661. * @param result defines Color3 object to store the result into
  5662. * @returns the unmodified current Color3
  5663. */
  5664. addToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  5665. /**
  5666. * Returns a new Color3 set with the subtracted values of the given one from the current Color3
  5667. * @param otherColor defines the second operand
  5668. * @returns the new Color3
  5669. */
  5670. subtract(otherColor: DeepImmutable<Color3>): Color3;
  5671. /**
  5672. * Stores the result of the subtraction of given one from the current Color3 rgb values into "result"
  5673. * @param otherColor defines the second operand
  5674. * @param result defines Color3 object to store the result into
  5675. * @returns the unmodified current Color3
  5676. */
  5677. subtractToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  5678. /**
  5679. * Copy the current object
  5680. * @returns a new Color3 copied the current one
  5681. */
  5682. clone(): Color3;
  5683. /**
  5684. * Copies the rgb values from the source in the current Color3
  5685. * @param source defines the source Color3 object
  5686. * @returns the updated Color3 object
  5687. */
  5688. copyFrom(source: DeepImmutable<Color3>): Color3;
  5689. /**
  5690. * Updates the Color3 rgb values from the given floats
  5691. * @param r defines the red component to read from
  5692. * @param g defines the green component to read from
  5693. * @param b defines the blue component to read from
  5694. * @returns the current Color3 object
  5695. */
  5696. copyFromFloats(r: number, g: number, b: number): Color3;
  5697. /**
  5698. * Updates the Color3 rgb values from the given floats
  5699. * @param r defines the red component to read from
  5700. * @param g defines the green component to read from
  5701. * @param b defines the blue component to read from
  5702. * @returns the current Color3 object
  5703. */
  5704. set(r: number, g: number, b: number): Color3;
  5705. /**
  5706. * Compute the Color3 hexadecimal code as a string
  5707. * @returns a string containing the hexadecimal representation of the Color3 object
  5708. */
  5709. toHexString(): string;
  5710. /**
  5711. * Computes a new Color3 converted from the current one to linear space
  5712. * @returns a new Color3 object
  5713. */
  5714. toLinearSpace(): Color3;
  5715. /**
  5716. * Converts current color in rgb space to HSV values
  5717. * @returns a new color3 representing the HSV values
  5718. */
  5719. toHSV(): Color3;
  5720. /**
  5721. * Converts current color in rgb space to HSV values
  5722. * @param result defines the Color3 where to store the HSV values
  5723. */
  5724. toHSVToRef(result: Color3): void;
  5725. /**
  5726. * Converts the Color3 values to linear space and stores the result in "convertedColor"
  5727. * @param convertedColor defines the Color3 object where to store the linear space version
  5728. * @returns the unmodified Color3
  5729. */
  5730. toLinearSpaceToRef(convertedColor: Color3): Color3;
  5731. /**
  5732. * Computes a new Color3 converted from the current one to gamma space
  5733. * @returns a new Color3 object
  5734. */
  5735. toGammaSpace(): Color3;
  5736. /**
  5737. * Converts the Color3 values to gamma space and stores the result in "convertedColor"
  5738. * @param convertedColor defines the Color3 object where to store the gamma space version
  5739. * @returns the unmodified Color3
  5740. */
  5741. toGammaSpaceToRef(convertedColor: Color3): Color3;
  5742. private static _BlackReadOnly;
  5743. /**
  5744. * Convert Hue, saturation and value to a Color3 (RGB)
  5745. * @param hue defines the hue
  5746. * @param saturation defines the saturation
  5747. * @param value defines the value
  5748. * @param result defines the Color3 where to store the RGB values
  5749. */
  5750. static HSVtoRGBToRef(hue: number, saturation: number, value: number, result: Color3): void;
  5751. /**
  5752. * Creates a new Color3 from the string containing valid hexadecimal values
  5753. * @param hex defines a string containing valid hexadecimal values
  5754. * @returns a new Color3 object
  5755. */
  5756. static FromHexString(hex: string): Color3;
  5757. /**
  5758. * Creates a new Color3 from the starting index of the given array
  5759. * @param array defines the source array
  5760. * @param offset defines an offset in the source array
  5761. * @returns a new Color3 object
  5762. */
  5763. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color3;
  5764. /**
  5765. * Creates a new Color3 from the starting index element of the given array
  5766. * @param array defines the source array to read from
  5767. * @param offset defines the offset in the source array
  5768. * @param result defines the target Color3 object
  5769. */
  5770. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number | undefined, result: Color3): void;
  5771. /**
  5772. * Creates a new Color3 from integer values (< 256)
  5773. * @param r defines the red component to read from (value between 0 and 255)
  5774. * @param g defines the green component to read from (value between 0 and 255)
  5775. * @param b defines the blue component to read from (value between 0 and 255)
  5776. * @returns a new Color3 object
  5777. */
  5778. static FromInts(r: number, g: number, b: number): Color3;
  5779. /**
  5780. * Creates a new Color3 with values linearly interpolated of "amount" between the start Color3 and the end Color3
  5781. * @param start defines the start Color3 value
  5782. * @param end defines the end Color3 value
  5783. * @param amount defines the gradient value between start and end
  5784. * @returns a new Color3 object
  5785. */
  5786. static Lerp(start: DeepImmutable<Color3>, end: DeepImmutable<Color3>, amount: number): Color3;
  5787. /**
  5788. * Creates a new Color3 with values linearly interpolated of "amount" between the start Color3 and the end Color3
  5789. * @param left defines the start value
  5790. * @param right defines the end value
  5791. * @param amount defines the gradient factor
  5792. * @param result defines the Color3 object where to store the result
  5793. */
  5794. static LerpToRef(left: DeepImmutable<Color3>, right: DeepImmutable<Color3>, amount: number, result: Color3): void;
  5795. /**
  5796. * Returns a Color3 value containing a red color
  5797. * @returns a new Color3 object
  5798. */
  5799. static Red(): Color3;
  5800. /**
  5801. * Returns a Color3 value containing a green color
  5802. * @returns a new Color3 object
  5803. */
  5804. static Green(): Color3;
  5805. /**
  5806. * Returns a Color3 value containing a blue color
  5807. * @returns a new Color3 object
  5808. */
  5809. static Blue(): Color3;
  5810. /**
  5811. * Returns a Color3 value containing a black color
  5812. * @returns a new Color3 object
  5813. */
  5814. static Black(): Color3;
  5815. /**
  5816. * Gets a Color3 value containing a black color that must not be updated
  5817. */
  5818. static get BlackReadOnly(): DeepImmutable<Color3>;
  5819. /**
  5820. * Returns a Color3 value containing a white color
  5821. * @returns a new Color3 object
  5822. */
  5823. static White(): Color3;
  5824. /**
  5825. * Returns a Color3 value containing a purple color
  5826. * @returns a new Color3 object
  5827. */
  5828. static Purple(): Color3;
  5829. /**
  5830. * Returns a Color3 value containing a magenta color
  5831. * @returns a new Color3 object
  5832. */
  5833. static Magenta(): Color3;
  5834. /**
  5835. * Returns a Color3 value containing a yellow color
  5836. * @returns a new Color3 object
  5837. */
  5838. static Yellow(): Color3;
  5839. /**
  5840. * Returns a Color3 value containing a gray color
  5841. * @returns a new Color3 object
  5842. */
  5843. static Gray(): Color3;
  5844. /**
  5845. * Returns a Color3 value containing a teal color
  5846. * @returns a new Color3 object
  5847. */
  5848. static Teal(): Color3;
  5849. /**
  5850. * Returns a Color3 value containing a random color
  5851. * @returns a new Color3 object
  5852. */
  5853. static Random(): Color3;
  5854. }
  5855. /**
  5856. * Class used to hold a RBGA color
  5857. */
  5858. export class Color4 {
  5859. /**
  5860. * Defines the red component (between 0 and 1, default is 0)
  5861. */
  5862. r: number;
  5863. /**
  5864. * Defines the green component (between 0 and 1, default is 0)
  5865. */
  5866. g: number;
  5867. /**
  5868. * Defines the blue component (between 0 and 1, default is 0)
  5869. */
  5870. b: number;
  5871. /**
  5872. * Defines the alpha component (between 0 and 1, default is 1)
  5873. */
  5874. a: number;
  5875. /**
  5876. * Creates a new Color4 object from red, green, blue values, all between 0 and 1
  5877. * @param r defines the red component (between 0 and 1, default is 0)
  5878. * @param g defines the green component (between 0 and 1, default is 0)
  5879. * @param b defines the blue component (between 0 and 1, default is 0)
  5880. * @param a defines the alpha component (between 0 and 1, default is 1)
  5881. */
  5882. constructor(
  5883. /**
  5884. * Defines the red component (between 0 and 1, default is 0)
  5885. */
  5886. r?: number,
  5887. /**
  5888. * Defines the green component (between 0 and 1, default is 0)
  5889. */
  5890. g?: number,
  5891. /**
  5892. * Defines the blue component (between 0 and 1, default is 0)
  5893. */
  5894. b?: number,
  5895. /**
  5896. * Defines the alpha component (between 0 and 1, default is 1)
  5897. */
  5898. a?: number);
  5899. /**
  5900. * Adds in place the given Color4 values to the current Color4 object
  5901. * @param right defines the second operand
  5902. * @returns the current updated Color4 object
  5903. */
  5904. addInPlace(right: DeepImmutable<Color4>): Color4;
  5905. /**
  5906. * Creates a new array populated with 4 numeric elements : red, green, blue, alpha values
  5907. * @returns the new array
  5908. */
  5909. asArray(): number[];
  5910. /**
  5911. * Stores from the starting index in the given array the Color4 successive values
  5912. * @param array defines the array where to store the r,g,b components
  5913. * @param index defines an optional index in the target array to define where to start storing values
  5914. * @returns the current Color4 object
  5915. */
  5916. toArray(array: number[], index?: number): Color4;
  5917. /**
  5918. * Update the current color with values stored in an array from the starting index of the given array
  5919. * @param array defines the source array
  5920. * @param offset defines an offset in the source array
  5921. * @returns the current Color4 object
  5922. */
  5923. fromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color4;
  5924. /**
  5925. * Determines equality between Color4 objects
  5926. * @param otherColor defines the second operand
  5927. * @returns true if the rgba values are equal to the given ones
  5928. */
  5929. equals(otherColor: DeepImmutable<Color4>): boolean;
  5930. /**
  5931. * Creates a new Color4 set with the added values of the current Color4 and of the given one
  5932. * @param right defines the second operand
  5933. * @returns a new Color4 object
  5934. */
  5935. add(right: DeepImmutable<Color4>): Color4;
  5936. /**
  5937. * Creates a new Color4 set with the subtracted values of the given one from the current Color4
  5938. * @param right defines the second operand
  5939. * @returns a new Color4 object
  5940. */
  5941. subtract(right: DeepImmutable<Color4>): Color4;
  5942. /**
  5943. * Subtracts the given ones from the current Color4 values and stores the results in "result"
  5944. * @param right defines the second operand
  5945. * @param result defines the Color4 object where to store the result
  5946. * @returns the current Color4 object
  5947. */
  5948. subtractToRef(right: DeepImmutable<Color4>, result: Color4): Color4;
  5949. /**
  5950. * Creates a new Color4 with the current Color4 values multiplied by scale
  5951. * @param scale defines the scaling factor to apply
  5952. * @returns a new Color4 object
  5953. */
  5954. scale(scale: number): Color4;
  5955. /**
  5956. * Multiplies the current Color4 values by scale and stores the result in "result"
  5957. * @param scale defines the scaling factor to apply
  5958. * @param result defines the Color4 object where to store the result
  5959. * @returns the current unmodified Color4
  5960. */
  5961. scaleToRef(scale: number, result: Color4): Color4;
  5962. /**
  5963. * Scale the current Color4 values by a factor and add the result to a given Color4
  5964. * @param scale defines the scale factor
  5965. * @param result defines the Color4 object where to store the result
  5966. * @returns the unmodified current Color4
  5967. */
  5968. scaleAndAddToRef(scale: number, result: Color4): Color4;
  5969. /**
  5970. * Clamps the rgb values by the min and max values and stores the result into "result"
  5971. * @param min defines minimum clamping value (default is 0)
  5972. * @param max defines maximum clamping value (default is 1)
  5973. * @param result defines color to store the result into.
  5974. * @returns the cuurent Color4
  5975. */
  5976. clampToRef(min: number | undefined, max: number | undefined, result: Color4): Color4;
  5977. /**
  5978. * Multipy an Color4 value by another and return a new Color4 object
  5979. * @param color defines the Color4 value to multiply by
  5980. * @returns a new Color4 object
  5981. */
  5982. multiply(color: Color4): Color4;
  5983. /**
  5984. * Multipy a Color4 value by another and push the result in a reference value
  5985. * @param color defines the Color4 value to multiply by
  5986. * @param result defines the Color4 to fill the result in
  5987. * @returns the result Color4
  5988. */
  5989. multiplyToRef(color: Color4, result: Color4): Color4;
  5990. /**
  5991. * Creates a string with the Color4 current values
  5992. * @returns the string representation of the Color4 object
  5993. */
  5994. toString(): string;
  5995. /**
  5996. * Returns the string "Color4"
  5997. * @returns "Color4"
  5998. */
  5999. getClassName(): string;
  6000. /**
  6001. * Compute the Color4 hash code
  6002. * @returns an unique number that can be used to hash Color4 objects
  6003. */
  6004. getHashCode(): number;
  6005. /**
  6006. * Creates a new Color4 copied from the current one
  6007. * @returns a new Color4 object
  6008. */
  6009. clone(): Color4;
  6010. /**
  6011. * Copies the given Color4 values into the current one
  6012. * @param source defines the source Color4 object
  6013. * @returns the current updated Color4 object
  6014. */
  6015. copyFrom(source: Color4): Color4;
  6016. /**
  6017. * Copies the given float values into the current one
  6018. * @param r defines the red component to read from
  6019. * @param g defines the green component to read from
  6020. * @param b defines the blue component to read from
  6021. * @param a defines the alpha component to read from
  6022. * @returns the current updated Color4 object
  6023. */
  6024. copyFromFloats(r: number, g: number, b: number, a: number): Color4;
  6025. /**
  6026. * Copies the given float values into the current one
  6027. * @param r defines the red component to read from
  6028. * @param g defines the green component to read from
  6029. * @param b defines the blue component to read from
  6030. * @param a defines the alpha component to read from
  6031. * @returns the current updated Color4 object
  6032. */
  6033. set(r: number, g: number, b: number, a: number): Color4;
  6034. /**
  6035. * Compute the Color4 hexadecimal code as a string
  6036. * @param returnAsColor3 defines if the string should only contains RGB values (off by default)
  6037. * @returns a string containing the hexadecimal representation of the Color4 object
  6038. */
  6039. toHexString(returnAsColor3?: boolean): string;
  6040. /**
  6041. * Computes a new Color4 converted from the current one to linear space
  6042. * @returns a new Color4 object
  6043. */
  6044. toLinearSpace(): Color4;
  6045. /**
  6046. * Converts the Color4 values to linear space and stores the result in "convertedColor"
  6047. * @param convertedColor defines the Color4 object where to store the linear space version
  6048. * @returns the unmodified Color4
  6049. */
  6050. toLinearSpaceToRef(convertedColor: Color4): Color4;
  6051. /**
  6052. * Computes a new Color4 converted from the current one to gamma space
  6053. * @returns a new Color4 object
  6054. */
  6055. toGammaSpace(): Color4;
  6056. /**
  6057. * Converts the Color4 values to gamma space and stores the result in "convertedColor"
  6058. * @param convertedColor defines the Color4 object where to store the gamma space version
  6059. * @returns the unmodified Color4
  6060. */
  6061. toGammaSpaceToRef(convertedColor: Color4): Color4;
  6062. /**
  6063. * Creates a new Color4 from the string containing valid hexadecimal values
  6064. * @param hex defines a string containing valid hexadecimal values
  6065. * @returns a new Color4 object
  6066. */
  6067. static FromHexString(hex: string): Color4;
  6068. /**
  6069. * Creates a new Color4 object set with the linearly interpolated values of "amount" between the left Color4 object and the right Color4 object
  6070. * @param left defines the start value
  6071. * @param right defines the end value
  6072. * @param amount defines the gradient factor
  6073. * @returns a new Color4 object
  6074. */
  6075. static Lerp(left: DeepImmutable<Color4>, right: DeepImmutable<Color4>, amount: number): Color4;
  6076. /**
  6077. * Set the given "result" with the linearly interpolated values of "amount" between the left Color4 object and the right Color4 object
  6078. * @param left defines the start value
  6079. * @param right defines the end value
  6080. * @param amount defines the gradient factor
  6081. * @param result defines the Color4 object where to store data
  6082. */
  6083. static LerpToRef(left: DeepImmutable<Color4>, right: DeepImmutable<Color4>, amount: number, result: Color4): void;
  6084. /**
  6085. * Creates a new Color4 from a Color3 and an alpha value
  6086. * @param color3 defines the source Color3 to read from
  6087. * @param alpha defines the alpha component (1.0 by default)
  6088. * @returns a new Color4 object
  6089. */
  6090. static FromColor3(color3: DeepImmutable<Color3>, alpha?: number): Color4;
  6091. /**
  6092. * Creates a new Color4 from the starting index element of the given array
  6093. * @param array defines the source array to read from
  6094. * @param offset defines the offset in the source array
  6095. * @returns a new Color4 object
  6096. */
  6097. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color4;
  6098. /**
  6099. * Creates a new Color4 from the starting index element of the given array
  6100. * @param array defines the source array to read from
  6101. * @param offset defines the offset in the source array
  6102. * @param result defines the target Color4 object
  6103. */
  6104. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number | undefined, result: Color4): void;
  6105. /**
  6106. * Creates a new Color3 from integer values (< 256)
  6107. * @param r defines the red component to read from (value between 0 and 255)
  6108. * @param g defines the green component to read from (value between 0 and 255)
  6109. * @param b defines the blue component to read from (value between 0 and 255)
  6110. * @param a defines the alpha component to read from (value between 0 and 255)
  6111. * @returns a new Color3 object
  6112. */
  6113. static FromInts(r: number, g: number, b: number, a: number): Color4;
  6114. /**
  6115. * Check the content of a given array and convert it to an array containing RGBA data
  6116. * If the original array was already containing count * 4 values then it is returned directly
  6117. * @param colors defines the array to check
  6118. * @param count defines the number of RGBA data to expect
  6119. * @returns an array containing count * 4 values (RGBA)
  6120. */
  6121. static CheckColors4(colors: number[], count: number): number[];
  6122. }
  6123. /**
  6124. * @hidden
  6125. */
  6126. export class TmpColors {
  6127. static Color3: Color3[];
  6128. static Color4: Color4[];
  6129. }
  6130. }
  6131. declare module "babylonjs/Animations/animationKey" {
  6132. /**
  6133. * Defines an interface which represents an animation key frame
  6134. */
  6135. export interface IAnimationKey {
  6136. /**
  6137. * Frame of the key frame
  6138. */
  6139. frame: number;
  6140. /**
  6141. * Value at the specifies key frame
  6142. */
  6143. value: any;
  6144. /**
  6145. * The input tangent for the cubic hermite spline
  6146. */
  6147. inTangent?: any;
  6148. /**
  6149. * The output tangent for the cubic hermite spline
  6150. */
  6151. outTangent?: any;
  6152. /**
  6153. * The animation interpolation type
  6154. */
  6155. interpolation?: AnimationKeyInterpolation;
  6156. }
  6157. /**
  6158. * Enum for the animation key frame interpolation type
  6159. */
  6160. export enum AnimationKeyInterpolation {
  6161. /**
  6162. * Do not interpolate between keys and use the start key value only. Tangents are ignored
  6163. */
  6164. STEP = 1
  6165. }
  6166. }
  6167. declare module "babylonjs/Animations/animationRange" {
  6168. /**
  6169. * Represents the range of an animation
  6170. */
  6171. export class AnimationRange {
  6172. /**The name of the animation range**/
  6173. name: string;
  6174. /**The starting frame of the animation */
  6175. from: number;
  6176. /**The ending frame of the animation*/
  6177. to: number;
  6178. /**
  6179. * Initializes the range of an animation
  6180. * @param name The name of the animation range
  6181. * @param from The starting frame of the animation
  6182. * @param to The ending frame of the animation
  6183. */
  6184. constructor(
  6185. /**The name of the animation range**/
  6186. name: string,
  6187. /**The starting frame of the animation */
  6188. from: number,
  6189. /**The ending frame of the animation*/
  6190. to: number);
  6191. /**
  6192. * Makes a copy of the animation range
  6193. * @returns A copy of the animation range
  6194. */
  6195. clone(): AnimationRange;
  6196. }
  6197. }
  6198. declare module "babylonjs/Animations/animationEvent" {
  6199. /**
  6200. * Composed of a frame, and an action function
  6201. */
  6202. export class AnimationEvent {
  6203. /** The frame for which the event is triggered **/
  6204. frame: number;
  6205. /** The event to perform when triggered **/
  6206. action: (currentFrame: number) => void;
  6207. /** Specifies if the event should be triggered only once**/
  6208. onlyOnce?: boolean | undefined;
  6209. /**
  6210. * Specifies if the animation event is done
  6211. */
  6212. isDone: boolean;
  6213. /**
  6214. * Initializes the animation event
  6215. * @param frame The frame for which the event is triggered
  6216. * @param action The event to perform when triggered
  6217. * @param onlyOnce Specifies if the event should be triggered only once
  6218. */
  6219. constructor(
  6220. /** The frame for which the event is triggered **/
  6221. frame: number,
  6222. /** The event to perform when triggered **/
  6223. action: (currentFrame: number) => void,
  6224. /** Specifies if the event should be triggered only once**/
  6225. onlyOnce?: boolean | undefined);
  6226. /** @hidden */
  6227. _clone(): AnimationEvent;
  6228. }
  6229. }
  6230. declare module "babylonjs/Behaviors/behavior" {
  6231. import { Nullable } from "babylonjs/types";
  6232. /**
  6233. * Interface used to define a behavior
  6234. */
  6235. export interface Behavior<T> {
  6236. /** gets or sets behavior's name */
  6237. name: string;
  6238. /**
  6239. * Function called when the behavior needs to be initialized (after attaching it to a target)
  6240. */
  6241. init(): void;
  6242. /**
  6243. * Called when the behavior is attached to a target
  6244. * @param target defines the target where the behavior is attached to
  6245. */
  6246. attach(target: T): void;
  6247. /**
  6248. * Called when the behavior is detached from its target
  6249. */
  6250. detach(): void;
  6251. }
  6252. /**
  6253. * Interface implemented by classes supporting behaviors
  6254. */
  6255. export interface IBehaviorAware<T> {
  6256. /**
  6257. * Attach a behavior
  6258. * @param behavior defines the behavior to attach
  6259. * @returns the current host
  6260. */
  6261. addBehavior(behavior: Behavior<T>): T;
  6262. /**
  6263. * Remove a behavior from the current object
  6264. * @param behavior defines the behavior to detach
  6265. * @returns the current host
  6266. */
  6267. removeBehavior(behavior: Behavior<T>): T;
  6268. /**
  6269. * Gets a behavior using its name to search
  6270. * @param name defines the name to search
  6271. * @returns the behavior or null if not found
  6272. */
  6273. getBehaviorByName(name: string): Nullable<Behavior<T>>;
  6274. }
  6275. }
  6276. declare module "babylonjs/Misc/smartArray" {
  6277. /**
  6278. * Defines an array and its length.
  6279. * It can be helpfull to group result from both Arrays and smart arrays in one structure.
  6280. */
  6281. export interface ISmartArrayLike<T> {
  6282. /**
  6283. * The data of the array.
  6284. */
  6285. data: Array<T>;
  6286. /**
  6287. * The active length of the array.
  6288. */
  6289. length: number;
  6290. }
  6291. /**
  6292. * Defines an GC Friendly array where the backfield array do not shrink to prevent over allocations.
  6293. */
  6294. export class SmartArray<T> implements ISmartArrayLike<T> {
  6295. /**
  6296. * The full set of data from the array.
  6297. */
  6298. data: Array<T>;
  6299. /**
  6300. * The active length of the array.
  6301. */
  6302. length: number;
  6303. protected _id: number;
  6304. /**
  6305. * Instantiates a Smart Array.
  6306. * @param capacity defines the default capacity of the array.
  6307. */
  6308. constructor(capacity: number);
  6309. /**
  6310. * Pushes a value at the end of the active data.
  6311. * @param value defines the object to push in the array.
  6312. */
  6313. push(value: T): void;
  6314. /**
  6315. * Iterates over the active data and apply the lambda to them.
  6316. * @param func defines the action to apply on each value.
  6317. */
  6318. forEach(func: (content: T) => void): void;
  6319. /**
  6320. * Sorts the full sets of data.
  6321. * @param compareFn defines the comparison function to apply.
  6322. */
  6323. sort(compareFn: (a: T, b: T) => number): void;
  6324. /**
  6325. * Resets the active data to an empty array.
  6326. */
  6327. reset(): void;
  6328. /**
  6329. * Releases all the data from the array as well as the array.
  6330. */
  6331. dispose(): void;
  6332. /**
  6333. * Concats the active data with a given array.
  6334. * @param array defines the data to concatenate with.
  6335. */
  6336. concat(array: any): void;
  6337. /**
  6338. * Returns the position of a value in the active data.
  6339. * @param value defines the value to find the index for
  6340. * @returns the index if found in the active data otherwise -1
  6341. */
  6342. indexOf(value: T): number;
  6343. /**
  6344. * Returns whether an element is part of the active data.
  6345. * @param value defines the value to look for
  6346. * @returns true if found in the active data otherwise false
  6347. */
  6348. contains(value: T): boolean;
  6349. private static _GlobalId;
  6350. }
  6351. /**
  6352. * Defines an GC Friendly array where the backfield array do not shrink to prevent over allocations.
  6353. * The data in this array can only be present once
  6354. */
  6355. export class SmartArrayNoDuplicate<T> extends SmartArray<T> {
  6356. private _duplicateId;
  6357. /**
  6358. * Pushes a value at the end of the active data.
  6359. * THIS DOES NOT PREVENT DUPPLICATE DATA
  6360. * @param value defines the object to push in the array.
  6361. */
  6362. push(value: T): void;
  6363. /**
  6364. * Pushes a value at the end of the active data.
  6365. * If the data is already present, it won t be added again
  6366. * @param value defines the object to push in the array.
  6367. * @returns true if added false if it was already present
  6368. */
  6369. pushNoDuplicate(value: T): boolean;
  6370. /**
  6371. * Resets the active data to an empty array.
  6372. */
  6373. reset(): void;
  6374. /**
  6375. * Concats the active data with a given array.
  6376. * This ensures no dupplicate will be present in the result.
  6377. * @param array defines the data to concatenate with.
  6378. */
  6379. concatWithNoDuplicate(array: any): void;
  6380. }
  6381. }
  6382. declare module "babylonjs/Cameras/cameraInputsManager" {
  6383. import { Nullable } from "babylonjs/types";
  6384. import { Camera } from "babylonjs/Cameras/camera";
  6385. /**
  6386. * @ignore
  6387. * This is a list of all the different input types that are available in the application.
  6388. * Fo instance: ArcRotateCameraGamepadInput...
  6389. */
  6390. export var CameraInputTypes: {};
  6391. /**
  6392. * This is the contract to implement in order to create a new input class.
  6393. * Inputs are dealing with listening to user actions and moving the camera accordingly.
  6394. */
  6395. export interface ICameraInput<TCamera extends Camera> {
  6396. /**
  6397. * Defines the camera the input is attached to.
  6398. */
  6399. camera: Nullable<TCamera>;
  6400. /**
  6401. * Gets the class name of the current intput.
  6402. * @returns the class name
  6403. */
  6404. getClassName(): string;
  6405. /**
  6406. * Get the friendly name associated with the input class.
  6407. * @returns the input friendly name
  6408. */
  6409. getSimpleName(): string;
  6410. /**
  6411. * Attach the input controls to a specific dom element to get the input from.
  6412. * @param element Defines the element the controls should be listened from
  6413. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  6414. */
  6415. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  6416. /**
  6417. * Detach the current controls from the specified dom element.
  6418. * @param element Defines the element to stop listening the inputs from
  6419. */
  6420. detachControl(element: Nullable<HTMLElement>): void;
  6421. /**
  6422. * Update the current camera state depending on the inputs that have been used this frame.
  6423. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  6424. */
  6425. checkInputs?: () => void;
  6426. }
  6427. /**
  6428. * Represents a map of input types to input instance or input index to input instance.
  6429. */
  6430. export interface CameraInputsMap<TCamera extends Camera> {
  6431. /**
  6432. * Accessor to the input by input type.
  6433. */
  6434. [name: string]: ICameraInput<TCamera>;
  6435. /**
  6436. * Accessor to the input by input index.
  6437. */
  6438. [idx: number]: ICameraInput<TCamera>;
  6439. }
  6440. /**
  6441. * This represents the input manager used within a camera.
  6442. * It helps dealing with all the different kind of input attached to a camera.
  6443. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  6444. */
  6445. export class CameraInputsManager<TCamera extends Camera> {
  6446. /**
  6447. * Defines the list of inputs attahed to the camera.
  6448. */
  6449. attached: CameraInputsMap<TCamera>;
  6450. /**
  6451. * Defines the dom element the camera is collecting inputs from.
  6452. * This is null if the controls have not been attached.
  6453. */
  6454. attachedElement: Nullable<HTMLElement>;
  6455. /**
  6456. * Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  6457. */
  6458. noPreventDefault: boolean;
  6459. /**
  6460. * Defined the camera the input manager belongs to.
  6461. */
  6462. camera: TCamera;
  6463. /**
  6464. * Update the current camera state depending on the inputs that have been used this frame.
  6465. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  6466. */
  6467. checkInputs: () => void;
  6468. /**
  6469. * Instantiate a new Camera Input Manager.
  6470. * @param camera Defines the camera the input manager blongs to
  6471. */
  6472. constructor(camera: TCamera);
  6473. /**
  6474. * Add an input method to a camera
  6475. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  6476. * @param input camera input method
  6477. */
  6478. add(input: ICameraInput<TCamera>): void;
  6479. /**
  6480. * Remove a specific input method from a camera
  6481. * example: camera.inputs.remove(camera.inputs.attached.mouse);
  6482. * @param inputToRemove camera input method
  6483. */
  6484. remove(inputToRemove: ICameraInput<TCamera>): void;
  6485. /**
  6486. * Remove a specific input type from a camera
  6487. * example: camera.inputs.remove("ArcRotateCameraGamepadInput");
  6488. * @param inputType the type of the input to remove
  6489. */
  6490. removeByType(inputType: string): void;
  6491. private _addCheckInputs;
  6492. /**
  6493. * Attach the input controls to the currently attached dom element to listen the events from.
  6494. * @param input Defines the input to attach
  6495. */
  6496. attachInput(input: ICameraInput<TCamera>): void;
  6497. /**
  6498. * Attach the current manager inputs controls to a specific dom element to listen the events from.
  6499. * @param element Defines the dom element to collect the events from
  6500. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  6501. */
  6502. attachElement(element: HTMLElement, noPreventDefault?: boolean): void;
  6503. /**
  6504. * Detach the current manager inputs controls from a specific dom element.
  6505. * @param element Defines the dom element to collect the events from
  6506. * @param disconnect Defines whether the input should be removed from the current list of attached inputs
  6507. */
  6508. detachElement(element: HTMLElement, disconnect?: boolean): void;
  6509. /**
  6510. * Rebuild the dynamic inputCheck function from the current list of
  6511. * defined inputs in the manager.
  6512. */
  6513. rebuildInputCheck(): void;
  6514. /**
  6515. * Remove all attached input methods from a camera
  6516. */
  6517. clear(): void;
  6518. /**
  6519. * Serialize the current input manager attached to a camera.
  6520. * This ensures than once parsed,
  6521. * the input associated to the camera will be identical to the current ones
  6522. * @param serializedCamera Defines the camera serialization JSON the input serialization should write to
  6523. */
  6524. serialize(serializedCamera: any): void;
  6525. /**
  6526. * Parses an input manager serialized JSON to restore the previous list of inputs
  6527. * and states associated to a camera.
  6528. * @param parsedCamera Defines the JSON to parse
  6529. */
  6530. parse(parsedCamera: any): void;
  6531. }
  6532. }
  6533. declare module "babylonjs/Meshes/buffer" {
  6534. import { Nullable, DataArray } from "babylonjs/types";
  6535. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  6536. /**
  6537. * Class used to store data that will be store in GPU memory
  6538. */
  6539. export class Buffer {
  6540. private _engine;
  6541. private _buffer;
  6542. /** @hidden */
  6543. _data: Nullable<DataArray>;
  6544. private _updatable;
  6545. private _instanced;
  6546. private _divisor;
  6547. /**
  6548. * Gets the byte stride.
  6549. */
  6550. readonly byteStride: number;
  6551. /**
  6552. * Constructor
  6553. * @param engine the engine
  6554. * @param data the data to use for this buffer
  6555. * @param updatable whether the data is updatable
  6556. * @param stride the stride (optional)
  6557. * @param postponeInternalCreation whether to postpone creating the internal WebGL buffer (optional)
  6558. * @param instanced whether the buffer is instanced (optional)
  6559. * @param useBytes set to true if the stride in in bytes (optional)
  6560. * @param divisor sets an optional divisor for instances (1 by default)
  6561. */
  6562. constructor(engine: any, data: DataArray, updatable: boolean, stride?: number, postponeInternalCreation?: boolean, instanced?: boolean, useBytes?: boolean, divisor?: number);
  6563. /**
  6564. * Create a new VertexBuffer based on the current buffer
  6565. * @param kind defines the vertex buffer kind (position, normal, etc.)
  6566. * @param offset defines offset in the buffer (0 by default)
  6567. * @param size defines the size in floats of attributes (position is 3 for instance)
  6568. * @param stride defines the stride size in floats in the buffer (the offset to apply to reach next value when data is interleaved)
  6569. * @param instanced defines if the vertex buffer contains indexed data
  6570. * @param useBytes defines if the offset and stride are in bytes *
  6571. * @param divisor sets an optional divisor for instances (1 by default)
  6572. * @returns the new vertex buffer
  6573. */
  6574. createVertexBuffer(kind: string, offset: number, size: number, stride?: number, instanced?: boolean, useBytes?: boolean, divisor?: number): VertexBuffer;
  6575. /**
  6576. * Gets a boolean indicating if the Buffer is updatable?
  6577. * @returns true if the buffer is updatable
  6578. */
  6579. isUpdatable(): boolean;
  6580. /**
  6581. * Gets current buffer's data
  6582. * @returns a DataArray or null
  6583. */
  6584. getData(): Nullable<DataArray>;
  6585. /**
  6586. * Gets underlying native buffer
  6587. * @returns underlying native buffer
  6588. */
  6589. getBuffer(): Nullable<DataBuffer>;
  6590. /**
  6591. * Gets the stride in float32 units (i.e. byte stride / 4).
  6592. * May not be an integer if the byte stride is not divisible by 4.
  6593. * @returns the stride in float32 units
  6594. * @deprecated Please use byteStride instead.
  6595. */
  6596. getStrideSize(): number;
  6597. /**
  6598. * Store data into the buffer. If the buffer was already used it will be either recreated or updated depending on isUpdatable property
  6599. * @param data defines the data to store
  6600. */
  6601. create(data?: Nullable<DataArray>): void;
  6602. /** @hidden */
  6603. _rebuild(): void;
  6604. /**
  6605. * Update current buffer data
  6606. * @param data defines the data to store
  6607. */
  6608. update(data: DataArray): void;
  6609. /**
  6610. * Updates the data directly.
  6611. * @param data the new data
  6612. * @param offset the new offset
  6613. * @param vertexCount the vertex count (optional)
  6614. * @param useBytes set to true if the offset is in bytes
  6615. */
  6616. updateDirectly(data: DataArray, offset: number, vertexCount?: number, useBytes?: boolean): void;
  6617. /**
  6618. * Release all resources
  6619. */
  6620. dispose(): void;
  6621. }
  6622. /**
  6623. * Specialized buffer used to store vertex data
  6624. */
  6625. export class VertexBuffer {
  6626. /** @hidden */
  6627. _buffer: Buffer;
  6628. private _kind;
  6629. private _size;
  6630. private _ownsBuffer;
  6631. private _instanced;
  6632. private _instanceDivisor;
  6633. /**
  6634. * The byte type.
  6635. */
  6636. static readonly BYTE: number;
  6637. /**
  6638. * The unsigned byte type.
  6639. */
  6640. static readonly UNSIGNED_BYTE: number;
  6641. /**
  6642. * The short type.
  6643. */
  6644. static readonly SHORT: number;
  6645. /**
  6646. * The unsigned short type.
  6647. */
  6648. static readonly UNSIGNED_SHORT: number;
  6649. /**
  6650. * The integer type.
  6651. */
  6652. static readonly INT: number;
  6653. /**
  6654. * The unsigned integer type.
  6655. */
  6656. static readonly UNSIGNED_INT: number;
  6657. /**
  6658. * The float type.
  6659. */
  6660. static readonly FLOAT: number;
  6661. /**
  6662. * Gets or sets the instance divisor when in instanced mode
  6663. */
  6664. get instanceDivisor(): number;
  6665. set instanceDivisor(value: number);
  6666. /**
  6667. * Gets the byte stride.
  6668. */
  6669. readonly byteStride: number;
  6670. /**
  6671. * Gets the byte offset.
  6672. */
  6673. readonly byteOffset: number;
  6674. /**
  6675. * Gets whether integer data values should be normalized into a certain range when being casted to a float.
  6676. */
  6677. readonly normalized: boolean;
  6678. /**
  6679. * Gets the data type of each component in the array.
  6680. */
  6681. readonly type: number;
  6682. /**
  6683. * Constructor
  6684. * @param engine the engine
  6685. * @param data the data to use for this vertex buffer
  6686. * @param kind the vertex buffer kind
  6687. * @param updatable whether the data is updatable
  6688. * @param postponeInternalCreation whether to postpone creating the internal WebGL buffer (optional)
  6689. * @param stride the stride (optional)
  6690. * @param instanced whether the buffer is instanced (optional)
  6691. * @param offset the offset of the data (optional)
  6692. * @param size the number of components (optional)
  6693. * @param type the type of the component (optional)
  6694. * @param normalized whether the data contains normalized data (optional)
  6695. * @param useBytes set to true if stride and offset are in bytes (optional)
  6696. * @param divisor defines the instance divisor to use (1 by default)
  6697. */
  6698. constructor(engine: any, data: DataArray | Buffer, kind: string, updatable: boolean, postponeInternalCreation?: boolean, stride?: number, instanced?: boolean, offset?: number, size?: number, type?: number, normalized?: boolean, useBytes?: boolean, divisor?: number);
  6699. /** @hidden */
  6700. _rebuild(): void;
  6701. /**
  6702. * Returns the kind of the VertexBuffer (string)
  6703. * @returns a string
  6704. */
  6705. getKind(): string;
  6706. /**
  6707. * Gets a boolean indicating if the VertexBuffer is updatable?
  6708. * @returns true if the buffer is updatable
  6709. */
  6710. isUpdatable(): boolean;
  6711. /**
  6712. * Gets current buffer's data
  6713. * @returns a DataArray or null
  6714. */
  6715. getData(): Nullable<DataArray>;
  6716. /**
  6717. * Gets underlying native buffer
  6718. * @returns underlying native buffer
  6719. */
  6720. getBuffer(): Nullable<DataBuffer>;
  6721. /**
  6722. * Gets the stride in float32 units (i.e. byte stride / 4).
  6723. * May not be an integer if the byte stride is not divisible by 4.
  6724. * @returns the stride in float32 units
  6725. * @deprecated Please use byteStride instead.
  6726. */
  6727. getStrideSize(): number;
  6728. /**
  6729. * Returns the offset as a multiple of the type byte length.
  6730. * @returns the offset in bytes
  6731. * @deprecated Please use byteOffset instead.
  6732. */
  6733. getOffset(): number;
  6734. /**
  6735. * Returns the number of components per vertex attribute (integer)
  6736. * @returns the size in float
  6737. */
  6738. getSize(): number;
  6739. /**
  6740. * Gets a boolean indicating is the internal buffer of the VertexBuffer is instanced
  6741. * @returns true if this buffer is instanced
  6742. */
  6743. getIsInstanced(): boolean;
  6744. /**
  6745. * Returns the instancing divisor, zero for non-instanced (integer).
  6746. * @returns a number
  6747. */
  6748. getInstanceDivisor(): number;
  6749. /**
  6750. * Store data into the buffer. If the buffer was already used it will be either recreated or updated depending on isUpdatable property
  6751. * @param data defines the data to store
  6752. */
  6753. create(data?: DataArray): void;
  6754. /**
  6755. * Updates the underlying buffer according to the passed numeric array or Float32Array.
  6756. * This function will create a new buffer if the current one is not updatable
  6757. * @param data defines the data to store
  6758. */
  6759. update(data: DataArray): void;
  6760. /**
  6761. * Updates directly the underlying WebGLBuffer according to the passed numeric array or Float32Array.
  6762. * Returns the directly updated WebGLBuffer.
  6763. * @param data the new data
  6764. * @param offset the new offset
  6765. * @param useBytes set to true if the offset is in bytes
  6766. */
  6767. updateDirectly(data: DataArray, offset: number, useBytes?: boolean): void;
  6768. /**
  6769. * Disposes the VertexBuffer and the underlying WebGLBuffer.
  6770. */
  6771. dispose(): void;
  6772. /**
  6773. * Enumerates each value of this vertex buffer as numbers.
  6774. * @param count the number of values to enumerate
  6775. * @param callback the callback function called for each value
  6776. */
  6777. forEach(count: number, callback: (value: number, index: number) => void): void;
  6778. /**
  6779. * Positions
  6780. */
  6781. static readonly PositionKind: string;
  6782. /**
  6783. * Normals
  6784. */
  6785. static readonly NormalKind: string;
  6786. /**
  6787. * Tangents
  6788. */
  6789. static readonly TangentKind: string;
  6790. /**
  6791. * Texture coordinates
  6792. */
  6793. static readonly UVKind: string;
  6794. /**
  6795. * Texture coordinates 2
  6796. */
  6797. static readonly UV2Kind: string;
  6798. /**
  6799. * Texture coordinates 3
  6800. */
  6801. static readonly UV3Kind: string;
  6802. /**
  6803. * Texture coordinates 4
  6804. */
  6805. static readonly UV4Kind: string;
  6806. /**
  6807. * Texture coordinates 5
  6808. */
  6809. static readonly UV5Kind: string;
  6810. /**
  6811. * Texture coordinates 6
  6812. */
  6813. static readonly UV6Kind: string;
  6814. /**
  6815. * Colors
  6816. */
  6817. static readonly ColorKind: string;
  6818. /**
  6819. * Matrix indices (for bones)
  6820. */
  6821. static readonly MatricesIndicesKind: string;
  6822. /**
  6823. * Matrix weights (for bones)
  6824. */
  6825. static readonly MatricesWeightsKind: string;
  6826. /**
  6827. * Additional matrix indices (for bones)
  6828. */
  6829. static readonly MatricesIndicesExtraKind: string;
  6830. /**
  6831. * Additional matrix weights (for bones)
  6832. */
  6833. static readonly MatricesWeightsExtraKind: string;
  6834. /**
  6835. * Deduces the stride given a kind.
  6836. * @param kind The kind string to deduce
  6837. * @returns The deduced stride
  6838. */
  6839. static DeduceStride(kind: string): number;
  6840. /**
  6841. * Gets the byte length of the given type.
  6842. * @param type the type
  6843. * @returns the number of bytes
  6844. */
  6845. static GetTypeByteLength(type: number): number;
  6846. /**
  6847. * Enumerates each value of the given parameters as numbers.
  6848. * @param data the data to enumerate
  6849. * @param byteOffset the byte offset of the data
  6850. * @param byteStride the byte stride of the data
  6851. * @param componentCount the number of components per element
  6852. * @param componentType the type of the component
  6853. * @param count the number of values to enumerate
  6854. * @param normalized whether the data is normalized
  6855. * @param callback the callback function called for each value
  6856. */
  6857. static ForEach(data: DataArray, byteOffset: number, byteStride: number, componentCount: number, componentType: number, count: number, normalized: boolean, callback: (value: number, index: number) => void): void;
  6858. private static _GetFloatValue;
  6859. }
  6860. }
  6861. declare module "babylonjs/Collisions/intersectionInfo" {
  6862. import { Nullable } from "babylonjs/types";
  6863. /**
  6864. * @hidden
  6865. */
  6866. export class IntersectionInfo {
  6867. bu: Nullable<number>;
  6868. bv: Nullable<number>;
  6869. distance: number;
  6870. faceId: number;
  6871. subMeshId: number;
  6872. constructor(bu: Nullable<number>, bv: Nullable<number>, distance: number);
  6873. }
  6874. }
  6875. declare module "babylonjs/Culling/boundingSphere" {
  6876. import { DeepImmutable } from "babylonjs/types";
  6877. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  6878. import { Plane } from "babylonjs/Maths/math.plane";
  6879. /**
  6880. * Class used to store bounding sphere information
  6881. */
  6882. export class BoundingSphere {
  6883. /**
  6884. * Gets the center of the bounding sphere in local space
  6885. */
  6886. readonly center: Vector3;
  6887. /**
  6888. * Radius of the bounding sphere in local space
  6889. */
  6890. radius: number;
  6891. /**
  6892. * Gets the center of the bounding sphere in world space
  6893. */
  6894. readonly centerWorld: Vector3;
  6895. /**
  6896. * Radius of the bounding sphere in world space
  6897. */
  6898. radiusWorld: number;
  6899. /**
  6900. * Gets the minimum vector in local space
  6901. */
  6902. readonly minimum: Vector3;
  6903. /**
  6904. * Gets the maximum vector in local space
  6905. */
  6906. readonly maximum: Vector3;
  6907. private _worldMatrix;
  6908. private static readonly TmpVector3;
  6909. /**
  6910. * Creates a new bounding sphere
  6911. * @param min defines the minimum vector (in local space)
  6912. * @param max defines the maximum vector (in local space)
  6913. * @param worldMatrix defines the new world matrix
  6914. */
  6915. constructor(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  6916. /**
  6917. * Recreates the entire bounding sphere from scratch as if we call the constructor in place
  6918. * @param min defines the new minimum vector (in local space)
  6919. * @param max defines the new maximum vector (in local space)
  6920. * @param worldMatrix defines the new world matrix
  6921. */
  6922. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  6923. /**
  6924. * Scale the current bounding sphere by applying a scale factor
  6925. * @param factor defines the scale factor to apply
  6926. * @returns the current bounding box
  6927. */
  6928. scale(factor: number): BoundingSphere;
  6929. /**
  6930. * Gets the world matrix of the bounding box
  6931. * @returns a matrix
  6932. */
  6933. getWorldMatrix(): DeepImmutable<Matrix>;
  6934. /** @hidden */
  6935. _update(worldMatrix: DeepImmutable<Matrix>): void;
  6936. /**
  6937. * Tests if the bounding sphere is intersecting the frustum planes
  6938. * @param frustumPlanes defines the frustum planes to test
  6939. * @returns true if there is an intersection
  6940. */
  6941. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  6942. /**
  6943. * Tests if the bounding sphere center is in between the frustum planes.
  6944. * Used for optimistic fast inclusion.
  6945. * @param frustumPlanes defines the frustum planes to test
  6946. * @returns true if the sphere center is in between the frustum planes
  6947. */
  6948. isCenterInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  6949. /**
  6950. * Tests if a point is inside the bounding sphere
  6951. * @param point defines the point to test
  6952. * @returns true if the point is inside the bounding sphere
  6953. */
  6954. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  6955. /**
  6956. * Checks if two sphere intersct
  6957. * @param sphere0 sphere 0
  6958. * @param sphere1 sphere 1
  6959. * @returns true if the speres intersect
  6960. */
  6961. static Intersects(sphere0: DeepImmutable<BoundingSphere>, sphere1: DeepImmutable<BoundingSphere>): boolean;
  6962. }
  6963. }
  6964. declare module "babylonjs/Culling/boundingBox" {
  6965. import { DeepImmutable } from "babylonjs/types";
  6966. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  6967. import { BoundingSphere } from "babylonjs/Culling/boundingSphere";
  6968. import { ICullable } from "babylonjs/Culling/boundingInfo";
  6969. import { Plane } from "babylonjs/Maths/math.plane";
  6970. /**
  6971. * Class used to store bounding box information
  6972. */
  6973. export class BoundingBox implements ICullable {
  6974. /**
  6975. * Gets the 8 vectors representing the bounding box in local space
  6976. */
  6977. readonly vectors: Vector3[];
  6978. /**
  6979. * Gets the center of the bounding box in local space
  6980. */
  6981. readonly center: Vector3;
  6982. /**
  6983. * Gets the center of the bounding box in world space
  6984. */
  6985. readonly centerWorld: Vector3;
  6986. /**
  6987. * Gets the extend size in local space
  6988. */
  6989. readonly extendSize: Vector3;
  6990. /**
  6991. * Gets the extend size in world space
  6992. */
  6993. readonly extendSizeWorld: Vector3;
  6994. /**
  6995. * Gets the OBB (object bounding box) directions
  6996. */
  6997. readonly directions: Vector3[];
  6998. /**
  6999. * Gets the 8 vectors representing the bounding box in world space
  7000. */
  7001. readonly vectorsWorld: Vector3[];
  7002. /**
  7003. * Gets the minimum vector in world space
  7004. */
  7005. readonly minimumWorld: Vector3;
  7006. /**
  7007. * Gets the maximum vector in world space
  7008. */
  7009. readonly maximumWorld: Vector3;
  7010. /**
  7011. * Gets the minimum vector in local space
  7012. */
  7013. readonly minimum: Vector3;
  7014. /**
  7015. * Gets the maximum vector in local space
  7016. */
  7017. readonly maximum: Vector3;
  7018. private _worldMatrix;
  7019. private static readonly TmpVector3;
  7020. /**
  7021. * @hidden
  7022. */
  7023. _tag: number;
  7024. /**
  7025. * Creates a new bounding box
  7026. * @param min defines the minimum vector (in local space)
  7027. * @param max defines the maximum vector (in local space)
  7028. * @param worldMatrix defines the new world matrix
  7029. */
  7030. constructor(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  7031. /**
  7032. * Recreates the entire bounding box from scratch as if we call the constructor in place
  7033. * @param min defines the new minimum vector (in local space)
  7034. * @param max defines the new maximum vector (in local space)
  7035. * @param worldMatrix defines the new world matrix
  7036. */
  7037. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  7038. /**
  7039. * Scale the current bounding box by applying a scale factor
  7040. * @param factor defines the scale factor to apply
  7041. * @returns the current bounding box
  7042. */
  7043. scale(factor: number): BoundingBox;
  7044. /**
  7045. * Gets the world matrix of the bounding box
  7046. * @returns a matrix
  7047. */
  7048. getWorldMatrix(): DeepImmutable<Matrix>;
  7049. /** @hidden */
  7050. _update(world: DeepImmutable<Matrix>): void;
  7051. /**
  7052. * Tests if the bounding box is intersecting the frustum planes
  7053. * @param frustumPlanes defines the frustum planes to test
  7054. * @returns true if there is an intersection
  7055. */
  7056. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  7057. /**
  7058. * Tests if the bounding box is entirely inside the frustum planes
  7059. * @param frustumPlanes defines the frustum planes to test
  7060. * @returns true if there is an inclusion
  7061. */
  7062. isCompletelyInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  7063. /**
  7064. * Tests if a point is inside the bounding box
  7065. * @param point defines the point to test
  7066. * @returns true if the point is inside the bounding box
  7067. */
  7068. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  7069. /**
  7070. * Tests if the bounding box intersects with a bounding sphere
  7071. * @param sphere defines the sphere to test
  7072. * @returns true if there is an intersection
  7073. */
  7074. intersectsSphere(sphere: DeepImmutable<BoundingSphere>): boolean;
  7075. /**
  7076. * Tests if the bounding box intersects with a box defined by a min and max vectors
  7077. * @param min defines the min vector to use
  7078. * @param max defines the max vector to use
  7079. * @returns true if there is an intersection
  7080. */
  7081. intersectsMinMax(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>): boolean;
  7082. /**
  7083. * Tests if two bounding boxes are intersections
  7084. * @param box0 defines the first box to test
  7085. * @param box1 defines the second box to test
  7086. * @returns true if there is an intersection
  7087. */
  7088. static Intersects(box0: DeepImmutable<BoundingBox>, box1: DeepImmutable<BoundingBox>): boolean;
  7089. /**
  7090. * Tests if a bounding box defines by a min/max vectors intersects a sphere
  7091. * @param minPoint defines the minimum vector of the bounding box
  7092. * @param maxPoint defines the maximum vector of the bounding box
  7093. * @param sphereCenter defines the sphere center
  7094. * @param sphereRadius defines the sphere radius
  7095. * @returns true if there is an intersection
  7096. */
  7097. static IntersectsSphere(minPoint: DeepImmutable<Vector3>, maxPoint: DeepImmutable<Vector3>, sphereCenter: DeepImmutable<Vector3>, sphereRadius: number): boolean;
  7098. /**
  7099. * Tests if a bounding box defined with 8 vectors is entirely inside frustum planes
  7100. * @param boundingVectors defines an array of 8 vectors representing a bounding box
  7101. * @param frustumPlanes defines the frustum planes to test
  7102. * @return true if there is an inclusion
  7103. */
  7104. static IsCompletelyInFrustum(boundingVectors: Array<DeepImmutable<Vector3>>, frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  7105. /**
  7106. * Tests if a bounding box defined with 8 vectors intersects frustum planes
  7107. * @param boundingVectors defines an array of 8 vectors representing a bounding box
  7108. * @param frustumPlanes defines the frustum planes to test
  7109. * @return true if there is an intersection
  7110. */
  7111. static IsInFrustum(boundingVectors: Array<DeepImmutable<Vector3>>, frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  7112. }
  7113. }
  7114. declare module "babylonjs/Collisions/collider" {
  7115. import { Nullable, IndicesArray } from "babylonjs/types";
  7116. import { Vector3 } from "babylonjs/Maths/math.vector";
  7117. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  7118. import { Plane } from "babylonjs/Maths/math.plane";
  7119. /** @hidden */
  7120. export class Collider {
  7121. /** Define if a collision was found */
  7122. collisionFound: boolean;
  7123. /**
  7124. * Define last intersection point in local space
  7125. */
  7126. intersectionPoint: Vector3;
  7127. /**
  7128. * Define last collided mesh
  7129. */
  7130. collidedMesh: Nullable<AbstractMesh>;
  7131. private _collisionPoint;
  7132. private _planeIntersectionPoint;
  7133. private _tempVector;
  7134. private _tempVector2;
  7135. private _tempVector3;
  7136. private _tempVector4;
  7137. private _edge;
  7138. private _baseToVertex;
  7139. private _destinationPoint;
  7140. private _slidePlaneNormal;
  7141. private _displacementVector;
  7142. /** @hidden */
  7143. _radius: Vector3;
  7144. /** @hidden */
  7145. _retry: number;
  7146. private _velocity;
  7147. private _basePoint;
  7148. private _epsilon;
  7149. /** @hidden */
  7150. _velocityWorldLength: number;
  7151. /** @hidden */
  7152. _basePointWorld: Vector3;
  7153. private _velocityWorld;
  7154. private _normalizedVelocity;
  7155. /** @hidden */
  7156. _initialVelocity: Vector3;
  7157. /** @hidden */
  7158. _initialPosition: Vector3;
  7159. private _nearestDistance;
  7160. private _collisionMask;
  7161. get collisionMask(): number;
  7162. set collisionMask(mask: number);
  7163. /**
  7164. * Gets the plane normal used to compute the sliding response (in local space)
  7165. */
  7166. get slidePlaneNormal(): Vector3;
  7167. /** @hidden */
  7168. _initialize(source: Vector3, dir: Vector3, e: number): void;
  7169. /** @hidden */
  7170. _checkPointInTriangle(point: Vector3, pa: Vector3, pb: Vector3, pc: Vector3, n: Vector3): boolean;
  7171. /** @hidden */
  7172. _canDoCollision(sphereCenter: Vector3, sphereRadius: number, vecMin: Vector3, vecMax: Vector3): boolean;
  7173. /** @hidden */
  7174. _testTriangle(faceIndex: number, trianglePlaneArray: Array<Plane>, p1: Vector3, p2: Vector3, p3: Vector3, hasMaterial: boolean, hostMesh: AbstractMesh): void;
  7175. /** @hidden */
  7176. _collide(trianglePlaneArray: Array<Plane>, pts: Vector3[], indices: IndicesArray, indexStart: number, indexEnd: number, decal: number, hasMaterial: boolean, hostMesh: AbstractMesh): void;
  7177. /** @hidden */
  7178. _getResponse(pos: Vector3, vel: Vector3): void;
  7179. }
  7180. }
  7181. declare module "babylonjs/Culling/boundingInfo" {
  7182. import { DeepImmutable } from "babylonjs/types";
  7183. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  7184. import { BoundingBox } from "babylonjs/Culling/boundingBox";
  7185. import { BoundingSphere } from "babylonjs/Culling/boundingSphere";
  7186. import { Plane } from "babylonjs/Maths/math.plane";
  7187. import { Collider } from "babylonjs/Collisions/collider";
  7188. /**
  7189. * Interface for cullable objects
  7190. * @see https://doc.babylonjs.com/babylon101/materials#back-face-culling
  7191. */
  7192. export interface ICullable {
  7193. /**
  7194. * Checks if the object or part of the object is in the frustum
  7195. * @param frustumPlanes Camera near/planes
  7196. * @returns true if the object is in frustum otherwise false
  7197. */
  7198. isInFrustum(frustumPlanes: Plane[]): boolean;
  7199. /**
  7200. * Checks if a cullable object (mesh...) is in the camera frustum
  7201. * Unlike isInFrustum this cheks the full bounding box
  7202. * @param frustumPlanes Camera near/planes
  7203. * @returns true if the object is in frustum otherwise false
  7204. */
  7205. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  7206. }
  7207. /**
  7208. * Info for a bounding data of a mesh
  7209. */
  7210. export class BoundingInfo implements ICullable {
  7211. /**
  7212. * Bounding box for the mesh
  7213. */
  7214. readonly boundingBox: BoundingBox;
  7215. /**
  7216. * Bounding sphere for the mesh
  7217. */
  7218. readonly boundingSphere: BoundingSphere;
  7219. private _isLocked;
  7220. private static readonly TmpVector3;
  7221. /**
  7222. * Constructs bounding info
  7223. * @param minimum min vector of the bounding box/sphere
  7224. * @param maximum max vector of the bounding box/sphere
  7225. * @param worldMatrix defines the new world matrix
  7226. */
  7227. constructor(minimum: DeepImmutable<Vector3>, maximum: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  7228. /**
  7229. * Recreates the entire bounding info from scratch as if we call the constructor in place
  7230. * @param min defines the new minimum vector (in local space)
  7231. * @param max defines the new maximum vector (in local space)
  7232. * @param worldMatrix defines the new world matrix
  7233. */
  7234. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  7235. /**
  7236. * min vector of the bounding box/sphere
  7237. */
  7238. get minimum(): Vector3;
  7239. /**
  7240. * max vector of the bounding box/sphere
  7241. */
  7242. get maximum(): Vector3;
  7243. /**
  7244. * If the info is locked and won't be updated to avoid perf overhead
  7245. */
  7246. get isLocked(): boolean;
  7247. set isLocked(value: boolean);
  7248. /**
  7249. * Updates the bounding sphere and box
  7250. * @param world world matrix to be used to update
  7251. */
  7252. update(world: DeepImmutable<Matrix>): void;
  7253. /**
  7254. * Recreate the bounding info to be centered around a specific point given a specific extend.
  7255. * @param center New center of the bounding info
  7256. * @param extend New extend of the bounding info
  7257. * @returns the current bounding info
  7258. */
  7259. centerOn(center: DeepImmutable<Vector3>, extend: DeepImmutable<Vector3>): BoundingInfo;
  7260. /**
  7261. * Scale the current bounding info by applying a scale factor
  7262. * @param factor defines the scale factor to apply
  7263. * @returns the current bounding info
  7264. */
  7265. scale(factor: number): BoundingInfo;
  7266. /**
  7267. * Returns `true` if the bounding info is within the frustum defined by the passed array of planes.
  7268. * @param frustumPlanes defines the frustum to test
  7269. * @param strategy defines the strategy to use for the culling (default is BABYLON.AbstractMesh.CULLINGSTRATEGY_STANDARD)
  7270. * @returns true if the bounding info is in the frustum planes
  7271. */
  7272. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>, strategy?: number): boolean;
  7273. /**
  7274. * Gets the world distance between the min and max points of the bounding box
  7275. */
  7276. get diagonalLength(): number;
  7277. /**
  7278. * Checks if a cullable object (mesh...) is in the camera frustum
  7279. * Unlike isInFrustum this cheks the full bounding box
  7280. * @param frustumPlanes Camera near/planes
  7281. * @returns true if the object is in frustum otherwise false
  7282. */
  7283. isCompletelyInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  7284. /** @hidden */
  7285. _checkCollision(collider: Collider): boolean;
  7286. /**
  7287. * Checks if a point is inside the bounding box and bounding sphere or the mesh
  7288. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  7289. * @param point the point to check intersection with
  7290. * @returns if the point intersects
  7291. */
  7292. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  7293. /**
  7294. * Checks if another bounding info intersects the bounding box and bounding sphere or the mesh
  7295. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  7296. * @param boundingInfo the bounding info to check intersection with
  7297. * @param precise if the intersection should be done using OBB
  7298. * @returns if the bounding info intersects
  7299. */
  7300. intersects(boundingInfo: DeepImmutable<BoundingInfo>, precise: boolean): boolean;
  7301. }
  7302. }
  7303. declare module "babylonjs/Maths/math.functions" {
  7304. import { FloatArray, Nullable, IndicesArray } from "babylonjs/types";
  7305. import { Vector2, Vector3 } from "babylonjs/Maths/math.vector";
  7306. /**
  7307. * Extracts minimum and maximum values from a list of indexed positions
  7308. * @param positions defines the positions to use
  7309. * @param indices defines the indices to the positions
  7310. * @param indexStart defines the start index
  7311. * @param indexCount defines the end index
  7312. * @param bias defines bias value to add to the result
  7313. * @return minimum and maximum values
  7314. */
  7315. export function extractMinAndMaxIndexed(positions: FloatArray, indices: IndicesArray, indexStart: number, indexCount: number, bias?: Nullable<Vector2>): {
  7316. minimum: Vector3;
  7317. maximum: Vector3;
  7318. };
  7319. /**
  7320. * Extracts minimum and maximum values from a list of positions
  7321. * @param positions defines the positions to use
  7322. * @param start defines the start index in the positions array
  7323. * @param count defines the number of positions to handle
  7324. * @param bias defines bias value to add to the result
  7325. * @param stride defines the stride size to use (distance between two positions in the positions array)
  7326. * @return minimum and maximum values
  7327. */
  7328. export function extractMinAndMax(positions: FloatArray, start: number, count: number, bias?: Nullable<Vector2>, stride?: number): {
  7329. minimum: Vector3;
  7330. maximum: Vector3;
  7331. };
  7332. }
  7333. declare module "babylonjs/Meshes/WebGL/webGLDataBuffer" {
  7334. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  7335. /** @hidden */
  7336. export class WebGLDataBuffer extends DataBuffer {
  7337. private _buffer;
  7338. constructor(resource: WebGLBuffer);
  7339. get underlyingResource(): any;
  7340. }
  7341. }
  7342. declare module "babylonjs/Engines/WebGL/webGLPipelineContext" {
  7343. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  7344. import { Nullable } from "babylonjs/types";
  7345. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  7346. /** @hidden */
  7347. export class WebGLPipelineContext implements IPipelineContext {
  7348. engine: ThinEngine;
  7349. program: Nullable<WebGLProgram>;
  7350. context?: WebGLRenderingContext;
  7351. vertexShader?: WebGLShader;
  7352. fragmentShader?: WebGLShader;
  7353. isParallelCompiled: boolean;
  7354. onCompiled?: () => void;
  7355. transformFeedback?: WebGLTransformFeedback | null;
  7356. vertexCompilationError: Nullable<string>;
  7357. fragmentCompilationError: Nullable<string>;
  7358. programLinkError: Nullable<string>;
  7359. programValidationError: Nullable<string>;
  7360. get isAsync(): boolean;
  7361. get isReady(): boolean;
  7362. _handlesSpectorRebuildCallback(onCompiled: (program: WebGLProgram) => void): void;
  7363. _getVertexShaderCode(): string | null;
  7364. _getFragmentShaderCode(): string | null;
  7365. }
  7366. }
  7367. declare module "babylonjs/Engines/Extensions/engine.uniformBuffer" {
  7368. import { FloatArray, Nullable } from "babylonjs/types";
  7369. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  7370. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  7371. module "babylonjs/Engines/thinEngine" {
  7372. interface ThinEngine {
  7373. /**
  7374. * Create an uniform buffer
  7375. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  7376. * @param elements defines the content of the uniform buffer
  7377. * @returns the webGL uniform buffer
  7378. */
  7379. createUniformBuffer(elements: FloatArray): DataBuffer;
  7380. /**
  7381. * Create a dynamic uniform buffer
  7382. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  7383. * @param elements defines the content of the uniform buffer
  7384. * @returns the webGL uniform buffer
  7385. */
  7386. createDynamicUniformBuffer(elements: FloatArray): DataBuffer;
  7387. /**
  7388. * Update an existing uniform buffer
  7389. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  7390. * @param uniformBuffer defines the target uniform buffer
  7391. * @param elements defines the content to update
  7392. * @param offset defines the offset in the uniform buffer where update should start
  7393. * @param count defines the size of the data to update
  7394. */
  7395. updateUniformBuffer(uniformBuffer: DataBuffer, elements: FloatArray, offset?: number, count?: number): void;
  7396. /**
  7397. * Bind an uniform buffer to the current webGL context
  7398. * @param buffer defines the buffer to bind
  7399. */
  7400. bindUniformBuffer(buffer: Nullable<DataBuffer>): void;
  7401. /**
  7402. * Bind a buffer to the current webGL context at a given location
  7403. * @param buffer defines the buffer to bind
  7404. * @param location defines the index where to bind the buffer
  7405. */
  7406. bindUniformBufferBase(buffer: DataBuffer, location: number): void;
  7407. /**
  7408. * Bind a specific block at a given index in a specific shader program
  7409. * @param pipelineContext defines the pipeline context to use
  7410. * @param blockName defines the block name
  7411. * @param index defines the index where to bind the block
  7412. */
  7413. bindUniformBlock(pipelineContext: IPipelineContext, blockName: string, index: number): void;
  7414. }
  7415. }
  7416. }
  7417. declare module "babylonjs/Materials/uniformBuffer" {
  7418. import { Nullable, FloatArray } from "babylonjs/types";
  7419. import { Matrix, Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  7420. import { Engine } from "babylonjs/Engines/engine";
  7421. import { Effect } from "babylonjs/Materials/effect";
  7422. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  7423. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  7424. import { Color3 } from "babylonjs/Maths/math.color";
  7425. import "babylonjs/Engines/Extensions/engine.uniformBuffer";
  7426. /**
  7427. * Uniform buffer objects.
  7428. *
  7429. * Handles blocks of uniform on the GPU.
  7430. *
  7431. * If WebGL 2 is not available, this class falls back on traditionnal setUniformXXX calls.
  7432. *
  7433. * For more information, please refer to :
  7434. * https://www.khronos.org/opengl/wiki/Uniform_Buffer_Object
  7435. */
  7436. export class UniformBuffer {
  7437. private _engine;
  7438. private _buffer;
  7439. private _data;
  7440. private _bufferData;
  7441. private _dynamic?;
  7442. private _uniformLocations;
  7443. private _uniformSizes;
  7444. private _uniformLocationPointer;
  7445. private _needSync;
  7446. private _noUBO;
  7447. private _currentEffect;
  7448. /** @hidden */
  7449. _alreadyBound: boolean;
  7450. private static _MAX_UNIFORM_SIZE;
  7451. private static _tempBuffer;
  7452. /**
  7453. * Lambda to Update a 3x3 Matrix in a uniform buffer.
  7454. * This is dynamic to allow compat with webgl 1 and 2.
  7455. * You will need to pass the name of the uniform as well as the value.
  7456. */
  7457. updateMatrix3x3: (name: string, matrix: Float32Array) => void;
  7458. /**
  7459. * Lambda to Update a 2x2 Matrix in a uniform buffer.
  7460. * This is dynamic to allow compat with webgl 1 and 2.
  7461. * You will need to pass the name of the uniform as well as the value.
  7462. */
  7463. updateMatrix2x2: (name: string, matrix: Float32Array) => void;
  7464. /**
  7465. * Lambda to Update a single float in a uniform buffer.
  7466. * This is dynamic to allow compat with webgl 1 and 2.
  7467. * You will need to pass the name of the uniform as well as the value.
  7468. */
  7469. updateFloat: (name: string, x: number) => void;
  7470. /**
  7471. * Lambda to Update a vec2 of float in a uniform buffer.
  7472. * This is dynamic to allow compat with webgl 1 and 2.
  7473. * You will need to pass the name of the uniform as well as the value.
  7474. */
  7475. updateFloat2: (name: string, x: number, y: number, suffix?: string) => void;
  7476. /**
  7477. * Lambda to Update a vec3 of float in a uniform buffer.
  7478. * This is dynamic to allow compat with webgl 1 and 2.
  7479. * You will need to pass the name of the uniform as well as the value.
  7480. */
  7481. updateFloat3: (name: string, x: number, y: number, z: number, suffix?: string) => void;
  7482. /**
  7483. * Lambda to Update a vec4 of float in a uniform buffer.
  7484. * This is dynamic to allow compat with webgl 1 and 2.
  7485. * You will need to pass the name of the uniform as well as the value.
  7486. */
  7487. updateFloat4: (name: string, x: number, y: number, z: number, w: number, suffix?: string) => void;
  7488. /**
  7489. * Lambda to Update a 4x4 Matrix in a uniform buffer.
  7490. * This is dynamic to allow compat with webgl 1 and 2.
  7491. * You will need to pass the name of the uniform as well as the value.
  7492. */
  7493. updateMatrix: (name: string, mat: Matrix) => void;
  7494. /**
  7495. * Lambda to Update vec3 of float from a Vector in a uniform buffer.
  7496. * This is dynamic to allow compat with webgl 1 and 2.
  7497. * You will need to pass the name of the uniform as well as the value.
  7498. */
  7499. updateVector3: (name: string, vector: Vector3) => void;
  7500. /**
  7501. * Lambda to Update vec4 of float from a Vector in a uniform buffer.
  7502. * This is dynamic to allow compat with webgl 1 and 2.
  7503. * You will need to pass the name of the uniform as well as the value.
  7504. */
  7505. updateVector4: (name: string, vector: Vector4) => void;
  7506. /**
  7507. * Lambda to Update vec3 of float from a Color in a uniform buffer.
  7508. * This is dynamic to allow compat with webgl 1 and 2.
  7509. * You will need to pass the name of the uniform as well as the value.
  7510. */
  7511. updateColor3: (name: string, color: Color3, suffix?: string) => void;
  7512. /**
  7513. * Lambda to Update vec4 of float from a Color in a uniform buffer.
  7514. * This is dynamic to allow compat with webgl 1 and 2.
  7515. * You will need to pass the name of the uniform as well as the value.
  7516. */
  7517. updateColor4: (name: string, color: Color3, alpha: number, suffix?: string) => void;
  7518. /**
  7519. * Instantiates a new Uniform buffer objects.
  7520. *
  7521. * Handles blocks of uniform on the GPU.
  7522. *
  7523. * If WebGL 2 is not available, this class falls back on traditionnal setUniformXXX calls.
  7524. *
  7525. * For more information, please refer to :
  7526. * @see https://www.khronos.org/opengl/wiki/Uniform_Buffer_Object
  7527. * @param engine Define the engine the buffer is associated with
  7528. * @param data Define the data contained in the buffer
  7529. * @param dynamic Define if the buffer is updatable
  7530. */
  7531. constructor(engine: Engine, data?: number[], dynamic?: boolean);
  7532. /**
  7533. * Indicates if the buffer is using the WebGL2 UBO implementation,
  7534. * or just falling back on setUniformXXX calls.
  7535. */
  7536. get useUbo(): boolean;
  7537. /**
  7538. * Indicates if the WebGL underlying uniform buffer is in sync
  7539. * with the javascript cache data.
  7540. */
  7541. get isSync(): boolean;
  7542. /**
  7543. * Indicates if the WebGL underlying uniform buffer is dynamic.
  7544. * Also, a dynamic UniformBuffer will disable cache verification and always
  7545. * update the underlying WebGL uniform buffer to the GPU.
  7546. * @returns if Dynamic, otherwise false
  7547. */
  7548. isDynamic(): boolean;
  7549. /**
  7550. * The data cache on JS side.
  7551. * @returns the underlying data as a float array
  7552. */
  7553. getData(): Float32Array;
  7554. /**
  7555. * The underlying WebGL Uniform buffer.
  7556. * @returns the webgl buffer
  7557. */
  7558. getBuffer(): Nullable<DataBuffer>;
  7559. /**
  7560. * std140 layout specifies how to align data within an UBO structure.
  7561. * See https://khronos.org/registry/OpenGL/specs/gl/glspec45.core.pdf#page=159
  7562. * for specs.
  7563. */
  7564. private _fillAlignment;
  7565. /**
  7566. * Adds an uniform in the buffer.
  7567. * Warning : the subsequents calls of this function must be in the same order as declared in the shader
  7568. * for the layout to be correct !
  7569. * @param name Name of the uniform, as used in the uniform block in the shader.
  7570. * @param size Data size, or data directly.
  7571. */
  7572. addUniform(name: string, size: number | number[]): void;
  7573. /**
  7574. * Adds a Matrix 4x4 to the uniform buffer.
  7575. * @param name Name of the uniform, as used in the uniform block in the shader.
  7576. * @param mat A 4x4 matrix.
  7577. */
  7578. addMatrix(name: string, mat: Matrix): void;
  7579. /**
  7580. * Adds a vec2 to the uniform buffer.
  7581. * @param name Name of the uniform, as used in the uniform block in the shader.
  7582. * @param x Define the x component value of the vec2
  7583. * @param y Define the y component value of the vec2
  7584. */
  7585. addFloat2(name: string, x: number, y: number): void;
  7586. /**
  7587. * Adds a vec3 to the uniform buffer.
  7588. * @param name Name of the uniform, as used in the uniform block in the shader.
  7589. * @param x Define the x component value of the vec3
  7590. * @param y Define the y component value of the vec3
  7591. * @param z Define the z component value of the vec3
  7592. */
  7593. addFloat3(name: string, x: number, y: number, z: number): void;
  7594. /**
  7595. * Adds a vec3 to the uniform buffer.
  7596. * @param name Name of the uniform, as used in the uniform block in the shader.
  7597. * @param color Define the vec3 from a Color
  7598. */
  7599. addColor3(name: string, color: Color3): void;
  7600. /**
  7601. * Adds a vec4 to the uniform buffer.
  7602. * @param name Name of the uniform, as used in the uniform block in the shader.
  7603. * @param color Define the rgb components from a Color
  7604. * @param alpha Define the a component of the vec4
  7605. */
  7606. addColor4(name: string, color: Color3, alpha: number): void;
  7607. /**
  7608. * Adds a vec3 to the uniform buffer.
  7609. * @param name Name of the uniform, as used in the uniform block in the shader.
  7610. * @param vector Define the vec3 components from a Vector
  7611. */
  7612. addVector3(name: string, vector: Vector3): void;
  7613. /**
  7614. * Adds a Matrix 3x3 to the uniform buffer.
  7615. * @param name Name of the uniform, as used in the uniform block in the shader.
  7616. */
  7617. addMatrix3x3(name: string): void;
  7618. /**
  7619. * Adds a Matrix 2x2 to the uniform buffer.
  7620. * @param name Name of the uniform, as used in the uniform block in the shader.
  7621. */
  7622. addMatrix2x2(name: string): void;
  7623. /**
  7624. * Effectively creates the WebGL Uniform Buffer, once layout is completed with `addUniform`.
  7625. */
  7626. create(): void;
  7627. /** @hidden */
  7628. _rebuild(): void;
  7629. /**
  7630. * Updates the WebGL Uniform Buffer on the GPU.
  7631. * If the `dynamic` flag is set to true, no cache comparison is done.
  7632. * Otherwise, the buffer will be updated only if the cache differs.
  7633. */
  7634. update(): void;
  7635. /**
  7636. * Updates the value of an uniform. The `update` method must be called afterwards to make it effective in the GPU.
  7637. * @param uniformName Define the name of the uniform, as used in the uniform block in the shader.
  7638. * @param data Define the flattened data
  7639. * @param size Define the size of the data.
  7640. */
  7641. updateUniform(uniformName: string, data: FloatArray, size: number): void;
  7642. private _valueCache;
  7643. private _cacheMatrix;
  7644. private _updateMatrix3x3ForUniform;
  7645. private _updateMatrix3x3ForEffect;
  7646. private _updateMatrix2x2ForEffect;
  7647. private _updateMatrix2x2ForUniform;
  7648. private _updateFloatForEffect;
  7649. private _updateFloatForUniform;
  7650. private _updateFloat2ForEffect;
  7651. private _updateFloat2ForUniform;
  7652. private _updateFloat3ForEffect;
  7653. private _updateFloat3ForUniform;
  7654. private _updateFloat4ForEffect;
  7655. private _updateFloat4ForUniform;
  7656. private _updateMatrixForEffect;
  7657. private _updateMatrixForUniform;
  7658. private _updateVector3ForEffect;
  7659. private _updateVector3ForUniform;
  7660. private _updateVector4ForEffect;
  7661. private _updateVector4ForUniform;
  7662. private _updateColor3ForEffect;
  7663. private _updateColor3ForUniform;
  7664. private _updateColor4ForEffect;
  7665. private _updateColor4ForUniform;
  7666. /**
  7667. * Sets a sampler uniform on the effect.
  7668. * @param name Define the name of the sampler.
  7669. * @param texture Define the texture to set in the sampler
  7670. */
  7671. setTexture(name: string, texture: Nullable<BaseTexture>): void;
  7672. /**
  7673. * Directly updates the value of the uniform in the cache AND on the GPU.
  7674. * @param uniformName Define the name of the uniform, as used in the uniform block in the shader.
  7675. * @param data Define the flattened data
  7676. */
  7677. updateUniformDirectly(uniformName: string, data: FloatArray): void;
  7678. /**
  7679. * Binds this uniform buffer to an effect.
  7680. * @param effect Define the effect to bind the buffer to
  7681. * @param name Name of the uniform block in the shader.
  7682. */
  7683. bindToEffect(effect: Effect, name: string): void;
  7684. /**
  7685. * Disposes the uniform buffer.
  7686. */
  7687. dispose(): void;
  7688. }
  7689. }
  7690. declare module "babylonjs/Misc/iInspectable" {
  7691. /**
  7692. * Enum that determines the text-wrapping mode to use.
  7693. */
  7694. export enum InspectableType {
  7695. /**
  7696. * Checkbox for booleans
  7697. */
  7698. Checkbox = 0,
  7699. /**
  7700. * Sliders for numbers
  7701. */
  7702. Slider = 1,
  7703. /**
  7704. * Vector3
  7705. */
  7706. Vector3 = 2,
  7707. /**
  7708. * Quaternions
  7709. */
  7710. Quaternion = 3,
  7711. /**
  7712. * Color3
  7713. */
  7714. Color3 = 4,
  7715. /**
  7716. * String
  7717. */
  7718. String = 5
  7719. }
  7720. /**
  7721. * Interface used to define custom inspectable properties.
  7722. * This interface is used by the inspector to display custom property grids
  7723. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  7724. */
  7725. export interface IInspectable {
  7726. /**
  7727. * Gets the label to display
  7728. */
  7729. label: string;
  7730. /**
  7731. * Gets the name of the property to edit
  7732. */
  7733. propertyName: string;
  7734. /**
  7735. * Gets the type of the editor to use
  7736. */
  7737. type: InspectableType;
  7738. /**
  7739. * Gets the minimum value of the property when using in "slider" mode
  7740. */
  7741. min?: number;
  7742. /**
  7743. * Gets the maximum value of the property when using in "slider" mode
  7744. */
  7745. max?: number;
  7746. /**
  7747. * Gets the setp to use when using in "slider" mode
  7748. */
  7749. step?: number;
  7750. }
  7751. }
  7752. declare module "babylonjs/Misc/timingTools" {
  7753. /**
  7754. * Class used to provide helper for timing
  7755. */
  7756. export class TimingTools {
  7757. /**
  7758. * Polyfill for setImmediate
  7759. * @param action defines the action to execute after the current execution block
  7760. */
  7761. static SetImmediate(action: () => void): void;
  7762. }
  7763. }
  7764. declare module "babylonjs/Misc/instantiationTools" {
  7765. /**
  7766. * Class used to enable instatition of objects by class name
  7767. */
  7768. export class InstantiationTools {
  7769. /**
  7770. * Use this object to register external classes like custom textures or material
  7771. * to allow the laoders to instantiate them
  7772. */
  7773. static RegisteredExternalClasses: {
  7774. [key: string]: Object;
  7775. };
  7776. /**
  7777. * Tries to instantiate a new object from a given class name
  7778. * @param className defines the class name to instantiate
  7779. * @returns the new object or null if the system was not able to do the instantiation
  7780. */
  7781. static Instantiate(className: string): any;
  7782. }
  7783. }
  7784. declare module "babylonjs/Engines/depthTextureCreationOptions" {
  7785. /**
  7786. * Define options used to create a depth texture
  7787. */
  7788. export class DepthTextureCreationOptions {
  7789. /** Specifies whether or not a stencil should be allocated in the texture */
  7790. generateStencil?: boolean;
  7791. /** Specifies whether or not bilinear filtering is enable on the texture */
  7792. bilinearFiltering?: boolean;
  7793. /** Specifies the comparison function to set on the texture. If 0 or undefined, the texture is not in comparison mode */
  7794. comparisonFunction?: number;
  7795. /** Specifies if the created texture is a cube texture */
  7796. isCube?: boolean;
  7797. }
  7798. }
  7799. declare module "babylonjs/Engines/Extensions/engine.cubeTexture" {
  7800. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  7801. import { Nullable } from "babylonjs/types";
  7802. import { Scene } from "babylonjs/scene";
  7803. import { DepthTextureCreationOptions } from "babylonjs/Engines/depthTextureCreationOptions";
  7804. module "babylonjs/Engines/thinEngine" {
  7805. interface ThinEngine {
  7806. /**
  7807. * Creates a depth stencil cube texture.
  7808. * This is only available in WebGL 2.
  7809. * @param size The size of face edge in the cube texture.
  7810. * @param options The options defining the cube texture.
  7811. * @returns The cube texture
  7812. */
  7813. _createDepthStencilCubeTexture(size: number, options: DepthTextureCreationOptions): InternalTexture;
  7814. /**
  7815. * Creates a cube texture
  7816. * @param rootUrl defines the url where the files to load is located
  7817. * @param scene defines the current scene
  7818. * @param files defines the list of files to load (1 per face)
  7819. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  7820. * @param onLoad defines an optional callback raised when the texture is loaded
  7821. * @param onError defines an optional callback raised if there is an issue to load the texture
  7822. * @param format defines the format of the data
  7823. * @param forcedExtension defines the extension to use to pick the right loader
  7824. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  7825. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  7826. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  7827. * @param fallback defines texture to use while falling back when (compressed) texture file not found.
  7828. * @returns the cube texture as an InternalTexture
  7829. */
  7830. createCubeTexture(rootUrl: string, scene: Nullable<Scene>, files: Nullable<string[]>, noMipmap: boolean | undefined, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>, format: number | undefined, forcedExtension: any, createPolynomials: boolean, lodScale: number, lodOffset: number, fallback: Nullable<InternalTexture>): InternalTexture;
  7831. /**
  7832. * Creates a cube texture
  7833. * @param rootUrl defines the url where the files to load is located
  7834. * @param scene defines the current scene
  7835. * @param files defines the list of files to load (1 per face)
  7836. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  7837. * @param onLoad defines an optional callback raised when the texture is loaded
  7838. * @param onError defines an optional callback raised if there is an issue to load the texture
  7839. * @param format defines the format of the data
  7840. * @param forcedExtension defines the extension to use to pick the right loader
  7841. * @returns the cube texture as an InternalTexture
  7842. */
  7843. createCubeTexture(rootUrl: string, scene: Nullable<Scene>, files: Nullable<string[]>, noMipmap: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>, format: number | undefined, forcedExtension: any): InternalTexture;
  7844. /**
  7845. * Creates a cube texture
  7846. * @param rootUrl defines the url where the files to load is located
  7847. * @param scene defines the current scene
  7848. * @param files defines the list of files to load (1 per face)
  7849. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  7850. * @param onLoad defines an optional callback raised when the texture is loaded
  7851. * @param onError defines an optional callback raised if there is an issue to load the texture
  7852. * @param format defines the format of the data
  7853. * @param forcedExtension defines the extension to use to pick the right loader
  7854. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  7855. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  7856. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  7857. * @returns the cube texture as an InternalTexture
  7858. */
  7859. createCubeTexture(rootUrl: string, scene: Nullable<Scene>, files: Nullable<string[]>, noMipmap: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>, format: number | undefined, forcedExtension: any, createPolynomials: boolean, lodScale: number, lodOffset: number): InternalTexture;
  7860. /** @hidden */
  7861. _partialLoadFile(url: string, index: number, loadedFiles: ArrayBuffer[], onfinish: (files: ArrayBuffer[]) => void, onErrorCallBack: Nullable<(message?: string, exception?: any) => void>): void;
  7862. /** @hidden */
  7863. _cascadeLoadFiles(scene: Nullable<Scene>, onfinish: (images: ArrayBuffer[]) => void, files: string[], onError: Nullable<(message?: string, exception?: any) => void>): void;
  7864. /** @hidden */
  7865. _cascadeLoadImgs(scene: Nullable<Scene>, onfinish: (images: HTMLImageElement[]) => void, files: string[], onError: Nullable<(message?: string, exception?: any) => void>, mimeType?: string): void;
  7866. /** @hidden */
  7867. _partialLoadImg(url: string, index: number, loadedImages: HTMLImageElement[], scene: Nullable<Scene>, onfinish: (images: HTMLImageElement[]) => void, onErrorCallBack: Nullable<(message?: string, exception?: any) => void>, mimeType?: string): void;
  7868. /**
  7869. * @hidden
  7870. */
  7871. _setCubeMapTextureParams(loadMipmap: boolean): void;
  7872. }
  7873. }
  7874. }
  7875. declare module "babylonjs/Materials/Textures/cubeTexture" {
  7876. import { Nullable } from "babylonjs/types";
  7877. import { Scene } from "babylonjs/scene";
  7878. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  7879. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  7880. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  7881. import "babylonjs/Engines/Extensions/engine.cubeTexture";
  7882. import { Observable } from "babylonjs/Misc/observable";
  7883. /**
  7884. * Class for creating a cube texture
  7885. */
  7886. export class CubeTexture extends BaseTexture {
  7887. private _delayedOnLoad;
  7888. /**
  7889. * Observable triggered once the texture has been loaded.
  7890. */
  7891. onLoadObservable: Observable<CubeTexture>;
  7892. /**
  7893. * The url of the texture
  7894. */
  7895. url: string;
  7896. /**
  7897. * Gets or sets the center of the bounding box associated with the cube texture.
  7898. * It must define where the camera used to render the texture was set
  7899. * @see https://doc.babylonjs.com/how_to/reflect#using-local-cubemap-mode
  7900. */
  7901. boundingBoxPosition: Vector3;
  7902. private _boundingBoxSize;
  7903. /**
  7904. * Gets or sets the size of the bounding box associated with the cube texture
  7905. * When defined, the cubemap will switch to local mode
  7906. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  7907. * @example https://www.babylonjs-playground.com/#RNASML
  7908. */
  7909. set boundingBoxSize(value: Vector3);
  7910. /**
  7911. * Returns the bounding box size
  7912. * @see https://doc.babylonjs.com/how_to/reflect#using-local-cubemap-mode
  7913. */
  7914. get boundingBoxSize(): Vector3;
  7915. protected _rotationY: number;
  7916. /**
  7917. * Sets texture matrix rotation angle around Y axis in radians.
  7918. */
  7919. set rotationY(value: number);
  7920. /**
  7921. * Gets texture matrix rotation angle around Y axis radians.
  7922. */
  7923. get rotationY(): number;
  7924. /**
  7925. * Are mip maps generated for this texture or not.
  7926. */
  7927. get noMipmap(): boolean;
  7928. private _noMipmap;
  7929. private _files;
  7930. protected _forcedExtension: Nullable<string>;
  7931. private _extensions;
  7932. private _textureMatrix;
  7933. private _format;
  7934. private _createPolynomials;
  7935. /**
  7936. * Creates a cube texture from an array of image urls
  7937. * @param files defines an array of image urls
  7938. * @param scene defines the hosting scene
  7939. * @param noMipmap specifies if mip maps are not used
  7940. * @returns a cube texture
  7941. */
  7942. static CreateFromImages(files: string[], scene: Scene, noMipmap?: boolean): CubeTexture;
  7943. /**
  7944. * Creates and return a texture created from prefilterd data by tools like IBL Baker or Lys.
  7945. * @param url defines the url of the prefiltered texture
  7946. * @param scene defines the scene the texture is attached to
  7947. * @param forcedExtension defines the extension of the file if different from the url
  7948. * @param createPolynomials defines whether or not to create polynomial harmonics from the texture data if necessary
  7949. * @return the prefiltered texture
  7950. */
  7951. static CreateFromPrefilteredData(url: string, scene: Scene, forcedExtension?: any, createPolynomials?: boolean): CubeTexture;
  7952. /**
  7953. * Creates a cube texture to use with reflection for instance. It can be based upon dds or six images as well
  7954. * as prefiltered data.
  7955. * @param rootUrl defines the url of the texture or the root name of the six images
  7956. * @param null defines the scene or engine the texture is attached to
  7957. * @param extensions defines the suffixes add to the picture name in case six images are in use like _px.jpg...
  7958. * @param noMipmap defines if mipmaps should be created or not
  7959. * @param files defines the six files to load for the different faces in that order: px, py, pz, nx, ny, nz
  7960. * @param onLoad defines a callback triggered at the end of the file load if no errors occured
  7961. * @param onError defines a callback triggered in case of error during load
  7962. * @param format defines the internal format to use for the texture once loaded
  7963. * @param prefiltered defines whether or not the texture is created from prefiltered data
  7964. * @param forcedExtension defines the extensions to use (force a special type of file to load) in case it is different from the file name
  7965. * @param createPolynomials defines whether or not to create polynomial harmonics from the texture data if necessary
  7966. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  7967. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  7968. * @return the cube texture
  7969. */
  7970. constructor(rootUrl: string, sceneOrEngine: Scene | ThinEngine, extensions?: Nullable<string[]>, noMipmap?: boolean, files?: Nullable<string[]>, onLoad?: Nullable<() => void>, onError?: Nullable<(message?: string, exception?: any) => void>, format?: number, prefiltered?: boolean, forcedExtension?: any, createPolynomials?: boolean, lodScale?: number, lodOffset?: number);
  7971. /**
  7972. * Get the current class name of the texture useful for serialization or dynamic coding.
  7973. * @returns "CubeTexture"
  7974. */
  7975. getClassName(): string;
  7976. /**
  7977. * Update the url (and optional buffer) of this texture if url was null during construction.
  7978. * @param url the url of the texture
  7979. * @param forcedExtension defines the extension to use
  7980. * @param onLoad callback called when the texture is loaded (defaults to null)
  7981. * @param prefiltered Defines whether the updated texture is prefiltered or not
  7982. */
  7983. updateURL(url: string, forcedExtension?: string, onLoad?: () => void, prefiltered?: boolean): void;
  7984. /**
  7985. * Delays loading of the cube texture
  7986. * @param forcedExtension defines the extension to use
  7987. */
  7988. delayLoad(forcedExtension?: string): void;
  7989. /**
  7990. * Returns the reflection texture matrix
  7991. * @returns the reflection texture matrix
  7992. */
  7993. getReflectionTextureMatrix(): Matrix;
  7994. /**
  7995. * Sets the reflection texture matrix
  7996. * @param value Reflection texture matrix
  7997. */
  7998. setReflectionTextureMatrix(value: Matrix): void;
  7999. /**
  8000. * Parses text to create a cube texture
  8001. * @param parsedTexture define the serialized text to read from
  8002. * @param scene defines the hosting scene
  8003. * @param rootUrl defines the root url of the cube texture
  8004. * @returns a cube texture
  8005. */
  8006. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): CubeTexture;
  8007. /**
  8008. * Makes a clone, or deep copy, of the cube texture
  8009. * @returns a new cube texture
  8010. */
  8011. clone(): CubeTexture;
  8012. }
  8013. }
  8014. declare module "babylonjs/Materials/materialDefines" {
  8015. /**
  8016. * Manages the defines for the Material
  8017. */
  8018. export class MaterialDefines {
  8019. /** @hidden */
  8020. protected _keys: string[];
  8021. private _isDirty;
  8022. /** @hidden */
  8023. _renderId: number;
  8024. /** @hidden */
  8025. _areLightsDirty: boolean;
  8026. /** @hidden */
  8027. _areLightsDisposed: boolean;
  8028. /** @hidden */
  8029. _areAttributesDirty: boolean;
  8030. /** @hidden */
  8031. _areTexturesDirty: boolean;
  8032. /** @hidden */
  8033. _areFresnelDirty: boolean;
  8034. /** @hidden */
  8035. _areMiscDirty: boolean;
  8036. /** @hidden */
  8037. _areImageProcessingDirty: boolean;
  8038. /** @hidden */
  8039. _normals: boolean;
  8040. /** @hidden */
  8041. _uvs: boolean;
  8042. /** @hidden */
  8043. _needNormals: boolean;
  8044. /** @hidden */
  8045. _needUVs: boolean;
  8046. [id: string]: any;
  8047. /**
  8048. * Specifies if the material needs to be re-calculated
  8049. */
  8050. get isDirty(): boolean;
  8051. /**
  8052. * Marks the material to indicate that it has been re-calculated
  8053. */
  8054. markAsProcessed(): void;
  8055. /**
  8056. * Marks the material to indicate that it needs to be re-calculated
  8057. */
  8058. markAsUnprocessed(): void;
  8059. /**
  8060. * Marks the material to indicate all of its defines need to be re-calculated
  8061. */
  8062. markAllAsDirty(): void;
  8063. /**
  8064. * Marks the material to indicate that image processing needs to be re-calculated
  8065. */
  8066. markAsImageProcessingDirty(): void;
  8067. /**
  8068. * Marks the material to indicate the lights need to be re-calculated
  8069. * @param disposed Defines whether the light is dirty due to dispose or not
  8070. */
  8071. markAsLightDirty(disposed?: boolean): void;
  8072. /**
  8073. * Marks the attribute state as changed
  8074. */
  8075. markAsAttributesDirty(): void;
  8076. /**
  8077. * Marks the texture state as changed
  8078. */
  8079. markAsTexturesDirty(): void;
  8080. /**
  8081. * Marks the fresnel state as changed
  8082. */
  8083. markAsFresnelDirty(): void;
  8084. /**
  8085. * Marks the misc state as changed
  8086. */
  8087. markAsMiscDirty(): void;
  8088. /**
  8089. * Rebuilds the material defines
  8090. */
  8091. rebuild(): void;
  8092. /**
  8093. * Specifies if two material defines are equal
  8094. * @param other - A material define instance to compare to
  8095. * @returns - Boolean indicating if the material defines are equal (true) or not (false)
  8096. */
  8097. isEqual(other: MaterialDefines): boolean;
  8098. /**
  8099. * Clones this instance's defines to another instance
  8100. * @param other - material defines to clone values to
  8101. */
  8102. cloneTo(other: MaterialDefines): void;
  8103. /**
  8104. * Resets the material define values
  8105. */
  8106. reset(): void;
  8107. /**
  8108. * Converts the material define values to a string
  8109. * @returns - String of material define information
  8110. */
  8111. toString(): string;
  8112. }
  8113. }
  8114. declare module "babylonjs/Materials/colorCurves" {
  8115. import { Effect } from "babylonjs/Materials/effect";
  8116. /**
  8117. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  8118. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  8119. * These are similar to controls found in many professional imaging or colorist software. The global controls are applied to the entire image. For advanced tuning, extra controls are provided to adjust the shadow, midtone and highlight areas of the image;
  8120. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  8121. */
  8122. export class ColorCurves {
  8123. private _dirty;
  8124. private _tempColor;
  8125. private _globalCurve;
  8126. private _highlightsCurve;
  8127. private _midtonesCurve;
  8128. private _shadowsCurve;
  8129. private _positiveCurve;
  8130. private _negativeCurve;
  8131. private _globalHue;
  8132. private _globalDensity;
  8133. private _globalSaturation;
  8134. private _globalExposure;
  8135. /**
  8136. * Gets the global Hue value.
  8137. * The hue value is a standard HSB hue in the range [0,360] where 0=red, 120=green and 240=blue. The default value is 30 degrees (orange).
  8138. */
  8139. get globalHue(): number;
  8140. /**
  8141. * Sets the global Hue value.
  8142. * The hue value is a standard HSB hue in the range [0,360] where 0=red, 120=green and 240=blue. The default value is 30 degrees (orange).
  8143. */
  8144. set globalHue(value: number);
  8145. /**
  8146. * Gets the global Density value.
  8147. * The density value is in range [-100,+100] where 0 means the color filter has no effect and +100 means the color filter has maximum effect.
  8148. * Values less than zero provide a filter of opposite hue.
  8149. */
  8150. get globalDensity(): number;
  8151. /**
  8152. * Sets the global Density value.
  8153. * The density value is in range [-100,+100] where 0 means the color filter has no effect and +100 means the color filter has maximum effect.
  8154. * Values less than zero provide a filter of opposite hue.
  8155. */
  8156. set globalDensity(value: number);
  8157. /**
  8158. * Gets the global Saturation value.
  8159. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase saturation and negative values decrease saturation.
  8160. */
  8161. get globalSaturation(): number;
  8162. /**
  8163. * Sets the global Saturation value.
  8164. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase saturation and negative values decrease saturation.
  8165. */
  8166. set globalSaturation(value: number);
  8167. /**
  8168. * Gets the global Exposure value.
  8169. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase exposure and negative values decrease exposure.
  8170. */
  8171. get globalExposure(): number;
  8172. /**
  8173. * Sets the global Exposure value.
  8174. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase exposure and negative values decrease exposure.
  8175. */
  8176. set globalExposure(value: number);
  8177. private _highlightsHue;
  8178. private _highlightsDensity;
  8179. private _highlightsSaturation;
  8180. private _highlightsExposure;
  8181. /**
  8182. * Gets the highlights Hue value.
  8183. * The hue value is a standard HSB hue in the range [0,360] where 0=red, 120=green and 240=blue. The default value is 30 degrees (orange).
  8184. */
  8185. get highlightsHue(): number;
  8186. /**
  8187. * Sets the highlights Hue value.
  8188. * The hue value is a standard HSB hue in the range [0,360] where 0=red, 120=green and 240=blue. The default value is 30 degrees (orange).
  8189. */
  8190. set highlightsHue(value: number);
  8191. /**
  8192. * Gets the highlights Density value.
  8193. * The density value is in range [-100,+100] where 0 means the color filter has no effect and +100 means the color filter has maximum effect.
  8194. * Values less than zero provide a filter of opposite hue.
  8195. */
  8196. get highlightsDensity(): number;
  8197. /**
  8198. * Sets the highlights Density value.
  8199. * The density value is in range [-100,+100] where 0 means the color filter has no effect and +100 means the color filter has maximum effect.
  8200. * Values less than zero provide a filter of opposite hue.
  8201. */
  8202. set highlightsDensity(value: number);
  8203. /**
  8204. * Gets the highlights Saturation value.
  8205. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase saturation and negative values decrease saturation.
  8206. */
  8207. get highlightsSaturation(): number;
  8208. /**
  8209. * Sets the highlights Saturation value.
  8210. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase saturation and negative values decrease saturation.
  8211. */
  8212. set highlightsSaturation(value: number);
  8213. /**
  8214. * Gets the highlights Exposure value.
  8215. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase exposure and negative values decrease exposure.
  8216. */
  8217. get highlightsExposure(): number;
  8218. /**
  8219. * Sets the highlights Exposure value.
  8220. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase exposure and negative values decrease exposure.
  8221. */
  8222. set highlightsExposure(value: number);
  8223. private _midtonesHue;
  8224. private _midtonesDensity;
  8225. private _midtonesSaturation;
  8226. private _midtonesExposure;
  8227. /**
  8228. * Gets the midtones Hue value.
  8229. * The hue value is a standard HSB hue in the range [0,360] where 0=red, 120=green and 240=blue. The default value is 30 degrees (orange).
  8230. */
  8231. get midtonesHue(): number;
  8232. /**
  8233. * Sets the midtones Hue value.
  8234. * The hue value is a standard HSB hue in the range [0,360] where 0=red, 120=green and 240=blue. The default value is 30 degrees (orange).
  8235. */
  8236. set midtonesHue(value: number);
  8237. /**
  8238. * Gets the midtones Density value.
  8239. * The density value is in range [-100,+100] where 0 means the color filter has no effect and +100 means the color filter has maximum effect.
  8240. * Values less than zero provide a filter of opposite hue.
  8241. */
  8242. get midtonesDensity(): number;
  8243. /**
  8244. * Sets the midtones Density value.
  8245. * The density value is in range [-100,+100] where 0 means the color filter has no effect and +100 means the color filter has maximum effect.
  8246. * Values less than zero provide a filter of opposite hue.
  8247. */
  8248. set midtonesDensity(value: number);
  8249. /**
  8250. * Gets the midtones Saturation value.
  8251. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase saturation and negative values decrease saturation.
  8252. */
  8253. get midtonesSaturation(): number;
  8254. /**
  8255. * Sets the midtones Saturation value.
  8256. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase saturation and negative values decrease saturation.
  8257. */
  8258. set midtonesSaturation(value: number);
  8259. /**
  8260. * Gets the midtones Exposure value.
  8261. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase exposure and negative values decrease exposure.
  8262. */
  8263. get midtonesExposure(): number;
  8264. /**
  8265. * Sets the midtones Exposure value.
  8266. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase exposure and negative values decrease exposure.
  8267. */
  8268. set midtonesExposure(value: number);
  8269. private _shadowsHue;
  8270. private _shadowsDensity;
  8271. private _shadowsSaturation;
  8272. private _shadowsExposure;
  8273. /**
  8274. * Gets the shadows Hue value.
  8275. * The hue value is a standard HSB hue in the range [0,360] where 0=red, 120=green and 240=blue. The default value is 30 degrees (orange).
  8276. */
  8277. get shadowsHue(): number;
  8278. /**
  8279. * Sets the shadows Hue value.
  8280. * The hue value is a standard HSB hue in the range [0,360] where 0=red, 120=green and 240=blue. The default value is 30 degrees (orange).
  8281. */
  8282. set shadowsHue(value: number);
  8283. /**
  8284. * Gets the shadows Density value.
  8285. * The density value is in range [-100,+100] where 0 means the color filter has no effect and +100 means the color filter has maximum effect.
  8286. * Values less than zero provide a filter of opposite hue.
  8287. */
  8288. get shadowsDensity(): number;
  8289. /**
  8290. * Sets the shadows Density value.
  8291. * The density value is in range [-100,+100] where 0 means the color filter has no effect and +100 means the color filter has maximum effect.
  8292. * Values less than zero provide a filter of opposite hue.
  8293. */
  8294. set shadowsDensity(value: number);
  8295. /**
  8296. * Gets the shadows Saturation value.
  8297. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase saturation and negative values decrease saturation.
  8298. */
  8299. get shadowsSaturation(): number;
  8300. /**
  8301. * Sets the shadows Saturation value.
  8302. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase saturation and negative values decrease saturation.
  8303. */
  8304. set shadowsSaturation(value: number);
  8305. /**
  8306. * Gets the shadows Exposure value.
  8307. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase exposure and negative values decrease exposure.
  8308. */
  8309. get shadowsExposure(): number;
  8310. /**
  8311. * Sets the shadows Exposure value.
  8312. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase exposure and negative values decrease exposure.
  8313. */
  8314. set shadowsExposure(value: number);
  8315. /**
  8316. * Returns the class name
  8317. * @returns The class name
  8318. */
  8319. getClassName(): string;
  8320. /**
  8321. * Binds the color curves to the shader.
  8322. * @param colorCurves The color curve to bind
  8323. * @param effect The effect to bind to
  8324. * @param positiveUniform The positive uniform shader parameter
  8325. * @param neutralUniform The neutral uniform shader parameter
  8326. * @param negativeUniform The negative uniform shader parameter
  8327. */
  8328. static Bind(colorCurves: ColorCurves, effect: Effect, positiveUniform?: string, neutralUniform?: string, negativeUniform?: string): void;
  8329. /**
  8330. * Prepare the list of uniforms associated with the ColorCurves effects.
  8331. * @param uniformsList The list of uniforms used in the effect
  8332. */
  8333. static PrepareUniforms(uniformsList: string[]): void;
  8334. /**
  8335. * Returns color grading data based on a hue, density, saturation and exposure value.
  8336. * @param filterHue The hue of the color filter.
  8337. * @param filterDensity The density of the color filter.
  8338. * @param saturation The saturation.
  8339. * @param exposure The exposure.
  8340. * @param result The result data container.
  8341. */
  8342. private getColorGradingDataToRef;
  8343. /**
  8344. * Takes an input slider value and returns an adjusted value that provides extra control near the centre.
  8345. * @param value The input slider value in range [-100,100].
  8346. * @returns Adjusted value.
  8347. */
  8348. private static applyColorGradingSliderNonlinear;
  8349. /**
  8350. * Returns an RGBA Color4 based on Hue, Saturation and Brightness (also referred to as value, HSV).
  8351. * @param hue The hue (H) input.
  8352. * @param saturation The saturation (S) input.
  8353. * @param brightness The brightness (B) input.
  8354. * @result An RGBA color represented as Vector4.
  8355. */
  8356. private static fromHSBToRef;
  8357. /**
  8358. * Returns a value clamped between min and max
  8359. * @param value The value to clamp
  8360. * @param min The minimum of value
  8361. * @param max The maximum of value
  8362. * @returns The clamped value.
  8363. */
  8364. private static clamp;
  8365. /**
  8366. * Clones the current color curve instance.
  8367. * @return The cloned curves
  8368. */
  8369. clone(): ColorCurves;
  8370. /**
  8371. * Serializes the current color curve instance to a json representation.
  8372. * @return a JSON representation
  8373. */
  8374. serialize(): any;
  8375. /**
  8376. * Parses the color curve from a json representation.
  8377. * @param source the JSON source to parse
  8378. * @return The parsed curves
  8379. */
  8380. static Parse(source: any): ColorCurves;
  8381. }
  8382. }
  8383. declare module "babylonjs/Materials/imageProcessingConfiguration" {
  8384. import { Observable } from "babylonjs/Misc/observable";
  8385. import { Nullable } from "babylonjs/types";
  8386. import { Color4 } from "babylonjs/Maths/math.color";
  8387. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  8388. import { Effect } from "babylonjs/Materials/effect";
  8389. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  8390. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  8391. /**
  8392. * Interface to follow in your material defines to integrate easily the
  8393. * Image proccessing functions.
  8394. * @hidden
  8395. */
  8396. export interface IImageProcessingConfigurationDefines {
  8397. IMAGEPROCESSING: boolean;
  8398. VIGNETTE: boolean;
  8399. VIGNETTEBLENDMODEMULTIPLY: boolean;
  8400. VIGNETTEBLENDMODEOPAQUE: boolean;
  8401. TONEMAPPING: boolean;
  8402. TONEMAPPING_ACES: boolean;
  8403. CONTRAST: boolean;
  8404. EXPOSURE: boolean;
  8405. COLORCURVES: boolean;
  8406. COLORGRADING: boolean;
  8407. COLORGRADING3D: boolean;
  8408. SAMPLER3DGREENDEPTH: boolean;
  8409. SAMPLER3DBGRMAP: boolean;
  8410. IMAGEPROCESSINGPOSTPROCESS: boolean;
  8411. }
  8412. /**
  8413. * @hidden
  8414. */
  8415. export class ImageProcessingConfigurationDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  8416. IMAGEPROCESSING: boolean;
  8417. VIGNETTE: boolean;
  8418. VIGNETTEBLENDMODEMULTIPLY: boolean;
  8419. VIGNETTEBLENDMODEOPAQUE: boolean;
  8420. TONEMAPPING: boolean;
  8421. TONEMAPPING_ACES: boolean;
  8422. CONTRAST: boolean;
  8423. COLORCURVES: boolean;
  8424. COLORGRADING: boolean;
  8425. COLORGRADING3D: boolean;
  8426. SAMPLER3DGREENDEPTH: boolean;
  8427. SAMPLER3DBGRMAP: boolean;
  8428. IMAGEPROCESSINGPOSTPROCESS: boolean;
  8429. EXPOSURE: boolean;
  8430. constructor();
  8431. }
  8432. /**
  8433. * This groups together the common properties used for image processing either in direct forward pass
  8434. * or through post processing effect depending on the use of the image processing pipeline in your scene
  8435. * or not.
  8436. */
  8437. export class ImageProcessingConfiguration {
  8438. /**
  8439. * Default tone mapping applied in BabylonJS.
  8440. */
  8441. static readonly TONEMAPPING_STANDARD: number;
  8442. /**
  8443. * ACES Tone mapping (used by default in unreal and unity). This can help getting closer
  8444. * to other engines rendering to increase portability.
  8445. */
  8446. static readonly TONEMAPPING_ACES: number;
  8447. /**
  8448. * Color curves setup used in the effect if colorCurvesEnabled is set to true
  8449. */
  8450. colorCurves: Nullable<ColorCurves>;
  8451. private _colorCurvesEnabled;
  8452. /**
  8453. * Gets wether the color curves effect is enabled.
  8454. */
  8455. get colorCurvesEnabled(): boolean;
  8456. /**
  8457. * Sets wether the color curves effect is enabled.
  8458. */
  8459. set colorCurvesEnabled(value: boolean);
  8460. private _colorGradingTexture;
  8461. /**
  8462. * Color grading LUT texture used in the effect if colorGradingEnabled is set to true
  8463. */
  8464. get colorGradingTexture(): Nullable<BaseTexture>;
  8465. /**
  8466. * Color grading LUT texture used in the effect if colorGradingEnabled is set to true
  8467. */
  8468. set colorGradingTexture(value: Nullable<BaseTexture>);
  8469. private _colorGradingEnabled;
  8470. /**
  8471. * Gets wether the color grading effect is enabled.
  8472. */
  8473. get colorGradingEnabled(): boolean;
  8474. /**
  8475. * Sets wether the color grading effect is enabled.
  8476. */
  8477. set colorGradingEnabled(value: boolean);
  8478. private _colorGradingWithGreenDepth;
  8479. /**
  8480. * Gets wether the color grading effect is using a green depth for the 3d Texture.
  8481. */
  8482. get colorGradingWithGreenDepth(): boolean;
  8483. /**
  8484. * Sets wether the color grading effect is using a green depth for the 3d Texture.
  8485. */
  8486. set colorGradingWithGreenDepth(value: boolean);
  8487. private _colorGradingBGR;
  8488. /**
  8489. * Gets wether the color grading texture contains BGR values.
  8490. */
  8491. get colorGradingBGR(): boolean;
  8492. /**
  8493. * Sets wether the color grading texture contains BGR values.
  8494. */
  8495. set colorGradingBGR(value: boolean);
  8496. /** @hidden */
  8497. _exposure: number;
  8498. /**
  8499. * Gets the Exposure used in the effect.
  8500. */
  8501. get exposure(): number;
  8502. /**
  8503. * Sets the Exposure used in the effect.
  8504. */
  8505. set exposure(value: number);
  8506. private _toneMappingEnabled;
  8507. /**
  8508. * Gets wether the tone mapping effect is enabled.
  8509. */
  8510. get toneMappingEnabled(): boolean;
  8511. /**
  8512. * Sets wether the tone mapping effect is enabled.
  8513. */
  8514. set toneMappingEnabled(value: boolean);
  8515. private _toneMappingType;
  8516. /**
  8517. * Gets the type of tone mapping effect.
  8518. */
  8519. get toneMappingType(): number;
  8520. /**
  8521. * Sets the type of tone mapping effect used in BabylonJS.
  8522. */
  8523. set toneMappingType(value: number);
  8524. protected _contrast: number;
  8525. /**
  8526. * Gets the contrast used in the effect.
  8527. */
  8528. get contrast(): number;
  8529. /**
  8530. * Sets the contrast used in the effect.
  8531. */
  8532. set contrast(value: number);
  8533. /**
  8534. * Vignette stretch size.
  8535. */
  8536. vignetteStretch: number;
  8537. /**
  8538. * Vignette centre X Offset.
  8539. */
  8540. vignetteCentreX: number;
  8541. /**
  8542. * Vignette centre Y Offset.
  8543. */
  8544. vignetteCentreY: number;
  8545. /**
  8546. * Vignette weight or intensity of the vignette effect.
  8547. */
  8548. vignetteWeight: number;
  8549. /**
  8550. * Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  8551. * if vignetteEnabled is set to true.
  8552. */
  8553. vignetteColor: Color4;
  8554. /**
  8555. * Camera field of view used by the Vignette effect.
  8556. */
  8557. vignetteCameraFov: number;
  8558. private _vignetteBlendMode;
  8559. /**
  8560. * Gets the vignette blend mode allowing different kind of effect.
  8561. */
  8562. get vignetteBlendMode(): number;
  8563. /**
  8564. * Sets the vignette blend mode allowing different kind of effect.
  8565. */
  8566. set vignetteBlendMode(value: number);
  8567. private _vignetteEnabled;
  8568. /**
  8569. * Gets wether the vignette effect is enabled.
  8570. */
  8571. get vignetteEnabled(): boolean;
  8572. /**
  8573. * Sets wether the vignette effect is enabled.
  8574. */
  8575. set vignetteEnabled(value: boolean);
  8576. private _applyByPostProcess;
  8577. /**
  8578. * Gets wether the image processing is applied through a post process or not.
  8579. */
  8580. get applyByPostProcess(): boolean;
  8581. /**
  8582. * Sets wether the image processing is applied through a post process or not.
  8583. */
  8584. set applyByPostProcess(value: boolean);
  8585. private _isEnabled;
  8586. /**
  8587. * Gets wether the image processing is enabled or not.
  8588. */
  8589. get isEnabled(): boolean;
  8590. /**
  8591. * Sets wether the image processing is enabled or not.
  8592. */
  8593. set isEnabled(value: boolean);
  8594. /**
  8595. * An event triggered when the configuration changes and requires Shader to Update some parameters.
  8596. */
  8597. onUpdateParameters: Observable<ImageProcessingConfiguration>;
  8598. /**
  8599. * Method called each time the image processing information changes requires to recompile the effect.
  8600. */
  8601. protected _updateParameters(): void;
  8602. /**
  8603. * Gets the current class name.
  8604. * @return "ImageProcessingConfiguration"
  8605. */
  8606. getClassName(): string;
  8607. /**
  8608. * Prepare the list of uniforms associated with the Image Processing effects.
  8609. * @param uniforms The list of uniforms used in the effect
  8610. * @param defines the list of defines currently in use
  8611. */
  8612. static PrepareUniforms(uniforms: string[], defines: IImageProcessingConfigurationDefines): void;
  8613. /**
  8614. * Prepare the list of samplers associated with the Image Processing effects.
  8615. * @param samplersList The list of uniforms used in the effect
  8616. * @param defines the list of defines currently in use
  8617. */
  8618. static PrepareSamplers(samplersList: string[], defines: IImageProcessingConfigurationDefines): void;
  8619. /**
  8620. * Prepare the list of defines associated to the shader.
  8621. * @param defines the list of defines to complete
  8622. * @param forPostProcess Define if we are currently in post process mode or not
  8623. */
  8624. prepareDefines(defines: IImageProcessingConfigurationDefines, forPostProcess?: boolean): void;
  8625. /**
  8626. * Returns true if all the image processing information are ready.
  8627. * @returns True if ready, otherwise, false
  8628. */
  8629. isReady(): boolean;
  8630. /**
  8631. * Binds the image processing to the shader.
  8632. * @param effect The effect to bind to
  8633. * @param overrideAspectRatio Override the aspect ratio of the effect
  8634. */
  8635. bind(effect: Effect, overrideAspectRatio?: number): void;
  8636. /**
  8637. * Clones the current image processing instance.
  8638. * @return The cloned image processing
  8639. */
  8640. clone(): ImageProcessingConfiguration;
  8641. /**
  8642. * Serializes the current image processing instance to a json representation.
  8643. * @return a JSON representation
  8644. */
  8645. serialize(): any;
  8646. /**
  8647. * Parses the image processing from a json representation.
  8648. * @param source the JSON source to parse
  8649. * @return The parsed image processing
  8650. */
  8651. static Parse(source: any): ImageProcessingConfiguration;
  8652. private static _VIGNETTEMODE_MULTIPLY;
  8653. private static _VIGNETTEMODE_OPAQUE;
  8654. /**
  8655. * Used to apply the vignette as a mix with the pixel color.
  8656. */
  8657. static get VIGNETTEMODE_MULTIPLY(): number;
  8658. /**
  8659. * Used to apply the vignette as a replacement of the pixel color.
  8660. */
  8661. static get VIGNETTEMODE_OPAQUE(): number;
  8662. }
  8663. }
  8664. declare module "babylonjs/Shaders/postprocess.vertex" {
  8665. /** @hidden */
  8666. export var postprocessVertexShader: {
  8667. name: string;
  8668. shader: string;
  8669. };
  8670. }
  8671. declare module "babylonjs/Engines/Extensions/engine.renderTarget" {
  8672. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  8673. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  8674. import { DepthTextureCreationOptions } from "babylonjs/Engines/depthTextureCreationOptions";
  8675. module "babylonjs/Engines/thinEngine" {
  8676. interface ThinEngine {
  8677. /**
  8678. * Creates a new render target texture
  8679. * @param size defines the size of the texture
  8680. * @param options defines the options used to create the texture
  8681. * @returns a new render target texture stored in an InternalTexture
  8682. */
  8683. createRenderTargetTexture(size: number | {
  8684. width: number;
  8685. height: number;
  8686. layers?: number;
  8687. }, options: boolean | RenderTargetCreationOptions): InternalTexture;
  8688. /**
  8689. * Creates a depth stencil texture.
  8690. * This is only available in WebGL 2 or with the depth texture extension available.
  8691. * @param size The size of face edge in the texture.
  8692. * @param options The options defining the texture.
  8693. * @returns The texture
  8694. */
  8695. createDepthStencilTexture(size: number | {
  8696. width: number;
  8697. height: number;
  8698. layers?: number;
  8699. }, options: DepthTextureCreationOptions): InternalTexture;
  8700. /** @hidden */
  8701. _createDepthStencilTexture(size: number | {
  8702. width: number;
  8703. height: number;
  8704. layers?: number;
  8705. }, options: DepthTextureCreationOptions): InternalTexture;
  8706. }
  8707. }
  8708. }
  8709. declare module "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes" {
  8710. /**
  8711. * Defines the kind of connection point for node based material
  8712. */
  8713. export enum NodeMaterialBlockConnectionPointTypes {
  8714. /** Float */
  8715. Float = 1,
  8716. /** Int */
  8717. Int = 2,
  8718. /** Vector2 */
  8719. Vector2 = 4,
  8720. /** Vector3 */
  8721. Vector3 = 8,
  8722. /** Vector4 */
  8723. Vector4 = 16,
  8724. /** Color3 */
  8725. Color3 = 32,
  8726. /** Color4 */
  8727. Color4 = 64,
  8728. /** Matrix */
  8729. Matrix = 128,
  8730. /** Custom object */
  8731. Object = 256,
  8732. /** Detect type based on connection */
  8733. AutoDetect = 1024,
  8734. /** Output type that will be defined by input type */
  8735. BasedOnInput = 2048
  8736. }
  8737. }
  8738. declare module "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets" {
  8739. /**
  8740. * Enum used to define the target of a block
  8741. */
  8742. export enum NodeMaterialBlockTargets {
  8743. /** Vertex shader */
  8744. Vertex = 1,
  8745. /** Fragment shader */
  8746. Fragment = 2,
  8747. /** Neutral */
  8748. Neutral = 4,
  8749. /** Vertex and Fragment */
  8750. VertexAndFragment = 3
  8751. }
  8752. }
  8753. declare module "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointMode" {
  8754. /**
  8755. * Enum defining the mode of a NodeMaterialBlockConnectionPoint
  8756. */
  8757. export enum NodeMaterialBlockConnectionPointMode {
  8758. /** Value is an uniform */
  8759. Uniform = 0,
  8760. /** Value is a mesh attribute */
  8761. Attribute = 1,
  8762. /** Value is a varying between vertex and fragment shaders */
  8763. Varying = 2,
  8764. /** Mode is undefined */
  8765. Undefined = 3
  8766. }
  8767. }
  8768. declare module "babylonjs/Materials/Node/Enums/nodeMaterialSystemValues" {
  8769. /**
  8770. * Enum used to define system values e.g. values automatically provided by the system
  8771. */
  8772. export enum NodeMaterialSystemValues {
  8773. /** World */
  8774. World = 1,
  8775. /** View */
  8776. View = 2,
  8777. /** Projection */
  8778. Projection = 3,
  8779. /** ViewProjection */
  8780. ViewProjection = 4,
  8781. /** WorldView */
  8782. WorldView = 5,
  8783. /** WorldViewProjection */
  8784. WorldViewProjection = 6,
  8785. /** CameraPosition */
  8786. CameraPosition = 7,
  8787. /** Fog Color */
  8788. FogColor = 8,
  8789. /** Delta time */
  8790. DeltaTime = 9
  8791. }
  8792. }
  8793. declare module "babylonjs/Maths/math.axis" {
  8794. import { Vector3 } from "babylonjs/Maths/math.vector";
  8795. /** Defines supported spaces */
  8796. export enum Space {
  8797. /** Local (object) space */
  8798. LOCAL = 0,
  8799. /** World space */
  8800. WORLD = 1,
  8801. /** Bone space */
  8802. BONE = 2
  8803. }
  8804. /** Defines the 3 main axes */
  8805. export class Axis {
  8806. /** X axis */
  8807. static X: Vector3;
  8808. /** Y axis */
  8809. static Y: Vector3;
  8810. /** Z axis */
  8811. static Z: Vector3;
  8812. }
  8813. }
  8814. declare module "babylonjs/Maths/math.frustum" {
  8815. import { Matrix } from "babylonjs/Maths/math.vector";
  8816. import { DeepImmutable } from "babylonjs/types";
  8817. import { Plane } from "babylonjs/Maths/math.plane";
  8818. /**
  8819. * Represents a camera frustum
  8820. */
  8821. export class Frustum {
  8822. /**
  8823. * Gets the planes representing the frustum
  8824. * @param transform matrix to be applied to the returned planes
  8825. * @returns a new array of 6 Frustum planes computed by the given transformation matrix.
  8826. */
  8827. static GetPlanes(transform: DeepImmutable<Matrix>): Plane[];
  8828. /**
  8829. * Gets the near frustum plane transformed by the transform matrix
  8830. * @param transform transformation matrix to be applied to the resulting frustum plane
  8831. * @param frustumPlane the resuling frustum plane
  8832. */
  8833. static GetNearPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  8834. /**
  8835. * Gets the far frustum plane transformed by the transform matrix
  8836. * @param transform transformation matrix to be applied to the resulting frustum plane
  8837. * @param frustumPlane the resuling frustum plane
  8838. */
  8839. static GetFarPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  8840. /**
  8841. * Gets the left frustum plane transformed by the transform matrix
  8842. * @param transform transformation matrix to be applied to the resulting frustum plane
  8843. * @param frustumPlane the resuling frustum plane
  8844. */
  8845. static GetLeftPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  8846. /**
  8847. * Gets the right frustum plane transformed by the transform matrix
  8848. * @param transform transformation matrix to be applied to the resulting frustum plane
  8849. * @param frustumPlane the resuling frustum plane
  8850. */
  8851. static GetRightPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  8852. /**
  8853. * Gets the top frustum plane transformed by the transform matrix
  8854. * @param transform transformation matrix to be applied to the resulting frustum plane
  8855. * @param frustumPlane the resuling frustum plane
  8856. */
  8857. static GetTopPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  8858. /**
  8859. * Gets the bottom frustum plane transformed by the transform matrix
  8860. * @param transform transformation matrix to be applied to the resulting frustum plane
  8861. * @param frustumPlane the resuling frustum plane
  8862. */
  8863. static GetBottomPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  8864. /**
  8865. * Sets the given array "frustumPlanes" with the 6 Frustum planes computed by the given transformation matrix.
  8866. * @param transform transformation matrix to be applied to the resulting frustum planes
  8867. * @param frustumPlanes the resuling frustum planes
  8868. */
  8869. static GetPlanesToRef(transform: DeepImmutable<Matrix>, frustumPlanes: Plane[]): void;
  8870. }
  8871. }
  8872. declare module "babylonjs/Maths/math.size" {
  8873. /**
  8874. * Interface for the size containing width and height
  8875. */
  8876. export interface ISize {
  8877. /**
  8878. * Width
  8879. */
  8880. width: number;
  8881. /**
  8882. * Heighht
  8883. */
  8884. height: number;
  8885. }
  8886. /**
  8887. * Size containing widht and height
  8888. */
  8889. export class Size implements ISize {
  8890. /**
  8891. * Width
  8892. */
  8893. width: number;
  8894. /**
  8895. * Height
  8896. */
  8897. height: number;
  8898. /**
  8899. * Creates a Size object from the given width and height (floats).
  8900. * @param width width of the new size
  8901. * @param height height of the new size
  8902. */
  8903. constructor(width: number, height: number);
  8904. /**
  8905. * Returns a string with the Size width and height
  8906. * @returns a string with the Size width and height
  8907. */
  8908. toString(): string;
  8909. /**
  8910. * "Size"
  8911. * @returns the string "Size"
  8912. */
  8913. getClassName(): string;
  8914. /**
  8915. * Returns the Size hash code.
  8916. * @returns a hash code for a unique width and height
  8917. */
  8918. getHashCode(): number;
  8919. /**
  8920. * Updates the current size from the given one.
  8921. * @param src the given size
  8922. */
  8923. copyFrom(src: Size): void;
  8924. /**
  8925. * Updates in place the current Size from the given floats.
  8926. * @param width width of the new size
  8927. * @param height height of the new size
  8928. * @returns the updated Size.
  8929. */
  8930. copyFromFloats(width: number, height: number): Size;
  8931. /**
  8932. * Updates in place the current Size from the given floats.
  8933. * @param width width to set
  8934. * @param height height to set
  8935. * @returns the updated Size.
  8936. */
  8937. set(width: number, height: number): Size;
  8938. /**
  8939. * Multiplies the width and height by numbers
  8940. * @param w factor to multiple the width by
  8941. * @param h factor to multiple the height by
  8942. * @returns a new Size set with the multiplication result of the current Size and the given floats.
  8943. */
  8944. multiplyByFloats(w: number, h: number): Size;
  8945. /**
  8946. * Clones the size
  8947. * @returns a new Size copied from the given one.
  8948. */
  8949. clone(): Size;
  8950. /**
  8951. * True if the current Size and the given one width and height are strictly equal.
  8952. * @param other the other size to compare against
  8953. * @returns True if the current Size and the given one width and height are strictly equal.
  8954. */
  8955. equals(other: Size): boolean;
  8956. /**
  8957. * The surface of the Size : width * height (float).
  8958. */
  8959. get surface(): number;
  8960. /**
  8961. * Create a new size of zero
  8962. * @returns a new Size set to (0.0, 0.0)
  8963. */
  8964. static Zero(): Size;
  8965. /**
  8966. * Sums the width and height of two sizes
  8967. * @param otherSize size to add to this size
  8968. * @returns a new Size set as the addition result of the current Size and the given one.
  8969. */
  8970. add(otherSize: Size): Size;
  8971. /**
  8972. * Subtracts the width and height of two
  8973. * @param otherSize size to subtract to this size
  8974. * @returns a new Size set as the subtraction result of the given one from the current Size.
  8975. */
  8976. subtract(otherSize: Size): Size;
  8977. /**
  8978. * Creates a new Size set at the linear interpolation "amount" between "start" and "end"
  8979. * @param start starting size to lerp between
  8980. * @param end end size to lerp between
  8981. * @param amount amount to lerp between the start and end values
  8982. * @returns a new Size set at the linear interpolation "amount" between "start" and "end"
  8983. */
  8984. static Lerp(start: Size, end: Size, amount: number): Size;
  8985. }
  8986. }
  8987. declare module "babylonjs/Maths/math.vertexFormat" {
  8988. import { Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  8989. /**
  8990. * Contains position and normal vectors for a vertex
  8991. */
  8992. export class PositionNormalVertex {
  8993. /** the position of the vertex (defaut: 0,0,0) */
  8994. position: Vector3;
  8995. /** the normal of the vertex (defaut: 0,1,0) */
  8996. normal: Vector3;
  8997. /**
  8998. * Creates a PositionNormalVertex
  8999. * @param position the position of the vertex (defaut: 0,0,0)
  9000. * @param normal the normal of the vertex (defaut: 0,1,0)
  9001. */
  9002. constructor(
  9003. /** the position of the vertex (defaut: 0,0,0) */
  9004. position?: Vector3,
  9005. /** the normal of the vertex (defaut: 0,1,0) */
  9006. normal?: Vector3);
  9007. /**
  9008. * Clones the PositionNormalVertex
  9009. * @returns the cloned PositionNormalVertex
  9010. */
  9011. clone(): PositionNormalVertex;
  9012. }
  9013. /**
  9014. * Contains position, normal and uv vectors for a vertex
  9015. */
  9016. export class PositionNormalTextureVertex {
  9017. /** the position of the vertex (defaut: 0,0,0) */
  9018. position: Vector3;
  9019. /** the normal of the vertex (defaut: 0,1,0) */
  9020. normal: Vector3;
  9021. /** the uv of the vertex (default: 0,0) */
  9022. uv: Vector2;
  9023. /**
  9024. * Creates a PositionNormalTextureVertex
  9025. * @param position the position of the vertex (defaut: 0,0,0)
  9026. * @param normal the normal of the vertex (defaut: 0,1,0)
  9027. * @param uv the uv of the vertex (default: 0,0)
  9028. */
  9029. constructor(
  9030. /** the position of the vertex (defaut: 0,0,0) */
  9031. position?: Vector3,
  9032. /** the normal of the vertex (defaut: 0,1,0) */
  9033. normal?: Vector3,
  9034. /** the uv of the vertex (default: 0,0) */
  9035. uv?: Vector2);
  9036. /**
  9037. * Clones the PositionNormalTextureVertex
  9038. * @returns the cloned PositionNormalTextureVertex
  9039. */
  9040. clone(): PositionNormalTextureVertex;
  9041. }
  9042. }
  9043. declare module "babylonjs/Maths/math" {
  9044. export * from "babylonjs/Maths/math.axis";
  9045. export * from "babylonjs/Maths/math.color";
  9046. export * from "babylonjs/Maths/math.constants";
  9047. export * from "babylonjs/Maths/math.frustum";
  9048. export * from "babylonjs/Maths/math.path";
  9049. export * from "babylonjs/Maths/math.plane";
  9050. export * from "babylonjs/Maths/math.size";
  9051. export * from "babylonjs/Maths/math.vector";
  9052. export * from "babylonjs/Maths/math.vertexFormat";
  9053. export * from "babylonjs/Maths/math.viewport";
  9054. }
  9055. declare module "babylonjs/Materials/Node/Blocks/Input/animatedInputBlockTypes" {
  9056. /**
  9057. * Enum defining the type of animations supported by InputBlock
  9058. */
  9059. export enum AnimatedInputBlockTypes {
  9060. /** No animation */
  9061. None = 0,
  9062. /** Time based animation. Will only work for floats */
  9063. Time = 1
  9064. }
  9065. }
  9066. declare module "babylonjs/Lights/shadowLight" {
  9067. import { Camera } from "babylonjs/Cameras/camera";
  9068. import { Scene } from "babylonjs/scene";
  9069. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  9070. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  9071. import { Light } from "babylonjs/Lights/light";
  9072. /**
  9073. * Interface describing all the common properties and methods a shadow light needs to implement.
  9074. * This helps both the shadow generator and materials to genrate the corresponding shadow maps
  9075. * as well as binding the different shadow properties to the effects.
  9076. */
  9077. export interface IShadowLight extends Light {
  9078. /**
  9079. * The light id in the scene (used in scene.findLighById for instance)
  9080. */
  9081. id: string;
  9082. /**
  9083. * The position the shdow will be casted from.
  9084. */
  9085. position: Vector3;
  9086. /**
  9087. * In 2d mode (needCube being false), the direction used to cast the shadow.
  9088. */
  9089. direction: Vector3;
  9090. /**
  9091. * The transformed position. Position of the light in world space taking parenting in account.
  9092. */
  9093. transformedPosition: Vector3;
  9094. /**
  9095. * The transformed direction. Direction of the light in world space taking parenting in account.
  9096. */
  9097. transformedDirection: Vector3;
  9098. /**
  9099. * The friendly name of the light in the scene.
  9100. */
  9101. name: string;
  9102. /**
  9103. * Defines the shadow projection clipping minimum z value.
  9104. */
  9105. shadowMinZ: number;
  9106. /**
  9107. * Defines the shadow projection clipping maximum z value.
  9108. */
  9109. shadowMaxZ: number;
  9110. /**
  9111. * Computes the transformed information (transformedPosition and transformedDirection in World space) of the current light
  9112. * @returns true if the information has been computed, false if it does not need to (no parenting)
  9113. */
  9114. computeTransformedInformation(): boolean;
  9115. /**
  9116. * Gets the scene the light belongs to.
  9117. * @returns The scene
  9118. */
  9119. getScene(): Scene;
  9120. /**
  9121. * Callback defining a custom Projection Matrix Builder.
  9122. * This can be used to override the default projection matrix computation.
  9123. */
  9124. customProjectionMatrixBuilder: (viewMatrix: Matrix, renderList: Array<AbstractMesh>, result: Matrix) => void;
  9125. /**
  9126. * Sets the shadow projection matrix in parameter to the generated projection matrix.
  9127. * @param matrix The materix to updated with the projection information
  9128. * @param viewMatrix The transform matrix of the light
  9129. * @param renderList The list of mesh to render in the map
  9130. * @returns The current light
  9131. */
  9132. setShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): IShadowLight;
  9133. /**
  9134. * Gets the current depth scale used in ESM.
  9135. * @returns The scale
  9136. */
  9137. getDepthScale(): number;
  9138. /**
  9139. * Returns whether or not the shadow generation require a cube texture or a 2d texture.
  9140. * @returns true if a cube texture needs to be use
  9141. */
  9142. needCube(): boolean;
  9143. /**
  9144. * Detects if the projection matrix requires to be recomputed this frame.
  9145. * @returns true if it requires to be recomputed otherwise, false.
  9146. */
  9147. needProjectionMatrixCompute(): boolean;
  9148. /**
  9149. * Forces the shadow generator to recompute the projection matrix even if position and direction did not changed.
  9150. */
  9151. forceProjectionMatrixCompute(): void;
  9152. /**
  9153. * Get the direction to use to render the shadow map. In case of cube texture, the face index can be passed.
  9154. * @param faceIndex The index of the face we are computed the direction to generate shadow
  9155. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  9156. */
  9157. getShadowDirection(faceIndex?: number): Vector3;
  9158. /**
  9159. * Gets the minZ used for shadow according to both the scene and the light.
  9160. * @param activeCamera The camera we are returning the min for
  9161. * @returns the depth min z
  9162. */
  9163. getDepthMinZ(activeCamera: Camera): number;
  9164. /**
  9165. * Gets the maxZ used for shadow according to both the scene and the light.
  9166. * @param activeCamera The camera we are returning the max for
  9167. * @returns the depth max z
  9168. */
  9169. getDepthMaxZ(activeCamera: Camera): number;
  9170. }
  9171. /**
  9172. * Base implementation IShadowLight
  9173. * It groups all the common behaviour in order to reduce dupplication and better follow the DRY pattern.
  9174. */
  9175. export abstract class ShadowLight extends Light implements IShadowLight {
  9176. protected abstract _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  9177. protected _position: Vector3;
  9178. protected _setPosition(value: Vector3): void;
  9179. /**
  9180. * Sets the position the shadow will be casted from. Also use as the light position for both
  9181. * point and spot lights.
  9182. */
  9183. get position(): Vector3;
  9184. /**
  9185. * Sets the position the shadow will be casted from. Also use as the light position for both
  9186. * point and spot lights.
  9187. */
  9188. set position(value: Vector3);
  9189. protected _direction: Vector3;
  9190. protected _setDirection(value: Vector3): void;
  9191. /**
  9192. * In 2d mode (needCube being false), gets the direction used to cast the shadow.
  9193. * Also use as the light direction on spot and directional lights.
  9194. */
  9195. get direction(): Vector3;
  9196. /**
  9197. * In 2d mode (needCube being false), sets the direction used to cast the shadow.
  9198. * Also use as the light direction on spot and directional lights.
  9199. */
  9200. set direction(value: Vector3);
  9201. protected _shadowMinZ: number;
  9202. /**
  9203. * Gets the shadow projection clipping minimum z value.
  9204. */
  9205. get shadowMinZ(): number;
  9206. /**
  9207. * Sets the shadow projection clipping minimum z value.
  9208. */
  9209. set shadowMinZ(value: number);
  9210. protected _shadowMaxZ: number;
  9211. /**
  9212. * Sets the shadow projection clipping maximum z value.
  9213. */
  9214. get shadowMaxZ(): number;
  9215. /**
  9216. * Gets the shadow projection clipping maximum z value.
  9217. */
  9218. set shadowMaxZ(value: number);
  9219. /**
  9220. * Callback defining a custom Projection Matrix Builder.
  9221. * This can be used to override the default projection matrix computation.
  9222. */
  9223. customProjectionMatrixBuilder: (viewMatrix: Matrix, renderList: Array<AbstractMesh>, result: Matrix) => void;
  9224. /**
  9225. * The transformed position. Position of the light in world space taking parenting in account.
  9226. */
  9227. transformedPosition: Vector3;
  9228. /**
  9229. * The transformed direction. Direction of the light in world space taking parenting in account.
  9230. */
  9231. transformedDirection: Vector3;
  9232. private _needProjectionMatrixCompute;
  9233. /**
  9234. * Computes the transformed information (transformedPosition and transformedDirection in World space) of the current light
  9235. * @returns true if the information has been computed, false if it does not need to (no parenting)
  9236. */
  9237. computeTransformedInformation(): boolean;
  9238. /**
  9239. * Return the depth scale used for the shadow map.
  9240. * @returns the depth scale.
  9241. */
  9242. getDepthScale(): number;
  9243. /**
  9244. * Get the direction to use to render the shadow map. In case of cube texture, the face index can be passed.
  9245. * @param faceIndex The index of the face we are computed the direction to generate shadow
  9246. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  9247. */
  9248. getShadowDirection(faceIndex?: number): Vector3;
  9249. /**
  9250. * Returns the ShadowLight absolute position in the World.
  9251. * @returns the position vector in world space
  9252. */
  9253. getAbsolutePosition(): Vector3;
  9254. /**
  9255. * Sets the ShadowLight direction toward the passed target.
  9256. * @param target The point to target in local space
  9257. * @returns the updated ShadowLight direction
  9258. */
  9259. setDirectionToTarget(target: Vector3): Vector3;
  9260. /**
  9261. * Returns the light rotation in euler definition.
  9262. * @returns the x y z rotation in local space.
  9263. */
  9264. getRotation(): Vector3;
  9265. /**
  9266. * Returns whether or not the shadow generation require a cube texture or a 2d texture.
  9267. * @returns true if a cube texture needs to be use
  9268. */
  9269. needCube(): boolean;
  9270. /**
  9271. * Detects if the projection matrix requires to be recomputed this frame.
  9272. * @returns true if it requires to be recomputed otherwise, false.
  9273. */
  9274. needProjectionMatrixCompute(): boolean;
  9275. /**
  9276. * Forces the shadow generator to recompute the projection matrix even if position and direction did not changed.
  9277. */
  9278. forceProjectionMatrixCompute(): void;
  9279. /** @hidden */
  9280. _initCache(): void;
  9281. /** @hidden */
  9282. _isSynchronized(): boolean;
  9283. /**
  9284. * Computes the world matrix of the node
  9285. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  9286. * @returns the world matrix
  9287. */
  9288. computeWorldMatrix(force?: boolean): Matrix;
  9289. /**
  9290. * Gets the minZ used for shadow according to both the scene and the light.
  9291. * @param activeCamera The camera we are returning the min for
  9292. * @returns the depth min z
  9293. */
  9294. getDepthMinZ(activeCamera: Camera): number;
  9295. /**
  9296. * Gets the maxZ used for shadow according to both the scene and the light.
  9297. * @param activeCamera The camera we are returning the max for
  9298. * @returns the depth max z
  9299. */
  9300. getDepthMaxZ(activeCamera: Camera): number;
  9301. /**
  9302. * Sets the shadow projection matrix in parameter to the generated projection matrix.
  9303. * @param matrix The materix to updated with the projection information
  9304. * @param viewMatrix The transform matrix of the light
  9305. * @param renderList The list of mesh to render in the map
  9306. * @returns The current light
  9307. */
  9308. setShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): IShadowLight;
  9309. }
  9310. }
  9311. declare module "babylonjs/Shaders/ShadersInclude/packingFunctions" {
  9312. /** @hidden */
  9313. export var packingFunctions: {
  9314. name: string;
  9315. shader: string;
  9316. };
  9317. }
  9318. declare module "babylonjs/Shaders/ShadersInclude/bayerDitherFunctions" {
  9319. /** @hidden */
  9320. export var bayerDitherFunctions: {
  9321. name: string;
  9322. shader: string;
  9323. };
  9324. }
  9325. declare module "babylonjs/Shaders/ShadersInclude/shadowMapFragmentDeclaration" {
  9326. import "babylonjs/Shaders/ShadersInclude/packingFunctions";
  9327. import "babylonjs/Shaders/ShadersInclude/bayerDitherFunctions";
  9328. /** @hidden */
  9329. export var shadowMapFragmentDeclaration: {
  9330. name: string;
  9331. shader: string;
  9332. };
  9333. }
  9334. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration" {
  9335. /** @hidden */
  9336. export var clipPlaneFragmentDeclaration: {
  9337. name: string;
  9338. shader: string;
  9339. };
  9340. }
  9341. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneFragment" {
  9342. /** @hidden */
  9343. export var clipPlaneFragment: {
  9344. name: string;
  9345. shader: string;
  9346. };
  9347. }
  9348. declare module "babylonjs/Shaders/ShadersInclude/shadowMapFragment" {
  9349. /** @hidden */
  9350. export var shadowMapFragment: {
  9351. name: string;
  9352. shader: string;
  9353. };
  9354. }
  9355. declare module "babylonjs/Shaders/shadowMap.fragment" {
  9356. import "babylonjs/Shaders/ShadersInclude/shadowMapFragmentDeclaration";
  9357. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  9358. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  9359. import "babylonjs/Shaders/ShadersInclude/shadowMapFragment";
  9360. /** @hidden */
  9361. export var shadowMapPixelShader: {
  9362. name: string;
  9363. shader: string;
  9364. };
  9365. }
  9366. declare module "babylonjs/Shaders/ShadersInclude/bonesDeclaration" {
  9367. /** @hidden */
  9368. export var bonesDeclaration: {
  9369. name: string;
  9370. shader: string;
  9371. };
  9372. }
  9373. declare module "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration" {
  9374. /** @hidden */
  9375. export var morphTargetsVertexGlobalDeclaration: {
  9376. name: string;
  9377. shader: string;
  9378. };
  9379. }
  9380. declare module "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration" {
  9381. /** @hidden */
  9382. export var morphTargetsVertexDeclaration: {
  9383. name: string;
  9384. shader: string;
  9385. };
  9386. }
  9387. declare module "babylonjs/Shaders/ShadersInclude/instancesDeclaration" {
  9388. /** @hidden */
  9389. export var instancesDeclaration: {
  9390. name: string;
  9391. shader: string;
  9392. };
  9393. }
  9394. declare module "babylonjs/Shaders/ShadersInclude/helperFunctions" {
  9395. /** @hidden */
  9396. export var helperFunctions: {
  9397. name: string;
  9398. shader: string;
  9399. };
  9400. }
  9401. declare module "babylonjs/Shaders/ShadersInclude/shadowMapVertexDeclaration" {
  9402. /** @hidden */
  9403. export var shadowMapVertexDeclaration: {
  9404. name: string;
  9405. shader: string;
  9406. };
  9407. }
  9408. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration" {
  9409. /** @hidden */
  9410. export var clipPlaneVertexDeclaration: {
  9411. name: string;
  9412. shader: string;
  9413. };
  9414. }
  9415. declare module "babylonjs/Shaders/ShadersInclude/morphTargetsVertex" {
  9416. /** @hidden */
  9417. export var morphTargetsVertex: {
  9418. name: string;
  9419. shader: string;
  9420. };
  9421. }
  9422. declare module "babylonjs/Shaders/ShadersInclude/instancesVertex" {
  9423. /** @hidden */
  9424. export var instancesVertex: {
  9425. name: string;
  9426. shader: string;
  9427. };
  9428. }
  9429. declare module "babylonjs/Shaders/ShadersInclude/bonesVertex" {
  9430. /** @hidden */
  9431. export var bonesVertex: {
  9432. name: string;
  9433. shader: string;
  9434. };
  9435. }
  9436. declare module "babylonjs/Shaders/ShadersInclude/shadowMapVertexNormalBias" {
  9437. /** @hidden */
  9438. export var shadowMapVertexNormalBias: {
  9439. name: string;
  9440. shader: string;
  9441. };
  9442. }
  9443. declare module "babylonjs/Shaders/ShadersInclude/shadowMapVertexMetric" {
  9444. /** @hidden */
  9445. export var shadowMapVertexMetric: {
  9446. name: string;
  9447. shader: string;
  9448. };
  9449. }
  9450. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneVertex" {
  9451. /** @hidden */
  9452. export var clipPlaneVertex: {
  9453. name: string;
  9454. shader: string;
  9455. };
  9456. }
  9457. declare module "babylonjs/Shaders/shadowMap.vertex" {
  9458. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  9459. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  9460. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  9461. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  9462. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  9463. import "babylonjs/Shaders/ShadersInclude/shadowMapVertexDeclaration";
  9464. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  9465. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  9466. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  9467. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  9468. import "babylonjs/Shaders/ShadersInclude/shadowMapVertexNormalBias";
  9469. import "babylonjs/Shaders/ShadersInclude/shadowMapVertexMetric";
  9470. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  9471. /** @hidden */
  9472. export var shadowMapVertexShader: {
  9473. name: string;
  9474. shader: string;
  9475. };
  9476. }
  9477. declare module "babylonjs/Shaders/depthBoxBlur.fragment" {
  9478. /** @hidden */
  9479. export var depthBoxBlurPixelShader: {
  9480. name: string;
  9481. shader: string;
  9482. };
  9483. }
  9484. declare module "babylonjs/Shaders/ShadersInclude/shadowMapFragmentSoftTransparentShadow" {
  9485. /** @hidden */
  9486. export var shadowMapFragmentSoftTransparentShadow: {
  9487. name: string;
  9488. shader: string;
  9489. };
  9490. }
  9491. declare module "babylonjs/Materials/effectFallbacks" {
  9492. import { IEffectFallbacks } from "babylonjs/Materials/iEffectFallbacks";
  9493. import { Effect } from "babylonjs/Materials/effect";
  9494. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  9495. /**
  9496. * EffectFallbacks can be used to add fallbacks (properties to disable) to certain properties when desired to improve performance.
  9497. * (Eg. Start at high quality with reflection and fog, if fps is low, remove reflection, if still low remove fog)
  9498. */
  9499. export class EffectFallbacks implements IEffectFallbacks {
  9500. private _defines;
  9501. private _currentRank;
  9502. private _maxRank;
  9503. private _mesh;
  9504. /**
  9505. * Removes the fallback from the bound mesh.
  9506. */
  9507. unBindMesh(): void;
  9508. /**
  9509. * Adds a fallback on the specified property.
  9510. * @param rank The rank of the fallback (Lower ranks will be fallbacked to first)
  9511. * @param define The name of the define in the shader
  9512. */
  9513. addFallback(rank: number, define: string): void;
  9514. /**
  9515. * Sets the mesh to use CPU skinning when needing to fallback.
  9516. * @param rank The rank of the fallback (Lower ranks will be fallbacked to first)
  9517. * @param mesh The mesh to use the fallbacks.
  9518. */
  9519. addCPUSkinningFallback(rank: number, mesh: AbstractMesh): void;
  9520. /**
  9521. * Checks to see if more fallbacks are still availible.
  9522. */
  9523. get hasMoreFallbacks(): boolean;
  9524. /**
  9525. * Removes the defines that should be removed when falling back.
  9526. * @param currentDefines defines the current define statements for the shader.
  9527. * @param effect defines the current effect we try to compile
  9528. * @returns The resulting defines with defines of the current rank removed.
  9529. */
  9530. reduce(currentDefines: string, effect: Effect): string;
  9531. }
  9532. }
  9533. declare module "babylonjs/Actions/action" {
  9534. import { Observable } from "babylonjs/Misc/observable";
  9535. import { Condition } from "babylonjs/Actions/condition";
  9536. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  9537. import { Scene } from "babylonjs/scene";
  9538. import { ActionManager } from "babylonjs/Actions/actionManager";
  9539. import { ActionEvent } from "babylonjs/Actions/actionEvent";
  9540. import { Node } from "babylonjs/node";
  9541. /**
  9542. * Interface used to define Action
  9543. */
  9544. export interface IAction {
  9545. /**
  9546. * Trigger for the action
  9547. */
  9548. trigger: number;
  9549. /** Options of the trigger */
  9550. triggerOptions: any;
  9551. /**
  9552. * Gets the trigger parameters
  9553. * @returns the trigger parameters
  9554. */
  9555. getTriggerParameter(): any;
  9556. /**
  9557. * Internal only - executes current action event
  9558. * @hidden
  9559. */
  9560. _executeCurrent(evt?: ActionEvent): void;
  9561. /**
  9562. * Serialize placeholder for child classes
  9563. * @param parent of child
  9564. * @returns the serialized object
  9565. */
  9566. serialize(parent: any): any;
  9567. /**
  9568. * Internal only
  9569. * @hidden
  9570. */
  9571. _prepare(): void;
  9572. /**
  9573. * Internal only - manager for action
  9574. * @hidden
  9575. */
  9576. _actionManager: AbstractActionManager;
  9577. /**
  9578. * Adds action to chain of actions, may be a DoNothingAction
  9579. * @param action defines the next action to execute
  9580. * @returns The action passed in
  9581. * @see https://www.babylonjs-playground.com/#1T30HR#0
  9582. */
  9583. then(action: IAction): IAction;
  9584. }
  9585. /**
  9586. * The action to be carried out following a trigger
  9587. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#available-actions
  9588. */
  9589. export class Action implements IAction {
  9590. /** the trigger, with or without parameters, for the action */
  9591. triggerOptions: any;
  9592. /**
  9593. * Trigger for the action
  9594. */
  9595. trigger: number;
  9596. /**
  9597. * Internal only - manager for action
  9598. * @hidden
  9599. */
  9600. _actionManager: ActionManager;
  9601. private _nextActiveAction;
  9602. private _child;
  9603. private _condition?;
  9604. private _triggerParameter;
  9605. /**
  9606. * An event triggered prior to action being executed.
  9607. */
  9608. onBeforeExecuteObservable: Observable<Action>;
  9609. /**
  9610. * Creates a new Action
  9611. * @param triggerOptions the trigger, with or without parameters, for the action
  9612. * @param condition an optional determinant of action
  9613. */
  9614. constructor(
  9615. /** the trigger, with or without parameters, for the action */
  9616. triggerOptions: any, condition?: Condition);
  9617. /**
  9618. * Internal only
  9619. * @hidden
  9620. */
  9621. _prepare(): void;
  9622. /**
  9623. * Gets the trigger parameters
  9624. * @returns the trigger parameters
  9625. */
  9626. getTriggerParameter(): any;
  9627. /**
  9628. * Internal only - executes current action event
  9629. * @hidden
  9630. */
  9631. _executeCurrent(evt?: ActionEvent): void;
  9632. /**
  9633. * Execute placeholder for child classes
  9634. * @param evt optional action event
  9635. */
  9636. execute(evt?: ActionEvent): void;
  9637. /**
  9638. * Skips to next active action
  9639. */
  9640. skipToNextActiveAction(): void;
  9641. /**
  9642. * Adds action to chain of actions, may be a DoNothingAction
  9643. * @param action defines the next action to execute
  9644. * @returns The action passed in
  9645. * @see https://www.babylonjs-playground.com/#1T30HR#0
  9646. */
  9647. then(action: Action): Action;
  9648. /**
  9649. * Internal only
  9650. * @hidden
  9651. */
  9652. _getProperty(propertyPath: string): string;
  9653. /**
  9654. * Internal only
  9655. * @hidden
  9656. */
  9657. _getEffectiveTarget(target: any, propertyPath: string): any;
  9658. /**
  9659. * Serialize placeholder for child classes
  9660. * @param parent of child
  9661. * @returns the serialized object
  9662. */
  9663. serialize(parent: any): any;
  9664. /**
  9665. * Internal only called by serialize
  9666. * @hidden
  9667. */
  9668. protected _serialize(serializedAction: any, parent?: any): any;
  9669. /**
  9670. * Internal only
  9671. * @hidden
  9672. */
  9673. static _SerializeValueAsString: (value: any) => string;
  9674. /**
  9675. * Internal only
  9676. * @hidden
  9677. */
  9678. static _GetTargetProperty: (target: Scene | Node) => {
  9679. name: string;
  9680. targetType: string;
  9681. value: string;
  9682. };
  9683. }
  9684. }
  9685. declare module "babylonjs/Actions/condition" {
  9686. import { ActionManager } from "babylonjs/Actions/actionManager";
  9687. /**
  9688. * A Condition applied to an Action
  9689. */
  9690. export class Condition {
  9691. /**
  9692. * Internal only - manager for action
  9693. * @hidden
  9694. */
  9695. _actionManager: ActionManager;
  9696. /**
  9697. * Internal only
  9698. * @hidden
  9699. */
  9700. _evaluationId: number;
  9701. /**
  9702. * Internal only
  9703. * @hidden
  9704. */
  9705. _currentResult: boolean;
  9706. /**
  9707. * Creates a new Condition
  9708. * @param actionManager the manager of the action the condition is applied to
  9709. */
  9710. constructor(actionManager: ActionManager);
  9711. /**
  9712. * Check if the current condition is valid
  9713. * @returns a boolean
  9714. */
  9715. isValid(): boolean;
  9716. /**
  9717. * Internal only
  9718. * @hidden
  9719. */
  9720. _getProperty(propertyPath: string): string;
  9721. /**
  9722. * Internal only
  9723. * @hidden
  9724. */
  9725. _getEffectiveTarget(target: any, propertyPath: string): any;
  9726. /**
  9727. * Serialize placeholder for child classes
  9728. * @returns the serialized object
  9729. */
  9730. serialize(): any;
  9731. /**
  9732. * Internal only
  9733. * @hidden
  9734. */
  9735. protected _serialize(serializedCondition: any): any;
  9736. }
  9737. /**
  9738. * Defines specific conditional operators as extensions of Condition
  9739. */
  9740. export class ValueCondition extends Condition {
  9741. /** path to specify the property of the target the conditional operator uses */
  9742. propertyPath: string;
  9743. /** the value compared by the conditional operator against the current value of the property */
  9744. value: any;
  9745. /** the conditional operator, default ValueCondition.IsEqual */
  9746. operator: number;
  9747. /**
  9748. * Internal only
  9749. * @hidden
  9750. */
  9751. private static _IsEqual;
  9752. /**
  9753. * Internal only
  9754. * @hidden
  9755. */
  9756. private static _IsDifferent;
  9757. /**
  9758. * Internal only
  9759. * @hidden
  9760. */
  9761. private static _IsGreater;
  9762. /**
  9763. * Internal only
  9764. * @hidden
  9765. */
  9766. private static _IsLesser;
  9767. /**
  9768. * returns the number for IsEqual
  9769. */
  9770. static get IsEqual(): number;
  9771. /**
  9772. * Returns the number for IsDifferent
  9773. */
  9774. static get IsDifferent(): number;
  9775. /**
  9776. * Returns the number for IsGreater
  9777. */
  9778. static get IsGreater(): number;
  9779. /**
  9780. * Returns the number for IsLesser
  9781. */
  9782. static get IsLesser(): number;
  9783. /**
  9784. * Internal only The action manager for the condition
  9785. * @hidden
  9786. */
  9787. _actionManager: ActionManager;
  9788. /**
  9789. * Internal only
  9790. * @hidden
  9791. */
  9792. private _target;
  9793. /**
  9794. * Internal only
  9795. * @hidden
  9796. */
  9797. private _effectiveTarget;
  9798. /**
  9799. * Internal only
  9800. * @hidden
  9801. */
  9802. private _property;
  9803. /**
  9804. * Creates a new ValueCondition
  9805. * @param actionManager manager for the action the condition applies to
  9806. * @param target for the action
  9807. * @param propertyPath path to specify the property of the target the conditional operator uses
  9808. * @param value the value compared by the conditional operator against the current value of the property
  9809. * @param operator the conditional operator, default ValueCondition.IsEqual
  9810. */
  9811. constructor(actionManager: ActionManager, target: any,
  9812. /** path to specify the property of the target the conditional operator uses */
  9813. propertyPath: string,
  9814. /** the value compared by the conditional operator against the current value of the property */
  9815. value: any,
  9816. /** the conditional operator, default ValueCondition.IsEqual */
  9817. operator?: number);
  9818. /**
  9819. * Compares the given value with the property value for the specified conditional operator
  9820. * @returns the result of the comparison
  9821. */
  9822. isValid(): boolean;
  9823. /**
  9824. * Serialize the ValueCondition into a JSON compatible object
  9825. * @returns serialization object
  9826. */
  9827. serialize(): any;
  9828. /**
  9829. * Gets the name of the conditional operator for the ValueCondition
  9830. * @param operator the conditional operator
  9831. * @returns the name
  9832. */
  9833. static GetOperatorName(operator: number): string;
  9834. }
  9835. /**
  9836. * Defines a predicate condition as an extension of Condition
  9837. */
  9838. export class PredicateCondition extends Condition {
  9839. /** defines the predicate function used to validate the condition */
  9840. predicate: () => boolean;
  9841. /**
  9842. * Internal only - manager for action
  9843. * @hidden
  9844. */
  9845. _actionManager: ActionManager;
  9846. /**
  9847. * Creates a new PredicateCondition
  9848. * @param actionManager manager for the action the condition applies to
  9849. * @param predicate defines the predicate function used to validate the condition
  9850. */
  9851. constructor(actionManager: ActionManager,
  9852. /** defines the predicate function used to validate the condition */
  9853. predicate: () => boolean);
  9854. /**
  9855. * @returns the validity of the predicate condition
  9856. */
  9857. isValid(): boolean;
  9858. }
  9859. /**
  9860. * Defines a state condition as an extension of Condition
  9861. */
  9862. export class StateCondition extends Condition {
  9863. /** Value to compare with target state */
  9864. value: string;
  9865. /**
  9866. * Internal only - manager for action
  9867. * @hidden
  9868. */
  9869. _actionManager: ActionManager;
  9870. /**
  9871. * Internal only
  9872. * @hidden
  9873. */
  9874. private _target;
  9875. /**
  9876. * Creates a new StateCondition
  9877. * @param actionManager manager for the action the condition applies to
  9878. * @param target of the condition
  9879. * @param value to compare with target state
  9880. */
  9881. constructor(actionManager: ActionManager, target: any,
  9882. /** Value to compare with target state */
  9883. value: string);
  9884. /**
  9885. * Gets a boolean indicating if the current condition is met
  9886. * @returns the validity of the state
  9887. */
  9888. isValid(): boolean;
  9889. /**
  9890. * Serialize the StateCondition into a JSON compatible object
  9891. * @returns serialization object
  9892. */
  9893. serialize(): any;
  9894. }
  9895. }
  9896. declare module "babylonjs/Actions/directActions" {
  9897. import { Action } from "babylonjs/Actions/action";
  9898. import { Condition } from "babylonjs/Actions/condition";
  9899. import { ActionEvent } from "babylonjs/Actions/actionEvent";
  9900. /**
  9901. * This defines an action responsible to toggle a boolean once triggered.
  9902. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  9903. */
  9904. export class SwitchBooleanAction extends Action {
  9905. /**
  9906. * The path to the boolean property in the target object
  9907. */
  9908. propertyPath: string;
  9909. private _target;
  9910. private _effectiveTarget;
  9911. private _property;
  9912. /**
  9913. * Instantiate the action
  9914. * @param triggerOptions defines the trigger options
  9915. * @param target defines the object containing the boolean
  9916. * @param propertyPath defines the path to the boolean property in the target object
  9917. * @param condition defines the trigger related conditions
  9918. */
  9919. constructor(triggerOptions: any, target: any, propertyPath: string, condition?: Condition);
  9920. /** @hidden */
  9921. _prepare(): void;
  9922. /**
  9923. * Execute the action toggle the boolean value.
  9924. */
  9925. execute(): void;
  9926. /**
  9927. * Serializes the actions and its related information.
  9928. * @param parent defines the object to serialize in
  9929. * @returns the serialized object
  9930. */
  9931. serialize(parent: any): any;
  9932. }
  9933. /**
  9934. * This defines an action responsible to set a the state field of the target
  9935. * to a desired value once triggered.
  9936. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  9937. */
  9938. export class SetStateAction extends Action {
  9939. /**
  9940. * The value to store in the state field.
  9941. */
  9942. value: string;
  9943. private _target;
  9944. /**
  9945. * Instantiate the action
  9946. * @param triggerOptions defines the trigger options
  9947. * @param target defines the object containing the state property
  9948. * @param value defines the value to store in the state field
  9949. * @param condition defines the trigger related conditions
  9950. */
  9951. constructor(triggerOptions: any, target: any, value: string, condition?: Condition);
  9952. /**
  9953. * Execute the action and store the value on the target state property.
  9954. */
  9955. execute(): void;
  9956. /**
  9957. * Serializes the actions and its related information.
  9958. * @param parent defines the object to serialize in
  9959. * @returns the serialized object
  9960. */
  9961. serialize(parent: any): any;
  9962. }
  9963. /**
  9964. * This defines an action responsible to set a property of the target
  9965. * to a desired value once triggered.
  9966. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  9967. */
  9968. export class SetValueAction extends Action {
  9969. /**
  9970. * The path of the property to set in the target.
  9971. */
  9972. propertyPath: string;
  9973. /**
  9974. * The value to set in the property
  9975. */
  9976. value: any;
  9977. private _target;
  9978. private _effectiveTarget;
  9979. private _property;
  9980. /**
  9981. * Instantiate the action
  9982. * @param triggerOptions defines the trigger options
  9983. * @param target defines the object containing the property
  9984. * @param propertyPath defines the path of the property to set in the target
  9985. * @param value defines the value to set in the property
  9986. * @param condition defines the trigger related conditions
  9987. */
  9988. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, condition?: Condition);
  9989. /** @hidden */
  9990. _prepare(): void;
  9991. /**
  9992. * Execute the action and set the targetted property to the desired value.
  9993. */
  9994. execute(): void;
  9995. /**
  9996. * Serializes the actions and its related information.
  9997. * @param parent defines the object to serialize in
  9998. * @returns the serialized object
  9999. */
  10000. serialize(parent: any): any;
  10001. }
  10002. /**
  10003. * This defines an action responsible to increment the target value
  10004. * to a desired value once triggered.
  10005. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10006. */
  10007. export class IncrementValueAction extends Action {
  10008. /**
  10009. * The path of the property to increment in the target.
  10010. */
  10011. propertyPath: string;
  10012. /**
  10013. * The value we should increment the property by.
  10014. */
  10015. value: any;
  10016. private _target;
  10017. private _effectiveTarget;
  10018. private _property;
  10019. /**
  10020. * Instantiate the action
  10021. * @param triggerOptions defines the trigger options
  10022. * @param target defines the object containing the property
  10023. * @param propertyPath defines the path of the property to increment in the target
  10024. * @param value defines the value value we should increment the property by
  10025. * @param condition defines the trigger related conditions
  10026. */
  10027. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, condition?: Condition);
  10028. /** @hidden */
  10029. _prepare(): void;
  10030. /**
  10031. * Execute the action and increment the target of the value amount.
  10032. */
  10033. execute(): void;
  10034. /**
  10035. * Serializes the actions and its related information.
  10036. * @param parent defines the object to serialize in
  10037. * @returns the serialized object
  10038. */
  10039. serialize(parent: any): any;
  10040. }
  10041. /**
  10042. * This defines an action responsible to start an animation once triggered.
  10043. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10044. */
  10045. export class PlayAnimationAction extends Action {
  10046. /**
  10047. * Where the animation should start (animation frame)
  10048. */
  10049. from: number;
  10050. /**
  10051. * Where the animation should stop (animation frame)
  10052. */
  10053. to: number;
  10054. /**
  10055. * Define if the animation should loop or stop after the first play.
  10056. */
  10057. loop?: boolean;
  10058. private _target;
  10059. /**
  10060. * Instantiate the action
  10061. * @param triggerOptions defines the trigger options
  10062. * @param target defines the target animation or animation name
  10063. * @param from defines from where the animation should start (animation frame)
  10064. * @param end defines where the animation should stop (animation frame)
  10065. * @param loop defines if the animation should loop or stop after the first play
  10066. * @param condition defines the trigger related conditions
  10067. */
  10068. constructor(triggerOptions: any, target: any, from: number, to: number, loop?: boolean, condition?: Condition);
  10069. /** @hidden */
  10070. _prepare(): void;
  10071. /**
  10072. * Execute the action and play the animation.
  10073. */
  10074. execute(): void;
  10075. /**
  10076. * Serializes the actions and its related information.
  10077. * @param parent defines the object to serialize in
  10078. * @returns the serialized object
  10079. */
  10080. serialize(parent: any): any;
  10081. }
  10082. /**
  10083. * This defines an action responsible to stop an animation once triggered.
  10084. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10085. */
  10086. export class StopAnimationAction extends Action {
  10087. private _target;
  10088. /**
  10089. * Instantiate the action
  10090. * @param triggerOptions defines the trigger options
  10091. * @param target defines the target animation or animation name
  10092. * @param condition defines the trigger related conditions
  10093. */
  10094. constructor(triggerOptions: any, target: any, condition?: Condition);
  10095. /** @hidden */
  10096. _prepare(): void;
  10097. /**
  10098. * Execute the action and stop the animation.
  10099. */
  10100. execute(): void;
  10101. /**
  10102. * Serializes the actions and its related information.
  10103. * @param parent defines the object to serialize in
  10104. * @returns the serialized object
  10105. */
  10106. serialize(parent: any): any;
  10107. }
  10108. /**
  10109. * This defines an action responsible that does nothing once triggered.
  10110. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10111. */
  10112. export class DoNothingAction extends Action {
  10113. /**
  10114. * Instantiate the action
  10115. * @param triggerOptions defines the trigger options
  10116. * @param condition defines the trigger related conditions
  10117. */
  10118. constructor(triggerOptions?: any, condition?: Condition);
  10119. /**
  10120. * Execute the action and do nothing.
  10121. */
  10122. execute(): void;
  10123. /**
  10124. * Serializes the actions and its related information.
  10125. * @param parent defines the object to serialize in
  10126. * @returns the serialized object
  10127. */
  10128. serialize(parent: any): any;
  10129. }
  10130. /**
  10131. * This defines an action responsible to trigger several actions once triggered.
  10132. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10133. */
  10134. export class CombineAction extends Action {
  10135. /**
  10136. * The list of aggregated animations to run.
  10137. */
  10138. children: Action[];
  10139. /**
  10140. * Instantiate the action
  10141. * @param triggerOptions defines the trigger options
  10142. * @param children defines the list of aggregated animations to run
  10143. * @param condition defines the trigger related conditions
  10144. */
  10145. constructor(triggerOptions: any, children: Action[], condition?: Condition);
  10146. /** @hidden */
  10147. _prepare(): void;
  10148. /**
  10149. * Execute the action and executes all the aggregated actions.
  10150. */
  10151. execute(evt: ActionEvent): void;
  10152. /**
  10153. * Serializes the actions and its related information.
  10154. * @param parent defines the object to serialize in
  10155. * @returns the serialized object
  10156. */
  10157. serialize(parent: any): any;
  10158. }
  10159. /**
  10160. * This defines an action responsible to run code (external event) once triggered.
  10161. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10162. */
  10163. export class ExecuteCodeAction extends Action {
  10164. /**
  10165. * The callback function to run.
  10166. */
  10167. func: (evt: ActionEvent) => void;
  10168. /**
  10169. * Instantiate the action
  10170. * @param triggerOptions defines the trigger options
  10171. * @param func defines the callback function to run
  10172. * @param condition defines the trigger related conditions
  10173. */
  10174. constructor(triggerOptions: any, func: (evt: ActionEvent) => void, condition?: Condition);
  10175. /**
  10176. * Execute the action and run the attached code.
  10177. */
  10178. execute(evt: ActionEvent): void;
  10179. }
  10180. /**
  10181. * This defines an action responsible to set the parent property of the target once triggered.
  10182. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10183. */
  10184. export class SetParentAction extends Action {
  10185. private _parent;
  10186. private _target;
  10187. /**
  10188. * Instantiate the action
  10189. * @param triggerOptions defines the trigger options
  10190. * @param target defines the target containing the parent property
  10191. * @param parent defines from where the animation should start (animation frame)
  10192. * @param condition defines the trigger related conditions
  10193. */
  10194. constructor(triggerOptions: any, target: any, parent: any, condition?: Condition);
  10195. /** @hidden */
  10196. _prepare(): void;
  10197. /**
  10198. * Execute the action and set the parent property.
  10199. */
  10200. execute(): void;
  10201. /**
  10202. * Serializes the actions and its related information.
  10203. * @param parent defines the object to serialize in
  10204. * @returns the serialized object
  10205. */
  10206. serialize(parent: any): any;
  10207. }
  10208. }
  10209. declare module "babylonjs/Actions/actionManager" {
  10210. import { Nullable } from "babylonjs/types";
  10211. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  10212. import { Scene } from "babylonjs/scene";
  10213. import { IAction } from "babylonjs/Actions/action";
  10214. import { IActionEvent } from "babylonjs/Actions/actionEvent";
  10215. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  10216. /**
  10217. * Action Manager manages all events to be triggered on a given mesh or the global scene.
  10218. * A single scene can have many Action Managers to handle predefined actions on specific meshes.
  10219. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10220. */
  10221. export class ActionManager extends AbstractActionManager {
  10222. /**
  10223. * Nothing
  10224. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10225. */
  10226. static readonly NothingTrigger: number;
  10227. /**
  10228. * On pick
  10229. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10230. */
  10231. static readonly OnPickTrigger: number;
  10232. /**
  10233. * On left pick
  10234. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10235. */
  10236. static readonly OnLeftPickTrigger: number;
  10237. /**
  10238. * On right pick
  10239. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10240. */
  10241. static readonly OnRightPickTrigger: number;
  10242. /**
  10243. * On center pick
  10244. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10245. */
  10246. static readonly OnCenterPickTrigger: number;
  10247. /**
  10248. * On pick down
  10249. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10250. */
  10251. static readonly OnPickDownTrigger: number;
  10252. /**
  10253. * On double pick
  10254. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10255. */
  10256. static readonly OnDoublePickTrigger: number;
  10257. /**
  10258. * On pick up
  10259. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10260. */
  10261. static readonly OnPickUpTrigger: number;
  10262. /**
  10263. * On pick out.
  10264. * This trigger will only be raised if you also declared a OnPickDown
  10265. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10266. */
  10267. static readonly OnPickOutTrigger: number;
  10268. /**
  10269. * On long press
  10270. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10271. */
  10272. static readonly OnLongPressTrigger: number;
  10273. /**
  10274. * On pointer over
  10275. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10276. */
  10277. static readonly OnPointerOverTrigger: number;
  10278. /**
  10279. * On pointer out
  10280. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10281. */
  10282. static readonly OnPointerOutTrigger: number;
  10283. /**
  10284. * On every frame
  10285. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10286. */
  10287. static readonly OnEveryFrameTrigger: number;
  10288. /**
  10289. * On intersection enter
  10290. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10291. */
  10292. static readonly OnIntersectionEnterTrigger: number;
  10293. /**
  10294. * On intersection exit
  10295. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10296. */
  10297. static readonly OnIntersectionExitTrigger: number;
  10298. /**
  10299. * On key down
  10300. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10301. */
  10302. static readonly OnKeyDownTrigger: number;
  10303. /**
  10304. * On key up
  10305. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10306. */
  10307. static readonly OnKeyUpTrigger: number;
  10308. private _scene;
  10309. /**
  10310. * Creates a new action manager
  10311. * @param scene defines the hosting scene
  10312. */
  10313. constructor(scene: Scene);
  10314. /**
  10315. * Releases all associated resources
  10316. */
  10317. dispose(): void;
  10318. /**
  10319. * Gets hosting scene
  10320. * @returns the hosting scene
  10321. */
  10322. getScene(): Scene;
  10323. /**
  10324. * Does this action manager handles actions of any of the given triggers
  10325. * @param triggers defines the triggers to be tested
  10326. * @return a boolean indicating whether one (or more) of the triggers is handled
  10327. */
  10328. hasSpecificTriggers(triggers: number[]): boolean;
  10329. /**
  10330. * Does this action manager handles actions of any of the given triggers. This function takes two arguments for
  10331. * speed.
  10332. * @param triggerA defines the trigger to be tested
  10333. * @param triggerB defines the trigger to be tested
  10334. * @return a boolean indicating whether one (or more) of the triggers is handled
  10335. */
  10336. hasSpecificTriggers2(triggerA: number, triggerB: number): boolean;
  10337. /**
  10338. * Does this action manager handles actions of a given trigger
  10339. * @param trigger defines the trigger to be tested
  10340. * @param parameterPredicate defines an optional predicate to filter triggers by parameter
  10341. * @return whether the trigger is handled
  10342. */
  10343. hasSpecificTrigger(trigger: number, parameterPredicate?: (parameter: any) => boolean): boolean;
  10344. /**
  10345. * Does this action manager has pointer triggers
  10346. */
  10347. get hasPointerTriggers(): boolean;
  10348. /**
  10349. * Does this action manager has pick triggers
  10350. */
  10351. get hasPickTriggers(): boolean;
  10352. /**
  10353. * Registers an action to this action manager
  10354. * @param action defines the action to be registered
  10355. * @return the action amended (prepared) after registration
  10356. */
  10357. registerAction(action: IAction): Nullable<IAction>;
  10358. /**
  10359. * Unregisters an action to this action manager
  10360. * @param action defines the action to be unregistered
  10361. * @return a boolean indicating whether the action has been unregistered
  10362. */
  10363. unregisterAction(action: IAction): Boolean;
  10364. /**
  10365. * Process a specific trigger
  10366. * @param trigger defines the trigger to process
  10367. * @param evt defines the event details to be processed
  10368. */
  10369. processTrigger(trigger: number, evt?: IActionEvent): void;
  10370. /** @hidden */
  10371. _getEffectiveTarget(target: any, propertyPath: string): any;
  10372. /** @hidden */
  10373. _getProperty(propertyPath: string): string;
  10374. /**
  10375. * Serialize this manager to a JSON object
  10376. * @param name defines the property name to store this manager
  10377. * @returns a JSON representation of this manager
  10378. */
  10379. serialize(name: string): any;
  10380. /**
  10381. * Creates a new ActionManager from a JSON data
  10382. * @param parsedActions defines the JSON data to read from
  10383. * @param object defines the hosting mesh
  10384. * @param scene defines the hosting scene
  10385. */
  10386. static Parse(parsedActions: any, object: Nullable<AbstractMesh>, scene: Scene): void;
  10387. /**
  10388. * Get a trigger name by index
  10389. * @param trigger defines the trigger index
  10390. * @returns a trigger name
  10391. */
  10392. static GetTriggerName(trigger: number): string;
  10393. }
  10394. }
  10395. declare module "babylonjs/Sprites/sprite" {
  10396. import { Vector3 } from "babylonjs/Maths/math.vector";
  10397. import { Nullable } from "babylonjs/types";
  10398. import { ActionManager } from "babylonjs/Actions/actionManager";
  10399. import { ISpriteManager, SpriteManager } from "babylonjs/Sprites/spriteManager";
  10400. import { Color4 } from "babylonjs/Maths/math.color";
  10401. import { Observable } from "babylonjs/Misc/observable";
  10402. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  10403. import { Animation } from "babylonjs/Animations/animation";
  10404. /**
  10405. * Class used to represent a sprite
  10406. * @see https://doc.babylonjs.com/babylon101/sprites
  10407. */
  10408. export class Sprite implements IAnimatable {
  10409. /** defines the name */
  10410. name: string;
  10411. /** Gets or sets the current world position */
  10412. position: Vector3;
  10413. /** Gets or sets the main color */
  10414. color: Color4;
  10415. /** Gets or sets the width */
  10416. width: number;
  10417. /** Gets or sets the height */
  10418. height: number;
  10419. /** Gets or sets rotation angle */
  10420. angle: number;
  10421. /** Gets or sets the cell index in the sprite sheet */
  10422. cellIndex: number;
  10423. /** Gets or sets the cell reference in the sprite sheet, uses sprite's filename when added to sprite sheet */
  10424. cellRef: string;
  10425. /** Gets or sets a boolean indicating if UV coordinates should be inverted in U axis */
  10426. invertU: boolean;
  10427. /** Gets or sets a boolean indicating if UV coordinates should be inverted in B axis */
  10428. invertV: boolean;
  10429. /** Gets or sets a boolean indicating that this sprite should be disposed after animation ends */
  10430. disposeWhenFinishedAnimating: boolean;
  10431. /** Gets the list of attached animations */
  10432. animations: Nullable<Array<Animation>>;
  10433. /** Gets or sets a boolean indicating if the sprite can be picked */
  10434. isPickable: boolean;
  10435. /** Gets or sets a boolean indicating that sprite texture alpha will be used for precise picking (false by default) */
  10436. useAlphaForPicking: boolean;
  10437. /** @hidden */
  10438. _xOffset: number;
  10439. /** @hidden */
  10440. _yOffset: number;
  10441. /** @hidden */
  10442. _xSize: number;
  10443. /** @hidden */
  10444. _ySize: number;
  10445. /**
  10446. * Gets or sets the associated action manager
  10447. */
  10448. actionManager: Nullable<ActionManager>;
  10449. /**
  10450. * An event triggered when the control has been disposed
  10451. */
  10452. onDisposeObservable: Observable<Sprite>;
  10453. private _animationStarted;
  10454. private _loopAnimation;
  10455. private _fromIndex;
  10456. private _toIndex;
  10457. private _delay;
  10458. private _direction;
  10459. private _manager;
  10460. private _time;
  10461. private _onAnimationEnd;
  10462. /**
  10463. * Gets or sets a boolean indicating if the sprite is visible (renderable). Default is true
  10464. */
  10465. isVisible: boolean;
  10466. /**
  10467. * Gets or sets the sprite size
  10468. */
  10469. get size(): number;
  10470. set size(value: number);
  10471. /**
  10472. * Returns a boolean indicating if the animation is started
  10473. */
  10474. get animationStarted(): boolean;
  10475. /**
  10476. * Gets or sets the unique id of the sprite
  10477. */
  10478. uniqueId: number;
  10479. /**
  10480. * Gets the manager of this sprite
  10481. */
  10482. get manager(): ISpriteManager;
  10483. /**
  10484. * Creates a new Sprite
  10485. * @param name defines the name
  10486. * @param manager defines the manager
  10487. */
  10488. constructor(
  10489. /** defines the name */
  10490. name: string, manager: ISpriteManager);
  10491. /**
  10492. * Returns the string "Sprite"
  10493. * @returns "Sprite"
  10494. */
  10495. getClassName(): string;
  10496. /** Gets or sets the initial key for the animation (setting it will restart the animation) */
  10497. get fromIndex(): number;
  10498. set fromIndex(value: number);
  10499. /** Gets or sets the end key for the animation (setting it will restart the animation) */
  10500. get toIndex(): number;
  10501. set toIndex(value: number);
  10502. /** Gets or sets a boolean indicating if the animation is looping (setting it will restart the animation) */
  10503. get loopAnimation(): boolean;
  10504. set loopAnimation(value: boolean);
  10505. /** Gets or sets the delay between cell changes (setting it will restart the animation) */
  10506. get delay(): number;
  10507. set delay(value: number);
  10508. /**
  10509. * Starts an animation
  10510. * @param from defines the initial key
  10511. * @param to defines the end key
  10512. * @param loop defines if the animation must loop
  10513. * @param delay defines the start delay (in ms)
  10514. * @param onAnimationEnd defines a callback to call when animation ends
  10515. */
  10516. playAnimation(from: number, to: number, loop: boolean, delay: number, onAnimationEnd?: Nullable<() => void>): void;
  10517. /** Stops current animation (if any) */
  10518. stopAnimation(): void;
  10519. /** @hidden */
  10520. _animate(deltaTime: number): void;
  10521. /** Release associated resources */
  10522. dispose(): void;
  10523. /**
  10524. * Serializes the sprite to a JSON object
  10525. * @returns the JSON object
  10526. */
  10527. serialize(): any;
  10528. /**
  10529. * Parses a JSON object to create a new sprite
  10530. * @param parsedSprite The JSON object to parse
  10531. * @param manager defines the hosting manager
  10532. * @returns the new sprite
  10533. */
  10534. static Parse(parsedSprite: any, manager: SpriteManager): Sprite;
  10535. }
  10536. }
  10537. declare module "babylonjs/Collisions/pickingInfo" {
  10538. import { Nullable } from "babylonjs/types";
  10539. import { Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  10540. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  10541. import { Sprite } from "babylonjs/Sprites/sprite";
  10542. import { Ray } from "babylonjs/Culling/ray";
  10543. /**
  10544. * Information about the result of picking within a scene
  10545. * @see https://doc.babylonjs.com/babylon101/picking_collisions
  10546. */
  10547. export class PickingInfo {
  10548. /** @hidden */
  10549. _pickingUnavailable: boolean;
  10550. /**
  10551. * If the pick collided with an object
  10552. */
  10553. hit: boolean;
  10554. /**
  10555. * Distance away where the pick collided
  10556. */
  10557. distance: number;
  10558. /**
  10559. * The location of pick collision
  10560. */
  10561. pickedPoint: Nullable<Vector3>;
  10562. /**
  10563. * The mesh corresponding the the pick collision
  10564. */
  10565. pickedMesh: Nullable<AbstractMesh>;
  10566. /** (See getTextureCoordinates) The barycentric U coordinate that is used when calculating the texture coordinates of the collision.*/
  10567. bu: number;
  10568. /** (See getTextureCoordinates) The barycentric V coordinate that is used when calculating the texture coordinates of the collision.*/
  10569. bv: number;
  10570. /** The index of the face on the mesh that was picked, or the index of the Line if the picked Mesh is a LinesMesh */
  10571. faceId: number;
  10572. /** The index of the face on the subMesh that was picked, or the index of the Line if the picked Mesh is a LinesMesh */
  10573. subMeshFaceId: number;
  10574. /** Id of the the submesh that was picked */
  10575. subMeshId: number;
  10576. /** If a sprite was picked, this will be the sprite the pick collided with */
  10577. pickedSprite: Nullable<Sprite>;
  10578. /** If we are pikcing a mesh with thin instance, this will give you the picked thin instance */
  10579. thinInstanceIndex: number;
  10580. /**
  10581. * If a mesh was used to do the picking (eg. 6dof controller) this will be populated.
  10582. */
  10583. originMesh: Nullable<AbstractMesh>;
  10584. /**
  10585. * The ray that was used to perform the picking.
  10586. */
  10587. ray: Nullable<Ray>;
  10588. /**
  10589. * Gets the normal correspodning to the face the pick collided with
  10590. * @param useWorldCoordinates If the resulting normal should be relative to the world (default: false)
  10591. * @param useVerticesNormals If the vertices normals should be used to calculate the normal instead of the normal map
  10592. * @returns The normal correspodning to the face the pick collided with
  10593. */
  10594. getNormal(useWorldCoordinates?: boolean, useVerticesNormals?: boolean): Nullable<Vector3>;
  10595. /**
  10596. * Gets the texture coordinates of where the pick occured
  10597. * @returns the vector containing the coordnates of the texture
  10598. */
  10599. getTextureCoordinates(): Nullable<Vector2>;
  10600. }
  10601. }
  10602. declare module "babylonjs/Culling/ray" {
  10603. import { DeepImmutable, Nullable, float } from "babylonjs/types";
  10604. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  10605. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  10606. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  10607. import { IntersectionInfo } from "babylonjs/Collisions/intersectionInfo";
  10608. import { BoundingBox } from "babylonjs/Culling/boundingBox";
  10609. import { BoundingSphere } from "babylonjs/Culling/boundingSphere";
  10610. import { Plane } from "babylonjs/Maths/math.plane";
  10611. /**
  10612. * Class representing a ray with position and direction
  10613. */
  10614. export class Ray {
  10615. /** origin point */
  10616. origin: Vector3;
  10617. /** direction */
  10618. direction: Vector3;
  10619. /** length of the ray */
  10620. length: number;
  10621. private static readonly _TmpVector3;
  10622. private _tmpRay;
  10623. /**
  10624. * Creates a new ray
  10625. * @param origin origin point
  10626. * @param direction direction
  10627. * @param length length of the ray
  10628. */
  10629. constructor(
  10630. /** origin point */
  10631. origin: Vector3,
  10632. /** direction */
  10633. direction: Vector3,
  10634. /** length of the ray */
  10635. length?: number);
  10636. /**
  10637. * Checks if the ray intersects a box
  10638. * This does not account for the ray lenght by design to improve perfs.
  10639. * @param minimum bound of the box
  10640. * @param maximum bound of the box
  10641. * @param intersectionTreshold extra extend to be added to the box in all direction
  10642. * @returns if the box was hit
  10643. */
  10644. intersectsBoxMinMax(minimum: DeepImmutable<Vector3>, maximum: DeepImmutable<Vector3>, intersectionTreshold?: number): boolean;
  10645. /**
  10646. * Checks if the ray intersects a box
  10647. * This does not account for the ray lenght by design to improve perfs.
  10648. * @param box the bounding box to check
  10649. * @param intersectionTreshold extra extend to be added to the BoundingBox in all direction
  10650. * @returns if the box was hit
  10651. */
  10652. intersectsBox(box: DeepImmutable<BoundingBox>, intersectionTreshold?: number): boolean;
  10653. /**
  10654. * If the ray hits a sphere
  10655. * @param sphere the bounding sphere to check
  10656. * @param intersectionTreshold extra extend to be added to the BoundingSphere in all direction
  10657. * @returns true if it hits the sphere
  10658. */
  10659. intersectsSphere(sphere: DeepImmutable<BoundingSphere>, intersectionTreshold?: number): boolean;
  10660. /**
  10661. * If the ray hits a triange
  10662. * @param vertex0 triangle vertex
  10663. * @param vertex1 triangle vertex
  10664. * @param vertex2 triangle vertex
  10665. * @returns intersection information if hit
  10666. */
  10667. intersectsTriangle(vertex0: DeepImmutable<Vector3>, vertex1: DeepImmutable<Vector3>, vertex2: DeepImmutable<Vector3>): Nullable<IntersectionInfo>;
  10668. /**
  10669. * Checks if ray intersects a plane
  10670. * @param plane the plane to check
  10671. * @returns the distance away it was hit
  10672. */
  10673. intersectsPlane(plane: DeepImmutable<Plane>): Nullable<number>;
  10674. /**
  10675. * Calculate the intercept of a ray on a given axis
  10676. * @param axis to check 'x' | 'y' | 'z'
  10677. * @param offset from axis interception (i.e. an offset of 1y is intercepted above ground)
  10678. * @returns a vector containing the coordinates where 'axis' is equal to zero (else offset), or null if there is no intercept.
  10679. */
  10680. intersectsAxis(axis: string, offset?: number): Nullable<Vector3>;
  10681. /**
  10682. * Checks if ray intersects a mesh
  10683. * @param mesh the mesh to check
  10684. * @param fastCheck defines if the first intersection will be used (and not the closest)
  10685. * @returns picking info of the intersecton
  10686. */
  10687. intersectsMesh(mesh: DeepImmutable<AbstractMesh>, fastCheck?: boolean): PickingInfo;
  10688. /**
  10689. * Checks if ray intersects a mesh
  10690. * @param meshes the meshes to check
  10691. * @param fastCheck defines if the first intersection will be used (and not the closest)
  10692. * @param results array to store result in
  10693. * @returns Array of picking infos
  10694. */
  10695. intersectsMeshes(meshes: Array<DeepImmutable<AbstractMesh>>, fastCheck?: boolean, results?: Array<PickingInfo>): Array<PickingInfo>;
  10696. private _comparePickingInfo;
  10697. private static smallnum;
  10698. private static rayl;
  10699. /**
  10700. * Intersection test between the ray and a given segment whithin a given tolerance (threshold)
  10701. * @param sega the first point of the segment to test the intersection against
  10702. * @param segb the second point of the segment to test the intersection against
  10703. * @param threshold the tolerance margin, if the ray doesn't intersect the segment but is close to the given threshold, the intersection is successful
  10704. * @return the distance from the ray origin to the intersection point if there's intersection, or -1 if there's no intersection
  10705. */
  10706. intersectionSegment(sega: DeepImmutable<Vector3>, segb: DeepImmutable<Vector3>, threshold: number): number;
  10707. /**
  10708. * Update the ray from viewport position
  10709. * @param x position
  10710. * @param y y position
  10711. * @param viewportWidth viewport width
  10712. * @param viewportHeight viewport height
  10713. * @param world world matrix
  10714. * @param view view matrix
  10715. * @param projection projection matrix
  10716. * @returns this ray updated
  10717. */
  10718. update(x: number, y: number, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Ray;
  10719. /**
  10720. * Creates a ray with origin and direction of 0,0,0
  10721. * @returns the new ray
  10722. */
  10723. static Zero(): Ray;
  10724. /**
  10725. * Creates a new ray from screen space and viewport
  10726. * @param x position
  10727. * @param y y position
  10728. * @param viewportWidth viewport width
  10729. * @param viewportHeight viewport height
  10730. * @param world world matrix
  10731. * @param view view matrix
  10732. * @param projection projection matrix
  10733. * @returns new ray
  10734. */
  10735. static CreateNew(x: number, y: number, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Ray;
  10736. /**
  10737. * Function will create a new transformed ray starting from origin and ending at the end point. Ray's length will be set, and ray will be
  10738. * transformed to the given world matrix.
  10739. * @param origin The origin point
  10740. * @param end The end point
  10741. * @param world a matrix to transform the ray to. Default is the identity matrix.
  10742. * @returns the new ray
  10743. */
  10744. static CreateNewFromTo(origin: Vector3, end: Vector3, world?: DeepImmutable<Matrix>): Ray;
  10745. /**
  10746. * Transforms a ray by a matrix
  10747. * @param ray ray to transform
  10748. * @param matrix matrix to apply
  10749. * @returns the resulting new ray
  10750. */
  10751. static Transform(ray: DeepImmutable<Ray>, matrix: DeepImmutable<Matrix>): Ray;
  10752. /**
  10753. * Transforms a ray by a matrix
  10754. * @param ray ray to transform
  10755. * @param matrix matrix to apply
  10756. * @param result ray to store result in
  10757. */
  10758. static TransformToRef(ray: DeepImmutable<Ray>, matrix: DeepImmutable<Matrix>, result: Ray): void;
  10759. /**
  10760. * Unproject a ray from screen space to object space
  10761. * @param sourceX defines the screen space x coordinate to use
  10762. * @param sourceY defines the screen space y coordinate to use
  10763. * @param viewportWidth defines the current width of the viewport
  10764. * @param viewportHeight defines the current height of the viewport
  10765. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  10766. * @param view defines the view matrix to use
  10767. * @param projection defines the projection matrix to use
  10768. */
  10769. unprojectRayToRef(sourceX: float, sourceY: float, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): void;
  10770. }
  10771. /**
  10772. * Type used to define predicate used to select faces when a mesh intersection is detected
  10773. */
  10774. export type TrianglePickingPredicate = (p0: Vector3, p1: Vector3, p2: Vector3, ray: Ray) => boolean;
  10775. module "babylonjs/scene" {
  10776. interface Scene {
  10777. /** @hidden */
  10778. _tempPickingRay: Nullable<Ray>;
  10779. /** @hidden */
  10780. _cachedRayForTransform: Ray;
  10781. /** @hidden */
  10782. _pickWithRayInverseMatrix: Matrix;
  10783. /** @hidden */
  10784. _internalPick(rayFunction: (world: Matrix) => Ray, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, onlyBoundingInfo?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  10785. /** @hidden */
  10786. _internalMultiPick(rayFunction: (world: Matrix) => Ray, predicate?: (mesh: AbstractMesh) => boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  10787. /** @hidden */
  10788. _internalPickForMesh(pickingInfo: Nullable<PickingInfo>, rayFunction: (world: Matrix) => Ray, mesh: AbstractMesh, world: Matrix, fastCheck?: boolean, onlyBoundingInfo?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  10789. }
  10790. }
  10791. }
  10792. declare module "babylonjs/sceneComponent" {
  10793. import { Scene } from "babylonjs/scene";
  10794. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  10795. import { SubMesh } from "babylonjs/Meshes/subMesh";
  10796. import { _InstancesBatch } from "babylonjs/Meshes/mesh";
  10797. import { SmartArrayNoDuplicate } from "babylonjs/Misc/smartArray";
  10798. import { Nullable } from "babylonjs/types";
  10799. import { Camera } from "babylonjs/Cameras/camera";
  10800. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  10801. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  10802. import { AbstractScene } from "babylonjs/abstractScene";
  10803. import { Mesh } from "babylonjs/Meshes/mesh";
  10804. /**
  10805. * Groups all the scene component constants in one place to ease maintenance.
  10806. * @hidden
  10807. */
  10808. export class SceneComponentConstants {
  10809. static readonly NAME_EFFECTLAYER: string;
  10810. static readonly NAME_LAYER: string;
  10811. static readonly NAME_LENSFLARESYSTEM: string;
  10812. static readonly NAME_BOUNDINGBOXRENDERER: string;
  10813. static readonly NAME_PARTICLESYSTEM: string;
  10814. static readonly NAME_GAMEPAD: string;
  10815. static readonly NAME_SIMPLIFICATIONQUEUE: string;
  10816. static readonly NAME_GEOMETRYBUFFERRENDERER: string;
  10817. static readonly NAME_PREPASSRENDERER: string;
  10818. static readonly NAME_DEPTHRENDERER: string;
  10819. static readonly NAME_POSTPROCESSRENDERPIPELINEMANAGER: string;
  10820. static readonly NAME_SPRITE: string;
  10821. static readonly NAME_OUTLINERENDERER: string;
  10822. static readonly NAME_PROCEDURALTEXTURE: string;
  10823. static readonly NAME_SHADOWGENERATOR: string;
  10824. static readonly NAME_OCTREE: string;
  10825. static readonly NAME_PHYSICSENGINE: string;
  10826. static readonly NAME_AUDIO: string;
  10827. static readonly STEP_ISREADYFORMESH_EFFECTLAYER: number;
  10828. static readonly STEP_BEFOREEVALUATEACTIVEMESH_BOUNDINGBOXRENDERER: number;
  10829. static readonly STEP_EVALUATESUBMESH_BOUNDINGBOXRENDERER: number;
  10830. static readonly STEP_ACTIVEMESH_BOUNDINGBOXRENDERER: number;
  10831. static readonly STEP_CAMERADRAWRENDERTARGET_EFFECTLAYER: number;
  10832. static readonly STEP_BEFORECAMERADRAW_EFFECTLAYER: number;
  10833. static readonly STEP_BEFORECAMERADRAW_LAYER: number;
  10834. static readonly STEP_BEFORECAMERADRAW_PREPASS: number;
  10835. static readonly STEP_BEFORERENDERTARGETDRAW_LAYER: number;
  10836. static readonly STEP_BEFORERENDERINGMESH_OUTLINE: number;
  10837. static readonly STEP_AFTERRENDERINGMESH_OUTLINE: number;
  10838. static readonly STEP_AFTERRENDERINGGROUPDRAW_EFFECTLAYER_DRAW: number;
  10839. static readonly STEP_AFTERRENDERINGGROUPDRAW_BOUNDINGBOXRENDERER: number;
  10840. static readonly STEP_BEFORECAMERAUPDATE_SIMPLIFICATIONQUEUE: number;
  10841. static readonly STEP_BEFORECAMERAUPDATE_GAMEPAD: number;
  10842. static readonly STEP_BEFORECLEAR_PROCEDURALTEXTURE: number;
  10843. static readonly STEP_AFTERRENDERTARGETDRAW_LAYER: number;
  10844. static readonly STEP_AFTERCAMERADRAW_EFFECTLAYER: number;
  10845. static readonly STEP_AFTERCAMERADRAW_LENSFLARESYSTEM: number;
  10846. static readonly STEP_AFTERCAMERADRAW_EFFECTLAYER_DRAW: number;
  10847. static readonly STEP_AFTERCAMERADRAW_LAYER: number;
  10848. static readonly STEP_AFTERCAMERADRAW_PREPASS: number;
  10849. static readonly STEP_AFTERRENDER_AUDIO: number;
  10850. static readonly STEP_GATHERRENDERTARGETS_DEPTHRENDERER: number;
  10851. static readonly STEP_GATHERRENDERTARGETS_GEOMETRYBUFFERRENDERER: number;
  10852. static readonly STEP_GATHERRENDERTARGETS_SHADOWGENERATOR: number;
  10853. static readonly STEP_GATHERRENDERTARGETS_POSTPROCESSRENDERPIPELINEMANAGER: number;
  10854. static readonly STEP_GATHERACTIVECAMERARENDERTARGETS_DEPTHRENDERER: number;
  10855. static readonly STEP_BEFORECLEARSTAGE_PREPASS: number;
  10856. static readonly STEP_POINTERMOVE_SPRITE: number;
  10857. static readonly STEP_POINTERDOWN_SPRITE: number;
  10858. static readonly STEP_POINTERUP_SPRITE: number;
  10859. }
  10860. /**
  10861. * This represents a scene component.
  10862. *
  10863. * This is used to decouple the dependency the scene is having on the different workloads like
  10864. * layers, post processes...
  10865. */
  10866. export interface ISceneComponent {
  10867. /**
  10868. * The name of the component. Each component must have a unique name.
  10869. */
  10870. name: string;
  10871. /**
  10872. * The scene the component belongs to.
  10873. */
  10874. scene: Scene;
  10875. /**
  10876. * Register the component to one instance of a scene.
  10877. */
  10878. register(): void;
  10879. /**
  10880. * Rebuilds the elements related to this component in case of
  10881. * context lost for instance.
  10882. */
  10883. rebuild(): void;
  10884. /**
  10885. * Disposes the component and the associated ressources.
  10886. */
  10887. dispose(): void;
  10888. }
  10889. /**
  10890. * This represents a SERIALIZABLE scene component.
  10891. *
  10892. * This extends Scene Component to add Serialization methods on top.
  10893. */
  10894. export interface ISceneSerializableComponent extends ISceneComponent {
  10895. /**
  10896. * Adds all the elements from the container to the scene
  10897. * @param container the container holding the elements
  10898. */
  10899. addFromContainer(container: AbstractScene): void;
  10900. /**
  10901. * Removes all the elements in the container from the scene
  10902. * @param container contains the elements to remove
  10903. * @param dispose if the removed element should be disposed (default: false)
  10904. */
  10905. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  10906. /**
  10907. * Serializes the component data to the specified json object
  10908. * @param serializationObject The object to serialize to
  10909. */
  10910. serialize(serializationObject: any): void;
  10911. }
  10912. /**
  10913. * Strong typing of a Mesh related stage step action
  10914. */
  10915. export type MeshStageAction = (mesh: AbstractMesh, hardwareInstancedRendering: boolean) => boolean;
  10916. /**
  10917. * Strong typing of a Evaluate Sub Mesh related stage step action
  10918. */
  10919. export type EvaluateSubMeshStageAction = (mesh: AbstractMesh, subMesh: SubMesh) => void;
  10920. /**
  10921. * Strong typing of a Active Mesh related stage step action
  10922. */
  10923. export type ActiveMeshStageAction = (sourceMesh: AbstractMesh, mesh: AbstractMesh) => void;
  10924. /**
  10925. * Strong typing of a Camera related stage step action
  10926. */
  10927. export type CameraStageAction = (camera: Camera) => void;
  10928. /**
  10929. * Strong typing of a Camera Frame buffer related stage step action
  10930. */
  10931. export type CameraStageFrameBufferAction = (camera: Camera) => boolean;
  10932. /**
  10933. * Strong typing of a Render Target related stage step action
  10934. */
  10935. export type RenderTargetStageAction = (renderTarget: RenderTargetTexture) => void;
  10936. /**
  10937. * Strong typing of a RenderingGroup related stage step action
  10938. */
  10939. export type RenderingGroupStageAction = (renderingGroupId: number) => void;
  10940. /**
  10941. * Strong typing of a Mesh Render related stage step action
  10942. */
  10943. export type RenderingMeshStageAction = (mesh: Mesh, subMesh: SubMesh, batch: _InstancesBatch) => void;
  10944. /**
  10945. * Strong typing of a simple stage step action
  10946. */
  10947. export type SimpleStageAction = () => void;
  10948. /**
  10949. * Strong typing of a render target action.
  10950. */
  10951. export type RenderTargetsStageAction = (renderTargets: SmartArrayNoDuplicate<RenderTargetTexture>) => void;
  10952. /**
  10953. * Strong typing of a pointer move action.
  10954. */
  10955. export type PointerMoveStageAction = (unTranslatedPointerX: number, unTranslatedPointerY: number, pickResult: Nullable<PickingInfo>, isMeshPicked: boolean, element: HTMLElement) => Nullable<PickingInfo>;
  10956. /**
  10957. * Strong typing of a pointer up/down action.
  10958. */
  10959. export type PointerUpDownStageAction = (unTranslatedPointerX: number, unTranslatedPointerY: number, pickResult: Nullable<PickingInfo>, evt: PointerEvent) => Nullable<PickingInfo>;
  10960. /**
  10961. * Representation of a stage in the scene (Basically a list of ordered steps)
  10962. * @hidden
  10963. */
  10964. export class Stage<T extends Function> extends Array<{
  10965. index: number;
  10966. component: ISceneComponent;
  10967. action: T;
  10968. }> {
  10969. /**
  10970. * Hide ctor from the rest of the world.
  10971. * @param items The items to add.
  10972. */
  10973. private constructor();
  10974. /**
  10975. * Creates a new Stage.
  10976. * @returns A new instance of a Stage
  10977. */
  10978. static Create<T extends Function>(): Stage<T>;
  10979. /**
  10980. * Registers a step in an ordered way in the targeted stage.
  10981. * @param index Defines the position to register the step in
  10982. * @param component Defines the component attached to the step
  10983. * @param action Defines the action to launch during the step
  10984. */
  10985. registerStep(index: number, component: ISceneComponent, action: T): void;
  10986. /**
  10987. * Clears all the steps from the stage.
  10988. */
  10989. clear(): void;
  10990. }
  10991. }
  10992. declare module "babylonjs/Sprites/spriteSceneComponent" {
  10993. import { Nullable } from "babylonjs/types";
  10994. import { Observable } from "babylonjs/Misc/observable";
  10995. import { Scene } from "babylonjs/scene";
  10996. import { Sprite } from "babylonjs/Sprites/sprite";
  10997. import { ISpriteManager } from "babylonjs/Sprites/spriteManager";
  10998. import { Ray } from "babylonjs/Culling/ray";
  10999. import { Camera } from "babylonjs/Cameras/camera";
  11000. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  11001. import { ISceneComponent } from "babylonjs/sceneComponent";
  11002. module "babylonjs/scene" {
  11003. interface Scene {
  11004. /** @hidden */
  11005. _pointerOverSprite: Nullable<Sprite>;
  11006. /** @hidden */
  11007. _pickedDownSprite: Nullable<Sprite>;
  11008. /** @hidden */
  11009. _tempSpritePickingRay: Nullable<Ray>;
  11010. /**
  11011. * All of the sprite managers added to this scene
  11012. * @see https://doc.babylonjs.com/babylon101/sprites
  11013. */
  11014. spriteManagers: Array<ISpriteManager>;
  11015. /**
  11016. * An event triggered when sprites rendering is about to start
  11017. * Note: This event can be trigger more than once per frame (because sprites can be rendered by render target textures as well)
  11018. */
  11019. onBeforeSpritesRenderingObservable: Observable<Scene>;
  11020. /**
  11021. * An event triggered when sprites rendering is done
  11022. * Note: This event can be trigger more than once per frame (because sprites can be rendered by render target textures as well)
  11023. */
  11024. onAfterSpritesRenderingObservable: Observable<Scene>;
  11025. /** @hidden */
  11026. _internalPickSprites(ray: Ray, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  11027. /** Launch a ray to try to pick a sprite in the scene
  11028. * @param x position on screen
  11029. * @param y position on screen
  11030. * @param predicate Predicate function used to determine eligible sprites. Can be set to null. In this case, a sprite must have isPickable set to true
  11031. * @param fastCheck defines if the first intersection will be used (and not the closest)
  11032. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  11033. * @returns a PickingInfo
  11034. */
  11035. pickSprite(x: number, y: number, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  11036. /** Use the given ray to pick a sprite in the scene
  11037. * @param ray The ray (in world space) to use to pick meshes
  11038. * @param predicate Predicate function used to determine eligible sprites. Can be set to null. In this case, a sprite must have isPickable set to true
  11039. * @param fastCheck defines if the first intersection will be used (and not the closest)
  11040. * @param camera camera to use. Can be set to null. In this case, the scene.activeCamera will be used
  11041. * @returns a PickingInfo
  11042. */
  11043. pickSpriteWithRay(ray: Ray, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  11044. /** @hidden */
  11045. _internalMultiPickSprites(ray: Ray, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  11046. /** Launch a ray to try to pick sprites in the scene
  11047. * @param x position on screen
  11048. * @param y position on screen
  11049. * @param predicate Predicate function used to determine eligible sprites. Can be set to null. In this case, a sprite must have isPickable set to true
  11050. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  11051. * @returns a PickingInfo array
  11052. */
  11053. multiPickSprite(x: number, y: number, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  11054. /** Use the given ray to pick sprites in the scene
  11055. * @param ray The ray (in world space) to use to pick meshes
  11056. * @param predicate Predicate function used to determine eligible sprites. Can be set to null. In this case, a sprite must have isPickable set to true
  11057. * @param camera camera to use. Can be set to null. In this case, the scene.activeCamera will be used
  11058. * @returns a PickingInfo array
  11059. */
  11060. multiPickSpriteWithRay(ray: Ray, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  11061. /**
  11062. * Force the sprite under the pointer
  11063. * @param sprite defines the sprite to use
  11064. */
  11065. setPointerOverSprite(sprite: Nullable<Sprite>): void;
  11066. /**
  11067. * Gets the sprite under the pointer
  11068. * @returns a Sprite or null if no sprite is under the pointer
  11069. */
  11070. getPointerOverSprite(): Nullable<Sprite>;
  11071. }
  11072. }
  11073. /**
  11074. * Defines the sprite scene component responsible to manage sprites
  11075. * in a given scene.
  11076. */
  11077. export class SpriteSceneComponent implements ISceneComponent {
  11078. /**
  11079. * The component name helpfull to identify the component in the list of scene components.
  11080. */
  11081. readonly name: string;
  11082. /**
  11083. * The scene the component belongs to.
  11084. */
  11085. scene: Scene;
  11086. /** @hidden */
  11087. private _spritePredicate;
  11088. /**
  11089. * Creates a new instance of the component for the given scene
  11090. * @param scene Defines the scene to register the component in
  11091. */
  11092. constructor(scene: Scene);
  11093. /**
  11094. * Registers the component in a given scene
  11095. */
  11096. register(): void;
  11097. /**
  11098. * Rebuilds the elements related to this component in case of
  11099. * context lost for instance.
  11100. */
  11101. rebuild(): void;
  11102. /**
  11103. * Disposes the component and the associated ressources.
  11104. */
  11105. dispose(): void;
  11106. private _pickSpriteButKeepRay;
  11107. private _pointerMove;
  11108. private _pointerDown;
  11109. private _pointerUp;
  11110. }
  11111. }
  11112. declare module "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration" {
  11113. /** @hidden */
  11114. export var fogFragmentDeclaration: {
  11115. name: string;
  11116. shader: string;
  11117. };
  11118. }
  11119. declare module "babylonjs/Shaders/ShadersInclude/fogFragment" {
  11120. /** @hidden */
  11121. export var fogFragment: {
  11122. name: string;
  11123. shader: string;
  11124. };
  11125. }
  11126. declare module "babylonjs/Shaders/sprites.fragment" {
  11127. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  11128. import "babylonjs/Shaders/ShadersInclude/fogFragment";
  11129. /** @hidden */
  11130. export var spritesPixelShader: {
  11131. name: string;
  11132. shader: string;
  11133. };
  11134. }
  11135. declare module "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration" {
  11136. /** @hidden */
  11137. export var fogVertexDeclaration: {
  11138. name: string;
  11139. shader: string;
  11140. };
  11141. }
  11142. declare module "babylonjs/Shaders/sprites.vertex" {
  11143. import "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration";
  11144. /** @hidden */
  11145. export var spritesVertexShader: {
  11146. name: string;
  11147. shader: string;
  11148. };
  11149. }
  11150. declare module "babylonjs/Sprites/spriteManager" {
  11151. import { IDisposable, Scene } from "babylonjs/scene";
  11152. import { Nullable } from "babylonjs/types";
  11153. import { Observable } from "babylonjs/Misc/observable";
  11154. import { Sprite } from "babylonjs/Sprites/sprite";
  11155. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  11156. import { Camera } from "babylonjs/Cameras/camera";
  11157. import { Texture } from "babylonjs/Materials/Textures/texture";
  11158. import "babylonjs/Shaders/sprites.fragment";
  11159. import "babylonjs/Shaders/sprites.vertex";
  11160. import { Ray } from "babylonjs/Culling/ray";
  11161. /**
  11162. * Defines the minimum interface to fullfil in order to be a sprite manager.
  11163. */
  11164. export interface ISpriteManager extends IDisposable {
  11165. /**
  11166. * Gets manager's name
  11167. */
  11168. name: string;
  11169. /**
  11170. * Restricts the camera to viewing objects with the same layerMask.
  11171. * A camera with a layerMask of 1 will render spriteManager.layerMask & camera.layerMask!== 0
  11172. */
  11173. layerMask: number;
  11174. /**
  11175. * Gets or sets a boolean indicating if the mesh can be picked (by scene.pick for instance or through actions). Default is true
  11176. */
  11177. isPickable: boolean;
  11178. /**
  11179. * Gets the hosting scene
  11180. */
  11181. scene: Scene;
  11182. /**
  11183. * Specifies the rendering group id for this mesh (0 by default)
  11184. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#rendering-groups
  11185. */
  11186. renderingGroupId: number;
  11187. /**
  11188. * Defines the list of sprites managed by the manager.
  11189. */
  11190. sprites: Array<Sprite>;
  11191. /**
  11192. * Gets or sets the spritesheet texture
  11193. */
  11194. texture: Texture;
  11195. /** Defines the default width of a cell in the spritesheet */
  11196. cellWidth: number;
  11197. /** Defines the default height of a cell in the spritesheet */
  11198. cellHeight: number;
  11199. /**
  11200. * Tests the intersection of a sprite with a specific ray.
  11201. * @param ray The ray we are sending to test the collision
  11202. * @param camera The camera space we are sending rays in
  11203. * @param predicate A predicate allowing excluding sprites from the list of object to test
  11204. * @param fastCheck defines if the first intersection will be used (and not the closest)
  11205. * @returns picking info or null.
  11206. */
  11207. intersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean): Nullable<PickingInfo>;
  11208. /**
  11209. * Intersects the sprites with a ray
  11210. * @param ray defines the ray to intersect with
  11211. * @param camera defines the current active camera
  11212. * @param predicate defines a predicate used to select candidate sprites
  11213. * @returns null if no hit or a PickingInfo array
  11214. */
  11215. multiIntersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean): Nullable<PickingInfo[]>;
  11216. /**
  11217. * Renders the list of sprites on screen.
  11218. */
  11219. render(): void;
  11220. }
  11221. /**
  11222. * Class used to manage multiple sprites on the same spritesheet
  11223. * @see https://doc.babylonjs.com/babylon101/sprites
  11224. */
  11225. export class SpriteManager implements ISpriteManager {
  11226. /** defines the manager's name */
  11227. name: string;
  11228. /** Define the Url to load snippets */
  11229. static SnippetUrl: string;
  11230. /** Snippet ID if the manager was created from the snippet server */
  11231. snippetId: string;
  11232. /** Gets the list of sprites */
  11233. sprites: Sprite[];
  11234. /** Gets or sets the rendering group id (0 by default) */
  11235. renderingGroupId: number;
  11236. /** Gets or sets camera layer mask */
  11237. layerMask: number;
  11238. /** Gets or sets a boolean indicating if the manager must consider scene fog when rendering */
  11239. fogEnabled: boolean;
  11240. /** Gets or sets a boolean indicating if the sprites are pickable */
  11241. isPickable: boolean;
  11242. /** Defines the default width of a cell in the spritesheet */
  11243. cellWidth: number;
  11244. /** Defines the default height of a cell in the spritesheet */
  11245. cellHeight: number;
  11246. /** Associative array from JSON sprite data file */
  11247. private _cellData;
  11248. /** Array of sprite names from JSON sprite data file */
  11249. private _spriteMap;
  11250. /** True when packed cell data from JSON file is ready*/
  11251. private _packedAndReady;
  11252. private _textureContent;
  11253. private _useInstancing;
  11254. /**
  11255. * An event triggered when the manager is disposed.
  11256. */
  11257. onDisposeObservable: Observable<SpriteManager>;
  11258. private _onDisposeObserver;
  11259. /**
  11260. * Callback called when the manager is disposed
  11261. */
  11262. set onDispose(callback: () => void);
  11263. private _capacity;
  11264. private _fromPacked;
  11265. private _spriteTexture;
  11266. private _epsilon;
  11267. private _scene;
  11268. private _vertexData;
  11269. private _buffer;
  11270. private _vertexBuffers;
  11271. private _spriteBuffer;
  11272. private _indexBuffer;
  11273. private _effectBase;
  11274. private _effectFog;
  11275. private _vertexBufferSize;
  11276. /**
  11277. * Gets or sets the unique id of the sprite
  11278. */
  11279. uniqueId: number;
  11280. /**
  11281. * Gets the array of sprites
  11282. */
  11283. get children(): Sprite[];
  11284. /**
  11285. * Gets the hosting scene
  11286. */
  11287. get scene(): Scene;
  11288. /**
  11289. * Gets the capacity of the manager
  11290. */
  11291. get capacity(): number;
  11292. /**
  11293. * Gets or sets the spritesheet texture
  11294. */
  11295. get texture(): Texture;
  11296. set texture(value: Texture);
  11297. private _blendMode;
  11298. /**
  11299. * Blend mode use to render the particle, it can be any of
  11300. * the static Constants.ALPHA_x properties provided in this class.
  11301. * Default value is Constants.ALPHA_COMBINE
  11302. */
  11303. get blendMode(): number;
  11304. set blendMode(blendMode: number);
  11305. /** Disables writing to the depth buffer when rendering the sprites.
  11306. * It can be handy to disable depth writing when using textures without alpha channel
  11307. * and setting some specific blend modes.
  11308. */
  11309. disableDepthWrite: boolean;
  11310. /**
  11311. * Creates a new sprite manager
  11312. * @param name defines the manager's name
  11313. * @param imgUrl defines the sprite sheet url
  11314. * @param capacity defines the maximum allowed number of sprites
  11315. * @param cellSize defines the size of a sprite cell
  11316. * @param scene defines the hosting scene
  11317. * @param epsilon defines the epsilon value to align texture (0.01 by default)
  11318. * @param samplingMode defines the smapling mode to use with spritesheet
  11319. * @param fromPacked set to false; do not alter
  11320. * @param spriteJSON null otherwise a JSON object defining sprite sheet data; do not alter
  11321. */
  11322. constructor(
  11323. /** defines the manager's name */
  11324. name: string, imgUrl: string, capacity: number, cellSize: any, scene: Scene, epsilon?: number, samplingMode?: number, fromPacked?: boolean, spriteJSON?: any | null);
  11325. /**
  11326. * Returns the string "SpriteManager"
  11327. * @returns "SpriteManager"
  11328. */
  11329. getClassName(): string;
  11330. private _makePacked;
  11331. private _appendSpriteVertex;
  11332. private _checkTextureAlpha;
  11333. /**
  11334. * Intersects the sprites with a ray
  11335. * @param ray defines the ray to intersect with
  11336. * @param camera defines the current active camera
  11337. * @param predicate defines a predicate used to select candidate sprites
  11338. * @param fastCheck defines if a fast check only must be done (the first potential sprite is will be used and not the closer)
  11339. * @returns null if no hit or a PickingInfo
  11340. */
  11341. intersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean): Nullable<PickingInfo>;
  11342. /**
  11343. * Intersects the sprites with a ray
  11344. * @param ray defines the ray to intersect with
  11345. * @param camera defines the current active camera
  11346. * @param predicate defines a predicate used to select candidate sprites
  11347. * @returns null if no hit or a PickingInfo array
  11348. */
  11349. multiIntersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean): Nullable<PickingInfo[]>;
  11350. /**
  11351. * Render all child sprites
  11352. */
  11353. render(): void;
  11354. /**
  11355. * Release associated resources
  11356. */
  11357. dispose(): void;
  11358. /**
  11359. * Serializes the sprite manager to a JSON object
  11360. * @param serializeTexture defines if the texture must be serialized as well
  11361. * @returns the JSON object
  11362. */
  11363. serialize(serializeTexture?: boolean): any;
  11364. /**
  11365. * Parses a JSON object to create a new sprite manager.
  11366. * @param parsedManager The JSON object to parse
  11367. * @param scene The scene to create the sprite managerin
  11368. * @param rootUrl The root url to use to load external dependencies like texture
  11369. * @returns the new sprite manager
  11370. */
  11371. static Parse(parsedManager: any, scene: Scene, rootUrl: string): SpriteManager;
  11372. /**
  11373. * Creates a sprite manager from a snippet saved in a remote file
  11374. * @param name defines the name of the sprite manager to create (can be null or empty to use the one from the json data)
  11375. * @param url defines the url to load from
  11376. * @param scene defines the hosting scene
  11377. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  11378. * @returns a promise that will resolve to the new sprite manager
  11379. */
  11380. static ParseFromFileAsync(name: Nullable<string>, url: string, scene: Scene, rootUrl?: string): Promise<SpriteManager>;
  11381. /**
  11382. * Creates a sprite manager from a snippet saved by the sprite editor
  11383. * @param snippetId defines the snippet to load (can be set to _BLANK to create a default one)
  11384. * @param scene defines the hosting scene
  11385. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  11386. * @returns a promise that will resolve to the new sprite manager
  11387. */
  11388. static CreateFromSnippetAsync(snippetId: string, scene: Scene, rootUrl?: string): Promise<SpriteManager>;
  11389. }
  11390. }
  11391. declare module "babylonjs/Misc/gradients" {
  11392. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  11393. /** Interface used by value gradients (color, factor, ...) */
  11394. export interface IValueGradient {
  11395. /**
  11396. * Gets or sets the gradient value (between 0 and 1)
  11397. */
  11398. gradient: number;
  11399. }
  11400. /** Class used to store color4 gradient */
  11401. export class ColorGradient implements IValueGradient {
  11402. /**
  11403. * Gets or sets the gradient value (between 0 and 1)
  11404. */
  11405. gradient: number;
  11406. /**
  11407. * Gets or sets first associated color
  11408. */
  11409. color1: Color4;
  11410. /**
  11411. * Gets or sets second associated color
  11412. */
  11413. color2?: Color4 | undefined;
  11414. /**
  11415. * Creates a new color4 gradient
  11416. * @param gradient gets or sets the gradient value (between 0 and 1)
  11417. * @param color1 gets or sets first associated color
  11418. * @param color2 gets or sets first second color
  11419. */
  11420. constructor(
  11421. /**
  11422. * Gets or sets the gradient value (between 0 and 1)
  11423. */
  11424. gradient: number,
  11425. /**
  11426. * Gets or sets first associated color
  11427. */
  11428. color1: Color4,
  11429. /**
  11430. * Gets or sets second associated color
  11431. */
  11432. color2?: Color4 | undefined);
  11433. /**
  11434. * Will get a color picked randomly between color1 and color2.
  11435. * If color2 is undefined then color1 will be used
  11436. * @param result defines the target Color4 to store the result in
  11437. */
  11438. getColorToRef(result: Color4): void;
  11439. }
  11440. /** Class used to store color 3 gradient */
  11441. export class Color3Gradient implements IValueGradient {
  11442. /**
  11443. * Gets or sets the gradient value (between 0 and 1)
  11444. */
  11445. gradient: number;
  11446. /**
  11447. * Gets or sets the associated color
  11448. */
  11449. color: Color3;
  11450. /**
  11451. * Creates a new color3 gradient
  11452. * @param gradient gets or sets the gradient value (between 0 and 1)
  11453. * @param color gets or sets associated color
  11454. */
  11455. constructor(
  11456. /**
  11457. * Gets or sets the gradient value (between 0 and 1)
  11458. */
  11459. gradient: number,
  11460. /**
  11461. * Gets or sets the associated color
  11462. */
  11463. color: Color3);
  11464. }
  11465. /** Class used to store factor gradient */
  11466. export class FactorGradient implements IValueGradient {
  11467. /**
  11468. * Gets or sets the gradient value (between 0 and 1)
  11469. */
  11470. gradient: number;
  11471. /**
  11472. * Gets or sets first associated factor
  11473. */
  11474. factor1: number;
  11475. /**
  11476. * Gets or sets second associated factor
  11477. */
  11478. factor2?: number | undefined;
  11479. /**
  11480. * Creates a new factor gradient
  11481. * @param gradient gets or sets the gradient value (between 0 and 1)
  11482. * @param factor1 gets or sets first associated factor
  11483. * @param factor2 gets or sets second associated factor
  11484. */
  11485. constructor(
  11486. /**
  11487. * Gets or sets the gradient value (between 0 and 1)
  11488. */
  11489. gradient: number,
  11490. /**
  11491. * Gets or sets first associated factor
  11492. */
  11493. factor1: number,
  11494. /**
  11495. * Gets or sets second associated factor
  11496. */
  11497. factor2?: number | undefined);
  11498. /**
  11499. * Will get a number picked randomly between factor1 and factor2.
  11500. * If factor2 is undefined then factor1 will be used
  11501. * @returns the picked number
  11502. */
  11503. getFactor(): number;
  11504. }
  11505. /**
  11506. * Helper used to simplify some generic gradient tasks
  11507. */
  11508. export class GradientHelper {
  11509. /**
  11510. * Gets the current gradient from an array of IValueGradient
  11511. * @param ratio defines the current ratio to get
  11512. * @param gradients defines the array of IValueGradient
  11513. * @param updateFunc defines the callback function used to get the final value from the selected gradients
  11514. */
  11515. static GetCurrentGradient(ratio: number, gradients: IValueGradient[], updateFunc: (current: IValueGradient, next: IValueGradient, scale: number) => void): void;
  11516. }
  11517. }
  11518. declare module "babylonjs/Engines/Extensions/engine.rawTexture" {
  11519. import { Nullable } from "babylonjs/types";
  11520. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  11521. import { Scene } from "babylonjs/scene";
  11522. module "babylonjs/Engines/thinEngine" {
  11523. interface ThinEngine {
  11524. /**
  11525. * Creates a raw texture
  11526. * @param data defines the data to store in the texture
  11527. * @param width defines the width of the texture
  11528. * @param height defines the height of the texture
  11529. * @param format defines the format of the data
  11530. * @param generateMipMaps defines if the engine should generate the mip levels
  11531. * @param invertY defines if data must be stored with Y axis inverted
  11532. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  11533. * @param compression defines the compression used (null by default)
  11534. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  11535. * @returns the raw texture inside an InternalTexture
  11536. */
  11537. createRawTexture(data: Nullable<ArrayBufferView>, width: number, height: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, type: number): InternalTexture;
  11538. /**
  11539. * Update a raw texture
  11540. * @param texture defines the texture to update
  11541. * @param data defines the data to store in the texture
  11542. * @param format defines the format of the data
  11543. * @param invertY defines if data must be stored with Y axis inverted
  11544. */
  11545. updateRawTexture(texture: Nullable<InternalTexture>, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  11546. /**
  11547. * Update a raw texture
  11548. * @param texture defines the texture to update
  11549. * @param data defines the data to store in the texture
  11550. * @param format defines the format of the data
  11551. * @param invertY defines if data must be stored with Y axis inverted
  11552. * @param compression defines the compression used (null by default)
  11553. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  11554. */
  11555. updateRawTexture(texture: Nullable<InternalTexture>, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, type: number): void;
  11556. /**
  11557. * Creates a new raw cube texture
  11558. * @param data defines the array of data to use to create each face
  11559. * @param size defines the size of the textures
  11560. * @param format defines the format of the data
  11561. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  11562. * @param generateMipMaps defines if the engine should generate the mip levels
  11563. * @param invertY defines if data must be stored with Y axis inverted
  11564. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  11565. * @param compression defines the compression used (null by default)
  11566. * @returns the cube texture as an InternalTexture
  11567. */
  11568. createRawCubeTexture(data: Nullable<ArrayBufferView[]>, size: number, format: number, type: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>): InternalTexture;
  11569. /**
  11570. * Update a raw cube texture
  11571. * @param texture defines the texture to udpdate
  11572. * @param data defines the data to store
  11573. * @param format defines the data format
  11574. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  11575. * @param invertY defines if data must be stored with Y axis inverted
  11576. */
  11577. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean): void;
  11578. /**
  11579. * Update a raw cube texture
  11580. * @param texture defines the texture to udpdate
  11581. * @param data defines the data to store
  11582. * @param format defines the data format
  11583. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  11584. * @param invertY defines if data must be stored with Y axis inverted
  11585. * @param compression defines the compression used (null by default)
  11586. */
  11587. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression: Nullable<string>): void;
  11588. /**
  11589. * Update a raw cube texture
  11590. * @param texture defines the texture to udpdate
  11591. * @param data defines the data to store
  11592. * @param format defines the data format
  11593. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  11594. * @param invertY defines if data must be stored with Y axis inverted
  11595. * @param compression defines the compression used (null by default)
  11596. * @param level defines which level of the texture to update
  11597. */
  11598. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression: Nullable<string>, level: number): void;
  11599. /**
  11600. * Creates a new raw cube texture from a specified url
  11601. * @param url defines the url where the data is located
  11602. * @param scene defines the current scene
  11603. * @param size defines the size of the textures
  11604. * @param format defines the format of the data
  11605. * @param type defines the type fo the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  11606. * @param noMipmap defines if the engine should avoid generating the mip levels
  11607. * @param callback defines a callback used to extract texture data from loaded data
  11608. * @param mipmapGenerator defines to provide an optional tool to generate mip levels
  11609. * @param onLoad defines a callback called when texture is loaded
  11610. * @param onError defines a callback called if there is an error
  11611. * @returns the cube texture as an InternalTexture
  11612. */
  11613. createRawCubeTextureFromUrl(url: string, scene: Nullable<Scene>, size: number, format: number, type: number, noMipmap: boolean, callback: (ArrayBuffer: ArrayBuffer) => Nullable<ArrayBufferView[]>, mipmapGenerator: Nullable<((faces: ArrayBufferView[]) => ArrayBufferView[][])>, onLoad: Nullable<() => void>, onError: Nullable<(message?: string, exception?: any) => void>): InternalTexture;
  11614. /**
  11615. * Creates a new raw cube texture from a specified url
  11616. * @param url defines the url where the data is located
  11617. * @param scene defines the current scene
  11618. * @param size defines the size of the textures
  11619. * @param format defines the format of the data
  11620. * @param type defines the type fo the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  11621. * @param noMipmap defines if the engine should avoid generating the mip levels
  11622. * @param callback defines a callback used to extract texture data from loaded data
  11623. * @param mipmapGenerator defines to provide an optional tool to generate mip levels
  11624. * @param onLoad defines a callback called when texture is loaded
  11625. * @param onError defines a callback called if there is an error
  11626. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  11627. * @param invertY defines if data must be stored with Y axis inverted
  11628. * @returns the cube texture as an InternalTexture
  11629. */
  11630. createRawCubeTextureFromUrl(url: string, scene: Nullable<Scene>, size: number, format: number, type: number, noMipmap: boolean, callback: (ArrayBuffer: ArrayBuffer) => Nullable<ArrayBufferView[]>, mipmapGenerator: Nullable<((faces: ArrayBufferView[]) => ArrayBufferView[][])>, onLoad: Nullable<() => void>, onError: Nullable<(message?: string, exception?: any) => void>, samplingMode: number, invertY: boolean): InternalTexture;
  11631. /**
  11632. * Creates a new raw 3D texture
  11633. * @param data defines the data used to create the texture
  11634. * @param width defines the width of the texture
  11635. * @param height defines the height of the texture
  11636. * @param depth defines the depth of the texture
  11637. * @param format defines the format of the texture
  11638. * @param generateMipMaps defines if the engine must generate mip levels
  11639. * @param invertY defines if data must be stored with Y axis inverted
  11640. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  11641. * @param compression defines the compressed used (can be null)
  11642. * @param textureType defines the compressed used (can be null)
  11643. * @returns a new raw 3D texture (stored in an InternalTexture)
  11644. */
  11645. createRawTexture3D(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, textureType: number): InternalTexture;
  11646. /**
  11647. * Update a raw 3D texture
  11648. * @param texture defines the texture to update
  11649. * @param data defines the data to store
  11650. * @param format defines the data format
  11651. * @param invertY defines if data must be stored with Y axis inverted
  11652. */
  11653. updateRawTexture3D(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  11654. /**
  11655. * Update a raw 3D texture
  11656. * @param texture defines the texture to update
  11657. * @param data defines the data to store
  11658. * @param format defines the data format
  11659. * @param invertY defines if data must be stored with Y axis inverted
  11660. * @param compression defines the used compression (can be null)
  11661. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  11662. */
  11663. updateRawTexture3D(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, textureType: number): void;
  11664. /**
  11665. * Creates a new raw 2D array texture
  11666. * @param data defines the data used to create the texture
  11667. * @param width defines the width of the texture
  11668. * @param height defines the height of the texture
  11669. * @param depth defines the number of layers of the texture
  11670. * @param format defines the format of the texture
  11671. * @param generateMipMaps defines if the engine must generate mip levels
  11672. * @param invertY defines if data must be stored with Y axis inverted
  11673. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  11674. * @param compression defines the compressed used (can be null)
  11675. * @param textureType defines the compressed used (can be null)
  11676. * @returns a new raw 2D array texture (stored in an InternalTexture)
  11677. */
  11678. createRawTexture2DArray(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, textureType: number): InternalTexture;
  11679. /**
  11680. * Update a raw 2D array texture
  11681. * @param texture defines the texture to update
  11682. * @param data defines the data to store
  11683. * @param format defines the data format
  11684. * @param invertY defines if data must be stored with Y axis inverted
  11685. */
  11686. updateRawTexture2DArray(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  11687. /**
  11688. * Update a raw 2D array texture
  11689. * @param texture defines the texture to update
  11690. * @param data defines the data to store
  11691. * @param format defines the data format
  11692. * @param invertY defines if data must be stored with Y axis inverted
  11693. * @param compression defines the used compression (can be null)
  11694. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  11695. */
  11696. updateRawTexture2DArray(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, textureType: number): void;
  11697. }
  11698. }
  11699. }
  11700. declare module "babylonjs/Materials/Textures/rawTexture" {
  11701. import { Texture } from "babylonjs/Materials/Textures/texture";
  11702. import "babylonjs/Engines/Extensions/engine.rawTexture";
  11703. import { Nullable } from "babylonjs/types";
  11704. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  11705. import { Scene } from "babylonjs/scene";
  11706. /**
  11707. * Raw texture can help creating a texture directly from an array of data.
  11708. * This can be super useful if you either get the data from an uncompressed source or
  11709. * if you wish to create your texture pixel by pixel.
  11710. */
  11711. export class RawTexture extends Texture {
  11712. /**
  11713. * Define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  11714. */
  11715. format: number;
  11716. /**
  11717. * Instantiates a new RawTexture.
  11718. * Raw texture can help creating a texture directly from an array of data.
  11719. * This can be super useful if you either get the data from an uncompressed source or
  11720. * if you wish to create your texture pixel by pixel.
  11721. * @param data define the array of data to use to create the texture
  11722. * @param width define the width of the texture
  11723. * @param height define the height of the texture
  11724. * @param format define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  11725. * @param sceneOrEngine defines the scene or engine the texture will belong to
  11726. * @param generateMipMaps define whether mip maps should be generated or not
  11727. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  11728. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  11729. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  11730. */
  11731. constructor(data: ArrayBufferView, width: number, height: number,
  11732. /**
  11733. * Define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  11734. */
  11735. format: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number);
  11736. /**
  11737. * Updates the texture underlying data.
  11738. * @param data Define the new data of the texture
  11739. */
  11740. update(data: ArrayBufferView): void;
  11741. /**
  11742. * Creates a luminance texture from some data.
  11743. * @param data Define the texture data
  11744. * @param width Define the width of the texture
  11745. * @param height Define the height of the texture
  11746. * @param sceneOrEngine defines the scene or engine the texture will belong to
  11747. * @param generateMipMaps Define whether or not to create mip maps for the texture
  11748. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  11749. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  11750. * @returns the luminance texture
  11751. */
  11752. static CreateLuminanceTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  11753. /**
  11754. * Creates a luminance alpha texture from some data.
  11755. * @param data Define the texture data
  11756. * @param width Define the width of the texture
  11757. * @param height Define the height of the texture
  11758. * @param sceneOrEngine defines the scene or engine the texture will belong to
  11759. * @param generateMipMaps Define whether or not to create mip maps for the texture
  11760. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  11761. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  11762. * @returns the luminance alpha texture
  11763. */
  11764. static CreateLuminanceAlphaTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  11765. /**
  11766. * Creates an alpha texture from some data.
  11767. * @param data Define the texture data
  11768. * @param width Define the width of the texture
  11769. * @param height Define the height of the texture
  11770. * @param sceneOrEngine defines the scene or engine the texture will belong to
  11771. * @param generateMipMaps Define whether or not to create mip maps for the texture
  11772. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  11773. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  11774. * @returns the alpha texture
  11775. */
  11776. static CreateAlphaTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  11777. /**
  11778. * Creates a RGB texture from some data.
  11779. * @param data Define the texture data
  11780. * @param width Define the width of the texture
  11781. * @param height Define the height of the texture
  11782. * @param sceneOrEngine defines the scene or engine the texture will belong to
  11783. * @param generateMipMaps Define whether or not to create mip maps for the texture
  11784. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  11785. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  11786. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  11787. * @returns the RGB alpha texture
  11788. */
  11789. static CreateRGBTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  11790. /**
  11791. * Creates a RGBA texture from some data.
  11792. * @param data Define the texture data
  11793. * @param width Define the width of the texture
  11794. * @param height Define the height of the texture
  11795. * @param sceneOrEngine defines the scene or engine the texture will belong to
  11796. * @param generateMipMaps Define whether or not to create mip maps for the texture
  11797. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  11798. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  11799. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  11800. * @returns the RGBA texture
  11801. */
  11802. static CreateRGBATexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  11803. /**
  11804. * Creates a R texture from some data.
  11805. * @param data Define the texture data
  11806. * @param width Define the width of the texture
  11807. * @param height Define the height of the texture
  11808. * @param sceneOrEngine defines the scene or engine the texture will belong to
  11809. * @param generateMipMaps Define whether or not to create mip maps for the texture
  11810. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  11811. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  11812. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  11813. * @returns the R texture
  11814. */
  11815. static CreateRTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  11816. }
  11817. }
  11818. declare module "babylonjs/Engines/Extensions/engine.dynamicBuffer" {
  11819. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  11820. import { IndicesArray, DataArray } from "babylonjs/types";
  11821. module "babylonjs/Engines/thinEngine" {
  11822. interface ThinEngine {
  11823. /**
  11824. * Update a dynamic index buffer
  11825. * @param indexBuffer defines the target index buffer
  11826. * @param indices defines the data to update
  11827. * @param offset defines the offset in the target index buffer where update should start
  11828. */
  11829. updateDynamicIndexBuffer(indexBuffer: DataBuffer, indices: IndicesArray, offset?: number): void;
  11830. /**
  11831. * Updates a dynamic vertex buffer.
  11832. * @param vertexBuffer the vertex buffer to update
  11833. * @param data the data used to update the vertex buffer
  11834. * @param byteOffset the byte offset of the data
  11835. * @param byteLength the byte length of the data
  11836. */
  11837. updateDynamicVertexBuffer(vertexBuffer: DataBuffer, data: DataArray, byteOffset?: number, byteLength?: number): void;
  11838. }
  11839. }
  11840. }
  11841. declare module "babylonjs/Materials/Textures/Procedurals/proceduralTextureSceneComponent" {
  11842. import { Scene } from "babylonjs/scene";
  11843. import { ISceneComponent } from "babylonjs/sceneComponent";
  11844. import { ProceduralTexture } from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  11845. module "babylonjs/abstractScene" {
  11846. interface AbstractScene {
  11847. /**
  11848. * The list of procedural textures added to the scene
  11849. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  11850. */
  11851. proceduralTextures: Array<ProceduralTexture>;
  11852. }
  11853. }
  11854. /**
  11855. * Defines the Procedural Texture scene component responsible to manage any Procedural Texture
  11856. * in a given scene.
  11857. */
  11858. export class ProceduralTextureSceneComponent implements ISceneComponent {
  11859. /**
  11860. * The component name helpfull to identify the component in the list of scene components.
  11861. */
  11862. readonly name: string;
  11863. /**
  11864. * The scene the component belongs to.
  11865. */
  11866. scene: Scene;
  11867. /**
  11868. * Creates a new instance of the component for the given scene
  11869. * @param scene Defines the scene to register the component in
  11870. */
  11871. constructor(scene: Scene);
  11872. /**
  11873. * Registers the component in a given scene
  11874. */
  11875. register(): void;
  11876. /**
  11877. * Rebuilds the elements related to this component in case of
  11878. * context lost for instance.
  11879. */
  11880. rebuild(): void;
  11881. /**
  11882. * Disposes the component and the associated ressources.
  11883. */
  11884. dispose(): void;
  11885. private _beforeClear;
  11886. }
  11887. }
  11888. declare module "babylonjs/Engines/Extensions/engine.renderTargetCube" {
  11889. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  11890. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  11891. module "babylonjs/Engines/thinEngine" {
  11892. interface ThinEngine {
  11893. /**
  11894. * Creates a new render target cube texture
  11895. * @param size defines the size of the texture
  11896. * @param options defines the options used to create the texture
  11897. * @returns a new render target cube texture stored in an InternalTexture
  11898. */
  11899. createRenderTargetCubeTexture(size: number, options?: Partial<RenderTargetCreationOptions>): InternalTexture;
  11900. }
  11901. }
  11902. }
  11903. declare module "babylonjs/Shaders/procedural.vertex" {
  11904. /** @hidden */
  11905. export var proceduralVertexShader: {
  11906. name: string;
  11907. shader: string;
  11908. };
  11909. }
  11910. declare module "babylonjs/Materials/Textures/Procedurals/proceduralTexture" {
  11911. import { Observable } from "babylonjs/Misc/observable";
  11912. import { Nullable } from "babylonjs/types";
  11913. import { Scene } from "babylonjs/scene";
  11914. import { Matrix, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  11915. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  11916. import { Effect } from "babylonjs/Materials/effect";
  11917. import { Texture } from "babylonjs/Materials/Textures/texture";
  11918. import "babylonjs/Engines/Extensions/engine.renderTarget";
  11919. import "babylonjs/Engines/Extensions/engine.renderTargetCube";
  11920. import "babylonjs/Shaders/procedural.vertex";
  11921. /**
  11922. * Procedural texturing is a way to programmatically create a texture. There are 2 types of procedural textures: code-only, and code that references some classic 2D images, sometimes calmpler' images.
  11923. * This is the base class of any Procedural texture and contains most of the shareable code.
  11924. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  11925. */
  11926. export class ProceduralTexture extends Texture {
  11927. isCube: boolean;
  11928. /**
  11929. * Define if the texture is enabled or not (disabled texture will not render)
  11930. */
  11931. isEnabled: boolean;
  11932. /**
  11933. * Define if the texture must be cleared before rendering (default is true)
  11934. */
  11935. autoClear: boolean;
  11936. /**
  11937. * Callback called when the texture is generated
  11938. */
  11939. onGenerated: () => void;
  11940. /**
  11941. * Event raised when the texture is generated
  11942. */
  11943. onGeneratedObservable: Observable<ProceduralTexture>;
  11944. /** @hidden */
  11945. _generateMipMaps: boolean;
  11946. /** @hidden **/
  11947. _effect: Effect;
  11948. /** @hidden */
  11949. _textures: {
  11950. [key: string]: Texture;
  11951. };
  11952. /** @hidden */
  11953. protected _fallbackTexture: Nullable<Texture>;
  11954. private _size;
  11955. private _currentRefreshId;
  11956. private _frameId;
  11957. private _refreshRate;
  11958. private _vertexBuffers;
  11959. private _indexBuffer;
  11960. private _uniforms;
  11961. private _samplers;
  11962. private _fragment;
  11963. private _floats;
  11964. private _ints;
  11965. private _floatsArrays;
  11966. private _colors3;
  11967. private _colors4;
  11968. private _vectors2;
  11969. private _vectors3;
  11970. private _matrices;
  11971. private _fallbackTextureUsed;
  11972. private _fullEngine;
  11973. private _cachedDefines;
  11974. private _contentUpdateId;
  11975. private _contentData;
  11976. /**
  11977. * Instantiates a new procedural texture.
  11978. * Procedural texturing is a way to programmatically create a texture. There are 2 types of procedural textures: code-only, and code that references some classic 2D images, sometimes called 'refMaps' or 'sampler' images.
  11979. * This is the base class of any Procedural texture and contains most of the shareable code.
  11980. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  11981. * @param name Define the name of the texture
  11982. * @param size Define the size of the texture to create
  11983. * @param fragment Define the fragment shader to use to generate the texture or null if it is defined later
  11984. * @param scene Define the scene the texture belongs to
  11985. * @param fallbackTexture Define a fallback texture in case there were issues to create the custom texture
  11986. * @param generateMipMaps Define if the texture should creates mip maps or not
  11987. * @param isCube Define if the texture is a cube texture or not (this will render each faces of the cube)
  11988. */
  11989. constructor(name: string, size: any, fragment: any, scene: Nullable<Scene>, fallbackTexture?: Nullable<Texture>, generateMipMaps?: boolean, isCube?: boolean);
  11990. /**
  11991. * The effect that is created when initializing the post process.
  11992. * @returns The created effect corresponding the the postprocess.
  11993. */
  11994. getEffect(): Effect;
  11995. /**
  11996. * Gets texture content (Use this function wisely as reading from a texture can be slow)
  11997. * @returns an ArrayBufferView (Uint8Array or Float32Array)
  11998. */
  11999. getContent(): Nullable<ArrayBufferView>;
  12000. private _createIndexBuffer;
  12001. /** @hidden */
  12002. _rebuild(): void;
  12003. /**
  12004. * Resets the texture in order to recreate its associated resources.
  12005. * This can be called in case of context loss
  12006. */
  12007. reset(): void;
  12008. protected _getDefines(): string;
  12009. /**
  12010. * Is the texture ready to be used ? (rendered at least once)
  12011. * @returns true if ready, otherwise, false.
  12012. */
  12013. isReady(): boolean;
  12014. /**
  12015. * Resets the refresh counter of the texture and start bak from scratch.
  12016. * Could be useful to regenerate the texture if it is setup to render only once.
  12017. */
  12018. resetRefreshCounter(): void;
  12019. /**
  12020. * Set the fragment shader to use in order to render the texture.
  12021. * @param fragment This can be set to a path (into the shader store) or to a json object containing a fragmentElement property.
  12022. */
  12023. setFragment(fragment: any): void;
  12024. /**
  12025. * Define the refresh rate of the texture or the rendering frequency.
  12026. * Use 0 to render just once, 1 to render on every frame, 2 to render every two frames and so on...
  12027. */
  12028. get refreshRate(): number;
  12029. set refreshRate(value: number);
  12030. /** @hidden */
  12031. _shouldRender(): boolean;
  12032. /**
  12033. * Get the size the texture is rendering at.
  12034. * @returns the size (texture is always squared)
  12035. */
  12036. getRenderSize(): number;
  12037. /**
  12038. * Resize the texture to new value.
  12039. * @param size Define the new size the texture should have
  12040. * @param generateMipMaps Define whether the new texture should create mip maps
  12041. */
  12042. resize(size: number, generateMipMaps: boolean): void;
  12043. private _checkUniform;
  12044. /**
  12045. * Set a texture in the shader program used to render.
  12046. * @param name Define the name of the uniform samplers as defined in the shader
  12047. * @param texture Define the texture to bind to this sampler
  12048. * @return the texture itself allowing "fluent" like uniform updates
  12049. */
  12050. setTexture(name: string, texture: Texture): ProceduralTexture;
  12051. /**
  12052. * Set a float in the shader.
  12053. * @param name Define the name of the uniform as defined in the shader
  12054. * @param value Define the value to give to the uniform
  12055. * @return the texture itself allowing "fluent" like uniform updates
  12056. */
  12057. setFloat(name: string, value: number): ProceduralTexture;
  12058. /**
  12059. * Set a int in the shader.
  12060. * @param name Define the name of the uniform as defined in the shader
  12061. * @param value Define the value to give to the uniform
  12062. * @return the texture itself allowing "fluent" like uniform updates
  12063. */
  12064. setInt(name: string, value: number): ProceduralTexture;
  12065. /**
  12066. * Set an array of floats in the shader.
  12067. * @param name Define the name of the uniform as defined in the shader
  12068. * @param value Define the value to give to the uniform
  12069. * @return the texture itself allowing "fluent" like uniform updates
  12070. */
  12071. setFloats(name: string, value: number[]): ProceduralTexture;
  12072. /**
  12073. * Set a vec3 in the shader from a Color3.
  12074. * @param name Define the name of the uniform as defined in the shader
  12075. * @param value Define the value to give to the uniform
  12076. * @return the texture itself allowing "fluent" like uniform updates
  12077. */
  12078. setColor3(name: string, value: Color3): ProceduralTexture;
  12079. /**
  12080. * Set a vec4 in the shader from a Color4.
  12081. * @param name Define the name of the uniform as defined in the shader
  12082. * @param value Define the value to give to the uniform
  12083. * @return the texture itself allowing "fluent" like uniform updates
  12084. */
  12085. setColor4(name: string, value: Color4): ProceduralTexture;
  12086. /**
  12087. * Set a vec2 in the shader from a Vector2.
  12088. * @param name Define the name of the uniform as defined in the shader
  12089. * @param value Define the value to give to the uniform
  12090. * @return the texture itself allowing "fluent" like uniform updates
  12091. */
  12092. setVector2(name: string, value: Vector2): ProceduralTexture;
  12093. /**
  12094. * Set a vec3 in the shader from a Vector3.
  12095. * @param name Define the name of the uniform as defined in the shader
  12096. * @param value Define the value to give to the uniform
  12097. * @return the texture itself allowing "fluent" like uniform updates
  12098. */
  12099. setVector3(name: string, value: Vector3): ProceduralTexture;
  12100. /**
  12101. * Set a mat4 in the shader from a MAtrix.
  12102. * @param name Define the name of the uniform as defined in the shader
  12103. * @param value Define the value to give to the uniform
  12104. * @return the texture itself allowing "fluent" like uniform updates
  12105. */
  12106. setMatrix(name: string, value: Matrix): ProceduralTexture;
  12107. /**
  12108. * Render the texture to its associated render target.
  12109. * @param useCameraPostProcess Define if camera post process should be applied to the texture
  12110. */
  12111. render(useCameraPostProcess?: boolean): void;
  12112. /**
  12113. * Clone the texture.
  12114. * @returns the cloned texture
  12115. */
  12116. clone(): ProceduralTexture;
  12117. /**
  12118. * Dispose the texture and release its asoociated resources.
  12119. */
  12120. dispose(): void;
  12121. }
  12122. }
  12123. declare module "babylonjs/Particles/baseParticleSystem" {
  12124. import { Nullable } from "babylonjs/types";
  12125. import { Vector2, Vector3 } from "babylonjs/Maths/math.vector";
  12126. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  12127. import { ImageProcessingConfiguration, ImageProcessingConfigurationDefines } from "babylonjs/Materials/imageProcessingConfiguration";
  12128. import { ColorGradient, FactorGradient, Color3Gradient, IValueGradient } from "babylonjs/Misc/gradients";
  12129. import { BoxParticleEmitter, IParticleEmitterType, PointParticleEmitter, HemisphericParticleEmitter, SphereParticleEmitter, SphereDirectedParticleEmitter, CylinderParticleEmitter, CylinderDirectedParticleEmitter, ConeParticleEmitter } from "babylonjs/Particles/EmitterTypes/index";
  12130. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  12131. import { Color4 } from "babylonjs/Maths/math.color";
  12132. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  12133. import "babylonjs/Engines/Extensions/engine.dynamicBuffer";
  12134. import { Animation } from "babylonjs/Animations/animation";
  12135. import { Scene } from "babylonjs/scene";
  12136. import { ProceduralTexture } from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  12137. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  12138. /**
  12139. * This represents the base class for particle system in Babylon.
  12140. * Particles are often small sprites used to simulate hard-to-reproduce phenomena like fire, smoke, water, or abstract visual effects like magic glitter and faery dust.
  12141. * Particles can take different shapes while emitted like box, sphere, cone or you can write your custom function.
  12142. * @example https://doc.babylonjs.com/babylon101/particles
  12143. */
  12144. export class BaseParticleSystem {
  12145. /**
  12146. * Source color is added to the destination color without alpha affecting the result
  12147. */
  12148. static BLENDMODE_ONEONE: number;
  12149. /**
  12150. * Blend current color and particle color using particle’s alpha
  12151. */
  12152. static BLENDMODE_STANDARD: number;
  12153. /**
  12154. * Add current color and particle color multiplied by particle’s alpha
  12155. */
  12156. static BLENDMODE_ADD: number;
  12157. /**
  12158. * Multiply current color with particle color
  12159. */
  12160. static BLENDMODE_MULTIPLY: number;
  12161. /**
  12162. * Multiply current color with particle color then add current color and particle color multiplied by particle’s alpha
  12163. */
  12164. static BLENDMODE_MULTIPLYADD: number;
  12165. /**
  12166. * List of animations used by the particle system.
  12167. */
  12168. animations: Animation[];
  12169. /**
  12170. * Gets or sets the unique id of the particle system
  12171. */
  12172. uniqueId: number;
  12173. /**
  12174. * The id of the Particle system.
  12175. */
  12176. id: string;
  12177. /**
  12178. * The friendly name of the Particle system.
  12179. */
  12180. name: string;
  12181. /**
  12182. * Snippet ID if the particle system was created from the snippet server
  12183. */
  12184. snippetId: string;
  12185. /**
  12186. * The rendering group used by the Particle system to chose when to render.
  12187. */
  12188. renderingGroupId: number;
  12189. /**
  12190. * The emitter represents the Mesh or position we are attaching the particle system to.
  12191. */
  12192. emitter: Nullable<AbstractMesh | Vector3>;
  12193. /**
  12194. * The maximum number of particles to emit per frame
  12195. */
  12196. emitRate: number;
  12197. /**
  12198. * If you want to launch only a few particles at once, that can be done, as well.
  12199. */
  12200. manualEmitCount: number;
  12201. /**
  12202. * The overall motion speed (0.01 is default update speed, faster updates = faster animation)
  12203. */
  12204. updateSpeed: number;
  12205. /**
  12206. * The amount of time the particle system is running (depends of the overall update speed).
  12207. */
  12208. targetStopDuration: number;
  12209. /**
  12210. * Specifies whether the particle system will be disposed once it reaches the end of the animation.
  12211. */
  12212. disposeOnStop: boolean;
  12213. /**
  12214. * Minimum power of emitting particles.
  12215. */
  12216. minEmitPower: number;
  12217. /**
  12218. * Maximum power of emitting particles.
  12219. */
  12220. maxEmitPower: number;
  12221. /**
  12222. * Minimum life time of emitting particles.
  12223. */
  12224. minLifeTime: number;
  12225. /**
  12226. * Maximum life time of emitting particles.
  12227. */
  12228. maxLifeTime: number;
  12229. /**
  12230. * Minimum Size of emitting particles.
  12231. */
  12232. minSize: number;
  12233. /**
  12234. * Maximum Size of emitting particles.
  12235. */
  12236. maxSize: number;
  12237. /**
  12238. * Minimum scale of emitting particles on X axis.
  12239. */
  12240. minScaleX: number;
  12241. /**
  12242. * Maximum scale of emitting particles on X axis.
  12243. */
  12244. maxScaleX: number;
  12245. /**
  12246. * Minimum scale of emitting particles on Y axis.
  12247. */
  12248. minScaleY: number;
  12249. /**
  12250. * Maximum scale of emitting particles on Y axis.
  12251. */
  12252. maxScaleY: number;
  12253. /**
  12254. * Gets or sets the minimal initial rotation in radians.
  12255. */
  12256. minInitialRotation: number;
  12257. /**
  12258. * Gets or sets the maximal initial rotation in radians.
  12259. */
  12260. maxInitialRotation: number;
  12261. /**
  12262. * Minimum angular speed of emitting particles (Z-axis rotation for each particle).
  12263. */
  12264. minAngularSpeed: number;
  12265. /**
  12266. * Maximum angular speed of emitting particles (Z-axis rotation for each particle).
  12267. */
  12268. maxAngularSpeed: number;
  12269. /**
  12270. * The texture used to render each particle. (this can be a spritesheet)
  12271. */
  12272. particleTexture: Nullable<BaseTexture>;
  12273. /**
  12274. * The layer mask we are rendering the particles through.
  12275. */
  12276. layerMask: number;
  12277. /**
  12278. * This can help using your own shader to render the particle system.
  12279. * The according effect will be created
  12280. */
  12281. customShader: any;
  12282. /**
  12283. * By default particle system starts as soon as they are created. This prevents the
  12284. * automatic start to happen and let you decide when to start emitting particles.
  12285. */
  12286. preventAutoStart: boolean;
  12287. private _noiseTexture;
  12288. /**
  12289. * Gets or sets a texture used to add random noise to particle positions
  12290. */
  12291. get noiseTexture(): Nullable<ProceduralTexture>;
  12292. set noiseTexture(value: Nullable<ProceduralTexture>);
  12293. /** Gets or sets the strength to apply to the noise value (default is (10, 10, 10)) */
  12294. noiseStrength: Vector3;
  12295. /**
  12296. * Callback triggered when the particle animation is ending.
  12297. */
  12298. onAnimationEnd: Nullable<() => void>;
  12299. /**
  12300. * Blend mode use to render the particle, it can be either ParticleSystem.BLENDMODE_ONEONE or ParticleSystem.BLENDMODE_STANDARD.
  12301. */
  12302. blendMode: number;
  12303. /**
  12304. * Forces the particle to write their depth information to the depth buffer. This can help preventing other draw calls
  12305. * to override the particles.
  12306. */
  12307. forceDepthWrite: boolean;
  12308. /** Gets or sets a value indicating how many cycles (or frames) must be executed before first rendering (this value has to be set before starting the system). Default is 0 */
  12309. preWarmCycles: number;
  12310. /** Gets or sets a value indicating the time step multiplier to use in pre-warm mode (default is 1) */
  12311. preWarmStepOffset: number;
  12312. /**
  12313. * If using a spritesheet (isAnimationSheetEnabled) defines the speed of the sprite loop (default is 1 meaning the animation will play once during the entire particle lifetime)
  12314. */
  12315. spriteCellChangeSpeed: number;
  12316. /**
  12317. * If using a spritesheet (isAnimationSheetEnabled) defines the first sprite cell to display
  12318. */
  12319. startSpriteCellID: number;
  12320. /**
  12321. * If using a spritesheet (isAnimationSheetEnabled) defines the last sprite cell to display
  12322. */
  12323. endSpriteCellID: number;
  12324. /**
  12325. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell width to use
  12326. */
  12327. spriteCellWidth: number;
  12328. /**
  12329. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell height to use
  12330. */
  12331. spriteCellHeight: number;
  12332. /**
  12333. * This allows the system to random pick the start cell ID between startSpriteCellID and endSpriteCellID
  12334. */
  12335. spriteRandomStartCell: boolean;
  12336. /** Gets or sets a Vector2 used to move the pivot (by default (0,0)) */
  12337. translationPivot: Vector2;
  12338. /** @hidden */
  12339. protected _isAnimationSheetEnabled: boolean;
  12340. /**
  12341. * Gets or sets a boolean indicating that hosted animations (in the system.animations array) must be started when system.start() is called
  12342. */
  12343. beginAnimationOnStart: boolean;
  12344. /**
  12345. * Gets or sets the frame to start the animation from when beginAnimationOnStart is true
  12346. */
  12347. beginAnimationFrom: number;
  12348. /**
  12349. * Gets or sets the frame to end the animation on when beginAnimationOnStart is true
  12350. */
  12351. beginAnimationTo: number;
  12352. /**
  12353. * Gets or sets a boolean indicating if animations must loop when beginAnimationOnStart is true
  12354. */
  12355. beginAnimationLoop: boolean;
  12356. /**
  12357. * Gets or sets a world offset applied to all particles
  12358. */
  12359. worldOffset: Vector3;
  12360. /**
  12361. * Gets or sets whether an animation sprite sheet is enabled or not on the particle system
  12362. */
  12363. get isAnimationSheetEnabled(): boolean;
  12364. set isAnimationSheetEnabled(value: boolean);
  12365. /**
  12366. * Get hosting scene
  12367. * @returns the scene
  12368. */
  12369. getScene(): Nullable<Scene>;
  12370. /**
  12371. * You can use gravity if you want to give an orientation to your particles.
  12372. */
  12373. gravity: Vector3;
  12374. protected _colorGradients: Nullable<Array<ColorGradient>>;
  12375. protected _sizeGradients: Nullable<Array<FactorGradient>>;
  12376. protected _lifeTimeGradients: Nullable<Array<FactorGradient>>;
  12377. protected _angularSpeedGradients: Nullable<Array<FactorGradient>>;
  12378. protected _velocityGradients: Nullable<Array<FactorGradient>>;
  12379. protected _limitVelocityGradients: Nullable<Array<FactorGradient>>;
  12380. protected _dragGradients: Nullable<Array<FactorGradient>>;
  12381. protected _emitRateGradients: Nullable<Array<FactorGradient>>;
  12382. protected _startSizeGradients: Nullable<Array<FactorGradient>>;
  12383. protected _rampGradients: Nullable<Array<Color3Gradient>>;
  12384. protected _colorRemapGradients: Nullable<Array<FactorGradient>>;
  12385. protected _alphaRemapGradients: Nullable<Array<FactorGradient>>;
  12386. protected _hasTargetStopDurationDependantGradient(): boolean | null;
  12387. /**
  12388. * Defines the delay in milliseconds before starting the system (0 by default)
  12389. */
  12390. startDelay: number;
  12391. /**
  12392. * Gets the current list of drag gradients.
  12393. * You must use addDragGradient and removeDragGradient to udpate this list
  12394. * @returns the list of drag gradients
  12395. */
  12396. getDragGradients(): Nullable<Array<FactorGradient>>;
  12397. /** Gets or sets a value indicating the damping to apply if the limit velocity factor is reached */
  12398. limitVelocityDamping: number;
  12399. /**
  12400. * Gets the current list of limit velocity gradients.
  12401. * You must use addLimitVelocityGradient and removeLimitVelocityGradient to udpate this list
  12402. * @returns the list of limit velocity gradients
  12403. */
  12404. getLimitVelocityGradients(): Nullable<Array<FactorGradient>>;
  12405. /**
  12406. * Gets the current list of color gradients.
  12407. * You must use addColorGradient and removeColorGradient to udpate this list
  12408. * @returns the list of color gradients
  12409. */
  12410. getColorGradients(): Nullable<Array<ColorGradient>>;
  12411. /**
  12412. * Gets the current list of size gradients.
  12413. * You must use addSizeGradient and removeSizeGradient to udpate this list
  12414. * @returns the list of size gradients
  12415. */
  12416. getSizeGradients(): Nullable<Array<FactorGradient>>;
  12417. /**
  12418. * Gets the current list of color remap gradients.
  12419. * You must use addColorRemapGradient and removeColorRemapGradient to udpate this list
  12420. * @returns the list of color remap gradients
  12421. */
  12422. getColorRemapGradients(): Nullable<Array<FactorGradient>>;
  12423. /**
  12424. * Gets the current list of alpha remap gradients.
  12425. * You must use addAlphaRemapGradient and removeAlphaRemapGradient to udpate this list
  12426. * @returns the list of alpha remap gradients
  12427. */
  12428. getAlphaRemapGradients(): Nullable<Array<FactorGradient>>;
  12429. /**
  12430. * Gets the current list of life time gradients.
  12431. * You must use addLifeTimeGradient and removeLifeTimeGradient to udpate this list
  12432. * @returns the list of life time gradients
  12433. */
  12434. getLifeTimeGradients(): Nullable<Array<FactorGradient>>;
  12435. /**
  12436. * Gets the current list of angular speed gradients.
  12437. * You must use addAngularSpeedGradient and removeAngularSpeedGradient to udpate this list
  12438. * @returns the list of angular speed gradients
  12439. */
  12440. getAngularSpeedGradients(): Nullable<Array<FactorGradient>>;
  12441. /**
  12442. * Gets the current list of velocity gradients.
  12443. * You must use addVelocityGradient and removeVelocityGradient to udpate this list
  12444. * @returns the list of velocity gradients
  12445. */
  12446. getVelocityGradients(): Nullable<Array<FactorGradient>>;
  12447. /**
  12448. * Gets the current list of start size gradients.
  12449. * You must use addStartSizeGradient and removeStartSizeGradient to udpate this list
  12450. * @returns the list of start size gradients
  12451. */
  12452. getStartSizeGradients(): Nullable<Array<FactorGradient>>;
  12453. /**
  12454. * Gets the current list of emit rate gradients.
  12455. * You must use addEmitRateGradient and removeEmitRateGradient to udpate this list
  12456. * @returns the list of emit rate gradients
  12457. */
  12458. getEmitRateGradients(): Nullable<Array<FactorGradient>>;
  12459. /**
  12460. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  12461. * This only works when particleEmitterTyps is a BoxParticleEmitter
  12462. */
  12463. get direction1(): Vector3;
  12464. set direction1(value: Vector3);
  12465. /**
  12466. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  12467. * This only works when particleEmitterTyps is a BoxParticleEmitter
  12468. */
  12469. get direction2(): Vector3;
  12470. set direction2(value: Vector3);
  12471. /**
  12472. * Minimum box point around our emitter. Our emitter is the center of particles source, but if you want your particles to emit from more than one point, then you can tell it to do so.
  12473. * This only works when particleEmitterTyps is a BoxParticleEmitter
  12474. */
  12475. get minEmitBox(): Vector3;
  12476. set minEmitBox(value: Vector3);
  12477. /**
  12478. * Maximum box point around our emitter. Our emitter is the center of particles source, but if you want your particles to emit from more than one point, then you can tell it to do so.
  12479. * This only works when particleEmitterTyps is a BoxParticleEmitter
  12480. */
  12481. get maxEmitBox(): Vector3;
  12482. set maxEmitBox(value: Vector3);
  12483. /**
  12484. * Random color of each particle after it has been emitted, between color1 and color2 vectors
  12485. */
  12486. color1: Color4;
  12487. /**
  12488. * Random color of each particle after it has been emitted, between color1 and color2 vectors
  12489. */
  12490. color2: Color4;
  12491. /**
  12492. * Color the particle will have at the end of its lifetime
  12493. */
  12494. colorDead: Color4;
  12495. /**
  12496. * An optional mask to filter some colors out of the texture, or filter a part of the alpha channel
  12497. */
  12498. textureMask: Color4;
  12499. /**
  12500. * The particle emitter type defines the emitter used by the particle system.
  12501. * It can be for example box, sphere, or cone...
  12502. */
  12503. particleEmitterType: IParticleEmitterType;
  12504. /** @hidden */
  12505. _isSubEmitter: boolean;
  12506. /**
  12507. * Gets or sets the billboard mode to use when isBillboardBased = true.
  12508. * Value can be: ParticleSystem.BILLBOARDMODE_ALL, ParticleSystem.BILLBOARDMODE_Y, ParticleSystem.BILLBOARDMODE_STRETCHED
  12509. */
  12510. billboardMode: number;
  12511. protected _isBillboardBased: boolean;
  12512. /**
  12513. * Gets or sets a boolean indicating if the particles must be rendered as billboard or aligned with the direction
  12514. */
  12515. get isBillboardBased(): boolean;
  12516. set isBillboardBased(value: boolean);
  12517. /**
  12518. * The scene the particle system belongs to.
  12519. */
  12520. protected _scene: Nullable<Scene>;
  12521. /**
  12522. * The engine the particle system belongs to.
  12523. */
  12524. protected _engine: ThinEngine;
  12525. /**
  12526. * Local cache of defines for image processing.
  12527. */
  12528. protected _imageProcessingConfigurationDefines: ImageProcessingConfigurationDefines;
  12529. /**
  12530. * Default configuration related to image processing available in the standard Material.
  12531. */
  12532. protected _imageProcessingConfiguration: Nullable<ImageProcessingConfiguration>;
  12533. /**
  12534. * Gets the image processing configuration used either in this material.
  12535. */
  12536. get imageProcessingConfiguration(): Nullable<ImageProcessingConfiguration>;
  12537. /**
  12538. * Sets the Default image processing configuration used either in the this material.
  12539. *
  12540. * If sets to null, the scene one is in use.
  12541. */
  12542. set imageProcessingConfiguration(value: Nullable<ImageProcessingConfiguration>);
  12543. /**
  12544. * Attaches a new image processing configuration to the Standard Material.
  12545. * @param configuration
  12546. */
  12547. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  12548. /** @hidden */
  12549. protected _reset(): void;
  12550. /** @hidden */
  12551. protected _removeGradientAndTexture(gradient: number, gradients: Nullable<IValueGradient[]>, texture: Nullable<RawTexture>): BaseParticleSystem;
  12552. /**
  12553. * Instantiates a particle system.
  12554. * Particles are often small sprites used to simulate hard-to-reproduce phenomena like fire, smoke, water, or abstract visual effects like magic glitter and faery dust.
  12555. * @param name The name of the particle system
  12556. */
  12557. constructor(name: string);
  12558. /**
  12559. * Creates a Point Emitter for the particle system (emits directly from the emitter position)
  12560. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  12561. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  12562. * @returns the emitter
  12563. */
  12564. createPointEmitter(direction1: Vector3, direction2: Vector3): PointParticleEmitter;
  12565. /**
  12566. * Creates a Hemisphere Emitter for the particle system (emits along the hemisphere radius)
  12567. * @param radius The radius of the hemisphere to emit from
  12568. * @param radiusRange The range of the hemisphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  12569. * @returns the emitter
  12570. */
  12571. createHemisphericEmitter(radius?: number, radiusRange?: number): HemisphericParticleEmitter;
  12572. /**
  12573. * Creates a Sphere Emitter for the particle system (emits along the sphere radius)
  12574. * @param radius The radius of the sphere to emit from
  12575. * @param radiusRange The range of the sphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  12576. * @returns the emitter
  12577. */
  12578. createSphereEmitter(radius?: number, radiusRange?: number): SphereParticleEmitter;
  12579. /**
  12580. * Creates a Directed Sphere Emitter for the particle system (emits between direction1 and direction2)
  12581. * @param radius The radius of the sphere to emit from
  12582. * @param direction1 Particles are emitted between the direction1 and direction2 from within the sphere
  12583. * @param direction2 Particles are emitted between the direction1 and direction2 from within the sphere
  12584. * @returns the emitter
  12585. */
  12586. createDirectedSphereEmitter(radius?: number, direction1?: Vector3, direction2?: Vector3): SphereDirectedParticleEmitter;
  12587. /**
  12588. * Creates a Cylinder Emitter for the particle system (emits from the cylinder to the particle position)
  12589. * @param radius The radius of the emission cylinder
  12590. * @param height The height of the emission cylinder
  12591. * @param radiusRange The range of emission [0-1] 0 Surface only, 1 Entire Radius
  12592. * @param directionRandomizer How much to randomize the particle direction [0-1]
  12593. * @returns the emitter
  12594. */
  12595. createCylinderEmitter(radius?: number, height?: number, radiusRange?: number, directionRandomizer?: number): CylinderParticleEmitter;
  12596. /**
  12597. * Creates a Directed Cylinder Emitter for the particle system (emits between direction1 and direction2)
  12598. * @param radius The radius of the cylinder to emit from
  12599. * @param height The height of the emission cylinder
  12600. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  12601. * @param direction1 Particles are emitted between the direction1 and direction2 from within the cylinder
  12602. * @param direction2 Particles are emitted between the direction1 and direction2 from within the cylinder
  12603. * @returns the emitter
  12604. */
  12605. createDirectedCylinderEmitter(radius?: number, height?: number, radiusRange?: number, direction1?: Vector3, direction2?: Vector3): CylinderDirectedParticleEmitter;
  12606. /**
  12607. * Creates a Cone Emitter for the particle system (emits from the cone to the particle position)
  12608. * @param radius The radius of the cone to emit from
  12609. * @param angle The base angle of the cone
  12610. * @returns the emitter
  12611. */
  12612. createConeEmitter(radius?: number, angle?: number): ConeParticleEmitter;
  12613. /**
  12614. * Creates a Box Emitter for the particle system. (emits between direction1 and direction2 from withing the box defined by minEmitBox and maxEmitBox)
  12615. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  12616. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  12617. * @param minEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  12618. * @param maxEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  12619. * @returns the emitter
  12620. */
  12621. createBoxEmitter(direction1: Vector3, direction2: Vector3, minEmitBox: Vector3, maxEmitBox: Vector3): BoxParticleEmitter;
  12622. }
  12623. }
  12624. declare module "babylonjs/Particles/subEmitter" {
  12625. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  12626. import { Scene } from "babylonjs/scene";
  12627. import { ParticleSystem } from "babylonjs/Particles/particleSystem";
  12628. /**
  12629. * Type of sub emitter
  12630. */
  12631. export enum SubEmitterType {
  12632. /**
  12633. * Attached to the particle over it's lifetime
  12634. */
  12635. ATTACHED = 0,
  12636. /**
  12637. * Created when the particle dies
  12638. */
  12639. END = 1
  12640. }
  12641. /**
  12642. * Sub emitter class used to emit particles from an existing particle
  12643. */
  12644. export class SubEmitter {
  12645. /**
  12646. * the particle system to be used by the sub emitter
  12647. */
  12648. particleSystem: ParticleSystem;
  12649. /**
  12650. * Type of the submitter (Default: END)
  12651. */
  12652. type: SubEmitterType;
  12653. /**
  12654. * If the particle should inherit the direction from the particle it's attached to. (+Y will face the direction the particle is moving) (Default: false)
  12655. * Note: This only is supported when using an emitter of type Mesh
  12656. */
  12657. inheritDirection: boolean;
  12658. /**
  12659. * How much of the attached particles speed should be added to the sub emitted particle (default: 0)
  12660. */
  12661. inheritedVelocityAmount: number;
  12662. /**
  12663. * Creates a sub emitter
  12664. * @param particleSystem the particle system to be used by the sub emitter
  12665. */
  12666. constructor(
  12667. /**
  12668. * the particle system to be used by the sub emitter
  12669. */
  12670. particleSystem: ParticleSystem);
  12671. /**
  12672. * Clones the sub emitter
  12673. * @returns the cloned sub emitter
  12674. */
  12675. clone(): SubEmitter;
  12676. /**
  12677. * Serialize current object to a JSON object
  12678. * @returns the serialized object
  12679. */
  12680. serialize(): any;
  12681. /** @hidden */
  12682. static _ParseParticleSystem(system: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string): ParticleSystem;
  12683. /**
  12684. * Creates a new SubEmitter from a serialized JSON version
  12685. * @param serializationObject defines the JSON object to read from
  12686. * @param sceneOrEngine defines the hosting scene or the hosting engine
  12687. * @param rootUrl defines the rootUrl for data loading
  12688. * @returns a new SubEmitter
  12689. */
  12690. static Parse(serializationObject: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string): SubEmitter;
  12691. /** Release associated resources */
  12692. dispose(): void;
  12693. }
  12694. }
  12695. declare module "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration" {
  12696. /** @hidden */
  12697. export var imageProcessingDeclaration: {
  12698. name: string;
  12699. shader: string;
  12700. };
  12701. }
  12702. declare module "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions" {
  12703. /** @hidden */
  12704. export var imageProcessingFunctions: {
  12705. name: string;
  12706. shader: string;
  12707. };
  12708. }
  12709. declare module "babylonjs/Shaders/particles.fragment" {
  12710. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  12711. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  12712. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  12713. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  12714. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  12715. /** @hidden */
  12716. export var particlesPixelShader: {
  12717. name: string;
  12718. shader: string;
  12719. };
  12720. }
  12721. declare module "babylonjs/Shaders/particles.vertex" {
  12722. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  12723. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  12724. /** @hidden */
  12725. export var particlesVertexShader: {
  12726. name: string;
  12727. shader: string;
  12728. };
  12729. }
  12730. declare module "babylonjs/Misc/interfaces/iClipPlanesHolder" {
  12731. import { Nullable } from "babylonjs/types";
  12732. import { Plane } from "babylonjs/Maths/math";
  12733. /**
  12734. * Interface used to define entities containing multiple clip planes
  12735. */
  12736. export interface IClipPlanesHolder {
  12737. /**
  12738. * Gets or sets the active clipplane 1
  12739. */
  12740. clipPlane: Nullable<Plane>;
  12741. /**
  12742. * Gets or sets the active clipplane 2
  12743. */
  12744. clipPlane2: Nullable<Plane>;
  12745. /**
  12746. * Gets or sets the active clipplane 3
  12747. */
  12748. clipPlane3: Nullable<Plane>;
  12749. /**
  12750. * Gets or sets the active clipplane 4
  12751. */
  12752. clipPlane4: Nullable<Plane>;
  12753. /**
  12754. * Gets or sets the active clipplane 5
  12755. */
  12756. clipPlane5: Nullable<Plane>;
  12757. /**
  12758. * Gets or sets the active clipplane 6
  12759. */
  12760. clipPlane6: Nullable<Plane>;
  12761. }
  12762. }
  12763. declare module "babylonjs/Materials/thinMaterialHelper" {
  12764. import { Effect } from "babylonjs/Materials/effect";
  12765. import { IClipPlanesHolder } from "babylonjs/Misc/interfaces/iClipPlanesHolder";
  12766. /**
  12767. * "Static Class" containing a few commonly used helper while dealing with material for rendering purpose.
  12768. *
  12769. * It is complementary with MaterialHelper but provides completely independent functions (for tree shaking sake)
  12770. *
  12771. * This works by convention in BabylonJS but is meant to be use only with shader following the in place naming rules and conventions.
  12772. */
  12773. export class ThinMaterialHelper {
  12774. /**
  12775. * Binds the clip plane information from the holder to the effect.
  12776. * @param effect The effect we are binding the data to
  12777. * @param holder The entity containing the clip plane information
  12778. */
  12779. static BindClipPlane(effect: Effect, holder: IClipPlanesHolder): void;
  12780. }
  12781. }
  12782. declare module "babylonjs/Engines/Extensions/engine.alpha" {
  12783. module "babylonjs/Engines/thinEngine" {
  12784. interface ThinEngine {
  12785. /**
  12786. * Sets alpha constants used by some alpha blending modes
  12787. * @param r defines the red component
  12788. * @param g defines the green component
  12789. * @param b defines the blue component
  12790. * @param a defines the alpha component
  12791. */
  12792. setAlphaConstants(r: number, g: number, b: number, a: number): void;
  12793. /**
  12794. * Sets the current alpha mode
  12795. * @param mode defines the mode to use (one of the Engine.ALPHA_XXX)
  12796. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  12797. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  12798. */
  12799. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  12800. /**
  12801. * Gets the current alpha mode
  12802. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  12803. * @returns the current alpha mode
  12804. */
  12805. getAlphaMode(): number;
  12806. /**
  12807. * Sets the current alpha equation
  12808. * @param equation defines the equation to use (one of the Engine.ALPHA_EQUATION_XXX)
  12809. */
  12810. setAlphaEquation(equation: number): void;
  12811. /**
  12812. * Gets the current alpha equation.
  12813. * @returns the current alpha equation
  12814. */
  12815. getAlphaEquation(): number;
  12816. }
  12817. }
  12818. }
  12819. declare module "babylonjs/Particles/particleSystem" {
  12820. import { Nullable } from "babylonjs/types";
  12821. import { FactorGradient, Color3Gradient } from "babylonjs/Misc/gradients";
  12822. import { Observable } from "babylonjs/Misc/observable";
  12823. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  12824. import { Effect } from "babylonjs/Materials/effect";
  12825. import { IDisposable } from "babylonjs/scene";
  12826. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  12827. import { BaseParticleSystem } from "babylonjs/Particles/baseParticleSystem";
  12828. import { Particle } from "babylonjs/Particles/particle";
  12829. import { SubEmitter } from "babylonjs/Particles/subEmitter";
  12830. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  12831. import "babylonjs/Shaders/particles.fragment";
  12832. import "babylonjs/Shaders/particles.vertex";
  12833. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  12834. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  12835. import "babylonjs/Engines/Extensions/engine.alpha";
  12836. import { Scene } from "babylonjs/scene";
  12837. /**
  12838. * This represents a particle system in Babylon.
  12839. * Particles are often small sprites used to simulate hard-to-reproduce phenomena like fire, smoke, water, or abstract visual effects like magic glitter and faery dust.
  12840. * Particles can take different shapes while emitted like box, sphere, cone or you can write your custom function.
  12841. * @example https://doc.babylonjs.com/babylon101/particles
  12842. */
  12843. export class ParticleSystem extends BaseParticleSystem implements IDisposable, IAnimatable, IParticleSystem {
  12844. /**
  12845. * Billboard mode will only apply to Y axis
  12846. */
  12847. static readonly BILLBOARDMODE_Y: number;
  12848. /**
  12849. * Billboard mode will apply to all axes
  12850. */
  12851. static readonly BILLBOARDMODE_ALL: number;
  12852. /**
  12853. * Special billboard mode where the particle will be biilboard to the camera but rotated to align with direction
  12854. */
  12855. static readonly BILLBOARDMODE_STRETCHED: number;
  12856. /**
  12857. * This function can be defined to provide custom update for active particles.
  12858. * This function will be called instead of regular update (age, position, color, etc.).
  12859. * Do not forget that this function will be called on every frame so try to keep it simple and fast :)
  12860. */
  12861. updateFunction: (particles: Particle[]) => void;
  12862. private _emitterWorldMatrix;
  12863. /**
  12864. * This function can be defined to specify initial direction for every new particle.
  12865. * It by default use the emitterType defined function
  12866. */
  12867. startDirectionFunction: (worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean) => void;
  12868. /**
  12869. * This function can be defined to specify initial position for every new particle.
  12870. * It by default use the emitterType defined function
  12871. */
  12872. startPositionFunction: (worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean) => void;
  12873. /**
  12874. * @hidden
  12875. */
  12876. _inheritedVelocityOffset: Vector3;
  12877. /**
  12878. * An event triggered when the system is disposed
  12879. */
  12880. onDisposeObservable: Observable<IParticleSystem>;
  12881. private _onDisposeObserver;
  12882. /**
  12883. * Sets a callback that will be triggered when the system is disposed
  12884. */
  12885. set onDispose(callback: () => void);
  12886. private _particles;
  12887. private _epsilon;
  12888. private _capacity;
  12889. private _stockParticles;
  12890. private _newPartsExcess;
  12891. private _vertexData;
  12892. private _vertexBuffer;
  12893. private _vertexBuffers;
  12894. private _spriteBuffer;
  12895. private _indexBuffer;
  12896. private _effect;
  12897. private _customEffect;
  12898. private _cachedDefines;
  12899. private _scaledColorStep;
  12900. private _colorDiff;
  12901. private _scaledDirection;
  12902. private _scaledGravity;
  12903. private _currentRenderId;
  12904. private _alive;
  12905. private _useInstancing;
  12906. private _started;
  12907. private _stopped;
  12908. private _actualFrame;
  12909. private _scaledUpdateSpeed;
  12910. private _vertexBufferSize;
  12911. /** @hidden */
  12912. _currentEmitRateGradient: Nullable<FactorGradient>;
  12913. /** @hidden */
  12914. _currentEmitRate1: number;
  12915. /** @hidden */
  12916. _currentEmitRate2: number;
  12917. /** @hidden */
  12918. _currentStartSizeGradient: Nullable<FactorGradient>;
  12919. /** @hidden */
  12920. _currentStartSize1: number;
  12921. /** @hidden */
  12922. _currentStartSize2: number;
  12923. private readonly _rawTextureWidth;
  12924. private _rampGradientsTexture;
  12925. private _useRampGradients;
  12926. /** Gets or sets a matrix to use to compute projection */
  12927. defaultProjectionMatrix: Matrix;
  12928. /** Gets or sets a matrix to use to compute view */
  12929. defaultViewMatrix: Matrix;
  12930. /** Gets or sets a boolean indicating that ramp gradients must be used
  12931. * @see https://doc.babylonjs.com/babylon101/particles#ramp-gradients
  12932. */
  12933. get useRampGradients(): boolean;
  12934. set useRampGradients(value: boolean);
  12935. /**
  12936. * The Sub-emitters templates that will be used to generate the sub particle system to be associated with the system, this property is used by the root particle system only.
  12937. * When a particle is spawned, an array will be chosen at random and all the emitters in that array will be attached to the particle. (Default: [])
  12938. */
  12939. subEmitters: Array<ParticleSystem | SubEmitter | Array<SubEmitter>>;
  12940. private _subEmitters;
  12941. /**
  12942. * @hidden
  12943. * If the particle systems emitter should be disposed when the particle system is disposed
  12944. */
  12945. _disposeEmitterOnDispose: boolean;
  12946. /**
  12947. * The current active Sub-systems, this property is used by the root particle system only.
  12948. */
  12949. activeSubSystems: Array<ParticleSystem>;
  12950. /**
  12951. * Specifies if the particles are updated in emitter local space or world space
  12952. */
  12953. isLocal: boolean;
  12954. private _rootParticleSystem;
  12955. /**
  12956. * Gets the current list of active particles
  12957. */
  12958. get particles(): Particle[];
  12959. /**
  12960. * Gets the number of particles active at the same time.
  12961. * @returns The number of active particles.
  12962. */
  12963. getActiveCount(): number;
  12964. /**
  12965. * Returns the string "ParticleSystem"
  12966. * @returns a string containing the class name
  12967. */
  12968. getClassName(): string;
  12969. /**
  12970. * Gets a boolean indicating that the system is stopping
  12971. * @returns true if the system is currently stopping
  12972. */
  12973. isStopping(): boolean;
  12974. /**
  12975. * Gets the custom effect used to render the particles
  12976. * @param blendMode Blend mode for which the effect should be retrieved
  12977. * @returns The effect
  12978. */
  12979. getCustomEffect(blendMode?: number): Nullable<Effect>;
  12980. /**
  12981. * Sets the custom effect used to render the particles
  12982. * @param effect The effect to set
  12983. * @param blendMode Blend mode for which the effect should be set
  12984. */
  12985. setCustomEffect(effect: Nullable<Effect>, blendMode?: number): void;
  12986. /** @hidden */
  12987. private _onBeforeDrawParticlesObservable;
  12988. /**
  12989. * Observable that will be called just before the particles are drawn
  12990. */
  12991. get onBeforeDrawParticlesObservable(): Observable<Nullable<Effect>>;
  12992. /**
  12993. * Gets the name of the particle vertex shader
  12994. */
  12995. get vertexShaderName(): string;
  12996. /**
  12997. * Instantiates a particle system.
  12998. * Particles are often small sprites used to simulate hard-to-reproduce phenomena like fire, smoke, water, or abstract visual effects like magic glitter and faery dust.
  12999. * @param name The name of the particle system
  13000. * @param capacity The max number of particles alive at the same time
  13001. * @param sceneOrEngine The scene the particle system belongs to or the engine to use if no scene
  13002. * @param customEffect a custom effect used to change the way particles are rendered by default
  13003. * @param isAnimationSheetEnabled Must be true if using a spritesheet to animate the particles texture
  13004. * @param epsilon Offset used to render the particles
  13005. */
  13006. constructor(name: string, capacity: number, sceneOrEngine: Scene | ThinEngine, customEffect?: Nullable<Effect>, isAnimationSheetEnabled?: boolean, epsilon?: number);
  13007. private _addFactorGradient;
  13008. private _removeFactorGradient;
  13009. /**
  13010. * Adds a new life time gradient
  13011. * @param gradient defines the gradient to use (between 0 and 1)
  13012. * @param factor defines the life time factor to affect to the specified gradient
  13013. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  13014. * @returns the current particle system
  13015. */
  13016. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  13017. /**
  13018. * Remove a specific life time gradient
  13019. * @param gradient defines the gradient to remove
  13020. * @returns the current particle system
  13021. */
  13022. removeLifeTimeGradient(gradient: number): IParticleSystem;
  13023. /**
  13024. * Adds a new size gradient
  13025. * @param gradient defines the gradient to use (between 0 and 1)
  13026. * @param factor defines the size factor to affect to the specified gradient
  13027. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  13028. * @returns the current particle system
  13029. */
  13030. addSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  13031. /**
  13032. * Remove a specific size gradient
  13033. * @param gradient defines the gradient to remove
  13034. * @returns the current particle system
  13035. */
  13036. removeSizeGradient(gradient: number): IParticleSystem;
  13037. /**
  13038. * Adds a new color remap gradient
  13039. * @param gradient defines the gradient to use (between 0 and 1)
  13040. * @param min defines the color remap minimal range
  13041. * @param max defines the color remap maximal range
  13042. * @returns the current particle system
  13043. */
  13044. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  13045. /**
  13046. * Remove a specific color remap gradient
  13047. * @param gradient defines the gradient to remove
  13048. * @returns the current particle system
  13049. */
  13050. removeColorRemapGradient(gradient: number): IParticleSystem;
  13051. /**
  13052. * Adds a new alpha remap gradient
  13053. * @param gradient defines the gradient to use (between 0 and 1)
  13054. * @param min defines the alpha remap minimal range
  13055. * @param max defines the alpha remap maximal range
  13056. * @returns the current particle system
  13057. */
  13058. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  13059. /**
  13060. * Remove a specific alpha remap gradient
  13061. * @param gradient defines the gradient to remove
  13062. * @returns the current particle system
  13063. */
  13064. removeAlphaRemapGradient(gradient: number): IParticleSystem;
  13065. /**
  13066. * Adds a new angular speed gradient
  13067. * @param gradient defines the gradient to use (between 0 and 1)
  13068. * @param factor defines the angular speed to affect to the specified gradient
  13069. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  13070. * @returns the current particle system
  13071. */
  13072. addAngularSpeedGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  13073. /**
  13074. * Remove a specific angular speed gradient
  13075. * @param gradient defines the gradient to remove
  13076. * @returns the current particle system
  13077. */
  13078. removeAngularSpeedGradient(gradient: number): IParticleSystem;
  13079. /**
  13080. * Adds a new velocity gradient
  13081. * @param gradient defines the gradient to use (between 0 and 1)
  13082. * @param factor defines the velocity to affect to the specified gradient
  13083. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  13084. * @returns the current particle system
  13085. */
  13086. addVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  13087. /**
  13088. * Remove a specific velocity gradient
  13089. * @param gradient defines the gradient to remove
  13090. * @returns the current particle system
  13091. */
  13092. removeVelocityGradient(gradient: number): IParticleSystem;
  13093. /**
  13094. * Adds a new limit velocity gradient
  13095. * @param gradient defines the gradient to use (between 0 and 1)
  13096. * @param factor defines the limit velocity value to affect to the specified gradient
  13097. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  13098. * @returns the current particle system
  13099. */
  13100. addLimitVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  13101. /**
  13102. * Remove a specific limit velocity gradient
  13103. * @param gradient defines the gradient to remove
  13104. * @returns the current particle system
  13105. */
  13106. removeLimitVelocityGradient(gradient: number): IParticleSystem;
  13107. /**
  13108. * Adds a new drag gradient
  13109. * @param gradient defines the gradient to use (between 0 and 1)
  13110. * @param factor defines the drag value to affect to the specified gradient
  13111. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  13112. * @returns the current particle system
  13113. */
  13114. addDragGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  13115. /**
  13116. * Remove a specific drag gradient
  13117. * @param gradient defines the gradient to remove
  13118. * @returns the current particle system
  13119. */
  13120. removeDragGradient(gradient: number): IParticleSystem;
  13121. /**
  13122. * Adds a new emit rate gradient (please note that this will only work if you set the targetStopDuration property)
  13123. * @param gradient defines the gradient to use (between 0 and 1)
  13124. * @param factor defines the emit rate value to affect to the specified gradient
  13125. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  13126. * @returns the current particle system
  13127. */
  13128. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  13129. /**
  13130. * Remove a specific emit rate gradient
  13131. * @param gradient defines the gradient to remove
  13132. * @returns the current particle system
  13133. */
  13134. removeEmitRateGradient(gradient: number): IParticleSystem;
  13135. /**
  13136. * Adds a new start size gradient (please note that this will only work if you set the targetStopDuration property)
  13137. * @param gradient defines the gradient to use (between 0 and 1)
  13138. * @param factor defines the start size value to affect to the specified gradient
  13139. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  13140. * @returns the current particle system
  13141. */
  13142. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  13143. /**
  13144. * Remove a specific start size gradient
  13145. * @param gradient defines the gradient to remove
  13146. * @returns the current particle system
  13147. */
  13148. removeStartSizeGradient(gradient: number): IParticleSystem;
  13149. private _createRampGradientTexture;
  13150. /**
  13151. * Gets the current list of ramp gradients.
  13152. * You must use addRampGradient and removeRampGradient to udpate this list
  13153. * @returns the list of ramp gradients
  13154. */
  13155. getRampGradients(): Nullable<Array<Color3Gradient>>;
  13156. /** Force the system to rebuild all gradients that need to be resync */
  13157. forceRefreshGradients(): void;
  13158. private _syncRampGradientTexture;
  13159. /**
  13160. * Adds a new ramp gradient used to remap particle colors
  13161. * @param gradient defines the gradient to use (between 0 and 1)
  13162. * @param color defines the color to affect to the specified gradient
  13163. * @returns the current particle system
  13164. */
  13165. addRampGradient(gradient: number, color: Color3): ParticleSystem;
  13166. /**
  13167. * Remove a specific ramp gradient
  13168. * @param gradient defines the gradient to remove
  13169. * @returns the current particle system
  13170. */
  13171. removeRampGradient(gradient: number): ParticleSystem;
  13172. /**
  13173. * Adds a new color gradient
  13174. * @param gradient defines the gradient to use (between 0 and 1)
  13175. * @param color1 defines the color to affect to the specified gradient
  13176. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  13177. * @returns this particle system
  13178. */
  13179. addColorGradient(gradient: number, color1: Color4, color2?: Color4): IParticleSystem;
  13180. /**
  13181. * Remove a specific color gradient
  13182. * @param gradient defines the gradient to remove
  13183. * @returns this particle system
  13184. */
  13185. removeColorGradient(gradient: number): IParticleSystem;
  13186. private _fetchR;
  13187. protected _reset(): void;
  13188. private _resetEffect;
  13189. private _createVertexBuffers;
  13190. private _createIndexBuffer;
  13191. /**
  13192. * Gets the maximum number of particles active at the same time.
  13193. * @returns The max number of active particles.
  13194. */
  13195. getCapacity(): number;
  13196. /**
  13197. * Gets whether there are still active particles in the system.
  13198. * @returns True if it is alive, otherwise false.
  13199. */
  13200. isAlive(): boolean;
  13201. /**
  13202. * Gets if the system has been started. (Note: this will still be true after stop is called)
  13203. * @returns True if it has been started, otherwise false.
  13204. */
  13205. isStarted(): boolean;
  13206. private _prepareSubEmitterInternalArray;
  13207. /**
  13208. * Starts the particle system and begins to emit
  13209. * @param delay defines the delay in milliseconds before starting the system (this.startDelay by default)
  13210. */
  13211. start(delay?: number): void;
  13212. /**
  13213. * Stops the particle system.
  13214. * @param stopSubEmitters if true it will stop the current system and all created sub-Systems if false it will stop the current root system only, this param is used by the root particle system only. the default value is true.
  13215. */
  13216. stop(stopSubEmitters?: boolean): void;
  13217. /**
  13218. * Remove all active particles
  13219. */
  13220. reset(): void;
  13221. /**
  13222. * @hidden (for internal use only)
  13223. */
  13224. _appendParticleVertex(index: number, particle: Particle, offsetX: number, offsetY: number): void;
  13225. /**
  13226. * "Recycles" one of the particle by copying it back to the "stock" of particles and removing it from the active list.
  13227. * Its lifetime will start back at 0.
  13228. */
  13229. recycleParticle: (particle: Particle) => void;
  13230. private _stopSubEmitters;
  13231. private _createParticle;
  13232. private _removeFromRoot;
  13233. private _emitFromParticle;
  13234. private _update;
  13235. /** @hidden */
  13236. static _GetAttributeNamesOrOptions(isAnimationSheetEnabled?: boolean, isBillboardBased?: boolean, useRampGradients?: boolean): string[];
  13237. /** @hidden */
  13238. static _GetEffectCreationOptions(isAnimationSheetEnabled?: boolean): string[];
  13239. /**
  13240. * Fill the defines array according to the current settings of the particle system
  13241. * @param defines Array to be updated
  13242. * @param blendMode blend mode to take into account when updating the array
  13243. */
  13244. fillDefines(defines: Array<string>, blendMode: number): void;
  13245. /**
  13246. * Fill the uniforms, attributes and samplers arrays according to the current settings of the particle system
  13247. * @param uniforms Uniforms array to fill
  13248. * @param attributes Attributes array to fill
  13249. * @param samplers Samplers array to fill
  13250. */
  13251. fillUniformsAttributesAndSamplerNames(uniforms: Array<string>, attributes: Array<string>, samplers: Array<string>): void;
  13252. /** @hidden */
  13253. private _getEffect;
  13254. /**
  13255. * Animates the particle system for the current frame by emitting new particles and or animating the living ones.
  13256. * @param preWarmOnly will prevent the system from updating the vertex buffer (default is false)
  13257. */
  13258. animate(preWarmOnly?: boolean): void;
  13259. private _appendParticleVertices;
  13260. /**
  13261. * Rebuilds the particle system.
  13262. */
  13263. rebuild(): void;
  13264. /**
  13265. * Is this system ready to be used/rendered
  13266. * @return true if the system is ready
  13267. */
  13268. isReady(): boolean;
  13269. private _render;
  13270. /**
  13271. * Renders the particle system in its current state.
  13272. * @returns the current number of particles
  13273. */
  13274. render(): number;
  13275. /**
  13276. * Disposes the particle system and free the associated resources
  13277. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  13278. */
  13279. dispose(disposeTexture?: boolean): void;
  13280. /**
  13281. * Clones the particle system.
  13282. * @param name The name of the cloned object
  13283. * @param newEmitter The new emitter to use
  13284. * @returns the cloned particle system
  13285. */
  13286. clone(name: string, newEmitter: any): ParticleSystem;
  13287. /**
  13288. * Serializes the particle system to a JSON object
  13289. * @param serializeTexture defines if the texture must be serialized as well
  13290. * @returns the JSON object
  13291. */
  13292. serialize(serializeTexture?: boolean): any;
  13293. /** @hidden */
  13294. static _Serialize(serializationObject: any, particleSystem: IParticleSystem, serializeTexture: boolean): void;
  13295. /** @hidden */
  13296. static _Parse(parsedParticleSystem: any, particleSystem: IParticleSystem, sceneOrEngine: Scene | ThinEngine, rootUrl: string): void;
  13297. /**
  13298. * Parses a JSON object to create a particle system.
  13299. * @param parsedParticleSystem The JSON object to parse
  13300. * @param sceneOrEngine The scene or the engine to create the particle system in
  13301. * @param rootUrl The root url to use to load external dependencies like texture
  13302. * @param doNotStart Ignore the preventAutoStart attribute and does not start
  13303. * @returns the Parsed particle system
  13304. */
  13305. static Parse(parsedParticleSystem: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string, doNotStart?: boolean): ParticleSystem;
  13306. }
  13307. }
  13308. declare module "babylonjs/Particles/particle" {
  13309. import { Nullable } from "babylonjs/types";
  13310. import { Vector2, Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  13311. import { Color4 } from "babylonjs/Maths/math.color";
  13312. import { ParticleSystem } from "babylonjs/Particles/particleSystem";
  13313. import { SubEmitter } from "babylonjs/Particles/subEmitter";
  13314. import { ColorGradient, FactorGradient } from "babylonjs/Misc/gradients";
  13315. /**
  13316. * A particle represents one of the element emitted by a particle system.
  13317. * This is mainly define by its coordinates, direction, velocity and age.
  13318. */
  13319. export class Particle {
  13320. /**
  13321. * The particle system the particle belongs to.
  13322. */
  13323. particleSystem: ParticleSystem;
  13324. private static _Count;
  13325. /**
  13326. * Unique ID of the particle
  13327. */
  13328. id: number;
  13329. /**
  13330. * The world position of the particle in the scene.
  13331. */
  13332. position: Vector3;
  13333. /**
  13334. * The world direction of the particle in the scene.
  13335. */
  13336. direction: Vector3;
  13337. /**
  13338. * The color of the particle.
  13339. */
  13340. color: Color4;
  13341. /**
  13342. * The color change of the particle per step.
  13343. */
  13344. colorStep: Color4;
  13345. /**
  13346. * Defines how long will the life of the particle be.
  13347. */
  13348. lifeTime: number;
  13349. /**
  13350. * The current age of the particle.
  13351. */
  13352. age: number;
  13353. /**
  13354. * The current size of the particle.
  13355. */
  13356. size: number;
  13357. /**
  13358. * The current scale of the particle.
  13359. */
  13360. scale: Vector2;
  13361. /**
  13362. * The current angle of the particle.
  13363. */
  13364. angle: number;
  13365. /**
  13366. * Defines how fast is the angle changing.
  13367. */
  13368. angularSpeed: number;
  13369. /**
  13370. * Defines the cell index used by the particle to be rendered from a sprite.
  13371. */
  13372. cellIndex: number;
  13373. /**
  13374. * The information required to support color remapping
  13375. */
  13376. remapData: Vector4;
  13377. /** @hidden */
  13378. _randomCellOffset?: number;
  13379. /** @hidden */
  13380. _initialDirection: Nullable<Vector3>;
  13381. /** @hidden */
  13382. _attachedSubEmitters: Nullable<Array<SubEmitter>>;
  13383. /** @hidden */
  13384. _initialStartSpriteCellID: number;
  13385. /** @hidden */
  13386. _initialEndSpriteCellID: number;
  13387. /** @hidden */
  13388. _currentColorGradient: Nullable<ColorGradient>;
  13389. /** @hidden */
  13390. _currentColor1: Color4;
  13391. /** @hidden */
  13392. _currentColor2: Color4;
  13393. /** @hidden */
  13394. _currentSizeGradient: Nullable<FactorGradient>;
  13395. /** @hidden */
  13396. _currentSize1: number;
  13397. /** @hidden */
  13398. _currentSize2: number;
  13399. /** @hidden */
  13400. _currentAngularSpeedGradient: Nullable<FactorGradient>;
  13401. /** @hidden */
  13402. _currentAngularSpeed1: number;
  13403. /** @hidden */
  13404. _currentAngularSpeed2: number;
  13405. /** @hidden */
  13406. _currentVelocityGradient: Nullable<FactorGradient>;
  13407. /** @hidden */
  13408. _currentVelocity1: number;
  13409. /** @hidden */
  13410. _currentVelocity2: number;
  13411. /** @hidden */
  13412. _currentLimitVelocityGradient: Nullable<FactorGradient>;
  13413. /** @hidden */
  13414. _currentLimitVelocity1: number;
  13415. /** @hidden */
  13416. _currentLimitVelocity2: number;
  13417. /** @hidden */
  13418. _currentDragGradient: Nullable<FactorGradient>;
  13419. /** @hidden */
  13420. _currentDrag1: number;
  13421. /** @hidden */
  13422. _currentDrag2: number;
  13423. /** @hidden */
  13424. _randomNoiseCoordinates1: Vector3;
  13425. /** @hidden */
  13426. _randomNoiseCoordinates2: Vector3;
  13427. /** @hidden */
  13428. _localPosition?: Vector3;
  13429. /**
  13430. * Creates a new instance Particle
  13431. * @param particleSystem the particle system the particle belongs to
  13432. */
  13433. constructor(
  13434. /**
  13435. * The particle system the particle belongs to.
  13436. */
  13437. particleSystem: ParticleSystem);
  13438. private updateCellInfoFromSystem;
  13439. /**
  13440. * Defines how the sprite cell index is updated for the particle
  13441. */
  13442. updateCellIndex(): void;
  13443. /** @hidden */
  13444. _inheritParticleInfoToSubEmitter(subEmitter: SubEmitter): void;
  13445. /** @hidden */
  13446. _inheritParticleInfoToSubEmitters(): void;
  13447. /** @hidden */
  13448. _reset(): void;
  13449. /**
  13450. * Copy the properties of particle to another one.
  13451. * @param other the particle to copy the information to.
  13452. */
  13453. copyTo(other: Particle): void;
  13454. }
  13455. }
  13456. declare module "babylonjs/Particles/EmitterTypes/IParticleEmitterType" {
  13457. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  13458. import { Effect } from "babylonjs/Materials/effect";
  13459. import { Particle } from "babylonjs/Particles/particle";
  13460. import { Nullable } from "babylonjs/types";
  13461. import { Scene } from "babylonjs/scene";
  13462. /**
  13463. * Particle emitter represents a volume emitting particles.
  13464. * This is the responsibility of the implementation to define the volume shape like cone/sphere/box.
  13465. */
  13466. export interface IParticleEmitterType {
  13467. /**
  13468. * Called by the particle System when the direction is computed for the created particle.
  13469. * @param worldMatrix is the world matrix of the particle system
  13470. * @param directionToUpdate is the direction vector to update with the result
  13471. * @param particle is the particle we are computed the direction for
  13472. * @param isLocal defines if the direction should be set in local space
  13473. */
  13474. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13475. /**
  13476. * Called by the particle System when the position is computed for the created particle.
  13477. * @param worldMatrix is the world matrix of the particle system
  13478. * @param positionToUpdate is the position vector to update with the result
  13479. * @param particle is the particle we are computed the position for
  13480. * @param isLocal defines if the position should be set in local space
  13481. */
  13482. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13483. /**
  13484. * Clones the current emitter and returns a copy of it
  13485. * @returns the new emitter
  13486. */
  13487. clone(): IParticleEmitterType;
  13488. /**
  13489. * Called by the GPUParticleSystem to setup the update shader
  13490. * @param effect defines the update shader
  13491. */
  13492. applyToShader(effect: Effect): void;
  13493. /**
  13494. * Returns a string to use to update the GPU particles update shader
  13495. * @returns the effect defines string
  13496. */
  13497. getEffectDefines(): string;
  13498. /**
  13499. * Returns a string representing the class name
  13500. * @returns a string containing the class name
  13501. */
  13502. getClassName(): string;
  13503. /**
  13504. * Serializes the particle system to a JSON object.
  13505. * @returns the JSON object
  13506. */
  13507. serialize(): any;
  13508. /**
  13509. * Parse properties from a JSON object
  13510. * @param serializationObject defines the JSON object
  13511. * @param scene defines the hosting scene
  13512. */
  13513. parse(serializationObject: any, scene: Nullable<Scene>): void;
  13514. }
  13515. }
  13516. declare module "babylonjs/Particles/EmitterTypes/boxParticleEmitter" {
  13517. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  13518. import { Effect } from "babylonjs/Materials/effect";
  13519. import { Particle } from "babylonjs/Particles/particle";
  13520. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  13521. /**
  13522. * Particle emitter emitting particles from the inside of a box.
  13523. * It emits the particles randomly between 2 given directions.
  13524. */
  13525. export class BoxParticleEmitter implements IParticleEmitterType {
  13526. /**
  13527. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  13528. */
  13529. direction1: Vector3;
  13530. /**
  13531. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  13532. */
  13533. direction2: Vector3;
  13534. /**
  13535. * Minimum box point around our emitter. Our emitter is the center of particles source, but if you want your particles to emit from more than one point, then you can tell it to do so.
  13536. */
  13537. minEmitBox: Vector3;
  13538. /**
  13539. * Maximum box point around our emitter. Our emitter is the center of particles source, but if you want your particles to emit from more than one point, then you can tell it to do so.
  13540. */
  13541. maxEmitBox: Vector3;
  13542. /**
  13543. * Creates a new instance BoxParticleEmitter
  13544. */
  13545. constructor();
  13546. /**
  13547. * Called by the particle System when the direction is computed for the created particle.
  13548. * @param worldMatrix is the world matrix of the particle system
  13549. * @param directionToUpdate is the direction vector to update with the result
  13550. * @param particle is the particle we are computed the direction for
  13551. * @param isLocal defines if the direction should be set in local space
  13552. */
  13553. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13554. /**
  13555. * Called by the particle System when the position is computed for the created particle.
  13556. * @param worldMatrix is the world matrix of the particle system
  13557. * @param positionToUpdate is the position vector to update with the result
  13558. * @param particle is the particle we are computed the position for
  13559. * @param isLocal defines if the position should be set in local space
  13560. */
  13561. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13562. /**
  13563. * Clones the current emitter and returns a copy of it
  13564. * @returns the new emitter
  13565. */
  13566. clone(): BoxParticleEmitter;
  13567. /**
  13568. * Called by the GPUParticleSystem to setup the update shader
  13569. * @param effect defines the update shader
  13570. */
  13571. applyToShader(effect: Effect): void;
  13572. /**
  13573. * Returns a string to use to update the GPU particles update shader
  13574. * @returns a string containng the defines string
  13575. */
  13576. getEffectDefines(): string;
  13577. /**
  13578. * Returns the string "BoxParticleEmitter"
  13579. * @returns a string containing the class name
  13580. */
  13581. getClassName(): string;
  13582. /**
  13583. * Serializes the particle system to a JSON object.
  13584. * @returns the JSON object
  13585. */
  13586. serialize(): any;
  13587. /**
  13588. * Parse properties from a JSON object
  13589. * @param serializationObject defines the JSON object
  13590. */
  13591. parse(serializationObject: any): void;
  13592. }
  13593. }
  13594. declare module "babylonjs/Particles/EmitterTypes/coneParticleEmitter" {
  13595. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  13596. import { Effect } from "babylonjs/Materials/effect";
  13597. import { Particle } from "babylonjs/Particles/particle";
  13598. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  13599. /**
  13600. * Particle emitter emitting particles from the inside of a cone.
  13601. * It emits the particles alongside the cone volume from the base to the particle.
  13602. * The emission direction might be randomized.
  13603. */
  13604. export class ConeParticleEmitter implements IParticleEmitterType {
  13605. /** defines how much to randomize the particle direction [0-1] (default is 0) */
  13606. directionRandomizer: number;
  13607. private _radius;
  13608. private _angle;
  13609. private _height;
  13610. /**
  13611. * Gets or sets a value indicating where on the radius the start position should be picked (1 = everywhere, 0 = only surface)
  13612. */
  13613. radiusRange: number;
  13614. /**
  13615. * Gets or sets a value indicating where on the height the start position should be picked (1 = everywhere, 0 = only surface)
  13616. */
  13617. heightRange: number;
  13618. /**
  13619. * Gets or sets a value indicating if all the particles should be emitted from the spawn point only (the base of the cone)
  13620. */
  13621. emitFromSpawnPointOnly: boolean;
  13622. /**
  13623. * Gets or sets the radius of the emission cone
  13624. */
  13625. get radius(): number;
  13626. set radius(value: number);
  13627. /**
  13628. * Gets or sets the angle of the emission cone
  13629. */
  13630. get angle(): number;
  13631. set angle(value: number);
  13632. private _buildHeight;
  13633. /**
  13634. * Creates a new instance ConeParticleEmitter
  13635. * @param radius the radius of the emission cone (1 by default)
  13636. * @param angle the cone base angle (PI by default)
  13637. * @param directionRandomizer defines how much to randomize the particle direction [0-1] (default is 0)
  13638. */
  13639. constructor(radius?: number, angle?: number,
  13640. /** defines how much to randomize the particle direction [0-1] (default is 0) */
  13641. directionRandomizer?: number);
  13642. /**
  13643. * Called by the particle System when the direction is computed for the created particle.
  13644. * @param worldMatrix is the world matrix of the particle system
  13645. * @param directionToUpdate is the direction vector to update with the result
  13646. * @param particle is the particle we are computed the direction for
  13647. * @param isLocal defines if the direction should be set in local space
  13648. */
  13649. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13650. /**
  13651. * Called by the particle System when the position is computed for the created particle.
  13652. * @param worldMatrix is the world matrix of the particle system
  13653. * @param positionToUpdate is the position vector to update with the result
  13654. * @param particle is the particle we are computed the position for
  13655. * @param isLocal defines if the position should be set in local space
  13656. */
  13657. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13658. /**
  13659. * Clones the current emitter and returns a copy of it
  13660. * @returns the new emitter
  13661. */
  13662. clone(): ConeParticleEmitter;
  13663. /**
  13664. * Called by the GPUParticleSystem to setup the update shader
  13665. * @param effect defines the update shader
  13666. */
  13667. applyToShader(effect: Effect): void;
  13668. /**
  13669. * Returns a string to use to update the GPU particles update shader
  13670. * @returns a string containng the defines string
  13671. */
  13672. getEffectDefines(): string;
  13673. /**
  13674. * Returns the string "ConeParticleEmitter"
  13675. * @returns a string containing the class name
  13676. */
  13677. getClassName(): string;
  13678. /**
  13679. * Serializes the particle system to a JSON object.
  13680. * @returns the JSON object
  13681. */
  13682. serialize(): any;
  13683. /**
  13684. * Parse properties from a JSON object
  13685. * @param serializationObject defines the JSON object
  13686. */
  13687. parse(serializationObject: any): void;
  13688. }
  13689. }
  13690. declare module "babylonjs/Particles/EmitterTypes/cylinderParticleEmitter" {
  13691. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  13692. import { Effect } from "babylonjs/Materials/effect";
  13693. import { Particle } from "babylonjs/Particles/particle";
  13694. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  13695. /**
  13696. * Particle emitter emitting particles from the inside of a cylinder.
  13697. * It emits the particles alongside the cylinder radius. The emission direction might be randomized.
  13698. */
  13699. export class CylinderParticleEmitter implements IParticleEmitterType {
  13700. /**
  13701. * The radius of the emission cylinder.
  13702. */
  13703. radius: number;
  13704. /**
  13705. * The height of the emission cylinder.
  13706. */
  13707. height: number;
  13708. /**
  13709. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  13710. */
  13711. radiusRange: number;
  13712. /**
  13713. * How much to randomize the particle direction [0-1].
  13714. */
  13715. directionRandomizer: number;
  13716. /**
  13717. * Creates a new instance CylinderParticleEmitter
  13718. * @param radius the radius of the emission cylinder (1 by default)
  13719. * @param height the height of the emission cylinder (1 by default)
  13720. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  13721. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  13722. */
  13723. constructor(
  13724. /**
  13725. * The radius of the emission cylinder.
  13726. */
  13727. radius?: number,
  13728. /**
  13729. * The height of the emission cylinder.
  13730. */
  13731. height?: number,
  13732. /**
  13733. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  13734. */
  13735. radiusRange?: number,
  13736. /**
  13737. * How much to randomize the particle direction [0-1].
  13738. */
  13739. directionRandomizer?: number);
  13740. /**
  13741. * Called by the particle System when the direction is computed for the created particle.
  13742. * @param worldMatrix is the world matrix of the particle system
  13743. * @param directionToUpdate is the direction vector to update with the result
  13744. * @param particle is the particle we are computed the direction for
  13745. * @param isLocal defines if the direction should be set in local space
  13746. */
  13747. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13748. /**
  13749. * Called by the particle System when the position is computed for the created particle.
  13750. * @param worldMatrix is the world matrix of the particle system
  13751. * @param positionToUpdate is the position vector to update with the result
  13752. * @param particle is the particle we are computed the position for
  13753. * @param isLocal defines if the position should be set in local space
  13754. */
  13755. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13756. /**
  13757. * Clones the current emitter and returns a copy of it
  13758. * @returns the new emitter
  13759. */
  13760. clone(): CylinderParticleEmitter;
  13761. /**
  13762. * Called by the GPUParticleSystem to setup the update shader
  13763. * @param effect defines the update shader
  13764. */
  13765. applyToShader(effect: Effect): void;
  13766. /**
  13767. * Returns a string to use to update the GPU particles update shader
  13768. * @returns a string containng the defines string
  13769. */
  13770. getEffectDefines(): string;
  13771. /**
  13772. * Returns the string "CylinderParticleEmitter"
  13773. * @returns a string containing the class name
  13774. */
  13775. getClassName(): string;
  13776. /**
  13777. * Serializes the particle system to a JSON object.
  13778. * @returns the JSON object
  13779. */
  13780. serialize(): any;
  13781. /**
  13782. * Parse properties from a JSON object
  13783. * @param serializationObject defines the JSON object
  13784. */
  13785. parse(serializationObject: any): void;
  13786. }
  13787. /**
  13788. * Particle emitter emitting particles from the inside of a cylinder.
  13789. * It emits the particles randomly between two vectors.
  13790. */
  13791. export class CylinderDirectedParticleEmitter extends CylinderParticleEmitter {
  13792. /**
  13793. * The min limit of the emission direction.
  13794. */
  13795. direction1: Vector3;
  13796. /**
  13797. * The max limit of the emission direction.
  13798. */
  13799. direction2: Vector3;
  13800. /**
  13801. * Creates a new instance CylinderDirectedParticleEmitter
  13802. * @param radius the radius of the emission cylinder (1 by default)
  13803. * @param height the height of the emission cylinder (1 by default)
  13804. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  13805. * @param direction1 the min limit of the emission direction (up vector by default)
  13806. * @param direction2 the max limit of the emission direction (up vector by default)
  13807. */
  13808. constructor(radius?: number, height?: number, radiusRange?: number,
  13809. /**
  13810. * The min limit of the emission direction.
  13811. */
  13812. direction1?: Vector3,
  13813. /**
  13814. * The max limit of the emission direction.
  13815. */
  13816. direction2?: Vector3);
  13817. /**
  13818. * Called by the particle System when the direction is computed for the created particle.
  13819. * @param worldMatrix is the world matrix of the particle system
  13820. * @param directionToUpdate is the direction vector to update with the result
  13821. * @param particle is the particle we are computed the direction for
  13822. */
  13823. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  13824. /**
  13825. * Clones the current emitter and returns a copy of it
  13826. * @returns the new emitter
  13827. */
  13828. clone(): CylinderDirectedParticleEmitter;
  13829. /**
  13830. * Called by the GPUParticleSystem to setup the update shader
  13831. * @param effect defines the update shader
  13832. */
  13833. applyToShader(effect: Effect): void;
  13834. /**
  13835. * Returns a string to use to update the GPU particles update shader
  13836. * @returns a string containng the defines string
  13837. */
  13838. getEffectDefines(): string;
  13839. /**
  13840. * Returns the string "CylinderDirectedParticleEmitter"
  13841. * @returns a string containing the class name
  13842. */
  13843. getClassName(): string;
  13844. /**
  13845. * Serializes the particle system to a JSON object.
  13846. * @returns the JSON object
  13847. */
  13848. serialize(): any;
  13849. /**
  13850. * Parse properties from a JSON object
  13851. * @param serializationObject defines the JSON object
  13852. */
  13853. parse(serializationObject: any): void;
  13854. }
  13855. }
  13856. declare module "babylonjs/Particles/EmitterTypes/hemisphericParticleEmitter" {
  13857. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  13858. import { Effect } from "babylonjs/Materials/effect";
  13859. import { Particle } from "babylonjs/Particles/particle";
  13860. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  13861. /**
  13862. * Particle emitter emitting particles from the inside of a hemisphere.
  13863. * It emits the particles alongside the hemisphere radius. The emission direction might be randomized.
  13864. */
  13865. export class HemisphericParticleEmitter implements IParticleEmitterType {
  13866. /**
  13867. * The radius of the emission hemisphere.
  13868. */
  13869. radius: number;
  13870. /**
  13871. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  13872. */
  13873. radiusRange: number;
  13874. /**
  13875. * How much to randomize the particle direction [0-1].
  13876. */
  13877. directionRandomizer: number;
  13878. /**
  13879. * Creates a new instance HemisphericParticleEmitter
  13880. * @param radius the radius of the emission hemisphere (1 by default)
  13881. * @param radiusRange the range of the emission hemisphere [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  13882. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  13883. */
  13884. constructor(
  13885. /**
  13886. * The radius of the emission hemisphere.
  13887. */
  13888. radius?: number,
  13889. /**
  13890. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  13891. */
  13892. radiusRange?: number,
  13893. /**
  13894. * How much to randomize the particle direction [0-1].
  13895. */
  13896. directionRandomizer?: number);
  13897. /**
  13898. * Called by the particle System when the direction is computed for the created particle.
  13899. * @param worldMatrix is the world matrix of the particle system
  13900. * @param directionToUpdate is the direction vector to update with the result
  13901. * @param particle is the particle we are computed the direction for
  13902. * @param isLocal defines if the direction should be set in local space
  13903. */
  13904. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13905. /**
  13906. * Called by the particle System when the position is computed for the created particle.
  13907. * @param worldMatrix is the world matrix of the particle system
  13908. * @param positionToUpdate is the position vector to update with the result
  13909. * @param particle is the particle we are computed the position for
  13910. * @param isLocal defines if the position should be set in local space
  13911. */
  13912. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13913. /**
  13914. * Clones the current emitter and returns a copy of it
  13915. * @returns the new emitter
  13916. */
  13917. clone(): HemisphericParticleEmitter;
  13918. /**
  13919. * Called by the GPUParticleSystem to setup the update shader
  13920. * @param effect defines the update shader
  13921. */
  13922. applyToShader(effect: Effect): void;
  13923. /**
  13924. * Returns a string to use to update the GPU particles update shader
  13925. * @returns a string containng the defines string
  13926. */
  13927. getEffectDefines(): string;
  13928. /**
  13929. * Returns the string "HemisphericParticleEmitter"
  13930. * @returns a string containing the class name
  13931. */
  13932. getClassName(): string;
  13933. /**
  13934. * Serializes the particle system to a JSON object.
  13935. * @returns the JSON object
  13936. */
  13937. serialize(): any;
  13938. /**
  13939. * Parse properties from a JSON object
  13940. * @param serializationObject defines the JSON object
  13941. */
  13942. parse(serializationObject: any): void;
  13943. }
  13944. }
  13945. declare module "babylonjs/Particles/EmitterTypes/pointParticleEmitter" {
  13946. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  13947. import { Effect } from "babylonjs/Materials/effect";
  13948. import { Particle } from "babylonjs/Particles/particle";
  13949. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  13950. /**
  13951. * Particle emitter emitting particles from a point.
  13952. * It emits the particles randomly between 2 given directions.
  13953. */
  13954. export class PointParticleEmitter implements IParticleEmitterType {
  13955. /**
  13956. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  13957. */
  13958. direction1: Vector3;
  13959. /**
  13960. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  13961. */
  13962. direction2: Vector3;
  13963. /**
  13964. * Creates a new instance PointParticleEmitter
  13965. */
  13966. constructor();
  13967. /**
  13968. * Called by the particle System when the direction is computed for the created particle.
  13969. * @param worldMatrix is the world matrix of the particle system
  13970. * @param directionToUpdate is the direction vector to update with the result
  13971. * @param particle is the particle we are computed the direction for
  13972. * @param isLocal defines if the direction should be set in local space
  13973. */
  13974. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13975. /**
  13976. * Called by the particle System when the position is computed for the created particle.
  13977. * @param worldMatrix is the world matrix of the particle system
  13978. * @param positionToUpdate is the position vector to update with the result
  13979. * @param particle is the particle we are computed the position for
  13980. * @param isLocal defines if the position should be set in local space
  13981. */
  13982. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13983. /**
  13984. * Clones the current emitter and returns a copy of it
  13985. * @returns the new emitter
  13986. */
  13987. clone(): PointParticleEmitter;
  13988. /**
  13989. * Called by the GPUParticleSystem to setup the update shader
  13990. * @param effect defines the update shader
  13991. */
  13992. applyToShader(effect: Effect): void;
  13993. /**
  13994. * Returns a string to use to update the GPU particles update shader
  13995. * @returns a string containng the defines string
  13996. */
  13997. getEffectDefines(): string;
  13998. /**
  13999. * Returns the string "PointParticleEmitter"
  14000. * @returns a string containing the class name
  14001. */
  14002. getClassName(): string;
  14003. /**
  14004. * Serializes the particle system to a JSON object.
  14005. * @returns the JSON object
  14006. */
  14007. serialize(): any;
  14008. /**
  14009. * Parse properties from a JSON object
  14010. * @param serializationObject defines the JSON object
  14011. */
  14012. parse(serializationObject: any): void;
  14013. }
  14014. }
  14015. declare module "babylonjs/Particles/EmitterTypes/sphereParticleEmitter" {
  14016. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  14017. import { Effect } from "babylonjs/Materials/effect";
  14018. import { Particle } from "babylonjs/Particles/particle";
  14019. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  14020. /**
  14021. * Particle emitter emitting particles from the inside of a sphere.
  14022. * It emits the particles alongside the sphere radius. The emission direction might be randomized.
  14023. */
  14024. export class SphereParticleEmitter implements IParticleEmitterType {
  14025. /**
  14026. * The radius of the emission sphere.
  14027. */
  14028. radius: number;
  14029. /**
  14030. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  14031. */
  14032. radiusRange: number;
  14033. /**
  14034. * How much to randomize the particle direction [0-1].
  14035. */
  14036. directionRandomizer: number;
  14037. /**
  14038. * Creates a new instance SphereParticleEmitter
  14039. * @param radius the radius of the emission sphere (1 by default)
  14040. * @param radiusRange the range of the emission sphere [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  14041. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  14042. */
  14043. constructor(
  14044. /**
  14045. * The radius of the emission sphere.
  14046. */
  14047. radius?: number,
  14048. /**
  14049. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  14050. */
  14051. radiusRange?: number,
  14052. /**
  14053. * How much to randomize the particle direction [0-1].
  14054. */
  14055. directionRandomizer?: number);
  14056. /**
  14057. * Called by the particle System when the direction is computed for the created particle.
  14058. * @param worldMatrix is the world matrix of the particle system
  14059. * @param directionToUpdate is the direction vector to update with the result
  14060. * @param particle is the particle we are computed the direction for
  14061. * @param isLocal defines if the direction should be set in local space
  14062. */
  14063. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  14064. /**
  14065. * Called by the particle System when the position is computed for the created particle.
  14066. * @param worldMatrix is the world matrix of the particle system
  14067. * @param positionToUpdate is the position vector to update with the result
  14068. * @param particle is the particle we are computed the position for
  14069. * @param isLocal defines if the position should be set in local space
  14070. */
  14071. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  14072. /**
  14073. * Clones the current emitter and returns a copy of it
  14074. * @returns the new emitter
  14075. */
  14076. clone(): SphereParticleEmitter;
  14077. /**
  14078. * Called by the GPUParticleSystem to setup the update shader
  14079. * @param effect defines the update shader
  14080. */
  14081. applyToShader(effect: Effect): void;
  14082. /**
  14083. * Returns a string to use to update the GPU particles update shader
  14084. * @returns a string containng the defines string
  14085. */
  14086. getEffectDefines(): string;
  14087. /**
  14088. * Returns the string "SphereParticleEmitter"
  14089. * @returns a string containing the class name
  14090. */
  14091. getClassName(): string;
  14092. /**
  14093. * Serializes the particle system to a JSON object.
  14094. * @returns the JSON object
  14095. */
  14096. serialize(): any;
  14097. /**
  14098. * Parse properties from a JSON object
  14099. * @param serializationObject defines the JSON object
  14100. */
  14101. parse(serializationObject: any): void;
  14102. }
  14103. /**
  14104. * Particle emitter emitting particles from the inside of a sphere.
  14105. * It emits the particles randomly between two vectors.
  14106. */
  14107. export class SphereDirectedParticleEmitter extends SphereParticleEmitter {
  14108. /**
  14109. * The min limit of the emission direction.
  14110. */
  14111. direction1: Vector3;
  14112. /**
  14113. * The max limit of the emission direction.
  14114. */
  14115. direction2: Vector3;
  14116. /**
  14117. * Creates a new instance SphereDirectedParticleEmitter
  14118. * @param radius the radius of the emission sphere (1 by default)
  14119. * @param direction1 the min limit of the emission direction (up vector by default)
  14120. * @param direction2 the max limit of the emission direction (up vector by default)
  14121. */
  14122. constructor(radius?: number,
  14123. /**
  14124. * The min limit of the emission direction.
  14125. */
  14126. direction1?: Vector3,
  14127. /**
  14128. * The max limit of the emission direction.
  14129. */
  14130. direction2?: Vector3);
  14131. /**
  14132. * Called by the particle System when the direction is computed for the created particle.
  14133. * @param worldMatrix is the world matrix of the particle system
  14134. * @param directionToUpdate is the direction vector to update with the result
  14135. * @param particle is the particle we are computed the direction for
  14136. */
  14137. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  14138. /**
  14139. * Clones the current emitter and returns a copy of it
  14140. * @returns the new emitter
  14141. */
  14142. clone(): SphereDirectedParticleEmitter;
  14143. /**
  14144. * Called by the GPUParticleSystem to setup the update shader
  14145. * @param effect defines the update shader
  14146. */
  14147. applyToShader(effect: Effect): void;
  14148. /**
  14149. * Returns a string to use to update the GPU particles update shader
  14150. * @returns a string containng the defines string
  14151. */
  14152. getEffectDefines(): string;
  14153. /**
  14154. * Returns the string "SphereDirectedParticleEmitter"
  14155. * @returns a string containing the class name
  14156. */
  14157. getClassName(): string;
  14158. /**
  14159. * Serializes the particle system to a JSON object.
  14160. * @returns the JSON object
  14161. */
  14162. serialize(): any;
  14163. /**
  14164. * Parse properties from a JSON object
  14165. * @param serializationObject defines the JSON object
  14166. */
  14167. parse(serializationObject: any): void;
  14168. }
  14169. }
  14170. declare module "babylonjs/Particles/EmitterTypes/customParticleEmitter" {
  14171. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  14172. import { Effect } from "babylonjs/Materials/effect";
  14173. import { Particle } from "babylonjs/Particles/particle";
  14174. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  14175. import { Nullable } from "babylonjs/types";
  14176. /**
  14177. * Particle emitter emitting particles from a custom list of positions.
  14178. */
  14179. export class CustomParticleEmitter implements IParticleEmitterType {
  14180. /**
  14181. * Gets or sets the position generator that will create the inital position of each particle.
  14182. * Index will be provided when used with GPU particle. Particle will be provided when used with CPU particles
  14183. */
  14184. particlePositionGenerator: (index: number, particle: Nullable<Particle>, outPosition: Vector3) => void;
  14185. /**
  14186. * Gets or sets the destination generator that will create the final destination of each particle.
  14187. * * Index will be provided when used with GPU particle. Particle will be provided when used with CPU particles
  14188. */
  14189. particleDestinationGenerator: (index: number, particle: Nullable<Particle>, outDestination: Vector3) => void;
  14190. /**
  14191. * Creates a new instance CustomParticleEmitter
  14192. */
  14193. constructor();
  14194. /**
  14195. * Called by the particle System when the direction is computed for the created particle.
  14196. * @param worldMatrix is the world matrix of the particle system
  14197. * @param directionToUpdate is the direction vector to update with the result
  14198. * @param particle is the particle we are computed the direction for
  14199. * @param isLocal defines if the direction should be set in local space
  14200. */
  14201. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  14202. /**
  14203. * Called by the particle System when the position is computed for the created particle.
  14204. * @param worldMatrix is the world matrix of the particle system
  14205. * @param positionToUpdate is the position vector to update with the result
  14206. * @param particle is the particle we are computed the position for
  14207. * @param isLocal defines if the position should be set in local space
  14208. */
  14209. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  14210. /**
  14211. * Clones the current emitter and returns a copy of it
  14212. * @returns the new emitter
  14213. */
  14214. clone(): CustomParticleEmitter;
  14215. /**
  14216. * Called by the GPUParticleSystem to setup the update shader
  14217. * @param effect defines the update shader
  14218. */
  14219. applyToShader(effect: Effect): void;
  14220. /**
  14221. * Returns a string to use to update the GPU particles update shader
  14222. * @returns a string containng the defines string
  14223. */
  14224. getEffectDefines(): string;
  14225. /**
  14226. * Returns the string "PointParticleEmitter"
  14227. * @returns a string containing the class name
  14228. */
  14229. getClassName(): string;
  14230. /**
  14231. * Serializes the particle system to a JSON object.
  14232. * @returns the JSON object
  14233. */
  14234. serialize(): any;
  14235. /**
  14236. * Parse properties from a JSON object
  14237. * @param serializationObject defines the JSON object
  14238. */
  14239. parse(serializationObject: any): void;
  14240. }
  14241. }
  14242. declare module "babylonjs/Particles/EmitterTypes/meshParticleEmitter" {
  14243. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  14244. import { Effect } from "babylonjs/Materials/effect";
  14245. import { Particle } from "babylonjs/Particles/particle";
  14246. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  14247. import { Nullable } from "babylonjs/types";
  14248. import { Scene } from "babylonjs/scene";
  14249. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  14250. /**
  14251. * Particle emitter emitting particles from the inside of a box.
  14252. * It emits the particles randomly between 2 given directions.
  14253. */
  14254. export class MeshParticleEmitter implements IParticleEmitterType {
  14255. private _indices;
  14256. private _positions;
  14257. private _normals;
  14258. private _storedNormal;
  14259. private _mesh;
  14260. /**
  14261. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  14262. */
  14263. direction1: Vector3;
  14264. /**
  14265. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  14266. */
  14267. direction2: Vector3;
  14268. /**
  14269. * Gets or sets a boolean indicating that particle directions must be built from mesh face normals
  14270. */
  14271. useMeshNormalsForDirection: boolean;
  14272. /** Defines the mesh to use as source */
  14273. get mesh(): Nullable<AbstractMesh>;
  14274. set mesh(value: Nullable<AbstractMesh>);
  14275. /**
  14276. * Creates a new instance MeshParticleEmitter
  14277. * @param mesh defines the mesh to use as source
  14278. */
  14279. constructor(mesh?: Nullable<AbstractMesh>);
  14280. /**
  14281. * Called by the particle System when the direction is computed for the created particle.
  14282. * @param worldMatrix is the world matrix of the particle system
  14283. * @param directionToUpdate is the direction vector to update with the result
  14284. * @param particle is the particle we are computed the direction for
  14285. * @param isLocal defines if the direction should be set in local space
  14286. */
  14287. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  14288. /**
  14289. * Called by the particle System when the position is computed for the created particle.
  14290. * @param worldMatrix is the world matrix of the particle system
  14291. * @param positionToUpdate is the position vector to update with the result
  14292. * @param particle is the particle we are computed the position for
  14293. * @param isLocal defines if the position should be set in local space
  14294. */
  14295. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  14296. /**
  14297. * Clones the current emitter and returns a copy of it
  14298. * @returns the new emitter
  14299. */
  14300. clone(): MeshParticleEmitter;
  14301. /**
  14302. * Called by the GPUParticleSystem to setup the update shader
  14303. * @param effect defines the update shader
  14304. */
  14305. applyToShader(effect: Effect): void;
  14306. /**
  14307. * Returns a string to use to update the GPU particles update shader
  14308. * @returns a string containng the defines string
  14309. */
  14310. getEffectDefines(): string;
  14311. /**
  14312. * Returns the string "BoxParticleEmitter"
  14313. * @returns a string containing the class name
  14314. */
  14315. getClassName(): string;
  14316. /**
  14317. * Serializes the particle system to a JSON object.
  14318. * @returns the JSON object
  14319. */
  14320. serialize(): any;
  14321. /**
  14322. * Parse properties from a JSON object
  14323. * @param serializationObject defines the JSON object
  14324. * @param scene defines the hosting scene
  14325. */
  14326. parse(serializationObject: any, scene: Nullable<Scene>): void;
  14327. }
  14328. }
  14329. declare module "babylonjs/Particles/EmitterTypes/index" {
  14330. export * from "babylonjs/Particles/EmitterTypes/boxParticleEmitter";
  14331. export * from "babylonjs/Particles/EmitterTypes/coneParticleEmitter";
  14332. export * from "babylonjs/Particles/EmitterTypes/cylinderParticleEmitter";
  14333. export * from "babylonjs/Particles/EmitterTypes/hemisphericParticleEmitter";
  14334. export * from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  14335. export * from "babylonjs/Particles/EmitterTypes/pointParticleEmitter";
  14336. export * from "babylonjs/Particles/EmitterTypes/sphereParticleEmitter";
  14337. export * from "babylonjs/Particles/EmitterTypes/customParticleEmitter";
  14338. export * from "babylonjs/Particles/EmitterTypes/meshParticleEmitter";
  14339. }
  14340. declare module "babylonjs/Particles/IParticleSystem" {
  14341. import { Nullable } from "babylonjs/types";
  14342. import { Vector2, Vector3, Matrix } from "babylonjs/Maths/math.vector";
  14343. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  14344. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  14345. import { BoxParticleEmitter, IParticleEmitterType, PointParticleEmitter, HemisphericParticleEmitter, SphereParticleEmitter, SphereDirectedParticleEmitter, CylinderParticleEmitter, ConeParticleEmitter } from "babylonjs/Particles/EmitterTypes/index";
  14346. import { Scene } from "babylonjs/scene";
  14347. import { ColorGradient, FactorGradient, Color3Gradient } from "babylonjs/Misc/gradients";
  14348. import { Effect } from "babylonjs/Materials/effect";
  14349. import { Observable } from "babylonjs/Misc/observable";
  14350. import { Animation } from "babylonjs/Animations/animation";
  14351. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  14352. /**
  14353. * Interface representing a particle system in Babylon.js.
  14354. * This groups the common functionalities that needs to be implemented in order to create a particle system.
  14355. * A particle system represents a way to manage particles from their emission to their animation and rendering.
  14356. */
  14357. export interface IParticleSystem {
  14358. /**
  14359. * List of animations used by the particle system.
  14360. */
  14361. animations: Animation[];
  14362. /**
  14363. * The id of the Particle system.
  14364. */
  14365. id: string;
  14366. /**
  14367. * The name of the Particle system.
  14368. */
  14369. name: string;
  14370. /**
  14371. * The emitter represents the Mesh or position we are attaching the particle system to.
  14372. */
  14373. emitter: Nullable<AbstractMesh | Vector3>;
  14374. /**
  14375. * Gets or sets a boolean indicating if the particles must be rendered as billboard or aligned with the direction
  14376. */
  14377. isBillboardBased: boolean;
  14378. /**
  14379. * The rendering group used by the Particle system to chose when to render.
  14380. */
  14381. renderingGroupId: number;
  14382. /**
  14383. * The layer mask we are rendering the particles through.
  14384. */
  14385. layerMask: number;
  14386. /**
  14387. * The overall motion speed (0.01 is default update speed, faster updates = faster animation)
  14388. */
  14389. updateSpeed: number;
  14390. /**
  14391. * The amount of time the particle system is running (depends of the overall update speed).
  14392. */
  14393. targetStopDuration: number;
  14394. /**
  14395. * The texture used to render each particle. (this can be a spritesheet)
  14396. */
  14397. particleTexture: Nullable<BaseTexture>;
  14398. /**
  14399. * Blend mode use to render the particle, it can be either ParticleSystem.BLENDMODE_ONEONE, ParticleSystem.BLENDMODE_STANDARD or ParticleSystem.BLENDMODE_ADD.
  14400. */
  14401. blendMode: number;
  14402. /**
  14403. * Minimum life time of emitting particles.
  14404. */
  14405. minLifeTime: number;
  14406. /**
  14407. * Maximum life time of emitting particles.
  14408. */
  14409. maxLifeTime: number;
  14410. /**
  14411. * Minimum Size of emitting particles.
  14412. */
  14413. minSize: number;
  14414. /**
  14415. * Maximum Size of emitting particles.
  14416. */
  14417. maxSize: number;
  14418. /**
  14419. * Minimum scale of emitting particles on X axis.
  14420. */
  14421. minScaleX: number;
  14422. /**
  14423. * Maximum scale of emitting particles on X axis.
  14424. */
  14425. maxScaleX: number;
  14426. /**
  14427. * Minimum scale of emitting particles on Y axis.
  14428. */
  14429. minScaleY: number;
  14430. /**
  14431. * Maximum scale of emitting particles on Y axis.
  14432. */
  14433. maxScaleY: number;
  14434. /**
  14435. * Random color of each particle after it has been emitted, between color1 and color2 vectors.
  14436. */
  14437. color1: Color4;
  14438. /**
  14439. * Random color of each particle after it has been emitted, between color1 and color2 vectors.
  14440. */
  14441. color2: Color4;
  14442. /**
  14443. * Color the particle will have at the end of its lifetime.
  14444. */
  14445. colorDead: Color4;
  14446. /**
  14447. * The maximum number of particles to emit per frame until we reach the activeParticleCount value
  14448. */
  14449. emitRate: number;
  14450. /**
  14451. * You can use gravity if you want to give an orientation to your particles.
  14452. */
  14453. gravity: Vector3;
  14454. /**
  14455. * Minimum power of emitting particles.
  14456. */
  14457. minEmitPower: number;
  14458. /**
  14459. * Maximum power of emitting particles.
  14460. */
  14461. maxEmitPower: number;
  14462. /**
  14463. * Minimum angular speed of emitting particles (Z-axis rotation for each particle).
  14464. */
  14465. minAngularSpeed: number;
  14466. /**
  14467. * Maximum angular speed of emitting particles (Z-axis rotation for each particle).
  14468. */
  14469. maxAngularSpeed: number;
  14470. /**
  14471. * Gets or sets the minimal initial rotation in radians.
  14472. */
  14473. minInitialRotation: number;
  14474. /**
  14475. * Gets or sets the maximal initial rotation in radians.
  14476. */
  14477. maxInitialRotation: number;
  14478. /**
  14479. * The particle emitter type defines the emitter used by the particle system.
  14480. * It can be for example box, sphere, or cone...
  14481. */
  14482. particleEmitterType: Nullable<IParticleEmitterType>;
  14483. /**
  14484. * Defines the delay in milliseconds before starting the system (0 by default)
  14485. */
  14486. startDelay: number;
  14487. /**
  14488. * Gets or sets a value indicating how many cycles (or frames) must be executed before first rendering (this value has to be set before starting the system). Default is 0
  14489. */
  14490. preWarmCycles: number;
  14491. /**
  14492. * Gets or sets a value indicating the time step multiplier to use in pre-warm mode (default is 1)
  14493. */
  14494. preWarmStepOffset: number;
  14495. /**
  14496. * If using a spritesheet (isAnimationSheetEnabled) defines the speed of the sprite loop (default is 1 meaning the animation will play once during the entire particle lifetime)
  14497. */
  14498. spriteCellChangeSpeed: number;
  14499. /**
  14500. * If using a spritesheet (isAnimationSheetEnabled) defines the first sprite cell to display
  14501. */
  14502. startSpriteCellID: number;
  14503. /**
  14504. * If using a spritesheet (isAnimationSheetEnabled) defines the last sprite cell to display
  14505. */
  14506. endSpriteCellID: number;
  14507. /**
  14508. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell width to use
  14509. */
  14510. spriteCellWidth: number;
  14511. /**
  14512. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell height to use
  14513. */
  14514. spriteCellHeight: number;
  14515. /**
  14516. * This allows the system to random pick the start cell ID between startSpriteCellID and endSpriteCellID
  14517. */
  14518. spriteRandomStartCell: boolean;
  14519. /**
  14520. * Gets or sets a boolean indicating if a spritesheet is used to animate the particles texture
  14521. */
  14522. isAnimationSheetEnabled: boolean;
  14523. /** Gets or sets a Vector2 used to move the pivot (by default (0,0)) */
  14524. translationPivot: Vector2;
  14525. /**
  14526. * Gets or sets a texture used to add random noise to particle positions
  14527. */
  14528. noiseTexture: Nullable<BaseTexture>;
  14529. /** Gets or sets the strength to apply to the noise value (default is (10, 10, 10)) */
  14530. noiseStrength: Vector3;
  14531. /**
  14532. * Gets or sets the billboard mode to use when isBillboardBased = true.
  14533. * Value can be: ParticleSystem.BILLBOARDMODE_ALL, ParticleSystem.BILLBOARDMODE_Y, ParticleSystem.BILLBOARDMODE_STRETCHED
  14534. */
  14535. billboardMode: number;
  14536. /** Gets or sets a value indicating the damping to apply if the limit velocity factor is reached */
  14537. limitVelocityDamping: number;
  14538. /**
  14539. * Gets or sets a boolean indicating that hosted animations (in the system.animations array) must be started when system.start() is called
  14540. */
  14541. beginAnimationOnStart: boolean;
  14542. /**
  14543. * Gets or sets the frame to start the animation from when beginAnimationOnStart is true
  14544. */
  14545. beginAnimationFrom: number;
  14546. /**
  14547. * Gets or sets the frame to end the animation on when beginAnimationOnStart is true
  14548. */
  14549. beginAnimationTo: number;
  14550. /**
  14551. * Gets or sets a boolean indicating if animations must loop when beginAnimationOnStart is true
  14552. */
  14553. beginAnimationLoop: boolean;
  14554. /**
  14555. * Specifies whether the particle system will be disposed once it reaches the end of the animation.
  14556. */
  14557. disposeOnStop: boolean;
  14558. /**
  14559. * Specifies if the particles are updated in emitter local space or world space
  14560. */
  14561. isLocal: boolean;
  14562. /** Snippet ID if the particle system was created from the snippet server */
  14563. snippetId: string;
  14564. /** Gets or sets a matrix to use to compute projection */
  14565. defaultProjectionMatrix: Matrix;
  14566. /**
  14567. * Gets the maximum number of particles active at the same time.
  14568. * @returns The max number of active particles.
  14569. */
  14570. getCapacity(): number;
  14571. /**
  14572. * Gets the number of particles active at the same time.
  14573. * @returns The number of active particles.
  14574. */
  14575. getActiveCount(): number;
  14576. /**
  14577. * Gets if the system has been started. (Note: this will still be true after stop is called)
  14578. * @returns True if it has been started, otherwise false.
  14579. */
  14580. isStarted(): boolean;
  14581. /**
  14582. * Animates the particle system for this frame.
  14583. */
  14584. animate(): void;
  14585. /**
  14586. * Renders the particle system in its current state.
  14587. * @returns the current number of particles
  14588. */
  14589. render(): number;
  14590. /**
  14591. * Dispose the particle system and frees its associated resources.
  14592. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  14593. */
  14594. dispose(disposeTexture?: boolean): void;
  14595. /**
  14596. * An event triggered when the system is disposed
  14597. */
  14598. onDisposeObservable: Observable<IParticleSystem>;
  14599. /**
  14600. * Clones the particle system.
  14601. * @param name The name of the cloned object
  14602. * @param newEmitter The new emitter to use
  14603. * @returns the cloned particle system
  14604. */
  14605. clone(name: string, newEmitter: any): Nullable<IParticleSystem>;
  14606. /**
  14607. * Serializes the particle system to a JSON object
  14608. * @param serializeTexture defines if the texture must be serialized as well
  14609. * @returns the JSON object
  14610. */
  14611. serialize(serializeTexture: boolean): any;
  14612. /**
  14613. * Rebuild the particle system
  14614. */
  14615. rebuild(): void;
  14616. /** Force the system to rebuild all gradients that need to be resync */
  14617. forceRefreshGradients(): void;
  14618. /**
  14619. * Starts the particle system and begins to emit
  14620. * @param delay defines the delay in milliseconds before starting the system (0 by default)
  14621. */
  14622. start(delay?: number): void;
  14623. /**
  14624. * Stops the particle system.
  14625. */
  14626. stop(): void;
  14627. /**
  14628. * Remove all active particles
  14629. */
  14630. reset(): void;
  14631. /**
  14632. * Gets a boolean indicating that the system is stopping
  14633. * @returns true if the system is currently stopping
  14634. */
  14635. isStopping(): boolean;
  14636. /**
  14637. * Is this system ready to be used/rendered
  14638. * @return true if the system is ready
  14639. */
  14640. isReady(): boolean;
  14641. /**
  14642. * Returns the string "ParticleSystem"
  14643. * @returns a string containing the class name
  14644. */
  14645. getClassName(): string;
  14646. /**
  14647. * Gets the custom effect used to render the particles
  14648. * @param blendMode Blend mode for which the effect should be retrieved
  14649. * @returns The effect
  14650. */
  14651. getCustomEffect(blendMode: number): Nullable<Effect>;
  14652. /**
  14653. * Sets the custom effect used to render the particles
  14654. * @param effect The effect to set
  14655. * @param blendMode Blend mode for which the effect should be set
  14656. */
  14657. setCustomEffect(effect: Nullable<Effect>, blendMode: number): void;
  14658. /**
  14659. * Fill the defines array according to the current settings of the particle system
  14660. * @param defines Array to be updated
  14661. * @param blendMode blend mode to take into account when updating the array
  14662. */
  14663. fillDefines(defines: Array<string>, blendMode: number): void;
  14664. /**
  14665. * Fill the uniforms, attributes and samplers arrays according to the current settings of the particle system
  14666. * @param uniforms Uniforms array to fill
  14667. * @param attributes Attributes array to fill
  14668. * @param samplers Samplers array to fill
  14669. */
  14670. fillUniformsAttributesAndSamplerNames(uniforms: Array<string>, attributes: Array<string>, samplers: Array<string>): void;
  14671. /**
  14672. * Observable that will be called just before the particles are drawn
  14673. */
  14674. onBeforeDrawParticlesObservable: Observable<Nullable<Effect>>;
  14675. /**
  14676. * Gets the name of the particle vertex shader
  14677. */
  14678. vertexShaderName: string;
  14679. /**
  14680. * Adds a new color gradient
  14681. * @param gradient defines the gradient to use (between 0 and 1)
  14682. * @param color1 defines the color to affect to the specified gradient
  14683. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  14684. * @returns the current particle system
  14685. */
  14686. addColorGradient(gradient: number, color1: Color4, color2?: Color4): IParticleSystem;
  14687. /**
  14688. * Remove a specific color gradient
  14689. * @param gradient defines the gradient to remove
  14690. * @returns the current particle system
  14691. */
  14692. removeColorGradient(gradient: number): IParticleSystem;
  14693. /**
  14694. * Adds a new size gradient
  14695. * @param gradient defines the gradient to use (between 0 and 1)
  14696. * @param factor defines the size factor to affect to the specified gradient
  14697. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14698. * @returns the current particle system
  14699. */
  14700. addSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14701. /**
  14702. * Remove a specific size gradient
  14703. * @param gradient defines the gradient to remove
  14704. * @returns the current particle system
  14705. */
  14706. removeSizeGradient(gradient: number): IParticleSystem;
  14707. /**
  14708. * Gets the current list of color gradients.
  14709. * You must use addColorGradient and removeColorGradient to udpate this list
  14710. * @returns the list of color gradients
  14711. */
  14712. getColorGradients(): Nullable<Array<ColorGradient>>;
  14713. /**
  14714. * Gets the current list of size gradients.
  14715. * You must use addSizeGradient and removeSizeGradient to udpate this list
  14716. * @returns the list of size gradients
  14717. */
  14718. getSizeGradients(): Nullable<Array<FactorGradient>>;
  14719. /**
  14720. * Gets the current list of angular speed gradients.
  14721. * You must use addAngularSpeedGradient and removeAngularSpeedGradient to udpate this list
  14722. * @returns the list of angular speed gradients
  14723. */
  14724. getAngularSpeedGradients(): Nullable<Array<FactorGradient>>;
  14725. /**
  14726. * Adds a new angular speed gradient
  14727. * @param gradient defines the gradient to use (between 0 and 1)
  14728. * @param factor defines the angular speed to affect to the specified gradient
  14729. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14730. * @returns the current particle system
  14731. */
  14732. addAngularSpeedGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14733. /**
  14734. * Remove a specific angular speed gradient
  14735. * @param gradient defines the gradient to remove
  14736. * @returns the current particle system
  14737. */
  14738. removeAngularSpeedGradient(gradient: number): IParticleSystem;
  14739. /**
  14740. * Gets the current list of velocity gradients.
  14741. * You must use addVelocityGradient and removeVelocityGradient to udpate this list
  14742. * @returns the list of velocity gradients
  14743. */
  14744. getVelocityGradients(): Nullable<Array<FactorGradient>>;
  14745. /**
  14746. * Adds a new velocity gradient
  14747. * @param gradient defines the gradient to use (between 0 and 1)
  14748. * @param factor defines the velocity to affect to the specified gradient
  14749. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14750. * @returns the current particle system
  14751. */
  14752. addVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14753. /**
  14754. * Remove a specific velocity gradient
  14755. * @param gradient defines the gradient to remove
  14756. * @returns the current particle system
  14757. */
  14758. removeVelocityGradient(gradient: number): IParticleSystem;
  14759. /**
  14760. * Gets the current list of limit velocity gradients.
  14761. * You must use addLimitVelocityGradient and removeLimitVelocityGradient to udpate this list
  14762. * @returns the list of limit velocity gradients
  14763. */
  14764. getLimitVelocityGradients(): Nullable<Array<FactorGradient>>;
  14765. /**
  14766. * Adds a new limit velocity gradient
  14767. * @param gradient defines the gradient to use (between 0 and 1)
  14768. * @param factor defines the limit velocity to affect to the specified gradient
  14769. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14770. * @returns the current particle system
  14771. */
  14772. addLimitVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14773. /**
  14774. * Remove a specific limit velocity gradient
  14775. * @param gradient defines the gradient to remove
  14776. * @returns the current particle system
  14777. */
  14778. removeLimitVelocityGradient(gradient: number): IParticleSystem;
  14779. /**
  14780. * Adds a new drag gradient
  14781. * @param gradient defines the gradient to use (between 0 and 1)
  14782. * @param factor defines the drag to affect to the specified gradient
  14783. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14784. * @returns the current particle system
  14785. */
  14786. addDragGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14787. /**
  14788. * Remove a specific drag gradient
  14789. * @param gradient defines the gradient to remove
  14790. * @returns the current particle system
  14791. */
  14792. removeDragGradient(gradient: number): IParticleSystem;
  14793. /**
  14794. * Gets the current list of drag gradients.
  14795. * You must use addDragGradient and removeDragGradient to udpate this list
  14796. * @returns the list of drag gradients
  14797. */
  14798. getDragGradients(): Nullable<Array<FactorGradient>>;
  14799. /**
  14800. * Adds a new emit rate gradient (please note that this will only work if you set the targetStopDuration property)
  14801. * @param gradient defines the gradient to use (between 0 and 1)
  14802. * @param factor defines the emit rate to affect to the specified gradient
  14803. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14804. * @returns the current particle system
  14805. */
  14806. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14807. /**
  14808. * Remove a specific emit rate gradient
  14809. * @param gradient defines the gradient to remove
  14810. * @returns the current particle system
  14811. */
  14812. removeEmitRateGradient(gradient: number): IParticleSystem;
  14813. /**
  14814. * Gets the current list of emit rate gradients.
  14815. * You must use addEmitRateGradient and removeEmitRateGradient to udpate this list
  14816. * @returns the list of emit rate gradients
  14817. */
  14818. getEmitRateGradients(): Nullable<Array<FactorGradient>>;
  14819. /**
  14820. * Adds a new start size gradient (please note that this will only work if you set the targetStopDuration property)
  14821. * @param gradient defines the gradient to use (between 0 and 1)
  14822. * @param factor defines the start size to affect to the specified gradient
  14823. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14824. * @returns the current particle system
  14825. */
  14826. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14827. /**
  14828. * Remove a specific start size gradient
  14829. * @param gradient defines the gradient to remove
  14830. * @returns the current particle system
  14831. */
  14832. removeStartSizeGradient(gradient: number): IParticleSystem;
  14833. /**
  14834. * Gets the current list of start size gradients.
  14835. * You must use addStartSizeGradient and removeStartSizeGradient to udpate this list
  14836. * @returns the list of start size gradients
  14837. */
  14838. getStartSizeGradients(): Nullable<Array<FactorGradient>>;
  14839. /**
  14840. * Adds a new life time gradient
  14841. * @param gradient defines the gradient to use (between 0 and 1)
  14842. * @param factor defines the life time factor to affect to the specified gradient
  14843. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14844. * @returns the current particle system
  14845. */
  14846. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14847. /**
  14848. * Remove a specific life time gradient
  14849. * @param gradient defines the gradient to remove
  14850. * @returns the current particle system
  14851. */
  14852. removeLifeTimeGradient(gradient: number): IParticleSystem;
  14853. /**
  14854. * Gets the current list of life time gradients.
  14855. * You must use addLifeTimeGradient and removeLifeTimeGradient to udpate this list
  14856. * @returns the list of life time gradients
  14857. */
  14858. getLifeTimeGradients(): Nullable<Array<FactorGradient>>;
  14859. /**
  14860. * Gets the current list of color gradients.
  14861. * You must use addColorGradient and removeColorGradient to udpate this list
  14862. * @returns the list of color gradients
  14863. */
  14864. getColorGradients(): Nullable<Array<ColorGradient>>;
  14865. /**
  14866. * Adds a new ramp gradient used to remap particle colors
  14867. * @param gradient defines the gradient to use (between 0 and 1)
  14868. * @param color defines the color to affect to the specified gradient
  14869. * @returns the current particle system
  14870. */
  14871. addRampGradient(gradient: number, color: Color3): IParticleSystem;
  14872. /**
  14873. * Gets the current list of ramp gradients.
  14874. * You must use addRampGradient and removeRampGradient to udpate this list
  14875. * @returns the list of ramp gradients
  14876. */
  14877. getRampGradients(): Nullable<Array<Color3Gradient>>;
  14878. /** Gets or sets a boolean indicating that ramp gradients must be used
  14879. * @see https://doc.babylonjs.com/babylon101/particles#ramp-gradients
  14880. */
  14881. useRampGradients: boolean;
  14882. /**
  14883. * Adds a new color remap gradient
  14884. * @param gradient defines the gradient to use (between 0 and 1)
  14885. * @param min defines the color remap minimal range
  14886. * @param max defines the color remap maximal range
  14887. * @returns the current particle system
  14888. */
  14889. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  14890. /**
  14891. * Gets the current list of color remap gradients.
  14892. * You must use addColorRemapGradient and removeColorRemapGradient to udpate this list
  14893. * @returns the list of color remap gradients
  14894. */
  14895. getColorRemapGradients(): Nullable<Array<FactorGradient>>;
  14896. /**
  14897. * Adds a new alpha remap gradient
  14898. * @param gradient defines the gradient to use (between 0 and 1)
  14899. * @param min defines the alpha remap minimal range
  14900. * @param max defines the alpha remap maximal range
  14901. * @returns the current particle system
  14902. */
  14903. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  14904. /**
  14905. * Gets the current list of alpha remap gradients.
  14906. * You must use addAlphaRemapGradient and removeAlphaRemapGradient to udpate this list
  14907. * @returns the list of alpha remap gradients
  14908. */
  14909. getAlphaRemapGradients(): Nullable<Array<FactorGradient>>;
  14910. /**
  14911. * Creates a Point Emitter for the particle system (emits directly from the emitter position)
  14912. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  14913. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  14914. * @returns the emitter
  14915. */
  14916. createPointEmitter(direction1: Vector3, direction2: Vector3): PointParticleEmitter;
  14917. /**
  14918. * Creates a Hemisphere Emitter for the particle system (emits along the hemisphere radius)
  14919. * @param radius The radius of the hemisphere to emit from
  14920. * @param radiusRange The range of the hemisphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  14921. * @returns the emitter
  14922. */
  14923. createHemisphericEmitter(radius: number, radiusRange: number): HemisphericParticleEmitter;
  14924. /**
  14925. * Creates a Sphere Emitter for the particle system (emits along the sphere radius)
  14926. * @param radius The radius of the sphere to emit from
  14927. * @param radiusRange The range of the sphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  14928. * @returns the emitter
  14929. */
  14930. createSphereEmitter(radius: number, radiusRange: number): SphereParticleEmitter;
  14931. /**
  14932. * Creates a Directed Sphere Emitter for the particle system (emits between direction1 and direction2)
  14933. * @param radius The radius of the sphere to emit from
  14934. * @param direction1 Particles are emitted between the direction1 and direction2 from within the sphere
  14935. * @param direction2 Particles are emitted between the direction1 and direction2 from within the sphere
  14936. * @returns the emitter
  14937. */
  14938. createDirectedSphereEmitter(radius: number, direction1: Vector3, direction2: Vector3): SphereDirectedParticleEmitter;
  14939. /**
  14940. * Creates a Cylinder Emitter for the particle system (emits from the cylinder to the particle position)
  14941. * @param radius The radius of the emission cylinder
  14942. * @param height The height of the emission cylinder
  14943. * @param radiusRange The range of emission [0-1] 0 Surface only, 1 Entire Radius
  14944. * @param directionRandomizer How much to randomize the particle direction [0-1]
  14945. * @returns the emitter
  14946. */
  14947. createCylinderEmitter(radius: number, height: number, radiusRange: number, directionRandomizer: number): CylinderParticleEmitter;
  14948. /**
  14949. * Creates a Directed Cylinder Emitter for the particle system (emits between direction1 and direction2)
  14950. * @param radius The radius of the cylinder to emit from
  14951. * @param height The height of the emission cylinder
  14952. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  14953. * @param direction1 Particles are emitted between the direction1 and direction2 from within the cylinder
  14954. * @param direction2 Particles are emitted between the direction1 and direction2 from within the cylinder
  14955. * @returns the emitter
  14956. */
  14957. createDirectedCylinderEmitter(radius: number, height: number, radiusRange: number, direction1: Vector3, direction2: Vector3): SphereDirectedParticleEmitter;
  14958. /**
  14959. * Creates a Cone Emitter for the particle system (emits from the cone to the particle position)
  14960. * @param radius The radius of the cone to emit from
  14961. * @param angle The base angle of the cone
  14962. * @returns the emitter
  14963. */
  14964. createConeEmitter(radius: number, angle: number): ConeParticleEmitter;
  14965. /**
  14966. * Creates a Box Emitter for the particle system. (emits between direction1 and direction2 from withing the box defined by minEmitBox and maxEmitBox)
  14967. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  14968. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  14969. * @param minEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  14970. * @param maxEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  14971. * @returns the emitter
  14972. */
  14973. createBoxEmitter(direction1: Vector3, direction2: Vector3, minEmitBox: Vector3, maxEmitBox: Vector3): BoxParticleEmitter;
  14974. /**
  14975. * Get hosting scene
  14976. * @returns the scene
  14977. */
  14978. getScene(): Nullable<Scene>;
  14979. }
  14980. }
  14981. declare module "babylonjs/Meshes/transformNode" {
  14982. import { DeepImmutable } from "babylonjs/types";
  14983. import { Observable } from "babylonjs/Misc/observable";
  14984. import { Nullable } from "babylonjs/types";
  14985. import { Camera } from "babylonjs/Cameras/camera";
  14986. import { Scene } from "babylonjs/scene";
  14987. import { Quaternion, Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  14988. import { Node } from "babylonjs/node";
  14989. import { Bone } from "babylonjs/Bones/bone";
  14990. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  14991. import { Space } from "babylonjs/Maths/math.axis";
  14992. /**
  14993. * A TransformNode is an object that is not rendered but can be used as a center of transformation. This can decrease memory usage and increase rendering speed compared to using an empty mesh as a parent and is less complicated than using a pivot matrix.
  14994. * @see https://doc.babylonjs.com/how_to/transformnode
  14995. */
  14996. export class TransformNode extends Node {
  14997. /**
  14998. * Object will not rotate to face the camera
  14999. */
  15000. static BILLBOARDMODE_NONE: number;
  15001. /**
  15002. * Object will rotate to face the camera but only on the x axis
  15003. */
  15004. static BILLBOARDMODE_X: number;
  15005. /**
  15006. * Object will rotate to face the camera but only on the y axis
  15007. */
  15008. static BILLBOARDMODE_Y: number;
  15009. /**
  15010. * Object will rotate to face the camera but only on the z axis
  15011. */
  15012. static BILLBOARDMODE_Z: number;
  15013. /**
  15014. * Object will rotate to face the camera
  15015. */
  15016. static BILLBOARDMODE_ALL: number;
  15017. /**
  15018. * Object will rotate to face the camera's position instead of orientation
  15019. */
  15020. static BILLBOARDMODE_USE_POSITION: number;
  15021. private static _TmpRotation;
  15022. private static _TmpScaling;
  15023. private static _TmpTranslation;
  15024. private _forward;
  15025. private _forwardInverted;
  15026. private _up;
  15027. private _right;
  15028. private _rightInverted;
  15029. private _position;
  15030. private _rotation;
  15031. private _rotationQuaternion;
  15032. protected _scaling: Vector3;
  15033. protected _isDirty: boolean;
  15034. private _transformToBoneReferal;
  15035. private _isAbsoluteSynced;
  15036. private _billboardMode;
  15037. /**
  15038. * Gets or sets the billboard mode. Default is 0.
  15039. *
  15040. * | Value | Type | Description |
  15041. * | --- | --- | --- |
  15042. * | 0 | BILLBOARDMODE_NONE | |
  15043. * | 1 | BILLBOARDMODE_X | |
  15044. * | 2 | BILLBOARDMODE_Y | |
  15045. * | 4 | BILLBOARDMODE_Z | |
  15046. * | 7 | BILLBOARDMODE_ALL | |
  15047. *
  15048. */
  15049. get billboardMode(): number;
  15050. set billboardMode(value: number);
  15051. private _preserveParentRotationForBillboard;
  15052. /**
  15053. * Gets or sets a boolean indicating that parent rotation should be preserved when using billboards.
  15054. * This could be useful for glTF objects where parent rotation helps converting from right handed to left handed
  15055. */
  15056. get preserveParentRotationForBillboard(): boolean;
  15057. set preserveParentRotationForBillboard(value: boolean);
  15058. /**
  15059. * Multiplication factor on scale x/y/z when computing the world matrix. Eg. for a 1x1x1 cube setting this to 2 will make it a 2x2x2 cube
  15060. */
  15061. scalingDeterminant: number;
  15062. private _infiniteDistance;
  15063. /**
  15064. * Gets or sets the distance of the object to max, often used by skybox
  15065. */
  15066. get infiniteDistance(): boolean;
  15067. set infiniteDistance(value: boolean);
  15068. /**
  15069. * Gets or sets a boolean indicating that non uniform scaling (when at least one component is different from others) should be ignored.
  15070. * By default the system will update normals to compensate
  15071. */
  15072. ignoreNonUniformScaling: boolean;
  15073. /**
  15074. * Gets or sets a boolean indicating that even if rotationQuaternion is defined, you can keep updating rotation property and Babylon.js will just mix both
  15075. */
  15076. reIntegrateRotationIntoRotationQuaternion: boolean;
  15077. /** @hidden */
  15078. _poseMatrix: Nullable<Matrix>;
  15079. /** @hidden */
  15080. _localMatrix: Matrix;
  15081. private _usePivotMatrix;
  15082. private _absolutePosition;
  15083. private _absoluteScaling;
  15084. private _absoluteRotationQuaternion;
  15085. private _pivotMatrix;
  15086. private _pivotMatrixInverse;
  15087. protected _postMultiplyPivotMatrix: boolean;
  15088. protected _isWorldMatrixFrozen: boolean;
  15089. /** @hidden */
  15090. _indexInSceneTransformNodesArray: number;
  15091. /**
  15092. * An event triggered after the world matrix is updated
  15093. */
  15094. onAfterWorldMatrixUpdateObservable: Observable<TransformNode>;
  15095. constructor(name: string, scene?: Nullable<Scene>, isPure?: boolean);
  15096. /**
  15097. * Gets a string identifying the name of the class
  15098. * @returns "TransformNode" string
  15099. */
  15100. getClassName(): string;
  15101. /**
  15102. * Gets or set the node position (default is (0.0, 0.0, 0.0))
  15103. */
  15104. get position(): Vector3;
  15105. set position(newPosition: Vector3);
  15106. /**
  15107. * Gets or sets the rotation property : a Vector3 defining the rotation value in radians around each local axis X, Y, Z (default is (0.0, 0.0, 0.0)).
  15108. * If rotation quaternion is set, this Vector3 will be ignored and copy from the quaternion
  15109. */
  15110. get rotation(): Vector3;
  15111. set rotation(newRotation: Vector3);
  15112. /**
  15113. * Gets or sets the scaling property : a Vector3 defining the node scaling along each local axis X, Y, Z (default is (0.0, 0.0, 0.0)).
  15114. */
  15115. get scaling(): Vector3;
  15116. set scaling(newScaling: Vector3);
  15117. /**
  15118. * Gets or sets the rotation Quaternion property : this a Quaternion object defining the node rotation by using a unit quaternion (undefined by default, but can be null).
  15119. * If set, only the rotationQuaternion is then used to compute the node rotation (ie. node.rotation will be ignored)
  15120. */
  15121. get rotationQuaternion(): Nullable<Quaternion>;
  15122. set rotationQuaternion(quaternion: Nullable<Quaternion>);
  15123. /**
  15124. * The forward direction of that transform in world space.
  15125. */
  15126. get forward(): Vector3;
  15127. /**
  15128. * The up direction of that transform in world space.
  15129. */
  15130. get up(): Vector3;
  15131. /**
  15132. * The right direction of that transform in world space.
  15133. */
  15134. get right(): Vector3;
  15135. /**
  15136. * Copies the parameter passed Matrix into the mesh Pose matrix.
  15137. * @param matrix the matrix to copy the pose from
  15138. * @returns this TransformNode.
  15139. */
  15140. updatePoseMatrix(matrix: Matrix): TransformNode;
  15141. /**
  15142. * Returns the mesh Pose matrix.
  15143. * @returns the pose matrix
  15144. */
  15145. getPoseMatrix(): Matrix;
  15146. /** @hidden */
  15147. _isSynchronized(): boolean;
  15148. /** @hidden */
  15149. _initCache(): void;
  15150. /**
  15151. * Flag the transform node as dirty (Forcing it to update everything)
  15152. * @param property if set to "rotation" the objects rotationQuaternion will be set to null
  15153. * @returns this transform node
  15154. */
  15155. markAsDirty(property: string): TransformNode;
  15156. /**
  15157. * Returns the current mesh absolute position.
  15158. * Returns a Vector3.
  15159. */
  15160. get absolutePosition(): Vector3;
  15161. /**
  15162. * Returns the current mesh absolute scaling.
  15163. * Returns a Vector3.
  15164. */
  15165. get absoluteScaling(): Vector3;
  15166. /**
  15167. * Returns the current mesh absolute rotation.
  15168. * Returns a Quaternion.
  15169. */
  15170. get absoluteRotationQuaternion(): Quaternion;
  15171. /**
  15172. * Sets a new matrix to apply before all other transformation
  15173. * @param matrix defines the transform matrix
  15174. * @returns the current TransformNode
  15175. */
  15176. setPreTransformMatrix(matrix: Matrix): TransformNode;
  15177. /**
  15178. * Sets a new pivot matrix to the current node
  15179. * @param matrix defines the new pivot matrix to use
  15180. * @param postMultiplyPivotMatrix defines if the pivot matrix must be cancelled in the world matrix. When this parameter is set to true (default), the inverse of the pivot matrix is also applied at the end to cancel the transformation effect
  15181. * @returns the current TransformNode
  15182. */
  15183. setPivotMatrix(matrix: DeepImmutable<Matrix>, postMultiplyPivotMatrix?: boolean): TransformNode;
  15184. /**
  15185. * Returns the mesh pivot matrix.
  15186. * Default : Identity.
  15187. * @returns the matrix
  15188. */
  15189. getPivotMatrix(): Matrix;
  15190. /**
  15191. * Instantiate (when possible) or clone that node with its hierarchy
  15192. * @param newParent defines the new parent to use for the instance (or clone)
  15193. * @param options defines options to configure how copy is done
  15194. * @param onNewNodeCreated defines an option callback to call when a clone or an instance is created
  15195. * @returns an instance (or a clone) of the current node with its hiearchy
  15196. */
  15197. instantiateHierarchy(newParent?: Nullable<TransformNode>, options?: {
  15198. doNotInstantiate: boolean;
  15199. }, onNewNodeCreated?: (source: TransformNode, clone: TransformNode) => void): Nullable<TransformNode>;
  15200. /**
  15201. * Prevents the World matrix to be computed any longer
  15202. * @param newWorldMatrix defines an optional matrix to use as world matrix
  15203. * @returns the TransformNode.
  15204. */
  15205. freezeWorldMatrix(newWorldMatrix?: Nullable<Matrix>): TransformNode;
  15206. /**
  15207. * Allows back the World matrix computation.
  15208. * @returns the TransformNode.
  15209. */
  15210. unfreezeWorldMatrix(): this;
  15211. /**
  15212. * True if the World matrix has been frozen.
  15213. */
  15214. get isWorldMatrixFrozen(): boolean;
  15215. /**
  15216. * Retuns the mesh absolute position in the World.
  15217. * @returns a Vector3.
  15218. */
  15219. getAbsolutePosition(): Vector3;
  15220. /**
  15221. * Sets the mesh absolute position in the World from a Vector3 or an Array(3).
  15222. * @param absolutePosition the absolute position to set
  15223. * @returns the TransformNode.
  15224. */
  15225. setAbsolutePosition(absolutePosition: Vector3): TransformNode;
  15226. /**
  15227. * Sets the mesh position in its local space.
  15228. * @param vector3 the position to set in localspace
  15229. * @returns the TransformNode.
  15230. */
  15231. setPositionWithLocalVector(vector3: Vector3): TransformNode;
  15232. /**
  15233. * Returns the mesh position in the local space from the current World matrix values.
  15234. * @returns a new Vector3.
  15235. */
  15236. getPositionExpressedInLocalSpace(): Vector3;
  15237. /**
  15238. * Translates the mesh along the passed Vector3 in its local space.
  15239. * @param vector3 the distance to translate in localspace
  15240. * @returns the TransformNode.
  15241. */
  15242. locallyTranslate(vector3: Vector3): TransformNode;
  15243. private static _lookAtVectorCache;
  15244. /**
  15245. * Orients a mesh towards a target point. Mesh must be drawn facing user.
  15246. * @param targetPoint the position (must be in same space as current mesh) to look at
  15247. * @param yawCor optional yaw (y-axis) correction in radians
  15248. * @param pitchCor optional pitch (x-axis) correction in radians
  15249. * @param rollCor optional roll (z-axis) correction in radians
  15250. * @param space the choosen space of the target
  15251. * @returns the TransformNode.
  15252. */
  15253. lookAt(targetPoint: Vector3, yawCor?: number, pitchCor?: number, rollCor?: number, space?: Space): TransformNode;
  15254. /**
  15255. * Returns a new Vector3 that is the localAxis, expressed in the mesh local space, rotated like the mesh.
  15256. * This Vector3 is expressed in the World space.
  15257. * @param localAxis axis to rotate
  15258. * @returns a new Vector3 that is the localAxis, expressed in the mesh local space, rotated like the mesh.
  15259. */
  15260. getDirection(localAxis: Vector3): Vector3;
  15261. /**
  15262. * Sets the Vector3 "result" as the rotated Vector3 "localAxis" in the same rotation than the mesh.
  15263. * localAxis is expressed in the mesh local space.
  15264. * result is computed in the Wordl space from the mesh World matrix.
  15265. * @param localAxis axis to rotate
  15266. * @param result the resulting transformnode
  15267. * @returns this TransformNode.
  15268. */
  15269. getDirectionToRef(localAxis: Vector3, result: Vector3): TransformNode;
  15270. /**
  15271. * Sets this transform node rotation to the given local axis.
  15272. * @param localAxis the axis in local space
  15273. * @param yawCor optional yaw (y-axis) correction in radians
  15274. * @param pitchCor optional pitch (x-axis) correction in radians
  15275. * @param rollCor optional roll (z-axis) correction in radians
  15276. * @returns this TransformNode
  15277. */
  15278. setDirection(localAxis: Vector3, yawCor?: number, pitchCor?: number, rollCor?: number): TransformNode;
  15279. /**
  15280. * Sets a new pivot point to the current node
  15281. * @param point defines the new pivot point to use
  15282. * @param space defines if the point is in world or local space (local by default)
  15283. * @returns the current TransformNode
  15284. */
  15285. setPivotPoint(point: Vector3, space?: Space): TransformNode;
  15286. /**
  15287. * Returns a new Vector3 set with the mesh pivot point coordinates in the local space.
  15288. * @returns the pivot point
  15289. */
  15290. getPivotPoint(): Vector3;
  15291. /**
  15292. * Sets the passed Vector3 "result" with the coordinates of the mesh pivot point in the local space.
  15293. * @param result the vector3 to store the result
  15294. * @returns this TransformNode.
  15295. */
  15296. getPivotPointToRef(result: Vector3): TransformNode;
  15297. /**
  15298. * Returns a new Vector3 set with the mesh pivot point World coordinates.
  15299. * @returns a new Vector3 set with the mesh pivot point World coordinates.
  15300. */
  15301. getAbsolutePivotPoint(): Vector3;
  15302. /**
  15303. * Sets the Vector3 "result" coordinates with the mesh pivot point World coordinates.
  15304. * @param result vector3 to store the result
  15305. * @returns this TransformNode.
  15306. */
  15307. getAbsolutePivotPointToRef(result: Vector3): TransformNode;
  15308. /**
  15309. * Defines the passed node as the parent of the current node.
  15310. * The node will remain exactly where it is and its position / rotation will be updated accordingly
  15311. * @see https://doc.babylonjs.com/how_to/parenting
  15312. * @param node the node ot set as the parent
  15313. * @returns this TransformNode.
  15314. */
  15315. setParent(node: Nullable<Node>): TransformNode;
  15316. private _nonUniformScaling;
  15317. /**
  15318. * True if the scaling property of this object is non uniform eg. (1,2,1)
  15319. */
  15320. get nonUniformScaling(): boolean;
  15321. /** @hidden */
  15322. _updateNonUniformScalingState(value: boolean): boolean;
  15323. /**
  15324. * Attach the current TransformNode to another TransformNode associated with a bone
  15325. * @param bone Bone affecting the TransformNode
  15326. * @param affectedTransformNode TransformNode associated with the bone
  15327. * @returns this object
  15328. */
  15329. attachToBone(bone: Bone, affectedTransformNode: TransformNode): TransformNode;
  15330. /**
  15331. * Detach the transform node if its associated with a bone
  15332. * @returns this object
  15333. */
  15334. detachFromBone(): TransformNode;
  15335. private static _rotationAxisCache;
  15336. /**
  15337. * Rotates the mesh around the axis vector for the passed angle (amount) expressed in radians, in the given space.
  15338. * space (default LOCAL) can be either Space.LOCAL, either Space.WORLD.
  15339. * Note that the property `rotationQuaternion` is then automatically updated and the property `rotation` is set to (0,0,0) and no longer used.
  15340. * The passed axis is also normalized.
  15341. * @param axis the axis to rotate around
  15342. * @param amount the amount to rotate in radians
  15343. * @param space Space to rotate in (Default: local)
  15344. * @returns the TransformNode.
  15345. */
  15346. rotate(axis: Vector3, amount: number, space?: Space): TransformNode;
  15347. /**
  15348. * Rotates the mesh around the axis vector for the passed angle (amount) expressed in radians, in world space.
  15349. * Note that the property `rotationQuaternion` is then automatically updated and the property `rotation` is set to (0,0,0) and no longer used.
  15350. * The passed axis is also normalized. .
  15351. * Method is based on http://www.euclideanspace.com/maths/geometry/affine/aroundPoint/index.htm
  15352. * @param point the point to rotate around
  15353. * @param axis the axis to rotate around
  15354. * @param amount the amount to rotate in radians
  15355. * @returns the TransformNode
  15356. */
  15357. rotateAround(point: Vector3, axis: Vector3, amount: number): TransformNode;
  15358. /**
  15359. * Translates the mesh along the axis vector for the passed distance in the given space.
  15360. * space (default LOCAL) can be either Space.LOCAL, either Space.WORLD.
  15361. * @param axis the axis to translate in
  15362. * @param distance the distance to translate
  15363. * @param space Space to rotate in (Default: local)
  15364. * @returns the TransformNode.
  15365. */
  15366. translate(axis: Vector3, distance: number, space?: Space): TransformNode;
  15367. /**
  15368. * Adds a rotation step to the mesh current rotation.
  15369. * x, y, z are Euler angles expressed in radians.
  15370. * This methods updates the current mesh rotation, either mesh.rotation, either mesh.rotationQuaternion if it's set.
  15371. * This means this rotation is made in the mesh local space only.
  15372. * It's useful to set a custom rotation order different from the BJS standard one YXZ.
  15373. * Example : this rotates the mesh first around its local X axis, then around its local Z axis, finally around its local Y axis.
  15374. * ```javascript
  15375. * mesh.addRotation(x1, 0, 0).addRotation(0, 0, z2).addRotation(0, 0, y3);
  15376. * ```
  15377. * Note that `addRotation()` accumulates the passed rotation values to the current ones and computes the .rotation or .rotationQuaternion updated values.
  15378. * Under the hood, only quaternions are used. So it's a little faster is you use .rotationQuaternion because it doesn't need to translate them back to Euler angles.
  15379. * @param x Rotation to add
  15380. * @param y Rotation to add
  15381. * @param z Rotation to add
  15382. * @returns the TransformNode.
  15383. */
  15384. addRotation(x: number, y: number, z: number): TransformNode;
  15385. /**
  15386. * @hidden
  15387. */
  15388. protected _getEffectiveParent(): Nullable<Node>;
  15389. /**
  15390. * Computes the world matrix of the node
  15391. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  15392. * @returns the world matrix
  15393. */
  15394. computeWorldMatrix(force?: boolean): Matrix;
  15395. /**
  15396. * Resets this nodeTransform's local matrix to Matrix.Identity().
  15397. * @param independentOfChildren indicates if all child nodeTransform's world-space transform should be preserved.
  15398. */
  15399. resetLocalMatrix(independentOfChildren?: boolean): void;
  15400. protected _afterComputeWorldMatrix(): void;
  15401. /**
  15402. * If you'd like to be called back after the mesh position, rotation or scaling has been updated.
  15403. * @param func callback function to add
  15404. *
  15405. * @returns the TransformNode.
  15406. */
  15407. registerAfterWorldMatrixUpdate(func: (mesh: TransformNode) => void): TransformNode;
  15408. /**
  15409. * Removes a registered callback function.
  15410. * @param func callback function to remove
  15411. * @returns the TransformNode.
  15412. */
  15413. unregisterAfterWorldMatrixUpdate(func: (mesh: TransformNode) => void): TransformNode;
  15414. /**
  15415. * Gets the position of the current mesh in camera space
  15416. * @param camera defines the camera to use
  15417. * @returns a position
  15418. */
  15419. getPositionInCameraSpace(camera?: Nullable<Camera>): Vector3;
  15420. /**
  15421. * Returns the distance from the mesh to the active camera
  15422. * @param camera defines the camera to use
  15423. * @returns the distance
  15424. */
  15425. getDistanceToCamera(camera?: Nullable<Camera>): number;
  15426. /**
  15427. * Clone the current transform node
  15428. * @param name Name of the new clone
  15429. * @param newParent New parent for the clone
  15430. * @param doNotCloneChildren Do not clone children hierarchy
  15431. * @returns the new transform node
  15432. */
  15433. clone(name: string, newParent: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<TransformNode>;
  15434. /**
  15435. * Serializes the objects information.
  15436. * @param currentSerializationObject defines the object to serialize in
  15437. * @returns the serialized object
  15438. */
  15439. serialize(currentSerializationObject?: any): any;
  15440. /**
  15441. * Returns a new TransformNode object parsed from the source provided.
  15442. * @param parsedTransformNode is the source.
  15443. * @param scene the scne the object belongs to
  15444. * @param rootUrl is a string, it's the root URL to prefix the `delayLoadingFile` property with
  15445. * @returns a new TransformNode object parsed from the source provided.
  15446. */
  15447. static Parse(parsedTransformNode: any, scene: Scene, rootUrl: string): TransformNode;
  15448. /**
  15449. * Get all child-transformNodes of this node
  15450. * @param directDescendantsOnly defines if true only direct descendants of 'this' will be considered, if false direct and also indirect (children of children, an so on in a recursive manner) descendants of 'this' will be considered
  15451. * @param predicate defines an optional predicate that will be called on every evaluated child, the predicate must return true for a given child to be part of the result, otherwise it will be ignored
  15452. * @returns an array of TransformNode
  15453. */
  15454. getChildTransformNodes(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): TransformNode[];
  15455. /**
  15456. * Releases resources associated with this transform node.
  15457. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  15458. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  15459. */
  15460. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  15461. /**
  15462. * Uniformly scales the mesh to fit inside of a unit cube (1 X 1 X 1 units)
  15463. * @param includeDescendants Use the hierarchy's bounding box instead of the mesh's bounding box. Default is false
  15464. * @param ignoreRotation ignore rotation when computing the scale (ie. object will be axis aligned). Default is false
  15465. * @param predicate predicate that is passed in to getHierarchyBoundingVectors when selecting which object should be included when scaling
  15466. * @returns the current mesh
  15467. */
  15468. normalizeToUnitCube(includeDescendants?: boolean, ignoreRotation?: boolean, predicate?: Nullable<(node: AbstractMesh) => boolean>): TransformNode;
  15469. private _syncAbsoluteScalingAndRotation;
  15470. }
  15471. }
  15472. declare module "babylonjs/Animations/animationPropertiesOverride" {
  15473. /**
  15474. * Class used to override all child animations of a given target
  15475. */
  15476. export class AnimationPropertiesOverride {
  15477. /**
  15478. * Gets or sets a value indicating if animation blending must be used
  15479. */
  15480. enableBlending: boolean;
  15481. /**
  15482. * Gets or sets the blending speed to use when enableBlending is true
  15483. */
  15484. blendingSpeed: number;
  15485. /**
  15486. * Gets or sets the default loop mode to use
  15487. */
  15488. loopMode: number;
  15489. }
  15490. }
  15491. declare module "babylonjs/Bones/bone" {
  15492. import { Skeleton } from "babylonjs/Bones/skeleton";
  15493. import { Vector3, Quaternion, Matrix } from "babylonjs/Maths/math.vector";
  15494. import { Nullable } from "babylonjs/types";
  15495. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  15496. import { TransformNode } from "babylonjs/Meshes/transformNode";
  15497. import { Node } from "babylonjs/node";
  15498. import { Space } from "babylonjs/Maths/math.axis";
  15499. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  15500. /**
  15501. * Class used to store bone information
  15502. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  15503. */
  15504. export class Bone extends Node {
  15505. /**
  15506. * defines the bone name
  15507. */
  15508. name: string;
  15509. private static _tmpVecs;
  15510. private static _tmpQuat;
  15511. private static _tmpMats;
  15512. /**
  15513. * Gets the list of child bones
  15514. */
  15515. children: Bone[];
  15516. /** Gets the animations associated with this bone */
  15517. animations: import("babylonjs/Animations/animation").Animation[];
  15518. /**
  15519. * Gets or sets bone length
  15520. */
  15521. length: number;
  15522. /**
  15523. * @hidden Internal only
  15524. * Set this value to map this bone to a different index in the transform matrices
  15525. * Set this value to -1 to exclude the bone from the transform matrices
  15526. */
  15527. _index: Nullable<number>;
  15528. private _skeleton;
  15529. private _localMatrix;
  15530. private _restPose;
  15531. private _bindPose;
  15532. private _baseMatrix;
  15533. private _absoluteTransform;
  15534. private _invertedAbsoluteTransform;
  15535. private _parent;
  15536. private _scalingDeterminant;
  15537. private _worldTransform;
  15538. private _localScaling;
  15539. private _localRotation;
  15540. private _localPosition;
  15541. private _needToDecompose;
  15542. private _needToCompose;
  15543. /** @hidden */
  15544. _linkedTransformNode: Nullable<TransformNode>;
  15545. /** @hidden */
  15546. _waitingTransformNodeId: Nullable<string>;
  15547. /** @hidden */
  15548. get _matrix(): Matrix;
  15549. /** @hidden */
  15550. set _matrix(value: Matrix);
  15551. /**
  15552. * Create a new bone
  15553. * @param name defines the bone name
  15554. * @param skeleton defines the parent skeleton
  15555. * @param parentBone defines the parent (can be null if the bone is the root)
  15556. * @param localMatrix defines the local matrix
  15557. * @param restPose defines the rest pose matrix
  15558. * @param baseMatrix defines the base matrix
  15559. * @param index defines index of the bone in the hiearchy
  15560. */
  15561. constructor(
  15562. /**
  15563. * defines the bone name
  15564. */
  15565. name: string, skeleton: Skeleton, parentBone?: Nullable<Bone>, localMatrix?: Nullable<Matrix>, restPose?: Nullable<Matrix>, baseMatrix?: Nullable<Matrix>, index?: Nullable<number>);
  15566. /**
  15567. * Gets the current object class name.
  15568. * @return the class name
  15569. */
  15570. getClassName(): string;
  15571. /**
  15572. * Gets the parent skeleton
  15573. * @returns a skeleton
  15574. */
  15575. getSkeleton(): Skeleton;
  15576. /**
  15577. * Gets parent bone
  15578. * @returns a bone or null if the bone is the root of the bone hierarchy
  15579. */
  15580. getParent(): Nullable<Bone>;
  15581. /**
  15582. * Returns an array containing the root bones
  15583. * @returns an array containing the root bones
  15584. */
  15585. getChildren(): Array<Bone>;
  15586. /**
  15587. * Gets the node index in matrix array generated for rendering
  15588. * @returns the node index
  15589. */
  15590. getIndex(): number;
  15591. /**
  15592. * Sets the parent bone
  15593. * @param parent defines the parent (can be null if the bone is the root)
  15594. * @param updateDifferenceMatrix defines if the difference matrix must be updated
  15595. */
  15596. setParent(parent: Nullable<Bone>, updateDifferenceMatrix?: boolean): void;
  15597. /**
  15598. * Gets the local matrix
  15599. * @returns a matrix
  15600. */
  15601. getLocalMatrix(): Matrix;
  15602. /**
  15603. * Gets the base matrix (initial matrix which remains unchanged)
  15604. * @returns a matrix
  15605. */
  15606. getBaseMatrix(): Matrix;
  15607. /**
  15608. * Gets the rest pose matrix
  15609. * @returns a matrix
  15610. */
  15611. getRestPose(): Matrix;
  15612. /**
  15613. * Sets the rest pose matrix
  15614. * @param matrix the local-space rest pose to set for this bone
  15615. */
  15616. setRestPose(matrix: Matrix): void;
  15617. /**
  15618. * Gets the bind pose matrix
  15619. * @returns the bind pose matrix
  15620. */
  15621. getBindPose(): Matrix;
  15622. /**
  15623. * Sets the bind pose matrix
  15624. * @param matrix the local-space bind pose to set for this bone
  15625. */
  15626. setBindPose(matrix: Matrix): void;
  15627. /**
  15628. * Gets a matrix used to store world matrix (ie. the matrix sent to shaders)
  15629. */
  15630. getWorldMatrix(): Matrix;
  15631. /**
  15632. * Sets the local matrix to rest pose matrix
  15633. */
  15634. returnToRest(): void;
  15635. /**
  15636. * Gets the inverse of the absolute transform matrix.
  15637. * This matrix will be multiplied by local matrix to get the difference matrix (ie. the difference between original state and current state)
  15638. * @returns a matrix
  15639. */
  15640. getInvertedAbsoluteTransform(): Matrix;
  15641. /**
  15642. * Gets the absolute transform matrix (ie base matrix * parent world matrix)
  15643. * @returns a matrix
  15644. */
  15645. getAbsoluteTransform(): Matrix;
  15646. /**
  15647. * Links with the given transform node.
  15648. * The local matrix of this bone is copied from the transform node every frame.
  15649. * @param transformNode defines the transform node to link to
  15650. */
  15651. linkTransformNode(transformNode: Nullable<TransformNode>): void;
  15652. /**
  15653. * Gets the node used to drive the bone's transformation
  15654. * @returns a transform node or null
  15655. */
  15656. getTransformNode(): Nullable<TransformNode>;
  15657. /** Gets or sets current position (in local space) */
  15658. get position(): Vector3;
  15659. set position(newPosition: Vector3);
  15660. /** Gets or sets current rotation (in local space) */
  15661. get rotation(): Vector3;
  15662. set rotation(newRotation: Vector3);
  15663. /** Gets or sets current rotation quaternion (in local space) */
  15664. get rotationQuaternion(): Quaternion;
  15665. set rotationQuaternion(newRotation: Quaternion);
  15666. /** Gets or sets current scaling (in local space) */
  15667. get scaling(): Vector3;
  15668. set scaling(newScaling: Vector3);
  15669. /**
  15670. * Gets the animation properties override
  15671. */
  15672. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  15673. private _decompose;
  15674. private _compose;
  15675. /**
  15676. * Update the base and local matrices
  15677. * @param matrix defines the new base or local matrix
  15678. * @param updateDifferenceMatrix defines if the difference matrix must be updated
  15679. * @param updateLocalMatrix defines if the local matrix should be updated
  15680. */
  15681. updateMatrix(matrix: Matrix, updateDifferenceMatrix?: boolean, updateLocalMatrix?: boolean): void;
  15682. /** @hidden */
  15683. _updateDifferenceMatrix(rootMatrix?: Matrix, updateChildren?: boolean): void;
  15684. /**
  15685. * Flag the bone as dirty (Forcing it to update everything)
  15686. */
  15687. markAsDirty(): void;
  15688. /** @hidden */
  15689. _markAsDirtyAndCompose(): void;
  15690. private _markAsDirtyAndDecompose;
  15691. /**
  15692. * Translate the bone in local or world space
  15693. * @param vec The amount to translate the bone
  15694. * @param space The space that the translation is in
  15695. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15696. */
  15697. translate(vec: Vector3, space?: Space, mesh?: AbstractMesh): void;
  15698. /**
  15699. * Set the postion of the bone in local or world space
  15700. * @param position The position to set the bone
  15701. * @param space The space that the position is in
  15702. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15703. */
  15704. setPosition(position: Vector3, space?: Space, mesh?: AbstractMesh): void;
  15705. /**
  15706. * Set the absolute position of the bone (world space)
  15707. * @param position The position to set the bone
  15708. * @param mesh The mesh that this bone is attached to
  15709. */
  15710. setAbsolutePosition(position: Vector3, mesh?: AbstractMesh): void;
  15711. /**
  15712. * Scale the bone on the x, y and z axes (in local space)
  15713. * @param x The amount to scale the bone on the x axis
  15714. * @param y The amount to scale the bone on the y axis
  15715. * @param z The amount to scale the bone on the z axis
  15716. * @param scaleChildren sets this to true if children of the bone should be scaled as well (false by default)
  15717. */
  15718. scale(x: number, y: number, z: number, scaleChildren?: boolean): void;
  15719. /**
  15720. * Set the bone scaling in local space
  15721. * @param scale defines the scaling vector
  15722. */
  15723. setScale(scale: Vector3): void;
  15724. /**
  15725. * Gets the current scaling in local space
  15726. * @returns the current scaling vector
  15727. */
  15728. getScale(): Vector3;
  15729. /**
  15730. * Gets the current scaling in local space and stores it in a target vector
  15731. * @param result defines the target vector
  15732. */
  15733. getScaleToRef(result: Vector3): void;
  15734. /**
  15735. * Set the yaw, pitch, and roll of the bone in local or world space
  15736. * @param yaw The rotation of the bone on the y axis
  15737. * @param pitch The rotation of the bone on the x axis
  15738. * @param roll The rotation of the bone on the z axis
  15739. * @param space The space that the axes of rotation are in
  15740. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15741. */
  15742. setYawPitchRoll(yaw: number, pitch: number, roll: number, space?: Space, mesh?: AbstractMesh): void;
  15743. /**
  15744. * Add a rotation to the bone on an axis in local or world space
  15745. * @param axis The axis to rotate the bone on
  15746. * @param amount The amount to rotate the bone
  15747. * @param space The space that the axis is in
  15748. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15749. */
  15750. rotate(axis: Vector3, amount: number, space?: Space, mesh?: AbstractMesh): void;
  15751. /**
  15752. * Set the rotation of the bone to a particular axis angle in local or world space
  15753. * @param axis The axis to rotate the bone on
  15754. * @param angle The angle that the bone should be rotated to
  15755. * @param space The space that the axis is in
  15756. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15757. */
  15758. setAxisAngle(axis: Vector3, angle: number, space?: Space, mesh?: AbstractMesh): void;
  15759. /**
  15760. * Set the euler rotation of the bone in local of world space
  15761. * @param rotation The euler rotation that the bone should be set to
  15762. * @param space The space that the rotation is in
  15763. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15764. */
  15765. setRotation(rotation: Vector3, space?: Space, mesh?: AbstractMesh): void;
  15766. /**
  15767. * Set the quaternion rotation of the bone in local of world space
  15768. * @param quat The quaternion rotation that the bone should be set to
  15769. * @param space The space that the rotation is in
  15770. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15771. */
  15772. setRotationQuaternion(quat: Quaternion, space?: Space, mesh?: AbstractMesh): void;
  15773. /**
  15774. * Set the rotation matrix of the bone in local of world space
  15775. * @param rotMat The rotation matrix that the bone should be set to
  15776. * @param space The space that the rotation is in
  15777. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15778. */
  15779. setRotationMatrix(rotMat: Matrix, space?: Space, mesh?: AbstractMesh): void;
  15780. private _rotateWithMatrix;
  15781. private _getNegativeRotationToRef;
  15782. /**
  15783. * Get the position of the bone in local or world space
  15784. * @param space The space that the returned position is in
  15785. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15786. * @returns The position of the bone
  15787. */
  15788. getPosition(space?: Space, mesh?: Nullable<AbstractMesh>): Vector3;
  15789. /**
  15790. * Copy the position of the bone to a vector3 in local or world space
  15791. * @param space The space that the returned position is in
  15792. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15793. * @param result The vector3 to copy the position to
  15794. */
  15795. getPositionToRef(space: Space | undefined, mesh: Nullable<AbstractMesh>, result: Vector3): void;
  15796. /**
  15797. * Get the absolute position of the bone (world space)
  15798. * @param mesh The mesh that this bone is attached to
  15799. * @returns The absolute position of the bone
  15800. */
  15801. getAbsolutePosition(mesh?: Nullable<AbstractMesh>): Vector3;
  15802. /**
  15803. * Copy the absolute position of the bone (world space) to the result param
  15804. * @param mesh The mesh that this bone is attached to
  15805. * @param result The vector3 to copy the absolute position to
  15806. */
  15807. getAbsolutePositionToRef(mesh: AbstractMesh, result: Vector3): void;
  15808. /**
  15809. * Compute the absolute transforms of this bone and its children
  15810. */
  15811. computeAbsoluteTransforms(): void;
  15812. /**
  15813. * Get the world direction from an axis that is in the local space of the bone
  15814. * @param localAxis The local direction that is used to compute the world direction
  15815. * @param mesh The mesh that this bone is attached to
  15816. * @returns The world direction
  15817. */
  15818. getDirection(localAxis: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  15819. /**
  15820. * Copy the world direction to a vector3 from an axis that is in the local space of the bone
  15821. * @param localAxis The local direction that is used to compute the world direction
  15822. * @param mesh The mesh that this bone is attached to
  15823. * @param result The vector3 that the world direction will be copied to
  15824. */
  15825. getDirectionToRef(localAxis: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  15826. /**
  15827. * Get the euler rotation of the bone in local or world space
  15828. * @param space The space that the rotation should be in
  15829. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15830. * @returns The euler rotation
  15831. */
  15832. getRotation(space?: Space, mesh?: Nullable<AbstractMesh>): Vector3;
  15833. /**
  15834. * Copy the euler rotation of the bone to a vector3. The rotation can be in either local or world space
  15835. * @param space The space that the rotation should be in
  15836. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15837. * @param result The vector3 that the rotation should be copied to
  15838. */
  15839. getRotationToRef(space: Space | undefined, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  15840. /**
  15841. * Get the quaternion rotation of the bone in either local or world space
  15842. * @param space The space that the rotation should be in
  15843. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15844. * @returns The quaternion rotation
  15845. */
  15846. getRotationQuaternion(space?: Space, mesh?: Nullable<AbstractMesh>): Quaternion;
  15847. /**
  15848. * Copy the quaternion rotation of the bone to a quaternion. The rotation can be in either local or world space
  15849. * @param space The space that the rotation should be in
  15850. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15851. * @param result The quaternion that the rotation should be copied to
  15852. */
  15853. getRotationQuaternionToRef(space: Space | undefined, mesh: AbstractMesh | null | undefined, result: Quaternion): void;
  15854. /**
  15855. * Get the rotation matrix of the bone in local or world space
  15856. * @param space The space that the rotation should be in
  15857. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15858. * @returns The rotation matrix
  15859. */
  15860. getRotationMatrix(space: Space | undefined, mesh: AbstractMesh): Matrix;
  15861. /**
  15862. * Copy the rotation matrix of the bone to a matrix. The rotation can be in either local or world space
  15863. * @param space The space that the rotation should be in
  15864. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15865. * @param result The quaternion that the rotation should be copied to
  15866. */
  15867. getRotationMatrixToRef(space: Space | undefined, mesh: AbstractMesh, result: Matrix): void;
  15868. /**
  15869. * Get the world position of a point that is in the local space of the bone
  15870. * @param position The local position
  15871. * @param mesh The mesh that this bone is attached to
  15872. * @returns The world position
  15873. */
  15874. getAbsolutePositionFromLocal(position: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  15875. /**
  15876. * Get the world position of a point that is in the local space of the bone and copy it to the result param
  15877. * @param position The local position
  15878. * @param mesh The mesh that this bone is attached to
  15879. * @param result The vector3 that the world position should be copied to
  15880. */
  15881. getAbsolutePositionFromLocalToRef(position: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  15882. /**
  15883. * Get the local position of a point that is in world space
  15884. * @param position The world position
  15885. * @param mesh The mesh that this bone is attached to
  15886. * @returns The local position
  15887. */
  15888. getLocalPositionFromAbsolute(position: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  15889. /**
  15890. * Get the local position of a point that is in world space and copy it to the result param
  15891. * @param position The world position
  15892. * @param mesh The mesh that this bone is attached to
  15893. * @param result The vector3 that the local position should be copied to
  15894. */
  15895. getLocalPositionFromAbsoluteToRef(position: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  15896. }
  15897. }
  15898. declare module "babylonjs/Animations/runtimeAnimation" {
  15899. import { Animation, _IAnimationState } from "babylonjs/Animations/animation";
  15900. import { Animatable } from "babylonjs/Animations/animatable";
  15901. import { Scene } from "babylonjs/scene";
  15902. /**
  15903. * Defines a runtime animation
  15904. */
  15905. export class RuntimeAnimation {
  15906. private _events;
  15907. /**
  15908. * The current frame of the runtime animation
  15909. */
  15910. private _currentFrame;
  15911. /**
  15912. * The animation used by the runtime animation
  15913. */
  15914. private _animation;
  15915. /**
  15916. * The target of the runtime animation
  15917. */
  15918. private _target;
  15919. /**
  15920. * The initiating animatable
  15921. */
  15922. private _host;
  15923. /**
  15924. * The original value of the runtime animation
  15925. */
  15926. private _originalValue;
  15927. /**
  15928. * The original blend value of the runtime animation
  15929. */
  15930. private _originalBlendValue;
  15931. /**
  15932. * The offsets cache of the runtime animation
  15933. */
  15934. private _offsetsCache;
  15935. /**
  15936. * The high limits cache of the runtime animation
  15937. */
  15938. private _highLimitsCache;
  15939. /**
  15940. * Specifies if the runtime animation has been stopped
  15941. */
  15942. private _stopped;
  15943. /**
  15944. * The blending factor of the runtime animation
  15945. */
  15946. private _blendingFactor;
  15947. /**
  15948. * The BabylonJS scene
  15949. */
  15950. private _scene;
  15951. /**
  15952. * The current value of the runtime animation
  15953. */
  15954. private _currentValue;
  15955. /** @hidden */
  15956. _animationState: _IAnimationState;
  15957. /**
  15958. * The active target of the runtime animation
  15959. */
  15960. private _activeTargets;
  15961. private _currentActiveTarget;
  15962. private _directTarget;
  15963. /**
  15964. * The target path of the runtime animation
  15965. */
  15966. private _targetPath;
  15967. /**
  15968. * The weight of the runtime animation
  15969. */
  15970. private _weight;
  15971. /**
  15972. * The ratio offset of the runtime animation
  15973. */
  15974. private _ratioOffset;
  15975. /**
  15976. * The previous delay of the runtime animation
  15977. */
  15978. private _previousDelay;
  15979. /**
  15980. * The previous ratio of the runtime animation
  15981. */
  15982. private _previousRatio;
  15983. private _enableBlending;
  15984. private _keys;
  15985. private _minFrame;
  15986. private _maxFrame;
  15987. private _minValue;
  15988. private _maxValue;
  15989. private _targetIsArray;
  15990. /**
  15991. * Gets the current frame of the runtime animation
  15992. */
  15993. get currentFrame(): number;
  15994. /**
  15995. * Gets the weight of the runtime animation
  15996. */
  15997. get weight(): number;
  15998. /**
  15999. * Gets the current value of the runtime animation
  16000. */
  16001. get currentValue(): any;
  16002. /**
  16003. * Gets the target path of the runtime animation
  16004. */
  16005. get targetPath(): string;
  16006. /**
  16007. * Gets the actual target of the runtime animation
  16008. */
  16009. get target(): any;
  16010. /**
  16011. * Gets the additive state of the runtime animation
  16012. */
  16013. get isAdditive(): boolean;
  16014. /** @hidden */
  16015. _onLoop: () => void;
  16016. /**
  16017. * Create a new RuntimeAnimation object
  16018. * @param target defines the target of the animation
  16019. * @param animation defines the source animation object
  16020. * @param scene defines the hosting scene
  16021. * @param host defines the initiating Animatable
  16022. */
  16023. constructor(target: any, animation: Animation, scene: Scene, host: Animatable);
  16024. private _preparePath;
  16025. /**
  16026. * Gets the animation from the runtime animation
  16027. */
  16028. get animation(): Animation;
  16029. /**
  16030. * Resets the runtime animation to the beginning
  16031. * @param restoreOriginal defines whether to restore the target property to the original value
  16032. */
  16033. reset(restoreOriginal?: boolean): void;
  16034. /**
  16035. * Specifies if the runtime animation is stopped
  16036. * @returns Boolean specifying if the runtime animation is stopped
  16037. */
  16038. isStopped(): boolean;
  16039. /**
  16040. * Disposes of the runtime animation
  16041. */
  16042. dispose(): void;
  16043. /**
  16044. * Apply the interpolated value to the target
  16045. * @param currentValue defines the value computed by the animation
  16046. * @param weight defines the weight to apply to this value (Defaults to 1.0)
  16047. */
  16048. setValue(currentValue: any, weight: number): void;
  16049. private _getOriginalValues;
  16050. private _setValue;
  16051. /**
  16052. * Gets the loop pmode of the runtime animation
  16053. * @returns Loop Mode
  16054. */
  16055. private _getCorrectLoopMode;
  16056. /**
  16057. * Move the current animation to a given frame
  16058. * @param frame defines the frame to move to
  16059. */
  16060. goToFrame(frame: number): void;
  16061. /**
  16062. * @hidden Internal use only
  16063. */
  16064. _prepareForSpeedRatioChange(newSpeedRatio: number): void;
  16065. /**
  16066. * Execute the current animation
  16067. * @param delay defines the delay to add to the current frame
  16068. * @param from defines the lower bound of the animation range
  16069. * @param to defines the upper bound of the animation range
  16070. * @param loop defines if the current animation must loop
  16071. * @param speedRatio defines the current speed ratio
  16072. * @param weight defines the weight of the animation (default is -1 so no weight)
  16073. * @param onLoop optional callback called when animation loops
  16074. * @returns a boolean indicating if the animation is running
  16075. */
  16076. animate(delay: number, from: number, to: number, loop: boolean, speedRatio: number, weight?: number): boolean;
  16077. }
  16078. }
  16079. declare module "babylonjs/Animations/animatable" {
  16080. import { Animation } from "babylonjs/Animations/animation";
  16081. import { RuntimeAnimation } from "babylonjs/Animations/runtimeAnimation";
  16082. import { Nullable } from "babylonjs/types";
  16083. import { Observable } from "babylonjs/Misc/observable";
  16084. import { Scene } from "babylonjs/scene";
  16085. import { Matrix, Quaternion, Vector3 } from "babylonjs/Maths/math.vector";
  16086. import { Node } from "babylonjs/node";
  16087. /**
  16088. * Class used to store an actual running animation
  16089. */
  16090. export class Animatable {
  16091. /** defines the target object */
  16092. target: any;
  16093. /** defines the starting frame number (default is 0) */
  16094. fromFrame: number;
  16095. /** defines the ending frame number (default is 100) */
  16096. toFrame: number;
  16097. /** defines if the animation must loop (default is false) */
  16098. loopAnimation: boolean;
  16099. /** defines a callback to call when animation ends if it is not looping */
  16100. onAnimationEnd?: (() => void) | null | undefined;
  16101. /** defines a callback to call when animation loops */
  16102. onAnimationLoop?: (() => void) | null | undefined;
  16103. /** defines whether the animation should be evaluated additively */
  16104. isAdditive: boolean;
  16105. private _localDelayOffset;
  16106. private _pausedDelay;
  16107. private _runtimeAnimations;
  16108. private _paused;
  16109. private _scene;
  16110. private _speedRatio;
  16111. private _weight;
  16112. private _syncRoot;
  16113. /**
  16114. * Gets or sets a boolean indicating if the animatable must be disposed and removed at the end of the animation.
  16115. * This will only apply for non looping animation (default is true)
  16116. */
  16117. disposeOnEnd: boolean;
  16118. /**
  16119. * Gets a boolean indicating if the animation has started
  16120. */
  16121. animationStarted: boolean;
  16122. /**
  16123. * Observer raised when the animation ends
  16124. */
  16125. onAnimationEndObservable: Observable<Animatable>;
  16126. /**
  16127. * Observer raised when the animation loops
  16128. */
  16129. onAnimationLoopObservable: Observable<Animatable>;
  16130. /**
  16131. * Gets the root Animatable used to synchronize and normalize animations
  16132. */
  16133. get syncRoot(): Nullable<Animatable>;
  16134. /**
  16135. * Gets the current frame of the first RuntimeAnimation
  16136. * Used to synchronize Animatables
  16137. */
  16138. get masterFrame(): number;
  16139. /**
  16140. * Gets or sets the animatable weight (-1.0 by default meaning not weighted)
  16141. */
  16142. get weight(): number;
  16143. set weight(value: number);
  16144. /**
  16145. * Gets or sets the speed ratio to apply to the animatable (1.0 by default)
  16146. */
  16147. get speedRatio(): number;
  16148. set speedRatio(value: number);
  16149. /**
  16150. * Creates a new Animatable
  16151. * @param scene defines the hosting scene
  16152. * @param target defines the target object
  16153. * @param fromFrame defines the starting frame number (default is 0)
  16154. * @param toFrame defines the ending frame number (default is 100)
  16155. * @param loopAnimation defines if the animation must loop (default is false)
  16156. * @param speedRatio defines the factor to apply to animation speed (default is 1)
  16157. * @param onAnimationEnd defines a callback to call when animation ends if it is not looping
  16158. * @param animations defines a group of animation to add to the new Animatable
  16159. * @param onAnimationLoop defines a callback to call when animation loops
  16160. * @param isAdditive defines whether the animation should be evaluated additively
  16161. */
  16162. constructor(scene: Scene,
  16163. /** defines the target object */
  16164. target: any,
  16165. /** defines the starting frame number (default is 0) */
  16166. fromFrame?: number,
  16167. /** defines the ending frame number (default is 100) */
  16168. toFrame?: number,
  16169. /** defines if the animation must loop (default is false) */
  16170. loopAnimation?: boolean, speedRatio?: number,
  16171. /** defines a callback to call when animation ends if it is not looping */
  16172. onAnimationEnd?: (() => void) | null | undefined, animations?: Animation[],
  16173. /** defines a callback to call when animation loops */
  16174. onAnimationLoop?: (() => void) | null | undefined,
  16175. /** defines whether the animation should be evaluated additively */
  16176. isAdditive?: boolean);
  16177. /**
  16178. * Synchronize and normalize current Animatable with a source Animatable
  16179. * This is useful when using animation weights and when animations are not of the same length
  16180. * @param root defines the root Animatable to synchronize with
  16181. * @returns the current Animatable
  16182. */
  16183. syncWith(root: Animatable): Animatable;
  16184. /**
  16185. * Gets the list of runtime animations
  16186. * @returns an array of RuntimeAnimation
  16187. */
  16188. getAnimations(): RuntimeAnimation[];
  16189. /**
  16190. * Adds more animations to the current animatable
  16191. * @param target defines the target of the animations
  16192. * @param animations defines the new animations to add
  16193. */
  16194. appendAnimations(target: any, animations: Animation[]): void;
  16195. /**
  16196. * Gets the source animation for a specific property
  16197. * @param property defines the propertyu to look for
  16198. * @returns null or the source animation for the given property
  16199. */
  16200. getAnimationByTargetProperty(property: string): Nullable<Animation>;
  16201. /**
  16202. * Gets the runtime animation for a specific property
  16203. * @param property defines the propertyu to look for
  16204. * @returns null or the runtime animation for the given property
  16205. */
  16206. getRuntimeAnimationByTargetProperty(property: string): Nullable<RuntimeAnimation>;
  16207. /**
  16208. * Resets the animatable to its original state
  16209. */
  16210. reset(): void;
  16211. /**
  16212. * Allows the animatable to blend with current running animations
  16213. * @see https://doc.babylonjs.com/babylon101/animations#animation-blending
  16214. * @param blendingSpeed defines the blending speed to use
  16215. */
  16216. enableBlending(blendingSpeed: number): void;
  16217. /**
  16218. * Disable animation blending
  16219. * @see https://doc.babylonjs.com/babylon101/animations#animation-blending
  16220. */
  16221. disableBlending(): void;
  16222. /**
  16223. * Jump directly to a given frame
  16224. * @param frame defines the frame to jump to
  16225. */
  16226. goToFrame(frame: number): void;
  16227. /**
  16228. * Pause the animation
  16229. */
  16230. pause(): void;
  16231. /**
  16232. * Restart the animation
  16233. */
  16234. restart(): void;
  16235. private _raiseOnAnimationEnd;
  16236. /**
  16237. * Stop and delete the current animation
  16238. * @param animationName defines a string used to only stop some of the runtime animations instead of all
  16239. * @param targetMask - a function that determines if the animation should be stopped based on its target (all animations will be stopped if both this and animationName are empty)
  16240. */
  16241. stop(animationName?: string, targetMask?: (target: any) => boolean): void;
  16242. /**
  16243. * Wait asynchronously for the animation to end
  16244. * @returns a promise which will be fullfilled when the animation ends
  16245. */
  16246. waitAsync(): Promise<Animatable>;
  16247. /** @hidden */
  16248. _animate(delay: number): boolean;
  16249. }
  16250. module "babylonjs/scene" {
  16251. interface Scene {
  16252. /** @hidden */
  16253. _registerTargetForLateAnimationBinding(runtimeAnimation: RuntimeAnimation, originalValue: any): void;
  16254. /** @hidden */
  16255. _processLateAnimationBindingsForMatrices(holder: {
  16256. totalWeight: number;
  16257. totalAdditiveWeight: number;
  16258. animations: RuntimeAnimation[];
  16259. additiveAnimations: RuntimeAnimation[];
  16260. originalValue: Matrix;
  16261. }): any;
  16262. /** @hidden */
  16263. _processLateAnimationBindingsForQuaternions(holder: {
  16264. totalWeight: number;
  16265. totalAdditiveWeight: number;
  16266. animations: RuntimeAnimation[];
  16267. additiveAnimations: RuntimeAnimation[];
  16268. originalValue: Quaternion;
  16269. }, refQuaternion: Quaternion): Quaternion;
  16270. /** @hidden */
  16271. _processLateAnimationBindings(): void;
  16272. /**
  16273. * Will start the animation sequence of a given target
  16274. * @param target defines the target
  16275. * @param from defines from which frame should animation start
  16276. * @param to defines until which frame should animation run.
  16277. * @param weight defines the weight to apply to the animation (1.0 by default)
  16278. * @param loop defines if the animation loops
  16279. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  16280. * @param onAnimationEnd defines the function to be executed when the animation ends
  16281. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  16282. * @param targetMask defines if the target should be animated if animations are present (this is called recursively on descendant animatables regardless of return value)
  16283. * @param onAnimationLoop defines the callback to call when an animation loops
  16284. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  16285. * @returns the animatable object created for this animation
  16286. */
  16287. beginWeightedAnimation(target: any, from: number, to: number, weight: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, animatable?: Animatable, targetMask?: (target: any) => boolean, onAnimationLoop?: () => void, isAdditive?: boolean): Animatable;
  16288. /**
  16289. * Will start the animation sequence of a given target
  16290. * @param target defines the target
  16291. * @param from defines from which frame should animation start
  16292. * @param to defines until which frame should animation run.
  16293. * @param loop defines if the animation loops
  16294. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  16295. * @param onAnimationEnd defines the function to be executed when the animation ends
  16296. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  16297. * @param stopCurrent defines if the current animations must be stopped first (true by default)
  16298. * @param targetMask defines if the target should be animate if animations are present (this is called recursively on descendant animatables regardless of return value)
  16299. * @param onAnimationLoop defines the callback to call when an animation loops
  16300. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  16301. * @returns the animatable object created for this animation
  16302. */
  16303. beginAnimation(target: any, from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, animatable?: Animatable, stopCurrent?: boolean, targetMask?: (target: any) => boolean, onAnimationLoop?: () => void, isAdditive?: boolean): Animatable;
  16304. /**
  16305. * Will start the animation sequence of a given target and its hierarchy
  16306. * @param target defines the target
  16307. * @param directDescendantsOnly if true only direct descendants will be used, if false direct and also indirect (children of children, an so on in a recursive manner) descendants will be used.
  16308. * @param from defines from which frame should animation start
  16309. * @param to defines until which frame should animation run.
  16310. * @param loop defines if the animation loops
  16311. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  16312. * @param onAnimationEnd defines the function to be executed when the animation ends
  16313. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  16314. * @param stopCurrent defines if the current animations must be stopped first (true by default)
  16315. * @param targetMask defines if the target should be animated if animations are present (this is called recursively on descendant animatables regardless of return value)
  16316. * @param onAnimationLoop defines the callback to call when an animation loops
  16317. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  16318. * @returns the list of created animatables
  16319. */
  16320. beginHierarchyAnimation(target: any, directDescendantsOnly: boolean, from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, animatable?: Animatable, stopCurrent?: boolean, targetMask?: (target: any) => boolean, onAnimationLoop?: () => void, isAdditive?: boolean): Animatable[];
  16321. /**
  16322. * Begin a new animation on a given node
  16323. * @param target defines the target where the animation will take place
  16324. * @param animations defines the list of animations to start
  16325. * @param from defines the initial value
  16326. * @param to defines the final value
  16327. * @param loop defines if you want animation to loop (off by default)
  16328. * @param speedRatio defines the speed ratio to apply to all animations
  16329. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  16330. * @param onAnimationLoop defines the callback to call when an animation loops
  16331. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  16332. * @returns the list of created animatables
  16333. */
  16334. beginDirectAnimation(target: any, animations: Animation[], from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, onAnimationLoop?: () => void, isAdditive?: boolean): Animatable;
  16335. /**
  16336. * Begin a new animation on a given node and its hierarchy
  16337. * @param target defines the root node where the animation will take place
  16338. * @param directDescendantsOnly if true only direct descendants will be used, if false direct and also indirect (children of children, an so on in a recursive manner) descendants will be used.
  16339. * @param animations defines the list of animations to start
  16340. * @param from defines the initial value
  16341. * @param to defines the final value
  16342. * @param loop defines if you want animation to loop (off by default)
  16343. * @param speedRatio defines the speed ratio to apply to all animations
  16344. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  16345. * @param onAnimationLoop defines the callback to call when an animation loops
  16346. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  16347. * @returns the list of animatables created for all nodes
  16348. */
  16349. beginDirectHierarchyAnimation(target: Node, directDescendantsOnly: boolean, animations: Animation[], from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, onAnimationLoop?: () => void, isAdditive?: boolean): Animatable[];
  16350. /**
  16351. * Gets the animatable associated with a specific target
  16352. * @param target defines the target of the animatable
  16353. * @returns the required animatable if found
  16354. */
  16355. getAnimatableByTarget(target: any): Nullable<Animatable>;
  16356. /**
  16357. * Gets all animatables associated with a given target
  16358. * @param target defines the target to look animatables for
  16359. * @returns an array of Animatables
  16360. */
  16361. getAllAnimatablesByTarget(target: any): Array<Animatable>;
  16362. /**
  16363. * Stops and removes all animations that have been applied to the scene
  16364. */
  16365. stopAllAnimations(): void;
  16366. /**
  16367. * Gets the current delta time used by animation engine
  16368. */
  16369. deltaTime: number;
  16370. }
  16371. }
  16372. module "babylonjs/Bones/bone" {
  16373. interface Bone {
  16374. /**
  16375. * Copy an animation range from another bone
  16376. * @param source defines the source bone
  16377. * @param rangeName defines the range name to copy
  16378. * @param frameOffset defines the frame offset
  16379. * @param rescaleAsRequired defines if rescaling must be applied if required
  16380. * @param skelDimensionsRatio defines the scaling ratio
  16381. * @returns true if operation was successful
  16382. */
  16383. copyAnimationRange(source: Bone, rangeName: string, frameOffset: number, rescaleAsRequired: boolean, skelDimensionsRatio: Nullable<Vector3>): boolean;
  16384. }
  16385. }
  16386. }
  16387. declare module "babylonjs/Bones/skeleton" {
  16388. import { Bone } from "babylonjs/Bones/bone";
  16389. import { Observable } from "babylonjs/Misc/observable";
  16390. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  16391. import { Scene } from "babylonjs/scene";
  16392. import { Nullable } from "babylonjs/types";
  16393. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  16394. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  16395. import { Animatable } from "babylonjs/Animations/animatable";
  16396. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  16397. import { Animation } from "babylonjs/Animations/animation";
  16398. import { AnimationRange } from "babylonjs/Animations/animationRange";
  16399. import { IInspectable } from "babylonjs/Misc/iInspectable";
  16400. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  16401. /**
  16402. * Class used to handle skinning animations
  16403. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  16404. */
  16405. export class Skeleton implements IAnimatable {
  16406. /** defines the skeleton name */
  16407. name: string;
  16408. /** defines the skeleton Id */
  16409. id: string;
  16410. /**
  16411. * Defines the list of child bones
  16412. */
  16413. bones: Bone[];
  16414. /**
  16415. * Defines an estimate of the dimension of the skeleton at rest
  16416. */
  16417. dimensionsAtRest: Vector3;
  16418. /**
  16419. * Defines a boolean indicating if the root matrix is provided by meshes or by the current skeleton (this is the default value)
  16420. */
  16421. needInitialSkinMatrix: boolean;
  16422. /**
  16423. * Defines a mesh that override the matrix used to get the world matrix (null by default).
  16424. */
  16425. overrideMesh: Nullable<AbstractMesh>;
  16426. /**
  16427. * Gets the list of animations attached to this skeleton
  16428. */
  16429. animations: Array<Animation>;
  16430. private _scene;
  16431. private _isDirty;
  16432. private _transformMatrices;
  16433. private _transformMatrixTexture;
  16434. private _meshesWithPoseMatrix;
  16435. private _animatables;
  16436. private _identity;
  16437. private _synchronizedWithMesh;
  16438. private _ranges;
  16439. private _lastAbsoluteTransformsUpdateId;
  16440. private _canUseTextureForBones;
  16441. private _uniqueId;
  16442. /** @hidden */
  16443. _numBonesWithLinkedTransformNode: number;
  16444. /** @hidden */
  16445. _hasWaitingData: Nullable<boolean>;
  16446. /**
  16447. * Specifies if the skeleton should be serialized
  16448. */
  16449. doNotSerialize: boolean;
  16450. private _useTextureToStoreBoneMatrices;
  16451. /**
  16452. * Gets or sets a boolean indicating that bone matrices should be stored as a texture instead of using shader uniforms (default is true).
  16453. * Please note that this option is not available if the hardware does not support it
  16454. */
  16455. get useTextureToStoreBoneMatrices(): boolean;
  16456. set useTextureToStoreBoneMatrices(value: boolean);
  16457. private _animationPropertiesOverride;
  16458. /**
  16459. * Gets or sets the animation properties override
  16460. */
  16461. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  16462. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  16463. /**
  16464. * List of inspectable custom properties (used by the Inspector)
  16465. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  16466. */
  16467. inspectableCustomProperties: IInspectable[];
  16468. /**
  16469. * An observable triggered before computing the skeleton's matrices
  16470. */
  16471. onBeforeComputeObservable: Observable<Skeleton>;
  16472. /**
  16473. * Gets a boolean indicating that the skeleton effectively stores matrices into a texture
  16474. */
  16475. get isUsingTextureForMatrices(): boolean;
  16476. /**
  16477. * Gets the unique ID of this skeleton
  16478. */
  16479. get uniqueId(): number;
  16480. /**
  16481. * Creates a new skeleton
  16482. * @param name defines the skeleton name
  16483. * @param id defines the skeleton Id
  16484. * @param scene defines the hosting scene
  16485. */
  16486. constructor(
  16487. /** defines the skeleton name */
  16488. name: string,
  16489. /** defines the skeleton Id */
  16490. id: string, scene: Scene);
  16491. /**
  16492. * Gets the current object class name.
  16493. * @return the class name
  16494. */
  16495. getClassName(): string;
  16496. /**
  16497. * Returns an array containing the root bones
  16498. * @returns an array containing the root bones
  16499. */
  16500. getChildren(): Array<Bone>;
  16501. /**
  16502. * Gets the list of transform matrices to send to shaders (one matrix per bone)
  16503. * @param mesh defines the mesh to use to get the root matrix (if needInitialSkinMatrix === true)
  16504. * @returns a Float32Array containing matrices data
  16505. */
  16506. getTransformMatrices(mesh: AbstractMesh): Float32Array;
  16507. /**
  16508. * Gets the list of transform matrices to send to shaders inside a texture (one matrix per bone)
  16509. * @param mesh defines the mesh to use to get the root matrix (if needInitialSkinMatrix === true)
  16510. * @returns a raw texture containing the data
  16511. */
  16512. getTransformMatrixTexture(mesh: AbstractMesh): Nullable<RawTexture>;
  16513. /**
  16514. * Gets the current hosting scene
  16515. * @returns a scene object
  16516. */
  16517. getScene(): Scene;
  16518. /**
  16519. * Gets a string representing the current skeleton data
  16520. * @param fullDetails defines a boolean indicating if we want a verbose version
  16521. * @returns a string representing the current skeleton data
  16522. */
  16523. toString(fullDetails?: boolean): string;
  16524. /**
  16525. * Get bone's index searching by name
  16526. * @param name defines bone's name to search for
  16527. * @return the indice of the bone. Returns -1 if not found
  16528. */
  16529. getBoneIndexByName(name: string): number;
  16530. /**
  16531. * Creater a new animation range
  16532. * @param name defines the name of the range
  16533. * @param from defines the start key
  16534. * @param to defines the end key
  16535. */
  16536. createAnimationRange(name: string, from: number, to: number): void;
  16537. /**
  16538. * Delete a specific animation range
  16539. * @param name defines the name of the range
  16540. * @param deleteFrames defines if frames must be removed as well
  16541. */
  16542. deleteAnimationRange(name: string, deleteFrames?: boolean): void;
  16543. /**
  16544. * Gets a specific animation range
  16545. * @param name defines the name of the range to look for
  16546. * @returns the requested animation range or null if not found
  16547. */
  16548. getAnimationRange(name: string): Nullable<AnimationRange>;
  16549. /**
  16550. * Gets the list of all animation ranges defined on this skeleton
  16551. * @returns an array
  16552. */
  16553. getAnimationRanges(): Nullable<AnimationRange>[];
  16554. /**
  16555. * Copy animation range from a source skeleton.
  16556. * This is not for a complete retargeting, only between very similar skeleton's with only possible bone length differences
  16557. * @param source defines the source skeleton
  16558. * @param name defines the name of the range to copy
  16559. * @param rescaleAsRequired defines if rescaling must be applied if required
  16560. * @returns true if operation was successful
  16561. */
  16562. copyAnimationRange(source: Skeleton, name: string, rescaleAsRequired?: boolean): boolean;
  16563. /**
  16564. * Forces the skeleton to go to rest pose
  16565. */
  16566. returnToRest(): void;
  16567. private _getHighestAnimationFrame;
  16568. /**
  16569. * Begin a specific animation range
  16570. * @param name defines the name of the range to start
  16571. * @param loop defines if looping must be turned on (false by default)
  16572. * @param speedRatio defines the speed ratio to apply (1 by default)
  16573. * @param onAnimationEnd defines a callback which will be called when animation will end
  16574. * @returns a new animatable
  16575. */
  16576. beginAnimation(name: string, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void): Nullable<Animatable>;
  16577. /**
  16578. * Convert the keyframes for a range of animation on a skeleton to be relative to a given reference frame.
  16579. * @param skeleton defines the Skeleton containing the animation range to convert
  16580. * @param referenceFrame defines the frame that keyframes in the range will be relative to
  16581. * @param range defines the name of the AnimationRange belonging to the Skeleton to convert
  16582. * @returns the original skeleton
  16583. */
  16584. static MakeAnimationAdditive(skeleton: Skeleton, referenceFrame: number | undefined, range: string): Nullable<Skeleton>;
  16585. /** @hidden */
  16586. _markAsDirty(): void;
  16587. /** @hidden */
  16588. _registerMeshWithPoseMatrix(mesh: AbstractMesh): void;
  16589. /** @hidden */
  16590. _unregisterMeshWithPoseMatrix(mesh: AbstractMesh): void;
  16591. private _computeTransformMatrices;
  16592. /**
  16593. * Build all resources required to render a skeleton
  16594. */
  16595. prepare(): void;
  16596. /**
  16597. * Gets the list of animatables currently running for this skeleton
  16598. * @returns an array of animatables
  16599. */
  16600. getAnimatables(): IAnimatable[];
  16601. /**
  16602. * Clone the current skeleton
  16603. * @param name defines the name of the new skeleton
  16604. * @param id defines the id of the new skeleton
  16605. * @returns the new skeleton
  16606. */
  16607. clone(name: string, id?: string): Skeleton;
  16608. /**
  16609. * Enable animation blending for this skeleton
  16610. * @param blendingSpeed defines the blending speed to apply
  16611. * @see https://doc.babylonjs.com/babylon101/animations#animation-blending
  16612. */
  16613. enableBlending(blendingSpeed?: number): void;
  16614. /**
  16615. * Releases all resources associated with the current skeleton
  16616. */
  16617. dispose(): void;
  16618. /**
  16619. * Serialize the skeleton in a JSON object
  16620. * @returns a JSON object
  16621. */
  16622. serialize(): any;
  16623. /**
  16624. * Creates a new skeleton from serialized data
  16625. * @param parsedSkeleton defines the serialized data
  16626. * @param scene defines the hosting scene
  16627. * @returns a new skeleton
  16628. */
  16629. static Parse(parsedSkeleton: any, scene: Scene): Skeleton;
  16630. /**
  16631. * Compute all node absolute transforms
  16632. * @param forceUpdate defines if computation must be done even if cache is up to date
  16633. */
  16634. computeAbsoluteTransforms(forceUpdate?: boolean): void;
  16635. /**
  16636. * Gets the root pose matrix
  16637. * @returns a matrix
  16638. */
  16639. getPoseMatrix(): Nullable<Matrix>;
  16640. /**
  16641. * Sorts bones per internal index
  16642. */
  16643. sortBones(): void;
  16644. private _sortBones;
  16645. }
  16646. }
  16647. declare module "babylonjs/Meshes/instancedMesh" {
  16648. import { Nullable, FloatArray, IndicesArray } from "babylonjs/types";
  16649. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  16650. import { Camera } from "babylonjs/Cameras/camera";
  16651. import { Node } from "babylonjs/node";
  16652. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  16653. import { Mesh } from "babylonjs/Meshes/mesh";
  16654. import { Material } from "babylonjs/Materials/material";
  16655. import { Skeleton } from "babylonjs/Bones/skeleton";
  16656. import { Light } from "babylonjs/Lights/light";
  16657. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  16658. /**
  16659. * Creates an instance based on a source mesh.
  16660. */
  16661. export class InstancedMesh extends AbstractMesh {
  16662. private _sourceMesh;
  16663. private _currentLOD;
  16664. /** @hidden */
  16665. _indexInSourceMeshInstanceArray: number;
  16666. constructor(name: string, source: Mesh);
  16667. /**
  16668. * Returns the string "InstancedMesh".
  16669. */
  16670. getClassName(): string;
  16671. /** Gets the list of lights affecting that mesh */
  16672. get lightSources(): Light[];
  16673. _resyncLightSources(): void;
  16674. _resyncLightSource(light: Light): void;
  16675. _removeLightSource(light: Light, dispose: boolean): void;
  16676. /**
  16677. * If the source mesh receives shadows
  16678. */
  16679. get receiveShadows(): boolean;
  16680. /**
  16681. * The material of the source mesh
  16682. */
  16683. get material(): Nullable<Material>;
  16684. /**
  16685. * Visibility of the source mesh
  16686. */
  16687. get visibility(): number;
  16688. /**
  16689. * Skeleton of the source mesh
  16690. */
  16691. get skeleton(): Nullable<Skeleton>;
  16692. /**
  16693. * Rendering ground id of the source mesh
  16694. */
  16695. get renderingGroupId(): number;
  16696. set renderingGroupId(value: number);
  16697. /**
  16698. * Returns the total number of vertices (integer).
  16699. */
  16700. getTotalVertices(): number;
  16701. /**
  16702. * Returns a positive integer : the total number of indices in this mesh geometry.
  16703. * @returns the numner of indices or zero if the mesh has no geometry.
  16704. */
  16705. getTotalIndices(): number;
  16706. /**
  16707. * The source mesh of the instance
  16708. */
  16709. get sourceMesh(): Mesh;
  16710. /**
  16711. * Creates a new InstancedMesh object from the mesh model.
  16712. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  16713. * @param name defines the name of the new instance
  16714. * @returns a new InstancedMesh
  16715. */
  16716. createInstance(name: string): InstancedMesh;
  16717. /**
  16718. * Is this node ready to be used/rendered
  16719. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  16720. * @return {boolean} is it ready
  16721. */
  16722. isReady(completeCheck?: boolean): boolean;
  16723. /**
  16724. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  16725. * @param kind kind of verticies to retreive (eg. positons, normals, uvs, etc.)
  16726. * @param copyWhenShared If true (default false) and and if the mesh geometry is shared among some other meshes, the returned array is a copy of the internal one.
  16727. * @returns a float array or a Float32Array of the requested kind of data : positons, normals, uvs, etc.
  16728. */
  16729. getVerticesData(kind: string, copyWhenShared?: boolean): Nullable<FloatArray>;
  16730. /**
  16731. * Sets the vertex data of the mesh geometry for the requested `kind`.
  16732. * If the mesh has no geometry, a new Geometry object is set to the mesh and then passed this vertex data.
  16733. * The `data` are either a numeric array either a Float32Array.
  16734. * The parameter `updatable` is passed as is to the underlying Geometry object constructor (if initianilly none) or updater.
  16735. * The parameter `stride` is an optional positive integer, it is usually automatically deducted from the `kind` (3 for positions or normals, 2 for UV, etc).
  16736. * Note that a new underlying VertexBuffer object is created each call.
  16737. * If the `kind` is the `PositionKind`, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  16738. *
  16739. * Possible `kind` values :
  16740. * - VertexBuffer.PositionKind
  16741. * - VertexBuffer.UVKind
  16742. * - VertexBuffer.UV2Kind
  16743. * - VertexBuffer.UV3Kind
  16744. * - VertexBuffer.UV4Kind
  16745. * - VertexBuffer.UV5Kind
  16746. * - VertexBuffer.UV6Kind
  16747. * - VertexBuffer.ColorKind
  16748. * - VertexBuffer.MatricesIndicesKind
  16749. * - VertexBuffer.MatricesIndicesExtraKind
  16750. * - VertexBuffer.MatricesWeightsKind
  16751. * - VertexBuffer.MatricesWeightsExtraKind
  16752. *
  16753. * Returns the Mesh.
  16754. */
  16755. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  16756. /**
  16757. * Updates the existing vertex data of the mesh geometry for the requested `kind`.
  16758. * If the mesh has no geometry, it is simply returned as it is.
  16759. * The `data` are either a numeric array either a Float32Array.
  16760. * No new underlying VertexBuffer object is created.
  16761. * If the `kind` is the `PositionKind` and if `updateExtends` is true, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  16762. * If the parameter `makeItUnique` is true, a new global geometry is created from this positions and is set to the mesh.
  16763. *
  16764. * Possible `kind` values :
  16765. * - VertexBuffer.PositionKind
  16766. * - VertexBuffer.UVKind
  16767. * - VertexBuffer.UV2Kind
  16768. * - VertexBuffer.UV3Kind
  16769. * - VertexBuffer.UV4Kind
  16770. * - VertexBuffer.UV5Kind
  16771. * - VertexBuffer.UV6Kind
  16772. * - VertexBuffer.ColorKind
  16773. * - VertexBuffer.MatricesIndicesKind
  16774. * - VertexBuffer.MatricesIndicesExtraKind
  16775. * - VertexBuffer.MatricesWeightsKind
  16776. * - VertexBuffer.MatricesWeightsExtraKind
  16777. *
  16778. * Returns the Mesh.
  16779. */
  16780. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): Mesh;
  16781. /**
  16782. * Sets the mesh indices.
  16783. * Expects an array populated with integers or a typed array (Int32Array, Uint32Array, Uint16Array).
  16784. * If the mesh has no geometry, a new Geometry object is created and set to the mesh.
  16785. * This method creates a new index buffer each call.
  16786. * Returns the Mesh.
  16787. */
  16788. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>): Mesh;
  16789. /**
  16790. * Boolean : True if the mesh owns the requested kind of data.
  16791. */
  16792. isVerticesDataPresent(kind: string): boolean;
  16793. /**
  16794. * Returns an array of indices (IndicesArray).
  16795. */
  16796. getIndices(): Nullable<IndicesArray>;
  16797. get _positions(): Nullable<Vector3[]>;
  16798. /**
  16799. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  16800. * This means the mesh underlying bounding box and sphere are recomputed.
  16801. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  16802. * @returns the current mesh
  16803. */
  16804. refreshBoundingInfo(applySkeleton?: boolean): InstancedMesh;
  16805. /** @hidden */
  16806. _preActivate(): InstancedMesh;
  16807. /** @hidden */
  16808. _activate(renderId: number, intermediateRendering: boolean): boolean;
  16809. /** @hidden */
  16810. _postActivate(): void;
  16811. getWorldMatrix(): Matrix;
  16812. get isAnInstance(): boolean;
  16813. /**
  16814. * Returns the current associated LOD AbstractMesh.
  16815. */
  16816. getLOD(camera: Camera): AbstractMesh;
  16817. /** @hidden */
  16818. _preActivateForIntermediateRendering(renderId: number): Mesh;
  16819. /** @hidden */
  16820. _syncSubMeshes(): InstancedMesh;
  16821. /** @hidden */
  16822. _generatePointsArray(): boolean;
  16823. /** @hidden */
  16824. _updateBoundingInfo(): AbstractMesh;
  16825. /**
  16826. * Creates a new InstancedMesh from the current mesh.
  16827. * - name (string) : the cloned mesh name
  16828. * - newParent (optional Node) : the optional Node to parent the clone to.
  16829. * - doNotCloneChildren (optional boolean, default `false`) : if `true` the model children aren't cloned.
  16830. *
  16831. * Returns the clone.
  16832. */
  16833. clone(name: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean): InstancedMesh;
  16834. /**
  16835. * Disposes the InstancedMesh.
  16836. * Returns nothing.
  16837. */
  16838. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  16839. }
  16840. module "babylonjs/Meshes/mesh" {
  16841. interface Mesh {
  16842. /**
  16843. * Register a custom buffer that will be instanced
  16844. * @see https://doc.babylonjs.com/how_to/how_to_use_instances#custom-buffers
  16845. * @param kind defines the buffer kind
  16846. * @param stride defines the stride in floats
  16847. */
  16848. registerInstancedBuffer(kind: string, stride: number): void;
  16849. /**
  16850. * true to use the edge renderer for all instances of this mesh
  16851. */
  16852. edgesShareWithInstances: boolean;
  16853. /** @hidden */
  16854. _userInstancedBuffersStorage: {
  16855. data: {
  16856. [key: string]: Float32Array;
  16857. };
  16858. sizes: {
  16859. [key: string]: number;
  16860. };
  16861. vertexBuffers: {
  16862. [key: string]: Nullable<VertexBuffer>;
  16863. };
  16864. strides: {
  16865. [key: string]: number;
  16866. };
  16867. };
  16868. }
  16869. }
  16870. module "babylonjs/Meshes/abstractMesh" {
  16871. interface AbstractMesh {
  16872. /**
  16873. * Object used to store instanced buffers defined by user
  16874. * @see https://doc.babylonjs.com/how_to/how_to_use_instances#custom-buffers
  16875. */
  16876. instancedBuffers: {
  16877. [key: string]: any;
  16878. };
  16879. }
  16880. }
  16881. }
  16882. declare module "babylonjs/Materials/shaderMaterial" {
  16883. import { Nullable } from "babylonjs/types";
  16884. import { Scene } from "babylonjs/scene";
  16885. import { Matrix, Vector3, Vector2, Vector4 } from "babylonjs/Maths/math.vector";
  16886. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  16887. import { Mesh } from "babylonjs/Meshes/mesh";
  16888. import { SubMesh } from "babylonjs/Meshes/subMesh";
  16889. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  16890. import { Effect } from "babylonjs/Materials/effect";
  16891. import { Material } from "babylonjs/Materials/material";
  16892. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  16893. /**
  16894. * Defines the options associated with the creation of a shader material.
  16895. */
  16896. export interface IShaderMaterialOptions {
  16897. /**
  16898. * Does the material work in alpha blend mode
  16899. */
  16900. needAlphaBlending: boolean;
  16901. /**
  16902. * Does the material work in alpha test mode
  16903. */
  16904. needAlphaTesting: boolean;
  16905. /**
  16906. * The list of attribute names used in the shader
  16907. */
  16908. attributes: string[];
  16909. /**
  16910. * The list of unifrom names used in the shader
  16911. */
  16912. uniforms: string[];
  16913. /**
  16914. * The list of UBO names used in the shader
  16915. */
  16916. uniformBuffers: string[];
  16917. /**
  16918. * The list of sampler names used in the shader
  16919. */
  16920. samplers: string[];
  16921. /**
  16922. * The list of defines used in the shader
  16923. */
  16924. defines: string[];
  16925. }
  16926. /**
  16927. * The ShaderMaterial object has the necessary methods to pass data from your scene to the Vertex and Fragment Shaders and returns a material that can be applied to any mesh.
  16928. *
  16929. * This returned material effects how the mesh will look based on the code in the shaders.
  16930. *
  16931. * @see https://doc.babylonjs.com/how_to/shader_material
  16932. */
  16933. export class ShaderMaterial extends Material {
  16934. private _shaderPath;
  16935. private _options;
  16936. private _textures;
  16937. private _textureArrays;
  16938. private _floats;
  16939. private _ints;
  16940. private _floatsArrays;
  16941. private _colors3;
  16942. private _colors3Arrays;
  16943. private _colors4;
  16944. private _colors4Arrays;
  16945. private _vectors2;
  16946. private _vectors3;
  16947. private _vectors4;
  16948. private _matrices;
  16949. private _matrixArrays;
  16950. private _matrices3x3;
  16951. private _matrices2x2;
  16952. private _vectors2Arrays;
  16953. private _vectors3Arrays;
  16954. private _vectors4Arrays;
  16955. private _cachedWorldViewMatrix;
  16956. private _cachedWorldViewProjectionMatrix;
  16957. private _renderId;
  16958. private _multiview;
  16959. private _cachedDefines;
  16960. /** Define the Url to load snippets */
  16961. static SnippetUrl: string;
  16962. /** Snippet ID if the material was created from the snippet server */
  16963. snippetId: string;
  16964. /**
  16965. * Instantiate a new shader material.
  16966. * The ShaderMaterial object has the necessary methods to pass data from your scene to the Vertex and Fragment Shaders and returns a material that can be applied to any mesh.
  16967. * This returned material effects how the mesh will look based on the code in the shaders.
  16968. * @see https://doc.babylonjs.com/how_to/shader_material
  16969. * @param name Define the name of the material in the scene
  16970. * @param scene Define the scene the material belongs to
  16971. * @param shaderPath Defines the route to the shader code in one of three ways:
  16972. * * object: { vertex: "custom", fragment: "custom" }, used with Effect.ShadersStore["customVertexShader"] and Effect.ShadersStore["customFragmentShader"]
  16973. * * object: { vertexElement: "vertexShaderCode", fragmentElement: "fragmentShaderCode" }, used with shader code in script tags
  16974. * * object: { vertexSource: "vertex shader code string", fragmentSource: "fragment shader code string" } using with strings containing the shaders code
  16975. * * string: "./COMMON_NAME", used with external files COMMON_NAME.vertex.fx and COMMON_NAME.fragment.fx in index.html folder.
  16976. * @param options Define the options used to create the shader
  16977. */
  16978. constructor(name: string, scene: Scene, shaderPath: any, options?: Partial<IShaderMaterialOptions>);
  16979. /**
  16980. * Gets the shader path used to define the shader code
  16981. * It can be modified to trigger a new compilation
  16982. */
  16983. get shaderPath(): any;
  16984. /**
  16985. * Sets the shader path used to define the shader code
  16986. * It can be modified to trigger a new compilation
  16987. */
  16988. set shaderPath(shaderPath: any);
  16989. /**
  16990. * Gets the options used to compile the shader.
  16991. * They can be modified to trigger a new compilation
  16992. */
  16993. get options(): IShaderMaterialOptions;
  16994. /**
  16995. * Gets the current class name of the material e.g. "ShaderMaterial"
  16996. * Mainly use in serialization.
  16997. * @returns the class name
  16998. */
  16999. getClassName(): string;
  17000. /**
  17001. * Specifies if the material will require alpha blending
  17002. * @returns a boolean specifying if alpha blending is needed
  17003. */
  17004. needAlphaBlending(): boolean;
  17005. /**
  17006. * Specifies if this material should be rendered in alpha test mode
  17007. * @returns a boolean specifying if an alpha test is needed.
  17008. */
  17009. needAlphaTesting(): boolean;
  17010. private _checkUniform;
  17011. /**
  17012. * Set a texture in the shader.
  17013. * @param name Define the name of the uniform samplers as defined in the shader
  17014. * @param texture Define the texture to bind to this sampler
  17015. * @return the material itself allowing "fluent" like uniform updates
  17016. */
  17017. setTexture(name: string, texture: BaseTexture): ShaderMaterial;
  17018. /**
  17019. * Set a texture array in the shader.
  17020. * @param name Define the name of the uniform sampler array as defined in the shader
  17021. * @param textures Define the list of textures to bind to this sampler
  17022. * @return the material itself allowing "fluent" like uniform updates
  17023. */
  17024. setTextureArray(name: string, textures: BaseTexture[]): ShaderMaterial;
  17025. /**
  17026. * Set a float in the shader.
  17027. * @param name Define the name of the uniform as defined in the shader
  17028. * @param value Define the value to give to the uniform
  17029. * @return the material itself allowing "fluent" like uniform updates
  17030. */
  17031. setFloat(name: string, value: number): ShaderMaterial;
  17032. /**
  17033. * Set a int in the shader.
  17034. * @param name Define the name of the uniform as defined in the shader
  17035. * @param value Define the value to give to the uniform
  17036. * @return the material itself allowing "fluent" like uniform updates
  17037. */
  17038. setInt(name: string, value: number): ShaderMaterial;
  17039. /**
  17040. * Set an array of floats in the shader.
  17041. * @param name Define the name of the uniform as defined in the shader
  17042. * @param value Define the value to give to the uniform
  17043. * @return the material itself allowing "fluent" like uniform updates
  17044. */
  17045. setFloats(name: string, value: number[]): ShaderMaterial;
  17046. /**
  17047. * Set a vec3 in the shader from a Color3.
  17048. * @param name Define the name of the uniform as defined in the shader
  17049. * @param value Define the value to give to the uniform
  17050. * @return the material itself allowing "fluent" like uniform updates
  17051. */
  17052. setColor3(name: string, value: Color3): ShaderMaterial;
  17053. /**
  17054. * Set a vec3 array in the shader from a Color3 array.
  17055. * @param name Define the name of the uniform as defined in the shader
  17056. * @param value Define the value to give to the uniform
  17057. * @return the material itself allowing "fluent" like uniform updates
  17058. */
  17059. setColor3Array(name: string, value: Color3[]): ShaderMaterial;
  17060. /**
  17061. * Set a vec4 in the shader from a Color4.
  17062. * @param name Define the name of the uniform as defined in the shader
  17063. * @param value Define the value to give to the uniform
  17064. * @return the material itself allowing "fluent" like uniform updates
  17065. */
  17066. setColor4(name: string, value: Color4): ShaderMaterial;
  17067. /**
  17068. * Set a vec4 array in the shader from a Color4 array.
  17069. * @param name Define the name of the uniform as defined in the shader
  17070. * @param value Define the value to give to the uniform
  17071. * @return the material itself allowing "fluent" like uniform updates
  17072. */
  17073. setColor4Array(name: string, value: Color4[]): ShaderMaterial;
  17074. /**
  17075. * Set a vec2 in the shader from a Vector2.
  17076. * @param name Define the name of the uniform as defined in the shader
  17077. * @param value Define the value to give to the uniform
  17078. * @return the material itself allowing "fluent" like uniform updates
  17079. */
  17080. setVector2(name: string, value: Vector2): ShaderMaterial;
  17081. /**
  17082. * Set a vec3 in the shader from a Vector3.
  17083. * @param name Define the name of the uniform as defined in the shader
  17084. * @param value Define the value to give to the uniform
  17085. * @return the material itself allowing "fluent" like uniform updates
  17086. */
  17087. setVector3(name: string, value: Vector3): ShaderMaterial;
  17088. /**
  17089. * Set a vec4 in the shader from a Vector4.
  17090. * @param name Define the name of the uniform as defined in the shader
  17091. * @param value Define the value to give to the uniform
  17092. * @return the material itself allowing "fluent" like uniform updates
  17093. */
  17094. setVector4(name: string, value: Vector4): ShaderMaterial;
  17095. /**
  17096. * Set a mat4 in the shader from a Matrix.
  17097. * @param name Define the name of the uniform as defined in the shader
  17098. * @param value Define the value to give to the uniform
  17099. * @return the material itself allowing "fluent" like uniform updates
  17100. */
  17101. setMatrix(name: string, value: Matrix): ShaderMaterial;
  17102. /**
  17103. * Set a float32Array in the shader from a matrix array.
  17104. * @param name Define the name of the uniform as defined in the shader
  17105. * @param value Define the value to give to the uniform
  17106. * @return the material itself allowing "fluent" like uniform updates
  17107. */
  17108. setMatrices(name: string, value: Matrix[]): ShaderMaterial;
  17109. /**
  17110. * Set a mat3 in the shader from a Float32Array.
  17111. * @param name Define the name of the uniform as defined in the shader
  17112. * @param value Define the value to give to the uniform
  17113. * @return the material itself allowing "fluent" like uniform updates
  17114. */
  17115. setMatrix3x3(name: string, value: Float32Array | Array<number>): ShaderMaterial;
  17116. /**
  17117. * Set a mat2 in the shader from a Float32Array.
  17118. * @param name Define the name of the uniform as defined in the shader
  17119. * @param value Define the value to give to the uniform
  17120. * @return the material itself allowing "fluent" like uniform updates
  17121. */
  17122. setMatrix2x2(name: string, value: Float32Array | Array<number>): ShaderMaterial;
  17123. /**
  17124. * Set a vec2 array in the shader from a number array.
  17125. * @param name Define the name of the uniform as defined in the shader
  17126. * @param value Define the value to give to the uniform
  17127. * @return the material itself allowing "fluent" like uniform updates
  17128. */
  17129. setArray2(name: string, value: number[]): ShaderMaterial;
  17130. /**
  17131. * Set a vec3 array in the shader from a number array.
  17132. * @param name Define the name of the uniform as defined in the shader
  17133. * @param value Define the value to give to the uniform
  17134. * @return the material itself allowing "fluent" like uniform updates
  17135. */
  17136. setArray3(name: string, value: number[]): ShaderMaterial;
  17137. /**
  17138. * Set a vec4 array in the shader from a number array.
  17139. * @param name Define the name of the uniform as defined in the shader
  17140. * @param value Define the value to give to the uniform
  17141. * @return the material itself allowing "fluent" like uniform updates
  17142. */
  17143. setArray4(name: string, value: number[]): ShaderMaterial;
  17144. private _checkCache;
  17145. /**
  17146. * Specifies that the submesh is ready to be used
  17147. * @param mesh defines the mesh to check
  17148. * @param subMesh defines which submesh to check
  17149. * @param useInstances specifies that instances should be used
  17150. * @returns a boolean indicating that the submesh is ready or not
  17151. */
  17152. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  17153. /**
  17154. * Checks if the material is ready to render the requested mesh
  17155. * @param mesh Define the mesh to render
  17156. * @param useInstances Define whether or not the material is used with instances
  17157. * @returns true if ready, otherwise false
  17158. */
  17159. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  17160. /**
  17161. * Binds the world matrix to the material
  17162. * @param world defines the world transformation matrix
  17163. * @param effectOverride - If provided, use this effect instead of internal effect
  17164. */
  17165. bindOnlyWorldMatrix(world: Matrix, effectOverride?: Nullable<Effect>): void;
  17166. /**
  17167. * Binds the submesh to this material by preparing the effect and shader to draw
  17168. * @param world defines the world transformation matrix
  17169. * @param mesh defines the mesh containing the submesh
  17170. * @param subMesh defines the submesh to bind the material to
  17171. */
  17172. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  17173. /**
  17174. * Binds the material to the mesh
  17175. * @param world defines the world transformation matrix
  17176. * @param mesh defines the mesh to bind the material to
  17177. * @param effectOverride - If provided, use this effect instead of internal effect
  17178. */
  17179. bind(world: Matrix, mesh?: Mesh, effectOverride?: Nullable<Effect>): void;
  17180. protected _afterBind(mesh?: Mesh): void;
  17181. /**
  17182. * Gets the active textures from the material
  17183. * @returns an array of textures
  17184. */
  17185. getActiveTextures(): BaseTexture[];
  17186. /**
  17187. * Specifies if the material uses a texture
  17188. * @param texture defines the texture to check against the material
  17189. * @returns a boolean specifying if the material uses the texture
  17190. */
  17191. hasTexture(texture: BaseTexture): boolean;
  17192. /**
  17193. * Makes a duplicate of the material, and gives it a new name
  17194. * @param name defines the new name for the duplicated material
  17195. * @returns the cloned material
  17196. */
  17197. clone(name: string): ShaderMaterial;
  17198. /**
  17199. * Disposes the material
  17200. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  17201. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  17202. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  17203. */
  17204. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  17205. /**
  17206. * Serializes this material in a JSON representation
  17207. * @returns the serialized material object
  17208. */
  17209. serialize(): any;
  17210. /**
  17211. * Creates a shader material from parsed shader material data
  17212. * @param source defines the JSON represnetation of the material
  17213. * @param scene defines the hosting scene
  17214. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  17215. * @returns a new material
  17216. */
  17217. static Parse(source: any, scene: Scene, rootUrl: string): ShaderMaterial;
  17218. /**
  17219. * Creates a new ShaderMaterial from a snippet saved in a remote file
  17220. * @param name defines the name of the ShaderMaterial to create (can be null or empty to use the one from the json data)
  17221. * @param url defines the url to load from
  17222. * @param scene defines the hosting scene
  17223. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  17224. * @returns a promise that will resolve to the new ShaderMaterial
  17225. */
  17226. static ParseFromFileAsync(name: Nullable<string>, url: string, scene: Scene, rootUrl?: string): Promise<ShaderMaterial>;
  17227. /**
  17228. * Creates a ShaderMaterial from a snippet saved by the Inspector
  17229. * @param snippetId defines the snippet to load
  17230. * @param scene defines the hosting scene
  17231. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  17232. * @returns a promise that will resolve to the new ShaderMaterial
  17233. */
  17234. static CreateFromSnippetAsync(snippetId: string, scene: Scene, rootUrl?: string): Promise<ShaderMaterial>;
  17235. }
  17236. }
  17237. declare module "babylonjs/Shaders/color.fragment" {
  17238. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  17239. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  17240. /** @hidden */
  17241. export var colorPixelShader: {
  17242. name: string;
  17243. shader: string;
  17244. };
  17245. }
  17246. declare module "babylonjs/Shaders/color.vertex" {
  17247. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  17248. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  17249. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  17250. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  17251. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  17252. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  17253. /** @hidden */
  17254. export var colorVertexShader: {
  17255. name: string;
  17256. shader: string;
  17257. };
  17258. }
  17259. declare module "babylonjs/Meshes/linesMesh" {
  17260. import { Nullable } from "babylonjs/types";
  17261. import { Scene } from "babylonjs/scene";
  17262. import { Color3 } from "babylonjs/Maths/math.color";
  17263. import { Node } from "babylonjs/node";
  17264. import { SubMesh } from "babylonjs/Meshes/subMesh";
  17265. import { Mesh } from "babylonjs/Meshes/mesh";
  17266. import { InstancedMesh } from "babylonjs/Meshes/instancedMesh";
  17267. import { Effect } from "babylonjs/Materials/effect";
  17268. import { Material } from "babylonjs/Materials/material";
  17269. import "babylonjs/Shaders/color.fragment";
  17270. import "babylonjs/Shaders/color.vertex";
  17271. /**
  17272. * Line mesh
  17273. * @see https://doc.babylonjs.com/babylon101/parametric_shapes
  17274. */
  17275. export class LinesMesh extends Mesh {
  17276. /**
  17277. * If vertex color should be applied to the mesh
  17278. */
  17279. readonly useVertexColor?: boolean | undefined;
  17280. /**
  17281. * If vertex alpha should be applied to the mesh
  17282. */
  17283. readonly useVertexAlpha?: boolean | undefined;
  17284. /**
  17285. * Color of the line (Default: White)
  17286. */
  17287. color: Color3;
  17288. /**
  17289. * Alpha of the line (Default: 1)
  17290. */
  17291. alpha: number;
  17292. /**
  17293. * The intersection Threshold is the margin applied when intersection a segment of the LinesMesh with a Ray.
  17294. * This margin is expressed in world space coordinates, so its value may vary.
  17295. * Default value is 0.1
  17296. */
  17297. intersectionThreshold: number;
  17298. private _colorShader;
  17299. private color4;
  17300. /**
  17301. * Creates a new LinesMesh
  17302. * @param name defines the name
  17303. * @param scene defines the hosting scene
  17304. * @param parent defines the parent mesh if any
  17305. * @param source defines the optional source LinesMesh used to clone data from
  17306. * @param doNotCloneChildren When cloning, skip cloning child meshes of source, default False.
  17307. * When false, achieved by calling a clone(), also passing False.
  17308. * This will make creation of children, recursive.
  17309. * @param useVertexColor defines if this LinesMesh supports vertex color
  17310. * @param useVertexAlpha defines if this LinesMesh supports vertex alpha
  17311. */
  17312. constructor(name: string, scene?: Nullable<Scene>, parent?: Nullable<Node>, source?: Nullable<LinesMesh>, doNotCloneChildren?: boolean,
  17313. /**
  17314. * If vertex color should be applied to the mesh
  17315. */
  17316. useVertexColor?: boolean | undefined,
  17317. /**
  17318. * If vertex alpha should be applied to the mesh
  17319. */
  17320. useVertexAlpha?: boolean | undefined);
  17321. private _addClipPlaneDefine;
  17322. private _removeClipPlaneDefine;
  17323. isReady(): boolean;
  17324. /**
  17325. * Returns the string "LineMesh"
  17326. */
  17327. getClassName(): string;
  17328. /**
  17329. * @hidden
  17330. */
  17331. get material(): Material;
  17332. /**
  17333. * @hidden
  17334. */
  17335. set material(value: Material);
  17336. /**
  17337. * @hidden
  17338. */
  17339. get checkCollisions(): boolean;
  17340. /** @hidden */
  17341. _bind(subMesh: SubMesh, effect: Effect, fillMode: number): Mesh;
  17342. /** @hidden */
  17343. _draw(subMesh: SubMesh, fillMode: number, instancesCount?: number): Mesh;
  17344. /**
  17345. * Disposes of the line mesh
  17346. * @param doNotRecurse If children should be disposed
  17347. */
  17348. dispose(doNotRecurse?: boolean): void;
  17349. /**
  17350. * Returns a new LineMesh object cloned from the current one.
  17351. */
  17352. clone(name: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean): LinesMesh;
  17353. /**
  17354. * Creates a new InstancedLinesMesh object from the mesh model.
  17355. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  17356. * @param name defines the name of the new instance
  17357. * @returns a new InstancedLinesMesh
  17358. */
  17359. createInstance(name: string): InstancedLinesMesh;
  17360. }
  17361. /**
  17362. * Creates an instance based on a source LinesMesh
  17363. */
  17364. export class InstancedLinesMesh extends InstancedMesh {
  17365. /**
  17366. * The intersection Threshold is the margin applied when intersection a segment of the LinesMesh with a Ray.
  17367. * This margin is expressed in world space coordinates, so its value may vary.
  17368. * Initilized with the intersectionThreshold value of the source LinesMesh
  17369. */
  17370. intersectionThreshold: number;
  17371. constructor(name: string, source: LinesMesh);
  17372. /**
  17373. * Returns the string "InstancedLinesMesh".
  17374. */
  17375. getClassName(): string;
  17376. }
  17377. }
  17378. declare module "babylonjs/Shaders/line.fragment" {
  17379. /** @hidden */
  17380. export var linePixelShader: {
  17381. name: string;
  17382. shader: string;
  17383. };
  17384. }
  17385. declare module "babylonjs/Shaders/line.vertex" {
  17386. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  17387. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  17388. /** @hidden */
  17389. export var lineVertexShader: {
  17390. name: string;
  17391. shader: string;
  17392. };
  17393. }
  17394. declare module "babylonjs/Rendering/edgesRenderer" {
  17395. import { Nullable } from "babylonjs/types";
  17396. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  17397. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  17398. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  17399. import { IDisposable } from "babylonjs/scene";
  17400. import { ShaderMaterial } from "babylonjs/Materials/shaderMaterial";
  17401. import "babylonjs/Shaders/line.fragment";
  17402. import "babylonjs/Shaders/line.vertex";
  17403. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  17404. import { SmartArray } from "babylonjs/Misc/smartArray";
  17405. module "babylonjs/scene" {
  17406. interface Scene {
  17407. /** @hidden */
  17408. _edgeRenderLineShader: Nullable<ShaderMaterial>;
  17409. }
  17410. }
  17411. module "babylonjs/Meshes/abstractMesh" {
  17412. interface AbstractMesh {
  17413. /**
  17414. * Gets the edgesRenderer associated with the mesh
  17415. */
  17416. edgesRenderer: Nullable<EdgesRenderer>;
  17417. }
  17418. }
  17419. module "babylonjs/Meshes/linesMesh" {
  17420. interface LinesMesh {
  17421. /**
  17422. * Enables the edge rendering mode on the mesh.
  17423. * This mode makes the mesh edges visible
  17424. * @param epsilon defines the maximal distance between two angles to detect a face
  17425. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  17426. * @returns the currentAbstractMesh
  17427. * @see https://www.babylonjs-playground.com/#19O9TU#0
  17428. */
  17429. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): AbstractMesh;
  17430. }
  17431. }
  17432. module "babylonjs/Meshes/linesMesh" {
  17433. interface InstancedLinesMesh {
  17434. /**
  17435. * Enables the edge rendering mode on the mesh.
  17436. * This mode makes the mesh edges visible
  17437. * @param epsilon defines the maximal distance between two angles to detect a face
  17438. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  17439. * @returns the current InstancedLinesMesh
  17440. * @see https://www.babylonjs-playground.com/#19O9TU#0
  17441. */
  17442. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): InstancedLinesMesh;
  17443. }
  17444. }
  17445. /**
  17446. * Defines the minimum contract an Edges renderer should follow.
  17447. */
  17448. export interface IEdgesRenderer extends IDisposable {
  17449. /**
  17450. * Gets or sets a boolean indicating if the edgesRenderer is active
  17451. */
  17452. isEnabled: boolean;
  17453. /**
  17454. * Renders the edges of the attached mesh,
  17455. */
  17456. render(): void;
  17457. /**
  17458. * Checks wether or not the edges renderer is ready to render.
  17459. * @return true if ready, otherwise false.
  17460. */
  17461. isReady(): boolean;
  17462. /**
  17463. * List of instances to render in case the source mesh has instances
  17464. */
  17465. customInstances: SmartArray<Matrix>;
  17466. }
  17467. /**
  17468. * Defines the additional options of the edges renderer
  17469. */
  17470. export interface IEdgesRendererOptions {
  17471. /**
  17472. * Gets or sets a boolean indicating that the alternate edge finder algorithm must be used
  17473. * If not defined, the default value is true
  17474. */
  17475. useAlternateEdgeFinder?: boolean;
  17476. /**
  17477. * Gets or sets a boolean indicating that the vertex merger fast processing must be used.
  17478. * If not defined, the default value is true.
  17479. * You should normally leave it undefined (or set it to true), except if you see some artifacts in the edges rendering (can happen with complex geometries)
  17480. * This option is used only if useAlternateEdgeFinder = true
  17481. */
  17482. useFastVertexMerger?: boolean;
  17483. /**
  17484. * During edges processing, the vertices are merged if they are close enough: epsilonVertexMerge is the limit whithin which vertices are considered to be equal.
  17485. * The default value is 1e-6
  17486. * This option is used only if useAlternateEdgeFinder = true
  17487. */
  17488. epsilonVertexMerge?: number;
  17489. /**
  17490. * Gets or sets a boolean indicating that tessellation should be applied before finding the edges. You may need to activate this option if your geometry is a bit
  17491. * unusual, like having a vertex of a triangle in-between two vertices of an edge of another triangle. It happens often when using CSG to construct meshes.
  17492. * This option is used only if useAlternateEdgeFinder = true
  17493. */
  17494. applyTessellation?: boolean;
  17495. /**
  17496. * The limit under which 3 vertices are considered to be aligned. 3 vertices PQR are considered aligned if distance(PQ) + distance(QR) - distance(PR) < epsilonVertexAligned
  17497. * The default value is 1e-6
  17498. * This option is used only if useAlternateEdgeFinder = true
  17499. */
  17500. epsilonVertexAligned?: number;
  17501. }
  17502. /**
  17503. * This class is used to generate edges of the mesh that could then easily be rendered in a scene.
  17504. */
  17505. export class EdgesRenderer implements IEdgesRenderer {
  17506. /**
  17507. * Define the size of the edges with an orthographic camera
  17508. */
  17509. edgesWidthScalerForOrthographic: number;
  17510. /**
  17511. * Define the size of the edges with a perspective camera
  17512. */
  17513. edgesWidthScalerForPerspective: number;
  17514. protected _source: AbstractMesh;
  17515. protected _linesPositions: number[];
  17516. protected _linesNormals: number[];
  17517. protected _linesIndices: number[];
  17518. protected _epsilon: number;
  17519. protected _indicesCount: number;
  17520. protected _lineShader: ShaderMaterial;
  17521. protected _ib: DataBuffer;
  17522. protected _buffers: {
  17523. [key: string]: Nullable<VertexBuffer>;
  17524. };
  17525. protected _buffersForInstances: {
  17526. [key: string]: Nullable<VertexBuffer>;
  17527. };
  17528. protected _checkVerticesInsteadOfIndices: boolean;
  17529. protected _options: Nullable<IEdgesRendererOptions>;
  17530. private _meshRebuildObserver;
  17531. private _meshDisposeObserver;
  17532. /** Gets or sets a boolean indicating if the edgesRenderer is active */
  17533. isEnabled: boolean;
  17534. /**
  17535. * List of instances to render in case the source mesh has instances
  17536. */
  17537. customInstances: SmartArray<Matrix>;
  17538. private static GetShader;
  17539. /**
  17540. * Creates an instance of the EdgesRenderer. It is primarily use to display edges of a mesh.
  17541. * Beware when you use this class with complex objects as the adjacencies computation can be really long
  17542. * @param source Mesh used to create edges
  17543. * @param epsilon sum of angles in adjacency to check for edge
  17544. * @param checkVerticesInsteadOfIndices bases the edges detection on vertices vs indices. Note that this parameter is not used if options.useAlternateEdgeFinder = true
  17545. * @param generateEdgesLines - should generate Lines or only prepare resources.
  17546. * @param options The options to apply when generating the edges
  17547. */
  17548. constructor(source: AbstractMesh, epsilon?: number, checkVerticesInsteadOfIndices?: boolean, generateEdgesLines?: boolean, options?: IEdgesRendererOptions);
  17549. protected _prepareRessources(): void;
  17550. /** @hidden */
  17551. _rebuild(): void;
  17552. /**
  17553. * Releases the required resources for the edges renderer
  17554. */
  17555. dispose(): void;
  17556. protected _processEdgeForAdjacencies(pa: number, pb: number, p0: number, p1: number, p2: number): number;
  17557. protected _processEdgeForAdjacenciesWithVertices(pa: Vector3, pb: Vector3, p0: Vector3, p1: Vector3, p2: Vector3): number;
  17558. /**
  17559. * Checks if the pair of p0 and p1 is en edge
  17560. * @param faceIndex
  17561. * @param edge
  17562. * @param faceNormals
  17563. * @param p0
  17564. * @param p1
  17565. * @private
  17566. */
  17567. protected _checkEdge(faceIndex: number, edge: number, faceNormals: Array<Vector3>, p0: Vector3, p1: Vector3): void;
  17568. /**
  17569. * push line into the position, normal and index buffer
  17570. * @protected
  17571. */
  17572. protected createLine(p0: Vector3, p1: Vector3, offset: number): void;
  17573. /**
  17574. * See https://playground.babylonjs.com/#R3JR6V#1 for a visual display of the algorithm
  17575. */
  17576. private _tessellateTriangle;
  17577. private _generateEdgesLinesAlternate;
  17578. /**
  17579. * Generates lines edges from adjacencjes
  17580. * @private
  17581. */
  17582. _generateEdgesLines(): void;
  17583. /**
  17584. * Checks wether or not the edges renderer is ready to render.
  17585. * @return true if ready, otherwise false.
  17586. */
  17587. isReady(): boolean;
  17588. /**
  17589. * Renders the edges of the attached mesh,
  17590. */
  17591. render(): void;
  17592. }
  17593. /**
  17594. * LineEdgesRenderer for LineMeshes to remove unnecessary triangulation
  17595. */
  17596. export class LineEdgesRenderer extends EdgesRenderer {
  17597. /**
  17598. * This constructor turns off auto generating edges line in Edges Renderer to make it here.
  17599. * @param source LineMesh used to generate edges
  17600. * @param epsilon not important (specified angle for edge detection)
  17601. * @param checkVerticesInsteadOfIndices not important for LineMesh
  17602. */
  17603. constructor(source: AbstractMesh, epsilon?: number, checkVerticesInsteadOfIndices?: boolean);
  17604. /**
  17605. * Generate edges for each line in LinesMesh. Every Line should be rendered as edge.
  17606. */
  17607. _generateEdgesLines(): void;
  17608. }
  17609. }
  17610. declare module "babylonjs/Rendering/renderingGroup" {
  17611. import { SmartArray, SmartArrayNoDuplicate } from "babylonjs/Misc/smartArray";
  17612. import { SubMesh } from "babylonjs/Meshes/subMesh";
  17613. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  17614. import { Nullable } from "babylonjs/types";
  17615. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  17616. import { IEdgesRenderer } from "babylonjs/Rendering/edgesRenderer";
  17617. import { ISpriteManager } from "babylonjs/Sprites/spriteManager";
  17618. import { Material } from "babylonjs/Materials/material";
  17619. import { Scene } from "babylonjs/scene";
  17620. /**
  17621. * This represents the object necessary to create a rendering group.
  17622. * This is exclusively used and created by the rendering manager.
  17623. * To modify the behavior, you use the available helpers in your scene or meshes.
  17624. * @hidden
  17625. */
  17626. export class RenderingGroup {
  17627. index: number;
  17628. private static _zeroVector;
  17629. private _scene;
  17630. private _opaqueSubMeshes;
  17631. private _transparentSubMeshes;
  17632. private _alphaTestSubMeshes;
  17633. private _depthOnlySubMeshes;
  17634. private _particleSystems;
  17635. private _spriteManagers;
  17636. private _opaqueSortCompareFn;
  17637. private _alphaTestSortCompareFn;
  17638. private _transparentSortCompareFn;
  17639. private _renderOpaque;
  17640. private _renderAlphaTest;
  17641. private _renderTransparent;
  17642. /** @hidden */
  17643. _edgesRenderers: SmartArrayNoDuplicate<IEdgesRenderer>;
  17644. onBeforeTransparentRendering: () => void;
  17645. /**
  17646. * Set the opaque sort comparison function.
  17647. * If null the sub meshes will be render in the order they were created
  17648. */
  17649. set opaqueSortCompareFn(value: Nullable<(a: SubMesh, b: SubMesh) => number>);
  17650. /**
  17651. * Set the alpha test sort comparison function.
  17652. * If null the sub meshes will be render in the order they were created
  17653. */
  17654. set alphaTestSortCompareFn(value: Nullable<(a: SubMesh, b: SubMesh) => number>);
  17655. /**
  17656. * Set the transparent sort comparison function.
  17657. * If null the sub meshes will be render in the order they were created
  17658. */
  17659. set transparentSortCompareFn(value: Nullable<(a: SubMesh, b: SubMesh) => number>);
  17660. /**
  17661. * Creates a new rendering group.
  17662. * @param index The rendering group index
  17663. * @param opaqueSortCompareFn The opaque sort comparison function. If null no order is applied
  17664. * @param alphaTestSortCompareFn The alpha test sort comparison function. If null no order is applied
  17665. * @param transparentSortCompareFn The transparent sort comparison function. If null back to front + alpha index sort is applied
  17666. */
  17667. constructor(index: number, scene: Scene, opaqueSortCompareFn?: Nullable<(a: SubMesh, b: SubMesh) => number>, alphaTestSortCompareFn?: Nullable<(a: SubMesh, b: SubMesh) => number>, transparentSortCompareFn?: Nullable<(a: SubMesh, b: SubMesh) => number>);
  17668. /**
  17669. * Render all the sub meshes contained in the group.
  17670. * @param customRenderFunction Used to override the default render behaviour of the group.
  17671. * @returns true if rendered some submeshes.
  17672. */
  17673. render(customRenderFunction: Nullable<(opaqueSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>) => void>, renderSprites: boolean, renderParticles: boolean, activeMeshes: Nullable<AbstractMesh[]>): void;
  17674. /**
  17675. * Renders the opaque submeshes in the order from the opaqueSortCompareFn.
  17676. * @param subMeshes The submeshes to render
  17677. */
  17678. private renderOpaqueSorted;
  17679. /**
  17680. * Renders the opaque submeshes in the order from the alphatestSortCompareFn.
  17681. * @param subMeshes The submeshes to render
  17682. */
  17683. private renderAlphaTestSorted;
  17684. /**
  17685. * Renders the opaque submeshes in the order from the transparentSortCompareFn.
  17686. * @param subMeshes The submeshes to render
  17687. */
  17688. private renderTransparentSorted;
  17689. /**
  17690. * Renders the submeshes in a specified order.
  17691. * @param subMeshes The submeshes to sort before render
  17692. * @param sortCompareFn The comparison function use to sort
  17693. * @param cameraPosition The camera position use to preprocess the submeshes to help sorting
  17694. * @param transparent Specifies to activate blending if true
  17695. */
  17696. private static renderSorted;
  17697. /**
  17698. * Renders the submeshes in the order they were dispatched (no sort applied).
  17699. * @param subMeshes The submeshes to render
  17700. */
  17701. private static renderUnsorted;
  17702. /**
  17703. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  17704. * are rendered back to front if in the same alpha index.
  17705. *
  17706. * @param a The first submesh
  17707. * @param b The second submesh
  17708. * @returns The result of the comparison
  17709. */
  17710. static defaultTransparentSortCompare(a: SubMesh, b: SubMesh): number;
  17711. /**
  17712. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  17713. * are rendered back to front.
  17714. *
  17715. * @param a The first submesh
  17716. * @param b The second submesh
  17717. * @returns The result of the comparison
  17718. */
  17719. static backToFrontSortCompare(a: SubMesh, b: SubMesh): number;
  17720. /**
  17721. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  17722. * are rendered front to back (prevent overdraw).
  17723. *
  17724. * @param a The first submesh
  17725. * @param b The second submesh
  17726. * @returns The result of the comparison
  17727. */
  17728. static frontToBackSortCompare(a: SubMesh, b: SubMesh): number;
  17729. /**
  17730. * Resets the different lists of submeshes to prepare a new frame.
  17731. */
  17732. prepare(): void;
  17733. dispose(): void;
  17734. /**
  17735. * Inserts the submesh in its correct queue depending on its material.
  17736. * @param subMesh The submesh to dispatch
  17737. * @param [mesh] Optional reference to the submeshes's mesh. Provide if you have an exiting reference to improve performance.
  17738. * @param [material] Optional reference to the submeshes's material. Provide if you have an exiting reference to improve performance.
  17739. */
  17740. dispatch(subMesh: SubMesh, mesh?: AbstractMesh, material?: Nullable<Material>): void;
  17741. dispatchSprites(spriteManager: ISpriteManager): void;
  17742. dispatchParticles(particleSystem: IParticleSystem): void;
  17743. private _renderParticles;
  17744. private _renderSprites;
  17745. }
  17746. }
  17747. declare module "babylonjs/Rendering/renderingManager" {
  17748. import { Nullable } from "babylonjs/types";
  17749. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  17750. import { SubMesh } from "babylonjs/Meshes/subMesh";
  17751. import { SmartArray } from "babylonjs/Misc/smartArray";
  17752. import { ISpriteManager } from "babylonjs/Sprites/spriteManager";
  17753. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  17754. import { Material } from "babylonjs/Materials/material";
  17755. import { Scene } from "babylonjs/scene";
  17756. import { Camera } from "babylonjs/Cameras/camera";
  17757. /**
  17758. * Interface describing the different options available in the rendering manager
  17759. * regarding Auto Clear between groups.
  17760. */
  17761. export interface IRenderingManagerAutoClearSetup {
  17762. /**
  17763. * Defines whether or not autoclear is enable.
  17764. */
  17765. autoClear: boolean;
  17766. /**
  17767. * Defines whether or not to autoclear the depth buffer.
  17768. */
  17769. depth: boolean;
  17770. /**
  17771. * Defines whether or not to autoclear the stencil buffer.
  17772. */
  17773. stencil: boolean;
  17774. }
  17775. /**
  17776. * This class is used by the onRenderingGroupObservable
  17777. */
  17778. export class RenderingGroupInfo {
  17779. /**
  17780. * The Scene that being rendered
  17781. */
  17782. scene: Scene;
  17783. /**
  17784. * The camera currently used for the rendering pass
  17785. */
  17786. camera: Nullable<Camera>;
  17787. /**
  17788. * The ID of the renderingGroup being processed
  17789. */
  17790. renderingGroupId: number;
  17791. }
  17792. /**
  17793. * This is the manager responsible of all the rendering for meshes sprites and particles.
  17794. * It is enable to manage the different groups as well as the different necessary sort functions.
  17795. * This should not be used directly aside of the few static configurations
  17796. */
  17797. export class RenderingManager {
  17798. /**
  17799. * The max id used for rendering groups (not included)
  17800. */
  17801. static MAX_RENDERINGGROUPS: number;
  17802. /**
  17803. * The min id used for rendering groups (included)
  17804. */
  17805. static MIN_RENDERINGGROUPS: number;
  17806. /**
  17807. * Used to globally prevent autoclearing scenes.
  17808. */
  17809. static AUTOCLEAR: boolean;
  17810. /**
  17811. * @hidden
  17812. */
  17813. _useSceneAutoClearSetup: boolean;
  17814. private _scene;
  17815. private _renderingGroups;
  17816. private _depthStencilBufferAlreadyCleaned;
  17817. private _autoClearDepthStencil;
  17818. private _customOpaqueSortCompareFn;
  17819. private _customAlphaTestSortCompareFn;
  17820. private _customTransparentSortCompareFn;
  17821. private _renderingGroupInfo;
  17822. /**
  17823. * Instantiates a new rendering group for a particular scene
  17824. * @param scene Defines the scene the groups belongs to
  17825. */
  17826. constructor(scene: Scene);
  17827. private _clearDepthStencilBuffer;
  17828. /**
  17829. * Renders the entire managed groups. This is used by the scene or the different rennder targets.
  17830. * @hidden
  17831. */
  17832. render(customRenderFunction: Nullable<(opaqueSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>) => void>, activeMeshes: Nullable<AbstractMesh[]>, renderParticles: boolean, renderSprites: boolean): void;
  17833. /**
  17834. * Resets the different information of the group to prepare a new frame
  17835. * @hidden
  17836. */
  17837. reset(): void;
  17838. /**
  17839. * Dispose and release the group and its associated resources.
  17840. * @hidden
  17841. */
  17842. dispose(): void;
  17843. /**
  17844. * Clear the info related to rendering groups preventing retention points during dispose.
  17845. */
  17846. freeRenderingGroups(): void;
  17847. private _prepareRenderingGroup;
  17848. /**
  17849. * Add a sprite manager to the rendering manager in order to render it this frame.
  17850. * @param spriteManager Define the sprite manager to render
  17851. */
  17852. dispatchSprites(spriteManager: ISpriteManager): void;
  17853. /**
  17854. * Add a particle system to the rendering manager in order to render it this frame.
  17855. * @param particleSystem Define the particle system to render
  17856. */
  17857. dispatchParticles(particleSystem: IParticleSystem): void;
  17858. /**
  17859. * Add a submesh to the manager in order to render it this frame
  17860. * @param subMesh The submesh to dispatch
  17861. * @param mesh Optional reference to the submeshes's mesh. Provide if you have an exiting reference to improve performance.
  17862. * @param material Optional reference to the submeshes's material. Provide if you have an exiting reference to improve performance.
  17863. */
  17864. dispatch(subMesh: SubMesh, mesh?: AbstractMesh, material?: Nullable<Material>): void;
  17865. /**
  17866. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  17867. * This allowed control for front to back rendering or reversly depending of the special needs.
  17868. *
  17869. * @param renderingGroupId The rendering group id corresponding to its index
  17870. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  17871. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  17872. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  17873. */
  17874. setRenderingOrder(renderingGroupId: number, opaqueSortCompareFn?: Nullable<(a: SubMesh, b: SubMesh) => number>, alphaTestSortCompareFn?: Nullable<(a: SubMesh, b: SubMesh) => number>, transparentSortCompareFn?: Nullable<(a: SubMesh, b: SubMesh) => number>): void;
  17875. /**
  17876. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  17877. *
  17878. * @param renderingGroupId The rendering group id corresponding to its index
  17879. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  17880. * @param depth Automatically clears depth between groups if true and autoClear is true.
  17881. * @param stencil Automatically clears stencil between groups if true and autoClear is true.
  17882. */
  17883. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean, depth?: boolean, stencil?: boolean): void;
  17884. /**
  17885. * Gets the current auto clear configuration for one rendering group of the rendering
  17886. * manager.
  17887. * @param index the rendering group index to get the information for
  17888. * @returns The auto clear setup for the requested rendering group
  17889. */
  17890. getAutoClearDepthStencilSetup(index: number): IRenderingManagerAutoClearSetup;
  17891. }
  17892. }
  17893. declare module "babylonjs/Lights/Shadows/shadowGenerator" {
  17894. import { SmartArray } from "babylonjs/Misc/smartArray";
  17895. import { Nullable } from "babylonjs/types";
  17896. import { Scene } from "babylonjs/scene";
  17897. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  17898. import { SubMesh } from "babylonjs/Meshes/subMesh";
  17899. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  17900. import { Mesh } from "babylonjs/Meshes/mesh";
  17901. import { IShadowLight } from "babylonjs/Lights/shadowLight";
  17902. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  17903. import { Effect } from "babylonjs/Materials/effect";
  17904. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  17905. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  17906. import "babylonjs/Shaders/shadowMap.fragment";
  17907. import "babylonjs/Shaders/shadowMap.vertex";
  17908. import "babylonjs/Shaders/depthBoxBlur.fragment";
  17909. import "babylonjs/Shaders/ShadersInclude/shadowMapFragmentSoftTransparentShadow";
  17910. import { Observable } from "babylonjs/Misc/observable";
  17911. /**
  17912. * Defines the options associated with the creation of a custom shader for a shadow generator.
  17913. */
  17914. export interface ICustomShaderOptions {
  17915. /**
  17916. * Gets or sets the custom shader name to use
  17917. */
  17918. shaderName: string;
  17919. /**
  17920. * The list of attribute names used in the shader
  17921. */
  17922. attributes?: string[];
  17923. /**
  17924. * The list of unifrom names used in the shader
  17925. */
  17926. uniforms?: string[];
  17927. /**
  17928. * The list of sampler names used in the shader
  17929. */
  17930. samplers?: string[];
  17931. /**
  17932. * The list of defines used in the shader
  17933. */
  17934. defines?: string[];
  17935. }
  17936. /**
  17937. * Interface to implement to create a shadow generator compatible with BJS.
  17938. */
  17939. export interface IShadowGenerator {
  17940. /** Gets or set the id of the shadow generator. It will be the one from the light if not defined */
  17941. id: string;
  17942. /**
  17943. * Gets the main RTT containing the shadow map (usually storing depth from the light point of view).
  17944. * @returns The render target texture if present otherwise, null
  17945. */
  17946. getShadowMap(): Nullable<RenderTargetTexture>;
  17947. /**
  17948. * Determine wheter the shadow generator is ready or not (mainly all effects and related post processes needs to be ready).
  17949. * @param subMesh The submesh we want to render in the shadow map
  17950. * @param useInstances Defines wether will draw in the map using instances
  17951. * @param isTransparent Indicates that isReady is called for a transparent subMesh
  17952. * @returns true if ready otherwise, false
  17953. */
  17954. isReady(subMesh: SubMesh, useInstances: boolean, isTransparent: boolean): boolean;
  17955. /**
  17956. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  17957. * @param defines Defines of the material we want to update
  17958. * @param lightIndex Index of the light in the enabled light list of the material
  17959. */
  17960. prepareDefines(defines: MaterialDefines, lightIndex: number): void;
  17961. /**
  17962. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  17963. * defined in the generator but impacting the effect).
  17964. * It implies the unifroms available on the materials are the standard BJS ones.
  17965. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  17966. * @param effect The effect we are binfing the information for
  17967. */
  17968. bindShadowLight(lightIndex: string, effect: Effect): void;
  17969. /**
  17970. * Gets the transformation matrix used to project the meshes into the map from the light point of view.
  17971. * (eq to shadow prjection matrix * light transform matrix)
  17972. * @returns The transform matrix used to create the shadow map
  17973. */
  17974. getTransformMatrix(): Matrix;
  17975. /**
  17976. * Recreates the shadow map dependencies like RTT and post processes. This can be used during the switch between
  17977. * Cube and 2D textures for instance.
  17978. */
  17979. recreateShadowMap(): void;
  17980. /**
  17981. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  17982. * @param onCompiled Callback triggered at the and of the effects compilation
  17983. * @param options Sets of optional options forcing the compilation with different modes
  17984. */
  17985. forceCompilation(onCompiled?: (generator: IShadowGenerator) => void, options?: Partial<{
  17986. useInstances: boolean;
  17987. }>): void;
  17988. /**
  17989. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  17990. * @param options Sets of optional options forcing the compilation with different modes
  17991. * @returns A promise that resolves when the compilation completes
  17992. */
  17993. forceCompilationAsync(options?: Partial<{
  17994. useInstances: boolean;
  17995. }>): Promise<void>;
  17996. /**
  17997. * Serializes the shadow generator setup to a json object.
  17998. * @returns The serialized JSON object
  17999. */
  18000. serialize(): any;
  18001. /**
  18002. * Disposes the Shadow map and related Textures and effects.
  18003. */
  18004. dispose(): void;
  18005. }
  18006. /**
  18007. * Default implementation IShadowGenerator.
  18008. * This is the main object responsible of generating shadows in the framework.
  18009. * Documentation: https://doc.babylonjs.com/babylon101/shadows
  18010. */
  18011. export class ShadowGenerator implements IShadowGenerator {
  18012. /**
  18013. * Name of the shadow generator class
  18014. */
  18015. static CLASSNAME: string;
  18016. /**
  18017. * Shadow generator mode None: no filtering applied.
  18018. */
  18019. static readonly FILTER_NONE: number;
  18020. /**
  18021. * Shadow generator mode ESM: Exponential Shadow Mapping.
  18022. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  18023. */
  18024. static readonly FILTER_EXPONENTIALSHADOWMAP: number;
  18025. /**
  18026. * Shadow generator mode Poisson Sampling: Percentage Closer Filtering.
  18027. * (Multiple Tap around evenly distributed around the pixel are used to evaluate the shadow strength)
  18028. */
  18029. static readonly FILTER_POISSONSAMPLING: number;
  18030. /**
  18031. * Shadow generator mode ESM: Blurred Exponential Shadow Mapping.
  18032. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  18033. */
  18034. static readonly FILTER_BLUREXPONENTIALSHADOWMAP: number;
  18035. /**
  18036. * Shadow generator mode ESM: Exponential Shadow Mapping using the inverse of the exponential preventing
  18037. * edge artifacts on steep falloff.
  18038. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  18039. */
  18040. static readonly FILTER_CLOSEEXPONENTIALSHADOWMAP: number;
  18041. /**
  18042. * Shadow generator mode ESM: Blurred Exponential Shadow Mapping using the inverse of the exponential preventing
  18043. * edge artifacts on steep falloff.
  18044. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  18045. */
  18046. static readonly FILTER_BLURCLOSEEXPONENTIALSHADOWMAP: number;
  18047. /**
  18048. * Shadow generator mode PCF: Percentage Closer Filtering
  18049. * benefits from Webgl 2 shadow samplers. Fallback to Poisson Sampling in Webgl 1
  18050. * (https://developer.nvidia.com/gpugems/GPUGems/gpugems_ch11.html)
  18051. */
  18052. static readonly FILTER_PCF: number;
  18053. /**
  18054. * Shadow generator mode PCSS: Percentage Closering Soft Shadow.
  18055. * benefits from Webgl 2 shadow samplers. Fallback to Poisson Sampling in Webgl 1
  18056. * Contact Hardening
  18057. */
  18058. static readonly FILTER_PCSS: number;
  18059. /**
  18060. * Reserved for PCF and PCSS
  18061. * Highest Quality.
  18062. *
  18063. * Execute PCF on a 5*5 kernel improving a lot the shadow aliasing artifacts.
  18064. *
  18065. * Execute PCSS with 32 taps blocker search and 64 taps PCF.
  18066. */
  18067. static readonly QUALITY_HIGH: number;
  18068. /**
  18069. * Reserved for PCF and PCSS
  18070. * Good tradeoff for quality/perf cross devices
  18071. *
  18072. * Execute PCF on a 3*3 kernel.
  18073. *
  18074. * Execute PCSS with 16 taps blocker search and 32 taps PCF.
  18075. */
  18076. static readonly QUALITY_MEDIUM: number;
  18077. /**
  18078. * Reserved for PCF and PCSS
  18079. * The lowest quality but the fastest.
  18080. *
  18081. * Execute PCF on a 1*1 kernel.
  18082. *
  18083. * Execute PCSS with 16 taps blocker search and 16 taps PCF.
  18084. */
  18085. static readonly QUALITY_LOW: number;
  18086. /** Gets or set the id of the shadow generator. It will be the one from the light if not defined */
  18087. id: string;
  18088. /** Gets or sets the custom shader name to use */
  18089. customShaderOptions: ICustomShaderOptions;
  18090. /**
  18091. * Observable triggered before the shadow is rendered. Can be used to update internal effect state
  18092. */
  18093. onBeforeShadowMapRenderObservable: Observable<Effect>;
  18094. /**
  18095. * Observable triggered after the shadow is rendered. Can be used to restore internal effect state
  18096. */
  18097. onAfterShadowMapRenderObservable: Observable<Effect>;
  18098. /**
  18099. * Observable triggered before a mesh is rendered in the shadow map.
  18100. * Can be used to update internal effect state (that you can get from the onBeforeShadowMapRenderObservable)
  18101. */
  18102. onBeforeShadowMapRenderMeshObservable: Observable<Mesh>;
  18103. /**
  18104. * Observable triggered after a mesh is rendered in the shadow map.
  18105. * Can be used to update internal effect state (that you can get from the onAfterShadowMapRenderObservable)
  18106. */
  18107. onAfterShadowMapRenderMeshObservable: Observable<Mesh>;
  18108. protected _bias: number;
  18109. /**
  18110. * Gets the bias: offset applied on the depth preventing acnea (in light direction).
  18111. */
  18112. get bias(): number;
  18113. /**
  18114. * Sets the bias: offset applied on the depth preventing acnea (in light direction).
  18115. */
  18116. set bias(bias: number);
  18117. protected _normalBias: number;
  18118. /**
  18119. * Gets the normalBias: offset applied on the depth preventing acnea (along side the normal direction and proportinal to the light/normal angle).
  18120. */
  18121. get normalBias(): number;
  18122. /**
  18123. * Sets the normalBias: offset applied on the depth preventing acnea (along side the normal direction and proportinal to the light/normal angle).
  18124. */
  18125. set normalBias(normalBias: number);
  18126. protected _blurBoxOffset: number;
  18127. /**
  18128. * Gets the blur box offset: offset applied during the blur pass.
  18129. * Only useful if useKernelBlur = false
  18130. */
  18131. get blurBoxOffset(): number;
  18132. /**
  18133. * Sets the blur box offset: offset applied during the blur pass.
  18134. * Only useful if useKernelBlur = false
  18135. */
  18136. set blurBoxOffset(value: number);
  18137. protected _blurScale: number;
  18138. /**
  18139. * Gets the blur scale: scale of the blurred texture compared to the main shadow map.
  18140. * 2 means half of the size.
  18141. */
  18142. get blurScale(): number;
  18143. /**
  18144. * Sets the blur scale: scale of the blurred texture compared to the main shadow map.
  18145. * 2 means half of the size.
  18146. */
  18147. set blurScale(value: number);
  18148. protected _blurKernel: number;
  18149. /**
  18150. * Gets the blur kernel: kernel size of the blur pass.
  18151. * Only useful if useKernelBlur = true
  18152. */
  18153. get blurKernel(): number;
  18154. /**
  18155. * Sets the blur kernel: kernel size of the blur pass.
  18156. * Only useful if useKernelBlur = true
  18157. */
  18158. set blurKernel(value: number);
  18159. protected _useKernelBlur: boolean;
  18160. /**
  18161. * Gets whether the blur pass is a kernel blur (if true) or box blur.
  18162. * Only useful in filtered mode (useBlurExponentialShadowMap...)
  18163. */
  18164. get useKernelBlur(): boolean;
  18165. /**
  18166. * Sets whether the blur pass is a kernel blur (if true) or box blur.
  18167. * Only useful in filtered mode (useBlurExponentialShadowMap...)
  18168. */
  18169. set useKernelBlur(value: boolean);
  18170. protected _depthScale: number;
  18171. /**
  18172. * Gets the depth scale used in ESM mode.
  18173. */
  18174. get depthScale(): number;
  18175. /**
  18176. * Sets the depth scale used in ESM mode.
  18177. * This can override the scale stored on the light.
  18178. */
  18179. set depthScale(value: number);
  18180. protected _validateFilter(filter: number): number;
  18181. protected _filter: number;
  18182. /**
  18183. * Gets the current mode of the shadow generator (normal, PCF, ESM...).
  18184. * The returned value is a number equal to one of the available mode defined in ShadowMap.FILTER_x like _FILTER_NONE
  18185. */
  18186. get filter(): number;
  18187. /**
  18188. * Sets the current mode of the shadow generator (normal, PCF, ESM...).
  18189. * The returned value is a number equal to one of the available mode defined in ShadowMap.FILTER_x like _FILTER_NONE
  18190. */
  18191. set filter(value: number);
  18192. /**
  18193. * Gets if the current filter is set to Poisson Sampling.
  18194. */
  18195. get usePoissonSampling(): boolean;
  18196. /**
  18197. * Sets the current filter to Poisson Sampling.
  18198. */
  18199. set usePoissonSampling(value: boolean);
  18200. /**
  18201. * Gets if the current filter is set to ESM.
  18202. */
  18203. get useExponentialShadowMap(): boolean;
  18204. /**
  18205. * Sets the current filter is to ESM.
  18206. */
  18207. set useExponentialShadowMap(value: boolean);
  18208. /**
  18209. * Gets if the current filter is set to filtered ESM.
  18210. */
  18211. get useBlurExponentialShadowMap(): boolean;
  18212. /**
  18213. * Gets if the current filter is set to filtered ESM.
  18214. */
  18215. set useBlurExponentialShadowMap(value: boolean);
  18216. /**
  18217. * Gets if the current filter is set to "close ESM" (using the inverse of the
  18218. * exponential to prevent steep falloff artifacts).
  18219. */
  18220. get useCloseExponentialShadowMap(): boolean;
  18221. /**
  18222. * Sets the current filter to "close ESM" (using the inverse of the
  18223. * exponential to prevent steep falloff artifacts).
  18224. */
  18225. set useCloseExponentialShadowMap(value: boolean);
  18226. /**
  18227. * Gets if the current filter is set to filtered "close ESM" (using the inverse of the
  18228. * exponential to prevent steep falloff artifacts).
  18229. */
  18230. get useBlurCloseExponentialShadowMap(): boolean;
  18231. /**
  18232. * Sets the current filter to filtered "close ESM" (using the inverse of the
  18233. * exponential to prevent steep falloff artifacts).
  18234. */
  18235. set useBlurCloseExponentialShadowMap(value: boolean);
  18236. /**
  18237. * Gets if the current filter is set to "PCF" (percentage closer filtering).
  18238. */
  18239. get usePercentageCloserFiltering(): boolean;
  18240. /**
  18241. * Sets the current filter to "PCF" (percentage closer filtering).
  18242. */
  18243. set usePercentageCloserFiltering(value: boolean);
  18244. protected _filteringQuality: number;
  18245. /**
  18246. * Gets the PCF or PCSS Quality.
  18247. * Only valid if usePercentageCloserFiltering or usePercentageCloserFiltering is true.
  18248. */
  18249. get filteringQuality(): number;
  18250. /**
  18251. * Sets the PCF or PCSS Quality.
  18252. * Only valid if usePercentageCloserFiltering or usePercentageCloserFiltering is true.
  18253. */
  18254. set filteringQuality(filteringQuality: number);
  18255. /**
  18256. * Gets if the current filter is set to "PCSS" (contact hardening).
  18257. */
  18258. get useContactHardeningShadow(): boolean;
  18259. /**
  18260. * Sets the current filter to "PCSS" (contact hardening).
  18261. */
  18262. set useContactHardeningShadow(value: boolean);
  18263. protected _contactHardeningLightSizeUVRatio: number;
  18264. /**
  18265. * Gets the Light Size (in shadow map uv unit) used in PCSS to determine the blocker search area and the penumbra size.
  18266. * Using a ratio helps keeping shape stability independently of the map size.
  18267. *
  18268. * It does not account for the light projection as it was having too much
  18269. * instability during the light setup or during light position changes.
  18270. *
  18271. * Only valid if useContactHardeningShadow is true.
  18272. */
  18273. get contactHardeningLightSizeUVRatio(): number;
  18274. /**
  18275. * Sets the Light Size (in shadow map uv unit) used in PCSS to determine the blocker search area and the penumbra size.
  18276. * Using a ratio helps keeping shape stability independently of the map size.
  18277. *
  18278. * It does not account for the light projection as it was having too much
  18279. * instability during the light setup or during light position changes.
  18280. *
  18281. * Only valid if useContactHardeningShadow is true.
  18282. */
  18283. set contactHardeningLightSizeUVRatio(contactHardeningLightSizeUVRatio: number);
  18284. protected _darkness: number;
  18285. /** Gets or sets the actual darkness of a shadow */
  18286. get darkness(): number;
  18287. set darkness(value: number);
  18288. /**
  18289. * Returns the darkness value (float). This can only decrease the actual darkness of a shadow.
  18290. * 0 means strongest and 1 would means no shadow.
  18291. * @returns the darkness.
  18292. */
  18293. getDarkness(): number;
  18294. /**
  18295. * Sets the darkness value (float). This can only decrease the actual darkness of a shadow.
  18296. * @param darkness The darkness value 0 means strongest and 1 would means no shadow.
  18297. * @returns the shadow generator allowing fluent coding.
  18298. */
  18299. setDarkness(darkness: number): ShadowGenerator;
  18300. protected _transparencyShadow: boolean;
  18301. /** Gets or sets the ability to have transparent shadow */
  18302. get transparencyShadow(): boolean;
  18303. set transparencyShadow(value: boolean);
  18304. /**
  18305. * Sets the ability to have transparent shadow (boolean).
  18306. * @param transparent True if transparent else False
  18307. * @returns the shadow generator allowing fluent coding
  18308. */
  18309. setTransparencyShadow(transparent: boolean): ShadowGenerator;
  18310. /**
  18311. * Enables or disables shadows with varying strength based on the transparency
  18312. * When it is enabled, the strength of the shadow is taken equal to mesh.visibility
  18313. * If you enabled an alpha texture on your material, the alpha value red from the texture is also combined to compute the strength:
  18314. * mesh.visibility * alphaTexture.a
  18315. * Note that by definition transparencyShadow must be set to true for enableSoftTransparentShadow to work!
  18316. */
  18317. enableSoftTransparentShadow: boolean;
  18318. protected _shadowMap: Nullable<RenderTargetTexture>;
  18319. protected _shadowMap2: Nullable<RenderTargetTexture>;
  18320. /**
  18321. * Gets the main RTT containing the shadow map (usually storing depth from the light point of view).
  18322. * @returns The render target texture if present otherwise, null
  18323. */
  18324. getShadowMap(): Nullable<RenderTargetTexture>;
  18325. /**
  18326. * Gets the RTT used during rendering (can be a blurred version of the shadow map or the shadow map itself).
  18327. * @returns The render target texture if the shadow map is present otherwise, null
  18328. */
  18329. getShadowMapForRendering(): Nullable<RenderTargetTexture>;
  18330. /**
  18331. * Gets the class name of that object
  18332. * @returns "ShadowGenerator"
  18333. */
  18334. getClassName(): string;
  18335. /**
  18336. * Helper function to add a mesh and its descendants to the list of shadow casters.
  18337. * @param mesh Mesh to add
  18338. * @param includeDescendants boolean indicating if the descendants should be added. Default to true
  18339. * @returns the Shadow Generator itself
  18340. */
  18341. addShadowCaster(mesh: AbstractMesh, includeDescendants?: boolean): ShadowGenerator;
  18342. /**
  18343. * Helper function to remove a mesh and its descendants from the list of shadow casters
  18344. * @param mesh Mesh to remove
  18345. * @param includeDescendants boolean indicating if the descendants should be removed. Default to true
  18346. * @returns the Shadow Generator itself
  18347. */
  18348. removeShadowCaster(mesh: AbstractMesh, includeDescendants?: boolean): ShadowGenerator;
  18349. /**
  18350. * Controls the extent to which the shadows fade out at the edge of the frustum
  18351. */
  18352. frustumEdgeFalloff: number;
  18353. protected _light: IShadowLight;
  18354. /**
  18355. * Returns the associated light object.
  18356. * @returns the light generating the shadow
  18357. */
  18358. getLight(): IShadowLight;
  18359. /**
  18360. * If true the shadow map is generated by rendering the back face of the mesh instead of the front face.
  18361. * This can help with self-shadowing as the geometry making up the back of objects is slightly offset.
  18362. * It might on the other hand introduce peter panning.
  18363. */
  18364. forceBackFacesOnly: boolean;
  18365. protected _scene: Scene;
  18366. protected _lightDirection: Vector3;
  18367. protected _effect: Effect;
  18368. protected _viewMatrix: Matrix;
  18369. protected _projectionMatrix: Matrix;
  18370. protected _transformMatrix: Matrix;
  18371. protected _cachedPosition: Vector3;
  18372. protected _cachedDirection: Vector3;
  18373. protected _cachedDefines: string;
  18374. protected _currentRenderID: number;
  18375. protected _boxBlurPostprocess: Nullable<PostProcess>;
  18376. protected _kernelBlurXPostprocess: Nullable<PostProcess>;
  18377. protected _kernelBlurYPostprocess: Nullable<PostProcess>;
  18378. protected _blurPostProcesses: PostProcess[];
  18379. protected _mapSize: number;
  18380. protected _currentFaceIndex: number;
  18381. protected _currentFaceIndexCache: number;
  18382. protected _textureType: number;
  18383. protected _defaultTextureMatrix: Matrix;
  18384. protected _storedUniqueId: Nullable<number>;
  18385. /** @hidden */
  18386. static _SceneComponentInitialization: (scene: Scene) => void;
  18387. /**
  18388. * Creates a ShadowGenerator object.
  18389. * A ShadowGenerator is the required tool to use the shadows.
  18390. * Each light casting shadows needs to use its own ShadowGenerator.
  18391. * Documentation : https://doc.babylonjs.com/babylon101/shadows
  18392. * @param mapSize The size of the texture what stores the shadows. Example : 1024.
  18393. * @param light The light object generating the shadows.
  18394. * @param usefulFloatFirst By default the generator will try to use half float textures but if you need precision (for self shadowing for instance), you can use this option to enforce full float texture.
  18395. */
  18396. constructor(mapSize: number, light: IShadowLight, usefulFloatFirst?: boolean);
  18397. protected _initializeGenerator(): void;
  18398. protected _createTargetRenderTexture(): void;
  18399. protected _initializeShadowMap(): void;
  18400. protected _initializeBlurRTTAndPostProcesses(): void;
  18401. protected _renderForShadowMap(opaqueSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>): void;
  18402. protected _bindCustomEffectForRenderSubMeshForShadowMap(subMesh: SubMesh, effect: Effect, matriceNames: any, mesh: AbstractMesh): void;
  18403. protected _renderSubMeshForShadowMap(subMesh: SubMesh, isTransparent?: boolean): void;
  18404. protected _applyFilterValues(): void;
  18405. /**
  18406. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  18407. * @param onCompiled Callback triggered at the and of the effects compilation
  18408. * @param options Sets of optional options forcing the compilation with different modes
  18409. */
  18410. forceCompilation(onCompiled?: (generator: IShadowGenerator) => void, options?: Partial<{
  18411. useInstances: boolean;
  18412. }>): void;
  18413. /**
  18414. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  18415. * @param options Sets of optional options forcing the compilation with different modes
  18416. * @returns A promise that resolves when the compilation completes
  18417. */
  18418. forceCompilationAsync(options?: Partial<{
  18419. useInstances: boolean;
  18420. }>): Promise<void>;
  18421. protected _isReadyCustomDefines(defines: any, subMesh: SubMesh, useInstances: boolean): void;
  18422. private _prepareShadowDefines;
  18423. /**
  18424. * Determine wheter the shadow generator is ready or not (mainly all effects and related post processes needs to be ready).
  18425. * @param subMesh The submesh we want to render in the shadow map
  18426. * @param useInstances Defines wether will draw in the map using instances
  18427. * @param isTransparent Indicates that isReady is called for a transparent subMesh
  18428. * @returns true if ready otherwise, false
  18429. */
  18430. isReady(subMesh: SubMesh, useInstances: boolean, isTransparent: boolean): boolean;
  18431. /**
  18432. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  18433. * @param defines Defines of the material we want to update
  18434. * @param lightIndex Index of the light in the enabled light list of the material
  18435. */
  18436. prepareDefines(defines: any, lightIndex: number): void;
  18437. /**
  18438. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  18439. * defined in the generator but impacting the effect).
  18440. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  18441. * @param effect The effect we are binfing the information for
  18442. */
  18443. bindShadowLight(lightIndex: string, effect: Effect): void;
  18444. /**
  18445. * Gets the transformation matrix used to project the meshes into the map from the light point of view.
  18446. * (eq to shadow prjection matrix * light transform matrix)
  18447. * @returns The transform matrix used to create the shadow map
  18448. */
  18449. getTransformMatrix(): Matrix;
  18450. /**
  18451. * Recreates the shadow map dependencies like RTT and post processes. This can be used during the switch between
  18452. * Cube and 2D textures for instance.
  18453. */
  18454. recreateShadowMap(): void;
  18455. protected _disposeBlurPostProcesses(): void;
  18456. protected _disposeRTTandPostProcesses(): void;
  18457. /**
  18458. * Disposes the ShadowGenerator.
  18459. * Returns nothing.
  18460. */
  18461. dispose(): void;
  18462. /**
  18463. * Serializes the shadow generator setup to a json object.
  18464. * @returns The serialized JSON object
  18465. */
  18466. serialize(): any;
  18467. /**
  18468. * Parses a serialized ShadowGenerator and returns a new ShadowGenerator.
  18469. * @param parsedShadowGenerator The JSON object to parse
  18470. * @param scene The scene to create the shadow map for
  18471. * @param constr A function that builds a shadow generator or undefined to create an instance of the default shadow generator
  18472. * @returns The parsed shadow generator
  18473. */
  18474. static Parse(parsedShadowGenerator: any, scene: Scene, constr?: (mapSize: number, light: IShadowLight) => ShadowGenerator): ShadowGenerator;
  18475. }
  18476. }
  18477. declare module "babylonjs/Lights/light" {
  18478. import { Nullable } from "babylonjs/types";
  18479. import { Scene } from "babylonjs/scene";
  18480. import { Vector3 } from "babylonjs/Maths/math.vector";
  18481. import { Color3 } from "babylonjs/Maths/math.color";
  18482. import { Node } from "babylonjs/node";
  18483. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  18484. import { Effect } from "babylonjs/Materials/effect";
  18485. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  18486. import { IShadowGenerator } from "babylonjs/Lights/Shadows/shadowGenerator";
  18487. /**
  18488. * Base class of all the lights in Babylon. It groups all the generic information about lights.
  18489. * Lights are used, as you would expect, to affect how meshes are seen, in terms of both illumination and colour.
  18490. * All meshes allow light to pass through them unless shadow generation is activated. The default number of lights allowed is four but this can be increased.
  18491. */
  18492. export abstract class Light extends Node {
  18493. /**
  18494. * Falloff Default: light is falling off following the material specification:
  18495. * standard material is using standard falloff whereas pbr material can request special falloff per materials.
  18496. */
  18497. static readonly FALLOFF_DEFAULT: number;
  18498. /**
  18499. * Falloff Physical: light is falling off following the inverse squared distance law.
  18500. */
  18501. static readonly FALLOFF_PHYSICAL: number;
  18502. /**
  18503. * Falloff gltf: light is falling off as described in the gltf moving to PBR document
  18504. * to enhance interoperability with other engines.
  18505. */
  18506. static readonly FALLOFF_GLTF: number;
  18507. /**
  18508. * Falloff Standard: light is falling off like in the standard material
  18509. * to enhance interoperability with other materials.
  18510. */
  18511. static readonly FALLOFF_STANDARD: number;
  18512. /**
  18513. * If every light affecting the material is in this lightmapMode,
  18514. * material.lightmapTexture adds or multiplies
  18515. * (depends on material.useLightmapAsShadowmap)
  18516. * after every other light calculations.
  18517. */
  18518. static readonly LIGHTMAP_DEFAULT: number;
  18519. /**
  18520. * material.lightmapTexture as only diffuse lighting from this light
  18521. * adds only specular lighting from this light
  18522. * adds dynamic shadows
  18523. */
  18524. static readonly LIGHTMAP_SPECULAR: number;
  18525. /**
  18526. * material.lightmapTexture as only lighting
  18527. * no light calculation from this light
  18528. * only adds dynamic shadows from this light
  18529. */
  18530. static readonly LIGHTMAP_SHADOWSONLY: number;
  18531. /**
  18532. * Each light type uses the default quantity according to its type:
  18533. * point/spot lights use luminous intensity
  18534. * directional lights use illuminance
  18535. */
  18536. static readonly INTENSITYMODE_AUTOMATIC: number;
  18537. /**
  18538. * lumen (lm)
  18539. */
  18540. static readonly INTENSITYMODE_LUMINOUSPOWER: number;
  18541. /**
  18542. * candela (lm/sr)
  18543. */
  18544. static readonly INTENSITYMODE_LUMINOUSINTENSITY: number;
  18545. /**
  18546. * lux (lm/m^2)
  18547. */
  18548. static readonly INTENSITYMODE_ILLUMINANCE: number;
  18549. /**
  18550. * nit (cd/m^2)
  18551. */
  18552. static readonly INTENSITYMODE_LUMINANCE: number;
  18553. /**
  18554. * Light type const id of the point light.
  18555. */
  18556. static readonly LIGHTTYPEID_POINTLIGHT: number;
  18557. /**
  18558. * Light type const id of the directional light.
  18559. */
  18560. static readonly LIGHTTYPEID_DIRECTIONALLIGHT: number;
  18561. /**
  18562. * Light type const id of the spot light.
  18563. */
  18564. static readonly LIGHTTYPEID_SPOTLIGHT: number;
  18565. /**
  18566. * Light type const id of the hemispheric light.
  18567. */
  18568. static readonly LIGHTTYPEID_HEMISPHERICLIGHT: number;
  18569. /**
  18570. * Diffuse gives the basic color to an object.
  18571. */
  18572. diffuse: Color3;
  18573. /**
  18574. * Specular produces a highlight color on an object.
  18575. * Note: This is note affecting PBR materials.
  18576. */
  18577. specular: Color3;
  18578. /**
  18579. * Defines the falloff type for this light. This lets overrriding how punctual light are
  18580. * falling off base on range or angle.
  18581. * This can be set to any values in Light.FALLOFF_x.
  18582. *
  18583. * Note: This is only useful for PBR Materials at the moment. This could be extended if required to
  18584. * other types of materials.
  18585. */
  18586. falloffType: number;
  18587. /**
  18588. * Strength of the light.
  18589. * Note: By default it is define in the framework own unit.
  18590. * Note: In PBR materials the intensityMode can be use to chose what unit the intensity is defined in.
  18591. */
  18592. intensity: number;
  18593. private _range;
  18594. protected _inverseSquaredRange: number;
  18595. /**
  18596. * Defines how far from the source the light is impacting in scene units.
  18597. * Note: Unused in PBR material as the distance light falloff is defined following the inverse squared falloff.
  18598. */
  18599. get range(): number;
  18600. /**
  18601. * Defines how far from the source the light is impacting in scene units.
  18602. * Note: Unused in PBR material as the distance light falloff is defined following the inverse squared falloff.
  18603. */
  18604. set range(value: number);
  18605. /**
  18606. * Cached photometric scale default to 1.0 as the automatic intensity mode defaults to 1.0 for every type
  18607. * of light.
  18608. */
  18609. private _photometricScale;
  18610. private _intensityMode;
  18611. /**
  18612. * Gets the photometric scale used to interpret the intensity.
  18613. * This is only relevant with PBR Materials where the light intensity can be defined in a physical way.
  18614. */
  18615. get intensityMode(): number;
  18616. /**
  18617. * Sets the photometric scale used to interpret the intensity.
  18618. * This is only relevant with PBR Materials where the light intensity can be defined in a physical way.
  18619. */
  18620. set intensityMode(value: number);
  18621. private _radius;
  18622. /**
  18623. * Gets the light radius used by PBR Materials to simulate soft area lights.
  18624. */
  18625. get radius(): number;
  18626. /**
  18627. * sets the light radius used by PBR Materials to simulate soft area lights.
  18628. */
  18629. set radius(value: number);
  18630. private _renderPriority;
  18631. /**
  18632. * Defines the rendering priority of the lights. It can help in case of fallback or number of lights
  18633. * exceeding the number allowed of the materials.
  18634. */
  18635. renderPriority: number;
  18636. private _shadowEnabled;
  18637. /**
  18638. * Gets wether or not the shadows are enabled for this light. This can help turning off/on shadow without detaching
  18639. * the current shadow generator.
  18640. */
  18641. get shadowEnabled(): boolean;
  18642. /**
  18643. * Sets wether or not the shadows are enabled for this light. This can help turning off/on shadow without detaching
  18644. * the current shadow generator.
  18645. */
  18646. set shadowEnabled(value: boolean);
  18647. private _includedOnlyMeshes;
  18648. /**
  18649. * Gets the only meshes impacted by this light.
  18650. */
  18651. get includedOnlyMeshes(): AbstractMesh[];
  18652. /**
  18653. * Sets the only meshes impacted by this light.
  18654. */
  18655. set includedOnlyMeshes(value: AbstractMesh[]);
  18656. private _excludedMeshes;
  18657. /**
  18658. * Gets the meshes not impacted by this light.
  18659. */
  18660. get excludedMeshes(): AbstractMesh[];
  18661. /**
  18662. * Sets the meshes not impacted by this light.
  18663. */
  18664. set excludedMeshes(value: AbstractMesh[]);
  18665. private _excludeWithLayerMask;
  18666. /**
  18667. * Gets the layer id use to find what meshes are not impacted by the light.
  18668. * Inactive if 0
  18669. */
  18670. get excludeWithLayerMask(): number;
  18671. /**
  18672. * Sets the layer id use to find what meshes are not impacted by the light.
  18673. * Inactive if 0
  18674. */
  18675. set excludeWithLayerMask(value: number);
  18676. private _includeOnlyWithLayerMask;
  18677. /**
  18678. * Gets the layer id use to find what meshes are impacted by the light.
  18679. * Inactive if 0
  18680. */
  18681. get includeOnlyWithLayerMask(): number;
  18682. /**
  18683. * Sets the layer id use to find what meshes are impacted by the light.
  18684. * Inactive if 0
  18685. */
  18686. set includeOnlyWithLayerMask(value: number);
  18687. private _lightmapMode;
  18688. /**
  18689. * Gets the lightmap mode of this light (should be one of the constants defined by Light.LIGHTMAP_x)
  18690. */
  18691. get lightmapMode(): number;
  18692. /**
  18693. * Sets the lightmap mode of this light (should be one of the constants defined by Light.LIGHTMAP_x)
  18694. */
  18695. set lightmapMode(value: number);
  18696. /**
  18697. * Shadow generator associted to the light.
  18698. * @hidden Internal use only.
  18699. */
  18700. _shadowGenerator: Nullable<IShadowGenerator>;
  18701. /**
  18702. * @hidden Internal use only.
  18703. */
  18704. _excludedMeshesIds: string[];
  18705. /**
  18706. * @hidden Internal use only.
  18707. */
  18708. _includedOnlyMeshesIds: string[];
  18709. /**
  18710. * The current light unifom buffer.
  18711. * @hidden Internal use only.
  18712. */
  18713. _uniformBuffer: UniformBuffer;
  18714. /** @hidden */
  18715. _renderId: number;
  18716. /**
  18717. * Creates a Light object in the scene.
  18718. * Documentation : https://doc.babylonjs.com/babylon101/lights
  18719. * @param name The firendly name of the light
  18720. * @param scene The scene the light belongs too
  18721. */
  18722. constructor(name: string, scene: Scene);
  18723. protected abstract _buildUniformLayout(): void;
  18724. /**
  18725. * Sets the passed Effect "effect" with the Light information.
  18726. * @param effect The effect to update
  18727. * @param lightIndex The index of the light in the effect to update
  18728. * @returns The light
  18729. */
  18730. abstract transferToEffect(effect: Effect, lightIndex: string): Light;
  18731. /**
  18732. * Sets the passed Effect "effect" with the Light textures.
  18733. * @param effect The effect to update
  18734. * @param lightIndex The index of the light in the effect to update
  18735. * @returns The light
  18736. */
  18737. transferTexturesToEffect(effect: Effect, lightIndex: string): Light;
  18738. /**
  18739. * Binds the lights information from the scene to the effect for the given mesh.
  18740. * @param lightIndex Light index
  18741. * @param scene The scene where the light belongs to
  18742. * @param effect The effect we are binding the data to
  18743. * @param useSpecular Defines if specular is supported
  18744. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  18745. */
  18746. _bindLight(lightIndex: number, scene: Scene, effect: Effect, useSpecular: boolean, rebuildInParallel?: boolean): void;
  18747. /**
  18748. * Sets the passed Effect "effect" with the Light information.
  18749. * @param effect The effect to update
  18750. * @param lightDataUniformName The uniform used to store light data (position or direction)
  18751. * @returns The light
  18752. */
  18753. abstract transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): Light;
  18754. /**
  18755. * Returns the string "Light".
  18756. * @returns the class name
  18757. */
  18758. getClassName(): string;
  18759. /** @hidden */
  18760. readonly _isLight: boolean;
  18761. /**
  18762. * Converts the light information to a readable string for debug purpose.
  18763. * @param fullDetails Supports for multiple levels of logging within scene loading
  18764. * @returns the human readable light info
  18765. */
  18766. toString(fullDetails?: boolean): string;
  18767. /** @hidden */
  18768. protected _syncParentEnabledState(): void;
  18769. /**
  18770. * Set the enabled state of this node.
  18771. * @param value - the new enabled state
  18772. */
  18773. setEnabled(value: boolean): void;
  18774. /**
  18775. * Returns the Light associated shadow generator if any.
  18776. * @return the associated shadow generator.
  18777. */
  18778. getShadowGenerator(): Nullable<IShadowGenerator>;
  18779. /**
  18780. * Returns a Vector3, the absolute light position in the World.
  18781. * @returns the world space position of the light
  18782. */
  18783. getAbsolutePosition(): Vector3;
  18784. /**
  18785. * Specifies if the light will affect the passed mesh.
  18786. * @param mesh The mesh to test against the light
  18787. * @return true the mesh is affected otherwise, false.
  18788. */
  18789. canAffectMesh(mesh: AbstractMesh): boolean;
  18790. /**
  18791. * Sort function to order lights for rendering.
  18792. * @param a First Light object to compare to second.
  18793. * @param b Second Light object to compare first.
  18794. * @return -1 to reduce's a's index relative to be, 0 for no change, 1 to increase a's index relative to b.
  18795. */
  18796. static CompareLightsPriority(a: Light, b: Light): number;
  18797. /**
  18798. * Releases resources associated with this node.
  18799. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  18800. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  18801. */
  18802. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  18803. /**
  18804. * Returns the light type ID (integer).
  18805. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  18806. */
  18807. getTypeID(): number;
  18808. /**
  18809. * Returns the intensity scaled by the Photometric Scale according to the light type and intensity mode.
  18810. * @returns the scaled intensity in intensity mode unit
  18811. */
  18812. getScaledIntensity(): number;
  18813. /**
  18814. * Returns a new Light object, named "name", from the current one.
  18815. * @param name The name of the cloned light
  18816. * @param newParent The parent of this light, if it has one
  18817. * @returns the new created light
  18818. */
  18819. clone(name: string, newParent?: Nullable<Node>): Nullable<Light>;
  18820. /**
  18821. * Serializes the current light into a Serialization object.
  18822. * @returns the serialized object.
  18823. */
  18824. serialize(): any;
  18825. /**
  18826. * Creates a new typed light from the passed type (integer) : point light = 0, directional light = 1, spot light = 2, hemispheric light = 3.
  18827. * This new light is named "name" and added to the passed scene.
  18828. * @param type Type according to the types available in Light.LIGHTTYPEID_x
  18829. * @param name The friendly name of the light
  18830. * @param scene The scene the new light will belong to
  18831. * @returns the constructor function
  18832. */
  18833. static GetConstructorFromName(type: number, name: string, scene: Scene): Nullable<() => Light>;
  18834. /**
  18835. * Parses the passed "parsedLight" and returns a new instanced Light from this parsing.
  18836. * @param parsedLight The JSON representation of the light
  18837. * @param scene The scene to create the parsed light in
  18838. * @returns the created light after parsing
  18839. */
  18840. static Parse(parsedLight: any, scene: Scene): Nullable<Light>;
  18841. private _hookArrayForExcluded;
  18842. private _hookArrayForIncludedOnly;
  18843. private _resyncMeshes;
  18844. /**
  18845. * Forces the meshes to update their light related information in their rendering used effects
  18846. * @hidden Internal Use Only
  18847. */
  18848. _markMeshesAsLightDirty(): void;
  18849. /**
  18850. * Recomputes the cached photometric scale if needed.
  18851. */
  18852. private _computePhotometricScale;
  18853. /**
  18854. * Returns the Photometric Scale according to the light type and intensity mode.
  18855. */
  18856. private _getPhotometricScale;
  18857. /**
  18858. * Reorder the light in the scene according to their defined priority.
  18859. * @hidden Internal Use Only
  18860. */
  18861. _reorderLightsInScene(): void;
  18862. /**
  18863. * Prepares the list of defines specific to the light type.
  18864. * @param defines the list of defines
  18865. * @param lightIndex defines the index of the light for the effect
  18866. */
  18867. abstract prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  18868. }
  18869. }
  18870. declare module "babylonjs/Cameras/targetCamera" {
  18871. import { Nullable } from "babylonjs/types";
  18872. import { Camera } from "babylonjs/Cameras/camera";
  18873. import { Scene } from "babylonjs/scene";
  18874. import { Quaternion, Matrix, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  18875. /**
  18876. * A target camera takes a mesh or position as a target and continues to look at it while it moves.
  18877. * This is the base of the follow, arc rotate cameras and Free camera
  18878. * @see https://doc.babylonjs.com/features/cameras
  18879. */
  18880. export class TargetCamera extends Camera {
  18881. private static _RigCamTransformMatrix;
  18882. private static _TargetTransformMatrix;
  18883. private static _TargetFocalPoint;
  18884. private _tmpUpVector;
  18885. private _tmpTargetVector;
  18886. /**
  18887. * Define the current direction the camera is moving to
  18888. */
  18889. cameraDirection: Vector3;
  18890. /**
  18891. * Define the current rotation the camera is rotating to
  18892. */
  18893. cameraRotation: Vector2;
  18894. /** Gets or sets a boolean indicating that the scaling of the parent hierarchy will not be taken in account by the camera */
  18895. ignoreParentScaling: boolean;
  18896. /**
  18897. * When set, the up vector of the camera will be updated by the rotation of the camera
  18898. */
  18899. updateUpVectorFromRotation: boolean;
  18900. private _tmpQuaternion;
  18901. /**
  18902. * Define the current rotation of the camera
  18903. */
  18904. rotation: Vector3;
  18905. /**
  18906. * Define the current rotation of the camera as a quaternion to prevent Gimbal lock
  18907. */
  18908. rotationQuaternion: Quaternion;
  18909. /**
  18910. * Define the current speed of the camera
  18911. */
  18912. speed: number;
  18913. /**
  18914. * Add constraint to the camera to prevent it to move freely in all directions and
  18915. * around all axis.
  18916. */
  18917. noRotationConstraint: boolean;
  18918. /**
  18919. * Reverses mouselook direction to 'natural' panning as opposed to traditional direct
  18920. * panning
  18921. */
  18922. invertRotation: boolean;
  18923. /**
  18924. * Speed multiplier for inverse camera panning
  18925. */
  18926. inverseRotationSpeed: number;
  18927. /**
  18928. * Define the current target of the camera as an object or a position.
  18929. */
  18930. lockedTarget: any;
  18931. /** @hidden */
  18932. _currentTarget: Vector3;
  18933. /** @hidden */
  18934. _initialFocalDistance: number;
  18935. /** @hidden */
  18936. _viewMatrix: Matrix;
  18937. /** @hidden */
  18938. _camMatrix: Matrix;
  18939. /** @hidden */
  18940. _cameraTransformMatrix: Matrix;
  18941. /** @hidden */
  18942. _cameraRotationMatrix: Matrix;
  18943. /** @hidden */
  18944. _referencePoint: Vector3;
  18945. /** @hidden */
  18946. _transformedReferencePoint: Vector3;
  18947. /** @hidden */
  18948. _reset: () => void;
  18949. private _defaultUp;
  18950. /**
  18951. * Instantiates a target camera that takes a mesh or position as a target and continues to look at it while it moves.
  18952. * This is the base of the follow, arc rotate cameras and Free camera
  18953. * @see https://doc.babylonjs.com/features/cameras
  18954. * @param name Defines the name of the camera in the scene
  18955. * @param position Defines the start position of the camera in the scene
  18956. * @param scene Defines the scene the camera belongs to
  18957. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  18958. */
  18959. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  18960. /**
  18961. * Gets the position in front of the camera at a given distance.
  18962. * @param distance The distance from the camera we want the position to be
  18963. * @returns the position
  18964. */
  18965. getFrontPosition(distance: number): Vector3;
  18966. /** @hidden */
  18967. _getLockedTargetPosition(): Nullable<Vector3>;
  18968. private _storedPosition;
  18969. private _storedRotation;
  18970. private _storedRotationQuaternion;
  18971. /**
  18972. * Store current camera state of the camera (fov, position, rotation, etc..)
  18973. * @returns the camera
  18974. */
  18975. storeState(): Camera;
  18976. /**
  18977. * Restored camera state. You must call storeState() first
  18978. * @returns whether it was successful or not
  18979. * @hidden
  18980. */
  18981. _restoreStateValues(): boolean;
  18982. /** @hidden */
  18983. _initCache(): void;
  18984. /** @hidden */
  18985. _updateCache(ignoreParentClass?: boolean): void;
  18986. /** @hidden */
  18987. _isSynchronizedViewMatrix(): boolean;
  18988. /** @hidden */
  18989. _computeLocalCameraSpeed(): number;
  18990. /**
  18991. * Defines the target the camera should look at.
  18992. * @param target Defines the new target as a Vector or a mesh
  18993. */
  18994. setTarget(target: Vector3): void;
  18995. /**
  18996. * Defines the target point of the camera.
  18997. * The camera looks towards it form the radius distance.
  18998. */
  18999. get target(): Vector3;
  19000. set target(value: Vector3);
  19001. /**
  19002. * Return the current target position of the camera. This value is expressed in local space.
  19003. * @returns the target position
  19004. */
  19005. getTarget(): Vector3;
  19006. /** @hidden */
  19007. _decideIfNeedsToMove(): boolean;
  19008. /** @hidden */
  19009. _updatePosition(): void;
  19010. /** @hidden */
  19011. _checkInputs(): void;
  19012. protected _updateCameraRotationMatrix(): void;
  19013. /**
  19014. * Update the up vector to apply the rotation of the camera (So if you changed the camera rotation.z this will let you update the up vector as well)
  19015. * @returns the current camera
  19016. */
  19017. private _rotateUpVectorWithCameraRotationMatrix;
  19018. private _cachedRotationZ;
  19019. private _cachedQuaternionRotationZ;
  19020. /** @hidden */
  19021. _getViewMatrix(): Matrix;
  19022. protected _computeViewMatrix(position: Vector3, target: Vector3, up: Vector3): void;
  19023. /**
  19024. * @hidden
  19025. */
  19026. createRigCamera(name: string, cameraIndex: number): Nullable<Camera>;
  19027. /**
  19028. * @hidden
  19029. */
  19030. _updateRigCameras(): void;
  19031. private _getRigCamPositionAndTarget;
  19032. /**
  19033. * Gets the current object class name.
  19034. * @return the class name
  19035. */
  19036. getClassName(): string;
  19037. }
  19038. }
  19039. declare module "babylonjs/Events/keyboardEvents" {
  19040. /**
  19041. * Gather the list of keyboard event types as constants.
  19042. */
  19043. export class KeyboardEventTypes {
  19044. /**
  19045. * The keydown event is fired when a key becomes active (pressed).
  19046. */
  19047. static readonly KEYDOWN: number;
  19048. /**
  19049. * The keyup event is fired when a key has been released.
  19050. */
  19051. static readonly KEYUP: number;
  19052. }
  19053. /**
  19054. * This class is used to store keyboard related info for the onKeyboardObservable event.
  19055. */
  19056. export class KeyboardInfo {
  19057. /**
  19058. * Defines the type of event (KeyboardEventTypes)
  19059. */
  19060. type: number;
  19061. /**
  19062. * Defines the related dom event
  19063. */
  19064. event: KeyboardEvent;
  19065. /**
  19066. * Instantiates a new keyboard info.
  19067. * This class is used to store keyboard related info for the onKeyboardObservable event.
  19068. * @param type Defines the type of event (KeyboardEventTypes)
  19069. * @param event Defines the related dom event
  19070. */
  19071. constructor(
  19072. /**
  19073. * Defines the type of event (KeyboardEventTypes)
  19074. */
  19075. type: number,
  19076. /**
  19077. * Defines the related dom event
  19078. */
  19079. event: KeyboardEvent);
  19080. }
  19081. /**
  19082. * This class is used to store keyboard related info for the onPreKeyboardObservable event.
  19083. * Set the skipOnKeyboardObservable property to true if you want the engine to stop any process after this event is triggered, even not calling onKeyboardObservable
  19084. */
  19085. export class KeyboardInfoPre extends KeyboardInfo {
  19086. /**
  19087. * Defines the type of event (KeyboardEventTypes)
  19088. */
  19089. type: number;
  19090. /**
  19091. * Defines the related dom event
  19092. */
  19093. event: KeyboardEvent;
  19094. /**
  19095. * Defines whether the engine should skip the next onKeyboardObservable associated to this pre.
  19096. */
  19097. skipOnPointerObservable: boolean;
  19098. /**
  19099. * Instantiates a new keyboard pre info.
  19100. * This class is used to store keyboard related info for the onPreKeyboardObservable event.
  19101. * @param type Defines the type of event (KeyboardEventTypes)
  19102. * @param event Defines the related dom event
  19103. */
  19104. constructor(
  19105. /**
  19106. * Defines the type of event (KeyboardEventTypes)
  19107. */
  19108. type: number,
  19109. /**
  19110. * Defines the related dom event
  19111. */
  19112. event: KeyboardEvent);
  19113. }
  19114. }
  19115. declare module "babylonjs/Cameras/Inputs/freeCameraKeyboardMoveInput" {
  19116. import { Nullable } from "babylonjs/types";
  19117. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  19118. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  19119. /**
  19120. * Manage the keyboard inputs to control the movement of a free camera.
  19121. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  19122. */
  19123. export class FreeCameraKeyboardMoveInput implements ICameraInput<FreeCamera> {
  19124. /**
  19125. * Defines the camera the input is attached to.
  19126. */
  19127. camera: FreeCamera;
  19128. /**
  19129. * Gets or Set the list of keyboard keys used to control the forward move of the camera.
  19130. */
  19131. keysUp: number[];
  19132. /**
  19133. * Gets or Set the list of keyboard keys used to control the upward move of the camera.
  19134. */
  19135. keysUpward: number[];
  19136. /**
  19137. * Gets or Set the list of keyboard keys used to control the backward move of the camera.
  19138. */
  19139. keysDown: number[];
  19140. /**
  19141. * Gets or Set the list of keyboard keys used to control the downward move of the camera.
  19142. */
  19143. keysDownward: number[];
  19144. /**
  19145. * Gets or Set the list of keyboard keys used to control the left strafe move of the camera.
  19146. */
  19147. keysLeft: number[];
  19148. /**
  19149. * Gets or Set the list of keyboard keys used to control the right strafe move of the camera.
  19150. */
  19151. keysRight: number[];
  19152. private _keys;
  19153. private _onCanvasBlurObserver;
  19154. private _onKeyboardObserver;
  19155. private _engine;
  19156. private _scene;
  19157. /**
  19158. * Attach the input controls to a specific dom element to get the input from.
  19159. * @param element Defines the element the controls should be listened from
  19160. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  19161. */
  19162. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  19163. /**
  19164. * Detach the current controls from the specified dom element.
  19165. * @param element Defines the element to stop listening the inputs from
  19166. */
  19167. detachControl(element: Nullable<HTMLElement>): void;
  19168. /**
  19169. * Update the current camera state depending on the inputs that have been used this frame.
  19170. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  19171. */
  19172. checkInputs(): void;
  19173. /**
  19174. * Gets the class name of the current intput.
  19175. * @returns the class name
  19176. */
  19177. getClassName(): string;
  19178. /** @hidden */
  19179. _onLostFocus(): void;
  19180. /**
  19181. * Get the friendly name associated with the input class.
  19182. * @returns the input friendly name
  19183. */
  19184. getSimpleName(): string;
  19185. }
  19186. }
  19187. declare module "babylonjs/Events/pointerEvents" {
  19188. import { Nullable } from "babylonjs/types";
  19189. import { Vector2 } from "babylonjs/Maths/math.vector";
  19190. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  19191. import { Ray } from "babylonjs/Culling/ray";
  19192. /**
  19193. * Gather the list of pointer event types as constants.
  19194. */
  19195. export class PointerEventTypes {
  19196. /**
  19197. * The pointerdown event is fired when a pointer becomes active. For mouse, it is fired when the device transitions from no buttons depressed to at least one button depressed. For touch, it is fired when physical contact is made with the digitizer. For pen, it is fired when the stylus makes physical contact with the digitizer.
  19198. */
  19199. static readonly POINTERDOWN: number;
  19200. /**
  19201. * The pointerup event is fired when a pointer is no longer active.
  19202. */
  19203. static readonly POINTERUP: number;
  19204. /**
  19205. * The pointermove event is fired when a pointer changes coordinates.
  19206. */
  19207. static readonly POINTERMOVE: number;
  19208. /**
  19209. * The pointerwheel event is fired when a mouse wheel has been rotated.
  19210. */
  19211. static readonly POINTERWHEEL: number;
  19212. /**
  19213. * The pointerpick event is fired when a mesh or sprite has been picked by the pointer.
  19214. */
  19215. static readonly POINTERPICK: number;
  19216. /**
  19217. * The pointertap event is fired when a the object has been touched and released without drag.
  19218. */
  19219. static readonly POINTERTAP: number;
  19220. /**
  19221. * The pointerdoubletap event is fired when a the object has been touched and released twice without drag.
  19222. */
  19223. static readonly POINTERDOUBLETAP: number;
  19224. }
  19225. /**
  19226. * Base class of pointer info types.
  19227. */
  19228. export class PointerInfoBase {
  19229. /**
  19230. * Defines the type of event (PointerEventTypes)
  19231. */
  19232. type: number;
  19233. /**
  19234. * Defines the related dom event
  19235. */
  19236. event: PointerEvent | MouseWheelEvent;
  19237. /**
  19238. * Instantiates the base class of pointers info.
  19239. * @param type Defines the type of event (PointerEventTypes)
  19240. * @param event Defines the related dom event
  19241. */
  19242. constructor(
  19243. /**
  19244. * Defines the type of event (PointerEventTypes)
  19245. */
  19246. type: number,
  19247. /**
  19248. * Defines the related dom event
  19249. */
  19250. event: PointerEvent | MouseWheelEvent);
  19251. }
  19252. /**
  19253. * This class is used to store pointer related info for the onPrePointerObservable event.
  19254. * Set the skipOnPointerObservable property to true if you want the engine to stop any process after this event is triggered, even not calling onPointerObservable
  19255. */
  19256. export class PointerInfoPre extends PointerInfoBase {
  19257. /**
  19258. * Ray from a pointer if availible (eg. 6dof controller)
  19259. */
  19260. ray: Nullable<Ray>;
  19261. /**
  19262. * Defines the local position of the pointer on the canvas.
  19263. */
  19264. localPosition: Vector2;
  19265. /**
  19266. * Defines whether the engine should skip the next OnPointerObservable associated to this pre.
  19267. */
  19268. skipOnPointerObservable: boolean;
  19269. /**
  19270. * Instantiates a PointerInfoPre to store pointer related info to the onPrePointerObservable event.
  19271. * @param type Defines the type of event (PointerEventTypes)
  19272. * @param event Defines the related dom event
  19273. * @param localX Defines the local x coordinates of the pointer when the event occured
  19274. * @param localY Defines the local y coordinates of the pointer when the event occured
  19275. */
  19276. constructor(type: number, event: PointerEvent | MouseWheelEvent, localX: number, localY: number);
  19277. }
  19278. /**
  19279. * This type contains all the data related to a pointer event in Babylon.js.
  19280. * The event member is an instance of PointerEvent for all types except PointerWheel and is of type MouseWheelEvent when type equals PointerWheel. The different event types can be found in the PointerEventTypes class.
  19281. */
  19282. export class PointerInfo extends PointerInfoBase {
  19283. /**
  19284. * Defines the picking info associated to the info (if any)\
  19285. */
  19286. pickInfo: Nullable<PickingInfo>;
  19287. /**
  19288. * Instantiates a PointerInfo to store pointer related info to the onPointerObservable event.
  19289. * @param type Defines the type of event (PointerEventTypes)
  19290. * @param event Defines the related dom event
  19291. * @param pickInfo Defines the picking info associated to the info (if any)\
  19292. */
  19293. constructor(type: number, event: PointerEvent | MouseWheelEvent,
  19294. /**
  19295. * Defines the picking info associated to the info (if any)\
  19296. */
  19297. pickInfo: Nullable<PickingInfo>);
  19298. }
  19299. /**
  19300. * Data relating to a touch event on the screen.
  19301. */
  19302. export interface PointerTouch {
  19303. /**
  19304. * X coordinate of touch.
  19305. */
  19306. x: number;
  19307. /**
  19308. * Y coordinate of touch.
  19309. */
  19310. y: number;
  19311. /**
  19312. * Id of touch. Unique for each finger.
  19313. */
  19314. pointerId: number;
  19315. /**
  19316. * Event type passed from DOM.
  19317. */
  19318. type: any;
  19319. }
  19320. }
  19321. declare module "babylonjs/Cameras/Inputs/freeCameraMouseInput" {
  19322. import { Observable } from "babylonjs/Misc/observable";
  19323. import { Nullable } from "babylonjs/types";
  19324. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  19325. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  19326. /**
  19327. * Manage the mouse inputs to control the movement of a free camera.
  19328. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  19329. */
  19330. export class FreeCameraMouseInput implements ICameraInput<FreeCamera> {
  19331. /**
  19332. * Define if touch is enabled in the mouse input
  19333. */
  19334. touchEnabled: boolean;
  19335. /**
  19336. * Defines the camera the input is attached to.
  19337. */
  19338. camera: FreeCamera;
  19339. /**
  19340. * Defines the buttons associated with the input to handle camera move.
  19341. */
  19342. buttons: number[];
  19343. /**
  19344. * Defines the pointer angular sensibility along the X and Y axis or how fast is the camera rotating.
  19345. */
  19346. angularSensibility: number;
  19347. private _pointerInput;
  19348. private _onMouseMove;
  19349. private _observer;
  19350. private previousPosition;
  19351. /**
  19352. * Observable for when a pointer move event occurs containing the move offset
  19353. */
  19354. onPointerMovedObservable: Observable<{
  19355. offsetX: number;
  19356. offsetY: number;
  19357. }>;
  19358. /**
  19359. * @hidden
  19360. * If the camera should be rotated automatically based on pointer movement
  19361. */
  19362. _allowCameraRotation: boolean;
  19363. /**
  19364. * Manage the mouse inputs to control the movement of a free camera.
  19365. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  19366. * @param touchEnabled Defines if touch is enabled or not
  19367. */
  19368. constructor(
  19369. /**
  19370. * Define if touch is enabled in the mouse input
  19371. */
  19372. touchEnabled?: boolean);
  19373. /**
  19374. * Attach the input controls to a specific dom element to get the input from.
  19375. * @param element Defines the element the controls should be listened from
  19376. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  19377. */
  19378. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  19379. /**
  19380. * Called on JS contextmenu event.
  19381. * Override this method to provide functionality.
  19382. */
  19383. protected onContextMenu(evt: PointerEvent): void;
  19384. /**
  19385. * Detach the current controls from the specified dom element.
  19386. * @param element Defines the element to stop listening the inputs from
  19387. */
  19388. detachControl(element: Nullable<HTMLElement>): void;
  19389. /**
  19390. * Gets the class name of the current intput.
  19391. * @returns the class name
  19392. */
  19393. getClassName(): string;
  19394. /**
  19395. * Get the friendly name associated with the input class.
  19396. * @returns the input friendly name
  19397. */
  19398. getSimpleName(): string;
  19399. }
  19400. }
  19401. declare module "babylonjs/Cameras/Inputs/freeCameraTouchInput" {
  19402. import { Nullable } from "babylonjs/types";
  19403. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  19404. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  19405. /**
  19406. * Manage the touch inputs to control the movement of a free camera.
  19407. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  19408. */
  19409. export class FreeCameraTouchInput implements ICameraInput<FreeCamera> {
  19410. /**
  19411. * Define if mouse events can be treated as touch events
  19412. */
  19413. allowMouse: boolean;
  19414. /**
  19415. * Defines the camera the input is attached to.
  19416. */
  19417. camera: FreeCamera;
  19418. /**
  19419. * Defines the touch sensibility for rotation.
  19420. * The higher the faster.
  19421. */
  19422. touchAngularSensibility: number;
  19423. /**
  19424. * Defines the touch sensibility for move.
  19425. * The higher the faster.
  19426. */
  19427. touchMoveSensibility: number;
  19428. private _offsetX;
  19429. private _offsetY;
  19430. private _pointerPressed;
  19431. private _pointerInput;
  19432. private _observer;
  19433. private _onLostFocus;
  19434. /**
  19435. * Manage the touch inputs to control the movement of a free camera.
  19436. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  19437. * @param allowMouse Defines if mouse events can be treated as touch events
  19438. */
  19439. constructor(
  19440. /**
  19441. * Define if mouse events can be treated as touch events
  19442. */
  19443. allowMouse?: boolean);
  19444. /**
  19445. * Attach the input controls to a specific dom element to get the input from.
  19446. * @param element Defines the element the controls should be listened from
  19447. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  19448. */
  19449. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  19450. /**
  19451. * Detach the current controls from the specified dom element.
  19452. * @param element Defines the element to stop listening the inputs from
  19453. */
  19454. detachControl(element: Nullable<HTMLElement>): void;
  19455. /**
  19456. * Update the current camera state depending on the inputs that have been used this frame.
  19457. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  19458. */
  19459. checkInputs(): void;
  19460. /**
  19461. * Gets the class name of the current intput.
  19462. * @returns the class name
  19463. */
  19464. getClassName(): string;
  19465. /**
  19466. * Get the friendly name associated with the input class.
  19467. * @returns the input friendly name
  19468. */
  19469. getSimpleName(): string;
  19470. }
  19471. }
  19472. declare module "babylonjs/Cameras/freeCameraInputsManager" {
  19473. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  19474. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  19475. import { FreeCameraMouseInput } from "babylonjs/Cameras/Inputs/freeCameraMouseInput";
  19476. import { Nullable } from "babylonjs/types";
  19477. /**
  19478. * Default Inputs manager for the FreeCamera.
  19479. * It groups all the default supported inputs for ease of use.
  19480. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  19481. */
  19482. export class FreeCameraInputsManager extends CameraInputsManager<FreeCamera> {
  19483. /**
  19484. * @hidden
  19485. */
  19486. _mouseInput: Nullable<FreeCameraMouseInput>;
  19487. /**
  19488. * Instantiates a new FreeCameraInputsManager.
  19489. * @param camera Defines the camera the inputs belong to
  19490. */
  19491. constructor(camera: FreeCamera);
  19492. /**
  19493. * Add keyboard input support to the input manager.
  19494. * @returns the current input manager
  19495. */
  19496. addKeyboard(): FreeCameraInputsManager;
  19497. /**
  19498. * Add mouse input support to the input manager.
  19499. * @param touchEnabled if the FreeCameraMouseInput should support touch (default: true)
  19500. * @returns the current input manager
  19501. */
  19502. addMouse(touchEnabled?: boolean): FreeCameraInputsManager;
  19503. /**
  19504. * Removes the mouse input support from the manager
  19505. * @returns the current input manager
  19506. */
  19507. removeMouse(): FreeCameraInputsManager;
  19508. /**
  19509. * Add touch input support to the input manager.
  19510. * @returns the current input manager
  19511. */
  19512. addTouch(): FreeCameraInputsManager;
  19513. /**
  19514. * Remove all attached input methods from a camera
  19515. */
  19516. clear(): void;
  19517. }
  19518. }
  19519. declare module "babylonjs/Cameras/freeCamera" {
  19520. import { Vector3 } from "babylonjs/Maths/math.vector";
  19521. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  19522. import { Scene } from "babylonjs/scene";
  19523. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  19524. import { FreeCameraInputsManager } from "babylonjs/Cameras/freeCameraInputsManager";
  19525. /**
  19526. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  19527. * Please consider using the new UniversalCamera instead as it adds more functionality like the gamepad.
  19528. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  19529. */
  19530. export class FreeCamera extends TargetCamera {
  19531. /**
  19532. * Define the collision ellipsoid of the camera.
  19533. * This is helpful to simulate a camera body like the player body around the camera
  19534. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  19535. */
  19536. ellipsoid: Vector3;
  19537. /**
  19538. * Define an offset for the position of the ellipsoid around the camera.
  19539. * This can be helpful to determine the center of the body near the gravity center of the body
  19540. * instead of its head.
  19541. */
  19542. ellipsoidOffset: Vector3;
  19543. /**
  19544. * Enable or disable collisions of the camera with the rest of the scene objects.
  19545. */
  19546. checkCollisions: boolean;
  19547. /**
  19548. * Enable or disable gravity on the camera.
  19549. */
  19550. applyGravity: boolean;
  19551. /**
  19552. * Define the input manager associated to the camera.
  19553. */
  19554. inputs: FreeCameraInputsManager;
  19555. /**
  19556. * Gets the input sensibility for a mouse input. (default is 2000.0)
  19557. * Higher values reduce sensitivity.
  19558. */
  19559. get angularSensibility(): number;
  19560. /**
  19561. * Sets the input sensibility for a mouse input. (default is 2000.0)
  19562. * Higher values reduce sensitivity.
  19563. */
  19564. set angularSensibility(value: number);
  19565. /**
  19566. * Gets or Set the list of keyboard keys used to control the forward move of the camera.
  19567. */
  19568. get keysUp(): number[];
  19569. set keysUp(value: number[]);
  19570. /**
  19571. * Gets or Set the list of keyboard keys used to control the upward move of the camera.
  19572. */
  19573. get keysUpward(): number[];
  19574. set keysUpward(value: number[]);
  19575. /**
  19576. * Gets or Set the list of keyboard keys used to control the backward move of the camera.
  19577. */
  19578. get keysDown(): number[];
  19579. set keysDown(value: number[]);
  19580. /**
  19581. * Gets or Set the list of keyboard keys used to control the downward move of the camera.
  19582. */
  19583. get keysDownward(): number[];
  19584. set keysDownward(value: number[]);
  19585. /**
  19586. * Gets or Set the list of keyboard keys used to control the left strafe move of the camera.
  19587. */
  19588. get keysLeft(): number[];
  19589. set keysLeft(value: number[]);
  19590. /**
  19591. * Gets or Set the list of keyboard keys used to control the right strafe move of the camera.
  19592. */
  19593. get keysRight(): number[];
  19594. set keysRight(value: number[]);
  19595. /**
  19596. * Event raised when the camera collide with a mesh in the scene.
  19597. */
  19598. onCollide: (collidedMesh: AbstractMesh) => void;
  19599. private _collider;
  19600. private _needMoveForGravity;
  19601. private _oldPosition;
  19602. private _diffPosition;
  19603. private _newPosition;
  19604. /** @hidden */
  19605. _localDirection: Vector3;
  19606. /** @hidden */
  19607. _transformedDirection: Vector3;
  19608. /**
  19609. * Instantiates a Free Camera.
  19610. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  19611. * Please consider using the new UniversalCamera instead as it adds more functionality like touch to this camera.
  19612. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  19613. * @param name Define the name of the camera in the scene
  19614. * @param position Define the start position of the camera in the scene
  19615. * @param scene Define the scene the camera belongs to
  19616. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  19617. */
  19618. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  19619. /**
  19620. * Attached controls to the current camera.
  19621. * @param element Defines the element the controls should be listened from
  19622. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  19623. */
  19624. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  19625. /**
  19626. * Detach the current controls from the camera.
  19627. * The camera will stop reacting to inputs.
  19628. * @param element Defines the element to stop listening the inputs from
  19629. */
  19630. detachControl(element: HTMLElement): void;
  19631. private _collisionMask;
  19632. /**
  19633. * Define a collision mask to limit the list of object the camera can collide with
  19634. */
  19635. get collisionMask(): number;
  19636. set collisionMask(mask: number);
  19637. /** @hidden */
  19638. _collideWithWorld(displacement: Vector3): void;
  19639. private _onCollisionPositionChange;
  19640. /** @hidden */
  19641. _checkInputs(): void;
  19642. /** @hidden */
  19643. _decideIfNeedsToMove(): boolean;
  19644. /** @hidden */
  19645. _updatePosition(): void;
  19646. /**
  19647. * Destroy the camera and release the current resources hold by it.
  19648. */
  19649. dispose(): void;
  19650. /**
  19651. * Gets the current object class name.
  19652. * @return the class name
  19653. */
  19654. getClassName(): string;
  19655. }
  19656. }
  19657. declare module "babylonjs/Gamepads/gamepad" {
  19658. import { Observable } from "babylonjs/Misc/observable";
  19659. /**
  19660. * Represents a gamepad control stick position
  19661. */
  19662. export class StickValues {
  19663. /**
  19664. * The x component of the control stick
  19665. */
  19666. x: number;
  19667. /**
  19668. * The y component of the control stick
  19669. */
  19670. y: number;
  19671. /**
  19672. * Initializes the gamepad x and y control stick values
  19673. * @param x The x component of the gamepad control stick value
  19674. * @param y The y component of the gamepad control stick value
  19675. */
  19676. constructor(
  19677. /**
  19678. * The x component of the control stick
  19679. */
  19680. x: number,
  19681. /**
  19682. * The y component of the control stick
  19683. */
  19684. y: number);
  19685. }
  19686. /**
  19687. * An interface which manages callbacks for gamepad button changes
  19688. */
  19689. export interface GamepadButtonChanges {
  19690. /**
  19691. * Called when a gamepad has been changed
  19692. */
  19693. changed: boolean;
  19694. /**
  19695. * Called when a gamepad press event has been triggered
  19696. */
  19697. pressChanged: boolean;
  19698. /**
  19699. * Called when a touch event has been triggered
  19700. */
  19701. touchChanged: boolean;
  19702. /**
  19703. * Called when a value has changed
  19704. */
  19705. valueChanged: boolean;
  19706. }
  19707. /**
  19708. * Represents a gamepad
  19709. */
  19710. export class Gamepad {
  19711. /**
  19712. * The id of the gamepad
  19713. */
  19714. id: string;
  19715. /**
  19716. * The index of the gamepad
  19717. */
  19718. index: number;
  19719. /**
  19720. * The browser gamepad
  19721. */
  19722. browserGamepad: any;
  19723. /**
  19724. * Specifies what type of gamepad this represents
  19725. */
  19726. type: number;
  19727. private _leftStick;
  19728. private _rightStick;
  19729. /** @hidden */
  19730. _isConnected: boolean;
  19731. private _leftStickAxisX;
  19732. private _leftStickAxisY;
  19733. private _rightStickAxisX;
  19734. private _rightStickAxisY;
  19735. /**
  19736. * Triggered when the left control stick has been changed
  19737. */
  19738. private _onleftstickchanged;
  19739. /**
  19740. * Triggered when the right control stick has been changed
  19741. */
  19742. private _onrightstickchanged;
  19743. /**
  19744. * Represents a gamepad controller
  19745. */
  19746. static GAMEPAD: number;
  19747. /**
  19748. * Represents a generic controller
  19749. */
  19750. static GENERIC: number;
  19751. /**
  19752. * Represents an XBox controller
  19753. */
  19754. static XBOX: number;
  19755. /**
  19756. * Represents a pose-enabled controller
  19757. */
  19758. static POSE_ENABLED: number;
  19759. /**
  19760. * Represents an Dual Shock controller
  19761. */
  19762. static DUALSHOCK: number;
  19763. /**
  19764. * Specifies whether the left control stick should be Y-inverted
  19765. */
  19766. protected _invertLeftStickY: boolean;
  19767. /**
  19768. * Specifies if the gamepad has been connected
  19769. */
  19770. get isConnected(): boolean;
  19771. /**
  19772. * Initializes the gamepad
  19773. * @param id The id of the gamepad
  19774. * @param index The index of the gamepad
  19775. * @param browserGamepad The browser gamepad
  19776. * @param leftStickX The x component of the left joystick
  19777. * @param leftStickY The y component of the left joystick
  19778. * @param rightStickX The x component of the right joystick
  19779. * @param rightStickY The y component of the right joystick
  19780. */
  19781. constructor(
  19782. /**
  19783. * The id of the gamepad
  19784. */
  19785. id: string,
  19786. /**
  19787. * The index of the gamepad
  19788. */
  19789. index: number,
  19790. /**
  19791. * The browser gamepad
  19792. */
  19793. browserGamepad: any, leftStickX?: number, leftStickY?: number, rightStickX?: number, rightStickY?: number);
  19794. /**
  19795. * Callback triggered when the left joystick has changed
  19796. * @param callback
  19797. */
  19798. onleftstickchanged(callback: (values: StickValues) => void): void;
  19799. /**
  19800. * Callback triggered when the right joystick has changed
  19801. * @param callback
  19802. */
  19803. onrightstickchanged(callback: (values: StickValues) => void): void;
  19804. /**
  19805. * Gets the left joystick
  19806. */
  19807. get leftStick(): StickValues;
  19808. /**
  19809. * Sets the left joystick values
  19810. */
  19811. set leftStick(newValues: StickValues);
  19812. /**
  19813. * Gets the right joystick
  19814. */
  19815. get rightStick(): StickValues;
  19816. /**
  19817. * Sets the right joystick value
  19818. */
  19819. set rightStick(newValues: StickValues);
  19820. /**
  19821. * Updates the gamepad joystick positions
  19822. */
  19823. update(): void;
  19824. /**
  19825. * Disposes the gamepad
  19826. */
  19827. dispose(): void;
  19828. }
  19829. /**
  19830. * Represents a generic gamepad
  19831. */
  19832. export class GenericPad extends Gamepad {
  19833. private _buttons;
  19834. private _onbuttondown;
  19835. private _onbuttonup;
  19836. /**
  19837. * Observable triggered when a button has been pressed
  19838. */
  19839. onButtonDownObservable: Observable<number>;
  19840. /**
  19841. * Observable triggered when a button has been released
  19842. */
  19843. onButtonUpObservable: Observable<number>;
  19844. /**
  19845. * Callback triggered when a button has been pressed
  19846. * @param callback Called when a button has been pressed
  19847. */
  19848. onbuttondown(callback: (buttonPressed: number) => void): void;
  19849. /**
  19850. * Callback triggered when a button has been released
  19851. * @param callback Called when a button has been released
  19852. */
  19853. onbuttonup(callback: (buttonReleased: number) => void): void;
  19854. /**
  19855. * Initializes the generic gamepad
  19856. * @param id The id of the generic gamepad
  19857. * @param index The index of the generic gamepad
  19858. * @param browserGamepad The browser gamepad
  19859. */
  19860. constructor(id: string, index: number, browserGamepad: any);
  19861. private _setButtonValue;
  19862. /**
  19863. * Updates the generic gamepad
  19864. */
  19865. update(): void;
  19866. /**
  19867. * Disposes the generic gamepad
  19868. */
  19869. dispose(): void;
  19870. }
  19871. }
  19872. declare module "babylonjs/Gamepads/Controllers/poseEnabledController" {
  19873. import { Observable } from "babylonjs/Misc/observable";
  19874. import { Nullable } from "babylonjs/types";
  19875. import { Quaternion, Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  19876. import { TransformNode } from "babylonjs/Meshes/transformNode";
  19877. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  19878. import { Ray } from "babylonjs/Culling/ray";
  19879. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  19880. import { PoseControlled, DevicePose } from "babylonjs/Cameras/VR/webVRCamera";
  19881. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  19882. /**
  19883. * Defines the types of pose enabled controllers that are supported
  19884. */
  19885. export enum PoseEnabledControllerType {
  19886. /**
  19887. * HTC Vive
  19888. */
  19889. VIVE = 0,
  19890. /**
  19891. * Oculus Rift
  19892. */
  19893. OCULUS = 1,
  19894. /**
  19895. * Windows mixed reality
  19896. */
  19897. WINDOWS = 2,
  19898. /**
  19899. * Samsung gear VR
  19900. */
  19901. GEAR_VR = 3,
  19902. /**
  19903. * Google Daydream
  19904. */
  19905. DAYDREAM = 4,
  19906. /**
  19907. * Generic
  19908. */
  19909. GENERIC = 5
  19910. }
  19911. /**
  19912. * Defines the MutableGamepadButton interface for the state of a gamepad button
  19913. */
  19914. export interface MutableGamepadButton {
  19915. /**
  19916. * Value of the button/trigger
  19917. */
  19918. value: number;
  19919. /**
  19920. * If the button/trigger is currently touched
  19921. */
  19922. touched: boolean;
  19923. /**
  19924. * If the button/trigger is currently pressed
  19925. */
  19926. pressed: boolean;
  19927. }
  19928. /**
  19929. * Defines the ExtendedGamepadButton interface for a gamepad button which includes state provided by a pose controller
  19930. * @hidden
  19931. */
  19932. export interface ExtendedGamepadButton extends GamepadButton {
  19933. /**
  19934. * If the button/trigger is currently pressed
  19935. */
  19936. readonly pressed: boolean;
  19937. /**
  19938. * If the button/trigger is currently touched
  19939. */
  19940. readonly touched: boolean;
  19941. /**
  19942. * Value of the button/trigger
  19943. */
  19944. readonly value: number;
  19945. }
  19946. /** @hidden */
  19947. export interface _GamePadFactory {
  19948. /**
  19949. * Returns whether or not the current gamepad can be created for this type of controller.
  19950. * @param gamepadInfo Defines the gamepad info as received from the controller APIs.
  19951. * @returns true if it can be created, otherwise false
  19952. */
  19953. canCreate(gamepadInfo: any): boolean;
  19954. /**
  19955. * Creates a new instance of the Gamepad.
  19956. * @param gamepadInfo Defines the gamepad info as received from the controller APIs.
  19957. * @returns the new gamepad instance
  19958. */
  19959. create(gamepadInfo: any): Gamepad;
  19960. }
  19961. /**
  19962. * Defines the PoseEnabledControllerHelper object that is used initialize a gamepad as the controller type it is specified as (eg. windows mixed reality controller)
  19963. */
  19964. export class PoseEnabledControllerHelper {
  19965. /** @hidden */
  19966. static _ControllerFactories: _GamePadFactory[];
  19967. /** @hidden */
  19968. static _DefaultControllerFactory: Nullable<(gamepadInfo: any) => Gamepad>;
  19969. /**
  19970. * Initializes a gamepad as the controller type it is specified as (eg. windows mixed reality controller)
  19971. * @param vrGamepad the gamepad to initialized
  19972. * @returns a vr controller of the type the gamepad identified as
  19973. */
  19974. static InitiateController(vrGamepad: any): Gamepad;
  19975. }
  19976. /**
  19977. * Defines the PoseEnabledController object that contains state of a vr capable controller
  19978. */
  19979. export class PoseEnabledController extends Gamepad implements PoseControlled {
  19980. /**
  19981. * If the controller is used in a webXR session
  19982. */
  19983. isXR: boolean;
  19984. private _deviceRoomPosition;
  19985. private _deviceRoomRotationQuaternion;
  19986. /**
  19987. * The device position in babylon space
  19988. */
  19989. devicePosition: Vector3;
  19990. /**
  19991. * The device rotation in babylon space
  19992. */
  19993. deviceRotationQuaternion: Quaternion;
  19994. /**
  19995. * The scale factor of the device in babylon space
  19996. */
  19997. deviceScaleFactor: number;
  19998. /**
  19999. * (Likely devicePosition should be used instead) The device position in its room space
  20000. */
  20001. position: Vector3;
  20002. /**
  20003. * (Likely deviceRotationQuaternion should be used instead) The device rotation in its room space
  20004. */
  20005. rotationQuaternion: Quaternion;
  20006. /**
  20007. * The type of controller (Eg. Windows mixed reality)
  20008. */
  20009. controllerType: PoseEnabledControllerType;
  20010. protected _calculatedPosition: Vector3;
  20011. private _calculatedRotation;
  20012. /**
  20013. * The raw pose from the device
  20014. */
  20015. rawPose: DevicePose;
  20016. private _trackPosition;
  20017. private _maxRotationDistFromHeadset;
  20018. private _draggedRoomRotation;
  20019. /**
  20020. * @hidden
  20021. */
  20022. _disableTrackPosition(fixedPosition: Vector3): void;
  20023. /**
  20024. * Internal, the mesh attached to the controller
  20025. * @hidden
  20026. */
  20027. _mesh: Nullable<AbstractMesh>;
  20028. private _poseControlledCamera;
  20029. private _leftHandSystemQuaternion;
  20030. /**
  20031. * Internal, matrix used to convert room space to babylon space
  20032. * @hidden
  20033. */
  20034. _deviceToWorld: Matrix;
  20035. /**
  20036. * Node to be used when casting a ray from the controller
  20037. * @hidden
  20038. */
  20039. _pointingPoseNode: Nullable<TransformNode>;
  20040. /**
  20041. * Name of the child mesh that can be used to cast a ray from the controller
  20042. */
  20043. static readonly POINTING_POSE: string;
  20044. /**
  20045. * Creates a new PoseEnabledController from a gamepad
  20046. * @param browserGamepad the gamepad that the PoseEnabledController should be created from
  20047. */
  20048. constructor(browserGamepad: any);
  20049. private _workingMatrix;
  20050. /**
  20051. * Updates the state of the pose enbaled controller and mesh based on the current position and rotation of the controller
  20052. */
  20053. update(): void;
  20054. /**
  20055. * Updates only the pose device and mesh without doing any button event checking
  20056. */
  20057. protected _updatePoseAndMesh(): void;
  20058. /**
  20059. * Updates the state of the pose enbaled controller based on the raw pose data from the device
  20060. * @param poseData raw pose fromthe device
  20061. */
  20062. updateFromDevice(poseData: DevicePose): void;
  20063. /**
  20064. * @hidden
  20065. */
  20066. _meshAttachedObservable: Observable<AbstractMesh>;
  20067. /**
  20068. * Attaches a mesh to the controller
  20069. * @param mesh the mesh to be attached
  20070. */
  20071. attachToMesh(mesh: AbstractMesh): void;
  20072. /**
  20073. * Attaches the controllers mesh to a camera
  20074. * @param camera the camera the mesh should be attached to
  20075. */
  20076. attachToPoseControlledCamera(camera: TargetCamera): void;
  20077. /**
  20078. * Disposes of the controller
  20079. */
  20080. dispose(): void;
  20081. /**
  20082. * The mesh that is attached to the controller
  20083. */
  20084. get mesh(): Nullable<AbstractMesh>;
  20085. /**
  20086. * Gets the ray of the controller in the direction the controller is pointing
  20087. * @param length the length the resulting ray should be
  20088. * @returns a ray in the direction the controller is pointing
  20089. */
  20090. getForwardRay(length?: number): Ray;
  20091. }
  20092. }
  20093. declare module "babylonjs/Gamepads/Controllers/webVRController" {
  20094. import { Observable } from "babylonjs/Misc/observable";
  20095. import { Scene } from "babylonjs/scene";
  20096. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  20097. import { PoseEnabledController, ExtendedGamepadButton, MutableGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  20098. import { StickValues, GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  20099. import { Nullable } from "babylonjs/types";
  20100. /**
  20101. * Defines the WebVRController object that represents controllers tracked in 3D space
  20102. */
  20103. export abstract class WebVRController extends PoseEnabledController {
  20104. /**
  20105. * Internal, the default controller model for the controller
  20106. */
  20107. protected _defaultModel: Nullable<AbstractMesh>;
  20108. /**
  20109. * Fired when the trigger state has changed
  20110. */
  20111. onTriggerStateChangedObservable: Observable<ExtendedGamepadButton>;
  20112. /**
  20113. * Fired when the main button state has changed
  20114. */
  20115. onMainButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  20116. /**
  20117. * Fired when the secondary button state has changed
  20118. */
  20119. onSecondaryButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  20120. /**
  20121. * Fired when the pad state has changed
  20122. */
  20123. onPadStateChangedObservable: Observable<ExtendedGamepadButton>;
  20124. /**
  20125. * Fired when controllers stick values have changed
  20126. */
  20127. onPadValuesChangedObservable: Observable<StickValues>;
  20128. /**
  20129. * Array of button availible on the controller
  20130. */
  20131. protected _buttons: Array<MutableGamepadButton>;
  20132. private _onButtonStateChange;
  20133. /**
  20134. * Fired when a controller button's state has changed
  20135. * @param callback the callback containing the button that was modified
  20136. */
  20137. onButtonStateChange(callback: (controlledIndex: number, buttonIndex: number, state: ExtendedGamepadButton) => void): void;
  20138. /**
  20139. * X and Y axis corresponding to the controllers joystick
  20140. */
  20141. pad: StickValues;
  20142. /**
  20143. * 'left' or 'right', see https://w3c.github.io/gamepad/extensions.html#gamepadhand-enum
  20144. */
  20145. hand: string;
  20146. /**
  20147. * The default controller model for the controller
  20148. */
  20149. get defaultModel(): Nullable<AbstractMesh>;
  20150. /**
  20151. * Creates a new WebVRController from a gamepad
  20152. * @param vrGamepad the gamepad that the WebVRController should be created from
  20153. */
  20154. constructor(vrGamepad: any);
  20155. /**
  20156. * Updates the state of the controller and mesh based on the current position and rotation of the controller
  20157. */
  20158. update(): void;
  20159. /**
  20160. * Function to be called when a button is modified
  20161. */
  20162. protected abstract _handleButtonChange(buttonIdx: number, value: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  20163. /**
  20164. * Loads a mesh and attaches it to the controller
  20165. * @param scene the scene the mesh should be added to
  20166. * @param meshLoaded callback for when the mesh has been loaded
  20167. */
  20168. abstract initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  20169. private _setButtonValue;
  20170. private _changes;
  20171. private _checkChanges;
  20172. /**
  20173. * Disposes of th webVRCOntroller
  20174. */
  20175. dispose(): void;
  20176. }
  20177. }
  20178. declare module "babylonjs/Lights/hemisphericLight" {
  20179. import { Nullable } from "babylonjs/types";
  20180. import { Scene } from "babylonjs/scene";
  20181. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  20182. import { Color3 } from "babylonjs/Maths/math.color";
  20183. import { Effect } from "babylonjs/Materials/effect";
  20184. import { Light } from "babylonjs/Lights/light";
  20185. import { IShadowGenerator } from "babylonjs/Lights/Shadows/shadowGenerator";
  20186. /**
  20187. * The HemisphericLight simulates the ambient environment light,
  20188. * so the passed direction is the light reflection direction, not the incoming direction.
  20189. */
  20190. export class HemisphericLight extends Light {
  20191. /**
  20192. * The groundColor is the light in the opposite direction to the one specified during creation.
  20193. * You can think of the diffuse and specular light as coming from the centre of the object in the given direction and the groundColor light in the opposite direction.
  20194. */
  20195. groundColor: Color3;
  20196. /**
  20197. * The light reflection direction, not the incoming direction.
  20198. */
  20199. direction: Vector3;
  20200. /**
  20201. * Creates a HemisphericLight object in the scene according to the passed direction (Vector3).
  20202. * The HemisphericLight simulates the ambient environment light, so the passed direction is the light reflection direction, not the incoming direction.
  20203. * The HemisphericLight can't cast shadows.
  20204. * Documentation : https://doc.babylonjs.com/babylon101/lights
  20205. * @param name The friendly name of the light
  20206. * @param direction The direction of the light reflection
  20207. * @param scene The scene the light belongs to
  20208. */
  20209. constructor(name: string, direction: Vector3, scene: Scene);
  20210. protected _buildUniformLayout(): void;
  20211. /**
  20212. * Returns the string "HemisphericLight".
  20213. * @return The class name
  20214. */
  20215. getClassName(): string;
  20216. /**
  20217. * Sets the HemisphericLight direction towards the passed target (Vector3).
  20218. * Returns the updated direction.
  20219. * @param target The target the direction should point to
  20220. * @return The computed direction
  20221. */
  20222. setDirectionToTarget(target: Vector3): Vector3;
  20223. /**
  20224. * Returns the shadow generator associated to the light.
  20225. * @returns Always null for hemispheric lights because it does not support shadows.
  20226. */
  20227. getShadowGenerator(): Nullable<IShadowGenerator>;
  20228. /**
  20229. * Sets the passed Effect object with the HemisphericLight normalized direction and color and the passed name (string).
  20230. * @param effect The effect to update
  20231. * @param lightIndex The index of the light in the effect to update
  20232. * @returns The hemispheric light
  20233. */
  20234. transferToEffect(effect: Effect, lightIndex: string): HemisphericLight;
  20235. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  20236. /**
  20237. * Computes the world matrix of the node
  20238. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  20239. * @param useWasUpdatedFlag defines a reserved property
  20240. * @returns the world matrix
  20241. */
  20242. computeWorldMatrix(): Matrix;
  20243. /**
  20244. * Returns the integer 3.
  20245. * @return The light Type id as a constant defines in Light.LIGHTTYPEID_x
  20246. */
  20247. getTypeID(): number;
  20248. /**
  20249. * Prepares the list of defines specific to the light type.
  20250. * @param defines the list of defines
  20251. * @param lightIndex defines the index of the light for the effect
  20252. */
  20253. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  20254. }
  20255. }
  20256. declare module "babylonjs/Shaders/vrMultiviewToSingleview.fragment" {
  20257. /** @hidden */
  20258. export var vrMultiviewToSingleviewPixelShader: {
  20259. name: string;
  20260. shader: string;
  20261. };
  20262. }
  20263. declare module "babylonjs/Materials/Textures/MultiviewRenderTarget" {
  20264. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  20265. import { Scene } from "babylonjs/scene";
  20266. /**
  20267. * Renders to multiple views with a single draw call
  20268. * @see https://www.khronos.org/registry/webgl/extensions/WEBGL_multiview/
  20269. */
  20270. export class MultiviewRenderTarget extends RenderTargetTexture {
  20271. /**
  20272. * Creates a multiview render target
  20273. * @param scene scene used with the render target
  20274. * @param size the size of the render target (used for each view)
  20275. */
  20276. constructor(scene: Scene, size?: number | {
  20277. width: number;
  20278. height: number;
  20279. } | {
  20280. ratio: number;
  20281. });
  20282. /**
  20283. * @hidden
  20284. * @param faceIndex the face index, if its a cube texture
  20285. */
  20286. _bindFrameBuffer(faceIndex?: number): void;
  20287. /**
  20288. * Gets the number of views the corresponding to the texture (eg. a MultiviewRenderTarget will have > 1)
  20289. * @returns the view count
  20290. */
  20291. getViewCount(): number;
  20292. }
  20293. }
  20294. declare module "babylonjs/Engines/Extensions/engine.multiview" {
  20295. import { Camera } from "babylonjs/Cameras/camera";
  20296. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  20297. import { Nullable } from "babylonjs/types";
  20298. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  20299. import { Matrix } from "babylonjs/Maths/math.vector";
  20300. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  20301. module "babylonjs/Engines/engine" {
  20302. interface Engine {
  20303. /**
  20304. * Creates a new multiview render target
  20305. * @param width defines the width of the texture
  20306. * @param height defines the height of the texture
  20307. * @returns the created multiview texture
  20308. */
  20309. createMultiviewRenderTargetTexture(width: number, height: number): InternalTexture;
  20310. /**
  20311. * Binds a multiview framebuffer to be drawn to
  20312. * @param multiviewTexture texture to bind
  20313. */
  20314. bindMultiviewFramebuffer(multiviewTexture: InternalTexture): void;
  20315. }
  20316. }
  20317. module "babylonjs/Cameras/camera" {
  20318. interface Camera {
  20319. /**
  20320. * @hidden
  20321. * For cameras that cannot use multiview images to display directly. (e.g. webVR camera will render to multiview texture, then copy to each eye texture and go from there)
  20322. */
  20323. _useMultiviewToSingleView: boolean;
  20324. /**
  20325. * @hidden
  20326. * For cameras that cannot use multiview images to display directly. (e.g. webVR camera will render to multiview texture, then copy to each eye texture and go from there)
  20327. */
  20328. _multiviewTexture: Nullable<RenderTargetTexture>;
  20329. /**
  20330. * @hidden
  20331. * ensures the multiview texture of the camera exists and has the specified width/height
  20332. * @param width height to set on the multiview texture
  20333. * @param height width to set on the multiview texture
  20334. */
  20335. _resizeOrCreateMultiviewTexture(width: number, height: number): void;
  20336. }
  20337. }
  20338. module "babylonjs/scene" {
  20339. interface Scene {
  20340. /** @hidden */
  20341. _transformMatrixR: Matrix;
  20342. /** @hidden */
  20343. _multiviewSceneUbo: Nullable<UniformBuffer>;
  20344. /** @hidden */
  20345. _createMultiviewUbo(): void;
  20346. /** @hidden */
  20347. _updateMultiviewUbo(viewR?: Matrix, projectionR?: Matrix): void;
  20348. /** @hidden */
  20349. _renderMultiviewToSingleView(camera: Camera): void;
  20350. }
  20351. }
  20352. }
  20353. declare module "babylonjs/PostProcesses/vrMultiviewToSingleviewPostProcess" {
  20354. import { Camera } from "babylonjs/Cameras/camera";
  20355. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  20356. import "babylonjs/Shaders/vrMultiviewToSingleview.fragment";
  20357. import "babylonjs/Engines/Extensions/engine.multiview";
  20358. /**
  20359. * VRMultiviewToSingleview used to convert multiview texture arrays to standard textures for scenarios such as webVR
  20360. * This will not be used for webXR as it supports displaying texture arrays directly
  20361. */
  20362. export class VRMultiviewToSingleviewPostProcess extends PostProcess {
  20363. /**
  20364. * Gets a string identifying the name of the class
  20365. * @returns "VRMultiviewToSingleviewPostProcess" string
  20366. */
  20367. getClassName(): string;
  20368. /**
  20369. * Initializes a VRMultiviewToSingleview
  20370. * @param name name of the post process
  20371. * @param camera camera to be applied to
  20372. * @param scaleFactor scaling factor to the size of the output texture
  20373. */
  20374. constructor(name: string, camera: Camera, scaleFactor: number);
  20375. }
  20376. }
  20377. declare module "babylonjs/Cameras/RigModes/webVRRigMode" { }
  20378. declare module "babylonjs/Engines/Extensions/engine.webVR" {
  20379. import { Nullable } from "babylonjs/types";
  20380. import { Size } from "babylonjs/Maths/math.size";
  20381. import { Observable } from "babylonjs/Misc/observable";
  20382. import { WebVROptions } from "babylonjs/Cameras/VR/webVRCamera";
  20383. /**
  20384. * Interface used to define additional presentation attributes
  20385. */
  20386. export interface IVRPresentationAttributes {
  20387. /**
  20388. * Defines a boolean indicating that we want to get 72hz mode on Oculus Browser (default is off eg. 60hz)
  20389. */
  20390. highRefreshRate: boolean;
  20391. /**
  20392. * Enables foveation in VR to improve perf. 0 none, 1 low, 2 medium, 3 high (Default is 1)
  20393. */
  20394. foveationLevel: number;
  20395. }
  20396. module "babylonjs/Engines/engine" {
  20397. interface Engine {
  20398. /** @hidden */
  20399. _vrDisplay: any;
  20400. /** @hidden */
  20401. _vrSupported: boolean;
  20402. /** @hidden */
  20403. _oldSize: Size;
  20404. /** @hidden */
  20405. _oldHardwareScaleFactor: number;
  20406. /** @hidden */
  20407. _vrExclusivePointerMode: boolean;
  20408. /** @hidden */
  20409. _webVRInitPromise: Promise<IDisplayChangedEventArgs>;
  20410. /** @hidden */
  20411. _onVRDisplayPointerRestricted: () => void;
  20412. /** @hidden */
  20413. _onVRDisplayPointerUnrestricted: () => void;
  20414. /** @hidden */
  20415. _onVrDisplayConnect: Nullable<(display: any) => void>;
  20416. /** @hidden */
  20417. _onVrDisplayDisconnect: Nullable<() => void>;
  20418. /** @hidden */
  20419. _onVrDisplayPresentChange: Nullable<() => void>;
  20420. /**
  20421. * Observable signaled when VR display mode changes
  20422. */
  20423. onVRDisplayChangedObservable: Observable<IDisplayChangedEventArgs>;
  20424. /**
  20425. * Observable signaled when VR request present is complete
  20426. */
  20427. onVRRequestPresentComplete: Observable<boolean>;
  20428. /**
  20429. * Observable signaled when VR request present starts
  20430. */
  20431. onVRRequestPresentStart: Observable<Engine>;
  20432. /**
  20433. * Gets a boolean indicating that the engine is currently in VR exclusive mode for the pointers
  20434. * @see https://docs.microsoft.com/en-us/microsoft-edge/webvr/essentials#mouse-input
  20435. */
  20436. isInVRExclusivePointerMode: boolean;
  20437. /**
  20438. * Gets a boolean indicating if a webVR device was detected
  20439. * @returns true if a webVR device was detected
  20440. */
  20441. isVRDevicePresent(): boolean;
  20442. /**
  20443. * Gets the current webVR device
  20444. * @returns the current webVR device (or null)
  20445. */
  20446. getVRDevice(): any;
  20447. /**
  20448. * Initializes a webVR display and starts listening to display change events
  20449. * The onVRDisplayChangedObservable will be notified upon these changes
  20450. * @returns A promise containing a VRDisplay and if vr is supported
  20451. */
  20452. initWebVRAsync(): Promise<IDisplayChangedEventArgs>;
  20453. /** @hidden */
  20454. _getVRDisplaysAsync(): Promise<IDisplayChangedEventArgs>;
  20455. /**
  20456. * Gets or sets the presentation attributes used to configure VR rendering
  20457. */
  20458. vrPresentationAttributes?: IVRPresentationAttributes;
  20459. /**
  20460. * Call this function to switch to webVR mode
  20461. * Will do nothing if webVR is not supported or if there is no webVR device
  20462. * @param options the webvr options provided to the camera. mainly used for multiview
  20463. * @see https://doc.babylonjs.com/how_to/webvr_camera
  20464. */
  20465. enableVR(options: WebVROptions): void;
  20466. /** @hidden */
  20467. _onVRFullScreenTriggered(): void;
  20468. }
  20469. }
  20470. }
  20471. declare module "babylonjs/Cameras/VR/webVRCamera" {
  20472. import { Nullable } from "babylonjs/types";
  20473. import { Observable } from "babylonjs/Misc/observable";
  20474. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  20475. import { Scene } from "babylonjs/scene";
  20476. import { Quaternion, Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  20477. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  20478. import { Node } from "babylonjs/node";
  20479. import { Ray } from "babylonjs/Culling/ray";
  20480. import "babylonjs/Cameras/RigModes/webVRRigMode";
  20481. import "babylonjs/Engines/Extensions/engine.webVR";
  20482. /**
  20483. * This is a copy of VRPose. See https://developer.mozilla.org/en-US/docs/Web/API/VRPose
  20484. * IMPORTANT!! The data is right-hand data.
  20485. * @export
  20486. * @interface DevicePose
  20487. */
  20488. export interface DevicePose {
  20489. /**
  20490. * The position of the device, values in array are [x,y,z].
  20491. */
  20492. readonly position: Nullable<Float32Array>;
  20493. /**
  20494. * The linearVelocity of the device, values in array are [x,y,z].
  20495. */
  20496. readonly linearVelocity: Nullable<Float32Array>;
  20497. /**
  20498. * The linearAcceleration of the device, values in array are [x,y,z].
  20499. */
  20500. readonly linearAcceleration: Nullable<Float32Array>;
  20501. /**
  20502. * The orientation of the device in a quaternion array, values in array are [x,y,z,w].
  20503. */
  20504. readonly orientation: Nullable<Float32Array>;
  20505. /**
  20506. * The angularVelocity of the device, values in array are [x,y,z].
  20507. */
  20508. readonly angularVelocity: Nullable<Float32Array>;
  20509. /**
  20510. * The angularAcceleration of the device, values in array are [x,y,z].
  20511. */
  20512. readonly angularAcceleration: Nullable<Float32Array>;
  20513. }
  20514. /**
  20515. * Interface representing a pose controlled object in Babylon.
  20516. * A pose controlled object has both regular pose values as well as pose values
  20517. * from an external device such as a VR head mounted display
  20518. */
  20519. export interface PoseControlled {
  20520. /**
  20521. * The position of the object in babylon space.
  20522. */
  20523. position: Vector3;
  20524. /**
  20525. * The rotation quaternion of the object in babylon space.
  20526. */
  20527. rotationQuaternion: Quaternion;
  20528. /**
  20529. * The position of the device in babylon space.
  20530. */
  20531. devicePosition?: Vector3;
  20532. /**
  20533. * The rotation quaternion of the device in babylon space.
  20534. */
  20535. deviceRotationQuaternion: Quaternion;
  20536. /**
  20537. * The raw pose coming from the device.
  20538. */
  20539. rawPose: Nullable<DevicePose>;
  20540. /**
  20541. * The scale of the device to be used when translating from device space to babylon space.
  20542. */
  20543. deviceScaleFactor: number;
  20544. /**
  20545. * Updates the poseControlled values based on the input device pose.
  20546. * @param poseData the pose data to update the object with
  20547. */
  20548. updateFromDevice(poseData: DevicePose): void;
  20549. }
  20550. /**
  20551. * Set of options to customize the webVRCamera
  20552. */
  20553. export interface WebVROptions {
  20554. /**
  20555. * Sets if the webVR camera should be tracked to the vrDevice. (default: true)
  20556. */
  20557. trackPosition?: boolean;
  20558. /**
  20559. * Sets the scale of the vrDevice in babylon space. (default: 1)
  20560. */
  20561. positionScale?: number;
  20562. /**
  20563. * If there are more than one VRDisplays, this will choose the display matching this name. (default: pick first vrDisplay)
  20564. */
  20565. displayName?: string;
  20566. /**
  20567. * Should the native controller meshes be initialized. (default: true)
  20568. */
  20569. controllerMeshes?: boolean;
  20570. /**
  20571. * Creating a default HemiLight only on controllers. (default: true)
  20572. */
  20573. defaultLightingOnControllers?: boolean;
  20574. /**
  20575. * If you don't want to use the default VR button of the helper. (default: false)
  20576. */
  20577. useCustomVRButton?: boolean;
  20578. /**
  20579. * If you'd like to provide your own button to the VRHelper. (default: standard babylon vr button)
  20580. */
  20581. customVRButton?: HTMLButtonElement;
  20582. /**
  20583. * To change the length of the ray for gaze/controllers. Will be scaled by positionScale. (default: 100)
  20584. */
  20585. rayLength?: number;
  20586. /**
  20587. * To change the default offset from the ground to account for user's height in meters. Will be scaled by positionScale. (default: 1.7)
  20588. */
  20589. defaultHeight?: number;
  20590. /**
  20591. * If multiview should be used if availible (default: false)
  20592. */
  20593. useMultiview?: boolean;
  20594. }
  20595. /**
  20596. * This represents a WebVR camera.
  20597. * The WebVR camera is Babylon's simple interface to interaction with Windows Mixed Reality, HTC Vive and Oculus Rift.
  20598. * @example https://doc.babylonjs.com/how_to/webvr_camera
  20599. */
  20600. export class WebVRFreeCamera extends FreeCamera implements PoseControlled {
  20601. private webVROptions;
  20602. /**
  20603. * @hidden
  20604. * The vrDisplay tied to the camera. See https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay
  20605. */
  20606. _vrDevice: any;
  20607. /**
  20608. * The rawPose of the vrDevice.
  20609. */
  20610. rawPose: Nullable<DevicePose>;
  20611. private _onVREnabled;
  20612. private _specsVersion;
  20613. private _attached;
  20614. private _frameData;
  20615. protected _descendants: Array<Node>;
  20616. private _deviceRoomPosition;
  20617. /** @hidden */
  20618. _deviceRoomRotationQuaternion: Quaternion;
  20619. private _standingMatrix;
  20620. /**
  20621. * Represents device position in babylon space.
  20622. */
  20623. devicePosition: Vector3;
  20624. /**
  20625. * Represents device rotation in babylon space.
  20626. */
  20627. deviceRotationQuaternion: Quaternion;
  20628. /**
  20629. * The scale of the device to be used when translating from device space to babylon space.
  20630. */
  20631. deviceScaleFactor: number;
  20632. private _deviceToWorld;
  20633. private _worldToDevice;
  20634. /**
  20635. * References to the webVR controllers for the vrDevice.
  20636. */
  20637. controllers: Array<WebVRController>;
  20638. /**
  20639. * Emits an event when a controller is attached.
  20640. */
  20641. onControllersAttachedObservable: Observable<WebVRController[]>;
  20642. /**
  20643. * Emits an event when a controller's mesh has been loaded;
  20644. */
  20645. onControllerMeshLoadedObservable: Observable<WebVRController>;
  20646. /**
  20647. * Emits an event when the HMD's pose has been updated.
  20648. */
  20649. onPoseUpdatedFromDeviceObservable: Observable<any>;
  20650. private _poseSet;
  20651. /**
  20652. * If the rig cameras be used as parent instead of this camera.
  20653. */
  20654. rigParenting: boolean;
  20655. private _lightOnControllers;
  20656. private _defaultHeight?;
  20657. /**
  20658. * Instantiates a WebVRFreeCamera.
  20659. * @param name The name of the WebVRFreeCamera
  20660. * @param position The starting anchor position for the camera
  20661. * @param scene The scene the camera belongs to
  20662. * @param webVROptions a set of customizable options for the webVRCamera
  20663. */
  20664. constructor(name: string, position: Vector3, scene: Scene, webVROptions?: WebVROptions);
  20665. /**
  20666. * Gets the device distance from the ground in meters.
  20667. * @returns the distance in meters from the vrDevice to ground in device space. If standing matrix is not supported for the vrDevice 0 is returned.
  20668. */
  20669. deviceDistanceToRoomGround(): number;
  20670. /**
  20671. * Enables the standing matrix when supported. This can be used to position the user's view the correct height from the ground.
  20672. * @param callback will be called when the standing matrix is set. Callback parameter is if the standing matrix is supported.
  20673. */
  20674. useStandingMatrix(callback?: (bool: boolean) => void): void;
  20675. /**
  20676. * Enables the standing matrix when supported. This can be used to position the user's view the correct height from the ground.
  20677. * @returns A promise with a boolean set to if the standing matrix is supported.
  20678. */
  20679. useStandingMatrixAsync(): Promise<boolean>;
  20680. /**
  20681. * Disposes the camera
  20682. */
  20683. dispose(): void;
  20684. /**
  20685. * Gets a vrController by name.
  20686. * @param name The name of the controller to retreive
  20687. * @returns the controller matching the name specified or null if not found
  20688. */
  20689. getControllerByName(name: string): Nullable<WebVRController>;
  20690. private _leftController;
  20691. /**
  20692. * The controller corresponding to the users left hand.
  20693. */
  20694. get leftController(): Nullable<WebVRController>;
  20695. private _rightController;
  20696. /**
  20697. * The controller corresponding to the users right hand.
  20698. */
  20699. get rightController(): Nullable<WebVRController>;
  20700. /**
  20701. * Casts a ray forward from the vrCamera's gaze.
  20702. * @param length Length of the ray (default: 100)
  20703. * @returns the ray corresponding to the gaze
  20704. */
  20705. getForwardRay(length?: number): Ray;
  20706. /**
  20707. * @hidden
  20708. * Updates the camera based on device's frame data
  20709. */
  20710. _checkInputs(): void;
  20711. /**
  20712. * Updates the poseControlled values based on the input device pose.
  20713. * @param poseData Pose coming from the device
  20714. */
  20715. updateFromDevice(poseData: DevicePose): void;
  20716. private _htmlElementAttached;
  20717. private _detachIfAttached;
  20718. /**
  20719. * WebVR's attach control will start broadcasting frames to the device.
  20720. * Note that in certain browsers (chrome for example) this function must be called
  20721. * within a user-interaction callback. Example:
  20722. * <pre> scene.onPointerDown = function() { camera.attachControl(canvas); }</pre>
  20723. *
  20724. * @param element html element to attach the vrDevice to
  20725. * @param noPreventDefault prevent the default html element operation when attaching the vrDevice
  20726. */
  20727. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  20728. /**
  20729. * Detaches the camera from the html element and disables VR
  20730. *
  20731. * @param element html element to detach from
  20732. */
  20733. detachControl(element: HTMLElement): void;
  20734. /**
  20735. * @returns the name of this class
  20736. */
  20737. getClassName(): string;
  20738. /**
  20739. * Calls resetPose on the vrDisplay
  20740. * See: https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay/resetPose
  20741. */
  20742. resetToCurrentRotation(): void;
  20743. /**
  20744. * @hidden
  20745. * Updates the rig cameras (left and right eye)
  20746. */
  20747. _updateRigCameras(): void;
  20748. private _workingVector;
  20749. private _oneVector;
  20750. private _workingMatrix;
  20751. private updateCacheCalled;
  20752. private _correctPositionIfNotTrackPosition;
  20753. /**
  20754. * @hidden
  20755. * Updates the cached values of the camera
  20756. * @param ignoreParentClass ignores updating the parent class's cache (default: false)
  20757. */
  20758. _updateCache(ignoreParentClass?: boolean): void;
  20759. /**
  20760. * @hidden
  20761. * Get current device position in babylon world
  20762. */
  20763. _computeDevicePosition(): void;
  20764. /**
  20765. * Updates the current device position and rotation in the babylon world
  20766. */
  20767. update(): void;
  20768. /**
  20769. * @hidden
  20770. * Gets the view matrix of this camera (Always set to identity as left and right eye cameras contain the actual view matrix)
  20771. * @returns an identity matrix
  20772. */
  20773. _getViewMatrix(): Matrix;
  20774. private _tmpMatrix;
  20775. /**
  20776. * This function is called by the two RIG cameras.
  20777. * 'this' is the left or right camera (and NOT (!!!) the WebVRFreeCamera instance)
  20778. * @hidden
  20779. */
  20780. _getWebVRViewMatrix(): Matrix;
  20781. /** @hidden */
  20782. _getWebVRProjectionMatrix(): Matrix;
  20783. private _onGamepadConnectedObserver;
  20784. private _onGamepadDisconnectedObserver;
  20785. private _updateCacheWhenTrackingDisabledObserver;
  20786. /**
  20787. * Initializes the controllers and their meshes
  20788. */
  20789. initControllers(): void;
  20790. }
  20791. }
  20792. declare module "babylonjs/Materials/materialHelper" {
  20793. import { Nullable } from "babylonjs/types";
  20794. import { Scene } from "babylonjs/scene";
  20795. import { Engine } from "babylonjs/Engines/engine";
  20796. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  20797. import { Light } from "babylonjs/Lights/light";
  20798. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  20799. import { Effect, IEffectCreationOptions } from "babylonjs/Materials/effect";
  20800. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  20801. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  20802. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  20803. /**
  20804. * "Static Class" containing the most commonly used helper while dealing with material for rendering purpose.
  20805. *
  20806. * It contains the basic tools to help defining defines, binding uniform for the common part of the materials.
  20807. *
  20808. * This works by convention in BabylonJS but is meant to be use only with shader following the in place naming rules and conventions.
  20809. */
  20810. export class MaterialHelper {
  20811. /**
  20812. * Bind the current view position to an effect.
  20813. * @param effect The effect to be bound
  20814. * @param scene The scene the eyes position is used from
  20815. * @param variableName name of the shader variable that will hold the eye position
  20816. */
  20817. static BindEyePosition(effect: Effect, scene: Scene, variableName?: string): void;
  20818. /**
  20819. * Helps preparing the defines values about the UVs in used in the effect.
  20820. * UVs are shared as much as we can accross channels in the shaders.
  20821. * @param texture The texture we are preparing the UVs for
  20822. * @param defines The defines to update
  20823. * @param key The channel key "diffuse", "specular"... used in the shader
  20824. */
  20825. static PrepareDefinesForMergedUV(texture: BaseTexture, defines: any, key: string): void;
  20826. /**
  20827. * Binds a texture matrix value to its corrsponding uniform
  20828. * @param texture The texture to bind the matrix for
  20829. * @param uniformBuffer The uniform buffer receivin the data
  20830. * @param key The channel key "diffuse", "specular"... used in the shader
  20831. */
  20832. static BindTextureMatrix(texture: BaseTexture, uniformBuffer: UniformBuffer, key: string): void;
  20833. /**
  20834. * Gets the current status of the fog (should it be enabled?)
  20835. * @param mesh defines the mesh to evaluate for fog support
  20836. * @param scene defines the hosting scene
  20837. * @returns true if fog must be enabled
  20838. */
  20839. static GetFogState(mesh: AbstractMesh, scene: Scene): boolean;
  20840. /**
  20841. * Helper used to prepare the list of defines associated with misc. values for shader compilation
  20842. * @param mesh defines the current mesh
  20843. * @param scene defines the current scene
  20844. * @param useLogarithmicDepth defines if logarithmic depth has to be turned on
  20845. * @param pointsCloud defines if point cloud rendering has to be turned on
  20846. * @param fogEnabled defines if fog has to be turned on
  20847. * @param alphaTest defines if alpha testing has to be turned on
  20848. * @param defines defines the current list of defines
  20849. */
  20850. static PrepareDefinesForMisc(mesh: AbstractMesh, scene: Scene, useLogarithmicDepth: boolean, pointsCloud: boolean, fogEnabled: boolean, alphaTest: boolean, defines: any): void;
  20851. /**
  20852. * Helper used to prepare the list of defines associated with frame values for shader compilation
  20853. * @param scene defines the current scene
  20854. * @param engine defines the current engine
  20855. * @param defines specifies the list of active defines
  20856. * @param useInstances defines if instances have to be turned on
  20857. * @param useClipPlane defines if clip plane have to be turned on
  20858. * @param useInstances defines if instances have to be turned on
  20859. * @param useThinInstances defines if thin instances have to be turned on
  20860. */
  20861. static PrepareDefinesForFrameBoundValues(scene: Scene, engine: Engine, defines: any, useInstances: boolean, useClipPlane?: Nullable<boolean>, useThinInstances?: boolean): void;
  20862. /**
  20863. * Prepares the defines for bones
  20864. * @param mesh The mesh containing the geometry data we will draw
  20865. * @param defines The defines to update
  20866. */
  20867. static PrepareDefinesForBones(mesh: AbstractMesh, defines: any): void;
  20868. /**
  20869. * Prepares the defines for morph targets
  20870. * @param mesh The mesh containing the geometry data we will draw
  20871. * @param defines The defines to update
  20872. */
  20873. static PrepareDefinesForMorphTargets(mesh: AbstractMesh, defines: any): void;
  20874. /**
  20875. * Prepares the defines used in the shader depending on the attributes data available in the mesh
  20876. * @param mesh The mesh containing the geometry data we will draw
  20877. * @param defines The defines to update
  20878. * @param useVertexColor Precise whether vertex colors should be used or not (override mesh info)
  20879. * @param useBones Precise whether bones should be used or not (override mesh info)
  20880. * @param useMorphTargets Precise whether morph targets should be used or not (override mesh info)
  20881. * @param useVertexAlpha Precise whether vertex alpha should be used or not (override mesh info)
  20882. * @returns false if defines are considered not dirty and have not been checked
  20883. */
  20884. static PrepareDefinesForAttributes(mesh: AbstractMesh, defines: any, useVertexColor: boolean, useBones: boolean, useMorphTargets?: boolean, useVertexAlpha?: boolean): boolean;
  20885. /**
  20886. * Prepares the defines related to multiview
  20887. * @param scene The scene we are intending to draw
  20888. * @param defines The defines to update
  20889. */
  20890. static PrepareDefinesForMultiview(scene: Scene, defines: any): void;
  20891. /**
  20892. * Prepares the defines related to the prepass
  20893. * @param scene The scene we are intending to draw
  20894. * @param defines The defines to update
  20895. * @param canRenderToMRT Indicates if this material renders to several textures in the prepass
  20896. */
  20897. static PrepareDefinesForPrePass(scene: Scene, defines: any, canRenderToMRT: boolean): void;
  20898. /**
  20899. * Prepares the defines related to the light information passed in parameter
  20900. * @param scene The scene we are intending to draw
  20901. * @param mesh The mesh the effect is compiling for
  20902. * @param light The light the effect is compiling for
  20903. * @param lightIndex The index of the light
  20904. * @param defines The defines to update
  20905. * @param specularSupported Specifies whether specular is supported or not (override lights data)
  20906. * @param state Defines the current state regarding what is needed (normals, etc...)
  20907. */
  20908. static PrepareDefinesForLight(scene: Scene, mesh: AbstractMesh, light: Light, lightIndex: number, defines: any, specularSupported: boolean, state: {
  20909. needNormals: boolean;
  20910. needRebuild: boolean;
  20911. shadowEnabled: boolean;
  20912. specularEnabled: boolean;
  20913. lightmapMode: boolean;
  20914. }): void;
  20915. /**
  20916. * Prepares the defines related to the light information passed in parameter
  20917. * @param scene The scene we are intending to draw
  20918. * @param mesh The mesh the effect is compiling for
  20919. * @param defines The defines to update
  20920. * @param specularSupported Specifies whether specular is supported or not (override lights data)
  20921. * @param maxSimultaneousLights Specfies how manuy lights can be added to the effect at max
  20922. * @param disableLighting Specifies whether the lighting is disabled (override scene and light)
  20923. * @returns true if normals will be required for the rest of the effect
  20924. */
  20925. static PrepareDefinesForLights(scene: Scene, mesh: AbstractMesh, defines: any, specularSupported: boolean, maxSimultaneousLights?: number, disableLighting?: boolean): boolean;
  20926. /**
  20927. * Prepares the uniforms and samplers list to be used in the effect (for a specific light)
  20928. * @param lightIndex defines the light index
  20929. * @param uniformsList The uniform list
  20930. * @param samplersList The sampler list
  20931. * @param projectedLightTexture defines if projected texture must be used
  20932. * @param uniformBuffersList defines an optional list of uniform buffers
  20933. */
  20934. static PrepareUniformsAndSamplersForLight(lightIndex: number, uniformsList: string[], samplersList: string[], projectedLightTexture?: any, uniformBuffersList?: Nullable<string[]>): void;
  20935. /**
  20936. * Prepares the uniforms and samplers list to be used in the effect
  20937. * @param uniformsListOrOptions The uniform names to prepare or an EffectCreationOptions containing the liist and extra information
  20938. * @param samplersList The sampler list
  20939. * @param defines The defines helping in the list generation
  20940. * @param maxSimultaneousLights The maximum number of simultanous light allowed in the effect
  20941. */
  20942. static PrepareUniformsAndSamplersList(uniformsListOrOptions: string[] | IEffectCreationOptions, samplersList?: string[], defines?: any, maxSimultaneousLights?: number): void;
  20943. /**
  20944. * This helps decreasing rank by rank the shadow quality (0 being the highest rank and quality)
  20945. * @param defines The defines to update while falling back
  20946. * @param fallbacks The authorized effect fallbacks
  20947. * @param maxSimultaneousLights The maximum number of lights allowed
  20948. * @param rank the current rank of the Effect
  20949. * @returns The newly affected rank
  20950. */
  20951. static HandleFallbacksForShadows(defines: any, fallbacks: EffectFallbacks, maxSimultaneousLights?: number, rank?: number): number;
  20952. private static _TmpMorphInfluencers;
  20953. /**
  20954. * Prepares the list of attributes required for morph targets according to the effect defines.
  20955. * @param attribs The current list of supported attribs
  20956. * @param mesh The mesh to prepare the morph targets attributes for
  20957. * @param influencers The number of influencers
  20958. */
  20959. static PrepareAttributesForMorphTargetsInfluencers(attribs: string[], mesh: AbstractMesh, influencers: number): void;
  20960. /**
  20961. * Prepares the list of attributes required for morph targets according to the effect defines.
  20962. * @param attribs The current list of supported attribs
  20963. * @param mesh The mesh to prepare the morph targets attributes for
  20964. * @param defines The current Defines of the effect
  20965. */
  20966. static PrepareAttributesForMorphTargets(attribs: string[], mesh: AbstractMesh, defines: any): void;
  20967. /**
  20968. * Prepares the list of attributes required for bones according to the effect defines.
  20969. * @param attribs The current list of supported attribs
  20970. * @param mesh The mesh to prepare the bones attributes for
  20971. * @param defines The current Defines of the effect
  20972. * @param fallbacks The current efffect fallback strategy
  20973. */
  20974. static PrepareAttributesForBones(attribs: string[], mesh: AbstractMesh, defines: any, fallbacks: EffectFallbacks): void;
  20975. /**
  20976. * Check and prepare the list of attributes required for instances according to the effect defines.
  20977. * @param attribs The current list of supported attribs
  20978. * @param defines The current MaterialDefines of the effect
  20979. */
  20980. static PrepareAttributesForInstances(attribs: string[], defines: MaterialDefines): void;
  20981. /**
  20982. * Add the list of attributes required for instances to the attribs array.
  20983. * @param attribs The current list of supported attribs
  20984. */
  20985. static PushAttributesForInstances(attribs: string[]): void;
  20986. /**
  20987. * Binds the light information to the effect.
  20988. * @param light The light containing the generator
  20989. * @param effect The effect we are binding the data to
  20990. * @param lightIndex The light index in the effect used to render
  20991. */
  20992. static BindLightProperties(light: Light, effect: Effect, lightIndex: number): void;
  20993. /**
  20994. * Binds the lights information from the scene to the effect for the given mesh.
  20995. * @param light Light to bind
  20996. * @param lightIndex Light index
  20997. * @param scene The scene where the light belongs to
  20998. * @param effect The effect we are binding the data to
  20999. * @param useSpecular Defines if specular is supported
  21000. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  21001. */
  21002. static BindLight(light: Light, lightIndex: number, scene: Scene, effect: Effect, useSpecular: boolean, rebuildInParallel?: boolean): void;
  21003. /**
  21004. * Binds the lights information from the scene to the effect for the given mesh.
  21005. * @param scene The scene the lights belongs to
  21006. * @param mesh The mesh we are binding the information to render
  21007. * @param effect The effect we are binding the data to
  21008. * @param defines The generated defines for the effect
  21009. * @param maxSimultaneousLights The maximum number of light that can be bound to the effect
  21010. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  21011. */
  21012. static BindLights(scene: Scene, mesh: AbstractMesh, effect: Effect, defines: any, maxSimultaneousLights?: number, rebuildInParallel?: boolean): void;
  21013. private static _tempFogColor;
  21014. /**
  21015. * Binds the fog information from the scene to the effect for the given mesh.
  21016. * @param scene The scene the lights belongs to
  21017. * @param mesh The mesh we are binding the information to render
  21018. * @param effect The effect we are binding the data to
  21019. * @param linearSpace Defines if the fog effect is applied in linear space
  21020. */
  21021. static BindFogParameters(scene: Scene, mesh: AbstractMesh, effect: Effect, linearSpace?: boolean): void;
  21022. /**
  21023. * Binds the bones information from the mesh to the effect.
  21024. * @param mesh The mesh we are binding the information to render
  21025. * @param effect The effect we are binding the data to
  21026. */
  21027. static BindBonesParameters(mesh?: AbstractMesh, effect?: Effect): void;
  21028. /**
  21029. * Binds the morph targets information from the mesh to the effect.
  21030. * @param abstractMesh The mesh we are binding the information to render
  21031. * @param effect The effect we are binding the data to
  21032. */
  21033. static BindMorphTargetParameters(abstractMesh: AbstractMesh, effect: Effect): void;
  21034. /**
  21035. * Binds the logarithmic depth information from the scene to the effect for the given defines.
  21036. * @param defines The generated defines used in the effect
  21037. * @param effect The effect we are binding the data to
  21038. * @param scene The scene we are willing to render with logarithmic scale for
  21039. */
  21040. static BindLogDepth(defines: any, effect: Effect, scene: Scene): void;
  21041. /**
  21042. * Binds the clip plane information from the scene to the effect.
  21043. * @param scene The scene the clip plane information are extracted from
  21044. * @param effect The effect we are binding the data to
  21045. */
  21046. static BindClipPlane(effect: Effect, scene: Scene): void;
  21047. }
  21048. }
  21049. declare module "babylonjs/Materials/Node/Blocks/Input/inputBlock" {
  21050. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21051. import { NodeMaterialBlockConnectionPointTypes } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  21052. import { NodeMaterialSystemValues } from "babylonjs/Materials/Node/Enums/nodeMaterialSystemValues";
  21053. import { Nullable } from "babylonjs/types";
  21054. import { Effect } from "babylonjs/Materials/effect";
  21055. import { Matrix } from "babylonjs/Maths/math.vector";
  21056. import { Scene } from "babylonjs/scene";
  21057. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21058. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  21059. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  21060. import { AnimatedInputBlockTypes } from "babylonjs/Materials/Node/Blocks/Input/animatedInputBlockTypes";
  21061. import { Observable } from "babylonjs/Misc/observable";
  21062. /**
  21063. * Block used to expose an input value
  21064. */
  21065. export class InputBlock extends NodeMaterialBlock {
  21066. private _mode;
  21067. private _associatedVariableName;
  21068. private _storedValue;
  21069. private _valueCallback;
  21070. private _type;
  21071. private _animationType;
  21072. /** Gets or set a value used to limit the range of float values */
  21073. min: number;
  21074. /** Gets or set a value used to limit the range of float values */
  21075. max: number;
  21076. /** Gets or set a value indicating that this input can only get 0 and 1 values */
  21077. isBoolean: boolean;
  21078. /** Gets or sets a value used by the Node Material editor to determine how to configure the current value if it is a matrix */
  21079. matrixMode: number;
  21080. /** @hidden */
  21081. _systemValue: Nullable<NodeMaterialSystemValues>;
  21082. /** Gets or sets a boolean indicating that this input can be edited in the Inspector (false by default) */
  21083. visibleInInspector: boolean;
  21084. /** Gets or sets a boolean indicating that the value of this input will not change after a build */
  21085. isConstant: boolean;
  21086. /** Gets or sets the group to use to display this block in the Inspector */
  21087. groupInInspector: string;
  21088. /** Gets an observable raised when the value is changed */
  21089. onValueChangedObservable: Observable<InputBlock>;
  21090. /**
  21091. * Gets or sets the connection point type (default is float)
  21092. */
  21093. get type(): NodeMaterialBlockConnectionPointTypes;
  21094. /**
  21095. * Creates a new InputBlock
  21096. * @param name defines the block name
  21097. * @param target defines the target of that block (Vertex by default)
  21098. * @param type defines the type of the input (can be set to NodeMaterialBlockConnectionPointTypes.AutoDetect)
  21099. */
  21100. constructor(name: string, target?: NodeMaterialBlockTargets, type?: NodeMaterialBlockConnectionPointTypes);
  21101. /**
  21102. * Validates if a name is a reserve word.
  21103. * @param newName the new name to be given to the node.
  21104. * @returns false if the name is a reserve word, else true.
  21105. */
  21106. validateBlockName(newName: string): boolean;
  21107. /**
  21108. * Gets the output component
  21109. */
  21110. get output(): NodeMaterialConnectionPoint;
  21111. /**
  21112. * Set the source of this connection point to a vertex attribute
  21113. * @param attributeName defines the attribute name (position, uv, normal, etc...). If not specified it will take the connection point name
  21114. * @returns the current connection point
  21115. */
  21116. setAsAttribute(attributeName?: string): InputBlock;
  21117. /**
  21118. * Set the source of this connection point to a system value
  21119. * @param value define the system value to use (world, view, etc...) or null to switch to manual value
  21120. * @returns the current connection point
  21121. */
  21122. setAsSystemValue(value: Nullable<NodeMaterialSystemValues>): InputBlock;
  21123. /**
  21124. * Gets or sets the value of that point.
  21125. * Please note that this value will be ignored if valueCallback is defined
  21126. */
  21127. get value(): any;
  21128. set value(value: any);
  21129. /**
  21130. * Gets or sets a callback used to get the value of that point.
  21131. * Please note that setting this value will force the connection point to ignore the value property
  21132. */
  21133. get valueCallback(): () => any;
  21134. set valueCallback(value: () => any);
  21135. /**
  21136. * Gets or sets the associated variable name in the shader
  21137. */
  21138. get associatedVariableName(): string;
  21139. set associatedVariableName(value: string);
  21140. /** Gets or sets the type of animation applied to the input */
  21141. get animationType(): AnimatedInputBlockTypes;
  21142. set animationType(value: AnimatedInputBlockTypes);
  21143. /**
  21144. * Gets a boolean indicating that this connection point not defined yet
  21145. */
  21146. get isUndefined(): boolean;
  21147. /**
  21148. * Gets or sets a boolean indicating that this connection point is coming from an uniform.
  21149. * In this case the connection point name must be the name of the uniform to use.
  21150. * Can only be set on inputs
  21151. */
  21152. get isUniform(): boolean;
  21153. set isUniform(value: boolean);
  21154. /**
  21155. * Gets or sets a boolean indicating that this connection point is coming from an attribute.
  21156. * In this case the connection point name must be the name of the attribute to use
  21157. * Can only be set on inputs
  21158. */
  21159. get isAttribute(): boolean;
  21160. set isAttribute(value: boolean);
  21161. /**
  21162. * Gets or sets a boolean indicating that this connection point is generating a varying variable.
  21163. * Can only be set on exit points
  21164. */
  21165. get isVarying(): boolean;
  21166. set isVarying(value: boolean);
  21167. /**
  21168. * Gets a boolean indicating that the current connection point is a system value
  21169. */
  21170. get isSystemValue(): boolean;
  21171. /**
  21172. * Gets or sets the current well known value or null if not defined as a system value
  21173. */
  21174. get systemValue(): Nullable<NodeMaterialSystemValues>;
  21175. set systemValue(value: Nullable<NodeMaterialSystemValues>);
  21176. /**
  21177. * Gets the current class name
  21178. * @returns the class name
  21179. */
  21180. getClassName(): string;
  21181. /**
  21182. * Animate the input if animationType !== None
  21183. * @param scene defines the rendering scene
  21184. */
  21185. animate(scene: Scene): void;
  21186. private _emitDefine;
  21187. initialize(state: NodeMaterialBuildState): void;
  21188. /**
  21189. * Set the input block to its default value (based on its type)
  21190. */
  21191. setDefaultValue(): void;
  21192. private _emitConstant;
  21193. /** @hidden */
  21194. get _noContextSwitch(): boolean;
  21195. private _emit;
  21196. /** @hidden */
  21197. _transmitWorld(effect: Effect, world: Matrix, worldView: Matrix, worldViewProjection: Matrix): void;
  21198. /** @hidden */
  21199. _transmit(effect: Effect, scene: Scene): void;
  21200. protected _buildBlock(state: NodeMaterialBuildState): void;
  21201. protected _dumpPropertiesCode(): string;
  21202. dispose(): void;
  21203. serialize(): any;
  21204. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  21205. }
  21206. }
  21207. declare module "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint" {
  21208. import { NodeMaterialBlockConnectionPointTypes } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  21209. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  21210. import { Nullable } from "babylonjs/types";
  21211. import { InputBlock } from "babylonjs/Materials/Node/Blocks/Input/inputBlock";
  21212. import { Observable } from "babylonjs/Misc/observable";
  21213. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21214. /**
  21215. * Enum used to define the compatibility state between two connection points
  21216. */
  21217. export enum NodeMaterialConnectionPointCompatibilityStates {
  21218. /** Points are compatibles */
  21219. Compatible = 0,
  21220. /** Points are incompatible because of their types */
  21221. TypeIncompatible = 1,
  21222. /** Points are incompatible because of their targets (vertex vs fragment) */
  21223. TargetIncompatible = 2
  21224. }
  21225. /**
  21226. * Defines the direction of a connection point
  21227. */
  21228. export enum NodeMaterialConnectionPointDirection {
  21229. /** Input */
  21230. Input = 0,
  21231. /** Output */
  21232. Output = 1
  21233. }
  21234. /**
  21235. * Defines a connection point for a block
  21236. */
  21237. export class NodeMaterialConnectionPoint {
  21238. /** @hidden */
  21239. _ownerBlock: NodeMaterialBlock;
  21240. /** @hidden */
  21241. _connectedPoint: Nullable<NodeMaterialConnectionPoint>;
  21242. private _endpoints;
  21243. private _associatedVariableName;
  21244. private _direction;
  21245. /** @hidden */
  21246. _typeConnectionSource: Nullable<NodeMaterialConnectionPoint>;
  21247. /** @hidden */
  21248. _linkedConnectionSource: Nullable<NodeMaterialConnectionPoint>;
  21249. private _type;
  21250. /** @hidden */
  21251. _enforceAssociatedVariableName: boolean;
  21252. /** Gets the direction of the point */
  21253. get direction(): NodeMaterialConnectionPointDirection;
  21254. /** Indicates that this connection point needs dual validation before being connected to another point */
  21255. needDualDirectionValidation: boolean;
  21256. /**
  21257. * Gets or sets the additional types supported by this connection point
  21258. */
  21259. acceptedConnectionPointTypes: NodeMaterialBlockConnectionPointTypes[];
  21260. /**
  21261. * Gets or sets the additional types excluded by this connection point
  21262. */
  21263. excludedConnectionPointTypes: NodeMaterialBlockConnectionPointTypes[];
  21264. /**
  21265. * Observable triggered when this point is connected
  21266. */
  21267. onConnectionObservable: Observable<NodeMaterialConnectionPoint>;
  21268. /**
  21269. * Gets or sets the associated variable name in the shader
  21270. */
  21271. get associatedVariableName(): string;
  21272. set associatedVariableName(value: string);
  21273. /** Get the inner type (ie AutoDetect for instance instead of the inferred one) */
  21274. get innerType(): NodeMaterialBlockConnectionPointTypes;
  21275. /**
  21276. * Gets or sets the connection point type (default is float)
  21277. */
  21278. get type(): NodeMaterialBlockConnectionPointTypes;
  21279. set type(value: NodeMaterialBlockConnectionPointTypes);
  21280. /**
  21281. * Gets or sets the connection point name
  21282. */
  21283. name: string;
  21284. /**
  21285. * Gets or sets the connection point name
  21286. */
  21287. displayName: string;
  21288. /**
  21289. * Gets or sets a boolean indicating that this connection point can be omitted
  21290. */
  21291. isOptional: boolean;
  21292. /**
  21293. * Gets or sets a boolean indicating that this connection point is exposed on a frame
  21294. */
  21295. isExposedOnFrame: boolean;
  21296. /**
  21297. * Gets or sets a string indicating that this uniform must be defined under a #ifdef
  21298. */
  21299. define: string;
  21300. /** @hidden */
  21301. _prioritizeVertex: boolean;
  21302. private _target;
  21303. /** Gets or sets the target of that connection point */
  21304. get target(): NodeMaterialBlockTargets;
  21305. set target(value: NodeMaterialBlockTargets);
  21306. /**
  21307. * Gets a boolean indicating that the current point is connected to another NodeMaterialBlock
  21308. */
  21309. get isConnected(): boolean;
  21310. /**
  21311. * Gets a boolean indicating that the current point is connected to an input block
  21312. */
  21313. get isConnectedToInputBlock(): boolean;
  21314. /**
  21315. * Gets a the connected input block (if any)
  21316. */
  21317. get connectInputBlock(): Nullable<InputBlock>;
  21318. /** Get the other side of the connection (if any) */
  21319. get connectedPoint(): Nullable<NodeMaterialConnectionPoint>;
  21320. /** Get the block that owns this connection point */
  21321. get ownerBlock(): NodeMaterialBlock;
  21322. /** Get the block connected on the other side of this connection (if any) */
  21323. get sourceBlock(): Nullable<NodeMaterialBlock>;
  21324. /** Get the block connected on the endpoints of this connection (if any) */
  21325. get connectedBlocks(): Array<NodeMaterialBlock>;
  21326. /** Gets the list of connected endpoints */
  21327. get endpoints(): NodeMaterialConnectionPoint[];
  21328. /** Gets a boolean indicating if that output point is connected to at least one input */
  21329. get hasEndpoints(): boolean;
  21330. /** Gets a boolean indicating that this connection will be used in the vertex shader */
  21331. get isConnectedInVertexShader(): boolean;
  21332. /** Gets a boolean indicating that this connection will be used in the fragment shader */
  21333. get isConnectedInFragmentShader(): boolean;
  21334. /**
  21335. * Creates a block suitable to be used as an input for this input point.
  21336. * If null is returned, a block based on the point type will be created.
  21337. * @returns The returned string parameter is the name of the output point of NodeMaterialBlock (first parameter of the returned array) that can be connected to the input
  21338. */
  21339. createCustomInputBlock(): Nullable<[NodeMaterialBlock, string]>;
  21340. /**
  21341. * Creates a new connection point
  21342. * @param name defines the connection point name
  21343. * @param ownerBlock defines the block hosting this connection point
  21344. * @param direction defines the direction of the connection point
  21345. */
  21346. constructor(name: string, ownerBlock: NodeMaterialBlock, direction: NodeMaterialConnectionPointDirection);
  21347. /**
  21348. * Gets the current class name e.g. "NodeMaterialConnectionPoint"
  21349. * @returns the class name
  21350. */
  21351. getClassName(): string;
  21352. /**
  21353. * Gets a boolean indicating if the current point can be connected to another point
  21354. * @param connectionPoint defines the other connection point
  21355. * @returns a boolean
  21356. */
  21357. canConnectTo(connectionPoint: NodeMaterialConnectionPoint): boolean;
  21358. /**
  21359. * Gets a number indicating if the current point can be connected to another point
  21360. * @param connectionPoint defines the other connection point
  21361. * @returns a number defining the compatibility state
  21362. */
  21363. checkCompatibilityState(connectionPoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPointCompatibilityStates;
  21364. /**
  21365. * Connect this point to another connection point
  21366. * @param connectionPoint defines the other connection point
  21367. * @param ignoreConstraints defines if the system will ignore connection type constraints (default is false)
  21368. * @returns the current connection point
  21369. */
  21370. connectTo(connectionPoint: NodeMaterialConnectionPoint, ignoreConstraints?: boolean): NodeMaterialConnectionPoint;
  21371. /**
  21372. * Disconnect this point from one of his endpoint
  21373. * @param endpoint defines the other connection point
  21374. * @returns the current connection point
  21375. */
  21376. disconnectFrom(endpoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPoint;
  21377. /**
  21378. * Serializes this point in a JSON representation
  21379. * @param isInput defines if the connection point is an input (default is true)
  21380. * @returns the serialized point object
  21381. */
  21382. serialize(isInput?: boolean): any;
  21383. /**
  21384. * Release resources
  21385. */
  21386. dispose(): void;
  21387. }
  21388. }
  21389. declare module "babylonjs/Materials/Node/Enums/nodeMaterialModes" {
  21390. /**
  21391. * Enum used to define the material modes
  21392. */
  21393. export enum NodeMaterialModes {
  21394. /** Regular material */
  21395. Material = 0,
  21396. /** For post process */
  21397. PostProcess = 1,
  21398. /** For particle system */
  21399. Particle = 2
  21400. }
  21401. }
  21402. declare module "babylonjs/Materials/Node/Blocks/Dual/textureBlock" {
  21403. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21404. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  21405. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  21406. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21407. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  21408. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  21409. import { Effect } from "babylonjs/Materials/effect";
  21410. import { Mesh } from "babylonjs/Meshes/mesh";
  21411. import { Nullable } from "babylonjs/types";
  21412. import { Texture } from "babylonjs/Materials/Textures/texture";
  21413. import { Scene } from "babylonjs/scene";
  21414. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  21415. /**
  21416. * Block used to read a texture from a sampler
  21417. */
  21418. export class TextureBlock extends NodeMaterialBlock {
  21419. private _defineName;
  21420. private _linearDefineName;
  21421. private _gammaDefineName;
  21422. private _tempTextureRead;
  21423. private _samplerName;
  21424. private _transformedUVName;
  21425. private _textureTransformName;
  21426. private _textureInfoName;
  21427. private _mainUVName;
  21428. private _mainUVDefineName;
  21429. private _fragmentOnly;
  21430. /**
  21431. * Gets or sets the texture associated with the node
  21432. */
  21433. texture: Nullable<Texture>;
  21434. /**
  21435. * Gets or sets a boolean indicating if content needs to be converted to gamma space
  21436. */
  21437. convertToGammaSpace: boolean;
  21438. /**
  21439. * Gets or sets a boolean indicating if content needs to be converted to linear space
  21440. */
  21441. convertToLinearSpace: boolean;
  21442. /**
  21443. * Create a new TextureBlock
  21444. * @param name defines the block name
  21445. */
  21446. constructor(name: string, fragmentOnly?: boolean);
  21447. /**
  21448. * Gets the current class name
  21449. * @returns the class name
  21450. */
  21451. getClassName(): string;
  21452. /**
  21453. * Gets the uv input component
  21454. */
  21455. get uv(): NodeMaterialConnectionPoint;
  21456. /**
  21457. * Gets the rgba output component
  21458. */
  21459. get rgba(): NodeMaterialConnectionPoint;
  21460. /**
  21461. * Gets the rgb output component
  21462. */
  21463. get rgb(): NodeMaterialConnectionPoint;
  21464. /**
  21465. * Gets the r output component
  21466. */
  21467. get r(): NodeMaterialConnectionPoint;
  21468. /**
  21469. * Gets the g output component
  21470. */
  21471. get g(): NodeMaterialConnectionPoint;
  21472. /**
  21473. * Gets the b output component
  21474. */
  21475. get b(): NodeMaterialConnectionPoint;
  21476. /**
  21477. * Gets the a output component
  21478. */
  21479. get a(): NodeMaterialConnectionPoint;
  21480. get target(): NodeMaterialBlockTargets;
  21481. autoConfigure(material: NodeMaterial): void;
  21482. initializeDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  21483. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  21484. isReady(): boolean;
  21485. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  21486. private get _isMixed();
  21487. private _injectVertexCode;
  21488. private _writeTextureRead;
  21489. private _writeOutput;
  21490. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  21491. protected _dumpPropertiesCode(): string;
  21492. serialize(): any;
  21493. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  21494. }
  21495. }
  21496. declare module "babylonjs/Shaders/ShadersInclude/reflectionFunction" {
  21497. /** @hidden */
  21498. export var reflectionFunction: {
  21499. name: string;
  21500. shader: string;
  21501. };
  21502. }
  21503. declare module "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBaseBlock" {
  21504. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21505. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  21506. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21507. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  21508. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  21509. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  21510. import { Effect } from "babylonjs/Materials/effect";
  21511. import { Mesh } from "babylonjs/Meshes/mesh";
  21512. import { Nullable } from "babylonjs/types";
  21513. import { Scene } from "babylonjs/scene";
  21514. import "babylonjs/Shaders/ShadersInclude/reflectionFunction";
  21515. /**
  21516. * Base block used to read a reflection texture from a sampler
  21517. */
  21518. export abstract class ReflectionTextureBaseBlock extends NodeMaterialBlock {
  21519. /** @hidden */
  21520. _define3DName: string;
  21521. /** @hidden */
  21522. _defineCubicName: string;
  21523. /** @hidden */
  21524. _defineExplicitName: string;
  21525. /** @hidden */
  21526. _defineProjectionName: string;
  21527. /** @hidden */
  21528. _defineLocalCubicName: string;
  21529. /** @hidden */
  21530. _defineSphericalName: string;
  21531. /** @hidden */
  21532. _definePlanarName: string;
  21533. /** @hidden */
  21534. _defineEquirectangularName: string;
  21535. /** @hidden */
  21536. _defineMirroredEquirectangularFixedName: string;
  21537. /** @hidden */
  21538. _defineEquirectangularFixedName: string;
  21539. /** @hidden */
  21540. _defineSkyboxName: string;
  21541. /** @hidden */
  21542. _defineOppositeZ: string;
  21543. /** @hidden */
  21544. _cubeSamplerName: string;
  21545. /** @hidden */
  21546. _2DSamplerName: string;
  21547. protected _positionUVWName: string;
  21548. protected _directionWName: string;
  21549. protected _reflectionVectorName: string;
  21550. /** @hidden */
  21551. _reflectionCoordsName: string;
  21552. /** @hidden */
  21553. _reflectionMatrixName: string;
  21554. protected _reflectionColorName: string;
  21555. /**
  21556. * Gets or sets the texture associated with the node
  21557. */
  21558. texture: Nullable<BaseTexture>;
  21559. /**
  21560. * Create a new ReflectionTextureBaseBlock
  21561. * @param name defines the block name
  21562. */
  21563. constructor(name: string);
  21564. /**
  21565. * Gets the current class name
  21566. * @returns the class name
  21567. */
  21568. getClassName(): string;
  21569. /**
  21570. * Gets the world position input component
  21571. */
  21572. abstract get position(): NodeMaterialConnectionPoint;
  21573. /**
  21574. * Gets the world position input component
  21575. */
  21576. abstract get worldPosition(): NodeMaterialConnectionPoint;
  21577. /**
  21578. * Gets the world normal input component
  21579. */
  21580. abstract get worldNormal(): NodeMaterialConnectionPoint;
  21581. /**
  21582. * Gets the world input component
  21583. */
  21584. abstract get world(): NodeMaterialConnectionPoint;
  21585. /**
  21586. * Gets the camera (or eye) position component
  21587. */
  21588. abstract get cameraPosition(): NodeMaterialConnectionPoint;
  21589. /**
  21590. * Gets the view input component
  21591. */
  21592. abstract get view(): NodeMaterialConnectionPoint;
  21593. protected _getTexture(): Nullable<BaseTexture>;
  21594. autoConfigure(material: NodeMaterial): void;
  21595. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  21596. isReady(): boolean;
  21597. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  21598. /**
  21599. * Gets the code to inject in the vertex shader
  21600. * @param state current state of the node material building
  21601. * @returns the shader code
  21602. */
  21603. handleVertexSide(state: NodeMaterialBuildState): string;
  21604. /**
  21605. * Handles the inits for the fragment code path
  21606. * @param state node material build state
  21607. */
  21608. handleFragmentSideInits(state: NodeMaterialBuildState): void;
  21609. /**
  21610. * Generates the reflection coords code for the fragment code path
  21611. * @param worldNormalVarName name of the world normal variable
  21612. * @param worldPos name of the world position variable. If not provided, will use the world position connected to this block
  21613. * @param onlyReflectionVector if true, generates code only for the reflection vector computation, not for the reflection coordinates
  21614. * @returns the shader code
  21615. */
  21616. handleFragmentSideCodeReflectionCoords(worldNormalVarName: string, worldPos?: string, onlyReflectionVector?: boolean): string;
  21617. /**
  21618. * Generates the reflection color code for the fragment code path
  21619. * @param lodVarName name of the lod variable
  21620. * @param swizzleLookupTexture swizzle to use for the final color variable
  21621. * @returns the shader code
  21622. */
  21623. handleFragmentSideCodeReflectionColor(lodVarName?: string, swizzleLookupTexture?: string): string;
  21624. /**
  21625. * Generates the code corresponding to the connected output points
  21626. * @param state node material build state
  21627. * @param varName name of the variable to output
  21628. * @returns the shader code
  21629. */
  21630. writeOutputs(state: NodeMaterialBuildState, varName: string): string;
  21631. protected _buildBlock(state: NodeMaterialBuildState): this;
  21632. protected _dumpPropertiesCode(): string;
  21633. serialize(): any;
  21634. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  21635. }
  21636. }
  21637. declare module "babylonjs/Materials/Node/nodeMaterialConnectionPointCustomObject" {
  21638. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21639. import { NodeMaterialConnectionPoint, NodeMaterialConnectionPointDirection, NodeMaterialConnectionPointCompatibilityStates } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21640. import { Nullable } from "babylonjs/types";
  21641. /**
  21642. * Defines a connection point to be used for points with a custom object type
  21643. */
  21644. export class NodeMaterialConnectionPointCustomObject<T extends NodeMaterialBlock> extends NodeMaterialConnectionPoint {
  21645. private _blockType;
  21646. private _blockName;
  21647. private _nameForCheking?;
  21648. /**
  21649. * Creates a new connection point
  21650. * @param name defines the connection point name
  21651. * @param ownerBlock defines the block hosting this connection point
  21652. * @param direction defines the direction of the connection point
  21653. */
  21654. constructor(name: string, ownerBlock: NodeMaterialBlock, direction: NodeMaterialConnectionPointDirection, _blockType: new (...args: any[]) => T, _blockName: string, _nameForCheking?: string | undefined);
  21655. /**
  21656. * Gets a number indicating if the current point can be connected to another point
  21657. * @param connectionPoint defines the other connection point
  21658. * @returns a number defining the compatibility state
  21659. */
  21660. checkCompatibilityState(connectionPoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPointCompatibilityStates;
  21661. /**
  21662. * Creates a block suitable to be used as an input for this input point.
  21663. * If null is returned, a block based on the point type will be created.
  21664. * @returns The returned string parameter is the name of the output point of NodeMaterialBlock (first parameter of the returned array) that can be connected to the input
  21665. */
  21666. createCustomInputBlock(): Nullable<[NodeMaterialBlock, string]>;
  21667. }
  21668. }
  21669. declare module "babylonjs/Materials/Node/nodeMaterialDecorator" {
  21670. /**
  21671. * Enum defining the type of properties that can be edited in the property pages in the NME
  21672. */
  21673. export enum PropertyTypeForEdition {
  21674. /** property is a boolean */
  21675. Boolean = 0,
  21676. /** property is a float */
  21677. Float = 1,
  21678. /** property is a Vector2 */
  21679. Vector2 = 2,
  21680. /** property is a list of values */
  21681. List = 3
  21682. }
  21683. /**
  21684. * Interface that defines an option in a variable of type list
  21685. */
  21686. export interface IEditablePropertyListOption {
  21687. /** label of the option */
  21688. "label": string;
  21689. /** value of the option */
  21690. "value": number;
  21691. }
  21692. /**
  21693. * Interface that defines the options available for an editable property
  21694. */
  21695. export interface IEditablePropertyOption {
  21696. /** min value */
  21697. "min"?: number;
  21698. /** max value */
  21699. "max"?: number;
  21700. /** notifiers: indicates which actions to take when the property is changed */
  21701. "notifiers"?: {
  21702. /** the material should be rebuilt */
  21703. "rebuild"?: boolean;
  21704. /** the preview should be updated */
  21705. "update"?: boolean;
  21706. };
  21707. /** list of the options for a variable of type list */
  21708. "options"?: IEditablePropertyListOption[];
  21709. }
  21710. /**
  21711. * Interface that describes an editable property
  21712. */
  21713. export interface IPropertyDescriptionForEdition {
  21714. /** name of the property */
  21715. "propertyName": string;
  21716. /** display name of the property */
  21717. "displayName": string;
  21718. /** type of the property */
  21719. "type": PropertyTypeForEdition;
  21720. /** group of the property - all properties with the same group value will be displayed in a specific section */
  21721. "groupName": string;
  21722. /** options for the property */
  21723. "options": IEditablePropertyOption;
  21724. }
  21725. /**
  21726. * Decorator that flags a property in a node material block as being editable
  21727. */
  21728. export function editableInPropertyPage(displayName: string, propertyType?: PropertyTypeForEdition, groupName?: string, options?: IEditablePropertyOption): (target: any, propertyKey: string) => void;
  21729. }
  21730. declare module "babylonjs/Materials/Node/Blocks/PBR/refractionBlock" {
  21731. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  21732. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21733. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  21734. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  21735. import { Nullable } from "babylonjs/types";
  21736. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  21737. import { Mesh } from "babylonjs/Meshes/mesh";
  21738. import { SubMesh } from "babylonjs/Meshes/subMesh";
  21739. import { Effect } from "babylonjs/Materials/effect";
  21740. import { Scene } from "babylonjs/scene";
  21741. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21742. /**
  21743. * Block used to implement the refraction part of the sub surface module of the PBR material
  21744. */
  21745. export class RefractionBlock extends NodeMaterialBlock {
  21746. /** @hidden */
  21747. _define3DName: string;
  21748. /** @hidden */
  21749. _refractionMatrixName: string;
  21750. /** @hidden */
  21751. _defineLODRefractionAlpha: string;
  21752. /** @hidden */
  21753. _defineLinearSpecularRefraction: string;
  21754. /** @hidden */
  21755. _defineOppositeZ: string;
  21756. /** @hidden */
  21757. _cubeSamplerName: string;
  21758. /** @hidden */
  21759. _2DSamplerName: string;
  21760. /** @hidden */
  21761. _vRefractionMicrosurfaceInfosName: string;
  21762. /** @hidden */
  21763. _vRefractionInfosName: string;
  21764. private _scene;
  21765. /**
  21766. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  21767. * Materials half opaque for instance using refraction could benefit from this control.
  21768. */
  21769. linkRefractionWithTransparency: boolean;
  21770. /**
  21771. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  21772. */
  21773. invertRefractionY: boolean;
  21774. /**
  21775. * Gets or sets the texture associated with the node
  21776. */
  21777. texture: Nullable<BaseTexture>;
  21778. /**
  21779. * Create a new RefractionBlock
  21780. * @param name defines the block name
  21781. */
  21782. constructor(name: string);
  21783. /**
  21784. * Gets the current class name
  21785. * @returns the class name
  21786. */
  21787. getClassName(): string;
  21788. /**
  21789. * Gets the intensity input component
  21790. */
  21791. get intensity(): NodeMaterialConnectionPoint;
  21792. /**
  21793. * Gets the index of refraction input component
  21794. */
  21795. get indexOfRefraction(): NodeMaterialConnectionPoint;
  21796. /**
  21797. * Gets the tint at distance input component
  21798. */
  21799. get tintAtDistance(): NodeMaterialConnectionPoint;
  21800. /**
  21801. * Gets the view input component
  21802. */
  21803. get view(): NodeMaterialConnectionPoint;
  21804. /**
  21805. * Gets the refraction object output component
  21806. */
  21807. get refraction(): NodeMaterialConnectionPoint;
  21808. /**
  21809. * Returns true if the block has a texture
  21810. */
  21811. get hasTexture(): boolean;
  21812. protected _getTexture(): Nullable<BaseTexture>;
  21813. autoConfigure(material: NodeMaterial): void;
  21814. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  21815. isReady(): boolean;
  21816. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  21817. /**
  21818. * Gets the main code of the block (fragment side)
  21819. * @param state current state of the node material building
  21820. * @returns the shader code
  21821. */
  21822. getCode(state: NodeMaterialBuildState): string;
  21823. protected _buildBlock(state: NodeMaterialBuildState): this;
  21824. protected _dumpPropertiesCode(): string;
  21825. serialize(): any;
  21826. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  21827. }
  21828. }
  21829. declare module "babylonjs/Materials/Node/Blocks/Dual/currentScreenBlock" {
  21830. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21831. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  21832. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  21833. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21834. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  21835. import { NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  21836. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  21837. import { Nullable } from "babylonjs/types";
  21838. import { Scene } from "babylonjs/scene";
  21839. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  21840. /**
  21841. * Base block used as input for post process
  21842. */
  21843. export class CurrentScreenBlock extends NodeMaterialBlock {
  21844. private _samplerName;
  21845. private _linearDefineName;
  21846. private _gammaDefineName;
  21847. private _mainUVName;
  21848. private _tempTextureRead;
  21849. /**
  21850. * Gets or sets the texture associated with the node
  21851. */
  21852. texture: Nullable<BaseTexture>;
  21853. /**
  21854. * Gets or sets a boolean indicating if content needs to be converted to gamma space
  21855. */
  21856. convertToGammaSpace: boolean;
  21857. /**
  21858. * Gets or sets a boolean indicating if content needs to be converted to linear space
  21859. */
  21860. convertToLinearSpace: boolean;
  21861. /**
  21862. * Create a new CurrentScreenBlock
  21863. * @param name defines the block name
  21864. */
  21865. constructor(name: string);
  21866. /**
  21867. * Gets the current class name
  21868. * @returns the class name
  21869. */
  21870. getClassName(): string;
  21871. /**
  21872. * Gets the uv input component
  21873. */
  21874. get uv(): NodeMaterialConnectionPoint;
  21875. /**
  21876. * Gets the rgba output component
  21877. */
  21878. get rgba(): NodeMaterialConnectionPoint;
  21879. /**
  21880. * Gets the rgb output component
  21881. */
  21882. get rgb(): NodeMaterialConnectionPoint;
  21883. /**
  21884. * Gets the r output component
  21885. */
  21886. get r(): NodeMaterialConnectionPoint;
  21887. /**
  21888. * Gets the g output component
  21889. */
  21890. get g(): NodeMaterialConnectionPoint;
  21891. /**
  21892. * Gets the b output component
  21893. */
  21894. get b(): NodeMaterialConnectionPoint;
  21895. /**
  21896. * Gets the a output component
  21897. */
  21898. get a(): NodeMaterialConnectionPoint;
  21899. /**
  21900. * Initialize the block and prepare the context for build
  21901. * @param state defines the state that will be used for the build
  21902. */
  21903. initialize(state: NodeMaterialBuildState): void;
  21904. get target(): NodeMaterialBlockTargets;
  21905. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  21906. isReady(): boolean;
  21907. private _injectVertexCode;
  21908. private _writeTextureRead;
  21909. private _writeOutput;
  21910. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  21911. serialize(): any;
  21912. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  21913. }
  21914. }
  21915. declare module "babylonjs/Materials/Node/Blocks/Particle/particleTextureBlock" {
  21916. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21917. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  21918. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21919. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  21920. import { NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  21921. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  21922. import { Nullable } from "babylonjs/types";
  21923. import { Scene } from "babylonjs/scene";
  21924. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  21925. /**
  21926. * Base block used for the particle texture
  21927. */
  21928. export class ParticleTextureBlock extends NodeMaterialBlock {
  21929. private _samplerName;
  21930. private _linearDefineName;
  21931. private _gammaDefineName;
  21932. private _tempTextureRead;
  21933. /**
  21934. * Gets or sets the texture associated with the node
  21935. */
  21936. texture: Nullable<BaseTexture>;
  21937. /**
  21938. * Gets or sets a boolean indicating if content needs to be converted to gamma space
  21939. */
  21940. convertToGammaSpace: boolean;
  21941. /**
  21942. * Gets or sets a boolean indicating if content needs to be converted to linear space
  21943. */
  21944. convertToLinearSpace: boolean;
  21945. /**
  21946. * Create a new ParticleTextureBlock
  21947. * @param name defines the block name
  21948. */
  21949. constructor(name: string);
  21950. /**
  21951. * Gets the current class name
  21952. * @returns the class name
  21953. */
  21954. getClassName(): string;
  21955. /**
  21956. * Gets the uv input component
  21957. */
  21958. get uv(): NodeMaterialConnectionPoint;
  21959. /**
  21960. * Gets the rgba output component
  21961. */
  21962. get rgba(): NodeMaterialConnectionPoint;
  21963. /**
  21964. * Gets the rgb output component
  21965. */
  21966. get rgb(): NodeMaterialConnectionPoint;
  21967. /**
  21968. * Gets the r output component
  21969. */
  21970. get r(): NodeMaterialConnectionPoint;
  21971. /**
  21972. * Gets the g output component
  21973. */
  21974. get g(): NodeMaterialConnectionPoint;
  21975. /**
  21976. * Gets the b output component
  21977. */
  21978. get b(): NodeMaterialConnectionPoint;
  21979. /**
  21980. * Gets the a output component
  21981. */
  21982. get a(): NodeMaterialConnectionPoint;
  21983. /**
  21984. * Initialize the block and prepare the context for build
  21985. * @param state defines the state that will be used for the build
  21986. */
  21987. initialize(state: NodeMaterialBuildState): void;
  21988. autoConfigure(material: NodeMaterial): void;
  21989. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  21990. isReady(): boolean;
  21991. private _writeOutput;
  21992. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  21993. serialize(): any;
  21994. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  21995. }
  21996. }
  21997. declare module "babylonjs/Materials/Node/nodeMaterialBuildStateSharedData" {
  21998. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21999. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22000. import { InputBlock } from "babylonjs/Materials/Node/Blocks/Input/inputBlock";
  22001. import { TextureBlock } from "babylonjs/Materials/Node/Blocks/Dual/textureBlock";
  22002. import { ReflectionTextureBaseBlock } from "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBaseBlock";
  22003. import { RefractionBlock } from "babylonjs/Materials/Node/Blocks/PBR/refractionBlock";
  22004. import { CurrentScreenBlock } from "babylonjs/Materials/Node/Blocks/Dual/currentScreenBlock";
  22005. import { ParticleTextureBlock } from "babylonjs/Materials/Node/Blocks/Particle/particleTextureBlock";
  22006. import { Scene } from "babylonjs/scene";
  22007. /**
  22008. * Class used to store shared data between 2 NodeMaterialBuildState
  22009. */
  22010. export class NodeMaterialBuildStateSharedData {
  22011. /**
  22012. * Gets the list of emitted varyings
  22013. */
  22014. temps: string[];
  22015. /**
  22016. * Gets the list of emitted varyings
  22017. */
  22018. varyings: string[];
  22019. /**
  22020. * Gets the varying declaration string
  22021. */
  22022. varyingDeclaration: string;
  22023. /**
  22024. * Input blocks
  22025. */
  22026. inputBlocks: InputBlock[];
  22027. /**
  22028. * Input blocks
  22029. */
  22030. textureBlocks: (TextureBlock | ReflectionTextureBaseBlock | RefractionBlock | CurrentScreenBlock | ParticleTextureBlock)[];
  22031. /**
  22032. * Bindable blocks (Blocks that need to set data to the effect)
  22033. */
  22034. bindableBlocks: NodeMaterialBlock[];
  22035. /**
  22036. * List of blocks that can provide a compilation fallback
  22037. */
  22038. blocksWithFallbacks: NodeMaterialBlock[];
  22039. /**
  22040. * List of blocks that can provide a define update
  22041. */
  22042. blocksWithDefines: NodeMaterialBlock[];
  22043. /**
  22044. * List of blocks that can provide a repeatable content
  22045. */
  22046. repeatableContentBlocks: NodeMaterialBlock[];
  22047. /**
  22048. * List of blocks that can provide a dynamic list of uniforms
  22049. */
  22050. dynamicUniformBlocks: NodeMaterialBlock[];
  22051. /**
  22052. * List of blocks that can block the isReady function for the material
  22053. */
  22054. blockingBlocks: NodeMaterialBlock[];
  22055. /**
  22056. * Gets the list of animated inputs
  22057. */
  22058. animatedInputs: InputBlock[];
  22059. /**
  22060. * Build Id used to avoid multiple recompilations
  22061. */
  22062. buildId: number;
  22063. /** List of emitted variables */
  22064. variableNames: {
  22065. [key: string]: number;
  22066. };
  22067. /** List of emitted defines */
  22068. defineNames: {
  22069. [key: string]: number;
  22070. };
  22071. /** Should emit comments? */
  22072. emitComments: boolean;
  22073. /** Emit build activity */
  22074. verbose: boolean;
  22075. /** Gets or sets the hosting scene */
  22076. scene: Scene;
  22077. /**
  22078. * Gets the compilation hints emitted at compilation time
  22079. */
  22080. hints: {
  22081. needWorldViewMatrix: boolean;
  22082. needWorldViewProjectionMatrix: boolean;
  22083. needAlphaBlending: boolean;
  22084. needAlphaTesting: boolean;
  22085. };
  22086. /**
  22087. * List of compilation checks
  22088. */
  22089. checks: {
  22090. emitVertex: boolean;
  22091. emitFragment: boolean;
  22092. notConnectedNonOptionalInputs: NodeMaterialConnectionPoint[];
  22093. };
  22094. /**
  22095. * Is vertex program allowed to be empty?
  22096. */
  22097. allowEmptyVertexProgram: boolean;
  22098. /** Creates a new shared data */
  22099. constructor();
  22100. /**
  22101. * Emits console errors and exceptions if there is a failing check
  22102. */
  22103. emitErrors(): void;
  22104. }
  22105. }
  22106. declare module "babylonjs/Materials/Node/nodeMaterialBuildState" {
  22107. import { NodeMaterialBlockConnectionPointTypes } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  22108. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  22109. import { NodeMaterialBuildStateSharedData } from "babylonjs/Materials/Node/nodeMaterialBuildStateSharedData";
  22110. /**
  22111. * Class used to store node based material build state
  22112. */
  22113. export class NodeMaterialBuildState {
  22114. /** Gets or sets a boolean indicating if the current state can emit uniform buffers */
  22115. supportUniformBuffers: boolean;
  22116. /**
  22117. * Gets the list of emitted attributes
  22118. */
  22119. attributes: string[];
  22120. /**
  22121. * Gets the list of emitted uniforms
  22122. */
  22123. uniforms: string[];
  22124. /**
  22125. * Gets the list of emitted constants
  22126. */
  22127. constants: string[];
  22128. /**
  22129. * Gets the list of emitted samplers
  22130. */
  22131. samplers: string[];
  22132. /**
  22133. * Gets the list of emitted functions
  22134. */
  22135. functions: {
  22136. [key: string]: string;
  22137. };
  22138. /**
  22139. * Gets the list of emitted extensions
  22140. */
  22141. extensions: {
  22142. [key: string]: string;
  22143. };
  22144. /**
  22145. * Gets the target of the compilation state
  22146. */
  22147. target: NodeMaterialBlockTargets;
  22148. /**
  22149. * Gets the list of emitted counters
  22150. */
  22151. counters: {
  22152. [key: string]: number;
  22153. };
  22154. /**
  22155. * Shared data between multiple NodeMaterialBuildState instances
  22156. */
  22157. sharedData: NodeMaterialBuildStateSharedData;
  22158. /** @hidden */
  22159. _vertexState: NodeMaterialBuildState;
  22160. /** @hidden */
  22161. _attributeDeclaration: string;
  22162. /** @hidden */
  22163. _uniformDeclaration: string;
  22164. /** @hidden */
  22165. _constantDeclaration: string;
  22166. /** @hidden */
  22167. _samplerDeclaration: string;
  22168. /** @hidden */
  22169. _varyingTransfer: string;
  22170. /** @hidden */
  22171. _injectAtEnd: string;
  22172. private _repeatableContentAnchorIndex;
  22173. /** @hidden */
  22174. _builtCompilationString: string;
  22175. /**
  22176. * Gets the emitted compilation strings
  22177. */
  22178. compilationString: string;
  22179. /**
  22180. * Finalize the compilation strings
  22181. * @param state defines the current compilation state
  22182. */
  22183. finalize(state: NodeMaterialBuildState): void;
  22184. /** @hidden */
  22185. get _repeatableContentAnchor(): string;
  22186. /** @hidden */
  22187. _getFreeVariableName(prefix: string): string;
  22188. /** @hidden */
  22189. _getFreeDefineName(prefix: string): string;
  22190. /** @hidden */
  22191. _excludeVariableName(name: string): void;
  22192. /** @hidden */
  22193. _emit2DSampler(name: string): void;
  22194. /** @hidden */
  22195. _getGLType(type: NodeMaterialBlockConnectionPointTypes): string;
  22196. /** @hidden */
  22197. _emitExtension(name: string, extension: string, define?: string): void;
  22198. /** @hidden */
  22199. _emitFunction(name: string, code: string, comments: string): void;
  22200. /** @hidden */
  22201. _emitCodeFromInclude(includeName: string, comments: string, options?: {
  22202. replaceStrings?: {
  22203. search: RegExp;
  22204. replace: string;
  22205. }[];
  22206. repeatKey?: string;
  22207. }): string;
  22208. /** @hidden */
  22209. _emitFunctionFromInclude(includeName: string, comments: string, options?: {
  22210. repeatKey?: string;
  22211. removeAttributes?: boolean;
  22212. removeUniforms?: boolean;
  22213. removeVaryings?: boolean;
  22214. removeIfDef?: boolean;
  22215. replaceStrings?: {
  22216. search: RegExp;
  22217. replace: string;
  22218. }[];
  22219. }, storeKey?: string): void;
  22220. /** @hidden */
  22221. _registerTempVariable(name: string): boolean;
  22222. /** @hidden */
  22223. _emitVaryingFromString(name: string, type: string, define?: string, notDefine?: boolean): boolean;
  22224. /** @hidden */
  22225. _emitUniformFromString(name: string, type: string, define?: string, notDefine?: boolean): void;
  22226. /** @hidden */
  22227. _emitFloat(value: number): string;
  22228. }
  22229. }
  22230. declare module "babylonjs/Misc/uniqueIdGenerator" {
  22231. /**
  22232. * Helper class used to generate session unique ID
  22233. */
  22234. export class UniqueIdGenerator {
  22235. private static _UniqueIdCounter;
  22236. /**
  22237. * Gets an unique (relatively to the current scene) Id
  22238. */
  22239. static get UniqueId(): number;
  22240. }
  22241. }
  22242. declare module "babylonjs/Materials/Node/nodeMaterialBlock" {
  22243. import { NodeMaterialBlockConnectionPointTypes } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  22244. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22245. import { Nullable } from "babylonjs/types";
  22246. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22247. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  22248. import { Effect } from "babylonjs/Materials/effect";
  22249. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  22250. import { Mesh } from "babylonjs/Meshes/mesh";
  22251. import { SubMesh } from "babylonjs/Meshes/subMesh";
  22252. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  22253. import { Scene } from "babylonjs/scene";
  22254. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  22255. /**
  22256. * Defines a block that can be used inside a node based material
  22257. */
  22258. export class NodeMaterialBlock {
  22259. private _buildId;
  22260. private _buildTarget;
  22261. private _target;
  22262. private _isFinalMerger;
  22263. private _isInput;
  22264. private _name;
  22265. protected _isUnique: boolean;
  22266. /** Gets or sets a boolean indicating that only one input can be connected at a time */
  22267. inputsAreExclusive: boolean;
  22268. /** @hidden */
  22269. _codeVariableName: string;
  22270. /** @hidden */
  22271. _inputs: NodeMaterialConnectionPoint[];
  22272. /** @hidden */
  22273. _outputs: NodeMaterialConnectionPoint[];
  22274. /** @hidden */
  22275. _preparationId: number;
  22276. /**
  22277. * Gets the name of the block
  22278. */
  22279. get name(): string;
  22280. /**
  22281. * Sets the name of the block. Will check if the name is valid.
  22282. */
  22283. set name(newName: string);
  22284. /**
  22285. * Gets or sets the unique id of the node
  22286. */
  22287. uniqueId: number;
  22288. /**
  22289. * Gets or sets the comments associated with this block
  22290. */
  22291. comments: string;
  22292. /**
  22293. * Gets a boolean indicating that this block can only be used once per NodeMaterial
  22294. */
  22295. get isUnique(): boolean;
  22296. /**
  22297. * Gets a boolean indicating that this block is an end block (e.g. it is generating a system value)
  22298. */
  22299. get isFinalMerger(): boolean;
  22300. /**
  22301. * Gets a boolean indicating that this block is an input (e.g. it sends data to the shader)
  22302. */
  22303. get isInput(): boolean;
  22304. /**
  22305. * Gets or sets the build Id
  22306. */
  22307. get buildId(): number;
  22308. set buildId(value: number);
  22309. /**
  22310. * Gets or sets the target of the block
  22311. */
  22312. get target(): NodeMaterialBlockTargets;
  22313. set target(value: NodeMaterialBlockTargets);
  22314. /**
  22315. * Gets the list of input points
  22316. */
  22317. get inputs(): NodeMaterialConnectionPoint[];
  22318. /** Gets the list of output points */
  22319. get outputs(): NodeMaterialConnectionPoint[];
  22320. /**
  22321. * Find an input by its name
  22322. * @param name defines the name of the input to look for
  22323. * @returns the input or null if not found
  22324. */
  22325. getInputByName(name: string): Nullable<NodeMaterialConnectionPoint>;
  22326. /**
  22327. * Find an output by its name
  22328. * @param name defines the name of the outputto look for
  22329. * @returns the output or null if not found
  22330. */
  22331. getOutputByName(name: string): Nullable<NodeMaterialConnectionPoint>;
  22332. /**
  22333. * Creates a new NodeMaterialBlock
  22334. * @param name defines the block name
  22335. * @param target defines the target of that block (Vertex by default)
  22336. * @param isFinalMerger defines a boolean indicating that this block is an end block (e.g. it is generating a system value). Default is false
  22337. * @param isInput defines a boolean indicating that this block is an input (e.g. it sends data to the shader). Default is false
  22338. */
  22339. constructor(name: string, target?: NodeMaterialBlockTargets, isFinalMerger?: boolean, isInput?: boolean);
  22340. /**
  22341. * Initialize the block and prepare the context for build
  22342. * @param state defines the state that will be used for the build
  22343. */
  22344. initialize(state: NodeMaterialBuildState): void;
  22345. /**
  22346. * Bind data to effect. Will only be called for blocks with isBindable === true
  22347. * @param effect defines the effect to bind data to
  22348. * @param nodeMaterial defines the hosting NodeMaterial
  22349. * @param mesh defines the mesh that will be rendered
  22350. * @param subMesh defines the submesh that will be rendered
  22351. */
  22352. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  22353. protected _declareOutput(output: NodeMaterialConnectionPoint, state: NodeMaterialBuildState): string;
  22354. protected _writeVariable(currentPoint: NodeMaterialConnectionPoint): string;
  22355. protected _writeFloat(value: number): string;
  22356. /**
  22357. * Gets the current class name e.g. "NodeMaterialBlock"
  22358. * @returns the class name
  22359. */
  22360. getClassName(): string;
  22361. /**
  22362. * Register a new input. Must be called inside a block constructor
  22363. * @param name defines the connection point name
  22364. * @param type defines the connection point type
  22365. * @param isOptional defines a boolean indicating that this input can be omitted
  22366. * @param target defines the target to use to limit the connection point (will be VertexAndFragment by default)
  22367. * @param point an already created connection point. If not provided, create a new one
  22368. * @returns the current block
  22369. */
  22370. registerInput(name: string, type: NodeMaterialBlockConnectionPointTypes, isOptional?: boolean, target?: NodeMaterialBlockTargets, point?: NodeMaterialConnectionPoint): this;
  22371. /**
  22372. * Register a new output. Must be called inside a block constructor
  22373. * @param name defines the connection point name
  22374. * @param type defines the connection point type
  22375. * @param target defines the target to use to limit the connection point (will be VertexAndFragment by default)
  22376. * @param point an already created connection point. If not provided, create a new one
  22377. * @returns the current block
  22378. */
  22379. registerOutput(name: string, type: NodeMaterialBlockConnectionPointTypes, target?: NodeMaterialBlockTargets, point?: NodeMaterialConnectionPoint): this;
  22380. /**
  22381. * Will return the first available input e.g. the first one which is not an uniform or an attribute
  22382. * @param forOutput defines an optional connection point to check compatibility with
  22383. * @returns the first available input or null
  22384. */
  22385. getFirstAvailableInput(forOutput?: Nullable<NodeMaterialConnectionPoint>): Nullable<NodeMaterialConnectionPoint>;
  22386. /**
  22387. * Will return the first available output e.g. the first one which is not yet connected and not a varying
  22388. * @param forBlock defines an optional block to check compatibility with
  22389. * @returns the first available input or null
  22390. */
  22391. getFirstAvailableOutput(forBlock?: Nullable<NodeMaterialBlock>): Nullable<NodeMaterialConnectionPoint>;
  22392. /**
  22393. * Gets the sibling of the given output
  22394. * @param current defines the current output
  22395. * @returns the next output in the list or null
  22396. */
  22397. getSiblingOutput(current: NodeMaterialConnectionPoint): Nullable<NodeMaterialConnectionPoint>;
  22398. /**
  22399. * Connect current block with another block
  22400. * @param other defines the block to connect with
  22401. * @param options define the various options to help pick the right connections
  22402. * @returns the current block
  22403. */
  22404. connectTo(other: NodeMaterialBlock, options?: {
  22405. input?: string;
  22406. output?: string;
  22407. outputSwizzle?: string;
  22408. }): this | undefined;
  22409. protected _buildBlock(state: NodeMaterialBuildState): void;
  22410. /**
  22411. * Add uniforms, samplers and uniform buffers at compilation time
  22412. * @param state defines the state to update
  22413. * @param nodeMaterial defines the node material requesting the update
  22414. * @param defines defines the material defines to update
  22415. * @param uniformBuffers defines the list of uniform buffer names
  22416. */
  22417. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  22418. /**
  22419. * Add potential fallbacks if shader compilation fails
  22420. * @param mesh defines the mesh to be rendered
  22421. * @param fallbacks defines the current prioritized list of fallbacks
  22422. */
  22423. provideFallbacks(mesh: AbstractMesh, fallbacks: EffectFallbacks): void;
  22424. /**
  22425. * Initialize defines for shader compilation
  22426. * @param mesh defines the mesh to be rendered
  22427. * @param nodeMaterial defines the node material requesting the update
  22428. * @param defines defines the material defines to update
  22429. * @param useInstances specifies that instances should be used
  22430. */
  22431. initializeDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  22432. /**
  22433. * Update defines for shader compilation
  22434. * @param mesh defines the mesh to be rendered
  22435. * @param nodeMaterial defines the node material requesting the update
  22436. * @param defines defines the material defines to update
  22437. * @param useInstances specifies that instances should be used
  22438. * @param subMesh defines which submesh to render
  22439. */
  22440. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  22441. /**
  22442. * Lets the block try to connect some inputs automatically
  22443. * @param material defines the hosting NodeMaterial
  22444. */
  22445. autoConfigure(material: NodeMaterial): void;
  22446. /**
  22447. * Function called when a block is declared as repeatable content generator
  22448. * @param vertexShaderState defines the current compilation state for the vertex shader
  22449. * @param fragmentShaderState defines the current compilation state for the fragment shader
  22450. * @param mesh defines the mesh to be rendered
  22451. * @param defines defines the material defines to update
  22452. */
  22453. replaceRepeatableContent(vertexShaderState: NodeMaterialBuildState, fragmentShaderState: NodeMaterialBuildState, mesh: AbstractMesh, defines: NodeMaterialDefines): void;
  22454. /**
  22455. * Checks if the block is ready
  22456. * @param mesh defines the mesh to be rendered
  22457. * @param nodeMaterial defines the node material requesting the update
  22458. * @param defines defines the material defines to update
  22459. * @param useInstances specifies that instances should be used
  22460. * @returns true if the block is ready
  22461. */
  22462. isReady(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): boolean;
  22463. protected _linkConnectionTypes(inputIndex0: number, inputIndex1: number): void;
  22464. private _processBuild;
  22465. /**
  22466. * Validates the new name for the block node.
  22467. * @param newName the new name to be given to the node.
  22468. * @returns false if the name is a reserve word, else true.
  22469. */
  22470. validateBlockName(newName: string): boolean;
  22471. /**
  22472. * Compile the current node and generate the shader code
  22473. * @param state defines the current compilation state (uniforms, samplers, current string)
  22474. * @param activeBlocks defines the list of active blocks (i.e. blocks to compile)
  22475. * @returns true if already built
  22476. */
  22477. build(state: NodeMaterialBuildState, activeBlocks: NodeMaterialBlock[]): boolean;
  22478. protected _inputRename(name: string): string;
  22479. protected _outputRename(name: string): string;
  22480. protected _dumpPropertiesCode(): string;
  22481. /** @hidden */
  22482. _dumpCode(uniqueNames: string[], alreadyDumped: NodeMaterialBlock[]): string;
  22483. /** @hidden */
  22484. _dumpCodeForOutputConnections(alreadyDumped: NodeMaterialBlock[]): string;
  22485. /**
  22486. * Clone the current block to a new identical block
  22487. * @param scene defines the hosting scene
  22488. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  22489. * @returns a copy of the current block
  22490. */
  22491. clone(scene: Scene, rootUrl?: string): Nullable<NodeMaterialBlock>;
  22492. /**
  22493. * Serializes this block in a JSON representation
  22494. * @returns the serialized block object
  22495. */
  22496. serialize(): any;
  22497. /** @hidden */
  22498. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  22499. private _deserializePortDisplayNamesAndExposedOnFrame;
  22500. /**
  22501. * Release resources
  22502. */
  22503. dispose(): void;
  22504. }
  22505. }
  22506. declare module "babylonjs/Materials/pushMaterial" {
  22507. import { Nullable } from "babylonjs/types";
  22508. import { Scene } from "babylonjs/scene";
  22509. import { Matrix } from "babylonjs/Maths/math.vector";
  22510. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  22511. import { Mesh } from "babylonjs/Meshes/mesh";
  22512. import { Material } from "babylonjs/Materials/material";
  22513. import { Effect } from "babylonjs/Materials/effect";
  22514. import { SubMesh } from "babylonjs/Meshes/subMesh";
  22515. /**
  22516. * Base class of materials working in push mode in babylon JS
  22517. * @hidden
  22518. */
  22519. export class PushMaterial extends Material {
  22520. protected _activeEffect: Effect;
  22521. protected _normalMatrix: Matrix;
  22522. constructor(name: string, scene: Scene);
  22523. getEffect(): Effect;
  22524. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  22525. protected _isReadyForSubMesh(subMesh: SubMesh): boolean;
  22526. /**
  22527. * Binds the given world matrix to the active effect
  22528. *
  22529. * @param world the matrix to bind
  22530. */
  22531. bindOnlyWorldMatrix(world: Matrix): void;
  22532. /**
  22533. * Binds the given normal matrix to the active effect
  22534. *
  22535. * @param normalMatrix the matrix to bind
  22536. */
  22537. bindOnlyNormalMatrix(normalMatrix: Matrix): void;
  22538. bind(world: Matrix, mesh?: Mesh): void;
  22539. protected _afterBind(mesh: Mesh, effect?: Nullable<Effect>): void;
  22540. protected _mustRebind(scene: Scene, effect: Effect, visibility?: number): boolean;
  22541. }
  22542. }
  22543. declare module "babylonjs/Materials/Node/Optimizers/nodeMaterialOptimizer" {
  22544. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22545. /**
  22546. * Root class for all node material optimizers
  22547. */
  22548. export class NodeMaterialOptimizer {
  22549. /**
  22550. * Function used to optimize a NodeMaterial graph
  22551. * @param vertexOutputNodes defines the list of output nodes for the vertex shader
  22552. * @param fragmentOutputNodes defines the list of output nodes for the fragment shader
  22553. */
  22554. optimize(vertexOutputNodes: NodeMaterialBlock[], fragmentOutputNodes: NodeMaterialBlock[]): void;
  22555. }
  22556. }
  22557. declare module "babylonjs/Materials/Node/Blocks/transformBlock" {
  22558. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22559. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22560. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22561. import { Scene } from "babylonjs/scene";
  22562. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  22563. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  22564. import { SubMesh } from "babylonjs/Meshes/subMesh";
  22565. /**
  22566. * Block used to transform a vector (2, 3 or 4) with a matrix. It will generate a Vector4
  22567. */
  22568. export class TransformBlock extends NodeMaterialBlock {
  22569. /**
  22570. * Defines the value to use to complement W value to transform it to a Vector4
  22571. */
  22572. complementW: number;
  22573. /**
  22574. * Defines the value to use to complement z value to transform it to a Vector4
  22575. */
  22576. complementZ: number;
  22577. /**
  22578. * Creates a new TransformBlock
  22579. * @param name defines the block name
  22580. */
  22581. constructor(name: string);
  22582. /**
  22583. * Gets the current class name
  22584. * @returns the class name
  22585. */
  22586. getClassName(): string;
  22587. /**
  22588. * Gets the vector input
  22589. */
  22590. get vector(): NodeMaterialConnectionPoint;
  22591. /**
  22592. * Gets the output component
  22593. */
  22594. get output(): NodeMaterialConnectionPoint;
  22595. /**
  22596. * Gets the xyz output component
  22597. */
  22598. get xyz(): NodeMaterialConnectionPoint;
  22599. /**
  22600. * Gets the matrix transform input
  22601. */
  22602. get transform(): NodeMaterialConnectionPoint;
  22603. protected _buildBlock(state: NodeMaterialBuildState): this;
  22604. /**
  22605. * Update defines for shader compilation
  22606. * @param mesh defines the mesh to be rendered
  22607. * @param nodeMaterial defines the node material requesting the update
  22608. * @param defines defines the material defines to update
  22609. * @param useInstances specifies that instances should be used
  22610. * @param subMesh defines which submesh to render
  22611. */
  22612. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  22613. serialize(): any;
  22614. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  22615. protected _dumpPropertiesCode(): string;
  22616. }
  22617. }
  22618. declare module "babylonjs/Materials/Node/Blocks/Vertex/vertexOutputBlock" {
  22619. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22620. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22621. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22622. /**
  22623. * Block used to output the vertex position
  22624. */
  22625. export class VertexOutputBlock extends NodeMaterialBlock {
  22626. /**
  22627. * Creates a new VertexOutputBlock
  22628. * @param name defines the block name
  22629. */
  22630. constructor(name: string);
  22631. /**
  22632. * Gets the current class name
  22633. * @returns the class name
  22634. */
  22635. getClassName(): string;
  22636. /**
  22637. * Gets the vector input component
  22638. */
  22639. get vector(): NodeMaterialConnectionPoint;
  22640. protected _buildBlock(state: NodeMaterialBuildState): this;
  22641. }
  22642. }
  22643. declare module "babylonjs/Materials/Node/Blocks/Fragment/fragmentOutputBlock" {
  22644. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22645. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22646. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22647. /**
  22648. * Block used to output the final color
  22649. */
  22650. export class FragmentOutputBlock extends NodeMaterialBlock {
  22651. /**
  22652. * Create a new FragmentOutputBlock
  22653. * @param name defines the block name
  22654. */
  22655. constructor(name: string);
  22656. /**
  22657. * Gets the current class name
  22658. * @returns the class name
  22659. */
  22660. getClassName(): string;
  22661. /**
  22662. * Gets the rgba input component
  22663. */
  22664. get rgba(): NodeMaterialConnectionPoint;
  22665. /**
  22666. * Gets the rgb input component
  22667. */
  22668. get rgb(): NodeMaterialConnectionPoint;
  22669. /**
  22670. * Gets the a input component
  22671. */
  22672. get a(): NodeMaterialConnectionPoint;
  22673. protected _buildBlock(state: NodeMaterialBuildState): this;
  22674. }
  22675. }
  22676. declare module "babylonjs/Materials/Node/Blocks/Particle/particleRampGradientBlock" {
  22677. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22678. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22679. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22680. /**
  22681. * Block used for the particle ramp gradient section
  22682. */
  22683. export class ParticleRampGradientBlock extends NodeMaterialBlock {
  22684. /**
  22685. * Create a new ParticleRampGradientBlock
  22686. * @param name defines the block name
  22687. */
  22688. constructor(name: string);
  22689. /**
  22690. * Gets the current class name
  22691. * @returns the class name
  22692. */
  22693. getClassName(): string;
  22694. /**
  22695. * Gets the color input component
  22696. */
  22697. get color(): NodeMaterialConnectionPoint;
  22698. /**
  22699. * Gets the rampColor output component
  22700. */
  22701. get rampColor(): NodeMaterialConnectionPoint;
  22702. /**
  22703. * Initialize the block and prepare the context for build
  22704. * @param state defines the state that will be used for the build
  22705. */
  22706. initialize(state: NodeMaterialBuildState): void;
  22707. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  22708. }
  22709. }
  22710. declare module "babylonjs/Materials/Node/Blocks/Particle/particleBlendMultiplyBlock" {
  22711. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22712. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22713. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22714. /**
  22715. * Block used for the particle blend multiply section
  22716. */
  22717. export class ParticleBlendMultiplyBlock extends NodeMaterialBlock {
  22718. /**
  22719. * Create a new ParticleBlendMultiplyBlock
  22720. * @param name defines the block name
  22721. */
  22722. constructor(name: string);
  22723. /**
  22724. * Gets the current class name
  22725. * @returns the class name
  22726. */
  22727. getClassName(): string;
  22728. /**
  22729. * Gets the color input component
  22730. */
  22731. get color(): NodeMaterialConnectionPoint;
  22732. /**
  22733. * Gets the alphaTexture input component
  22734. */
  22735. get alphaTexture(): NodeMaterialConnectionPoint;
  22736. /**
  22737. * Gets the alphaColor input component
  22738. */
  22739. get alphaColor(): NodeMaterialConnectionPoint;
  22740. /**
  22741. * Gets the blendColor output component
  22742. */
  22743. get blendColor(): NodeMaterialConnectionPoint;
  22744. /**
  22745. * Initialize the block and prepare the context for build
  22746. * @param state defines the state that will be used for the build
  22747. */
  22748. initialize(state: NodeMaterialBuildState): void;
  22749. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  22750. }
  22751. }
  22752. declare module "babylonjs/Materials/Node/Blocks/vectorMergerBlock" {
  22753. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22754. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22755. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22756. /**
  22757. * Block used to create a Vector2/3/4 out of individual inputs (one for each component)
  22758. */
  22759. export class VectorMergerBlock extends NodeMaterialBlock {
  22760. /**
  22761. * Create a new VectorMergerBlock
  22762. * @param name defines the block name
  22763. */
  22764. constructor(name: string);
  22765. /**
  22766. * Gets the current class name
  22767. * @returns the class name
  22768. */
  22769. getClassName(): string;
  22770. /**
  22771. * Gets the xyz component (input)
  22772. */
  22773. get xyzIn(): NodeMaterialConnectionPoint;
  22774. /**
  22775. * Gets the xy component (input)
  22776. */
  22777. get xyIn(): NodeMaterialConnectionPoint;
  22778. /**
  22779. * Gets the x component (input)
  22780. */
  22781. get x(): NodeMaterialConnectionPoint;
  22782. /**
  22783. * Gets the y component (input)
  22784. */
  22785. get y(): NodeMaterialConnectionPoint;
  22786. /**
  22787. * Gets the z component (input)
  22788. */
  22789. get z(): NodeMaterialConnectionPoint;
  22790. /**
  22791. * Gets the w component (input)
  22792. */
  22793. get w(): NodeMaterialConnectionPoint;
  22794. /**
  22795. * Gets the xyzw component (output)
  22796. */
  22797. get xyzw(): NodeMaterialConnectionPoint;
  22798. /**
  22799. * Gets the xyz component (output)
  22800. */
  22801. get xyzOut(): NodeMaterialConnectionPoint;
  22802. /**
  22803. * Gets the xy component (output)
  22804. */
  22805. get xyOut(): NodeMaterialConnectionPoint;
  22806. /**
  22807. * Gets the xy component (output)
  22808. * @deprecated Please use xyOut instead.
  22809. */
  22810. get xy(): NodeMaterialConnectionPoint;
  22811. /**
  22812. * Gets the xyz component (output)
  22813. * @deprecated Please use xyzOut instead.
  22814. */
  22815. get xyz(): NodeMaterialConnectionPoint;
  22816. protected _buildBlock(state: NodeMaterialBuildState): this;
  22817. }
  22818. }
  22819. declare module "babylonjs/Materials/Node/Blocks/remapBlock" {
  22820. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22821. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22822. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22823. import { Vector2 } from "babylonjs/Maths/math.vector";
  22824. import { Scene } from "babylonjs/scene";
  22825. /**
  22826. * Block used to remap a float from a range to a new one
  22827. */
  22828. export class RemapBlock extends NodeMaterialBlock {
  22829. /**
  22830. * Gets or sets the source range
  22831. */
  22832. sourceRange: Vector2;
  22833. /**
  22834. * Gets or sets the target range
  22835. */
  22836. targetRange: Vector2;
  22837. /**
  22838. * Creates a new RemapBlock
  22839. * @param name defines the block name
  22840. */
  22841. constructor(name: string);
  22842. /**
  22843. * Gets the current class name
  22844. * @returns the class name
  22845. */
  22846. getClassName(): string;
  22847. /**
  22848. * Gets the input component
  22849. */
  22850. get input(): NodeMaterialConnectionPoint;
  22851. /**
  22852. * Gets the source min input component
  22853. */
  22854. get sourceMin(): NodeMaterialConnectionPoint;
  22855. /**
  22856. * Gets the source max input component
  22857. */
  22858. get sourceMax(): NodeMaterialConnectionPoint;
  22859. /**
  22860. * Gets the target min input component
  22861. */
  22862. get targetMin(): NodeMaterialConnectionPoint;
  22863. /**
  22864. * Gets the target max input component
  22865. */
  22866. get targetMax(): NodeMaterialConnectionPoint;
  22867. /**
  22868. * Gets the output component
  22869. */
  22870. get output(): NodeMaterialConnectionPoint;
  22871. protected _buildBlock(state: NodeMaterialBuildState): this;
  22872. protected _dumpPropertiesCode(): string;
  22873. serialize(): any;
  22874. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  22875. }
  22876. }
  22877. declare module "babylonjs/Materials/Node/Blocks/multiplyBlock" {
  22878. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22879. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22880. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22881. /**
  22882. * Block used to multiply 2 values
  22883. */
  22884. export class MultiplyBlock extends NodeMaterialBlock {
  22885. /**
  22886. * Creates a new MultiplyBlock
  22887. * @param name defines the block name
  22888. */
  22889. constructor(name: string);
  22890. /**
  22891. * Gets the current class name
  22892. * @returns the class name
  22893. */
  22894. getClassName(): string;
  22895. /**
  22896. * Gets the left operand input component
  22897. */
  22898. get left(): NodeMaterialConnectionPoint;
  22899. /**
  22900. * Gets the right operand input component
  22901. */
  22902. get right(): NodeMaterialConnectionPoint;
  22903. /**
  22904. * Gets the output component
  22905. */
  22906. get output(): NodeMaterialConnectionPoint;
  22907. protected _buildBlock(state: NodeMaterialBuildState): this;
  22908. }
  22909. }
  22910. declare module "babylonjs/Materials/Node/Blocks/colorSplitterBlock" {
  22911. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22912. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22913. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22914. /**
  22915. * Block used to expand a Color3/4 into 4 outputs (one for each component)
  22916. */
  22917. export class ColorSplitterBlock extends NodeMaterialBlock {
  22918. /**
  22919. * Create a new ColorSplitterBlock
  22920. * @param name defines the block name
  22921. */
  22922. constructor(name: string);
  22923. /**
  22924. * Gets the current class name
  22925. * @returns the class name
  22926. */
  22927. getClassName(): string;
  22928. /**
  22929. * Gets the rgba component (input)
  22930. */
  22931. get rgba(): NodeMaterialConnectionPoint;
  22932. /**
  22933. * Gets the rgb component (input)
  22934. */
  22935. get rgbIn(): NodeMaterialConnectionPoint;
  22936. /**
  22937. * Gets the rgb component (output)
  22938. */
  22939. get rgbOut(): NodeMaterialConnectionPoint;
  22940. /**
  22941. * Gets the r component (output)
  22942. */
  22943. get r(): NodeMaterialConnectionPoint;
  22944. /**
  22945. * Gets the g component (output)
  22946. */
  22947. get g(): NodeMaterialConnectionPoint;
  22948. /**
  22949. * Gets the b component (output)
  22950. */
  22951. get b(): NodeMaterialConnectionPoint;
  22952. /**
  22953. * Gets the a component (output)
  22954. */
  22955. get a(): NodeMaterialConnectionPoint;
  22956. protected _inputRename(name: string): string;
  22957. protected _outputRename(name: string): string;
  22958. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  22959. }
  22960. }
  22961. declare module "babylonjs/Materials/Node/nodeMaterial" {
  22962. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22963. import { PushMaterial } from "babylonjs/Materials/pushMaterial";
  22964. import { Scene } from "babylonjs/scene";
  22965. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  22966. import { Matrix } from "babylonjs/Maths/math.vector";
  22967. import { Mesh } from "babylonjs/Meshes/mesh";
  22968. import { Engine } from "babylonjs/Engines/engine";
  22969. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  22970. import { Observable } from "babylonjs/Misc/observable";
  22971. import { SubMesh } from "babylonjs/Meshes/subMesh";
  22972. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  22973. import { NodeMaterialOptimizer } from "babylonjs/Materials/Node/Optimizers/nodeMaterialOptimizer";
  22974. import { ImageProcessingConfiguration, IImageProcessingConfigurationDefines } from "babylonjs/Materials/imageProcessingConfiguration";
  22975. import { Nullable } from "babylonjs/types";
  22976. import { InputBlock } from "babylonjs/Materials/Node/Blocks/Input/inputBlock";
  22977. import { TextureBlock } from "babylonjs/Materials/Node/Blocks/Dual/textureBlock";
  22978. import { ReflectionTextureBaseBlock } from "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBaseBlock";
  22979. import { RefractionBlock } from "babylonjs/Materials/Node/Blocks/PBR/refractionBlock";
  22980. import { CurrentScreenBlock } from "babylonjs/Materials/Node/Blocks/Dual/currentScreenBlock";
  22981. import { ParticleTextureBlock } from "babylonjs/Materials/Node/Blocks/Particle/particleTextureBlock";
  22982. import { Effect } from "babylonjs/Materials/effect";
  22983. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  22984. import { Camera } from "babylonjs/Cameras/camera";
  22985. import { NodeMaterialModes } from "babylonjs/Materials/Node/Enums/nodeMaterialModes";
  22986. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  22987. /**
  22988. * Interface used to configure the node material editor
  22989. */
  22990. export interface INodeMaterialEditorOptions {
  22991. /** Define the URl to load node editor script */
  22992. editorURL?: string;
  22993. }
  22994. /** @hidden */
  22995. export class NodeMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  22996. NORMAL: boolean;
  22997. TANGENT: boolean;
  22998. UV1: boolean;
  22999. /** BONES */
  23000. NUM_BONE_INFLUENCERS: number;
  23001. BonesPerMesh: number;
  23002. BONETEXTURE: boolean;
  23003. /** MORPH TARGETS */
  23004. MORPHTARGETS: boolean;
  23005. MORPHTARGETS_NORMAL: boolean;
  23006. MORPHTARGETS_TANGENT: boolean;
  23007. MORPHTARGETS_UV: boolean;
  23008. NUM_MORPH_INFLUENCERS: number;
  23009. /** IMAGE PROCESSING */
  23010. IMAGEPROCESSING: boolean;
  23011. VIGNETTE: boolean;
  23012. VIGNETTEBLENDMODEMULTIPLY: boolean;
  23013. VIGNETTEBLENDMODEOPAQUE: boolean;
  23014. TONEMAPPING: boolean;
  23015. TONEMAPPING_ACES: boolean;
  23016. CONTRAST: boolean;
  23017. EXPOSURE: boolean;
  23018. COLORCURVES: boolean;
  23019. COLORGRADING: boolean;
  23020. COLORGRADING3D: boolean;
  23021. SAMPLER3DGREENDEPTH: boolean;
  23022. SAMPLER3DBGRMAP: boolean;
  23023. IMAGEPROCESSINGPOSTPROCESS: boolean;
  23024. /** MISC. */
  23025. BUMPDIRECTUV: number;
  23026. constructor();
  23027. setValue(name: string, value: any, markAsUnprocessedIfDirty?: boolean): void;
  23028. }
  23029. /**
  23030. * Class used to configure NodeMaterial
  23031. */
  23032. export interface INodeMaterialOptions {
  23033. /**
  23034. * Defines if blocks should emit comments
  23035. */
  23036. emitComments: boolean;
  23037. }
  23038. /**
  23039. * Class used to create a node based material built by assembling shader blocks
  23040. */
  23041. export class NodeMaterial extends PushMaterial {
  23042. private static _BuildIdGenerator;
  23043. private _options;
  23044. private _vertexCompilationState;
  23045. private _fragmentCompilationState;
  23046. private _sharedData;
  23047. private _buildId;
  23048. private _buildWasSuccessful;
  23049. private _cachedWorldViewMatrix;
  23050. private _cachedWorldViewProjectionMatrix;
  23051. private _optimizers;
  23052. private _animationFrame;
  23053. /** Define the Url to load node editor script */
  23054. static EditorURL: string;
  23055. /** Define the Url to load snippets */
  23056. static SnippetUrl: string;
  23057. /** Gets or sets a boolean indicating that node materials should not deserialize textures from json / snippet content */
  23058. static IgnoreTexturesAtLoadTime: boolean;
  23059. private BJSNODEMATERIALEDITOR;
  23060. /** Get the inspector from bundle or global */
  23061. private _getGlobalNodeMaterialEditor;
  23062. /**
  23063. * Snippet ID if the material was created from the snippet server
  23064. */
  23065. snippetId: string;
  23066. /**
  23067. * Gets or sets data used by visual editor
  23068. * @see https://nme.babylonjs.com
  23069. */
  23070. editorData: any;
  23071. /**
  23072. * Gets or sets a boolean indicating that alpha value must be ignored (This will turn alpha blending off even if an alpha value is produced by the material)
  23073. */
  23074. ignoreAlpha: boolean;
  23075. /**
  23076. * Defines the maximum number of lights that can be used in the material
  23077. */
  23078. maxSimultaneousLights: number;
  23079. /**
  23080. * Observable raised when the material is built
  23081. */
  23082. onBuildObservable: Observable<NodeMaterial>;
  23083. /**
  23084. * Gets or sets the root nodes of the material vertex shader
  23085. */
  23086. _vertexOutputNodes: NodeMaterialBlock[];
  23087. /**
  23088. * Gets or sets the root nodes of the material fragment (pixel) shader
  23089. */
  23090. _fragmentOutputNodes: NodeMaterialBlock[];
  23091. /** Gets or sets options to control the node material overall behavior */
  23092. get options(): INodeMaterialOptions;
  23093. set options(options: INodeMaterialOptions);
  23094. /**
  23095. * Default configuration related to image processing available in the standard Material.
  23096. */
  23097. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  23098. /**
  23099. * Gets the image processing configuration used either in this material.
  23100. */
  23101. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  23102. /**
  23103. * Sets the Default image processing configuration used either in the this material.
  23104. *
  23105. * If sets to null, the scene one is in use.
  23106. */
  23107. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  23108. /**
  23109. * Gets an array of blocks that needs to be serialized even if they are not yet connected
  23110. */
  23111. attachedBlocks: NodeMaterialBlock[];
  23112. /**
  23113. * Specifies the mode of the node material
  23114. * @hidden
  23115. */
  23116. _mode: NodeMaterialModes;
  23117. /**
  23118. * Gets the mode property
  23119. */
  23120. get mode(): NodeMaterialModes;
  23121. /**
  23122. * Create a new node based material
  23123. * @param name defines the material name
  23124. * @param scene defines the hosting scene
  23125. * @param options defines creation option
  23126. */
  23127. constructor(name: string, scene?: Scene, options?: Partial<INodeMaterialOptions>);
  23128. /**
  23129. * Gets the current class name of the material e.g. "NodeMaterial"
  23130. * @returns the class name
  23131. */
  23132. getClassName(): string;
  23133. /**
  23134. * Keep track of the image processing observer to allow dispose and replace.
  23135. */
  23136. private _imageProcessingObserver;
  23137. /**
  23138. * Attaches a new image processing configuration to the Standard Material.
  23139. * @param configuration
  23140. */
  23141. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  23142. /**
  23143. * Get a block by its name
  23144. * @param name defines the name of the block to retrieve
  23145. * @returns the required block or null if not found
  23146. */
  23147. getBlockByName(name: string): Nullable<NodeMaterialBlock>;
  23148. /**
  23149. * Get a block by its name
  23150. * @param predicate defines the predicate used to find the good candidate
  23151. * @returns the required block or null if not found
  23152. */
  23153. getBlockByPredicate(predicate: (block: NodeMaterialBlock) => boolean): Nullable<NodeMaterialBlock>;
  23154. /**
  23155. * Get an input block by its name
  23156. * @param predicate defines the predicate used to find the good candidate
  23157. * @returns the required input block or null if not found
  23158. */
  23159. getInputBlockByPredicate(predicate: (block: InputBlock) => boolean): Nullable<InputBlock>;
  23160. /**
  23161. * Gets the list of input blocks attached to this material
  23162. * @returns an array of InputBlocks
  23163. */
  23164. getInputBlocks(): InputBlock[];
  23165. /**
  23166. * Adds a new optimizer to the list of optimizers
  23167. * @param optimizer defines the optimizers to add
  23168. * @returns the current material
  23169. */
  23170. registerOptimizer(optimizer: NodeMaterialOptimizer): this | undefined;
  23171. /**
  23172. * Remove an optimizer from the list of optimizers
  23173. * @param optimizer defines the optimizers to remove
  23174. * @returns the current material
  23175. */
  23176. unregisterOptimizer(optimizer: NodeMaterialOptimizer): this | undefined;
  23177. /**
  23178. * Add a new block to the list of output nodes
  23179. * @param node defines the node to add
  23180. * @returns the current material
  23181. */
  23182. addOutputNode(node: NodeMaterialBlock): this;
  23183. /**
  23184. * Remove a block from the list of root nodes
  23185. * @param node defines the node to remove
  23186. * @returns the current material
  23187. */
  23188. removeOutputNode(node: NodeMaterialBlock): this;
  23189. private _addVertexOutputNode;
  23190. private _removeVertexOutputNode;
  23191. private _addFragmentOutputNode;
  23192. private _removeFragmentOutputNode;
  23193. /**
  23194. * Specifies if the material will require alpha blending
  23195. * @returns a boolean specifying if alpha blending is needed
  23196. */
  23197. needAlphaBlending(): boolean;
  23198. /**
  23199. * Specifies if this material should be rendered in alpha test mode
  23200. * @returns a boolean specifying if an alpha test is needed.
  23201. */
  23202. needAlphaTesting(): boolean;
  23203. private _initializeBlock;
  23204. private _resetDualBlocks;
  23205. /**
  23206. * Remove a block from the current node material
  23207. * @param block defines the block to remove
  23208. */
  23209. removeBlock(block: NodeMaterialBlock): void;
  23210. /**
  23211. * Build the material and generates the inner effect
  23212. * @param verbose defines if the build should log activity
  23213. */
  23214. build(verbose?: boolean): void;
  23215. /**
  23216. * Runs an otpimization phase to try to improve the shader code
  23217. */
  23218. optimize(): void;
  23219. private _prepareDefinesForAttributes;
  23220. /**
  23221. * Create a post process from the material
  23222. * @param camera The camera to apply the render pass to.
  23223. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  23224. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  23225. * @param engine The engine which the post process will be applied. (default: current engine)
  23226. * @param reusable If the post process can be reused on the same frame. (default: false)
  23227. * @param textureType Type of textures used when performing the post process. (default: 0)
  23228. * @param textureFormat Format of textures used when performing the post process. (default: TEXTUREFORMAT_RGBA)
  23229. * @returns the post process created
  23230. */
  23231. createPostProcess(camera: Nullable<Camera>, options?: number | PostProcessOptions, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, textureFormat?: number): PostProcess;
  23232. /**
  23233. * Create the post process effect from the material
  23234. * @param postProcess The post process to create the effect for
  23235. */
  23236. createEffectForPostProcess(postProcess: PostProcess): void;
  23237. private _createEffectOrPostProcess;
  23238. private _createEffectForParticles;
  23239. /**
  23240. * Create the effect to be used as the custom effect for a particle system
  23241. * @param particleSystem Particle system to create the effect for
  23242. * @param onCompiled defines a function to call when the effect creation is successful
  23243. * @param onError defines a function to call when the effect creation has failed
  23244. */
  23245. createEffectForParticles(particleSystem: IParticleSystem, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  23246. private _processDefines;
  23247. /**
  23248. * Get if the submesh is ready to be used and all its information available.
  23249. * Child classes can use it to update shaders
  23250. * @param mesh defines the mesh to check
  23251. * @param subMesh defines which submesh to check
  23252. * @param useInstances specifies that instances should be used
  23253. * @returns a boolean indicating that the submesh is ready or not
  23254. */
  23255. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  23256. /**
  23257. * Get a string representing the shaders built by the current node graph
  23258. */
  23259. get compiledShaders(): string;
  23260. /**
  23261. * Binds the world matrix to the material
  23262. * @param world defines the world transformation matrix
  23263. */
  23264. bindOnlyWorldMatrix(world: Matrix): void;
  23265. /**
  23266. * Binds the submesh to this material by preparing the effect and shader to draw
  23267. * @param world defines the world transformation matrix
  23268. * @param mesh defines the mesh containing the submesh
  23269. * @param subMesh defines the submesh to bind the material to
  23270. */
  23271. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  23272. /**
  23273. * Gets the active textures from the material
  23274. * @returns an array of textures
  23275. */
  23276. getActiveTextures(): BaseTexture[];
  23277. /**
  23278. * Gets the list of texture blocks
  23279. * @returns an array of texture blocks
  23280. */
  23281. getTextureBlocks(): (TextureBlock | ReflectionTextureBaseBlock | RefractionBlock | CurrentScreenBlock | ParticleTextureBlock)[];
  23282. /**
  23283. * Specifies if the material uses a texture
  23284. * @param texture defines the texture to check against the material
  23285. * @returns a boolean specifying if the material uses the texture
  23286. */
  23287. hasTexture(texture: BaseTexture): boolean;
  23288. /**
  23289. * Disposes the material
  23290. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  23291. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  23292. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  23293. */
  23294. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  23295. /** Creates the node editor window. */
  23296. private _createNodeEditor;
  23297. /**
  23298. * Launch the node material editor
  23299. * @param config Define the configuration of the editor
  23300. * @return a promise fulfilled when the node editor is visible
  23301. */
  23302. edit(config?: INodeMaterialEditorOptions): Promise<void>;
  23303. /**
  23304. * Clear the current material
  23305. */
  23306. clear(): void;
  23307. /**
  23308. * Clear the current material and set it to a default state
  23309. */
  23310. setToDefault(): void;
  23311. /**
  23312. * Clear the current material and set it to a default state for post process
  23313. */
  23314. setToDefaultPostProcess(): void;
  23315. /**
  23316. * Clear the current material and set it to a default state for particle
  23317. */
  23318. setToDefaultParticle(): void;
  23319. /**
  23320. * Loads the current Node Material from a url pointing to a file save by the Node Material Editor
  23321. * @param url defines the url to load from
  23322. * @returns a promise that will fullfil when the material is fully loaded
  23323. */
  23324. loadAsync(url: string): Promise<void>;
  23325. private _gatherBlocks;
  23326. /**
  23327. * Generate a string containing the code declaration required to create an equivalent of this material
  23328. * @returns a string
  23329. */
  23330. generateCode(): string;
  23331. /**
  23332. * Serializes this material in a JSON representation
  23333. * @returns the serialized material object
  23334. */
  23335. serialize(selectedBlocks?: NodeMaterialBlock[]): any;
  23336. private _restoreConnections;
  23337. /**
  23338. * Clear the current graph and load a new one from a serialization object
  23339. * @param source defines the JSON representation of the material
  23340. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  23341. * @param merge defines whether or not the source must be merged or replace the current content
  23342. */
  23343. loadFromSerialization(source: any, rootUrl?: string, merge?: boolean): void;
  23344. /**
  23345. * Makes a duplicate of the current material.
  23346. * @param name - name to use for the new material.
  23347. */
  23348. clone(name: string): NodeMaterial;
  23349. /**
  23350. * Creates a node material from parsed material data
  23351. * @param source defines the JSON representation of the material
  23352. * @param scene defines the hosting scene
  23353. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  23354. * @returns a new node material
  23355. */
  23356. static Parse(source: any, scene: Scene, rootUrl?: string): NodeMaterial;
  23357. /**
  23358. * Creates a node material from a snippet saved in a remote file
  23359. * @param name defines the name of the material to create
  23360. * @param url defines the url to load from
  23361. * @param scene defines the hosting scene
  23362. * @returns a promise that will resolve to the new node material
  23363. */
  23364. static ParseFromFileAsync(name: string, url: string, scene: Scene): Promise<NodeMaterial>;
  23365. /**
  23366. * Creates a node material from a snippet saved by the node material editor
  23367. * @param snippetId defines the snippet to load
  23368. * @param scene defines the hosting scene
  23369. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  23370. * @param nodeMaterial defines a node material to update (instead of creating a new one)
  23371. * @returns a promise that will resolve to the new node material
  23372. */
  23373. static ParseFromSnippetAsync(snippetId: string, scene: Scene, rootUrl?: string, nodeMaterial?: NodeMaterial): Promise<NodeMaterial>;
  23374. /**
  23375. * Creates a new node material set to default basic configuration
  23376. * @param name defines the name of the material
  23377. * @param scene defines the hosting scene
  23378. * @returns a new NodeMaterial
  23379. */
  23380. static CreateDefault(name: string, scene?: Scene): NodeMaterial;
  23381. }
  23382. }
  23383. declare module "babylonjs/PostProcesses/postProcess" {
  23384. import { Nullable } from "babylonjs/types";
  23385. import { SmartArray } from "babylonjs/Misc/smartArray";
  23386. import { Observable } from "babylonjs/Misc/observable";
  23387. import { Vector2 } from "babylonjs/Maths/math.vector";
  23388. import { Camera } from "babylonjs/Cameras/camera";
  23389. import { Effect } from "babylonjs/Materials/effect";
  23390. import "babylonjs/Shaders/postprocess.vertex";
  23391. import { IInspectable } from "babylonjs/Misc/iInspectable";
  23392. import { Engine } from "babylonjs/Engines/engine";
  23393. import { Color4 } from "babylonjs/Maths/math.color";
  23394. import "babylonjs/Engines/Extensions/engine.renderTarget";
  23395. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  23396. import { Scene } from "babylonjs/scene";
  23397. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  23398. /**
  23399. * Size options for a post process
  23400. */
  23401. export type PostProcessOptions = {
  23402. width: number;
  23403. height: number;
  23404. };
  23405. /**
  23406. * PostProcess can be used to apply a shader to a texture after it has been rendered
  23407. * See https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  23408. */
  23409. export class PostProcess {
  23410. /**
  23411. * Gets or sets the unique id of the post process
  23412. */
  23413. uniqueId: number;
  23414. /** Name of the PostProcess. */
  23415. name: string;
  23416. /**
  23417. * Width of the texture to apply the post process on
  23418. */
  23419. width: number;
  23420. /**
  23421. * Height of the texture to apply the post process on
  23422. */
  23423. height: number;
  23424. /**
  23425. * Gets the node material used to create this postprocess (null if the postprocess was manually created)
  23426. */
  23427. nodeMaterialSource: Nullable<NodeMaterial>;
  23428. /**
  23429. * Internal, reference to the location where this postprocess was output to. (Typically the texture on the next postprocess in the chain)
  23430. * @hidden
  23431. */
  23432. _outputTexture: Nullable<InternalTexture>;
  23433. /**
  23434. * Sampling mode used by the shader
  23435. * See https://doc.babylonjs.com/classes/3.1/texture
  23436. */
  23437. renderTargetSamplingMode: number;
  23438. /**
  23439. * Clear color to use when screen clearing
  23440. */
  23441. clearColor: Color4;
  23442. /**
  23443. * If the buffer needs to be cleared before applying the post process. (default: true)
  23444. * Should be set to false if shader will overwrite all previous pixels.
  23445. */
  23446. autoClear: boolean;
  23447. /**
  23448. * Type of alpha mode to use when performing the post process (default: Engine.ALPHA_DISABLE)
  23449. */
  23450. alphaMode: number;
  23451. /**
  23452. * Sets the setAlphaBlendConstants of the babylon engine
  23453. */
  23454. alphaConstants: Color4;
  23455. /**
  23456. * Animations to be used for the post processing
  23457. */
  23458. animations: import("babylonjs/Animations/animation").Animation[];
  23459. /**
  23460. * Enable Pixel Perfect mode where texture is not scaled to be power of 2.
  23461. * Can only be used on a single postprocess or on the last one of a chain. (default: false)
  23462. */
  23463. enablePixelPerfectMode: boolean;
  23464. /**
  23465. * Force the postprocess to be applied without taking in account viewport
  23466. */
  23467. forceFullscreenViewport: boolean;
  23468. /**
  23469. * List of inspectable custom properties (used by the Inspector)
  23470. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  23471. */
  23472. inspectableCustomProperties: IInspectable[];
  23473. /**
  23474. * Scale mode for the post process (default: Engine.SCALEMODE_FLOOR)
  23475. *
  23476. * | Value | Type | Description |
  23477. * | ----- | ----------------------------------- | ----------- |
  23478. * | 1 | SCALEMODE_FLOOR | [engine.scalemode_floor](https://doc.babylonjs.com/api/classes/babylon.engine#scalemode_floor) |
  23479. * | 2 | SCALEMODE_NEAREST | [engine.scalemode_nearest](https://doc.babylonjs.com/api/classes/babylon.engine#scalemode_nearest) |
  23480. * | 3 | SCALEMODE_CEILING | [engine.scalemode_ceiling](https://doc.babylonjs.com/api/classes/babylon.engine#scalemode_ceiling) |
  23481. *
  23482. */
  23483. scaleMode: number;
  23484. /**
  23485. * Force textures to be a power of two (default: false)
  23486. */
  23487. alwaysForcePOT: boolean;
  23488. private _samples;
  23489. /**
  23490. * Number of sample textures (default: 1)
  23491. */
  23492. get samples(): number;
  23493. set samples(n: number);
  23494. /**
  23495. * Modify the scale of the post process to be the same as the viewport (default: false)
  23496. */
  23497. adaptScaleToCurrentViewport: boolean;
  23498. private _camera;
  23499. protected _scene: Scene;
  23500. private _engine;
  23501. private _options;
  23502. private _reusable;
  23503. private _textureType;
  23504. private _textureFormat;
  23505. /**
  23506. * Smart array of input and output textures for the post process.
  23507. * @hidden
  23508. */
  23509. _textures: SmartArray<import("babylonjs/Materials/Textures/internalTexture").InternalTexture>;
  23510. /**
  23511. * The index in _textures that corresponds to the output texture.
  23512. * @hidden
  23513. */
  23514. _currentRenderTextureInd: number;
  23515. private _effect;
  23516. private _samplers;
  23517. private _fragmentUrl;
  23518. private _vertexUrl;
  23519. private _parameters;
  23520. private _scaleRatio;
  23521. protected _indexParameters: any;
  23522. private _shareOutputWithPostProcess;
  23523. private _texelSize;
  23524. private _forcedOutputTexture;
  23525. /**
  23526. * Returns the fragment url or shader name used in the post process.
  23527. * @returns the fragment url or name in the shader store.
  23528. */
  23529. getEffectName(): string;
  23530. /**
  23531. * An event triggered when the postprocess is activated.
  23532. */
  23533. onActivateObservable: Observable<Camera>;
  23534. private _onActivateObserver;
  23535. /**
  23536. * A function that is added to the onActivateObservable
  23537. */
  23538. set onActivate(callback: Nullable<(camera: Camera) => void>);
  23539. /**
  23540. * An event triggered when the postprocess changes its size.
  23541. */
  23542. onSizeChangedObservable: Observable<PostProcess>;
  23543. private _onSizeChangedObserver;
  23544. /**
  23545. * A function that is added to the onSizeChangedObservable
  23546. */
  23547. set onSizeChanged(callback: (postProcess: PostProcess) => void);
  23548. /**
  23549. * An event triggered when the postprocess applies its effect.
  23550. */
  23551. onApplyObservable: Observable<Effect>;
  23552. private _onApplyObserver;
  23553. /**
  23554. * A function that is added to the onApplyObservable
  23555. */
  23556. set onApply(callback: (effect: Effect) => void);
  23557. /**
  23558. * An event triggered before rendering the postprocess
  23559. */
  23560. onBeforeRenderObservable: Observable<Effect>;
  23561. private _onBeforeRenderObserver;
  23562. /**
  23563. * A function that is added to the onBeforeRenderObservable
  23564. */
  23565. set onBeforeRender(callback: (effect: Effect) => void);
  23566. /**
  23567. * An event triggered after rendering the postprocess
  23568. */
  23569. onAfterRenderObservable: Observable<Effect>;
  23570. private _onAfterRenderObserver;
  23571. /**
  23572. * A function that is added to the onAfterRenderObservable
  23573. */
  23574. set onAfterRender(callback: (efect: Effect) => void);
  23575. /**
  23576. * The input texture for this post process and the output texture of the previous post process. When added to a pipeline the previous post process will
  23577. * render it's output into this texture and this texture will be used as textureSampler in the fragment shader of this post process.
  23578. */
  23579. get inputTexture(): InternalTexture;
  23580. set inputTexture(value: InternalTexture);
  23581. /**
  23582. * Since inputTexture should always be defined, if we previously manually set `inputTexture`,
  23583. * the only way to unset it is to use this function to restore its internal state
  23584. */
  23585. restoreDefaultInputTexture(): void;
  23586. /**
  23587. * Gets the camera which post process is applied to.
  23588. * @returns The camera the post process is applied to.
  23589. */
  23590. getCamera(): Camera;
  23591. /**
  23592. * Gets the texel size of the postprocess.
  23593. * See https://en.wikipedia.org/wiki/Texel_(graphics)
  23594. */
  23595. get texelSize(): Vector2;
  23596. /**
  23597. * Creates a new instance PostProcess
  23598. * @param name The name of the PostProcess.
  23599. * @param fragmentUrl The url of the fragment shader to be used.
  23600. * @param parameters Array of the names of uniform non-sampler2D variables that will be passed to the shader.
  23601. * @param samplers Array of the names of uniform sampler2D variables that will be passed to the shader.
  23602. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  23603. * @param camera The camera to apply the render pass to.
  23604. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  23605. * @param engine The engine which the post process will be applied. (default: current engine)
  23606. * @param reusable If the post process can be reused on the same frame. (default: false)
  23607. * @param defines String of defines that will be set when running the fragment shader. (default: null)
  23608. * @param textureType Type of textures used when performing the post process. (default: 0)
  23609. * @param vertexUrl The url of the vertex shader to be used. (default: "postprocess")
  23610. * @param indexParameters The index parameters to be used for babylons include syntax "#include<kernelBlurVaryingDeclaration>[0..varyingCount]". (default: undefined) See usage in babylon.blurPostProcess.ts and kernelBlur.vertex.fx
  23611. * @param blockCompilation If the shader should not be compiled imediatly. (default: false)
  23612. * @param textureFormat Format of textures used when performing the post process. (default: TEXTUREFORMAT_RGBA)
  23613. */
  23614. constructor(name: string, fragmentUrl: string, parameters: Nullable<string[]>, samplers: Nullable<string[]>, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, defines?: Nullable<string>, textureType?: number, vertexUrl?: string, indexParameters?: any, blockCompilation?: boolean, textureFormat?: number);
  23615. /**
  23616. * Gets a string identifying the name of the class
  23617. * @returns "PostProcess" string
  23618. */
  23619. getClassName(): string;
  23620. /**
  23621. * Gets the engine which this post process belongs to.
  23622. * @returns The engine the post process was enabled with.
  23623. */
  23624. getEngine(): Engine;
  23625. /**
  23626. * The effect that is created when initializing the post process.
  23627. * @returns The created effect corresponding the the postprocess.
  23628. */
  23629. getEffect(): Effect;
  23630. /**
  23631. * To avoid multiple redundant textures for multiple post process, the output the output texture for this post process can be shared with another.
  23632. * @param postProcess The post process to share the output with.
  23633. * @returns This post process.
  23634. */
  23635. shareOutputWith(postProcess: PostProcess): PostProcess;
  23636. /**
  23637. * Reverses the effect of calling shareOutputWith and returns the post process back to its original state.
  23638. * This should be called if the post process that shares output with this post process is disabled/disposed.
  23639. */
  23640. useOwnOutput(): void;
  23641. /**
  23642. * Updates the effect with the current post process compile time values and recompiles the shader.
  23643. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  23644. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  23645. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  23646. * @param indexParameters The index parameters to be used for babylons include syntax "#include<kernelBlurVaryingDeclaration>[0..varyingCount]". (default: undefined) See usage in babylon.blurPostProcess.ts and kernelBlur.vertex.fx
  23647. * @param onCompiled Called when the shader has been compiled.
  23648. * @param onError Called if there is an error when compiling a shader.
  23649. * @param vertexUrl The url of the vertex shader to be used (default: the one given at construction time)
  23650. * @param fragmentUrl The url of the fragment shader to be used (default: the one given at construction time)
  23651. */
  23652. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void, vertexUrl?: string, fragmentUrl?: string): void;
  23653. /**
  23654. * The post process is reusable if it can be used multiple times within one frame.
  23655. * @returns If the post process is reusable
  23656. */
  23657. isReusable(): boolean;
  23658. /** invalidate frameBuffer to hint the postprocess to create a depth buffer */
  23659. markTextureDirty(): void;
  23660. /**
  23661. * Activates the post process by intializing the textures to be used when executed. Notifies onActivateObservable.
  23662. * When this post process is used in a pipeline, this is call will bind the input texture of this post process to the output of the previous.
  23663. * @param camera The camera that will be used in the post process. This camera will be used when calling onActivateObservable.
  23664. * @param sourceTexture The source texture to be inspected to get the width and height if not specified in the post process constructor. (default: null)
  23665. * @param forceDepthStencil If true, a depth and stencil buffer will be generated. (default: false)
  23666. * @returns The target texture that was bound to be written to.
  23667. */
  23668. activate(camera: Nullable<Camera>, sourceTexture?: Nullable<InternalTexture>, forceDepthStencil?: boolean): InternalTexture;
  23669. /**
  23670. * If the post process is supported.
  23671. */
  23672. get isSupported(): boolean;
  23673. /**
  23674. * The aspect ratio of the output texture.
  23675. */
  23676. get aspectRatio(): number;
  23677. /**
  23678. * Get a value indicating if the post-process is ready to be used
  23679. * @returns true if the post-process is ready (shader is compiled)
  23680. */
  23681. isReady(): boolean;
  23682. /**
  23683. * Binds all textures and uniforms to the shader, this will be run on every pass.
  23684. * @returns the effect corresponding to this post process. Null if not compiled or not ready.
  23685. */
  23686. apply(): Nullable<Effect>;
  23687. private _disposeTextures;
  23688. /**
  23689. * Disposes the post process.
  23690. * @param camera The camera to dispose the post process on.
  23691. */
  23692. dispose(camera?: Camera): void;
  23693. /**
  23694. * Serializes the particle system to a JSON object
  23695. * @returns the JSON object
  23696. */
  23697. serialize(): any;
  23698. /**
  23699. * Creates a material from parsed material data
  23700. * @param parsedPostProcess defines parsed post process data
  23701. * @param scene defines the hosting scene
  23702. * @param rootUrl defines the root URL to use to load textures
  23703. * @returns a new post process
  23704. */
  23705. static Parse(parsedPostProcess: any, scene: Scene, rootUrl: string): Nullable<PostProcess>;
  23706. }
  23707. }
  23708. declare module "babylonjs/Shaders/ShadersInclude/kernelBlurVaryingDeclaration" {
  23709. /** @hidden */
  23710. export var kernelBlurVaryingDeclaration: {
  23711. name: string;
  23712. shader: string;
  23713. };
  23714. }
  23715. declare module "babylonjs/Shaders/ShadersInclude/kernelBlurFragment" {
  23716. /** @hidden */
  23717. export var kernelBlurFragment: {
  23718. name: string;
  23719. shader: string;
  23720. };
  23721. }
  23722. declare module "babylonjs/Shaders/ShadersInclude/kernelBlurFragment2" {
  23723. /** @hidden */
  23724. export var kernelBlurFragment2: {
  23725. name: string;
  23726. shader: string;
  23727. };
  23728. }
  23729. declare module "babylonjs/Shaders/kernelBlur.fragment" {
  23730. import "babylonjs/Shaders/ShadersInclude/kernelBlurVaryingDeclaration";
  23731. import "babylonjs/Shaders/ShadersInclude/packingFunctions";
  23732. import "babylonjs/Shaders/ShadersInclude/kernelBlurFragment";
  23733. import "babylonjs/Shaders/ShadersInclude/kernelBlurFragment2";
  23734. /** @hidden */
  23735. export var kernelBlurPixelShader: {
  23736. name: string;
  23737. shader: string;
  23738. };
  23739. }
  23740. declare module "babylonjs/Shaders/ShadersInclude/kernelBlurVertex" {
  23741. /** @hidden */
  23742. export var kernelBlurVertex: {
  23743. name: string;
  23744. shader: string;
  23745. };
  23746. }
  23747. declare module "babylonjs/Shaders/kernelBlur.vertex" {
  23748. import "babylonjs/Shaders/ShadersInclude/kernelBlurVaryingDeclaration";
  23749. import "babylonjs/Shaders/ShadersInclude/kernelBlurVertex";
  23750. /** @hidden */
  23751. export var kernelBlurVertexShader: {
  23752. name: string;
  23753. shader: string;
  23754. };
  23755. }
  23756. declare module "babylonjs/PostProcesses/blurPostProcess" {
  23757. import { Vector2 } from "babylonjs/Maths/math.vector";
  23758. import { Nullable } from "babylonjs/types";
  23759. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  23760. import { Camera } from "babylonjs/Cameras/camera";
  23761. import { Effect } from "babylonjs/Materials/effect";
  23762. import { Engine } from "babylonjs/Engines/engine";
  23763. import "babylonjs/Shaders/kernelBlur.fragment";
  23764. import "babylonjs/Shaders/kernelBlur.vertex";
  23765. import { Scene } from "babylonjs/scene";
  23766. /**
  23767. * The Blur Post Process which blurs an image based on a kernel and direction.
  23768. * Can be used twice in x and y directions to perform a guassian blur in two passes.
  23769. */
  23770. export class BlurPostProcess extends PostProcess {
  23771. private blockCompilation;
  23772. protected _kernel: number;
  23773. protected _idealKernel: number;
  23774. protected _packedFloat: boolean;
  23775. private _staticDefines;
  23776. /** The direction in which to blur the image. */
  23777. direction: Vector2;
  23778. /**
  23779. * Sets the length in pixels of the blur sample region
  23780. */
  23781. set kernel(v: number);
  23782. /**
  23783. * Gets the length in pixels of the blur sample region
  23784. */
  23785. get kernel(): number;
  23786. /**
  23787. * Sets wether or not the blur needs to unpack/repack floats
  23788. */
  23789. set packedFloat(v: boolean);
  23790. /**
  23791. * Gets wether or not the blur is unpacking/repacking floats
  23792. */
  23793. get packedFloat(): boolean;
  23794. /**
  23795. * Gets a string identifying the name of the class
  23796. * @returns "BlurPostProcess" string
  23797. */
  23798. getClassName(): string;
  23799. /**
  23800. * Creates a new instance BlurPostProcess
  23801. * @param name The name of the effect.
  23802. * @param direction The direction in which to blur the image.
  23803. * @param kernel The size of the kernel to be used when computing the blur. eg. Size of 3 will blur the center pixel by 2 pixels surrounding it.
  23804. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  23805. * @param camera The camera to apply the render pass to.
  23806. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  23807. * @param engine The engine which the post process will be applied. (default: current engine)
  23808. * @param reusable If the post process can be reused on the same frame. (default: false)
  23809. * @param textureType Type of textures used when performing the post process. (default: 0)
  23810. * @param blockCompilation If compilation of the shader should not be done in the constructor. The updateEffect method can be used to compile the shader at a later time. (default: false)
  23811. */
  23812. constructor(name: string, direction: Vector2, kernel: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, defines?: string, blockCompilation?: boolean);
  23813. /**
  23814. * Updates the effect with the current post process compile time values and recompiles the shader.
  23815. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  23816. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  23817. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  23818. * @param indexParameters The index parameters to be used for babylons include syntax "#include<kernelBlurVaryingDeclaration>[0..varyingCount]". (default: undefined) See usage in babylon.blurPostProcess.ts and kernelBlur.vertex.fx
  23819. * @param onCompiled Called when the shader has been compiled.
  23820. * @param onError Called if there is an error when compiling a shader.
  23821. */
  23822. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  23823. protected _updateParameters(onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  23824. /**
  23825. * Best kernels are odd numbers that when divided by 2, their integer part is even, so 5, 9 or 13.
  23826. * Other odd kernels optimize correctly but require proportionally more samples, even kernels are
  23827. * possible but will produce minor visual artifacts. Since each new kernel requires a new shader we
  23828. * want to minimize kernel changes, having gaps between physical kernels is helpful in that regard.
  23829. * The gaps between physical kernels are compensated for in the weighting of the samples
  23830. * @param idealKernel Ideal blur kernel.
  23831. * @return Nearest best kernel.
  23832. */
  23833. protected _nearestBestKernel(idealKernel: number): number;
  23834. /**
  23835. * Calculates the value of a Gaussian distribution with sigma 3 at a given point.
  23836. * @param x The point on the Gaussian distribution to sample.
  23837. * @return the value of the Gaussian function at x.
  23838. */
  23839. protected _gaussianWeight(x: number): number;
  23840. /**
  23841. * Generates a string that can be used as a floating point number in GLSL.
  23842. * @param x Value to print.
  23843. * @param decimalFigures Number of decimal places to print the number to (excluding trailing 0s).
  23844. * @return GLSL float string.
  23845. */
  23846. protected _glslFloat(x: number, decimalFigures?: number): string;
  23847. /** @hidden */
  23848. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<BlurPostProcess>;
  23849. }
  23850. }
  23851. declare module "babylonjs/Materials/Textures/mirrorTexture" {
  23852. import { Scene } from "babylonjs/scene";
  23853. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  23854. import { Plane } from "babylonjs/Maths/math.plane";
  23855. /**
  23856. * Mirror texture can be used to simulate the view from a mirror in a scene.
  23857. * It will dynamically be rendered every frame to adapt to the camera point of view.
  23858. * You can then easily use it as a reflectionTexture on a flat surface.
  23859. * In case the surface is not a plane, please consider relying on reflection probes.
  23860. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  23861. */
  23862. export class MirrorTexture extends RenderTargetTexture {
  23863. private scene;
  23864. /**
  23865. * Define the reflection plane we want to use. The mirrorPlane is usually set to the constructed reflector.
  23866. * It is possible to directly set the mirrorPlane by directly using a Plane(a, b, c, d) where a, b and c give the plane normal vector (a, b, c) and d is a scalar displacement from the mirrorPlane to the origin. However in all but the very simplest of situations it is more straight forward to set it to the reflector as stated in the doc.
  23867. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  23868. */
  23869. mirrorPlane: Plane;
  23870. /**
  23871. * Define the blur ratio used to blur the reflection if needed.
  23872. */
  23873. set blurRatio(value: number);
  23874. get blurRatio(): number;
  23875. /**
  23876. * Define the adaptive blur kernel used to blur the reflection if needed.
  23877. * This will autocompute the closest best match for the `blurKernel`
  23878. */
  23879. set adaptiveBlurKernel(value: number);
  23880. /**
  23881. * Define the blur kernel used to blur the reflection if needed.
  23882. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  23883. */
  23884. set blurKernel(value: number);
  23885. /**
  23886. * Define the blur kernel on the X Axis used to blur the reflection if needed.
  23887. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  23888. */
  23889. set blurKernelX(value: number);
  23890. get blurKernelX(): number;
  23891. /**
  23892. * Define the blur kernel on the Y Axis used to blur the reflection if needed.
  23893. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  23894. */
  23895. set blurKernelY(value: number);
  23896. get blurKernelY(): number;
  23897. private _autoComputeBlurKernel;
  23898. protected _onRatioRescale(): void;
  23899. private _updateGammaSpace;
  23900. private _imageProcessingConfigChangeObserver;
  23901. private _transformMatrix;
  23902. private _mirrorMatrix;
  23903. private _savedViewMatrix;
  23904. private _blurX;
  23905. private _blurY;
  23906. private _adaptiveBlurKernel;
  23907. private _blurKernelX;
  23908. private _blurKernelY;
  23909. private _blurRatio;
  23910. /**
  23911. * Instantiates a Mirror Texture.
  23912. * Mirror texture can be used to simulate the view from a mirror in a scene.
  23913. * It will dynamically be rendered every frame to adapt to the camera point of view.
  23914. * You can then easily use it as a reflectionTexture on a flat surface.
  23915. * In case the surface is not a plane, please consider relying on reflection probes.
  23916. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  23917. * @param name
  23918. * @param size
  23919. * @param scene
  23920. * @param generateMipMaps
  23921. * @param type
  23922. * @param samplingMode
  23923. * @param generateDepthBuffer
  23924. */
  23925. constructor(name: string, size: number | {
  23926. width: number;
  23927. height: number;
  23928. } | {
  23929. ratio: number;
  23930. }, scene: Scene, generateMipMaps?: boolean, type?: number, samplingMode?: number, generateDepthBuffer?: boolean);
  23931. private _preparePostProcesses;
  23932. /**
  23933. * Clone the mirror texture.
  23934. * @returns the cloned texture
  23935. */
  23936. clone(): MirrorTexture;
  23937. /**
  23938. * Serialize the texture to a JSON representation you could use in Parse later on
  23939. * @returns the serialized JSON representation
  23940. */
  23941. serialize(): any;
  23942. /**
  23943. * Dispose the texture and release its associated resources.
  23944. */
  23945. dispose(): void;
  23946. }
  23947. }
  23948. declare module "babylonjs/Materials/Textures/texture" {
  23949. import { Observable } from "babylonjs/Misc/observable";
  23950. import { Nullable } from "babylonjs/types";
  23951. import { Matrix } from "babylonjs/Maths/math.vector";
  23952. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  23953. import { IInspectable } from "babylonjs/Misc/iInspectable";
  23954. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  23955. import { CubeTexture } from "babylonjs/Materials/Textures/cubeTexture";
  23956. import { MirrorTexture } from "babylonjs/Materials/Textures/mirrorTexture";
  23957. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  23958. import { Scene } from "babylonjs/scene";
  23959. /**
  23960. * This represents a texture in babylon. It can be easily loaded from a network, base64 or html input.
  23961. * @see https://doc.babylonjs.com/babylon101/materials#texture
  23962. */
  23963. export class Texture extends BaseTexture {
  23964. /**
  23965. * Gets or sets a general boolean used to indicate that textures containing direct data (buffers) must be saved as part of the serialization process
  23966. */
  23967. static SerializeBuffers: boolean;
  23968. /** @hidden */
  23969. static _CubeTextureParser: (jsonTexture: any, scene: Scene, rootUrl: string) => CubeTexture;
  23970. /** @hidden */
  23971. static _CreateMirror: (name: string, renderTargetSize: number, scene: Scene, generateMipMaps: boolean) => MirrorTexture;
  23972. /** @hidden */
  23973. static _CreateRenderTargetTexture: (name: string, renderTargetSize: number, scene: Scene, generateMipMaps: boolean) => RenderTargetTexture;
  23974. /** nearest is mag = nearest and min = nearest and mip = linear */
  23975. static readonly NEAREST_SAMPLINGMODE: number;
  23976. /** nearest is mag = nearest and min = nearest and mip = linear */
  23977. static readonly NEAREST_NEAREST_MIPLINEAR: number;
  23978. /** Bilinear is mag = linear and min = linear and mip = nearest */
  23979. static readonly BILINEAR_SAMPLINGMODE: number;
  23980. /** Bilinear is mag = linear and min = linear and mip = nearest */
  23981. static readonly LINEAR_LINEAR_MIPNEAREST: number;
  23982. /** Trilinear is mag = linear and min = linear and mip = linear */
  23983. static readonly TRILINEAR_SAMPLINGMODE: number;
  23984. /** Trilinear is mag = linear and min = linear and mip = linear */
  23985. static readonly LINEAR_LINEAR_MIPLINEAR: number;
  23986. /** mag = nearest and min = nearest and mip = nearest */
  23987. static readonly NEAREST_NEAREST_MIPNEAREST: number;
  23988. /** mag = nearest and min = linear and mip = nearest */
  23989. static readonly NEAREST_LINEAR_MIPNEAREST: number;
  23990. /** mag = nearest and min = linear and mip = linear */
  23991. static readonly NEAREST_LINEAR_MIPLINEAR: number;
  23992. /** mag = nearest and min = linear and mip = none */
  23993. static readonly NEAREST_LINEAR: number;
  23994. /** mag = nearest and min = nearest and mip = none */
  23995. static readonly NEAREST_NEAREST: number;
  23996. /** mag = linear and min = nearest and mip = nearest */
  23997. static readonly LINEAR_NEAREST_MIPNEAREST: number;
  23998. /** mag = linear and min = nearest and mip = linear */
  23999. static readonly LINEAR_NEAREST_MIPLINEAR: number;
  24000. /** mag = linear and min = linear and mip = none */
  24001. static readonly LINEAR_LINEAR: number;
  24002. /** mag = linear and min = nearest and mip = none */
  24003. static readonly LINEAR_NEAREST: number;
  24004. /** Explicit coordinates mode */
  24005. static readonly EXPLICIT_MODE: number;
  24006. /** Spherical coordinates mode */
  24007. static readonly SPHERICAL_MODE: number;
  24008. /** Planar coordinates mode */
  24009. static readonly PLANAR_MODE: number;
  24010. /** Cubic coordinates mode */
  24011. static readonly CUBIC_MODE: number;
  24012. /** Projection coordinates mode */
  24013. static readonly PROJECTION_MODE: number;
  24014. /** Inverse Cubic coordinates mode */
  24015. static readonly SKYBOX_MODE: number;
  24016. /** Inverse Cubic coordinates mode */
  24017. static readonly INVCUBIC_MODE: number;
  24018. /** Equirectangular coordinates mode */
  24019. static readonly EQUIRECTANGULAR_MODE: number;
  24020. /** Equirectangular Fixed coordinates mode */
  24021. static readonly FIXED_EQUIRECTANGULAR_MODE: number;
  24022. /** Equirectangular Fixed Mirrored coordinates mode */
  24023. static readonly FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  24024. /** Texture is not repeating outside of 0..1 UVs */
  24025. static readonly CLAMP_ADDRESSMODE: number;
  24026. /** Texture is repeating outside of 0..1 UVs */
  24027. static readonly WRAP_ADDRESSMODE: number;
  24028. /** Texture is repeating and mirrored */
  24029. static readonly MIRROR_ADDRESSMODE: number;
  24030. /**
  24031. * Gets or sets a boolean which defines if the texture url must be build from the serialized URL instead of just using the name and loading them side by side with the scene file
  24032. */
  24033. static UseSerializedUrlIfAny: boolean;
  24034. /**
  24035. * Define the url of the texture.
  24036. */
  24037. url: Nullable<string>;
  24038. /**
  24039. * Define an offset on the texture to offset the u coordinates of the UVs
  24040. * @see https://doc.babylonjs.com/how_to/more_materials#offsetting
  24041. */
  24042. uOffset: number;
  24043. /**
  24044. * Define an offset on the texture to offset the v coordinates of the UVs
  24045. * @see https://doc.babylonjs.com/how_to/more_materials#offsetting
  24046. */
  24047. vOffset: number;
  24048. /**
  24049. * Define an offset on the texture to scale the u coordinates of the UVs
  24050. * @see https://doc.babylonjs.com/how_to/more_materials#tiling
  24051. */
  24052. uScale: number;
  24053. /**
  24054. * Define an offset on the texture to scale the v coordinates of the UVs
  24055. * @see https://doc.babylonjs.com/how_to/more_materials#tiling
  24056. */
  24057. vScale: number;
  24058. /**
  24059. * Define an offset on the texture to rotate around the u coordinates of the UVs
  24060. * @see https://doc.babylonjs.com/how_to/more_materials
  24061. */
  24062. uAng: number;
  24063. /**
  24064. * Define an offset on the texture to rotate around the v coordinates of the UVs
  24065. * @see https://doc.babylonjs.com/how_to/more_materials
  24066. */
  24067. vAng: number;
  24068. /**
  24069. * Define an offset on the texture to rotate around the w coordinates of the UVs (in case of 3d texture)
  24070. * @see https://doc.babylonjs.com/how_to/more_materials
  24071. */
  24072. wAng: number;
  24073. /**
  24074. * Defines the center of rotation (U)
  24075. */
  24076. uRotationCenter: number;
  24077. /**
  24078. * Defines the center of rotation (V)
  24079. */
  24080. vRotationCenter: number;
  24081. /**
  24082. * Defines the center of rotation (W)
  24083. */
  24084. wRotationCenter: number;
  24085. /**
  24086. * Are mip maps generated for this texture or not.
  24087. */
  24088. get noMipmap(): boolean;
  24089. /**
  24090. * List of inspectable custom properties (used by the Inspector)
  24091. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  24092. */
  24093. inspectableCustomProperties: Nullable<IInspectable[]>;
  24094. private _noMipmap;
  24095. /** @hidden */
  24096. _invertY: boolean;
  24097. private _rowGenerationMatrix;
  24098. private _cachedTextureMatrix;
  24099. private _projectionModeMatrix;
  24100. private _t0;
  24101. private _t1;
  24102. private _t2;
  24103. private _cachedUOffset;
  24104. private _cachedVOffset;
  24105. private _cachedUScale;
  24106. private _cachedVScale;
  24107. private _cachedUAng;
  24108. private _cachedVAng;
  24109. private _cachedWAng;
  24110. private _cachedProjectionMatrixId;
  24111. private _cachedCoordinatesMode;
  24112. /** @hidden */
  24113. protected _initialSamplingMode: number;
  24114. /** @hidden */
  24115. _buffer: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>;
  24116. private _deleteBuffer;
  24117. protected _format: Nullable<number>;
  24118. private _delayedOnLoad;
  24119. private _delayedOnError;
  24120. private _mimeType?;
  24121. /**
  24122. * Observable triggered once the texture has been loaded.
  24123. */
  24124. onLoadObservable: Observable<Texture>;
  24125. protected _isBlocking: boolean;
  24126. /**
  24127. * Is the texture preventing material to render while loading.
  24128. * If false, a default texture will be used instead of the loading one during the preparation step.
  24129. */
  24130. set isBlocking(value: boolean);
  24131. get isBlocking(): boolean;
  24132. /**
  24133. * Get the current sampling mode associated with the texture.
  24134. */
  24135. get samplingMode(): number;
  24136. /**
  24137. * Gets a boolean indicating if the texture needs to be inverted on the y axis during loading
  24138. */
  24139. get invertY(): boolean;
  24140. /**
  24141. * Instantiates a new texture.
  24142. * This represents a texture in babylon. It can be easily loaded from a network, base64 or html input.
  24143. * @see https://doc.babylonjs.com/babylon101/materials#texture
  24144. * @param url defines the url of the picture to load as a texture
  24145. * @param sceneOrEngine defines the scene or engine the texture will belong to
  24146. * @param noMipmap defines if the texture will require mip maps or not
  24147. * @param invertY defines if the texture needs to be inverted on the y axis during loading
  24148. * @param samplingMode defines the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  24149. * @param onLoad defines a callback triggered when the texture has been loaded
  24150. * @param onError defines a callback triggered when an error occurred during the loading session
  24151. * @param buffer defines the buffer to load the texture from in case the texture is loaded from a buffer representation
  24152. * @param deleteBuffer defines if the buffer we are loading the texture from should be deleted after load
  24153. * @param format defines the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  24154. * @param mimeType defines an optional mime type information
  24155. */
  24156. constructor(url: Nullable<string>, sceneOrEngine: Nullable<Scene | ThinEngine>, noMipmap?: boolean, invertY?: boolean, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<(message?: string, exception?: any) => void>, buffer?: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>, deleteBuffer?: boolean, format?: number, mimeType?: string);
  24157. /**
  24158. * Update the url (and optional buffer) of this texture if url was null during construction.
  24159. * @param url the url of the texture
  24160. * @param buffer the buffer of the texture (defaults to null)
  24161. * @param onLoad callback called when the texture is loaded (defaults to null)
  24162. */
  24163. updateURL(url: string, buffer?: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob>, onLoad?: () => void): void;
  24164. /**
  24165. * Finish the loading sequence of a texture flagged as delayed load.
  24166. * @hidden
  24167. */
  24168. delayLoad(): void;
  24169. private _prepareRowForTextureGeneration;
  24170. /**
  24171. * Get the current texture matrix which includes the requested offsetting, tiling and rotation components.
  24172. * @returns the transform matrix of the texture.
  24173. */
  24174. getTextureMatrix(uBase?: number): Matrix;
  24175. /**
  24176. * Get the current matrix used to apply reflection. This is useful to rotate an environment texture for instance.
  24177. * @returns The reflection texture transform
  24178. */
  24179. getReflectionTextureMatrix(): Matrix;
  24180. /**
  24181. * Clones the texture.
  24182. * @returns the cloned texture
  24183. */
  24184. clone(): Texture;
  24185. /**
  24186. * Serialize the texture to a JSON representation we can easily use in the resepective Parse function.
  24187. * @returns The JSON representation of the texture
  24188. */
  24189. serialize(): any;
  24190. /**
  24191. * Get the current class name of the texture useful for serialization or dynamic coding.
  24192. * @returns "Texture"
  24193. */
  24194. getClassName(): string;
  24195. /**
  24196. * Dispose the texture and release its associated resources.
  24197. */
  24198. dispose(): void;
  24199. /**
  24200. * Parse the JSON representation of a texture in order to recreate the texture in the given scene.
  24201. * @param parsedTexture Define the JSON representation of the texture
  24202. * @param scene Define the scene the parsed texture should be instantiated in
  24203. * @param rootUrl Define the root url of the parsing sequence in the case of relative dependencies
  24204. * @returns The parsed texture if successful
  24205. */
  24206. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): Nullable<BaseTexture>;
  24207. /**
  24208. * Creates a texture from its base 64 representation.
  24209. * @param data Define the base64 payload without the data: prefix
  24210. * @param name Define the name of the texture in the scene useful fo caching purpose for instance
  24211. * @param scene Define the scene the texture should belong to
  24212. * @param noMipmap Forces the texture to not create mip map information if true
  24213. * @param invertY define if the texture needs to be inverted on the y axis during loading
  24214. * @param samplingMode define the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  24215. * @param onLoad define a callback triggered when the texture has been loaded
  24216. * @param onError define a callback triggered when an error occurred during the loading session
  24217. * @param format define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  24218. * @returns the created texture
  24219. */
  24220. static CreateFromBase64String(data: string, name: string, scene: Scene, noMipmap?: boolean, invertY?: boolean, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<() => void>, format?: number): Texture;
  24221. /**
  24222. * Creates a texture from its data: representation. (data: will be added in case only the payload has been passed in)
  24223. * @param data Define the base64 payload without the data: prefix
  24224. * @param name Define the name of the texture in the scene useful fo caching purpose for instance
  24225. * @param buffer define the buffer to load the texture from in case the texture is loaded from a buffer representation
  24226. * @param scene Define the scene the texture should belong to
  24227. * @param deleteBuffer define if the buffer we are loading the texture from should be deleted after load
  24228. * @param noMipmap Forces the texture to not create mip map information if true
  24229. * @param invertY define if the texture needs to be inverted on the y axis during loading
  24230. * @param samplingMode define the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  24231. * @param onLoad define a callback triggered when the texture has been loaded
  24232. * @param onError define a callback triggered when an error occurred during the loading session
  24233. * @param format define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  24234. * @returns the created texture
  24235. */
  24236. static LoadFromDataString(name: string, buffer: any, scene: Scene, deleteBuffer?: boolean, noMipmap?: boolean, invertY?: boolean, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<(message?: string, exception?: any) => void>, format?: number): Texture;
  24237. }
  24238. }
  24239. declare module "babylonjs/PostProcesses/postProcessManager" {
  24240. import { Nullable } from "babylonjs/types";
  24241. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  24242. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  24243. import { Scene } from "babylonjs/scene";
  24244. /**
  24245. * PostProcessManager is used to manage one or more post processes or post process pipelines
  24246. * See https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  24247. */
  24248. export class PostProcessManager {
  24249. private _scene;
  24250. private _indexBuffer;
  24251. private _vertexBuffers;
  24252. /**
  24253. * Creates a new instance PostProcess
  24254. * @param scene The scene that the post process is associated with.
  24255. */
  24256. constructor(scene: Scene);
  24257. private _prepareBuffers;
  24258. private _buildIndexBuffer;
  24259. /**
  24260. * Rebuilds the vertex buffers of the manager.
  24261. * @hidden
  24262. */
  24263. _rebuild(): void;
  24264. /**
  24265. * Prepares a frame to be run through a post process.
  24266. * @param sourceTexture The input texture to the post procesess. (default: null)
  24267. * @param postProcesses An array of post processes to be run. (default: null)
  24268. * @returns True if the post processes were able to be run.
  24269. * @hidden
  24270. */
  24271. _prepareFrame(sourceTexture?: Nullable<InternalTexture>, postProcesses?: Nullable<PostProcess[]>): boolean;
  24272. /**
  24273. * Manually render a set of post processes to a texture.
  24274. * Please note, the frame buffer won't be unbound after the call in case you have more render to do.
  24275. * @param postProcesses An array of post processes to be run.
  24276. * @param targetTexture The target texture to render to.
  24277. * @param forceFullscreenViewport force gl.viewport to be full screen eg. 0,0,textureWidth,textureHeight
  24278. * @param faceIndex defines the face to render to if a cubemap is defined as the target
  24279. * @param lodLevel defines which lod of the texture to render to
  24280. * @param doNotBindFrambuffer If set to true, assumes that the framebuffer has been bound previously
  24281. */
  24282. directRender(postProcesses: PostProcess[], targetTexture?: Nullable<InternalTexture>, forceFullscreenViewport?: boolean, faceIndex?: number, lodLevel?: number, doNotBindFrambuffer?: boolean): void;
  24283. /**
  24284. * Finalize the result of the output of the postprocesses.
  24285. * @param doNotPresent If true the result will not be displayed to the screen.
  24286. * @param targetTexture The target texture to render to.
  24287. * @param faceIndex The index of the face to bind the target texture to.
  24288. * @param postProcesses The array of post processes to render.
  24289. * @param forceFullscreenViewport force gl.viewport to be full screen eg. 0,0,textureWidth,textureHeight (default: false)
  24290. * @hidden
  24291. */
  24292. _finalizeFrame(doNotPresent?: boolean, targetTexture?: InternalTexture, faceIndex?: number, postProcesses?: Array<PostProcess>, forceFullscreenViewport?: boolean): void;
  24293. /**
  24294. * Disposes of the post process manager.
  24295. */
  24296. dispose(): void;
  24297. }
  24298. }
  24299. declare module "babylonjs/Materials/Textures/renderTargetTexture" {
  24300. import { Observable } from "babylonjs/Misc/observable";
  24301. import { SmartArray } from "babylonjs/Misc/smartArray";
  24302. import { Nullable, Immutable } from "babylonjs/types";
  24303. import { Camera } from "babylonjs/Cameras/camera";
  24304. import { Scene } from "babylonjs/scene";
  24305. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  24306. import { Color4 } from "babylonjs/Maths/math.color";
  24307. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  24308. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  24309. import { SubMesh } from "babylonjs/Meshes/subMesh";
  24310. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  24311. import { Texture } from "babylonjs/Materials/Textures/texture";
  24312. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  24313. import { RenderingManager } from "babylonjs/Rendering/renderingManager";
  24314. import "babylonjs/Engines/Extensions/engine.renderTarget";
  24315. import "babylonjs/Engines/Extensions/engine.renderTargetCube";
  24316. import { Engine } from "babylonjs/Engines/engine";
  24317. /**
  24318. * This Helps creating a texture that will be created from a camera in your scene.
  24319. * It is basically a dynamic texture that could be used to create special effects for instance.
  24320. * Actually, It is the base of lot of effects in the framework like post process, shadows, effect layers and rendering pipelines...
  24321. */
  24322. export class RenderTargetTexture extends Texture {
  24323. isCube: boolean;
  24324. /**
  24325. * The texture will only be rendered once which can be useful to improve performance if everything in your render is static for instance.
  24326. */
  24327. static readonly REFRESHRATE_RENDER_ONCE: number;
  24328. /**
  24329. * The texture will only be rendered rendered every frame and is recomended for dynamic contents.
  24330. */
  24331. static readonly REFRESHRATE_RENDER_ONEVERYFRAME: number;
  24332. /**
  24333. * The texture will be rendered every 2 frames which could be enough if your dynamic objects are not
  24334. * the central point of your effect and can save a lot of performances.
  24335. */
  24336. static readonly REFRESHRATE_RENDER_ONEVERYTWOFRAMES: number;
  24337. /**
  24338. * Use this predicate to dynamically define the list of mesh you want to render.
  24339. * If set, the renderList property will be overwritten.
  24340. */
  24341. renderListPredicate: (AbstractMesh: AbstractMesh) => boolean;
  24342. private _renderList;
  24343. /**
  24344. * Use this list to define the list of mesh you want to render.
  24345. */
  24346. get renderList(): Nullable<Array<AbstractMesh>>;
  24347. set renderList(value: Nullable<Array<AbstractMesh>>);
  24348. /**
  24349. * Use this function to overload the renderList array at rendering time.
  24350. * Return null to render with the curent renderList, else return the list of meshes to use for rendering.
  24351. * For 2DArray RTT, layerOrFace is the index of the layer that is going to be rendered, else it is the faceIndex of
  24352. * the cube (if the RTT is a cube, else layerOrFace=0).
  24353. * The renderList passed to the function is the current render list (the one that will be used if the function returns null).
  24354. * The length of this list is passed through renderListLength: don't use renderList.length directly because the array can
  24355. * hold dummy elements!
  24356. */
  24357. getCustomRenderList: (layerOrFace: number, renderList: Nullable<Immutable<Array<AbstractMesh>>>, renderListLength: number) => Nullable<Array<AbstractMesh>>;
  24358. private _hookArray;
  24359. /**
  24360. * Define if particles should be rendered in your texture.
  24361. */
  24362. renderParticles: boolean;
  24363. /**
  24364. * Define if sprites should be rendered in your texture.
  24365. */
  24366. renderSprites: boolean;
  24367. /**
  24368. * Override the default coordinates mode to projection for RTT as it is the most common case for rendered textures.
  24369. */
  24370. coordinatesMode: number;
  24371. /**
  24372. * Define the camera used to render the texture.
  24373. */
  24374. activeCamera: Nullable<Camera>;
  24375. /**
  24376. * Override the mesh isReady function with your own one.
  24377. */
  24378. customIsReadyFunction: (mesh: AbstractMesh, refreshRate: number) => boolean;
  24379. /**
  24380. * Override the render function of the texture with your own one.
  24381. */
  24382. customRenderFunction: (opaqueSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>, beforeTransparents?: () => void) => void;
  24383. /**
  24384. * Define if camera post processes should be use while rendering the texture.
  24385. */
  24386. useCameraPostProcesses: boolean;
  24387. /**
  24388. * Define if the camera viewport should be respected while rendering the texture or if the render should be done to the entire texture.
  24389. */
  24390. ignoreCameraViewport: boolean;
  24391. private _postProcessManager;
  24392. private _postProcesses;
  24393. private _resizeObserver;
  24394. /**
  24395. * An event triggered when the texture is unbind.
  24396. */
  24397. onBeforeBindObservable: Observable<RenderTargetTexture>;
  24398. /**
  24399. * An event triggered when the texture is unbind.
  24400. */
  24401. onAfterUnbindObservable: Observable<RenderTargetTexture>;
  24402. private _onAfterUnbindObserver;
  24403. /**
  24404. * Set a after unbind callback in the texture.
  24405. * This has been kept for backward compatibility and use of onAfterUnbindObservable is recommended.
  24406. */
  24407. set onAfterUnbind(callback: () => void);
  24408. /**
  24409. * An event triggered before rendering the texture
  24410. */
  24411. onBeforeRenderObservable: Observable<number>;
  24412. private _onBeforeRenderObserver;
  24413. /**
  24414. * Set a before render callback in the texture.
  24415. * This has been kept for backward compatibility and use of onBeforeRenderObservable is recommended.
  24416. */
  24417. set onBeforeRender(callback: (faceIndex: number) => void);
  24418. /**
  24419. * An event triggered after rendering the texture
  24420. */
  24421. onAfterRenderObservable: Observable<number>;
  24422. private _onAfterRenderObserver;
  24423. /**
  24424. * Set a after render callback in the texture.
  24425. * This has been kept for backward compatibility and use of onAfterRenderObservable is recommended.
  24426. */
  24427. set onAfterRender(callback: (faceIndex: number) => void);
  24428. /**
  24429. * An event triggered after the texture clear
  24430. */
  24431. onClearObservable: Observable<Engine>;
  24432. private _onClearObserver;
  24433. /**
  24434. * Set a clear callback in the texture.
  24435. * This has been kept for backward compatibility and use of onClearObservable is recommended.
  24436. */
  24437. set onClear(callback: (Engine: Engine) => void);
  24438. /**
  24439. * An event triggered when the texture is resized.
  24440. */
  24441. onResizeObservable: Observable<RenderTargetTexture>;
  24442. /**
  24443. * Define the clear color of the Render Target if it should be different from the scene.
  24444. */
  24445. clearColor: Color4;
  24446. protected _size: number | {
  24447. width: number;
  24448. height: number;
  24449. layers?: number;
  24450. };
  24451. protected _initialSizeParameter: number | {
  24452. width: number;
  24453. height: number;
  24454. } | {
  24455. ratio: number;
  24456. };
  24457. protected _sizeRatio: Nullable<number>;
  24458. /** @hidden */
  24459. _generateMipMaps: boolean;
  24460. protected _renderingManager: RenderingManager;
  24461. /** @hidden */
  24462. _waitingRenderList: string[];
  24463. protected _doNotChangeAspectRatio: boolean;
  24464. protected _currentRefreshId: number;
  24465. protected _refreshRate: number;
  24466. protected _textureMatrix: Matrix;
  24467. protected _samples: number;
  24468. protected _renderTargetOptions: RenderTargetCreationOptions;
  24469. /**
  24470. * Gets render target creation options that were used.
  24471. */
  24472. get renderTargetOptions(): RenderTargetCreationOptions;
  24473. protected _onRatioRescale(): void;
  24474. /**
  24475. * Gets or sets the center of the bounding box associated with the texture (when in cube mode)
  24476. * It must define where the camera used to render the texture is set
  24477. */
  24478. boundingBoxPosition: Vector3;
  24479. private _boundingBoxSize;
  24480. /**
  24481. * Gets or sets the size of the bounding box associated with the texture (when in cube mode)
  24482. * When defined, the cubemap will switch to local mode
  24483. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  24484. * @example https://www.babylonjs-playground.com/#RNASML
  24485. */
  24486. set boundingBoxSize(value: Vector3);
  24487. get boundingBoxSize(): Vector3;
  24488. /**
  24489. * In case the RTT has been created with a depth texture, get the associated
  24490. * depth texture.
  24491. * Otherwise, return null.
  24492. */
  24493. get depthStencilTexture(): Nullable<InternalTexture>;
  24494. /**
  24495. * Instantiate a render target texture. This is mainly used to render of screen the scene to for instance apply post processse
  24496. * or used a shadow, depth texture...
  24497. * @param name The friendly name of the texture
  24498. * @param size The size of the RTT (number if square, or {width: number, height:number} or {ratio:} to define a ratio from the main scene)
  24499. * @param scene The scene the RTT belongs to. The latest created scene will be used if not precised.
  24500. * @param generateMipMaps True if mip maps need to be generated after render.
  24501. * @param doNotChangeAspectRatio True to not change the aspect ratio of the scene in the RTT
  24502. * @param type The type of the buffer in the RTT (int, half float, float...)
  24503. * @param isCube True if a cube texture needs to be created
  24504. * @param samplingMode The sampling mode to be usedwith the render target (Linear, Nearest...)
  24505. * @param generateDepthBuffer True to generate a depth buffer
  24506. * @param generateStencilBuffer True to generate a stencil buffer
  24507. * @param isMulti True if multiple textures need to be created (Draw Buffers)
  24508. * @param format The internal format of the buffer in the RTT (RED, RG, RGB, RGBA, ALPHA...)
  24509. * @param delayAllocation if the texture allocation should be delayed (default: false)
  24510. */
  24511. constructor(name: string, size: number | {
  24512. width: number;
  24513. height: number;
  24514. layers?: number;
  24515. } | {
  24516. ratio: number;
  24517. }, scene: Nullable<Scene>, generateMipMaps?: boolean, doNotChangeAspectRatio?: boolean, type?: number, isCube?: boolean, samplingMode?: number, generateDepthBuffer?: boolean, generateStencilBuffer?: boolean, isMulti?: boolean, format?: number, delayAllocation?: boolean);
  24518. /**
  24519. * Creates a depth stencil texture.
  24520. * This is only available in WebGL 2 or with the depth texture extension available.
  24521. * @param comparisonFunction Specifies the comparison function to set on the texture. If 0 or undefined, the texture is not in comparison mode
  24522. * @param bilinearFiltering Specifies whether or not bilinear filtering is enable on the texture
  24523. * @param generateStencil Specifies whether or not a stencil should be allocated in the texture
  24524. */
  24525. createDepthStencilTexture(comparisonFunction?: number, bilinearFiltering?: boolean, generateStencil?: boolean): void;
  24526. private _processSizeParameter;
  24527. /**
  24528. * Define the number of samples to use in case of MSAA.
  24529. * It defaults to one meaning no MSAA has been enabled.
  24530. */
  24531. get samples(): number;
  24532. set samples(value: number);
  24533. /**
  24534. * Resets the refresh counter of the texture and start bak from scratch.
  24535. * Could be useful to regenerate the texture if it is setup to render only once.
  24536. */
  24537. resetRefreshCounter(): void;
  24538. /**
  24539. * Define the refresh rate of the texture or the rendering frequency.
  24540. * Use 0 to render just once, 1 to render on every frame, 2 to render every two frames and so on...
  24541. */
  24542. get refreshRate(): number;
  24543. set refreshRate(value: number);
  24544. /**
  24545. * Adds a post process to the render target rendering passes.
  24546. * @param postProcess define the post process to add
  24547. */
  24548. addPostProcess(postProcess: PostProcess): void;
  24549. /**
  24550. * Clear all the post processes attached to the render target
  24551. * @param dispose define if the cleared post processesshould also be disposed (false by default)
  24552. */
  24553. clearPostProcesses(dispose?: boolean): void;
  24554. /**
  24555. * Remove one of the post process from the list of attached post processes to the texture
  24556. * @param postProcess define the post process to remove from the list
  24557. */
  24558. removePostProcess(postProcess: PostProcess): void;
  24559. /** @hidden */
  24560. _shouldRender(): boolean;
  24561. /**
  24562. * Gets the actual render size of the texture.
  24563. * @returns the width of the render size
  24564. */
  24565. getRenderSize(): number;
  24566. /**
  24567. * Gets the actual render width of the texture.
  24568. * @returns the width of the render size
  24569. */
  24570. getRenderWidth(): number;
  24571. /**
  24572. * Gets the actual render height of the texture.
  24573. * @returns the height of the render size
  24574. */
  24575. getRenderHeight(): number;
  24576. /**
  24577. * Gets the actual number of layers of the texture.
  24578. * @returns the number of layers
  24579. */
  24580. getRenderLayers(): number;
  24581. /**
  24582. * Get if the texture can be rescaled or not.
  24583. */
  24584. get canRescale(): boolean;
  24585. /**
  24586. * Resize the texture using a ratio.
  24587. * @param ratio the ratio to apply to the texture size in order to compute the new target size
  24588. */
  24589. scale(ratio: number): void;
  24590. /**
  24591. * Get the texture reflection matrix used to rotate/transform the reflection.
  24592. * @returns the reflection matrix
  24593. */
  24594. getReflectionTextureMatrix(): Matrix;
  24595. /**
  24596. * Resize the texture to a new desired size.
  24597. * Be carrefull as it will recreate all the data in the new texture.
  24598. * @param size Define the new size. It can be:
  24599. * - a number for squared texture,
  24600. * - an object containing { width: number, height: number }
  24601. * - or an object containing a ratio { ratio: number }
  24602. */
  24603. resize(size: number | {
  24604. width: number;
  24605. height: number;
  24606. } | {
  24607. ratio: number;
  24608. }): void;
  24609. private _defaultRenderListPrepared;
  24610. /**
  24611. * Renders all the objects from the render list into the texture.
  24612. * @param useCameraPostProcess Define if camera post processes should be used during the rendering
  24613. * @param dumpForDebug Define if the rendering result should be dumped (copied) for debugging purpose
  24614. */
  24615. render(useCameraPostProcess?: boolean, dumpForDebug?: boolean): void;
  24616. private _bestReflectionRenderTargetDimension;
  24617. private _prepareRenderingManager;
  24618. /**
  24619. * @hidden
  24620. * @param faceIndex face index to bind to if this is a cubetexture
  24621. * @param layer defines the index of the texture to bind in the array
  24622. */
  24623. _bindFrameBuffer(faceIndex?: number, layer?: number): void;
  24624. protected unbindFrameBuffer(engine: Engine, faceIndex: number): void;
  24625. private renderToTarget;
  24626. /**
  24627. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  24628. * This allowed control for front to back rendering or reversly depending of the special needs.
  24629. *
  24630. * @param renderingGroupId The rendering group id corresponding to its index
  24631. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  24632. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  24633. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  24634. */
  24635. setRenderingOrder(renderingGroupId: number, opaqueSortCompareFn?: Nullable<(a: SubMesh, b: SubMesh) => number>, alphaTestSortCompareFn?: Nullable<(a: SubMesh, b: SubMesh) => number>, transparentSortCompareFn?: Nullable<(a: SubMesh, b: SubMesh) => number>): void;
  24636. /**
  24637. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  24638. *
  24639. * @param renderingGroupId The rendering group id corresponding to its index
  24640. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  24641. */
  24642. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean): void;
  24643. /**
  24644. * Clones the texture.
  24645. * @returns the cloned texture
  24646. */
  24647. clone(): RenderTargetTexture;
  24648. /**
  24649. * Serialize the texture to a JSON representation we can easily use in the resepective Parse function.
  24650. * @returns The JSON representation of the texture
  24651. */
  24652. serialize(): any;
  24653. /**
  24654. * This will remove the attached framebuffer objects. The texture will not be able to be used as render target anymore
  24655. */
  24656. disposeFramebufferObjects(): void;
  24657. /**
  24658. * Dispose the texture and release its associated resources.
  24659. */
  24660. dispose(): void;
  24661. /** @hidden */
  24662. _rebuild(): void;
  24663. /**
  24664. * Clear the info related to rendering groups preventing retention point in material dispose.
  24665. */
  24666. freeRenderingGroups(): void;
  24667. /**
  24668. * Gets the number of views the corresponding to the texture (eg. a MultiviewRenderTarget will have > 1)
  24669. * @returns the view count
  24670. */
  24671. getViewCount(): number;
  24672. }
  24673. }
  24674. declare module "babylonjs/Misc/guid" {
  24675. /**
  24676. * Class used to manipulate GUIDs
  24677. */
  24678. export class GUID {
  24679. /**
  24680. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  24681. * Be aware Math.random() could cause collisions, but:
  24682. * "All but 6 of the 128 bits of the ID are randomly generated, which means that for any two ids, there's a 1 in 2^^122 (or 5.3x10^^36) chance they'll collide"
  24683. * @returns a pseudo random id
  24684. */
  24685. static RandomId(): string;
  24686. }
  24687. }
  24688. declare module "babylonjs/Materials/shadowDepthWrapper" {
  24689. import { Nullable } from "babylonjs/types";
  24690. import { Scene } from "babylonjs/scene";
  24691. import { SubMesh } from "babylonjs/Meshes/subMesh";
  24692. import { Material } from "babylonjs/Materials/material";
  24693. import { Effect } from "babylonjs/Materials/effect";
  24694. import { ShadowGenerator } from "babylonjs/Lights/Shadows/shadowGenerator";
  24695. /**
  24696. * Options to be used when creating a shadow depth material
  24697. */
  24698. export interface IIOptionShadowDepthMaterial {
  24699. /** Variables in the vertex shader code that need to have their names remapped.
  24700. * The format is: ["var_name", "var_remapped_name", "var_name", "var_remapped_name", ...]
  24701. * "var_name" should be either: worldPos or vNormalW
  24702. * So, if the variable holding the world position in your vertex shader is not named worldPos, you must tell the system
  24703. * the name to use instead by using: ["worldPos", "myWorldPosVar"] assuming the variable is named myWorldPosVar in your code.
  24704. * If the normal must also be remapped: ["worldPos", "myWorldPosVar", "vNormalW", "myWorldNormal"]
  24705. */
  24706. remappedVariables?: string[];
  24707. /** Set standalone to true if the base material wrapped by ShadowDepthMaterial is not used for a regular object but for depth shadow generation only */
  24708. standalone?: boolean;
  24709. }
  24710. /**
  24711. * Class that can be used to wrap a base material to generate accurate shadows when using custom vertex/fragment code in the base material
  24712. */
  24713. export class ShadowDepthWrapper {
  24714. private _scene;
  24715. private _options?;
  24716. private _baseMaterial;
  24717. private _onEffectCreatedObserver;
  24718. private _subMeshToEffect;
  24719. private _subMeshToDepthEffect;
  24720. private _meshes;
  24721. /** @hidden */
  24722. _matriceNames: any;
  24723. /** Gets the standalone status of the wrapper */
  24724. get standalone(): boolean;
  24725. /** Gets the base material the wrapper is built upon */
  24726. get baseMaterial(): Material;
  24727. /**
  24728. * Instantiate a new shadow depth wrapper.
  24729. * It works by injecting some specific code in the vertex/fragment shaders of the base material and is used by a shadow generator to
  24730. * generate the shadow depth map. For more information, please refer to the documentation:
  24731. * https://doc.babylonjs.com/babylon101/shadows
  24732. * @param baseMaterial Material to wrap
  24733. * @param scene Define the scene the material belongs to
  24734. * @param options Options used to create the wrapper
  24735. */
  24736. constructor(baseMaterial: Material, scene: Scene, options?: IIOptionShadowDepthMaterial);
  24737. /**
  24738. * Gets the effect to use to generate the depth map
  24739. * @param subMesh subMesh to get the effect for
  24740. * @param shadowGenerator shadow generator to get the effect for
  24741. * @returns the effect to use to generate the depth map for the subMesh + shadow generator specified
  24742. */
  24743. getEffect(subMesh: Nullable<SubMesh>, shadowGenerator: ShadowGenerator): Nullable<Effect>;
  24744. /**
  24745. * Specifies that the submesh is ready to be used for depth rendering
  24746. * @param subMesh submesh to check
  24747. * @param defines the list of defines to take into account when checking the effect
  24748. * @param shadowGenerator combined with subMesh, it defines the effect to check
  24749. * @param useInstances specifies that instances should be used
  24750. * @returns a boolean indicating that the submesh is ready or not
  24751. */
  24752. isReadyForSubMesh(subMesh: SubMesh, defines: string[], shadowGenerator: ShadowGenerator, useInstances: boolean): boolean;
  24753. /**
  24754. * Disposes the resources
  24755. */
  24756. dispose(): void;
  24757. private _makeEffect;
  24758. }
  24759. }
  24760. declare module "babylonjs/Engines/Extensions/engine.multiRender" {
  24761. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  24762. import { IMultiRenderTargetOptions } from "babylonjs/Materials/Textures/multiRenderTarget";
  24763. import { Nullable } from "babylonjs/types";
  24764. module "babylonjs/Engines/thinEngine" {
  24765. interface ThinEngine {
  24766. /**
  24767. * Unbind a list of render target textures from the webGL context
  24768. * This is used only when drawBuffer extension or webGL2 are active
  24769. * @param textures defines the render target textures to unbind
  24770. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  24771. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  24772. */
  24773. unBindMultiColorAttachmentFramebuffer(textures: InternalTexture[], disableGenerateMipMaps: boolean, onBeforeUnbind?: () => void): void;
  24774. /**
  24775. * Create a multi render target texture
  24776. * @see https://doc.babylonjs.com/features/webgl2#multiple-render-target
  24777. * @param size defines the size of the texture
  24778. * @param options defines the creation options
  24779. * @returns the cube texture as an InternalTexture
  24780. */
  24781. createMultipleRenderTarget(size: any, options: IMultiRenderTargetOptions): InternalTexture[];
  24782. /**
  24783. * Update the sample count for a given multiple render target texture
  24784. * @see https://doc.babylonjs.com/features/webgl2#multisample-render-targets
  24785. * @param textures defines the textures to update
  24786. * @param samples defines the sample count to set
  24787. * @returns the effective sample count (could be 0 if multisample render targets are not supported)
  24788. */
  24789. updateMultipleRenderTargetTextureSampleCount(textures: Nullable<InternalTexture[]>, samples: number): number;
  24790. /**
  24791. * Select a subsets of attachments to draw to.
  24792. * @param attachments gl attachments
  24793. */
  24794. bindAttachments(attachments: number[]): void;
  24795. }
  24796. }
  24797. }
  24798. declare module "babylonjs/Materials/Textures/multiRenderTarget" {
  24799. import { Scene } from "babylonjs/scene";
  24800. import { Engine } from "babylonjs/Engines/engine";
  24801. import { Texture } from "babylonjs/Materials/Textures/texture";
  24802. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  24803. import "babylonjs/Engines/Extensions/engine.multiRender";
  24804. /**
  24805. * Creation options of the multi render target texture.
  24806. */
  24807. export interface IMultiRenderTargetOptions {
  24808. /**
  24809. * Define if the texture needs to create mip maps after render.
  24810. */
  24811. generateMipMaps?: boolean;
  24812. /**
  24813. * Define the types of all the draw buffers we want to create
  24814. */
  24815. types?: number[];
  24816. /**
  24817. * Define the sampling modes of all the draw buffers we want to create
  24818. */
  24819. samplingModes?: number[];
  24820. /**
  24821. * Define if a depth buffer is required
  24822. */
  24823. generateDepthBuffer?: boolean;
  24824. /**
  24825. * Define if a stencil buffer is required
  24826. */
  24827. generateStencilBuffer?: boolean;
  24828. /**
  24829. * Define if a depth texture is required instead of a depth buffer
  24830. */
  24831. generateDepthTexture?: boolean;
  24832. /**
  24833. * Define the number of desired draw buffers
  24834. */
  24835. textureCount?: number;
  24836. /**
  24837. * Define if aspect ratio should be adapted to the texture or stay the scene one
  24838. */
  24839. doNotChangeAspectRatio?: boolean;
  24840. /**
  24841. * Define the default type of the buffers we are creating
  24842. */
  24843. defaultType?: number;
  24844. }
  24845. /**
  24846. * A multi render target, like a render target provides the ability to render to a texture.
  24847. * Unlike the render target, it can render to several draw buffers in one draw.
  24848. * This is specially interesting in deferred rendering or for any effects requiring more than
  24849. * just one color from a single pass.
  24850. */
  24851. export class MultiRenderTarget extends RenderTargetTexture {
  24852. private _internalTextures;
  24853. private _textures;
  24854. private _multiRenderTargetOptions;
  24855. private _count;
  24856. /**
  24857. * Get if draw buffers are currently supported by the used hardware and browser.
  24858. */
  24859. get isSupported(): boolean;
  24860. /**
  24861. * Get the list of textures generated by the multi render target.
  24862. */
  24863. get textures(): Texture[];
  24864. /**
  24865. * Gets the number of textures in this MRT. This number can be different from `_textures.length` in case a depth texture is generated.
  24866. */
  24867. get count(): number;
  24868. /**
  24869. * Get the depth texture generated by the multi render target if options.generateDepthTexture has been set
  24870. */
  24871. get depthTexture(): Texture;
  24872. /**
  24873. * Set the wrapping mode on U of all the textures we are rendering to.
  24874. * Can be any of the Texture. (CLAMP_ADDRESSMODE, MIRROR_ADDRESSMODE or WRAP_ADDRESSMODE)
  24875. */
  24876. set wrapU(wrap: number);
  24877. /**
  24878. * Set the wrapping mode on V of all the textures we are rendering to.
  24879. * Can be any of the Texture. (CLAMP_ADDRESSMODE, MIRROR_ADDRESSMODE or WRAP_ADDRESSMODE)
  24880. */
  24881. set wrapV(wrap: number);
  24882. /**
  24883. * Instantiate a new multi render target texture.
  24884. * A multi render target, like a render target provides the ability to render to a texture.
  24885. * Unlike the render target, it can render to several draw buffers in one draw.
  24886. * This is specially interesting in deferred rendering or for any effects requiring more than
  24887. * just one color from a single pass.
  24888. * @param name Define the name of the texture
  24889. * @param size Define the size of the buffers to render to
  24890. * @param count Define the number of target we are rendering into
  24891. * @param scene Define the scene the texture belongs to
  24892. * @param options Define the options used to create the multi render target
  24893. */
  24894. constructor(name: string, size: any, count: number, scene: Scene, options?: IMultiRenderTargetOptions);
  24895. /** @hidden */
  24896. _rebuild(): void;
  24897. private _createInternalTextures;
  24898. private _createTextures;
  24899. /**
  24900. * Define the number of samples used if MSAA is enabled.
  24901. */
  24902. get samples(): number;
  24903. set samples(value: number);
  24904. /**
  24905. * Resize all the textures in the multi render target.
  24906. * Be carrefull as it will recreate all the data in the new texture.
  24907. * @param size Define the new size
  24908. */
  24909. resize(size: any): void;
  24910. protected unbindFrameBuffer(engine: Engine, faceIndex: number): void;
  24911. /**
  24912. * Dispose the render targets and their associated resources
  24913. */
  24914. dispose(): void;
  24915. /**
  24916. * Release all the underlying texture used as draw buffers.
  24917. */
  24918. releaseInternalTextures(): void;
  24919. }
  24920. }
  24921. declare module "babylonjs/Shaders/imageProcessing.fragment" {
  24922. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  24923. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  24924. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  24925. /** @hidden */
  24926. export var imageProcessingPixelShader: {
  24927. name: string;
  24928. shader: string;
  24929. };
  24930. }
  24931. declare module "babylonjs/PostProcesses/imageProcessingPostProcess" {
  24932. import { Nullable } from "babylonjs/types";
  24933. import { Color4 } from "babylonjs/Maths/math.color";
  24934. import { Camera } from "babylonjs/Cameras/camera";
  24935. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  24936. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  24937. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  24938. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  24939. import { Engine } from "babylonjs/Engines/engine";
  24940. import "babylonjs/Shaders/imageProcessing.fragment";
  24941. import "babylonjs/Shaders/postprocess.vertex";
  24942. /**
  24943. * ImageProcessingPostProcess
  24944. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#imageprocessing
  24945. */
  24946. export class ImageProcessingPostProcess extends PostProcess {
  24947. /**
  24948. * Default configuration related to image processing available in the PBR Material.
  24949. */
  24950. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  24951. /**
  24952. * Gets the image processing configuration used either in this material.
  24953. */
  24954. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  24955. /**
  24956. * Sets the Default image processing configuration used either in the this material.
  24957. *
  24958. * If sets to null, the scene one is in use.
  24959. */
  24960. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  24961. /**
  24962. * Keep track of the image processing observer to allow dispose and replace.
  24963. */
  24964. private _imageProcessingObserver;
  24965. /**
  24966. * Attaches a new image processing configuration to the PBR Material.
  24967. * @param configuration
  24968. */
  24969. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>, doNotBuild?: boolean): void;
  24970. /**
  24971. * If the post process is supported.
  24972. */
  24973. get isSupported(): boolean;
  24974. /**
  24975. * Gets Color curves setup used in the effect if colorCurvesEnabled is set to true .
  24976. */
  24977. get colorCurves(): Nullable<ColorCurves>;
  24978. /**
  24979. * Sets Color curves setup used in the effect if colorCurvesEnabled is set to true .
  24980. */
  24981. set colorCurves(value: Nullable<ColorCurves>);
  24982. /**
  24983. * Gets wether the color curves effect is enabled.
  24984. */
  24985. get colorCurvesEnabled(): boolean;
  24986. /**
  24987. * Sets wether the color curves effect is enabled.
  24988. */
  24989. set colorCurvesEnabled(value: boolean);
  24990. /**
  24991. * Gets Color grading LUT texture used in the effect if colorGradingEnabled is set to true.
  24992. */
  24993. get colorGradingTexture(): Nullable<BaseTexture>;
  24994. /**
  24995. * Sets Color grading LUT texture used in the effect if colorGradingEnabled is set to true.
  24996. */
  24997. set colorGradingTexture(value: Nullable<BaseTexture>);
  24998. /**
  24999. * Gets wether the color grading effect is enabled.
  25000. */
  25001. get colorGradingEnabled(): boolean;
  25002. /**
  25003. * Gets wether the color grading effect is enabled.
  25004. */
  25005. set colorGradingEnabled(value: boolean);
  25006. /**
  25007. * Gets exposure used in the effect.
  25008. */
  25009. get exposure(): number;
  25010. /**
  25011. * Sets exposure used in the effect.
  25012. */
  25013. set exposure(value: number);
  25014. /**
  25015. * Gets wether tonemapping is enabled or not.
  25016. */
  25017. get toneMappingEnabled(): boolean;
  25018. /**
  25019. * Sets wether tonemapping is enabled or not
  25020. */
  25021. set toneMappingEnabled(value: boolean);
  25022. /**
  25023. * Gets the type of tone mapping effect.
  25024. */
  25025. get toneMappingType(): number;
  25026. /**
  25027. * Sets the type of tone mapping effect.
  25028. */
  25029. set toneMappingType(value: number);
  25030. /**
  25031. * Gets contrast used in the effect.
  25032. */
  25033. get contrast(): number;
  25034. /**
  25035. * Sets contrast used in the effect.
  25036. */
  25037. set contrast(value: number);
  25038. /**
  25039. * Gets Vignette stretch size.
  25040. */
  25041. get vignetteStretch(): number;
  25042. /**
  25043. * Sets Vignette stretch size.
  25044. */
  25045. set vignetteStretch(value: number);
  25046. /**
  25047. * Gets Vignette centre X Offset.
  25048. */
  25049. get vignetteCentreX(): number;
  25050. /**
  25051. * Sets Vignette centre X Offset.
  25052. */
  25053. set vignetteCentreX(value: number);
  25054. /**
  25055. * Gets Vignette centre Y Offset.
  25056. */
  25057. get vignetteCentreY(): number;
  25058. /**
  25059. * Sets Vignette centre Y Offset.
  25060. */
  25061. set vignetteCentreY(value: number);
  25062. /**
  25063. * Gets Vignette weight or intensity of the vignette effect.
  25064. */
  25065. get vignetteWeight(): number;
  25066. /**
  25067. * Sets Vignette weight or intensity of the vignette effect.
  25068. */
  25069. set vignetteWeight(value: number);
  25070. /**
  25071. * Gets Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  25072. * if vignetteEnabled is set to true.
  25073. */
  25074. get vignetteColor(): Color4;
  25075. /**
  25076. * Sets Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  25077. * if vignetteEnabled is set to true.
  25078. */
  25079. set vignetteColor(value: Color4);
  25080. /**
  25081. * Gets Camera field of view used by the Vignette effect.
  25082. */
  25083. get vignetteCameraFov(): number;
  25084. /**
  25085. * Sets Camera field of view used by the Vignette effect.
  25086. */
  25087. set vignetteCameraFov(value: number);
  25088. /**
  25089. * Gets the vignette blend mode allowing different kind of effect.
  25090. */
  25091. get vignetteBlendMode(): number;
  25092. /**
  25093. * Sets the vignette blend mode allowing different kind of effect.
  25094. */
  25095. set vignetteBlendMode(value: number);
  25096. /**
  25097. * Gets wether the vignette effect is enabled.
  25098. */
  25099. get vignetteEnabled(): boolean;
  25100. /**
  25101. * Sets wether the vignette effect is enabled.
  25102. */
  25103. set vignetteEnabled(value: boolean);
  25104. private _fromLinearSpace;
  25105. /**
  25106. * Gets wether the input of the processing is in Gamma or Linear Space.
  25107. */
  25108. get fromLinearSpace(): boolean;
  25109. /**
  25110. * Sets wether the input of the processing is in Gamma or Linear Space.
  25111. */
  25112. set fromLinearSpace(value: boolean);
  25113. /**
  25114. * Defines cache preventing GC.
  25115. */
  25116. private _defines;
  25117. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, imageProcessingConfiguration?: ImageProcessingConfiguration);
  25118. /**
  25119. * "ImageProcessingPostProcess"
  25120. * @returns "ImageProcessingPostProcess"
  25121. */
  25122. getClassName(): string;
  25123. /**
  25124. * @hidden
  25125. */
  25126. _updateParameters(): void;
  25127. dispose(camera?: Camera): void;
  25128. }
  25129. }
  25130. declare module "babylonjs/Shaders/ShadersInclude/fibonacci" {
  25131. /** @hidden */
  25132. export var fibonacci: {
  25133. name: string;
  25134. shader: string;
  25135. };
  25136. }
  25137. declare module "babylonjs/Shaders/ShadersInclude/subSurfaceScatteringFunctions" {
  25138. /** @hidden */
  25139. export var subSurfaceScatteringFunctions: {
  25140. name: string;
  25141. shader: string;
  25142. };
  25143. }
  25144. declare module "babylonjs/Shaders/ShadersInclude/diffusionProfile" {
  25145. /** @hidden */
  25146. export var diffusionProfile: {
  25147. name: string;
  25148. shader: string;
  25149. };
  25150. }
  25151. declare module "babylonjs/Shaders/subSurfaceScattering.fragment" {
  25152. import "babylonjs/Shaders/ShadersInclude/fibonacci";
  25153. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  25154. import "babylonjs/Shaders/ShadersInclude/subSurfaceScatteringFunctions";
  25155. import "babylonjs/Shaders/ShadersInclude/diffusionProfile";
  25156. /** @hidden */
  25157. export var subSurfaceScatteringPixelShader: {
  25158. name: string;
  25159. shader: string;
  25160. };
  25161. }
  25162. declare module "babylonjs/PostProcesses/subSurfaceScatteringPostProcess" {
  25163. import { Nullable } from "babylonjs/types";
  25164. import { Camera } from "babylonjs/Cameras/camera";
  25165. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  25166. import { Engine } from "babylonjs/Engines/engine";
  25167. import { Scene } from "babylonjs/scene";
  25168. import "babylonjs/Shaders/imageProcessing.fragment";
  25169. import "babylonjs/Shaders/subSurfaceScattering.fragment";
  25170. import "babylonjs/Shaders/postprocess.vertex";
  25171. /**
  25172. * Sub surface scattering post process
  25173. */
  25174. export class SubSurfaceScatteringPostProcess extends PostProcess {
  25175. /**
  25176. * Gets a string identifying the name of the class
  25177. * @returns "SubSurfaceScatteringPostProcess" string
  25178. */
  25179. getClassName(): string;
  25180. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  25181. }
  25182. }
  25183. declare module "babylonjs/Rendering/prePassEffectConfiguration" {
  25184. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  25185. /**
  25186. * Interface for defining prepass effects in the prepass post-process pipeline
  25187. */
  25188. export interface PrePassEffectConfiguration {
  25189. /**
  25190. * Post process to attach for this effect
  25191. */
  25192. postProcess: PostProcess;
  25193. /**
  25194. * Is the effect enabled
  25195. */
  25196. enabled: boolean;
  25197. /**
  25198. * Disposes the effect configuration
  25199. */
  25200. dispose(): void;
  25201. /**
  25202. * Disposes the effect configuration
  25203. */
  25204. createPostProcess: () => PostProcess;
  25205. }
  25206. }
  25207. declare module "babylonjs/Rendering/subSurfaceConfiguration" {
  25208. import { Scene } from "babylonjs/scene";
  25209. import { Color3 } from "babylonjs/Maths/math.color";
  25210. import { SubSurfaceScatteringPostProcess } from "babylonjs/PostProcesses/subSurfaceScatteringPostProcess";
  25211. import { PrePassEffectConfiguration } from "babylonjs/Rendering/prePassEffectConfiguration";
  25212. /**
  25213. * Contains all parameters needed for the prepass to perform
  25214. * screen space subsurface scattering
  25215. */
  25216. export class SubSurfaceConfiguration implements PrePassEffectConfiguration {
  25217. private _ssDiffusionS;
  25218. private _ssFilterRadii;
  25219. private _ssDiffusionD;
  25220. /**
  25221. * Post process to attach for screen space subsurface scattering
  25222. */
  25223. postProcess: SubSurfaceScatteringPostProcess;
  25224. /**
  25225. * Diffusion profile color for subsurface scattering
  25226. */
  25227. get ssDiffusionS(): number[];
  25228. /**
  25229. * Diffusion profile max color channel value for subsurface scattering
  25230. */
  25231. get ssDiffusionD(): number[];
  25232. /**
  25233. * Diffusion profile filter radius for subsurface scattering
  25234. */
  25235. get ssFilterRadii(): number[];
  25236. /**
  25237. * Is subsurface enabled
  25238. */
  25239. enabled: boolean;
  25240. /**
  25241. * Diffusion profile colors for subsurface scattering
  25242. * You can add one diffusion color using `addDiffusionProfile` on `scene.prePassRenderer`
  25243. * See ...
  25244. * Note that you can only store up to 5 of them
  25245. */
  25246. ssDiffusionProfileColors: Color3[];
  25247. /**
  25248. * Defines the ratio real world => scene units.
  25249. * Used for subsurface scattering
  25250. */
  25251. metersPerUnit: number;
  25252. private _scene;
  25253. /**
  25254. * Builds a subsurface configuration object
  25255. * @param scene The scene
  25256. */
  25257. constructor(scene: Scene);
  25258. /**
  25259. * Adds a new diffusion profile.
  25260. * Useful for more realistic subsurface scattering on diverse materials.
  25261. * @param color The color of the diffusion profile. Should be the average color of the material.
  25262. * @return The index of the diffusion profile for the material subsurface configuration
  25263. */
  25264. addDiffusionProfile(color: Color3): number;
  25265. /**
  25266. * Creates the sss post process
  25267. * @return The created post process
  25268. */
  25269. createPostProcess(): SubSurfaceScatteringPostProcess;
  25270. /**
  25271. * Deletes all diffusion profiles.
  25272. * Note that in order to render subsurface scattering, you should have at least 1 diffusion profile.
  25273. */
  25274. clearAllDiffusionProfiles(): void;
  25275. /**
  25276. * Disposes this object
  25277. */
  25278. dispose(): void;
  25279. /**
  25280. * @hidden
  25281. * https://zero-radiance.github.io/post/sampling-diffusion/
  25282. *
  25283. * Importance sample the normalized diffuse reflectance profile for the computed value of 's'.
  25284. * ------------------------------------------------------------------------------------
  25285. * R[r, phi, s] = s * (Exp[-r * s] + Exp[-r * s / 3]) / (8 * Pi * r)
  25286. * PDF[r, phi, s] = r * R[r, phi, s]
  25287. * CDF[r, s] = 1 - 1/4 * Exp[-r * s] - 3/4 * Exp[-r * s / 3]
  25288. * ------------------------------------------------------------------------------------
  25289. * We importance sample the color channel with the widest scattering distance.
  25290. */
  25291. getDiffusionProfileParameters(color: Color3): number;
  25292. /**
  25293. * Performs sampling of a Normalized Burley diffusion profile in polar coordinates.
  25294. * 'u' is the random number (the value of the CDF): [0, 1).
  25295. * rcp(s) = 1 / ShapeParam = ScatteringDistance.
  25296. * Returns the sampled radial distance, s.t. (u = 0 -> r = 0) and (u = 1 -> r = Inf).
  25297. */
  25298. private _sampleBurleyDiffusionProfile;
  25299. }
  25300. }
  25301. declare module "babylonjs/Rendering/prePassRenderer" {
  25302. import { MultiRenderTarget } from "babylonjs/Materials/Textures/multiRenderTarget";
  25303. import { Scene } from "babylonjs/scene";
  25304. import { ImageProcessingPostProcess } from "babylonjs/PostProcesses/imageProcessingPostProcess";
  25305. import { Effect } from "babylonjs/Materials/effect";
  25306. import { SubSurfaceConfiguration } from "babylonjs/Rendering/subSurfaceConfiguration";
  25307. /**
  25308. * Renders a pre pass of the scene
  25309. * This means every mesh in the scene will be rendered to a render target texture
  25310. * And then this texture will be composited to the rendering canvas with post processes
  25311. * It is necessary for effects like subsurface scattering or deferred shading
  25312. */
  25313. export class PrePassRenderer {
  25314. /** @hidden */
  25315. static _SceneComponentInitialization: (scene: Scene) => void;
  25316. private _scene;
  25317. private _engine;
  25318. private _isDirty;
  25319. /**
  25320. * Number of textures in the multi render target texture where the scene is directly rendered
  25321. */
  25322. readonly mrtCount: number;
  25323. /**
  25324. * The render target where the scene is directly rendered
  25325. */
  25326. prePassRT: MultiRenderTarget;
  25327. private _mrtTypes;
  25328. private _multiRenderAttachments;
  25329. private _defaultAttachments;
  25330. private _clearAttachments;
  25331. private _postProcesses;
  25332. private readonly _clearColor;
  25333. /**
  25334. * Image processing post process for composition
  25335. */
  25336. imageProcessingPostProcess: ImageProcessingPostProcess;
  25337. /**
  25338. * Configuration for sub surface scattering post process
  25339. */
  25340. subSurfaceConfiguration: SubSurfaceConfiguration;
  25341. /**
  25342. * Should materials render their geometry on the MRT
  25343. */
  25344. materialsShouldRenderGeometry: boolean;
  25345. /**
  25346. * Should materials render the irradiance information on the MRT
  25347. */
  25348. materialsShouldRenderIrradiance: boolean;
  25349. private _enabled;
  25350. /**
  25351. * Indicates if the prepass is enabled
  25352. */
  25353. get enabled(): boolean;
  25354. /**
  25355. * How many samples are used for MSAA of the scene render target
  25356. */
  25357. get samples(): number;
  25358. set samples(n: number);
  25359. /**
  25360. * Instanciates a prepass renderer
  25361. * @param scene The scene
  25362. */
  25363. constructor(scene: Scene);
  25364. private _initializeAttachments;
  25365. private _createCompositionEffect;
  25366. /**
  25367. * Indicates if rendering a prepass is supported
  25368. */
  25369. get isSupported(): boolean;
  25370. /**
  25371. * Sets the proper output textures to draw in the engine.
  25372. * @param effect The effect that is drawn. It can be or not be compatible with drawing to several output textures.
  25373. */
  25374. bindAttachmentsForEffect(effect: Effect): void;
  25375. /**
  25376. * @hidden
  25377. */
  25378. _beforeCameraDraw(): void;
  25379. /**
  25380. * @hidden
  25381. */
  25382. _afterCameraDraw(): void;
  25383. private _checkRTSize;
  25384. private _bindFrameBuffer;
  25385. /**
  25386. * Clears the scene render target (in the sense of settings pixels to the scene clear color value)
  25387. */
  25388. clear(): void;
  25389. private _setState;
  25390. private _enable;
  25391. private _disable;
  25392. private _resetPostProcessChain;
  25393. private _bindPostProcessChain;
  25394. /**
  25395. * Marks the prepass renderer as dirty, triggering a check if the prepass is necessary for the next rendering.
  25396. */
  25397. markAsDirty(): void;
  25398. private _update;
  25399. /**
  25400. * Disposes the prepass renderer.
  25401. */
  25402. dispose(): void;
  25403. }
  25404. }
  25405. declare module "babylonjs/Materials/material" {
  25406. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  25407. import { SmartArray } from "babylonjs/Misc/smartArray";
  25408. import { Observable } from "babylonjs/Misc/observable";
  25409. import { Nullable } from "babylonjs/types";
  25410. import { Scene } from "babylonjs/scene";
  25411. import { Matrix } from "babylonjs/Maths/math.vector";
  25412. import { SubMesh } from "babylonjs/Meshes/subMesh";
  25413. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  25414. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  25415. import { Effect } from "babylonjs/Materials/effect";
  25416. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  25417. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  25418. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  25419. import { IInspectable } from "babylonjs/Misc/iInspectable";
  25420. import { ShadowDepthWrapper } from "babylonjs/Materials/shadowDepthWrapper";
  25421. import { PrePassRenderer } from "babylonjs/Rendering/prePassRenderer";
  25422. import { Mesh } from "babylonjs/Meshes/mesh";
  25423. import { Animation } from "babylonjs/Animations/animation";
  25424. /**
  25425. * Options for compiling materials.
  25426. */
  25427. export interface IMaterialCompilationOptions {
  25428. /**
  25429. * Defines whether clip planes are enabled.
  25430. */
  25431. clipPlane: boolean;
  25432. /**
  25433. * Defines whether instances are enabled.
  25434. */
  25435. useInstances: boolean;
  25436. }
  25437. /**
  25438. * Options passed when calling customShaderNameResolve
  25439. */
  25440. export interface ICustomShaderNameResolveOptions {
  25441. /**
  25442. * If provided, will be called two times with the vertex and fragment code so that this code can be updated before it is compiled by the GPU
  25443. */
  25444. processFinalCode?: Nullable<(shaderType: string, code: string) => string>;
  25445. }
  25446. /**
  25447. * Base class for the main features of a material in Babylon.js
  25448. */
  25449. export class Material implements IAnimatable {
  25450. /**
  25451. * Returns the triangle fill mode
  25452. */
  25453. static readonly TriangleFillMode: number;
  25454. /**
  25455. * Returns the wireframe mode
  25456. */
  25457. static readonly WireFrameFillMode: number;
  25458. /**
  25459. * Returns the point fill mode
  25460. */
  25461. static readonly PointFillMode: number;
  25462. /**
  25463. * Returns the point list draw mode
  25464. */
  25465. static readonly PointListDrawMode: number;
  25466. /**
  25467. * Returns the line list draw mode
  25468. */
  25469. static readonly LineListDrawMode: number;
  25470. /**
  25471. * Returns the line loop draw mode
  25472. */
  25473. static readonly LineLoopDrawMode: number;
  25474. /**
  25475. * Returns the line strip draw mode
  25476. */
  25477. static readonly LineStripDrawMode: number;
  25478. /**
  25479. * Returns the triangle strip draw mode
  25480. */
  25481. static readonly TriangleStripDrawMode: number;
  25482. /**
  25483. * Returns the triangle fan draw mode
  25484. */
  25485. static readonly TriangleFanDrawMode: number;
  25486. /**
  25487. * Stores the clock-wise side orientation
  25488. */
  25489. static readonly ClockWiseSideOrientation: number;
  25490. /**
  25491. * Stores the counter clock-wise side orientation
  25492. */
  25493. static readonly CounterClockWiseSideOrientation: number;
  25494. /**
  25495. * The dirty texture flag value
  25496. */
  25497. static readonly TextureDirtyFlag: number;
  25498. /**
  25499. * The dirty light flag value
  25500. */
  25501. static readonly LightDirtyFlag: number;
  25502. /**
  25503. * The dirty fresnel flag value
  25504. */
  25505. static readonly FresnelDirtyFlag: number;
  25506. /**
  25507. * The dirty attribute flag value
  25508. */
  25509. static readonly AttributesDirtyFlag: number;
  25510. /**
  25511. * The dirty misc flag value
  25512. */
  25513. static readonly MiscDirtyFlag: number;
  25514. /**
  25515. * The all dirty flag value
  25516. */
  25517. static readonly AllDirtyFlag: number;
  25518. /**
  25519. * MaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  25520. */
  25521. static readonly MATERIAL_OPAQUE: number;
  25522. /**
  25523. * MaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  25524. */
  25525. static readonly MATERIAL_ALPHATEST: number;
  25526. /**
  25527. * MaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  25528. */
  25529. static readonly MATERIAL_ALPHABLEND: number;
  25530. /**
  25531. * MaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  25532. * They are also discarded below the alpha cutoff threshold to improve performances.
  25533. */
  25534. static readonly MATERIAL_ALPHATESTANDBLEND: number;
  25535. /**
  25536. * The Whiteout method is used to blend normals.
  25537. * Details of the algorithm can be found here: https://blog.selfshadow.com/publications/blending-in-detail/
  25538. */
  25539. static readonly MATERIAL_NORMALBLENDMETHOD_WHITEOUT: number;
  25540. /**
  25541. * The Reoriented Normal Mapping method is used to blend normals.
  25542. * Details of the algorithm can be found here: https://blog.selfshadow.com/publications/blending-in-detail/
  25543. */
  25544. static readonly MATERIAL_NORMALBLENDMETHOD_RNM: number;
  25545. /**
  25546. * Custom callback helping to override the default shader used in the material.
  25547. */
  25548. customShaderNameResolve: (shaderName: string, uniforms: string[], uniformBuffers: string[], samplers: string[], defines: MaterialDefines | string[], attributes?: string[], options?: ICustomShaderNameResolveOptions) => string;
  25549. /**
  25550. * Custom shadow depth material to use for shadow rendering instead of the in-built one
  25551. */
  25552. shadowDepthWrapper: Nullable<ShadowDepthWrapper>;
  25553. /**
  25554. * Gets or sets a boolean indicating that the material is allowed (if supported) to do shader hot swapping.
  25555. * This means that the material can keep using a previous shader while a new one is being compiled.
  25556. * This is mostly used when shader parallel compilation is supported (true by default)
  25557. */
  25558. allowShaderHotSwapping: boolean;
  25559. /**
  25560. * The ID of the material
  25561. */
  25562. id: string;
  25563. /**
  25564. * Gets or sets the unique id of the material
  25565. */
  25566. uniqueId: number;
  25567. /**
  25568. * The name of the material
  25569. */
  25570. name: string;
  25571. /**
  25572. * Gets or sets user defined metadata
  25573. */
  25574. metadata: any;
  25575. /**
  25576. * For internal use only. Please do not use.
  25577. */
  25578. reservedDataStore: any;
  25579. /**
  25580. * Specifies if the ready state should be checked on each call
  25581. */
  25582. checkReadyOnEveryCall: boolean;
  25583. /**
  25584. * Specifies if the ready state should be checked once
  25585. */
  25586. checkReadyOnlyOnce: boolean;
  25587. /**
  25588. * The state of the material
  25589. */
  25590. state: string;
  25591. /**
  25592. * If the material can be rendered to several textures with MRT extension
  25593. */
  25594. get canRenderToMRT(): boolean;
  25595. /**
  25596. * The alpha value of the material
  25597. */
  25598. protected _alpha: number;
  25599. /**
  25600. * List of inspectable custom properties (used by the Inspector)
  25601. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  25602. */
  25603. inspectableCustomProperties: IInspectable[];
  25604. /**
  25605. * Sets the alpha value of the material
  25606. */
  25607. set alpha(value: number);
  25608. /**
  25609. * Gets the alpha value of the material
  25610. */
  25611. get alpha(): number;
  25612. /**
  25613. * Specifies if back face culling is enabled
  25614. */
  25615. protected _backFaceCulling: boolean;
  25616. /**
  25617. * Sets the back-face culling state
  25618. */
  25619. set backFaceCulling(value: boolean);
  25620. /**
  25621. * Gets the back-face culling state
  25622. */
  25623. get backFaceCulling(): boolean;
  25624. /**
  25625. * Stores the value for side orientation
  25626. */
  25627. sideOrientation: number;
  25628. /**
  25629. * Callback triggered when the material is compiled
  25630. */
  25631. onCompiled: Nullable<(effect: Effect) => void>;
  25632. /**
  25633. * Callback triggered when an error occurs
  25634. */
  25635. onError: Nullable<(effect: Effect, errors: string) => void>;
  25636. /**
  25637. * Callback triggered to get the render target textures
  25638. */
  25639. getRenderTargetTextures: Nullable<() => SmartArray<RenderTargetTexture>>;
  25640. /**
  25641. * Gets a boolean indicating that current material needs to register RTT
  25642. */
  25643. get hasRenderTargetTextures(): boolean;
  25644. /**
  25645. * Specifies if the material should be serialized
  25646. */
  25647. doNotSerialize: boolean;
  25648. /**
  25649. * @hidden
  25650. */
  25651. _storeEffectOnSubMeshes: boolean;
  25652. /**
  25653. * Stores the animations for the material
  25654. */
  25655. animations: Nullable<Array<Animation>>;
  25656. /**
  25657. * An event triggered when the material is disposed
  25658. */
  25659. onDisposeObservable: Observable<Material>;
  25660. /**
  25661. * An observer which watches for dispose events
  25662. */
  25663. private _onDisposeObserver;
  25664. private _onUnBindObservable;
  25665. /**
  25666. * Called during a dispose event
  25667. */
  25668. set onDispose(callback: () => void);
  25669. private _onBindObservable;
  25670. /**
  25671. * An event triggered when the material is bound
  25672. */
  25673. get onBindObservable(): Observable<AbstractMesh>;
  25674. /**
  25675. * An observer which watches for bind events
  25676. */
  25677. private _onBindObserver;
  25678. /**
  25679. * Called during a bind event
  25680. */
  25681. set onBind(callback: (Mesh: AbstractMesh) => void);
  25682. /**
  25683. * An event triggered when the material is unbound
  25684. */
  25685. get onUnBindObservable(): Observable<Material>;
  25686. protected _onEffectCreatedObservable: Nullable<Observable<{
  25687. effect: Effect;
  25688. subMesh: Nullable<SubMesh>;
  25689. }>>;
  25690. /**
  25691. * An event triggered when the effect is (re)created
  25692. */
  25693. get onEffectCreatedObservable(): Observable<{
  25694. effect: Effect;
  25695. subMesh: Nullable<SubMesh>;
  25696. }>;
  25697. /**
  25698. * Stores the value of the alpha mode
  25699. */
  25700. private _alphaMode;
  25701. /**
  25702. * Sets the value of the alpha mode.
  25703. *
  25704. * | Value | Type | Description |
  25705. * | --- | --- | --- |
  25706. * | 0 | ALPHA_DISABLE | |
  25707. * | 1 | ALPHA_ADD | |
  25708. * | 2 | ALPHA_COMBINE | |
  25709. * | 3 | ALPHA_SUBTRACT | |
  25710. * | 4 | ALPHA_MULTIPLY | |
  25711. * | 5 | ALPHA_MAXIMIZED | |
  25712. * | 6 | ALPHA_ONEONE | |
  25713. * | 7 | ALPHA_PREMULTIPLIED | |
  25714. * | 8 | ALPHA_PREMULTIPLIED_PORTERDUFF | |
  25715. * | 9 | ALPHA_INTERPOLATE | |
  25716. * | 10 | ALPHA_SCREENMODE | |
  25717. *
  25718. */
  25719. set alphaMode(value: number);
  25720. /**
  25721. * Gets the value of the alpha mode
  25722. */
  25723. get alphaMode(): number;
  25724. /**
  25725. * Stores the state of the need depth pre-pass value
  25726. */
  25727. private _needDepthPrePass;
  25728. /**
  25729. * Sets the need depth pre-pass value
  25730. */
  25731. set needDepthPrePass(value: boolean);
  25732. /**
  25733. * Gets the depth pre-pass value
  25734. */
  25735. get needDepthPrePass(): boolean;
  25736. /**
  25737. * Specifies if depth writing should be disabled
  25738. */
  25739. disableDepthWrite: boolean;
  25740. /**
  25741. * Specifies if color writing should be disabled
  25742. */
  25743. disableColorWrite: boolean;
  25744. /**
  25745. * Specifies if depth writing should be forced
  25746. */
  25747. forceDepthWrite: boolean;
  25748. /**
  25749. * Specifies the depth function that should be used. 0 means the default engine function
  25750. */
  25751. depthFunction: number;
  25752. /**
  25753. * Specifies if there should be a separate pass for culling
  25754. */
  25755. separateCullingPass: boolean;
  25756. /**
  25757. * Stores the state specifing if fog should be enabled
  25758. */
  25759. private _fogEnabled;
  25760. /**
  25761. * Sets the state for enabling fog
  25762. */
  25763. set fogEnabled(value: boolean);
  25764. /**
  25765. * Gets the value of the fog enabled state
  25766. */
  25767. get fogEnabled(): boolean;
  25768. /**
  25769. * Stores the size of points
  25770. */
  25771. pointSize: number;
  25772. /**
  25773. * Stores the z offset value
  25774. */
  25775. zOffset: number;
  25776. get wireframe(): boolean;
  25777. /**
  25778. * Sets the state of wireframe mode
  25779. */
  25780. set wireframe(value: boolean);
  25781. /**
  25782. * Gets the value specifying if point clouds are enabled
  25783. */
  25784. get pointsCloud(): boolean;
  25785. /**
  25786. * Sets the state of point cloud mode
  25787. */
  25788. set pointsCloud(value: boolean);
  25789. /**
  25790. * Gets the material fill mode
  25791. */
  25792. get fillMode(): number;
  25793. /**
  25794. * Sets the material fill mode
  25795. */
  25796. set fillMode(value: number);
  25797. /**
  25798. * @hidden
  25799. * Stores the effects for the material
  25800. */
  25801. _effect: Nullable<Effect>;
  25802. /**
  25803. * Specifies if uniform buffers should be used
  25804. */
  25805. private _useUBO;
  25806. /**
  25807. * Stores a reference to the scene
  25808. */
  25809. private _scene;
  25810. /**
  25811. * Stores the fill mode state
  25812. */
  25813. private _fillMode;
  25814. /**
  25815. * Specifies if the depth write state should be cached
  25816. */
  25817. private _cachedDepthWriteState;
  25818. /**
  25819. * Specifies if the color write state should be cached
  25820. */
  25821. private _cachedColorWriteState;
  25822. /**
  25823. * Specifies if the depth function state should be cached
  25824. */
  25825. private _cachedDepthFunctionState;
  25826. /**
  25827. * Stores the uniform buffer
  25828. */
  25829. protected _uniformBuffer: UniformBuffer;
  25830. /** @hidden */
  25831. _indexInSceneMaterialArray: number;
  25832. /** @hidden */
  25833. meshMap: Nullable<{
  25834. [id: string]: AbstractMesh | undefined;
  25835. }>;
  25836. /**
  25837. * Creates a material instance
  25838. * @param name defines the name of the material
  25839. * @param scene defines the scene to reference
  25840. * @param doNotAdd specifies if the material should be added to the scene
  25841. */
  25842. constructor(name: string, scene: Scene, doNotAdd?: boolean);
  25843. /**
  25844. * Returns a string representation of the current material
  25845. * @param fullDetails defines a boolean indicating which levels of logging is desired
  25846. * @returns a string with material information
  25847. */
  25848. toString(fullDetails?: boolean): string;
  25849. /**
  25850. * Gets the class name of the material
  25851. * @returns a string with the class name of the material
  25852. */
  25853. getClassName(): string;
  25854. /**
  25855. * Specifies if updates for the material been locked
  25856. */
  25857. get isFrozen(): boolean;
  25858. /**
  25859. * Locks updates for the material
  25860. */
  25861. freeze(): void;
  25862. /**
  25863. * Unlocks updates for the material
  25864. */
  25865. unfreeze(): void;
  25866. /**
  25867. * Specifies if the material is ready to be used
  25868. * @param mesh defines the mesh to check
  25869. * @param useInstances specifies if instances should be used
  25870. * @returns a boolean indicating if the material is ready to be used
  25871. */
  25872. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  25873. /**
  25874. * Specifies that the submesh is ready to be used
  25875. * @param mesh defines the mesh to check
  25876. * @param subMesh defines which submesh to check
  25877. * @param useInstances specifies that instances should be used
  25878. * @returns a boolean indicating that the submesh is ready or not
  25879. */
  25880. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  25881. /**
  25882. * Returns the material effect
  25883. * @returns the effect associated with the material
  25884. */
  25885. getEffect(): Nullable<Effect>;
  25886. /**
  25887. * Returns the current scene
  25888. * @returns a Scene
  25889. */
  25890. getScene(): Scene;
  25891. /**
  25892. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  25893. */
  25894. protected _forceAlphaTest: boolean;
  25895. /**
  25896. * The transparency mode of the material.
  25897. */
  25898. protected _transparencyMode: Nullable<number>;
  25899. /**
  25900. * Gets the current transparency mode.
  25901. */
  25902. get transparencyMode(): Nullable<number>;
  25903. /**
  25904. * Sets the transparency mode of the material.
  25905. *
  25906. * | Value | Type | Description |
  25907. * | ----- | ----------------------------------- | ----------- |
  25908. * | 0 | OPAQUE | |
  25909. * | 1 | ALPHATEST | |
  25910. * | 2 | ALPHABLEND | |
  25911. * | 3 | ALPHATESTANDBLEND | |
  25912. *
  25913. */
  25914. set transparencyMode(value: Nullable<number>);
  25915. /**
  25916. * Returns true if alpha blending should be disabled.
  25917. */
  25918. protected get _disableAlphaBlending(): boolean;
  25919. /**
  25920. * Specifies whether or not this material should be rendered in alpha blend mode.
  25921. * @returns a boolean specifying if alpha blending is needed
  25922. */
  25923. needAlphaBlending(): boolean;
  25924. /**
  25925. * Specifies if the mesh will require alpha blending
  25926. * @param mesh defines the mesh to check
  25927. * @returns a boolean specifying if alpha blending is needed for the mesh
  25928. */
  25929. needAlphaBlendingForMesh(mesh: AbstractMesh): boolean;
  25930. /**
  25931. * Specifies whether or not this material should be rendered in alpha test mode.
  25932. * @returns a boolean specifying if an alpha test is needed.
  25933. */
  25934. needAlphaTesting(): boolean;
  25935. /**
  25936. * Specifies if material alpha testing should be turned on for the mesh
  25937. * @param mesh defines the mesh to check
  25938. */
  25939. protected _shouldTurnAlphaTestOn(mesh: AbstractMesh): boolean;
  25940. /**
  25941. * Gets the texture used for the alpha test
  25942. * @returns the texture to use for alpha testing
  25943. */
  25944. getAlphaTestTexture(): Nullable<BaseTexture>;
  25945. /**
  25946. * Marks the material to indicate that it needs to be re-calculated
  25947. */
  25948. markDirty(): void;
  25949. /** @hidden */
  25950. _preBind(effect?: Effect, overrideOrientation?: Nullable<number>): boolean;
  25951. /**
  25952. * Binds the material to the mesh
  25953. * @param world defines the world transformation matrix
  25954. * @param mesh defines the mesh to bind the material to
  25955. */
  25956. bind(world: Matrix, mesh?: Mesh): void;
  25957. /**
  25958. * Binds the submesh to the material
  25959. * @param world defines the world transformation matrix
  25960. * @param mesh defines the mesh containing the submesh
  25961. * @param subMesh defines the submesh to bind the material to
  25962. */
  25963. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  25964. /**
  25965. * Binds the world matrix to the material
  25966. * @param world defines the world transformation matrix
  25967. */
  25968. bindOnlyWorldMatrix(world: Matrix): void;
  25969. /**
  25970. * Binds the scene's uniform buffer to the effect.
  25971. * @param effect defines the effect to bind to the scene uniform buffer
  25972. * @param sceneUbo defines the uniform buffer storing scene data
  25973. */
  25974. bindSceneUniformBuffer(effect: Effect, sceneUbo: UniformBuffer): void;
  25975. /**
  25976. * Binds the view matrix to the effect
  25977. * @param effect defines the effect to bind the view matrix to
  25978. */
  25979. bindView(effect: Effect): void;
  25980. /**
  25981. * Binds the view projection matrix to the effect
  25982. * @param effect defines the effect to bind the view projection matrix to
  25983. */
  25984. bindViewProjection(effect: Effect): void;
  25985. /**
  25986. * Processes to execute after binding the material to a mesh
  25987. * @param mesh defines the rendered mesh
  25988. */
  25989. protected _afterBind(mesh?: Mesh): void;
  25990. /**
  25991. * Unbinds the material from the mesh
  25992. */
  25993. unbind(): void;
  25994. /**
  25995. * Gets the active textures from the material
  25996. * @returns an array of textures
  25997. */
  25998. getActiveTextures(): BaseTexture[];
  25999. /**
  26000. * Specifies if the material uses a texture
  26001. * @param texture defines the texture to check against the material
  26002. * @returns a boolean specifying if the material uses the texture
  26003. */
  26004. hasTexture(texture: BaseTexture): boolean;
  26005. /**
  26006. * Makes a duplicate of the material, and gives it a new name
  26007. * @param name defines the new name for the duplicated material
  26008. * @returns the cloned material
  26009. */
  26010. clone(name: string): Nullable<Material>;
  26011. /**
  26012. * Gets the meshes bound to the material
  26013. * @returns an array of meshes bound to the material
  26014. */
  26015. getBindedMeshes(): AbstractMesh[];
  26016. /**
  26017. * Force shader compilation
  26018. * @param mesh defines the mesh associated with this material
  26019. * @param onCompiled defines a function to execute once the material is compiled
  26020. * @param options defines the options to configure the compilation
  26021. * @param onError defines a function to execute if the material fails compiling
  26022. */
  26023. forceCompilation(mesh: AbstractMesh, onCompiled?: (material: Material) => void, options?: Partial<IMaterialCompilationOptions>, onError?: (reason: string) => void): void;
  26024. /**
  26025. * Force shader compilation
  26026. * @param mesh defines the mesh that will use this material
  26027. * @param options defines additional options for compiling the shaders
  26028. * @returns a promise that resolves when the compilation completes
  26029. */
  26030. forceCompilationAsync(mesh: AbstractMesh, options?: Partial<IMaterialCompilationOptions>): Promise<void>;
  26031. private static readonly _AllDirtyCallBack;
  26032. private static readonly _ImageProcessingDirtyCallBack;
  26033. private static readonly _TextureDirtyCallBack;
  26034. private static readonly _FresnelDirtyCallBack;
  26035. private static readonly _MiscDirtyCallBack;
  26036. private static readonly _LightsDirtyCallBack;
  26037. private static readonly _AttributeDirtyCallBack;
  26038. private static _FresnelAndMiscDirtyCallBack;
  26039. private static _TextureAndMiscDirtyCallBack;
  26040. private static readonly _DirtyCallbackArray;
  26041. private static readonly _RunDirtyCallBacks;
  26042. /**
  26043. * Marks a define in the material to indicate that it needs to be re-computed
  26044. * @param flag defines a flag used to determine which parts of the material have to be marked as dirty
  26045. */
  26046. markAsDirty(flag: number): void;
  26047. /**
  26048. * Marks all submeshes of a material to indicate that their material defines need to be re-calculated
  26049. * @param func defines a function which checks material defines against the submeshes
  26050. */
  26051. protected _markAllSubMeshesAsDirty(func: (defines: MaterialDefines) => void): void;
  26052. /**
  26053. * Indicates that the scene should check if the rendering now needs a prepass
  26054. */
  26055. protected _markScenePrePassDirty(): void;
  26056. /**
  26057. * Indicates that we need to re-calculated for all submeshes
  26058. */
  26059. protected _markAllSubMeshesAsAllDirty(): void;
  26060. /**
  26061. * Indicates that image processing needs to be re-calculated for all submeshes
  26062. */
  26063. protected _markAllSubMeshesAsImageProcessingDirty(): void;
  26064. /**
  26065. * Indicates that textures need to be re-calculated for all submeshes
  26066. */
  26067. protected _markAllSubMeshesAsTexturesDirty(): void;
  26068. /**
  26069. * Indicates that fresnel needs to be re-calculated for all submeshes
  26070. */
  26071. protected _markAllSubMeshesAsFresnelDirty(): void;
  26072. /**
  26073. * Indicates that fresnel and misc need to be re-calculated for all submeshes
  26074. */
  26075. protected _markAllSubMeshesAsFresnelAndMiscDirty(): void;
  26076. /**
  26077. * Indicates that lights need to be re-calculated for all submeshes
  26078. */
  26079. protected _markAllSubMeshesAsLightsDirty(): void;
  26080. /**
  26081. * Indicates that attributes need to be re-calculated for all submeshes
  26082. */
  26083. protected _markAllSubMeshesAsAttributesDirty(): void;
  26084. /**
  26085. * Indicates that misc needs to be re-calculated for all submeshes
  26086. */
  26087. protected _markAllSubMeshesAsMiscDirty(): void;
  26088. /**
  26089. * Indicates that textures and misc need to be re-calculated for all submeshes
  26090. */
  26091. protected _markAllSubMeshesAsTexturesAndMiscDirty(): void;
  26092. /**
  26093. * Sets the required values to the prepass renderer.
  26094. * @param prePassRenderer defines the prepass renderer to setup.
  26095. * @returns true if the pre pass is needed.
  26096. */
  26097. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  26098. /**
  26099. * Disposes the material
  26100. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  26101. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  26102. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  26103. */
  26104. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  26105. /** @hidden */
  26106. private releaseVertexArrayObject;
  26107. /**
  26108. * Serializes this material
  26109. * @returns the serialized material object
  26110. */
  26111. serialize(): any;
  26112. /**
  26113. * Creates a material from parsed material data
  26114. * @param parsedMaterial defines parsed material data
  26115. * @param scene defines the hosting scene
  26116. * @param rootUrl defines the root URL to use to load textures
  26117. * @returns a new material
  26118. */
  26119. static Parse(parsedMaterial: any, scene: Scene, rootUrl: string): Nullable<Material>;
  26120. }
  26121. }
  26122. declare module "babylonjs/Materials/multiMaterial" {
  26123. import { Nullable } from "babylonjs/types";
  26124. import { Scene } from "babylonjs/scene";
  26125. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  26126. import { SubMesh } from "babylonjs/Meshes/subMesh";
  26127. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  26128. import { Material } from "babylonjs/Materials/material";
  26129. /**
  26130. * A multi-material is used to apply different materials to different parts of the same object without the need of
  26131. * separate meshes. This can be use to improve performances.
  26132. * @see https://doc.babylonjs.com/how_to/multi_materials
  26133. */
  26134. export class MultiMaterial extends Material {
  26135. private _subMaterials;
  26136. /**
  26137. * Gets or Sets the list of Materials used within the multi material.
  26138. * They need to be ordered according to the submeshes order in the associated mesh
  26139. */
  26140. get subMaterials(): Nullable<Material>[];
  26141. set subMaterials(value: Nullable<Material>[]);
  26142. /**
  26143. * Function used to align with Node.getChildren()
  26144. * @returns the list of Materials used within the multi material
  26145. */
  26146. getChildren(): Nullable<Material>[];
  26147. /**
  26148. * Instantiates a new Multi Material
  26149. * A multi-material is used to apply different materials to different parts of the same object without the need of
  26150. * separate meshes. This can be use to improve performances.
  26151. * @see https://doc.babylonjs.com/how_to/multi_materials
  26152. * @param name Define the name in the scene
  26153. * @param scene Define the scene the material belongs to
  26154. */
  26155. constructor(name: string, scene: Scene);
  26156. private _hookArray;
  26157. /**
  26158. * Get one of the submaterial by its index in the submaterials array
  26159. * @param index The index to look the sub material at
  26160. * @returns The Material if the index has been defined
  26161. */
  26162. getSubMaterial(index: number): Nullable<Material>;
  26163. /**
  26164. * Get the list of active textures for the whole sub materials list.
  26165. * @returns All the textures that will be used during the rendering
  26166. */
  26167. getActiveTextures(): BaseTexture[];
  26168. /**
  26169. * Gets the current class name of the material e.g. "MultiMaterial"
  26170. * Mainly use in serialization.
  26171. * @returns the class name
  26172. */
  26173. getClassName(): string;
  26174. /**
  26175. * Checks if the material is ready to render the requested sub mesh
  26176. * @param mesh Define the mesh the submesh belongs to
  26177. * @param subMesh Define the sub mesh to look readyness for
  26178. * @param useInstances Define whether or not the material is used with instances
  26179. * @returns true if ready, otherwise false
  26180. */
  26181. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  26182. /**
  26183. * Clones the current material and its related sub materials
  26184. * @param name Define the name of the newly cloned material
  26185. * @param cloneChildren Define if submaterial will be cloned or shared with the parent instance
  26186. * @returns the cloned material
  26187. */
  26188. clone(name: string, cloneChildren?: boolean): MultiMaterial;
  26189. /**
  26190. * Serializes the materials into a JSON representation.
  26191. * @returns the JSON representation
  26192. */
  26193. serialize(): any;
  26194. /**
  26195. * Dispose the material and release its associated resources
  26196. * @param forceDisposeEffect Define if we want to force disposing the associated effect (if false the shader is not released and could be reuse later on)
  26197. * @param forceDisposeTextures Define if we want to force disposing the associated textures (if false, they will not be disposed and can still be use elsewhere in the app)
  26198. * @param forceDisposeChildren Define if we want to force disposing the associated submaterials (if false, they will not be disposed and can still be use elsewhere in the app)
  26199. */
  26200. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, forceDisposeChildren?: boolean): void;
  26201. /**
  26202. * Creates a MultiMaterial from parsed MultiMaterial data.
  26203. * @param parsedMultiMaterial defines parsed MultiMaterial data.
  26204. * @param scene defines the hosting scene
  26205. * @returns a new MultiMaterial
  26206. */
  26207. static ParseMultiMaterial(parsedMultiMaterial: any, scene: Scene): MultiMaterial;
  26208. }
  26209. }
  26210. declare module "babylonjs/Meshes/subMesh" {
  26211. import { Nullable, IndicesArray, DeepImmutable, FloatArray } from "babylonjs/types";
  26212. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  26213. import { Engine } from "babylonjs/Engines/engine";
  26214. import { IntersectionInfo } from "babylonjs/Collisions/intersectionInfo";
  26215. import { ICullable, BoundingInfo } from "babylonjs/Culling/boundingInfo";
  26216. import { Effect } from "babylonjs/Materials/effect";
  26217. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  26218. import { Plane } from "babylonjs/Maths/math.plane";
  26219. import { Collider } from "babylonjs/Collisions/collider";
  26220. import { Material } from "babylonjs/Materials/material";
  26221. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  26222. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  26223. import { Mesh } from "babylonjs/Meshes/mesh";
  26224. import { Ray } from "babylonjs/Culling/ray";
  26225. import { TrianglePickingPredicate } from "babylonjs/Culling/ray";
  26226. /**
  26227. * Defines a subdivision inside a mesh
  26228. */
  26229. export class SubMesh implements ICullable {
  26230. /** the material index to use */
  26231. materialIndex: number;
  26232. /** vertex index start */
  26233. verticesStart: number;
  26234. /** vertices count */
  26235. verticesCount: number;
  26236. /** index start */
  26237. indexStart: number;
  26238. /** indices count */
  26239. indexCount: number;
  26240. /** @hidden */
  26241. _materialDefines: Nullable<MaterialDefines>;
  26242. /** @hidden */
  26243. _materialEffect: Nullable<Effect>;
  26244. /** @hidden */
  26245. _effectOverride: Nullable<Effect>;
  26246. /**
  26247. * Gets material defines used by the effect associated to the sub mesh
  26248. */
  26249. get materialDefines(): Nullable<MaterialDefines>;
  26250. /**
  26251. * Sets material defines used by the effect associated to the sub mesh
  26252. */
  26253. set materialDefines(defines: Nullable<MaterialDefines>);
  26254. /**
  26255. * Gets associated effect
  26256. */
  26257. get effect(): Nullable<Effect>;
  26258. /**
  26259. * Sets associated effect (effect used to render this submesh)
  26260. * @param effect defines the effect to associate with
  26261. * @param defines defines the set of defines used to compile this effect
  26262. */
  26263. setEffect(effect: Nullable<Effect>, defines?: Nullable<MaterialDefines>): void;
  26264. /** @hidden */
  26265. _linesIndexCount: number;
  26266. private _mesh;
  26267. private _renderingMesh;
  26268. private _boundingInfo;
  26269. private _linesIndexBuffer;
  26270. /** @hidden */
  26271. _lastColliderWorldVertices: Nullable<Vector3[]>;
  26272. /** @hidden */
  26273. _trianglePlanes: Plane[];
  26274. /** @hidden */
  26275. _lastColliderTransformMatrix: Nullable<Matrix>;
  26276. /** @hidden */
  26277. _renderId: number;
  26278. /** @hidden */
  26279. _alphaIndex: number;
  26280. /** @hidden */
  26281. _distanceToCamera: number;
  26282. /** @hidden */
  26283. _id: number;
  26284. private _currentMaterial;
  26285. /**
  26286. * Add a new submesh to a mesh
  26287. * @param materialIndex defines the material index to use
  26288. * @param verticesStart defines vertex index start
  26289. * @param verticesCount defines vertices count
  26290. * @param indexStart defines index start
  26291. * @param indexCount defines indices count
  26292. * @param mesh defines the parent mesh
  26293. * @param renderingMesh defines an optional rendering mesh
  26294. * @param createBoundingBox defines if bounding box should be created for this submesh
  26295. * @returns the new submesh
  26296. */
  26297. static AddToMesh(materialIndex: number, verticesStart: number, verticesCount: number, indexStart: number, indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh, createBoundingBox?: boolean): SubMesh;
  26298. /**
  26299. * Creates a new submesh
  26300. * @param materialIndex defines the material index to use
  26301. * @param verticesStart defines vertex index start
  26302. * @param verticesCount defines vertices count
  26303. * @param indexStart defines index start
  26304. * @param indexCount defines indices count
  26305. * @param mesh defines the parent mesh
  26306. * @param renderingMesh defines an optional rendering mesh
  26307. * @param createBoundingBox defines if bounding box should be created for this submesh
  26308. * @param addToMesh defines a boolean indicating that the submesh must be added to the mesh.subMeshes array (true by default)
  26309. */
  26310. constructor(
  26311. /** the material index to use */
  26312. materialIndex: number,
  26313. /** vertex index start */
  26314. verticesStart: number,
  26315. /** vertices count */
  26316. verticesCount: number,
  26317. /** index start */
  26318. indexStart: number,
  26319. /** indices count */
  26320. indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh, createBoundingBox?: boolean, addToMesh?: boolean);
  26321. /**
  26322. * Returns true if this submesh covers the entire parent mesh
  26323. * @ignorenaming
  26324. */
  26325. get IsGlobal(): boolean;
  26326. /**
  26327. * Returns the submesh BoudingInfo object
  26328. * @returns current bounding info (or mesh's one if the submesh is global)
  26329. */
  26330. getBoundingInfo(): BoundingInfo;
  26331. /**
  26332. * Sets the submesh BoundingInfo
  26333. * @param boundingInfo defines the new bounding info to use
  26334. * @returns the SubMesh
  26335. */
  26336. setBoundingInfo(boundingInfo: BoundingInfo): SubMesh;
  26337. /**
  26338. * Returns the mesh of the current submesh
  26339. * @return the parent mesh
  26340. */
  26341. getMesh(): AbstractMesh;
  26342. /**
  26343. * Returns the rendering mesh of the submesh
  26344. * @returns the rendering mesh (could be different from parent mesh)
  26345. */
  26346. getRenderingMesh(): Mesh;
  26347. /**
  26348. * Returns the replacement mesh of the submesh
  26349. * @returns the replacement mesh (could be different from parent mesh)
  26350. */
  26351. getReplacementMesh(): Nullable<AbstractMesh>;
  26352. /**
  26353. * Returns the effective mesh of the submesh
  26354. * @returns the effective mesh (could be different from parent mesh)
  26355. */
  26356. getEffectiveMesh(): AbstractMesh;
  26357. /**
  26358. * Returns the submesh material
  26359. * @returns null or the current material
  26360. */
  26361. getMaterial(): Nullable<Material>;
  26362. private _IsMultiMaterial;
  26363. /**
  26364. * Sets a new updated BoundingInfo object to the submesh
  26365. * @param data defines an optional position array to use to determine the bounding info
  26366. * @returns the SubMesh
  26367. */
  26368. refreshBoundingInfo(data?: Nullable<FloatArray>): SubMesh;
  26369. /** @hidden */
  26370. _checkCollision(collider: Collider): boolean;
  26371. /**
  26372. * Updates the submesh BoundingInfo
  26373. * @param world defines the world matrix to use to update the bounding info
  26374. * @returns the submesh
  26375. */
  26376. updateBoundingInfo(world: DeepImmutable<Matrix>): SubMesh;
  26377. /**
  26378. * True is the submesh bounding box intersects the frustum defined by the passed array of planes.
  26379. * @param frustumPlanes defines the frustum planes
  26380. * @returns true if the submesh is intersecting with the frustum
  26381. */
  26382. isInFrustum(frustumPlanes: Plane[]): boolean;
  26383. /**
  26384. * True is the submesh bounding box is completely inside the frustum defined by the passed array of planes
  26385. * @param frustumPlanes defines the frustum planes
  26386. * @returns true if the submesh is inside the frustum
  26387. */
  26388. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  26389. /**
  26390. * Renders the submesh
  26391. * @param enableAlphaMode defines if alpha needs to be used
  26392. * @returns the submesh
  26393. */
  26394. render(enableAlphaMode: boolean): SubMesh;
  26395. /**
  26396. * @hidden
  26397. */
  26398. _getLinesIndexBuffer(indices: IndicesArray, engine: Engine): DataBuffer;
  26399. /**
  26400. * Checks if the submesh intersects with a ray
  26401. * @param ray defines the ray to test
  26402. * @returns true is the passed ray intersects the submesh bounding box
  26403. */
  26404. canIntersects(ray: Ray): boolean;
  26405. /**
  26406. * Intersects current submesh with a ray
  26407. * @param ray defines the ray to test
  26408. * @param positions defines mesh's positions array
  26409. * @param indices defines mesh's indices array
  26410. * @param fastCheck defines if the first intersection will be used (and not the closest)
  26411. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  26412. * @returns intersection info or null if no intersection
  26413. */
  26414. intersects(ray: Ray, positions: Vector3[], indices: IndicesArray, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<IntersectionInfo>;
  26415. /** @hidden */
  26416. private _intersectLines;
  26417. /** @hidden */
  26418. private _intersectUnIndexedLines;
  26419. /** @hidden */
  26420. private _intersectTriangles;
  26421. /** @hidden */
  26422. private _intersectUnIndexedTriangles;
  26423. /** @hidden */
  26424. _rebuild(): void;
  26425. /**
  26426. * Creates a new submesh from the passed mesh
  26427. * @param newMesh defines the new hosting mesh
  26428. * @param newRenderingMesh defines an optional rendering mesh
  26429. * @returns the new submesh
  26430. */
  26431. clone(newMesh: AbstractMesh, newRenderingMesh?: Mesh): SubMesh;
  26432. /**
  26433. * Release associated resources
  26434. */
  26435. dispose(): void;
  26436. /**
  26437. * Gets the class name
  26438. * @returns the string "SubMesh".
  26439. */
  26440. getClassName(): string;
  26441. /**
  26442. * Creates a new submesh from indices data
  26443. * @param materialIndex the index of the main mesh material
  26444. * @param startIndex the index where to start the copy in the mesh indices array
  26445. * @param indexCount the number of indices to copy then from the startIndex
  26446. * @param mesh the main mesh to create the submesh from
  26447. * @param renderingMesh the optional rendering mesh
  26448. * @returns a new submesh
  26449. */
  26450. static CreateFromIndices(materialIndex: number, startIndex: number, indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh): SubMesh;
  26451. }
  26452. }
  26453. declare module "babylonjs/Loading/sceneLoaderFlags" {
  26454. /**
  26455. * Class used to represent data loading progression
  26456. */
  26457. export class SceneLoaderFlags {
  26458. private static _ForceFullSceneLoadingForIncremental;
  26459. private static _ShowLoadingScreen;
  26460. private static _CleanBoneMatrixWeights;
  26461. private static _loggingLevel;
  26462. /**
  26463. * Gets or sets a boolean indicating if entire scene must be loaded even if scene contains incremental data
  26464. */
  26465. static get ForceFullSceneLoadingForIncremental(): boolean;
  26466. static set ForceFullSceneLoadingForIncremental(value: boolean);
  26467. /**
  26468. * Gets or sets a boolean indicating if loading screen must be displayed while loading a scene
  26469. */
  26470. static get ShowLoadingScreen(): boolean;
  26471. static set ShowLoadingScreen(value: boolean);
  26472. /**
  26473. * Defines the current logging level (while loading the scene)
  26474. * @ignorenaming
  26475. */
  26476. static get loggingLevel(): number;
  26477. static set loggingLevel(value: number);
  26478. /**
  26479. * Gets or set a boolean indicating if matrix weights must be cleaned upon loading
  26480. */
  26481. static get CleanBoneMatrixWeights(): boolean;
  26482. static set CleanBoneMatrixWeights(value: boolean);
  26483. }
  26484. }
  26485. declare module "babylonjs/Meshes/geometry" {
  26486. import { Nullable, FloatArray, DataArray, IndicesArray } from "babylonjs/types";
  26487. import { Scene } from "babylonjs/scene";
  26488. import { Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  26489. import { Engine } from "babylonjs/Engines/engine";
  26490. import { IGetSetVerticesData, VertexData } from "babylonjs/Meshes/mesh.vertexData";
  26491. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  26492. import { Effect } from "babylonjs/Materials/effect";
  26493. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  26494. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  26495. import { Mesh } from "babylonjs/Meshes/mesh";
  26496. /**
  26497. * Class used to store geometry data (vertex buffers + index buffer)
  26498. */
  26499. export class Geometry implements IGetSetVerticesData {
  26500. /**
  26501. * Gets or sets the ID of the geometry
  26502. */
  26503. id: string;
  26504. /**
  26505. * Gets or sets the unique ID of the geometry
  26506. */
  26507. uniqueId: number;
  26508. /**
  26509. * Gets the delay loading state of the geometry (none by default which means not delayed)
  26510. */
  26511. delayLoadState: number;
  26512. /**
  26513. * Gets the file containing the data to load when running in delay load state
  26514. */
  26515. delayLoadingFile: Nullable<string>;
  26516. /**
  26517. * Callback called when the geometry is updated
  26518. */
  26519. onGeometryUpdated: (geometry: Geometry, kind?: string) => void;
  26520. private _scene;
  26521. private _engine;
  26522. private _meshes;
  26523. private _totalVertices;
  26524. /** @hidden */
  26525. _indices: IndicesArray;
  26526. /** @hidden */
  26527. _vertexBuffers: {
  26528. [key: string]: VertexBuffer;
  26529. };
  26530. private _isDisposed;
  26531. private _extend;
  26532. private _boundingBias;
  26533. /** @hidden */
  26534. _delayInfo: Array<string>;
  26535. private _indexBuffer;
  26536. private _indexBufferIsUpdatable;
  26537. /** @hidden */
  26538. _boundingInfo: Nullable<BoundingInfo>;
  26539. /** @hidden */
  26540. _delayLoadingFunction: Nullable<(any: any, geometry: Geometry) => void>;
  26541. /** @hidden */
  26542. _softwareSkinningFrameId: number;
  26543. private _vertexArrayObjects;
  26544. private _updatable;
  26545. /** @hidden */
  26546. _positions: Nullable<Vector3[]>;
  26547. /**
  26548. * Gets or sets the Bias Vector to apply on the bounding elements (box/sphere), the max extend is computed as v += v * bias.x + bias.y, the min is computed as v -= v * bias.x + bias.y
  26549. */
  26550. get boundingBias(): Vector2;
  26551. /**
  26552. * Gets or sets the Bias Vector to apply on the bounding elements (box/sphere), the max extend is computed as v += v * bias.x + bias.y, the min is computed as v -= v * bias.x + bias.y
  26553. */
  26554. set boundingBias(value: Vector2);
  26555. /**
  26556. * Static function used to attach a new empty geometry to a mesh
  26557. * @param mesh defines the mesh to attach the geometry to
  26558. * @returns the new Geometry
  26559. */
  26560. static CreateGeometryForMesh(mesh: Mesh): Geometry;
  26561. /** Get the list of meshes using this geometry */
  26562. get meshes(): Mesh[];
  26563. /**
  26564. * If set to true (false by defaut), the bounding info applied to the meshes sharing this geometry will be the bounding info defined at the class level
  26565. * and won't be computed based on the vertex positions (which is what we get when useBoundingInfoFromGeometry = false)
  26566. */
  26567. useBoundingInfoFromGeometry: boolean;
  26568. /**
  26569. * Creates a new geometry
  26570. * @param id defines the unique ID
  26571. * @param scene defines the hosting scene
  26572. * @param vertexData defines the VertexData used to get geometry data
  26573. * @param updatable defines if geometry must be updatable (false by default)
  26574. * @param mesh defines the mesh that will be associated with the geometry
  26575. */
  26576. constructor(id: string, scene: Scene, vertexData?: VertexData, updatable?: boolean, mesh?: Nullable<Mesh>);
  26577. /**
  26578. * Gets the current extend of the geometry
  26579. */
  26580. get extend(): {
  26581. minimum: Vector3;
  26582. maximum: Vector3;
  26583. };
  26584. /**
  26585. * Gets the hosting scene
  26586. * @returns the hosting Scene
  26587. */
  26588. getScene(): Scene;
  26589. /**
  26590. * Gets the hosting engine
  26591. * @returns the hosting Engine
  26592. */
  26593. getEngine(): Engine;
  26594. /**
  26595. * Defines if the geometry is ready to use
  26596. * @returns true if the geometry is ready to be used
  26597. */
  26598. isReady(): boolean;
  26599. /**
  26600. * Gets a value indicating that the geometry should not be serialized
  26601. */
  26602. get doNotSerialize(): boolean;
  26603. /** @hidden */
  26604. _rebuild(): void;
  26605. /**
  26606. * Affects all geometry data in one call
  26607. * @param vertexData defines the geometry data
  26608. * @param updatable defines if the geometry must be flagged as updatable (false as default)
  26609. */
  26610. setAllVerticesData(vertexData: VertexData, updatable?: boolean): void;
  26611. /**
  26612. * Set specific vertex data
  26613. * @param kind defines the data kind (Position, normal, etc...)
  26614. * @param data defines the vertex data to use
  26615. * @param updatable defines if the vertex must be flagged as updatable (false as default)
  26616. * @param stride defines the stride to use (0 by default). This value is deduced from the kind value if not specified
  26617. */
  26618. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): void;
  26619. /**
  26620. * Removes a specific vertex data
  26621. * @param kind defines the data kind (Position, normal, etc...)
  26622. */
  26623. removeVerticesData(kind: string): void;
  26624. /**
  26625. * Affect a vertex buffer to the geometry. the vertexBuffer.getKind() function is used to determine where to store the data
  26626. * @param buffer defines the vertex buffer to use
  26627. * @param totalVertices defines the total number of vertices for position kind (could be null)
  26628. */
  26629. setVerticesBuffer(buffer: VertexBuffer, totalVertices?: Nullable<number>): void;
  26630. /**
  26631. * Update a specific vertex buffer
  26632. * This function will directly update the underlying DataBuffer according to the passed numeric array or Float32Array
  26633. * It will do nothing if the buffer is not updatable
  26634. * @param kind defines the data kind (Position, normal, etc...)
  26635. * @param data defines the data to use
  26636. * @param offset defines the offset in the target buffer where to store the data
  26637. * @param useBytes set to true if the offset is in bytes
  26638. */
  26639. updateVerticesDataDirectly(kind: string, data: DataArray, offset: number, useBytes?: boolean): void;
  26640. /**
  26641. * Update a specific vertex buffer
  26642. * This function will create a new buffer if the current one is not updatable
  26643. * @param kind defines the data kind (Position, normal, etc...)
  26644. * @param data defines the data to use
  26645. * @param updateExtends defines if the geometry extends must be recomputed (false by default)
  26646. */
  26647. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean): void;
  26648. private _updateBoundingInfo;
  26649. /** @hidden */
  26650. _bind(effect: Nullable<Effect>, indexToBind?: Nullable<DataBuffer>): void;
  26651. /**
  26652. * Gets total number of vertices
  26653. * @returns the total number of vertices
  26654. */
  26655. getTotalVertices(): number;
  26656. /**
  26657. * Gets a specific vertex data attached to this geometry. Float data is constructed if the vertex buffer data cannot be returned directly.
  26658. * @param kind defines the data kind (Position, normal, etc...)
  26659. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  26660. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  26661. * @returns a float array containing vertex data
  26662. */
  26663. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  26664. /**
  26665. * Returns a boolean defining if the vertex data for the requested `kind` is updatable
  26666. * @param kind defines the data kind (Position, normal, etc...)
  26667. * @returns true if the vertex buffer with the specified kind is updatable
  26668. */
  26669. isVertexBufferUpdatable(kind: string): boolean;
  26670. /**
  26671. * Gets a specific vertex buffer
  26672. * @param kind defines the data kind (Position, normal, etc...)
  26673. * @returns a VertexBuffer
  26674. */
  26675. getVertexBuffer(kind: string): Nullable<VertexBuffer>;
  26676. /**
  26677. * Returns all vertex buffers
  26678. * @return an object holding all vertex buffers indexed by kind
  26679. */
  26680. getVertexBuffers(): Nullable<{
  26681. [key: string]: VertexBuffer;
  26682. }>;
  26683. /**
  26684. * Gets a boolean indicating if specific vertex buffer is present
  26685. * @param kind defines the data kind (Position, normal, etc...)
  26686. * @returns true if data is present
  26687. */
  26688. isVerticesDataPresent(kind: string): boolean;
  26689. /**
  26690. * Gets a list of all attached data kinds (Position, normal, etc...)
  26691. * @returns a list of string containing all kinds
  26692. */
  26693. getVerticesDataKinds(): string[];
  26694. /**
  26695. * Update index buffer
  26696. * @param indices defines the indices to store in the index buffer
  26697. * @param offset defines the offset in the target buffer where to store the data
  26698. * @param gpuMemoryOnly defines a boolean indicating that only the GPU memory must be updated leaving the CPU version of the indices unchanged (false by default)
  26699. */
  26700. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): void;
  26701. /**
  26702. * Creates a new index buffer
  26703. * @param indices defines the indices to store in the index buffer
  26704. * @param totalVertices defines the total number of vertices (could be null)
  26705. * @param updatable defines if the index buffer must be flagged as updatable (false by default)
  26706. */
  26707. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>, updatable?: boolean): void;
  26708. /**
  26709. * Return the total number of indices
  26710. * @returns the total number of indices
  26711. */
  26712. getTotalIndices(): number;
  26713. /**
  26714. * Gets the index buffer array
  26715. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  26716. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  26717. * @returns the index buffer array
  26718. */
  26719. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  26720. /**
  26721. * Gets the index buffer
  26722. * @return the index buffer
  26723. */
  26724. getIndexBuffer(): Nullable<DataBuffer>;
  26725. /** @hidden */
  26726. _releaseVertexArrayObject(effect?: Nullable<Effect>): void;
  26727. /**
  26728. * Release the associated resources for a specific mesh
  26729. * @param mesh defines the source mesh
  26730. * @param shouldDispose defines if the geometry must be disposed if there is no more mesh pointing to it
  26731. */
  26732. releaseForMesh(mesh: Mesh, shouldDispose?: boolean): void;
  26733. /**
  26734. * Apply current geometry to a given mesh
  26735. * @param mesh defines the mesh to apply geometry to
  26736. */
  26737. applyToMesh(mesh: Mesh): void;
  26738. private _updateExtend;
  26739. private _applyToMesh;
  26740. private notifyUpdate;
  26741. /**
  26742. * Load the geometry if it was flagged as delay loaded
  26743. * @param scene defines the hosting scene
  26744. * @param onLoaded defines a callback called when the geometry is loaded
  26745. */
  26746. load(scene: Scene, onLoaded?: () => void): void;
  26747. private _queueLoad;
  26748. /**
  26749. * Invert the geometry to move from a right handed system to a left handed one.
  26750. */
  26751. toLeftHanded(): void;
  26752. /** @hidden */
  26753. _resetPointsArrayCache(): void;
  26754. /** @hidden */
  26755. _generatePointsArray(): boolean;
  26756. /**
  26757. * Gets a value indicating if the geometry is disposed
  26758. * @returns true if the geometry was disposed
  26759. */
  26760. isDisposed(): boolean;
  26761. private _disposeVertexArrayObjects;
  26762. /**
  26763. * Free all associated resources
  26764. */
  26765. dispose(): void;
  26766. /**
  26767. * Clone the current geometry into a new geometry
  26768. * @param id defines the unique ID of the new geometry
  26769. * @returns a new geometry object
  26770. */
  26771. copy(id: string): Geometry;
  26772. /**
  26773. * Serialize the current geometry info (and not the vertices data) into a JSON object
  26774. * @return a JSON representation of the current geometry data (without the vertices data)
  26775. */
  26776. serialize(): any;
  26777. private toNumberArray;
  26778. /**
  26779. * Serialize all vertices data into a JSON oject
  26780. * @returns a JSON representation of the current geometry data
  26781. */
  26782. serializeVerticeData(): any;
  26783. /**
  26784. * Extracts a clone of a mesh geometry
  26785. * @param mesh defines the source mesh
  26786. * @param id defines the unique ID of the new geometry object
  26787. * @returns the new geometry object
  26788. */
  26789. static ExtractFromMesh(mesh: Mesh, id: string): Nullable<Geometry>;
  26790. /**
  26791. * You should now use Tools.RandomId(), this method is still here for legacy reasons.
  26792. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  26793. * Be aware Math.random() could cause collisions, but:
  26794. * "All but 6 of the 128 bits of the ID are randomly generated, which means that for any two ids, there's a 1 in 2^^122 (or 5.3x10^^36) chance they'll collide"
  26795. * @returns a string containing a new GUID
  26796. */
  26797. static RandomId(): string;
  26798. /** @hidden */
  26799. static _ImportGeometry(parsedGeometry: any, mesh: Mesh): void;
  26800. private static _CleanMatricesWeights;
  26801. /**
  26802. * Create a new geometry from persisted data (Using .babylon file format)
  26803. * @param parsedVertexData defines the persisted data
  26804. * @param scene defines the hosting scene
  26805. * @param rootUrl defines the root url to use to load assets (like delayed data)
  26806. * @returns the new geometry object
  26807. */
  26808. static Parse(parsedVertexData: any, scene: Scene, rootUrl: string): Nullable<Geometry>;
  26809. }
  26810. }
  26811. declare module "babylonjs/Meshes/mesh.vertexData" {
  26812. import { Nullable, FloatArray, IndicesArray } from "babylonjs/types";
  26813. import { Matrix, Vector3, Vector2, Vector4 } from "babylonjs/Maths/math.vector";
  26814. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  26815. import { Geometry } from "babylonjs/Meshes/geometry";
  26816. import { Mesh } from "babylonjs/Meshes/mesh";
  26817. /**
  26818. * Define an interface for all classes that will get and set the data on vertices
  26819. */
  26820. export interface IGetSetVerticesData {
  26821. /**
  26822. * Gets a boolean indicating if specific vertex data is present
  26823. * @param kind defines the vertex data kind to use
  26824. * @returns true is data kind is present
  26825. */
  26826. isVerticesDataPresent(kind: string): boolean;
  26827. /**
  26828. * Gets a specific vertex data attached to this geometry. Float data is constructed if the vertex buffer data cannot be returned directly.
  26829. * @param kind defines the data kind (Position, normal, etc...)
  26830. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  26831. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  26832. * @returns a float array containing vertex data
  26833. */
  26834. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  26835. /**
  26836. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  26837. * @param copyWhenShared If true (default false) and and if the mesh geometry is shared among some other meshes, the returned array is a copy of the internal one.
  26838. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  26839. * @returns the indices array or an empty array if the mesh has no geometry
  26840. */
  26841. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  26842. /**
  26843. * Set specific vertex data
  26844. * @param kind defines the data kind (Position, normal, etc...)
  26845. * @param data defines the vertex data to use
  26846. * @param updatable defines if the vertex must be flagged as updatable (false as default)
  26847. * @param stride defines the stride to use (0 by default). This value is deduced from the kind value if not specified
  26848. */
  26849. setVerticesData(kind: string, data: FloatArray, updatable: boolean): void;
  26850. /**
  26851. * Update a specific associated vertex buffer
  26852. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  26853. * - VertexBuffer.PositionKind
  26854. * - VertexBuffer.UVKind
  26855. * - VertexBuffer.UV2Kind
  26856. * - VertexBuffer.UV3Kind
  26857. * - VertexBuffer.UV4Kind
  26858. * - VertexBuffer.UV5Kind
  26859. * - VertexBuffer.UV6Kind
  26860. * - VertexBuffer.ColorKind
  26861. * - VertexBuffer.MatricesIndicesKind
  26862. * - VertexBuffer.MatricesIndicesExtraKind
  26863. * - VertexBuffer.MatricesWeightsKind
  26864. * - VertexBuffer.MatricesWeightsExtraKind
  26865. * @param data defines the data source
  26866. * @param updateExtends defines if extends info of the mesh must be updated (can be null). This is mostly useful for "position" kind
  26867. * @param makeItUnique defines if the geometry associated with the mesh must be cloned to make the change only for this mesh (and not all meshes associated with the same geometry)
  26868. */
  26869. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): void;
  26870. /**
  26871. * Creates a new index buffer
  26872. * @param indices defines the indices to store in the index buffer
  26873. * @param totalVertices defines the total number of vertices (could be null)
  26874. * @param updatable defines if the index buffer must be flagged as updatable (false by default)
  26875. */
  26876. setIndices(indices: IndicesArray, totalVertices: Nullable<number>, updatable?: boolean): void;
  26877. }
  26878. /**
  26879. * This class contains the various kinds of data on every vertex of a mesh used in determining its shape and appearance
  26880. */
  26881. export class VertexData {
  26882. /**
  26883. * Mesh side orientation : usually the external or front surface
  26884. */
  26885. static readonly FRONTSIDE: number;
  26886. /**
  26887. * Mesh side orientation : usually the internal or back surface
  26888. */
  26889. static readonly BACKSIDE: number;
  26890. /**
  26891. * Mesh side orientation : both internal and external or front and back surfaces
  26892. */
  26893. static readonly DOUBLESIDE: number;
  26894. /**
  26895. * Mesh side orientation : by default, `FRONTSIDE`
  26896. */
  26897. static readonly DEFAULTSIDE: number;
  26898. /**
  26899. * An array of the x, y, z position of each vertex [...., x, y, z, .....]
  26900. */
  26901. positions: Nullable<FloatArray>;
  26902. /**
  26903. * An array of the x, y, z normal vector of each vertex [...., x, y, z, .....]
  26904. */
  26905. normals: Nullable<FloatArray>;
  26906. /**
  26907. * An array of the x, y, z tangent vector of each vertex [...., x, y, z, .....]
  26908. */
  26909. tangents: Nullable<FloatArray>;
  26910. /**
  26911. * An array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  26912. */
  26913. uvs: Nullable<FloatArray>;
  26914. /**
  26915. * A second array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  26916. */
  26917. uvs2: Nullable<FloatArray>;
  26918. /**
  26919. * A third array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  26920. */
  26921. uvs3: Nullable<FloatArray>;
  26922. /**
  26923. * A fourth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  26924. */
  26925. uvs4: Nullable<FloatArray>;
  26926. /**
  26927. * A fifth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  26928. */
  26929. uvs5: Nullable<FloatArray>;
  26930. /**
  26931. * A sixth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  26932. */
  26933. uvs6: Nullable<FloatArray>;
  26934. /**
  26935. * An array of the r, g, b, a, color of each vertex [...., r, g, b, a, .....]
  26936. */
  26937. colors: Nullable<FloatArray>;
  26938. /**
  26939. * An array containing the list of indices to the array of matrices produced by bones, each vertex have up to 4 indices (8 if the matricesIndicesExtra is set).
  26940. */
  26941. matricesIndices: Nullable<FloatArray>;
  26942. /**
  26943. * An array containing the list of weights defining the weight of each indexed matrix in the final computation
  26944. */
  26945. matricesWeights: Nullable<FloatArray>;
  26946. /**
  26947. * An array extending the number of possible indices
  26948. */
  26949. matricesIndicesExtra: Nullable<FloatArray>;
  26950. /**
  26951. * An array extending the number of possible weights when the number of indices is extended
  26952. */
  26953. matricesWeightsExtra: Nullable<FloatArray>;
  26954. /**
  26955. * An array of i, j, k the three vertex indices required for each triangular facet [...., i, j, k .....]
  26956. */
  26957. indices: Nullable<IndicesArray>;
  26958. /**
  26959. * Uses the passed data array to set the set the values for the specified kind of data
  26960. * @param data a linear array of floating numbers
  26961. * @param kind the type of data that is being set, eg positions, colors etc
  26962. */
  26963. set(data: FloatArray, kind: string): void;
  26964. /**
  26965. * Associates the vertexData to the passed Mesh.
  26966. * Sets it as updatable or not (default `false`)
  26967. * @param mesh the mesh the vertexData is applied to
  26968. * @param updatable when used and having the value true allows new data to update the vertexData
  26969. * @returns the VertexData
  26970. */
  26971. applyToMesh(mesh: Mesh, updatable?: boolean): VertexData;
  26972. /**
  26973. * Associates the vertexData to the passed Geometry.
  26974. * Sets it as updatable or not (default `false`)
  26975. * @param geometry the geometry the vertexData is applied to
  26976. * @param updatable when used and having the value true allows new data to update the vertexData
  26977. * @returns VertexData
  26978. */
  26979. applyToGeometry(geometry: Geometry, updatable?: boolean): VertexData;
  26980. /**
  26981. * Updates the associated mesh
  26982. * @param mesh the mesh to be updated
  26983. * @param updateExtends when true the mesh BoundingInfo will be renewed when and if position kind is updated, optional with default false
  26984. * @param makeItUnique when true, and when and if position kind is updated, a new global geometry will be created from these positions and set to the mesh, optional with default false
  26985. * @returns VertexData
  26986. */
  26987. updateMesh(mesh: Mesh): VertexData;
  26988. /**
  26989. * Updates the associated geometry
  26990. * @param geometry the geometry to be updated
  26991. * @param updateExtends when true BoundingInfo will be renewed when and if position kind is updated, optional with default false
  26992. * @param makeItUnique when true, and when and if position kind is updated, a new global geometry will be created from these positions and set to the mesh, optional with default false
  26993. * @returns VertexData.
  26994. */
  26995. updateGeometry(geometry: Geometry): VertexData;
  26996. private _applyTo;
  26997. private _update;
  26998. /**
  26999. * Transforms each position and each normal of the vertexData according to the passed Matrix
  27000. * @param matrix the transforming matrix
  27001. * @returns the VertexData
  27002. */
  27003. transform(matrix: Matrix): VertexData;
  27004. /**
  27005. * Merges the passed VertexData into the current one
  27006. * @param other the VertexData to be merged into the current one
  27007. * @param use32BitsIndices defines a boolean indicating if indices must be store in a 32 bits array
  27008. * @returns the modified VertexData
  27009. */
  27010. merge(other: VertexData, use32BitsIndices?: boolean): VertexData;
  27011. private _mergeElement;
  27012. private _validate;
  27013. /**
  27014. * Serializes the VertexData
  27015. * @returns a serialized object
  27016. */
  27017. serialize(): any;
  27018. /**
  27019. * Extracts the vertexData from a mesh
  27020. * @param mesh the mesh from which to extract the VertexData
  27021. * @param copyWhenShared defines if the VertexData must be cloned when shared between multiple meshes, optional, default false
  27022. * @param forceCopy indicating that the VertexData must be cloned, optional, default false
  27023. * @returns the object VertexData associated to the passed mesh
  27024. */
  27025. static ExtractFromMesh(mesh: Mesh, copyWhenShared?: boolean, forceCopy?: boolean): VertexData;
  27026. /**
  27027. * Extracts the vertexData from the geometry
  27028. * @param geometry the geometry from which to extract the VertexData
  27029. * @param copyWhenShared defines if the VertexData must be cloned when the geometrty is shared between multiple meshes, optional, default false
  27030. * @param forceCopy indicating that the VertexData must be cloned, optional, default false
  27031. * @returns the object VertexData associated to the passed mesh
  27032. */
  27033. static ExtractFromGeometry(geometry: Geometry, copyWhenShared?: boolean, forceCopy?: boolean): VertexData;
  27034. private static _ExtractFrom;
  27035. /**
  27036. * Creates the VertexData for a Ribbon
  27037. * @param options an object used to set the following optional parameters for the ribbon, required but can be empty
  27038. * * pathArray array of paths, each of which an array of successive Vector3
  27039. * * closeArray creates a seam between the first and the last paths of the pathArray, optional, default false
  27040. * * closePath creates a seam between the first and the last points of each path of the path array, optional, default false
  27041. * * offset a positive integer, only used when pathArray contains a single path (offset = 10 means the point 1 is joined to the point 11), default rounded half size of the pathArray length
  27042. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27043. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  27044. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  27045. * * invertUV swaps in the U and V coordinates when applying a texture, optional, default false
  27046. * * uvs a linear array, of length 2 * number of vertices, of custom UV values, optional
  27047. * * colors a linear array, of length 4 * number of vertices, of custom color values, optional
  27048. * @returns the VertexData of the ribbon
  27049. */
  27050. static CreateRibbon(options: {
  27051. pathArray: Vector3[][];
  27052. closeArray?: boolean;
  27053. closePath?: boolean;
  27054. offset?: number;
  27055. sideOrientation?: number;
  27056. frontUVs?: Vector4;
  27057. backUVs?: Vector4;
  27058. invertUV?: boolean;
  27059. uvs?: Vector2[];
  27060. colors?: Color4[];
  27061. }): VertexData;
  27062. /**
  27063. * Creates the VertexData for a box
  27064. * @param options an object used to set the following optional parameters for the box, required but can be empty
  27065. * * size sets the width, height and depth of the box to the value of size, optional default 1
  27066. * * width sets the width (x direction) of the box, overwrites the width set by size, optional, default size
  27067. * * height sets the height (y direction) of the box, overwrites the height set by size, optional, default size
  27068. * * depth sets the depth (z direction) of the box, overwrites the depth set by size, optional, default size
  27069. * * faceUV an array of 6 Vector4 elements used to set different images to each box side
  27070. * * faceColors an array of 6 Color3 elements used to set different colors to each box side
  27071. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27072. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  27073. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  27074. * @returns the VertexData of the box
  27075. */
  27076. static CreateBox(options: {
  27077. size?: number;
  27078. width?: number;
  27079. height?: number;
  27080. depth?: number;
  27081. faceUV?: Vector4[];
  27082. faceColors?: Color4[];
  27083. sideOrientation?: number;
  27084. frontUVs?: Vector4;
  27085. backUVs?: Vector4;
  27086. }): VertexData;
  27087. /**
  27088. * Creates the VertexData for a tiled box
  27089. * @param options an object used to set the following optional parameters for the box, required but can be empty
  27090. * * faceTiles sets the pattern, tile size and number of tiles for a face
  27091. * * faceUV an array of 6 Vector4 elements used to set different images to each box side
  27092. * * faceColors an array of 6 Color3 elements used to set different colors to each box side
  27093. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27094. * @returns the VertexData of the box
  27095. */
  27096. static CreateTiledBox(options: {
  27097. pattern?: number;
  27098. width?: number;
  27099. height?: number;
  27100. depth?: number;
  27101. tileSize?: number;
  27102. tileWidth?: number;
  27103. tileHeight?: number;
  27104. alignHorizontal?: number;
  27105. alignVertical?: number;
  27106. faceUV?: Vector4[];
  27107. faceColors?: Color4[];
  27108. sideOrientation?: number;
  27109. }): VertexData;
  27110. /**
  27111. * Creates the VertexData for a tiled plane
  27112. * @param options an object used to set the following optional parameters for the box, required but can be empty
  27113. * * pattern a limited pattern arrangement depending on the number
  27114. * * tileSize sets the width, height and depth of the tile to the value of size, optional default 1
  27115. * * tileWidth sets the width (x direction) of the tile, overwrites the width set by size, optional, default size
  27116. * * tileHeight sets the height (y direction) of the tile, overwrites the height set by size, optional, default size
  27117. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27118. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  27119. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  27120. * @returns the VertexData of the tiled plane
  27121. */
  27122. static CreateTiledPlane(options: {
  27123. pattern?: number;
  27124. tileSize?: number;
  27125. tileWidth?: number;
  27126. tileHeight?: number;
  27127. size?: number;
  27128. width?: number;
  27129. height?: number;
  27130. alignHorizontal?: number;
  27131. alignVertical?: number;
  27132. sideOrientation?: number;
  27133. frontUVs?: Vector4;
  27134. backUVs?: Vector4;
  27135. }): VertexData;
  27136. /**
  27137. * Creates the VertexData for an ellipsoid, defaults to a sphere
  27138. * @param options an object used to set the following optional parameters for the box, required but can be empty
  27139. * * segments sets the number of horizontal strips optional, default 32
  27140. * * diameter sets the axes dimensions, diameterX, diameterY and diameterZ to the value of diameter, optional default 1
  27141. * * diameterX sets the diameterX (x direction) of the ellipsoid, overwrites the diameterX set by diameter, optional, default diameter
  27142. * * diameterY sets the diameterY (y direction) of the ellipsoid, overwrites the diameterY set by diameter, optional, default diameter
  27143. * * diameterZ sets the diameterZ (z direction) of the ellipsoid, overwrites the diameterZ set by diameter, optional, default diameter
  27144. * * arc a number from 0 to 1, to create an unclosed ellipsoid based on the fraction of the circumference (latitude) given by the arc value, optional, default 1
  27145. * * slice a number from 0 to 1, to create an unclosed ellipsoid based on the fraction of the height (latitude) given by the arc value, optional, default 1
  27146. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27147. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  27148. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  27149. * @returns the VertexData of the ellipsoid
  27150. */
  27151. static CreateSphere(options: {
  27152. segments?: number;
  27153. diameter?: number;
  27154. diameterX?: number;
  27155. diameterY?: number;
  27156. diameterZ?: number;
  27157. arc?: number;
  27158. slice?: number;
  27159. sideOrientation?: number;
  27160. frontUVs?: Vector4;
  27161. backUVs?: Vector4;
  27162. }): VertexData;
  27163. /**
  27164. * Creates the VertexData for a cylinder, cone or prism
  27165. * @param options an object used to set the following optional parameters for the box, required but can be empty
  27166. * * height sets the height (y direction) of the cylinder, optional, default 2
  27167. * * diameterTop sets the diameter of the top of the cone, overwrites diameter, optional, default diameter
  27168. * * diameterBottom sets the diameter of the bottom of the cone, overwrites diameter, optional, default diameter
  27169. * * diameter sets the diameter of the top and bottom of the cone, optional default 1
  27170. * * tessellation the number of prism sides, 3 for a triangular prism, optional, default 24
  27171. * * subdivisions` the number of rings along the cylinder height, optional, default 1
  27172. * * arc a number from 0 to 1, to create an unclosed cylinder based on the fraction of the circumference given by the arc value, optional, default 1
  27173. * * faceColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  27174. * * faceUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  27175. * * hasRings when true makes each subdivision independantly treated as a face for faceUV and faceColors, optional, default false
  27176. * * enclose when true closes an open cylinder by adding extra flat faces between the height axis and vertical edges, think cut cake
  27177. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27178. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  27179. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  27180. * @returns the VertexData of the cylinder, cone or prism
  27181. */
  27182. static CreateCylinder(options: {
  27183. height?: number;
  27184. diameterTop?: number;
  27185. diameterBottom?: number;
  27186. diameter?: number;
  27187. tessellation?: number;
  27188. subdivisions?: number;
  27189. arc?: number;
  27190. faceColors?: Color4[];
  27191. faceUV?: Vector4[];
  27192. hasRings?: boolean;
  27193. enclose?: boolean;
  27194. sideOrientation?: number;
  27195. frontUVs?: Vector4;
  27196. backUVs?: Vector4;
  27197. }): VertexData;
  27198. /**
  27199. * Creates the VertexData for a torus
  27200. * @param options an object used to set the following optional parameters for the box, required but can be empty
  27201. * * diameter the diameter of the torus, optional default 1
  27202. * * thickness the diameter of the tube forming the torus, optional default 0.5
  27203. * * tessellation the number of prism sides, 3 for a triangular prism, optional, default 24
  27204. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27205. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  27206. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  27207. * @returns the VertexData of the torus
  27208. */
  27209. static CreateTorus(options: {
  27210. diameter?: number;
  27211. thickness?: number;
  27212. tessellation?: number;
  27213. sideOrientation?: number;
  27214. frontUVs?: Vector4;
  27215. backUVs?: Vector4;
  27216. }): VertexData;
  27217. /**
  27218. * Creates the VertexData of the LineSystem
  27219. * @param options an object used to set the following optional parameters for the LineSystem, required but can be empty
  27220. * - lines an array of lines, each line being an array of successive Vector3
  27221. * - colors an array of line colors, each of the line colors being an array of successive Color4, one per line point
  27222. * @returns the VertexData of the LineSystem
  27223. */
  27224. static CreateLineSystem(options: {
  27225. lines: Vector3[][];
  27226. colors?: Nullable<Color4[][]>;
  27227. }): VertexData;
  27228. /**
  27229. * Create the VertexData for a DashedLines
  27230. * @param options an object used to set the following optional parameters for the DashedLines, required but can be empty
  27231. * - points an array successive Vector3
  27232. * - dashSize the size of the dashes relative to the dash number, optional, default 3
  27233. * - gapSize the size of the gap between two successive dashes relative to the dash number, optional, default 1
  27234. * - dashNb the intended total number of dashes, optional, default 200
  27235. * @returns the VertexData for the DashedLines
  27236. */
  27237. static CreateDashedLines(options: {
  27238. points: Vector3[];
  27239. dashSize?: number;
  27240. gapSize?: number;
  27241. dashNb?: number;
  27242. }): VertexData;
  27243. /**
  27244. * Creates the VertexData for a Ground
  27245. * @param options an object used to set the following optional parameters for the Ground, required but can be empty
  27246. * - width the width (x direction) of the ground, optional, default 1
  27247. * - height the height (z direction) of the ground, optional, default 1
  27248. * - subdivisions the number of subdivisions per side, optional, default 1
  27249. * @returns the VertexData of the Ground
  27250. */
  27251. static CreateGround(options: {
  27252. width?: number;
  27253. height?: number;
  27254. subdivisions?: number;
  27255. subdivisionsX?: number;
  27256. subdivisionsY?: number;
  27257. }): VertexData;
  27258. /**
  27259. * Creates the VertexData for a TiledGround by subdividing the ground into tiles
  27260. * @param options an object used to set the following optional parameters for the Ground, required but can be empty
  27261. * * xmin the ground minimum X coordinate, optional, default -1
  27262. * * zmin the ground minimum Z coordinate, optional, default -1
  27263. * * xmax the ground maximum X coordinate, optional, default 1
  27264. * * zmax the ground maximum Z coordinate, optional, default 1
  27265. * * subdivisions a javascript object {w: positive integer, h: positive integer}, `w` and `h` are the numbers of subdivisions on the ground width and height creating 'tiles', default {w: 6, h: 6}
  27266. * * precision a javascript object {w: positive integer, h: positive integer}, `w` and `h` are the numbers of subdivisions on the tile width and height, default {w: 2, h: 2}
  27267. * @returns the VertexData of the TiledGround
  27268. */
  27269. static CreateTiledGround(options: {
  27270. xmin: number;
  27271. zmin: number;
  27272. xmax: number;
  27273. zmax: number;
  27274. subdivisions?: {
  27275. w: number;
  27276. h: number;
  27277. };
  27278. precision?: {
  27279. w: number;
  27280. h: number;
  27281. };
  27282. }): VertexData;
  27283. /**
  27284. * Creates the VertexData of the Ground designed from a heightmap
  27285. * @param options an object used to set the following parameters for the Ground, required and provided by MeshBuilder.CreateGroundFromHeightMap
  27286. * * width the width (x direction) of the ground
  27287. * * height the height (z direction) of the ground
  27288. * * subdivisions the number of subdivisions per side
  27289. * * minHeight the minimum altitude on the ground, optional, default 0
  27290. * * maxHeight the maximum altitude on the ground, optional default 1
  27291. * * colorFilter the filter to apply to the image pixel colors to compute the height, optional Color3, default (0.3, 0.59, 0.11)
  27292. * * buffer the array holding the image color data
  27293. * * bufferWidth the width of image
  27294. * * bufferHeight the height of image
  27295. * * alphaFilter Remove any data where the alpha channel is below this value, defaults 0 (all data visible)
  27296. * @returns the VertexData of the Ground designed from a heightmap
  27297. */
  27298. static CreateGroundFromHeightMap(options: {
  27299. width: number;
  27300. height: number;
  27301. subdivisions: number;
  27302. minHeight: number;
  27303. maxHeight: number;
  27304. colorFilter: Color3;
  27305. buffer: Uint8Array;
  27306. bufferWidth: number;
  27307. bufferHeight: number;
  27308. alphaFilter: number;
  27309. }): VertexData;
  27310. /**
  27311. * Creates the VertexData for a Plane
  27312. * @param options an object used to set the following optional parameters for the plane, required but can be empty
  27313. * * size sets the width and height of the plane to the value of size, optional default 1
  27314. * * width sets the width (x direction) of the plane, overwrites the width set by size, optional, default size
  27315. * * height sets the height (y direction) of the plane, overwrites the height set by size, optional, default size
  27316. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27317. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  27318. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  27319. * @returns the VertexData of the box
  27320. */
  27321. static CreatePlane(options: {
  27322. size?: number;
  27323. width?: number;
  27324. height?: number;
  27325. sideOrientation?: number;
  27326. frontUVs?: Vector4;
  27327. backUVs?: Vector4;
  27328. }): VertexData;
  27329. /**
  27330. * Creates the VertexData of the Disc or regular Polygon
  27331. * @param options an object used to set the following optional parameters for the disc, required but can be empty
  27332. * * radius the radius of the disc, optional default 0.5
  27333. * * tessellation the number of polygon sides, optional, default 64
  27334. * * arc a number from 0 to 1, to create an unclosed polygon based on the fraction of the circumference given by the arc value, optional, default 1
  27335. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27336. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  27337. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  27338. * @returns the VertexData of the box
  27339. */
  27340. static CreateDisc(options: {
  27341. radius?: number;
  27342. tessellation?: number;
  27343. arc?: number;
  27344. sideOrientation?: number;
  27345. frontUVs?: Vector4;
  27346. backUVs?: Vector4;
  27347. }): VertexData;
  27348. /**
  27349. * Creates the VertexData for an irregular Polygon in the XoZ plane using a mesh built by polygonTriangulation.build()
  27350. * All parameters are provided by MeshBuilder.CreatePolygon as needed
  27351. * @param polygon a mesh built from polygonTriangulation.build()
  27352. * @param sideOrientation takes the values Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27353. * @param fUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  27354. * @param fColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  27355. * @param frontUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  27356. * @param backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  27357. * @param wrap a boolean, default false, when true and fUVs used texture is wrapped around all sides, when false texture is applied side
  27358. * @returns the VertexData of the Polygon
  27359. */
  27360. static CreatePolygon(polygon: Mesh, sideOrientation: number, fUV?: Vector4[], fColors?: Color4[], frontUVs?: Vector4, backUVs?: Vector4, wrap?: boolean): VertexData;
  27361. /**
  27362. * Creates the VertexData of the IcoSphere
  27363. * @param options an object used to set the following optional parameters for the IcoSphere, required but can be empty
  27364. * * radius the radius of the IcoSphere, optional default 1
  27365. * * radiusX allows stretching in the x direction, optional, default radius
  27366. * * radiusY allows stretching in the y direction, optional, default radius
  27367. * * radiusZ allows stretching in the z direction, optional, default radius
  27368. * * flat when true creates a flat shaded mesh, optional, default true
  27369. * * subdivisions increasing the subdivisions increases the number of faces, optional, default 4
  27370. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27371. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  27372. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  27373. * @returns the VertexData of the IcoSphere
  27374. */
  27375. static CreateIcoSphere(options: {
  27376. radius?: number;
  27377. radiusX?: number;
  27378. radiusY?: number;
  27379. radiusZ?: number;
  27380. flat?: boolean;
  27381. subdivisions?: number;
  27382. sideOrientation?: number;
  27383. frontUVs?: Vector4;
  27384. backUVs?: Vector4;
  27385. }): VertexData;
  27386. /**
  27387. * Creates the VertexData for a Polyhedron
  27388. * @param options an object used to set the following optional parameters for the polyhedron, required but can be empty
  27389. * * type provided types are:
  27390. * * 0 : Tetrahedron, 1 : Octahedron, 2 : Dodecahedron, 3 : Icosahedron, 4 : Rhombicuboctahedron, 5 : Triangular Prism, 6 : Pentagonal Prism, 7 : Hexagonal Prism, 8 : Square Pyramid (J1)
  27391. * * 9 : Pentagonal Pyramid (J2), 10 : Triangular Dipyramid (J12), 11 : Pentagonal Dipyramid (J13), 12 : Elongated Square Dipyramid (J15), 13 : Elongated Pentagonal Dipyramid (J16), 14 : Elongated Pentagonal Cupola (J20)
  27392. * * size the size of the IcoSphere, optional default 1
  27393. * * sizeX allows stretching in the x direction, optional, default size
  27394. * * sizeY allows stretching in the y direction, optional, default size
  27395. * * sizeZ allows stretching in the z direction, optional, default size
  27396. * * custom a number that overwrites the type to create from an extended set of polyhedron from https://www.babylonjs-playground.com/#21QRSK#15 with minimised editor
  27397. * * faceUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  27398. * * faceColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  27399. * * flat when true creates a flat shaded mesh, optional, default true
  27400. * * subdivisions increasing the subdivisions increases the number of faces, optional, default 4
  27401. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27402. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  27403. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  27404. * @returns the VertexData of the Polyhedron
  27405. */
  27406. static CreatePolyhedron(options: {
  27407. type?: number;
  27408. size?: number;
  27409. sizeX?: number;
  27410. sizeY?: number;
  27411. sizeZ?: number;
  27412. custom?: any;
  27413. faceUV?: Vector4[];
  27414. faceColors?: Color4[];
  27415. flat?: boolean;
  27416. sideOrientation?: number;
  27417. frontUVs?: Vector4;
  27418. backUVs?: Vector4;
  27419. }): VertexData;
  27420. /**
  27421. * Creates the VertexData for a TorusKnot
  27422. * @param options an object used to set the following optional parameters for the TorusKnot, required but can be empty
  27423. * * radius the radius of the torus knot, optional, default 2
  27424. * * tube the thickness of the tube, optional, default 0.5
  27425. * * radialSegments the number of sides on each tube segments, optional, default 32
  27426. * * tubularSegments the number of tubes to decompose the knot into, optional, default 32
  27427. * * p the number of windings around the z axis, optional, default 2
  27428. * * q the number of windings around the x axis, optional, default 3
  27429. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27430. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  27431. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  27432. * @returns the VertexData of the Torus Knot
  27433. */
  27434. static CreateTorusKnot(options: {
  27435. radius?: number;
  27436. tube?: number;
  27437. radialSegments?: number;
  27438. tubularSegments?: number;
  27439. p?: number;
  27440. q?: number;
  27441. sideOrientation?: number;
  27442. frontUVs?: Vector4;
  27443. backUVs?: Vector4;
  27444. }): VertexData;
  27445. /**
  27446. * Compute normals for given positions and indices
  27447. * @param positions an array of vertex positions, [...., x, y, z, ......]
  27448. * @param indices an array of indices in groups of three for each triangular facet, [...., i, j, k, ......]
  27449. * @param normals an array of vertex normals, [...., x, y, z, ......]
  27450. * @param options an object used to set the following optional parameters for the TorusKnot, optional
  27451. * * facetNormals : optional array of facet normals (vector3)
  27452. * * facetPositions : optional array of facet positions (vector3)
  27453. * * facetPartitioning : optional partitioning array. facetPositions is required for facetPartitioning computation
  27454. * * ratio : optional partitioning ratio / bounding box, required for facetPartitioning computation
  27455. * * bInfo : optional bounding info, required for facetPartitioning computation
  27456. * * bbSize : optional bounding box size data, required for facetPartitioning computation
  27457. * * subDiv : optional partitioning data about subdivsions on each axis (int), required for facetPartitioning computation
  27458. * * useRightHandedSystem: optional boolean to for right handed system computation
  27459. * * depthSort : optional boolean to enable the facet depth sort computation
  27460. * * distanceTo : optional Vector3 to compute the facet depth from this location
  27461. * * depthSortedFacets : optional array of depthSortedFacets to store the facet distances from the reference location
  27462. */
  27463. static ComputeNormals(positions: any, indices: any, normals: any, options?: {
  27464. facetNormals?: any;
  27465. facetPositions?: any;
  27466. facetPartitioning?: any;
  27467. ratio?: number;
  27468. bInfo?: any;
  27469. bbSize?: Vector3;
  27470. subDiv?: any;
  27471. useRightHandedSystem?: boolean;
  27472. depthSort?: boolean;
  27473. distanceTo?: Vector3;
  27474. depthSortedFacets?: any;
  27475. }): void;
  27476. /** @hidden */
  27477. static _ComputeSides(sideOrientation: number, positions: FloatArray, indices: FloatArray, normals: FloatArray, uvs: FloatArray, frontUVs?: Vector4, backUVs?: Vector4): void;
  27478. /**
  27479. * Applies VertexData created from the imported parameters to the geometry
  27480. * @param parsedVertexData the parsed data from an imported file
  27481. * @param geometry the geometry to apply the VertexData to
  27482. */
  27483. static ImportVertexData(parsedVertexData: any, geometry: Geometry): void;
  27484. }
  27485. }
  27486. declare module "babylonjs/Morph/morphTarget" {
  27487. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  27488. import { Observable } from "babylonjs/Misc/observable";
  27489. import { Nullable, FloatArray } from "babylonjs/types";
  27490. import { Scene } from "babylonjs/scene";
  27491. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  27492. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  27493. /**
  27494. * Defines a target to use with MorphTargetManager
  27495. * @see https://doc.babylonjs.com/how_to/how_to_use_morphtargets
  27496. */
  27497. export class MorphTarget implements IAnimatable {
  27498. /** defines the name of the target */
  27499. name: string;
  27500. /**
  27501. * Gets or sets the list of animations
  27502. */
  27503. animations: import("babylonjs/Animations/animation").Animation[];
  27504. private _scene;
  27505. private _positions;
  27506. private _normals;
  27507. private _tangents;
  27508. private _uvs;
  27509. private _influence;
  27510. private _uniqueId;
  27511. /**
  27512. * Observable raised when the influence changes
  27513. */
  27514. onInfluenceChanged: Observable<boolean>;
  27515. /** @hidden */
  27516. _onDataLayoutChanged: Observable<void>;
  27517. /**
  27518. * Gets or sets the influence of this target (ie. its weight in the overall morphing)
  27519. */
  27520. get influence(): number;
  27521. set influence(influence: number);
  27522. /**
  27523. * Gets or sets the id of the morph Target
  27524. */
  27525. id: string;
  27526. private _animationPropertiesOverride;
  27527. /**
  27528. * Gets or sets the animation properties override
  27529. */
  27530. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  27531. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  27532. /**
  27533. * Creates a new MorphTarget
  27534. * @param name defines the name of the target
  27535. * @param influence defines the influence to use
  27536. * @param scene defines the scene the morphtarget belongs to
  27537. */
  27538. constructor(
  27539. /** defines the name of the target */
  27540. name: string, influence?: number, scene?: Nullable<Scene>);
  27541. /**
  27542. * Gets the unique ID of this manager
  27543. */
  27544. get uniqueId(): number;
  27545. /**
  27546. * Gets a boolean defining if the target contains position data
  27547. */
  27548. get hasPositions(): boolean;
  27549. /**
  27550. * Gets a boolean defining if the target contains normal data
  27551. */
  27552. get hasNormals(): boolean;
  27553. /**
  27554. * Gets a boolean defining if the target contains tangent data
  27555. */
  27556. get hasTangents(): boolean;
  27557. /**
  27558. * Gets a boolean defining if the target contains texture coordinates data
  27559. */
  27560. get hasUVs(): boolean;
  27561. /**
  27562. * Affects position data to this target
  27563. * @param data defines the position data to use
  27564. */
  27565. setPositions(data: Nullable<FloatArray>): void;
  27566. /**
  27567. * Gets the position data stored in this target
  27568. * @returns a FloatArray containing the position data (or null if not present)
  27569. */
  27570. getPositions(): Nullable<FloatArray>;
  27571. /**
  27572. * Affects normal data to this target
  27573. * @param data defines the normal data to use
  27574. */
  27575. setNormals(data: Nullable<FloatArray>): void;
  27576. /**
  27577. * Gets the normal data stored in this target
  27578. * @returns a FloatArray containing the normal data (or null if not present)
  27579. */
  27580. getNormals(): Nullable<FloatArray>;
  27581. /**
  27582. * Affects tangent data to this target
  27583. * @param data defines the tangent data to use
  27584. */
  27585. setTangents(data: Nullable<FloatArray>): void;
  27586. /**
  27587. * Gets the tangent data stored in this target
  27588. * @returns a FloatArray containing the tangent data (or null if not present)
  27589. */
  27590. getTangents(): Nullable<FloatArray>;
  27591. /**
  27592. * Affects texture coordinates data to this target
  27593. * @param data defines the texture coordinates data to use
  27594. */
  27595. setUVs(data: Nullable<FloatArray>): void;
  27596. /**
  27597. * Gets the texture coordinates data stored in this target
  27598. * @returns a FloatArray containing the texture coordinates data (or null if not present)
  27599. */
  27600. getUVs(): Nullable<FloatArray>;
  27601. /**
  27602. * Clone the current target
  27603. * @returns a new MorphTarget
  27604. */
  27605. clone(): MorphTarget;
  27606. /**
  27607. * Serializes the current target into a Serialization object
  27608. * @returns the serialized object
  27609. */
  27610. serialize(): any;
  27611. /**
  27612. * Returns the string "MorphTarget"
  27613. * @returns "MorphTarget"
  27614. */
  27615. getClassName(): string;
  27616. /**
  27617. * Creates a new target from serialized data
  27618. * @param serializationObject defines the serialized data to use
  27619. * @returns a new MorphTarget
  27620. */
  27621. static Parse(serializationObject: any): MorphTarget;
  27622. /**
  27623. * Creates a MorphTarget from mesh data
  27624. * @param mesh defines the source mesh
  27625. * @param name defines the name to use for the new target
  27626. * @param influence defines the influence to attach to the target
  27627. * @returns a new MorphTarget
  27628. */
  27629. static FromMesh(mesh: AbstractMesh, name?: string, influence?: number): MorphTarget;
  27630. }
  27631. }
  27632. declare module "babylonjs/Morph/morphTargetManager" {
  27633. import { Nullable } from "babylonjs/types";
  27634. import { Scene } from "babylonjs/scene";
  27635. import { MorphTarget } from "babylonjs/Morph/morphTarget";
  27636. /**
  27637. * This class is used to deform meshes using morphing between different targets
  27638. * @see https://doc.babylonjs.com/how_to/how_to_use_morphtargets
  27639. */
  27640. export class MorphTargetManager {
  27641. private _targets;
  27642. private _targetInfluenceChangedObservers;
  27643. private _targetDataLayoutChangedObservers;
  27644. private _activeTargets;
  27645. private _scene;
  27646. private _influences;
  27647. private _supportsNormals;
  27648. private _supportsTangents;
  27649. private _supportsUVs;
  27650. private _vertexCount;
  27651. private _uniqueId;
  27652. private _tempInfluences;
  27653. /**
  27654. * Gets or sets a boolean indicating if normals must be morphed
  27655. */
  27656. enableNormalMorphing: boolean;
  27657. /**
  27658. * Gets or sets a boolean indicating if tangents must be morphed
  27659. */
  27660. enableTangentMorphing: boolean;
  27661. /**
  27662. * Gets or sets a boolean indicating if UV must be morphed
  27663. */
  27664. enableUVMorphing: boolean;
  27665. /**
  27666. * Creates a new MorphTargetManager
  27667. * @param scene defines the current scene
  27668. */
  27669. constructor(scene?: Nullable<Scene>);
  27670. /**
  27671. * Gets the unique ID of this manager
  27672. */
  27673. get uniqueId(): number;
  27674. /**
  27675. * Gets the number of vertices handled by this manager
  27676. */
  27677. get vertexCount(): number;
  27678. /**
  27679. * Gets a boolean indicating if this manager supports morphing of normals
  27680. */
  27681. get supportsNormals(): boolean;
  27682. /**
  27683. * Gets a boolean indicating if this manager supports morphing of tangents
  27684. */
  27685. get supportsTangents(): boolean;
  27686. /**
  27687. * Gets a boolean indicating if this manager supports morphing of texture coordinates
  27688. */
  27689. get supportsUVs(): boolean;
  27690. /**
  27691. * Gets the number of targets stored in this manager
  27692. */
  27693. get numTargets(): number;
  27694. /**
  27695. * Gets the number of influencers (ie. the number of targets with influences > 0)
  27696. */
  27697. get numInfluencers(): number;
  27698. /**
  27699. * Gets the list of influences (one per target)
  27700. */
  27701. get influences(): Float32Array;
  27702. /**
  27703. * Gets the active target at specified index. An active target is a target with an influence > 0
  27704. * @param index defines the index to check
  27705. * @returns the requested target
  27706. */
  27707. getActiveTarget(index: number): MorphTarget;
  27708. /**
  27709. * Gets the target at specified index
  27710. * @param index defines the index to check
  27711. * @returns the requested target
  27712. */
  27713. getTarget(index: number): MorphTarget;
  27714. /**
  27715. * Add a new target to this manager
  27716. * @param target defines the target to add
  27717. */
  27718. addTarget(target: MorphTarget): void;
  27719. /**
  27720. * Removes a target from the manager
  27721. * @param target defines the target to remove
  27722. */
  27723. removeTarget(target: MorphTarget): void;
  27724. /**
  27725. * Clone the current manager
  27726. * @returns a new MorphTargetManager
  27727. */
  27728. clone(): MorphTargetManager;
  27729. /**
  27730. * Serializes the current manager into a Serialization object
  27731. * @returns the serialized object
  27732. */
  27733. serialize(): any;
  27734. private _syncActiveTargets;
  27735. /**
  27736. * Syncrhonize the targets with all the meshes using this morph target manager
  27737. */
  27738. synchronize(): void;
  27739. /**
  27740. * Creates a new MorphTargetManager from serialized data
  27741. * @param serializationObject defines the serialized data
  27742. * @param scene defines the hosting scene
  27743. * @returns the new MorphTargetManager
  27744. */
  27745. static Parse(serializationObject: any, scene: Scene): MorphTargetManager;
  27746. }
  27747. }
  27748. declare module "babylonjs/Meshes/meshLODLevel" {
  27749. import { Mesh } from "babylonjs/Meshes/mesh";
  27750. import { Nullable } from "babylonjs/types";
  27751. /**
  27752. * Class used to represent a specific level of detail of a mesh
  27753. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  27754. */
  27755. export class MeshLODLevel {
  27756. /** Defines the distance where this level should start being displayed */
  27757. distance: number;
  27758. /** Defines the mesh to use to render this level */
  27759. mesh: Nullable<Mesh>;
  27760. /**
  27761. * Creates a new LOD level
  27762. * @param distance defines the distance where this level should star being displayed
  27763. * @param mesh defines the mesh to use to render this level
  27764. */
  27765. constructor(
  27766. /** Defines the distance where this level should start being displayed */
  27767. distance: number,
  27768. /** Defines the mesh to use to render this level */
  27769. mesh: Nullable<Mesh>);
  27770. }
  27771. }
  27772. declare module "babylonjs/Misc/canvasGenerator" {
  27773. /**
  27774. * Helper class used to generate a canvas to manipulate images
  27775. */
  27776. export class CanvasGenerator {
  27777. /**
  27778. * Create a new canvas (or offscreen canvas depending on the context)
  27779. * @param width defines the expected width
  27780. * @param height defines the expected height
  27781. * @return a new canvas or offscreen canvas
  27782. */
  27783. static CreateCanvas(width: number, height: number): HTMLCanvasElement | OffscreenCanvas;
  27784. }
  27785. }
  27786. declare module "babylonjs/Meshes/groundMesh" {
  27787. import { Scene } from "babylonjs/scene";
  27788. import { Vector3 } from "babylonjs/Maths/math.vector";
  27789. import { Mesh } from "babylonjs/Meshes/mesh";
  27790. /**
  27791. * Mesh representing the gorund
  27792. */
  27793. export class GroundMesh extends Mesh {
  27794. /** If octree should be generated */
  27795. generateOctree: boolean;
  27796. private _heightQuads;
  27797. /** @hidden */
  27798. _subdivisionsX: number;
  27799. /** @hidden */
  27800. _subdivisionsY: number;
  27801. /** @hidden */
  27802. _width: number;
  27803. /** @hidden */
  27804. _height: number;
  27805. /** @hidden */
  27806. _minX: number;
  27807. /** @hidden */
  27808. _maxX: number;
  27809. /** @hidden */
  27810. _minZ: number;
  27811. /** @hidden */
  27812. _maxZ: number;
  27813. constructor(name: string, scene: Scene);
  27814. /**
  27815. * "GroundMesh"
  27816. * @returns "GroundMesh"
  27817. */
  27818. getClassName(): string;
  27819. /**
  27820. * The minimum of x and y subdivisions
  27821. */
  27822. get subdivisions(): number;
  27823. /**
  27824. * X subdivisions
  27825. */
  27826. get subdivisionsX(): number;
  27827. /**
  27828. * Y subdivisions
  27829. */
  27830. get subdivisionsY(): number;
  27831. /**
  27832. * This function will update an octree to help to select the right submeshes for rendering, picking and collision computations.
  27833. * Please note that you must have a decent number of submeshes to get performance improvements when using an octree
  27834. * @param chunksCount the number of subdivisions for x and y
  27835. * @param octreeBlocksSize (Default: 32)
  27836. */
  27837. optimize(chunksCount: number, octreeBlocksSize?: number): void;
  27838. /**
  27839. * Returns a height (y) value in the Worl system :
  27840. * the ground altitude at the coordinates (x, z) expressed in the World system.
  27841. * @param x x coordinate
  27842. * @param z z coordinate
  27843. * @returns the ground y position if (x, z) are outside the ground surface.
  27844. */
  27845. getHeightAtCoordinates(x: number, z: number): number;
  27846. /**
  27847. * Returns a normalized vector (Vector3) orthogonal to the ground
  27848. * at the ground coordinates (x, z) expressed in the World system.
  27849. * @param x x coordinate
  27850. * @param z z coordinate
  27851. * @returns Vector3(0.0, 1.0, 0.0) if (x, z) are outside the ground surface.
  27852. */
  27853. getNormalAtCoordinates(x: number, z: number): Vector3;
  27854. /**
  27855. * Updates the Vector3 passed a reference with a normalized vector orthogonal to the ground
  27856. * at the ground coordinates (x, z) expressed in the World system.
  27857. * Doesn't uptade the reference Vector3 if (x, z) are outside the ground surface.
  27858. * @param x x coordinate
  27859. * @param z z coordinate
  27860. * @param ref vector to store the result
  27861. * @returns the GroundMesh.
  27862. */
  27863. getNormalAtCoordinatesToRef(x: number, z: number, ref: Vector3): GroundMesh;
  27864. /**
  27865. * Force the heights to be recomputed for getHeightAtCoordinates() or getNormalAtCoordinates()
  27866. * if the ground has been updated.
  27867. * This can be used in the render loop.
  27868. * @returns the GroundMesh.
  27869. */
  27870. updateCoordinateHeights(): GroundMesh;
  27871. private _getFacetAt;
  27872. private _initHeightQuads;
  27873. private _computeHeightQuads;
  27874. /**
  27875. * Serializes this ground mesh
  27876. * @param serializationObject object to write serialization to
  27877. */
  27878. serialize(serializationObject: any): void;
  27879. /**
  27880. * Parses a serialized ground mesh
  27881. * @param parsedMesh the serialized mesh
  27882. * @param scene the scene to create the ground mesh in
  27883. * @returns the created ground mesh
  27884. */
  27885. static Parse(parsedMesh: any, scene: Scene): GroundMesh;
  27886. }
  27887. }
  27888. declare module "babylonjs/Physics/physicsJoint" {
  27889. import { Vector3 } from "babylonjs/Maths/math.vector";
  27890. import { IPhysicsEnginePlugin } from "babylonjs/Physics/IPhysicsEngine";
  27891. /**
  27892. * Interface for Physics-Joint data
  27893. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  27894. */
  27895. export interface PhysicsJointData {
  27896. /**
  27897. * The main pivot of the joint
  27898. */
  27899. mainPivot?: Vector3;
  27900. /**
  27901. * The connected pivot of the joint
  27902. */
  27903. connectedPivot?: Vector3;
  27904. /**
  27905. * The main axis of the joint
  27906. */
  27907. mainAxis?: Vector3;
  27908. /**
  27909. * The connected axis of the joint
  27910. */
  27911. connectedAxis?: Vector3;
  27912. /**
  27913. * The collision of the joint
  27914. */
  27915. collision?: boolean;
  27916. /**
  27917. * Native Oimo/Cannon/Energy data
  27918. */
  27919. nativeParams?: any;
  27920. }
  27921. /**
  27922. * This is a holder class for the physics joint created by the physics plugin
  27923. * It holds a set of functions to control the underlying joint
  27924. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  27925. */
  27926. export class PhysicsJoint {
  27927. /**
  27928. * The type of the physics joint
  27929. */
  27930. type: number;
  27931. /**
  27932. * The data for the physics joint
  27933. */
  27934. jointData: PhysicsJointData;
  27935. private _physicsJoint;
  27936. protected _physicsPlugin: IPhysicsEnginePlugin;
  27937. /**
  27938. * Initializes the physics joint
  27939. * @param type The type of the physics joint
  27940. * @param jointData The data for the physics joint
  27941. */
  27942. constructor(
  27943. /**
  27944. * The type of the physics joint
  27945. */
  27946. type: number,
  27947. /**
  27948. * The data for the physics joint
  27949. */
  27950. jointData: PhysicsJointData);
  27951. /**
  27952. * Gets the physics joint
  27953. */
  27954. get physicsJoint(): any;
  27955. /**
  27956. * Sets the physics joint
  27957. */
  27958. set physicsJoint(newJoint: any);
  27959. /**
  27960. * Sets the physics plugin
  27961. */
  27962. set physicsPlugin(physicsPlugin: IPhysicsEnginePlugin);
  27963. /**
  27964. * Execute a function that is physics-plugin specific.
  27965. * @param {Function} func the function that will be executed.
  27966. * It accepts two parameters: the physics world and the physics joint
  27967. */
  27968. executeNativeFunction(func: (world: any, physicsJoint: any) => void): void;
  27969. /**
  27970. * Distance-Joint type
  27971. */
  27972. static DistanceJoint: number;
  27973. /**
  27974. * Hinge-Joint type
  27975. */
  27976. static HingeJoint: number;
  27977. /**
  27978. * Ball-and-Socket joint type
  27979. */
  27980. static BallAndSocketJoint: number;
  27981. /**
  27982. * Wheel-Joint type
  27983. */
  27984. static WheelJoint: number;
  27985. /**
  27986. * Slider-Joint type
  27987. */
  27988. static SliderJoint: number;
  27989. /**
  27990. * Prismatic-Joint type
  27991. */
  27992. static PrismaticJoint: number;
  27993. /**
  27994. * Universal-Joint type
  27995. * ENERGY FTW! (compare with this - @see http://ode-wiki.org/wiki/index.php?title=Manual:_Joint_Types_and_Functions)
  27996. */
  27997. static UniversalJoint: number;
  27998. /**
  27999. * Hinge-Joint 2 type
  28000. */
  28001. static Hinge2Joint: number;
  28002. /**
  28003. * Point to Point Joint type. Similar to a Ball-Joint. Different in parameters
  28004. */
  28005. static PointToPointJoint: number;
  28006. /**
  28007. * Spring-Joint type
  28008. */
  28009. static SpringJoint: number;
  28010. /**
  28011. * Lock-Joint type
  28012. */
  28013. static LockJoint: number;
  28014. }
  28015. /**
  28016. * A class representing a physics distance joint
  28017. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28018. */
  28019. export class DistanceJoint extends PhysicsJoint {
  28020. /**
  28021. *
  28022. * @param jointData The data for the Distance-Joint
  28023. */
  28024. constructor(jointData: DistanceJointData);
  28025. /**
  28026. * Update the predefined distance.
  28027. * @param maxDistance The maximum preferred distance
  28028. * @param minDistance The minimum preferred distance
  28029. */
  28030. updateDistance(maxDistance: number, minDistance?: number): void;
  28031. }
  28032. /**
  28033. * Represents a Motor-Enabled Joint
  28034. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28035. */
  28036. export class MotorEnabledJoint extends PhysicsJoint implements IMotorEnabledJoint {
  28037. /**
  28038. * Initializes the Motor-Enabled Joint
  28039. * @param type The type of the joint
  28040. * @param jointData The physica joint data for the joint
  28041. */
  28042. constructor(type: number, jointData: PhysicsJointData);
  28043. /**
  28044. * Set the motor values.
  28045. * Attention, this function is plugin specific. Engines won't react 100% the same.
  28046. * @param force the force to apply
  28047. * @param maxForce max force for this motor.
  28048. */
  28049. setMotor(force?: number, maxForce?: number): void;
  28050. /**
  28051. * Set the motor's limits.
  28052. * Attention, this function is plugin specific. Engines won't react 100% the same.
  28053. * @param upperLimit The upper limit of the motor
  28054. * @param lowerLimit The lower limit of the motor
  28055. */
  28056. setLimit(upperLimit: number, lowerLimit?: number): void;
  28057. }
  28058. /**
  28059. * This class represents a single physics Hinge-Joint
  28060. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28061. */
  28062. export class HingeJoint extends MotorEnabledJoint {
  28063. /**
  28064. * Initializes the Hinge-Joint
  28065. * @param jointData The joint data for the Hinge-Joint
  28066. */
  28067. constructor(jointData: PhysicsJointData);
  28068. /**
  28069. * Set the motor values.
  28070. * Attention, this function is plugin specific. Engines won't react 100% the same.
  28071. * @param {number} force the force to apply
  28072. * @param {number} maxForce max force for this motor.
  28073. */
  28074. setMotor(force?: number, maxForce?: number): void;
  28075. /**
  28076. * Set the motor's limits.
  28077. * Attention, this function is plugin specific. Engines won't react 100% the same.
  28078. * @param upperLimit The upper limit of the motor
  28079. * @param lowerLimit The lower limit of the motor
  28080. */
  28081. setLimit(upperLimit: number, lowerLimit?: number): void;
  28082. }
  28083. /**
  28084. * This class represents a dual hinge physics joint (same as wheel joint)
  28085. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28086. */
  28087. export class Hinge2Joint extends MotorEnabledJoint {
  28088. /**
  28089. * Initializes the Hinge2-Joint
  28090. * @param jointData The joint data for the Hinge2-Joint
  28091. */
  28092. constructor(jointData: PhysicsJointData);
  28093. /**
  28094. * Set the motor values.
  28095. * Attention, this function is plugin specific. Engines won't react 100% the same.
  28096. * @param {number} targetSpeed the speed the motor is to reach
  28097. * @param {number} maxForce max force for this motor.
  28098. * @param {motorIndex} the motor's index, 0 or 1.
  28099. */
  28100. setMotor(targetSpeed?: number, maxForce?: number, motorIndex?: number): void;
  28101. /**
  28102. * Set the motor limits.
  28103. * Attention, this function is plugin specific. Engines won't react 100% the same.
  28104. * @param {number} upperLimit the upper limit
  28105. * @param {number} lowerLimit lower limit
  28106. * @param {motorIndex} the motor's index, 0 or 1.
  28107. */
  28108. setLimit(upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  28109. }
  28110. /**
  28111. * Interface for a motor enabled joint
  28112. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28113. */
  28114. export interface IMotorEnabledJoint {
  28115. /**
  28116. * Physics joint
  28117. */
  28118. physicsJoint: any;
  28119. /**
  28120. * Sets the motor of the motor-enabled joint
  28121. * @param force The force of the motor
  28122. * @param maxForce The maximum force of the motor
  28123. * @param motorIndex The index of the motor
  28124. */
  28125. setMotor(force?: number, maxForce?: number, motorIndex?: number): void;
  28126. /**
  28127. * Sets the limit of the motor
  28128. * @param upperLimit The upper limit of the motor
  28129. * @param lowerLimit The lower limit of the motor
  28130. * @param motorIndex The index of the motor
  28131. */
  28132. setLimit(upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  28133. }
  28134. /**
  28135. * Joint data for a Distance-Joint
  28136. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28137. */
  28138. export interface DistanceJointData extends PhysicsJointData {
  28139. /**
  28140. * Max distance the 2 joint objects can be apart
  28141. */
  28142. maxDistance: number;
  28143. }
  28144. /**
  28145. * Joint data from a spring joint
  28146. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28147. */
  28148. export interface SpringJointData extends PhysicsJointData {
  28149. /**
  28150. * Length of the spring
  28151. */
  28152. length: number;
  28153. /**
  28154. * Stiffness of the spring
  28155. */
  28156. stiffness: number;
  28157. /**
  28158. * Damping of the spring
  28159. */
  28160. damping: number;
  28161. /** this callback will be called when applying the force to the impostors. */
  28162. forceApplicationCallback: () => void;
  28163. }
  28164. }
  28165. declare module "babylonjs/Physics/physicsRaycastResult" {
  28166. import { Vector3 } from "babylonjs/Maths/math.vector";
  28167. /**
  28168. * Holds the data for the raycast result
  28169. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28170. */
  28171. export class PhysicsRaycastResult {
  28172. private _hasHit;
  28173. private _hitDistance;
  28174. private _hitNormalWorld;
  28175. private _hitPointWorld;
  28176. private _rayFromWorld;
  28177. private _rayToWorld;
  28178. /**
  28179. * Gets if there was a hit
  28180. */
  28181. get hasHit(): boolean;
  28182. /**
  28183. * Gets the distance from the hit
  28184. */
  28185. get hitDistance(): number;
  28186. /**
  28187. * Gets the hit normal/direction in the world
  28188. */
  28189. get hitNormalWorld(): Vector3;
  28190. /**
  28191. * Gets the hit point in the world
  28192. */
  28193. get hitPointWorld(): Vector3;
  28194. /**
  28195. * Gets the ray "start point" of the ray in the world
  28196. */
  28197. get rayFromWorld(): Vector3;
  28198. /**
  28199. * Gets the ray "end point" of the ray in the world
  28200. */
  28201. get rayToWorld(): Vector3;
  28202. /**
  28203. * Sets the hit data (normal & point in world space)
  28204. * @param hitNormalWorld defines the normal in world space
  28205. * @param hitPointWorld defines the point in world space
  28206. */
  28207. setHitData(hitNormalWorld: IXYZ, hitPointWorld: IXYZ): void;
  28208. /**
  28209. * Sets the distance from the start point to the hit point
  28210. * @param distance
  28211. */
  28212. setHitDistance(distance: number): void;
  28213. /**
  28214. * Calculates the distance manually
  28215. */
  28216. calculateHitDistance(): void;
  28217. /**
  28218. * Resets all the values to default
  28219. * @param from The from point on world space
  28220. * @param to The to point on world space
  28221. */
  28222. reset(from?: Vector3, to?: Vector3): void;
  28223. }
  28224. /**
  28225. * Interface for the size containing width and height
  28226. */
  28227. interface IXYZ {
  28228. /**
  28229. * X
  28230. */
  28231. x: number;
  28232. /**
  28233. * Y
  28234. */
  28235. y: number;
  28236. /**
  28237. * Z
  28238. */
  28239. z: number;
  28240. }
  28241. }
  28242. declare module "babylonjs/Physics/IPhysicsEngine" {
  28243. import { Nullable } from "babylonjs/types";
  28244. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  28245. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  28246. import { PhysicsImpostor, IPhysicsEnabledObject } from "babylonjs/Physics/physicsImpostor";
  28247. import { PhysicsJoint, IMotorEnabledJoint } from "babylonjs/Physics/physicsJoint";
  28248. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  28249. /**
  28250. * Interface used to describe a physics joint
  28251. */
  28252. export interface PhysicsImpostorJoint {
  28253. /** Defines the main impostor to which the joint is linked */
  28254. mainImpostor: PhysicsImpostor;
  28255. /** Defines the impostor that is connected to the main impostor using this joint */
  28256. connectedImpostor: PhysicsImpostor;
  28257. /** Defines the joint itself */
  28258. joint: PhysicsJoint;
  28259. }
  28260. /** @hidden */
  28261. export interface IPhysicsEnginePlugin {
  28262. world: any;
  28263. name: string;
  28264. setGravity(gravity: Vector3): void;
  28265. setTimeStep(timeStep: number): void;
  28266. getTimeStep(): number;
  28267. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  28268. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  28269. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  28270. generatePhysicsBody(impostor: PhysicsImpostor): void;
  28271. removePhysicsBody(impostor: PhysicsImpostor): void;
  28272. generateJoint(joint: PhysicsImpostorJoint): void;
  28273. removeJoint(joint: PhysicsImpostorJoint): void;
  28274. isSupported(): boolean;
  28275. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  28276. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  28277. setLinearVelocity(impostor: PhysicsImpostor, velocity: Nullable<Vector3>): void;
  28278. setAngularVelocity(impostor: PhysicsImpostor, velocity: Nullable<Vector3>): void;
  28279. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  28280. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  28281. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  28282. getBodyMass(impostor: PhysicsImpostor): number;
  28283. getBodyFriction(impostor: PhysicsImpostor): number;
  28284. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  28285. getBodyRestitution(impostor: PhysicsImpostor): number;
  28286. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  28287. getBodyPressure?(impostor: PhysicsImpostor): number;
  28288. setBodyPressure?(impostor: PhysicsImpostor, pressure: number): void;
  28289. getBodyStiffness?(impostor: PhysicsImpostor): number;
  28290. setBodyStiffness?(impostor: PhysicsImpostor, stiffness: number): void;
  28291. getBodyVelocityIterations?(impostor: PhysicsImpostor): number;
  28292. setBodyVelocityIterations?(impostor: PhysicsImpostor, velocityIterations: number): void;
  28293. getBodyPositionIterations?(impostor: PhysicsImpostor): number;
  28294. setBodyPositionIterations?(impostor: PhysicsImpostor, positionIterations: number): void;
  28295. appendAnchor?(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, width: number, height: number, influence: number, noCollisionBetweenLinkedBodies: boolean): void;
  28296. appendHook?(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, length: number, influence: number, noCollisionBetweenLinkedBodies: boolean): void;
  28297. sleepBody(impostor: PhysicsImpostor): void;
  28298. wakeUpBody(impostor: PhysicsImpostor): void;
  28299. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  28300. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  28301. setMotor(joint: IMotorEnabledJoint, speed: number, maxForce?: number, motorIndex?: number): void;
  28302. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  28303. getRadius(impostor: PhysicsImpostor): number;
  28304. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  28305. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  28306. dispose(): void;
  28307. }
  28308. /**
  28309. * Interface used to define a physics engine
  28310. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28311. */
  28312. export interface IPhysicsEngine {
  28313. /**
  28314. * Gets the gravity vector used by the simulation
  28315. */
  28316. gravity: Vector3;
  28317. /**
  28318. * Sets the gravity vector used by the simulation
  28319. * @param gravity defines the gravity vector to use
  28320. */
  28321. setGravity(gravity: Vector3): void;
  28322. /**
  28323. * Set the time step of the physics engine.
  28324. * Default is 1/60.
  28325. * To slow it down, enter 1/600 for example.
  28326. * To speed it up, 1/30
  28327. * @param newTimeStep the new timestep to apply to this world.
  28328. */
  28329. setTimeStep(newTimeStep: number): void;
  28330. /**
  28331. * Get the time step of the physics engine.
  28332. * @returns the current time step
  28333. */
  28334. getTimeStep(): number;
  28335. /**
  28336. * Set the sub time step of the physics engine.
  28337. * Default is 0 meaning there is no sub steps
  28338. * To increase physics resolution precision, set a small value (like 1 ms)
  28339. * @param subTimeStep defines the new sub timestep used for physics resolution.
  28340. */
  28341. setSubTimeStep(subTimeStep: number): void;
  28342. /**
  28343. * Get the sub time step of the physics engine.
  28344. * @returns the current sub time step
  28345. */
  28346. getSubTimeStep(): number;
  28347. /**
  28348. * Release all resources
  28349. */
  28350. dispose(): void;
  28351. /**
  28352. * Gets the name of the current physics plugin
  28353. * @returns the name of the plugin
  28354. */
  28355. getPhysicsPluginName(): string;
  28356. /**
  28357. * Adding a new impostor for the impostor tracking.
  28358. * This will be done by the impostor itself.
  28359. * @param impostor the impostor to add
  28360. */
  28361. addImpostor(impostor: PhysicsImpostor): void;
  28362. /**
  28363. * Remove an impostor from the engine.
  28364. * This impostor and its mesh will not longer be updated by the physics engine.
  28365. * @param impostor the impostor to remove
  28366. */
  28367. removeImpostor(impostor: PhysicsImpostor): void;
  28368. /**
  28369. * Add a joint to the physics engine
  28370. * @param mainImpostor defines the main impostor to which the joint is added.
  28371. * @param connectedImpostor defines the impostor that is connected to the main impostor using this joint
  28372. * @param joint defines the joint that will connect both impostors.
  28373. */
  28374. addJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  28375. /**
  28376. * Removes a joint from the simulation
  28377. * @param mainImpostor defines the impostor used with the joint
  28378. * @param connectedImpostor defines the other impostor connected to the main one by the joint
  28379. * @param joint defines the joint to remove
  28380. */
  28381. removeJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  28382. /**
  28383. * Gets the current plugin used to run the simulation
  28384. * @returns current plugin
  28385. */
  28386. getPhysicsPlugin(): IPhysicsEnginePlugin;
  28387. /**
  28388. * Gets the list of physic impostors
  28389. * @returns an array of PhysicsImpostor
  28390. */
  28391. getImpostors(): Array<PhysicsImpostor>;
  28392. /**
  28393. * Gets the impostor for a physics enabled object
  28394. * @param object defines the object impersonated by the impostor
  28395. * @returns the PhysicsImpostor or null if not found
  28396. */
  28397. getImpostorForPhysicsObject(object: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  28398. /**
  28399. * Gets the impostor for a physics body object
  28400. * @param body defines physics body used by the impostor
  28401. * @returns the PhysicsImpostor or null if not found
  28402. */
  28403. getImpostorWithPhysicsBody(body: any): Nullable<PhysicsImpostor>;
  28404. /**
  28405. * Does a raycast in the physics world
  28406. * @param from when should the ray start?
  28407. * @param to when should the ray end?
  28408. * @returns PhysicsRaycastResult
  28409. */
  28410. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  28411. /**
  28412. * Called by the scene. No need to call it.
  28413. * @param delta defines the timespam between frames
  28414. */
  28415. _step(delta: number): void;
  28416. }
  28417. }
  28418. declare module "babylonjs/Physics/physicsImpostor" {
  28419. import { Nullable, IndicesArray } from "babylonjs/types";
  28420. import { Vector3, Matrix, Quaternion } from "babylonjs/Maths/math.vector";
  28421. import { TransformNode } from "babylonjs/Meshes/transformNode";
  28422. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  28423. import { Scene } from "babylonjs/scene";
  28424. import { Bone } from "babylonjs/Bones/bone";
  28425. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  28426. import { PhysicsJoint, PhysicsJointData } from "babylonjs/Physics/physicsJoint";
  28427. import { Space } from "babylonjs/Maths/math.axis";
  28428. /**
  28429. * The interface for the physics imposter parameters
  28430. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28431. */
  28432. export interface PhysicsImpostorParameters {
  28433. /**
  28434. * The mass of the physics imposter
  28435. */
  28436. mass: number;
  28437. /**
  28438. * The friction of the physics imposter
  28439. */
  28440. friction?: number;
  28441. /**
  28442. * The coefficient of restitution of the physics imposter
  28443. */
  28444. restitution?: number;
  28445. /**
  28446. * The native options of the physics imposter
  28447. */
  28448. nativeOptions?: any;
  28449. /**
  28450. * Specifies if the parent should be ignored
  28451. */
  28452. ignoreParent?: boolean;
  28453. /**
  28454. * Specifies if bi-directional transformations should be disabled
  28455. */
  28456. disableBidirectionalTransformation?: boolean;
  28457. /**
  28458. * The pressure inside the physics imposter, soft object only
  28459. */
  28460. pressure?: number;
  28461. /**
  28462. * The stiffness the physics imposter, soft object only
  28463. */
  28464. stiffness?: number;
  28465. /**
  28466. * The number of iterations used in maintaining consistent vertex velocities, soft object only
  28467. */
  28468. velocityIterations?: number;
  28469. /**
  28470. * The number of iterations used in maintaining consistent vertex positions, soft object only
  28471. */
  28472. positionIterations?: number;
  28473. /**
  28474. * The number used to fix points on a cloth (0, 1, 2, 4, 8) or rope (0, 1, 2) only
  28475. * 0 None, 1, back left or top, 2, back right or bottom, 4, front left, 8, front right
  28476. * Add to fix multiple points
  28477. */
  28478. fixedPoints?: number;
  28479. /**
  28480. * The collision margin around a soft object
  28481. */
  28482. margin?: number;
  28483. /**
  28484. * The collision margin around a soft object
  28485. */
  28486. damping?: number;
  28487. /**
  28488. * The path for a rope based on an extrusion
  28489. */
  28490. path?: any;
  28491. /**
  28492. * The shape of an extrusion used for a rope based on an extrusion
  28493. */
  28494. shape?: any;
  28495. }
  28496. /**
  28497. * Interface for a physics-enabled object
  28498. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28499. */
  28500. export interface IPhysicsEnabledObject {
  28501. /**
  28502. * The position of the physics-enabled object
  28503. */
  28504. position: Vector3;
  28505. /**
  28506. * The rotation of the physics-enabled object
  28507. */
  28508. rotationQuaternion: Nullable<Quaternion>;
  28509. /**
  28510. * The scale of the physics-enabled object
  28511. */
  28512. scaling: Vector3;
  28513. /**
  28514. * The rotation of the physics-enabled object
  28515. */
  28516. rotation?: Vector3;
  28517. /**
  28518. * The parent of the physics-enabled object
  28519. */
  28520. parent?: any;
  28521. /**
  28522. * The bounding info of the physics-enabled object
  28523. * @returns The bounding info of the physics-enabled object
  28524. */
  28525. getBoundingInfo(): BoundingInfo;
  28526. /**
  28527. * Computes the world matrix
  28528. * @param force Specifies if the world matrix should be computed by force
  28529. * @returns A world matrix
  28530. */
  28531. computeWorldMatrix(force: boolean): Matrix;
  28532. /**
  28533. * Gets the world matrix
  28534. * @returns A world matrix
  28535. */
  28536. getWorldMatrix?(): Matrix;
  28537. /**
  28538. * Gets the child meshes
  28539. * @param directDescendantsOnly Specifies if only direct-descendants should be obtained
  28540. * @returns An array of abstract meshes
  28541. */
  28542. getChildMeshes?(directDescendantsOnly?: boolean): Array<AbstractMesh>;
  28543. /**
  28544. * Gets the vertex data
  28545. * @param kind The type of vertex data
  28546. * @returns A nullable array of numbers, or a float32 array
  28547. */
  28548. getVerticesData(kind: string): Nullable<Array<number> | Float32Array>;
  28549. /**
  28550. * Gets the indices from the mesh
  28551. * @returns A nullable array of index arrays
  28552. */
  28553. getIndices?(): Nullable<IndicesArray>;
  28554. /**
  28555. * Gets the scene from the mesh
  28556. * @returns the indices array or null
  28557. */
  28558. getScene?(): Scene;
  28559. /**
  28560. * Gets the absolute position from the mesh
  28561. * @returns the absolute position
  28562. */
  28563. getAbsolutePosition(): Vector3;
  28564. /**
  28565. * Gets the absolute pivot point from the mesh
  28566. * @returns the absolute pivot point
  28567. */
  28568. getAbsolutePivotPoint(): Vector3;
  28569. /**
  28570. * Rotates the mesh
  28571. * @param axis The axis of rotation
  28572. * @param amount The amount of rotation
  28573. * @param space The space of the rotation
  28574. * @returns The rotation transform node
  28575. */
  28576. rotate(axis: Vector3, amount: number, space?: Space): TransformNode;
  28577. /**
  28578. * Translates the mesh
  28579. * @param axis The axis of translation
  28580. * @param distance The distance of translation
  28581. * @param space The space of the translation
  28582. * @returns The transform node
  28583. */
  28584. translate(axis: Vector3, distance: number, space?: Space): TransformNode;
  28585. /**
  28586. * Sets the absolute position of the mesh
  28587. * @param absolutePosition The absolute position of the mesh
  28588. * @returns The transform node
  28589. */
  28590. setAbsolutePosition(absolutePosition: Vector3): TransformNode;
  28591. /**
  28592. * Gets the class name of the mesh
  28593. * @returns The class name
  28594. */
  28595. getClassName(): string;
  28596. }
  28597. /**
  28598. * Represents a physics imposter
  28599. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28600. */
  28601. export class PhysicsImpostor {
  28602. /**
  28603. * The physics-enabled object used as the physics imposter
  28604. */
  28605. object: IPhysicsEnabledObject;
  28606. /**
  28607. * The type of the physics imposter
  28608. */
  28609. type: number;
  28610. private _options;
  28611. private _scene?;
  28612. /**
  28613. * The default object size of the imposter
  28614. */
  28615. static DEFAULT_OBJECT_SIZE: Vector3;
  28616. /**
  28617. * The identity quaternion of the imposter
  28618. */
  28619. static IDENTITY_QUATERNION: Quaternion;
  28620. /** @hidden */
  28621. _pluginData: any;
  28622. private _physicsEngine;
  28623. private _physicsBody;
  28624. private _bodyUpdateRequired;
  28625. private _onBeforePhysicsStepCallbacks;
  28626. private _onAfterPhysicsStepCallbacks;
  28627. /** @hidden */
  28628. _onPhysicsCollideCallbacks: Array<{
  28629. callback: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor) => void;
  28630. otherImpostors: Array<PhysicsImpostor>;
  28631. }>;
  28632. private _deltaPosition;
  28633. private _deltaRotation;
  28634. private _deltaRotationConjugated;
  28635. /** @hidden */
  28636. _isFromLine: boolean;
  28637. private _parent;
  28638. private _isDisposed;
  28639. private static _tmpVecs;
  28640. private static _tmpQuat;
  28641. /**
  28642. * Specifies if the physics imposter is disposed
  28643. */
  28644. get isDisposed(): boolean;
  28645. /**
  28646. * Gets the mass of the physics imposter
  28647. */
  28648. get mass(): number;
  28649. set mass(value: number);
  28650. /**
  28651. * Gets the coefficient of friction
  28652. */
  28653. get friction(): number;
  28654. /**
  28655. * Sets the coefficient of friction
  28656. */
  28657. set friction(value: number);
  28658. /**
  28659. * Gets the coefficient of restitution
  28660. */
  28661. get restitution(): number;
  28662. /**
  28663. * Sets the coefficient of restitution
  28664. */
  28665. set restitution(value: number);
  28666. /**
  28667. * Gets the pressure of a soft body; only supported by the AmmoJSPlugin
  28668. */
  28669. get pressure(): number;
  28670. /**
  28671. * Sets the pressure of a soft body; only supported by the AmmoJSPlugin
  28672. */
  28673. set pressure(value: number);
  28674. /**
  28675. * Gets the stiffness of a soft body; only supported by the AmmoJSPlugin
  28676. */
  28677. get stiffness(): number;
  28678. /**
  28679. * Sets the stiffness of a soft body; only supported by the AmmoJSPlugin
  28680. */
  28681. set stiffness(value: number);
  28682. /**
  28683. * Gets the velocityIterations of a soft body; only supported by the AmmoJSPlugin
  28684. */
  28685. get velocityIterations(): number;
  28686. /**
  28687. * Sets the velocityIterations of a soft body; only supported by the AmmoJSPlugin
  28688. */
  28689. set velocityIterations(value: number);
  28690. /**
  28691. * Gets the positionIterations of a soft body; only supported by the AmmoJSPlugin
  28692. */
  28693. get positionIterations(): number;
  28694. /**
  28695. * Sets the positionIterations of a soft body; only supported by the AmmoJSPlugin
  28696. */
  28697. set positionIterations(value: number);
  28698. /**
  28699. * The unique id of the physics imposter
  28700. * set by the physics engine when adding this impostor to the array
  28701. */
  28702. uniqueId: number;
  28703. /**
  28704. * @hidden
  28705. */
  28706. soft: boolean;
  28707. /**
  28708. * @hidden
  28709. */
  28710. segments: number;
  28711. private _joints;
  28712. /**
  28713. * Initializes the physics imposter
  28714. * @param object The physics-enabled object used as the physics imposter
  28715. * @param type The type of the physics imposter
  28716. * @param _options The options for the physics imposter
  28717. * @param _scene The Babylon scene
  28718. */
  28719. constructor(
  28720. /**
  28721. * The physics-enabled object used as the physics imposter
  28722. */
  28723. object: IPhysicsEnabledObject,
  28724. /**
  28725. * The type of the physics imposter
  28726. */
  28727. type: number, _options?: PhysicsImpostorParameters, _scene?: Scene | undefined);
  28728. /**
  28729. * This function will completly initialize this impostor.
  28730. * It will create a new body - but only if this mesh has no parent.
  28731. * If it has, this impostor will not be used other than to define the impostor
  28732. * of the child mesh.
  28733. * @hidden
  28734. */
  28735. _init(): void;
  28736. private _getPhysicsParent;
  28737. /**
  28738. * Should a new body be generated.
  28739. * @returns boolean specifying if body initialization is required
  28740. */
  28741. isBodyInitRequired(): boolean;
  28742. /**
  28743. * Sets the updated scaling
  28744. * @param updated Specifies if the scaling is updated
  28745. */
  28746. setScalingUpdated(): void;
  28747. /**
  28748. * Force a regeneration of this or the parent's impostor's body.
  28749. * Use under cautious - This will remove all joints already implemented.
  28750. */
  28751. forceUpdate(): void;
  28752. /**
  28753. * Gets the body that holds this impostor. Either its own, or its parent.
  28754. */
  28755. get physicsBody(): any;
  28756. /**
  28757. * Get the parent of the physics imposter
  28758. * @returns Physics imposter or null
  28759. */
  28760. get parent(): Nullable<PhysicsImpostor>;
  28761. /**
  28762. * Sets the parent of the physics imposter
  28763. */
  28764. set parent(value: Nullable<PhysicsImpostor>);
  28765. /**
  28766. * Set the physics body. Used mainly by the physics engine/plugin
  28767. */
  28768. set physicsBody(physicsBody: any);
  28769. /**
  28770. * Resets the update flags
  28771. */
  28772. resetUpdateFlags(): void;
  28773. /**
  28774. * Gets the object extend size
  28775. * @returns the object extend size
  28776. */
  28777. getObjectExtendSize(): Vector3;
  28778. /**
  28779. * Gets the object center
  28780. * @returns The object center
  28781. */
  28782. getObjectCenter(): Vector3;
  28783. /**
  28784. * Get a specific parameter from the options parameters
  28785. * @param paramName The object parameter name
  28786. * @returns The object parameter
  28787. */
  28788. getParam(paramName: string): any;
  28789. /**
  28790. * Sets a specific parameter in the options given to the physics plugin
  28791. * @param paramName The parameter name
  28792. * @param value The value of the parameter
  28793. */
  28794. setParam(paramName: string, value: number): void;
  28795. /**
  28796. * Specifically change the body's mass option. Won't recreate the physics body object
  28797. * @param mass The mass of the physics imposter
  28798. */
  28799. setMass(mass: number): void;
  28800. /**
  28801. * Gets the linear velocity
  28802. * @returns linear velocity or null
  28803. */
  28804. getLinearVelocity(): Nullable<Vector3>;
  28805. /**
  28806. * Sets the linear velocity
  28807. * @param velocity linear velocity or null
  28808. */
  28809. setLinearVelocity(velocity: Nullable<Vector3>): void;
  28810. /**
  28811. * Gets the angular velocity
  28812. * @returns angular velocity or null
  28813. */
  28814. getAngularVelocity(): Nullable<Vector3>;
  28815. /**
  28816. * Sets the angular velocity
  28817. * @param velocity The velocity or null
  28818. */
  28819. setAngularVelocity(velocity: Nullable<Vector3>): void;
  28820. /**
  28821. * Execute a function with the physics plugin native code
  28822. * Provide a function the will have two variables - the world object and the physics body object
  28823. * @param func The function to execute with the physics plugin native code
  28824. */
  28825. executeNativeFunction(func: (world: any, physicsBody: any) => void): void;
  28826. /**
  28827. * Register a function that will be executed before the physics world is stepping forward
  28828. * @param func The function to execute before the physics world is stepped forward
  28829. */
  28830. registerBeforePhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  28831. /**
  28832. * Unregister a function that will be executed before the physics world is stepping forward
  28833. * @param func The function to execute before the physics world is stepped forward
  28834. */
  28835. unregisterBeforePhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  28836. /**
  28837. * Register a function that will be executed after the physics step
  28838. * @param func The function to execute after physics step
  28839. */
  28840. registerAfterPhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  28841. /**
  28842. * Unregisters a function that will be executed after the physics step
  28843. * @param func The function to execute after physics step
  28844. */
  28845. unregisterAfterPhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  28846. /**
  28847. * register a function that will be executed when this impostor collides against a different body
  28848. * @param collideAgainst Physics imposter, or array of physics imposters to collide against
  28849. * @param func Callback that is executed on collision
  28850. */
  28851. registerOnPhysicsCollide(collideAgainst: PhysicsImpostor | Array<PhysicsImpostor>, func: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor) => void): void;
  28852. /**
  28853. * Unregisters the physics imposter on contact
  28854. * @param collideAgainst The physics object to collide against
  28855. * @param func Callback to execute on collision
  28856. */
  28857. unregisterOnPhysicsCollide(collideAgainst: PhysicsImpostor | Array<PhysicsImpostor>, func: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor | Array<PhysicsImpostor>) => void): void;
  28858. private _tmpQuat;
  28859. private _tmpQuat2;
  28860. /**
  28861. * Get the parent rotation
  28862. * @returns The parent rotation
  28863. */
  28864. getParentsRotation(): Quaternion;
  28865. /**
  28866. * this function is executed by the physics engine.
  28867. */
  28868. beforeStep: () => void;
  28869. /**
  28870. * this function is executed by the physics engine
  28871. */
  28872. afterStep: () => void;
  28873. /**
  28874. * Legacy collision detection event support
  28875. */
  28876. onCollideEvent: Nullable<(collider: PhysicsImpostor, collidedWith: PhysicsImpostor) => void>;
  28877. /**
  28878. * event and body object due to cannon's event-based architecture.
  28879. */
  28880. onCollide: (e: {
  28881. body: any;
  28882. }) => void;
  28883. /**
  28884. * Apply a force
  28885. * @param force The force to apply
  28886. * @param contactPoint The contact point for the force
  28887. * @returns The physics imposter
  28888. */
  28889. applyForce(force: Vector3, contactPoint: Vector3): PhysicsImpostor;
  28890. /**
  28891. * Apply an impulse
  28892. * @param force The impulse force
  28893. * @param contactPoint The contact point for the impulse force
  28894. * @returns The physics imposter
  28895. */
  28896. applyImpulse(force: Vector3, contactPoint: Vector3): PhysicsImpostor;
  28897. /**
  28898. * A help function to create a joint
  28899. * @param otherImpostor A physics imposter used to create a joint
  28900. * @param jointType The type of joint
  28901. * @param jointData The data for the joint
  28902. * @returns The physics imposter
  28903. */
  28904. createJoint(otherImpostor: PhysicsImpostor, jointType: number, jointData: PhysicsJointData): PhysicsImpostor;
  28905. /**
  28906. * Add a joint to this impostor with a different impostor
  28907. * @param otherImpostor A physics imposter used to add a joint
  28908. * @param joint The joint to add
  28909. * @returns The physics imposter
  28910. */
  28911. addJoint(otherImpostor: PhysicsImpostor, joint: PhysicsJoint): PhysicsImpostor;
  28912. /**
  28913. * Add an anchor to a cloth impostor
  28914. * @param otherImpostor rigid impostor to anchor to
  28915. * @param width ratio across width from 0 to 1
  28916. * @param height ratio up height from 0 to 1
  28917. * @param influence the elasticity between cloth impostor and anchor from 0, very stretchy to 1, little strech
  28918. * @param noCollisionBetweenLinkedBodies when true collisions between cloth impostor and anchor are ignored; default false
  28919. * @returns impostor the soft imposter
  28920. */
  28921. addAnchor(otherImpostor: PhysicsImpostor, width: number, height: number, influence: number, noCollisionBetweenLinkedBodies: boolean): PhysicsImpostor;
  28922. /**
  28923. * Add a hook to a rope impostor
  28924. * @param otherImpostor rigid impostor to anchor to
  28925. * @param length ratio across rope from 0 to 1
  28926. * @param influence the elasticity between rope impostor and anchor from 0, very stretchy to 1, little strech
  28927. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  28928. * @returns impostor the rope imposter
  28929. */
  28930. addHook(otherImpostor: PhysicsImpostor, length: number, influence: number, noCollisionBetweenLinkedBodies: boolean): PhysicsImpostor;
  28931. /**
  28932. * Will keep this body still, in a sleep mode.
  28933. * @returns the physics imposter
  28934. */
  28935. sleep(): PhysicsImpostor;
  28936. /**
  28937. * Wake the body up.
  28938. * @returns The physics imposter
  28939. */
  28940. wakeUp(): PhysicsImpostor;
  28941. /**
  28942. * Clones the physics imposter
  28943. * @param newObject The physics imposter clones to this physics-enabled object
  28944. * @returns A nullable physics imposter
  28945. */
  28946. clone(newObject: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  28947. /**
  28948. * Disposes the physics imposter
  28949. */
  28950. dispose(): void;
  28951. /**
  28952. * Sets the delta position
  28953. * @param position The delta position amount
  28954. */
  28955. setDeltaPosition(position: Vector3): void;
  28956. /**
  28957. * Sets the delta rotation
  28958. * @param rotation The delta rotation amount
  28959. */
  28960. setDeltaRotation(rotation: Quaternion): void;
  28961. /**
  28962. * Gets the box size of the physics imposter and stores the result in the input parameter
  28963. * @param result Stores the box size
  28964. * @returns The physics imposter
  28965. */
  28966. getBoxSizeToRef(result: Vector3): PhysicsImpostor;
  28967. /**
  28968. * Gets the radius of the physics imposter
  28969. * @returns Radius of the physics imposter
  28970. */
  28971. getRadius(): number;
  28972. /**
  28973. * Sync a bone with this impostor
  28974. * @param bone The bone to sync to the impostor.
  28975. * @param boneMesh The mesh that the bone is influencing.
  28976. * @param jointPivot The pivot of the joint / bone in local space.
  28977. * @param distToJoint Optional distance from the impostor to the joint.
  28978. * @param adjustRotation Optional quaternion for adjusting the local rotation of the bone.
  28979. */
  28980. syncBoneWithImpostor(bone: Bone, boneMesh: AbstractMesh, jointPivot: Vector3, distToJoint?: number, adjustRotation?: Quaternion): void;
  28981. /**
  28982. * Sync impostor to a bone
  28983. * @param bone The bone that the impostor will be synced to.
  28984. * @param boneMesh The mesh that the bone is influencing.
  28985. * @param jointPivot The pivot of the joint / bone in local space.
  28986. * @param distToJoint Optional distance from the impostor to the joint.
  28987. * @param adjustRotation Optional quaternion for adjusting the local rotation of the bone.
  28988. * @param boneAxis Optional vector3 axis the bone is aligned with
  28989. */
  28990. syncImpostorWithBone(bone: Bone, boneMesh: AbstractMesh, jointPivot: Vector3, distToJoint?: number, adjustRotation?: Quaternion, boneAxis?: Vector3): void;
  28991. /**
  28992. * No-Imposter type
  28993. */
  28994. static NoImpostor: number;
  28995. /**
  28996. * Sphere-Imposter type
  28997. */
  28998. static SphereImpostor: number;
  28999. /**
  29000. * Box-Imposter type
  29001. */
  29002. static BoxImpostor: number;
  29003. /**
  29004. * Plane-Imposter type
  29005. */
  29006. static PlaneImpostor: number;
  29007. /**
  29008. * Mesh-imposter type
  29009. */
  29010. static MeshImpostor: number;
  29011. /**
  29012. * Capsule-Impostor type (Ammo.js plugin only)
  29013. */
  29014. static CapsuleImpostor: number;
  29015. /**
  29016. * Cylinder-Imposter type
  29017. */
  29018. static CylinderImpostor: number;
  29019. /**
  29020. * Particle-Imposter type
  29021. */
  29022. static ParticleImpostor: number;
  29023. /**
  29024. * Heightmap-Imposter type
  29025. */
  29026. static HeightmapImpostor: number;
  29027. /**
  29028. * ConvexHull-Impostor type (Ammo.js plugin only)
  29029. */
  29030. static ConvexHullImpostor: number;
  29031. /**
  29032. * Custom-Imposter type (Ammo.js plugin only)
  29033. */
  29034. static CustomImpostor: number;
  29035. /**
  29036. * Rope-Imposter type
  29037. */
  29038. static RopeImpostor: number;
  29039. /**
  29040. * Cloth-Imposter type
  29041. */
  29042. static ClothImpostor: number;
  29043. /**
  29044. * Softbody-Imposter type
  29045. */
  29046. static SoftbodyImpostor: number;
  29047. }
  29048. }
  29049. declare module "babylonjs/Meshes/mesh" {
  29050. import { Observable } from "babylonjs/Misc/observable";
  29051. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  29052. import { Nullable, FloatArray, IndicesArray } from "babylonjs/types";
  29053. import { Camera } from "babylonjs/Cameras/camera";
  29054. import { Scene } from "babylonjs/scene";
  29055. import { Matrix, Vector3, Vector2, Vector4 } from "babylonjs/Maths/math.vector";
  29056. import { Color4 } from "babylonjs/Maths/math.color";
  29057. import { Engine } from "babylonjs/Engines/engine";
  29058. import { Node } from "babylonjs/node";
  29059. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  29060. import { IGetSetVerticesData } from "babylonjs/Meshes/mesh.vertexData";
  29061. import { Buffer } from "babylonjs/Meshes/buffer";
  29062. import { Geometry } from "babylonjs/Meshes/geometry";
  29063. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  29064. import { SubMesh } from "babylonjs/Meshes/subMesh";
  29065. import { BoundingSphere } from "babylonjs/Culling/boundingSphere";
  29066. import { Effect } from "babylonjs/Materials/effect";
  29067. import { Material } from "babylonjs/Materials/material";
  29068. import { Skeleton } from "babylonjs/Bones/skeleton";
  29069. import { MorphTargetManager } from "babylonjs/Morph/morphTargetManager";
  29070. import { MeshLODLevel } from "babylonjs/Meshes/meshLODLevel";
  29071. import { Path3D } from "babylonjs/Maths/math.path";
  29072. import { Plane } from "babylonjs/Maths/math.plane";
  29073. import { TransformNode } from "babylonjs/Meshes/transformNode";
  29074. import { LinesMesh } from "babylonjs/Meshes/linesMesh";
  29075. import { InstancedMesh } from "babylonjs/Meshes/instancedMesh";
  29076. import { GroundMesh } from "babylonjs/Meshes/groundMesh";
  29077. import { IPhysicsEnabledObject } from "babylonjs/Physics/physicsImpostor";
  29078. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  29079. /**
  29080. * @hidden
  29081. **/
  29082. export class _CreationDataStorage {
  29083. closePath?: boolean;
  29084. closeArray?: boolean;
  29085. idx: number[];
  29086. dashSize: number;
  29087. gapSize: number;
  29088. path3D: Path3D;
  29089. pathArray: Vector3[][];
  29090. arc: number;
  29091. radius: number;
  29092. cap: number;
  29093. tessellation: number;
  29094. }
  29095. /**
  29096. * @hidden
  29097. **/
  29098. class _InstanceDataStorage {
  29099. visibleInstances: any;
  29100. batchCache: _InstancesBatch;
  29101. instancesBufferSize: number;
  29102. instancesBuffer: Nullable<Buffer>;
  29103. instancesData: Float32Array;
  29104. overridenInstanceCount: number;
  29105. isFrozen: boolean;
  29106. previousBatch: Nullable<_InstancesBatch>;
  29107. hardwareInstancedRendering: boolean;
  29108. sideOrientation: number;
  29109. manualUpdate: boolean;
  29110. }
  29111. /**
  29112. * @hidden
  29113. **/
  29114. export class _InstancesBatch {
  29115. mustReturn: boolean;
  29116. visibleInstances: Nullable<import("babylonjs/Meshes/instancedMesh").InstancedMesh[]>[];
  29117. renderSelf: boolean[];
  29118. hardwareInstancedRendering: boolean[];
  29119. }
  29120. /**
  29121. * @hidden
  29122. **/
  29123. class _ThinInstanceDataStorage {
  29124. instancesCount: number;
  29125. matrixBuffer: Nullable<Buffer>;
  29126. matrixBufferSize: number;
  29127. matrixData: Nullable<Float32Array>;
  29128. boundingVectors: Array<Vector3>;
  29129. worldMatrices: Nullable<Matrix[]>;
  29130. }
  29131. /**
  29132. * Class used to represent renderable models
  29133. */
  29134. export class Mesh extends AbstractMesh implements IGetSetVerticesData {
  29135. /**
  29136. * Mesh side orientation : usually the external or front surface
  29137. */
  29138. static readonly FRONTSIDE: number;
  29139. /**
  29140. * Mesh side orientation : usually the internal or back surface
  29141. */
  29142. static readonly BACKSIDE: number;
  29143. /**
  29144. * Mesh side orientation : both internal and external or front and back surfaces
  29145. */
  29146. static readonly DOUBLESIDE: number;
  29147. /**
  29148. * Mesh side orientation : by default, `FRONTSIDE`
  29149. */
  29150. static readonly DEFAULTSIDE: number;
  29151. /**
  29152. * Mesh cap setting : no cap
  29153. */
  29154. static readonly NO_CAP: number;
  29155. /**
  29156. * Mesh cap setting : one cap at the beginning of the mesh
  29157. */
  29158. static readonly CAP_START: number;
  29159. /**
  29160. * Mesh cap setting : one cap at the end of the mesh
  29161. */
  29162. static readonly CAP_END: number;
  29163. /**
  29164. * Mesh cap setting : two caps, one at the beginning and one at the end of the mesh
  29165. */
  29166. static readonly CAP_ALL: number;
  29167. /**
  29168. * Mesh pattern setting : no flip or rotate
  29169. */
  29170. static readonly NO_FLIP: number;
  29171. /**
  29172. * Mesh pattern setting : flip (reflect in y axis) alternate tiles on each row or column
  29173. */
  29174. static readonly FLIP_TILE: number;
  29175. /**
  29176. * Mesh pattern setting : rotate (180degs) alternate tiles on each row or column
  29177. */
  29178. static readonly ROTATE_TILE: number;
  29179. /**
  29180. * Mesh pattern setting : flip (reflect in y axis) all tiles on alternate rows
  29181. */
  29182. static readonly FLIP_ROW: number;
  29183. /**
  29184. * Mesh pattern setting : rotate (180degs) all tiles on alternate rows
  29185. */
  29186. static readonly ROTATE_ROW: number;
  29187. /**
  29188. * Mesh pattern setting : flip and rotate alternate tiles on each row or column
  29189. */
  29190. static readonly FLIP_N_ROTATE_TILE: number;
  29191. /**
  29192. * Mesh pattern setting : rotate pattern and rotate
  29193. */
  29194. static readonly FLIP_N_ROTATE_ROW: number;
  29195. /**
  29196. * Mesh tile positioning : part tiles same on left/right or top/bottom
  29197. */
  29198. static readonly CENTER: number;
  29199. /**
  29200. * Mesh tile positioning : part tiles on left
  29201. */
  29202. static readonly LEFT: number;
  29203. /**
  29204. * Mesh tile positioning : part tiles on right
  29205. */
  29206. static readonly RIGHT: number;
  29207. /**
  29208. * Mesh tile positioning : part tiles on top
  29209. */
  29210. static readonly TOP: number;
  29211. /**
  29212. * Mesh tile positioning : part tiles on bottom
  29213. */
  29214. static readonly BOTTOM: number;
  29215. /**
  29216. * Gets the default side orientation.
  29217. * @param orientation the orientation to value to attempt to get
  29218. * @returns the default orientation
  29219. * @hidden
  29220. */
  29221. static _GetDefaultSideOrientation(orientation?: number): number;
  29222. private _internalMeshDataInfo;
  29223. get computeBonesUsingShaders(): boolean;
  29224. set computeBonesUsingShaders(value: boolean);
  29225. /**
  29226. * An event triggered before rendering the mesh
  29227. */
  29228. get onBeforeRenderObservable(): Observable<Mesh>;
  29229. /**
  29230. * An event triggered before binding the mesh
  29231. */
  29232. get onBeforeBindObservable(): Observable<Mesh>;
  29233. /**
  29234. * An event triggered after rendering the mesh
  29235. */
  29236. get onAfterRenderObservable(): Observable<Mesh>;
  29237. /**
  29238. * An event triggered before drawing the mesh
  29239. */
  29240. get onBeforeDrawObservable(): Observable<Mesh>;
  29241. private _onBeforeDrawObserver;
  29242. /**
  29243. * Sets a callback to call before drawing the mesh. It is recommended to use onBeforeDrawObservable instead
  29244. */
  29245. set onBeforeDraw(callback: () => void);
  29246. get hasInstances(): boolean;
  29247. get hasThinInstances(): boolean;
  29248. /**
  29249. * Gets the delay loading state of the mesh (when delay loading is turned on)
  29250. * @see https://doc.babylonjs.com/how_to/using_the_incremental_loading_system
  29251. */
  29252. delayLoadState: number;
  29253. /**
  29254. * Gets the list of instances created from this mesh
  29255. * it is not supposed to be modified manually.
  29256. * Note also that the order of the InstancedMesh wihin the array is not significant and might change.
  29257. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  29258. */
  29259. instances: import("babylonjs/Meshes/instancedMesh").InstancedMesh[];
  29260. /**
  29261. * Gets the file containing delay loading data for this mesh
  29262. */
  29263. delayLoadingFile: string;
  29264. /** @hidden */
  29265. _binaryInfo: any;
  29266. /**
  29267. * User defined function used to change how LOD level selection is done
  29268. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  29269. */
  29270. onLODLevelSelection: (distance: number, mesh: Mesh, selectedLevel: Nullable<Mesh>) => void;
  29271. /**
  29272. * Gets or sets the morph target manager
  29273. * @see https://doc.babylonjs.com/how_to/how_to_use_morphtargets
  29274. */
  29275. get morphTargetManager(): Nullable<MorphTargetManager>;
  29276. set morphTargetManager(value: Nullable<MorphTargetManager>);
  29277. /** @hidden */
  29278. _creationDataStorage: Nullable<_CreationDataStorage>;
  29279. /** @hidden */
  29280. _geometry: Nullable<Geometry>;
  29281. /** @hidden */
  29282. _delayInfo: Array<string>;
  29283. /** @hidden */
  29284. _delayLoadingFunction: (any: any, mesh: Mesh) => void;
  29285. /** @hidden */
  29286. _instanceDataStorage: _InstanceDataStorage;
  29287. /** @hidden */
  29288. _thinInstanceDataStorage: _ThinInstanceDataStorage;
  29289. private _effectiveMaterial;
  29290. /** @hidden */
  29291. _shouldGenerateFlatShading: boolean;
  29292. /** @hidden */
  29293. _originalBuilderSideOrientation: number;
  29294. /**
  29295. * Use this property to change the original side orientation defined at construction time
  29296. */
  29297. overrideMaterialSideOrientation: Nullable<number>;
  29298. /**
  29299. * Gets the source mesh (the one used to clone this one from)
  29300. */
  29301. get source(): Nullable<Mesh>;
  29302. /**
  29303. * Gets or sets a boolean indicating that this mesh does not use index buffer
  29304. */
  29305. get isUnIndexed(): boolean;
  29306. set isUnIndexed(value: boolean);
  29307. /** Gets the array buffer used to store the instanced buffer used for instances' world matrices */
  29308. get worldMatrixInstancedBuffer(): Float32Array;
  29309. /** Gets or sets a boolean indicating that the update of the instance buffer of the world matrices is manual */
  29310. get manualUpdateOfWorldMatrixInstancedBuffer(): boolean;
  29311. set manualUpdateOfWorldMatrixInstancedBuffer(value: boolean);
  29312. /**
  29313. * @constructor
  29314. * @param name The value used by scene.getMeshByName() to do a lookup.
  29315. * @param scene The scene to add this mesh to.
  29316. * @param parent The parent of this mesh, if it has one
  29317. * @param source An optional Mesh from which geometry is shared, cloned.
  29318. * @param doNotCloneChildren When cloning, skip cloning child meshes of source, default False.
  29319. * When false, achieved by calling a clone(), also passing False.
  29320. * This will make creation of children, recursive.
  29321. * @param clonePhysicsImpostor When cloning, include cloning mesh physics impostor, default True.
  29322. */
  29323. constructor(name: string, scene?: Nullable<Scene>, parent?: Nullable<Node>, source?: Nullable<Mesh>, doNotCloneChildren?: boolean, clonePhysicsImpostor?: boolean);
  29324. instantiateHierarchy(newParent?: Nullable<TransformNode>, options?: {
  29325. doNotInstantiate: boolean;
  29326. }, onNewNodeCreated?: (source: TransformNode, clone: TransformNode) => void): Nullable<TransformNode>;
  29327. /**
  29328. * Gets the class name
  29329. * @returns the string "Mesh".
  29330. */
  29331. getClassName(): string;
  29332. /** @hidden */
  29333. get _isMesh(): boolean;
  29334. /**
  29335. * Returns a description of this mesh
  29336. * @param fullDetails define if full details about this mesh must be used
  29337. * @returns a descriptive string representing this mesh
  29338. */
  29339. toString(fullDetails?: boolean): string;
  29340. /** @hidden */
  29341. _unBindEffect(): void;
  29342. /**
  29343. * Gets a boolean indicating if this mesh has LOD
  29344. */
  29345. get hasLODLevels(): boolean;
  29346. /**
  29347. * Gets the list of MeshLODLevel associated with the current mesh
  29348. * @returns an array of MeshLODLevel
  29349. */
  29350. getLODLevels(): MeshLODLevel[];
  29351. private _sortLODLevels;
  29352. /**
  29353. * Add a mesh as LOD level triggered at the given distance.
  29354. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  29355. * @param distance The distance from the center of the object to show this level
  29356. * @param mesh The mesh to be added as LOD level (can be null)
  29357. * @return This mesh (for chaining)
  29358. */
  29359. addLODLevel(distance: number, mesh: Nullable<Mesh>): Mesh;
  29360. /**
  29361. * Returns the LOD level mesh at the passed distance or null if not found.
  29362. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  29363. * @param distance The distance from the center of the object to show this level
  29364. * @returns a Mesh or `null`
  29365. */
  29366. getLODLevelAtDistance(distance: number): Nullable<Mesh>;
  29367. /**
  29368. * Remove a mesh from the LOD array
  29369. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  29370. * @param mesh defines the mesh to be removed
  29371. * @return This mesh (for chaining)
  29372. */
  29373. removeLODLevel(mesh: Mesh): Mesh;
  29374. /**
  29375. * Returns the registered LOD mesh distant from the parameter `camera` position if any, else returns the current mesh.
  29376. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  29377. * @param camera defines the camera to use to compute distance
  29378. * @param boundingSphere defines a custom bounding sphere to use instead of the one from this mesh
  29379. * @return This mesh (for chaining)
  29380. */
  29381. getLOD(camera: Camera, boundingSphere?: BoundingSphere): Nullable<AbstractMesh>;
  29382. /**
  29383. * Gets the mesh internal Geometry object
  29384. */
  29385. get geometry(): Nullable<Geometry>;
  29386. /**
  29387. * Returns the total number of vertices within the mesh geometry or zero if the mesh has no geometry.
  29388. * @returns the total number of vertices
  29389. */
  29390. getTotalVertices(): number;
  29391. /**
  29392. * Returns the content of an associated vertex buffer
  29393. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  29394. * - VertexBuffer.PositionKind
  29395. * - VertexBuffer.UVKind
  29396. * - VertexBuffer.UV2Kind
  29397. * - VertexBuffer.UV3Kind
  29398. * - VertexBuffer.UV4Kind
  29399. * - VertexBuffer.UV5Kind
  29400. * - VertexBuffer.UV6Kind
  29401. * - VertexBuffer.ColorKind
  29402. * - VertexBuffer.MatricesIndicesKind
  29403. * - VertexBuffer.MatricesIndicesExtraKind
  29404. * - VertexBuffer.MatricesWeightsKind
  29405. * - VertexBuffer.MatricesWeightsExtraKind
  29406. * @param copyWhenShared defines a boolean indicating that if the mesh geometry is shared among some other meshes, the returned array is a copy of the internal one
  29407. * @param forceCopy defines a boolean forcing the copy of the buffer no matter what the value of copyWhenShared is
  29408. * @returns a FloatArray or null if the mesh has no geometry or no vertex buffer for this kind.
  29409. */
  29410. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  29411. /**
  29412. * Returns the mesh VertexBuffer object from the requested `kind`
  29413. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  29414. * - VertexBuffer.PositionKind
  29415. * - VertexBuffer.NormalKind
  29416. * - VertexBuffer.UVKind
  29417. * - VertexBuffer.UV2Kind
  29418. * - VertexBuffer.UV3Kind
  29419. * - VertexBuffer.UV4Kind
  29420. * - VertexBuffer.UV5Kind
  29421. * - VertexBuffer.UV6Kind
  29422. * - VertexBuffer.ColorKind
  29423. * - VertexBuffer.MatricesIndicesKind
  29424. * - VertexBuffer.MatricesIndicesExtraKind
  29425. * - VertexBuffer.MatricesWeightsKind
  29426. * - VertexBuffer.MatricesWeightsExtraKind
  29427. * @returns a FloatArray or null if the mesh has no vertex buffer for this kind.
  29428. */
  29429. getVertexBuffer(kind: string): Nullable<VertexBuffer>;
  29430. /**
  29431. * Tests if a specific vertex buffer is associated with this mesh
  29432. * @param kind defines which buffer to check (positions, indices, normals, etc). Possible `kind` values :
  29433. * - VertexBuffer.PositionKind
  29434. * - VertexBuffer.NormalKind
  29435. * - VertexBuffer.UVKind
  29436. * - VertexBuffer.UV2Kind
  29437. * - VertexBuffer.UV3Kind
  29438. * - VertexBuffer.UV4Kind
  29439. * - VertexBuffer.UV5Kind
  29440. * - VertexBuffer.UV6Kind
  29441. * - VertexBuffer.ColorKind
  29442. * - VertexBuffer.MatricesIndicesKind
  29443. * - VertexBuffer.MatricesIndicesExtraKind
  29444. * - VertexBuffer.MatricesWeightsKind
  29445. * - VertexBuffer.MatricesWeightsExtraKind
  29446. * @returns a boolean
  29447. */
  29448. isVerticesDataPresent(kind: string): boolean;
  29449. /**
  29450. * Returns a boolean defining if the vertex data for the requested `kind` is updatable.
  29451. * @param kind defines which buffer to check (positions, indices, normals, etc). Possible `kind` values :
  29452. * - VertexBuffer.PositionKind
  29453. * - VertexBuffer.UVKind
  29454. * - VertexBuffer.UV2Kind
  29455. * - VertexBuffer.UV3Kind
  29456. * - VertexBuffer.UV4Kind
  29457. * - VertexBuffer.UV5Kind
  29458. * - VertexBuffer.UV6Kind
  29459. * - VertexBuffer.ColorKind
  29460. * - VertexBuffer.MatricesIndicesKind
  29461. * - VertexBuffer.MatricesIndicesExtraKind
  29462. * - VertexBuffer.MatricesWeightsKind
  29463. * - VertexBuffer.MatricesWeightsExtraKind
  29464. * @returns a boolean
  29465. */
  29466. isVertexBufferUpdatable(kind: string): boolean;
  29467. /**
  29468. * Returns a string which contains the list of existing `kinds` of Vertex Data associated with this mesh.
  29469. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  29470. * - VertexBuffer.PositionKind
  29471. * - VertexBuffer.NormalKind
  29472. * - VertexBuffer.UVKind
  29473. * - VertexBuffer.UV2Kind
  29474. * - VertexBuffer.UV3Kind
  29475. * - VertexBuffer.UV4Kind
  29476. * - VertexBuffer.UV5Kind
  29477. * - VertexBuffer.UV6Kind
  29478. * - VertexBuffer.ColorKind
  29479. * - VertexBuffer.MatricesIndicesKind
  29480. * - VertexBuffer.MatricesIndicesExtraKind
  29481. * - VertexBuffer.MatricesWeightsKind
  29482. * - VertexBuffer.MatricesWeightsExtraKind
  29483. * @returns an array of strings
  29484. */
  29485. getVerticesDataKinds(): string[];
  29486. /**
  29487. * Returns a positive integer : the total number of indices in this mesh geometry.
  29488. * @returns the numner of indices or zero if the mesh has no geometry.
  29489. */
  29490. getTotalIndices(): number;
  29491. /**
  29492. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  29493. * @param copyWhenShared If true (default false) and and if the mesh geometry is shared among some other meshes, the returned array is a copy of the internal one.
  29494. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  29495. * @returns the indices array or an empty array if the mesh has no geometry
  29496. */
  29497. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  29498. get isBlocked(): boolean;
  29499. /**
  29500. * Determine if the current mesh is ready to be rendered
  29501. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  29502. * @param forceInstanceSupport will check if the mesh will be ready when used with instances (false by default)
  29503. * @returns true if all associated assets are ready (material, textures, shaders)
  29504. */
  29505. isReady(completeCheck?: boolean, forceInstanceSupport?: boolean): boolean;
  29506. /**
  29507. * Gets a boolean indicating if the normals aren't to be recomputed on next mesh `positions` array update. This property is pertinent only for updatable parametric shapes.
  29508. */
  29509. get areNormalsFrozen(): boolean;
  29510. /**
  29511. * This function affects parametric shapes on vertex position update only : ribbons, tubes, etc. It has no effect at all on other shapes. It prevents the mesh normals from being recomputed on next `positions` array update.
  29512. * @returns the current mesh
  29513. */
  29514. freezeNormals(): Mesh;
  29515. /**
  29516. * This function affects parametric shapes on vertex position update only : ribbons, tubes, etc. It has no effect at all on other shapes. It reactivates the mesh normals computation if it was previously frozen
  29517. * @returns the current mesh
  29518. */
  29519. unfreezeNormals(): Mesh;
  29520. /**
  29521. * Sets a value overriding the instance count. Only applicable when custom instanced InterleavedVertexBuffer are used rather than InstancedMeshs
  29522. */
  29523. set overridenInstanceCount(count: number);
  29524. /** @hidden */
  29525. _preActivate(): Mesh;
  29526. /** @hidden */
  29527. _preActivateForIntermediateRendering(renderId: number): Mesh;
  29528. /** @hidden */
  29529. _registerInstanceForRenderId(instance: InstancedMesh, renderId: number): Mesh;
  29530. protected _afterComputeWorldMatrix(): void;
  29531. /** @hidden */
  29532. _postActivate(): void;
  29533. /**
  29534. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  29535. * This means the mesh underlying bounding box and sphere are recomputed.
  29536. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  29537. * @returns the current mesh
  29538. */
  29539. refreshBoundingInfo(applySkeleton?: boolean): Mesh;
  29540. /** @hidden */
  29541. _createGlobalSubMesh(force: boolean): Nullable<SubMesh>;
  29542. /**
  29543. * This function will subdivide the mesh into multiple submeshes
  29544. * @param count defines the expected number of submeshes
  29545. */
  29546. subdivide(count: number): void;
  29547. /**
  29548. * Copy a FloatArray into a specific associated vertex buffer
  29549. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  29550. * - VertexBuffer.PositionKind
  29551. * - VertexBuffer.UVKind
  29552. * - VertexBuffer.UV2Kind
  29553. * - VertexBuffer.UV3Kind
  29554. * - VertexBuffer.UV4Kind
  29555. * - VertexBuffer.UV5Kind
  29556. * - VertexBuffer.UV6Kind
  29557. * - VertexBuffer.ColorKind
  29558. * - VertexBuffer.MatricesIndicesKind
  29559. * - VertexBuffer.MatricesIndicesExtraKind
  29560. * - VertexBuffer.MatricesWeightsKind
  29561. * - VertexBuffer.MatricesWeightsExtraKind
  29562. * @param data defines the data source
  29563. * @param updatable defines if the updated vertex buffer must be flagged as updatable
  29564. * @param stride defines the data stride size (can be null)
  29565. * @returns the current mesh
  29566. */
  29567. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  29568. /**
  29569. * Delete a vertex buffer associated with this mesh
  29570. * @param kind defines which buffer to delete (positions, indices, normals, etc). Possible `kind` values :
  29571. * - VertexBuffer.PositionKind
  29572. * - VertexBuffer.UVKind
  29573. * - VertexBuffer.UV2Kind
  29574. * - VertexBuffer.UV3Kind
  29575. * - VertexBuffer.UV4Kind
  29576. * - VertexBuffer.UV5Kind
  29577. * - VertexBuffer.UV6Kind
  29578. * - VertexBuffer.ColorKind
  29579. * - VertexBuffer.MatricesIndicesKind
  29580. * - VertexBuffer.MatricesIndicesExtraKind
  29581. * - VertexBuffer.MatricesWeightsKind
  29582. * - VertexBuffer.MatricesWeightsExtraKind
  29583. */
  29584. removeVerticesData(kind: string): void;
  29585. /**
  29586. * Flags an associated vertex buffer as updatable
  29587. * @param kind defines which buffer to use (positions, indices, normals, etc). Possible `kind` values :
  29588. * - VertexBuffer.PositionKind
  29589. * - VertexBuffer.UVKind
  29590. * - VertexBuffer.UV2Kind
  29591. * - VertexBuffer.UV3Kind
  29592. * - VertexBuffer.UV4Kind
  29593. * - VertexBuffer.UV5Kind
  29594. * - VertexBuffer.UV6Kind
  29595. * - VertexBuffer.ColorKind
  29596. * - VertexBuffer.MatricesIndicesKind
  29597. * - VertexBuffer.MatricesIndicesExtraKind
  29598. * - VertexBuffer.MatricesWeightsKind
  29599. * - VertexBuffer.MatricesWeightsExtraKind
  29600. * @param updatable defines if the updated vertex buffer must be flagged as updatable
  29601. */
  29602. markVerticesDataAsUpdatable(kind: string, updatable?: boolean): void;
  29603. /**
  29604. * Sets the mesh global Vertex Buffer
  29605. * @param buffer defines the buffer to use
  29606. * @returns the current mesh
  29607. */
  29608. setVerticesBuffer(buffer: VertexBuffer): Mesh;
  29609. /**
  29610. * Update a specific associated vertex buffer
  29611. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  29612. * - VertexBuffer.PositionKind
  29613. * - VertexBuffer.UVKind
  29614. * - VertexBuffer.UV2Kind
  29615. * - VertexBuffer.UV3Kind
  29616. * - VertexBuffer.UV4Kind
  29617. * - VertexBuffer.UV5Kind
  29618. * - VertexBuffer.UV6Kind
  29619. * - VertexBuffer.ColorKind
  29620. * - VertexBuffer.MatricesIndicesKind
  29621. * - VertexBuffer.MatricesIndicesExtraKind
  29622. * - VertexBuffer.MatricesWeightsKind
  29623. * - VertexBuffer.MatricesWeightsExtraKind
  29624. * @param data defines the data source
  29625. * @param updateExtends defines if extends info of the mesh must be updated (can be null). This is mostly useful for "position" kind
  29626. * @param makeItUnique defines if the geometry associated with the mesh must be cloned to make the change only for this mesh (and not all meshes associated with the same geometry)
  29627. * @returns the current mesh
  29628. */
  29629. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): AbstractMesh;
  29630. /**
  29631. * This method updates the vertex positions of an updatable mesh according to the `positionFunction` returned values.
  29632. * @see https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh#other-shapes-updatemeshpositions
  29633. * @param positionFunction is a simple JS function what is passed the mesh `positions` array. It doesn't need to return anything
  29634. * @param computeNormals is a boolean (default true) to enable/disable the mesh normal recomputation after the vertex position update
  29635. * @returns the current mesh
  29636. */
  29637. updateMeshPositions(positionFunction: (data: FloatArray) => void, computeNormals?: boolean): Mesh;
  29638. /**
  29639. * Creates a un-shared specific occurence of the geometry for the mesh.
  29640. * @returns the current mesh
  29641. */
  29642. makeGeometryUnique(): Mesh;
  29643. /**
  29644. * Set the index buffer of this mesh
  29645. * @param indices defines the source data
  29646. * @param totalVertices defines the total number of vertices referenced by this index data (can be null)
  29647. * @param updatable defines if the updated index buffer must be flagged as updatable (default is false)
  29648. * @returns the current mesh
  29649. */
  29650. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>, updatable?: boolean): AbstractMesh;
  29651. /**
  29652. * Update the current index buffer
  29653. * @param indices defines the source data
  29654. * @param offset defines the offset in the index buffer where to store the new data (can be null)
  29655. * @param gpuMemoryOnly defines a boolean indicating that only the GPU memory must be updated leaving the CPU version of the indices unchanged (false by default)
  29656. * @returns the current mesh
  29657. */
  29658. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): AbstractMesh;
  29659. /**
  29660. * Invert the geometry to move from a right handed system to a left handed one.
  29661. * @returns the current mesh
  29662. */
  29663. toLeftHanded(): Mesh;
  29664. /** @hidden */
  29665. _bind(subMesh: SubMesh, effect: Effect, fillMode: number): Mesh;
  29666. /** @hidden */
  29667. _draw(subMesh: SubMesh, fillMode: number, instancesCount?: number): Mesh;
  29668. /**
  29669. * Registers for this mesh a javascript function called just before the rendering process
  29670. * @param func defines the function to call before rendering this mesh
  29671. * @returns the current mesh
  29672. */
  29673. registerBeforeRender(func: (mesh: AbstractMesh) => void): Mesh;
  29674. /**
  29675. * Disposes a previously registered javascript function called before the rendering
  29676. * @param func defines the function to remove
  29677. * @returns the current mesh
  29678. */
  29679. unregisterBeforeRender(func: (mesh: AbstractMesh) => void): Mesh;
  29680. /**
  29681. * Registers for this mesh a javascript function called just after the rendering is complete
  29682. * @param func defines the function to call after rendering this mesh
  29683. * @returns the current mesh
  29684. */
  29685. registerAfterRender(func: (mesh: AbstractMesh) => void): Mesh;
  29686. /**
  29687. * Disposes a previously registered javascript function called after the rendering.
  29688. * @param func defines the function to remove
  29689. * @returns the current mesh
  29690. */
  29691. unregisterAfterRender(func: (mesh: AbstractMesh) => void): Mesh;
  29692. /** @hidden */
  29693. _getInstancesRenderList(subMeshId: number, isReplacementMode?: boolean): _InstancesBatch;
  29694. /** @hidden */
  29695. _renderWithInstances(subMesh: SubMesh, fillMode: number, batch: _InstancesBatch, effect: Effect, engine: Engine): Mesh;
  29696. /** @hidden */
  29697. _renderWithThinInstances(subMesh: SubMesh, fillMode: number, effect: Effect, engine: Engine): void;
  29698. /** @hidden */
  29699. _processInstancedBuffers(visibleInstances: InstancedMesh[], renderSelf: boolean): void;
  29700. /** @hidden */
  29701. _processRendering(renderingMesh: AbstractMesh, subMesh: SubMesh, effect: Effect, fillMode: number, batch: _InstancesBatch, hardwareInstancedRendering: boolean, onBeforeDraw: (isInstance: boolean, world: Matrix, effectiveMaterial?: Material) => void, effectiveMaterial?: Material): Mesh;
  29702. /** @hidden */
  29703. _rebuild(): void;
  29704. /** @hidden */
  29705. _freeze(): void;
  29706. /** @hidden */
  29707. _unFreeze(): void;
  29708. /**
  29709. * Triggers the draw call for the mesh. Usually, you don't need to call this method by your own because the mesh rendering is handled by the scene rendering manager
  29710. * @param subMesh defines the subMesh to render
  29711. * @param enableAlphaMode defines if alpha mode can be changed
  29712. * @param effectiveMeshReplacement defines an optional mesh used to provide info for the rendering
  29713. * @returns the current mesh
  29714. */
  29715. render(subMesh: SubMesh, enableAlphaMode: boolean, effectiveMeshReplacement?: AbstractMesh): Mesh;
  29716. private _onBeforeDraw;
  29717. /**
  29718. * Renormalize the mesh and patch it up if there are no weights
  29719. * Similar to normalization by adding the weights compute the reciprocal and multiply all elements, this wil ensure that everything adds to 1.
  29720. * However in the case of zero weights then we set just a single influence to 1.
  29721. * We check in the function for extra's present and if so we use the normalizeSkinWeightsWithExtras rather than the FourWeights version.
  29722. */
  29723. cleanMatrixWeights(): void;
  29724. private normalizeSkinFourWeights;
  29725. private normalizeSkinWeightsAndExtra;
  29726. /**
  29727. * ValidateSkinning is used to determine that a mesh has valid skinning data along with skin metrics, if missing weights,
  29728. * or not normalized it is returned as invalid mesh the string can be used for console logs, or on screen messages to let
  29729. * the user know there was an issue with importing the mesh
  29730. * @returns a validation object with skinned, valid and report string
  29731. */
  29732. validateSkinning(): {
  29733. skinned: boolean;
  29734. valid: boolean;
  29735. report: string;
  29736. };
  29737. /** @hidden */
  29738. _checkDelayState(): Mesh;
  29739. private _queueLoad;
  29740. /**
  29741. * Returns `true` if the mesh is within the frustum defined by the passed array of planes.
  29742. * A mesh is in the frustum if its bounding box intersects the frustum
  29743. * @param frustumPlanes defines the frustum to test
  29744. * @returns true if the mesh is in the frustum planes
  29745. */
  29746. isInFrustum(frustumPlanes: Plane[]): boolean;
  29747. /**
  29748. * Sets the mesh material by the material or multiMaterial `id` property
  29749. * @param id is a string identifying the material or the multiMaterial
  29750. * @returns the current mesh
  29751. */
  29752. setMaterialByID(id: string): Mesh;
  29753. /**
  29754. * Returns as a new array populated with the mesh material and/or skeleton, if any.
  29755. * @returns an array of IAnimatable
  29756. */
  29757. getAnimatables(): IAnimatable[];
  29758. /**
  29759. * Modifies the mesh geometry according to the passed transformation matrix.
  29760. * This method returns nothing but it really modifies the mesh even if it's originally not set as updatable.
  29761. * The mesh normals are modified using the same transformation.
  29762. * Note that, under the hood, this method sets a new VertexBuffer each call.
  29763. * @param transform defines the transform matrix to use
  29764. * @see https://doc.babylonjs.com/resources/baking_transformations
  29765. * @returns the current mesh
  29766. */
  29767. bakeTransformIntoVertices(transform: Matrix): Mesh;
  29768. /**
  29769. * Modifies the mesh geometry according to its own current World Matrix.
  29770. * The mesh World Matrix is then reset.
  29771. * This method returns nothing but really modifies the mesh even if it's originally not set as updatable.
  29772. * Note that, under the hood, this method sets a new VertexBuffer each call.
  29773. * @see https://doc.babylonjs.com/resources/baking_transformations
  29774. * @param bakeIndependenlyOfChildren indicates whether to preserve all child nodes' World Matrix during baking
  29775. * @returns the current mesh
  29776. */
  29777. bakeCurrentTransformIntoVertices(bakeIndependenlyOfChildren?: boolean): Mesh;
  29778. /** @hidden */
  29779. get _positions(): Nullable<Vector3[]>;
  29780. /** @hidden */
  29781. _resetPointsArrayCache(): Mesh;
  29782. /** @hidden */
  29783. _generatePointsArray(): boolean;
  29784. /**
  29785. * Returns a new Mesh object generated from the current mesh properties.
  29786. * This method must not get confused with createInstance()
  29787. * @param name is a string, the name given to the new mesh
  29788. * @param newParent can be any Node object (default `null`)
  29789. * @param doNotCloneChildren allows/denies the recursive cloning of the original mesh children if any (default `false`)
  29790. * @param clonePhysicsImpostor allows/denies the cloning in the same time of the original mesh `body` used by the physics engine, if any (default `true`)
  29791. * @returns a new mesh
  29792. */
  29793. clone(name?: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean, clonePhysicsImpostor?: boolean): Mesh;
  29794. /**
  29795. * Releases resources associated with this mesh.
  29796. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  29797. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  29798. */
  29799. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  29800. /** @hidden */
  29801. _disposeInstanceSpecificData(): void;
  29802. /** @hidden */
  29803. _disposeThinInstanceSpecificData(): void;
  29804. /**
  29805. * Modifies the mesh geometry according to a displacement map.
  29806. * A displacement map is a colored image. Each pixel color value (actually a gradient computed from red, green, blue values) will give the displacement to apply to each mesh vertex.
  29807. * The mesh must be set as updatable. Its internal geometry is directly modified, no new buffer are allocated.
  29808. * @param url is a string, the URL from the image file is to be downloaded.
  29809. * @param minHeight is the lower limit of the displacement.
  29810. * @param maxHeight is the upper limit of the displacement.
  29811. * @param onSuccess is an optional Javascript function to be called just after the mesh is modified. It is passed the modified mesh and must return nothing.
  29812. * @param uvOffset is an optional vector2 used to offset UV.
  29813. * @param uvScale is an optional vector2 used to scale UV.
  29814. * @param forceUpdate defines whether or not to force an update of the generated buffers. This is useful to apply on a deserialized model for instance.
  29815. * @returns the Mesh.
  29816. */
  29817. applyDisplacementMap(url: string, minHeight: number, maxHeight: number, onSuccess?: (mesh: Mesh) => void, uvOffset?: Vector2, uvScale?: Vector2, forceUpdate?: boolean): Mesh;
  29818. /**
  29819. * Modifies the mesh geometry according to a displacementMap buffer.
  29820. * A displacement map is a colored image. Each pixel color value (actually a gradient computed from red, green, blue values) will give the displacement to apply to each mesh vertex.
  29821. * The mesh must be set as updatable. Its internal geometry is directly modified, no new buffer are allocated.
  29822. * @param buffer is a `Uint8Array` buffer containing series of `Uint8` lower than 255, the red, green, blue and alpha values of each successive pixel.
  29823. * @param heightMapWidth is the width of the buffer image.
  29824. * @param heightMapHeight is the height of the buffer image.
  29825. * @param minHeight is the lower limit of the displacement.
  29826. * @param maxHeight is the upper limit of the displacement.
  29827. * @param onSuccess is an optional Javascript function to be called just after the mesh is modified. It is passed the modified mesh and must return nothing.
  29828. * @param uvOffset is an optional vector2 used to offset UV.
  29829. * @param uvScale is an optional vector2 used to scale UV.
  29830. * @param forceUpdate defines whether or not to force an update of the generated buffers. This is useful to apply on a deserialized model for instance.
  29831. * @returns the Mesh.
  29832. */
  29833. applyDisplacementMapFromBuffer(buffer: Uint8Array, heightMapWidth: number, heightMapHeight: number, minHeight: number, maxHeight: number, uvOffset?: Vector2, uvScale?: Vector2, forceUpdate?: boolean): Mesh;
  29834. /**
  29835. * Modify the mesh to get a flat shading rendering.
  29836. * This means each mesh facet will then have its own normals. Usually new vertices are added in the mesh geometry to get this result.
  29837. * Warning : the mesh is really modified even if not set originally as updatable and, under the hood, a new VertexBuffer is allocated.
  29838. * @returns current mesh
  29839. */
  29840. convertToFlatShadedMesh(): Mesh;
  29841. /**
  29842. * This method removes all the mesh indices and add new vertices (duplication) in order to unfold facets into buffers.
  29843. * In other words, more vertices, no more indices and a single bigger VBO.
  29844. * The mesh is really modified even if not set originally as updatable. Under the hood, a new VertexBuffer is allocated.
  29845. * @returns current mesh
  29846. */
  29847. convertToUnIndexedMesh(): Mesh;
  29848. /**
  29849. * Inverses facet orientations.
  29850. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  29851. * @param flipNormals will also inverts the normals
  29852. * @returns current mesh
  29853. */
  29854. flipFaces(flipNormals?: boolean): Mesh;
  29855. /**
  29856. * Increase the number of facets and hence vertices in a mesh
  29857. * Vertex normals are interpolated from existing vertex normals
  29858. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  29859. * @param numberPerEdge the number of new vertices to add to each edge of a facet, optional default 1
  29860. */
  29861. increaseVertices(numberPerEdge: number): void;
  29862. /**
  29863. * Force adjacent facets to share vertices and remove any facets that have all vertices in a line
  29864. * This will undo any application of covertToFlatShadedMesh
  29865. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  29866. */
  29867. forceSharedVertices(): void;
  29868. /** @hidden */
  29869. static _instancedMeshFactory(name: string, mesh: Mesh): InstancedMesh;
  29870. /** @hidden */
  29871. static _PhysicsImpostorParser(scene: Scene, physicObject: IPhysicsEnabledObject, jsonObject: any): PhysicsImpostor;
  29872. /**
  29873. * Creates a new InstancedMesh object from the mesh model.
  29874. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  29875. * @param name defines the name of the new instance
  29876. * @returns a new InstancedMesh
  29877. */
  29878. createInstance(name: string): InstancedMesh;
  29879. /**
  29880. * Synchronises all the mesh instance submeshes to the current mesh submeshes, if any.
  29881. * After this call, all the mesh instances have the same submeshes than the current mesh.
  29882. * @returns the current mesh
  29883. */
  29884. synchronizeInstances(): Mesh;
  29885. /**
  29886. * Optimization of the mesh's indices, in case a mesh has duplicated vertices.
  29887. * The function will only reorder the indices and will not remove unused vertices to avoid problems with submeshes.
  29888. * This should be used together with the simplification to avoid disappearing triangles.
  29889. * @param successCallback an optional success callback to be called after the optimization finished.
  29890. * @returns the current mesh
  29891. */
  29892. optimizeIndices(successCallback?: (mesh?: Mesh) => void): Mesh;
  29893. /**
  29894. * Serialize current mesh
  29895. * @param serializationObject defines the object which will receive the serialization data
  29896. */
  29897. serialize(serializationObject: any): void;
  29898. /** @hidden */
  29899. _syncGeometryWithMorphTargetManager(): void;
  29900. /** @hidden */
  29901. static _GroundMeshParser: (parsedMesh: any, scene: Scene) => Mesh;
  29902. /**
  29903. * Returns a new Mesh object parsed from the source provided.
  29904. * @param parsedMesh is the source
  29905. * @param scene defines the hosting scene
  29906. * @param rootUrl is the root URL to prefix the `delayLoadingFile` property with
  29907. * @returns a new Mesh
  29908. */
  29909. static Parse(parsedMesh: any, scene: Scene, rootUrl: string): Mesh;
  29910. /**
  29911. * Creates a ribbon mesh. Please consider using the same method from the MeshBuilder class instead
  29912. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  29913. * @param name defines the name of the mesh to create
  29914. * @param pathArray is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry.
  29915. * @param closeArray creates a seam between the first and the last paths of the path array (default is false)
  29916. * @param closePath creates a seam between the first and the last points of each path of the path array
  29917. * @param offset is taken in account only if the `pathArray` is containing a single path
  29918. * @param scene defines the hosting scene
  29919. * @param updatable defines if the mesh must be flagged as updatable
  29920. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  29921. * @param instance defines an instance of an existing Ribbon object to be updated with the passed `pathArray` parameter (https://doc.babylonjs.com/how_to/How_to_dynamically_morph_a_mesh#ribbon)
  29922. * @returns a new Mesh
  29923. */
  29924. static CreateRibbon(name: string, pathArray: Vector3[][], closeArray: boolean, closePath: boolean, offset: number, scene?: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  29925. /**
  29926. * Creates a plane polygonal mesh. By default, this is a disc. Please consider using the same method from the MeshBuilder class instead
  29927. * @param name defines the name of the mesh to create
  29928. * @param radius sets the radius size (float) of the polygon (default 0.5)
  29929. * @param tessellation sets the number of polygon sides (positive integer, default 64). So a tessellation valued to 3 will build a triangle, to 4 a square, etc
  29930. * @param scene defines the hosting scene
  29931. * @param updatable defines if the mesh must be flagged as updatable
  29932. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  29933. * @returns a new Mesh
  29934. */
  29935. static CreateDisc(name: string, radius: number, tessellation: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number): Mesh;
  29936. /**
  29937. * Creates a box mesh. Please consider using the same method from the MeshBuilder class instead
  29938. * @param name defines the name of the mesh to create
  29939. * @param size sets the size (float) of each box side (default 1)
  29940. * @param scene defines the hosting scene
  29941. * @param updatable defines if the mesh must be flagged as updatable
  29942. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  29943. * @returns a new Mesh
  29944. */
  29945. static CreateBox(name: string, size: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number): Mesh;
  29946. /**
  29947. * Creates a sphere mesh. Please consider using the same method from the MeshBuilder class instead
  29948. * @param name defines the name of the mesh to create
  29949. * @param segments sets the sphere number of horizontal stripes (positive integer, default 32)
  29950. * @param diameter sets the diameter size (float) of the sphere (default 1)
  29951. * @param scene defines the hosting scene
  29952. * @param updatable defines if the mesh must be flagged as updatable
  29953. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  29954. * @returns a new Mesh
  29955. */
  29956. static CreateSphere(name: string, segments: number, diameter: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  29957. /**
  29958. * Creates a hemisphere mesh. Please consider using the same method from the MeshBuilder class instead
  29959. * @param name defines the name of the mesh to create
  29960. * @param segments sets the sphere number of horizontal stripes (positive integer, default 32)
  29961. * @param diameter sets the diameter size (float) of the sphere (default 1)
  29962. * @param scene defines the hosting scene
  29963. * @returns a new Mesh
  29964. */
  29965. static CreateHemisphere(name: string, segments: number, diameter: number, scene?: Scene): Mesh;
  29966. /**
  29967. * Creates a cylinder or a cone mesh. Please consider using the same method from the MeshBuilder class instead
  29968. * @param name defines the name of the mesh to create
  29969. * @param height sets the height size (float) of the cylinder/cone (float, default 2)
  29970. * @param diameterTop set the top cap diameter (floats, default 1)
  29971. * @param diameterBottom set the bottom cap diameter (floats, default 1). This value can't be zero
  29972. * @param tessellation sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance
  29973. * @param subdivisions sets the number of rings along the cylinder height (positive integer, default 1)
  29974. * @param scene defines the hosting scene
  29975. * @param updatable defines if the mesh must be flagged as updatable
  29976. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  29977. * @returns a new Mesh
  29978. */
  29979. static CreateCylinder(name: string, height: number, diameterTop: number, diameterBottom: number, tessellation: number, subdivisions: any, scene?: Scene, updatable?: any, sideOrientation?: number): Mesh;
  29980. /**
  29981. * Creates a torus mesh. Please consider using the same method from the MeshBuilder class instead
  29982. * @param name defines the name of the mesh to create
  29983. * @param diameter sets the diameter size (float) of the torus (default 1)
  29984. * @param thickness sets the diameter size of the tube of the torus (float, default 0.5)
  29985. * @param tessellation sets the number of torus sides (postive integer, default 16)
  29986. * @param scene defines the hosting scene
  29987. * @param updatable defines if the mesh must be flagged as updatable
  29988. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  29989. * @returns a new Mesh
  29990. */
  29991. static CreateTorus(name: string, diameter: number, thickness: number, tessellation: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  29992. /**
  29993. * Creates a torus knot mesh. Please consider using the same method from the MeshBuilder class instead
  29994. * @param name defines the name of the mesh to create
  29995. * @param radius sets the global radius size (float) of the torus knot (default 2)
  29996. * @param tube sets the diameter size of the tube of the torus (float, default 0.5)
  29997. * @param radialSegments sets the number of sides on each tube segments (positive integer, default 32)
  29998. * @param tubularSegments sets the number of tubes to decompose the knot into (positive integer, default 32)
  29999. * @param p the number of windings on X axis (positive integers, default 2)
  30000. * @param q the number of windings on Y axis (positive integers, default 3)
  30001. * @param scene defines the hosting scene
  30002. * @param updatable defines if the mesh must be flagged as updatable
  30003. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30004. * @returns a new Mesh
  30005. */
  30006. static CreateTorusKnot(name: string, radius: number, tube: number, radialSegments: number, tubularSegments: number, p: number, q: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  30007. /**
  30008. * Creates a line mesh. Please consider using the same method from the MeshBuilder class instead.
  30009. * @param name defines the name of the mesh to create
  30010. * @param points is an array successive Vector3
  30011. * @param scene defines the hosting scene
  30012. * @param updatable defines if the mesh must be flagged as updatable
  30013. * @param instance is an instance of an existing LineMesh object to be updated with the passed `points` parameter (https://doc.babylonjs.com/how_to/How_to_dynamically_morph_a_mesh#lines-and-dashedlines).
  30014. * @returns a new Mesh
  30015. */
  30016. static CreateLines(name: string, points: Vector3[], scene?: Nullable<Scene>, updatable?: boolean, instance?: Nullable<LinesMesh>): LinesMesh;
  30017. /**
  30018. * Creates a dashed line mesh. Please consider using the same method from the MeshBuilder class instead
  30019. * @param name defines the name of the mesh to create
  30020. * @param points is an array successive Vector3
  30021. * @param dashSize is the size of the dashes relatively the dash number (positive float, default 3)
  30022. * @param gapSize is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  30023. * @param dashNb is the intended total number of dashes (positive integer, default 200)
  30024. * @param scene defines the hosting scene
  30025. * @param updatable defines if the mesh must be flagged as updatable
  30026. * @param instance is an instance of an existing LineMesh object to be updated with the passed `points` parameter (https://doc.babylonjs.com/how_to/How_to_dynamically_morph_a_mesh#lines-and-dashedlines)
  30027. * @returns a new Mesh
  30028. */
  30029. static CreateDashedLines(name: string, points: Vector3[], dashSize: number, gapSize: number, dashNb: number, scene?: Nullable<Scene>, updatable?: boolean, instance?: LinesMesh): LinesMesh;
  30030. /**
  30031. * Creates a polygon mesh.Please consider using the same method from the MeshBuilder class instead
  30032. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh.
  30033. * The parameter `shape` is a required array of successive Vector3 representing the corners of the polygon in th XoZ plane, that is y = 0 for all vectors.
  30034. * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  30035. * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  30036. * Remember you can only change the shape positions, not their number when updating a polygon.
  30037. * @see https://doc.babylonjs.com/how_to/parametric_shapes#non-regular-polygon
  30038. * @param name defines the name of the mesh to create
  30039. * @param shape is a required array of successive Vector3 representing the corners of the polygon in th XoZ plane, that is y = 0 for all vectors
  30040. * @param scene defines the hosting scene
  30041. * @param holes is a required array of arrays of successive Vector3 used to defines holes in the polygon
  30042. * @param updatable defines if the mesh must be flagged as updatable
  30043. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30044. * @param earcutInjection can be used to inject your own earcut reference
  30045. * @returns a new Mesh
  30046. */
  30047. static CreatePolygon(name: string, shape: Vector3[], scene: Scene, holes?: Vector3[][], updatable?: boolean, sideOrientation?: number, earcutInjection?: any): Mesh;
  30048. /**
  30049. * Creates an extruded polygon mesh, with depth in the Y direction. Please consider using the same method from the MeshBuilder class instead.
  30050. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-non-regular-polygon
  30051. * @param name defines the name of the mesh to create
  30052. * @param shape is a required array of successive Vector3 representing the corners of the polygon in th XoZ plane, that is y = 0 for all vectors
  30053. * @param depth defines the height of extrusion
  30054. * @param scene defines the hosting scene
  30055. * @param holes is a required array of arrays of successive Vector3 used to defines holes in the polygon
  30056. * @param updatable defines if the mesh must be flagged as updatable
  30057. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30058. * @param earcutInjection can be used to inject your own earcut reference
  30059. * @returns a new Mesh
  30060. */
  30061. static ExtrudePolygon(name: string, shape: Vector3[], depth: number, scene: Scene, holes?: Vector3[][], updatable?: boolean, sideOrientation?: number, earcutInjection?: any): Mesh;
  30062. /**
  30063. * Creates an extruded shape mesh.
  30064. * The extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters. Please consider using the same method from the MeshBuilder class instead
  30065. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  30066. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  30067. * @param name defines the name of the mesh to create
  30068. * @param shape is a required array of successive Vector3. This array depicts the shape to be extruded in its local space : the shape must be designed in the xOy plane and will be extruded along the Z axis
  30069. * @param path is a required array of successive Vector3. This is the axis curve the shape is extruded along
  30070. * @param scale is the value to scale the shape
  30071. * @param rotation is the angle value to rotate the shape each step (each path point), from the former step (so rotation added each step) along the curve
  30072. * @param cap sets the way the extruded shape is capped. Possible values : Mesh.NO_CAP (default), Mesh.CAP_START, Mesh.CAP_END, Mesh.CAP_ALL
  30073. * @param scene defines the hosting scene
  30074. * @param updatable defines if the mesh must be flagged as updatable
  30075. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30076. * @param instance is an instance of an existing ExtrudedShape object to be updated with the passed `shape`, `path`, `scale` or `rotation` parameters (https://doc.babylonjs.com/how_to/How_to_dynamically_morph_a_mesh#extruded-shape)
  30077. * @returns a new Mesh
  30078. */
  30079. static ExtrudeShape(name: string, shape: Vector3[], path: Vector3[], scale: number, rotation: number, cap: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  30080. /**
  30081. * Creates an custom extruded shape mesh.
  30082. * The custom extrusion is a parametric shape.
  30083. * It has no predefined shape. Its final shape will depend on the input parameters.
  30084. * Please consider using the same method from the MeshBuilder class instead
  30085. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  30086. * @param name defines the name of the mesh to create
  30087. * @param shape is a required array of successive Vector3. This array depicts the shape to be extruded in its local space : the shape must be designed in the xOy plane and will be extruded along the Z axis
  30088. * @param path is a required array of successive Vector3. This is the axis curve the shape is extruded along
  30089. * @param scaleFunction is a custom Javascript function called on each path point
  30090. * @param rotationFunction is a custom Javascript function called on each path point
  30091. * @param ribbonCloseArray forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  30092. * @param ribbonClosePath forces the extrusion underlying ribbon to close its `pathArray`
  30093. * @param cap sets the way the extruded shape is capped. Possible values : Mesh.NO_CAP (default), Mesh.CAP_START, Mesh.CAP_END, Mesh.CAP_ALL
  30094. * @param scene defines the hosting scene
  30095. * @param updatable defines if the mesh must be flagged as updatable
  30096. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30097. * @param instance is an instance of an existing ExtrudedShape object to be updated with the passed `shape`, `path`, `scale` or `rotation` parameters (https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh#extruded-shape)
  30098. * @returns a new Mesh
  30099. */
  30100. static ExtrudeShapeCustom(name: string, shape: Vector3[], path: Vector3[], scaleFunction: Function, rotationFunction: Function, ribbonCloseArray: boolean, ribbonClosePath: boolean, cap: number, scene: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  30101. /**
  30102. * Creates lathe mesh.
  30103. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe.
  30104. * Please consider using the same method from the MeshBuilder class instead
  30105. * @param name defines the name of the mesh to create
  30106. * @param shape is a required array of successive Vector3. This array depicts the shape to be rotated in its local space : the shape must be designed in the xOy plane and will be rotated around the Y axis. It's usually a 2D shape, so the Vector3 z coordinates are often set to zero
  30107. * @param radius is the radius value of the lathe
  30108. * @param tessellation is the side number of the lathe.
  30109. * @param scene defines the hosting scene
  30110. * @param updatable defines if the mesh must be flagged as updatable
  30111. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30112. * @returns a new Mesh
  30113. */
  30114. static CreateLathe(name: string, shape: Vector3[], radius: number, tessellation: number, scene: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  30115. /**
  30116. * Creates a plane mesh. Please consider using the same method from the MeshBuilder class instead
  30117. * @param name defines the name of the mesh to create
  30118. * @param size sets the size (float) of both sides of the plane at once (default 1)
  30119. * @param scene defines the hosting scene
  30120. * @param updatable defines if the mesh must be flagged as updatable
  30121. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30122. * @returns a new Mesh
  30123. */
  30124. static CreatePlane(name: string, size: number, scene: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  30125. /**
  30126. * Creates a ground mesh.
  30127. * Please consider using the same method from the MeshBuilder class instead
  30128. * @param name defines the name of the mesh to create
  30129. * @param width set the width of the ground
  30130. * @param height set the height of the ground
  30131. * @param subdivisions sets the number of subdivisions per side
  30132. * @param scene defines the hosting scene
  30133. * @param updatable defines if the mesh must be flagged as updatable
  30134. * @returns a new Mesh
  30135. */
  30136. static CreateGround(name: string, width: number, height: number, subdivisions: number, scene?: Scene, updatable?: boolean): Mesh;
  30137. /**
  30138. * Creates a tiled ground mesh.
  30139. * Please consider using the same method from the MeshBuilder class instead
  30140. * @param name defines the name of the mesh to create
  30141. * @param xmin set the ground minimum X coordinate
  30142. * @param zmin set the ground minimum Y coordinate
  30143. * @param xmax set the ground maximum X coordinate
  30144. * @param zmax set the ground maximum Z coordinate
  30145. * @param subdivisions is an object `{w: positive integer, h: positive integer}` (default `{w: 6, h: 6}`). `w` and `h` are the numbers of subdivisions on the ground width and height. Each subdivision is called a tile
  30146. * @param precision is an object `{w: positive integer, h: positive integer}` (default `{w: 2, h: 2}`). `w` and `h` are the numbers of subdivisions on the ground width and height of each tile
  30147. * @param scene defines the hosting scene
  30148. * @param updatable defines if the mesh must be flagged as updatable
  30149. * @returns a new Mesh
  30150. */
  30151. static CreateTiledGround(name: string, xmin: number, zmin: number, xmax: number, zmax: number, subdivisions: {
  30152. w: number;
  30153. h: number;
  30154. }, precision: {
  30155. w: number;
  30156. h: number;
  30157. }, scene: Scene, updatable?: boolean): Mesh;
  30158. /**
  30159. * Creates a ground mesh from a height map.
  30160. * Please consider using the same method from the MeshBuilder class instead
  30161. * @see https://doc.babylonjs.com/babylon101/height_map
  30162. * @param name defines the name of the mesh to create
  30163. * @param url sets the URL of the height map image resource
  30164. * @param width set the ground width size
  30165. * @param height set the ground height size
  30166. * @param subdivisions sets the number of subdivision per side
  30167. * @param minHeight is the minimum altitude on the ground
  30168. * @param maxHeight is the maximum altitude on the ground
  30169. * @param scene defines the hosting scene
  30170. * @param updatable defines if the mesh must be flagged as updatable
  30171. * @param onReady is a callback function that will be called once the mesh is built (the height map download can last some time)
  30172. * @param alphaFilter will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  30173. * @returns a new Mesh
  30174. */
  30175. static CreateGroundFromHeightMap(name: string, url: string, width: number, height: number, subdivisions: number, minHeight: number, maxHeight: number, scene: Scene, updatable?: boolean, onReady?: (mesh: GroundMesh) => void, alphaFilter?: number): GroundMesh;
  30176. /**
  30177. * Creates a tube mesh.
  30178. * The tube is a parametric shape.
  30179. * It has no predefined shape. Its final shape will depend on the input parameters.
  30180. * Please consider using the same method from the MeshBuilder class instead
  30181. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  30182. * @param name defines the name of the mesh to create
  30183. * @param path is a required array of successive Vector3. It is the curve used as the axis of the tube
  30184. * @param radius sets the tube radius size
  30185. * @param tessellation is the number of sides on the tubular surface
  30186. * @param radiusFunction is a custom function. If it is not null, it overwrittes the parameter `radius`. This function is called on each point of the tube path and is passed the index `i` of the i-th point and the distance of this point from the first point of the path
  30187. * @param cap sets the way the extruded shape is capped. Possible values : Mesh.NO_CAP (default), Mesh.CAP_START, Mesh.CAP_END, Mesh.CAP_ALL
  30188. * @param scene defines the hosting scene
  30189. * @param updatable defines if the mesh must be flagged as updatable
  30190. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30191. * @param instance is an instance of an existing Tube object to be updated with the passed `pathArray` parameter (https://doc.babylonjs.com/how_to/How_to_dynamically_morph_a_mesh#tube)
  30192. * @returns a new Mesh
  30193. */
  30194. static CreateTube(name: string, path: Vector3[], radius: number, tessellation: number, radiusFunction: {
  30195. (i: number, distance: number): number;
  30196. }, cap: number, scene: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  30197. /**
  30198. * Creates a polyhedron mesh.
  30199. * Please consider using the same method from the MeshBuilder class instead.
  30200. * * The parameter `type` (positive integer, max 14, default 0) sets the polyhedron type to build among the 15 embbeded types. Please refer to the type sheet in the tutorial to choose the wanted type
  30201. * * The parameter `size` (positive float, default 1) sets the polygon size
  30202. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  30203. * * You can build other polyhedron types than the 15 embbeded ones by setting the parameter `custom` (`polyhedronObject`, default null). If you set the parameter `custom`, this overwrittes the parameter `type`
  30204. * * A `polyhedronObject` is a formatted javascript object. You'll find a full file with pre-set polyhedra here : https://github.com/BabylonJS/Extensions/tree/master/Polyhedron
  30205. * * You can set the color and the UV of each side of the polyhedron with the parameters `faceColors` (Color4, default `(1, 1, 1, 1)`) and faceUV (Vector4, default `(0, 0, 1, 1)`)
  30206. * * To understand how to set `faceUV` or `faceColors`, please read this by considering the right number of faces of your polyhedron, instead of only 6 for the box : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  30207. * * The parameter `flat` (boolean, default true). If set to false, it gives the polyhedron a single global face, so less vertices and shared normals. In this case, `faceColors` and `faceUV` are ignored
  30208. * * You can also set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  30209. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  30210. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  30211. * @param name defines the name of the mesh to create
  30212. * @param options defines the options used to create the mesh
  30213. * @param scene defines the hosting scene
  30214. * @returns a new Mesh
  30215. */
  30216. static CreatePolyhedron(name: string, options: {
  30217. type?: number;
  30218. size?: number;
  30219. sizeX?: number;
  30220. sizeY?: number;
  30221. sizeZ?: number;
  30222. custom?: any;
  30223. faceUV?: Vector4[];
  30224. faceColors?: Color4[];
  30225. updatable?: boolean;
  30226. sideOrientation?: number;
  30227. }, scene: Scene): Mesh;
  30228. /**
  30229. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  30230. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  30231. * * You can set some different icosphere dimensions, for instance to build an ellipsoid, by using the parameters `radiusX`, `radiusY` and `radiusZ` (all by default have the same value than `radius`)
  30232. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  30233. * * The parameter `flat` (boolean, default true) gives each side its own normals. Set it to false to get a smooth continuous light reflection on the surface
  30234. * * You can also set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  30235. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  30236. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  30237. * @param name defines the name of the mesh
  30238. * @param options defines the options used to create the mesh
  30239. * @param scene defines the hosting scene
  30240. * @returns a new Mesh
  30241. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  30242. */
  30243. static CreateIcoSphere(name: string, options: {
  30244. radius?: number;
  30245. flat?: boolean;
  30246. subdivisions?: number;
  30247. sideOrientation?: number;
  30248. updatable?: boolean;
  30249. }, scene: Scene): Mesh;
  30250. /**
  30251. * Creates a decal mesh.
  30252. * Please consider using the same method from the MeshBuilder class instead.
  30253. * A decal is a mesh usually applied as a model onto the surface of another mesh
  30254. * @param name defines the name of the mesh
  30255. * @param sourceMesh defines the mesh receiving the decal
  30256. * @param position sets the position of the decal in world coordinates
  30257. * @param normal sets the normal of the mesh where the decal is applied onto in world coordinates
  30258. * @param size sets the decal scaling
  30259. * @param angle sets the angle to rotate the decal
  30260. * @returns a new Mesh
  30261. */
  30262. static CreateDecal(name: string, sourceMesh: AbstractMesh, position: Vector3, normal: Vector3, size: Vector3, angle: number): Mesh;
  30263. /**
  30264. * Prepare internal position array for software CPU skinning
  30265. * @returns original positions used for CPU skinning. Useful for integrating Morphing with skeletons in same mesh
  30266. */
  30267. setPositionsForCPUSkinning(): Float32Array;
  30268. /**
  30269. * Prepare internal normal array for software CPU skinning
  30270. * @returns original normals used for CPU skinning. Useful for integrating Morphing with skeletons in same mesh.
  30271. */
  30272. setNormalsForCPUSkinning(): Float32Array;
  30273. /**
  30274. * Updates the vertex buffer by applying transformation from the bones
  30275. * @param skeleton defines the skeleton to apply to current mesh
  30276. * @returns the current mesh
  30277. */
  30278. applySkeleton(skeleton: Skeleton): Mesh;
  30279. /**
  30280. * Returns an object containing a min and max Vector3 which are the minimum and maximum vectors of each mesh bounding box from the passed array, in the world coordinates
  30281. * @param meshes defines the list of meshes to scan
  30282. * @returns an object `{min:` Vector3`, max:` Vector3`}`
  30283. */
  30284. static MinMax(meshes: AbstractMesh[]): {
  30285. min: Vector3;
  30286. max: Vector3;
  30287. };
  30288. /**
  30289. * Returns the center of the `{min:` Vector3`, max:` Vector3`}` or the center of MinMax vector3 computed from a mesh array
  30290. * @param meshesOrMinMaxVector could be an array of meshes or a `{min:` Vector3`, max:` Vector3`}` object
  30291. * @returns a vector3
  30292. */
  30293. static Center(meshesOrMinMaxVector: {
  30294. min: Vector3;
  30295. max: Vector3;
  30296. } | AbstractMesh[]): Vector3;
  30297. /**
  30298. * Merge the array of meshes into a single mesh for performance reasons.
  30299. * @param meshes defines he vertices source. They should all be of the same material. Entries can empty
  30300. * @param disposeSource when true (default), dispose of the vertices from the source meshes
  30301. * @param allow32BitsIndices when the sum of the vertices > 64k, this must be set to true
  30302. * @param meshSubclass when set, vertices inserted into this Mesh. Meshes can then be merged into a Mesh sub-class.
  30303. * @param subdivideWithSubMeshes when true (false default), subdivide mesh to his subMesh array with meshes source.
  30304. * @param multiMultiMaterials when true (false default), subdivide mesh and accept multiple multi materials, ignores subdivideWithSubMeshes.
  30305. * @returns a new mesh
  30306. */
  30307. static MergeMeshes(meshes: Array<Mesh>, disposeSource?: boolean, allow32BitsIndices?: boolean, meshSubclass?: Mesh, subdivideWithSubMeshes?: boolean, multiMultiMaterials?: boolean): Nullable<Mesh>;
  30308. /** @hidden */
  30309. addInstance(instance: InstancedMesh): void;
  30310. /** @hidden */
  30311. removeInstance(instance: InstancedMesh): void;
  30312. }
  30313. }
  30314. declare module "babylonjs/Cameras/camera" {
  30315. import { SmartArray } from "babylonjs/Misc/smartArray";
  30316. import { Observable } from "babylonjs/Misc/observable";
  30317. import { Nullable } from "babylonjs/types";
  30318. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  30319. import { Scene } from "babylonjs/scene";
  30320. import { Matrix, Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  30321. import { Node } from "babylonjs/node";
  30322. import { Mesh } from "babylonjs/Meshes/mesh";
  30323. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  30324. import { ICullable } from "babylonjs/Culling/boundingInfo";
  30325. import { Viewport } from "babylonjs/Maths/math.viewport";
  30326. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  30327. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  30328. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  30329. import { Ray } from "babylonjs/Culling/ray";
  30330. /**
  30331. * This is the base class of all the camera used in the application.
  30332. * @see https://doc.babylonjs.com/features/cameras
  30333. */
  30334. export class Camera extends Node {
  30335. /** @hidden */
  30336. static _createDefaultParsedCamera: (name: string, scene: Scene) => Camera;
  30337. /**
  30338. * This is the default projection mode used by the cameras.
  30339. * It helps recreating a feeling of perspective and better appreciate depth.
  30340. * This is the best way to simulate real life cameras.
  30341. */
  30342. static readonly PERSPECTIVE_CAMERA: number;
  30343. /**
  30344. * This helps creating camera with an orthographic mode.
  30345. * Orthographic is commonly used in engineering as a means to produce object specifications that communicate dimensions unambiguously, each line of 1 unit length (cm, meter..whatever) will appear to have the same length everywhere on the drawing. This allows the drafter to dimension only a subset of lines and let the reader know that other lines of that length on the drawing are also that length in reality. Every parallel line in the drawing is also parallel in the object.
  30346. */
  30347. static readonly ORTHOGRAPHIC_CAMERA: number;
  30348. /**
  30349. * This is the default FOV mode for perspective cameras.
  30350. * This setting aligns the upper and lower bounds of the viewport to the upper and lower bounds of the camera frustum.
  30351. */
  30352. static readonly FOVMODE_VERTICAL_FIXED: number;
  30353. /**
  30354. * This setting aligns the left and right bounds of the viewport to the left and right bounds of the camera frustum.
  30355. */
  30356. static readonly FOVMODE_HORIZONTAL_FIXED: number;
  30357. /**
  30358. * This specifies ther is no need for a camera rig.
  30359. * Basically only one eye is rendered corresponding to the camera.
  30360. */
  30361. static readonly RIG_MODE_NONE: number;
  30362. /**
  30363. * Simulates a camera Rig with one blue eye and one red eye.
  30364. * This can be use with 3d blue and red glasses.
  30365. */
  30366. static readonly RIG_MODE_STEREOSCOPIC_ANAGLYPH: number;
  30367. /**
  30368. * Defines that both eyes of the camera will be rendered side by side with a parallel target.
  30369. */
  30370. static readonly RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_PARALLEL: number;
  30371. /**
  30372. * Defines that both eyes of the camera will be rendered side by side with a none parallel target.
  30373. */
  30374. static readonly RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_CROSSEYED: number;
  30375. /**
  30376. * Defines that both eyes of the camera will be rendered over under each other.
  30377. */
  30378. static readonly RIG_MODE_STEREOSCOPIC_OVERUNDER: number;
  30379. /**
  30380. * Defines that both eyes of the camera will be rendered on successive lines interlaced for passive 3d monitors.
  30381. */
  30382. static readonly RIG_MODE_STEREOSCOPIC_INTERLACED: number;
  30383. /**
  30384. * Defines that both eyes of the camera should be renderered in a VR mode (carbox).
  30385. */
  30386. static readonly RIG_MODE_VR: number;
  30387. /**
  30388. * Defines that both eyes of the camera should be renderered in a VR mode (webVR).
  30389. */
  30390. static readonly RIG_MODE_WEBVR: number;
  30391. /**
  30392. * Custom rig mode allowing rig cameras to be populated manually with any number of cameras
  30393. */
  30394. static readonly RIG_MODE_CUSTOM: number;
  30395. /**
  30396. * Defines if by default attaching controls should prevent the default javascript event to continue.
  30397. */
  30398. static ForceAttachControlToAlwaysPreventDefault: boolean;
  30399. /**
  30400. * Define the input manager associated with the camera.
  30401. */
  30402. inputs: CameraInputsManager<Camera>;
  30403. /** @hidden */
  30404. _position: Vector3;
  30405. /**
  30406. * Define the current local position of the camera in the scene
  30407. */
  30408. get position(): Vector3;
  30409. set position(newPosition: Vector3);
  30410. /**
  30411. * The vector the camera should consider as up.
  30412. * (default is Vector3(0, 1, 0) aka Vector3.Up())
  30413. */
  30414. upVector: Vector3;
  30415. /**
  30416. * Define the current limit on the left side for an orthographic camera
  30417. * In scene unit
  30418. */
  30419. orthoLeft: Nullable<number>;
  30420. /**
  30421. * Define the current limit on the right side for an orthographic camera
  30422. * In scene unit
  30423. */
  30424. orthoRight: Nullable<number>;
  30425. /**
  30426. * Define the current limit on the bottom side for an orthographic camera
  30427. * In scene unit
  30428. */
  30429. orthoBottom: Nullable<number>;
  30430. /**
  30431. * Define the current limit on the top side for an orthographic camera
  30432. * In scene unit
  30433. */
  30434. orthoTop: Nullable<number>;
  30435. /**
  30436. * Field Of View is set in Radians. (default is 0.8)
  30437. */
  30438. fov: number;
  30439. /**
  30440. * Define the minimum distance the camera can see from.
  30441. * This is important to note that the depth buffer are not infinite and the closer it starts
  30442. * the more your scene might encounter depth fighting issue.
  30443. */
  30444. minZ: number;
  30445. /**
  30446. * Define the maximum distance the camera can see to.
  30447. * This is important to note that the depth buffer are not infinite and the further it end
  30448. * the more your scene might encounter depth fighting issue.
  30449. */
  30450. maxZ: number;
  30451. /**
  30452. * Define the default inertia of the camera.
  30453. * This helps giving a smooth feeling to the camera movement.
  30454. */
  30455. inertia: number;
  30456. /**
  30457. * Define the mode of the camera (Camera.PERSPECTIVE_CAMERA or Camera.ORTHOGRAPHIC_CAMERA)
  30458. */
  30459. mode: number;
  30460. /**
  30461. * Define whether the camera is intermediate.
  30462. * This is useful to not present the output directly to the screen in case of rig without post process for instance
  30463. */
  30464. isIntermediate: boolean;
  30465. /**
  30466. * Define the viewport of the camera.
  30467. * This correspond to the portion of the screen the camera will render to in normalized 0 to 1 unit.
  30468. */
  30469. viewport: Viewport;
  30470. /**
  30471. * Restricts the camera to viewing objects with the same layerMask.
  30472. * A camera with a layerMask of 1 will render mesh.layerMask & camera.layerMask!== 0
  30473. */
  30474. layerMask: number;
  30475. /**
  30476. * fovMode sets the camera frustum bounds to the viewport bounds. (default is FOVMODE_VERTICAL_FIXED)
  30477. */
  30478. fovMode: number;
  30479. /**
  30480. * Rig mode of the camera.
  30481. * This is useful to create the camera with two "eyes" instead of one to create VR or stereoscopic scenes.
  30482. * This is normally controlled byt the camera themselves as internal use.
  30483. */
  30484. cameraRigMode: number;
  30485. /**
  30486. * Defines the distance between both "eyes" in case of a RIG
  30487. */
  30488. interaxialDistance: number;
  30489. /**
  30490. * Defines if stereoscopic rendering is done side by side or over under.
  30491. */
  30492. isStereoscopicSideBySide: boolean;
  30493. /**
  30494. * Defines the list of custom render target which are rendered to and then used as the input to this camera's render. Eg. display another camera view on a TV in the main scene
  30495. * This is pretty helpfull if you wish to make a camera render to a texture you could reuse somewhere
  30496. * else in the scene. (Eg. security camera)
  30497. *
  30498. * To change the final output target of the camera, camera.outputRenderTarget should be used instead (eg. webXR renders to a render target corrisponding to an HMD)
  30499. */
  30500. customRenderTargets: import("babylonjs/Materials/Textures/renderTargetTexture").RenderTargetTexture[];
  30501. /**
  30502. * When set, the camera will render to this render target instead of the default canvas
  30503. *
  30504. * If the desire is to use the output of a camera as a texture in the scene consider using camera.customRenderTargets instead
  30505. */
  30506. outputRenderTarget: Nullable<RenderTargetTexture>;
  30507. /**
  30508. * Observable triggered when the camera view matrix has changed.
  30509. */
  30510. onViewMatrixChangedObservable: Observable<Camera>;
  30511. /**
  30512. * Observable triggered when the camera Projection matrix has changed.
  30513. */
  30514. onProjectionMatrixChangedObservable: Observable<Camera>;
  30515. /**
  30516. * Observable triggered when the inputs have been processed.
  30517. */
  30518. onAfterCheckInputsObservable: Observable<Camera>;
  30519. /**
  30520. * Observable triggered when reset has been called and applied to the camera.
  30521. */
  30522. onRestoreStateObservable: Observable<Camera>;
  30523. /**
  30524. * Is this camera a part of a rig system?
  30525. */
  30526. isRigCamera: boolean;
  30527. /**
  30528. * If isRigCamera set to true this will be set with the parent camera.
  30529. * The parent camera is not (!) necessarily the .parent of this camera (like in the case of XR)
  30530. */
  30531. rigParent?: Camera;
  30532. /** @hidden */
  30533. _cameraRigParams: any;
  30534. /** @hidden */
  30535. _rigCameras: Camera[];
  30536. /** @hidden */
  30537. _rigPostProcess: Nullable<PostProcess>;
  30538. protected _webvrViewMatrix: Matrix;
  30539. /** @hidden */
  30540. _skipRendering: boolean;
  30541. /** @hidden */
  30542. _projectionMatrix: Matrix;
  30543. /** @hidden */
  30544. _postProcesses: Nullable<import("babylonjs/PostProcesses/postProcess").PostProcess>[];
  30545. /** @hidden */
  30546. _activeMeshes: SmartArray<AbstractMesh>;
  30547. protected _globalPosition: Vector3;
  30548. /** @hidden */
  30549. _computedViewMatrix: Matrix;
  30550. private _doNotComputeProjectionMatrix;
  30551. private _transformMatrix;
  30552. private _frustumPlanes;
  30553. private _refreshFrustumPlanes;
  30554. private _storedFov;
  30555. private _stateStored;
  30556. /**
  30557. * Instantiates a new camera object.
  30558. * This should not be used directly but through the inherited cameras: ArcRotate, Free...
  30559. * @see https://doc.babylonjs.com/features/cameras
  30560. * @param name Defines the name of the camera in the scene
  30561. * @param position Defines the position of the camera
  30562. * @param scene Defines the scene the camera belongs too
  30563. * @param setActiveOnSceneIfNoneActive Defines if the camera should be set as active after creation if no other camera have been defined in the scene
  30564. */
  30565. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  30566. /**
  30567. * Store current camera state (fov, position, etc..)
  30568. * @returns the camera
  30569. */
  30570. storeState(): Camera;
  30571. /**
  30572. * Restores the camera state values if it has been stored. You must call storeState() first
  30573. */
  30574. protected _restoreStateValues(): boolean;
  30575. /**
  30576. * Restored camera state. You must call storeState() first.
  30577. * @returns true if restored and false otherwise
  30578. */
  30579. restoreState(): boolean;
  30580. /**
  30581. * Gets the class name of the camera.
  30582. * @returns the class name
  30583. */
  30584. getClassName(): string;
  30585. /** @hidden */
  30586. readonly _isCamera: boolean;
  30587. /**
  30588. * Gets a string representation of the camera useful for debug purpose.
  30589. * @param fullDetails Defines that a more verboe level of logging is required
  30590. * @returns the string representation
  30591. */
  30592. toString(fullDetails?: boolean): string;
  30593. /**
  30594. * Gets the current world space position of the camera.
  30595. */
  30596. get globalPosition(): Vector3;
  30597. /**
  30598. * Gets the list of active meshes this frame (meshes no culled or excluded by lod s in the frame)
  30599. * @returns the active meshe list
  30600. */
  30601. getActiveMeshes(): SmartArray<AbstractMesh>;
  30602. /**
  30603. * Check whether a mesh is part of the current active mesh list of the camera
  30604. * @param mesh Defines the mesh to check
  30605. * @returns true if active, false otherwise
  30606. */
  30607. isActiveMesh(mesh: Mesh): boolean;
  30608. /**
  30609. * Is this camera ready to be used/rendered
  30610. * @param completeCheck defines if a complete check (including post processes) has to be done (false by default)
  30611. * @return true if the camera is ready
  30612. */
  30613. isReady(completeCheck?: boolean): boolean;
  30614. /** @hidden */
  30615. _initCache(): void;
  30616. /** @hidden */
  30617. _updateCache(ignoreParentClass?: boolean): void;
  30618. /** @hidden */
  30619. _isSynchronized(): boolean;
  30620. /** @hidden */
  30621. _isSynchronizedViewMatrix(): boolean;
  30622. /** @hidden */
  30623. _isSynchronizedProjectionMatrix(): boolean;
  30624. /**
  30625. * Attach the input controls to a specific dom element to get the input from.
  30626. * @param element Defines the element the controls should be listened from
  30627. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  30628. */
  30629. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  30630. /**
  30631. * Detach the current controls from the specified dom element.
  30632. * @param element Defines the element to stop listening the inputs from
  30633. */
  30634. detachControl(element: HTMLElement): void;
  30635. /**
  30636. * Update the camera state according to the different inputs gathered during the frame.
  30637. */
  30638. update(): void;
  30639. /** @hidden */
  30640. _checkInputs(): void;
  30641. /** @hidden */
  30642. get rigCameras(): Camera[];
  30643. /**
  30644. * Gets the post process used by the rig cameras
  30645. */
  30646. get rigPostProcess(): Nullable<PostProcess>;
  30647. /**
  30648. * Internal, gets the first post proces.
  30649. * @returns the first post process to be run on this camera.
  30650. */
  30651. _getFirstPostProcess(): Nullable<PostProcess>;
  30652. private _cascadePostProcessesToRigCams;
  30653. /**
  30654. * Attach a post process to the camera.
  30655. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#attach-postprocess
  30656. * @param postProcess The post process to attach to the camera
  30657. * @param insertAt The position of the post process in case several of them are in use in the scene
  30658. * @returns the position the post process has been inserted at
  30659. */
  30660. attachPostProcess(postProcess: PostProcess, insertAt?: Nullable<number>): number;
  30661. /**
  30662. * Detach a post process to the camera.
  30663. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#attach-postprocess
  30664. * @param postProcess The post process to detach from the camera
  30665. */
  30666. detachPostProcess(postProcess: PostProcess): void;
  30667. /**
  30668. * Gets the current world matrix of the camera
  30669. */
  30670. getWorldMatrix(): Matrix;
  30671. /** @hidden */
  30672. _getViewMatrix(): Matrix;
  30673. /**
  30674. * Gets the current view matrix of the camera.
  30675. * @param force forces the camera to recompute the matrix without looking at the cached state
  30676. * @returns the view matrix
  30677. */
  30678. getViewMatrix(force?: boolean): Matrix;
  30679. /**
  30680. * Freeze the projection matrix.
  30681. * It will prevent the cache check of the camera projection compute and can speed up perf
  30682. * if no parameter of the camera are meant to change
  30683. * @param projection Defines manually a projection if necessary
  30684. */
  30685. freezeProjectionMatrix(projection?: Matrix): void;
  30686. /**
  30687. * Unfreeze the projection matrix if it has previously been freezed by freezeProjectionMatrix.
  30688. */
  30689. unfreezeProjectionMatrix(): void;
  30690. /**
  30691. * Gets the current projection matrix of the camera.
  30692. * @param force forces the camera to recompute the matrix without looking at the cached state
  30693. * @returns the projection matrix
  30694. */
  30695. getProjectionMatrix(force?: boolean): Matrix;
  30696. /**
  30697. * Gets the transformation matrix (ie. the multiplication of view by projection matrices)
  30698. * @returns a Matrix
  30699. */
  30700. getTransformationMatrix(): Matrix;
  30701. private _updateFrustumPlanes;
  30702. /**
  30703. * Checks if a cullable object (mesh...) is in the camera frustum
  30704. * This checks the bounding box center. See isCompletelyInFrustum for a full bounding check
  30705. * @param target The object to check
  30706. * @param checkRigCameras If the rig cameras should be checked (eg. with webVR camera both eyes should be checked) (Default: false)
  30707. * @returns true if the object is in frustum otherwise false
  30708. */
  30709. isInFrustum(target: ICullable, checkRigCameras?: boolean): boolean;
  30710. /**
  30711. * Checks if a cullable object (mesh...) is in the camera frustum
  30712. * Unlike isInFrustum this cheks the full bounding box
  30713. * @param target The object to check
  30714. * @returns true if the object is in frustum otherwise false
  30715. */
  30716. isCompletelyInFrustum(target: ICullable): boolean;
  30717. /**
  30718. * Gets a ray in the forward direction from the camera.
  30719. * @param length Defines the length of the ray to create
  30720. * @param transform Defines the transform to apply to the ray, by default the world matrx is used to create a workd space ray
  30721. * @param origin Defines the start point of the ray which defaults to the camera position
  30722. * @returns the forward ray
  30723. */
  30724. getForwardRay(length?: number, transform?: Matrix, origin?: Vector3): Ray;
  30725. /**
  30726. * Gets a ray in the forward direction from the camera.
  30727. * @param refRay the ray to (re)use when setting the values
  30728. * @param length Defines the length of the ray to create
  30729. * @param transform Defines the transform to apply to the ray, by default the world matrx is used to create a workd space ray
  30730. * @param origin Defines the start point of the ray which defaults to the camera position
  30731. * @returns the forward ray
  30732. */
  30733. getForwardRayToRef(refRay: Ray, length?: number, transform?: Matrix, origin?: Vector3): Ray;
  30734. /**
  30735. * Releases resources associated with this node.
  30736. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  30737. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  30738. */
  30739. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  30740. /** @hidden */
  30741. _isLeftCamera: boolean;
  30742. /**
  30743. * Gets the left camera of a rig setup in case of Rigged Camera
  30744. */
  30745. get isLeftCamera(): boolean;
  30746. /** @hidden */
  30747. _isRightCamera: boolean;
  30748. /**
  30749. * Gets the right camera of a rig setup in case of Rigged Camera
  30750. */
  30751. get isRightCamera(): boolean;
  30752. /**
  30753. * Gets the left camera of a rig setup in case of Rigged Camera
  30754. */
  30755. get leftCamera(): Nullable<FreeCamera>;
  30756. /**
  30757. * Gets the right camera of a rig setup in case of Rigged Camera
  30758. */
  30759. get rightCamera(): Nullable<FreeCamera>;
  30760. /**
  30761. * Gets the left camera target of a rig setup in case of Rigged Camera
  30762. * @returns the target position
  30763. */
  30764. getLeftTarget(): Nullable<Vector3>;
  30765. /**
  30766. * Gets the right camera target of a rig setup in case of Rigged Camera
  30767. * @returns the target position
  30768. */
  30769. getRightTarget(): Nullable<Vector3>;
  30770. /**
  30771. * @hidden
  30772. */
  30773. setCameraRigMode(mode: number, rigParams: any): void;
  30774. /** @hidden */
  30775. static _setStereoscopicRigMode(camera: Camera): void;
  30776. /** @hidden */
  30777. static _setStereoscopicAnaglyphRigMode(camera: Camera): void;
  30778. /** @hidden */
  30779. static _setVRRigMode(camera: Camera, rigParams: any): void;
  30780. /** @hidden */
  30781. static _setWebVRRigMode(camera: Camera, rigParams: any): void;
  30782. /** @hidden */
  30783. _getVRProjectionMatrix(): Matrix;
  30784. protected _updateCameraRotationMatrix(): void;
  30785. protected _updateWebVRCameraRotationMatrix(): void;
  30786. /**
  30787. * This function MUST be overwritten by the different WebVR cameras available.
  30788. * The context in which it is running is the RIG camera. So 'this' is the TargetCamera, left or right.
  30789. * @hidden
  30790. */
  30791. _getWebVRProjectionMatrix(): Matrix;
  30792. /**
  30793. * This function MUST be overwritten by the different WebVR cameras available.
  30794. * The context in which it is running is the RIG camera. So 'this' is the TargetCamera, left or right.
  30795. * @hidden
  30796. */
  30797. _getWebVRViewMatrix(): Matrix;
  30798. /** @hidden */
  30799. setCameraRigParameter(name: string, value: any): void;
  30800. /**
  30801. * needs to be overridden by children so sub has required properties to be copied
  30802. * @hidden
  30803. */
  30804. createRigCamera(name: string, cameraIndex: number): Nullable<Camera>;
  30805. /**
  30806. * May need to be overridden by children
  30807. * @hidden
  30808. */
  30809. _updateRigCameras(): void;
  30810. /** @hidden */
  30811. _setupInputs(): void;
  30812. /**
  30813. * Serialiaze the camera setup to a json represention
  30814. * @returns the JSON representation
  30815. */
  30816. serialize(): any;
  30817. /**
  30818. * Clones the current camera.
  30819. * @param name The cloned camera name
  30820. * @returns the cloned camera
  30821. */
  30822. clone(name: string): Camera;
  30823. /**
  30824. * Gets the direction of the camera relative to a given local axis.
  30825. * @param localAxis Defines the reference axis to provide a relative direction.
  30826. * @return the direction
  30827. */
  30828. getDirection(localAxis: Vector3): Vector3;
  30829. /**
  30830. * Returns the current camera absolute rotation
  30831. */
  30832. get absoluteRotation(): Quaternion;
  30833. /**
  30834. * Gets the direction of the camera relative to a given local axis into a passed vector.
  30835. * @param localAxis Defines the reference axis to provide a relative direction.
  30836. * @param result Defines the vector to store the result in
  30837. */
  30838. getDirectionToRef(localAxis: Vector3, result: Vector3): void;
  30839. /**
  30840. * Gets a camera constructor for a given camera type
  30841. * @param type The type of the camera to construct (should be equal to one of the camera class name)
  30842. * @param name The name of the camera the result will be able to instantiate
  30843. * @param scene The scene the result will construct the camera in
  30844. * @param interaxial_distance In case of stereoscopic setup, the distance between both eyes
  30845. * @param isStereoscopicSideBySide In case of stereoscopic setup, should the sereo be side b side
  30846. * @returns a factory method to construc the camera
  30847. */
  30848. static GetConstructorFromName(type: string, name: string, scene: Scene, interaxial_distance?: number, isStereoscopicSideBySide?: boolean): () => Camera;
  30849. /**
  30850. * Compute the world matrix of the camera.
  30851. * @returns the camera world matrix
  30852. */
  30853. computeWorldMatrix(): Matrix;
  30854. /**
  30855. * Parse a JSON and creates the camera from the parsed information
  30856. * @param parsedCamera The JSON to parse
  30857. * @param scene The scene to instantiate the camera in
  30858. * @returns the newly constructed camera
  30859. */
  30860. static Parse(parsedCamera: any, scene: Scene): Camera;
  30861. }
  30862. }
  30863. declare module "babylonjs/Meshes/Builders/discBuilder" {
  30864. import { Nullable } from "babylonjs/types";
  30865. import { Scene } from "babylonjs/scene";
  30866. import { Vector4 } from "babylonjs/Maths/math.vector";
  30867. import { Mesh } from "babylonjs/Meshes/mesh";
  30868. /**
  30869. * Class containing static functions to help procedurally build meshes
  30870. */
  30871. export class DiscBuilder {
  30872. /**
  30873. * Creates a plane polygonal mesh. By default, this is a disc
  30874. * * The parameter `radius` sets the radius size (float) of the polygon (default 0.5)
  30875. * * The parameter `tessellation` sets the number of polygon sides (positive integer, default 64). So a tessellation valued to 3 will build a triangle, to 4 a square, etc
  30876. * * You can create an unclosed polygon with the parameter `arc` (positive float, default 1), valued between 0 and 1, what is the ratio of the circumference : 2 x PI x ratio
  30877. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  30878. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  30879. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  30880. * @param name defines the name of the mesh
  30881. * @param options defines the options used to create the mesh
  30882. * @param scene defines the hosting scene
  30883. * @returns the plane polygonal mesh
  30884. * @see https://doc.babylonjs.com/how_to/set_shapes#disc-or-regular-polygon
  30885. */
  30886. static CreateDisc(name: string, options: {
  30887. radius?: number;
  30888. tessellation?: number;
  30889. arc?: number;
  30890. updatable?: boolean;
  30891. sideOrientation?: number;
  30892. frontUVs?: Vector4;
  30893. backUVs?: Vector4;
  30894. }, scene?: Nullable<Scene>): Mesh;
  30895. }
  30896. }
  30897. declare module "babylonjs/Materials/fresnelParameters" {
  30898. import { DeepImmutable } from "babylonjs/types";
  30899. import { Color3 } from "babylonjs/Maths/math.color";
  30900. /**
  30901. * Options to be used when creating a FresnelParameters.
  30902. */
  30903. export type IFresnelParametersCreationOptions = {
  30904. /**
  30905. * Define the color used on edges (grazing angle)
  30906. */
  30907. leftColor?: Color3;
  30908. /**
  30909. * Define the color used on center
  30910. */
  30911. rightColor?: Color3;
  30912. /**
  30913. * Define bias applied to computed fresnel term
  30914. */
  30915. bias?: number;
  30916. /**
  30917. * Defined the power exponent applied to fresnel term
  30918. */
  30919. power?: number;
  30920. /**
  30921. * Define if the fresnel effect is enable or not.
  30922. */
  30923. isEnabled?: boolean;
  30924. };
  30925. /**
  30926. * Serialized format for FresnelParameters.
  30927. */
  30928. export type IFresnelParametersSerialized = {
  30929. /**
  30930. * Define the color used on edges (grazing angle) [as an array]
  30931. */
  30932. leftColor: number[];
  30933. /**
  30934. * Define the color used on center [as an array]
  30935. */
  30936. rightColor: number[];
  30937. /**
  30938. * Define bias applied to computed fresnel term
  30939. */
  30940. bias: number;
  30941. /**
  30942. * Defined the power exponent applied to fresnel term
  30943. */
  30944. power?: number;
  30945. /**
  30946. * Define if the fresnel effect is enable or not.
  30947. */
  30948. isEnabled: boolean;
  30949. };
  30950. /**
  30951. * This represents all the required information to add a fresnel effect on a material:
  30952. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  30953. */
  30954. export class FresnelParameters {
  30955. private _isEnabled;
  30956. /**
  30957. * Define if the fresnel effect is enable or not.
  30958. */
  30959. get isEnabled(): boolean;
  30960. set isEnabled(value: boolean);
  30961. /**
  30962. * Define the color used on edges (grazing angle)
  30963. */
  30964. leftColor: Color3;
  30965. /**
  30966. * Define the color used on center
  30967. */
  30968. rightColor: Color3;
  30969. /**
  30970. * Define bias applied to computed fresnel term
  30971. */
  30972. bias: number;
  30973. /**
  30974. * Defined the power exponent applied to fresnel term
  30975. */
  30976. power: number;
  30977. /**
  30978. * Creates a new FresnelParameters object.
  30979. *
  30980. * @param options provide your own settings to optionally to override defaults
  30981. */
  30982. constructor(options?: IFresnelParametersCreationOptions);
  30983. /**
  30984. * Clones the current fresnel and its valuues
  30985. * @returns a clone fresnel configuration
  30986. */
  30987. clone(): FresnelParameters;
  30988. /**
  30989. * Determines equality between FresnelParameters objects
  30990. * @param otherFresnelParameters defines the second operand
  30991. * @returns true if the power, bias, leftColor, rightColor and isEnabled values are equal to the given ones
  30992. */
  30993. equals(otherFresnelParameters: DeepImmutable<FresnelParameters>): boolean;
  30994. /**
  30995. * Serializes the current fresnel parameters to a JSON representation.
  30996. * @return the JSON serialization
  30997. */
  30998. serialize(): IFresnelParametersSerialized;
  30999. /**
  31000. * Parse a JSON object and deserialize it to a new Fresnel parameter object.
  31001. * @param parsedFresnelParameters Define the JSON representation
  31002. * @returns the parsed parameters
  31003. */
  31004. static Parse(parsedFresnelParameters: IFresnelParametersSerialized): FresnelParameters;
  31005. }
  31006. }
  31007. declare module "babylonjs/Materials/materialFlags" {
  31008. /**
  31009. * This groups all the flags used to control the materials channel.
  31010. */
  31011. export class MaterialFlags {
  31012. private static _DiffuseTextureEnabled;
  31013. /**
  31014. * Are diffuse textures enabled in the application.
  31015. */
  31016. static get DiffuseTextureEnabled(): boolean;
  31017. static set DiffuseTextureEnabled(value: boolean);
  31018. private static _DetailTextureEnabled;
  31019. /**
  31020. * Are detail textures enabled in the application.
  31021. */
  31022. static get DetailTextureEnabled(): boolean;
  31023. static set DetailTextureEnabled(value: boolean);
  31024. private static _AmbientTextureEnabled;
  31025. /**
  31026. * Are ambient textures enabled in the application.
  31027. */
  31028. static get AmbientTextureEnabled(): boolean;
  31029. static set AmbientTextureEnabled(value: boolean);
  31030. private static _OpacityTextureEnabled;
  31031. /**
  31032. * Are opacity textures enabled in the application.
  31033. */
  31034. static get OpacityTextureEnabled(): boolean;
  31035. static set OpacityTextureEnabled(value: boolean);
  31036. private static _ReflectionTextureEnabled;
  31037. /**
  31038. * Are reflection textures enabled in the application.
  31039. */
  31040. static get ReflectionTextureEnabled(): boolean;
  31041. static set ReflectionTextureEnabled(value: boolean);
  31042. private static _EmissiveTextureEnabled;
  31043. /**
  31044. * Are emissive textures enabled in the application.
  31045. */
  31046. static get EmissiveTextureEnabled(): boolean;
  31047. static set EmissiveTextureEnabled(value: boolean);
  31048. private static _SpecularTextureEnabled;
  31049. /**
  31050. * Are specular textures enabled in the application.
  31051. */
  31052. static get SpecularTextureEnabled(): boolean;
  31053. static set SpecularTextureEnabled(value: boolean);
  31054. private static _BumpTextureEnabled;
  31055. /**
  31056. * Are bump textures enabled in the application.
  31057. */
  31058. static get BumpTextureEnabled(): boolean;
  31059. static set BumpTextureEnabled(value: boolean);
  31060. private static _LightmapTextureEnabled;
  31061. /**
  31062. * Are lightmap textures enabled in the application.
  31063. */
  31064. static get LightmapTextureEnabled(): boolean;
  31065. static set LightmapTextureEnabled(value: boolean);
  31066. private static _RefractionTextureEnabled;
  31067. /**
  31068. * Are refraction textures enabled in the application.
  31069. */
  31070. static get RefractionTextureEnabled(): boolean;
  31071. static set RefractionTextureEnabled(value: boolean);
  31072. private static _ColorGradingTextureEnabled;
  31073. /**
  31074. * Are color grading textures enabled in the application.
  31075. */
  31076. static get ColorGradingTextureEnabled(): boolean;
  31077. static set ColorGradingTextureEnabled(value: boolean);
  31078. private static _FresnelEnabled;
  31079. /**
  31080. * Are fresnels enabled in the application.
  31081. */
  31082. static get FresnelEnabled(): boolean;
  31083. static set FresnelEnabled(value: boolean);
  31084. private static _ClearCoatTextureEnabled;
  31085. /**
  31086. * Are clear coat textures enabled in the application.
  31087. */
  31088. static get ClearCoatTextureEnabled(): boolean;
  31089. static set ClearCoatTextureEnabled(value: boolean);
  31090. private static _ClearCoatBumpTextureEnabled;
  31091. /**
  31092. * Are clear coat bump textures enabled in the application.
  31093. */
  31094. static get ClearCoatBumpTextureEnabled(): boolean;
  31095. static set ClearCoatBumpTextureEnabled(value: boolean);
  31096. private static _ClearCoatTintTextureEnabled;
  31097. /**
  31098. * Are clear coat tint textures enabled in the application.
  31099. */
  31100. static get ClearCoatTintTextureEnabled(): boolean;
  31101. static set ClearCoatTintTextureEnabled(value: boolean);
  31102. private static _SheenTextureEnabled;
  31103. /**
  31104. * Are sheen textures enabled in the application.
  31105. */
  31106. static get SheenTextureEnabled(): boolean;
  31107. static set SheenTextureEnabled(value: boolean);
  31108. private static _AnisotropicTextureEnabled;
  31109. /**
  31110. * Are anisotropic textures enabled in the application.
  31111. */
  31112. static get AnisotropicTextureEnabled(): boolean;
  31113. static set AnisotropicTextureEnabled(value: boolean);
  31114. private static _ThicknessTextureEnabled;
  31115. /**
  31116. * Are thickness textures enabled in the application.
  31117. */
  31118. static get ThicknessTextureEnabled(): boolean;
  31119. static set ThicknessTextureEnabled(value: boolean);
  31120. }
  31121. }
  31122. declare module "babylonjs/Shaders/ShadersInclude/defaultFragmentDeclaration" {
  31123. /** @hidden */
  31124. export var defaultFragmentDeclaration: {
  31125. name: string;
  31126. shader: string;
  31127. };
  31128. }
  31129. declare module "babylonjs/Shaders/ShadersInclude/defaultUboDeclaration" {
  31130. /** @hidden */
  31131. export var defaultUboDeclaration: {
  31132. name: string;
  31133. shader: string;
  31134. };
  31135. }
  31136. declare module "babylonjs/Shaders/ShadersInclude/prePassDeclaration" {
  31137. /** @hidden */
  31138. export var prePassDeclaration: {
  31139. name: string;
  31140. shader: string;
  31141. };
  31142. }
  31143. declare module "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration" {
  31144. /** @hidden */
  31145. export var lightFragmentDeclaration: {
  31146. name: string;
  31147. shader: string;
  31148. };
  31149. }
  31150. declare module "babylonjs/Shaders/ShadersInclude/lightUboDeclaration" {
  31151. /** @hidden */
  31152. export var lightUboDeclaration: {
  31153. name: string;
  31154. shader: string;
  31155. };
  31156. }
  31157. declare module "babylonjs/Shaders/ShadersInclude/lightsFragmentFunctions" {
  31158. /** @hidden */
  31159. export var lightsFragmentFunctions: {
  31160. name: string;
  31161. shader: string;
  31162. };
  31163. }
  31164. declare module "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions" {
  31165. /** @hidden */
  31166. export var shadowsFragmentFunctions: {
  31167. name: string;
  31168. shader: string;
  31169. };
  31170. }
  31171. declare module "babylonjs/Shaders/ShadersInclude/fresnelFunction" {
  31172. /** @hidden */
  31173. export var fresnelFunction: {
  31174. name: string;
  31175. shader: string;
  31176. };
  31177. }
  31178. declare module "babylonjs/Shaders/ShadersInclude/bumpFragmentMainFunctions" {
  31179. /** @hidden */
  31180. export var bumpFragmentMainFunctions: {
  31181. name: string;
  31182. shader: string;
  31183. };
  31184. }
  31185. declare module "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions" {
  31186. /** @hidden */
  31187. export var bumpFragmentFunctions: {
  31188. name: string;
  31189. shader: string;
  31190. };
  31191. }
  31192. declare module "babylonjs/Shaders/ShadersInclude/logDepthDeclaration" {
  31193. /** @hidden */
  31194. export var logDepthDeclaration: {
  31195. name: string;
  31196. shader: string;
  31197. };
  31198. }
  31199. declare module "babylonjs/Shaders/ShadersInclude/bumpFragment" {
  31200. /** @hidden */
  31201. export var bumpFragment: {
  31202. name: string;
  31203. shader: string;
  31204. };
  31205. }
  31206. declare module "babylonjs/Shaders/ShadersInclude/depthPrePass" {
  31207. /** @hidden */
  31208. export var depthPrePass: {
  31209. name: string;
  31210. shader: string;
  31211. };
  31212. }
  31213. declare module "babylonjs/Shaders/ShadersInclude/lightFragment" {
  31214. /** @hidden */
  31215. export var lightFragment: {
  31216. name: string;
  31217. shader: string;
  31218. };
  31219. }
  31220. declare module "babylonjs/Shaders/ShadersInclude/logDepthFragment" {
  31221. /** @hidden */
  31222. export var logDepthFragment: {
  31223. name: string;
  31224. shader: string;
  31225. };
  31226. }
  31227. declare module "babylonjs/Shaders/default.fragment" {
  31228. import "babylonjs/Shaders/ShadersInclude/defaultFragmentDeclaration";
  31229. import "babylonjs/Shaders/ShadersInclude/defaultUboDeclaration";
  31230. import "babylonjs/Shaders/ShadersInclude/prePassDeclaration";
  31231. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  31232. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  31233. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  31234. import "babylonjs/Shaders/ShadersInclude/lightsFragmentFunctions";
  31235. import "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions";
  31236. import "babylonjs/Shaders/ShadersInclude/fresnelFunction";
  31237. import "babylonjs/Shaders/ShadersInclude/reflectionFunction";
  31238. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  31239. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  31240. import "babylonjs/Shaders/ShadersInclude/bumpFragmentMainFunctions";
  31241. import "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions";
  31242. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  31243. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  31244. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  31245. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  31246. import "babylonjs/Shaders/ShadersInclude/bumpFragment";
  31247. import "babylonjs/Shaders/ShadersInclude/depthPrePass";
  31248. import "babylonjs/Shaders/ShadersInclude/lightFragment";
  31249. import "babylonjs/Shaders/ShadersInclude/logDepthFragment";
  31250. import "babylonjs/Shaders/ShadersInclude/fogFragment";
  31251. /** @hidden */
  31252. export var defaultPixelShader: {
  31253. name: string;
  31254. shader: string;
  31255. };
  31256. }
  31257. declare module "babylonjs/Shaders/ShadersInclude/defaultVertexDeclaration" {
  31258. /** @hidden */
  31259. export var defaultVertexDeclaration: {
  31260. name: string;
  31261. shader: string;
  31262. };
  31263. }
  31264. declare module "babylonjs/Shaders/ShadersInclude/bumpVertexDeclaration" {
  31265. /** @hidden */
  31266. export var bumpVertexDeclaration: {
  31267. name: string;
  31268. shader: string;
  31269. };
  31270. }
  31271. declare module "babylonjs/Shaders/ShadersInclude/bumpVertex" {
  31272. /** @hidden */
  31273. export var bumpVertex: {
  31274. name: string;
  31275. shader: string;
  31276. };
  31277. }
  31278. declare module "babylonjs/Shaders/ShadersInclude/fogVertex" {
  31279. /** @hidden */
  31280. export var fogVertex: {
  31281. name: string;
  31282. shader: string;
  31283. };
  31284. }
  31285. declare module "babylonjs/Shaders/ShadersInclude/shadowsVertex" {
  31286. /** @hidden */
  31287. export var shadowsVertex: {
  31288. name: string;
  31289. shader: string;
  31290. };
  31291. }
  31292. declare module "babylonjs/Shaders/ShadersInclude/pointCloudVertex" {
  31293. /** @hidden */
  31294. export var pointCloudVertex: {
  31295. name: string;
  31296. shader: string;
  31297. };
  31298. }
  31299. declare module "babylonjs/Shaders/ShadersInclude/logDepthVertex" {
  31300. /** @hidden */
  31301. export var logDepthVertex: {
  31302. name: string;
  31303. shader: string;
  31304. };
  31305. }
  31306. declare module "babylonjs/Shaders/default.vertex" {
  31307. import "babylonjs/Shaders/ShadersInclude/defaultVertexDeclaration";
  31308. import "babylonjs/Shaders/ShadersInclude/defaultUboDeclaration";
  31309. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  31310. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  31311. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  31312. import "babylonjs/Shaders/ShadersInclude/bumpVertexDeclaration";
  31313. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  31314. import "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration";
  31315. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  31316. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  31317. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  31318. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  31319. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  31320. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  31321. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  31322. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  31323. import "babylonjs/Shaders/ShadersInclude/bumpVertex";
  31324. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  31325. import "babylonjs/Shaders/ShadersInclude/fogVertex";
  31326. import "babylonjs/Shaders/ShadersInclude/shadowsVertex";
  31327. import "babylonjs/Shaders/ShadersInclude/pointCloudVertex";
  31328. import "babylonjs/Shaders/ShadersInclude/logDepthVertex";
  31329. /** @hidden */
  31330. export var defaultVertexShader: {
  31331. name: string;
  31332. shader: string;
  31333. };
  31334. }
  31335. declare module "babylonjs/Materials/material.detailMapConfiguration" {
  31336. import { Nullable } from "babylonjs/types";
  31337. import { Scene } from "babylonjs/scene";
  31338. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  31339. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  31340. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  31341. /**
  31342. * @hidden
  31343. */
  31344. export interface IMaterialDetailMapDefines {
  31345. DETAIL: boolean;
  31346. DETAILDIRECTUV: number;
  31347. DETAIL_NORMALBLENDMETHOD: number;
  31348. /** @hidden */
  31349. _areTexturesDirty: boolean;
  31350. }
  31351. /**
  31352. * Define the code related to the detail map parameters of a material
  31353. *
  31354. * Inspired from:
  31355. * Unity: https://docs.unity3d.com/Packages/com.unity.render-pipelines.high-definition@9.0/manual/Mask-Map-and-Detail-Map.html and https://docs.unity3d.com/Manual/StandardShaderMaterialParameterDetail.html
  31356. * Unreal: https://docs.unrealengine.com/en-US/Engine/Rendering/Materials/HowTo/DetailTexturing/index.html
  31357. * Cryengine: https://docs.cryengine.com/display/SDKDOC2/Detail+Maps
  31358. */
  31359. export class DetailMapConfiguration {
  31360. private _texture;
  31361. /**
  31362. * The detail texture of the material.
  31363. */
  31364. texture: Nullable<BaseTexture>;
  31365. /**
  31366. * Defines how strongly the detail diffuse/albedo channel is blended with the regular diffuse/albedo texture
  31367. * Bigger values mean stronger blending
  31368. */
  31369. diffuseBlendLevel: number;
  31370. /**
  31371. * Defines how strongly the detail roughness channel is blended with the regular roughness value
  31372. * Bigger values mean stronger blending. Only used with PBR materials
  31373. */
  31374. roughnessBlendLevel: number;
  31375. /**
  31376. * Defines how strong the bump effect from the detail map is
  31377. * Bigger values mean stronger effect
  31378. */
  31379. bumpLevel: number;
  31380. private _normalBlendMethod;
  31381. /**
  31382. * The method used to blend the bump and detail normals together
  31383. */
  31384. normalBlendMethod: number;
  31385. private _isEnabled;
  31386. /**
  31387. * Enable or disable the detail map on this material
  31388. */
  31389. isEnabled: boolean;
  31390. /** @hidden */
  31391. private _internalMarkAllSubMeshesAsTexturesDirty;
  31392. /** @hidden */
  31393. _markAllSubMeshesAsTexturesDirty(): void;
  31394. /**
  31395. * Instantiate a new detail map
  31396. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  31397. */
  31398. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  31399. /**
  31400. * Gets whether the submesh is ready to be used or not.
  31401. * @param defines the list of "defines" to update.
  31402. * @param scene defines the scene the material belongs to.
  31403. * @returns - boolean indicating that the submesh is ready or not.
  31404. */
  31405. isReadyForSubMesh(defines: IMaterialDetailMapDefines, scene: Scene): boolean;
  31406. /**
  31407. * Update the defines for detail map usage
  31408. * @param defines the list of "defines" to update.
  31409. * @param scene defines the scene the material belongs to.
  31410. */
  31411. prepareDefines(defines: IMaterialDetailMapDefines, scene: Scene): void;
  31412. /**
  31413. * Binds the material data.
  31414. * @param uniformBuffer defines the Uniform buffer to fill in.
  31415. * @param scene defines the scene the material belongs to.
  31416. * @param isFrozen defines whether the material is frozen or not.
  31417. */
  31418. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  31419. /**
  31420. * Checks to see if a texture is used in the material.
  31421. * @param texture - Base texture to use.
  31422. * @returns - Boolean specifying if a texture is used in the material.
  31423. */
  31424. hasTexture(texture: BaseTexture): boolean;
  31425. /**
  31426. * Returns an array of the actively used textures.
  31427. * @param activeTextures Array of BaseTextures
  31428. */
  31429. getActiveTextures(activeTextures: BaseTexture[]): void;
  31430. /**
  31431. * Returns the animatable textures.
  31432. * @param animatables Array of animatable textures.
  31433. */
  31434. getAnimatables(animatables: IAnimatable[]): void;
  31435. /**
  31436. * Disposes the resources of the material.
  31437. * @param forceDisposeTextures - Forces the disposal of all textures.
  31438. */
  31439. dispose(forceDisposeTextures?: boolean): void;
  31440. /**
  31441. * Get the current class name useful for serialization or dynamic coding.
  31442. * @returns "DetailMap"
  31443. */
  31444. getClassName(): string;
  31445. /**
  31446. * Add the required uniforms to the current list.
  31447. * @param uniforms defines the current uniform list.
  31448. */
  31449. static AddUniforms(uniforms: string[]): void;
  31450. /**
  31451. * Add the required samplers to the current list.
  31452. * @param samplers defines the current sampler list.
  31453. */
  31454. static AddSamplers(samplers: string[]): void;
  31455. /**
  31456. * Add the required uniforms to the current buffer.
  31457. * @param uniformBuffer defines the current uniform buffer.
  31458. */
  31459. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  31460. /**
  31461. * Makes a duplicate of the current instance into another one.
  31462. * @param detailMap define the instance where to copy the info
  31463. */
  31464. copyTo(detailMap: DetailMapConfiguration): void;
  31465. /**
  31466. * Serializes this detail map instance
  31467. * @returns - An object with the serialized instance.
  31468. */
  31469. serialize(): any;
  31470. /**
  31471. * Parses a detail map setting from a serialized object.
  31472. * @param source - Serialized object.
  31473. * @param scene Defines the scene we are parsing for
  31474. * @param rootUrl Defines the rootUrl to load from
  31475. */
  31476. parse(source: any, scene: Scene, rootUrl: string): void;
  31477. }
  31478. }
  31479. declare module "babylonjs/Materials/standardMaterial" {
  31480. import { SmartArray } from "babylonjs/Misc/smartArray";
  31481. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  31482. import { Nullable } from "babylonjs/types";
  31483. import { Scene } from "babylonjs/scene";
  31484. import { Matrix } from "babylonjs/Maths/math.vector";
  31485. import { Color3 } from "babylonjs/Maths/math.color";
  31486. import { SubMesh } from "babylonjs/Meshes/subMesh";
  31487. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  31488. import { Mesh } from "babylonjs/Meshes/mesh";
  31489. import { ImageProcessingConfiguration, IImageProcessingConfigurationDefines } from "babylonjs/Materials/imageProcessingConfiguration";
  31490. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  31491. import { FresnelParameters } from "babylonjs/Materials/fresnelParameters";
  31492. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  31493. import { PushMaterial } from "babylonjs/Materials/pushMaterial";
  31494. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  31495. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  31496. import "babylonjs/Shaders/default.fragment";
  31497. import "babylonjs/Shaders/default.vertex";
  31498. import { IMaterialDetailMapDefines, DetailMapConfiguration } from "babylonjs/Materials/material.detailMapConfiguration";
  31499. /** @hidden */
  31500. export class StandardMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines, IMaterialDetailMapDefines {
  31501. MAINUV1: boolean;
  31502. MAINUV2: boolean;
  31503. DIFFUSE: boolean;
  31504. DIFFUSEDIRECTUV: number;
  31505. DETAIL: boolean;
  31506. DETAILDIRECTUV: number;
  31507. DETAIL_NORMALBLENDMETHOD: number;
  31508. AMBIENT: boolean;
  31509. AMBIENTDIRECTUV: number;
  31510. OPACITY: boolean;
  31511. OPACITYDIRECTUV: number;
  31512. OPACITYRGB: boolean;
  31513. REFLECTION: boolean;
  31514. EMISSIVE: boolean;
  31515. EMISSIVEDIRECTUV: number;
  31516. SPECULAR: boolean;
  31517. SPECULARDIRECTUV: number;
  31518. BUMP: boolean;
  31519. BUMPDIRECTUV: number;
  31520. PARALLAX: boolean;
  31521. PARALLAXOCCLUSION: boolean;
  31522. SPECULAROVERALPHA: boolean;
  31523. CLIPPLANE: boolean;
  31524. CLIPPLANE2: boolean;
  31525. CLIPPLANE3: boolean;
  31526. CLIPPLANE4: boolean;
  31527. CLIPPLANE5: boolean;
  31528. CLIPPLANE6: boolean;
  31529. ALPHATEST: boolean;
  31530. DEPTHPREPASS: boolean;
  31531. ALPHAFROMDIFFUSE: boolean;
  31532. POINTSIZE: boolean;
  31533. FOG: boolean;
  31534. SPECULARTERM: boolean;
  31535. DIFFUSEFRESNEL: boolean;
  31536. OPACITYFRESNEL: boolean;
  31537. REFLECTIONFRESNEL: boolean;
  31538. REFRACTIONFRESNEL: boolean;
  31539. EMISSIVEFRESNEL: boolean;
  31540. FRESNEL: boolean;
  31541. NORMAL: boolean;
  31542. UV1: boolean;
  31543. UV2: boolean;
  31544. VERTEXCOLOR: boolean;
  31545. VERTEXALPHA: boolean;
  31546. NUM_BONE_INFLUENCERS: number;
  31547. BonesPerMesh: number;
  31548. BONETEXTURE: boolean;
  31549. INSTANCES: boolean;
  31550. THIN_INSTANCES: boolean;
  31551. GLOSSINESS: boolean;
  31552. ROUGHNESS: boolean;
  31553. EMISSIVEASILLUMINATION: boolean;
  31554. LINKEMISSIVEWITHDIFFUSE: boolean;
  31555. REFLECTIONFRESNELFROMSPECULAR: boolean;
  31556. LIGHTMAP: boolean;
  31557. LIGHTMAPDIRECTUV: number;
  31558. OBJECTSPACE_NORMALMAP: boolean;
  31559. USELIGHTMAPASSHADOWMAP: boolean;
  31560. REFLECTIONMAP_3D: boolean;
  31561. REFLECTIONMAP_SPHERICAL: boolean;
  31562. REFLECTIONMAP_PLANAR: boolean;
  31563. REFLECTIONMAP_CUBIC: boolean;
  31564. USE_LOCAL_REFLECTIONMAP_CUBIC: boolean;
  31565. REFLECTIONMAP_PROJECTION: boolean;
  31566. REFLECTIONMAP_SKYBOX: boolean;
  31567. REFLECTIONMAP_EXPLICIT: boolean;
  31568. REFLECTIONMAP_EQUIRECTANGULAR: boolean;
  31569. REFLECTIONMAP_EQUIRECTANGULAR_FIXED: boolean;
  31570. REFLECTIONMAP_MIRROREDEQUIRECTANGULAR_FIXED: boolean;
  31571. INVERTCUBICMAP: boolean;
  31572. LOGARITHMICDEPTH: boolean;
  31573. REFRACTION: boolean;
  31574. REFRACTIONMAP_3D: boolean;
  31575. REFLECTIONOVERALPHA: boolean;
  31576. TWOSIDEDLIGHTING: boolean;
  31577. SHADOWFLOAT: boolean;
  31578. MORPHTARGETS: boolean;
  31579. MORPHTARGETS_NORMAL: boolean;
  31580. MORPHTARGETS_TANGENT: boolean;
  31581. MORPHTARGETS_UV: boolean;
  31582. NUM_MORPH_INFLUENCERS: number;
  31583. NONUNIFORMSCALING: boolean;
  31584. PREMULTIPLYALPHA: boolean;
  31585. ALPHATEST_AFTERALLALPHACOMPUTATIONS: boolean;
  31586. ALPHABLEND: boolean;
  31587. PREPASS: boolean;
  31588. SCENE_MRT_COUNT: number;
  31589. RGBDLIGHTMAP: boolean;
  31590. RGBDREFLECTION: boolean;
  31591. RGBDREFRACTION: boolean;
  31592. IMAGEPROCESSING: boolean;
  31593. VIGNETTE: boolean;
  31594. VIGNETTEBLENDMODEMULTIPLY: boolean;
  31595. VIGNETTEBLENDMODEOPAQUE: boolean;
  31596. TONEMAPPING: boolean;
  31597. TONEMAPPING_ACES: boolean;
  31598. CONTRAST: boolean;
  31599. COLORCURVES: boolean;
  31600. COLORGRADING: boolean;
  31601. COLORGRADING3D: boolean;
  31602. SAMPLER3DGREENDEPTH: boolean;
  31603. SAMPLER3DBGRMAP: boolean;
  31604. IMAGEPROCESSINGPOSTPROCESS: boolean;
  31605. MULTIVIEW: boolean;
  31606. /**
  31607. * If the reflection texture on this material is in linear color space
  31608. * @hidden
  31609. */
  31610. IS_REFLECTION_LINEAR: boolean;
  31611. /**
  31612. * If the refraction texture on this material is in linear color space
  31613. * @hidden
  31614. */
  31615. IS_REFRACTION_LINEAR: boolean;
  31616. EXPOSURE: boolean;
  31617. constructor();
  31618. setReflectionMode(modeToEnable: string): void;
  31619. }
  31620. /**
  31621. * This is the default material used in Babylon. It is the best trade off between quality
  31622. * and performances.
  31623. * @see https://doc.babylonjs.com/babylon101/materials
  31624. */
  31625. export class StandardMaterial extends PushMaterial {
  31626. private _diffuseTexture;
  31627. /**
  31628. * The basic texture of the material as viewed under a light.
  31629. */
  31630. diffuseTexture: Nullable<BaseTexture>;
  31631. private _ambientTexture;
  31632. /**
  31633. * AKA Occlusion Texture in other nomenclature, it helps adding baked shadows into your material.
  31634. */
  31635. ambientTexture: Nullable<BaseTexture>;
  31636. private _opacityTexture;
  31637. /**
  31638. * Define the transparency of the material from a texture.
  31639. * The final alpha value can be read either from the red channel (if texture.getAlphaFromRGB is false)
  31640. * or from the luminance or the current texel (if texture.getAlphaFromRGB is true)
  31641. */
  31642. opacityTexture: Nullable<BaseTexture>;
  31643. private _reflectionTexture;
  31644. /**
  31645. * Define the texture used to display the reflection.
  31646. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  31647. */
  31648. reflectionTexture: Nullable<BaseTexture>;
  31649. private _emissiveTexture;
  31650. /**
  31651. * Define texture of the material as if self lit.
  31652. * This will be mixed in the final result even in the absence of light.
  31653. */
  31654. emissiveTexture: Nullable<BaseTexture>;
  31655. private _specularTexture;
  31656. /**
  31657. * Define how the color and intensity of the highlight given by the light in the material.
  31658. */
  31659. specularTexture: Nullable<BaseTexture>;
  31660. private _bumpTexture;
  31661. /**
  31662. * Bump mapping is a technique to simulate bump and dents on a rendered surface.
  31663. * These are made by creating a normal map from an image. The means to do this can be found on the web, a search for 'normal map generator' will bring up free and paid for methods of doing this.
  31664. * @see https://doc.babylonjs.com/how_to/more_materials#bump-map
  31665. */
  31666. bumpTexture: Nullable<BaseTexture>;
  31667. private _lightmapTexture;
  31668. /**
  31669. * Complex lighting can be computationally expensive to compute at runtime.
  31670. * To save on computation, lightmaps may be used to store calculated lighting in a texture which will be applied to a given mesh.
  31671. * @see https://doc.babylonjs.com/babylon101/lights#lightmaps
  31672. */
  31673. lightmapTexture: Nullable<BaseTexture>;
  31674. private _refractionTexture;
  31675. /**
  31676. * Define the texture used to display the refraction.
  31677. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  31678. */
  31679. refractionTexture: Nullable<BaseTexture>;
  31680. /**
  31681. * The color of the material lit by the environmental background lighting.
  31682. * @see https://doc.babylonjs.com/babylon101/materials#ambient-color-example
  31683. */
  31684. ambientColor: Color3;
  31685. /**
  31686. * The basic color of the material as viewed under a light.
  31687. */
  31688. diffuseColor: Color3;
  31689. /**
  31690. * Define how the color and intensity of the highlight given by the light in the material.
  31691. */
  31692. specularColor: Color3;
  31693. /**
  31694. * Define the color of the material as if self lit.
  31695. * This will be mixed in the final result even in the absence of light.
  31696. */
  31697. emissiveColor: Color3;
  31698. /**
  31699. * Defines how sharp are the highlights in the material.
  31700. * The bigger the value the sharper giving a more glossy feeling to the result.
  31701. * Reversely, the smaller the value the blurrier giving a more rough feeling to the result.
  31702. */
  31703. specularPower: number;
  31704. private _useAlphaFromDiffuseTexture;
  31705. /**
  31706. * Does the transparency come from the diffuse texture alpha channel.
  31707. */
  31708. useAlphaFromDiffuseTexture: boolean;
  31709. private _useEmissiveAsIllumination;
  31710. /**
  31711. * If true, the emissive value is added into the end result, otherwise it is multiplied in.
  31712. */
  31713. useEmissiveAsIllumination: boolean;
  31714. private _linkEmissiveWithDiffuse;
  31715. /**
  31716. * If true, some kind of energy conservation will prevent the end result to be more than 1 by reducing
  31717. * the emissive level when the final color is close to one.
  31718. */
  31719. linkEmissiveWithDiffuse: boolean;
  31720. private _useSpecularOverAlpha;
  31721. /**
  31722. * Specifies that the material will keep the specular highlights over a transparent surface (only the most limunous ones).
  31723. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  31724. */
  31725. useSpecularOverAlpha: boolean;
  31726. private _useReflectionOverAlpha;
  31727. /**
  31728. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  31729. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  31730. */
  31731. useReflectionOverAlpha: boolean;
  31732. private _disableLighting;
  31733. /**
  31734. * Does lights from the scene impacts this material.
  31735. * It can be a nice trick for performance to disable lighting on a fully emissive material.
  31736. */
  31737. disableLighting: boolean;
  31738. private _useObjectSpaceNormalMap;
  31739. /**
  31740. * Allows using an object space normal map (instead of tangent space).
  31741. */
  31742. useObjectSpaceNormalMap: boolean;
  31743. private _useParallax;
  31744. /**
  31745. * Is parallax enabled or not.
  31746. * @see https://doc.babylonjs.com/how_to/using_parallax_mapping
  31747. */
  31748. useParallax: boolean;
  31749. private _useParallaxOcclusion;
  31750. /**
  31751. * Is parallax occlusion enabled or not.
  31752. * If true, the outcome is way more realistic than traditional Parallax but you can expect a performance hit that worthes consideration.
  31753. * @see https://doc.babylonjs.com/how_to/using_parallax_mapping
  31754. */
  31755. useParallaxOcclusion: boolean;
  31756. /**
  31757. * Apply a scaling factor that determine which "depth" the height map should reprensent. A value between 0.05 and 0.1 is reasonnable in Parallax, you can reach 0.2 using Parallax Occlusion.
  31758. */
  31759. parallaxScaleBias: number;
  31760. private _roughness;
  31761. /**
  31762. * Helps to define how blurry the reflections should appears in the material.
  31763. */
  31764. roughness: number;
  31765. /**
  31766. * In case of refraction, define the value of the index of refraction.
  31767. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  31768. */
  31769. indexOfRefraction: number;
  31770. /**
  31771. * Invert the refraction texture alongside the y axis.
  31772. * It can be useful with procedural textures or probe for instance.
  31773. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  31774. */
  31775. invertRefractionY: boolean;
  31776. /**
  31777. * Defines the alpha limits in alpha test mode.
  31778. */
  31779. alphaCutOff: number;
  31780. private _useLightmapAsShadowmap;
  31781. /**
  31782. * In case of light mapping, define whether the map contains light or shadow informations.
  31783. */
  31784. useLightmapAsShadowmap: boolean;
  31785. private _diffuseFresnelParameters;
  31786. /**
  31787. * Define the diffuse fresnel parameters of the material.
  31788. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  31789. */
  31790. diffuseFresnelParameters: FresnelParameters;
  31791. private _opacityFresnelParameters;
  31792. /**
  31793. * Define the opacity fresnel parameters of the material.
  31794. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  31795. */
  31796. opacityFresnelParameters: FresnelParameters;
  31797. private _reflectionFresnelParameters;
  31798. /**
  31799. * Define the reflection fresnel parameters of the material.
  31800. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  31801. */
  31802. reflectionFresnelParameters: FresnelParameters;
  31803. private _refractionFresnelParameters;
  31804. /**
  31805. * Define the refraction fresnel parameters of the material.
  31806. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  31807. */
  31808. refractionFresnelParameters: FresnelParameters;
  31809. private _emissiveFresnelParameters;
  31810. /**
  31811. * Define the emissive fresnel parameters of the material.
  31812. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  31813. */
  31814. emissiveFresnelParameters: FresnelParameters;
  31815. private _useReflectionFresnelFromSpecular;
  31816. /**
  31817. * If true automatically deducts the fresnels values from the material specularity.
  31818. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  31819. */
  31820. useReflectionFresnelFromSpecular: boolean;
  31821. private _useGlossinessFromSpecularMapAlpha;
  31822. /**
  31823. * Defines if the glossiness/roughness of the material should be read from the specular map alpha channel
  31824. */
  31825. useGlossinessFromSpecularMapAlpha: boolean;
  31826. private _maxSimultaneousLights;
  31827. /**
  31828. * Defines the maximum number of lights that can be used in the material
  31829. */
  31830. maxSimultaneousLights: number;
  31831. private _invertNormalMapX;
  31832. /**
  31833. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  31834. */
  31835. invertNormalMapX: boolean;
  31836. private _invertNormalMapY;
  31837. /**
  31838. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  31839. */
  31840. invertNormalMapY: boolean;
  31841. private _twoSidedLighting;
  31842. /**
  31843. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  31844. */
  31845. twoSidedLighting: boolean;
  31846. /**
  31847. * Default configuration related to image processing available in the standard Material.
  31848. */
  31849. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  31850. /**
  31851. * Gets the image processing configuration used either in this material.
  31852. */
  31853. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  31854. /**
  31855. * Sets the Default image processing configuration used either in the this material.
  31856. *
  31857. * If sets to null, the scene one is in use.
  31858. */
  31859. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  31860. /**
  31861. * Keep track of the image processing observer to allow dispose and replace.
  31862. */
  31863. private _imageProcessingObserver;
  31864. /**
  31865. * Attaches a new image processing configuration to the Standard Material.
  31866. * @param configuration
  31867. */
  31868. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  31869. /**
  31870. * Gets wether the color curves effect is enabled.
  31871. */
  31872. get cameraColorCurvesEnabled(): boolean;
  31873. /**
  31874. * Sets wether the color curves effect is enabled.
  31875. */
  31876. set cameraColorCurvesEnabled(value: boolean);
  31877. /**
  31878. * Gets wether the color grading effect is enabled.
  31879. */
  31880. get cameraColorGradingEnabled(): boolean;
  31881. /**
  31882. * Gets wether the color grading effect is enabled.
  31883. */
  31884. set cameraColorGradingEnabled(value: boolean);
  31885. /**
  31886. * Gets wether tonemapping is enabled or not.
  31887. */
  31888. get cameraToneMappingEnabled(): boolean;
  31889. /**
  31890. * Sets wether tonemapping is enabled or not
  31891. */
  31892. set cameraToneMappingEnabled(value: boolean);
  31893. /**
  31894. * The camera exposure used on this material.
  31895. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  31896. * This corresponds to a photographic exposure.
  31897. */
  31898. get cameraExposure(): number;
  31899. /**
  31900. * The camera exposure used on this material.
  31901. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  31902. * This corresponds to a photographic exposure.
  31903. */
  31904. set cameraExposure(value: number);
  31905. /**
  31906. * Gets The camera contrast used on this material.
  31907. */
  31908. get cameraContrast(): number;
  31909. /**
  31910. * Sets The camera contrast used on this material.
  31911. */
  31912. set cameraContrast(value: number);
  31913. /**
  31914. * Gets the Color Grading 2D Lookup Texture.
  31915. */
  31916. get cameraColorGradingTexture(): Nullable<BaseTexture>;
  31917. /**
  31918. * Sets the Color Grading 2D Lookup Texture.
  31919. */
  31920. set cameraColorGradingTexture(value: Nullable<BaseTexture>);
  31921. /**
  31922. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  31923. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  31924. * These are similar to controls found in many professional imaging or colorist software. The global controls are applied to the entire image. For advanced tuning, extra controls are provided to adjust the shadow, midtone and highlight areas of the image;
  31925. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  31926. */
  31927. get cameraColorCurves(): Nullable<ColorCurves>;
  31928. /**
  31929. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  31930. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  31931. * These are similar to controls found in many professional imaging or colorist software. The global controls are applied to the entire image. For advanced tuning, extra controls are provided to adjust the shadow, midtone and highlight areas of the image;
  31932. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  31933. */
  31934. set cameraColorCurves(value: Nullable<ColorCurves>);
  31935. /**
  31936. * Can this material render to several textures at once
  31937. */
  31938. get canRenderToMRT(): boolean;
  31939. /**
  31940. * Defines the detail map parameters for the material.
  31941. */
  31942. readonly detailMap: DetailMapConfiguration;
  31943. protected _renderTargets: SmartArray<RenderTargetTexture>;
  31944. protected _worldViewProjectionMatrix: Matrix;
  31945. protected _globalAmbientColor: Color3;
  31946. protected _useLogarithmicDepth: boolean;
  31947. protected _rebuildInParallel: boolean;
  31948. /**
  31949. * Instantiates a new standard material.
  31950. * This is the default material used in Babylon. It is the best trade off between quality
  31951. * and performances.
  31952. * @see https://doc.babylonjs.com/babylon101/materials
  31953. * @param name Define the name of the material in the scene
  31954. * @param scene Define the scene the material belong to
  31955. */
  31956. constructor(name: string, scene: Scene);
  31957. /**
  31958. * Gets a boolean indicating that current material needs to register RTT
  31959. */
  31960. get hasRenderTargetTextures(): boolean;
  31961. /**
  31962. * Gets the current class name of the material e.g. "StandardMaterial"
  31963. * Mainly use in serialization.
  31964. * @returns the class name
  31965. */
  31966. getClassName(): string;
  31967. /**
  31968. * In case the depth buffer does not allow enough depth precision for your scene (might be the case in large scenes)
  31969. * You can try switching to logarithmic depth.
  31970. * @see https://doc.babylonjs.com/how_to/using_logarithmic_depth_buffer
  31971. */
  31972. get useLogarithmicDepth(): boolean;
  31973. set useLogarithmicDepth(value: boolean);
  31974. /**
  31975. * Specifies if the material will require alpha blending
  31976. * @returns a boolean specifying if alpha blending is needed
  31977. */
  31978. needAlphaBlending(): boolean;
  31979. /**
  31980. * Specifies if this material should be rendered in alpha test mode
  31981. * @returns a boolean specifying if an alpha test is needed.
  31982. */
  31983. needAlphaTesting(): boolean;
  31984. protected _shouldUseAlphaFromDiffuseTexture(): boolean;
  31985. /**
  31986. * Get the texture used for alpha test purpose.
  31987. * @returns the diffuse texture in case of the standard material.
  31988. */
  31989. getAlphaTestTexture(): Nullable<BaseTexture>;
  31990. /**
  31991. * Get if the submesh is ready to be used and all its information available.
  31992. * Child classes can use it to update shaders
  31993. * @param mesh defines the mesh to check
  31994. * @param subMesh defines which submesh to check
  31995. * @param useInstances specifies that instances should be used
  31996. * @returns a boolean indicating that the submesh is ready or not
  31997. */
  31998. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  31999. /**
  32000. * Builds the material UBO layouts.
  32001. * Used internally during the effect preparation.
  32002. */
  32003. buildUniformLayout(): void;
  32004. /**
  32005. * Unbinds the material from the mesh
  32006. */
  32007. unbind(): void;
  32008. /**
  32009. * Binds the submesh to this material by preparing the effect and shader to draw
  32010. * @param world defines the world transformation matrix
  32011. * @param mesh defines the mesh containing the submesh
  32012. * @param subMesh defines the submesh to bind the material to
  32013. */
  32014. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  32015. /**
  32016. * Get the list of animatables in the material.
  32017. * @returns the list of animatables object used in the material
  32018. */
  32019. getAnimatables(): IAnimatable[];
  32020. /**
  32021. * Gets the active textures from the material
  32022. * @returns an array of textures
  32023. */
  32024. getActiveTextures(): BaseTexture[];
  32025. /**
  32026. * Specifies if the material uses a texture
  32027. * @param texture defines the texture to check against the material
  32028. * @returns a boolean specifying if the material uses the texture
  32029. */
  32030. hasTexture(texture: BaseTexture): boolean;
  32031. /**
  32032. * Disposes the material
  32033. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  32034. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  32035. */
  32036. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  32037. /**
  32038. * Makes a duplicate of the material, and gives it a new name
  32039. * @param name defines the new name for the duplicated material
  32040. * @returns the cloned material
  32041. */
  32042. clone(name: string): StandardMaterial;
  32043. /**
  32044. * Serializes this material in a JSON representation
  32045. * @returns the serialized material object
  32046. */
  32047. serialize(): any;
  32048. /**
  32049. * Creates a standard material from parsed material data
  32050. * @param source defines the JSON representation of the material
  32051. * @param scene defines the hosting scene
  32052. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  32053. * @returns a new standard material
  32054. */
  32055. static Parse(source: any, scene: Scene, rootUrl: string): StandardMaterial;
  32056. /**
  32057. * Are diffuse textures enabled in the application.
  32058. */
  32059. static get DiffuseTextureEnabled(): boolean;
  32060. static set DiffuseTextureEnabled(value: boolean);
  32061. /**
  32062. * Are detail textures enabled in the application.
  32063. */
  32064. static get DetailTextureEnabled(): boolean;
  32065. static set DetailTextureEnabled(value: boolean);
  32066. /**
  32067. * Are ambient textures enabled in the application.
  32068. */
  32069. static get AmbientTextureEnabled(): boolean;
  32070. static set AmbientTextureEnabled(value: boolean);
  32071. /**
  32072. * Are opacity textures enabled in the application.
  32073. */
  32074. static get OpacityTextureEnabled(): boolean;
  32075. static set OpacityTextureEnabled(value: boolean);
  32076. /**
  32077. * Are reflection textures enabled in the application.
  32078. */
  32079. static get ReflectionTextureEnabled(): boolean;
  32080. static set ReflectionTextureEnabled(value: boolean);
  32081. /**
  32082. * Are emissive textures enabled in the application.
  32083. */
  32084. static get EmissiveTextureEnabled(): boolean;
  32085. static set EmissiveTextureEnabled(value: boolean);
  32086. /**
  32087. * Are specular textures enabled in the application.
  32088. */
  32089. static get SpecularTextureEnabled(): boolean;
  32090. static set SpecularTextureEnabled(value: boolean);
  32091. /**
  32092. * Are bump textures enabled in the application.
  32093. */
  32094. static get BumpTextureEnabled(): boolean;
  32095. static set BumpTextureEnabled(value: boolean);
  32096. /**
  32097. * Are lightmap textures enabled in the application.
  32098. */
  32099. static get LightmapTextureEnabled(): boolean;
  32100. static set LightmapTextureEnabled(value: boolean);
  32101. /**
  32102. * Are refraction textures enabled in the application.
  32103. */
  32104. static get RefractionTextureEnabled(): boolean;
  32105. static set RefractionTextureEnabled(value: boolean);
  32106. /**
  32107. * Are color grading textures enabled in the application.
  32108. */
  32109. static get ColorGradingTextureEnabled(): boolean;
  32110. static set ColorGradingTextureEnabled(value: boolean);
  32111. /**
  32112. * Are fresnels enabled in the application.
  32113. */
  32114. static get FresnelEnabled(): boolean;
  32115. static set FresnelEnabled(value: boolean);
  32116. }
  32117. }
  32118. declare module "babylonjs/Particles/solidParticleSystem" {
  32119. import { Nullable } from "babylonjs/types";
  32120. import { Mesh } from "babylonjs/Meshes/mesh";
  32121. import { Scene, IDisposable } from "babylonjs/scene";
  32122. import { DepthSortedParticle, SolidParticle, SolidParticleVertex } from "babylonjs/Particles/solidParticle";
  32123. import { Material } from "babylonjs/Materials/material";
  32124. import { MultiMaterial } from "babylonjs/Materials/multiMaterial";
  32125. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  32126. /**
  32127. * The SPS is a single updatable mesh. The solid particles are simply separate parts or faces fo this big mesh.
  32128. *As it is just a mesh, the SPS has all the same properties than any other BJS mesh : not more, not less. It can be scaled, rotated, translated, enlighted, textured, moved, etc.
  32129. * The SPS is also a particle system. It provides some methods to manage the particles.
  32130. * However it is behavior agnostic. This means it has no emitter, no particle physics, no particle recycler. You have to implement your own behavior.
  32131. *
  32132. * Full documentation here : https://doc.babylonjs.com/how_to/Solid_Particle_System
  32133. */
  32134. export class SolidParticleSystem implements IDisposable {
  32135. /**
  32136. * The SPS array of Solid Particle objects. Just access each particle as with any classic array.
  32137. * Example : var p = SPS.particles[i];
  32138. */
  32139. particles: SolidParticle[];
  32140. /**
  32141. * The SPS total number of particles. Read only. Use SPS.counter instead if you need to set your own value.
  32142. */
  32143. nbParticles: number;
  32144. /**
  32145. * If the particles must ever face the camera (default false). Useful for planar particles.
  32146. */
  32147. billboard: boolean;
  32148. /**
  32149. * Recompute normals when adding a shape
  32150. */
  32151. recomputeNormals: boolean;
  32152. /**
  32153. * This a counter ofr your own usage. It's not set by any SPS functions.
  32154. */
  32155. counter: number;
  32156. /**
  32157. * The SPS name. This name is also given to the underlying mesh.
  32158. */
  32159. name: string;
  32160. /**
  32161. * The SPS mesh. It's a standard BJS Mesh, so all the methods from the Mesh class are avalaible.
  32162. */
  32163. mesh: Mesh;
  32164. /**
  32165. * This empty object is intended to store some SPS specific or temporary values in order to lower the Garbage Collector activity.
  32166. * Please read : https://doc.babylonjs.com/how_to/Solid_Particle_System#garbage-collector-concerns
  32167. */
  32168. vars: any;
  32169. /**
  32170. * This array is populated when the SPS is set as 'pickable'.
  32171. * Each key of this array is a `faceId` value that you can get from a pickResult object.
  32172. * Each element of this array is an object `{idx: int, faceId: int}`.
  32173. * `idx` is the picked particle index in the `SPS.particles` array
  32174. * `faceId` is the picked face index counted within this particle.
  32175. * This array is the first element of the pickedBySubMesh array : sps.pickBySubMesh[0].
  32176. * It's not pertinent to use it when using a SPS with the support for MultiMaterial enabled.
  32177. * Use the method SPS.pickedParticle(pickingInfo) instead.
  32178. * Please read : https://doc.babylonjs.com/how_to/Solid_Particle_System#pickable-particles
  32179. */
  32180. pickedParticles: {
  32181. idx: number;
  32182. faceId: number;
  32183. }[];
  32184. /**
  32185. * This array is populated when the SPS is set as 'pickable'
  32186. * Each key of this array is a submesh index.
  32187. * Each element of this array is a second array defined like this :
  32188. * Each key of this second array is a `faceId` value that you can get from a pickResult object.
  32189. * Each element of this second array is an object `{idx: int, faceId: int}`.
  32190. * `idx` is the picked particle index in the `SPS.particles` array
  32191. * `faceId` is the picked face index counted within this particle.
  32192. * It's better to use the method SPS.pickedParticle(pickingInfo) rather than using directly this array.
  32193. * Please read : https://doc.babylonjs.com/how_to/Solid_Particle_System#pickable-particles
  32194. */
  32195. pickedBySubMesh: {
  32196. idx: number;
  32197. faceId: number;
  32198. }[][];
  32199. /**
  32200. * This array is populated when `enableDepthSort` is set to true.
  32201. * Each element of this array is an instance of the class DepthSortedParticle.
  32202. */
  32203. depthSortedParticles: DepthSortedParticle[];
  32204. /**
  32205. * If the particle intersection must be computed only with the bounding sphere (no bounding box computation, so faster). (Internal use only)
  32206. * @hidden
  32207. */
  32208. _bSphereOnly: boolean;
  32209. /**
  32210. * A number to multiply the boundind sphere radius by in order to reduce it for instance. (Internal use only)
  32211. * @hidden
  32212. */
  32213. _bSphereRadiusFactor: number;
  32214. private _scene;
  32215. private _positions;
  32216. private _indices;
  32217. private _normals;
  32218. private _colors;
  32219. private _uvs;
  32220. private _indices32;
  32221. private _positions32;
  32222. private _normals32;
  32223. private _fixedNormal32;
  32224. private _colors32;
  32225. private _uvs32;
  32226. private _index;
  32227. private _updatable;
  32228. private _pickable;
  32229. private _isVisibilityBoxLocked;
  32230. private _alwaysVisible;
  32231. private _depthSort;
  32232. private _expandable;
  32233. private _shapeCounter;
  32234. private _copy;
  32235. private _color;
  32236. private _computeParticleColor;
  32237. private _computeParticleTexture;
  32238. private _computeParticleRotation;
  32239. private _computeParticleVertex;
  32240. private _computeBoundingBox;
  32241. private _depthSortParticles;
  32242. private _camera;
  32243. private _mustUnrotateFixedNormals;
  32244. private _particlesIntersect;
  32245. private _needs32Bits;
  32246. private _isNotBuilt;
  32247. private _lastParticleId;
  32248. private _idxOfId;
  32249. private _multimaterialEnabled;
  32250. private _useModelMaterial;
  32251. private _indicesByMaterial;
  32252. private _materialIndexes;
  32253. private _depthSortFunction;
  32254. private _materialSortFunction;
  32255. private _materials;
  32256. private _multimaterial;
  32257. private _materialIndexesById;
  32258. private _defaultMaterial;
  32259. private _autoUpdateSubMeshes;
  32260. private _tmpVertex;
  32261. /**
  32262. * Creates a SPS (Solid Particle System) object.
  32263. * @param name (String) is the SPS name, this will be the underlying mesh name.
  32264. * @param scene (Scene) is the scene in which the SPS is added.
  32265. * @param options defines the options of the sps e.g.
  32266. * * updatable (optional boolean, default true) : if the SPS must be updatable or immutable.
  32267. * * isPickable (optional boolean, default false) : if the solid particles must be pickable.
  32268. * * enableDepthSort (optional boolean, default false) : if the solid particles must be sorted in the geometry according to their distance to the camera.
  32269. * * useModelMaterial (optional boolean, defaut false) : if the model materials must be used to create the SPS multimaterial. This enables the multimaterial supports of the SPS.
  32270. * * enableMultiMaterial (optional boolean, default false) : if the solid particles can be given different materials.
  32271. * * expandable (optional boolean, default false) : if particles can still be added after the initial SPS mesh creation.
  32272. * * particleIntersection (optional boolean, default false) : if the solid particle intersections must be computed.
  32273. * * boundingSphereOnly (optional boolean, default false) : if the particle intersection must be computed only with the bounding sphere (no bounding box computation, so faster).
  32274. * * bSphereRadiusFactor (optional float, default 1.0) : a number to multiply the boundind sphere radius by in order to reduce it for instance.
  32275. * @example bSphereRadiusFactor = 1.0 / Math.sqrt(3.0) => the bounding sphere exactly matches a spherical mesh.
  32276. */
  32277. constructor(name: string, scene: Scene, options?: {
  32278. updatable?: boolean;
  32279. isPickable?: boolean;
  32280. enableDepthSort?: boolean;
  32281. particleIntersection?: boolean;
  32282. boundingSphereOnly?: boolean;
  32283. bSphereRadiusFactor?: number;
  32284. expandable?: boolean;
  32285. useModelMaterial?: boolean;
  32286. enableMultiMaterial?: boolean;
  32287. });
  32288. /**
  32289. * Builds the SPS underlying mesh. Returns a standard Mesh.
  32290. * If no model shape was added to the SPS, the returned mesh is just a single triangular plane.
  32291. * @returns the created mesh
  32292. */
  32293. buildMesh(): Mesh;
  32294. /**
  32295. * Digests the mesh and generates as many solid particles in the system as wanted. Returns the SPS.
  32296. * These particles will have the same geometry than the mesh parts and will be positioned at the same localisation than the mesh original places.
  32297. * Thus the particles generated from `digest()` have their property `position` set yet.
  32298. * @param mesh ( Mesh ) is the mesh to be digested
  32299. * @param options {facetNb} (optional integer, default 1) is the number of mesh facets per particle, this parameter is overriden by the parameter `number` if any
  32300. * {delta} (optional integer, default 0) is the random extra number of facets per particle , each particle will have between `facetNb` and `facetNb + delta` facets
  32301. * {number} (optional positive integer) is the wanted number of particles : each particle is built with `mesh_total_facets / number` facets
  32302. * {storage} (optional existing array) is an array where the particles will be stored for a further use instead of being inserted in the SPS.
  32303. * @returns the current SPS
  32304. */
  32305. digest(mesh: Mesh, options?: {
  32306. facetNb?: number;
  32307. number?: number;
  32308. delta?: number;
  32309. storage?: [];
  32310. }): SolidParticleSystem;
  32311. /**
  32312. * Unrotate the fixed normals in case the mesh was built with pre-rotated particles, ex : use of positionFunction in addShape()
  32313. * @hidden
  32314. */
  32315. private _unrotateFixedNormals;
  32316. /**
  32317. * Resets the temporary working copy particle
  32318. * @hidden
  32319. */
  32320. private _resetCopy;
  32321. /**
  32322. * Inserts the shape model geometry in the global SPS mesh by updating the positions, indices, normals, colors, uvs arrays
  32323. * @param p the current index in the positions array to be updated
  32324. * @param ind the current index in the indices array
  32325. * @param shape a Vector3 array, the shape geometry
  32326. * @param positions the positions array to be updated
  32327. * @param meshInd the shape indices array
  32328. * @param indices the indices array to be updated
  32329. * @param meshUV the shape uv array
  32330. * @param uvs the uv array to be updated
  32331. * @param meshCol the shape color array
  32332. * @param colors the color array to be updated
  32333. * @param meshNor the shape normals array
  32334. * @param normals the normals array to be updated
  32335. * @param idx the particle index
  32336. * @param idxInShape the particle index in its shape
  32337. * @param options the addShape() method passed options
  32338. * @model the particle model
  32339. * @hidden
  32340. */
  32341. private _meshBuilder;
  32342. /**
  32343. * Returns a shape Vector3 array from positions float array
  32344. * @param positions float array
  32345. * @returns a vector3 array
  32346. * @hidden
  32347. */
  32348. private _posToShape;
  32349. /**
  32350. * Returns a shapeUV array from a float uvs (array deep copy)
  32351. * @param uvs as a float array
  32352. * @returns a shapeUV array
  32353. * @hidden
  32354. */
  32355. private _uvsToShapeUV;
  32356. /**
  32357. * Adds a new particle object in the particles array
  32358. * @param idx particle index in particles array
  32359. * @param id particle id
  32360. * @param idxpos positionIndex : the starting index of the particle vertices in the SPS "positions" array
  32361. * @param idxind indiceIndex : he starting index of the particle indices in the SPS "indices" array
  32362. * @param model particle ModelShape object
  32363. * @param shapeId model shape identifier
  32364. * @param idxInShape index of the particle in the current model
  32365. * @param bInfo model bounding info object
  32366. * @param storage target storage array, if any
  32367. * @hidden
  32368. */
  32369. private _addParticle;
  32370. /**
  32371. * Adds some particles to the SPS from the model shape. Returns the shape id.
  32372. * Please read the doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#create-an-immutable-sps
  32373. * @param mesh is any Mesh object that will be used as a model for the solid particles.
  32374. * @param nb (positive integer) the number of particles to be created from this model
  32375. * @param options {positionFunction} is an optional javascript function to called for each particle on SPS creation.
  32376. * {vertexFunction} is an optional javascript function to called for each vertex of each particle on SPS creation
  32377. * {storage} (optional existing array) is an array where the particles will be stored for a further use instead of being inserted in the SPS.
  32378. * @returns the number of shapes in the system
  32379. */
  32380. addShape(mesh: Mesh, nb: number, options?: {
  32381. positionFunction?: any;
  32382. vertexFunction?: any;
  32383. storage?: [];
  32384. }): number;
  32385. /**
  32386. * Rebuilds a particle back to its just built status : if needed, recomputes the custom positions and vertices
  32387. * @hidden
  32388. */
  32389. private _rebuildParticle;
  32390. /**
  32391. * Rebuilds the whole mesh and updates the VBO : custom positions and vertices are recomputed if needed.
  32392. * @param reset boolean, default false : if the particles must be reset at position and rotation zero, scaling 1, color white, initial UVs and not parented.
  32393. * @returns the SPS.
  32394. */
  32395. rebuildMesh(reset?: boolean): SolidParticleSystem;
  32396. /** Removes the particles from the start-th to the end-th included from an expandable SPS (required).
  32397. * Returns an array with the removed particles.
  32398. * If the number of particles to remove is lower than zero or greater than the global remaining particle number, then an empty array is returned.
  32399. * The SPS can't be empty so at least one particle needs to remain in place.
  32400. * Under the hood, the VertexData array, so the VBO buffer, is recreated each call.
  32401. * @param start index of the first particle to remove
  32402. * @param end index of the last particle to remove (included)
  32403. * @returns an array populated with the removed particles
  32404. */
  32405. removeParticles(start: number, end: number): SolidParticle[];
  32406. /**
  32407. * Inserts some pre-created particles in the solid particle system so that they can be managed by setParticles().
  32408. * @param solidParticleArray an array populated with Solid Particles objects
  32409. * @returns the SPS
  32410. */
  32411. insertParticlesFromArray(solidParticleArray: SolidParticle[]): SolidParticleSystem;
  32412. /**
  32413. * Creates a new particle and modifies the SPS mesh geometry :
  32414. * - calls _meshBuilder() to increase the SPS mesh geometry step by step
  32415. * - calls _addParticle() to populate the particle array
  32416. * factorized code from addShape() and insertParticlesFromArray()
  32417. * @param idx particle index in the particles array
  32418. * @param i particle index in its shape
  32419. * @param modelShape particle ModelShape object
  32420. * @param shape shape vertex array
  32421. * @param meshInd shape indices array
  32422. * @param meshUV shape uv array
  32423. * @param meshCol shape color array
  32424. * @param meshNor shape normals array
  32425. * @param bbInfo shape bounding info
  32426. * @param storage target particle storage
  32427. * @options addShape() passed options
  32428. * @hidden
  32429. */
  32430. private _insertNewParticle;
  32431. /**
  32432. * Sets all the particles : this method actually really updates the mesh according to the particle positions, rotations, colors, textures, etc.
  32433. * This method calls `updateParticle()` for each particle of the SPS.
  32434. * For an animated SPS, it is usually called within the render loop.
  32435. * This methods does nothing if called on a non updatable or not yet built SPS. Example : buildMesh() not called after having added or removed particles from an expandable SPS.
  32436. * @param start The particle index in the particle array where to start to compute the particle property values _(default 0)_
  32437. * @param end The particle index in the particle array where to stop to compute the particle property values _(default nbParticle - 1)_
  32438. * @param update If the mesh must be finally updated on this call after all the particle computations _(default true)_
  32439. * @returns the SPS.
  32440. */
  32441. setParticles(start?: number, end?: number, update?: boolean): SolidParticleSystem;
  32442. /**
  32443. * Disposes the SPS.
  32444. */
  32445. dispose(): void;
  32446. /** Returns an object {idx: numbern faceId: number} for the picked particle from the passed pickingInfo object.
  32447. * idx is the particle index in the SPS
  32448. * faceId is the picked face index counted within this particle.
  32449. * Returns null if the pickInfo can't identify a picked particle.
  32450. * @param pickingInfo (PickingInfo object)
  32451. * @returns {idx: number, faceId: number} or null
  32452. */
  32453. pickedParticle(pickingInfo: PickingInfo): Nullable<{
  32454. idx: number;
  32455. faceId: number;
  32456. }>;
  32457. /**
  32458. * Returns a SolidParticle object from its identifier : particle.id
  32459. * @param id (integer) the particle Id
  32460. * @returns the searched particle or null if not found in the SPS.
  32461. */
  32462. getParticleById(id: number): Nullable<SolidParticle>;
  32463. /**
  32464. * Returns a new array populated with the particles having the passed shapeId.
  32465. * @param shapeId (integer) the shape identifier
  32466. * @returns a new solid particle array
  32467. */
  32468. getParticlesByShapeId(shapeId: number): SolidParticle[];
  32469. /**
  32470. * Populates the passed array "ref" with the particles having the passed shapeId.
  32471. * @param shapeId the shape identifier
  32472. * @returns the SPS
  32473. * @param ref
  32474. */
  32475. getParticlesByShapeIdToRef(shapeId: number, ref: SolidParticle[]): SolidParticleSystem;
  32476. /**
  32477. * Computes the required SubMeshes according the materials assigned to the particles.
  32478. * @returns the solid particle system.
  32479. * Does nothing if called before the SPS mesh is built.
  32480. */
  32481. computeSubMeshes(): SolidParticleSystem;
  32482. /**
  32483. * Sorts the solid particles by material when MultiMaterial is enabled.
  32484. * Updates the indices32 array.
  32485. * Updates the indicesByMaterial array.
  32486. * Updates the mesh indices array.
  32487. * @returns the SPS
  32488. * @hidden
  32489. */
  32490. private _sortParticlesByMaterial;
  32491. /**
  32492. * Sets the material indexes by id materialIndexesById[id] = materialIndex
  32493. * @hidden
  32494. */
  32495. private _setMaterialIndexesById;
  32496. /**
  32497. * Returns an array with unique values of Materials from the passed array
  32498. * @param array the material array to be checked and filtered
  32499. * @hidden
  32500. */
  32501. private _filterUniqueMaterialId;
  32502. /**
  32503. * Sets a new Standard Material as _defaultMaterial if not already set.
  32504. * @hidden
  32505. */
  32506. private _setDefaultMaterial;
  32507. /**
  32508. * Visibilty helper : Recomputes the visible size according to the mesh bounding box
  32509. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  32510. * @returns the SPS.
  32511. */
  32512. refreshVisibleSize(): SolidParticleSystem;
  32513. /**
  32514. * Visibility helper : Sets the size of a visibility box, this sets the underlying mesh bounding box.
  32515. * @param size the size (float) of the visibility box
  32516. * note : this doesn't lock the SPS mesh bounding box.
  32517. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  32518. */
  32519. setVisibilityBox(size: number): void;
  32520. /**
  32521. * Gets whether the SPS as always visible or not
  32522. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  32523. */
  32524. get isAlwaysVisible(): boolean;
  32525. /**
  32526. * Sets the SPS as always visible or not
  32527. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  32528. */
  32529. set isAlwaysVisible(val: boolean);
  32530. /**
  32531. * Sets the SPS visibility box as locked or not. This enables/disables the underlying mesh bounding box updates.
  32532. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  32533. */
  32534. set isVisibilityBoxLocked(val: boolean);
  32535. /**
  32536. * Gets if the SPS visibility box as locked or not. This enables/disables the underlying mesh bounding box updates.
  32537. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  32538. */
  32539. get isVisibilityBoxLocked(): boolean;
  32540. /**
  32541. * Tells to `setParticles()` to compute the particle rotations or not.
  32542. * Default value : true. The SPS is faster when it's set to false.
  32543. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate.
  32544. */
  32545. set computeParticleRotation(val: boolean);
  32546. /**
  32547. * Tells to `setParticles()` to compute the particle colors or not.
  32548. * Default value : true. The SPS is faster when it's set to false.
  32549. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  32550. */
  32551. set computeParticleColor(val: boolean);
  32552. set computeParticleTexture(val: boolean);
  32553. /**
  32554. * Tells to `setParticles()` to call the vertex function for each vertex of each particle, or not.
  32555. * Default value : false. The SPS is faster when it's set to false.
  32556. * Note : the particle custom vertex positions aren't stored values.
  32557. */
  32558. set computeParticleVertex(val: boolean);
  32559. /**
  32560. * Tells to `setParticles()` to compute or not the mesh bounding box when computing the particle positions.
  32561. */
  32562. set computeBoundingBox(val: boolean);
  32563. /**
  32564. * Tells to `setParticles()` to sort or not the distance between each particle and the camera.
  32565. * Skipped when `enableDepthSort` is set to `false` (default) at construction time.
  32566. * Default : `true`
  32567. */
  32568. set depthSortParticles(val: boolean);
  32569. /**
  32570. * Gets if `setParticles()` computes the particle rotations or not.
  32571. * Default value : true. The SPS is faster when it's set to false.
  32572. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate.
  32573. */
  32574. get computeParticleRotation(): boolean;
  32575. /**
  32576. * Gets if `setParticles()` computes the particle colors or not.
  32577. * Default value : true. The SPS is faster when it's set to false.
  32578. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  32579. */
  32580. get computeParticleColor(): boolean;
  32581. /**
  32582. * Gets if `setParticles()` computes the particle textures or not.
  32583. * Default value : true. The SPS is faster when it's set to false.
  32584. * Note : the particle textures are stored values, so setting `computeParticleTexture` to false will keep yet the last colors set.
  32585. */
  32586. get computeParticleTexture(): boolean;
  32587. /**
  32588. * Gets if `setParticles()` calls the vertex function for each vertex of each particle, or not.
  32589. * Default value : false. The SPS is faster when it's set to false.
  32590. * Note : the particle custom vertex positions aren't stored values.
  32591. */
  32592. get computeParticleVertex(): boolean;
  32593. /**
  32594. * Gets if `setParticles()` computes or not the mesh bounding box when computing the particle positions.
  32595. */
  32596. get computeBoundingBox(): boolean;
  32597. /**
  32598. * Gets if `setParticles()` sorts or not the distance between each particle and the camera.
  32599. * Skipped when `enableDepthSort` is set to `false` (default) at construction time.
  32600. * Default : `true`
  32601. */
  32602. get depthSortParticles(): boolean;
  32603. /**
  32604. * Gets if the SPS is created as expandable at construction time.
  32605. * Default : `false`
  32606. */
  32607. get expandable(): boolean;
  32608. /**
  32609. * Gets if the SPS supports the Multi Materials
  32610. */
  32611. get multimaterialEnabled(): boolean;
  32612. /**
  32613. * Gets if the SPS uses the model materials for its own multimaterial.
  32614. */
  32615. get useModelMaterial(): boolean;
  32616. /**
  32617. * The SPS used material array.
  32618. */
  32619. get materials(): Material[];
  32620. /**
  32621. * Sets the SPS MultiMaterial from the passed materials.
  32622. * Note : the passed array is internally copied and not used then by reference.
  32623. * @param materials an array of material objects. This array indexes are the materialIndex values of the particles.
  32624. */
  32625. setMultiMaterial(materials: Material[]): void;
  32626. /**
  32627. * The SPS computed multimaterial object
  32628. */
  32629. get multimaterial(): MultiMaterial;
  32630. set multimaterial(mm: MultiMaterial);
  32631. /**
  32632. * If the subMeshes must be updated on the next call to setParticles()
  32633. */
  32634. get autoUpdateSubMeshes(): boolean;
  32635. set autoUpdateSubMeshes(val: boolean);
  32636. /**
  32637. * This function does nothing. It may be overwritten to set all the particle first values.
  32638. * The SPS doesn't call this function, you may have to call it by your own.
  32639. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  32640. */
  32641. initParticles(): void;
  32642. /**
  32643. * This function does nothing. It may be overwritten to recycle a particle.
  32644. * The SPS doesn't call this function, you may have to call it by your own.
  32645. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  32646. * @param particle The particle to recycle
  32647. * @returns the recycled particle
  32648. */
  32649. recycleParticle(particle: SolidParticle): SolidParticle;
  32650. /**
  32651. * Updates a particle : this function should be overwritten by the user.
  32652. * It is called on each particle by `setParticles()`. This is the place to code each particle behavior.
  32653. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  32654. * @example : just set a particle position or velocity and recycle conditions
  32655. * @param particle The particle to update
  32656. * @returns the updated particle
  32657. */
  32658. updateParticle(particle: SolidParticle): SolidParticle;
  32659. /**
  32660. * Updates a vertex of a particle : it can be overwritten by the user.
  32661. * This will be called on each vertex particle by `setParticles()` if `computeParticleVertex` is set to true only.
  32662. * @param particle the current particle
  32663. * @param vertex the current vertex of the current particle : a SolidParticleVertex object
  32664. * @param pt the index of the current vertex in the particle shape
  32665. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#update-each-particle-shape
  32666. * @example : just set a vertex particle position or color
  32667. * @returns the sps
  32668. */
  32669. updateParticleVertex(particle: SolidParticle, vertex: SolidParticleVertex, pt: number): SolidParticleSystem;
  32670. /**
  32671. * This will be called before any other treatment by `setParticles()` and will be passed three parameters.
  32672. * This does nothing and may be overwritten by the user.
  32673. * @param start the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  32674. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  32675. * @param update the boolean update value actually passed to setParticles()
  32676. */
  32677. beforeUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  32678. /**
  32679. * This will be called by `setParticles()` after all the other treatments and just before the actual mesh update.
  32680. * This will be passed three parameters.
  32681. * This does nothing and may be overwritten by the user.
  32682. * @param start the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  32683. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  32684. * @param update the boolean update value actually passed to setParticles()
  32685. */
  32686. afterUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  32687. }
  32688. }
  32689. declare module "babylonjs/Particles/solidParticle" {
  32690. import { Nullable } from "babylonjs/types";
  32691. import { Vector3, Matrix, Quaternion, Vector4, Vector2 } from "babylonjs/Maths/math.vector";
  32692. import { Color4 } from "babylonjs/Maths/math.color";
  32693. import { Mesh } from "babylonjs/Meshes/mesh";
  32694. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  32695. import { SolidParticleSystem } from "babylonjs/Particles/solidParticleSystem";
  32696. import { Plane } from "babylonjs/Maths/math.plane";
  32697. import { Material } from "babylonjs/Materials/material";
  32698. /**
  32699. * Represents one particle of a solid particle system.
  32700. */
  32701. export class SolidParticle {
  32702. /**
  32703. * particle global index
  32704. */
  32705. idx: number;
  32706. /**
  32707. * particle identifier
  32708. */
  32709. id: number;
  32710. /**
  32711. * The color of the particle
  32712. */
  32713. color: Nullable<Color4>;
  32714. /**
  32715. * The world space position of the particle.
  32716. */
  32717. position: Vector3;
  32718. /**
  32719. * The world space rotation of the particle. (Not use if rotationQuaternion is set)
  32720. */
  32721. rotation: Vector3;
  32722. /**
  32723. * The world space rotation quaternion of the particle.
  32724. */
  32725. rotationQuaternion: Nullable<Quaternion>;
  32726. /**
  32727. * The scaling of the particle.
  32728. */
  32729. scaling: Vector3;
  32730. /**
  32731. * The uvs of the particle.
  32732. */
  32733. uvs: Vector4;
  32734. /**
  32735. * The current speed of the particle.
  32736. */
  32737. velocity: Vector3;
  32738. /**
  32739. * The pivot point in the particle local space.
  32740. */
  32741. pivot: Vector3;
  32742. /**
  32743. * Must the particle be translated from its pivot point in its local space ?
  32744. * In this case, the pivot point is set at the origin of the particle local space and the particle is translated.
  32745. * Default : false
  32746. */
  32747. translateFromPivot: boolean;
  32748. /**
  32749. * Is the particle active or not ?
  32750. */
  32751. alive: boolean;
  32752. /**
  32753. * Is the particle visible or not ?
  32754. */
  32755. isVisible: boolean;
  32756. /**
  32757. * Index of this particle in the global "positions" array (Internal use)
  32758. * @hidden
  32759. */
  32760. _pos: number;
  32761. /**
  32762. * @hidden Index of this particle in the global "indices" array (Internal use)
  32763. */
  32764. _ind: number;
  32765. /**
  32766. * @hidden ModelShape of this particle (Internal use)
  32767. */
  32768. _model: ModelShape;
  32769. /**
  32770. * ModelShape id of this particle
  32771. */
  32772. shapeId: number;
  32773. /**
  32774. * Index of the particle in its shape id
  32775. */
  32776. idxInShape: number;
  32777. /**
  32778. * @hidden Reference to the shape model BoundingInfo object (Internal use)
  32779. */
  32780. _modelBoundingInfo: BoundingInfo;
  32781. /**
  32782. * @hidden Particle BoundingInfo object (Internal use)
  32783. */
  32784. _boundingInfo: BoundingInfo;
  32785. /**
  32786. * @hidden Reference to the SPS what the particle belongs to (Internal use)
  32787. */
  32788. _sps: SolidParticleSystem;
  32789. /**
  32790. * @hidden Still set as invisible in order to skip useless computations (Internal use)
  32791. */
  32792. _stillInvisible: boolean;
  32793. /**
  32794. * @hidden Last computed particle rotation matrix
  32795. */
  32796. _rotationMatrix: number[];
  32797. /**
  32798. * Parent particle Id, if any.
  32799. * Default null.
  32800. */
  32801. parentId: Nullable<number>;
  32802. /**
  32803. * The particle material identifier (integer) when MultiMaterials are enabled in the SPS.
  32804. */
  32805. materialIndex: Nullable<number>;
  32806. /**
  32807. * Custom object or properties.
  32808. */
  32809. props: Nullable<any>;
  32810. /**
  32811. * The culling strategy to use to check whether the solid particle must be culled or not when using isInFrustum().
  32812. * The possible values are :
  32813. * - AbstractMesh.CULLINGSTRATEGY_STANDARD
  32814. * - AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  32815. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION
  32816. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY
  32817. * The default value for solid particles is AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  32818. * Please read each static variable documentation in the class AbstractMesh to get details about the culling process.
  32819. * */
  32820. cullingStrategy: number;
  32821. /**
  32822. * @hidden Internal global position in the SPS.
  32823. */
  32824. _globalPosition: Vector3;
  32825. /**
  32826. * Creates a Solid Particle object.
  32827. * Don't create particles manually, use instead the Solid Particle System internal tools like _addParticle()
  32828. * @param particleIndex (integer) is the particle index in the Solid Particle System pool.
  32829. * @param particleId (integer) is the particle identifier. Unless some particles are removed from the SPS, it's the same value than the particle idx.
  32830. * @param positionIndex (integer) is the starting index of the particle vertices in the SPS "positions" array.
  32831. * @param indiceIndex (integer) is the starting index of the particle indices in the SPS "indices" array.
  32832. * @param model (ModelShape) is a reference to the model shape on what the particle is designed.
  32833. * @param shapeId (integer) is the model shape identifier in the SPS.
  32834. * @param idxInShape (integer) is the index of the particle in the current model (ex: the 10th box of addShape(box, 30))
  32835. * @param sps defines the sps it is associated to
  32836. * @param modelBoundingInfo is the reference to the model BoundingInfo used for intersection computations.
  32837. * @param materialIndex is the particle material identifier (integer) when the MultiMaterials are enabled in the SPS.
  32838. */
  32839. constructor(particleIndex: number, particleId: number, positionIndex: number, indiceIndex: number, model: Nullable<ModelShape>, shapeId: number, idxInShape: number, sps: SolidParticleSystem, modelBoundingInfo?: Nullable<BoundingInfo>, materialIndex?: Nullable<number>);
  32840. /**
  32841. * Copies the particle property values into the existing target : position, rotation, scaling, uvs, colors, pivot, parent, visibility, alive
  32842. * @param target the particle target
  32843. * @returns the current particle
  32844. */
  32845. copyToRef(target: SolidParticle): SolidParticle;
  32846. /**
  32847. * Legacy support, changed scale to scaling
  32848. */
  32849. get scale(): Vector3;
  32850. /**
  32851. * Legacy support, changed scale to scaling
  32852. */
  32853. set scale(scale: Vector3);
  32854. /**
  32855. * Legacy support, changed quaternion to rotationQuaternion
  32856. */
  32857. get quaternion(): Nullable<Quaternion>;
  32858. /**
  32859. * Legacy support, changed quaternion to rotationQuaternion
  32860. */
  32861. set quaternion(q: Nullable<Quaternion>);
  32862. /**
  32863. * Returns a boolean. True if the particle intersects another particle or another mesh, else false.
  32864. * The intersection is computed on the particle bounding sphere and Axis Aligned Bounding Box (AABB)
  32865. * @param target is the object (solid particle or mesh) what the intersection is computed against.
  32866. * @returns true if it intersects
  32867. */
  32868. intersectsMesh(target: Mesh | SolidParticle): boolean;
  32869. /**
  32870. * Returns `true` if the solid particle is within the frustum defined by the passed array of planes.
  32871. * A particle is in the frustum if its bounding box intersects the frustum
  32872. * @param frustumPlanes defines the frustum to test
  32873. * @returns true if the particle is in the frustum planes
  32874. */
  32875. isInFrustum(frustumPlanes: Plane[]): boolean;
  32876. /**
  32877. * get the rotation matrix of the particle
  32878. * @hidden
  32879. */
  32880. getRotationMatrix(m: Matrix): void;
  32881. }
  32882. /**
  32883. * Represents the shape of the model used by one particle of a solid particle system.
  32884. * SPS internal tool, don't use it manually.
  32885. */
  32886. export class ModelShape {
  32887. /**
  32888. * The shape id
  32889. * @hidden
  32890. */
  32891. shapeID: number;
  32892. /**
  32893. * flat array of model positions (internal use)
  32894. * @hidden
  32895. */
  32896. _shape: Vector3[];
  32897. /**
  32898. * flat array of model UVs (internal use)
  32899. * @hidden
  32900. */
  32901. _shapeUV: number[];
  32902. /**
  32903. * color array of the model
  32904. * @hidden
  32905. */
  32906. _shapeColors: number[];
  32907. /**
  32908. * indices array of the model
  32909. * @hidden
  32910. */
  32911. _indices: number[];
  32912. /**
  32913. * normals array of the model
  32914. * @hidden
  32915. */
  32916. _normals: number[];
  32917. /**
  32918. * length of the shape in the model indices array (internal use)
  32919. * @hidden
  32920. */
  32921. _indicesLength: number;
  32922. /**
  32923. * Custom position function (internal use)
  32924. * @hidden
  32925. */
  32926. _positionFunction: Nullable<(particle: SolidParticle, i: number, s: number) => void>;
  32927. /**
  32928. * Custom vertex function (internal use)
  32929. * @hidden
  32930. */
  32931. _vertexFunction: Nullable<(particle: SolidParticle, vertex: Vector3, i: number) => void>;
  32932. /**
  32933. * Model material (internal use)
  32934. * @hidden
  32935. */
  32936. _material: Nullable<Material>;
  32937. /**
  32938. * Creates a ModelShape object. This is an internal simplified reference to a mesh used as for a model to replicate particles from by the SPS.
  32939. * SPS internal tool, don't use it manually.
  32940. * @hidden
  32941. */
  32942. constructor(id: number, shape: Vector3[], indices: number[], normals: number[], colors: number[], shapeUV: number[], posFunction: Nullable<(particle: SolidParticle, i: number, s: number) => void>, vtxFunction: Nullable<(particle: SolidParticle, vertex: Vector3, i: number) => void>, material: Nullable<Material>);
  32943. }
  32944. /**
  32945. * Represents a Depth Sorted Particle in the solid particle system.
  32946. * @hidden
  32947. */
  32948. export class DepthSortedParticle {
  32949. /**
  32950. * Particle index
  32951. */
  32952. idx: number;
  32953. /**
  32954. * Index of the particle in the "indices" array
  32955. */
  32956. ind: number;
  32957. /**
  32958. * Length of the particle shape in the "indices" array
  32959. */
  32960. indicesLength: number;
  32961. /**
  32962. * Squared distance from the particle to the camera
  32963. */
  32964. sqDistance: number;
  32965. /**
  32966. * Material index when used with MultiMaterials
  32967. */
  32968. materialIndex: number;
  32969. /**
  32970. * Creates a new sorted particle
  32971. * @param materialIndex
  32972. */
  32973. constructor(idx: number, ind: number, indLength: number, materialIndex: number);
  32974. }
  32975. /**
  32976. * Represents a solid particle vertex
  32977. */
  32978. export class SolidParticleVertex {
  32979. /**
  32980. * Vertex position
  32981. */
  32982. position: Vector3;
  32983. /**
  32984. * Vertex color
  32985. */
  32986. color: Color4;
  32987. /**
  32988. * Vertex UV
  32989. */
  32990. uv: Vector2;
  32991. /**
  32992. * Creates a new solid particle vertex
  32993. */
  32994. constructor();
  32995. /** Vertex x coordinate */
  32996. get x(): number;
  32997. set x(val: number);
  32998. /** Vertex y coordinate */
  32999. get y(): number;
  33000. set y(val: number);
  33001. /** Vertex z coordinate */
  33002. get z(): number;
  33003. set z(val: number);
  33004. }
  33005. }
  33006. declare module "babylonjs/Collisions/meshCollisionData" {
  33007. import { Collider } from "babylonjs/Collisions/collider";
  33008. import { Vector3 } from "babylonjs/Maths/math.vector";
  33009. import { Nullable } from "babylonjs/types";
  33010. import { Observer } from "babylonjs/Misc/observable";
  33011. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  33012. /**
  33013. * @hidden
  33014. */
  33015. export class _MeshCollisionData {
  33016. _checkCollisions: boolean;
  33017. _collisionMask: number;
  33018. _collisionGroup: number;
  33019. _surroundingMeshes: Nullable<AbstractMesh[]>;
  33020. _collider: Nullable<Collider>;
  33021. _oldPositionForCollisions: Vector3;
  33022. _diffPositionForCollisions: Vector3;
  33023. _onCollideObserver: Nullable<Observer<AbstractMesh>>;
  33024. _onCollisionPositionChangeObserver: Nullable<Observer<Vector3>>;
  33025. }
  33026. }
  33027. declare module "babylonjs/Meshes/abstractMesh" {
  33028. import { Observable } from "babylonjs/Misc/observable";
  33029. import { Nullable, FloatArray, IndicesArray, DeepImmutable } from "babylonjs/types";
  33030. import { Camera } from "babylonjs/Cameras/camera";
  33031. import { Scene, IDisposable } from "babylonjs/scene";
  33032. import { Matrix, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  33033. import { Node } from "babylonjs/node";
  33034. import { IGetSetVerticesData } from "babylonjs/Meshes/mesh.vertexData";
  33035. import { TransformNode } from "babylonjs/Meshes/transformNode";
  33036. import { SubMesh } from "babylonjs/Meshes/subMesh";
  33037. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  33038. import { ICullable, BoundingInfo } from "babylonjs/Culling/boundingInfo";
  33039. import { Material } from "babylonjs/Materials/material";
  33040. import { Light } from "babylonjs/Lights/light";
  33041. import { Skeleton } from "babylonjs/Bones/skeleton";
  33042. import { IEdgesRenderer } from "babylonjs/Rendering/edgesRenderer";
  33043. import { SolidParticle } from "babylonjs/Particles/solidParticle";
  33044. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  33045. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  33046. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  33047. import { Plane } from "babylonjs/Maths/math.plane";
  33048. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  33049. import { Ray } from "babylonjs/Culling/ray";
  33050. import { Collider } from "babylonjs/Collisions/collider";
  33051. import { TrianglePickingPredicate } from "babylonjs/Culling/ray";
  33052. import { RenderingGroup } from "babylonjs/Rendering/renderingGroup";
  33053. /** @hidden */
  33054. class _FacetDataStorage {
  33055. facetPositions: Vector3[];
  33056. facetNormals: Vector3[];
  33057. facetPartitioning: number[][];
  33058. facetNb: number;
  33059. partitioningSubdivisions: number;
  33060. partitioningBBoxRatio: number;
  33061. facetDataEnabled: boolean;
  33062. facetParameters: any;
  33063. bbSize: Vector3;
  33064. subDiv: {
  33065. max: number;
  33066. X: number;
  33067. Y: number;
  33068. Z: number;
  33069. };
  33070. facetDepthSort: boolean;
  33071. facetDepthSortEnabled: boolean;
  33072. depthSortedIndices: IndicesArray;
  33073. depthSortedFacets: {
  33074. ind: number;
  33075. sqDistance: number;
  33076. }[];
  33077. facetDepthSortFunction: (f1: {
  33078. ind: number;
  33079. sqDistance: number;
  33080. }, f2: {
  33081. ind: number;
  33082. sqDistance: number;
  33083. }) => number;
  33084. facetDepthSortFrom: Vector3;
  33085. facetDepthSortOrigin: Vector3;
  33086. invertedMatrix: Matrix;
  33087. }
  33088. /**
  33089. * @hidden
  33090. **/
  33091. class _InternalAbstractMeshDataInfo {
  33092. _hasVertexAlpha: boolean;
  33093. _useVertexColors: boolean;
  33094. _numBoneInfluencers: number;
  33095. _applyFog: boolean;
  33096. _receiveShadows: boolean;
  33097. _facetData: _FacetDataStorage;
  33098. _visibility: number;
  33099. _skeleton: Nullable<Skeleton>;
  33100. _layerMask: number;
  33101. _computeBonesUsingShaders: boolean;
  33102. _isActive: boolean;
  33103. _onlyForInstances: boolean;
  33104. _isActiveIntermediate: boolean;
  33105. _onlyForInstancesIntermediate: boolean;
  33106. _actAsRegularMesh: boolean;
  33107. }
  33108. /**
  33109. * Class used to store all common mesh properties
  33110. */
  33111. export class AbstractMesh extends TransformNode implements IDisposable, ICullable, IGetSetVerticesData {
  33112. /** No occlusion */
  33113. static OCCLUSION_TYPE_NONE: number;
  33114. /** Occlusion set to optimisitic */
  33115. static OCCLUSION_TYPE_OPTIMISTIC: number;
  33116. /** Occlusion set to strict */
  33117. static OCCLUSION_TYPE_STRICT: number;
  33118. /** Use an accurante occlusion algorithm */
  33119. static OCCLUSION_ALGORITHM_TYPE_ACCURATE: number;
  33120. /** Use a conservative occlusion algorithm */
  33121. static OCCLUSION_ALGORITHM_TYPE_CONSERVATIVE: number;
  33122. /** Default culling strategy : this is an exclusion test and it's the more accurate.
  33123. * Test order :
  33124. * Is the bounding sphere outside the frustum ?
  33125. * If not, are the bounding box vertices outside the frustum ?
  33126. * It not, then the cullable object is in the frustum.
  33127. */
  33128. static readonly CULLINGSTRATEGY_STANDARD: number;
  33129. /** Culling strategy : Bounding Sphere Only.
  33130. * This is an exclusion test. It's faster than the standard strategy because the bounding box is not tested.
  33131. * It's also less accurate than the standard because some not visible objects can still be selected.
  33132. * Test : is the bounding sphere outside the frustum ?
  33133. * If not, then the cullable object is in the frustum.
  33134. */
  33135. static readonly CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY: number;
  33136. /** Culling strategy : Optimistic Inclusion.
  33137. * This in an inclusion test first, then the standard exclusion test.
  33138. * This can be faster when a cullable object is expected to be almost always in the camera frustum.
  33139. * This could also be a little slower than the standard test when the tested object center is not the frustum but one of its bounding box vertex is still inside.
  33140. * Anyway, it's as accurate as the standard strategy.
  33141. * Test :
  33142. * Is the cullable object bounding sphere center in the frustum ?
  33143. * If not, apply the default culling strategy.
  33144. */
  33145. static readonly CULLINGSTRATEGY_OPTIMISTIC_INCLUSION: number;
  33146. /** Culling strategy : Optimistic Inclusion then Bounding Sphere Only.
  33147. * This in an inclusion test first, then the bounding sphere only exclusion test.
  33148. * This can be the fastest test when a cullable object is expected to be almost always in the camera frustum.
  33149. * This could also be a little slower than the BoundingSphereOnly strategy when the tested object center is not in the frustum but its bounding sphere still intersects it.
  33150. * It's less accurate than the standard strategy and as accurate as the BoundingSphereOnly strategy.
  33151. * Test :
  33152. * Is the cullable object bounding sphere center in the frustum ?
  33153. * If not, apply the Bounding Sphere Only strategy. No Bounding Box is tested here.
  33154. */
  33155. static readonly CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY: number;
  33156. /**
  33157. * No billboard
  33158. */
  33159. static get BILLBOARDMODE_NONE(): number;
  33160. /** Billboard on X axis */
  33161. static get BILLBOARDMODE_X(): number;
  33162. /** Billboard on Y axis */
  33163. static get BILLBOARDMODE_Y(): number;
  33164. /** Billboard on Z axis */
  33165. static get BILLBOARDMODE_Z(): number;
  33166. /** Billboard on all axes */
  33167. static get BILLBOARDMODE_ALL(): number;
  33168. /** Billboard on using position instead of orientation */
  33169. static get BILLBOARDMODE_USE_POSITION(): number;
  33170. /** @hidden */
  33171. _internalAbstractMeshDataInfo: _InternalAbstractMeshDataInfo;
  33172. /**
  33173. * The culling strategy to use to check whether the mesh must be rendered or not.
  33174. * This value can be changed at any time and will be used on the next render mesh selection.
  33175. * The possible values are :
  33176. * - AbstractMesh.CULLINGSTRATEGY_STANDARD
  33177. * - AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  33178. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION
  33179. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY
  33180. * Please read each static variable documentation to get details about the culling process.
  33181. * */
  33182. cullingStrategy: number;
  33183. /**
  33184. * Gets the number of facets in the mesh
  33185. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#what-is-a-mesh-facet
  33186. */
  33187. get facetNb(): number;
  33188. /**
  33189. * Gets or set the number (integer) of subdivisions per axis in the partioning space
  33190. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#tweaking-the-partitioning
  33191. */
  33192. get partitioningSubdivisions(): number;
  33193. set partitioningSubdivisions(nb: number);
  33194. /**
  33195. * The ratio (float) to apply to the bouding box size to set to the partioning space.
  33196. * Ex : 1.01 (default) the partioning space is 1% bigger than the bounding box
  33197. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#tweaking-the-partitioning
  33198. */
  33199. get partitioningBBoxRatio(): number;
  33200. set partitioningBBoxRatio(ratio: number);
  33201. /**
  33202. * Gets or sets a boolean indicating that the facets must be depth sorted on next call to `updateFacetData()`.
  33203. * Works only for updatable meshes.
  33204. * Doesn't work with multi-materials
  33205. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#facet-depth-sort
  33206. */
  33207. get mustDepthSortFacets(): boolean;
  33208. set mustDepthSortFacets(sort: boolean);
  33209. /**
  33210. * The location (Vector3) where the facet depth sort must be computed from.
  33211. * By default, the active camera position.
  33212. * Used only when facet depth sort is enabled
  33213. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#facet-depth-sort
  33214. */
  33215. get facetDepthSortFrom(): Vector3;
  33216. set facetDepthSortFrom(location: Vector3);
  33217. /**
  33218. * gets a boolean indicating if facetData is enabled
  33219. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#what-is-a-mesh-facet
  33220. */
  33221. get isFacetDataEnabled(): boolean;
  33222. /** @hidden */
  33223. _updateNonUniformScalingState(value: boolean): boolean;
  33224. /**
  33225. * An event triggered when this mesh collides with another one
  33226. */
  33227. onCollideObservable: Observable<AbstractMesh>;
  33228. /** Set a function to call when this mesh collides with another one */
  33229. set onCollide(callback: () => void);
  33230. /**
  33231. * An event triggered when the collision's position changes
  33232. */
  33233. onCollisionPositionChangeObservable: Observable<Vector3>;
  33234. /** Set a function to call when the collision's position changes */
  33235. set onCollisionPositionChange(callback: () => void);
  33236. /**
  33237. * An event triggered when material is changed
  33238. */
  33239. onMaterialChangedObservable: Observable<AbstractMesh>;
  33240. /**
  33241. * Gets or sets the orientation for POV movement & rotation
  33242. */
  33243. definedFacingForward: boolean;
  33244. /** @hidden */
  33245. _occlusionQuery: Nullable<WebGLQuery>;
  33246. /** @hidden */
  33247. _renderingGroup: Nullable<RenderingGroup>;
  33248. /**
  33249. * Gets or sets mesh visibility between 0 and 1 (default is 1)
  33250. */
  33251. get visibility(): number;
  33252. /**
  33253. * Gets or sets mesh visibility between 0 and 1 (default is 1)
  33254. */
  33255. set visibility(value: number);
  33256. /** Gets or sets the alpha index used to sort transparent meshes
  33257. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#alpha-index
  33258. */
  33259. alphaIndex: number;
  33260. /**
  33261. * Gets or sets a boolean indicating if the mesh is visible (renderable). Default is true
  33262. */
  33263. isVisible: boolean;
  33264. /**
  33265. * Gets or sets a boolean indicating if the mesh can be picked (by scene.pick for instance or through actions). Default is true
  33266. */
  33267. isPickable: boolean;
  33268. /** Gets or sets a boolean indicating that bounding boxes of subMeshes must be rendered as well (false by default) */
  33269. showSubMeshesBoundingBox: boolean;
  33270. /** Gets or sets a boolean indicating if the mesh must be considered as a ray blocker for lens flares (false by default)
  33271. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  33272. */
  33273. isBlocker: boolean;
  33274. /**
  33275. * Gets or sets a boolean indicating that pointer move events must be supported on this mesh (false by default)
  33276. */
  33277. enablePointerMoveEvents: boolean;
  33278. /**
  33279. * Specifies the rendering group id for this mesh (0 by default)
  33280. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#rendering-groups
  33281. */
  33282. renderingGroupId: number;
  33283. private _material;
  33284. /** Gets or sets current material */
  33285. get material(): Nullable<Material>;
  33286. set material(value: Nullable<Material>);
  33287. /**
  33288. * Gets or sets a boolean indicating that this mesh can receive realtime shadows
  33289. * @see https://doc.babylonjs.com/babylon101/shadows
  33290. */
  33291. get receiveShadows(): boolean;
  33292. set receiveShadows(value: boolean);
  33293. /** Defines color to use when rendering outline */
  33294. outlineColor: Color3;
  33295. /** Define width to use when rendering outline */
  33296. outlineWidth: number;
  33297. /** Defines color to use when rendering overlay */
  33298. overlayColor: Color3;
  33299. /** Defines alpha to use when rendering overlay */
  33300. overlayAlpha: number;
  33301. /** Gets or sets a boolean indicating that this mesh contains vertex color data with alpha values */
  33302. get hasVertexAlpha(): boolean;
  33303. set hasVertexAlpha(value: boolean);
  33304. /** Gets or sets a boolean indicating that this mesh needs to use vertex color data to render (if this kind of vertex data is available in the geometry) */
  33305. get useVertexColors(): boolean;
  33306. set useVertexColors(value: boolean);
  33307. /**
  33308. * Gets or sets a boolean indicating that bone animations must be computed by the CPU (false by default)
  33309. */
  33310. get computeBonesUsingShaders(): boolean;
  33311. set computeBonesUsingShaders(value: boolean);
  33312. /** Gets or sets the number of allowed bone influences per vertex (4 by default) */
  33313. get numBoneInfluencers(): number;
  33314. set numBoneInfluencers(value: number);
  33315. /** Gets or sets a boolean indicating that this mesh will allow fog to be rendered on it (true by default) */
  33316. get applyFog(): boolean;
  33317. set applyFog(value: boolean);
  33318. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes selection (true by default) */
  33319. useOctreeForRenderingSelection: boolean;
  33320. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes picking (true by default) */
  33321. useOctreeForPicking: boolean;
  33322. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes collision (true by default) */
  33323. useOctreeForCollisions: boolean;
  33324. /**
  33325. * Gets or sets the current layer mask (default is 0x0FFFFFFF)
  33326. * @see https://doc.babylonjs.com/how_to/layermasks_and_multi-cam_textures
  33327. */
  33328. get layerMask(): number;
  33329. set layerMask(value: number);
  33330. /**
  33331. * True if the mesh must be rendered in any case (this will shortcut the frustum clipping phase)
  33332. */
  33333. alwaysSelectAsActiveMesh: boolean;
  33334. /**
  33335. * Gets or sets a boolean indicating that the bounding info does not need to be kept in sync (for performance reason)
  33336. */
  33337. doNotSyncBoundingInfo: boolean;
  33338. /**
  33339. * Gets or sets the current action manager
  33340. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  33341. */
  33342. actionManager: Nullable<AbstractActionManager>;
  33343. private _meshCollisionData;
  33344. /**
  33345. * Gets or sets the ellipsoid used to impersonate this mesh when using collision engine (default is (0.5, 1, 0.5))
  33346. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  33347. */
  33348. ellipsoid: Vector3;
  33349. /**
  33350. * Gets or sets the ellipsoid offset used to impersonate this mesh when using collision engine (default is (0, 0, 0))
  33351. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  33352. */
  33353. ellipsoidOffset: Vector3;
  33354. /**
  33355. * Gets or sets a collision mask used to mask collisions (default is -1).
  33356. * A collision between A and B will happen if A.collisionGroup & b.collisionMask !== 0
  33357. */
  33358. get collisionMask(): number;
  33359. set collisionMask(mask: number);
  33360. /**
  33361. * Gets or sets the current collision group mask (-1 by default).
  33362. * A collision between A and B will happen if A.collisionGroup & b.collisionMask !== 0
  33363. */
  33364. get collisionGroup(): number;
  33365. set collisionGroup(mask: number);
  33366. /**
  33367. * Gets or sets current surrounding meshes (null by default).
  33368. *
  33369. * By default collision detection is tested against every mesh in the scene.
  33370. * It is possible to set surroundingMeshes to a defined list of meshes and then only these specified
  33371. * meshes will be tested for the collision.
  33372. *
  33373. * Note: if set to an empty array no collision will happen when this mesh is moved.
  33374. */
  33375. get surroundingMeshes(): Nullable<AbstractMesh[]>;
  33376. set surroundingMeshes(meshes: Nullable<AbstractMesh[]>);
  33377. /**
  33378. * Defines edge width used when edgesRenderer is enabled
  33379. * @see https://www.babylonjs-playground.com/#10OJSG#13
  33380. */
  33381. edgesWidth: number;
  33382. /**
  33383. * Defines edge color used when edgesRenderer is enabled
  33384. * @see https://www.babylonjs-playground.com/#10OJSG#13
  33385. */
  33386. edgesColor: Color4;
  33387. /** @hidden */
  33388. _edgesRenderer: Nullable<IEdgesRenderer>;
  33389. /** @hidden */
  33390. _masterMesh: Nullable<AbstractMesh>;
  33391. /** @hidden */
  33392. _boundingInfo: Nullable<BoundingInfo>;
  33393. /** @hidden */
  33394. _renderId: number;
  33395. /**
  33396. * Gets or sets the list of subMeshes
  33397. * @see https://doc.babylonjs.com/how_to/multi_materials
  33398. */
  33399. subMeshes: SubMesh[];
  33400. /** @hidden */
  33401. _intersectionsInProgress: AbstractMesh[];
  33402. /** @hidden */
  33403. _unIndexed: boolean;
  33404. /** @hidden */
  33405. _lightSources: Light[];
  33406. /** Gets the list of lights affecting that mesh */
  33407. get lightSources(): Light[];
  33408. /** @hidden */
  33409. get _positions(): Nullable<Vector3[]>;
  33410. /** @hidden */
  33411. _waitingData: {
  33412. lods: Nullable<any>;
  33413. actions: Nullable<any>;
  33414. freezeWorldMatrix: Nullable<boolean>;
  33415. };
  33416. /** @hidden */
  33417. _bonesTransformMatrices: Nullable<Float32Array>;
  33418. /** @hidden */
  33419. _transformMatrixTexture: Nullable<RawTexture>;
  33420. /**
  33421. * Gets or sets a skeleton to apply skining transformations
  33422. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  33423. */
  33424. set skeleton(value: Nullable<Skeleton>);
  33425. get skeleton(): Nullable<Skeleton>;
  33426. /**
  33427. * An event triggered when the mesh is rebuilt.
  33428. */
  33429. onRebuildObservable: Observable<AbstractMesh>;
  33430. /**
  33431. * Creates a new AbstractMesh
  33432. * @param name defines the name of the mesh
  33433. * @param scene defines the hosting scene
  33434. */
  33435. constructor(name: string, scene?: Nullable<Scene>);
  33436. /**
  33437. * Returns the string "AbstractMesh"
  33438. * @returns "AbstractMesh"
  33439. */
  33440. getClassName(): string;
  33441. /**
  33442. * Gets a string representation of the current mesh
  33443. * @param fullDetails defines a boolean indicating if full details must be included
  33444. * @returns a string representation of the current mesh
  33445. */
  33446. toString(fullDetails?: boolean): string;
  33447. /**
  33448. * @hidden
  33449. */
  33450. protected _getEffectiveParent(): Nullable<Node>;
  33451. /** @hidden */
  33452. _getActionManagerForTrigger(trigger?: number, initialCall?: boolean): Nullable<AbstractActionManager>;
  33453. /** @hidden */
  33454. _rebuild(): void;
  33455. /** @hidden */
  33456. _resyncLightSources(): void;
  33457. /** @hidden */
  33458. _resyncLightSource(light: Light): void;
  33459. /** @hidden */
  33460. _unBindEffect(): void;
  33461. /** @hidden */
  33462. _removeLightSource(light: Light, dispose: boolean): void;
  33463. private _markSubMeshesAsDirty;
  33464. /** @hidden */
  33465. _markSubMeshesAsLightDirty(dispose?: boolean): void;
  33466. /** @hidden */
  33467. _markSubMeshesAsAttributesDirty(): void;
  33468. /** @hidden */
  33469. _markSubMeshesAsMiscDirty(): void;
  33470. /**
  33471. * Gets or sets a Vector3 depicting the mesh scaling along each local axis X, Y, Z. Default is (1.0, 1.0, 1.0)
  33472. */
  33473. get scaling(): Vector3;
  33474. set scaling(newScaling: Vector3);
  33475. /**
  33476. * Returns true if the mesh is blocked. Implemented by child classes
  33477. */
  33478. get isBlocked(): boolean;
  33479. /**
  33480. * Returns the mesh itself by default. Implemented by child classes
  33481. * @param camera defines the camera to use to pick the right LOD level
  33482. * @returns the currentAbstractMesh
  33483. */
  33484. getLOD(camera: Camera): Nullable<AbstractMesh>;
  33485. /**
  33486. * Returns 0 by default. Implemented by child classes
  33487. * @returns an integer
  33488. */
  33489. getTotalVertices(): number;
  33490. /**
  33491. * Returns a positive integer : the total number of indices in this mesh geometry.
  33492. * @returns the numner of indices or zero if the mesh has no geometry.
  33493. */
  33494. getTotalIndices(): number;
  33495. /**
  33496. * Returns null by default. Implemented by child classes
  33497. * @returns null
  33498. */
  33499. getIndices(): Nullable<IndicesArray>;
  33500. /**
  33501. * Returns the array of the requested vertex data kind. Implemented by child classes
  33502. * @param kind defines the vertex data kind to use
  33503. * @returns null
  33504. */
  33505. getVerticesData(kind: string): Nullable<FloatArray>;
  33506. /**
  33507. * Sets the vertex data of the mesh geometry for the requested `kind`.
  33508. * If the mesh has no geometry, a new Geometry object is set to the mesh and then passed this vertex data.
  33509. * Note that a new underlying VertexBuffer object is created each call.
  33510. * If the `kind` is the `PositionKind`, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  33511. * @param kind defines vertex data kind:
  33512. * * VertexBuffer.PositionKind
  33513. * * VertexBuffer.UVKind
  33514. * * VertexBuffer.UV2Kind
  33515. * * VertexBuffer.UV3Kind
  33516. * * VertexBuffer.UV4Kind
  33517. * * VertexBuffer.UV5Kind
  33518. * * VertexBuffer.UV6Kind
  33519. * * VertexBuffer.ColorKind
  33520. * * VertexBuffer.MatricesIndicesKind
  33521. * * VertexBuffer.MatricesIndicesExtraKind
  33522. * * VertexBuffer.MatricesWeightsKind
  33523. * * VertexBuffer.MatricesWeightsExtraKind
  33524. * @param data defines the data source
  33525. * @param updatable defines if the data must be flagged as updatable (or static)
  33526. * @param stride defines the vertex stride (size of an entire vertex). Can be null and in this case will be deduced from vertex data kind
  33527. * @returns the current mesh
  33528. */
  33529. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  33530. /**
  33531. * Updates the existing vertex data of the mesh geometry for the requested `kind`.
  33532. * If the mesh has no geometry, it is simply returned as it is.
  33533. * @param kind defines vertex data kind:
  33534. * * VertexBuffer.PositionKind
  33535. * * VertexBuffer.UVKind
  33536. * * VertexBuffer.UV2Kind
  33537. * * VertexBuffer.UV3Kind
  33538. * * VertexBuffer.UV4Kind
  33539. * * VertexBuffer.UV5Kind
  33540. * * VertexBuffer.UV6Kind
  33541. * * VertexBuffer.ColorKind
  33542. * * VertexBuffer.MatricesIndicesKind
  33543. * * VertexBuffer.MatricesIndicesExtraKind
  33544. * * VertexBuffer.MatricesWeightsKind
  33545. * * VertexBuffer.MatricesWeightsExtraKind
  33546. * @param data defines the data source
  33547. * @param updateExtends If `kind` is `PositionKind` and if `updateExtends` is true, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed
  33548. * @param makeItUnique If true, a new global geometry is created from this data and is set to the mesh
  33549. * @returns the current mesh
  33550. */
  33551. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): AbstractMesh;
  33552. /**
  33553. * Sets the mesh indices,
  33554. * If the mesh has no geometry, a new Geometry object is created and set to the mesh.
  33555. * @param indices Expects an array populated with integers or a typed array (Int32Array, Uint32Array, Uint16Array)
  33556. * @param totalVertices Defines the total number of vertices
  33557. * @returns the current mesh
  33558. */
  33559. setIndices(indices: IndicesArray, totalVertices: Nullable<number>): AbstractMesh;
  33560. /**
  33561. * Gets a boolean indicating if specific vertex data is present
  33562. * @param kind defines the vertex data kind to use
  33563. * @returns true is data kind is present
  33564. */
  33565. isVerticesDataPresent(kind: string): boolean;
  33566. /**
  33567. * Returns the mesh BoundingInfo object or creates a new one and returns if it was undefined.
  33568. * Note that it returns a shallow bounding of the mesh (i.e. it does not include children).
  33569. * To get the full bounding of all children, call `getHierarchyBoundingVectors` instead.
  33570. * @returns a BoundingInfo
  33571. */
  33572. getBoundingInfo(): BoundingInfo;
  33573. /**
  33574. * Uniformly scales the mesh to fit inside of a unit cube (1 X 1 X 1 units)
  33575. * @param includeDescendants Use the hierarchy's bounding box instead of the mesh's bounding box. Default is false
  33576. * @param ignoreRotation ignore rotation when computing the scale (ie. object will be axis aligned). Default is false
  33577. * @param predicate predicate that is passed in to getHierarchyBoundingVectors when selecting which object should be included when scaling
  33578. * @returns the current mesh
  33579. */
  33580. normalizeToUnitCube(includeDescendants?: boolean, ignoreRotation?: boolean, predicate?: Nullable<(node: AbstractMesh) => boolean>): AbstractMesh;
  33581. /**
  33582. * Overwrite the current bounding info
  33583. * @param boundingInfo defines the new bounding info
  33584. * @returns the current mesh
  33585. */
  33586. setBoundingInfo(boundingInfo: BoundingInfo): AbstractMesh;
  33587. /** Gets a boolean indicating if this mesh has skinning data and an attached skeleton */
  33588. get useBones(): boolean;
  33589. /** @hidden */
  33590. _preActivate(): void;
  33591. /** @hidden */
  33592. _preActivateForIntermediateRendering(renderId: number): void;
  33593. /** @hidden */
  33594. _activate(renderId: number, intermediateRendering: boolean): boolean;
  33595. /** @hidden */
  33596. _postActivate(): void;
  33597. /** @hidden */
  33598. _freeze(): void;
  33599. /** @hidden */
  33600. _unFreeze(): void;
  33601. /**
  33602. * Gets the current world matrix
  33603. * @returns a Matrix
  33604. */
  33605. getWorldMatrix(): Matrix;
  33606. /** @hidden */
  33607. _getWorldMatrixDeterminant(): number;
  33608. /**
  33609. * Gets a boolean indicating if this mesh is an instance or a regular mesh
  33610. */
  33611. get isAnInstance(): boolean;
  33612. /**
  33613. * Gets a boolean indicating if this mesh has instances
  33614. */
  33615. get hasInstances(): boolean;
  33616. /**
  33617. * Gets a boolean indicating if this mesh has thin instances
  33618. */
  33619. get hasThinInstances(): boolean;
  33620. /**
  33621. * Perform relative position change from the point of view of behind the front of the mesh.
  33622. * This is performed taking into account the meshes current rotation, so you do not have to care.
  33623. * Supports definition of mesh facing forward or backward
  33624. * @param amountRight defines the distance on the right axis
  33625. * @param amountUp defines the distance on the up axis
  33626. * @param amountForward defines the distance on the forward axis
  33627. * @returns the current mesh
  33628. */
  33629. movePOV(amountRight: number, amountUp: number, amountForward: number): AbstractMesh;
  33630. /**
  33631. * Calculate relative position change from the point of view of behind the front of the mesh.
  33632. * This is performed taking into account the meshes current rotation, so you do not have to care.
  33633. * Supports definition of mesh facing forward or backward
  33634. * @param amountRight defines the distance on the right axis
  33635. * @param amountUp defines the distance on the up axis
  33636. * @param amountForward defines the distance on the forward axis
  33637. * @returns the new displacement vector
  33638. */
  33639. calcMovePOV(amountRight: number, amountUp: number, amountForward: number): Vector3;
  33640. /**
  33641. * Perform relative rotation change from the point of view of behind the front of the mesh.
  33642. * Supports definition of mesh facing forward or backward
  33643. * @param flipBack defines the flip
  33644. * @param twirlClockwise defines the twirl
  33645. * @param tiltRight defines the tilt
  33646. * @returns the current mesh
  33647. */
  33648. rotatePOV(flipBack: number, twirlClockwise: number, tiltRight: number): AbstractMesh;
  33649. /**
  33650. * Calculate relative rotation change from the point of view of behind the front of the mesh.
  33651. * Supports definition of mesh facing forward or backward.
  33652. * @param flipBack defines the flip
  33653. * @param twirlClockwise defines the twirl
  33654. * @param tiltRight defines the tilt
  33655. * @returns the new rotation vector
  33656. */
  33657. calcRotatePOV(flipBack: number, twirlClockwise: number, tiltRight: number): Vector3;
  33658. /**
  33659. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  33660. * This means the mesh underlying bounding box and sphere are recomputed.
  33661. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  33662. * @returns the current mesh
  33663. */
  33664. refreshBoundingInfo(applySkeleton?: boolean): AbstractMesh;
  33665. /** @hidden */
  33666. _refreshBoundingInfo(data: Nullable<FloatArray>, bias: Nullable<Vector2>): void;
  33667. /** @hidden */
  33668. _getPositionData(applySkeleton: boolean): Nullable<FloatArray>;
  33669. /** @hidden */
  33670. _updateBoundingInfo(): AbstractMesh;
  33671. /** @hidden */
  33672. _updateSubMeshesBoundingInfo(matrix: DeepImmutable<Matrix>): AbstractMesh;
  33673. /** @hidden */
  33674. protected _afterComputeWorldMatrix(): void;
  33675. /** @hidden */
  33676. get _effectiveMesh(): AbstractMesh;
  33677. /**
  33678. * Returns `true` if the mesh is within the frustum defined by the passed array of planes.
  33679. * A mesh is in the frustum if its bounding box intersects the frustum
  33680. * @param frustumPlanes defines the frustum to test
  33681. * @returns true if the mesh is in the frustum planes
  33682. */
  33683. isInFrustum(frustumPlanes: Plane[]): boolean;
  33684. /**
  33685. * Returns `true` if the mesh is completely in the frustum defined be the passed array of planes.
  33686. * A mesh is completely in the frustum if its bounding box it completely inside the frustum.
  33687. * @param frustumPlanes defines the frustum to test
  33688. * @returns true if the mesh is completely in the frustum planes
  33689. */
  33690. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  33691. /**
  33692. * True if the mesh intersects another mesh or a SolidParticle object
  33693. * @param mesh defines a target mesh or SolidParticle to test
  33694. * @param precise Unless the parameter `precise` is set to `true` the intersection is computed according to Axis Aligned Bounding Boxes (AABB), else according to OBB (Oriented BBoxes)
  33695. * @param includeDescendants Can be set to true to test if the mesh defined in parameters intersects with the current mesh or any child meshes
  33696. * @returns true if there is an intersection
  33697. */
  33698. intersectsMesh(mesh: AbstractMesh | SolidParticle, precise?: boolean, includeDescendants?: boolean): boolean;
  33699. /**
  33700. * Returns true if the passed point (Vector3) is inside the mesh bounding box
  33701. * @param point defines the point to test
  33702. * @returns true if there is an intersection
  33703. */
  33704. intersectsPoint(point: Vector3): boolean;
  33705. /**
  33706. * Gets or sets a boolean indicating that this mesh can be used in the collision engine
  33707. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  33708. */
  33709. get checkCollisions(): boolean;
  33710. set checkCollisions(collisionEnabled: boolean);
  33711. /**
  33712. * Gets Collider object used to compute collisions (not physics)
  33713. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  33714. */
  33715. get collider(): Nullable<Collider>;
  33716. /**
  33717. * Move the mesh using collision engine
  33718. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  33719. * @param displacement defines the requested displacement vector
  33720. * @returns the current mesh
  33721. */
  33722. moveWithCollisions(displacement: Vector3): AbstractMesh;
  33723. private _onCollisionPositionChange;
  33724. /** @hidden */
  33725. _collideForSubMesh(subMesh: SubMesh, transformMatrix: Matrix, collider: Collider): AbstractMesh;
  33726. /** @hidden */
  33727. _processCollisionsForSubMeshes(collider: Collider, transformMatrix: Matrix): AbstractMesh;
  33728. /** @hidden */
  33729. _checkCollision(collider: Collider): AbstractMesh;
  33730. /** @hidden */
  33731. _generatePointsArray(): boolean;
  33732. /**
  33733. * Checks if the passed Ray intersects with the mesh
  33734. * @param ray defines the ray to use
  33735. * @param fastCheck defines if fast mode (but less precise) must be used (false by default)
  33736. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  33737. * @param onlyBoundingInfo defines a boolean indicating if picking should only happen using bounding info (false by default)
  33738. * @param worldToUse defines the world matrix to use to get the world coordinate of the intersection point
  33739. * @returns the picking info
  33740. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  33741. */
  33742. intersects(ray: Ray, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate, onlyBoundingInfo?: boolean, worldToUse?: Matrix): PickingInfo;
  33743. /**
  33744. * Clones the current mesh
  33745. * @param name defines the mesh name
  33746. * @param newParent defines the new mesh parent
  33747. * @param doNotCloneChildren defines a boolean indicating that children must not be cloned (false by default)
  33748. * @returns the new mesh
  33749. */
  33750. clone(name: string, newParent: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<AbstractMesh>;
  33751. /**
  33752. * Disposes all the submeshes of the current meshnp
  33753. * @returns the current mesh
  33754. */
  33755. releaseSubMeshes(): AbstractMesh;
  33756. /**
  33757. * Releases resources associated with this abstract mesh.
  33758. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  33759. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  33760. */
  33761. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  33762. /**
  33763. * Adds the passed mesh as a child to the current mesh
  33764. * @param mesh defines the child mesh
  33765. * @returns the current mesh
  33766. */
  33767. addChild(mesh: AbstractMesh): AbstractMesh;
  33768. /**
  33769. * Removes the passed mesh from the current mesh children list
  33770. * @param mesh defines the child mesh
  33771. * @returns the current mesh
  33772. */
  33773. removeChild(mesh: AbstractMesh): AbstractMesh;
  33774. /** @hidden */
  33775. private _initFacetData;
  33776. /**
  33777. * Updates the mesh facetData arrays and the internal partitioning when the mesh is morphed or updated.
  33778. * This method can be called within the render loop.
  33779. * You don't need to call this method by yourself in the render loop when you update/morph a mesh with the methods CreateXXX() as they automatically manage this computation
  33780. * @returns the current mesh
  33781. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33782. */
  33783. updateFacetData(): AbstractMesh;
  33784. /**
  33785. * Returns the facetLocalNormals array.
  33786. * The normals are expressed in the mesh local spac
  33787. * @returns an array of Vector3
  33788. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33789. */
  33790. getFacetLocalNormals(): Vector3[];
  33791. /**
  33792. * Returns the facetLocalPositions array.
  33793. * The facet positions are expressed in the mesh local space
  33794. * @returns an array of Vector3
  33795. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33796. */
  33797. getFacetLocalPositions(): Vector3[];
  33798. /**
  33799. * Returns the facetLocalPartioning array
  33800. * @returns an array of array of numbers
  33801. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33802. */
  33803. getFacetLocalPartitioning(): number[][];
  33804. /**
  33805. * Returns the i-th facet position in the world system.
  33806. * This method allocates a new Vector3 per call
  33807. * @param i defines the facet index
  33808. * @returns a new Vector3
  33809. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33810. */
  33811. getFacetPosition(i: number): Vector3;
  33812. /**
  33813. * Sets the reference Vector3 with the i-th facet position in the world system
  33814. * @param i defines the facet index
  33815. * @param ref defines the target vector
  33816. * @returns the current mesh
  33817. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33818. */
  33819. getFacetPositionToRef(i: number, ref: Vector3): AbstractMesh;
  33820. /**
  33821. * Returns the i-th facet normal in the world system.
  33822. * This method allocates a new Vector3 per call
  33823. * @param i defines the facet index
  33824. * @returns a new Vector3
  33825. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33826. */
  33827. getFacetNormal(i: number): Vector3;
  33828. /**
  33829. * Sets the reference Vector3 with the i-th facet normal in the world system
  33830. * @param i defines the facet index
  33831. * @param ref defines the target vector
  33832. * @returns the current mesh
  33833. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33834. */
  33835. getFacetNormalToRef(i: number, ref: Vector3): this;
  33836. /**
  33837. * Returns the facets (in an array) in the same partitioning block than the one the passed coordinates are located (expressed in the mesh local system)
  33838. * @param x defines x coordinate
  33839. * @param y defines y coordinate
  33840. * @param z defines z coordinate
  33841. * @returns the array of facet indexes
  33842. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33843. */
  33844. getFacetsAtLocalCoordinates(x: number, y: number, z: number): Nullable<number[]>;
  33845. /**
  33846. * Returns the closest mesh facet index at (x,y,z) World coordinates, null if not found
  33847. * @param projected sets as the (x,y,z) world projection on the facet
  33848. * @param checkFace if true (default false), only the facet "facing" to (x,y,z) or only the ones "turning their backs", according to the parameter "facing" are returned
  33849. * @param facing if facing and checkFace are true, only the facet "facing" to (x, y, z) are returned : positive dot (x, y, z) * facet position. If facing si false and checkFace is true, only the facet "turning their backs" to (x, y, z) are returned : negative dot (x, y, z) * facet position
  33850. * @param x defines x coordinate
  33851. * @param y defines y coordinate
  33852. * @param z defines z coordinate
  33853. * @returns the face index if found (or null instead)
  33854. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33855. */
  33856. getClosestFacetAtCoordinates(x: number, y: number, z: number, projected?: Vector3, checkFace?: boolean, facing?: boolean): Nullable<number>;
  33857. /**
  33858. * Returns the closest mesh facet index at (x,y,z) local coordinates, null if not found
  33859. * @param projected sets as the (x,y,z) local projection on the facet
  33860. * @param checkFace if true (default false), only the facet "facing" to (x,y,z) or only the ones "turning their backs", according to the parameter "facing" are returned
  33861. * @param facing if facing and checkFace are true, only the facet "facing" to (x, y, z) are returned : positive dot (x, y, z) * facet position. If facing si false and checkFace is true, only the facet "turning their backs" to (x, y, z) are returned : negative dot (x, y, z) * facet position
  33862. * @param x defines x coordinate
  33863. * @param y defines y coordinate
  33864. * @param z defines z coordinate
  33865. * @returns the face index if found (or null instead)
  33866. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33867. */
  33868. getClosestFacetAtLocalCoordinates(x: number, y: number, z: number, projected?: Vector3, checkFace?: boolean, facing?: boolean): Nullable<number>;
  33869. /**
  33870. * Returns the object "parameter" set with all the expected parameters for facetData computation by ComputeNormals()
  33871. * @returns the parameters
  33872. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33873. */
  33874. getFacetDataParameters(): any;
  33875. /**
  33876. * Disables the feature FacetData and frees the related memory
  33877. * @returns the current mesh
  33878. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33879. */
  33880. disableFacetData(): AbstractMesh;
  33881. /**
  33882. * Updates the AbstractMesh indices array
  33883. * @param indices defines the data source
  33884. * @param offset defines the offset in the index buffer where to store the new data (can be null)
  33885. * @param gpuMemoryOnly defines a boolean indicating that only the GPU memory must be updated leaving the CPU version of the indices unchanged (false by default)
  33886. * @returns the current mesh
  33887. */
  33888. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): AbstractMesh;
  33889. /**
  33890. * Creates new normals data for the mesh
  33891. * @param updatable defines if the normal vertex buffer must be flagged as updatable
  33892. * @returns the current mesh
  33893. */
  33894. createNormals(updatable: boolean): AbstractMesh;
  33895. /**
  33896. * Align the mesh with a normal
  33897. * @param normal defines the normal to use
  33898. * @param upDirection can be used to redefined the up vector to use (will use the (0, 1, 0) by default)
  33899. * @returns the current mesh
  33900. */
  33901. alignWithNormal(normal: Vector3, upDirection?: Vector3): AbstractMesh;
  33902. /** @hidden */
  33903. _checkOcclusionQuery(): boolean;
  33904. /**
  33905. * Disables the mesh edge rendering mode
  33906. * @returns the currentAbstractMesh
  33907. */
  33908. disableEdgesRendering(): AbstractMesh;
  33909. /**
  33910. * Enables the edge rendering mode on the mesh.
  33911. * This mode makes the mesh edges visible
  33912. * @param epsilon defines the maximal distance between two angles to detect a face
  33913. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  33914. * @returns the currentAbstractMesh
  33915. * @see https://www.babylonjs-playground.com/#19O9TU#0
  33916. */
  33917. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): AbstractMesh;
  33918. /**
  33919. * This function returns all of the particle systems in the scene that use the mesh as an emitter.
  33920. * @returns an array of particle systems in the scene that use the mesh as an emitter
  33921. */
  33922. getConnectedParticleSystems(): IParticleSystem[];
  33923. }
  33924. }
  33925. declare module "babylonjs/Actions/actionEvent" {
  33926. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  33927. import { Nullable } from "babylonjs/types";
  33928. import { Sprite } from "babylonjs/Sprites/sprite";
  33929. import { Scene } from "babylonjs/scene";
  33930. import { Vector2 } from "babylonjs/Maths/math.vector";
  33931. /**
  33932. * Interface used to define ActionEvent
  33933. */
  33934. export interface IActionEvent {
  33935. /** The mesh or sprite that triggered the action */
  33936. source: any;
  33937. /** The X mouse cursor position at the time of the event */
  33938. pointerX: number;
  33939. /** The Y mouse cursor position at the time of the event */
  33940. pointerY: number;
  33941. /** The mesh that is currently pointed at (can be null) */
  33942. meshUnderPointer: Nullable<AbstractMesh>;
  33943. /** the original (browser) event that triggered the ActionEvent */
  33944. sourceEvent?: any;
  33945. /** additional data for the event */
  33946. additionalData?: any;
  33947. }
  33948. /**
  33949. * ActionEvent is the event being sent when an action is triggered.
  33950. */
  33951. export class ActionEvent implements IActionEvent {
  33952. /** The mesh or sprite that triggered the action */
  33953. source: any;
  33954. /** The X mouse cursor position at the time of the event */
  33955. pointerX: number;
  33956. /** The Y mouse cursor position at the time of the event */
  33957. pointerY: number;
  33958. /** The mesh that is currently pointed at (can be null) */
  33959. meshUnderPointer: Nullable<AbstractMesh>;
  33960. /** the original (browser) event that triggered the ActionEvent */
  33961. sourceEvent?: any;
  33962. /** additional data for the event */
  33963. additionalData?: any;
  33964. /**
  33965. * Creates a new ActionEvent
  33966. * @param source The mesh or sprite that triggered the action
  33967. * @param pointerX The X mouse cursor position at the time of the event
  33968. * @param pointerY The Y mouse cursor position at the time of the event
  33969. * @param meshUnderPointer The mesh that is currently pointed at (can be null)
  33970. * @param sourceEvent the original (browser) event that triggered the ActionEvent
  33971. * @param additionalData additional data for the event
  33972. */
  33973. constructor(
  33974. /** The mesh or sprite that triggered the action */
  33975. source: any,
  33976. /** The X mouse cursor position at the time of the event */
  33977. pointerX: number,
  33978. /** The Y mouse cursor position at the time of the event */
  33979. pointerY: number,
  33980. /** The mesh that is currently pointed at (can be null) */
  33981. meshUnderPointer: Nullable<AbstractMesh>,
  33982. /** the original (browser) event that triggered the ActionEvent */
  33983. sourceEvent?: any,
  33984. /** additional data for the event */
  33985. additionalData?: any);
  33986. /**
  33987. * Helper function to auto-create an ActionEvent from a source mesh.
  33988. * @param source The source mesh that triggered the event
  33989. * @param evt The original (browser) event
  33990. * @param additionalData additional data for the event
  33991. * @returns the new ActionEvent
  33992. */
  33993. static CreateNew(source: AbstractMesh, evt?: Event, additionalData?: any): ActionEvent;
  33994. /**
  33995. * Helper function to auto-create an ActionEvent from a source sprite
  33996. * @param source The source sprite that triggered the event
  33997. * @param scene Scene associated with the sprite
  33998. * @param evt The original (browser) event
  33999. * @param additionalData additional data for the event
  34000. * @returns the new ActionEvent
  34001. */
  34002. static CreateNewFromSprite(source: Sprite, scene: Scene, evt?: Event, additionalData?: any): ActionEvent;
  34003. /**
  34004. * Helper function to auto-create an ActionEvent from a scene. If triggered by a mesh use ActionEvent.CreateNew
  34005. * @param scene the scene where the event occurred
  34006. * @param evt The original (browser) event
  34007. * @returns the new ActionEvent
  34008. */
  34009. static CreateNewFromScene(scene: Scene, evt: Event): ActionEvent;
  34010. /**
  34011. * Helper function to auto-create an ActionEvent from a primitive
  34012. * @param prim defines the target primitive
  34013. * @param pointerPos defines the pointer position
  34014. * @param evt The original (browser) event
  34015. * @param additionalData additional data for the event
  34016. * @returns the new ActionEvent
  34017. */
  34018. static CreateNewFromPrimitive(prim: any, pointerPos: Vector2, evt?: Event, additionalData?: any): ActionEvent;
  34019. }
  34020. }
  34021. declare module "babylonjs/Actions/abstractActionManager" {
  34022. import { IDisposable } from "babylonjs/scene";
  34023. import { IActionEvent } from "babylonjs/Actions/actionEvent";
  34024. import { IAction } from "babylonjs/Actions/action";
  34025. import { Nullable } from "babylonjs/types";
  34026. /**
  34027. * Abstract class used to decouple action Manager from scene and meshes.
  34028. * Do not instantiate.
  34029. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  34030. */
  34031. export abstract class AbstractActionManager implements IDisposable {
  34032. /** Gets the list of active triggers */
  34033. static Triggers: {
  34034. [key: string]: number;
  34035. };
  34036. /** Gets the cursor to use when hovering items */
  34037. hoverCursor: string;
  34038. /** Gets the list of actions */
  34039. actions: IAction[];
  34040. /**
  34041. * Gets or sets a boolean indicating that the manager is recursive meaning that it can trigger action from children
  34042. */
  34043. isRecursive: boolean;
  34044. /**
  34045. * Releases all associated resources
  34046. */
  34047. abstract dispose(): void;
  34048. /**
  34049. * Does this action manager has pointer triggers
  34050. */
  34051. abstract get hasPointerTriggers(): boolean;
  34052. /**
  34053. * Does this action manager has pick triggers
  34054. */
  34055. abstract get hasPickTriggers(): boolean;
  34056. /**
  34057. * Process a specific trigger
  34058. * @param trigger defines the trigger to process
  34059. * @param evt defines the event details to be processed
  34060. */
  34061. abstract processTrigger(trigger: number, evt?: IActionEvent): void;
  34062. /**
  34063. * Does this action manager handles actions of any of the given triggers
  34064. * @param triggers defines the triggers to be tested
  34065. * @return a boolean indicating whether one (or more) of the triggers is handled
  34066. */
  34067. abstract hasSpecificTriggers(triggers: number[]): boolean;
  34068. /**
  34069. * Does this action manager handles actions of any of the given triggers. This function takes two arguments for
  34070. * speed.
  34071. * @param triggerA defines the trigger to be tested
  34072. * @param triggerB defines the trigger to be tested
  34073. * @return a boolean indicating whether one (or more) of the triggers is handled
  34074. */
  34075. abstract hasSpecificTriggers2(triggerA: number, triggerB: number): boolean;
  34076. /**
  34077. * Does this action manager handles actions of a given trigger
  34078. * @param trigger defines the trigger to be tested
  34079. * @param parameterPredicate defines an optional predicate to filter triggers by parameter
  34080. * @return whether the trigger is handled
  34081. */
  34082. abstract hasSpecificTrigger(trigger: number, parameterPredicate?: (parameter: any) => boolean): boolean;
  34083. /**
  34084. * Serialize this manager to a JSON object
  34085. * @param name defines the property name to store this manager
  34086. * @returns a JSON representation of this manager
  34087. */
  34088. abstract serialize(name: string): any;
  34089. /**
  34090. * Registers an action to this action manager
  34091. * @param action defines the action to be registered
  34092. * @return the action amended (prepared) after registration
  34093. */
  34094. abstract registerAction(action: IAction): Nullable<IAction>;
  34095. /**
  34096. * Unregisters an action to this action manager
  34097. * @param action defines the action to be unregistered
  34098. * @return a boolean indicating whether the action has been unregistered
  34099. */
  34100. abstract unregisterAction(action: IAction): Boolean;
  34101. /**
  34102. * Does exist one action manager with at least one trigger
  34103. **/
  34104. static get HasTriggers(): boolean;
  34105. /**
  34106. * Does exist one action manager with at least one pick trigger
  34107. **/
  34108. static get HasPickTriggers(): boolean;
  34109. /**
  34110. * Does exist one action manager that handles actions of a given trigger
  34111. * @param trigger defines the trigger to be tested
  34112. * @return a boolean indicating whether the trigger is handeled by at least one action manager
  34113. **/
  34114. static HasSpecificTrigger(trigger: number): boolean;
  34115. }
  34116. }
  34117. declare module "babylonjs/node" {
  34118. import { Scene } from "babylonjs/scene";
  34119. import { Nullable } from "babylonjs/types";
  34120. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  34121. import { Engine } from "babylonjs/Engines/engine";
  34122. import { IBehaviorAware, Behavior } from "babylonjs/Behaviors/behavior";
  34123. import { Observable } from "babylonjs/Misc/observable";
  34124. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  34125. import { IInspectable } from "babylonjs/Misc/iInspectable";
  34126. import { Animatable } from "babylonjs/Animations/animatable";
  34127. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  34128. import { Animation } from "babylonjs/Animations/animation";
  34129. import { AnimationRange } from "babylonjs/Animations/animationRange";
  34130. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  34131. /**
  34132. * Defines how a node can be built from a string name.
  34133. */
  34134. export type NodeConstructor = (name: string, scene: Scene, options?: any) => () => Node;
  34135. /**
  34136. * Node is the basic class for all scene objects (Mesh, Light, Camera.)
  34137. */
  34138. export class Node implements IBehaviorAware<Node> {
  34139. /** @hidden */
  34140. static _AnimationRangeFactory: (name: string, from: number, to: number) => AnimationRange;
  34141. private static _NodeConstructors;
  34142. /**
  34143. * Add a new node constructor
  34144. * @param type defines the type name of the node to construct
  34145. * @param constructorFunc defines the constructor function
  34146. */
  34147. static AddNodeConstructor(type: string, constructorFunc: NodeConstructor): void;
  34148. /**
  34149. * Returns a node constructor based on type name
  34150. * @param type defines the type name
  34151. * @param name defines the new node name
  34152. * @param scene defines the hosting scene
  34153. * @param options defines optional options to transmit to constructors
  34154. * @returns the new constructor or null
  34155. */
  34156. static Construct(type: string, name: string, scene: Scene, options?: any): Nullable<() => Node>;
  34157. /**
  34158. * Gets or sets the name of the node
  34159. */
  34160. name: string;
  34161. /**
  34162. * Gets or sets the id of the node
  34163. */
  34164. id: string;
  34165. /**
  34166. * Gets or sets the unique id of the node
  34167. */
  34168. uniqueId: number;
  34169. /**
  34170. * Gets or sets a string used to store user defined state for the node
  34171. */
  34172. state: string;
  34173. /**
  34174. * Gets or sets an object used to store user defined information for the node
  34175. */
  34176. metadata: any;
  34177. /**
  34178. * For internal use only. Please do not use.
  34179. */
  34180. reservedDataStore: any;
  34181. /**
  34182. * List of inspectable custom properties (used by the Inspector)
  34183. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  34184. */
  34185. inspectableCustomProperties: IInspectable[];
  34186. private _doNotSerialize;
  34187. /**
  34188. * Gets or sets a boolean used to define if the node must be serialized
  34189. */
  34190. get doNotSerialize(): boolean;
  34191. set doNotSerialize(value: boolean);
  34192. /** @hidden */
  34193. _isDisposed: boolean;
  34194. /**
  34195. * Gets a list of Animations associated with the node
  34196. */
  34197. animations: import("babylonjs/Animations/animation").Animation[];
  34198. protected _ranges: {
  34199. [name: string]: Nullable<AnimationRange>;
  34200. };
  34201. /**
  34202. * Callback raised when the node is ready to be used
  34203. */
  34204. onReady: Nullable<(node: Node) => void>;
  34205. private _isEnabled;
  34206. private _isParentEnabled;
  34207. private _isReady;
  34208. /** @hidden */
  34209. _currentRenderId: number;
  34210. private _parentUpdateId;
  34211. /** @hidden */
  34212. _childUpdateId: number;
  34213. /** @hidden */
  34214. _waitingParentId: Nullable<string>;
  34215. /** @hidden */
  34216. _scene: Scene;
  34217. /** @hidden */
  34218. _cache: any;
  34219. private _parentNode;
  34220. private _children;
  34221. /** @hidden */
  34222. _worldMatrix: Matrix;
  34223. /** @hidden */
  34224. _worldMatrixDeterminant: number;
  34225. /** @hidden */
  34226. _worldMatrixDeterminantIsDirty: boolean;
  34227. /** @hidden */
  34228. private _sceneRootNodesIndex;
  34229. /**
  34230. * Gets a boolean indicating if the node has been disposed
  34231. * @returns true if the node was disposed
  34232. */
  34233. isDisposed(): boolean;
  34234. /**
  34235. * Gets or sets the parent of the node (without keeping the current position in the scene)
  34236. * @see https://doc.babylonjs.com/how_to/parenting
  34237. */
  34238. set parent(parent: Nullable<Node>);
  34239. get parent(): Nullable<Node>;
  34240. /** @hidden */
  34241. _addToSceneRootNodes(): void;
  34242. /** @hidden */
  34243. _removeFromSceneRootNodes(): void;
  34244. private _animationPropertiesOverride;
  34245. /**
  34246. * Gets or sets the animation properties override
  34247. */
  34248. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  34249. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  34250. /**
  34251. * Gets a string identifying the name of the class
  34252. * @returns "Node" string
  34253. */
  34254. getClassName(): string;
  34255. /** @hidden */
  34256. readonly _isNode: boolean;
  34257. /**
  34258. * An event triggered when the mesh is disposed
  34259. */
  34260. onDisposeObservable: Observable<Node>;
  34261. private _onDisposeObserver;
  34262. /**
  34263. * Sets a callback that will be raised when the node will be disposed
  34264. */
  34265. set onDispose(callback: () => void);
  34266. /**
  34267. * Creates a new Node
  34268. * @param name the name and id to be given to this node
  34269. * @param scene the scene this node will be added to
  34270. */
  34271. constructor(name: string, scene?: Nullable<Scene>);
  34272. /**
  34273. * Gets the scene of the node
  34274. * @returns a scene
  34275. */
  34276. getScene(): Scene;
  34277. /**
  34278. * Gets the engine of the node
  34279. * @returns a Engine
  34280. */
  34281. getEngine(): Engine;
  34282. private _behaviors;
  34283. /**
  34284. * Attach a behavior to the node
  34285. * @see https://doc.babylonjs.com/features/behaviour
  34286. * @param behavior defines the behavior to attach
  34287. * @param attachImmediately defines that the behavior must be attached even if the scene is still loading
  34288. * @returns the current Node
  34289. */
  34290. addBehavior(behavior: Behavior<Node>, attachImmediately?: boolean): Node;
  34291. /**
  34292. * Remove an attached behavior
  34293. * @see https://doc.babylonjs.com/features/behaviour
  34294. * @param behavior defines the behavior to attach
  34295. * @returns the current Node
  34296. */
  34297. removeBehavior(behavior: Behavior<Node>): Node;
  34298. /**
  34299. * Gets the list of attached behaviors
  34300. * @see https://doc.babylonjs.com/features/behaviour
  34301. */
  34302. get behaviors(): Behavior<Node>[];
  34303. /**
  34304. * Gets an attached behavior by name
  34305. * @param name defines the name of the behavior to look for
  34306. * @see https://doc.babylonjs.com/features/behaviour
  34307. * @returns null if behavior was not found else the requested behavior
  34308. */
  34309. getBehaviorByName(name: string): Nullable<Behavior<Node>>;
  34310. /**
  34311. * Returns the latest update of the World matrix
  34312. * @returns a Matrix
  34313. */
  34314. getWorldMatrix(): Matrix;
  34315. /** @hidden */
  34316. _getWorldMatrixDeterminant(): number;
  34317. /**
  34318. * Returns directly the latest state of the mesh World matrix.
  34319. * A Matrix is returned.
  34320. */
  34321. get worldMatrixFromCache(): Matrix;
  34322. /** @hidden */
  34323. _initCache(): void;
  34324. /** @hidden */
  34325. updateCache(force?: boolean): void;
  34326. /** @hidden */
  34327. _getActionManagerForTrigger(trigger?: number, initialCall?: boolean): Nullable<AbstractActionManager>;
  34328. /** @hidden */
  34329. _updateCache(ignoreParentClass?: boolean): void;
  34330. /** @hidden */
  34331. _isSynchronized(): boolean;
  34332. /** @hidden */
  34333. _markSyncedWithParent(): void;
  34334. /** @hidden */
  34335. isSynchronizedWithParent(): boolean;
  34336. /** @hidden */
  34337. isSynchronized(): boolean;
  34338. /**
  34339. * Is this node ready to be used/rendered
  34340. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  34341. * @return true if the node is ready
  34342. */
  34343. isReady(completeCheck?: boolean): boolean;
  34344. /**
  34345. * Is this node enabled?
  34346. * If the node has a parent, all ancestors will be checked and false will be returned if any are false (not enabled), otherwise will return true
  34347. * @param checkAncestors indicates if this method should check the ancestors. The default is to check the ancestors. If set to false, the method will return the value of this node without checking ancestors
  34348. * @return whether this node (and its parent) is enabled
  34349. */
  34350. isEnabled(checkAncestors?: boolean): boolean;
  34351. /** @hidden */
  34352. protected _syncParentEnabledState(): void;
  34353. /**
  34354. * Set the enabled state of this node
  34355. * @param value defines the new enabled state
  34356. */
  34357. setEnabled(value: boolean): void;
  34358. /**
  34359. * Is this node a descendant of the given node?
  34360. * The function will iterate up the hierarchy until the ancestor was found or no more parents defined
  34361. * @param ancestor defines the parent node to inspect
  34362. * @returns a boolean indicating if this node is a descendant of the given node
  34363. */
  34364. isDescendantOf(ancestor: Node): boolean;
  34365. /** @hidden */
  34366. _getDescendants(results: Node[], directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): void;
  34367. /**
  34368. * Will return all nodes that have this node as ascendant
  34369. * @param directDescendantsOnly defines if true only direct descendants of 'this' will be considered, if false direct and also indirect (children of children, an so on in a recursive manner) descendants of 'this' will be considered
  34370. * @param predicate defines an optional predicate that will be called on every evaluated child, the predicate must return true for a given child to be part of the result, otherwise it will be ignored
  34371. * @return all children nodes of all types
  34372. */
  34373. getDescendants(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): Node[];
  34374. /**
  34375. * Get all child-meshes of this node
  34376. * @param directDescendantsOnly defines if true only direct descendants of 'this' will be considered, if false direct and also indirect (children of children, an so on in a recursive manner) descendants of 'this' will be considered (Default: false)
  34377. * @param predicate defines an optional predicate that will be called on every evaluated child, the predicate must return true for a given child to be part of the result, otherwise it will be ignored
  34378. * @returns an array of AbstractMesh
  34379. */
  34380. getChildMeshes(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): AbstractMesh[];
  34381. /**
  34382. * Get all direct children of this node
  34383. * @param predicate defines an optional predicate that will be called on every evaluated child, the predicate must return true for a given child to be part of the result, otherwise it will be ignored
  34384. * @param directDescendantsOnly defines if true only direct descendants of 'this' will be considered, if false direct and also indirect (children of children, an so on in a recursive manner) descendants of 'this' will be considered (Default: true)
  34385. * @returns an array of Node
  34386. */
  34387. getChildren(predicate?: (node: Node) => boolean, directDescendantsOnly?: boolean): Node[];
  34388. /** @hidden */
  34389. _setReady(state: boolean): void;
  34390. /**
  34391. * Get an animation by name
  34392. * @param name defines the name of the animation to look for
  34393. * @returns null if not found else the requested animation
  34394. */
  34395. getAnimationByName(name: string): Nullable<Animation>;
  34396. /**
  34397. * Creates an animation range for this node
  34398. * @param name defines the name of the range
  34399. * @param from defines the starting key
  34400. * @param to defines the end key
  34401. */
  34402. createAnimationRange(name: string, from: number, to: number): void;
  34403. /**
  34404. * Delete a specific animation range
  34405. * @param name defines the name of the range to delete
  34406. * @param deleteFrames defines if animation frames from the range must be deleted as well
  34407. */
  34408. deleteAnimationRange(name: string, deleteFrames?: boolean): void;
  34409. /**
  34410. * Get an animation range by name
  34411. * @param name defines the name of the animation range to look for
  34412. * @returns null if not found else the requested animation range
  34413. */
  34414. getAnimationRange(name: string): Nullable<AnimationRange>;
  34415. /**
  34416. * Gets the list of all animation ranges defined on this node
  34417. * @returns an array
  34418. */
  34419. getAnimationRanges(): Nullable<AnimationRange>[];
  34420. /**
  34421. * Will start the animation sequence
  34422. * @param name defines the range frames for animation sequence
  34423. * @param loop defines if the animation should loop (false by default)
  34424. * @param speedRatio defines the speed factor in which to run the animation (1 by default)
  34425. * @param onAnimationEnd defines a function to be executed when the animation ended (undefined by default)
  34426. * @returns the object created for this animation. If range does not exist, it will return null
  34427. */
  34428. beginAnimation(name: string, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void): Nullable<Animatable>;
  34429. /**
  34430. * Serialize animation ranges into a JSON compatible object
  34431. * @returns serialization object
  34432. */
  34433. serializeAnimationRanges(): any;
  34434. /**
  34435. * Computes the world matrix of the node
  34436. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  34437. * @returns the world matrix
  34438. */
  34439. computeWorldMatrix(force?: boolean): Matrix;
  34440. /**
  34441. * Releases resources associated with this node.
  34442. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  34443. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  34444. */
  34445. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  34446. /**
  34447. * Parse animation range data from a serialization object and store them into a given node
  34448. * @param node defines where to store the animation ranges
  34449. * @param parsedNode defines the serialization object to read data from
  34450. * @param scene defines the hosting scene
  34451. */
  34452. static ParseAnimationRanges(node: Node, parsedNode: any, scene: Scene): void;
  34453. /**
  34454. * Return the minimum and maximum world vectors of the entire hierarchy under current node
  34455. * @param includeDescendants Include bounding info from descendants as well (true by default)
  34456. * @param predicate defines a callback function that can be customize to filter what meshes should be included in the list used to compute the bounding vectors
  34457. * @returns the new bounding vectors
  34458. */
  34459. getHierarchyBoundingVectors(includeDescendants?: boolean, predicate?: Nullable<(abstractMesh: AbstractMesh) => boolean>): {
  34460. min: Vector3;
  34461. max: Vector3;
  34462. };
  34463. }
  34464. }
  34465. declare module "babylonjs/Animations/animation" {
  34466. import { IEasingFunction, EasingFunction } from "babylonjs/Animations/easing";
  34467. import { Vector3, Quaternion, Vector2, Matrix } from "babylonjs/Maths/math.vector";
  34468. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  34469. import { Nullable } from "babylonjs/types";
  34470. import { Scene } from "babylonjs/scene";
  34471. import { IAnimationKey } from "babylonjs/Animations/animationKey";
  34472. import { AnimationRange } from "babylonjs/Animations/animationRange";
  34473. import { AnimationEvent } from "babylonjs/Animations/animationEvent";
  34474. import { Node } from "babylonjs/node";
  34475. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  34476. import { Size } from "babylonjs/Maths/math.size";
  34477. import { Animatable } from "babylonjs/Animations/animatable";
  34478. import { RuntimeAnimation } from "babylonjs/Animations/runtimeAnimation";
  34479. /**
  34480. * @hidden
  34481. */
  34482. export class _IAnimationState {
  34483. key: number;
  34484. repeatCount: number;
  34485. workValue?: any;
  34486. loopMode?: number;
  34487. offsetValue?: any;
  34488. highLimitValue?: any;
  34489. }
  34490. /**
  34491. * Class used to store any kind of animation
  34492. */
  34493. export class Animation {
  34494. /**Name of the animation */
  34495. name: string;
  34496. /**Property to animate */
  34497. targetProperty: string;
  34498. /**The frames per second of the animation */
  34499. framePerSecond: number;
  34500. /**The data type of the animation */
  34501. dataType: number;
  34502. /**The loop mode of the animation */
  34503. loopMode?: number | undefined;
  34504. /**Specifies if blending should be enabled */
  34505. enableBlending?: boolean | undefined;
  34506. /**
  34507. * Use matrix interpolation instead of using direct key value when animating matrices
  34508. */
  34509. static AllowMatricesInterpolation: boolean;
  34510. /**
  34511. * When matrix interpolation is enabled, this boolean forces the system to use Matrix.DecomposeLerp instead of Matrix.Lerp. Interpolation is more precise but slower
  34512. */
  34513. static AllowMatrixDecomposeForInterpolation: boolean;
  34514. /** Define the Url to load snippets */
  34515. static SnippetUrl: string;
  34516. /** Snippet ID if the animation was created from the snippet server */
  34517. snippetId: string;
  34518. /**
  34519. * Stores the key frames of the animation
  34520. */
  34521. private _keys;
  34522. /**
  34523. * Stores the easing function of the animation
  34524. */
  34525. private _easingFunction;
  34526. /**
  34527. * @hidden Internal use only
  34528. */
  34529. _runtimeAnimations: import("babylonjs/Animations/runtimeAnimation").RuntimeAnimation[];
  34530. /**
  34531. * The set of event that will be linked to this animation
  34532. */
  34533. private _events;
  34534. /**
  34535. * Stores an array of target property paths
  34536. */
  34537. targetPropertyPath: string[];
  34538. /**
  34539. * Stores the blending speed of the animation
  34540. */
  34541. blendingSpeed: number;
  34542. /**
  34543. * Stores the animation ranges for the animation
  34544. */
  34545. private _ranges;
  34546. /**
  34547. * @hidden Internal use
  34548. */
  34549. static _PrepareAnimation(name: string, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction): Nullable<Animation>;
  34550. /**
  34551. * Sets up an animation
  34552. * @param property The property to animate
  34553. * @param animationType The animation type to apply
  34554. * @param framePerSecond The frames per second of the animation
  34555. * @param easingFunction The easing function used in the animation
  34556. * @returns The created animation
  34557. */
  34558. static CreateAnimation(property: string, animationType: number, framePerSecond: number, easingFunction: EasingFunction): Animation;
  34559. /**
  34560. * Create and start an animation on a node
  34561. * @param name defines the name of the global animation that will be run on all nodes
  34562. * @param node defines the root node where the animation will take place
  34563. * @param targetProperty defines property to animate
  34564. * @param framePerSecond defines the number of frame per second yo use
  34565. * @param totalFrame defines the number of frames in total
  34566. * @param from defines the initial value
  34567. * @param to defines the final value
  34568. * @param loopMode defines which loop mode you want to use (off by default)
  34569. * @param easingFunction defines the easing function to use (linear by default)
  34570. * @param onAnimationEnd defines the callback to call when animation end
  34571. * @returns the animatable created for this animation
  34572. */
  34573. static CreateAndStartAnimation(name: string, node: Node, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable>;
  34574. /**
  34575. * Create and start an animation on a node and its descendants
  34576. * @param name defines the name of the global animation that will be run on all nodes
  34577. * @param node defines the root node where the animation will take place
  34578. * @param directDescendantsOnly if true only direct descendants will be used, if false direct and also indirect (children of children, an so on in a recursive manner) descendants will be used
  34579. * @param targetProperty defines property to animate
  34580. * @param framePerSecond defines the number of frame per second to use
  34581. * @param totalFrame defines the number of frames in total
  34582. * @param from defines the initial value
  34583. * @param to defines the final value
  34584. * @param loopMode defines which loop mode you want to use (off by default)
  34585. * @param easingFunction defines the easing function to use (linear by default)
  34586. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  34587. * @returns the list of animatables created for all nodes
  34588. * @example https://www.babylonjs-playground.com/#MH0VLI
  34589. */
  34590. static CreateAndStartHierarchyAnimation(name: string, node: Node, directDescendantsOnly: boolean, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable[]>;
  34591. /**
  34592. * Creates a new animation, merges it with the existing animations and starts it
  34593. * @param name Name of the animation
  34594. * @param node Node which contains the scene that begins the animations
  34595. * @param targetProperty Specifies which property to animate
  34596. * @param framePerSecond The frames per second of the animation
  34597. * @param totalFrame The total number of frames
  34598. * @param from The frame at the beginning of the animation
  34599. * @param to The frame at the end of the animation
  34600. * @param loopMode Specifies the loop mode of the animation
  34601. * @param easingFunction (Optional) The easing function of the animation, which allow custom mathematical formulas for animations
  34602. * @param onAnimationEnd Callback to run once the animation is complete
  34603. * @returns Nullable animation
  34604. */
  34605. static CreateMergeAndStartAnimation(name: string, node: Node, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable>;
  34606. /**
  34607. * Convert the keyframes for all animations belonging to the group to be relative to a given reference frame.
  34608. * @param sourceAnimation defines the Animation containing keyframes to convert
  34609. * @param referenceFrame defines the frame that keyframes in the range will be relative to
  34610. * @param range defines the name of the AnimationRange belonging to the Animation to convert
  34611. * @param cloneOriginal defines whether or not to clone the animation and convert the clone or convert the original animation (default is false)
  34612. * @param clonedName defines the name of the resulting cloned Animation if cloneOriginal is true
  34613. * @returns a new Animation if cloneOriginal is true or the original Animation if cloneOriginal is false
  34614. */
  34615. static MakeAnimationAdditive(sourceAnimation: Animation, referenceFrame?: number, range?: string, cloneOriginal?: boolean, clonedName?: string): Animation;
  34616. /**
  34617. * Transition property of an host to the target Value
  34618. * @param property The property to transition
  34619. * @param targetValue The target Value of the property
  34620. * @param host The object where the property to animate belongs
  34621. * @param scene Scene used to run the animation
  34622. * @param frameRate Framerate (in frame/s) to use
  34623. * @param transition The transition type we want to use
  34624. * @param duration The duration of the animation, in milliseconds
  34625. * @param onAnimationEnd Callback trigger at the end of the animation
  34626. * @returns Nullable animation
  34627. */
  34628. static TransitionTo(property: string, targetValue: any, host: any, scene: Scene, frameRate: number, transition: Animation, duration: number, onAnimationEnd?: Nullable<() => void>): Nullable<Animatable>;
  34629. /**
  34630. * Return the array of runtime animations currently using this animation
  34631. */
  34632. get runtimeAnimations(): RuntimeAnimation[];
  34633. /**
  34634. * Specifies if any of the runtime animations are currently running
  34635. */
  34636. get hasRunningRuntimeAnimations(): boolean;
  34637. /**
  34638. * Initializes the animation
  34639. * @param name Name of the animation
  34640. * @param targetProperty Property to animate
  34641. * @param framePerSecond The frames per second of the animation
  34642. * @param dataType The data type of the animation
  34643. * @param loopMode The loop mode of the animation
  34644. * @param enableBlending Specifies if blending should be enabled
  34645. */
  34646. constructor(
  34647. /**Name of the animation */
  34648. name: string,
  34649. /**Property to animate */
  34650. targetProperty: string,
  34651. /**The frames per second of the animation */
  34652. framePerSecond: number,
  34653. /**The data type of the animation */
  34654. dataType: number,
  34655. /**The loop mode of the animation */
  34656. loopMode?: number | undefined,
  34657. /**Specifies if blending should be enabled */
  34658. enableBlending?: boolean | undefined);
  34659. /**
  34660. * Converts the animation to a string
  34661. * @param fullDetails support for multiple levels of logging within scene loading
  34662. * @returns String form of the animation
  34663. */
  34664. toString(fullDetails?: boolean): string;
  34665. /**
  34666. * Add an event to this animation
  34667. * @param event Event to add
  34668. */
  34669. addEvent(event: AnimationEvent): void;
  34670. /**
  34671. * Remove all events found at the given frame
  34672. * @param frame The frame to remove events from
  34673. */
  34674. removeEvents(frame: number): void;
  34675. /**
  34676. * Retrieves all the events from the animation
  34677. * @returns Events from the animation
  34678. */
  34679. getEvents(): AnimationEvent[];
  34680. /**
  34681. * Creates an animation range
  34682. * @param name Name of the animation range
  34683. * @param from Starting frame of the animation range
  34684. * @param to Ending frame of the animation
  34685. */
  34686. createRange(name: string, from: number, to: number): void;
  34687. /**
  34688. * Deletes an animation range by name
  34689. * @param name Name of the animation range to delete
  34690. * @param deleteFrames Specifies if the key frames for the range should also be deleted (true) or not (false)
  34691. */
  34692. deleteRange(name: string, deleteFrames?: boolean): void;
  34693. /**
  34694. * Gets the animation range by name, or null if not defined
  34695. * @param name Name of the animation range
  34696. * @returns Nullable animation range
  34697. */
  34698. getRange(name: string): Nullable<AnimationRange>;
  34699. /**
  34700. * Gets the key frames from the animation
  34701. * @returns The key frames of the animation
  34702. */
  34703. getKeys(): Array<IAnimationKey>;
  34704. /**
  34705. * Gets the highest frame rate of the animation
  34706. * @returns Highest frame rate of the animation
  34707. */
  34708. getHighestFrame(): number;
  34709. /**
  34710. * Gets the easing function of the animation
  34711. * @returns Easing function of the animation
  34712. */
  34713. getEasingFunction(): IEasingFunction;
  34714. /**
  34715. * Sets the easing function of the animation
  34716. * @param easingFunction A custom mathematical formula for animation
  34717. */
  34718. setEasingFunction(easingFunction: EasingFunction): void;
  34719. /**
  34720. * Interpolates a scalar linearly
  34721. * @param startValue Start value of the animation curve
  34722. * @param endValue End value of the animation curve
  34723. * @param gradient Scalar amount to interpolate
  34724. * @returns Interpolated scalar value
  34725. */
  34726. floatInterpolateFunction(startValue: number, endValue: number, gradient: number): number;
  34727. /**
  34728. * Interpolates a scalar cubically
  34729. * @param startValue Start value of the animation curve
  34730. * @param outTangent End tangent of the animation
  34731. * @param endValue End value of the animation curve
  34732. * @param inTangent Start tangent of the animation curve
  34733. * @param gradient Scalar amount to interpolate
  34734. * @returns Interpolated scalar value
  34735. */
  34736. floatInterpolateFunctionWithTangents(startValue: number, outTangent: number, endValue: number, inTangent: number, gradient: number): number;
  34737. /**
  34738. * Interpolates a quaternion using a spherical linear interpolation
  34739. * @param startValue Start value of the animation curve
  34740. * @param endValue End value of the animation curve
  34741. * @param gradient Scalar amount to interpolate
  34742. * @returns Interpolated quaternion value
  34743. */
  34744. quaternionInterpolateFunction(startValue: Quaternion, endValue: Quaternion, gradient: number): Quaternion;
  34745. /**
  34746. * Interpolates a quaternion cubically
  34747. * @param startValue Start value of the animation curve
  34748. * @param outTangent End tangent of the animation curve
  34749. * @param endValue End value of the animation curve
  34750. * @param inTangent Start tangent of the animation curve
  34751. * @param gradient Scalar amount to interpolate
  34752. * @returns Interpolated quaternion value
  34753. */
  34754. quaternionInterpolateFunctionWithTangents(startValue: Quaternion, outTangent: Quaternion, endValue: Quaternion, inTangent: Quaternion, gradient: number): Quaternion;
  34755. /**
  34756. * Interpolates a Vector3 linearl
  34757. * @param startValue Start value of the animation curve
  34758. * @param endValue End value of the animation curve
  34759. * @param gradient Scalar amount to interpolate
  34760. * @returns Interpolated scalar value
  34761. */
  34762. vector3InterpolateFunction(startValue: Vector3, endValue: Vector3, gradient: number): Vector3;
  34763. /**
  34764. * Interpolates a Vector3 cubically
  34765. * @param startValue Start value of the animation curve
  34766. * @param outTangent End tangent of the animation
  34767. * @param endValue End value of the animation curve
  34768. * @param inTangent Start tangent of the animation curve
  34769. * @param gradient Scalar amount to interpolate
  34770. * @returns InterpolatedVector3 value
  34771. */
  34772. vector3InterpolateFunctionWithTangents(startValue: Vector3, outTangent: Vector3, endValue: Vector3, inTangent: Vector3, gradient: number): Vector3;
  34773. /**
  34774. * Interpolates a Vector2 linearly
  34775. * @param startValue Start value of the animation curve
  34776. * @param endValue End value of the animation curve
  34777. * @param gradient Scalar amount to interpolate
  34778. * @returns Interpolated Vector2 value
  34779. */
  34780. vector2InterpolateFunction(startValue: Vector2, endValue: Vector2, gradient: number): Vector2;
  34781. /**
  34782. * Interpolates a Vector2 cubically
  34783. * @param startValue Start value of the animation curve
  34784. * @param outTangent End tangent of the animation
  34785. * @param endValue End value of the animation curve
  34786. * @param inTangent Start tangent of the animation curve
  34787. * @param gradient Scalar amount to interpolate
  34788. * @returns Interpolated Vector2 value
  34789. */
  34790. vector2InterpolateFunctionWithTangents(startValue: Vector2, outTangent: Vector2, endValue: Vector2, inTangent: Vector2, gradient: number): Vector2;
  34791. /**
  34792. * Interpolates a size linearly
  34793. * @param startValue Start value of the animation curve
  34794. * @param endValue End value of the animation curve
  34795. * @param gradient Scalar amount to interpolate
  34796. * @returns Interpolated Size value
  34797. */
  34798. sizeInterpolateFunction(startValue: Size, endValue: Size, gradient: number): Size;
  34799. /**
  34800. * Interpolates a Color3 linearly
  34801. * @param startValue Start value of the animation curve
  34802. * @param endValue End value of the animation curve
  34803. * @param gradient Scalar amount to interpolate
  34804. * @returns Interpolated Color3 value
  34805. */
  34806. color3InterpolateFunction(startValue: Color3, endValue: Color3, gradient: number): Color3;
  34807. /**
  34808. * Interpolates a Color4 linearly
  34809. * @param startValue Start value of the animation curve
  34810. * @param endValue End value of the animation curve
  34811. * @param gradient Scalar amount to interpolate
  34812. * @returns Interpolated Color3 value
  34813. */
  34814. color4InterpolateFunction(startValue: Color4, endValue: Color4, gradient: number): Color4;
  34815. /**
  34816. * @hidden Internal use only
  34817. */
  34818. _getKeyValue(value: any): any;
  34819. /**
  34820. * @hidden Internal use only
  34821. */
  34822. _interpolate(currentFrame: number, state: _IAnimationState): any;
  34823. /**
  34824. * Defines the function to use to interpolate matrices
  34825. * @param startValue defines the start matrix
  34826. * @param endValue defines the end matrix
  34827. * @param gradient defines the gradient between both matrices
  34828. * @param result defines an optional target matrix where to store the interpolation
  34829. * @returns the interpolated matrix
  34830. */
  34831. matrixInterpolateFunction(startValue: Matrix, endValue: Matrix, gradient: number, result?: Matrix): Matrix;
  34832. /**
  34833. * Makes a copy of the animation
  34834. * @returns Cloned animation
  34835. */
  34836. clone(): Animation;
  34837. /**
  34838. * Sets the key frames of the animation
  34839. * @param values The animation key frames to set
  34840. */
  34841. setKeys(values: Array<IAnimationKey>): void;
  34842. /**
  34843. * Serializes the animation to an object
  34844. * @returns Serialized object
  34845. */
  34846. serialize(): any;
  34847. /**
  34848. * Float animation type
  34849. */
  34850. static readonly ANIMATIONTYPE_FLOAT: number;
  34851. /**
  34852. * Vector3 animation type
  34853. */
  34854. static readonly ANIMATIONTYPE_VECTOR3: number;
  34855. /**
  34856. * Quaternion animation type
  34857. */
  34858. static readonly ANIMATIONTYPE_QUATERNION: number;
  34859. /**
  34860. * Matrix animation type
  34861. */
  34862. static readonly ANIMATIONTYPE_MATRIX: number;
  34863. /**
  34864. * Color3 animation type
  34865. */
  34866. static readonly ANIMATIONTYPE_COLOR3: number;
  34867. /**
  34868. * Color3 animation type
  34869. */
  34870. static readonly ANIMATIONTYPE_COLOR4: number;
  34871. /**
  34872. * Vector2 animation type
  34873. */
  34874. static readonly ANIMATIONTYPE_VECTOR2: number;
  34875. /**
  34876. * Size animation type
  34877. */
  34878. static readonly ANIMATIONTYPE_SIZE: number;
  34879. /**
  34880. * Relative Loop Mode
  34881. */
  34882. static readonly ANIMATIONLOOPMODE_RELATIVE: number;
  34883. /**
  34884. * Cycle Loop Mode
  34885. */
  34886. static readonly ANIMATIONLOOPMODE_CYCLE: number;
  34887. /**
  34888. * Constant Loop Mode
  34889. */
  34890. static readonly ANIMATIONLOOPMODE_CONSTANT: number;
  34891. /** @hidden */
  34892. static _UniversalLerp(left: any, right: any, amount: number): any;
  34893. /**
  34894. * Parses an animation object and creates an animation
  34895. * @param parsedAnimation Parsed animation object
  34896. * @returns Animation object
  34897. */
  34898. static Parse(parsedAnimation: any): Animation;
  34899. /**
  34900. * Appends the serialized animations from the source animations
  34901. * @param source Source containing the animations
  34902. * @param destination Target to store the animations
  34903. */
  34904. static AppendSerializedAnimations(source: IAnimatable, destination: any): void;
  34905. /**
  34906. * Creates a new animation or an array of animations from a snippet saved in a remote file
  34907. * @param name defines the name of the animation to create (can be null or empty to use the one from the json data)
  34908. * @param url defines the url to load from
  34909. * @returns a promise that will resolve to the new animation or an array of animations
  34910. */
  34911. static ParseFromFileAsync(name: Nullable<string>, url: string): Promise<Animation | Array<Animation>>;
  34912. /**
  34913. * Creates an animation or an array of animations from a snippet saved by the Inspector
  34914. * @param snippetId defines the snippet to load
  34915. * @returns a promise that will resolve to the new animation or a new array of animations
  34916. */
  34917. static CreateFromSnippetAsync(snippetId: string): Promise<Animation | Array<Animation>>;
  34918. }
  34919. }
  34920. declare module "babylonjs/Animations/animatable.interface" {
  34921. import { Nullable } from "babylonjs/types";
  34922. import { Animation } from "babylonjs/Animations/animation";
  34923. /**
  34924. * Interface containing an array of animations
  34925. */
  34926. export interface IAnimatable {
  34927. /**
  34928. * Array of animations
  34929. */
  34930. animations: Nullable<Array<Animation>>;
  34931. }
  34932. }
  34933. declare module "babylonjs/Misc/decorators" {
  34934. import { Nullable } from "babylonjs/types";
  34935. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  34936. import { Scene } from "babylonjs/scene";
  34937. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  34938. import { FresnelParameters } from "babylonjs/Materials/fresnelParameters";
  34939. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  34940. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  34941. export function expandToProperty(callback: string, targetKey?: Nullable<string>): (target: any, propertyKey: string) => void;
  34942. export function serialize(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34943. export function serializeAsTexture(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34944. export function serializeAsColor3(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34945. export function serializeAsFresnelParameters(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34946. export function serializeAsVector2(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34947. export function serializeAsVector3(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34948. export function serializeAsMeshReference(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34949. export function serializeAsColorCurves(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34950. export function serializeAsColor4(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34951. export function serializeAsImageProcessingConfiguration(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34952. export function serializeAsQuaternion(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34953. export function serializeAsMatrix(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34954. /**
  34955. * Decorator used to define property that can be serialized as reference to a camera
  34956. * @param sourceName defines the name of the property to decorate
  34957. */
  34958. export function serializeAsCameraReference(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34959. /**
  34960. * Class used to help serialization objects
  34961. */
  34962. export class SerializationHelper {
  34963. /** @hidden */
  34964. static _ImageProcessingConfigurationParser: (sourceProperty: any) => ImageProcessingConfiguration;
  34965. /** @hidden */
  34966. static _FresnelParametersParser: (sourceProperty: any) => FresnelParameters;
  34967. /** @hidden */
  34968. static _ColorCurvesParser: (sourceProperty: any) => ColorCurves;
  34969. /** @hidden */
  34970. static _TextureParser: (sourceProperty: any, scene: Scene, rootUrl: string) => Nullable<BaseTexture>;
  34971. /**
  34972. * Appends the serialized animations from the source animations
  34973. * @param source Source containing the animations
  34974. * @param destination Target to store the animations
  34975. */
  34976. static AppendSerializedAnimations(source: IAnimatable, destination: any): void;
  34977. /**
  34978. * Static function used to serialized a specific entity
  34979. * @param entity defines the entity to serialize
  34980. * @param serializationObject defines the optional target obecjt where serialization data will be stored
  34981. * @returns a JSON compatible object representing the serialization of the entity
  34982. */
  34983. static Serialize<T>(entity: T, serializationObject?: any): any;
  34984. /**
  34985. * Creates a new entity from a serialization data object
  34986. * @param creationFunction defines a function used to instanciated the new entity
  34987. * @param source defines the source serialization data
  34988. * @param scene defines the hosting scene
  34989. * @param rootUrl defines the root url for resources
  34990. * @returns a new entity
  34991. */
  34992. static Parse<T>(creationFunction: () => T, source: any, scene: Nullable<Scene>, rootUrl?: Nullable<string>): T;
  34993. /**
  34994. * Clones an object
  34995. * @param creationFunction defines the function used to instanciate the new object
  34996. * @param source defines the source object
  34997. * @returns the cloned object
  34998. */
  34999. static Clone<T>(creationFunction: () => T, source: T): T;
  35000. /**
  35001. * Instanciates a new object based on a source one (some data will be shared between both object)
  35002. * @param creationFunction defines the function used to instanciate the new object
  35003. * @param source defines the source object
  35004. * @returns the new object
  35005. */
  35006. static Instanciate<T>(creationFunction: () => T, source: T): T;
  35007. }
  35008. }
  35009. declare module "babylonjs/Materials/Textures/baseTexture" {
  35010. import { Observable } from "babylonjs/Misc/observable";
  35011. import { Nullable } from "babylonjs/types";
  35012. import { Scene } from "babylonjs/scene";
  35013. import { Matrix } from "babylonjs/Maths/math.vector";
  35014. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  35015. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  35016. import { ISize } from "babylonjs/Maths/math.size";
  35017. import "babylonjs/Misc/fileTools";
  35018. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  35019. /**
  35020. * Base class of all the textures in babylon.
  35021. * It groups all the common properties the materials, post process, lights... might need
  35022. * in order to make a correct use of the texture.
  35023. */
  35024. export class BaseTexture implements IAnimatable {
  35025. /**
  35026. * Default anisotropic filtering level for the application.
  35027. * It is set to 4 as a good tradeoff between perf and quality.
  35028. */
  35029. static DEFAULT_ANISOTROPIC_FILTERING_LEVEL: number;
  35030. /**
  35031. * Gets or sets the unique id of the texture
  35032. */
  35033. uniqueId: number;
  35034. /**
  35035. * Define the name of the texture.
  35036. */
  35037. name: string;
  35038. /**
  35039. * Gets or sets an object used to store user defined information.
  35040. */
  35041. metadata: any;
  35042. /**
  35043. * For internal use only. Please do not use.
  35044. */
  35045. reservedDataStore: any;
  35046. private _hasAlpha;
  35047. /**
  35048. * Define if the texture is having a usable alpha value (can be use for transparency or glossiness for instance).
  35049. */
  35050. set hasAlpha(value: boolean);
  35051. get hasAlpha(): boolean;
  35052. /**
  35053. * Defines if the alpha value should be determined via the rgb values.
  35054. * If true the luminance of the pixel might be used to find the corresponding alpha value.
  35055. */
  35056. getAlphaFromRGB: boolean;
  35057. /**
  35058. * Intensity or strength of the texture.
  35059. * It is commonly used by materials to fine tune the intensity of the texture
  35060. */
  35061. level: number;
  35062. /**
  35063. * Define the UV chanel to use starting from 0 and defaulting to 0.
  35064. * This is part of the texture as textures usually maps to one uv set.
  35065. */
  35066. coordinatesIndex: number;
  35067. private _coordinatesMode;
  35068. /**
  35069. * How a texture is mapped.
  35070. *
  35071. * | Value | Type | Description |
  35072. * | ----- | ----------------------------------- | ----------- |
  35073. * | 0 | EXPLICIT_MODE | |
  35074. * | 1 | SPHERICAL_MODE | |
  35075. * | 2 | PLANAR_MODE | |
  35076. * | 3 | CUBIC_MODE | |
  35077. * | 4 | PROJECTION_MODE | |
  35078. * | 5 | SKYBOX_MODE | |
  35079. * | 6 | INVCUBIC_MODE | |
  35080. * | 7 | EQUIRECTANGULAR_MODE | |
  35081. * | 8 | FIXED_EQUIRECTANGULAR_MODE | |
  35082. * | 9 | FIXED_EQUIRECTANGULAR_MIRRORED_MODE | |
  35083. */
  35084. set coordinatesMode(value: number);
  35085. get coordinatesMode(): number;
  35086. /**
  35087. * | Value | Type | Description |
  35088. * | ----- | ------------------ | ----------- |
  35089. * | 0 | CLAMP_ADDRESSMODE | |
  35090. * | 1 | WRAP_ADDRESSMODE | |
  35091. * | 2 | MIRROR_ADDRESSMODE | |
  35092. */
  35093. wrapU: number;
  35094. /**
  35095. * | Value | Type | Description |
  35096. * | ----- | ------------------ | ----------- |
  35097. * | 0 | CLAMP_ADDRESSMODE | |
  35098. * | 1 | WRAP_ADDRESSMODE | |
  35099. * | 2 | MIRROR_ADDRESSMODE | |
  35100. */
  35101. wrapV: number;
  35102. /**
  35103. * | Value | Type | Description |
  35104. * | ----- | ------------------ | ----------- |
  35105. * | 0 | CLAMP_ADDRESSMODE | |
  35106. * | 1 | WRAP_ADDRESSMODE | |
  35107. * | 2 | MIRROR_ADDRESSMODE | |
  35108. */
  35109. wrapR: number;
  35110. /**
  35111. * With compliant hardware and browser (supporting anisotropic filtering)
  35112. * this defines the level of anisotropic filtering in the texture.
  35113. * The higher the better but the slower. This defaults to 4 as it seems to be the best tradeoff.
  35114. */
  35115. anisotropicFilteringLevel: number;
  35116. /**
  35117. * Define if the texture is a cube texture or if false a 2d texture.
  35118. */
  35119. get isCube(): boolean;
  35120. set isCube(value: boolean);
  35121. /**
  35122. * Define if the texture is a 3d texture (webgl 2) or if false a 2d texture.
  35123. */
  35124. get is3D(): boolean;
  35125. set is3D(value: boolean);
  35126. /**
  35127. * Define if the texture is a 2d array texture (webgl 2) or if false a 2d texture.
  35128. */
  35129. get is2DArray(): boolean;
  35130. set is2DArray(value: boolean);
  35131. /**
  35132. * Define if the texture contains data in gamma space (most of the png/jpg aside bump).
  35133. * HDR texture are usually stored in linear space.
  35134. * This only impacts the PBR and Background materials
  35135. */
  35136. gammaSpace: boolean;
  35137. /**
  35138. * Gets or sets whether or not the texture contains RGBD data.
  35139. */
  35140. get isRGBD(): boolean;
  35141. set isRGBD(value: boolean);
  35142. /**
  35143. * Is Z inverted in the texture (useful in a cube texture).
  35144. */
  35145. invertZ: boolean;
  35146. /**
  35147. * Are mip maps generated for this texture or not.
  35148. */
  35149. get noMipmap(): boolean;
  35150. /**
  35151. * @hidden
  35152. */
  35153. lodLevelInAlpha: boolean;
  35154. /**
  35155. * With prefiltered texture, defined the offset used during the prefiltering steps.
  35156. */
  35157. get lodGenerationOffset(): number;
  35158. set lodGenerationOffset(value: number);
  35159. /**
  35160. * With prefiltered texture, defined the scale used during the prefiltering steps.
  35161. */
  35162. get lodGenerationScale(): number;
  35163. set lodGenerationScale(value: number);
  35164. /**
  35165. * With prefiltered texture, defined if the specular generation is based on a linear ramp.
  35166. * By default we are using a log2 of the linear roughness helping to keep a better resolution for
  35167. * average roughness values.
  35168. */
  35169. get linearSpecularLOD(): boolean;
  35170. set linearSpecularLOD(value: boolean);
  35171. /**
  35172. * In case a better definition than spherical harmonics is required for the diffuse part of the environment.
  35173. * You can set the irradiance texture to rely on a texture instead of the spherical approach.
  35174. * This texture need to have the same characteristics than its parent (Cube vs 2d, coordinates mode, Gamma/Linear, RGBD).
  35175. */
  35176. get irradianceTexture(): Nullable<BaseTexture>;
  35177. set irradianceTexture(value: Nullable<BaseTexture>);
  35178. /**
  35179. * Define if the texture is a render target.
  35180. */
  35181. isRenderTarget: boolean;
  35182. /**
  35183. * Define the unique id of the texture in the scene.
  35184. */
  35185. get uid(): string;
  35186. /** @hidden */
  35187. _prefiltered: boolean;
  35188. /**
  35189. * Return a string representation of the texture.
  35190. * @returns the texture as a string
  35191. */
  35192. toString(): string;
  35193. /**
  35194. * Get the class name of the texture.
  35195. * @returns "BaseTexture"
  35196. */
  35197. getClassName(): string;
  35198. /**
  35199. * Define the list of animation attached to the texture.
  35200. */
  35201. animations: import("babylonjs/Animations/animation").Animation[];
  35202. /**
  35203. * An event triggered when the texture is disposed.
  35204. */
  35205. onDisposeObservable: Observable<BaseTexture>;
  35206. private _onDisposeObserver;
  35207. /**
  35208. * Callback triggered when the texture has been disposed.
  35209. * Kept for back compatibility, you can use the onDisposeObservable instead.
  35210. */
  35211. set onDispose(callback: () => void);
  35212. /**
  35213. * Define the current state of the loading sequence when in delayed load mode.
  35214. */
  35215. delayLoadState: number;
  35216. protected _scene: Nullable<Scene>;
  35217. protected _engine: Nullable<ThinEngine>;
  35218. /** @hidden */
  35219. _texture: Nullable<InternalTexture>;
  35220. private _uid;
  35221. /**
  35222. * Define if the texture is preventinga material to render or not.
  35223. * If not and the texture is not ready, the engine will use a default black texture instead.
  35224. */
  35225. get isBlocking(): boolean;
  35226. /**
  35227. * Instantiates a new BaseTexture.
  35228. * Base class of all the textures in babylon.
  35229. * It groups all the common properties the materials, post process, lights... might need
  35230. * in order to make a correct use of the texture.
  35231. * @param sceneOrEngine Define the scene or engine the texture blongs to
  35232. */
  35233. constructor(sceneOrEngine: Nullable<Scene | ThinEngine>);
  35234. /**
  35235. * Get the scene the texture belongs to.
  35236. * @returns the scene or null if undefined
  35237. */
  35238. getScene(): Nullable<Scene>;
  35239. /** @hidden */
  35240. protected _getEngine(): Nullable<ThinEngine>;
  35241. /**
  35242. * Get the texture transform matrix used to offset tile the texture for istance.
  35243. * @returns the transformation matrix
  35244. */
  35245. getTextureMatrix(): Matrix;
  35246. /**
  35247. * Get the texture reflection matrix used to rotate/transform the reflection.
  35248. * @returns the reflection matrix
  35249. */
  35250. getReflectionTextureMatrix(): Matrix;
  35251. /**
  35252. * Get the underlying lower level texture from Babylon.
  35253. * @returns the insternal texture
  35254. */
  35255. getInternalTexture(): Nullable<InternalTexture>;
  35256. /**
  35257. * Get if the texture is ready to be consumed (either it is ready or it is not blocking)
  35258. * @returns true if ready or not blocking
  35259. */
  35260. isReadyOrNotBlocking(): boolean;
  35261. /**
  35262. * Get if the texture is ready to be used (downloaded, converted, mip mapped...).
  35263. * @returns true if fully ready
  35264. */
  35265. isReady(): boolean;
  35266. private _cachedSize;
  35267. /**
  35268. * Get the size of the texture.
  35269. * @returns the texture size.
  35270. */
  35271. getSize(): ISize;
  35272. /**
  35273. * Get the base size of the texture.
  35274. * It can be different from the size if the texture has been resized for POT for instance
  35275. * @returns the base size
  35276. */
  35277. getBaseSize(): ISize;
  35278. /**
  35279. * Update the sampling mode of the texture.
  35280. * Default is Trilinear mode.
  35281. *
  35282. * | Value | Type | Description |
  35283. * | ----- | ------------------ | ----------- |
  35284. * | 1 | NEAREST_SAMPLINGMODE or NEAREST_NEAREST_MIPLINEAR | Nearest is: mag = nearest, min = nearest, mip = linear |
  35285. * | 2 | BILINEAR_SAMPLINGMODE or LINEAR_LINEAR_MIPNEAREST | Bilinear is: mag = linear, min = linear, mip = nearest |
  35286. * | 3 | TRILINEAR_SAMPLINGMODE or LINEAR_LINEAR_MIPLINEAR | Trilinear is: mag = linear, min = linear, mip = linear |
  35287. * | 4 | NEAREST_NEAREST_MIPNEAREST | |
  35288. * | 5 | NEAREST_LINEAR_MIPNEAREST | |
  35289. * | 6 | NEAREST_LINEAR_MIPLINEAR | |
  35290. * | 7 | NEAREST_LINEAR | |
  35291. * | 8 | NEAREST_NEAREST | |
  35292. * | 9 | LINEAR_NEAREST_MIPNEAREST | |
  35293. * | 10 | LINEAR_NEAREST_MIPLINEAR | |
  35294. * | 11 | LINEAR_LINEAR | |
  35295. * | 12 | LINEAR_NEAREST | |
  35296. *
  35297. * > _mag_: magnification filter (close to the viewer)
  35298. * > _min_: minification filter (far from the viewer)
  35299. * > _mip_: filter used between mip map levels
  35300. *@param samplingMode Define the new sampling mode of the texture
  35301. */
  35302. updateSamplingMode(samplingMode: number): void;
  35303. /**
  35304. * Scales the texture if is `canRescale()`
  35305. * @param ratio the resize factor we want to use to rescale
  35306. */
  35307. scale(ratio: number): void;
  35308. /**
  35309. * Get if the texture can rescale.
  35310. */
  35311. get canRescale(): boolean;
  35312. /** @hidden */
  35313. _getFromCache(url: Nullable<string>, noMipmap: boolean, sampling?: number, invertY?: boolean): Nullable<InternalTexture>;
  35314. /** @hidden */
  35315. _rebuild(): void;
  35316. /**
  35317. * Triggers the load sequence in delayed load mode.
  35318. */
  35319. delayLoad(): void;
  35320. /**
  35321. * Clones the texture.
  35322. * @returns the cloned texture
  35323. */
  35324. clone(): Nullable<BaseTexture>;
  35325. /**
  35326. * Get the texture underlying type (INT, FLOAT...)
  35327. */
  35328. get textureType(): number;
  35329. /**
  35330. * Get the texture underlying format (RGB, RGBA...)
  35331. */
  35332. get textureFormat(): number;
  35333. /**
  35334. * Indicates that textures need to be re-calculated for all materials
  35335. */
  35336. protected _markAllSubMeshesAsTexturesDirty(): void;
  35337. /**
  35338. * Reads the pixels stored in the webgl texture and returns them as an ArrayBuffer.
  35339. * This will returns an RGBA array buffer containing either in values (0-255) or
  35340. * float values (0-1) depending of the underlying buffer type.
  35341. * @param faceIndex defines the face of the texture to read (in case of cube texture)
  35342. * @param level defines the LOD level of the texture to read (in case of Mip Maps)
  35343. * @param buffer defines a user defined buffer to fill with data (can be null)
  35344. * @returns The Array buffer containing the pixels data.
  35345. */
  35346. readPixels(faceIndex?: number, level?: number, buffer?: Nullable<ArrayBufferView>): Nullable<ArrayBufferView>;
  35347. /**
  35348. * Release and destroy the underlying lower level texture aka internalTexture.
  35349. */
  35350. releaseInternalTexture(): void;
  35351. /** @hidden */
  35352. get _lodTextureHigh(): Nullable<BaseTexture>;
  35353. /** @hidden */
  35354. get _lodTextureMid(): Nullable<BaseTexture>;
  35355. /** @hidden */
  35356. get _lodTextureLow(): Nullable<BaseTexture>;
  35357. /**
  35358. * Dispose the texture and release its associated resources.
  35359. */
  35360. dispose(): void;
  35361. /**
  35362. * Serialize the texture into a JSON representation that can be parsed later on.
  35363. * @returns the JSON representation of the texture
  35364. */
  35365. serialize(): any;
  35366. /**
  35367. * Helper function to be called back once a list of texture contains only ready textures.
  35368. * @param textures Define the list of textures to wait for
  35369. * @param callback Define the callback triggered once the entire list will be ready
  35370. */
  35371. static WhenAllReady(textures: BaseTexture[], callback: () => void): void;
  35372. private static _isScene;
  35373. }
  35374. }
  35375. declare module "babylonjs/Materials/effect" {
  35376. import { Observable } from "babylonjs/Misc/observable";
  35377. import { Nullable } from "babylonjs/types";
  35378. import { IDisposable } from "babylonjs/scene";
  35379. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  35380. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  35381. import { IMatrixLike, IVector2Like, IVector3Like, IVector4Like, IColor3Like, IColor4Like } from "babylonjs/Maths/math.like";
  35382. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  35383. import { IEffectFallbacks } from "babylonjs/Materials/iEffectFallbacks";
  35384. import { Engine } from "babylonjs/Engines/engine";
  35385. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  35386. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  35387. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  35388. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  35389. /**
  35390. * Options to be used when creating an effect.
  35391. */
  35392. export interface IEffectCreationOptions {
  35393. /**
  35394. * Atrributes that will be used in the shader.
  35395. */
  35396. attributes: string[];
  35397. /**
  35398. * Uniform varible names that will be set in the shader.
  35399. */
  35400. uniformsNames: string[];
  35401. /**
  35402. * Uniform buffer variable names that will be set in the shader.
  35403. */
  35404. uniformBuffersNames: string[];
  35405. /**
  35406. * Sampler texture variable names that will be set in the shader.
  35407. */
  35408. samplers: string[];
  35409. /**
  35410. * Define statements that will be set in the shader.
  35411. */
  35412. defines: any;
  35413. /**
  35414. * Possible fallbacks for this effect to improve performance when needed.
  35415. */
  35416. fallbacks: Nullable<IEffectFallbacks>;
  35417. /**
  35418. * Callback that will be called when the shader is compiled.
  35419. */
  35420. onCompiled: Nullable<(effect: Effect) => void>;
  35421. /**
  35422. * Callback that will be called if an error occurs during shader compilation.
  35423. */
  35424. onError: Nullable<(effect: Effect, errors: string) => void>;
  35425. /**
  35426. * Parameters to be used with Babylons include syntax to iterate over an array (eg. {lights: 10})
  35427. */
  35428. indexParameters?: any;
  35429. /**
  35430. * Max number of lights that can be used in the shader.
  35431. */
  35432. maxSimultaneousLights?: number;
  35433. /**
  35434. * See https://developer.mozilla.org/en-US/docs/Web/API/WebGL2RenderingContext/transformFeedbackVaryings
  35435. */
  35436. transformFeedbackVaryings?: Nullable<string[]>;
  35437. /**
  35438. * If provided, will be called two times with the vertex and fragment code so that this code can be updated before it is compiled by the GPU
  35439. */
  35440. processFinalCode?: Nullable<(shaderType: string, code: string) => string>;
  35441. /**
  35442. * Is this effect rendering to several color attachments ?
  35443. */
  35444. multiTarget?: boolean;
  35445. }
  35446. /**
  35447. * Effect containing vertex and fragment shader that can be executed on an object.
  35448. */
  35449. export class Effect implements IDisposable {
  35450. /**
  35451. * Gets or sets the relative url used to load shaders if using the engine in non-minified mode
  35452. */
  35453. static ShadersRepository: string;
  35454. /**
  35455. * Enable logging of the shader code when a compilation error occurs
  35456. */
  35457. static LogShaderCodeOnCompilationError: boolean;
  35458. /**
  35459. * Name of the effect.
  35460. */
  35461. name: any;
  35462. /**
  35463. * String container all the define statements that should be set on the shader.
  35464. */
  35465. defines: string;
  35466. /**
  35467. * Callback that will be called when the shader is compiled.
  35468. */
  35469. onCompiled: Nullable<(effect: Effect) => void>;
  35470. /**
  35471. * Callback that will be called if an error occurs during shader compilation.
  35472. */
  35473. onError: Nullable<(effect: Effect, errors: string) => void>;
  35474. /**
  35475. * Callback that will be called when effect is bound.
  35476. */
  35477. onBind: Nullable<(effect: Effect) => void>;
  35478. /**
  35479. * Unique ID of the effect.
  35480. */
  35481. uniqueId: number;
  35482. /**
  35483. * Observable that will be called when the shader is compiled.
  35484. * It is recommended to use executeWhenCompile() or to make sure that scene.isReady() is called to get this observable raised.
  35485. */
  35486. onCompileObservable: Observable<Effect>;
  35487. /**
  35488. * Observable that will be called if an error occurs during shader compilation.
  35489. */
  35490. onErrorObservable: Observable<Effect>;
  35491. /** @hidden */
  35492. _onBindObservable: Nullable<Observable<Effect>>;
  35493. /**
  35494. * @hidden
  35495. * Specifies if the effect was previously ready
  35496. */
  35497. _wasPreviouslyReady: boolean;
  35498. /**
  35499. * Observable that will be called when effect is bound.
  35500. */
  35501. get onBindObservable(): Observable<Effect>;
  35502. /** @hidden */
  35503. _bonesComputationForcedToCPU: boolean;
  35504. /** @hidden */
  35505. _multiTarget: boolean;
  35506. private static _uniqueIdSeed;
  35507. private _engine;
  35508. private _uniformBuffersNames;
  35509. private _uniformBuffersNamesList;
  35510. private _uniformsNames;
  35511. private _samplerList;
  35512. private _samplers;
  35513. private _isReady;
  35514. private _compilationError;
  35515. private _allFallbacksProcessed;
  35516. private _attributesNames;
  35517. private _attributes;
  35518. private _attributeLocationByName;
  35519. private _uniforms;
  35520. /**
  35521. * Key for the effect.
  35522. * @hidden
  35523. */
  35524. _key: string;
  35525. private _indexParameters;
  35526. private _fallbacks;
  35527. private _vertexSourceCode;
  35528. private _fragmentSourceCode;
  35529. private _vertexSourceCodeOverride;
  35530. private _fragmentSourceCodeOverride;
  35531. private _transformFeedbackVaryings;
  35532. /**
  35533. * Compiled shader to webGL program.
  35534. * @hidden
  35535. */
  35536. _pipelineContext: Nullable<IPipelineContext>;
  35537. private _valueCache;
  35538. private static _baseCache;
  35539. /**
  35540. * Instantiates an effect.
  35541. * An effect can be used to create/manage/execute vertex and fragment shaders.
  35542. * @param baseName Name of the effect.
  35543. * @param attributesNamesOrOptions List of attribute names that will be passed to the shader or set of all options to create the effect.
  35544. * @param uniformsNamesOrEngine List of uniform variable names that will be passed to the shader or the engine that will be used to render effect.
  35545. * @param samplers List of sampler variables that will be passed to the shader.
  35546. * @param engine Engine to be used to render the effect
  35547. * @param defines Define statements to be added to the shader.
  35548. * @param fallbacks Possible fallbacks for this effect to improve performance when needed.
  35549. * @param onCompiled Callback that will be called when the shader is compiled.
  35550. * @param onError Callback that will be called if an error occurs during shader compilation.
  35551. * @param indexParameters Parameters to be used with Babylons include syntax to iterate over an array (eg. {lights: 10})
  35552. */
  35553. constructor(baseName: any, attributesNamesOrOptions: string[] | IEffectCreationOptions, uniformsNamesOrEngine: string[] | ThinEngine, samplers?: Nullable<string[]>, engine?: ThinEngine, defines?: Nullable<string>, fallbacks?: Nullable<IEffectFallbacks>, onCompiled?: Nullable<(effect: Effect) => void>, onError?: Nullable<(effect: Effect, errors: string) => void>, indexParameters?: any);
  35554. private _useFinalCode;
  35555. /**
  35556. * Unique key for this effect
  35557. */
  35558. get key(): string;
  35559. /**
  35560. * If the effect has been compiled and prepared.
  35561. * @returns if the effect is compiled and prepared.
  35562. */
  35563. isReady(): boolean;
  35564. private _isReadyInternal;
  35565. /**
  35566. * The engine the effect was initialized with.
  35567. * @returns the engine.
  35568. */
  35569. getEngine(): Engine;
  35570. /**
  35571. * The pipeline context for this effect
  35572. * @returns the associated pipeline context
  35573. */
  35574. getPipelineContext(): Nullable<IPipelineContext>;
  35575. /**
  35576. * The set of names of attribute variables for the shader.
  35577. * @returns An array of attribute names.
  35578. */
  35579. getAttributesNames(): string[];
  35580. /**
  35581. * Returns the attribute at the given index.
  35582. * @param index The index of the attribute.
  35583. * @returns The location of the attribute.
  35584. */
  35585. getAttributeLocation(index: number): number;
  35586. /**
  35587. * Returns the attribute based on the name of the variable.
  35588. * @param name of the attribute to look up.
  35589. * @returns the attribute location.
  35590. */
  35591. getAttributeLocationByName(name: string): number;
  35592. /**
  35593. * The number of attributes.
  35594. * @returns the numnber of attributes.
  35595. */
  35596. getAttributesCount(): number;
  35597. /**
  35598. * Gets the index of a uniform variable.
  35599. * @param uniformName of the uniform to look up.
  35600. * @returns the index.
  35601. */
  35602. getUniformIndex(uniformName: string): number;
  35603. /**
  35604. * Returns the attribute based on the name of the variable.
  35605. * @param uniformName of the uniform to look up.
  35606. * @returns the location of the uniform.
  35607. */
  35608. getUniform(uniformName: string): Nullable<WebGLUniformLocation>;
  35609. /**
  35610. * Returns an array of sampler variable names
  35611. * @returns The array of sampler variable names.
  35612. */
  35613. getSamplers(): string[];
  35614. /**
  35615. * Returns an array of uniform variable names
  35616. * @returns The array of uniform variable names.
  35617. */
  35618. getUniformNames(): string[];
  35619. /**
  35620. * Returns an array of uniform buffer variable names
  35621. * @returns The array of uniform buffer variable names.
  35622. */
  35623. getUniformBuffersNames(): string[];
  35624. /**
  35625. * Returns the index parameters used to create the effect
  35626. * @returns The index parameters object
  35627. */
  35628. getIndexParameters(): any;
  35629. /**
  35630. * The error from the last compilation.
  35631. * @returns the error string.
  35632. */
  35633. getCompilationError(): string;
  35634. /**
  35635. * Gets a boolean indicating that all fallbacks were used during compilation
  35636. * @returns true if all fallbacks were used
  35637. */
  35638. allFallbacksProcessed(): boolean;
  35639. /**
  35640. * Adds a callback to the onCompiled observable and call the callback imediatly if already ready.
  35641. * @param func The callback to be used.
  35642. */
  35643. executeWhenCompiled(func: (effect: Effect) => void): void;
  35644. private _checkIsReady;
  35645. private _loadShader;
  35646. /**
  35647. * Gets the vertex shader source code of this effect
  35648. */
  35649. get vertexSourceCode(): string;
  35650. /**
  35651. * Gets the fragment shader source code of this effect
  35652. */
  35653. get fragmentSourceCode(): string;
  35654. /**
  35655. * Recompiles the webGL program
  35656. * @param vertexSourceCode The source code for the vertex shader.
  35657. * @param fragmentSourceCode The source code for the fragment shader.
  35658. * @param onCompiled Callback called when completed.
  35659. * @param onError Callback called on error.
  35660. * @hidden
  35661. */
  35662. _rebuildProgram(vertexSourceCode: string, fragmentSourceCode: string, onCompiled: (pipelineContext: IPipelineContext) => void, onError: (message: string) => void): void;
  35663. /**
  35664. * Prepares the effect
  35665. * @hidden
  35666. */
  35667. _prepareEffect(): void;
  35668. private _getShaderCodeAndErrorLine;
  35669. private _processCompilationErrors;
  35670. /**
  35671. * Checks if the effect is supported. (Must be called after compilation)
  35672. */
  35673. get isSupported(): boolean;
  35674. /**
  35675. * Binds a texture to the engine to be used as output of the shader.
  35676. * @param channel Name of the output variable.
  35677. * @param texture Texture to bind.
  35678. * @hidden
  35679. */
  35680. _bindTexture(channel: string, texture: Nullable<InternalTexture>): void;
  35681. /**
  35682. * Sets a texture on the engine to be used in the shader.
  35683. * @param channel Name of the sampler variable.
  35684. * @param texture Texture to set.
  35685. */
  35686. setTexture(channel: string, texture: Nullable<BaseTexture>): void;
  35687. /**
  35688. * Sets a depth stencil texture from a render target on the engine to be used in the shader.
  35689. * @param channel Name of the sampler variable.
  35690. * @param texture Texture to set.
  35691. */
  35692. setDepthStencilTexture(channel: string, texture: Nullable<RenderTargetTexture>): void;
  35693. /**
  35694. * Sets an array of textures on the engine to be used in the shader.
  35695. * @param channel Name of the variable.
  35696. * @param textures Textures to set.
  35697. */
  35698. setTextureArray(channel: string, textures: BaseTexture[]): void;
  35699. /**
  35700. * Sets a texture to be the input of the specified post process. (To use the output, pass in the next post process in the pipeline)
  35701. * @param channel Name of the sampler variable.
  35702. * @param postProcess Post process to get the input texture from.
  35703. */
  35704. setTextureFromPostProcess(channel: string, postProcess: Nullable<PostProcess>): void;
  35705. /**
  35706. * (Warning! setTextureFromPostProcessOutput may be desired instead)
  35707. * Sets the input texture of the passed in post process to be input of this effect. (To use the output of the passed in post process use setTextureFromPostProcessOutput)
  35708. * @param channel Name of the sampler variable.
  35709. * @param postProcess Post process to get the output texture from.
  35710. */
  35711. setTextureFromPostProcessOutput(channel: string, postProcess: Nullable<PostProcess>): void;
  35712. /** @hidden */
  35713. _cacheMatrix(uniformName: string, matrix: IMatrixLike): boolean;
  35714. /** @hidden */
  35715. _cacheFloat2(uniformName: string, x: number, y: number): boolean;
  35716. /** @hidden */
  35717. _cacheFloat3(uniformName: string, x: number, y: number, z: number): boolean;
  35718. /** @hidden */
  35719. _cacheFloat4(uniformName: string, x: number, y: number, z: number, w: number): boolean;
  35720. /**
  35721. * Binds a buffer to a uniform.
  35722. * @param buffer Buffer to bind.
  35723. * @param name Name of the uniform variable to bind to.
  35724. */
  35725. bindUniformBuffer(buffer: DataBuffer, name: string): void;
  35726. /**
  35727. * Binds block to a uniform.
  35728. * @param blockName Name of the block to bind.
  35729. * @param index Index to bind.
  35730. */
  35731. bindUniformBlock(blockName: string, index: number): void;
  35732. /**
  35733. * Sets an interger value on a uniform variable.
  35734. * @param uniformName Name of the variable.
  35735. * @param value Value to be set.
  35736. * @returns this effect.
  35737. */
  35738. setInt(uniformName: string, value: number): Effect;
  35739. /**
  35740. * Sets an int array on a uniform variable.
  35741. * @param uniformName Name of the variable.
  35742. * @param array array to be set.
  35743. * @returns this effect.
  35744. */
  35745. setIntArray(uniformName: string, array: Int32Array): Effect;
  35746. /**
  35747. * Sets an int array 2 on a uniform variable. (Array is specified as single array eg. [1,2,3,4] will result in [[1,2],[3,4]] in the shader)
  35748. * @param uniformName Name of the variable.
  35749. * @param array array to be set.
  35750. * @returns this effect.
  35751. */
  35752. setIntArray2(uniformName: string, array: Int32Array): Effect;
  35753. /**
  35754. * Sets an int array 3 on a uniform variable. (Array is specified as single array eg. [1,2,3,4,5,6] will result in [[1,2,3],[4,5,6]] in the shader)
  35755. * @param uniformName Name of the variable.
  35756. * @param array array to be set.
  35757. * @returns this effect.
  35758. */
  35759. setIntArray3(uniformName: string, array: Int32Array): Effect;
  35760. /**
  35761. * Sets an int array 4 on a uniform variable. (Array is specified as single array eg. [1,2,3,4,5,6,7,8] will result in [[1,2,3,4],[5,6,7,8]] in the shader)
  35762. * @param uniformName Name of the variable.
  35763. * @param array array to be set.
  35764. * @returns this effect.
  35765. */
  35766. setIntArray4(uniformName: string, array: Int32Array): Effect;
  35767. /**
  35768. * Sets an float array on a uniform variable.
  35769. * @param uniformName Name of the variable.
  35770. * @param array array to be set.
  35771. * @returns this effect.
  35772. */
  35773. setFloatArray(uniformName: string, array: Float32Array): Effect;
  35774. /**
  35775. * Sets an float array 2 on a uniform variable. (Array is specified as single array eg. [1,2,3,4] will result in [[1,2],[3,4]] in the shader)
  35776. * @param uniformName Name of the variable.
  35777. * @param array array to be set.
  35778. * @returns this effect.
  35779. */
  35780. setFloatArray2(uniformName: string, array: Float32Array): Effect;
  35781. /**
  35782. * Sets an float array 3 on a uniform variable. (Array is specified as single array eg. [1,2,3,4,5,6] will result in [[1,2,3],[4,5,6]] in the shader)
  35783. * @param uniformName Name of the variable.
  35784. * @param array array to be set.
  35785. * @returns this effect.
  35786. */
  35787. setFloatArray3(uniformName: string, array: Float32Array): Effect;
  35788. /**
  35789. * Sets an float array 4 on a uniform variable. (Array is specified as single array eg. [1,2,3,4,5,6,7,8] will result in [[1,2,3,4],[5,6,7,8]] in the shader)
  35790. * @param uniformName Name of the variable.
  35791. * @param array array to be set.
  35792. * @returns this effect.
  35793. */
  35794. setFloatArray4(uniformName: string, array: Float32Array): Effect;
  35795. /**
  35796. * Sets an array on a uniform variable.
  35797. * @param uniformName Name of the variable.
  35798. * @param array array to be set.
  35799. * @returns this effect.
  35800. */
  35801. setArray(uniformName: string, array: number[]): Effect;
  35802. /**
  35803. * Sets an array 2 on a uniform variable. (Array is specified as single array eg. [1,2,3,4] will result in [[1,2],[3,4]] in the shader)
  35804. * @param uniformName Name of the variable.
  35805. * @param array array to be set.
  35806. * @returns this effect.
  35807. */
  35808. setArray2(uniformName: string, array: number[]): Effect;
  35809. /**
  35810. * Sets an array 3 on a uniform variable. (Array is specified as single array eg. [1,2,3,4,5,6] will result in [[1,2,3],[4,5,6]] in the shader)
  35811. * @param uniformName Name of the variable.
  35812. * @param array array to be set.
  35813. * @returns this effect.
  35814. */
  35815. setArray3(uniformName: string, array: number[]): Effect;
  35816. /**
  35817. * Sets an array 4 on a uniform variable. (Array is specified as single array eg. [1,2,3,4,5,6,7,8] will result in [[1,2,3,4],[5,6,7,8]] in the shader)
  35818. * @param uniformName Name of the variable.
  35819. * @param array array to be set.
  35820. * @returns this effect.
  35821. */
  35822. setArray4(uniformName: string, array: number[]): Effect;
  35823. /**
  35824. * Sets matrices on a uniform variable.
  35825. * @param uniformName Name of the variable.
  35826. * @param matrices matrices to be set.
  35827. * @returns this effect.
  35828. */
  35829. setMatrices(uniformName: string, matrices: Float32Array | Array<number>): Effect;
  35830. /**
  35831. * Sets matrix on a uniform variable.
  35832. * @param uniformName Name of the variable.
  35833. * @param matrix matrix to be set.
  35834. * @returns this effect.
  35835. */
  35836. setMatrix(uniformName: string, matrix: IMatrixLike): Effect;
  35837. /**
  35838. * Sets a 3x3 matrix on a uniform variable. (Speicified as [1,2,3,4,5,6,7,8,9] will result in [1,2,3][4,5,6][7,8,9] matrix)
  35839. * @param uniformName Name of the variable.
  35840. * @param matrix matrix to be set.
  35841. * @returns this effect.
  35842. */
  35843. setMatrix3x3(uniformName: string, matrix: Float32Array | Array<number>): Effect;
  35844. /**
  35845. * Sets a 2x2 matrix on a uniform variable. (Speicified as [1,2,3,4] will result in [1,2][3,4] matrix)
  35846. * @param uniformName Name of the variable.
  35847. * @param matrix matrix to be set.
  35848. * @returns this effect.
  35849. */
  35850. setMatrix2x2(uniformName: string, matrix: Float32Array | Array<number>): Effect;
  35851. /**
  35852. * Sets a float on a uniform variable.
  35853. * @param uniformName Name of the variable.
  35854. * @param value value to be set.
  35855. * @returns this effect.
  35856. */
  35857. setFloat(uniformName: string, value: number): Effect;
  35858. /**
  35859. * Sets a boolean on a uniform variable.
  35860. * @param uniformName Name of the variable.
  35861. * @param bool value to be set.
  35862. * @returns this effect.
  35863. */
  35864. setBool(uniformName: string, bool: boolean): Effect;
  35865. /**
  35866. * Sets a Vector2 on a uniform variable.
  35867. * @param uniformName Name of the variable.
  35868. * @param vector2 vector2 to be set.
  35869. * @returns this effect.
  35870. */
  35871. setVector2(uniformName: string, vector2: IVector2Like): Effect;
  35872. /**
  35873. * Sets a float2 on a uniform variable.
  35874. * @param uniformName Name of the variable.
  35875. * @param x First float in float2.
  35876. * @param y Second float in float2.
  35877. * @returns this effect.
  35878. */
  35879. setFloat2(uniformName: string, x: number, y: number): Effect;
  35880. /**
  35881. * Sets a Vector3 on a uniform variable.
  35882. * @param uniformName Name of the variable.
  35883. * @param vector3 Value to be set.
  35884. * @returns this effect.
  35885. */
  35886. setVector3(uniformName: string, vector3: IVector3Like): Effect;
  35887. /**
  35888. * Sets a float3 on a uniform variable.
  35889. * @param uniformName Name of the variable.
  35890. * @param x First float in float3.
  35891. * @param y Second float in float3.
  35892. * @param z Third float in float3.
  35893. * @returns this effect.
  35894. */
  35895. setFloat3(uniformName: string, x: number, y: number, z: number): Effect;
  35896. /**
  35897. * Sets a Vector4 on a uniform variable.
  35898. * @param uniformName Name of the variable.
  35899. * @param vector4 Value to be set.
  35900. * @returns this effect.
  35901. */
  35902. setVector4(uniformName: string, vector4: IVector4Like): Effect;
  35903. /**
  35904. * Sets a float4 on a uniform variable.
  35905. * @param uniformName Name of the variable.
  35906. * @param x First float in float4.
  35907. * @param y Second float in float4.
  35908. * @param z Third float in float4.
  35909. * @param w Fourth float in float4.
  35910. * @returns this effect.
  35911. */
  35912. setFloat4(uniformName: string, x: number, y: number, z: number, w: number): Effect;
  35913. /**
  35914. * Sets a Color3 on a uniform variable.
  35915. * @param uniformName Name of the variable.
  35916. * @param color3 Value to be set.
  35917. * @returns this effect.
  35918. */
  35919. setColor3(uniformName: string, color3: IColor3Like): Effect;
  35920. /**
  35921. * Sets a Color4 on a uniform variable.
  35922. * @param uniformName Name of the variable.
  35923. * @param color3 Value to be set.
  35924. * @param alpha Alpha value to be set.
  35925. * @returns this effect.
  35926. */
  35927. setColor4(uniformName: string, color3: IColor3Like, alpha: number): Effect;
  35928. /**
  35929. * Sets a Color4 on a uniform variable
  35930. * @param uniformName defines the name of the variable
  35931. * @param color4 defines the value to be set
  35932. * @returns this effect.
  35933. */
  35934. setDirectColor4(uniformName: string, color4: IColor4Like): Effect;
  35935. /** Release all associated resources */
  35936. dispose(): void;
  35937. /**
  35938. * This function will add a new shader to the shader store
  35939. * @param name the name of the shader
  35940. * @param pixelShader optional pixel shader content
  35941. * @param vertexShader optional vertex shader content
  35942. */
  35943. static RegisterShader(name: string, pixelShader?: string, vertexShader?: string): void;
  35944. /**
  35945. * Store of each shader (The can be looked up using effect.key)
  35946. */
  35947. static ShadersStore: {
  35948. [key: string]: string;
  35949. };
  35950. /**
  35951. * Store of each included file for a shader (The can be looked up using effect.key)
  35952. */
  35953. static IncludesShadersStore: {
  35954. [key: string]: string;
  35955. };
  35956. /**
  35957. * Resets the cache of effects.
  35958. */
  35959. static ResetCache(): void;
  35960. }
  35961. }
  35962. declare module "babylonjs/Engines/engineCapabilities" {
  35963. /**
  35964. * Interface used to describe the capabilities of the engine relatively to the current browser
  35965. */
  35966. export interface EngineCapabilities {
  35967. /** Maximum textures units per fragment shader */
  35968. maxTexturesImageUnits: number;
  35969. /** Maximum texture units per vertex shader */
  35970. maxVertexTextureImageUnits: number;
  35971. /** Maximum textures units in the entire pipeline */
  35972. maxCombinedTexturesImageUnits: number;
  35973. /** Maximum texture size */
  35974. maxTextureSize: number;
  35975. /** Maximum texture samples */
  35976. maxSamples?: number;
  35977. /** Maximum cube texture size */
  35978. maxCubemapTextureSize: number;
  35979. /** Maximum render texture size */
  35980. maxRenderTextureSize: number;
  35981. /** Maximum number of vertex attributes */
  35982. maxVertexAttribs: number;
  35983. /** Maximum number of varyings */
  35984. maxVaryingVectors: number;
  35985. /** Maximum number of uniforms per vertex shader */
  35986. maxVertexUniformVectors: number;
  35987. /** Maximum number of uniforms per fragment shader */
  35988. maxFragmentUniformVectors: number;
  35989. /** Defines if standard derivates (dx/dy) are supported */
  35990. standardDerivatives: boolean;
  35991. /** Defines if s3tc texture compression is supported */
  35992. s3tc?: WEBGL_compressed_texture_s3tc;
  35993. /** Defines if pvrtc texture compression is supported */
  35994. pvrtc: any;
  35995. /** Defines if etc1 texture compression is supported */
  35996. etc1: any;
  35997. /** Defines if etc2 texture compression is supported */
  35998. etc2: any;
  35999. /** Defines if astc texture compression is supported */
  36000. astc: any;
  36001. /** Defines if float textures are supported */
  36002. textureFloat: boolean;
  36003. /** Defines if vertex array objects are supported */
  36004. vertexArrayObject: boolean;
  36005. /** Gets the webgl extension for anisotropic filtering (null if not supported) */
  36006. textureAnisotropicFilterExtension?: EXT_texture_filter_anisotropic;
  36007. /** Gets the maximum level of anisotropy supported */
  36008. maxAnisotropy: number;
  36009. /** Defines if instancing is supported */
  36010. instancedArrays: boolean;
  36011. /** Defines if 32 bits indices are supported */
  36012. uintIndices: boolean;
  36013. /** Defines if high precision shaders are supported */
  36014. highPrecisionShaderSupported: boolean;
  36015. /** Defines if depth reading in the fragment shader is supported */
  36016. fragmentDepthSupported: boolean;
  36017. /** Defines if float texture linear filtering is supported*/
  36018. textureFloatLinearFiltering: boolean;
  36019. /** Defines if rendering to float textures is supported */
  36020. textureFloatRender: boolean;
  36021. /** Defines if half float textures are supported*/
  36022. textureHalfFloat: boolean;
  36023. /** Defines if half float texture linear filtering is supported*/
  36024. textureHalfFloatLinearFiltering: boolean;
  36025. /** Defines if rendering to half float textures is supported */
  36026. textureHalfFloatRender: boolean;
  36027. /** Defines if textureLOD shader command is supported */
  36028. textureLOD: boolean;
  36029. /** Defines if draw buffers extension is supported */
  36030. drawBuffersExtension: boolean;
  36031. /** Defines if depth textures are supported */
  36032. depthTextureExtension: boolean;
  36033. /** Defines if float color buffer are supported */
  36034. colorBufferFloat: boolean;
  36035. /** Gets disjoint timer query extension (null if not supported) */
  36036. timerQuery?: EXT_disjoint_timer_query;
  36037. /** Defines if timestamp can be used with timer query */
  36038. canUseTimestampForTimerQuery: boolean;
  36039. /** Defines if multiview is supported (https://www.khronos.org/registry/webgl/extensions/WEBGL_multiview/) */
  36040. multiview?: any;
  36041. /** Defines if oculus multiview is supported (https://developer.oculus.com/documentation/oculus-browser/latest/concepts/browser-multiview/) */
  36042. oculusMultiview?: any;
  36043. /** Function used to let the system compiles shaders in background */
  36044. parallelShaderCompile?: {
  36045. COMPLETION_STATUS_KHR: number;
  36046. };
  36047. /** Max number of texture samples for MSAA */
  36048. maxMSAASamples: number;
  36049. /** Defines if the blend min max extension is supported */
  36050. blendMinMax: boolean;
  36051. }
  36052. }
  36053. declare module "babylonjs/States/depthCullingState" {
  36054. import { Nullable } from "babylonjs/types";
  36055. /**
  36056. * @hidden
  36057. **/
  36058. export class DepthCullingState {
  36059. private _isDepthTestDirty;
  36060. private _isDepthMaskDirty;
  36061. private _isDepthFuncDirty;
  36062. private _isCullFaceDirty;
  36063. private _isCullDirty;
  36064. private _isZOffsetDirty;
  36065. private _isFrontFaceDirty;
  36066. private _depthTest;
  36067. private _depthMask;
  36068. private _depthFunc;
  36069. private _cull;
  36070. private _cullFace;
  36071. private _zOffset;
  36072. private _frontFace;
  36073. /**
  36074. * Initializes the state.
  36075. */
  36076. constructor();
  36077. get isDirty(): boolean;
  36078. get zOffset(): number;
  36079. set zOffset(value: number);
  36080. get cullFace(): Nullable<number>;
  36081. set cullFace(value: Nullable<number>);
  36082. get cull(): Nullable<boolean>;
  36083. set cull(value: Nullable<boolean>);
  36084. get depthFunc(): Nullable<number>;
  36085. set depthFunc(value: Nullable<number>);
  36086. get depthMask(): boolean;
  36087. set depthMask(value: boolean);
  36088. get depthTest(): boolean;
  36089. set depthTest(value: boolean);
  36090. get frontFace(): Nullable<number>;
  36091. set frontFace(value: Nullable<number>);
  36092. reset(): void;
  36093. apply(gl: WebGLRenderingContext): void;
  36094. }
  36095. }
  36096. declare module "babylonjs/States/stencilState" {
  36097. /**
  36098. * @hidden
  36099. **/
  36100. export class StencilState {
  36101. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will always pass. i.e. Pixels will be drawn in the order they are drawn */
  36102. static readonly ALWAYS: number;
  36103. /** Passed to stencilOperation to specify that stencil value must be kept */
  36104. static readonly KEEP: number;
  36105. /** Passed to stencilOperation to specify that stencil value must be replaced */
  36106. static readonly REPLACE: number;
  36107. private _isStencilTestDirty;
  36108. private _isStencilMaskDirty;
  36109. private _isStencilFuncDirty;
  36110. private _isStencilOpDirty;
  36111. private _stencilTest;
  36112. private _stencilMask;
  36113. private _stencilFunc;
  36114. private _stencilFuncRef;
  36115. private _stencilFuncMask;
  36116. private _stencilOpStencilFail;
  36117. private _stencilOpDepthFail;
  36118. private _stencilOpStencilDepthPass;
  36119. get isDirty(): boolean;
  36120. get stencilFunc(): number;
  36121. set stencilFunc(value: number);
  36122. get stencilFuncRef(): number;
  36123. set stencilFuncRef(value: number);
  36124. get stencilFuncMask(): number;
  36125. set stencilFuncMask(value: number);
  36126. get stencilOpStencilFail(): number;
  36127. set stencilOpStencilFail(value: number);
  36128. get stencilOpDepthFail(): number;
  36129. set stencilOpDepthFail(value: number);
  36130. get stencilOpStencilDepthPass(): number;
  36131. set stencilOpStencilDepthPass(value: number);
  36132. get stencilMask(): number;
  36133. set stencilMask(value: number);
  36134. get stencilTest(): boolean;
  36135. set stencilTest(value: boolean);
  36136. constructor();
  36137. reset(): void;
  36138. apply(gl: WebGLRenderingContext): void;
  36139. }
  36140. }
  36141. declare module "babylonjs/States/alphaCullingState" {
  36142. /**
  36143. * @hidden
  36144. **/
  36145. export class AlphaState {
  36146. private _isAlphaBlendDirty;
  36147. private _isBlendFunctionParametersDirty;
  36148. private _isBlendEquationParametersDirty;
  36149. private _isBlendConstantsDirty;
  36150. private _alphaBlend;
  36151. private _blendFunctionParameters;
  36152. private _blendEquationParameters;
  36153. private _blendConstants;
  36154. /**
  36155. * Initializes the state.
  36156. */
  36157. constructor();
  36158. get isDirty(): boolean;
  36159. get alphaBlend(): boolean;
  36160. set alphaBlend(value: boolean);
  36161. setAlphaBlendConstants(r: number, g: number, b: number, a: number): void;
  36162. setAlphaBlendFunctionParameters(value0: number, value1: number, value2: number, value3: number): void;
  36163. setAlphaEquationParameters(rgb: number, alpha: number): void;
  36164. reset(): void;
  36165. apply(gl: WebGLRenderingContext): void;
  36166. }
  36167. }
  36168. declare module "babylonjs/Engines/WebGL/webGL2ShaderProcessors" {
  36169. import { IShaderProcessor } from "babylonjs/Engines/Processors/iShaderProcessor";
  36170. /** @hidden */
  36171. export class WebGL2ShaderProcessor implements IShaderProcessor {
  36172. attributeProcessor(attribute: string): string;
  36173. varyingProcessor(varying: string, isFragment: boolean): string;
  36174. postProcessor(code: string, defines: string[], isFragment: boolean): string;
  36175. }
  36176. }
  36177. declare module "babylonjs/Engines/instancingAttributeInfo" {
  36178. /**
  36179. * Interface for attribute information associated with buffer instanciation
  36180. */
  36181. export interface InstancingAttributeInfo {
  36182. /**
  36183. * Name of the GLSL attribute
  36184. * if attribute index is not specified, this is used to retrieve the index from the effect
  36185. */
  36186. attributeName: string;
  36187. /**
  36188. * Index/offset of the attribute in the vertex shader
  36189. * if not specified, this will be computes from the name.
  36190. */
  36191. index?: number;
  36192. /**
  36193. * size of the attribute, 1, 2, 3 or 4
  36194. */
  36195. attributeSize: number;
  36196. /**
  36197. * Offset of the data in the Vertex Buffer acting as the instancing buffer
  36198. */
  36199. offset: number;
  36200. /**
  36201. * Modifies the rate at which generic vertex attributes advance when rendering multiple instances
  36202. * default to 1
  36203. */
  36204. divisor?: number;
  36205. /**
  36206. * type of the attribute, gl.BYTE, gl.UNSIGNED_BYTE, gl.SHORT, gl.UNSIGNED_SHORT, gl.FIXED, gl.FLOAT.
  36207. * default is FLOAT
  36208. */
  36209. attributeType?: number;
  36210. /**
  36211. * normalization of fixed-point data. behavior unclear, use FALSE, default is FALSE
  36212. */
  36213. normalized?: boolean;
  36214. }
  36215. }
  36216. declare module "babylonjs/Engines/Extensions/engine.videoTexture" {
  36217. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  36218. import { Nullable } from "babylonjs/types";
  36219. module "babylonjs/Engines/thinEngine" {
  36220. interface ThinEngine {
  36221. /**
  36222. * Update a video texture
  36223. * @param texture defines the texture to update
  36224. * @param video defines the video element to use
  36225. * @param invertY defines if data must be stored with Y axis inverted
  36226. */
  36227. updateVideoTexture(texture: Nullable<InternalTexture>, video: HTMLVideoElement, invertY: boolean): void;
  36228. }
  36229. }
  36230. }
  36231. declare module "babylonjs/Engines/Extensions/engine.dynamicTexture" {
  36232. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  36233. import { Nullable } from "babylonjs/types";
  36234. module "babylonjs/Engines/thinEngine" {
  36235. interface ThinEngine {
  36236. /**
  36237. * Creates a dynamic texture
  36238. * @param width defines the width of the texture
  36239. * @param height defines the height of the texture
  36240. * @param generateMipMaps defines if the engine should generate the mip levels
  36241. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  36242. * @returns the dynamic texture inside an InternalTexture
  36243. */
  36244. createDynamicTexture(width: number, height: number, generateMipMaps: boolean, samplingMode: number): InternalTexture;
  36245. /**
  36246. * Update the content of a dynamic texture
  36247. * @param texture defines the texture to update
  36248. * @param canvas defines the canvas containing the source
  36249. * @param invertY defines if data must be stored with Y axis inverted
  36250. * @param premulAlpha defines if alpha is stored as premultiplied
  36251. * @param format defines the format of the data
  36252. * @param forceBindTexture if the texture should be forced to be bound eg. after a graphics context loss (Default: false)
  36253. */
  36254. updateDynamicTexture(texture: Nullable<InternalTexture>, canvas: HTMLCanvasElement | OffscreenCanvas, invertY: boolean, premulAlpha?: boolean, format?: number, forceBindTexture?: boolean): void;
  36255. }
  36256. }
  36257. }
  36258. declare module "babylonjs/Materials/Textures/videoTexture" {
  36259. import { Observable } from "babylonjs/Misc/observable";
  36260. import { Nullable } from "babylonjs/types";
  36261. import { Scene } from "babylonjs/scene";
  36262. import { Texture } from "babylonjs/Materials/Textures/texture";
  36263. import "babylonjs/Engines/Extensions/engine.videoTexture";
  36264. import "babylonjs/Engines/Extensions/engine.dynamicTexture";
  36265. /**
  36266. * Settings for finer control over video usage
  36267. */
  36268. export interface VideoTextureSettings {
  36269. /**
  36270. * Applies `autoplay` to video, if specified
  36271. */
  36272. autoPlay?: boolean;
  36273. /**
  36274. * Applies `loop` to video, if specified
  36275. */
  36276. loop?: boolean;
  36277. /**
  36278. * Automatically updates internal texture from video at every frame in the render loop
  36279. */
  36280. autoUpdateTexture: boolean;
  36281. /**
  36282. * Image src displayed during the video loading or until the user interacts with the video.
  36283. */
  36284. poster?: string;
  36285. }
  36286. /**
  36287. * If you want to display a video in your scene, this is the special texture for that.
  36288. * This special texture works similar to other textures, with the exception of a few parameters.
  36289. * @see https://doc.babylonjs.com/how_to/video_texture
  36290. */
  36291. export class VideoTexture extends Texture {
  36292. /**
  36293. * Tells whether textures will be updated automatically or user is required to call `updateTexture` manually
  36294. */
  36295. readonly autoUpdateTexture: boolean;
  36296. /**
  36297. * The video instance used by the texture internally
  36298. */
  36299. readonly video: HTMLVideoElement;
  36300. private _onUserActionRequestedObservable;
  36301. /**
  36302. * Event triggerd when a dom action is required by the user to play the video.
  36303. * This happens due to recent changes in browser policies preventing video to auto start.
  36304. */
  36305. get onUserActionRequestedObservable(): Observable<Texture>;
  36306. private _generateMipMaps;
  36307. private _stillImageCaptured;
  36308. private _displayingPosterTexture;
  36309. private _settings;
  36310. private _createInternalTextureOnEvent;
  36311. private _frameId;
  36312. private _currentSrc;
  36313. /**
  36314. * Creates a video texture.
  36315. * If you want to display a video in your scene, this is the special texture for that.
  36316. * This special texture works similar to other textures, with the exception of a few parameters.
  36317. * @see https://doc.babylonjs.com/how_to/video_texture
  36318. * @param name optional name, will detect from video source, if not defined
  36319. * @param src can be used to provide an url, array of urls or an already setup HTML video element.
  36320. * @param scene is obviously the current scene.
  36321. * @param generateMipMaps can be used to turn on mipmaps (Can be expensive for videoTextures because they are often updated).
  36322. * @param invertY is false by default but can be used to invert video on Y axis
  36323. * @param samplingMode controls the sampling method and is set to TRILINEAR_SAMPLINGMODE by default
  36324. * @param settings allows finer control over video usage
  36325. */
  36326. constructor(name: Nullable<string>, src: string | string[] | HTMLVideoElement, scene: Nullable<Scene>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, settings?: VideoTextureSettings);
  36327. private _getName;
  36328. private _getVideo;
  36329. private _createInternalTexture;
  36330. private reset;
  36331. /**
  36332. * @hidden Internal method to initiate `update`.
  36333. */
  36334. _rebuild(): void;
  36335. /**
  36336. * Update Texture in the `auto` mode. Does not do anything if `settings.autoUpdateTexture` is false.
  36337. */
  36338. update(): void;
  36339. /**
  36340. * Update Texture in `manual` mode. Does not do anything if not visible or paused.
  36341. * @param isVisible Visibility state, detected by user using `scene.getActiveMeshes()` or othervise.
  36342. */
  36343. updateTexture(isVisible: boolean): void;
  36344. protected _updateInternalTexture: () => void;
  36345. /**
  36346. * Change video content. Changing video instance or setting multiple urls (as in constructor) is not supported.
  36347. * @param url New url.
  36348. */
  36349. updateURL(url: string): void;
  36350. /**
  36351. * Clones the texture.
  36352. * @returns the cloned texture
  36353. */
  36354. clone(): VideoTexture;
  36355. /**
  36356. * Dispose the texture and release its associated resources.
  36357. */
  36358. dispose(): void;
  36359. /**
  36360. * Creates a video texture straight from a stream.
  36361. * @param scene Define the scene the texture should be created in
  36362. * @param stream Define the stream the texture should be created from
  36363. * @returns The created video texture as a promise
  36364. */
  36365. static CreateFromStreamAsync(scene: Scene, stream: MediaStream): Promise<VideoTexture>;
  36366. /**
  36367. * Creates a video texture straight from your WebCam video feed.
  36368. * @param scene Define the scene the texture should be created in
  36369. * @param constraints Define the constraints to use to create the web cam feed from WebRTC
  36370. * @param audioConstaints Define the audio constraints to use to create the web cam feed from WebRTC
  36371. * @returns The created video texture as a promise
  36372. */
  36373. static CreateFromWebCamAsync(scene: Scene, constraints: {
  36374. minWidth: number;
  36375. maxWidth: number;
  36376. minHeight: number;
  36377. maxHeight: number;
  36378. deviceId: string;
  36379. } & MediaTrackConstraints, audioConstaints?: boolean | MediaTrackConstraints): Promise<VideoTexture>;
  36380. /**
  36381. * Creates a video texture straight from your WebCam video feed.
  36382. * @param scene Define the scene the texture should be created in
  36383. * @param onReady Define a callback to triggered once the texture will be ready
  36384. * @param constraints Define the constraints to use to create the web cam feed from WebRTC
  36385. * @param audioConstaints Define the audio constraints to use to create the web cam feed from WebRTC
  36386. */
  36387. static CreateFromWebCam(scene: Scene, onReady: (videoTexture: VideoTexture) => void, constraints: {
  36388. minWidth: number;
  36389. maxWidth: number;
  36390. minHeight: number;
  36391. maxHeight: number;
  36392. deviceId: string;
  36393. } & MediaTrackConstraints, audioConstaints?: boolean | MediaTrackConstraints): void;
  36394. }
  36395. }
  36396. declare module "babylonjs/Engines/thinEngine" {
  36397. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  36398. import { Effect, IEffectCreationOptions } from "babylonjs/Materials/effect";
  36399. import { IShaderProcessor } from "babylonjs/Engines/Processors/iShaderProcessor";
  36400. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  36401. import { Nullable, DataArray, IndicesArray } from "babylonjs/types";
  36402. import { EngineCapabilities } from "babylonjs/Engines/engineCapabilities";
  36403. import { Observable } from "babylonjs/Misc/observable";
  36404. import { DepthCullingState } from "babylonjs/States/depthCullingState";
  36405. import { StencilState } from "babylonjs/States/stencilState";
  36406. import { AlphaState } from "babylonjs/States/alphaCullingState";
  36407. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  36408. import { IViewportLike, IColor4Like } from "babylonjs/Maths/math.like";
  36409. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  36410. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  36411. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  36412. import { WebGLPipelineContext } from "babylonjs/Engines/WebGL/webGLPipelineContext";
  36413. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  36414. import { InstancingAttributeInfo } from "babylonjs/Engines/instancingAttributeInfo";
  36415. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  36416. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  36417. import { IEffectFallbacks } from "babylonjs/Materials/iEffectFallbacks";
  36418. import { IWebRequest } from "babylonjs/Misc/interfaces/iWebRequest";
  36419. import { WebRequest } from "babylonjs/Misc/webRequest";
  36420. import { LoadFileError } from "babylonjs/Misc/fileTools";
  36421. /**
  36422. * Defines the interface used by objects working like Scene
  36423. * @hidden
  36424. */
  36425. export interface ISceneLike {
  36426. _addPendingData(data: any): void;
  36427. _removePendingData(data: any): void;
  36428. offlineProvider: IOfflineProvider;
  36429. }
  36430. /**
  36431. * Information about the current host
  36432. */
  36433. export interface HostInformation {
  36434. /**
  36435. * Defines if the current host is a mobile
  36436. */
  36437. isMobile: boolean;
  36438. }
  36439. /** Interface defining initialization parameters for Engine class */
  36440. export interface EngineOptions extends WebGLContextAttributes {
  36441. /**
  36442. * Defines if the engine should no exceed a specified device ratio
  36443. * @see https://developer.mozilla.org/en-US/docs/Web/API/Window/devicePixelRatio
  36444. */
  36445. limitDeviceRatio?: number;
  36446. /**
  36447. * Defines if webvr should be enabled automatically
  36448. * @see https://doc.babylonjs.com/how_to/webvr_camera
  36449. */
  36450. autoEnableWebVR?: boolean;
  36451. /**
  36452. * Defines if webgl2 should be turned off even if supported
  36453. * @see https://doc.babylonjs.com/features/webgl2
  36454. */
  36455. disableWebGL2Support?: boolean;
  36456. /**
  36457. * Defines if webaudio should be initialized as well
  36458. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  36459. */
  36460. audioEngine?: boolean;
  36461. /**
  36462. * Defines if animations should run using a deterministic lock step
  36463. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  36464. */
  36465. deterministicLockstep?: boolean;
  36466. /** Defines the maximum steps to use with deterministic lock step mode */
  36467. lockstepMaxSteps?: number;
  36468. /** Defines the seconds between each deterministic lock step */
  36469. timeStep?: number;
  36470. /**
  36471. * Defines that engine should ignore context lost events
  36472. * If this event happens when this parameter is true, you will have to reload the page to restore rendering
  36473. */
  36474. doNotHandleContextLost?: boolean;
  36475. /**
  36476. * Defines that engine should ignore modifying touch action attribute and style
  36477. * If not handle, you might need to set it up on your side for expected touch devices behavior.
  36478. */
  36479. doNotHandleTouchAction?: boolean;
  36480. /**
  36481. * Defines that engine should compile shaders with high precision floats (if supported). True by default
  36482. */
  36483. useHighPrecisionFloats?: boolean;
  36484. /**
  36485. * Make the canvas XR Compatible for XR sessions
  36486. */
  36487. xrCompatible?: boolean;
  36488. /**
  36489. * Make the matrix computations to be performed in 64 bits instead of 32 bits. False by default
  36490. */
  36491. useHighPrecisionMatrix?: boolean;
  36492. }
  36493. /**
  36494. * The base engine class (root of all engines)
  36495. */
  36496. export class ThinEngine {
  36497. /** Use this array to turn off some WebGL2 features on known buggy browsers version */
  36498. static ExceptionList: ({
  36499. key: string;
  36500. capture: string;
  36501. captureConstraint: number;
  36502. targets: string[];
  36503. } | {
  36504. key: string;
  36505. capture: null;
  36506. captureConstraint: null;
  36507. targets: string[];
  36508. })[];
  36509. /** @hidden */
  36510. static _TextureLoaders: IInternalTextureLoader[];
  36511. /**
  36512. * Returns the current npm package of the sdk
  36513. */
  36514. static get NpmPackage(): string;
  36515. /**
  36516. * Returns the current version of the framework
  36517. */
  36518. static get Version(): string;
  36519. /**
  36520. * Returns a string describing the current engine
  36521. */
  36522. get description(): string;
  36523. /**
  36524. * Gets or sets the epsilon value used by collision engine
  36525. */
  36526. static CollisionsEpsilon: number;
  36527. /**
  36528. * Gets or sets the relative url used to load shaders if using the engine in non-minified mode
  36529. */
  36530. static get ShadersRepository(): string;
  36531. static set ShadersRepository(value: string);
  36532. /** @hidden */
  36533. _shaderProcessor: IShaderProcessor;
  36534. /**
  36535. * Gets or sets a boolean that indicates if textures must be forced to power of 2 size even if not required
  36536. */
  36537. forcePOTTextures: boolean;
  36538. /**
  36539. * Gets a boolean indicating if the engine is currently rendering in fullscreen mode
  36540. */
  36541. isFullscreen: boolean;
  36542. /**
  36543. * Gets or sets a boolean indicating if back faces must be culled (true by default)
  36544. */
  36545. cullBackFaces: boolean;
  36546. /**
  36547. * Gets or sets a boolean indicating if the engine must keep rendering even if the window is not in foregroun
  36548. */
  36549. renderEvenInBackground: boolean;
  36550. /**
  36551. * Gets or sets a boolean indicating that cache can be kept between frames
  36552. */
  36553. preventCacheWipeBetweenFrames: boolean;
  36554. /** Gets or sets a boolean indicating if the engine should validate programs after compilation */
  36555. validateShaderPrograms: boolean;
  36556. /**
  36557. * Gets or sets a boolean indicating if depth buffer should be reverse, going from far to near.
  36558. * This can provide greater z depth for distant objects.
  36559. */
  36560. useReverseDepthBuffer: boolean;
  36561. /**
  36562. * Gets or sets a boolean indicating that uniform buffers must be disabled even if they are supported
  36563. */
  36564. disableUniformBuffers: boolean;
  36565. /** @hidden */
  36566. _uniformBuffers: UniformBuffer[];
  36567. /**
  36568. * Gets a boolean indicating that the engine supports uniform buffers
  36569. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  36570. */
  36571. get supportsUniformBuffers(): boolean;
  36572. /** @hidden */
  36573. _gl: WebGLRenderingContext;
  36574. /** @hidden */
  36575. _webGLVersion: number;
  36576. protected _renderingCanvas: Nullable<HTMLCanvasElement>;
  36577. protected _windowIsBackground: boolean;
  36578. protected _creationOptions: EngineOptions;
  36579. protected _highPrecisionShadersAllowed: boolean;
  36580. /** @hidden */
  36581. get _shouldUseHighPrecisionShader(): boolean;
  36582. /**
  36583. * Gets a boolean indicating that only power of 2 textures are supported
  36584. * Please note that you can still use non power of 2 textures but in this case the engine will forcefully convert them
  36585. */
  36586. get needPOTTextures(): boolean;
  36587. /** @hidden */
  36588. _badOS: boolean;
  36589. /** @hidden */
  36590. _badDesktopOS: boolean;
  36591. private _hardwareScalingLevel;
  36592. /** @hidden */
  36593. _caps: EngineCapabilities;
  36594. private _isStencilEnable;
  36595. private _glVersion;
  36596. private _glRenderer;
  36597. private _glVendor;
  36598. /** @hidden */
  36599. _videoTextureSupported: boolean;
  36600. protected _renderingQueueLaunched: boolean;
  36601. protected _activeRenderLoops: (() => void)[];
  36602. /**
  36603. * Observable signaled when a context lost event is raised
  36604. */
  36605. onContextLostObservable: Observable<ThinEngine>;
  36606. /**
  36607. * Observable signaled when a context restored event is raised
  36608. */
  36609. onContextRestoredObservable: Observable<ThinEngine>;
  36610. private _onContextLost;
  36611. private _onContextRestored;
  36612. protected _contextWasLost: boolean;
  36613. /** @hidden */
  36614. _doNotHandleContextLost: boolean;
  36615. /**
  36616. * Gets or sets a boolean indicating if resources should be retained to be able to handle context lost events
  36617. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#handling-webgl-context-lost
  36618. */
  36619. get doNotHandleContextLost(): boolean;
  36620. set doNotHandleContextLost(value: boolean);
  36621. /**
  36622. * Gets or sets a boolean indicating that vertex array object must be disabled even if they are supported
  36623. */
  36624. disableVertexArrayObjects: boolean;
  36625. /** @hidden */
  36626. protected _colorWrite: boolean;
  36627. /** @hidden */
  36628. protected _colorWriteChanged: boolean;
  36629. /** @hidden */
  36630. protected _depthCullingState: DepthCullingState;
  36631. /** @hidden */
  36632. protected _stencilState: StencilState;
  36633. /** @hidden */
  36634. _alphaState: AlphaState;
  36635. /** @hidden */
  36636. _alphaMode: number;
  36637. /** @hidden */
  36638. _alphaEquation: number;
  36639. /** @hidden */
  36640. _internalTexturesCache: InternalTexture[];
  36641. /** @hidden */
  36642. protected _activeChannel: number;
  36643. private _currentTextureChannel;
  36644. /** @hidden */
  36645. protected _boundTexturesCache: {
  36646. [key: string]: Nullable<InternalTexture>;
  36647. };
  36648. /** @hidden */
  36649. protected _currentEffect: Nullable<Effect>;
  36650. /** @hidden */
  36651. protected _currentProgram: Nullable<WebGLProgram>;
  36652. private _compiledEffects;
  36653. private _vertexAttribArraysEnabled;
  36654. /** @hidden */
  36655. protected _cachedViewport: Nullable<IViewportLike>;
  36656. private _cachedVertexArrayObject;
  36657. /** @hidden */
  36658. protected _cachedVertexBuffers: any;
  36659. /** @hidden */
  36660. protected _cachedIndexBuffer: Nullable<DataBuffer>;
  36661. /** @hidden */
  36662. protected _cachedEffectForVertexBuffers: Nullable<Effect>;
  36663. /** @hidden */
  36664. _currentRenderTarget: Nullable<InternalTexture>;
  36665. private _uintIndicesCurrentlySet;
  36666. protected _currentBoundBuffer: Nullable<WebGLBuffer>[];
  36667. /** @hidden */
  36668. _currentFramebuffer: Nullable<WebGLFramebuffer>;
  36669. /** @hidden */
  36670. _dummyFramebuffer: Nullable<WebGLFramebuffer>;
  36671. private _currentBufferPointers;
  36672. private _currentInstanceLocations;
  36673. private _currentInstanceBuffers;
  36674. private _textureUnits;
  36675. /** @hidden */
  36676. _workingCanvas: Nullable<HTMLCanvasElement | OffscreenCanvas>;
  36677. /** @hidden */
  36678. _workingContext: Nullable<CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D>;
  36679. /** @hidden */
  36680. _boundRenderFunction: any;
  36681. private _vaoRecordInProgress;
  36682. private _mustWipeVertexAttributes;
  36683. private _emptyTexture;
  36684. private _emptyCubeTexture;
  36685. private _emptyTexture3D;
  36686. private _emptyTexture2DArray;
  36687. /** @hidden */
  36688. _frameHandler: number;
  36689. private _nextFreeTextureSlots;
  36690. private _maxSimultaneousTextures;
  36691. private _activeRequests;
  36692. /** @hidden */
  36693. _transformTextureUrl: Nullable<(url: string) => string>;
  36694. /**
  36695. * Gets information about the current host
  36696. */
  36697. hostInformation: HostInformation;
  36698. protected get _supportsHardwareTextureRescaling(): boolean;
  36699. private _framebufferDimensionsObject;
  36700. /**
  36701. * sets the object from which width and height will be taken from when getting render width and height
  36702. * Will fallback to the gl object
  36703. * @param dimensions the framebuffer width and height that will be used.
  36704. */
  36705. set framebufferDimensionsObject(dimensions: Nullable<{
  36706. framebufferWidth: number;
  36707. framebufferHeight: number;
  36708. }>);
  36709. /**
  36710. * Gets the current viewport
  36711. */
  36712. get currentViewport(): Nullable<IViewportLike>;
  36713. /**
  36714. * Gets the default empty texture
  36715. */
  36716. get emptyTexture(): InternalTexture;
  36717. /**
  36718. * Gets the default empty 3D texture
  36719. */
  36720. get emptyTexture3D(): InternalTexture;
  36721. /**
  36722. * Gets the default empty 2D array texture
  36723. */
  36724. get emptyTexture2DArray(): InternalTexture;
  36725. /**
  36726. * Gets the default empty cube texture
  36727. */
  36728. get emptyCubeTexture(): InternalTexture;
  36729. /**
  36730. * Defines whether the engine has been created with the premultipliedAlpha option on or not.
  36731. */
  36732. readonly premultipliedAlpha: boolean;
  36733. /**
  36734. * Observable event triggered before each texture is initialized
  36735. */
  36736. onBeforeTextureInitObservable: Observable<import("babylonjs/Materials/Textures/texture").Texture>;
  36737. /**
  36738. * Creates a new engine
  36739. * @param canvasOrContext defines the canvas or WebGL context to use for rendering. If you provide a WebGL context, Babylon.js will not hook events on the canvas (like pointers, keyboards, etc...) so no event observables will be available. This is mostly used when Babylon.js is used as a plugin on a system which alreay used the WebGL context
  36740. * @param antialias defines enable antialiasing (default: false)
  36741. * @param options defines further options to be sent to the getContext() function
  36742. * @param adaptToDeviceRatio defines whether to adapt to the device's viewport characteristics (default: false)
  36743. */
  36744. constructor(canvasOrContext: Nullable<HTMLCanvasElement | WebGLRenderingContext | WebGL2RenderingContext>, antialias?: boolean, options?: EngineOptions, adaptToDeviceRatio?: boolean);
  36745. private _rebuildInternalTextures;
  36746. private _rebuildEffects;
  36747. /**
  36748. * Gets a boolean indicating if all created effects are ready
  36749. * @returns true if all effects are ready
  36750. */
  36751. areAllEffectsReady(): boolean;
  36752. protected _rebuildBuffers(): void;
  36753. protected _initGLContext(): void;
  36754. /**
  36755. * Gets version of the current webGL context
  36756. */
  36757. get webGLVersion(): number;
  36758. /**
  36759. * Gets a string identifying the name of the class
  36760. * @returns "Engine" string
  36761. */
  36762. getClassName(): string;
  36763. /**
  36764. * Returns true if the stencil buffer has been enabled through the creation option of the context.
  36765. */
  36766. get isStencilEnable(): boolean;
  36767. /** @hidden */
  36768. _prepareWorkingCanvas(): void;
  36769. /**
  36770. * Reset the texture cache to empty state
  36771. */
  36772. resetTextureCache(): void;
  36773. /**
  36774. * Gets an object containing information about the current webGL context
  36775. * @returns an object containing the vender, the renderer and the version of the current webGL context
  36776. */
  36777. getGlInfo(): {
  36778. vendor: string;
  36779. renderer: string;
  36780. version: string;
  36781. };
  36782. /**
  36783. * Defines the hardware scaling level.
  36784. * By default the hardware scaling level is computed from the window device ratio.
  36785. * if level = 1 then the engine will render at the exact resolution of the canvas. If level = 0.5 then the engine will render at twice the size of the canvas.
  36786. * @param level defines the level to use
  36787. */
  36788. setHardwareScalingLevel(level: number): void;
  36789. /**
  36790. * Gets the current hardware scaling level.
  36791. * By default the hardware scaling level is computed from the window device ratio.
  36792. * if level = 1 then the engine will render at the exact resolution of the canvas. If level = 0.5 then the engine will render at twice the size of the canvas.
  36793. * @returns a number indicating the current hardware scaling level
  36794. */
  36795. getHardwareScalingLevel(): number;
  36796. /**
  36797. * Gets the list of loaded textures
  36798. * @returns an array containing all loaded textures
  36799. */
  36800. getLoadedTexturesCache(): InternalTexture[];
  36801. /**
  36802. * Gets the object containing all engine capabilities
  36803. * @returns the EngineCapabilities object
  36804. */
  36805. getCaps(): EngineCapabilities;
  36806. /**
  36807. * stop executing a render loop function and remove it from the execution array
  36808. * @param renderFunction defines the function to be removed. If not provided all functions will be removed.
  36809. */
  36810. stopRenderLoop(renderFunction?: () => void): void;
  36811. /** @hidden */
  36812. _renderLoop(): void;
  36813. /**
  36814. * Gets the HTML canvas attached with the current webGL context
  36815. * @returns a HTML canvas
  36816. */
  36817. getRenderingCanvas(): Nullable<HTMLCanvasElement>;
  36818. /**
  36819. * Gets host window
  36820. * @returns the host window object
  36821. */
  36822. getHostWindow(): Nullable<Window>;
  36823. /**
  36824. * Gets the current render width
  36825. * @param useScreen defines if screen size must be used (or the current render target if any)
  36826. * @returns a number defining the current render width
  36827. */
  36828. getRenderWidth(useScreen?: boolean): number;
  36829. /**
  36830. * Gets the current render height
  36831. * @param useScreen defines if screen size must be used (or the current render target if any)
  36832. * @returns a number defining the current render height
  36833. */
  36834. getRenderHeight(useScreen?: boolean): number;
  36835. /**
  36836. * Can be used to override the current requestAnimationFrame requester.
  36837. * @hidden
  36838. */
  36839. protected _queueNewFrame(bindedRenderFunction: any, requester?: any): number;
  36840. /**
  36841. * Register and execute a render loop. The engine can have more than one render function
  36842. * @param renderFunction defines the function to continuously execute
  36843. */
  36844. runRenderLoop(renderFunction: () => void): void;
  36845. /**
  36846. * Clear the current render buffer or the current render target (if any is set up)
  36847. * @param color defines the color to use
  36848. * @param backBuffer defines if the back buffer must be cleared
  36849. * @param depth defines if the depth buffer must be cleared
  36850. * @param stencil defines if the stencil buffer must be cleared
  36851. */
  36852. clear(color: Nullable<IColor4Like>, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  36853. private _viewportCached;
  36854. /** @hidden */
  36855. _viewport(x: number, y: number, width: number, height: number): void;
  36856. /**
  36857. * Set the WebGL's viewport
  36858. * @param viewport defines the viewport element to be used
  36859. * @param requiredWidth defines the width required for rendering. If not provided the rendering canvas' width is used
  36860. * @param requiredHeight defines the height required for rendering. If not provided the rendering canvas' height is used
  36861. */
  36862. setViewport(viewport: IViewportLike, requiredWidth?: number, requiredHeight?: number): void;
  36863. /**
  36864. * Begin a new frame
  36865. */
  36866. beginFrame(): void;
  36867. /**
  36868. * Enf the current frame
  36869. */
  36870. endFrame(): void;
  36871. /**
  36872. * Resize the view according to the canvas' size
  36873. */
  36874. resize(): void;
  36875. /**
  36876. * Force a specific size of the canvas
  36877. * @param width defines the new canvas' width
  36878. * @param height defines the new canvas' height
  36879. * @returns true if the size was changed
  36880. */
  36881. setSize(width: number, height: number): boolean;
  36882. /**
  36883. * Binds the frame buffer to the specified texture.
  36884. * @param texture The texture to render to or null for the default canvas
  36885. * @param faceIndex The face of the texture to render to in case of cube texture
  36886. * @param requiredWidth The width of the target to render to
  36887. * @param requiredHeight The height of the target to render to
  36888. * @param forceFullscreenViewport Forces the viewport to be the entire texture/screen if true
  36889. * @param lodLevel defines the lod level to bind to the frame buffer
  36890. * @param layer defines the 2d array index to bind to frame buffer to
  36891. */
  36892. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean, lodLevel?: number, layer?: number): void;
  36893. /** @hidden */
  36894. _bindUnboundFramebuffer(framebuffer: Nullable<WebGLFramebuffer>): void;
  36895. /**
  36896. * Unbind the current render target texture from the webGL context
  36897. * @param texture defines the render target texture to unbind
  36898. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  36899. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  36900. */
  36901. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  36902. /**
  36903. * Force a webGL flush (ie. a flush of all waiting webGL commands)
  36904. */
  36905. flushFramebuffer(): void;
  36906. /**
  36907. * Unbind the current render target and bind the default framebuffer
  36908. */
  36909. restoreDefaultFramebuffer(): void;
  36910. /** @hidden */
  36911. protected _resetVertexBufferBinding(): void;
  36912. /**
  36913. * Creates a vertex buffer
  36914. * @param data the data for the vertex buffer
  36915. * @returns the new WebGL static buffer
  36916. */
  36917. createVertexBuffer(data: DataArray): DataBuffer;
  36918. private _createVertexBuffer;
  36919. /**
  36920. * Creates a dynamic vertex buffer
  36921. * @param data the data for the dynamic vertex buffer
  36922. * @returns the new WebGL dynamic buffer
  36923. */
  36924. createDynamicVertexBuffer(data: DataArray): DataBuffer;
  36925. protected _resetIndexBufferBinding(): void;
  36926. /**
  36927. * Creates a new index buffer
  36928. * @param indices defines the content of the index buffer
  36929. * @param updatable defines if the index buffer must be updatable
  36930. * @returns a new webGL buffer
  36931. */
  36932. createIndexBuffer(indices: IndicesArray, updatable?: boolean): DataBuffer;
  36933. protected _normalizeIndexData(indices: IndicesArray): Uint16Array | Uint32Array;
  36934. /**
  36935. * Bind a webGL buffer to the webGL context
  36936. * @param buffer defines the buffer to bind
  36937. */
  36938. bindArrayBuffer(buffer: Nullable<DataBuffer>): void;
  36939. protected bindIndexBuffer(buffer: Nullable<DataBuffer>): void;
  36940. private bindBuffer;
  36941. /**
  36942. * update the bound buffer with the given data
  36943. * @param data defines the data to update
  36944. */
  36945. updateArrayBuffer(data: Float32Array): void;
  36946. private _vertexAttribPointer;
  36947. /** @hidden */
  36948. _bindIndexBufferWithCache(indexBuffer: Nullable<DataBuffer>): void;
  36949. private _bindVertexBuffersAttributes;
  36950. /**
  36951. * Records a vertex array object
  36952. * @see https://doc.babylonjs.com/features/webgl2#vertex-array-objects
  36953. * @param vertexBuffers defines the list of vertex buffers to store
  36954. * @param indexBuffer defines the index buffer to store
  36955. * @param effect defines the effect to store
  36956. * @returns the new vertex array object
  36957. */
  36958. recordVertexArrayObject(vertexBuffers: {
  36959. [key: string]: VertexBuffer;
  36960. }, indexBuffer: Nullable<DataBuffer>, effect: Effect): WebGLVertexArrayObject;
  36961. /**
  36962. * Bind a specific vertex array object
  36963. * @see https://doc.babylonjs.com/features/webgl2#vertex-array-objects
  36964. * @param vertexArrayObject defines the vertex array object to bind
  36965. * @param indexBuffer defines the index buffer to bind
  36966. */
  36967. bindVertexArrayObject(vertexArrayObject: WebGLVertexArrayObject, indexBuffer: Nullable<DataBuffer>): void;
  36968. /**
  36969. * Bind webGl buffers directly to the webGL context
  36970. * @param vertexBuffer defines the vertex buffer to bind
  36971. * @param indexBuffer defines the index buffer to bind
  36972. * @param vertexDeclaration defines the vertex declaration to use with the vertex buffer
  36973. * @param vertexStrideSize defines the vertex stride of the vertex buffer
  36974. * @param effect defines the effect associated with the vertex buffer
  36975. */
  36976. bindBuffersDirectly(vertexBuffer: DataBuffer, indexBuffer: DataBuffer, vertexDeclaration: number[], vertexStrideSize: number, effect: Effect): void;
  36977. private _unbindVertexArrayObject;
  36978. /**
  36979. * Bind a list of vertex buffers to the webGL context
  36980. * @param vertexBuffers defines the list of vertex buffers to bind
  36981. * @param indexBuffer defines the index buffer to bind
  36982. * @param effect defines the effect associated with the vertex buffers
  36983. */
  36984. bindBuffers(vertexBuffers: {
  36985. [key: string]: Nullable<VertexBuffer>;
  36986. }, indexBuffer: Nullable<DataBuffer>, effect: Effect): void;
  36987. /**
  36988. * Unbind all instance attributes
  36989. */
  36990. unbindInstanceAttributes(): void;
  36991. /**
  36992. * Release and free the memory of a vertex array object
  36993. * @param vao defines the vertex array object to delete
  36994. */
  36995. releaseVertexArrayObject(vao: WebGLVertexArrayObject): void;
  36996. /** @hidden */
  36997. _releaseBuffer(buffer: DataBuffer): boolean;
  36998. protected _deleteBuffer(buffer: DataBuffer): void;
  36999. /**
  37000. * Update the content of a webGL buffer used with instanciation and bind it to the webGL context
  37001. * @param instancesBuffer defines the webGL buffer to update and bind
  37002. * @param data defines the data to store in the buffer
  37003. * @param offsetLocations defines the offsets or attributes information used to determine where data must be stored in the buffer
  37004. */
  37005. updateAndBindInstancesBuffer(instancesBuffer: DataBuffer, data: Float32Array, offsetLocations: number[] | InstancingAttributeInfo[]): void;
  37006. /**
  37007. * Bind the content of a webGL buffer used with instantiation
  37008. * @param instancesBuffer defines the webGL buffer to bind
  37009. * @param attributesInfo defines the offsets or attributes information used to determine where data must be stored in the buffer
  37010. * @param computeStride defines Whether to compute the strides from the info or use the default 0
  37011. */
  37012. bindInstancesBuffer(instancesBuffer: DataBuffer, attributesInfo: InstancingAttributeInfo[], computeStride?: boolean): void;
  37013. /**
  37014. * Disable the instance attribute corresponding to the name in parameter
  37015. * @param name defines the name of the attribute to disable
  37016. */
  37017. disableInstanceAttributeByName(name: string): void;
  37018. /**
  37019. * Disable the instance attribute corresponding to the location in parameter
  37020. * @param attributeLocation defines the attribute location of the attribute to disable
  37021. */
  37022. disableInstanceAttribute(attributeLocation: number): void;
  37023. /**
  37024. * Disable the attribute corresponding to the location in parameter
  37025. * @param attributeLocation defines the attribute location of the attribute to disable
  37026. */
  37027. disableAttributeByIndex(attributeLocation: number): void;
  37028. /**
  37029. * Send a draw order
  37030. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  37031. * @param indexStart defines the starting index
  37032. * @param indexCount defines the number of index to draw
  37033. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  37034. */
  37035. draw(useTriangles: boolean, indexStart: number, indexCount: number, instancesCount?: number): void;
  37036. /**
  37037. * Draw a list of points
  37038. * @param verticesStart defines the index of first vertex to draw
  37039. * @param verticesCount defines the count of vertices to draw
  37040. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  37041. */
  37042. drawPointClouds(verticesStart: number, verticesCount: number, instancesCount?: number): void;
  37043. /**
  37044. * Draw a list of unindexed primitives
  37045. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  37046. * @param verticesStart defines the index of first vertex to draw
  37047. * @param verticesCount defines the count of vertices to draw
  37048. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  37049. */
  37050. drawUnIndexed(useTriangles: boolean, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  37051. /**
  37052. * Draw a list of indexed primitives
  37053. * @param fillMode defines the primitive to use
  37054. * @param indexStart defines the starting index
  37055. * @param indexCount defines the number of index to draw
  37056. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  37057. */
  37058. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  37059. /**
  37060. * Draw a list of unindexed primitives
  37061. * @param fillMode defines the primitive to use
  37062. * @param verticesStart defines the index of first vertex to draw
  37063. * @param verticesCount defines the count of vertices to draw
  37064. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  37065. */
  37066. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  37067. private _drawMode;
  37068. /** @hidden */
  37069. protected _reportDrawCall(): void;
  37070. /** @hidden */
  37071. _releaseEffect(effect: Effect): void;
  37072. /** @hidden */
  37073. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  37074. /**
  37075. * Create a new effect (used to store vertex/fragment shaders)
  37076. * @param baseName defines the base name of the effect (The name of file without .fragment.fx or .vertex.fx)
  37077. * @param attributesNamesOrOptions defines either a list of attribute names or an IEffectCreationOptions object
  37078. * @param uniformsNamesOrEngine defines either a list of uniform names or the engine to use
  37079. * @param samplers defines an array of string used to represent textures
  37080. * @param defines defines the string containing the defines to use to compile the shaders
  37081. * @param fallbacks defines the list of potential fallbacks to use if shader conmpilation fails
  37082. * @param onCompiled defines a function to call when the effect creation is successful
  37083. * @param onError defines a function to call when the effect creation has failed
  37084. * @param indexParameters defines an object containing the index values to use to compile shaders (like the maximum number of simultaneous lights)
  37085. * @returns the new Effect
  37086. */
  37087. createEffect(baseName: any, attributesNamesOrOptions: string[] | IEffectCreationOptions, uniformsNamesOrEngine: string[] | ThinEngine, samplers?: string[], defines?: string, fallbacks?: IEffectFallbacks, onCompiled?: Nullable<(effect: Effect) => void>, onError?: Nullable<(effect: Effect, errors: string) => void>, indexParameters?: any): Effect;
  37088. protected static _ConcatenateShader(source: string, defines: Nullable<string>, shaderVersion?: string): string;
  37089. private _compileShader;
  37090. private _compileRawShader;
  37091. /** @hidden */
  37092. _getShaderSource(shader: WebGLShader): Nullable<string>;
  37093. /**
  37094. * Directly creates a webGL program
  37095. * @param pipelineContext defines the pipeline context to attach to
  37096. * @param vertexCode defines the vertex shader code to use
  37097. * @param fragmentCode defines the fragment shader code to use
  37098. * @param context defines the webGL context to use (if not set, the current one will be used)
  37099. * @param transformFeedbackVaryings defines the list of transform feedback varyings to use
  37100. * @returns the new webGL program
  37101. */
  37102. createRawShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  37103. /**
  37104. * Creates a webGL program
  37105. * @param pipelineContext defines the pipeline context to attach to
  37106. * @param vertexCode defines the vertex shader code to use
  37107. * @param fragmentCode defines the fragment shader code to use
  37108. * @param defines defines the string containing the defines to use to compile the shaders
  37109. * @param context defines the webGL context to use (if not set, the current one will be used)
  37110. * @param transformFeedbackVaryings defines the list of transform feedback varyings to use
  37111. * @returns the new webGL program
  37112. */
  37113. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  37114. /**
  37115. * Creates a new pipeline context
  37116. * @returns the new pipeline
  37117. */
  37118. createPipelineContext(): IPipelineContext;
  37119. protected _createShaderProgram(pipelineContext: WebGLPipelineContext, vertexShader: WebGLShader, fragmentShader: WebGLShader, context: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  37120. protected _finalizePipelineContext(pipelineContext: WebGLPipelineContext): void;
  37121. /** @hidden */
  37122. _preparePipelineContext(pipelineContext: IPipelineContext, vertexSourceCode: string, fragmentSourceCode: string, createAsRaw: boolean, rebuildRebind: any, defines: Nullable<string>, transformFeedbackVaryings: Nullable<string[]>): void;
  37123. /** @hidden */
  37124. _isRenderingStateCompiled(pipelineContext: IPipelineContext): boolean;
  37125. /** @hidden */
  37126. _executeWhenRenderingStateIsCompiled(pipelineContext: IPipelineContext, action: () => void): void;
  37127. /**
  37128. * Gets the list of webGL uniform locations associated with a specific program based on a list of uniform names
  37129. * @param pipelineContext defines the pipeline context to use
  37130. * @param uniformsNames defines the list of uniform names
  37131. * @returns an array of webGL uniform locations
  37132. */
  37133. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): Nullable<WebGLUniformLocation>[];
  37134. /**
  37135. * Gets the lsit of active attributes for a given webGL program
  37136. * @param pipelineContext defines the pipeline context to use
  37137. * @param attributesNames defines the list of attribute names to get
  37138. * @returns an array of indices indicating the offset of each attribute
  37139. */
  37140. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  37141. /**
  37142. * Activates an effect, mkaing it the current one (ie. the one used for rendering)
  37143. * @param effect defines the effect to activate
  37144. */
  37145. enableEffect(effect: Nullable<Effect>): void;
  37146. /**
  37147. * Set the value of an uniform to a number (int)
  37148. * @param uniform defines the webGL uniform location where to store the value
  37149. * @param value defines the int number to store
  37150. */
  37151. setInt(uniform: Nullable<WebGLUniformLocation>, value: number): void;
  37152. /**
  37153. * Set the value of an uniform to an array of int32
  37154. * @param uniform defines the webGL uniform location where to store the value
  37155. * @param array defines the array of int32 to store
  37156. */
  37157. setIntArray(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  37158. /**
  37159. * Set the value of an uniform to an array of int32 (stored as vec2)
  37160. * @param uniform defines the webGL uniform location where to store the value
  37161. * @param array defines the array of int32 to store
  37162. */
  37163. setIntArray2(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  37164. /**
  37165. * Set the value of an uniform to an array of int32 (stored as vec3)
  37166. * @param uniform defines the webGL uniform location where to store the value
  37167. * @param array defines the array of int32 to store
  37168. */
  37169. setIntArray3(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  37170. /**
  37171. * Set the value of an uniform to an array of int32 (stored as vec4)
  37172. * @param uniform defines the webGL uniform location where to store the value
  37173. * @param array defines the array of int32 to store
  37174. */
  37175. setIntArray4(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  37176. /**
  37177. * Set the value of an uniform to an array of number
  37178. * @param uniform defines the webGL uniform location where to store the value
  37179. * @param array defines the array of number to store
  37180. */
  37181. setArray(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  37182. /**
  37183. * Set the value of an uniform to an array of number (stored as vec2)
  37184. * @param uniform defines the webGL uniform location where to store the value
  37185. * @param array defines the array of number to store
  37186. */
  37187. setArray2(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  37188. /**
  37189. * Set the value of an uniform to an array of number (stored as vec3)
  37190. * @param uniform defines the webGL uniform location where to store the value
  37191. * @param array defines the array of number to store
  37192. */
  37193. setArray3(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  37194. /**
  37195. * Set the value of an uniform to an array of number (stored as vec4)
  37196. * @param uniform defines the webGL uniform location where to store the value
  37197. * @param array defines the array of number to store
  37198. */
  37199. setArray4(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  37200. /**
  37201. * Set the value of an uniform to an array of float32 (stored as matrices)
  37202. * @param uniform defines the webGL uniform location where to store the value
  37203. * @param matrices defines the array of float32 to store
  37204. */
  37205. setMatrices(uniform: Nullable<WebGLUniformLocation>, matrices: Float32Array): void;
  37206. /**
  37207. * Set the value of an uniform to a matrix (3x3)
  37208. * @param uniform defines the webGL uniform location where to store the value
  37209. * @param matrix defines the Float32Array representing the 3x3 matrix to store
  37210. */
  37211. setMatrix3x3(uniform: Nullable<WebGLUniformLocation>, matrix: Float32Array): void;
  37212. /**
  37213. * Set the value of an uniform to a matrix (2x2)
  37214. * @param uniform defines the webGL uniform location where to store the value
  37215. * @param matrix defines the Float32Array representing the 2x2 matrix to store
  37216. */
  37217. setMatrix2x2(uniform: Nullable<WebGLUniformLocation>, matrix: Float32Array): void;
  37218. /**
  37219. * Set the value of an uniform to a number (float)
  37220. * @param uniform defines the webGL uniform location where to store the value
  37221. * @param value defines the float number to store
  37222. */
  37223. setFloat(uniform: Nullable<WebGLUniformLocation>, value: number): void;
  37224. /**
  37225. * Set the value of an uniform to a vec2
  37226. * @param uniform defines the webGL uniform location where to store the value
  37227. * @param x defines the 1st component of the value
  37228. * @param y defines the 2nd component of the value
  37229. */
  37230. setFloat2(uniform: Nullable<WebGLUniformLocation>, x: number, y: number): void;
  37231. /**
  37232. * Set the value of an uniform to a vec3
  37233. * @param uniform defines the webGL uniform location where to store the value
  37234. * @param x defines the 1st component of the value
  37235. * @param y defines the 2nd component of the value
  37236. * @param z defines the 3rd component of the value
  37237. */
  37238. setFloat3(uniform: Nullable<WebGLUniformLocation>, x: number, y: number, z: number): void;
  37239. /**
  37240. * Set the value of an uniform to a vec4
  37241. * @param uniform defines the webGL uniform location where to store the value
  37242. * @param x defines the 1st component of the value
  37243. * @param y defines the 2nd component of the value
  37244. * @param z defines the 3rd component of the value
  37245. * @param w defines the 4th component of the value
  37246. */
  37247. setFloat4(uniform: Nullable<WebGLUniformLocation>, x: number, y: number, z: number, w: number): void;
  37248. /**
  37249. * Apply all cached states (depth, culling, stencil and alpha)
  37250. */
  37251. applyStates(): void;
  37252. /**
  37253. * Enable or disable color writing
  37254. * @param enable defines the state to set
  37255. */
  37256. setColorWrite(enable: boolean): void;
  37257. /**
  37258. * Gets a boolean indicating if color writing is enabled
  37259. * @returns the current color writing state
  37260. */
  37261. getColorWrite(): boolean;
  37262. /**
  37263. * Gets the depth culling state manager
  37264. */
  37265. get depthCullingState(): DepthCullingState;
  37266. /**
  37267. * Gets the alpha state manager
  37268. */
  37269. get alphaState(): AlphaState;
  37270. /**
  37271. * Gets the stencil state manager
  37272. */
  37273. get stencilState(): StencilState;
  37274. /**
  37275. * Clears the list of texture accessible through engine.
  37276. * This can help preventing texture load conflict due to name collision.
  37277. */
  37278. clearInternalTexturesCache(): void;
  37279. /**
  37280. * Force the entire cache to be cleared
  37281. * You should not have to use this function unless your engine needs to share the webGL context with another engine
  37282. * @param bruteForce defines a boolean to force clearing ALL caches (including stencil, detoh and alpha states)
  37283. */
  37284. wipeCaches(bruteForce?: boolean): void;
  37285. /** @hidden */
  37286. _getSamplingParameters(samplingMode: number, generateMipMaps: boolean): {
  37287. min: number;
  37288. mag: number;
  37289. };
  37290. /** @hidden */
  37291. _createTexture(): WebGLTexture;
  37292. /**
  37293. * Usually called from Texture.ts.
  37294. * Passed information to create a WebGLTexture
  37295. * @param url defines a value which contains one of the following:
  37296. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  37297. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  37298. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  37299. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  37300. * @param invertY when true, image is flipped when loaded. You probably want true. Certain compressed textures may invert this if their default is inverted (eg. ktx)
  37301. * @param scene needed for loading to the correct scene
  37302. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  37303. * @param onLoad optional callback to be called upon successful completion
  37304. * @param onError optional callback to be called upon failure
  37305. * @param buffer a source of a file previously fetched as either a base64 string, an ArrayBuffer (compressed or image format), HTMLImageElement (image format), or a Blob
  37306. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  37307. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  37308. * @param forcedExtension defines the extension to use to pick the right loader
  37309. * @param mimeType defines an optional mime type
  37310. * @returns a InternalTexture for assignment back into BABYLON.Texture
  37311. */
  37312. createTexture(url: Nullable<string>, noMipmap: boolean, invertY: boolean, scene: Nullable<ISceneLike>, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<(message: string, exception: any) => void>, buffer?: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>, fallback?: Nullable<InternalTexture>, format?: Nullable<number>, forcedExtension?: Nullable<string>, mimeType?: string): InternalTexture;
  37313. /**
  37314. * Loads an image as an HTMLImageElement.
  37315. * @param input url string, ArrayBuffer, or Blob to load
  37316. * @param onLoad callback called when the image successfully loads
  37317. * @param onError callback called when the image fails to load
  37318. * @param offlineProvider offline provider for caching
  37319. * @param mimeType optional mime type
  37320. * @returns the HTMLImageElement of the loaded image
  37321. * @hidden
  37322. */
  37323. static _FileToolsLoadImage(input: string | ArrayBuffer | ArrayBufferView | Blob, onLoad: (img: HTMLImageElement | ImageBitmap) => void, onError: (message?: string, exception?: any) => void, offlineProvider: Nullable<IOfflineProvider>, mimeType?: string): Nullable<HTMLImageElement>;
  37324. /**
  37325. * @hidden
  37326. */
  37327. _rescaleTexture(source: InternalTexture, destination: InternalTexture, scene: Nullable<any>, internalFormat: number, onComplete: () => void): void;
  37328. private _unpackFlipYCached;
  37329. /**
  37330. * In case you are sharing the context with other applications, it might
  37331. * be interested to not cache the unpack flip y state to ensure a consistent
  37332. * value would be set.
  37333. */
  37334. enableUnpackFlipYCached: boolean;
  37335. /** @hidden */
  37336. _unpackFlipY(value: boolean): void;
  37337. /** @hidden */
  37338. _getUnpackAlignement(): number;
  37339. private _getTextureTarget;
  37340. /**
  37341. * Update the sampling mode of a given texture
  37342. * @param samplingMode defines the required sampling mode
  37343. * @param texture defines the texture to update
  37344. * @param generateMipMaps defines whether to generate mipmaps for the texture
  37345. */
  37346. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture, generateMipMaps?: boolean): void;
  37347. /**
  37348. * Update the sampling mode of a given texture
  37349. * @param texture defines the texture to update
  37350. * @param wrapU defines the texture wrap mode of the u coordinates
  37351. * @param wrapV defines the texture wrap mode of the v coordinates
  37352. * @param wrapR defines the texture wrap mode of the r coordinates
  37353. */
  37354. updateTextureWrappingMode(texture: InternalTexture, wrapU: Nullable<number>, wrapV?: Nullable<number>, wrapR?: Nullable<number>): void;
  37355. /** @hidden */
  37356. _setupDepthStencilTexture(internalTexture: InternalTexture, size: number | {
  37357. width: number;
  37358. height: number;
  37359. layers?: number;
  37360. }, generateStencil: boolean, bilinearFiltering: boolean, comparisonFunction: number): void;
  37361. /** @hidden */
  37362. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  37363. /** @hidden */
  37364. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number, babylonInternalFormat?: number, useTextureWidthAndHeight?: boolean): void;
  37365. /**
  37366. * Update a portion of an internal texture
  37367. * @param texture defines the texture to update
  37368. * @param imageData defines the data to store into the texture
  37369. * @param xOffset defines the x coordinates of the update rectangle
  37370. * @param yOffset defines the y coordinates of the update rectangle
  37371. * @param width defines the width of the update rectangle
  37372. * @param height defines the height of the update rectangle
  37373. * @param faceIndex defines the face index if texture is a cube (0 by default)
  37374. * @param lod defines the lod level to update (0 by default)
  37375. */
  37376. updateTextureData(texture: InternalTexture, imageData: ArrayBufferView, xOffset: number, yOffset: number, width: number, height: number, faceIndex?: number, lod?: number): void;
  37377. /** @hidden */
  37378. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  37379. protected _prepareWebGLTextureContinuation(texture: InternalTexture, scene: Nullable<ISceneLike>, noMipmap: boolean, isCompressed: boolean, samplingMode: number): void;
  37380. private _prepareWebGLTexture;
  37381. /** @hidden */
  37382. _setupFramebufferDepthAttachments(generateStencilBuffer: boolean, generateDepthBuffer: boolean, width: number, height: number, samples?: number): Nullable<WebGLRenderbuffer>;
  37383. private _getDepthStencilBuffer;
  37384. /** @hidden */
  37385. _releaseFramebufferObjects(texture: InternalTexture): void;
  37386. /** @hidden */
  37387. _releaseTexture(texture: InternalTexture): void;
  37388. protected _deleteTexture(texture: Nullable<WebGLTexture>): void;
  37389. protected _setProgram(program: WebGLProgram): void;
  37390. protected _boundUniforms: {
  37391. [key: number]: WebGLUniformLocation;
  37392. };
  37393. /**
  37394. * Binds an effect to the webGL context
  37395. * @param effect defines the effect to bind
  37396. */
  37397. bindSamplers(effect: Effect): void;
  37398. private _activateCurrentTexture;
  37399. /** @hidden */
  37400. _bindTextureDirectly(target: number, texture: Nullable<InternalTexture>, forTextureDataUpdate?: boolean, force?: boolean): boolean;
  37401. /** @hidden */
  37402. _bindTexture(channel: number, texture: Nullable<InternalTexture>): void;
  37403. /**
  37404. * Unbind all textures from the webGL context
  37405. */
  37406. unbindAllTextures(): void;
  37407. /**
  37408. * Sets a texture to the according uniform.
  37409. * @param channel The texture channel
  37410. * @param uniform The uniform to set
  37411. * @param texture The texture to apply
  37412. */
  37413. setTexture(channel: number, uniform: Nullable<WebGLUniformLocation>, texture: Nullable<BaseTexture>): void;
  37414. private _bindSamplerUniformToChannel;
  37415. private _getTextureWrapMode;
  37416. protected _setTexture(channel: number, texture: Nullable<BaseTexture>, isPartOfTextureArray?: boolean, depthStencilTexture?: boolean): boolean;
  37417. /**
  37418. * Sets an array of texture to the webGL context
  37419. * @param channel defines the channel where the texture array must be set
  37420. * @param uniform defines the associated uniform location
  37421. * @param textures defines the array of textures to bind
  37422. */
  37423. setTextureArray(channel: number, uniform: Nullable<WebGLUniformLocation>, textures: BaseTexture[]): void;
  37424. /** @hidden */
  37425. _setAnisotropicLevel(target: number, internalTexture: InternalTexture, anisotropicFilteringLevel: number): void;
  37426. private _setTextureParameterFloat;
  37427. private _setTextureParameterInteger;
  37428. /**
  37429. * Unbind all vertex attributes from the webGL context
  37430. */
  37431. unbindAllAttributes(): void;
  37432. /**
  37433. * Force the engine to release all cached effects. This means that next effect compilation will have to be done completely even if a similar effect was already compiled
  37434. */
  37435. releaseEffects(): void;
  37436. /**
  37437. * Dispose and release all associated resources
  37438. */
  37439. dispose(): void;
  37440. /**
  37441. * Attach a new callback raised when context lost event is fired
  37442. * @param callback defines the callback to call
  37443. */
  37444. attachContextLostEvent(callback: ((event: WebGLContextEvent) => void)): void;
  37445. /**
  37446. * Attach a new callback raised when context restored event is fired
  37447. * @param callback defines the callback to call
  37448. */
  37449. attachContextRestoredEvent(callback: ((event: WebGLContextEvent) => void)): void;
  37450. /**
  37451. * Get the current error code of the webGL context
  37452. * @returns the error code
  37453. * @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getError
  37454. */
  37455. getError(): number;
  37456. private _canRenderToFloatFramebuffer;
  37457. private _canRenderToHalfFloatFramebuffer;
  37458. private _canRenderToFramebuffer;
  37459. /** @hidden */
  37460. _getWebGLTextureType(type: number): number;
  37461. /** @hidden */
  37462. _getInternalFormat(format: number): number;
  37463. /** @hidden */
  37464. _getRGBABufferInternalSizedFormat(type: number, format?: number): number;
  37465. /** @hidden */
  37466. _getRGBAMultiSampleBufferFormat(type: number): number;
  37467. /** @hidden */
  37468. _loadFile(url: string, onSuccess: (data: string | ArrayBuffer, responseURL?: string) => void, onProgress?: (data: any) => void, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean, onError?: (request?: IWebRequest, exception?: any) => void): IFileRequest;
  37469. /**
  37470. * Loads a file from a url
  37471. * @param url url to load
  37472. * @param onSuccess callback called when the file successfully loads
  37473. * @param onProgress callback called while file is loading (if the server supports this mode)
  37474. * @param offlineProvider defines the offline provider for caching
  37475. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  37476. * @param onError callback called when the file fails to load
  37477. * @returns a file request object
  37478. * @hidden
  37479. */
  37480. static _FileToolsLoadFile(url: string, onSuccess: (data: string | ArrayBuffer, responseURL?: string) => void, onProgress?: (ev: ProgressEvent) => void, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean, onError?: (request?: WebRequest, exception?: LoadFileError) => void): IFileRequest;
  37481. /**
  37482. * Reads pixels from the current frame buffer. Please note that this function can be slow
  37483. * @param x defines the x coordinate of the rectangle where pixels must be read
  37484. * @param y defines the y coordinate of the rectangle where pixels must be read
  37485. * @param width defines the width of the rectangle where pixels must be read
  37486. * @param height defines the height of the rectangle where pixels must be read
  37487. * @param hasAlpha defines whether the output should have alpha or not (defaults to true)
  37488. * @returns a Uint8Array containing RGBA colors
  37489. */
  37490. readPixels(x: number, y: number, width: number, height: number, hasAlpha?: boolean): Uint8Array;
  37491. private static _isSupported;
  37492. /**
  37493. * Gets a boolean indicating if the engine can be instanciated (ie. if a webGL context can be found)
  37494. * @returns true if the engine can be created
  37495. * @ignorenaming
  37496. */
  37497. static isSupported(): boolean;
  37498. /**
  37499. * Find the next highest power of two.
  37500. * @param x Number to start search from.
  37501. * @return Next highest power of two.
  37502. */
  37503. static CeilingPOT(x: number): number;
  37504. /**
  37505. * Find the next lowest power of two.
  37506. * @param x Number to start search from.
  37507. * @return Next lowest power of two.
  37508. */
  37509. static FloorPOT(x: number): number;
  37510. /**
  37511. * Find the nearest power of two.
  37512. * @param x Number to start search from.
  37513. * @return Next nearest power of two.
  37514. */
  37515. static NearestPOT(x: number): number;
  37516. /**
  37517. * Get the closest exponent of two
  37518. * @param value defines the value to approximate
  37519. * @param max defines the maximum value to return
  37520. * @param mode defines how to define the closest value
  37521. * @returns closest exponent of two of the given value
  37522. */
  37523. static GetExponentOfTwo(value: number, max: number, mode?: number): number;
  37524. /**
  37525. * Queue a new function into the requested animation frame pool (ie. this function will be executed byt the browser for the next frame)
  37526. * @param func - the function to be called
  37527. * @param requester - the object that will request the next frame. Falls back to window.
  37528. * @returns frame number
  37529. */
  37530. static QueueNewFrame(func: () => void, requester?: any): number;
  37531. /**
  37532. * Gets host document
  37533. * @returns the host document object
  37534. */
  37535. getHostDocument(): Nullable<Document>;
  37536. }
  37537. }
  37538. declare module "babylonjs/Maths/sphericalPolynomial" {
  37539. import { Vector3 } from "babylonjs/Maths/math.vector";
  37540. import { Color3 } from "babylonjs/Maths/math.color";
  37541. /**
  37542. * Class representing spherical harmonics coefficients to the 3rd degree
  37543. */
  37544. export class SphericalHarmonics {
  37545. /**
  37546. * Defines whether or not the harmonics have been prescaled for rendering.
  37547. */
  37548. preScaled: boolean;
  37549. /**
  37550. * The l0,0 coefficients of the spherical harmonics
  37551. */
  37552. l00: Vector3;
  37553. /**
  37554. * The l1,-1 coefficients of the spherical harmonics
  37555. */
  37556. l1_1: Vector3;
  37557. /**
  37558. * The l1,0 coefficients of the spherical harmonics
  37559. */
  37560. l10: Vector3;
  37561. /**
  37562. * The l1,1 coefficients of the spherical harmonics
  37563. */
  37564. l11: Vector3;
  37565. /**
  37566. * The l2,-2 coefficients of the spherical harmonics
  37567. */
  37568. l2_2: Vector3;
  37569. /**
  37570. * The l2,-1 coefficients of the spherical harmonics
  37571. */
  37572. l2_1: Vector3;
  37573. /**
  37574. * The l2,0 coefficients of the spherical harmonics
  37575. */
  37576. l20: Vector3;
  37577. /**
  37578. * The l2,1 coefficients of the spherical harmonics
  37579. */
  37580. l21: Vector3;
  37581. /**
  37582. * The l2,2 coefficients of the spherical harmonics
  37583. */
  37584. l22: Vector3;
  37585. /**
  37586. * Adds a light to the spherical harmonics
  37587. * @param direction the direction of the light
  37588. * @param color the color of the light
  37589. * @param deltaSolidAngle the delta solid angle of the light
  37590. */
  37591. addLight(direction: Vector3, color: Color3, deltaSolidAngle: number): void;
  37592. /**
  37593. * Scales the spherical harmonics by the given amount
  37594. * @param scale the amount to scale
  37595. */
  37596. scaleInPlace(scale: number): void;
  37597. /**
  37598. * Convert from incident radiance (Li) to irradiance (E) by applying convolution with the cosine-weighted hemisphere.
  37599. *
  37600. * ```
  37601. * E_lm = A_l * L_lm
  37602. * ```
  37603. *
  37604. * In spherical harmonics this convolution amounts to scaling factors for each frequency band.
  37605. * This corresponds to equation 5 in "An Efficient Representation for Irradiance Environment Maps", where
  37606. * the scaling factors are given in equation 9.
  37607. */
  37608. convertIncidentRadianceToIrradiance(): void;
  37609. /**
  37610. * Convert from irradiance to outgoing radiance for Lambertian BDRF, suitable for efficient shader evaluation.
  37611. *
  37612. * ```
  37613. * L = (1/pi) * E * rho
  37614. * ```
  37615. *
  37616. * This is done by an additional scale by 1/pi, so is a fairly trivial operation but important conceptually.
  37617. */
  37618. convertIrradianceToLambertianRadiance(): void;
  37619. /**
  37620. * Integrates the reconstruction coefficients directly in to the SH preventing further
  37621. * required operations at run time.
  37622. *
  37623. * This is simply done by scaling back the SH with Ylm constants parameter.
  37624. * The trigonometric part being applied by the shader at run time.
  37625. */
  37626. preScaleForRendering(): void;
  37627. /**
  37628. * Constructs a spherical harmonics from an array.
  37629. * @param data defines the 9x3 coefficients (l00, l1-1, l10, l11, l2-2, l2-1, l20, l21, l22)
  37630. * @returns the spherical harmonics
  37631. */
  37632. static FromArray(data: ArrayLike<ArrayLike<number>>): SphericalHarmonics;
  37633. /**
  37634. * Gets the spherical harmonics from polynomial
  37635. * @param polynomial the spherical polynomial
  37636. * @returns the spherical harmonics
  37637. */
  37638. static FromPolynomial(polynomial: SphericalPolynomial): SphericalHarmonics;
  37639. }
  37640. /**
  37641. * Class representing spherical polynomial coefficients to the 3rd degree
  37642. */
  37643. export class SphericalPolynomial {
  37644. private _harmonics;
  37645. /**
  37646. * The spherical harmonics used to create the polynomials.
  37647. */
  37648. get preScaledHarmonics(): SphericalHarmonics;
  37649. /**
  37650. * The x coefficients of the spherical polynomial
  37651. */
  37652. x: Vector3;
  37653. /**
  37654. * The y coefficients of the spherical polynomial
  37655. */
  37656. y: Vector3;
  37657. /**
  37658. * The z coefficients of the spherical polynomial
  37659. */
  37660. z: Vector3;
  37661. /**
  37662. * The xx coefficients of the spherical polynomial
  37663. */
  37664. xx: Vector3;
  37665. /**
  37666. * The yy coefficients of the spherical polynomial
  37667. */
  37668. yy: Vector3;
  37669. /**
  37670. * The zz coefficients of the spherical polynomial
  37671. */
  37672. zz: Vector3;
  37673. /**
  37674. * The xy coefficients of the spherical polynomial
  37675. */
  37676. xy: Vector3;
  37677. /**
  37678. * The yz coefficients of the spherical polynomial
  37679. */
  37680. yz: Vector3;
  37681. /**
  37682. * The zx coefficients of the spherical polynomial
  37683. */
  37684. zx: Vector3;
  37685. /**
  37686. * Adds an ambient color to the spherical polynomial
  37687. * @param color the color to add
  37688. */
  37689. addAmbient(color: Color3): void;
  37690. /**
  37691. * Scales the spherical polynomial by the given amount
  37692. * @param scale the amount to scale
  37693. */
  37694. scaleInPlace(scale: number): void;
  37695. /**
  37696. * Gets the spherical polynomial from harmonics
  37697. * @param harmonics the spherical harmonics
  37698. * @returns the spherical polynomial
  37699. */
  37700. static FromHarmonics(harmonics: SphericalHarmonics): SphericalPolynomial;
  37701. /**
  37702. * Constructs a spherical polynomial from an array.
  37703. * @param data defines the 9x3 coefficients (x, y, z, xx, yy, zz, yz, zx, xy)
  37704. * @returns the spherical polynomial
  37705. */
  37706. static FromArray(data: ArrayLike<ArrayLike<number>>): SphericalPolynomial;
  37707. }
  37708. }
  37709. declare module "babylonjs/Materials/Textures/internalTexture" {
  37710. import { Observable } from "babylonjs/Misc/observable";
  37711. import { Nullable, int } from "babylonjs/types";
  37712. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  37713. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  37714. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  37715. /**
  37716. * Defines the source of the internal texture
  37717. */
  37718. export enum InternalTextureSource {
  37719. /**
  37720. * The source of the texture data is unknown
  37721. */
  37722. Unknown = 0,
  37723. /**
  37724. * Texture data comes from an URL
  37725. */
  37726. Url = 1,
  37727. /**
  37728. * Texture data is only used for temporary storage
  37729. */
  37730. Temp = 2,
  37731. /**
  37732. * Texture data comes from raw data (ArrayBuffer)
  37733. */
  37734. Raw = 3,
  37735. /**
  37736. * Texture content is dynamic (video or dynamic texture)
  37737. */
  37738. Dynamic = 4,
  37739. /**
  37740. * Texture content is generated by rendering to it
  37741. */
  37742. RenderTarget = 5,
  37743. /**
  37744. * Texture content is part of a multi render target process
  37745. */
  37746. MultiRenderTarget = 6,
  37747. /**
  37748. * Texture data comes from a cube data file
  37749. */
  37750. Cube = 7,
  37751. /**
  37752. * Texture data comes from a raw cube data
  37753. */
  37754. CubeRaw = 8,
  37755. /**
  37756. * Texture data come from a prefiltered cube data file
  37757. */
  37758. CubePrefiltered = 9,
  37759. /**
  37760. * Texture content is raw 3D data
  37761. */
  37762. Raw3D = 10,
  37763. /**
  37764. * Texture content is raw 2D array data
  37765. */
  37766. Raw2DArray = 11,
  37767. /**
  37768. * Texture content is a depth texture
  37769. */
  37770. Depth = 12,
  37771. /**
  37772. * Texture data comes from a raw cube data encoded with RGBD
  37773. */
  37774. CubeRawRGBD = 13
  37775. }
  37776. /**
  37777. * Class used to store data associated with WebGL texture data for the engine
  37778. * This class should not be used directly
  37779. */
  37780. export class InternalTexture {
  37781. /** @hidden */
  37782. static _UpdateRGBDAsync: (internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number) => Promise<void>;
  37783. /**
  37784. * Defines if the texture is ready
  37785. */
  37786. isReady: boolean;
  37787. /**
  37788. * Defines if the texture is a cube texture
  37789. */
  37790. isCube: boolean;
  37791. /**
  37792. * Defines if the texture contains 3D data
  37793. */
  37794. is3D: boolean;
  37795. /**
  37796. * Defines if the texture contains 2D array data
  37797. */
  37798. is2DArray: boolean;
  37799. /**
  37800. * Defines if the texture contains multiview data
  37801. */
  37802. isMultiview: boolean;
  37803. /**
  37804. * Gets the URL used to load this texture
  37805. */
  37806. url: string;
  37807. /**
  37808. * Gets the sampling mode of the texture
  37809. */
  37810. samplingMode: number;
  37811. /**
  37812. * Gets a boolean indicating if the texture needs mipmaps generation
  37813. */
  37814. generateMipMaps: boolean;
  37815. /**
  37816. * Gets the number of samples used by the texture (WebGL2+ only)
  37817. */
  37818. samples: number;
  37819. /**
  37820. * Gets the type of the texture (int, float...)
  37821. */
  37822. type: number;
  37823. /**
  37824. * Gets the format of the texture (RGB, RGBA...)
  37825. */
  37826. format: number;
  37827. /**
  37828. * Observable called when the texture is loaded
  37829. */
  37830. onLoadedObservable: Observable<InternalTexture>;
  37831. /**
  37832. * Gets the width of the texture
  37833. */
  37834. width: number;
  37835. /**
  37836. * Gets the height of the texture
  37837. */
  37838. height: number;
  37839. /**
  37840. * Gets the depth of the texture
  37841. */
  37842. depth: number;
  37843. /**
  37844. * Gets the initial width of the texture (It could be rescaled if the current system does not support non power of two textures)
  37845. */
  37846. baseWidth: number;
  37847. /**
  37848. * Gets the initial height of the texture (It could be rescaled if the current system does not support non power of two textures)
  37849. */
  37850. baseHeight: number;
  37851. /**
  37852. * Gets the initial depth of the texture (It could be rescaled if the current system does not support non power of two textures)
  37853. */
  37854. baseDepth: number;
  37855. /**
  37856. * Gets a boolean indicating if the texture is inverted on Y axis
  37857. */
  37858. invertY: boolean;
  37859. /** @hidden */
  37860. _invertVScale: boolean;
  37861. /** @hidden */
  37862. _associatedChannel: number;
  37863. /** @hidden */
  37864. _source: InternalTextureSource;
  37865. /** @hidden */
  37866. _buffer: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>;
  37867. /** @hidden */
  37868. _bufferView: Nullable<ArrayBufferView>;
  37869. /** @hidden */
  37870. _bufferViewArray: Nullable<ArrayBufferView[]>;
  37871. /** @hidden */
  37872. _bufferViewArrayArray: Nullable<ArrayBufferView[][]>;
  37873. /** @hidden */
  37874. _size: number;
  37875. /** @hidden */
  37876. _extension: string;
  37877. /** @hidden */
  37878. _files: Nullable<string[]>;
  37879. /** @hidden */
  37880. _workingCanvas: Nullable<HTMLCanvasElement | OffscreenCanvas>;
  37881. /** @hidden */
  37882. _workingContext: Nullable<CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D>;
  37883. /** @hidden */
  37884. _framebuffer: Nullable<WebGLFramebuffer>;
  37885. /** @hidden */
  37886. _depthStencilBuffer: Nullable<WebGLRenderbuffer>;
  37887. /** @hidden */
  37888. _MSAAFramebuffer: Nullable<WebGLFramebuffer>;
  37889. /** @hidden */
  37890. _MSAARenderBuffer: Nullable<WebGLRenderbuffer>;
  37891. /** @hidden */
  37892. _attachments: Nullable<number[]>;
  37893. /** @hidden */
  37894. _textureArray: Nullable<InternalTexture[]>;
  37895. /** @hidden */
  37896. _cachedCoordinatesMode: Nullable<number>;
  37897. /** @hidden */
  37898. _cachedWrapU: Nullable<number>;
  37899. /** @hidden */
  37900. _cachedWrapV: Nullable<number>;
  37901. /** @hidden */
  37902. _cachedWrapR: Nullable<number>;
  37903. /** @hidden */
  37904. _cachedAnisotropicFilteringLevel: Nullable<number>;
  37905. /** @hidden */
  37906. _isDisabled: boolean;
  37907. /** @hidden */
  37908. _compression: Nullable<string>;
  37909. /** @hidden */
  37910. _generateStencilBuffer: boolean;
  37911. /** @hidden */
  37912. _generateDepthBuffer: boolean;
  37913. /** @hidden */
  37914. _comparisonFunction: number;
  37915. /** @hidden */
  37916. _sphericalPolynomial: Nullable<SphericalPolynomial>;
  37917. /** @hidden */
  37918. _lodGenerationScale: number;
  37919. /** @hidden */
  37920. _lodGenerationOffset: number;
  37921. /** @hidden */
  37922. _depthStencilTexture: Nullable<InternalTexture>;
  37923. /** @hidden */
  37924. _colorTextureArray: Nullable<WebGLTexture>;
  37925. /** @hidden */
  37926. _depthStencilTextureArray: Nullable<WebGLTexture>;
  37927. /** @hidden */
  37928. _lodTextureHigh: Nullable<BaseTexture>;
  37929. /** @hidden */
  37930. _lodTextureMid: Nullable<BaseTexture>;
  37931. /** @hidden */
  37932. _lodTextureLow: Nullable<BaseTexture>;
  37933. /** @hidden */
  37934. _isRGBD: boolean;
  37935. /** @hidden */
  37936. _linearSpecularLOD: boolean;
  37937. /** @hidden */
  37938. _irradianceTexture: Nullable<BaseTexture>;
  37939. /** @hidden */
  37940. _webGLTexture: Nullable<WebGLTexture>;
  37941. /** @hidden */
  37942. _references: number;
  37943. private _engine;
  37944. /**
  37945. * Gets the Engine the texture belongs to.
  37946. * @returns The babylon engine
  37947. */
  37948. getEngine(): ThinEngine;
  37949. /**
  37950. * Gets the data source type of the texture
  37951. */
  37952. get source(): InternalTextureSource;
  37953. /**
  37954. * Creates a new InternalTexture
  37955. * @param engine defines the engine to use
  37956. * @param source defines the type of data that will be used
  37957. * @param delayAllocation if the texture allocation should be delayed (default: false)
  37958. */
  37959. constructor(engine: ThinEngine, source: InternalTextureSource, delayAllocation?: boolean);
  37960. /**
  37961. * Increments the number of references (ie. the number of Texture that point to it)
  37962. */
  37963. incrementReferences(): void;
  37964. /**
  37965. * Change the size of the texture (not the size of the content)
  37966. * @param width defines the new width
  37967. * @param height defines the new height
  37968. * @param depth defines the new depth (1 by default)
  37969. */
  37970. updateSize(width: int, height: int, depth?: int): void;
  37971. /** @hidden */
  37972. _rebuild(): void;
  37973. /** @hidden */
  37974. _swapAndDie(target: InternalTexture): void;
  37975. /**
  37976. * Dispose the current allocated resources
  37977. */
  37978. dispose(): void;
  37979. }
  37980. }
  37981. declare module "babylonjs/Audio/analyser" {
  37982. import { Scene } from "babylonjs/scene";
  37983. /**
  37984. * Class used to work with sound analyzer using fast fourier transform (FFT)
  37985. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  37986. */
  37987. export class Analyser {
  37988. /**
  37989. * Gets or sets the smoothing
  37990. * @ignorenaming
  37991. */
  37992. SMOOTHING: number;
  37993. /**
  37994. * Gets or sets the FFT table size
  37995. * @ignorenaming
  37996. */
  37997. FFT_SIZE: number;
  37998. /**
  37999. * Gets or sets the bar graph amplitude
  38000. * @ignorenaming
  38001. */
  38002. BARGRAPHAMPLITUDE: number;
  38003. /**
  38004. * Gets or sets the position of the debug canvas
  38005. * @ignorenaming
  38006. */
  38007. DEBUGCANVASPOS: {
  38008. x: number;
  38009. y: number;
  38010. };
  38011. /**
  38012. * Gets or sets the debug canvas size
  38013. * @ignorenaming
  38014. */
  38015. DEBUGCANVASSIZE: {
  38016. width: number;
  38017. height: number;
  38018. };
  38019. private _byteFreqs;
  38020. private _byteTime;
  38021. private _floatFreqs;
  38022. private _webAudioAnalyser;
  38023. private _debugCanvas;
  38024. private _debugCanvasContext;
  38025. private _scene;
  38026. private _registerFunc;
  38027. private _audioEngine;
  38028. /**
  38029. * Creates a new analyser
  38030. * @param scene defines hosting scene
  38031. */
  38032. constructor(scene: Scene);
  38033. /**
  38034. * Get the number of data values you will have to play with for the visualization
  38035. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/frequencyBinCount
  38036. * @returns a number
  38037. */
  38038. getFrequencyBinCount(): number;
  38039. /**
  38040. * Gets the current frequency data as a byte array
  38041. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData
  38042. * @returns a Uint8Array
  38043. */
  38044. getByteFrequencyData(): Uint8Array;
  38045. /**
  38046. * Gets the current waveform as a byte array
  38047. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteTimeDomainData
  38048. * @returns a Uint8Array
  38049. */
  38050. getByteTimeDomainData(): Uint8Array;
  38051. /**
  38052. * Gets the current frequency data as a float array
  38053. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData
  38054. * @returns a Float32Array
  38055. */
  38056. getFloatFrequencyData(): Float32Array;
  38057. /**
  38058. * Renders the debug canvas
  38059. */
  38060. drawDebugCanvas(): void;
  38061. /**
  38062. * Stops rendering the debug canvas and removes it
  38063. */
  38064. stopDebugCanvas(): void;
  38065. /**
  38066. * Connects two audio nodes
  38067. * @param inputAudioNode defines first node to connect
  38068. * @param outputAudioNode defines second node to connect
  38069. */
  38070. connectAudioNodes(inputAudioNode: AudioNode, outputAudioNode: AudioNode): void;
  38071. /**
  38072. * Releases all associated resources
  38073. */
  38074. dispose(): void;
  38075. }
  38076. }
  38077. declare module "babylonjs/Audio/audioEngine" {
  38078. import { IDisposable } from "babylonjs/scene";
  38079. import { Analyser } from "babylonjs/Audio/analyser";
  38080. import { Nullable } from "babylonjs/types";
  38081. import { Observable } from "babylonjs/Misc/observable";
  38082. /**
  38083. * This represents an audio engine and it is responsible
  38084. * to play, synchronize and analyse sounds throughout the application.
  38085. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  38086. */
  38087. export interface IAudioEngine extends IDisposable {
  38088. /**
  38089. * Gets whether the current host supports Web Audio and thus could create AudioContexts.
  38090. */
  38091. readonly canUseWebAudio: boolean;
  38092. /**
  38093. * Gets the current AudioContext if available.
  38094. */
  38095. readonly audioContext: Nullable<AudioContext>;
  38096. /**
  38097. * The master gain node defines the global audio volume of your audio engine.
  38098. */
  38099. readonly masterGain: GainNode;
  38100. /**
  38101. * Gets whether or not mp3 are supported by your browser.
  38102. */
  38103. readonly isMP3supported: boolean;
  38104. /**
  38105. * Gets whether or not ogg are supported by your browser.
  38106. */
  38107. readonly isOGGsupported: boolean;
  38108. /**
  38109. * Defines if Babylon should emit a warning if WebAudio is not supported.
  38110. * @ignoreNaming
  38111. */
  38112. WarnedWebAudioUnsupported: boolean;
  38113. /**
  38114. * Defines if the audio engine relies on a custom unlocked button.
  38115. * In this case, the embedded button will not be displayed.
  38116. */
  38117. useCustomUnlockedButton: boolean;
  38118. /**
  38119. * Gets whether or not the audio engine is unlocked (require first a user gesture on some browser).
  38120. */
  38121. readonly unlocked: boolean;
  38122. /**
  38123. * Event raised when audio has been unlocked on the browser.
  38124. */
  38125. onAudioUnlockedObservable: Observable<AudioEngine>;
  38126. /**
  38127. * Event raised when audio has been locked on the browser.
  38128. */
  38129. onAudioLockedObservable: Observable<AudioEngine>;
  38130. /**
  38131. * Flags the audio engine in Locked state.
  38132. * This happens due to new browser policies preventing audio to autoplay.
  38133. */
  38134. lock(): void;
  38135. /**
  38136. * Unlocks the audio engine once a user action has been done on the dom.
  38137. * This is helpful to resume play once browser policies have been satisfied.
  38138. */
  38139. unlock(): void;
  38140. /**
  38141. * Gets the global volume sets on the master gain.
  38142. * @returns the global volume if set or -1 otherwise
  38143. */
  38144. getGlobalVolume(): number;
  38145. /**
  38146. * Sets the global volume of your experience (sets on the master gain).
  38147. * @param newVolume Defines the new global volume of the application
  38148. */
  38149. setGlobalVolume(newVolume: number): void;
  38150. /**
  38151. * Connect the audio engine to an audio analyser allowing some amazing
  38152. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  38153. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  38154. * @param analyser The analyser to connect to the engine
  38155. */
  38156. connectToAnalyser(analyser: Analyser): void;
  38157. }
  38158. /**
  38159. * This represents the default audio engine used in babylon.
  38160. * It is responsible to play, synchronize and analyse sounds throughout the application.
  38161. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  38162. */
  38163. export class AudioEngine implements IAudioEngine {
  38164. private _audioContext;
  38165. private _audioContextInitialized;
  38166. private _muteButton;
  38167. private _hostElement;
  38168. /**
  38169. * Gets whether the current host supports Web Audio and thus could create AudioContexts.
  38170. */
  38171. canUseWebAudio: boolean;
  38172. /**
  38173. * The master gain node defines the global audio volume of your audio engine.
  38174. */
  38175. masterGain: GainNode;
  38176. /**
  38177. * Defines if Babylon should emit a warning if WebAudio is not supported.
  38178. * @ignoreNaming
  38179. */
  38180. WarnedWebAudioUnsupported: boolean;
  38181. /**
  38182. * Gets whether or not mp3 are supported by your browser.
  38183. */
  38184. isMP3supported: boolean;
  38185. /**
  38186. * Gets whether or not ogg are supported by your browser.
  38187. */
  38188. isOGGsupported: boolean;
  38189. /**
  38190. * Gets whether audio has been unlocked on the device.
  38191. * Some Browsers have strong restrictions about Audio and won t autoplay unless
  38192. * a user interaction has happened.
  38193. */
  38194. unlocked: boolean;
  38195. /**
  38196. * Defines if the audio engine relies on a custom unlocked button.
  38197. * In this case, the embedded button will not be displayed.
  38198. */
  38199. useCustomUnlockedButton: boolean;
  38200. /**
  38201. * Event raised when audio has been unlocked on the browser.
  38202. */
  38203. onAudioUnlockedObservable: Observable<AudioEngine>;
  38204. /**
  38205. * Event raised when audio has been locked on the browser.
  38206. */
  38207. onAudioLockedObservable: Observable<AudioEngine>;
  38208. /**
  38209. * Gets the current AudioContext if available.
  38210. */
  38211. get audioContext(): Nullable<AudioContext>;
  38212. private _connectedAnalyser;
  38213. /**
  38214. * Instantiates a new audio engine.
  38215. *
  38216. * There should be only one per page as some browsers restrict the number
  38217. * of audio contexts you can create.
  38218. * @param hostElement defines the host element where to display the mute icon if necessary
  38219. */
  38220. constructor(hostElement?: Nullable<HTMLElement>);
  38221. /**
  38222. * Flags the audio engine in Locked state.
  38223. * This happens due to new browser policies preventing audio to autoplay.
  38224. */
  38225. lock(): void;
  38226. /**
  38227. * Unlocks the audio engine once a user action has been done on the dom.
  38228. * This is helpful to resume play once browser policies have been satisfied.
  38229. */
  38230. unlock(): void;
  38231. private _resumeAudioContext;
  38232. private _initializeAudioContext;
  38233. private _tryToRun;
  38234. private _triggerRunningState;
  38235. private _triggerSuspendedState;
  38236. private _displayMuteButton;
  38237. private _moveButtonToTopLeft;
  38238. private _onResize;
  38239. private _hideMuteButton;
  38240. /**
  38241. * Destroy and release the resources associated with the audio ccontext.
  38242. */
  38243. dispose(): void;
  38244. /**
  38245. * Gets the global volume sets on the master gain.
  38246. * @returns the global volume if set or -1 otherwise
  38247. */
  38248. getGlobalVolume(): number;
  38249. /**
  38250. * Sets the global volume of your experience (sets on the master gain).
  38251. * @param newVolume Defines the new global volume of the application
  38252. */
  38253. setGlobalVolume(newVolume: number): void;
  38254. /**
  38255. * Connect the audio engine to an audio analyser allowing some amazing
  38256. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  38257. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  38258. * @param analyser The analyser to connect to the engine
  38259. */
  38260. connectToAnalyser(analyser: Analyser): void;
  38261. }
  38262. }
  38263. declare module "babylonjs/Loading/loadingScreen" {
  38264. /**
  38265. * Interface used to present a loading screen while loading a scene
  38266. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  38267. */
  38268. export interface ILoadingScreen {
  38269. /**
  38270. * Function called to display the loading screen
  38271. */
  38272. displayLoadingUI: () => void;
  38273. /**
  38274. * Function called to hide the loading screen
  38275. */
  38276. hideLoadingUI: () => void;
  38277. /**
  38278. * Gets or sets the color to use for the background
  38279. */
  38280. loadingUIBackgroundColor: string;
  38281. /**
  38282. * Gets or sets the text to display while loading
  38283. */
  38284. loadingUIText: string;
  38285. }
  38286. /**
  38287. * Class used for the default loading screen
  38288. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  38289. */
  38290. export class DefaultLoadingScreen implements ILoadingScreen {
  38291. private _renderingCanvas;
  38292. private _loadingText;
  38293. private _loadingDivBackgroundColor;
  38294. private _loadingDiv;
  38295. private _loadingTextDiv;
  38296. /** Gets or sets the logo url to use for the default loading screen */
  38297. static DefaultLogoUrl: string;
  38298. /** Gets or sets the spinner url to use for the default loading screen */
  38299. static DefaultSpinnerUrl: string;
  38300. /**
  38301. * Creates a new default loading screen
  38302. * @param _renderingCanvas defines the canvas used to render the scene
  38303. * @param _loadingText defines the default text to display
  38304. * @param _loadingDivBackgroundColor defines the default background color
  38305. */
  38306. constructor(_renderingCanvas: HTMLCanvasElement, _loadingText?: string, _loadingDivBackgroundColor?: string);
  38307. /**
  38308. * Function called to display the loading screen
  38309. */
  38310. displayLoadingUI(): void;
  38311. /**
  38312. * Function called to hide the loading screen
  38313. */
  38314. hideLoadingUI(): void;
  38315. /**
  38316. * Gets or sets the text to display while loading
  38317. */
  38318. set loadingUIText(text: string);
  38319. get loadingUIText(): string;
  38320. /**
  38321. * Gets or sets the color to use for the background
  38322. */
  38323. get loadingUIBackgroundColor(): string;
  38324. set loadingUIBackgroundColor(color: string);
  38325. private _resizeLoadingUI;
  38326. }
  38327. }
  38328. declare module "babylonjs/Misc/customAnimationFrameRequester" {
  38329. /**
  38330. * Interface for any object that can request an animation frame
  38331. */
  38332. export interface ICustomAnimationFrameRequester {
  38333. /**
  38334. * This function will be called when the render loop is ready. If this is not populated, the engine's renderloop function will be called
  38335. */
  38336. renderFunction?: Function;
  38337. /**
  38338. * Called to request the next frame to render to
  38339. * @see https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame
  38340. */
  38341. requestAnimationFrame: Function;
  38342. /**
  38343. * You can pass this value to cancelAnimationFrame() to cancel the refresh callback request
  38344. * @see https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame#Return_value
  38345. */
  38346. requestID?: number;
  38347. }
  38348. }
  38349. declare module "babylonjs/Misc/performanceMonitor" {
  38350. /**
  38351. * Performance monitor tracks rolling average frame-time and frame-time variance over a user defined sliding-window
  38352. */
  38353. export class PerformanceMonitor {
  38354. private _enabled;
  38355. private _rollingFrameTime;
  38356. private _lastFrameTimeMs;
  38357. /**
  38358. * constructor
  38359. * @param frameSampleSize The number of samples required to saturate the sliding window
  38360. */
  38361. constructor(frameSampleSize?: number);
  38362. /**
  38363. * Samples current frame
  38364. * @param timeMs A timestamp in milliseconds of the current frame to compare with other frames
  38365. */
  38366. sampleFrame(timeMs?: number): void;
  38367. /**
  38368. * Returns the average frame time in milliseconds over the sliding window (or the subset of frames sampled so far)
  38369. */
  38370. get averageFrameTime(): number;
  38371. /**
  38372. * Returns the variance frame time in milliseconds over the sliding window (or the subset of frames sampled so far)
  38373. */
  38374. get averageFrameTimeVariance(): number;
  38375. /**
  38376. * Returns the frame time of the most recent frame
  38377. */
  38378. get instantaneousFrameTime(): number;
  38379. /**
  38380. * Returns the average framerate in frames per second over the sliding window (or the subset of frames sampled so far)
  38381. */
  38382. get averageFPS(): number;
  38383. /**
  38384. * Returns the average framerate in frames per second using the most recent frame time
  38385. */
  38386. get instantaneousFPS(): number;
  38387. /**
  38388. * Returns true if enough samples have been taken to completely fill the sliding window
  38389. */
  38390. get isSaturated(): boolean;
  38391. /**
  38392. * Enables contributions to the sliding window sample set
  38393. */
  38394. enable(): void;
  38395. /**
  38396. * Disables contributions to the sliding window sample set
  38397. * Samples will not be interpolated over the disabled period
  38398. */
  38399. disable(): void;
  38400. /**
  38401. * Returns true if sampling is enabled
  38402. */
  38403. get isEnabled(): boolean;
  38404. /**
  38405. * Resets performance monitor
  38406. */
  38407. reset(): void;
  38408. }
  38409. /**
  38410. * RollingAverage
  38411. *
  38412. * Utility to efficiently compute the rolling average and variance over a sliding window of samples
  38413. */
  38414. export class RollingAverage {
  38415. /**
  38416. * Current average
  38417. */
  38418. average: number;
  38419. /**
  38420. * Current variance
  38421. */
  38422. variance: number;
  38423. protected _samples: Array<number>;
  38424. protected _sampleCount: number;
  38425. protected _pos: number;
  38426. protected _m2: number;
  38427. /**
  38428. * constructor
  38429. * @param length The number of samples required to saturate the sliding window
  38430. */
  38431. constructor(length: number);
  38432. /**
  38433. * Adds a sample to the sample set
  38434. * @param v The sample value
  38435. */
  38436. add(v: number): void;
  38437. /**
  38438. * Returns previously added values or null if outside of history or outside the sliding window domain
  38439. * @param i Index in history. For example, pass 0 for the most recent value and 1 for the value before that
  38440. * @return Value previously recorded with add() or null if outside of range
  38441. */
  38442. history(i: number): number;
  38443. /**
  38444. * Returns true if enough samples have been taken to completely fill the sliding window
  38445. * @return true if sample-set saturated
  38446. */
  38447. isSaturated(): boolean;
  38448. /**
  38449. * Resets the rolling average (equivalent to 0 samples taken so far)
  38450. */
  38451. reset(): void;
  38452. /**
  38453. * Wraps a value around the sample range boundaries
  38454. * @param i Position in sample range, for example if the sample length is 5, and i is -3, then 2 will be returned.
  38455. * @return Wrapped position in sample range
  38456. */
  38457. protected _wrapPosition(i: number): number;
  38458. }
  38459. }
  38460. declare module "babylonjs/Misc/perfCounter" {
  38461. /**
  38462. * This class is used to track a performance counter which is number based.
  38463. * The user has access to many properties which give statistics of different nature.
  38464. *
  38465. * The implementer can track two kinds of Performance Counter: time and count.
  38466. * For time you can optionally call fetchNewFrame() to notify the start of a new frame to monitor, then call beginMonitoring() to start and endMonitoring() to record the lapsed time. endMonitoring takes a newFrame parameter for you to specify if the monitored time should be set for a new frame or accumulated to the current frame being monitored.
  38467. * For count you first have to call fetchNewFrame() to notify the start of a new frame to monitor, then call addCount() how many time required to increment the count value you monitor.
  38468. */
  38469. export class PerfCounter {
  38470. /**
  38471. * Gets or sets a global boolean to turn on and off all the counters
  38472. */
  38473. static Enabled: boolean;
  38474. /**
  38475. * Returns the smallest value ever
  38476. */
  38477. get min(): number;
  38478. /**
  38479. * Returns the biggest value ever
  38480. */
  38481. get max(): number;
  38482. /**
  38483. * Returns the average value since the performance counter is running
  38484. */
  38485. get average(): number;
  38486. /**
  38487. * Returns the average value of the last second the counter was monitored
  38488. */
  38489. get lastSecAverage(): number;
  38490. /**
  38491. * Returns the current value
  38492. */
  38493. get current(): number;
  38494. /**
  38495. * Gets the accumulated total
  38496. */
  38497. get total(): number;
  38498. /**
  38499. * Gets the total value count
  38500. */
  38501. get count(): number;
  38502. /**
  38503. * Creates a new counter
  38504. */
  38505. constructor();
  38506. /**
  38507. * Call this method to start monitoring a new frame.
  38508. * This scenario is typically used when you accumulate monitoring time many times for a single frame, you call this method at the start of the frame, then beginMonitoring to start recording and endMonitoring(false) to accumulated the recorded time to the PerfCounter or addCount() to accumulate a monitored count.
  38509. */
  38510. fetchNewFrame(): void;
  38511. /**
  38512. * Call this method to monitor a count of something (e.g. mesh drawn in viewport count)
  38513. * @param newCount the count value to add to the monitored count
  38514. * @param fetchResult true when it's the last time in the frame you add to the counter and you wish to update the statistics properties (min/max/average), false if you only want to update statistics.
  38515. */
  38516. addCount(newCount: number, fetchResult: boolean): void;
  38517. /**
  38518. * Start monitoring this performance counter
  38519. */
  38520. beginMonitoring(): void;
  38521. /**
  38522. * Compute the time lapsed since the previous beginMonitoring() call.
  38523. * @param newFrame true by default to fetch the result and monitor a new frame, if false the time monitored will be added to the current frame counter
  38524. */
  38525. endMonitoring(newFrame?: boolean): void;
  38526. private _fetchResult;
  38527. private _startMonitoringTime;
  38528. private _min;
  38529. private _max;
  38530. private _average;
  38531. private _current;
  38532. private _totalValueCount;
  38533. private _totalAccumulated;
  38534. private _lastSecAverage;
  38535. private _lastSecAccumulated;
  38536. private _lastSecTime;
  38537. private _lastSecValueCount;
  38538. }
  38539. }
  38540. declare module "babylonjs/Engines/Extensions/engine.readTexture" {
  38541. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  38542. import { Nullable } from "babylonjs/types";
  38543. module "babylonjs/Engines/thinEngine" {
  38544. interface ThinEngine {
  38545. /** @hidden */
  38546. _readTexturePixels(texture: InternalTexture, width: number, height: number, faceIndex?: number, level?: number, buffer?: Nullable<ArrayBufferView>): ArrayBufferView;
  38547. }
  38548. }
  38549. }
  38550. declare module "babylonjs/Engines/engine" {
  38551. import { Observable } from "babylonjs/Misc/observable";
  38552. import { Nullable } from "babylonjs/types";
  38553. import { Scene } from "babylonjs/scene";
  38554. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  38555. import { IAudioEngine } from "babylonjs/Audio/audioEngine";
  38556. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  38557. import { ILoadingScreen } from "babylonjs/Loading/loadingScreen";
  38558. import { WebGLPipelineContext } from "babylonjs/Engines/WebGL/webGLPipelineContext";
  38559. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  38560. import { ICustomAnimationFrameRequester } from "babylonjs/Misc/customAnimationFrameRequester";
  38561. import { ThinEngine, EngineOptions } from "babylonjs/Engines/thinEngine";
  38562. import { IViewportLike, IColor4Like } from "babylonjs/Maths/math.like";
  38563. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  38564. import { PerformanceMonitor } from "babylonjs/Misc/performanceMonitor";
  38565. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  38566. import { PerfCounter } from "babylonjs/Misc/perfCounter";
  38567. import "babylonjs/Engines/Extensions/engine.alpha";
  38568. import "babylonjs/Engines/Extensions/engine.readTexture";
  38569. import "babylonjs/Engines/Extensions/engine.dynamicBuffer";
  38570. import { Material } from "babylonjs/Materials/material";
  38571. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  38572. /**
  38573. * Defines the interface used by display changed events
  38574. */
  38575. export interface IDisplayChangedEventArgs {
  38576. /** Gets the vrDisplay object (if any) */
  38577. vrDisplay: Nullable<any>;
  38578. /** Gets a boolean indicating if webVR is supported */
  38579. vrSupported: boolean;
  38580. }
  38581. /**
  38582. * Defines the interface used by objects containing a viewport (like a camera)
  38583. */
  38584. interface IViewportOwnerLike {
  38585. /**
  38586. * Gets or sets the viewport
  38587. */
  38588. viewport: IViewportLike;
  38589. }
  38590. /**
  38591. * The engine class is responsible for interfacing with all lower-level APIs such as WebGL and Audio
  38592. */
  38593. export class Engine extends ThinEngine {
  38594. /** Defines that alpha blending is disabled */
  38595. static readonly ALPHA_DISABLE: number;
  38596. /** Defines that alpha blending to SRC ALPHA * SRC + DEST */
  38597. static readonly ALPHA_ADD: number;
  38598. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC ALPHA) * DEST */
  38599. static readonly ALPHA_COMBINE: number;
  38600. /** Defines that alpha blending to DEST - SRC * DEST */
  38601. static readonly ALPHA_SUBTRACT: number;
  38602. /** Defines that alpha blending to SRC * DEST */
  38603. static readonly ALPHA_MULTIPLY: number;
  38604. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC) * DEST */
  38605. static readonly ALPHA_MAXIMIZED: number;
  38606. /** Defines that alpha blending to SRC + DEST */
  38607. static readonly ALPHA_ONEONE: number;
  38608. /** Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST */
  38609. static readonly ALPHA_PREMULTIPLIED: number;
  38610. /**
  38611. * Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST
  38612. * Alpha will be set to (1 - SRC ALPHA) * DEST ALPHA
  38613. */
  38614. static readonly ALPHA_PREMULTIPLIED_PORTERDUFF: number;
  38615. /** Defines that alpha blending to CST * SRC + (1 - CST) * DEST */
  38616. static readonly ALPHA_INTERPOLATE: number;
  38617. /**
  38618. * Defines that alpha blending to SRC + (1 - SRC) * DEST
  38619. * Alpha will be set to SRC ALPHA + (1 - SRC ALPHA) * DEST ALPHA
  38620. */
  38621. static readonly ALPHA_SCREENMODE: number;
  38622. /** Defines that the ressource is not delayed*/
  38623. static readonly DELAYLOADSTATE_NONE: number;
  38624. /** Defines that the ressource was successfully delay loaded */
  38625. static readonly DELAYLOADSTATE_LOADED: number;
  38626. /** Defines that the ressource is currently delay loading */
  38627. static readonly DELAYLOADSTATE_LOADING: number;
  38628. /** Defines that the ressource is delayed and has not started loading */
  38629. static readonly DELAYLOADSTATE_NOTLOADED: number;
  38630. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will never pass. i.e. Nothing will be drawn */
  38631. static readonly NEVER: number;
  38632. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will always pass. i.e. Pixels will be drawn in the order they are drawn */
  38633. static readonly ALWAYS: number;
  38634. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than the stored value */
  38635. static readonly LESS: number;
  38636. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is equals to the stored value */
  38637. static readonly EQUAL: number;
  38638. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than or equal to the stored value */
  38639. static readonly LEQUAL: number;
  38640. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than the stored value */
  38641. static readonly GREATER: number;
  38642. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than or equal to the stored value */
  38643. static readonly GEQUAL: number;
  38644. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is not equal to the stored value */
  38645. static readonly NOTEQUAL: number;
  38646. /** Passed to stencilOperation to specify that stencil value must be kept */
  38647. static readonly KEEP: number;
  38648. /** Passed to stencilOperation to specify that stencil value must be replaced */
  38649. static readonly REPLACE: number;
  38650. /** Passed to stencilOperation to specify that stencil value must be incremented */
  38651. static readonly INCR: number;
  38652. /** Passed to stencilOperation to specify that stencil value must be decremented */
  38653. static readonly DECR: number;
  38654. /** Passed to stencilOperation to specify that stencil value must be inverted */
  38655. static readonly INVERT: number;
  38656. /** Passed to stencilOperation to specify that stencil value must be incremented with wrapping */
  38657. static readonly INCR_WRAP: number;
  38658. /** Passed to stencilOperation to specify that stencil value must be decremented with wrapping */
  38659. static readonly DECR_WRAP: number;
  38660. /** Texture is not repeating outside of 0..1 UVs */
  38661. static readonly TEXTURE_CLAMP_ADDRESSMODE: number;
  38662. /** Texture is repeating outside of 0..1 UVs */
  38663. static readonly TEXTURE_WRAP_ADDRESSMODE: number;
  38664. /** Texture is repeating and mirrored */
  38665. static readonly TEXTURE_MIRROR_ADDRESSMODE: number;
  38666. /** ALPHA */
  38667. static readonly TEXTUREFORMAT_ALPHA: number;
  38668. /** LUMINANCE */
  38669. static readonly TEXTUREFORMAT_LUMINANCE: number;
  38670. /** LUMINANCE_ALPHA */
  38671. static readonly TEXTUREFORMAT_LUMINANCE_ALPHA: number;
  38672. /** RGB */
  38673. static readonly TEXTUREFORMAT_RGB: number;
  38674. /** RGBA */
  38675. static readonly TEXTUREFORMAT_RGBA: number;
  38676. /** RED */
  38677. static readonly TEXTUREFORMAT_RED: number;
  38678. /** RED (2nd reference) */
  38679. static readonly TEXTUREFORMAT_R: number;
  38680. /** RG */
  38681. static readonly TEXTUREFORMAT_RG: number;
  38682. /** RED_INTEGER */
  38683. static readonly TEXTUREFORMAT_RED_INTEGER: number;
  38684. /** RED_INTEGER (2nd reference) */
  38685. static readonly TEXTUREFORMAT_R_INTEGER: number;
  38686. /** RG_INTEGER */
  38687. static readonly TEXTUREFORMAT_RG_INTEGER: number;
  38688. /** RGB_INTEGER */
  38689. static readonly TEXTUREFORMAT_RGB_INTEGER: number;
  38690. /** RGBA_INTEGER */
  38691. static readonly TEXTUREFORMAT_RGBA_INTEGER: number;
  38692. /** UNSIGNED_BYTE */
  38693. static readonly TEXTURETYPE_UNSIGNED_BYTE: number;
  38694. /** UNSIGNED_BYTE (2nd reference) */
  38695. static readonly TEXTURETYPE_UNSIGNED_INT: number;
  38696. /** FLOAT */
  38697. static readonly TEXTURETYPE_FLOAT: number;
  38698. /** HALF_FLOAT */
  38699. static readonly TEXTURETYPE_HALF_FLOAT: number;
  38700. /** BYTE */
  38701. static readonly TEXTURETYPE_BYTE: number;
  38702. /** SHORT */
  38703. static readonly TEXTURETYPE_SHORT: number;
  38704. /** UNSIGNED_SHORT */
  38705. static readonly TEXTURETYPE_UNSIGNED_SHORT: number;
  38706. /** INT */
  38707. static readonly TEXTURETYPE_INT: number;
  38708. /** UNSIGNED_INT */
  38709. static readonly TEXTURETYPE_UNSIGNED_INTEGER: number;
  38710. /** UNSIGNED_SHORT_4_4_4_4 */
  38711. static readonly TEXTURETYPE_UNSIGNED_SHORT_4_4_4_4: number;
  38712. /** UNSIGNED_SHORT_5_5_5_1 */
  38713. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_5_5_1: number;
  38714. /** UNSIGNED_SHORT_5_6_5 */
  38715. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_6_5: number;
  38716. /** UNSIGNED_INT_2_10_10_10_REV */
  38717. static readonly TEXTURETYPE_UNSIGNED_INT_2_10_10_10_REV: number;
  38718. /** UNSIGNED_INT_24_8 */
  38719. static readonly TEXTURETYPE_UNSIGNED_INT_24_8: number;
  38720. /** UNSIGNED_INT_10F_11F_11F_REV */
  38721. static readonly TEXTURETYPE_UNSIGNED_INT_10F_11F_11F_REV: number;
  38722. /** UNSIGNED_INT_5_9_9_9_REV */
  38723. static readonly TEXTURETYPE_UNSIGNED_INT_5_9_9_9_REV: number;
  38724. /** FLOAT_32_UNSIGNED_INT_24_8_REV */
  38725. static readonly TEXTURETYPE_FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  38726. /** nearest is mag = nearest and min = nearest and mip = linear */
  38727. static readonly TEXTURE_NEAREST_SAMPLINGMODE: number;
  38728. /** Bilinear is mag = linear and min = linear and mip = nearest */
  38729. static readonly TEXTURE_BILINEAR_SAMPLINGMODE: number;
  38730. /** Trilinear is mag = linear and min = linear and mip = linear */
  38731. static readonly TEXTURE_TRILINEAR_SAMPLINGMODE: number;
  38732. /** nearest is mag = nearest and min = nearest and mip = linear */
  38733. static readonly TEXTURE_NEAREST_NEAREST_MIPLINEAR: number;
  38734. /** Bilinear is mag = linear and min = linear and mip = nearest */
  38735. static readonly TEXTURE_LINEAR_LINEAR_MIPNEAREST: number;
  38736. /** Trilinear is mag = linear and min = linear and mip = linear */
  38737. static readonly TEXTURE_LINEAR_LINEAR_MIPLINEAR: number;
  38738. /** mag = nearest and min = nearest and mip = nearest */
  38739. static readonly TEXTURE_NEAREST_NEAREST_MIPNEAREST: number;
  38740. /** mag = nearest and min = linear and mip = nearest */
  38741. static readonly TEXTURE_NEAREST_LINEAR_MIPNEAREST: number;
  38742. /** mag = nearest and min = linear and mip = linear */
  38743. static readonly TEXTURE_NEAREST_LINEAR_MIPLINEAR: number;
  38744. /** mag = nearest and min = linear and mip = none */
  38745. static readonly TEXTURE_NEAREST_LINEAR: number;
  38746. /** mag = nearest and min = nearest and mip = none */
  38747. static readonly TEXTURE_NEAREST_NEAREST: number;
  38748. /** mag = linear and min = nearest and mip = nearest */
  38749. static readonly TEXTURE_LINEAR_NEAREST_MIPNEAREST: number;
  38750. /** mag = linear and min = nearest and mip = linear */
  38751. static readonly TEXTURE_LINEAR_NEAREST_MIPLINEAR: number;
  38752. /** mag = linear and min = linear and mip = none */
  38753. static readonly TEXTURE_LINEAR_LINEAR: number;
  38754. /** mag = linear and min = nearest and mip = none */
  38755. static readonly TEXTURE_LINEAR_NEAREST: number;
  38756. /** Explicit coordinates mode */
  38757. static readonly TEXTURE_EXPLICIT_MODE: number;
  38758. /** Spherical coordinates mode */
  38759. static readonly TEXTURE_SPHERICAL_MODE: number;
  38760. /** Planar coordinates mode */
  38761. static readonly TEXTURE_PLANAR_MODE: number;
  38762. /** Cubic coordinates mode */
  38763. static readonly TEXTURE_CUBIC_MODE: number;
  38764. /** Projection coordinates mode */
  38765. static readonly TEXTURE_PROJECTION_MODE: number;
  38766. /** Skybox coordinates mode */
  38767. static readonly TEXTURE_SKYBOX_MODE: number;
  38768. /** Inverse Cubic coordinates mode */
  38769. static readonly TEXTURE_INVCUBIC_MODE: number;
  38770. /** Equirectangular coordinates mode */
  38771. static readonly TEXTURE_EQUIRECTANGULAR_MODE: number;
  38772. /** Equirectangular Fixed coordinates mode */
  38773. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MODE: number;
  38774. /** Equirectangular Fixed Mirrored coordinates mode */
  38775. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  38776. /** Defines that texture rescaling will use a floor to find the closer power of 2 size */
  38777. static readonly SCALEMODE_FLOOR: number;
  38778. /** Defines that texture rescaling will look for the nearest power of 2 size */
  38779. static readonly SCALEMODE_NEAREST: number;
  38780. /** Defines that texture rescaling will use a ceil to find the closer power of 2 size */
  38781. static readonly SCALEMODE_CEILING: number;
  38782. /**
  38783. * Returns the current npm package of the sdk
  38784. */
  38785. static get NpmPackage(): string;
  38786. /**
  38787. * Returns the current version of the framework
  38788. */
  38789. static get Version(): string;
  38790. /** Gets the list of created engines */
  38791. static get Instances(): Engine[];
  38792. /**
  38793. * Gets the latest created engine
  38794. */
  38795. static get LastCreatedEngine(): Nullable<Engine>;
  38796. /**
  38797. * Gets the latest created scene
  38798. */
  38799. static get LastCreatedScene(): Nullable<Scene>;
  38800. /**
  38801. * Will flag all materials in all scenes in all engines as dirty to trigger new shader compilation
  38802. * @param flag defines which part of the materials must be marked as dirty
  38803. * @param predicate defines a predicate used to filter which materials should be affected
  38804. */
  38805. static MarkAllMaterialsAsDirty(flag: number, predicate?: (mat: Material) => boolean): void;
  38806. /**
  38807. * Method called to create the default loading screen.
  38808. * This can be overriden in your own app.
  38809. * @param canvas The rendering canvas element
  38810. * @returns The loading screen
  38811. */
  38812. static DefaultLoadingScreenFactory(canvas: HTMLCanvasElement): ILoadingScreen;
  38813. /**
  38814. * Method called to create the default rescale post process on each engine.
  38815. */
  38816. static _RescalePostProcessFactory: Nullable<(engine: Engine) => PostProcess>;
  38817. /**
  38818. * Gets or sets a boolean to enable/disable IndexedDB support and avoid XHR on .manifest
  38819. **/
  38820. enableOfflineSupport: boolean;
  38821. /**
  38822. * Gets or sets a boolean to enable/disable checking manifest if IndexedDB support is enabled (js will always consider the database is up to date)
  38823. **/
  38824. disableManifestCheck: boolean;
  38825. /**
  38826. * Gets the list of created scenes
  38827. */
  38828. scenes: Scene[];
  38829. /**
  38830. * Event raised when a new scene is created
  38831. */
  38832. onNewSceneAddedObservable: Observable<Scene>;
  38833. /**
  38834. * Gets the list of created postprocesses
  38835. */
  38836. postProcesses: import("babylonjs/PostProcesses/postProcess").PostProcess[];
  38837. /**
  38838. * Gets a boolean indicating if the pointer is currently locked
  38839. */
  38840. isPointerLock: boolean;
  38841. /**
  38842. * Observable event triggered each time the rendering canvas is resized
  38843. */
  38844. onResizeObservable: Observable<Engine>;
  38845. /**
  38846. * Observable event triggered each time the canvas loses focus
  38847. */
  38848. onCanvasBlurObservable: Observable<Engine>;
  38849. /**
  38850. * Observable event triggered each time the canvas gains focus
  38851. */
  38852. onCanvasFocusObservable: Observable<Engine>;
  38853. /**
  38854. * Observable event triggered each time the canvas receives pointerout event
  38855. */
  38856. onCanvasPointerOutObservable: Observable<PointerEvent>;
  38857. /**
  38858. * Observable raised when the engine begins a new frame
  38859. */
  38860. onBeginFrameObservable: Observable<Engine>;
  38861. /**
  38862. * If set, will be used to request the next animation frame for the render loop
  38863. */
  38864. customAnimationFrameRequester: Nullable<ICustomAnimationFrameRequester>;
  38865. /**
  38866. * Observable raised when the engine ends the current frame
  38867. */
  38868. onEndFrameObservable: Observable<Engine>;
  38869. /**
  38870. * Observable raised when the engine is about to compile a shader
  38871. */
  38872. onBeforeShaderCompilationObservable: Observable<Engine>;
  38873. /**
  38874. * Observable raised when the engine has jsut compiled a shader
  38875. */
  38876. onAfterShaderCompilationObservable: Observable<Engine>;
  38877. /**
  38878. * Gets the audio engine
  38879. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  38880. * @ignorenaming
  38881. */
  38882. static audioEngine: IAudioEngine;
  38883. /**
  38884. * Default AudioEngine factory responsible of creating the Audio Engine.
  38885. * By default, this will create a BabylonJS Audio Engine if the workload has been embedded.
  38886. */
  38887. static AudioEngineFactory: (hostElement: Nullable<HTMLElement>) => IAudioEngine;
  38888. /**
  38889. * Default offline support factory responsible of creating a tool used to store data locally.
  38890. * By default, this will create a Database object if the workload has been embedded.
  38891. */
  38892. static OfflineProviderFactory: (urlToScene: string, callbackManifestChecked: (checked: boolean) => any, disableManifestCheck: boolean) => IOfflineProvider;
  38893. private _loadingScreen;
  38894. private _pointerLockRequested;
  38895. private _rescalePostProcess;
  38896. private _deterministicLockstep;
  38897. private _lockstepMaxSteps;
  38898. private _timeStep;
  38899. protected get _supportsHardwareTextureRescaling(): boolean;
  38900. private _fps;
  38901. private _deltaTime;
  38902. /** @hidden */
  38903. _drawCalls: PerfCounter;
  38904. /** Gets or sets the tab index to set to the rendering canvas. 1 is the minimum value to set to be able to capture keyboard events */
  38905. canvasTabIndex: number;
  38906. /**
  38907. * Turn this value on if you want to pause FPS computation when in background
  38908. */
  38909. disablePerformanceMonitorInBackground: boolean;
  38910. private _performanceMonitor;
  38911. /**
  38912. * Gets the performance monitor attached to this engine
  38913. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  38914. */
  38915. get performanceMonitor(): PerformanceMonitor;
  38916. private _onFocus;
  38917. private _onBlur;
  38918. private _onCanvasPointerOut;
  38919. private _onCanvasBlur;
  38920. private _onCanvasFocus;
  38921. private _onFullscreenChange;
  38922. private _onPointerLockChange;
  38923. /**
  38924. * Gets the HTML element used to attach event listeners
  38925. * @returns a HTML element
  38926. */
  38927. getInputElement(): Nullable<HTMLElement>;
  38928. /**
  38929. * Creates a new engine
  38930. * @param canvasOrContext defines the canvas or WebGL context to use for rendering. If you provide a WebGL context, Babylon.js will not hook events on the canvas (like pointers, keyboards, etc...) so no event observables will be available. This is mostly used when Babylon.js is used as a plugin on a system which alreay used the WebGL context
  38931. * @param antialias defines enable antialiasing (default: false)
  38932. * @param options defines further options to be sent to the getContext() function
  38933. * @param adaptToDeviceRatio defines whether to adapt to the device's viewport characteristics (default: false)
  38934. */
  38935. constructor(canvasOrContext: Nullable<HTMLCanvasElement | WebGLRenderingContext>, antialias?: boolean, options?: EngineOptions, adaptToDeviceRatio?: boolean);
  38936. /**
  38937. * Gets current aspect ratio
  38938. * @param viewportOwner defines the camera to use to get the aspect ratio
  38939. * @param useScreen defines if screen size must be used (or the current render target if any)
  38940. * @returns a number defining the aspect ratio
  38941. */
  38942. getAspectRatio(viewportOwner: IViewportOwnerLike, useScreen?: boolean): number;
  38943. /**
  38944. * Gets current screen aspect ratio
  38945. * @returns a number defining the aspect ratio
  38946. */
  38947. getScreenAspectRatio(): number;
  38948. /**
  38949. * Gets the client rect of the HTML canvas attached with the current webGL context
  38950. * @returns a client rectanglee
  38951. */
  38952. getRenderingCanvasClientRect(): Nullable<ClientRect>;
  38953. /**
  38954. * Gets the client rect of the HTML element used for events
  38955. * @returns a client rectanglee
  38956. */
  38957. getInputElementClientRect(): Nullable<ClientRect>;
  38958. /**
  38959. * Gets a boolean indicating that the engine is running in deterministic lock step mode
  38960. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  38961. * @returns true if engine is in deterministic lock step mode
  38962. */
  38963. isDeterministicLockStep(): boolean;
  38964. /**
  38965. * Gets the max steps when engine is running in deterministic lock step
  38966. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  38967. * @returns the max steps
  38968. */
  38969. getLockstepMaxSteps(): number;
  38970. /**
  38971. * Returns the time in ms between steps when using deterministic lock step.
  38972. * @returns time step in (ms)
  38973. */
  38974. getTimeStep(): number;
  38975. /**
  38976. * Force the mipmap generation for the given render target texture
  38977. * @param texture defines the render target texture to use
  38978. * @param unbind defines whether or not to unbind the texture after generation. Defaults to true.
  38979. */
  38980. generateMipMapsForCubemap(texture: InternalTexture, unbind?: boolean): void;
  38981. /** States */
  38982. /**
  38983. * Set various states to the webGL context
  38984. * @param culling defines backface culling state
  38985. * @param zOffset defines the value to apply to zOffset (0 by default)
  38986. * @param force defines if states must be applied even if cache is up to date
  38987. * @param reverseSide defines if culling must be reversed (CCW instead of CW and CW instead of CCW)
  38988. */
  38989. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  38990. /**
  38991. * Set the z offset to apply to current rendering
  38992. * @param value defines the offset to apply
  38993. */
  38994. setZOffset(value: number): void;
  38995. /**
  38996. * Gets the current value of the zOffset
  38997. * @returns the current zOffset state
  38998. */
  38999. getZOffset(): number;
  39000. /**
  39001. * Enable or disable depth buffering
  39002. * @param enable defines the state to set
  39003. */
  39004. setDepthBuffer(enable: boolean): void;
  39005. /**
  39006. * Gets a boolean indicating if depth writing is enabled
  39007. * @returns the current depth writing state
  39008. */
  39009. getDepthWrite(): boolean;
  39010. /**
  39011. * Enable or disable depth writing
  39012. * @param enable defines the state to set
  39013. */
  39014. setDepthWrite(enable: boolean): void;
  39015. /**
  39016. * Gets a boolean indicating if stencil buffer is enabled
  39017. * @returns the current stencil buffer state
  39018. */
  39019. getStencilBuffer(): boolean;
  39020. /**
  39021. * Enable or disable the stencil buffer
  39022. * @param enable defines if the stencil buffer must be enabled or disabled
  39023. */
  39024. setStencilBuffer(enable: boolean): void;
  39025. /**
  39026. * Gets the current stencil mask
  39027. * @returns a number defining the new stencil mask to use
  39028. */
  39029. getStencilMask(): number;
  39030. /**
  39031. * Sets the current stencil mask
  39032. * @param mask defines the new stencil mask to use
  39033. */
  39034. setStencilMask(mask: number): void;
  39035. /**
  39036. * Gets the current stencil function
  39037. * @returns a number defining the stencil function to use
  39038. */
  39039. getStencilFunction(): number;
  39040. /**
  39041. * Gets the current stencil reference value
  39042. * @returns a number defining the stencil reference value to use
  39043. */
  39044. getStencilFunctionReference(): number;
  39045. /**
  39046. * Gets the current stencil mask
  39047. * @returns a number defining the stencil mask to use
  39048. */
  39049. getStencilFunctionMask(): number;
  39050. /**
  39051. * Sets the current stencil function
  39052. * @param stencilFunc defines the new stencil function to use
  39053. */
  39054. setStencilFunction(stencilFunc: number): void;
  39055. /**
  39056. * Sets the current stencil reference
  39057. * @param reference defines the new stencil reference to use
  39058. */
  39059. setStencilFunctionReference(reference: number): void;
  39060. /**
  39061. * Sets the current stencil mask
  39062. * @param mask defines the new stencil mask to use
  39063. */
  39064. setStencilFunctionMask(mask: number): void;
  39065. /**
  39066. * Gets the current stencil operation when stencil fails
  39067. * @returns a number defining stencil operation to use when stencil fails
  39068. */
  39069. getStencilOperationFail(): number;
  39070. /**
  39071. * Gets the current stencil operation when depth fails
  39072. * @returns a number defining stencil operation to use when depth fails
  39073. */
  39074. getStencilOperationDepthFail(): number;
  39075. /**
  39076. * Gets the current stencil operation when stencil passes
  39077. * @returns a number defining stencil operation to use when stencil passes
  39078. */
  39079. getStencilOperationPass(): number;
  39080. /**
  39081. * Sets the stencil operation to use when stencil fails
  39082. * @param operation defines the stencil operation to use when stencil fails
  39083. */
  39084. setStencilOperationFail(operation: number): void;
  39085. /**
  39086. * Sets the stencil operation to use when depth fails
  39087. * @param operation defines the stencil operation to use when depth fails
  39088. */
  39089. setStencilOperationDepthFail(operation: number): void;
  39090. /**
  39091. * Sets the stencil operation to use when stencil passes
  39092. * @param operation defines the stencil operation to use when stencil passes
  39093. */
  39094. setStencilOperationPass(operation: number): void;
  39095. /**
  39096. * Sets a boolean indicating if the dithering state is enabled or disabled
  39097. * @param value defines the dithering state
  39098. */
  39099. setDitheringState(value: boolean): void;
  39100. /**
  39101. * Sets a boolean indicating if the rasterizer state is enabled or disabled
  39102. * @param value defines the rasterizer state
  39103. */
  39104. setRasterizerState(value: boolean): void;
  39105. /**
  39106. * Gets the current depth function
  39107. * @returns a number defining the depth function
  39108. */
  39109. getDepthFunction(): Nullable<number>;
  39110. /**
  39111. * Sets the current depth function
  39112. * @param depthFunc defines the function to use
  39113. */
  39114. setDepthFunction(depthFunc: number): void;
  39115. /**
  39116. * Sets the current depth function to GREATER
  39117. */
  39118. setDepthFunctionToGreater(): void;
  39119. /**
  39120. * Sets the current depth function to GEQUAL
  39121. */
  39122. setDepthFunctionToGreaterOrEqual(): void;
  39123. /**
  39124. * Sets the current depth function to LESS
  39125. */
  39126. setDepthFunctionToLess(): void;
  39127. /**
  39128. * Sets the current depth function to LEQUAL
  39129. */
  39130. setDepthFunctionToLessOrEqual(): void;
  39131. private _cachedStencilBuffer;
  39132. private _cachedStencilFunction;
  39133. private _cachedStencilMask;
  39134. private _cachedStencilOperationPass;
  39135. private _cachedStencilOperationFail;
  39136. private _cachedStencilOperationDepthFail;
  39137. private _cachedStencilReference;
  39138. /**
  39139. * Caches the the state of the stencil buffer
  39140. */
  39141. cacheStencilState(): void;
  39142. /**
  39143. * Restores the state of the stencil buffer
  39144. */
  39145. restoreStencilState(): void;
  39146. /**
  39147. * Directly set the WebGL Viewport
  39148. * @param x defines the x coordinate of the viewport (in screen space)
  39149. * @param y defines the y coordinate of the viewport (in screen space)
  39150. * @param width defines the width of the viewport (in screen space)
  39151. * @param height defines the height of the viewport (in screen space)
  39152. * @return the current viewport Object (if any) that is being replaced by this call. You can restore this viewport later on to go back to the original state
  39153. */
  39154. setDirectViewport(x: number, y: number, width: number, height: number): Nullable<IViewportLike>;
  39155. /**
  39156. * Executes a scissor clear (ie. a clear on a specific portion of the screen)
  39157. * @param x defines the x-coordinate of the top left corner of the clear rectangle
  39158. * @param y defines the y-coordinate of the corner of the clear rectangle
  39159. * @param width defines the width of the clear rectangle
  39160. * @param height defines the height of the clear rectangle
  39161. * @param clearColor defines the clear color
  39162. */
  39163. scissorClear(x: number, y: number, width: number, height: number, clearColor: IColor4Like): void;
  39164. /**
  39165. * Enable scissor test on a specific rectangle (ie. render will only be executed on a specific portion of the screen)
  39166. * @param x defines the x-coordinate of the top left corner of the clear rectangle
  39167. * @param y defines the y-coordinate of the corner of the clear rectangle
  39168. * @param width defines the width of the clear rectangle
  39169. * @param height defines the height of the clear rectangle
  39170. */
  39171. enableScissor(x: number, y: number, width: number, height: number): void;
  39172. /**
  39173. * Disable previously set scissor test rectangle
  39174. */
  39175. disableScissor(): void;
  39176. protected _reportDrawCall(): void;
  39177. /**
  39178. * Initializes a webVR display and starts listening to display change events
  39179. * The onVRDisplayChangedObservable will be notified upon these changes
  39180. * @returns The onVRDisplayChangedObservable
  39181. */
  39182. initWebVR(): Observable<IDisplayChangedEventArgs>;
  39183. /** @hidden */
  39184. _prepareVRComponent(): void;
  39185. /** @hidden */
  39186. _connectVREvents(canvas?: HTMLCanvasElement, document?: any): void;
  39187. /** @hidden */
  39188. _submitVRFrame(): void;
  39189. /**
  39190. * Call this function to leave webVR mode
  39191. * Will do nothing if webVR is not supported or if there is no webVR device
  39192. * @see https://doc.babylonjs.com/how_to/webvr_camera
  39193. */
  39194. disableVR(): void;
  39195. /**
  39196. * Gets a boolean indicating that the system is in VR mode and is presenting
  39197. * @returns true if VR mode is engaged
  39198. */
  39199. isVRPresenting(): boolean;
  39200. /** @hidden */
  39201. _requestVRFrame(): void;
  39202. /** @hidden */
  39203. _loadFileAsync(url: string, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  39204. /**
  39205. * Gets the source code of the vertex shader associated with a specific webGL program
  39206. * @param program defines the program to use
  39207. * @returns a string containing the source code of the vertex shader associated with the program
  39208. */
  39209. getVertexShaderSource(program: WebGLProgram): Nullable<string>;
  39210. /**
  39211. * Gets the source code of the fragment shader associated with a specific webGL program
  39212. * @param program defines the program to use
  39213. * @returns a string containing the source code of the fragment shader associated with the program
  39214. */
  39215. getFragmentShaderSource(program: WebGLProgram): Nullable<string>;
  39216. /**
  39217. * Sets a depth stencil texture from a render target to the according uniform.
  39218. * @param channel The texture channel
  39219. * @param uniform The uniform to set
  39220. * @param texture The render target texture containing the depth stencil texture to apply
  39221. */
  39222. setDepthStencilTexture(channel: number, uniform: Nullable<WebGLUniformLocation>, texture: Nullable<RenderTargetTexture>): void;
  39223. /**
  39224. * Sets a texture to the webGL context from a postprocess
  39225. * @param channel defines the channel to use
  39226. * @param postProcess defines the source postprocess
  39227. */
  39228. setTextureFromPostProcess(channel: number, postProcess: Nullable<PostProcess>): void;
  39229. /**
  39230. * Binds the output of the passed in post process to the texture channel specified
  39231. * @param channel The channel the texture should be bound to
  39232. * @param postProcess The post process which's output should be bound
  39233. */
  39234. setTextureFromPostProcessOutput(channel: number, postProcess: Nullable<PostProcess>): void;
  39235. protected _rebuildBuffers(): void;
  39236. /** @hidden */
  39237. _renderFrame(): void;
  39238. _renderLoop(): void;
  39239. /** @hidden */
  39240. _renderViews(): boolean;
  39241. /**
  39242. * Toggle full screen mode
  39243. * @param requestPointerLock defines if a pointer lock should be requested from the user
  39244. */
  39245. switchFullscreen(requestPointerLock: boolean): void;
  39246. /**
  39247. * Enters full screen mode
  39248. * @param requestPointerLock defines if a pointer lock should be requested from the user
  39249. */
  39250. enterFullscreen(requestPointerLock: boolean): void;
  39251. /**
  39252. * Exits full screen mode
  39253. */
  39254. exitFullscreen(): void;
  39255. /**
  39256. * Enters Pointerlock mode
  39257. */
  39258. enterPointerlock(): void;
  39259. /**
  39260. * Exits Pointerlock mode
  39261. */
  39262. exitPointerlock(): void;
  39263. /**
  39264. * Begin a new frame
  39265. */
  39266. beginFrame(): void;
  39267. /**
  39268. * Enf the current frame
  39269. */
  39270. endFrame(): void;
  39271. resize(): void;
  39272. /**
  39273. * Force a specific size of the canvas
  39274. * @param width defines the new canvas' width
  39275. * @param height defines the new canvas' height
  39276. * @returns true if the size was changed
  39277. */
  39278. setSize(width: number, height: number): boolean;
  39279. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  39280. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  39281. protected _createShaderProgram(pipelineContext: WebGLPipelineContext, vertexShader: WebGLShader, fragmentShader: WebGLShader, context: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  39282. _releaseTexture(texture: InternalTexture): void;
  39283. /**
  39284. * @hidden
  39285. * Rescales a texture
  39286. * @param source input texutre
  39287. * @param destination destination texture
  39288. * @param scene scene to use to render the resize
  39289. * @param internalFormat format to use when resizing
  39290. * @param onComplete callback to be called when resize has completed
  39291. */
  39292. _rescaleTexture(source: InternalTexture, destination: InternalTexture, scene: Nullable<any>, internalFormat: number, onComplete: () => void): void;
  39293. /**
  39294. * Gets the current framerate
  39295. * @returns a number representing the framerate
  39296. */
  39297. getFps(): number;
  39298. /**
  39299. * Gets the time spent between current and previous frame
  39300. * @returns a number representing the delta time in ms
  39301. */
  39302. getDeltaTime(): number;
  39303. private _measureFps;
  39304. /** @hidden */
  39305. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement | ImageBitmap, faceIndex?: number, lod?: number): void;
  39306. /**
  39307. * Updates the sample count of a render target texture
  39308. * @see https://doc.babylonjs.com/features/webgl2#multisample-render-targets
  39309. * @param texture defines the texture to update
  39310. * @param samples defines the sample count to set
  39311. * @returns the effective sample count (could be 0 if multisample render targets are not supported)
  39312. */
  39313. updateRenderTargetTextureSampleCount(texture: Nullable<InternalTexture>, samples: number): number;
  39314. /**
  39315. * Updates a depth texture Comparison Mode and Function.
  39316. * If the comparison Function is equal to 0, the mode will be set to none.
  39317. * Otherwise, this only works in webgl 2 and requires a shadow sampler in the shader.
  39318. * @param texture The texture to set the comparison function for
  39319. * @param comparisonFunction The comparison function to set, 0 if no comparison required
  39320. */
  39321. updateTextureComparisonFunction(texture: InternalTexture, comparisonFunction: number): void;
  39322. /**
  39323. * Creates a webGL buffer to use with instanciation
  39324. * @param capacity defines the size of the buffer
  39325. * @returns the webGL buffer
  39326. */
  39327. createInstancesBuffer(capacity: number): DataBuffer;
  39328. /**
  39329. * Delete a webGL buffer used with instanciation
  39330. * @param buffer defines the webGL buffer to delete
  39331. */
  39332. deleteInstancesBuffer(buffer: WebGLBuffer): void;
  39333. private _clientWaitAsync;
  39334. /** @hidden */
  39335. _readPixelsAsync(x: number, y: number, w: number, h: number, format: number, type: number, outputBuffer: ArrayBufferView): Promise<ArrayBufferView> | null;
  39336. dispose(): void;
  39337. private _disableTouchAction;
  39338. /**
  39339. * Display the loading screen
  39340. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  39341. */
  39342. displayLoadingUI(): void;
  39343. /**
  39344. * Hide the loading screen
  39345. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  39346. */
  39347. hideLoadingUI(): void;
  39348. /**
  39349. * Gets the current loading screen object
  39350. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  39351. */
  39352. get loadingScreen(): ILoadingScreen;
  39353. /**
  39354. * Sets the current loading screen object
  39355. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  39356. */
  39357. set loadingScreen(loadingScreen: ILoadingScreen);
  39358. /**
  39359. * Sets the current loading screen text
  39360. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  39361. */
  39362. set loadingUIText(text: string);
  39363. /**
  39364. * Sets the current loading screen background color
  39365. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  39366. */
  39367. set loadingUIBackgroundColor(color: string);
  39368. /** Pointerlock and fullscreen */
  39369. /**
  39370. * Ask the browser to promote the current element to pointerlock mode
  39371. * @param element defines the DOM element to promote
  39372. */
  39373. static _RequestPointerlock(element: HTMLElement): void;
  39374. /**
  39375. * Asks the browser to exit pointerlock mode
  39376. */
  39377. static _ExitPointerlock(): void;
  39378. /**
  39379. * Ask the browser to promote the current element to fullscreen rendering mode
  39380. * @param element defines the DOM element to promote
  39381. */
  39382. static _RequestFullscreen(element: HTMLElement): void;
  39383. /**
  39384. * Asks the browser to exit fullscreen mode
  39385. */
  39386. static _ExitFullscreen(): void;
  39387. }
  39388. }
  39389. declare module "babylonjs/Engines/engineStore" {
  39390. import { Nullable } from "babylonjs/types";
  39391. import { Engine } from "babylonjs/Engines/engine";
  39392. import { Scene } from "babylonjs/scene";
  39393. /**
  39394. * The engine store class is responsible to hold all the instances of Engine and Scene created
  39395. * during the life time of the application.
  39396. */
  39397. export class EngineStore {
  39398. /** Gets the list of created engines */
  39399. static Instances: import("babylonjs/Engines/engine").Engine[];
  39400. /** @hidden */
  39401. static _LastCreatedScene: Nullable<Scene>;
  39402. /**
  39403. * Gets the latest created engine
  39404. */
  39405. static get LastCreatedEngine(): Nullable<Engine>;
  39406. /**
  39407. * Gets the latest created scene
  39408. */
  39409. static get LastCreatedScene(): Nullable<Scene>;
  39410. /**
  39411. * Gets or sets a global variable indicating if fallback texture must be used when a texture cannot be loaded
  39412. * @ignorenaming
  39413. */
  39414. static UseFallbackTexture: boolean;
  39415. /**
  39416. * Texture content used if a texture cannot loaded
  39417. * @ignorenaming
  39418. */
  39419. static FallbackTexture: string;
  39420. }
  39421. }
  39422. declare module "babylonjs/Misc/promise" {
  39423. /**
  39424. * Helper class that provides a small promise polyfill
  39425. */
  39426. export class PromisePolyfill {
  39427. /**
  39428. * Static function used to check if the polyfill is required
  39429. * If this is the case then the function will inject the polyfill to window.Promise
  39430. * @param force defines a boolean used to force the injection (mostly for testing purposes)
  39431. */
  39432. static Apply(force?: boolean): void;
  39433. }
  39434. }
  39435. declare module "babylonjs/Misc/interfaces/screenshotSize" {
  39436. /**
  39437. * Interface for screenshot methods with describe argument called `size` as object with options
  39438. * @link https://doc.babylonjs.com/api/classes/babylon.screenshottools
  39439. */
  39440. export interface IScreenshotSize {
  39441. /**
  39442. * number in pixels for canvas height
  39443. */
  39444. height?: number;
  39445. /**
  39446. * multiplier allowing render at a higher or lower resolution
  39447. * If value is defined then height and width will be ignored and taken from camera
  39448. */
  39449. precision?: number;
  39450. /**
  39451. * number in pixels for canvas width
  39452. */
  39453. width?: number;
  39454. }
  39455. }
  39456. declare module "babylonjs/Misc/tools" {
  39457. import { Nullable, float } from "babylonjs/types";
  39458. import { DomManagement } from "babylonjs/Misc/domManagement";
  39459. import { WebRequest } from "babylonjs/Misc/webRequest";
  39460. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  39461. import { ReadFileError } from "babylonjs/Misc/fileTools";
  39462. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  39463. import { IScreenshotSize } from "babylonjs/Misc/interfaces/screenshotSize";
  39464. import { Camera } from "babylonjs/Cameras/camera";
  39465. import { Engine } from "babylonjs/Engines/engine";
  39466. interface IColor4Like {
  39467. r: float;
  39468. g: float;
  39469. b: float;
  39470. a: float;
  39471. }
  39472. /**
  39473. * Class containing a set of static utilities functions
  39474. */
  39475. export class Tools {
  39476. /**
  39477. * Gets or sets the base URL to use to load assets
  39478. */
  39479. static get BaseUrl(): string;
  39480. static set BaseUrl(value: string);
  39481. /**
  39482. * Enable/Disable Custom HTTP Request Headers globally.
  39483. * default = false
  39484. * @see CustomRequestHeaders
  39485. */
  39486. static UseCustomRequestHeaders: boolean;
  39487. /**
  39488. * Custom HTTP Request Headers to be sent with XMLHttpRequests
  39489. * i.e. when loading files, where the server/service expects an Authorization header
  39490. */
  39491. static CustomRequestHeaders: {
  39492. [key: string]: string;
  39493. };
  39494. /**
  39495. * Gets or sets the retry strategy to apply when an error happens while loading an asset
  39496. */
  39497. static get DefaultRetryStrategy(): (url: string, request: WebRequest, retryIndex: number) => number;
  39498. static set DefaultRetryStrategy(strategy: (url: string, request: WebRequest, retryIndex: number) => number);
  39499. /**
  39500. * Default behaviour for cors in the application.
  39501. * It can be a string if the expected behavior is identical in the entire app.
  39502. * Or a callback to be able to set it per url or on a group of them (in case of Video source for instance)
  39503. */
  39504. static get CorsBehavior(): string | ((url: string | string[]) => string);
  39505. static set CorsBehavior(value: string | ((url: string | string[]) => string));
  39506. /**
  39507. * Gets or sets a global variable indicating if fallback texture must be used when a texture cannot be loaded
  39508. * @ignorenaming
  39509. */
  39510. static get UseFallbackTexture(): boolean;
  39511. static set UseFallbackTexture(value: boolean);
  39512. /**
  39513. * Use this object to register external classes like custom textures or material
  39514. * to allow the laoders to instantiate them
  39515. */
  39516. static get RegisteredExternalClasses(): {
  39517. [key: string]: Object;
  39518. };
  39519. static set RegisteredExternalClasses(classes: {
  39520. [key: string]: Object;
  39521. });
  39522. /**
  39523. * Texture content used if a texture cannot loaded
  39524. * @ignorenaming
  39525. */
  39526. static get fallbackTexture(): string;
  39527. static set fallbackTexture(value: string);
  39528. /**
  39529. * Read the content of a byte array at a specified coordinates (taking in account wrapping)
  39530. * @param u defines the coordinate on X axis
  39531. * @param v defines the coordinate on Y axis
  39532. * @param width defines the width of the source data
  39533. * @param height defines the height of the source data
  39534. * @param pixels defines the source byte array
  39535. * @param color defines the output color
  39536. */
  39537. static FetchToRef(u: number, v: number, width: number, height: number, pixels: Uint8Array, color: IColor4Like): void;
  39538. /**
  39539. * Interpolates between a and b via alpha
  39540. * @param a The lower value (returned when alpha = 0)
  39541. * @param b The upper value (returned when alpha = 1)
  39542. * @param alpha The interpolation-factor
  39543. * @return The mixed value
  39544. */
  39545. static Mix(a: number, b: number, alpha: number): number;
  39546. /**
  39547. * Tries to instantiate a new object from a given class name
  39548. * @param className defines the class name to instantiate
  39549. * @returns the new object or null if the system was not able to do the instantiation
  39550. */
  39551. static Instantiate(className: string): any;
  39552. /**
  39553. * Provides a slice function that will work even on IE
  39554. * @param data defines the array to slice
  39555. * @param start defines the start of the data (optional)
  39556. * @param end defines the end of the data (optional)
  39557. * @returns the new sliced array
  39558. */
  39559. static Slice<T>(data: T, start?: number, end?: number): T;
  39560. /**
  39561. * Polyfill for setImmediate
  39562. * @param action defines the action to execute after the current execution block
  39563. */
  39564. static SetImmediate(action: () => void): void;
  39565. /**
  39566. * Function indicating if a number is an exponent of 2
  39567. * @param value defines the value to test
  39568. * @returns true if the value is an exponent of 2
  39569. */
  39570. static IsExponentOfTwo(value: number): boolean;
  39571. private static _tmpFloatArray;
  39572. /**
  39573. * Returns the nearest 32-bit single precision float representation of a Number
  39574. * @param value A Number. If the parameter is of a different type, it will get converted
  39575. * to a number or to NaN if it cannot be converted
  39576. * @returns number
  39577. */
  39578. static FloatRound(value: number): number;
  39579. /**
  39580. * Extracts the filename from a path
  39581. * @param path defines the path to use
  39582. * @returns the filename
  39583. */
  39584. static GetFilename(path: string): string;
  39585. /**
  39586. * Extracts the "folder" part of a path (everything before the filename).
  39587. * @param uri The URI to extract the info from
  39588. * @param returnUnchangedIfNoSlash Do not touch the URI if no slashes are present
  39589. * @returns The "folder" part of the path
  39590. */
  39591. static GetFolderPath(uri: string, returnUnchangedIfNoSlash?: boolean): string;
  39592. /**
  39593. * Extracts text content from a DOM element hierarchy
  39594. * Back Compat only, please use DomManagement.GetDOMTextContent instead.
  39595. */
  39596. static GetDOMTextContent: typeof DomManagement.GetDOMTextContent;
  39597. /**
  39598. * Convert an angle in radians to degrees
  39599. * @param angle defines the angle to convert
  39600. * @returns the angle in degrees
  39601. */
  39602. static ToDegrees(angle: number): number;
  39603. /**
  39604. * Convert an angle in degrees to radians
  39605. * @param angle defines the angle to convert
  39606. * @returns the angle in radians
  39607. */
  39608. static ToRadians(angle: number): number;
  39609. /**
  39610. * Returns an array if obj is not an array
  39611. * @param obj defines the object to evaluate as an array
  39612. * @param allowsNullUndefined defines a boolean indicating if obj is allowed to be null or undefined
  39613. * @returns either obj directly if obj is an array or a new array containing obj
  39614. */
  39615. static MakeArray(obj: any, allowsNullUndefined?: boolean): Nullable<Array<any>>;
  39616. /**
  39617. * Gets the pointer prefix to use
  39618. * @param engine defines the engine we are finding the prefix for
  39619. * @returns "pointer" if touch is enabled. Else returns "mouse"
  39620. */
  39621. static GetPointerPrefix(engine: Engine): string;
  39622. /**
  39623. * Sets the cors behavior on a dom element. This will add the required Tools.CorsBehavior to the element.
  39624. * @param url define the url we are trying
  39625. * @param element define the dom element where to configure the cors policy
  39626. */
  39627. static SetCorsBehavior(url: string | string[], element: {
  39628. crossOrigin: string | null;
  39629. }): void;
  39630. /**
  39631. * Removes unwanted characters from an url
  39632. * @param url defines the url to clean
  39633. * @returns the cleaned url
  39634. */
  39635. static CleanUrl(url: string): string;
  39636. /**
  39637. * Gets or sets a function used to pre-process url before using them to load assets
  39638. */
  39639. static get PreprocessUrl(): (url: string) => string;
  39640. static set PreprocessUrl(processor: (url: string) => string);
  39641. /**
  39642. * Loads an image as an HTMLImageElement.
  39643. * @param input url string, ArrayBuffer, or Blob to load
  39644. * @param onLoad callback called when the image successfully loads
  39645. * @param onError callback called when the image fails to load
  39646. * @param offlineProvider offline provider for caching
  39647. * @param mimeType optional mime type
  39648. * @returns the HTMLImageElement of the loaded image
  39649. */
  39650. static LoadImage(input: string | ArrayBuffer | Blob, onLoad: (img: HTMLImageElement | ImageBitmap) => void, onError: (message?: string, exception?: any) => void, offlineProvider: Nullable<IOfflineProvider>, mimeType?: string): Nullable<HTMLImageElement>;
  39651. /**
  39652. * Loads a file from a url
  39653. * @param url url string, ArrayBuffer, or Blob to load
  39654. * @param onSuccess callback called when the file successfully loads
  39655. * @param onProgress callback called while file is loading (if the server supports this mode)
  39656. * @param offlineProvider defines the offline provider for caching
  39657. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  39658. * @param onError callback called when the file fails to load
  39659. * @returns a file request object
  39660. */
  39661. static LoadFile(url: string, onSuccess: (data: string | ArrayBuffer, responseURL?: string) => void, onProgress?: (data: any) => void, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean, onError?: (request?: WebRequest, exception?: any) => void): IFileRequest;
  39662. /**
  39663. * Loads a file from a url
  39664. * @param url the file url to load
  39665. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  39666. * @returns a promise containing an ArrayBuffer corresponding to the loaded file
  39667. */
  39668. static LoadFileAsync(url: string, useArrayBuffer?: boolean): Promise<ArrayBuffer | string>;
  39669. /**
  39670. * Load a script (identified by an url). When the url returns, the
  39671. * content of this file is added into a new script element, attached to the DOM (body element)
  39672. * @param scriptUrl defines the url of the script to laod
  39673. * @param onSuccess defines the callback called when the script is loaded
  39674. * @param onError defines the callback to call if an error occurs
  39675. * @param scriptId defines the id of the script element
  39676. */
  39677. static LoadScript(scriptUrl: string, onSuccess: () => void, onError?: (message?: string, exception?: any) => void, scriptId?: string): void;
  39678. /**
  39679. * Load an asynchronous script (identified by an url). When the url returns, the
  39680. * content of this file is added into a new script element, attached to the DOM (body element)
  39681. * @param scriptUrl defines the url of the script to laod
  39682. * @param scriptId defines the id of the script element
  39683. * @returns a promise request object
  39684. */
  39685. static LoadScriptAsync(scriptUrl: string, scriptId?: string): Promise<void>;
  39686. /**
  39687. * Loads a file from a blob
  39688. * @param fileToLoad defines the blob to use
  39689. * @param callback defines the callback to call when data is loaded
  39690. * @param progressCallback defines the callback to call during loading process
  39691. * @returns a file request object
  39692. */
  39693. static ReadFileAsDataURL(fileToLoad: Blob, callback: (data: any) => void, progressCallback: (ev: ProgressEvent) => any): IFileRequest;
  39694. /**
  39695. * Reads a file from a File object
  39696. * @param file defines the file to load
  39697. * @param onSuccess defines the callback to call when data is loaded
  39698. * @param onProgress defines the callback to call during loading process
  39699. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  39700. * @param onError defines the callback to call when an error occurs
  39701. * @returns a file request object
  39702. */
  39703. static ReadFile(file: File, onSuccess: (data: any) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  39704. /**
  39705. * Creates a data url from a given string content
  39706. * @param content defines the content to convert
  39707. * @returns the new data url link
  39708. */
  39709. static FileAsURL(content: string): string;
  39710. /**
  39711. * Format the given number to a specific decimal format
  39712. * @param value defines the number to format
  39713. * @param decimals defines the number of decimals to use
  39714. * @returns the formatted string
  39715. */
  39716. static Format(value: number, decimals?: number): string;
  39717. /**
  39718. * Tries to copy an object by duplicating every property
  39719. * @param source defines the source object
  39720. * @param destination defines the target object
  39721. * @param doNotCopyList defines a list of properties to avoid
  39722. * @param mustCopyList defines a list of properties to copy (even if they start with _)
  39723. */
  39724. static DeepCopy(source: any, destination: any, doNotCopyList?: string[], mustCopyList?: string[]): void;
  39725. /**
  39726. * Gets a boolean indicating if the given object has no own property
  39727. * @param obj defines the object to test
  39728. * @returns true if object has no own property
  39729. */
  39730. static IsEmpty(obj: any): boolean;
  39731. /**
  39732. * Function used to register events at window level
  39733. * @param windowElement defines the Window object to use
  39734. * @param events defines the events to register
  39735. */
  39736. static RegisterTopRootEvents(windowElement: Window, events: {
  39737. name: string;
  39738. handler: Nullable<(e: FocusEvent) => any>;
  39739. }[]): void;
  39740. /**
  39741. * Function used to unregister events from window level
  39742. * @param windowElement defines the Window object to use
  39743. * @param events defines the events to unregister
  39744. */
  39745. static UnregisterTopRootEvents(windowElement: Window, events: {
  39746. name: string;
  39747. handler: Nullable<(e: FocusEvent) => any>;
  39748. }[]): void;
  39749. /**
  39750. * @ignore
  39751. */
  39752. static _ScreenshotCanvas: HTMLCanvasElement;
  39753. /**
  39754. * Dumps the current bound framebuffer
  39755. * @param width defines the rendering width
  39756. * @param height defines the rendering height
  39757. * @param engine defines the hosting engine
  39758. * @param successCallback defines the callback triggered once the data are available
  39759. * @param mimeType defines the mime type of the result
  39760. * @param fileName defines the filename to download. If present, the result will automatically be downloaded
  39761. */
  39762. static DumpFramebuffer(width: number, height: number, engine: Engine, successCallback?: (data: string) => void, mimeType?: string, fileName?: string): void;
  39763. /**
  39764. * Converts the canvas data to blob.
  39765. * This acts as a polyfill for browsers not supporting the to blob function.
  39766. * @param canvas Defines the canvas to extract the data from
  39767. * @param successCallback Defines the callback triggered once the data are available
  39768. * @param mimeType Defines the mime type of the result
  39769. */
  39770. static ToBlob(canvas: HTMLCanvasElement, successCallback: (blob: Nullable<Blob>) => void, mimeType?: string): void;
  39771. /**
  39772. * Encodes the canvas data to base 64 or automatically download the result if filename is defined
  39773. * @param successCallback defines the callback triggered once the data are available
  39774. * @param mimeType defines the mime type of the result
  39775. * @param fileName defines he filename to download. If present, the result will automatically be downloaded
  39776. */
  39777. static EncodeScreenshotCanvasData(successCallback?: (data: string) => void, mimeType?: string, fileName?: string): void;
  39778. /**
  39779. * Downloads a blob in the browser
  39780. * @param blob defines the blob to download
  39781. * @param fileName defines the name of the downloaded file
  39782. */
  39783. static Download(blob: Blob, fileName: string): void;
  39784. /**
  39785. * Captures a screenshot of the current rendering
  39786. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  39787. * @param engine defines the rendering engine
  39788. * @param camera defines the source camera
  39789. * @param size This parameter can be set to a single number or to an object with the
  39790. * following (optional) properties: precision, width, height. If a single number is passed,
  39791. * it will be used for both width and height. If an object is passed, the screenshot size
  39792. * will be derived from the parameters. The precision property is a multiplier allowing
  39793. * rendering at a higher or lower resolution
  39794. * @param successCallback defines the callback receives a single parameter which contains the
  39795. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  39796. * src parameter of an <img> to display it
  39797. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  39798. * Check your browser for supported MIME types
  39799. */
  39800. static CreateScreenshot(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string): void;
  39801. /**
  39802. * Captures a screenshot of the current rendering
  39803. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  39804. * @param engine defines the rendering engine
  39805. * @param camera defines the source camera
  39806. * @param size This parameter can be set to a single number or to an object with the
  39807. * following (optional) properties: precision, width, height. If a single number is passed,
  39808. * it will be used for both width and height. If an object is passed, the screenshot size
  39809. * will be derived from the parameters. The precision property is a multiplier allowing
  39810. * rendering at a higher or lower resolution
  39811. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  39812. * Check your browser for supported MIME types
  39813. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  39814. * to the src parameter of an <img> to display it
  39815. */
  39816. static CreateScreenshotAsync(engine: Engine, camera: Camera, size: IScreenshotSize | number, mimeType?: string): Promise<string>;
  39817. /**
  39818. * Generates an image screenshot from the specified camera.
  39819. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  39820. * @param engine The engine to use for rendering
  39821. * @param camera The camera to use for rendering
  39822. * @param size This parameter can be set to a single number or to an object with the
  39823. * following (optional) properties: precision, width, height. If a single number is passed,
  39824. * it will be used for both width and height. If an object is passed, the screenshot size
  39825. * will be derived from the parameters. The precision property is a multiplier allowing
  39826. * rendering at a higher or lower resolution
  39827. * @param successCallback The callback receives a single parameter which contains the
  39828. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  39829. * src parameter of an <img> to display it
  39830. * @param mimeType The MIME type of the screenshot image (default: image/png).
  39831. * Check your browser for supported MIME types
  39832. * @param samples Texture samples (default: 1)
  39833. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  39834. * @param fileName A name for for the downloaded file.
  39835. */
  39836. static CreateScreenshotUsingRenderTarget(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): void;
  39837. /**
  39838. * Generates an image screenshot from the specified camera.
  39839. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  39840. * @param engine The engine to use for rendering
  39841. * @param camera The camera to use for rendering
  39842. * @param size This parameter can be set to a single number or to an object with the
  39843. * following (optional) properties: precision, width, height. If a single number is passed,
  39844. * it will be used for both width and height. If an object is passed, the screenshot size
  39845. * will be derived from the parameters. The precision property is a multiplier allowing
  39846. * rendering at a higher or lower resolution
  39847. * @param mimeType The MIME type of the screenshot image (default: image/png).
  39848. * Check your browser for supported MIME types
  39849. * @param samples Texture samples (default: 1)
  39850. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  39851. * @param fileName A name for for the downloaded file.
  39852. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  39853. * to the src parameter of an <img> to display it
  39854. */
  39855. static CreateScreenshotUsingRenderTargetAsync(engine: Engine, camera: Camera, size: IScreenshotSize | number, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): Promise<string>;
  39856. /**
  39857. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  39858. * Be aware Math.random() could cause collisions, but:
  39859. * "All but 6 of the 128 bits of the ID are randomly generated, which means that for any two ids, there's a 1 in 2^^122 (or 5.3x10^^36) chance they'll collide"
  39860. * @returns a pseudo random id
  39861. */
  39862. static RandomId(): string;
  39863. /**
  39864. * Test if the given uri is a base64 string
  39865. * @param uri The uri to test
  39866. * @return True if the uri is a base64 string or false otherwise
  39867. */
  39868. static IsBase64(uri: string): boolean;
  39869. /**
  39870. * Decode the given base64 uri.
  39871. * @param uri The uri to decode
  39872. * @return The decoded base64 data.
  39873. */
  39874. static DecodeBase64(uri: string): ArrayBuffer;
  39875. /**
  39876. * Gets the absolute url.
  39877. * @param url the input url
  39878. * @return the absolute url
  39879. */
  39880. static GetAbsoluteUrl(url: string): string;
  39881. /**
  39882. * No log
  39883. */
  39884. static readonly NoneLogLevel: number;
  39885. /**
  39886. * Only message logs
  39887. */
  39888. static readonly MessageLogLevel: number;
  39889. /**
  39890. * Only warning logs
  39891. */
  39892. static readonly WarningLogLevel: number;
  39893. /**
  39894. * Only error logs
  39895. */
  39896. static readonly ErrorLogLevel: number;
  39897. /**
  39898. * All logs
  39899. */
  39900. static readonly AllLogLevel: number;
  39901. /**
  39902. * Gets a value indicating the number of loading errors
  39903. * @ignorenaming
  39904. */
  39905. static get errorsCount(): number;
  39906. /**
  39907. * Callback called when a new log is added
  39908. */
  39909. static OnNewCacheEntry: (entry: string) => void;
  39910. /**
  39911. * Log a message to the console
  39912. * @param message defines the message to log
  39913. */
  39914. static Log(message: string): void;
  39915. /**
  39916. * Write a warning message to the console
  39917. * @param message defines the message to log
  39918. */
  39919. static Warn(message: string): void;
  39920. /**
  39921. * Write an error message to the console
  39922. * @param message defines the message to log
  39923. */
  39924. static Error(message: string): void;
  39925. /**
  39926. * Gets current log cache (list of logs)
  39927. */
  39928. static get LogCache(): string;
  39929. /**
  39930. * Clears the log cache
  39931. */
  39932. static ClearLogCache(): void;
  39933. /**
  39934. * Sets the current log level (MessageLogLevel / WarningLogLevel / ErrorLogLevel)
  39935. */
  39936. static set LogLevels(level: number);
  39937. /**
  39938. * Checks if the window object exists
  39939. * Back Compat only, please use DomManagement.IsWindowObjectExist instead.
  39940. */
  39941. static IsWindowObjectExist: typeof DomManagement.IsWindowObjectExist;
  39942. /**
  39943. * No performance log
  39944. */
  39945. static readonly PerformanceNoneLogLevel: number;
  39946. /**
  39947. * Use user marks to log performance
  39948. */
  39949. static readonly PerformanceUserMarkLogLevel: number;
  39950. /**
  39951. * Log performance to the console
  39952. */
  39953. static readonly PerformanceConsoleLogLevel: number;
  39954. private static _performance;
  39955. /**
  39956. * Sets the current performance log level
  39957. */
  39958. static set PerformanceLogLevel(level: number);
  39959. private static _StartPerformanceCounterDisabled;
  39960. private static _EndPerformanceCounterDisabled;
  39961. private static _StartUserMark;
  39962. private static _EndUserMark;
  39963. private static _StartPerformanceConsole;
  39964. private static _EndPerformanceConsole;
  39965. /**
  39966. * Starts a performance counter
  39967. */
  39968. static StartPerformanceCounter: (counterName: string, condition?: boolean) => void;
  39969. /**
  39970. * Ends a specific performance coutner
  39971. */
  39972. static EndPerformanceCounter: (counterName: string, condition?: boolean) => void;
  39973. /**
  39974. * Gets either window.performance.now() if supported or Date.now() else
  39975. */
  39976. static get Now(): number;
  39977. /**
  39978. * This method will return the name of the class used to create the instance of the given object.
  39979. * It will works only on Javascript basic data types (number, string, ...) and instance of class declared with the @className decorator.
  39980. * @param object the object to get the class name from
  39981. * @param isType defines if the object is actually a type
  39982. * @returns the name of the class, will be "object" for a custom data type not using the @className decorator
  39983. */
  39984. static GetClassName(object: any, isType?: boolean): string;
  39985. /**
  39986. * Gets the first element of an array satisfying a given predicate
  39987. * @param array defines the array to browse
  39988. * @param predicate defines the predicate to use
  39989. * @returns null if not found or the element
  39990. */
  39991. static First<T>(array: Array<T>, predicate: (item: T) => boolean): Nullable<T>;
  39992. /**
  39993. * This method will return the name of the full name of the class, including its owning module (if any).
  39994. * It will works only on Javascript basic data types (number, string, ...) and instance of class declared with the @className decorator or implementing a method getClassName():string (in which case the module won't be specified).
  39995. * @param object the object to get the class name from
  39996. * @param isType defines if the object is actually a type
  39997. * @return a string that can have two forms: "moduleName.className" if module was specified when the class' Name was registered or "className" if there was not module specified.
  39998. * @ignorenaming
  39999. */
  40000. static getFullClassName(object: any, isType?: boolean): Nullable<string>;
  40001. /**
  40002. * Returns a promise that resolves after the given amount of time.
  40003. * @param delay Number of milliseconds to delay
  40004. * @returns Promise that resolves after the given amount of time
  40005. */
  40006. static DelayAsync(delay: number): Promise<void>;
  40007. /**
  40008. * Utility function to detect if the current user agent is Safari
  40009. * @returns whether or not the current user agent is safari
  40010. */
  40011. static IsSafari(): boolean;
  40012. }
  40013. /**
  40014. * Use this className as a decorator on a given class definition to add it a name and optionally its module.
  40015. * You can then use the Tools.getClassName(obj) on an instance to retrieve its class name.
  40016. * This method is the only way to get it done in all cases, even if the .js file declaring the class is minified
  40017. * @param name The name of the class, case should be preserved
  40018. * @param module The name of the Module hosting the class, optional, but strongly recommended to specify if possible. Case should be preserved.
  40019. */
  40020. export function className(name: string, module?: string): (target: Object) => void;
  40021. /**
  40022. * An implementation of a loop for asynchronous functions.
  40023. */
  40024. export class AsyncLoop {
  40025. /**
  40026. * Defines the number of iterations for the loop
  40027. */
  40028. iterations: number;
  40029. /**
  40030. * Defines the current index of the loop.
  40031. */
  40032. index: number;
  40033. private _done;
  40034. private _fn;
  40035. private _successCallback;
  40036. /**
  40037. * Constructor.
  40038. * @param iterations the number of iterations.
  40039. * @param func the function to run each iteration
  40040. * @param successCallback the callback that will be called upon succesful execution
  40041. * @param offset starting offset.
  40042. */
  40043. constructor(
  40044. /**
  40045. * Defines the number of iterations for the loop
  40046. */
  40047. iterations: number, func: (asyncLoop: AsyncLoop) => void, successCallback: () => void, offset?: number);
  40048. /**
  40049. * Execute the next iteration. Must be called after the last iteration was finished.
  40050. */
  40051. executeNext(): void;
  40052. /**
  40053. * Break the loop and run the success callback.
  40054. */
  40055. breakLoop(): void;
  40056. /**
  40057. * Create and run an async loop.
  40058. * @param iterations the number of iterations.
  40059. * @param fn the function to run each iteration
  40060. * @param successCallback the callback that will be called upon succesful execution
  40061. * @param offset starting offset.
  40062. * @returns the created async loop object
  40063. */
  40064. static Run(iterations: number, fn: (asyncLoop: AsyncLoop) => void, successCallback: () => void, offset?: number): AsyncLoop;
  40065. /**
  40066. * A for-loop that will run a given number of iterations synchronous and the rest async.
  40067. * @param iterations total number of iterations
  40068. * @param syncedIterations number of synchronous iterations in each async iteration.
  40069. * @param fn the function to call each iteration.
  40070. * @param callback a success call back that will be called when iterating stops.
  40071. * @param breakFunction a break condition (optional)
  40072. * @param timeout timeout settings for the setTimeout function. default - 0.
  40073. * @returns the created async loop object
  40074. */
  40075. static SyncAsyncForLoop(iterations: number, syncedIterations: number, fn: (iteration: number) => void, callback: () => void, breakFunction?: () => boolean, timeout?: number): AsyncLoop;
  40076. }
  40077. }
  40078. declare module "babylonjs/Misc/stringDictionary" {
  40079. import { Nullable } from "babylonjs/types";
  40080. /**
  40081. * This class implement a typical dictionary using a string as key and the generic type T as value.
  40082. * The underlying implementation relies on an associative array to ensure the best performances.
  40083. * The value can be anything including 'null' but except 'undefined'
  40084. */
  40085. export class StringDictionary<T> {
  40086. /**
  40087. * This will clear this dictionary and copy the content from the 'source' one.
  40088. * If the T value is a custom object, it won't be copied/cloned, the same object will be used
  40089. * @param source the dictionary to take the content from and copy to this dictionary
  40090. */
  40091. copyFrom(source: StringDictionary<T>): void;
  40092. /**
  40093. * Get a value based from its key
  40094. * @param key the given key to get the matching value from
  40095. * @return the value if found, otherwise undefined is returned
  40096. */
  40097. get(key: string): T | undefined;
  40098. /**
  40099. * Get a value from its key or add it if it doesn't exist.
  40100. * This method will ensure you that a given key/data will be present in the dictionary.
  40101. * @param key the given key to get the matching value from
  40102. * @param factory the factory that will create the value if the key is not present in the dictionary.
  40103. * The factory will only be invoked if there's no data for the given key.
  40104. * @return the value corresponding to the key.
  40105. */
  40106. getOrAddWithFactory(key: string, factory: (key: string) => T): T;
  40107. /**
  40108. * Get a value from its key if present in the dictionary otherwise add it
  40109. * @param key the key to get the value from
  40110. * @param val if there's no such key/value pair in the dictionary add it with this value
  40111. * @return the value corresponding to the key
  40112. */
  40113. getOrAdd(key: string, val: T): T;
  40114. /**
  40115. * Check if there's a given key in the dictionary
  40116. * @param key the key to check for
  40117. * @return true if the key is present, false otherwise
  40118. */
  40119. contains(key: string): boolean;
  40120. /**
  40121. * Add a new key and its corresponding value
  40122. * @param key the key to add
  40123. * @param value the value corresponding to the key
  40124. * @return true if the operation completed successfully, false if we couldn't insert the key/value because there was already this key in the dictionary
  40125. */
  40126. add(key: string, value: T): boolean;
  40127. /**
  40128. * Update a specific value associated to a key
  40129. * @param key defines the key to use
  40130. * @param value defines the value to store
  40131. * @returns true if the value was updated (or false if the key was not found)
  40132. */
  40133. set(key: string, value: T): boolean;
  40134. /**
  40135. * Get the element of the given key and remove it from the dictionary
  40136. * @param key defines the key to search
  40137. * @returns the value associated with the key or null if not found
  40138. */
  40139. getAndRemove(key: string): Nullable<T>;
  40140. /**
  40141. * Remove a key/value from the dictionary.
  40142. * @param key the key to remove
  40143. * @return true if the item was successfully deleted, false if no item with such key exist in the dictionary
  40144. */
  40145. remove(key: string): boolean;
  40146. /**
  40147. * Clear the whole content of the dictionary
  40148. */
  40149. clear(): void;
  40150. /**
  40151. * Gets the current count
  40152. */
  40153. get count(): number;
  40154. /**
  40155. * Execute a callback on each key/val of the dictionary.
  40156. * Note that you can remove any element in this dictionary in the callback implementation
  40157. * @param callback the callback to execute on a given key/value pair
  40158. */
  40159. forEach(callback: (key: string, val: T) => void): void;
  40160. /**
  40161. * Execute a callback on every occurrence of the dictionary until it returns a valid TRes object.
  40162. * If the callback returns null or undefined the method will iterate to the next key/value pair
  40163. * Note that you can remove any element in this dictionary in the callback implementation
  40164. * @param callback the callback to execute, if it return a valid T instanced object the enumeration will stop and the object will be returned
  40165. * @returns the first item
  40166. */
  40167. first<TRes>(callback: (key: string, val: T) => TRes): TRes | null;
  40168. private _count;
  40169. private _data;
  40170. }
  40171. }
  40172. declare module "babylonjs/Collisions/collisionCoordinator" {
  40173. import { Nullable } from "babylonjs/types";
  40174. import { Scene } from "babylonjs/scene";
  40175. import { Vector3 } from "babylonjs/Maths/math.vector";
  40176. import { Collider } from "babylonjs/Collisions/collider";
  40177. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  40178. /** @hidden */
  40179. export interface ICollisionCoordinator {
  40180. createCollider(): Collider;
  40181. getNewPosition(position: Vector3, displacement: Vector3, collider: Collider, maximumRetry: number, excludedMesh: Nullable<AbstractMesh>, onNewPosition: (collisionIndex: number, newPosition: Vector3, collidedMesh: Nullable<AbstractMesh>) => void, collisionIndex: number): void;
  40182. init(scene: Scene): void;
  40183. }
  40184. /** @hidden */
  40185. export class DefaultCollisionCoordinator implements ICollisionCoordinator {
  40186. private _scene;
  40187. private _scaledPosition;
  40188. private _scaledVelocity;
  40189. private _finalPosition;
  40190. getNewPosition(position: Vector3, displacement: Vector3, collider: Collider, maximumRetry: number, excludedMesh: AbstractMesh, onNewPosition: (collisionIndex: number, newPosition: Vector3, collidedMesh: Nullable<AbstractMesh>) => void, collisionIndex: number): void;
  40191. createCollider(): Collider;
  40192. init(scene: Scene): void;
  40193. private _collideWithWorld;
  40194. }
  40195. }
  40196. declare module "babylonjs/Inputs/scene.inputManager" {
  40197. import { Nullable } from "babylonjs/types";
  40198. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  40199. import { Vector2 } from "babylonjs/Maths/math.vector";
  40200. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  40201. import { Scene } from "babylonjs/scene";
  40202. /**
  40203. * Class used to manage all inputs for the scene.
  40204. */
  40205. export class InputManager {
  40206. /** The distance in pixel that you have to move to prevent some events */
  40207. static DragMovementThreshold: number;
  40208. /** Time in milliseconds to wait to raise long press events if button is still pressed */
  40209. static LongPressDelay: number;
  40210. /** Time in milliseconds with two consecutive clicks will be considered as a double click */
  40211. static DoubleClickDelay: number;
  40212. /** If you need to check double click without raising a single click at first click, enable this flag */
  40213. static ExclusiveDoubleClickMode: boolean;
  40214. /** This is a defensive check to not allow control attachment prior to an already active one. If already attached, previous control is unattached before attaching the new one. */
  40215. private _alreadyAttached;
  40216. private _wheelEventName;
  40217. private _onPointerMove;
  40218. private _onPointerDown;
  40219. private _onPointerUp;
  40220. private _initClickEvent;
  40221. private _initActionManager;
  40222. private _delayedSimpleClick;
  40223. private _delayedSimpleClickTimeout;
  40224. private _previousDelayedSimpleClickTimeout;
  40225. private _meshPickProceed;
  40226. private _previousButtonPressed;
  40227. private _currentPickResult;
  40228. private _previousPickResult;
  40229. private _totalPointersPressed;
  40230. private _doubleClickOccured;
  40231. private _pointerOverMesh;
  40232. private _pickedDownMesh;
  40233. private _pickedUpMesh;
  40234. private _pointerX;
  40235. private _pointerY;
  40236. private _unTranslatedPointerX;
  40237. private _unTranslatedPointerY;
  40238. private _startingPointerPosition;
  40239. private _previousStartingPointerPosition;
  40240. private _startingPointerTime;
  40241. private _previousStartingPointerTime;
  40242. private _pointerCaptures;
  40243. private _onKeyDown;
  40244. private _onKeyUp;
  40245. private _onCanvasFocusObserver;
  40246. private _onCanvasBlurObserver;
  40247. private _scene;
  40248. /**
  40249. * Creates a new InputManager
  40250. * @param scene defines the hosting scene
  40251. */
  40252. constructor(scene: Scene);
  40253. /**
  40254. * Gets the mesh that is currently under the pointer
  40255. */
  40256. get meshUnderPointer(): Nullable<AbstractMesh>;
  40257. /**
  40258. * Gets the pointer coordinates in 2D without any translation (ie. straight out of the pointer event)
  40259. */
  40260. get unTranslatedPointer(): Vector2;
  40261. /**
  40262. * Gets or sets the current on-screen X position of the pointer
  40263. */
  40264. get pointerX(): number;
  40265. set pointerX(value: number);
  40266. /**
  40267. * Gets or sets the current on-screen Y position of the pointer
  40268. */
  40269. get pointerY(): number;
  40270. set pointerY(value: number);
  40271. private _updatePointerPosition;
  40272. private _processPointerMove;
  40273. private _setRayOnPointerInfo;
  40274. private _checkPrePointerObservable;
  40275. /**
  40276. * Use this method to simulate a pointer move on a mesh
  40277. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  40278. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  40279. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  40280. */
  40281. simulatePointerMove(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): void;
  40282. /**
  40283. * Use this method to simulate a pointer down on a mesh
  40284. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  40285. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  40286. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  40287. */
  40288. simulatePointerDown(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): void;
  40289. private _processPointerDown;
  40290. /** @hidden */
  40291. _isPointerSwiping(): boolean;
  40292. /**
  40293. * Use this method to simulate a pointer up on a mesh
  40294. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  40295. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  40296. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  40297. * @param doubleTap indicates that the pointer up event should be considered as part of a double click (false by default)
  40298. */
  40299. simulatePointerUp(pickResult: PickingInfo, pointerEventInit?: PointerEventInit, doubleTap?: boolean): void;
  40300. private _processPointerUp;
  40301. /**
  40302. * Gets a boolean indicating if the current pointer event is captured (meaning that the scene has already handled the pointer down)
  40303. * @param pointerId defines the pointer id to use in a multi-touch scenario (0 by default)
  40304. * @returns true if the pointer was captured
  40305. */
  40306. isPointerCaptured(pointerId?: number): boolean;
  40307. /**
  40308. * Attach events to the canvas (To handle actionManagers triggers and raise onPointerMove, onPointerDown and onPointerUp
  40309. * @param attachUp defines if you want to attach events to pointerup
  40310. * @param attachDown defines if you want to attach events to pointerdown
  40311. * @param attachMove defines if you want to attach events to pointermove
  40312. * @param elementToAttachTo defines the target DOM element to attach to (will use the canvas by default)
  40313. */
  40314. attachControl(attachUp?: boolean, attachDown?: boolean, attachMove?: boolean, elementToAttachTo?: Nullable<HTMLElement>): void;
  40315. /**
  40316. * Detaches all event handlers
  40317. */
  40318. detachControl(): void;
  40319. /**
  40320. * Force the value of meshUnderPointer
  40321. * @param mesh defines the mesh to use
  40322. */
  40323. setPointerOverMesh(mesh: Nullable<AbstractMesh>): void;
  40324. /**
  40325. * Gets the mesh under the pointer
  40326. * @returns a Mesh or null if no mesh is under the pointer
  40327. */
  40328. getPointerOverMesh(): Nullable<AbstractMesh>;
  40329. }
  40330. }
  40331. declare module "babylonjs/Animations/animationGroup" {
  40332. import { Animatable } from "babylonjs/Animations/animatable";
  40333. import { Animation } from "babylonjs/Animations/animation";
  40334. import { Scene, IDisposable } from "babylonjs/scene";
  40335. import { Observable } from "babylonjs/Misc/observable";
  40336. import { Nullable } from "babylonjs/types";
  40337. import "babylonjs/Animations/animatable";
  40338. /**
  40339. * This class defines the direct association between an animation and a target
  40340. */
  40341. export class TargetedAnimation {
  40342. /**
  40343. * Animation to perform
  40344. */
  40345. animation: Animation;
  40346. /**
  40347. * Target to animate
  40348. */
  40349. target: any;
  40350. /**
  40351. * Returns the string "TargetedAnimation"
  40352. * @returns "TargetedAnimation"
  40353. */
  40354. getClassName(): string;
  40355. /**
  40356. * Serialize the object
  40357. * @returns the JSON object representing the current entity
  40358. */
  40359. serialize(): any;
  40360. }
  40361. /**
  40362. * Use this class to create coordinated animations on multiple targets
  40363. */
  40364. export class AnimationGroup implements IDisposable {
  40365. /** The name of the animation group */
  40366. name: string;
  40367. private _scene;
  40368. private _targetedAnimations;
  40369. private _animatables;
  40370. private _from;
  40371. private _to;
  40372. private _isStarted;
  40373. private _isPaused;
  40374. private _speedRatio;
  40375. private _loopAnimation;
  40376. private _isAdditive;
  40377. /**
  40378. * Gets or sets the unique id of the node
  40379. */
  40380. uniqueId: number;
  40381. /**
  40382. * This observable will notify when one animation have ended
  40383. */
  40384. onAnimationEndObservable: Observable<TargetedAnimation>;
  40385. /**
  40386. * Observer raised when one animation loops
  40387. */
  40388. onAnimationLoopObservable: Observable<TargetedAnimation>;
  40389. /**
  40390. * Observer raised when all animations have looped
  40391. */
  40392. onAnimationGroupLoopObservable: Observable<AnimationGroup>;
  40393. /**
  40394. * This observable will notify when all animations have ended.
  40395. */
  40396. onAnimationGroupEndObservable: Observable<AnimationGroup>;
  40397. /**
  40398. * This observable will notify when all animations have paused.
  40399. */
  40400. onAnimationGroupPauseObservable: Observable<AnimationGroup>;
  40401. /**
  40402. * This observable will notify when all animations are playing.
  40403. */
  40404. onAnimationGroupPlayObservable: Observable<AnimationGroup>;
  40405. /**
  40406. * Gets the first frame
  40407. */
  40408. get from(): number;
  40409. /**
  40410. * Gets the last frame
  40411. */
  40412. get to(): number;
  40413. /**
  40414. * Define if the animations are started
  40415. */
  40416. get isStarted(): boolean;
  40417. /**
  40418. * Gets a value indicating that the current group is playing
  40419. */
  40420. get isPlaying(): boolean;
  40421. /**
  40422. * Gets or sets the speed ratio to use for all animations
  40423. */
  40424. get speedRatio(): number;
  40425. /**
  40426. * Gets or sets the speed ratio to use for all animations
  40427. */
  40428. set speedRatio(value: number);
  40429. /**
  40430. * Gets or sets if all animations should loop or not
  40431. */
  40432. get loopAnimation(): boolean;
  40433. set loopAnimation(value: boolean);
  40434. /**
  40435. * Gets or sets if all animations should be evaluated additively
  40436. */
  40437. get isAdditive(): boolean;
  40438. set isAdditive(value: boolean);
  40439. /**
  40440. * Gets the targeted animations for this animation group
  40441. */
  40442. get targetedAnimations(): Array<TargetedAnimation>;
  40443. /**
  40444. * returning the list of animatables controlled by this animation group.
  40445. */
  40446. get animatables(): Array<Animatable>;
  40447. /**
  40448. * Gets the list of target animations
  40449. */
  40450. get children(): TargetedAnimation[];
  40451. /**
  40452. * Instantiates a new Animation Group.
  40453. * This helps managing several animations at once.
  40454. * @see https://doc.babylonjs.com/how_to/group
  40455. * @param name Defines the name of the group
  40456. * @param scene Defines the scene the group belongs to
  40457. */
  40458. constructor(
  40459. /** The name of the animation group */
  40460. name: string, scene?: Nullable<Scene>);
  40461. /**
  40462. * Add an animation (with its target) in the group
  40463. * @param animation defines the animation we want to add
  40464. * @param target defines the target of the animation
  40465. * @returns the TargetedAnimation object
  40466. */
  40467. addTargetedAnimation(animation: Animation, target: any): TargetedAnimation;
  40468. /**
  40469. * This function will normalize every animation in the group to make sure they all go from beginFrame to endFrame
  40470. * It can add constant keys at begin or end
  40471. * @param beginFrame defines the new begin frame for all animations or the smallest begin frame of all animations if null (defaults to null)
  40472. * @param endFrame defines the new end frame for all animations or the largest end frame of all animations if null (defaults to null)
  40473. * @returns the animation group
  40474. */
  40475. normalize(beginFrame?: Nullable<number>, endFrame?: Nullable<number>): AnimationGroup;
  40476. private _animationLoopCount;
  40477. private _animationLoopFlags;
  40478. private _processLoop;
  40479. /**
  40480. * Start all animations on given targets
  40481. * @param loop defines if animations must loop
  40482. * @param speedRatio defines the ratio to apply to animation speed (1 by default)
  40483. * @param from defines the from key (optional)
  40484. * @param to defines the to key (optional)
  40485. * @param isAdditive defines the additive state for the resulting animatables (optional)
  40486. * @returns the current animation group
  40487. */
  40488. start(loop?: boolean, speedRatio?: number, from?: number, to?: number, isAdditive?: boolean): AnimationGroup;
  40489. /**
  40490. * Pause all animations
  40491. * @returns the animation group
  40492. */
  40493. pause(): AnimationGroup;
  40494. /**
  40495. * Play all animations to initial state
  40496. * This function will start() the animations if they were not started or will restart() them if they were paused
  40497. * @param loop defines if animations must loop
  40498. * @returns the animation group
  40499. */
  40500. play(loop?: boolean): AnimationGroup;
  40501. /**
  40502. * Reset all animations to initial state
  40503. * @returns the animation group
  40504. */
  40505. reset(): AnimationGroup;
  40506. /**
  40507. * Restart animations from key 0
  40508. * @returns the animation group
  40509. */
  40510. restart(): AnimationGroup;
  40511. /**
  40512. * Stop all animations
  40513. * @returns the animation group
  40514. */
  40515. stop(): AnimationGroup;
  40516. /**
  40517. * Set animation weight for all animatables
  40518. * @param weight defines the weight to use
  40519. * @return the animationGroup
  40520. * @see https://doc.babylonjs.com/babylon101/animations#animation-weights
  40521. */
  40522. setWeightForAllAnimatables(weight: number): AnimationGroup;
  40523. /**
  40524. * Synchronize and normalize all animatables with a source animatable
  40525. * @param root defines the root animatable to synchronize with
  40526. * @return the animationGroup
  40527. * @see https://doc.babylonjs.com/babylon101/animations#animation-weights
  40528. */
  40529. syncAllAnimationsWith(root: Animatable): AnimationGroup;
  40530. /**
  40531. * Goes to a specific frame in this animation group
  40532. * @param frame the frame number to go to
  40533. * @return the animationGroup
  40534. */
  40535. goToFrame(frame: number): AnimationGroup;
  40536. /**
  40537. * Dispose all associated resources
  40538. */
  40539. dispose(): void;
  40540. private _checkAnimationGroupEnded;
  40541. /**
  40542. * Clone the current animation group and returns a copy
  40543. * @param newName defines the name of the new group
  40544. * @param targetConverter defines an optional function used to convert current animation targets to new ones
  40545. * @returns the new aniamtion group
  40546. */
  40547. clone(newName: string, targetConverter?: (oldTarget: any) => any): AnimationGroup;
  40548. /**
  40549. * Serializes the animationGroup to an object
  40550. * @returns Serialized object
  40551. */
  40552. serialize(): any;
  40553. /**
  40554. * Returns a new AnimationGroup object parsed from the source provided.
  40555. * @param parsedAnimationGroup defines the source
  40556. * @param scene defines the scene that will receive the animationGroup
  40557. * @returns a new AnimationGroup
  40558. */
  40559. static Parse(parsedAnimationGroup: any, scene: Scene): AnimationGroup;
  40560. /**
  40561. * Convert the keyframes for all animations belonging to the group to be relative to a given reference frame.
  40562. * @param sourceAnimationGroup defines the AnimationGroup containing animations to convert
  40563. * @param referenceFrame defines the frame that keyframes in the range will be relative to
  40564. * @param range defines the name of the AnimationRange belonging to the animations in the group to convert
  40565. * @param cloneOriginal defines whether or not to clone the group and convert the clone or convert the original group (default is false)
  40566. * @param clonedName defines the name of the resulting cloned AnimationGroup if cloneOriginal is true
  40567. * @returns a new AnimationGroup if cloneOriginal is true or the original AnimationGroup if cloneOriginal is false
  40568. */
  40569. static MakeAnimationAdditive(sourceAnimationGroup: AnimationGroup, referenceFrame?: number, range?: string, cloneOriginal?: boolean, clonedName?: string): AnimationGroup;
  40570. /**
  40571. * Returns the string "AnimationGroup"
  40572. * @returns "AnimationGroup"
  40573. */
  40574. getClassName(): string;
  40575. /**
  40576. * Creates a detailled string about the object
  40577. * @param fullDetails defines if the output string will support multiple levels of logging within scene loading
  40578. * @returns a string representing the object
  40579. */
  40580. toString(fullDetails?: boolean): string;
  40581. }
  40582. }
  40583. declare module "babylonjs/scene" {
  40584. import { Nullable } from "babylonjs/types";
  40585. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  40586. import { Observable } from "babylonjs/Misc/observable";
  40587. import { SmartArrayNoDuplicate, SmartArray, ISmartArrayLike } from "babylonjs/Misc/smartArray";
  40588. import { Vector2, Vector3, Matrix } from "babylonjs/Maths/math.vector";
  40589. import { Geometry } from "babylonjs/Meshes/geometry";
  40590. import { TransformNode } from "babylonjs/Meshes/transformNode";
  40591. import { SubMesh } from "babylonjs/Meshes/subMesh";
  40592. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  40593. import { Mesh } from "babylonjs/Meshes/mesh";
  40594. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  40595. import { Bone } from "babylonjs/Bones/bone";
  40596. import { Skeleton } from "babylonjs/Bones/skeleton";
  40597. import { MorphTargetManager } from "babylonjs/Morph/morphTargetManager";
  40598. import { Camera } from "babylonjs/Cameras/camera";
  40599. import { AbstractScene } from "babylonjs/abstractScene";
  40600. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  40601. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  40602. import { Material } from "babylonjs/Materials/material";
  40603. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  40604. import { Effect } from "babylonjs/Materials/effect";
  40605. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  40606. import { MultiMaterial } from "babylonjs/Materials/multiMaterial";
  40607. import { Light } from "babylonjs/Lights/light";
  40608. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  40609. import { ICollisionCoordinator } from "babylonjs/Collisions/collisionCoordinator";
  40610. import { PointerEventTypes, PointerInfoPre, PointerInfo } from "babylonjs/Events/pointerEvents";
  40611. import { KeyboardInfoPre, KeyboardInfo } from "babylonjs/Events/keyboardEvents";
  40612. import { PostProcessManager } from "babylonjs/PostProcesses/postProcessManager";
  40613. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  40614. import { RenderingGroupInfo, IRenderingManagerAutoClearSetup } from "babylonjs/Rendering/renderingManager";
  40615. import { ISceneComponent, ISceneSerializableComponent, Stage, SimpleStageAction, RenderTargetsStageAction, RenderTargetStageAction, MeshStageAction, EvaluateSubMeshStageAction, ActiveMeshStageAction, CameraStageAction, RenderingGroupStageAction, RenderingMeshStageAction, PointerMoveStageAction, PointerUpDownStageAction, CameraStageFrameBufferAction } from "babylonjs/sceneComponent";
  40616. import { Engine } from "babylonjs/Engines/engine";
  40617. import { Node } from "babylonjs/node";
  40618. import { MorphTarget } from "babylonjs/Morph/morphTarget";
  40619. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  40620. import { WebRequest } from "babylonjs/Misc/webRequest";
  40621. import { InputManager } from "babylonjs/Inputs/scene.inputManager";
  40622. import { PerfCounter } from "babylonjs/Misc/perfCounter";
  40623. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  40624. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  40625. import { Plane } from "babylonjs/Maths/math.plane";
  40626. import { LoadFileError, RequestFileError, ReadFileError } from "babylonjs/Misc/fileTools";
  40627. import { IClipPlanesHolder } from "babylonjs/Misc/interfaces/iClipPlanesHolder";
  40628. import { Ray } from "babylonjs/Culling/ray";
  40629. import { TrianglePickingPredicate } from "babylonjs/Culling/ray";
  40630. import { Animation } from "babylonjs/Animations/animation";
  40631. import { Animatable } from "babylonjs/Animations/animatable";
  40632. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  40633. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  40634. import { Collider } from "babylonjs/Collisions/collider";
  40635. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  40636. /**
  40637. * Define an interface for all classes that will hold resources
  40638. */
  40639. export interface IDisposable {
  40640. /**
  40641. * Releases all held resources
  40642. */
  40643. dispose(): void;
  40644. }
  40645. /** Interface defining initialization parameters for Scene class */
  40646. export interface SceneOptions {
  40647. /**
  40648. * Defines that scene should keep up-to-date a map of geometry to enable fast look-up by uniqueId
  40649. * It will improve performance when the number of geometries becomes important.
  40650. */
  40651. useGeometryUniqueIdsMap?: boolean;
  40652. /**
  40653. * Defines that each material of the scene should keep up-to-date a map of referencing meshes for fast diposing
  40654. * It will improve performance when the number of mesh becomes important, but might consume a bit more memory
  40655. */
  40656. useMaterialMeshMap?: boolean;
  40657. /**
  40658. * Defines that each mesh of the scene should keep up-to-date a map of referencing cloned meshes for fast diposing
  40659. * It will improve performance when the number of mesh becomes important, but might consume a bit more memory
  40660. */
  40661. useClonedMeshMap?: boolean;
  40662. /** Defines if the creation of the scene should impact the engine (Eg. UtilityLayer's scene) */
  40663. virtual?: boolean;
  40664. }
  40665. /**
  40666. * Represents a scene to be rendered by the engine.
  40667. * @see https://doc.babylonjs.com/features/scene
  40668. */
  40669. export class Scene extends AbstractScene implements IAnimatable, IClipPlanesHolder {
  40670. /** The fog is deactivated */
  40671. static readonly FOGMODE_NONE: number;
  40672. /** The fog density is following an exponential function */
  40673. static readonly FOGMODE_EXP: number;
  40674. /** The fog density is following an exponential function faster than FOGMODE_EXP */
  40675. static readonly FOGMODE_EXP2: number;
  40676. /** The fog density is following a linear function. */
  40677. static readonly FOGMODE_LINEAR: number;
  40678. /**
  40679. * Gets or sets the minimum deltatime when deterministic lock step is enabled
  40680. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  40681. */
  40682. static MinDeltaTime: number;
  40683. /**
  40684. * Gets or sets the maximum deltatime when deterministic lock step is enabled
  40685. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  40686. */
  40687. static MaxDeltaTime: number;
  40688. /**
  40689. * Factory used to create the default material.
  40690. * @param name The name of the material to create
  40691. * @param scene The scene to create the material for
  40692. * @returns The default material
  40693. */
  40694. static DefaultMaterialFactory(scene: Scene): Material;
  40695. /**
  40696. * Factory used to create the a collision coordinator.
  40697. * @returns The collision coordinator
  40698. */
  40699. static CollisionCoordinatorFactory(): ICollisionCoordinator;
  40700. /** @hidden */
  40701. _inputManager: InputManager;
  40702. /** Define this parameter if you are using multiple cameras and you want to specify which one should be used for pointer position */
  40703. cameraToUseForPointers: Nullable<Camera>;
  40704. /** @hidden */
  40705. readonly _isScene: boolean;
  40706. /** @hidden */
  40707. _blockEntityCollection: boolean;
  40708. /**
  40709. * Gets or sets a boolean that indicates if the scene must clear the render buffer before rendering a frame
  40710. */
  40711. autoClear: boolean;
  40712. /**
  40713. * Gets or sets a boolean that indicates if the scene must clear the depth and stencil buffers before rendering a frame
  40714. */
  40715. autoClearDepthAndStencil: boolean;
  40716. /**
  40717. * Defines the color used to clear the render buffer (Default is (0.2, 0.2, 0.3, 1.0))
  40718. */
  40719. clearColor: Color4;
  40720. /**
  40721. * Defines the color used to simulate the ambient color (Default is (0, 0, 0))
  40722. */
  40723. ambientColor: Color3;
  40724. /**
  40725. * This is use to store the default BRDF lookup for PBR materials in your scene.
  40726. * It should only be one of the following (if not the default embedded one):
  40727. * * For uncorrelated BRDF (pbr.brdf.useEnergyConservation = false and pbr.brdf.useSmithVisibilityHeightCorrelated = false) : https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds
  40728. * * For correlated BRDF (pbr.brdf.useEnergyConservation = false and pbr.brdf.useSmithVisibilityHeightCorrelated = true) : https://assets.babylonjs.com/environments/correlatedBRDF.dds
  40729. * * For correlated multi scattering BRDF (pbr.brdf.useEnergyConservation = true and pbr.brdf.useSmithVisibilityHeightCorrelated = true) : https://assets.babylonjs.com/environments/correlatedMSBRDF.dds
  40730. * The material properties need to be setup according to the type of texture in use.
  40731. */
  40732. environmentBRDFTexture: BaseTexture;
  40733. /** @hidden */
  40734. protected _environmentTexture: Nullable<BaseTexture>;
  40735. /**
  40736. * Texture used in all pbr material as the reflection texture.
  40737. * As in the majority of the scene they are the same (exception for multi room and so on),
  40738. * this is easier to reference from here than from all the materials.
  40739. */
  40740. get environmentTexture(): Nullable<BaseTexture>;
  40741. /**
  40742. * Texture used in all pbr material as the reflection texture.
  40743. * As in the majority of the scene they are the same (exception for multi room and so on),
  40744. * this is easier to set here than in all the materials.
  40745. */
  40746. set environmentTexture(value: Nullable<BaseTexture>);
  40747. /** @hidden */
  40748. protected _environmentIntensity: number;
  40749. /**
  40750. * Intensity of the environment in all pbr material.
  40751. * This dims or reinforces the IBL lighting overall (reflection and diffuse).
  40752. * As in the majority of the scene they are the same (exception for multi room and so on),
  40753. * this is easier to reference from here than from all the materials.
  40754. */
  40755. get environmentIntensity(): number;
  40756. /**
  40757. * Intensity of the environment in all pbr material.
  40758. * This dims or reinforces the IBL lighting overall (reflection and diffuse).
  40759. * As in the majority of the scene they are the same (exception for multi room and so on),
  40760. * this is easier to set here than in all the materials.
  40761. */
  40762. set environmentIntensity(value: number);
  40763. /** @hidden */
  40764. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  40765. /**
  40766. * Default image processing configuration used either in the rendering
  40767. * Forward main pass or through the imageProcessingPostProcess if present.
  40768. * As in the majority of the scene they are the same (exception for multi camera),
  40769. * this is easier to reference from here than from all the materials and post process.
  40770. *
  40771. * No setter as we it is a shared configuration, you can set the values instead.
  40772. */
  40773. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  40774. private _forceWireframe;
  40775. /**
  40776. * Gets or sets a boolean indicating if all rendering must be done in wireframe
  40777. */
  40778. set forceWireframe(value: boolean);
  40779. get forceWireframe(): boolean;
  40780. private _skipFrustumClipping;
  40781. /**
  40782. * Gets or sets a boolean indicating if we should skip the frustum clipping part of the active meshes selection
  40783. */
  40784. set skipFrustumClipping(value: boolean);
  40785. get skipFrustumClipping(): boolean;
  40786. private _forcePointsCloud;
  40787. /**
  40788. * Gets or sets a boolean indicating if all rendering must be done in point cloud
  40789. */
  40790. set forcePointsCloud(value: boolean);
  40791. get forcePointsCloud(): boolean;
  40792. /**
  40793. * Gets or sets the active clipplane 1
  40794. */
  40795. clipPlane: Nullable<Plane>;
  40796. /**
  40797. * Gets or sets the active clipplane 2
  40798. */
  40799. clipPlane2: Nullable<Plane>;
  40800. /**
  40801. * Gets or sets the active clipplane 3
  40802. */
  40803. clipPlane3: Nullable<Plane>;
  40804. /**
  40805. * Gets or sets the active clipplane 4
  40806. */
  40807. clipPlane4: Nullable<Plane>;
  40808. /**
  40809. * Gets or sets the active clipplane 5
  40810. */
  40811. clipPlane5: Nullable<Plane>;
  40812. /**
  40813. * Gets or sets the active clipplane 6
  40814. */
  40815. clipPlane6: Nullable<Plane>;
  40816. /**
  40817. * Gets or sets a boolean indicating if animations are enabled
  40818. */
  40819. animationsEnabled: boolean;
  40820. private _animationPropertiesOverride;
  40821. /**
  40822. * Gets or sets the animation properties override
  40823. */
  40824. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  40825. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  40826. /**
  40827. * Gets or sets a boolean indicating if a constant deltatime has to be used
  40828. * This is mostly useful for testing purposes when you do not want the animations to scale with the framerate
  40829. */
  40830. useConstantAnimationDeltaTime: boolean;
  40831. /**
  40832. * Gets or sets a boolean indicating if the scene must keep the meshUnderPointer property updated
  40833. * Please note that it requires to run a ray cast through the scene on every frame
  40834. */
  40835. constantlyUpdateMeshUnderPointer: boolean;
  40836. /**
  40837. * Defines the HTML cursor to use when hovering over interactive elements
  40838. */
  40839. hoverCursor: string;
  40840. /**
  40841. * Defines the HTML default cursor to use (empty by default)
  40842. */
  40843. defaultCursor: string;
  40844. /**
  40845. * Defines whether cursors are handled by the scene.
  40846. */
  40847. doNotHandleCursors: boolean;
  40848. /**
  40849. * This is used to call preventDefault() on pointer down
  40850. * in order to block unwanted artifacts like system double clicks
  40851. */
  40852. preventDefaultOnPointerDown: boolean;
  40853. /**
  40854. * This is used to call preventDefault() on pointer up
  40855. * in order to block unwanted artifacts like system double clicks
  40856. */
  40857. preventDefaultOnPointerUp: boolean;
  40858. /**
  40859. * Gets or sets user defined metadata
  40860. */
  40861. metadata: any;
  40862. /**
  40863. * For internal use only. Please do not use.
  40864. */
  40865. reservedDataStore: any;
  40866. /**
  40867. * Gets the name of the plugin used to load this scene (null by default)
  40868. */
  40869. loadingPluginName: string;
  40870. /**
  40871. * Use this array to add regular expressions used to disable offline support for specific urls
  40872. */
  40873. disableOfflineSupportExceptionRules: RegExp[];
  40874. /**
  40875. * An event triggered when the scene is disposed.
  40876. */
  40877. onDisposeObservable: Observable<Scene>;
  40878. private _onDisposeObserver;
  40879. /** Sets a function to be executed when this scene is disposed. */
  40880. set onDispose(callback: () => void);
  40881. /**
  40882. * An event triggered before rendering the scene (right after animations and physics)
  40883. */
  40884. onBeforeRenderObservable: Observable<Scene>;
  40885. private _onBeforeRenderObserver;
  40886. /** Sets a function to be executed before rendering this scene */
  40887. set beforeRender(callback: Nullable<() => void>);
  40888. /**
  40889. * An event triggered after rendering the scene
  40890. */
  40891. onAfterRenderObservable: Observable<Scene>;
  40892. /**
  40893. * An event triggered after rendering the scene for an active camera (When scene.render is called this will be called after each camera)
  40894. */
  40895. onAfterRenderCameraObservable: Observable<Camera>;
  40896. private _onAfterRenderObserver;
  40897. /** Sets a function to be executed after rendering this scene */
  40898. set afterRender(callback: Nullable<() => void>);
  40899. /**
  40900. * An event triggered before animating the scene
  40901. */
  40902. onBeforeAnimationsObservable: Observable<Scene>;
  40903. /**
  40904. * An event triggered after animations processing
  40905. */
  40906. onAfterAnimationsObservable: Observable<Scene>;
  40907. /**
  40908. * An event triggered before draw calls are ready to be sent
  40909. */
  40910. onBeforeDrawPhaseObservable: Observable<Scene>;
  40911. /**
  40912. * An event triggered after draw calls have been sent
  40913. */
  40914. onAfterDrawPhaseObservable: Observable<Scene>;
  40915. /**
  40916. * An event triggered when the scene is ready
  40917. */
  40918. onReadyObservable: Observable<Scene>;
  40919. /**
  40920. * An event triggered before rendering a camera
  40921. */
  40922. onBeforeCameraRenderObservable: Observable<Camera>;
  40923. private _onBeforeCameraRenderObserver;
  40924. /** Sets a function to be executed before rendering a camera*/
  40925. set beforeCameraRender(callback: () => void);
  40926. /**
  40927. * An event triggered after rendering a camera
  40928. */
  40929. onAfterCameraRenderObservable: Observable<Camera>;
  40930. private _onAfterCameraRenderObserver;
  40931. /** Sets a function to be executed after rendering a camera*/
  40932. set afterCameraRender(callback: () => void);
  40933. /**
  40934. * An event triggered when active meshes evaluation is about to start
  40935. */
  40936. onBeforeActiveMeshesEvaluationObservable: Observable<Scene>;
  40937. /**
  40938. * An event triggered when active meshes evaluation is done
  40939. */
  40940. onAfterActiveMeshesEvaluationObservable: Observable<Scene>;
  40941. /**
  40942. * An event triggered when particles rendering is about to start
  40943. * Note: This event can be trigger more than once per frame (because particles can be rendered by render target textures as well)
  40944. */
  40945. onBeforeParticlesRenderingObservable: Observable<Scene>;
  40946. /**
  40947. * An event triggered when particles rendering is done
  40948. * Note: This event can be trigger more than once per frame (because particles can be rendered by render target textures as well)
  40949. */
  40950. onAfterParticlesRenderingObservable: Observable<Scene>;
  40951. /**
  40952. * An event triggered when SceneLoader.Append or SceneLoader.Load or SceneLoader.ImportMesh were successfully executed
  40953. */
  40954. onDataLoadedObservable: Observable<Scene>;
  40955. /**
  40956. * An event triggered when a camera is created
  40957. */
  40958. onNewCameraAddedObservable: Observable<Camera>;
  40959. /**
  40960. * An event triggered when a camera is removed
  40961. */
  40962. onCameraRemovedObservable: Observable<Camera>;
  40963. /**
  40964. * An event triggered when a light is created
  40965. */
  40966. onNewLightAddedObservable: Observable<Light>;
  40967. /**
  40968. * An event triggered when a light is removed
  40969. */
  40970. onLightRemovedObservable: Observable<Light>;
  40971. /**
  40972. * An event triggered when a geometry is created
  40973. */
  40974. onNewGeometryAddedObservable: Observable<Geometry>;
  40975. /**
  40976. * An event triggered when a geometry is removed
  40977. */
  40978. onGeometryRemovedObservable: Observable<Geometry>;
  40979. /**
  40980. * An event triggered when a transform node is created
  40981. */
  40982. onNewTransformNodeAddedObservable: Observable<TransformNode>;
  40983. /**
  40984. * An event triggered when a transform node is removed
  40985. */
  40986. onTransformNodeRemovedObservable: Observable<TransformNode>;
  40987. /**
  40988. * An event triggered when a mesh is created
  40989. */
  40990. onNewMeshAddedObservable: Observable<AbstractMesh>;
  40991. /**
  40992. * An event triggered when a mesh is removed
  40993. */
  40994. onMeshRemovedObservable: Observable<AbstractMesh>;
  40995. /**
  40996. * An event triggered when a skeleton is created
  40997. */
  40998. onNewSkeletonAddedObservable: Observable<Skeleton>;
  40999. /**
  41000. * An event triggered when a skeleton is removed
  41001. */
  41002. onSkeletonRemovedObservable: Observable<Skeleton>;
  41003. /**
  41004. * An event triggered when a material is created
  41005. */
  41006. onNewMaterialAddedObservable: Observable<Material>;
  41007. /**
  41008. * An event triggered when a material is removed
  41009. */
  41010. onMaterialRemovedObservable: Observable<Material>;
  41011. /**
  41012. * An event triggered when a texture is created
  41013. */
  41014. onNewTextureAddedObservable: Observable<BaseTexture>;
  41015. /**
  41016. * An event triggered when a texture is removed
  41017. */
  41018. onTextureRemovedObservable: Observable<BaseTexture>;
  41019. /**
  41020. * An event triggered when render targets are about to be rendered
  41021. * Can happen multiple times per frame.
  41022. */
  41023. onBeforeRenderTargetsRenderObservable: Observable<Scene>;
  41024. /**
  41025. * An event triggered when render targets were rendered.
  41026. * Can happen multiple times per frame.
  41027. */
  41028. onAfterRenderTargetsRenderObservable: Observable<Scene>;
  41029. /**
  41030. * An event triggered before calculating deterministic simulation step
  41031. */
  41032. onBeforeStepObservable: Observable<Scene>;
  41033. /**
  41034. * An event triggered after calculating deterministic simulation step
  41035. */
  41036. onAfterStepObservable: Observable<Scene>;
  41037. /**
  41038. * An event triggered when the activeCamera property is updated
  41039. */
  41040. onActiveCameraChanged: Observable<Scene>;
  41041. /**
  41042. * This Observable will be triggered before rendering each renderingGroup of each rendered camera.
  41043. * The RenderinGroupInfo class contains all the information about the context in which the observable is called
  41044. * If you wish to register an Observer only for a given set of renderingGroup, use the mask with a combination of the renderingGroup index elevated to the power of two (1 for renderingGroup 0, 2 for renderingrOup1, 4 for 2 and 8 for 3)
  41045. */
  41046. onBeforeRenderingGroupObservable: Observable<RenderingGroupInfo>;
  41047. /**
  41048. * This Observable will be triggered after rendering each renderingGroup of each rendered camera.
  41049. * The RenderinGroupInfo class contains all the information about the context in which the observable is called
  41050. * If you wish to register an Observer only for a given set of renderingGroup, use the mask with a combination of the renderingGroup index elevated to the power of two (1 for renderingGroup 0, 2 for renderingrOup1, 4 for 2 and 8 for 3)
  41051. */
  41052. onAfterRenderingGroupObservable: Observable<RenderingGroupInfo>;
  41053. /**
  41054. * This Observable will when a mesh has been imported into the scene.
  41055. */
  41056. onMeshImportedObservable: Observable<AbstractMesh>;
  41057. /**
  41058. * This Observable will when an animation file has been imported into the scene.
  41059. */
  41060. onAnimationFileImportedObservable: Observable<Scene>;
  41061. /**
  41062. * Gets or sets a user defined funtion to select LOD from a mesh and a camera.
  41063. * By default this function is undefined and Babylon.js will select LOD based on distance to camera
  41064. */
  41065. customLODSelector: (mesh: AbstractMesh, camera: Camera) => Nullable<AbstractMesh>;
  41066. /** @hidden */
  41067. _registeredForLateAnimationBindings: SmartArrayNoDuplicate<any>;
  41068. /**
  41069. * Gets or sets a predicate used to select candidate meshes for a pointer down event
  41070. */
  41071. pointerDownPredicate: (Mesh: AbstractMesh) => boolean;
  41072. /**
  41073. * Gets or sets a predicate used to select candidate meshes for a pointer up event
  41074. */
  41075. pointerUpPredicate: (Mesh: AbstractMesh) => boolean;
  41076. /**
  41077. * Gets or sets a predicate used to select candidate meshes for a pointer move event
  41078. */
  41079. pointerMovePredicate: (Mesh: AbstractMesh) => boolean;
  41080. /** Callback called when a pointer move is detected */
  41081. onPointerMove: (evt: PointerEvent, pickInfo: PickingInfo, type: PointerEventTypes) => void;
  41082. /** Callback called when a pointer down is detected */
  41083. onPointerDown: (evt: PointerEvent, pickInfo: PickingInfo, type: PointerEventTypes) => void;
  41084. /** Callback called when a pointer up is detected */
  41085. onPointerUp: (evt: PointerEvent, pickInfo: Nullable<PickingInfo>, type: PointerEventTypes) => void;
  41086. /** Callback called when a pointer pick is detected */
  41087. onPointerPick: (evt: PointerEvent, pickInfo: PickingInfo) => void;
  41088. /**
  41089. * This observable event is triggered when any ponter event is triggered. It is registered during Scene.attachControl() and it is called BEFORE the 3D engine process anything (mesh/sprite picking for instance).
  41090. * You have the possibility to skip the process and the call to onPointerObservable by setting PointerInfoPre.skipOnPointerObservable to true
  41091. */
  41092. onPrePointerObservable: Observable<PointerInfoPre>;
  41093. /**
  41094. * Observable event triggered each time an input event is received from the rendering canvas
  41095. */
  41096. onPointerObservable: Observable<PointerInfo>;
  41097. /**
  41098. * Gets the pointer coordinates without any translation (ie. straight out of the pointer event)
  41099. */
  41100. get unTranslatedPointer(): Vector2;
  41101. /**
  41102. * Gets or sets the distance in pixel that you have to move to prevent some events. Default is 10 pixels
  41103. */
  41104. static get DragMovementThreshold(): number;
  41105. static set DragMovementThreshold(value: number);
  41106. /**
  41107. * Time in milliseconds to wait to raise long press events if button is still pressed. Default is 500 ms
  41108. */
  41109. static get LongPressDelay(): number;
  41110. static set LongPressDelay(value: number);
  41111. /**
  41112. * Time in milliseconds to wait to raise long press events if button is still pressed. Default is 300 ms
  41113. */
  41114. static get DoubleClickDelay(): number;
  41115. static set DoubleClickDelay(value: number);
  41116. /** If you need to check double click without raising a single click at first click, enable this flag */
  41117. static get ExclusiveDoubleClickMode(): boolean;
  41118. static set ExclusiveDoubleClickMode(value: boolean);
  41119. /** @hidden */
  41120. _mirroredCameraPosition: Nullable<Vector3>;
  41121. /**
  41122. * This observable event is triggered when any keyboard event si raised and registered during Scene.attachControl()
  41123. * You have the possibility to skip the process and the call to onKeyboardObservable by setting KeyboardInfoPre.skipOnPointerObservable to true
  41124. */
  41125. onPreKeyboardObservable: Observable<KeyboardInfoPre>;
  41126. /**
  41127. * Observable event triggered each time an keyboard event is received from the hosting window
  41128. */
  41129. onKeyboardObservable: Observable<KeyboardInfo>;
  41130. private _useRightHandedSystem;
  41131. /**
  41132. * Gets or sets a boolean indicating if the scene must use right-handed coordinates system
  41133. */
  41134. set useRightHandedSystem(value: boolean);
  41135. get useRightHandedSystem(): boolean;
  41136. private _timeAccumulator;
  41137. private _currentStepId;
  41138. private _currentInternalStep;
  41139. /**
  41140. * Sets the step Id used by deterministic lock step
  41141. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  41142. * @param newStepId defines the step Id
  41143. */
  41144. setStepId(newStepId: number): void;
  41145. /**
  41146. * Gets the step Id used by deterministic lock step
  41147. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  41148. * @returns the step Id
  41149. */
  41150. getStepId(): number;
  41151. /**
  41152. * Gets the internal step used by deterministic lock step
  41153. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  41154. * @returns the internal step
  41155. */
  41156. getInternalStep(): number;
  41157. private _fogEnabled;
  41158. /**
  41159. * Gets or sets a boolean indicating if fog is enabled on this scene
  41160. * @see https://doc.babylonjs.com/babylon101/environment#fog
  41161. * (Default is true)
  41162. */
  41163. set fogEnabled(value: boolean);
  41164. get fogEnabled(): boolean;
  41165. private _fogMode;
  41166. /**
  41167. * Gets or sets the fog mode to use
  41168. * @see https://doc.babylonjs.com/babylon101/environment#fog
  41169. * | mode | value |
  41170. * | --- | --- |
  41171. * | FOGMODE_NONE | 0 |
  41172. * | FOGMODE_EXP | 1 |
  41173. * | FOGMODE_EXP2 | 2 |
  41174. * | FOGMODE_LINEAR | 3 |
  41175. */
  41176. set fogMode(value: number);
  41177. get fogMode(): number;
  41178. /**
  41179. * Gets or sets the fog color to use
  41180. * @see https://doc.babylonjs.com/babylon101/environment#fog
  41181. * (Default is Color3(0.2, 0.2, 0.3))
  41182. */
  41183. fogColor: Color3;
  41184. /**
  41185. * Gets or sets the fog density to use
  41186. * @see https://doc.babylonjs.com/babylon101/environment#fog
  41187. * (Default is 0.1)
  41188. */
  41189. fogDensity: number;
  41190. /**
  41191. * Gets or sets the fog start distance to use
  41192. * @see https://doc.babylonjs.com/babylon101/environment#fog
  41193. * (Default is 0)
  41194. */
  41195. fogStart: number;
  41196. /**
  41197. * Gets or sets the fog end distance to use
  41198. * @see https://doc.babylonjs.com/babylon101/environment#fog
  41199. * (Default is 1000)
  41200. */
  41201. fogEnd: number;
  41202. /**
  41203. * Flag indicating that the frame buffer binding is handled by another component
  41204. */
  41205. prePass: boolean;
  41206. private _shadowsEnabled;
  41207. /**
  41208. * Gets or sets a boolean indicating if shadows are enabled on this scene
  41209. */
  41210. set shadowsEnabled(value: boolean);
  41211. get shadowsEnabled(): boolean;
  41212. private _lightsEnabled;
  41213. /**
  41214. * Gets or sets a boolean indicating if lights are enabled on this scene
  41215. */
  41216. set lightsEnabled(value: boolean);
  41217. get lightsEnabled(): boolean;
  41218. /** All of the active cameras added to this scene. */
  41219. activeCameras: Camera[];
  41220. /** @hidden */
  41221. _activeCamera: Nullable<Camera>;
  41222. /** Gets or sets the current active camera */
  41223. get activeCamera(): Nullable<Camera>;
  41224. set activeCamera(value: Nullable<Camera>);
  41225. private _defaultMaterial;
  41226. /** The default material used on meshes when no material is affected */
  41227. get defaultMaterial(): Material;
  41228. /** The default material used on meshes when no material is affected */
  41229. set defaultMaterial(value: Material);
  41230. private _texturesEnabled;
  41231. /**
  41232. * Gets or sets a boolean indicating if textures are enabled on this scene
  41233. */
  41234. set texturesEnabled(value: boolean);
  41235. get texturesEnabled(): boolean;
  41236. /**
  41237. * Gets or sets a boolean indicating if physic engines are enabled on this scene
  41238. */
  41239. physicsEnabled: boolean;
  41240. /**
  41241. * Gets or sets a boolean indicating if particles are enabled on this scene
  41242. */
  41243. particlesEnabled: boolean;
  41244. /**
  41245. * Gets or sets a boolean indicating if sprites are enabled on this scene
  41246. */
  41247. spritesEnabled: boolean;
  41248. private _skeletonsEnabled;
  41249. /**
  41250. * Gets or sets a boolean indicating if skeletons are enabled on this scene
  41251. */
  41252. set skeletonsEnabled(value: boolean);
  41253. get skeletonsEnabled(): boolean;
  41254. /**
  41255. * Gets or sets a boolean indicating if lens flares are enabled on this scene
  41256. */
  41257. lensFlaresEnabled: boolean;
  41258. /**
  41259. * Gets or sets a boolean indicating if collisions are enabled on this scene
  41260. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  41261. */
  41262. collisionsEnabled: boolean;
  41263. private _collisionCoordinator;
  41264. /** @hidden */
  41265. get collisionCoordinator(): ICollisionCoordinator;
  41266. /**
  41267. * Defines the gravity applied to this scene (used only for collisions)
  41268. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  41269. */
  41270. gravity: Vector3;
  41271. /**
  41272. * Gets or sets a boolean indicating if postprocesses are enabled on this scene
  41273. */
  41274. postProcessesEnabled: boolean;
  41275. /**
  41276. * Gets the current postprocess manager
  41277. */
  41278. postProcessManager: PostProcessManager;
  41279. /**
  41280. * Gets or sets a boolean indicating if render targets are enabled on this scene
  41281. */
  41282. renderTargetsEnabled: boolean;
  41283. /**
  41284. * Gets or sets a boolean indicating if next render targets must be dumped as image for debugging purposes
  41285. * We recommend not using it and instead rely on Spector.js: http://spector.babylonjs.com
  41286. */
  41287. dumpNextRenderTargets: boolean;
  41288. /**
  41289. * The list of user defined render targets added to the scene
  41290. */
  41291. customRenderTargets: RenderTargetTexture[];
  41292. /**
  41293. * Defines if texture loading must be delayed
  41294. * If true, textures will only be loaded when they need to be rendered
  41295. */
  41296. useDelayedTextureLoading: boolean;
  41297. /**
  41298. * Gets the list of meshes imported to the scene through SceneLoader
  41299. */
  41300. importedMeshesFiles: String[];
  41301. /**
  41302. * Gets or sets a boolean indicating if probes are enabled on this scene
  41303. */
  41304. probesEnabled: boolean;
  41305. /**
  41306. * Gets or sets the current offline provider to use to store scene data
  41307. * @see https://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  41308. */
  41309. offlineProvider: IOfflineProvider;
  41310. /**
  41311. * Gets or sets the action manager associated with the scene
  41312. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  41313. */
  41314. actionManager: AbstractActionManager;
  41315. private _meshesForIntersections;
  41316. /**
  41317. * Gets or sets a boolean indicating if procedural textures are enabled on this scene
  41318. */
  41319. proceduralTexturesEnabled: boolean;
  41320. private _engine;
  41321. private _totalVertices;
  41322. /** @hidden */
  41323. _activeIndices: PerfCounter;
  41324. /** @hidden */
  41325. _activeParticles: PerfCounter;
  41326. /** @hidden */
  41327. _activeBones: PerfCounter;
  41328. private _animationRatio;
  41329. /** @hidden */
  41330. _animationTimeLast: number;
  41331. /** @hidden */
  41332. _animationTime: number;
  41333. /**
  41334. * Gets or sets a general scale for animation speed
  41335. * @see https://www.babylonjs-playground.com/#IBU2W7#3
  41336. */
  41337. animationTimeScale: number;
  41338. /** @hidden */
  41339. _cachedMaterial: Nullable<Material>;
  41340. /** @hidden */
  41341. _cachedEffect: Nullable<Effect>;
  41342. /** @hidden */
  41343. _cachedVisibility: Nullable<number>;
  41344. private _renderId;
  41345. private _frameId;
  41346. private _executeWhenReadyTimeoutId;
  41347. private _intermediateRendering;
  41348. private _viewUpdateFlag;
  41349. private _projectionUpdateFlag;
  41350. /** @hidden */
  41351. _toBeDisposed: Nullable<IDisposable>[];
  41352. private _activeRequests;
  41353. /** @hidden */
  41354. _pendingData: any[];
  41355. private _isDisposed;
  41356. /**
  41357. * Gets or sets a boolean indicating that all submeshes of active meshes must be rendered
  41358. * Use this boolean to avoid computing frustum clipping on submeshes (This could help when you are CPU bound)
  41359. */
  41360. dispatchAllSubMeshesOfActiveMeshes: boolean;
  41361. private _activeMeshes;
  41362. private _processedMaterials;
  41363. private _renderTargets;
  41364. /** @hidden */
  41365. _activeParticleSystems: SmartArray<IParticleSystem>;
  41366. private _activeSkeletons;
  41367. private _softwareSkinnedMeshes;
  41368. private _renderingManager;
  41369. /** @hidden */
  41370. _activeAnimatables: import("babylonjs/Animations/animatable").Animatable[];
  41371. private _transformMatrix;
  41372. private _sceneUbo;
  41373. /** @hidden */
  41374. _viewMatrix: Matrix;
  41375. private _projectionMatrix;
  41376. /** @hidden */
  41377. _forcedViewPosition: Nullable<Vector3>;
  41378. /** @hidden */
  41379. _frustumPlanes: Plane[];
  41380. /**
  41381. * Gets the list of frustum planes (built from the active camera)
  41382. */
  41383. get frustumPlanes(): Plane[];
  41384. /**
  41385. * Gets or sets a boolean indicating if lights must be sorted by priority (off by default)
  41386. * This is useful if there are more lights that the maximum simulteanous authorized
  41387. */
  41388. requireLightSorting: boolean;
  41389. /** @hidden */
  41390. readonly useMaterialMeshMap: boolean;
  41391. /** @hidden */
  41392. readonly useClonedMeshMap: boolean;
  41393. private _externalData;
  41394. private _uid;
  41395. /**
  41396. * @hidden
  41397. * Backing store of defined scene components.
  41398. */
  41399. _components: ISceneComponent[];
  41400. /**
  41401. * @hidden
  41402. * Backing store of defined scene components.
  41403. */
  41404. _serializableComponents: ISceneSerializableComponent[];
  41405. /**
  41406. * List of components to register on the next registration step.
  41407. */
  41408. private _transientComponents;
  41409. /**
  41410. * Registers the transient components if needed.
  41411. */
  41412. private _registerTransientComponents;
  41413. /**
  41414. * @hidden
  41415. * Add a component to the scene.
  41416. * Note that the ccomponent could be registered on th next frame if this is called after
  41417. * the register component stage.
  41418. * @param component Defines the component to add to the scene
  41419. */
  41420. _addComponent(component: ISceneComponent): void;
  41421. /**
  41422. * @hidden
  41423. * Gets a component from the scene.
  41424. * @param name defines the name of the component to retrieve
  41425. * @returns the component or null if not present
  41426. */
  41427. _getComponent(name: string): Nullable<ISceneComponent>;
  41428. /**
  41429. * @hidden
  41430. * Defines the actions happening before camera updates.
  41431. */
  41432. _beforeCameraUpdateStage: Stage<SimpleStageAction>;
  41433. /**
  41434. * @hidden
  41435. * Defines the actions happening before clear the canvas.
  41436. */
  41437. _beforeClearStage: Stage<SimpleStageAction>;
  41438. /**
  41439. * @hidden
  41440. * Defines the actions when collecting render targets for the frame.
  41441. */
  41442. _gatherRenderTargetsStage: Stage<RenderTargetsStageAction>;
  41443. /**
  41444. * @hidden
  41445. * Defines the actions happening for one camera in the frame.
  41446. */
  41447. _gatherActiveCameraRenderTargetsStage: Stage<RenderTargetsStageAction>;
  41448. /**
  41449. * @hidden
  41450. * Defines the actions happening during the per mesh ready checks.
  41451. */
  41452. _isReadyForMeshStage: Stage<MeshStageAction>;
  41453. /**
  41454. * @hidden
  41455. * Defines the actions happening before evaluate active mesh checks.
  41456. */
  41457. _beforeEvaluateActiveMeshStage: Stage<SimpleStageAction>;
  41458. /**
  41459. * @hidden
  41460. * Defines the actions happening during the evaluate sub mesh checks.
  41461. */
  41462. _evaluateSubMeshStage: Stage<EvaluateSubMeshStageAction>;
  41463. /**
  41464. * @hidden
  41465. * Defines the actions happening during the active mesh stage.
  41466. */
  41467. _activeMeshStage: Stage<ActiveMeshStageAction>;
  41468. /**
  41469. * @hidden
  41470. * Defines the actions happening during the per camera render target step.
  41471. */
  41472. _cameraDrawRenderTargetStage: Stage<CameraStageFrameBufferAction>;
  41473. /**
  41474. * @hidden
  41475. * Defines the actions happening just before the active camera is drawing.
  41476. */
  41477. _beforeCameraDrawStage: Stage<CameraStageAction>;
  41478. /**
  41479. * @hidden
  41480. * Defines the actions happening just before a render target is drawing.
  41481. */
  41482. _beforeRenderTargetDrawStage: Stage<RenderTargetStageAction>;
  41483. /**
  41484. * @hidden
  41485. * Defines the actions happening just before a rendering group is drawing.
  41486. */
  41487. _beforeRenderingGroupDrawStage: Stage<RenderingGroupStageAction>;
  41488. /**
  41489. * @hidden
  41490. * Defines the actions happening just before a mesh is drawing.
  41491. */
  41492. _beforeRenderingMeshStage: Stage<RenderingMeshStageAction>;
  41493. /**
  41494. * @hidden
  41495. * Defines the actions happening just after a mesh has been drawn.
  41496. */
  41497. _afterRenderingMeshStage: Stage<RenderingMeshStageAction>;
  41498. /**
  41499. * @hidden
  41500. * Defines the actions happening just after a rendering group has been drawn.
  41501. */
  41502. _afterRenderingGroupDrawStage: Stage<RenderingGroupStageAction>;
  41503. /**
  41504. * @hidden
  41505. * Defines the actions happening just after the active camera has been drawn.
  41506. */
  41507. _afterCameraDrawStage: Stage<CameraStageAction>;
  41508. /**
  41509. * @hidden
  41510. * Defines the actions happening just after a render target has been drawn.
  41511. */
  41512. _afterRenderTargetDrawStage: Stage<RenderTargetStageAction>;
  41513. /**
  41514. * @hidden
  41515. * Defines the actions happening just after rendering all cameras and computing intersections.
  41516. */
  41517. _afterRenderStage: Stage<SimpleStageAction>;
  41518. /**
  41519. * @hidden
  41520. * Defines the actions happening when a pointer move event happens.
  41521. */
  41522. _pointerMoveStage: Stage<PointerMoveStageAction>;
  41523. /**
  41524. * @hidden
  41525. * Defines the actions happening when a pointer down event happens.
  41526. */
  41527. _pointerDownStage: Stage<PointerUpDownStageAction>;
  41528. /**
  41529. * @hidden
  41530. * Defines the actions happening when a pointer up event happens.
  41531. */
  41532. _pointerUpStage: Stage<PointerUpDownStageAction>;
  41533. /**
  41534. * an optional map from Geometry Id to Geometry index in the 'geometries' array
  41535. */
  41536. private geometriesByUniqueId;
  41537. /**
  41538. * Creates a new Scene
  41539. * @param engine defines the engine to use to render this scene
  41540. * @param options defines the scene options
  41541. */
  41542. constructor(engine: Engine, options?: SceneOptions);
  41543. /**
  41544. * Gets a string identifying the name of the class
  41545. * @returns "Scene" string
  41546. */
  41547. getClassName(): string;
  41548. private _defaultMeshCandidates;
  41549. /**
  41550. * @hidden
  41551. */
  41552. _getDefaultMeshCandidates(): ISmartArrayLike<AbstractMesh>;
  41553. private _defaultSubMeshCandidates;
  41554. /**
  41555. * @hidden
  41556. */
  41557. _getDefaultSubMeshCandidates(mesh: AbstractMesh): ISmartArrayLike<SubMesh>;
  41558. /**
  41559. * Sets the default candidate providers for the scene.
  41560. * This sets the getActiveMeshCandidates, getActiveSubMeshCandidates, getIntersectingSubMeshCandidates
  41561. * and getCollidingSubMeshCandidates to their default function
  41562. */
  41563. setDefaultCandidateProviders(): void;
  41564. /**
  41565. * Gets the mesh that is currently under the pointer
  41566. */
  41567. get meshUnderPointer(): Nullable<AbstractMesh>;
  41568. /**
  41569. * Gets or sets the current on-screen X position of the pointer
  41570. */
  41571. get pointerX(): number;
  41572. set pointerX(value: number);
  41573. /**
  41574. * Gets or sets the current on-screen Y position of the pointer
  41575. */
  41576. get pointerY(): number;
  41577. set pointerY(value: number);
  41578. /**
  41579. * Gets the cached material (ie. the latest rendered one)
  41580. * @returns the cached material
  41581. */
  41582. getCachedMaterial(): Nullable<Material>;
  41583. /**
  41584. * Gets the cached effect (ie. the latest rendered one)
  41585. * @returns the cached effect
  41586. */
  41587. getCachedEffect(): Nullable<Effect>;
  41588. /**
  41589. * Gets the cached visibility state (ie. the latest rendered one)
  41590. * @returns the cached visibility state
  41591. */
  41592. getCachedVisibility(): Nullable<number>;
  41593. /**
  41594. * Gets a boolean indicating if the current material / effect / visibility must be bind again
  41595. * @param material defines the current material
  41596. * @param effect defines the current effect
  41597. * @param visibility defines the current visibility state
  41598. * @returns true if one parameter is not cached
  41599. */
  41600. isCachedMaterialInvalid(material: Material, effect: Effect, visibility?: number): boolean;
  41601. /**
  41602. * Gets the engine associated with the scene
  41603. * @returns an Engine
  41604. */
  41605. getEngine(): Engine;
  41606. /**
  41607. * Gets the total number of vertices rendered per frame
  41608. * @returns the total number of vertices rendered per frame
  41609. */
  41610. getTotalVertices(): number;
  41611. /**
  41612. * Gets the performance counter for total vertices
  41613. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  41614. */
  41615. get totalVerticesPerfCounter(): PerfCounter;
  41616. /**
  41617. * Gets the total number of active indices rendered per frame (You can deduce the number of rendered triangles by dividing this number by 3)
  41618. * @returns the total number of active indices rendered per frame
  41619. */
  41620. getActiveIndices(): number;
  41621. /**
  41622. * Gets the performance counter for active indices
  41623. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  41624. */
  41625. get totalActiveIndicesPerfCounter(): PerfCounter;
  41626. /**
  41627. * Gets the total number of active particles rendered per frame
  41628. * @returns the total number of active particles rendered per frame
  41629. */
  41630. getActiveParticles(): number;
  41631. /**
  41632. * Gets the performance counter for active particles
  41633. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  41634. */
  41635. get activeParticlesPerfCounter(): PerfCounter;
  41636. /**
  41637. * Gets the total number of active bones rendered per frame
  41638. * @returns the total number of active bones rendered per frame
  41639. */
  41640. getActiveBones(): number;
  41641. /**
  41642. * Gets the performance counter for active bones
  41643. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  41644. */
  41645. get activeBonesPerfCounter(): PerfCounter;
  41646. /**
  41647. * Gets the array of active meshes
  41648. * @returns an array of AbstractMesh
  41649. */
  41650. getActiveMeshes(): SmartArray<AbstractMesh>;
  41651. /**
  41652. * Gets the animation ratio (which is 1.0 is the scene renders at 60fps and 2 if the scene renders at 30fps, etc.)
  41653. * @returns a number
  41654. */
  41655. getAnimationRatio(): number;
  41656. /**
  41657. * Gets an unique Id for the current render phase
  41658. * @returns a number
  41659. */
  41660. getRenderId(): number;
  41661. /**
  41662. * Gets an unique Id for the current frame
  41663. * @returns a number
  41664. */
  41665. getFrameId(): number;
  41666. /** Call this function if you want to manually increment the render Id*/
  41667. incrementRenderId(): void;
  41668. private _createUbo;
  41669. /**
  41670. * Use this method to simulate a pointer move on a mesh
  41671. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  41672. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  41673. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  41674. * @returns the current scene
  41675. */
  41676. simulatePointerMove(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): Scene;
  41677. /**
  41678. * Use this method to simulate a pointer down on a mesh
  41679. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  41680. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  41681. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  41682. * @returns the current scene
  41683. */
  41684. simulatePointerDown(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): Scene;
  41685. /**
  41686. * Use this method to simulate a pointer up on a mesh
  41687. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  41688. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  41689. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  41690. * @param doubleTap indicates that the pointer up event should be considered as part of a double click (false by default)
  41691. * @returns the current scene
  41692. */
  41693. simulatePointerUp(pickResult: PickingInfo, pointerEventInit?: PointerEventInit, doubleTap?: boolean): Scene;
  41694. /**
  41695. * Gets a boolean indicating if the current pointer event is captured (meaning that the scene has already handled the pointer down)
  41696. * @param pointerId defines the pointer id to use in a multi-touch scenario (0 by default)
  41697. * @returns true if the pointer was captured
  41698. */
  41699. isPointerCaptured(pointerId?: number): boolean;
  41700. /**
  41701. * Attach events to the canvas (To handle actionManagers triggers and raise onPointerMove, onPointerDown and onPointerUp
  41702. * @param attachUp defines if you want to attach events to pointerup
  41703. * @param attachDown defines if you want to attach events to pointerdown
  41704. * @param attachMove defines if you want to attach events to pointermove
  41705. */
  41706. attachControl(attachUp?: boolean, attachDown?: boolean, attachMove?: boolean): void;
  41707. /** Detaches all event handlers*/
  41708. detachControl(): void;
  41709. /**
  41710. * This function will check if the scene can be rendered (textures are loaded, shaders are compiled)
  41711. * Delay loaded resources are not taking in account
  41712. * @return true if all required resources are ready
  41713. */
  41714. isReady(): boolean;
  41715. /** Resets all cached information relative to material (including effect and visibility) */
  41716. resetCachedMaterial(): void;
  41717. /**
  41718. * Registers a function to be called before every frame render
  41719. * @param func defines the function to register
  41720. */
  41721. registerBeforeRender(func: () => void): void;
  41722. /**
  41723. * Unregisters a function called before every frame render
  41724. * @param func defines the function to unregister
  41725. */
  41726. unregisterBeforeRender(func: () => void): void;
  41727. /**
  41728. * Registers a function to be called after every frame render
  41729. * @param func defines the function to register
  41730. */
  41731. registerAfterRender(func: () => void): void;
  41732. /**
  41733. * Unregisters a function called after every frame render
  41734. * @param func defines the function to unregister
  41735. */
  41736. unregisterAfterRender(func: () => void): void;
  41737. private _executeOnceBeforeRender;
  41738. /**
  41739. * The provided function will run before render once and will be disposed afterwards.
  41740. * A timeout delay can be provided so that the function will be executed in N ms.
  41741. * The timeout is using the browser's native setTimeout so time percision cannot be guaranteed.
  41742. * @param func The function to be executed.
  41743. * @param timeout optional delay in ms
  41744. */
  41745. executeOnceBeforeRender(func: () => void, timeout?: number): void;
  41746. /** @hidden */
  41747. _addPendingData(data: any): void;
  41748. /** @hidden */
  41749. _removePendingData(data: any): void;
  41750. /**
  41751. * Returns the number of items waiting to be loaded
  41752. * @returns the number of items waiting to be loaded
  41753. */
  41754. getWaitingItemsCount(): number;
  41755. /**
  41756. * Returns a boolean indicating if the scene is still loading data
  41757. */
  41758. get isLoading(): boolean;
  41759. /**
  41760. * Registers a function to be executed when the scene is ready
  41761. * @param {Function} func - the function to be executed
  41762. */
  41763. executeWhenReady(func: () => void): void;
  41764. /**
  41765. * Returns a promise that resolves when the scene is ready
  41766. * @returns A promise that resolves when the scene is ready
  41767. */
  41768. whenReadyAsync(): Promise<void>;
  41769. /** @hidden */
  41770. _checkIsReady(): void;
  41771. /**
  41772. * Gets all animatable attached to the scene
  41773. */
  41774. get animatables(): Animatable[];
  41775. /**
  41776. * Resets the last animation time frame.
  41777. * Useful to override when animations start running when loading a scene for the first time.
  41778. */
  41779. resetLastAnimationTimeFrame(): void;
  41780. /**
  41781. * Gets the current view matrix
  41782. * @returns a Matrix
  41783. */
  41784. getViewMatrix(): Matrix;
  41785. /**
  41786. * Gets the current projection matrix
  41787. * @returns a Matrix
  41788. */
  41789. getProjectionMatrix(): Matrix;
  41790. /**
  41791. * Gets the current transform matrix
  41792. * @returns a Matrix made of View * Projection
  41793. */
  41794. getTransformMatrix(): Matrix;
  41795. /**
  41796. * Sets the current transform matrix
  41797. * @param viewL defines the View matrix to use
  41798. * @param projectionL defines the Projection matrix to use
  41799. * @param viewR defines the right View matrix to use (if provided)
  41800. * @param projectionR defines the right Projection matrix to use (if provided)
  41801. */
  41802. setTransformMatrix(viewL: Matrix, projectionL: Matrix, viewR?: Matrix, projectionR?: Matrix): void;
  41803. /**
  41804. * Gets the uniform buffer used to store scene data
  41805. * @returns a UniformBuffer
  41806. */
  41807. getSceneUniformBuffer(): UniformBuffer;
  41808. /**
  41809. * Gets an unique (relatively to the current scene) Id
  41810. * @returns an unique number for the scene
  41811. */
  41812. getUniqueId(): number;
  41813. /**
  41814. * Add a mesh to the list of scene's meshes
  41815. * @param newMesh defines the mesh to add
  41816. * @param recursive if all child meshes should also be added to the scene
  41817. */
  41818. addMesh(newMesh: AbstractMesh, recursive?: boolean): void;
  41819. /**
  41820. * Remove a mesh for the list of scene's meshes
  41821. * @param toRemove defines the mesh to remove
  41822. * @param recursive if all child meshes should also be removed from the scene
  41823. * @returns the index where the mesh was in the mesh list
  41824. */
  41825. removeMesh(toRemove: AbstractMesh, recursive?: boolean): number;
  41826. /**
  41827. * Add a transform node to the list of scene's transform nodes
  41828. * @param newTransformNode defines the transform node to add
  41829. */
  41830. addTransformNode(newTransformNode: TransformNode): void;
  41831. /**
  41832. * Remove a transform node for the list of scene's transform nodes
  41833. * @param toRemove defines the transform node to remove
  41834. * @returns the index where the transform node was in the transform node list
  41835. */
  41836. removeTransformNode(toRemove: TransformNode): number;
  41837. /**
  41838. * Remove a skeleton for the list of scene's skeletons
  41839. * @param toRemove defines the skeleton to remove
  41840. * @returns the index where the skeleton was in the skeleton list
  41841. */
  41842. removeSkeleton(toRemove: Skeleton): number;
  41843. /**
  41844. * Remove a morph target for the list of scene's morph targets
  41845. * @param toRemove defines the morph target to remove
  41846. * @returns the index where the morph target was in the morph target list
  41847. */
  41848. removeMorphTargetManager(toRemove: MorphTargetManager): number;
  41849. /**
  41850. * Remove a light for the list of scene's lights
  41851. * @param toRemove defines the light to remove
  41852. * @returns the index where the light was in the light list
  41853. */
  41854. removeLight(toRemove: Light): number;
  41855. /**
  41856. * Remove a camera for the list of scene's cameras
  41857. * @param toRemove defines the camera to remove
  41858. * @returns the index where the camera was in the camera list
  41859. */
  41860. removeCamera(toRemove: Camera): number;
  41861. /**
  41862. * Remove a particle system for the list of scene's particle systems
  41863. * @param toRemove defines the particle system to remove
  41864. * @returns the index where the particle system was in the particle system list
  41865. */
  41866. removeParticleSystem(toRemove: IParticleSystem): number;
  41867. /**
  41868. * Remove a animation for the list of scene's animations
  41869. * @param toRemove defines the animation to remove
  41870. * @returns the index where the animation was in the animation list
  41871. */
  41872. removeAnimation(toRemove: Animation): number;
  41873. /**
  41874. * Will stop the animation of the given target
  41875. * @param target - the target
  41876. * @param animationName - the name of the animation to stop (all animations will be stopped if both this and targetMask are empty)
  41877. * @param targetMask - a function that determines if the animation should be stopped based on its target (all animations will be stopped if both this and animationName are empty)
  41878. */
  41879. stopAnimation(target: any, animationName?: string, targetMask?: (target: any) => boolean): void;
  41880. /**
  41881. * Removes the given animation group from this scene.
  41882. * @param toRemove The animation group to remove
  41883. * @returns The index of the removed animation group
  41884. */
  41885. removeAnimationGroup(toRemove: AnimationGroup): number;
  41886. /**
  41887. * Removes the given multi-material from this scene.
  41888. * @param toRemove The multi-material to remove
  41889. * @returns The index of the removed multi-material
  41890. */
  41891. removeMultiMaterial(toRemove: MultiMaterial): number;
  41892. /**
  41893. * Removes the given material from this scene.
  41894. * @param toRemove The material to remove
  41895. * @returns The index of the removed material
  41896. */
  41897. removeMaterial(toRemove: Material): number;
  41898. /**
  41899. * Removes the given action manager from this scene.
  41900. * @param toRemove The action manager to remove
  41901. * @returns The index of the removed action manager
  41902. */
  41903. removeActionManager(toRemove: AbstractActionManager): number;
  41904. /**
  41905. * Removes the given texture from this scene.
  41906. * @param toRemove The texture to remove
  41907. * @returns The index of the removed texture
  41908. */
  41909. removeTexture(toRemove: BaseTexture): number;
  41910. /**
  41911. * Adds the given light to this scene
  41912. * @param newLight The light to add
  41913. */
  41914. addLight(newLight: Light): void;
  41915. /**
  41916. * Sorts the list list based on light priorities
  41917. */
  41918. sortLightsByPriority(): void;
  41919. /**
  41920. * Adds the given camera to this scene
  41921. * @param newCamera The camera to add
  41922. */
  41923. addCamera(newCamera: Camera): void;
  41924. /**
  41925. * Adds the given skeleton to this scene
  41926. * @param newSkeleton The skeleton to add
  41927. */
  41928. addSkeleton(newSkeleton: Skeleton): void;
  41929. /**
  41930. * Adds the given particle system to this scene
  41931. * @param newParticleSystem The particle system to add
  41932. */
  41933. addParticleSystem(newParticleSystem: IParticleSystem): void;
  41934. /**
  41935. * Adds the given animation to this scene
  41936. * @param newAnimation The animation to add
  41937. */
  41938. addAnimation(newAnimation: Animation): void;
  41939. /**
  41940. * Adds the given animation group to this scene.
  41941. * @param newAnimationGroup The animation group to add
  41942. */
  41943. addAnimationGroup(newAnimationGroup: AnimationGroup): void;
  41944. /**
  41945. * Adds the given multi-material to this scene
  41946. * @param newMultiMaterial The multi-material to add
  41947. */
  41948. addMultiMaterial(newMultiMaterial: MultiMaterial): void;
  41949. /**
  41950. * Adds the given material to this scene
  41951. * @param newMaterial The material to add
  41952. */
  41953. addMaterial(newMaterial: Material): void;
  41954. /**
  41955. * Adds the given morph target to this scene
  41956. * @param newMorphTargetManager The morph target to add
  41957. */
  41958. addMorphTargetManager(newMorphTargetManager: MorphTargetManager): void;
  41959. /**
  41960. * Adds the given geometry to this scene
  41961. * @param newGeometry The geometry to add
  41962. */
  41963. addGeometry(newGeometry: Geometry): void;
  41964. /**
  41965. * Adds the given action manager to this scene
  41966. * @param newActionManager The action manager to add
  41967. */
  41968. addActionManager(newActionManager: AbstractActionManager): void;
  41969. /**
  41970. * Adds the given texture to this scene.
  41971. * @param newTexture The texture to add
  41972. */
  41973. addTexture(newTexture: BaseTexture): void;
  41974. /**
  41975. * Switch active camera
  41976. * @param newCamera defines the new active camera
  41977. * @param attachControl defines if attachControl must be called for the new active camera (default: true)
  41978. */
  41979. switchActiveCamera(newCamera: Camera, attachControl?: boolean): void;
  41980. /**
  41981. * sets the active camera of the scene using its ID
  41982. * @param id defines the camera's ID
  41983. * @return the new active camera or null if none found.
  41984. */
  41985. setActiveCameraByID(id: string): Nullable<Camera>;
  41986. /**
  41987. * sets the active camera of the scene using its name
  41988. * @param name defines the camera's name
  41989. * @returns the new active camera or null if none found.
  41990. */
  41991. setActiveCameraByName(name: string): Nullable<Camera>;
  41992. /**
  41993. * get an animation group using its name
  41994. * @param name defines the material's name
  41995. * @return the animation group or null if none found.
  41996. */
  41997. getAnimationGroupByName(name: string): Nullable<AnimationGroup>;
  41998. /**
  41999. * Get a material using its unique id
  42000. * @param uniqueId defines the material's unique id
  42001. * @return the material or null if none found.
  42002. */
  42003. getMaterialByUniqueID(uniqueId: number): Nullable<Material>;
  42004. /**
  42005. * get a material using its id
  42006. * @param id defines the material's ID
  42007. * @return the material or null if none found.
  42008. */
  42009. getMaterialByID(id: string): Nullable<Material>;
  42010. /**
  42011. * Gets a the last added material using a given id
  42012. * @param id defines the material's ID
  42013. * @return the last material with the given id or null if none found.
  42014. */
  42015. getLastMaterialByID(id: string): Nullable<Material>;
  42016. /**
  42017. * Gets a material using its name
  42018. * @param name defines the material's name
  42019. * @return the material or null if none found.
  42020. */
  42021. getMaterialByName(name: string): Nullable<Material>;
  42022. /**
  42023. * Get a texture using its unique id
  42024. * @param uniqueId defines the texture's unique id
  42025. * @return the texture or null if none found.
  42026. */
  42027. getTextureByUniqueID(uniqueId: number): Nullable<BaseTexture>;
  42028. /**
  42029. * Gets a camera using its id
  42030. * @param id defines the id to look for
  42031. * @returns the camera or null if not found
  42032. */
  42033. getCameraByID(id: string): Nullable<Camera>;
  42034. /**
  42035. * Gets a camera using its unique id
  42036. * @param uniqueId defines the unique id to look for
  42037. * @returns the camera or null if not found
  42038. */
  42039. getCameraByUniqueID(uniqueId: number): Nullable<Camera>;
  42040. /**
  42041. * Gets a camera using its name
  42042. * @param name defines the camera's name
  42043. * @return the camera or null if none found.
  42044. */
  42045. getCameraByName(name: string): Nullable<Camera>;
  42046. /**
  42047. * Gets a bone using its id
  42048. * @param id defines the bone's id
  42049. * @return the bone or null if not found
  42050. */
  42051. getBoneByID(id: string): Nullable<Bone>;
  42052. /**
  42053. * Gets a bone using its id
  42054. * @param name defines the bone's name
  42055. * @return the bone or null if not found
  42056. */
  42057. getBoneByName(name: string): Nullable<Bone>;
  42058. /**
  42059. * Gets a light node using its name
  42060. * @param name defines the the light's name
  42061. * @return the light or null if none found.
  42062. */
  42063. getLightByName(name: string): Nullable<Light>;
  42064. /**
  42065. * Gets a light node using its id
  42066. * @param id defines the light's id
  42067. * @return the light or null if none found.
  42068. */
  42069. getLightByID(id: string): Nullable<Light>;
  42070. /**
  42071. * Gets a light node using its scene-generated unique ID
  42072. * @param uniqueId defines the light's unique id
  42073. * @return the light or null if none found.
  42074. */
  42075. getLightByUniqueID(uniqueId: number): Nullable<Light>;
  42076. /**
  42077. * Gets a particle system by id
  42078. * @param id defines the particle system id
  42079. * @return the corresponding system or null if none found
  42080. */
  42081. getParticleSystemByID(id: string): Nullable<IParticleSystem>;
  42082. /**
  42083. * Gets a geometry using its ID
  42084. * @param id defines the geometry's id
  42085. * @return the geometry or null if none found.
  42086. */
  42087. getGeometryByID(id: string): Nullable<Geometry>;
  42088. private _getGeometryByUniqueID;
  42089. /**
  42090. * Add a new geometry to this scene
  42091. * @param geometry defines the geometry to be added to the scene.
  42092. * @param force defines if the geometry must be pushed even if a geometry with this id already exists
  42093. * @return a boolean defining if the geometry was added or not
  42094. */
  42095. pushGeometry(geometry: Geometry, force?: boolean): boolean;
  42096. /**
  42097. * Removes an existing geometry
  42098. * @param geometry defines the geometry to be removed from the scene
  42099. * @return a boolean defining if the geometry was removed or not
  42100. */
  42101. removeGeometry(geometry: Geometry): boolean;
  42102. /**
  42103. * Gets the list of geometries attached to the scene
  42104. * @returns an array of Geometry
  42105. */
  42106. getGeometries(): Geometry[];
  42107. /**
  42108. * Gets the first added mesh found of a given ID
  42109. * @param id defines the id to search for
  42110. * @return the mesh found or null if not found at all
  42111. */
  42112. getMeshByID(id: string): Nullable<AbstractMesh>;
  42113. /**
  42114. * Gets a list of meshes using their id
  42115. * @param id defines the id to search for
  42116. * @returns a list of meshes
  42117. */
  42118. getMeshesByID(id: string): Array<AbstractMesh>;
  42119. /**
  42120. * Gets the first added transform node found of a given ID
  42121. * @param id defines the id to search for
  42122. * @return the found transform node or null if not found at all.
  42123. */
  42124. getTransformNodeByID(id: string): Nullable<TransformNode>;
  42125. /**
  42126. * Gets a transform node with its auto-generated unique id
  42127. * @param uniqueId efines the unique id to search for
  42128. * @return the found transform node or null if not found at all.
  42129. */
  42130. getTransformNodeByUniqueID(uniqueId: number): Nullable<TransformNode>;
  42131. /**
  42132. * Gets a list of transform nodes using their id
  42133. * @param id defines the id to search for
  42134. * @returns a list of transform nodes
  42135. */
  42136. getTransformNodesByID(id: string): Array<TransformNode>;
  42137. /**
  42138. * Gets a mesh with its auto-generated unique id
  42139. * @param uniqueId defines the unique id to search for
  42140. * @return the found mesh or null if not found at all.
  42141. */
  42142. getMeshByUniqueID(uniqueId: number): Nullable<AbstractMesh>;
  42143. /**
  42144. * Gets a the last added mesh using a given id
  42145. * @param id defines the id to search for
  42146. * @return the found mesh or null if not found at all.
  42147. */
  42148. getLastMeshByID(id: string): Nullable<AbstractMesh>;
  42149. /**
  42150. * Gets a the last added node (Mesh, Camera, Light) using a given id
  42151. * @param id defines the id to search for
  42152. * @return the found node or null if not found at all
  42153. */
  42154. getLastEntryByID(id: string): Nullable<Node>;
  42155. /**
  42156. * Gets a node (Mesh, Camera, Light) using a given id
  42157. * @param id defines the id to search for
  42158. * @return the found node or null if not found at all
  42159. */
  42160. getNodeByID(id: string): Nullable<Node>;
  42161. /**
  42162. * Gets a node (Mesh, Camera, Light) using a given name
  42163. * @param name defines the name to search for
  42164. * @return the found node or null if not found at all.
  42165. */
  42166. getNodeByName(name: string): Nullable<Node>;
  42167. /**
  42168. * Gets a mesh using a given name
  42169. * @param name defines the name to search for
  42170. * @return the found mesh or null if not found at all.
  42171. */
  42172. getMeshByName(name: string): Nullable<AbstractMesh>;
  42173. /**
  42174. * Gets a transform node using a given name
  42175. * @param name defines the name to search for
  42176. * @return the found transform node or null if not found at all.
  42177. */
  42178. getTransformNodeByName(name: string): Nullable<TransformNode>;
  42179. /**
  42180. * Gets a skeleton using a given id (if many are found, this function will pick the last one)
  42181. * @param id defines the id to search for
  42182. * @return the found skeleton or null if not found at all.
  42183. */
  42184. getLastSkeletonByID(id: string): Nullable<Skeleton>;
  42185. /**
  42186. * Gets a skeleton using a given auto generated unique id
  42187. * @param uniqueId defines the unique id to search for
  42188. * @return the found skeleton or null if not found at all.
  42189. */
  42190. getSkeletonByUniqueId(uniqueId: number): Nullable<Skeleton>;
  42191. /**
  42192. * Gets a skeleton using a given id (if many are found, this function will pick the first one)
  42193. * @param id defines the id to search for
  42194. * @return the found skeleton or null if not found at all.
  42195. */
  42196. getSkeletonById(id: string): Nullable<Skeleton>;
  42197. /**
  42198. * Gets a skeleton using a given name
  42199. * @param name defines the name to search for
  42200. * @return the found skeleton or null if not found at all.
  42201. */
  42202. getSkeletonByName(name: string): Nullable<Skeleton>;
  42203. /**
  42204. * Gets a morph target manager using a given id (if many are found, this function will pick the last one)
  42205. * @param id defines the id to search for
  42206. * @return the found morph target manager or null if not found at all.
  42207. */
  42208. getMorphTargetManagerById(id: number): Nullable<MorphTargetManager>;
  42209. /**
  42210. * Gets a morph target using a given id (if many are found, this function will pick the first one)
  42211. * @param id defines the id to search for
  42212. * @return the found morph target or null if not found at all.
  42213. */
  42214. getMorphTargetById(id: string): Nullable<MorphTarget>;
  42215. /**
  42216. * Gets a morph target using a given name (if many are found, this function will pick the first one)
  42217. * @param name defines the name to search for
  42218. * @return the found morph target or null if not found at all.
  42219. */
  42220. getMorphTargetByName(name: string): Nullable<MorphTarget>;
  42221. /**
  42222. * Gets a post process using a given name (if many are found, this function will pick the first one)
  42223. * @param name defines the name to search for
  42224. * @return the found post process or null if not found at all.
  42225. */
  42226. getPostProcessByName(name: string): Nullable<PostProcess>;
  42227. /**
  42228. * Gets a boolean indicating if the given mesh is active
  42229. * @param mesh defines the mesh to look for
  42230. * @returns true if the mesh is in the active list
  42231. */
  42232. isActiveMesh(mesh: AbstractMesh): boolean;
  42233. /**
  42234. * Return a unique id as a string which can serve as an identifier for the scene
  42235. */
  42236. get uid(): string;
  42237. /**
  42238. * Add an externaly attached data from its key.
  42239. * This method call will fail and return false, if such key already exists.
  42240. * If you don't care and just want to get the data no matter what, use the more convenient getOrAddExternalDataWithFactory() method.
  42241. * @param key the unique key that identifies the data
  42242. * @param data the data object to associate to the key for this Engine instance
  42243. * @return true if no such key were already present and the data was added successfully, false otherwise
  42244. */
  42245. addExternalData<T>(key: string, data: T): boolean;
  42246. /**
  42247. * Get an externaly attached data from its key
  42248. * @param key the unique key that identifies the data
  42249. * @return the associated data, if present (can be null), or undefined if not present
  42250. */
  42251. getExternalData<T>(key: string): Nullable<T>;
  42252. /**
  42253. * Get an externaly attached data from its key, create it using a factory if it's not already present
  42254. * @param key the unique key that identifies the data
  42255. * @param factory the factory that will be called to create the instance if and only if it doesn't exists
  42256. * @return the associated data, can be null if the factory returned null.
  42257. */
  42258. getOrAddExternalDataWithFactory<T>(key: string, factory: (k: string) => T): T;
  42259. /**
  42260. * Remove an externaly attached data from the Engine instance
  42261. * @param key the unique key that identifies the data
  42262. * @return true if the data was successfully removed, false if it doesn't exist
  42263. */
  42264. removeExternalData(key: string): boolean;
  42265. private _evaluateSubMesh;
  42266. /**
  42267. * Clear the processed materials smart array preventing retention point in material dispose.
  42268. */
  42269. freeProcessedMaterials(): void;
  42270. private _preventFreeActiveMeshesAndRenderingGroups;
  42271. /** Gets or sets a boolean blocking all the calls to freeActiveMeshes and freeRenderingGroups
  42272. * It can be used in order to prevent going through methods freeRenderingGroups and freeActiveMeshes several times to improve performance
  42273. * when disposing several meshes in a row or a hierarchy of meshes.
  42274. * When used, it is the responsability of the user to blockfreeActiveMeshesAndRenderingGroups back to false.
  42275. */
  42276. get blockfreeActiveMeshesAndRenderingGroups(): boolean;
  42277. set blockfreeActiveMeshesAndRenderingGroups(value: boolean);
  42278. /**
  42279. * Clear the active meshes smart array preventing retention point in mesh dispose.
  42280. */
  42281. freeActiveMeshes(): void;
  42282. /**
  42283. * Clear the info related to rendering groups preventing retention points during dispose.
  42284. */
  42285. freeRenderingGroups(): void;
  42286. /** @hidden */
  42287. _isInIntermediateRendering(): boolean;
  42288. /**
  42289. * Lambda returning the list of potentially active meshes.
  42290. */
  42291. getActiveMeshCandidates: () => ISmartArrayLike<AbstractMesh>;
  42292. /**
  42293. * Lambda returning the list of potentially active sub meshes.
  42294. */
  42295. getActiveSubMeshCandidates: (mesh: AbstractMesh) => ISmartArrayLike<SubMesh>;
  42296. /**
  42297. * Lambda returning the list of potentially intersecting sub meshes.
  42298. */
  42299. getIntersectingSubMeshCandidates: (mesh: AbstractMesh, localRay: Ray) => ISmartArrayLike<SubMesh>;
  42300. /**
  42301. * Lambda returning the list of potentially colliding sub meshes.
  42302. */
  42303. getCollidingSubMeshCandidates: (mesh: AbstractMesh, collider: Collider) => ISmartArrayLike<SubMesh>;
  42304. private _activeMeshesFrozen;
  42305. private _skipEvaluateActiveMeshesCompletely;
  42306. /**
  42307. * Use this function to stop evaluating active meshes. The current list will be keep alive between frames
  42308. * @param skipEvaluateActiveMeshes defines an optional boolean indicating that the evaluate active meshes step must be completely skipped
  42309. * @returns the current scene
  42310. */
  42311. freezeActiveMeshes(skipEvaluateActiveMeshes?: boolean): Scene;
  42312. /**
  42313. * Use this function to restart evaluating active meshes on every frame
  42314. * @returns the current scene
  42315. */
  42316. unfreezeActiveMeshes(): Scene;
  42317. private _evaluateActiveMeshes;
  42318. private _activeMesh;
  42319. /**
  42320. * Update the transform matrix to update from the current active camera
  42321. * @param force defines a boolean used to force the update even if cache is up to date
  42322. */
  42323. updateTransformMatrix(force?: boolean): void;
  42324. private _bindFrameBuffer;
  42325. /** @hidden */
  42326. _allowPostProcessClearColor: boolean;
  42327. /** @hidden */
  42328. _renderForCamera(camera: Camera, rigParent?: Camera): void;
  42329. private _processSubCameras;
  42330. private _checkIntersections;
  42331. /** @hidden */
  42332. _advancePhysicsEngineStep(step: number): void;
  42333. /**
  42334. * User updatable function that will return a deterministic frame time when engine is in deterministic lock step mode
  42335. */
  42336. getDeterministicFrameTime: () => number;
  42337. /** @hidden */
  42338. _animate(): void;
  42339. /** Execute all animations (for a frame) */
  42340. animate(): void;
  42341. /**
  42342. * Render the scene
  42343. * @param updateCameras defines a boolean indicating if cameras must update according to their inputs (true by default)
  42344. * @param ignoreAnimations defines a boolean indicating if animations should not be executed (false by default)
  42345. */
  42346. render(updateCameras?: boolean, ignoreAnimations?: boolean): void;
  42347. /**
  42348. * Freeze all materials
  42349. * A frozen material will not be updatable but should be faster to render
  42350. */
  42351. freezeMaterials(): void;
  42352. /**
  42353. * Unfreeze all materials
  42354. * A frozen material will not be updatable but should be faster to render
  42355. */
  42356. unfreezeMaterials(): void;
  42357. /**
  42358. * Releases all held ressources
  42359. */
  42360. dispose(): void;
  42361. /**
  42362. * Gets if the scene is already disposed
  42363. */
  42364. get isDisposed(): boolean;
  42365. /**
  42366. * Call this function to reduce memory footprint of the scene.
  42367. * Vertex buffers will not store CPU data anymore (this will prevent picking, collisions or physics to work correctly)
  42368. */
  42369. clearCachedVertexData(): void;
  42370. /**
  42371. * This function will remove the local cached buffer data from texture.
  42372. * It will save memory but will prevent the texture from being rebuilt
  42373. */
  42374. cleanCachedTextureBuffer(): void;
  42375. /**
  42376. * Get the world extend vectors with an optional filter
  42377. *
  42378. * @param filterPredicate the predicate - which meshes should be included when calculating the world size
  42379. * @returns {{ min: Vector3; max: Vector3 }} min and max vectors
  42380. */
  42381. getWorldExtends(filterPredicate?: (mesh: AbstractMesh) => boolean): {
  42382. min: Vector3;
  42383. max: Vector3;
  42384. };
  42385. /**
  42386. * Creates a ray that can be used to pick in the scene
  42387. * @param x defines the x coordinate of the origin (on-screen)
  42388. * @param y defines the y coordinate of the origin (on-screen)
  42389. * @param world defines the world matrix to use if you want to pick in object space (instead of world space)
  42390. * @param camera defines the camera to use for the picking
  42391. * @param cameraViewSpace defines if picking will be done in view space (false by default)
  42392. * @returns a Ray
  42393. */
  42394. createPickingRay(x: number, y: number, world: Matrix, camera: Nullable<Camera>, cameraViewSpace?: boolean): Ray;
  42395. /**
  42396. * Creates a ray that can be used to pick in the scene
  42397. * @param x defines the x coordinate of the origin (on-screen)
  42398. * @param y defines the y coordinate of the origin (on-screen)
  42399. * @param world defines the world matrix to use if you want to pick in object space (instead of world space)
  42400. * @param result defines the ray where to store the picking ray
  42401. * @param camera defines the camera to use for the picking
  42402. * @param cameraViewSpace defines if picking will be done in view space (false by default)
  42403. * @returns the current scene
  42404. */
  42405. createPickingRayToRef(x: number, y: number, world: Matrix, result: Ray, camera: Nullable<Camera>, cameraViewSpace?: boolean): Scene;
  42406. /**
  42407. * Creates a ray that can be used to pick in the scene
  42408. * @param x defines the x coordinate of the origin (on-screen)
  42409. * @param y defines the y coordinate of the origin (on-screen)
  42410. * @param camera defines the camera to use for the picking
  42411. * @returns a Ray
  42412. */
  42413. createPickingRayInCameraSpace(x: number, y: number, camera?: Camera): Ray;
  42414. /**
  42415. * Creates a ray that can be used to pick in the scene
  42416. * @param x defines the x coordinate of the origin (on-screen)
  42417. * @param y defines the y coordinate of the origin (on-screen)
  42418. * @param result defines the ray where to store the picking ray
  42419. * @param camera defines the camera to use for the picking
  42420. * @returns the current scene
  42421. */
  42422. createPickingRayInCameraSpaceToRef(x: number, y: number, result: Ray, camera?: Camera): Scene;
  42423. /** Launch a ray to try to pick a mesh in the scene
  42424. * @param x position on screen
  42425. * @param y position on screen
  42426. * @param predicate Predicate function used to determine eligible meshes. Can be set to null. In this case, a mesh must be enabled, visible and with isPickable set to true
  42427. * @param fastCheck defines if the first intersection will be used (and not the closest)
  42428. * @param camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  42429. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  42430. * @returns a PickingInfo
  42431. */
  42432. pick(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, camera?: Nullable<Camera>, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  42433. /** Launch a ray to try to pick a mesh in the scene using only bounding information of the main mesh (not using submeshes)
  42434. * @param x position on screen
  42435. * @param y position on screen
  42436. * @param predicate Predicate function used to determine eligible meshes. Can be set to null. In this case, a mesh must be enabled, visible and with isPickable set to true
  42437. * @param fastCheck defines if the first intersection will be used (and not the closest)
  42438. * @param camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  42439. * @returns a PickingInfo (Please note that some info will not be set like distance, bv, bu and everything that cannot be capture by only using bounding infos)
  42440. */
  42441. pickWithBoundingInfo(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, camera?: Nullable<Camera>): Nullable<PickingInfo>;
  42442. /** Use the given ray to pick a mesh in the scene
  42443. * @param ray The ray to use to pick meshes
  42444. * @param predicate Predicate function used to determine eligible meshes. Can be set to null. In this case, a mesh must have isPickable set to true
  42445. * @param fastCheck defines if the first intersection will be used (and not the closest)
  42446. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  42447. * @returns a PickingInfo
  42448. */
  42449. pickWithRay(ray: Ray, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  42450. /**
  42451. * Launch a ray to try to pick a mesh in the scene
  42452. * @param x X position on screen
  42453. * @param y Y position on screen
  42454. * @param predicate Predicate function used to determine eligible meshes. Can be set to null. In this case, a mesh must be enabled, visible and with isPickable set to true
  42455. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  42456. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  42457. * @returns an array of PickingInfo
  42458. */
  42459. multiPick(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, camera?: Camera, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  42460. /**
  42461. * Launch a ray to try to pick a mesh in the scene
  42462. * @param ray Ray to use
  42463. * @param predicate Predicate function used to determine eligible meshes. Can be set to null. In this case, a mesh must be enabled, visible and with isPickable set to true
  42464. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  42465. * @returns an array of PickingInfo
  42466. */
  42467. multiPickWithRay(ray: Ray, predicate: (mesh: AbstractMesh) => boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  42468. /**
  42469. * Force the value of meshUnderPointer
  42470. * @param mesh defines the mesh to use
  42471. */
  42472. setPointerOverMesh(mesh: Nullable<AbstractMesh>): void;
  42473. /**
  42474. * Gets the mesh under the pointer
  42475. * @returns a Mesh or null if no mesh is under the pointer
  42476. */
  42477. getPointerOverMesh(): Nullable<AbstractMesh>;
  42478. /** @hidden */
  42479. _rebuildGeometries(): void;
  42480. /** @hidden */
  42481. _rebuildTextures(): void;
  42482. private _getByTags;
  42483. /**
  42484. * Get a list of meshes by tags
  42485. * @param tagsQuery defines the tags query to use
  42486. * @param forEach defines a predicate used to filter results
  42487. * @returns an array of Mesh
  42488. */
  42489. getMeshesByTags(tagsQuery: string, forEach?: (mesh: AbstractMesh) => void): Mesh[];
  42490. /**
  42491. * Get a list of cameras by tags
  42492. * @param tagsQuery defines the tags query to use
  42493. * @param forEach defines a predicate used to filter results
  42494. * @returns an array of Camera
  42495. */
  42496. getCamerasByTags(tagsQuery: string, forEach?: (camera: Camera) => void): Camera[];
  42497. /**
  42498. * Get a list of lights by tags
  42499. * @param tagsQuery defines the tags query to use
  42500. * @param forEach defines a predicate used to filter results
  42501. * @returns an array of Light
  42502. */
  42503. getLightsByTags(tagsQuery: string, forEach?: (light: Light) => void): Light[];
  42504. /**
  42505. * Get a list of materials by tags
  42506. * @param tagsQuery defines the tags query to use
  42507. * @param forEach defines a predicate used to filter results
  42508. * @returns an array of Material
  42509. */
  42510. getMaterialByTags(tagsQuery: string, forEach?: (material: Material) => void): Material[];
  42511. /**
  42512. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  42513. * This allowed control for front to back rendering or reversly depending of the special needs.
  42514. *
  42515. * @param renderingGroupId The rendering group id corresponding to its index
  42516. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  42517. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  42518. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  42519. */
  42520. setRenderingOrder(renderingGroupId: number, opaqueSortCompareFn?: Nullable<(a: SubMesh, b: SubMesh) => number>, alphaTestSortCompareFn?: Nullable<(a: SubMesh, b: SubMesh) => number>, transparentSortCompareFn?: Nullable<(a: SubMesh, b: SubMesh) => number>): void;
  42521. /**
  42522. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  42523. *
  42524. * @param renderingGroupId The rendering group id corresponding to its index
  42525. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  42526. * @param depth Automatically clears depth between groups if true and autoClear is true.
  42527. * @param stencil Automatically clears stencil between groups if true and autoClear is true.
  42528. */
  42529. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean, depth?: boolean, stencil?: boolean): void;
  42530. /**
  42531. * Gets the current auto clear configuration for one rendering group of the rendering
  42532. * manager.
  42533. * @param index the rendering group index to get the information for
  42534. * @returns The auto clear setup for the requested rendering group
  42535. */
  42536. getAutoClearDepthStencilSetup(index: number): IRenderingManagerAutoClearSetup;
  42537. private _blockMaterialDirtyMechanism;
  42538. /** Gets or sets a boolean blocking all the calls to markAllMaterialsAsDirty (ie. the materials won't be updated if they are out of sync) */
  42539. get blockMaterialDirtyMechanism(): boolean;
  42540. set blockMaterialDirtyMechanism(value: boolean);
  42541. /**
  42542. * Will flag all materials as dirty to trigger new shader compilation
  42543. * @param flag defines the flag used to specify which material part must be marked as dirty
  42544. * @param predicate If not null, it will be used to specifiy if a material has to be marked as dirty
  42545. */
  42546. markAllMaterialsAsDirty(flag: number, predicate?: (mat: Material) => boolean): void;
  42547. /** @hidden */
  42548. _loadFile(url: string, onSuccess: (data: string | ArrayBuffer, responseURL?: string) => void, onProgress?: (ev: ProgressEvent) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean, onError?: (request?: WebRequest, exception?: LoadFileError) => void): IFileRequest;
  42549. /** @hidden */
  42550. _loadFileAsync(url: string, onProgress?: (data: any) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  42551. /** @hidden */
  42552. _requestFile(url: string, onSuccess: (data: string | ArrayBuffer, request?: WebRequest) => void, onProgress?: (ev: ProgressEvent) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean, onError?: (error: RequestFileError) => void, onOpened?: (request: WebRequest) => void): IFileRequest;
  42553. /** @hidden */
  42554. _requestFileAsync(url: string, onProgress?: (ev: ProgressEvent) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean, onOpened?: (request: WebRequest) => void): Promise<string | ArrayBuffer>;
  42555. /** @hidden */
  42556. _readFile(file: File, onSuccess: (data: string | ArrayBuffer) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  42557. /** @hidden */
  42558. _readFileAsync(file: File, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  42559. }
  42560. }
  42561. declare module "babylonjs/assetContainer" {
  42562. import { AbstractScene } from "babylonjs/abstractScene";
  42563. import { Scene } from "babylonjs/scene";
  42564. import { Mesh } from "babylonjs/Meshes/mesh";
  42565. import { TransformNode } from "babylonjs/Meshes/transformNode";
  42566. import { Skeleton } from "babylonjs/Bones/skeleton";
  42567. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  42568. import { Animatable } from "babylonjs/Animations/animatable";
  42569. import { Nullable } from "babylonjs/types";
  42570. import { Node } from "babylonjs/node";
  42571. /**
  42572. * Set of assets to keep when moving a scene into an asset container.
  42573. */
  42574. export class KeepAssets extends AbstractScene {
  42575. }
  42576. /**
  42577. * Class used to store the output of the AssetContainer.instantiateAllMeshesToScene function
  42578. */
  42579. export class InstantiatedEntries {
  42580. /**
  42581. * List of new root nodes (eg. nodes with no parent)
  42582. */
  42583. rootNodes: TransformNode[];
  42584. /**
  42585. * List of new skeletons
  42586. */
  42587. skeletons: Skeleton[];
  42588. /**
  42589. * List of new animation groups
  42590. */
  42591. animationGroups: AnimationGroup[];
  42592. }
  42593. /**
  42594. * Container with a set of assets that can be added or removed from a scene.
  42595. */
  42596. export class AssetContainer extends AbstractScene {
  42597. private _wasAddedToScene;
  42598. /**
  42599. * The scene the AssetContainer belongs to.
  42600. */
  42601. scene: Scene;
  42602. /**
  42603. * Instantiates an AssetContainer.
  42604. * @param scene The scene the AssetContainer belongs to.
  42605. */
  42606. constructor(scene: Scene);
  42607. /**
  42608. * Instantiate or clone all meshes and add the new ones to the scene.
  42609. * Skeletons and animation groups will all be cloned
  42610. * @param nameFunction defines an optional function used to get new names for clones
  42611. * @param cloneMaterials defines an optional boolean that defines if materials must be cloned as well (false by default)
  42612. * @returns a list of rootNodes, skeletons and aniamtion groups that were duplicated
  42613. */
  42614. instantiateModelsToScene(nameFunction?: (sourceName: string) => string, cloneMaterials?: boolean): InstantiatedEntries;
  42615. /**
  42616. * Adds all the assets from the container to the scene.
  42617. */
  42618. addAllToScene(): void;
  42619. /**
  42620. * Removes all the assets in the container from the scene
  42621. */
  42622. removeAllFromScene(): void;
  42623. /**
  42624. * Disposes all the assets in the container
  42625. */
  42626. dispose(): void;
  42627. private _moveAssets;
  42628. /**
  42629. * Removes all the assets contained in the scene and adds them to the container.
  42630. * @param keepAssets Set of assets to keep in the scene. (default: empty)
  42631. */
  42632. moveAllFromScene(keepAssets?: KeepAssets): void;
  42633. /**
  42634. * Adds all meshes in the asset container to a root mesh that can be used to position all the contained meshes. The root mesh is then added to the front of the meshes in the assetContainer.
  42635. * @returns the root mesh
  42636. */
  42637. createRootMesh(): Mesh;
  42638. /**
  42639. * Merge animations (direct and animation groups) from this asset container into a scene
  42640. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  42641. * @param animatables set of animatables to retarget to a node from the scene
  42642. * @param targetConverter defines a function used to convert animation targets from the asset container to the scene (default: search node by name)
  42643. * @returns an array of the new AnimationGroup added to the scene (empty array if none)
  42644. */
  42645. mergeAnimationsTo(scene: Scene | null | undefined, animatables: Animatable[], targetConverter?: Nullable<(target: any) => Nullable<Node>>): AnimationGroup[];
  42646. }
  42647. }
  42648. declare module "babylonjs/abstractScene" {
  42649. import { Scene } from "babylonjs/scene";
  42650. import { Nullable } from "babylonjs/types";
  42651. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  42652. import { TransformNode } from "babylonjs/Meshes/transformNode";
  42653. import { Geometry } from "babylonjs/Meshes/geometry";
  42654. import { Skeleton } from "babylonjs/Bones/skeleton";
  42655. import { MorphTargetManager } from "babylonjs/Morph/morphTargetManager";
  42656. import { AssetContainer } from "babylonjs/assetContainer";
  42657. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  42658. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  42659. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  42660. import { Material } from "babylonjs/Materials/material";
  42661. import { MultiMaterial } from "babylonjs/Materials/multiMaterial";
  42662. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  42663. import { Camera } from "babylonjs/Cameras/camera";
  42664. import { Light } from "babylonjs/Lights/light";
  42665. import { Node } from "babylonjs/node";
  42666. import { Animation } from "babylonjs/Animations/animation";
  42667. /**
  42668. * Defines how the parser contract is defined.
  42669. * These parsers are used to parse a list of specific assets (like particle systems, etc..)
  42670. */
  42671. export type BabylonFileParser = (parsedData: any, scene: Scene, container: AssetContainer, rootUrl: string) => void;
  42672. /**
  42673. * Defines how the individual parser contract is defined.
  42674. * These parser can parse an individual asset
  42675. */
  42676. export type IndividualBabylonFileParser = (parsedData: any, scene: Scene, rootUrl: string) => any;
  42677. /**
  42678. * Base class of the scene acting as a container for the different elements composing a scene.
  42679. * This class is dynamically extended by the different components of the scene increasing
  42680. * flexibility and reducing coupling
  42681. */
  42682. export abstract class AbstractScene {
  42683. /**
  42684. * Stores the list of available parsers in the application.
  42685. */
  42686. private static _BabylonFileParsers;
  42687. /**
  42688. * Stores the list of available individual parsers in the application.
  42689. */
  42690. private static _IndividualBabylonFileParsers;
  42691. /**
  42692. * Adds a parser in the list of available ones
  42693. * @param name Defines the name of the parser
  42694. * @param parser Defines the parser to add
  42695. */
  42696. static AddParser(name: string, parser: BabylonFileParser): void;
  42697. /**
  42698. * Gets a general parser from the list of avaialble ones
  42699. * @param name Defines the name of the parser
  42700. * @returns the requested parser or null
  42701. */
  42702. static GetParser(name: string): Nullable<BabylonFileParser>;
  42703. /**
  42704. * Adds n individual parser in the list of available ones
  42705. * @param name Defines the name of the parser
  42706. * @param parser Defines the parser to add
  42707. */
  42708. static AddIndividualParser(name: string, parser: IndividualBabylonFileParser): void;
  42709. /**
  42710. * Gets an individual parser from the list of avaialble ones
  42711. * @param name Defines the name of the parser
  42712. * @returns the requested parser or null
  42713. */
  42714. static GetIndividualParser(name: string): Nullable<IndividualBabylonFileParser>;
  42715. /**
  42716. * Parser json data and populate both a scene and its associated container object
  42717. * @param jsonData Defines the data to parse
  42718. * @param scene Defines the scene to parse the data for
  42719. * @param container Defines the container attached to the parsing sequence
  42720. * @param rootUrl Defines the root url of the data
  42721. */
  42722. static Parse(jsonData: any, scene: Scene, container: AssetContainer, rootUrl: string): void;
  42723. /**
  42724. * Gets the list of root nodes (ie. nodes with no parent)
  42725. */
  42726. rootNodes: Node[];
  42727. /** All of the cameras added to this scene
  42728. * @see https://doc.babylonjs.com/babylon101/cameras
  42729. */
  42730. cameras: Camera[];
  42731. /**
  42732. * All of the lights added to this scene
  42733. * @see https://doc.babylonjs.com/babylon101/lights
  42734. */
  42735. lights: Light[];
  42736. /**
  42737. * All of the (abstract) meshes added to this scene
  42738. */
  42739. meshes: AbstractMesh[];
  42740. /**
  42741. * The list of skeletons added to the scene
  42742. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  42743. */
  42744. skeletons: Skeleton[];
  42745. /**
  42746. * All of the particle systems added to this scene
  42747. * @see https://doc.babylonjs.com/babylon101/particles
  42748. */
  42749. particleSystems: IParticleSystem[];
  42750. /**
  42751. * Gets a list of Animations associated with the scene
  42752. */
  42753. animations: Animation[];
  42754. /**
  42755. * All of the animation groups added to this scene
  42756. * @see https://doc.babylonjs.com/how_to/group
  42757. */
  42758. animationGroups: AnimationGroup[];
  42759. /**
  42760. * All of the multi-materials added to this scene
  42761. * @see https://doc.babylonjs.com/how_to/multi_materials
  42762. */
  42763. multiMaterials: MultiMaterial[];
  42764. /**
  42765. * All of the materials added to this scene
  42766. * In the context of a Scene, it is not supposed to be modified manually.
  42767. * Any addition or removal should be done using the addMaterial and removeMaterial Scene methods.
  42768. * Note also that the order of the Material within the array is not significant and might change.
  42769. * @see https://doc.babylonjs.com/babylon101/materials
  42770. */
  42771. materials: Material[];
  42772. /**
  42773. * The list of morph target managers added to the scene
  42774. * @see https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh
  42775. */
  42776. morphTargetManagers: MorphTargetManager[];
  42777. /**
  42778. * The list of geometries used in the scene.
  42779. */
  42780. geometries: Geometry[];
  42781. /**
  42782. * All of the tranform nodes added to this scene
  42783. * In the context of a Scene, it is not supposed to be modified manually.
  42784. * Any addition or removal should be done using the addTransformNode and removeTransformNode Scene methods.
  42785. * Note also that the order of the TransformNode wihin the array is not significant and might change.
  42786. * @see https://doc.babylonjs.com/how_to/transformnode
  42787. */
  42788. transformNodes: TransformNode[];
  42789. /**
  42790. * ActionManagers available on the scene.
  42791. */
  42792. actionManagers: AbstractActionManager[];
  42793. /**
  42794. * Textures to keep.
  42795. */
  42796. textures: BaseTexture[];
  42797. /**
  42798. * Environment texture for the scene
  42799. */
  42800. environmentTexture: Nullable<BaseTexture>;
  42801. /**
  42802. * The list of postprocesses added to the scene
  42803. */
  42804. postProcesses: import("babylonjs/PostProcesses/postProcess").PostProcess[];
  42805. /**
  42806. * @returns all meshes, lights, cameras, transformNodes and bones
  42807. */
  42808. getNodes(): Array<Node>;
  42809. }
  42810. }
  42811. declare module "babylonjs/Audio/sound" {
  42812. import { Observable } from "babylonjs/Misc/observable";
  42813. import { Vector3 } from "babylonjs/Maths/math.vector";
  42814. import { Nullable } from "babylonjs/types";
  42815. import { Scene } from "babylonjs/scene";
  42816. import { TransformNode } from "babylonjs/Meshes/transformNode";
  42817. /**
  42818. * Interface used to define options for Sound class
  42819. */
  42820. export interface ISoundOptions {
  42821. /**
  42822. * Does the sound autoplay once loaded.
  42823. */
  42824. autoplay?: boolean;
  42825. /**
  42826. * Does the sound loop after it finishes playing once.
  42827. */
  42828. loop?: boolean;
  42829. /**
  42830. * Sound's volume
  42831. */
  42832. volume?: number;
  42833. /**
  42834. * Is it a spatial sound?
  42835. */
  42836. spatialSound?: boolean;
  42837. /**
  42838. * Maximum distance to hear that sound
  42839. */
  42840. maxDistance?: number;
  42841. /**
  42842. * Uses user defined attenuation function
  42843. */
  42844. useCustomAttenuation?: boolean;
  42845. /**
  42846. * Define the roll off factor of spatial sounds.
  42847. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  42848. */
  42849. rolloffFactor?: number;
  42850. /**
  42851. * Define the reference distance the sound should be heard perfectly.
  42852. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  42853. */
  42854. refDistance?: number;
  42855. /**
  42856. * Define the distance attenuation model the sound will follow.
  42857. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  42858. */
  42859. distanceModel?: string;
  42860. /**
  42861. * Defines the playback speed (1 by default)
  42862. */
  42863. playbackRate?: number;
  42864. /**
  42865. * Defines if the sound is from a streaming source
  42866. */
  42867. streaming?: boolean;
  42868. /**
  42869. * Defines an optional length (in seconds) inside the sound file
  42870. */
  42871. length?: number;
  42872. /**
  42873. * Defines an optional offset (in seconds) inside the sound file
  42874. */
  42875. offset?: number;
  42876. /**
  42877. * If true, URLs will not be required to state the audio file codec to use.
  42878. */
  42879. skipCodecCheck?: boolean;
  42880. }
  42881. /**
  42882. * Defines a sound that can be played in the application.
  42883. * The sound can either be an ambient track or a simple sound played in reaction to a user action.
  42884. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  42885. */
  42886. export class Sound {
  42887. /**
  42888. * The name of the sound in the scene.
  42889. */
  42890. name: string;
  42891. /**
  42892. * Does the sound autoplay once loaded.
  42893. */
  42894. autoplay: boolean;
  42895. /**
  42896. * Does the sound loop after it finishes playing once.
  42897. */
  42898. loop: boolean;
  42899. /**
  42900. * Does the sound use a custom attenuation curve to simulate the falloff
  42901. * happening when the source gets further away from the camera.
  42902. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-your-own-custom-attenuation-function
  42903. */
  42904. useCustomAttenuation: boolean;
  42905. /**
  42906. * The sound track id this sound belongs to.
  42907. */
  42908. soundTrackId: number;
  42909. /**
  42910. * Is this sound currently played.
  42911. */
  42912. isPlaying: boolean;
  42913. /**
  42914. * Is this sound currently paused.
  42915. */
  42916. isPaused: boolean;
  42917. /**
  42918. * Does this sound enables spatial sound.
  42919. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  42920. */
  42921. spatialSound: boolean;
  42922. /**
  42923. * Define the reference distance the sound should be heard perfectly.
  42924. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  42925. */
  42926. refDistance: number;
  42927. /**
  42928. * Define the roll off factor of spatial sounds.
  42929. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  42930. */
  42931. rolloffFactor: number;
  42932. /**
  42933. * Define the max distance the sound should be heard (intensity just became 0 at this point).
  42934. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  42935. */
  42936. maxDistance: number;
  42937. /**
  42938. * Define the distance attenuation model the sound will follow.
  42939. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  42940. */
  42941. distanceModel: string;
  42942. /**
  42943. * @hidden
  42944. * Back Compat
  42945. **/
  42946. onended: () => any;
  42947. /**
  42948. * Gets or sets an object used to store user defined information for the sound.
  42949. */
  42950. metadata: any;
  42951. /**
  42952. * Observable event when the current playing sound finishes.
  42953. */
  42954. onEndedObservable: Observable<Sound>;
  42955. private _panningModel;
  42956. private _playbackRate;
  42957. private _streaming;
  42958. private _startTime;
  42959. private _startOffset;
  42960. private _position;
  42961. /** @hidden */
  42962. _positionInEmitterSpace: boolean;
  42963. private _localDirection;
  42964. private _volume;
  42965. private _isReadyToPlay;
  42966. private _isDirectional;
  42967. private _readyToPlayCallback;
  42968. private _audioBuffer;
  42969. private _soundSource;
  42970. private _streamingSource;
  42971. private _soundPanner;
  42972. private _soundGain;
  42973. private _inputAudioNode;
  42974. private _outputAudioNode;
  42975. private _coneInnerAngle;
  42976. private _coneOuterAngle;
  42977. private _coneOuterGain;
  42978. private _scene;
  42979. private _connectedTransformNode;
  42980. private _customAttenuationFunction;
  42981. private _registerFunc;
  42982. private _isOutputConnected;
  42983. private _htmlAudioElement;
  42984. private _urlType;
  42985. private _length?;
  42986. private _offset?;
  42987. /** @hidden */
  42988. static _SceneComponentInitialization: (scene: Scene) => void;
  42989. /**
  42990. * Create a sound and attach it to a scene
  42991. * @param name Name of your sound
  42992. * @param urlOrArrayBuffer Url to the sound to load async or ArrayBuffer, it also works with MediaStreams
  42993. * @param scene defines the scene the sound belongs to
  42994. * @param readyToPlayCallback Provide a callback function if you'd like to load your code once the sound is ready to be played
  42995. * @param options Objects to provide with the current available options: autoplay, loop, volume, spatialSound, maxDistance, rolloffFactor, refDistance, distanceModel, panningModel, streaming
  42996. */
  42997. constructor(name: string, urlOrArrayBuffer: any, scene: Scene, readyToPlayCallback?: Nullable<() => void>, options?: ISoundOptions);
  42998. /**
  42999. * Release the sound and its associated resources
  43000. */
  43001. dispose(): void;
  43002. /**
  43003. * Gets if the sounds is ready to be played or not.
  43004. * @returns true if ready, otherwise false
  43005. */
  43006. isReady(): boolean;
  43007. private _soundLoaded;
  43008. /**
  43009. * Sets the data of the sound from an audiobuffer
  43010. * @param audioBuffer The audioBuffer containing the data
  43011. */
  43012. setAudioBuffer(audioBuffer: AudioBuffer): void;
  43013. /**
  43014. * Updates the current sounds options such as maxdistance, loop...
  43015. * @param options A JSON object containing values named as the object properties
  43016. */
  43017. updateOptions(options: ISoundOptions): void;
  43018. private _createSpatialParameters;
  43019. private _updateSpatialParameters;
  43020. /**
  43021. * Switch the panning model to HRTF:
  43022. * Renders a stereo output of higher quality than equalpower — it uses a convolution with measured impulse responses from human subjects.
  43023. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  43024. */
  43025. switchPanningModelToHRTF(): void;
  43026. /**
  43027. * Switch the panning model to Equal Power:
  43028. * Represents the equal-power panning algorithm, generally regarded as simple and efficient. equalpower is the default value.
  43029. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  43030. */
  43031. switchPanningModelToEqualPower(): void;
  43032. private _switchPanningModel;
  43033. /**
  43034. * Connect this sound to a sound track audio node like gain...
  43035. * @param soundTrackAudioNode the sound track audio node to connect to
  43036. */
  43037. connectToSoundTrackAudioNode(soundTrackAudioNode: AudioNode): void;
  43038. /**
  43039. * Transform this sound into a directional source
  43040. * @param coneInnerAngle Size of the inner cone in degree
  43041. * @param coneOuterAngle Size of the outer cone in degree
  43042. * @param coneOuterGain Volume of the sound outside the outer cone (between 0.0 and 1.0)
  43043. */
  43044. setDirectionalCone(coneInnerAngle: number, coneOuterAngle: number, coneOuterGain: number): void;
  43045. /**
  43046. * Gets or sets the inner angle for the directional cone.
  43047. */
  43048. get directionalConeInnerAngle(): number;
  43049. /**
  43050. * Gets or sets the inner angle for the directional cone.
  43051. */
  43052. set directionalConeInnerAngle(value: number);
  43053. /**
  43054. * Gets or sets the outer angle for the directional cone.
  43055. */
  43056. get directionalConeOuterAngle(): number;
  43057. /**
  43058. * Gets or sets the outer angle for the directional cone.
  43059. */
  43060. set directionalConeOuterAngle(value: number);
  43061. /**
  43062. * Sets the position of the emitter if spatial sound is enabled
  43063. * @param newPosition Defines the new posisiton
  43064. */
  43065. setPosition(newPosition: Vector3): void;
  43066. /**
  43067. * Sets the local direction of the emitter if spatial sound is enabled
  43068. * @param newLocalDirection Defines the new local direction
  43069. */
  43070. setLocalDirectionToMesh(newLocalDirection: Vector3): void;
  43071. private _updateDirection;
  43072. /** @hidden */
  43073. updateDistanceFromListener(): void;
  43074. /**
  43075. * Sets a new custom attenuation function for the sound.
  43076. * @param callback Defines the function used for the attenuation
  43077. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-your-own-custom-attenuation-function
  43078. */
  43079. setAttenuationFunction(callback: (currentVolume: number, currentDistance: number, maxDistance: number, refDistance: number, rolloffFactor: number) => number): void;
  43080. /**
  43081. * Play the sound
  43082. * @param time (optional) Start the sound after X seconds. Start immediately (0) by default.
  43083. * @param offset (optional) Start the sound at a specific time in seconds
  43084. * @param length (optional) Sound duration (in seconds)
  43085. */
  43086. play(time?: number, offset?: number, length?: number): void;
  43087. private _onended;
  43088. /**
  43089. * Stop the sound
  43090. * @param time (optional) Stop the sound after X seconds. Stop immediately (0) by default.
  43091. */
  43092. stop(time?: number): void;
  43093. /**
  43094. * Put the sound in pause
  43095. */
  43096. pause(): void;
  43097. /**
  43098. * Sets a dedicated volume for this sounds
  43099. * @param newVolume Define the new volume of the sound
  43100. * @param time Define time for gradual change to new volume
  43101. */
  43102. setVolume(newVolume: number, time?: number): void;
  43103. /**
  43104. * Set the sound play back rate
  43105. * @param newPlaybackRate Define the playback rate the sound should be played at
  43106. */
  43107. setPlaybackRate(newPlaybackRate: number): void;
  43108. /**
  43109. * Gets the volume of the sound.
  43110. * @returns the volume of the sound
  43111. */
  43112. getVolume(): number;
  43113. /**
  43114. * Attach the sound to a dedicated mesh
  43115. * @param transformNode The transform node to connect the sound with
  43116. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#attaching-a-sound-to-a-mesh
  43117. */
  43118. attachToMesh(transformNode: TransformNode): void;
  43119. /**
  43120. * Detach the sound from the previously attached mesh
  43121. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#attaching-a-sound-to-a-mesh
  43122. */
  43123. detachFromMesh(): void;
  43124. private _onRegisterAfterWorldMatrixUpdate;
  43125. /**
  43126. * Clone the current sound in the scene.
  43127. * @returns the new sound clone
  43128. */
  43129. clone(): Nullable<Sound>;
  43130. /**
  43131. * Gets the current underlying audio buffer containing the data
  43132. * @returns the audio buffer
  43133. */
  43134. getAudioBuffer(): Nullable<AudioBuffer>;
  43135. /**
  43136. * Gets the WebAudio AudioBufferSourceNode, lets you keep track of and stop instances of this Sound.
  43137. * @returns the source node
  43138. */
  43139. getSoundSource(): Nullable<AudioBufferSourceNode>;
  43140. /**
  43141. * Gets the WebAudio GainNode, gives you precise control over the gain of instances of this Sound.
  43142. * @returns the gain node
  43143. */
  43144. getSoundGain(): Nullable<GainNode>;
  43145. /**
  43146. * Serializes the Sound in a JSON representation
  43147. * @returns the JSON representation of the sound
  43148. */
  43149. serialize(): any;
  43150. /**
  43151. * Parse a JSON representation of a sound to innstantiate in a given scene
  43152. * @param parsedSound Define the JSON representation of the sound (usually coming from the serialize method)
  43153. * @param scene Define the scene the new parsed sound should be created in
  43154. * @param rootUrl Define the rooturl of the load in case we need to fetch relative dependencies
  43155. * @param sourceSound Define a cound place holder if do not need to instantiate a new one
  43156. * @returns the newly parsed sound
  43157. */
  43158. static Parse(parsedSound: any, scene: Scene, rootUrl: string, sourceSound?: Sound): Sound;
  43159. }
  43160. }
  43161. declare module "babylonjs/Actions/directAudioActions" {
  43162. import { Action } from "babylonjs/Actions/action";
  43163. import { Condition } from "babylonjs/Actions/condition";
  43164. import { Sound } from "babylonjs/Audio/sound";
  43165. /**
  43166. * This defines an action helpful to play a defined sound on a triggered action.
  43167. */
  43168. export class PlaySoundAction extends Action {
  43169. private _sound;
  43170. /**
  43171. * Instantiate the action
  43172. * @param triggerOptions defines the trigger options
  43173. * @param sound defines the sound to play
  43174. * @param condition defines the trigger related conditions
  43175. */
  43176. constructor(triggerOptions: any, sound: Sound, condition?: Condition);
  43177. /** @hidden */
  43178. _prepare(): void;
  43179. /**
  43180. * Execute the action and play the sound.
  43181. */
  43182. execute(): void;
  43183. /**
  43184. * Serializes the actions and its related information.
  43185. * @param parent defines the object to serialize in
  43186. * @returns the serialized object
  43187. */
  43188. serialize(parent: any): any;
  43189. }
  43190. /**
  43191. * This defines an action helpful to stop a defined sound on a triggered action.
  43192. */
  43193. export class StopSoundAction extends Action {
  43194. private _sound;
  43195. /**
  43196. * Instantiate the action
  43197. * @param triggerOptions defines the trigger options
  43198. * @param sound defines the sound to stop
  43199. * @param condition defines the trigger related conditions
  43200. */
  43201. constructor(triggerOptions: any, sound: Sound, condition?: Condition);
  43202. /** @hidden */
  43203. _prepare(): void;
  43204. /**
  43205. * Execute the action and stop the sound.
  43206. */
  43207. execute(): void;
  43208. /**
  43209. * Serializes the actions and its related information.
  43210. * @param parent defines the object to serialize in
  43211. * @returns the serialized object
  43212. */
  43213. serialize(parent: any): any;
  43214. }
  43215. }
  43216. declare module "babylonjs/Actions/interpolateValueAction" {
  43217. import { Action } from "babylonjs/Actions/action";
  43218. import { Condition } from "babylonjs/Actions/condition";
  43219. import { Observable } from "babylonjs/Misc/observable";
  43220. /**
  43221. * This defines an action responsible to change the value of a property
  43222. * by interpolating between its current value and the newly set one once triggered.
  43223. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  43224. */
  43225. export class InterpolateValueAction extends Action {
  43226. /**
  43227. * Defines the path of the property where the value should be interpolated
  43228. */
  43229. propertyPath: string;
  43230. /**
  43231. * Defines the target value at the end of the interpolation.
  43232. */
  43233. value: any;
  43234. /**
  43235. * Defines the time it will take for the property to interpolate to the value.
  43236. */
  43237. duration: number;
  43238. /**
  43239. * Defines if the other scene animations should be stopped when the action has been triggered
  43240. */
  43241. stopOtherAnimations?: boolean;
  43242. /**
  43243. * Defines a callback raised once the interpolation animation has been done.
  43244. */
  43245. onInterpolationDone?: () => void;
  43246. /**
  43247. * Observable triggered once the interpolation animation has been done.
  43248. */
  43249. onInterpolationDoneObservable: Observable<InterpolateValueAction>;
  43250. private _target;
  43251. private _effectiveTarget;
  43252. private _property;
  43253. /**
  43254. * Instantiate the action
  43255. * @param triggerOptions defines the trigger options
  43256. * @param target defines the object containing the value to interpolate
  43257. * @param propertyPath defines the path to the property in the target object
  43258. * @param value defines the target value at the end of the interpolation
  43259. * @param duration deines the time it will take for the property to interpolate to the value.
  43260. * @param condition defines the trigger related conditions
  43261. * @param stopOtherAnimations defines if the other scene animations should be stopped when the action has been triggered
  43262. * @param onInterpolationDone defines a callback raised once the interpolation animation has been done
  43263. */
  43264. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, duration?: number, condition?: Condition, stopOtherAnimations?: boolean, onInterpolationDone?: () => void);
  43265. /** @hidden */
  43266. _prepare(): void;
  43267. /**
  43268. * Execute the action starts the value interpolation.
  43269. */
  43270. execute(): void;
  43271. /**
  43272. * Serializes the actions and its related information.
  43273. * @param parent defines the object to serialize in
  43274. * @returns the serialized object
  43275. */
  43276. serialize(parent: any): any;
  43277. }
  43278. }
  43279. declare module "babylonjs/Actions/index" {
  43280. export * from "babylonjs/Actions/abstractActionManager";
  43281. export * from "babylonjs/Actions/action";
  43282. export * from "babylonjs/Actions/actionEvent";
  43283. export * from "babylonjs/Actions/actionManager";
  43284. export * from "babylonjs/Actions/condition";
  43285. export * from "babylonjs/Actions/directActions";
  43286. export * from "babylonjs/Actions/directAudioActions";
  43287. export * from "babylonjs/Actions/interpolateValueAction";
  43288. }
  43289. declare module "babylonjs/Animations/index" {
  43290. export * from "babylonjs/Animations/animatable";
  43291. export * from "babylonjs/Animations/animation";
  43292. export * from "babylonjs/Animations/animationGroup";
  43293. export * from "babylonjs/Animations/animationPropertiesOverride";
  43294. export * from "babylonjs/Animations/easing";
  43295. export * from "babylonjs/Animations/runtimeAnimation";
  43296. export * from "babylonjs/Animations/animationEvent";
  43297. export * from "babylonjs/Animations/animationGroup";
  43298. export * from "babylonjs/Animations/animationKey";
  43299. export * from "babylonjs/Animations/animationRange";
  43300. export * from "babylonjs/Animations/animatable.interface";
  43301. }
  43302. declare module "babylonjs/Audio/soundTrack" {
  43303. import { Sound } from "babylonjs/Audio/sound";
  43304. import { Analyser } from "babylonjs/Audio/analyser";
  43305. import { Scene } from "babylonjs/scene";
  43306. /**
  43307. * Options allowed during the creation of a sound track.
  43308. */
  43309. export interface ISoundTrackOptions {
  43310. /**
  43311. * The volume the sound track should take during creation
  43312. */
  43313. volume?: number;
  43314. /**
  43315. * Define if the sound track is the main sound track of the scene
  43316. */
  43317. mainTrack?: boolean;
  43318. }
  43319. /**
  43320. * It could be useful to isolate your music & sounds on several tracks to better manage volume on a grouped instance of sounds.
  43321. * It will be also used in a future release to apply effects on a specific track.
  43322. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-sound-tracks
  43323. */
  43324. export class SoundTrack {
  43325. /**
  43326. * The unique identifier of the sound track in the scene.
  43327. */
  43328. id: number;
  43329. /**
  43330. * The list of sounds included in the sound track.
  43331. */
  43332. soundCollection: Array<Sound>;
  43333. private _outputAudioNode;
  43334. private _scene;
  43335. private _connectedAnalyser;
  43336. private _options;
  43337. private _isInitialized;
  43338. /**
  43339. * Creates a new sound track.
  43340. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-sound-tracks
  43341. * @param scene Define the scene the sound track belongs to
  43342. * @param options
  43343. */
  43344. constructor(scene: Scene, options?: ISoundTrackOptions);
  43345. private _initializeSoundTrackAudioGraph;
  43346. /**
  43347. * Release the sound track and its associated resources
  43348. */
  43349. dispose(): void;
  43350. /**
  43351. * Adds a sound to this sound track
  43352. * @param sound define the cound to add
  43353. * @ignoreNaming
  43354. */
  43355. AddSound(sound: Sound): void;
  43356. /**
  43357. * Removes a sound to this sound track
  43358. * @param sound define the cound to remove
  43359. * @ignoreNaming
  43360. */
  43361. RemoveSound(sound: Sound): void;
  43362. /**
  43363. * Set a global volume for the full sound track.
  43364. * @param newVolume Define the new volume of the sound track
  43365. */
  43366. setVolume(newVolume: number): void;
  43367. /**
  43368. * Switch the panning model to HRTF:
  43369. * Renders a stereo output of higher quality than equalpower — it uses a convolution with measured impulse responses from human subjects.
  43370. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  43371. */
  43372. switchPanningModelToHRTF(): void;
  43373. /**
  43374. * Switch the panning model to Equal Power:
  43375. * Represents the equal-power panning algorithm, generally regarded as simple and efficient. equalpower is the default value.
  43376. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  43377. */
  43378. switchPanningModelToEqualPower(): void;
  43379. /**
  43380. * Connect the sound track to an audio analyser allowing some amazing
  43381. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  43382. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  43383. * @param analyser The analyser to connect to the engine
  43384. */
  43385. connectToAnalyser(analyser: Analyser): void;
  43386. }
  43387. }
  43388. declare module "babylonjs/Audio/audioSceneComponent" {
  43389. import { Sound } from "babylonjs/Audio/sound";
  43390. import { SoundTrack } from "babylonjs/Audio/soundTrack";
  43391. import { Nullable } from "babylonjs/types";
  43392. import { Vector3 } from "babylonjs/Maths/math.vector";
  43393. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  43394. import { Scene } from "babylonjs/scene";
  43395. import { AbstractScene } from "babylonjs/abstractScene";
  43396. import "babylonjs/Audio/audioEngine";
  43397. module "babylonjs/abstractScene" {
  43398. interface AbstractScene {
  43399. /**
  43400. * The list of sounds used in the scene.
  43401. */
  43402. sounds: Nullable<Array<Sound>>;
  43403. }
  43404. }
  43405. module "babylonjs/scene" {
  43406. interface Scene {
  43407. /**
  43408. * @hidden
  43409. * Backing field
  43410. */
  43411. _mainSoundTrack: SoundTrack;
  43412. /**
  43413. * The main sound track played by the scene.
  43414. * It cotains your primary collection of sounds.
  43415. */
  43416. mainSoundTrack: SoundTrack;
  43417. /**
  43418. * The list of sound tracks added to the scene
  43419. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  43420. */
  43421. soundTracks: Nullable<Array<SoundTrack>>;
  43422. /**
  43423. * Gets a sound using a given name
  43424. * @param name defines the name to search for
  43425. * @return the found sound or null if not found at all.
  43426. */
  43427. getSoundByName(name: string): Nullable<Sound>;
  43428. /**
  43429. * Gets or sets if audio support is enabled
  43430. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  43431. */
  43432. audioEnabled: boolean;
  43433. /**
  43434. * Gets or sets if audio will be output to headphones
  43435. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  43436. */
  43437. headphone: boolean;
  43438. /**
  43439. * Gets or sets custom audio listener position provider
  43440. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  43441. */
  43442. audioListenerPositionProvider: Nullable<() => Vector3>;
  43443. /**
  43444. * Gets or sets a refresh rate when using 3D audio positioning
  43445. */
  43446. audioPositioningRefreshRate: number;
  43447. }
  43448. }
  43449. /**
  43450. * Defines the sound scene component responsible to manage any sounds
  43451. * in a given scene.
  43452. */
  43453. export class AudioSceneComponent implements ISceneSerializableComponent {
  43454. /**
  43455. * The component name helpfull to identify the component in the list of scene components.
  43456. */
  43457. readonly name: string;
  43458. /**
  43459. * The scene the component belongs to.
  43460. */
  43461. scene: Scene;
  43462. private _audioEnabled;
  43463. /**
  43464. * Gets whether audio is enabled or not.
  43465. * Please use related enable/disable method to switch state.
  43466. */
  43467. get audioEnabled(): boolean;
  43468. private _headphone;
  43469. /**
  43470. * Gets whether audio is outputing to headphone or not.
  43471. * Please use the according Switch methods to change output.
  43472. */
  43473. get headphone(): boolean;
  43474. /**
  43475. * Gets or sets a refresh rate when using 3D audio positioning
  43476. */
  43477. audioPositioningRefreshRate: number;
  43478. private _audioListenerPositionProvider;
  43479. /**
  43480. * Gets the current audio listener position provider
  43481. */
  43482. get audioListenerPositionProvider(): Nullable<() => Vector3>;
  43483. /**
  43484. * Sets a custom listener position for all sounds in the scene
  43485. * By default, this is the position of the first active camera
  43486. */
  43487. set audioListenerPositionProvider(value: Nullable<() => Vector3>);
  43488. /**
  43489. * Creates a new instance of the component for the given scene
  43490. * @param scene Defines the scene to register the component in
  43491. */
  43492. constructor(scene: Scene);
  43493. /**
  43494. * Registers the component in a given scene
  43495. */
  43496. register(): void;
  43497. /**
  43498. * Rebuilds the elements related to this component in case of
  43499. * context lost for instance.
  43500. */
  43501. rebuild(): void;
  43502. /**
  43503. * Serializes the component data to the specified json object
  43504. * @param serializationObject The object to serialize to
  43505. */
  43506. serialize(serializationObject: any): void;
  43507. /**
  43508. * Adds all the elements from the container to the scene
  43509. * @param container the container holding the elements
  43510. */
  43511. addFromContainer(container: AbstractScene): void;
  43512. /**
  43513. * Removes all the elements in the container from the scene
  43514. * @param container contains the elements to remove
  43515. * @param dispose if the removed element should be disposed (default: false)
  43516. */
  43517. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  43518. /**
  43519. * Disposes the component and the associated ressources.
  43520. */
  43521. dispose(): void;
  43522. /**
  43523. * Disables audio in the associated scene.
  43524. */
  43525. disableAudio(): void;
  43526. /**
  43527. * Enables audio in the associated scene.
  43528. */
  43529. enableAudio(): void;
  43530. /**
  43531. * Switch audio to headphone output.
  43532. */
  43533. switchAudioModeForHeadphones(): void;
  43534. /**
  43535. * Switch audio to normal speakers.
  43536. */
  43537. switchAudioModeForNormalSpeakers(): void;
  43538. private _cachedCameraDirection;
  43539. private _cachedCameraPosition;
  43540. private _lastCheck;
  43541. private _afterRender;
  43542. }
  43543. }
  43544. declare module "babylonjs/Audio/weightedsound" {
  43545. import { Sound } from "babylonjs/Audio/sound";
  43546. /**
  43547. * Wraps one or more Sound objects and selects one with random weight for playback.
  43548. */
  43549. export class WeightedSound {
  43550. /** When true a Sound will be selected and played when the current playing Sound completes. */
  43551. loop: boolean;
  43552. private _coneInnerAngle;
  43553. private _coneOuterAngle;
  43554. private _volume;
  43555. /** A Sound is currently playing. */
  43556. isPlaying: boolean;
  43557. /** A Sound is currently paused. */
  43558. isPaused: boolean;
  43559. private _sounds;
  43560. private _weights;
  43561. private _currentIndex?;
  43562. /**
  43563. * Creates a new WeightedSound from the list of sounds given.
  43564. * @param loop When true a Sound will be selected and played when the current playing Sound completes.
  43565. * @param sounds Array of Sounds that will be selected from.
  43566. * @param weights Array of number values for selection weights; length must equal sounds, values will be normalized to 1
  43567. */
  43568. constructor(loop: boolean, sounds: Sound[], weights: number[]);
  43569. /**
  43570. * The size of cone in degrees for a directional sound in which there will be no attenuation.
  43571. */
  43572. get directionalConeInnerAngle(): number;
  43573. /**
  43574. * The size of cone in degress for a directional sound in which there will be no attenuation.
  43575. */
  43576. set directionalConeInnerAngle(value: number);
  43577. /**
  43578. * Size of cone in degrees for a directional sound outside of which there will be no sound.
  43579. * Listener angles between innerAngle and outerAngle will falloff linearly.
  43580. */
  43581. get directionalConeOuterAngle(): number;
  43582. /**
  43583. * Size of cone in degrees for a directional sound outside of which there will be no sound.
  43584. * Listener angles between innerAngle and outerAngle will falloff linearly.
  43585. */
  43586. set directionalConeOuterAngle(value: number);
  43587. /**
  43588. * Playback volume.
  43589. */
  43590. get volume(): number;
  43591. /**
  43592. * Playback volume.
  43593. */
  43594. set volume(value: number);
  43595. private _onended;
  43596. /**
  43597. * Suspend playback
  43598. */
  43599. pause(): void;
  43600. /**
  43601. * Stop playback
  43602. */
  43603. stop(): void;
  43604. /**
  43605. * Start playback.
  43606. * @param startOffset Position the clip head at a specific time in seconds.
  43607. */
  43608. play(startOffset?: number): void;
  43609. }
  43610. }
  43611. declare module "babylonjs/Audio/index" {
  43612. export * from "babylonjs/Audio/analyser";
  43613. export * from "babylonjs/Audio/audioEngine";
  43614. export * from "babylonjs/Audio/audioSceneComponent";
  43615. export * from "babylonjs/Audio/sound";
  43616. export * from "babylonjs/Audio/soundTrack";
  43617. export * from "babylonjs/Audio/weightedsound";
  43618. }
  43619. declare module "babylonjs/Behaviors/Cameras/bouncingBehavior" {
  43620. import { Behavior } from "babylonjs/Behaviors/behavior";
  43621. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  43622. import { BackEase } from "babylonjs/Animations/easing";
  43623. /**
  43624. * Add a bouncing effect to an ArcRotateCamera when reaching a specified minimum and maximum radius
  43625. * @see https://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  43626. */
  43627. export class BouncingBehavior implements Behavior<ArcRotateCamera> {
  43628. /**
  43629. * Gets the name of the behavior.
  43630. */
  43631. get name(): string;
  43632. /**
  43633. * The easing function used by animations
  43634. */
  43635. static EasingFunction: BackEase;
  43636. /**
  43637. * The easing mode used by animations
  43638. */
  43639. static EasingMode: number;
  43640. /**
  43641. * The duration of the animation, in milliseconds
  43642. */
  43643. transitionDuration: number;
  43644. /**
  43645. * Length of the distance animated by the transition when lower radius is reached
  43646. */
  43647. lowerRadiusTransitionRange: number;
  43648. /**
  43649. * Length of the distance animated by the transition when upper radius is reached
  43650. */
  43651. upperRadiusTransitionRange: number;
  43652. private _autoTransitionRange;
  43653. /**
  43654. * Gets a value indicating if the lowerRadiusTransitionRange and upperRadiusTransitionRange are defined automatically
  43655. */
  43656. get autoTransitionRange(): boolean;
  43657. /**
  43658. * Sets a value indicating if the lowerRadiusTransitionRange and upperRadiusTransitionRange are defined automatically
  43659. * Transition ranges will be set to 5% of the bounding box diagonal in world space
  43660. */
  43661. set autoTransitionRange(value: boolean);
  43662. private _attachedCamera;
  43663. private _onAfterCheckInputsObserver;
  43664. private _onMeshTargetChangedObserver;
  43665. /**
  43666. * Initializes the behavior.
  43667. */
  43668. init(): void;
  43669. /**
  43670. * Attaches the behavior to its arc rotate camera.
  43671. * @param camera Defines the camera to attach the behavior to
  43672. */
  43673. attach(camera: ArcRotateCamera): void;
  43674. /**
  43675. * Detaches the behavior from its current arc rotate camera.
  43676. */
  43677. detach(): void;
  43678. private _radiusIsAnimating;
  43679. private _radiusBounceTransition;
  43680. private _animatables;
  43681. private _cachedWheelPrecision;
  43682. /**
  43683. * Checks if the camera radius is at the specified limit. Takes into account animation locks.
  43684. * @param radiusLimit The limit to check against.
  43685. * @return Bool to indicate if at limit.
  43686. */
  43687. private _isRadiusAtLimit;
  43688. /**
  43689. * Applies an animation to the radius of the camera, extending by the radiusDelta.
  43690. * @param radiusDelta The delta by which to animate to. Can be negative.
  43691. */
  43692. private _applyBoundRadiusAnimation;
  43693. /**
  43694. * Removes all animation locks. Allows new animations to be added to any of the camera properties.
  43695. */
  43696. protected _clearAnimationLocks(): void;
  43697. /**
  43698. * Stops and removes all animations that have been applied to the camera
  43699. */
  43700. stopAllAnimations(): void;
  43701. }
  43702. }
  43703. declare module "babylonjs/Behaviors/Cameras/framingBehavior" {
  43704. import { Behavior } from "babylonjs/Behaviors/behavior";
  43705. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  43706. import { ExponentialEase } from "babylonjs/Animations/easing";
  43707. import { Nullable } from "babylonjs/types";
  43708. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  43709. import { Vector3 } from "babylonjs/Maths/math.vector";
  43710. /**
  43711. * The framing behavior (FramingBehavior) is designed to automatically position an ArcRotateCamera when its target is set to a mesh. It is also useful if you want to prevent the camera to go under a virtual horizontal plane.
  43712. * @see https://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  43713. */
  43714. export class FramingBehavior implements Behavior<ArcRotateCamera> {
  43715. /**
  43716. * Gets the name of the behavior.
  43717. */
  43718. get name(): string;
  43719. private _mode;
  43720. private _radiusScale;
  43721. private _positionScale;
  43722. private _defaultElevation;
  43723. private _elevationReturnTime;
  43724. private _elevationReturnWaitTime;
  43725. private _zoomStopsAnimation;
  43726. private _framingTime;
  43727. /**
  43728. * The easing function used by animations
  43729. */
  43730. static EasingFunction: ExponentialEase;
  43731. /**
  43732. * The easing mode used by animations
  43733. */
  43734. static EasingMode: number;
  43735. /**
  43736. * Sets the current mode used by the behavior
  43737. */
  43738. set mode(mode: number);
  43739. /**
  43740. * Gets current mode used by the behavior.
  43741. */
  43742. get mode(): number;
  43743. /**
  43744. * Sets the scale applied to the radius (1 by default)
  43745. */
  43746. set radiusScale(radius: number);
  43747. /**
  43748. * Gets the scale applied to the radius
  43749. */
  43750. get radiusScale(): number;
  43751. /**
  43752. * Sets the scale to apply on Y axis to position camera focus. 0.5 by default which means the center of the bounding box.
  43753. */
  43754. set positionScale(scale: number);
  43755. /**
  43756. * Gets the scale to apply on Y axis to position camera focus. 0.5 by default which means the center of the bounding box.
  43757. */
  43758. get positionScale(): number;
  43759. /**
  43760. * Sets the angle above/below the horizontal plane to return to when the return to default elevation idle
  43761. * behaviour is triggered, in radians.
  43762. */
  43763. set defaultElevation(elevation: number);
  43764. /**
  43765. * Gets the angle above/below the horizontal plane to return to when the return to default elevation idle
  43766. * behaviour is triggered, in radians.
  43767. */
  43768. get defaultElevation(): number;
  43769. /**
  43770. * Sets the time (in milliseconds) taken to return to the default beta position.
  43771. * Negative value indicates camera should not return to default.
  43772. */
  43773. set elevationReturnTime(speed: number);
  43774. /**
  43775. * Gets the time (in milliseconds) taken to return to the default beta position.
  43776. * Negative value indicates camera should not return to default.
  43777. */
  43778. get elevationReturnTime(): number;
  43779. /**
  43780. * Sets the delay (in milliseconds) taken before the camera returns to the default beta position.
  43781. */
  43782. set elevationReturnWaitTime(time: number);
  43783. /**
  43784. * Gets the delay (in milliseconds) taken before the camera returns to the default beta position.
  43785. */
  43786. get elevationReturnWaitTime(): number;
  43787. /**
  43788. * Sets the flag that indicates if user zooming should stop animation.
  43789. */
  43790. set zoomStopsAnimation(flag: boolean);
  43791. /**
  43792. * Gets the flag that indicates if user zooming should stop animation.
  43793. */
  43794. get zoomStopsAnimation(): boolean;
  43795. /**
  43796. * Sets the transition time when framing the mesh, in milliseconds
  43797. */
  43798. set framingTime(time: number);
  43799. /**
  43800. * Gets the transition time when framing the mesh, in milliseconds
  43801. */
  43802. get framingTime(): number;
  43803. /**
  43804. * Define if the behavior should automatically change the configured
  43805. * camera limits and sensibilities.
  43806. */
  43807. autoCorrectCameraLimitsAndSensibility: boolean;
  43808. private _onPrePointerObservableObserver;
  43809. private _onAfterCheckInputsObserver;
  43810. private _onMeshTargetChangedObserver;
  43811. private _attachedCamera;
  43812. private _isPointerDown;
  43813. private _lastInteractionTime;
  43814. /**
  43815. * Initializes the behavior.
  43816. */
  43817. init(): void;
  43818. /**
  43819. * Attaches the behavior to its arc rotate camera.
  43820. * @param camera Defines the camera to attach the behavior to
  43821. */
  43822. attach(camera: ArcRotateCamera): void;
  43823. /**
  43824. * Detaches the behavior from its current arc rotate camera.
  43825. */
  43826. detach(): void;
  43827. private _animatables;
  43828. private _betaIsAnimating;
  43829. private _betaTransition;
  43830. private _radiusTransition;
  43831. private _vectorTransition;
  43832. /**
  43833. * Targets the given mesh and updates zoom level accordingly.
  43834. * @param mesh The mesh to target.
  43835. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  43836. * @param onAnimationEnd Callback triggered at the end of the framing animation
  43837. */
  43838. zoomOnMesh(mesh: AbstractMesh, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  43839. /**
  43840. * Targets the given mesh with its children and updates zoom level accordingly.
  43841. * @param mesh The mesh to target.
  43842. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  43843. * @param onAnimationEnd Callback triggered at the end of the framing animation
  43844. */
  43845. zoomOnMeshHierarchy(mesh: AbstractMesh, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  43846. /**
  43847. * Targets the given meshes with their children and updates zoom level accordingly.
  43848. * @param meshes The mesh to target.
  43849. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  43850. * @param onAnimationEnd Callback triggered at the end of the framing animation
  43851. */
  43852. zoomOnMeshesHierarchy(meshes: AbstractMesh[], focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  43853. /**
  43854. * Targets the bounding box info defined by its extends and updates zoom level accordingly.
  43855. * @param minimumWorld Determines the smaller position of the bounding box extend
  43856. * @param maximumWorld Determines the bigger position of the bounding box extend
  43857. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  43858. * @param onAnimationEnd Callback triggered at the end of the framing animation
  43859. */
  43860. zoomOnBoundingInfo(minimumWorld: Vector3, maximumWorld: Vector3, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  43861. /**
  43862. * Calculates the lowest radius for the camera based on the bounding box of the mesh.
  43863. * @param mesh The mesh on which to base the calculation. mesh boundingInfo used to estimate necessary
  43864. * frustum width.
  43865. * @return The minimum distance from the primary mesh's center point at which the camera must be kept in order
  43866. * to fully enclose the mesh in the viewing frustum.
  43867. */
  43868. protected _calculateLowerRadiusFromModelBoundingSphere(minimumWorld: Vector3, maximumWorld: Vector3): number;
  43869. /**
  43870. * Keeps the camera above the ground plane. If the user pulls the camera below the ground plane, the camera
  43871. * is automatically returned to its default position (expected to be above ground plane).
  43872. */
  43873. private _maintainCameraAboveGround;
  43874. /**
  43875. * Returns the frustum slope based on the canvas ratio and camera FOV
  43876. * @returns The frustum slope represented as a Vector2 with X and Y slopes
  43877. */
  43878. private _getFrustumSlope;
  43879. /**
  43880. * Removes all animation locks. Allows new animations to be added to any of the arcCamera properties.
  43881. */
  43882. private _clearAnimationLocks;
  43883. /**
  43884. * Applies any current user interaction to the camera. Takes into account maximum alpha rotation.
  43885. */
  43886. private _applyUserInteraction;
  43887. /**
  43888. * Stops and removes all animations that have been applied to the camera
  43889. */
  43890. stopAllAnimations(): void;
  43891. /**
  43892. * Gets a value indicating if the user is moving the camera
  43893. */
  43894. get isUserIsMoving(): boolean;
  43895. /**
  43896. * The camera can move all the way towards the mesh.
  43897. */
  43898. static IgnoreBoundsSizeMode: number;
  43899. /**
  43900. * The camera is not allowed to zoom closer to the mesh than the point at which the adjusted bounding sphere touches the frustum sides
  43901. */
  43902. static FitFrustumSidesMode: number;
  43903. }
  43904. }
  43905. declare module "babylonjs/Cameras/Inputs/BaseCameraPointersInput" {
  43906. import { Nullable } from "babylonjs/types";
  43907. import { Camera } from "babylonjs/Cameras/camera";
  43908. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  43909. import { PointerTouch } from "babylonjs/Events/pointerEvents";
  43910. /**
  43911. * Base class for Camera Pointer Inputs.
  43912. * See FollowCameraPointersInput in src/Cameras/Inputs/followCameraPointersInput.ts
  43913. * for example usage.
  43914. */
  43915. export abstract class BaseCameraPointersInput implements ICameraInput<Camera> {
  43916. /**
  43917. * Defines the camera the input is attached to.
  43918. */
  43919. abstract camera: Camera;
  43920. /**
  43921. * Whether keyboard modifier keys are pressed at time of last mouse event.
  43922. */
  43923. protected _altKey: boolean;
  43924. protected _ctrlKey: boolean;
  43925. protected _metaKey: boolean;
  43926. protected _shiftKey: boolean;
  43927. /**
  43928. * Which mouse buttons were pressed at time of last mouse event.
  43929. * https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/buttons
  43930. */
  43931. protected _buttonsPressed: number;
  43932. /**
  43933. * Defines the buttons associated with the input to handle camera move.
  43934. */
  43935. buttons: number[];
  43936. /**
  43937. * Attach the input controls to a specific dom element to get the input from.
  43938. * @param element Defines the element the controls should be listened from
  43939. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  43940. */
  43941. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  43942. /**
  43943. * Detach the current controls from the specified dom element.
  43944. * @param element Defines the element to stop listening the inputs from
  43945. */
  43946. detachControl(element: Nullable<HTMLElement>): void;
  43947. /**
  43948. * Gets the class name of the current input.
  43949. * @returns the class name
  43950. */
  43951. getClassName(): string;
  43952. /**
  43953. * Get the friendly name associated with the input class.
  43954. * @returns the input friendly name
  43955. */
  43956. getSimpleName(): string;
  43957. /**
  43958. * Called on pointer POINTERDOUBLETAP event.
  43959. * Override this method to provide functionality on POINTERDOUBLETAP event.
  43960. */
  43961. protected onDoubleTap(type: string): void;
  43962. /**
  43963. * Called on pointer POINTERMOVE event if only a single touch is active.
  43964. * Override this method to provide functionality.
  43965. */
  43966. protected onTouch(point: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  43967. /**
  43968. * Called on pointer POINTERMOVE event if multiple touches are active.
  43969. * Override this method to provide functionality.
  43970. */
  43971. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  43972. /**
  43973. * Called on JS contextmenu event.
  43974. * Override this method to provide functionality.
  43975. */
  43976. protected onContextMenu(evt: PointerEvent): void;
  43977. /**
  43978. * Called each time a new POINTERDOWN event occurs. Ie, for each button
  43979. * press.
  43980. * Override this method to provide functionality.
  43981. */
  43982. protected onButtonDown(evt: PointerEvent): void;
  43983. /**
  43984. * Called each time a new POINTERUP event occurs. Ie, for each button
  43985. * release.
  43986. * Override this method to provide functionality.
  43987. */
  43988. protected onButtonUp(evt: PointerEvent): void;
  43989. /**
  43990. * Called when window becomes inactive.
  43991. * Override this method to provide functionality.
  43992. */
  43993. protected onLostFocus(): void;
  43994. private _pointerInput;
  43995. private _observer;
  43996. private _onLostFocus;
  43997. private pointA;
  43998. private pointB;
  43999. }
  44000. }
  44001. declare module "babylonjs/Cameras/Inputs/arcRotateCameraPointersInput" {
  44002. import { Nullable } from "babylonjs/types";
  44003. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  44004. import { BaseCameraPointersInput } from "babylonjs/Cameras/Inputs/BaseCameraPointersInput";
  44005. import { PointerTouch } from "babylonjs/Events/pointerEvents";
  44006. /**
  44007. * Manage the pointers inputs to control an arc rotate camera.
  44008. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  44009. */
  44010. export class ArcRotateCameraPointersInput extends BaseCameraPointersInput {
  44011. /**
  44012. * Defines the camera the input is attached to.
  44013. */
  44014. camera: ArcRotateCamera;
  44015. /**
  44016. * Gets the class name of the current input.
  44017. * @returns the class name
  44018. */
  44019. getClassName(): string;
  44020. /**
  44021. * Defines the buttons associated with the input to handle camera move.
  44022. */
  44023. buttons: number[];
  44024. /**
  44025. * Defines the pointer angular sensibility along the X axis or how fast is
  44026. * the camera rotating.
  44027. */
  44028. angularSensibilityX: number;
  44029. /**
  44030. * Defines the pointer angular sensibility along the Y axis or how fast is
  44031. * the camera rotating.
  44032. */
  44033. angularSensibilityY: number;
  44034. /**
  44035. * Defines the pointer pinch precision or how fast is the camera zooming.
  44036. */
  44037. pinchPrecision: number;
  44038. /**
  44039. * pinchDeltaPercentage will be used instead of pinchPrecision if different
  44040. * from 0.
  44041. * It defines the percentage of current camera.radius to use as delta when
  44042. * pinch zoom is used.
  44043. */
  44044. pinchDeltaPercentage: number;
  44045. /**
  44046. * When useNaturalPinchZoom is true, multi touch zoom will zoom in such
  44047. * that any object in the plane at the camera's target point will scale
  44048. * perfectly with finger motion.
  44049. * Overrides pinchDeltaPercentage and pinchPrecision.
  44050. */
  44051. useNaturalPinchZoom: boolean;
  44052. /**
  44053. * Defines the pointer panning sensibility or how fast is the camera moving.
  44054. */
  44055. panningSensibility: number;
  44056. /**
  44057. * Defines whether panning (2 fingers swipe) is enabled through multitouch.
  44058. */
  44059. multiTouchPanning: boolean;
  44060. /**
  44061. * Defines whether panning is enabled for both pan (2 fingers swipe) and
  44062. * zoom (pinch) through multitouch.
  44063. */
  44064. multiTouchPanAndZoom: boolean;
  44065. /**
  44066. * Revers pinch action direction.
  44067. */
  44068. pinchInwards: boolean;
  44069. private _isPanClick;
  44070. private _twoFingerActivityCount;
  44071. private _isPinching;
  44072. /**
  44073. * Called on pointer POINTERMOVE event if only a single touch is active.
  44074. */
  44075. protected onTouch(point: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  44076. /**
  44077. * Called on pointer POINTERDOUBLETAP event.
  44078. */
  44079. protected onDoubleTap(type: string): void;
  44080. /**
  44081. * Called on pointer POINTERMOVE event if multiple touches are active.
  44082. */
  44083. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  44084. /**
  44085. * Called each time a new POINTERDOWN event occurs. Ie, for each button
  44086. * press.
  44087. */
  44088. protected onButtonDown(evt: PointerEvent): void;
  44089. /**
  44090. * Called each time a new POINTERUP event occurs. Ie, for each button
  44091. * release.
  44092. */
  44093. protected onButtonUp(evt: PointerEvent): void;
  44094. /**
  44095. * Called when window becomes inactive.
  44096. */
  44097. protected onLostFocus(): void;
  44098. }
  44099. }
  44100. declare module "babylonjs/Cameras/Inputs/arcRotateCameraKeyboardMoveInput" {
  44101. import { Nullable } from "babylonjs/types";
  44102. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  44103. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  44104. /**
  44105. * Manage the keyboard inputs to control the movement of an arc rotate camera.
  44106. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  44107. */
  44108. export class ArcRotateCameraKeyboardMoveInput implements ICameraInput<ArcRotateCamera> {
  44109. /**
  44110. * Defines the camera the input is attached to.
  44111. */
  44112. camera: ArcRotateCamera;
  44113. /**
  44114. * Defines the list of key codes associated with the up action (increase alpha)
  44115. */
  44116. keysUp: number[];
  44117. /**
  44118. * Defines the list of key codes associated with the down action (decrease alpha)
  44119. */
  44120. keysDown: number[];
  44121. /**
  44122. * Defines the list of key codes associated with the left action (increase beta)
  44123. */
  44124. keysLeft: number[];
  44125. /**
  44126. * Defines the list of key codes associated with the right action (decrease beta)
  44127. */
  44128. keysRight: number[];
  44129. /**
  44130. * Defines the list of key codes associated with the reset action.
  44131. * Those keys reset the camera to its last stored state (with the method camera.storeState())
  44132. */
  44133. keysReset: number[];
  44134. /**
  44135. * Defines the panning sensibility of the inputs.
  44136. * (How fast is the camera panning)
  44137. */
  44138. panningSensibility: number;
  44139. /**
  44140. * Defines the zooming sensibility of the inputs.
  44141. * (How fast is the camera zooming)
  44142. */
  44143. zoomingSensibility: number;
  44144. /**
  44145. * Defines whether maintaining the alt key down switch the movement mode from
  44146. * orientation to zoom.
  44147. */
  44148. useAltToZoom: boolean;
  44149. /**
  44150. * Rotation speed of the camera
  44151. */
  44152. angularSpeed: number;
  44153. private _keys;
  44154. private _ctrlPressed;
  44155. private _altPressed;
  44156. private _onCanvasBlurObserver;
  44157. private _onKeyboardObserver;
  44158. private _engine;
  44159. private _scene;
  44160. /**
  44161. * Attach the input controls to a specific dom element to get the input from.
  44162. * @param element Defines the element the controls should be listened from
  44163. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  44164. */
  44165. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  44166. /**
  44167. * Detach the current controls from the specified dom element.
  44168. * @param element Defines the element to stop listening the inputs from
  44169. */
  44170. detachControl(element: Nullable<HTMLElement>): void;
  44171. /**
  44172. * Update the current camera state depending on the inputs that have been used this frame.
  44173. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  44174. */
  44175. checkInputs(): void;
  44176. /**
  44177. * Gets the class name of the current intput.
  44178. * @returns the class name
  44179. */
  44180. getClassName(): string;
  44181. /**
  44182. * Get the friendly name associated with the input class.
  44183. * @returns the input friendly name
  44184. */
  44185. getSimpleName(): string;
  44186. }
  44187. }
  44188. declare module "babylonjs/Cameras/Inputs/arcRotateCameraMouseWheelInput" {
  44189. import { Nullable } from "babylonjs/types";
  44190. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  44191. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  44192. /**
  44193. * Manage the mouse wheel inputs to control an arc rotate camera.
  44194. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  44195. */
  44196. export class ArcRotateCameraMouseWheelInput implements ICameraInput<ArcRotateCamera> {
  44197. /**
  44198. * Defines the camera the input is attached to.
  44199. */
  44200. camera: ArcRotateCamera;
  44201. /**
  44202. * Gets or Set the mouse wheel precision or how fast is the camera zooming.
  44203. */
  44204. wheelPrecision: number;
  44205. /**
  44206. * wheelDeltaPercentage will be used instead of wheelPrecision if different from 0.
  44207. * It defines the percentage of current camera.radius to use as delta when wheel is used.
  44208. */
  44209. wheelDeltaPercentage: number;
  44210. private _wheel;
  44211. private _observer;
  44212. private computeDeltaFromMouseWheelLegacyEvent;
  44213. /**
  44214. * Attach the input controls to a specific dom element to get the input from.
  44215. * @param element Defines the element the controls should be listened from
  44216. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  44217. */
  44218. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  44219. /**
  44220. * Detach the current controls from the specified dom element.
  44221. * @param element Defines the element to stop listening the inputs from
  44222. */
  44223. detachControl(element: Nullable<HTMLElement>): void;
  44224. /**
  44225. * Gets the class name of the current intput.
  44226. * @returns the class name
  44227. */
  44228. getClassName(): string;
  44229. /**
  44230. * Get the friendly name associated with the input class.
  44231. * @returns the input friendly name
  44232. */
  44233. getSimpleName(): string;
  44234. }
  44235. }
  44236. declare module "babylonjs/Cameras/arcRotateCameraInputsManager" {
  44237. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  44238. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  44239. /**
  44240. * Default Inputs manager for the ArcRotateCamera.
  44241. * It groups all the default supported inputs for ease of use.
  44242. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  44243. */
  44244. export class ArcRotateCameraInputsManager extends CameraInputsManager<ArcRotateCamera> {
  44245. /**
  44246. * Instantiates a new ArcRotateCameraInputsManager.
  44247. * @param camera Defines the camera the inputs belong to
  44248. */
  44249. constructor(camera: ArcRotateCamera);
  44250. /**
  44251. * Add mouse wheel input support to the input manager.
  44252. * @returns the current input manager
  44253. */
  44254. addMouseWheel(): ArcRotateCameraInputsManager;
  44255. /**
  44256. * Add pointers input support to the input manager.
  44257. * @returns the current input manager
  44258. */
  44259. addPointers(): ArcRotateCameraInputsManager;
  44260. /**
  44261. * Add keyboard input support to the input manager.
  44262. * @returns the current input manager
  44263. */
  44264. addKeyboard(): ArcRotateCameraInputsManager;
  44265. }
  44266. }
  44267. declare module "babylonjs/Cameras/arcRotateCamera" {
  44268. import { Observable } from "babylonjs/Misc/observable";
  44269. import { Nullable } from "babylonjs/types";
  44270. import { Scene } from "babylonjs/scene";
  44271. import { Matrix, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  44272. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  44273. import { AutoRotationBehavior } from "babylonjs/Behaviors/Cameras/autoRotationBehavior";
  44274. import { BouncingBehavior } from "babylonjs/Behaviors/Cameras/bouncingBehavior";
  44275. import { FramingBehavior } from "babylonjs/Behaviors/Cameras/framingBehavior";
  44276. import { Camera } from "babylonjs/Cameras/camera";
  44277. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  44278. import { ArcRotateCameraInputsManager } from "babylonjs/Cameras/arcRotateCameraInputsManager";
  44279. import { Collider } from "babylonjs/Collisions/collider";
  44280. /**
  44281. * This represents an orbital type of camera.
  44282. *
  44283. * This camera always points towards a given target position and can be rotated around that target with the target as the centre of rotation. It can be controlled with cursors and mouse, or with touch events.
  44284. * Think of this camera as one orbiting its target position, or more imaginatively as a spy satellite orbiting the earth. Its position relative to the target (earth) can be set by three parameters, alpha (radians) the longitudinal rotation, beta (radians) the latitudinal rotation and radius the distance from the target position.
  44285. * @see https://doc.babylonjs.com/babylon101/cameras#arc-rotate-camera
  44286. */
  44287. export class ArcRotateCamera extends TargetCamera {
  44288. /**
  44289. * Defines the rotation angle of the camera along the longitudinal axis.
  44290. */
  44291. alpha: number;
  44292. /**
  44293. * Defines the rotation angle of the camera along the latitudinal axis.
  44294. */
  44295. beta: number;
  44296. /**
  44297. * Defines the radius of the camera from it s target point.
  44298. */
  44299. radius: number;
  44300. protected _target: Vector3;
  44301. protected _targetHost: Nullable<AbstractMesh>;
  44302. /**
  44303. * Defines the target point of the camera.
  44304. * The camera looks towards it form the radius distance.
  44305. * Please note that you can set the target to a mesh and thus the target will be copied from mesh.position
  44306. */
  44307. get target(): Vector3;
  44308. set target(value: Vector3);
  44309. /**
  44310. * Define the current local position of the camera in the scene
  44311. */
  44312. get position(): Vector3;
  44313. set position(newPosition: Vector3);
  44314. protected _upVector: Vector3;
  44315. protected _upToYMatrix: Matrix;
  44316. protected _YToUpMatrix: Matrix;
  44317. /**
  44318. * The vector the camera should consider as up. (default is Vector3(0, 1, 0) as returned by Vector3.Up())
  44319. * Setting this will copy the given vector to the camera's upVector, and set rotation matrices to and from Y up.
  44320. * DO NOT set the up vector using copyFrom or copyFromFloats, as this bypasses setting the above matrices.
  44321. */
  44322. set upVector(vec: Vector3);
  44323. get upVector(): Vector3;
  44324. /**
  44325. * Sets the Y-up to camera up-vector rotation matrix, and the up-vector to Y-up rotation matrix.
  44326. */
  44327. setMatUp(): void;
  44328. /**
  44329. * Current inertia value on the longitudinal axis.
  44330. * The bigger this number the longer it will take for the camera to stop.
  44331. */
  44332. inertialAlphaOffset: number;
  44333. /**
  44334. * Current inertia value on the latitudinal axis.
  44335. * The bigger this number the longer it will take for the camera to stop.
  44336. */
  44337. inertialBetaOffset: number;
  44338. /**
  44339. * Current inertia value on the radius axis.
  44340. * The bigger this number the longer it will take for the camera to stop.
  44341. */
  44342. inertialRadiusOffset: number;
  44343. /**
  44344. * Minimum allowed angle on the longitudinal axis.
  44345. * This can help limiting how the Camera is able to move in the scene.
  44346. */
  44347. lowerAlphaLimit: Nullable<number>;
  44348. /**
  44349. * Maximum allowed angle on the longitudinal axis.
  44350. * This can help limiting how the Camera is able to move in the scene.
  44351. */
  44352. upperAlphaLimit: Nullable<number>;
  44353. /**
  44354. * Minimum allowed angle on the latitudinal axis.
  44355. * This can help limiting how the Camera is able to move in the scene.
  44356. */
  44357. lowerBetaLimit: number;
  44358. /**
  44359. * Maximum allowed angle on the latitudinal axis.
  44360. * This can help limiting how the Camera is able to move in the scene.
  44361. */
  44362. upperBetaLimit: number;
  44363. /**
  44364. * Minimum allowed distance of the camera to the target (The camera can not get closer).
  44365. * This can help limiting how the Camera is able to move in the scene.
  44366. */
  44367. lowerRadiusLimit: Nullable<number>;
  44368. /**
  44369. * Maximum allowed distance of the camera to the target (The camera can not get further).
  44370. * This can help limiting how the Camera is able to move in the scene.
  44371. */
  44372. upperRadiusLimit: Nullable<number>;
  44373. /**
  44374. * Defines the current inertia value used during panning of the camera along the X axis.
  44375. */
  44376. inertialPanningX: number;
  44377. /**
  44378. * Defines the current inertia value used during panning of the camera along the Y axis.
  44379. */
  44380. inertialPanningY: number;
  44381. /**
  44382. * Defines the distance used to consider the camera in pan mode vs pinch/zoom.
  44383. * Basically if your fingers moves away from more than this distance you will be considered
  44384. * in pinch mode.
  44385. */
  44386. pinchToPanMaxDistance: number;
  44387. /**
  44388. * Defines the maximum distance the camera can pan.
  44389. * This could help keeping the cammera always in your scene.
  44390. */
  44391. panningDistanceLimit: Nullable<number>;
  44392. /**
  44393. * Defines the target of the camera before paning.
  44394. */
  44395. panningOriginTarget: Vector3;
  44396. /**
  44397. * Defines the value of the inertia used during panning.
  44398. * 0 would mean stop inertia and one would mean no decelleration at all.
  44399. */
  44400. panningInertia: number;
  44401. /**
  44402. * Gets or Set the pointer angular sensibility along the X axis or how fast is the camera rotating.
  44403. */
  44404. get angularSensibilityX(): number;
  44405. set angularSensibilityX(value: number);
  44406. /**
  44407. * Gets or Set the pointer angular sensibility along the Y axis or how fast is the camera rotating.
  44408. */
  44409. get angularSensibilityY(): number;
  44410. set angularSensibilityY(value: number);
  44411. /**
  44412. * Gets or Set the pointer pinch precision or how fast is the camera zooming.
  44413. */
  44414. get pinchPrecision(): number;
  44415. set pinchPrecision(value: number);
  44416. /**
  44417. * Gets or Set the pointer pinch delta percentage or how fast is the camera zooming.
  44418. * It will be used instead of pinchDeltaPrecision if different from 0.
  44419. * It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
  44420. */
  44421. get pinchDeltaPercentage(): number;
  44422. set pinchDeltaPercentage(value: number);
  44423. /**
  44424. * Gets or Set the pointer use natural pinch zoom to override the pinch precision
  44425. * and pinch delta percentage.
  44426. * When useNaturalPinchZoom is true, multi touch zoom will zoom in such
  44427. * that any object in the plane at the camera's target point will scale
  44428. * perfectly with finger motion.
  44429. */
  44430. get useNaturalPinchZoom(): boolean;
  44431. set useNaturalPinchZoom(value: boolean);
  44432. /**
  44433. * Gets or Set the pointer panning sensibility or how fast is the camera moving.
  44434. */
  44435. get panningSensibility(): number;
  44436. set panningSensibility(value: number);
  44437. /**
  44438. * Gets or Set the list of keyboard keys used to control beta angle in a positive direction.
  44439. */
  44440. get keysUp(): number[];
  44441. set keysUp(value: number[]);
  44442. /**
  44443. * Gets or Set the list of keyboard keys used to control beta angle in a negative direction.
  44444. */
  44445. get keysDown(): number[];
  44446. set keysDown(value: number[]);
  44447. /**
  44448. * Gets or Set the list of keyboard keys used to control alpha angle in a negative direction.
  44449. */
  44450. get keysLeft(): number[];
  44451. set keysLeft(value: number[]);
  44452. /**
  44453. * Gets or Set the list of keyboard keys used to control alpha angle in a positive direction.
  44454. */
  44455. get keysRight(): number[];
  44456. set keysRight(value: number[]);
  44457. /**
  44458. * Gets or Set the mouse wheel precision or how fast is the camera zooming.
  44459. */
  44460. get wheelPrecision(): number;
  44461. set wheelPrecision(value: number);
  44462. /**
  44463. * Gets or Set the mouse wheel delta percentage or how fast is the camera zooming.
  44464. * It will be used instead of pinchDeltaPrecision if different from 0.
  44465. * It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
  44466. */
  44467. get wheelDeltaPercentage(): number;
  44468. set wheelDeltaPercentage(value: number);
  44469. /**
  44470. * Defines how much the radius should be scaled while zomming on a particular mesh (through the zoomOn function)
  44471. */
  44472. zoomOnFactor: number;
  44473. /**
  44474. * Defines a screen offset for the camera position.
  44475. */
  44476. targetScreenOffset: Vector2;
  44477. /**
  44478. * Allows the camera to be completely reversed.
  44479. * If false the camera can not arrive upside down.
  44480. */
  44481. allowUpsideDown: boolean;
  44482. /**
  44483. * Define if double tap/click is used to restore the previously saved state of the camera.
  44484. */
  44485. useInputToRestoreState: boolean;
  44486. /** @hidden */
  44487. _viewMatrix: Matrix;
  44488. /** @hidden */
  44489. _useCtrlForPanning: boolean;
  44490. /** @hidden */
  44491. _panningMouseButton: number;
  44492. /**
  44493. * Defines the input associated to the camera.
  44494. */
  44495. inputs: ArcRotateCameraInputsManager;
  44496. /** @hidden */
  44497. _reset: () => void;
  44498. /**
  44499. * Defines the allowed panning axis.
  44500. */
  44501. panningAxis: Vector3;
  44502. protected _localDirection: Vector3;
  44503. protected _transformedDirection: Vector3;
  44504. private _bouncingBehavior;
  44505. /**
  44506. * Gets the bouncing behavior of the camera if it has been enabled.
  44507. * @see https://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  44508. */
  44509. get bouncingBehavior(): Nullable<BouncingBehavior>;
  44510. /**
  44511. * Defines if the bouncing behavior of the camera is enabled on the camera.
  44512. * @see https://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  44513. */
  44514. get useBouncingBehavior(): boolean;
  44515. set useBouncingBehavior(value: boolean);
  44516. private _framingBehavior;
  44517. /**
  44518. * Gets the framing behavior of the camera if it has been enabled.
  44519. * @see https://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  44520. */
  44521. get framingBehavior(): Nullable<FramingBehavior>;
  44522. /**
  44523. * Defines if the framing behavior of the camera is enabled on the camera.
  44524. * @see https://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  44525. */
  44526. get useFramingBehavior(): boolean;
  44527. set useFramingBehavior(value: boolean);
  44528. private _autoRotationBehavior;
  44529. /**
  44530. * Gets the auto rotation behavior of the camera if it has been enabled.
  44531. * @see https://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  44532. */
  44533. get autoRotationBehavior(): Nullable<AutoRotationBehavior>;
  44534. /**
  44535. * Defines if the auto rotation behavior of the camera is enabled on the camera.
  44536. * @see https://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  44537. */
  44538. get useAutoRotationBehavior(): boolean;
  44539. set useAutoRotationBehavior(value: boolean);
  44540. /**
  44541. * Observable triggered when the mesh target has been changed on the camera.
  44542. */
  44543. onMeshTargetChangedObservable: Observable<Nullable<AbstractMesh>>;
  44544. /**
  44545. * Event raised when the camera is colliding with a mesh.
  44546. */
  44547. onCollide: (collidedMesh: AbstractMesh) => void;
  44548. /**
  44549. * Defines whether the camera should check collision with the objects oh the scene.
  44550. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#how-can-i-do-this
  44551. */
  44552. checkCollisions: boolean;
  44553. /**
  44554. * Defines the collision radius of the camera.
  44555. * This simulates a sphere around the camera.
  44556. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  44557. */
  44558. collisionRadius: Vector3;
  44559. protected _collider: Collider;
  44560. protected _previousPosition: Vector3;
  44561. protected _collisionVelocity: Vector3;
  44562. protected _newPosition: Vector3;
  44563. protected _previousAlpha: number;
  44564. protected _previousBeta: number;
  44565. protected _previousRadius: number;
  44566. protected _collisionTriggered: boolean;
  44567. protected _targetBoundingCenter: Nullable<Vector3>;
  44568. private _computationVector;
  44569. /**
  44570. * Instantiates a new ArcRotateCamera in a given scene
  44571. * @param name Defines the name of the camera
  44572. * @param alpha Defines the camera rotation along the logitudinal axis
  44573. * @param beta Defines the camera rotation along the latitudinal axis
  44574. * @param radius Defines the camera distance from its target
  44575. * @param target Defines the camera target
  44576. * @param scene Defines the scene the camera belongs to
  44577. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  44578. */
  44579. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  44580. /** @hidden */
  44581. _initCache(): void;
  44582. /** @hidden */
  44583. _updateCache(ignoreParentClass?: boolean): void;
  44584. protected _getTargetPosition(): Vector3;
  44585. private _storedAlpha;
  44586. private _storedBeta;
  44587. private _storedRadius;
  44588. private _storedTarget;
  44589. private _storedTargetScreenOffset;
  44590. /**
  44591. * Stores the current state of the camera (alpha, beta, radius and target)
  44592. * @returns the camera itself
  44593. */
  44594. storeState(): Camera;
  44595. /**
  44596. * @hidden
  44597. * Restored camera state. You must call storeState() first
  44598. */
  44599. _restoreStateValues(): boolean;
  44600. /** @hidden */
  44601. _isSynchronizedViewMatrix(): boolean;
  44602. /**
  44603. * Attached controls to the current camera.
  44604. * @param element Defines the element the controls should be listened from
  44605. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  44606. * @param useCtrlForPanning Defines whether ctrl is used for paning within the controls
  44607. * @param panningMouseButton Defines whether panning is allowed through mouse click button
  44608. */
  44609. attachControl(element: HTMLElement, noPreventDefault?: boolean, useCtrlForPanning?: boolean, panningMouseButton?: number): void;
  44610. /**
  44611. * Detach the current controls from the camera.
  44612. * The camera will stop reacting to inputs.
  44613. * @param element Defines the element to stop listening the inputs from
  44614. */
  44615. detachControl(element: HTMLElement): void;
  44616. /** @hidden */
  44617. _checkInputs(): void;
  44618. protected _checkLimits(): void;
  44619. /**
  44620. * Rebuilds angles (alpha, beta) and radius from the give position and target
  44621. */
  44622. rebuildAnglesAndRadius(): void;
  44623. /**
  44624. * Use a position to define the current camera related information like alpha, beta and radius
  44625. * @param position Defines the position to set the camera at
  44626. */
  44627. setPosition(position: Vector3): void;
  44628. /**
  44629. * Defines the target the camera should look at.
  44630. * This will automatically adapt alpha beta and radius to fit within the new target.
  44631. * @param target Defines the new target as a Vector or a mesh
  44632. * @param toBoundingCenter In case of a mesh target, defines whether to target the mesh position or its bounding information center
  44633. * @param allowSamePosition If false, prevents reapplying the new computed position if it is identical to the current one (optim)
  44634. */
  44635. setTarget(target: AbstractMesh | Vector3, toBoundingCenter?: boolean, allowSamePosition?: boolean): void;
  44636. /** @hidden */
  44637. _getViewMatrix(): Matrix;
  44638. protected _onCollisionPositionChange: (collisionId: number, newPosition: Vector3, collidedMesh?: Nullable<AbstractMesh>) => void;
  44639. /**
  44640. * Zooms on a mesh to be at the min distance where we could see it fully in the current viewport.
  44641. * @param meshes Defines the mesh to zoom on
  44642. * @param doNotUpdateMaxZ Defines whether or not maxZ should be updated whilst zooming on the mesh (this can happen if the mesh is big and the maxradius pretty small for instance)
  44643. */
  44644. zoomOn(meshes?: AbstractMesh[], doNotUpdateMaxZ?: boolean): void;
  44645. /**
  44646. * Focus on a mesh or a bounding box. This adapts the target and maxRadius if necessary but does not update the current radius.
  44647. * The target will be changed but the radius
  44648. * @param meshesOrMinMaxVectorAndDistance Defines the mesh or bounding info to focus on
  44649. * @param doNotUpdateMaxZ Defines whether or not maxZ should be updated whilst zooming on the mesh (this can happen if the mesh is big and the maxradius pretty small for instance)
  44650. */
  44651. focusOn(meshesOrMinMaxVectorAndDistance: AbstractMesh[] | {
  44652. min: Vector3;
  44653. max: Vector3;
  44654. distance: number;
  44655. }, doNotUpdateMaxZ?: boolean): void;
  44656. /**
  44657. * @override
  44658. * Override Camera.createRigCamera
  44659. */
  44660. createRigCamera(name: string, cameraIndex: number): Camera;
  44661. /**
  44662. * @hidden
  44663. * @override
  44664. * Override Camera._updateRigCameras
  44665. */
  44666. _updateRigCameras(): void;
  44667. /**
  44668. * Destroy the camera and release the current resources hold by it.
  44669. */
  44670. dispose(): void;
  44671. /**
  44672. * Gets the current object class name.
  44673. * @return the class name
  44674. */
  44675. getClassName(): string;
  44676. }
  44677. }
  44678. declare module "babylonjs/Behaviors/Cameras/autoRotationBehavior" {
  44679. import { Behavior } from "babylonjs/Behaviors/behavior";
  44680. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  44681. /**
  44682. * The autoRotation behavior (AutoRotationBehavior) is designed to create a smooth rotation of an ArcRotateCamera when there is no user interaction.
  44683. * @see https://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  44684. */
  44685. export class AutoRotationBehavior implements Behavior<ArcRotateCamera> {
  44686. /**
  44687. * Gets the name of the behavior.
  44688. */
  44689. get name(): string;
  44690. private _zoomStopsAnimation;
  44691. private _idleRotationSpeed;
  44692. private _idleRotationWaitTime;
  44693. private _idleRotationSpinupTime;
  44694. /**
  44695. * Sets the flag that indicates if user zooming should stop animation.
  44696. */
  44697. set zoomStopsAnimation(flag: boolean);
  44698. /**
  44699. * Gets the flag that indicates if user zooming should stop animation.
  44700. */
  44701. get zoomStopsAnimation(): boolean;
  44702. /**
  44703. * Sets the default speed at which the camera rotates around the model.
  44704. */
  44705. set idleRotationSpeed(speed: number);
  44706. /**
  44707. * Gets the default speed at which the camera rotates around the model.
  44708. */
  44709. get idleRotationSpeed(): number;
  44710. /**
  44711. * Sets the time (in milliseconds) to wait after user interaction before the camera starts rotating.
  44712. */
  44713. set idleRotationWaitTime(time: number);
  44714. /**
  44715. * Gets the time (milliseconds) to wait after user interaction before the camera starts rotating.
  44716. */
  44717. get idleRotationWaitTime(): number;
  44718. /**
  44719. * Sets the time (milliseconds) to take to spin up to the full idle rotation speed.
  44720. */
  44721. set idleRotationSpinupTime(time: number);
  44722. /**
  44723. * Gets the time (milliseconds) to take to spin up to the full idle rotation speed.
  44724. */
  44725. get idleRotationSpinupTime(): number;
  44726. /**
  44727. * Gets a value indicating if the camera is currently rotating because of this behavior
  44728. */
  44729. get rotationInProgress(): boolean;
  44730. private _onPrePointerObservableObserver;
  44731. private _onAfterCheckInputsObserver;
  44732. private _attachedCamera;
  44733. private _isPointerDown;
  44734. private _lastFrameTime;
  44735. private _lastInteractionTime;
  44736. private _cameraRotationSpeed;
  44737. /**
  44738. * Initializes the behavior.
  44739. */
  44740. init(): void;
  44741. /**
  44742. * Attaches the behavior to its arc rotate camera.
  44743. * @param camera Defines the camera to attach the behavior to
  44744. */
  44745. attach(camera: ArcRotateCamera): void;
  44746. /**
  44747. * Detaches the behavior from its current arc rotate camera.
  44748. */
  44749. detach(): void;
  44750. /**
  44751. * Returns true if user is scrolling.
  44752. * @return true if user is scrolling.
  44753. */
  44754. private _userIsZooming;
  44755. private _lastFrameRadius;
  44756. private _shouldAnimationStopForInteraction;
  44757. /**
  44758. * Applies any current user interaction to the camera. Takes into account maximum alpha rotation.
  44759. */
  44760. private _applyUserInteraction;
  44761. private _userIsMoving;
  44762. }
  44763. }
  44764. declare module "babylonjs/Behaviors/Cameras/index" {
  44765. export * from "babylonjs/Behaviors/Cameras/autoRotationBehavior";
  44766. export * from "babylonjs/Behaviors/Cameras/bouncingBehavior";
  44767. export * from "babylonjs/Behaviors/Cameras/framingBehavior";
  44768. }
  44769. declare module "babylonjs/Behaviors/Meshes/attachToBoxBehavior" {
  44770. import { Mesh } from "babylonjs/Meshes/mesh";
  44771. import { TransformNode } from "babylonjs/Meshes/transformNode";
  44772. import { Behavior } from "babylonjs/Behaviors/behavior";
  44773. /**
  44774. * A behavior that when attached to a mesh will will place a specified node on the meshes face pointing towards the camera
  44775. */
  44776. export class AttachToBoxBehavior implements Behavior<Mesh> {
  44777. private ui;
  44778. /**
  44779. * The name of the behavior
  44780. */
  44781. name: string;
  44782. /**
  44783. * The distance away from the face of the mesh that the UI should be attached to (default: 0.15)
  44784. */
  44785. distanceAwayFromFace: number;
  44786. /**
  44787. * The distance from the bottom of the face that the UI should be attached to (default: 0.15)
  44788. */
  44789. distanceAwayFromBottomOfFace: number;
  44790. private _faceVectors;
  44791. private _target;
  44792. private _scene;
  44793. private _onRenderObserver;
  44794. private _tmpMatrix;
  44795. private _tmpVector;
  44796. /**
  44797. * Creates the AttachToBoxBehavior, used to attach UI to the closest face of the box to a camera
  44798. * @param ui The transform node that should be attched to the mesh
  44799. */
  44800. constructor(ui: TransformNode);
  44801. /**
  44802. * Initializes the behavior
  44803. */
  44804. init(): void;
  44805. private _closestFace;
  44806. private _zeroVector;
  44807. private _lookAtTmpMatrix;
  44808. private _lookAtToRef;
  44809. /**
  44810. * Attaches the AttachToBoxBehavior to the passed in mesh
  44811. * @param target The mesh that the specified node will be attached to
  44812. */
  44813. attach(target: Mesh): void;
  44814. /**
  44815. * Detaches the behavior from the mesh
  44816. */
  44817. detach(): void;
  44818. }
  44819. }
  44820. declare module "babylonjs/Behaviors/Meshes/fadeInOutBehavior" {
  44821. import { Behavior } from "babylonjs/Behaviors/behavior";
  44822. import { Mesh } from "babylonjs/Meshes/mesh";
  44823. /**
  44824. * A behavior that when attached to a mesh will allow the mesh to fade in and out
  44825. */
  44826. export class FadeInOutBehavior implements Behavior<Mesh> {
  44827. /**
  44828. * Time in milliseconds to delay before fading in (Default: 0)
  44829. */
  44830. delay: number;
  44831. /**
  44832. * Time in milliseconds for the mesh to fade in (Default: 300)
  44833. */
  44834. fadeInTime: number;
  44835. private _millisecondsPerFrame;
  44836. private _hovered;
  44837. private _hoverValue;
  44838. private _ownerNode;
  44839. /**
  44840. * Instatiates the FadeInOutBehavior
  44841. */
  44842. constructor();
  44843. /**
  44844. * The name of the behavior
  44845. */
  44846. get name(): string;
  44847. /**
  44848. * Initializes the behavior
  44849. */
  44850. init(): void;
  44851. /**
  44852. * Attaches the fade behavior on the passed in mesh
  44853. * @param ownerNode The mesh that will be faded in/out once attached
  44854. */
  44855. attach(ownerNode: Mesh): void;
  44856. /**
  44857. * Detaches the behavior from the mesh
  44858. */
  44859. detach(): void;
  44860. /**
  44861. * Triggers the mesh to begin fading in or out
  44862. * @param value if the object should fade in or out (true to fade in)
  44863. */
  44864. fadeIn(value: boolean): void;
  44865. private _update;
  44866. private _setAllVisibility;
  44867. }
  44868. }
  44869. declare module "babylonjs/Misc/pivotTools" {
  44870. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  44871. /**
  44872. * Class containing a set of static utilities functions for managing Pivots
  44873. * @hidden
  44874. */
  44875. export class PivotTools {
  44876. private static _PivotCached;
  44877. private static _OldPivotPoint;
  44878. private static _PivotTranslation;
  44879. private static _PivotTmpVector;
  44880. /** @hidden */
  44881. static _RemoveAndStorePivotPoint(mesh: AbstractMesh): void;
  44882. /** @hidden */
  44883. static _RestorePivotPoint(mesh: AbstractMesh): void;
  44884. }
  44885. }
  44886. declare module "babylonjs/Meshes/Builders/planeBuilder" {
  44887. import { Scene } from "babylonjs/scene";
  44888. import { Vector4 } from "babylonjs/Maths/math.vector";
  44889. import { Mesh } from "babylonjs/Meshes/mesh";
  44890. import { Nullable } from "babylonjs/types";
  44891. import { Plane } from "babylonjs/Maths/math.plane";
  44892. /**
  44893. * Class containing static functions to help procedurally build meshes
  44894. */
  44895. export class PlaneBuilder {
  44896. /**
  44897. * Creates a plane mesh
  44898. * * The parameter `size` sets the size (float) of both sides of the plane at once (default 1)
  44899. * * You can set some different plane dimensions by using the parameters `width` and `height` (both by default have the same value of `size`)
  44900. * * The parameter `sourcePlane` is a Plane instance. It builds a mesh plane from a Math plane
  44901. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  44902. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  44903. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  44904. * @param name defines the name of the mesh
  44905. * @param options defines the options used to create the mesh
  44906. * @param scene defines the hosting scene
  44907. * @returns the plane mesh
  44908. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  44909. */
  44910. static CreatePlane(name: string, options: {
  44911. size?: number;
  44912. width?: number;
  44913. height?: number;
  44914. sideOrientation?: number;
  44915. frontUVs?: Vector4;
  44916. backUVs?: Vector4;
  44917. updatable?: boolean;
  44918. sourcePlane?: Plane;
  44919. }, scene?: Nullable<Scene>): Mesh;
  44920. }
  44921. }
  44922. declare module "babylonjs/Behaviors/Meshes/pointerDragBehavior" {
  44923. import { Behavior } from "babylonjs/Behaviors/behavior";
  44924. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  44925. import { Observable } from "babylonjs/Misc/observable";
  44926. import { Vector3 } from "babylonjs/Maths/math.vector";
  44927. import { Ray } from "babylonjs/Culling/ray";
  44928. import "babylonjs/Meshes/Builders/planeBuilder";
  44929. /**
  44930. * A behavior that when attached to a mesh will allow the mesh to be dragged around the screen based on pointer events
  44931. */
  44932. export class PointerDragBehavior implements Behavior<AbstractMesh> {
  44933. private static _AnyMouseID;
  44934. /**
  44935. * Abstract mesh the behavior is set on
  44936. */
  44937. attachedNode: AbstractMesh;
  44938. private _dragPlane;
  44939. private _scene;
  44940. private _pointerObserver;
  44941. private _beforeRenderObserver;
  44942. private static _planeScene;
  44943. private _useAlternatePickedPointAboveMaxDragAngleDragSpeed;
  44944. /**
  44945. * The maximum tolerated angle between the drag plane and dragging pointer rays to trigger pointer events. Set to 0 to allow any angle (default: 0)
  44946. */
  44947. maxDragAngle: number;
  44948. /**
  44949. * @hidden
  44950. */
  44951. _useAlternatePickedPointAboveMaxDragAngle: boolean;
  44952. /**
  44953. * The id of the pointer that is currently interacting with the behavior (-1 when no pointer is active)
  44954. */
  44955. currentDraggingPointerID: number;
  44956. /**
  44957. * The last position where the pointer hit the drag plane in world space
  44958. */
  44959. lastDragPosition: Vector3;
  44960. /**
  44961. * If the behavior is currently in a dragging state
  44962. */
  44963. dragging: boolean;
  44964. /**
  44965. * The distance towards the target drag position to move each frame. This can be useful to avoid jitter. Set this to 1 for no delay. (Default: 0.2)
  44966. */
  44967. dragDeltaRatio: number;
  44968. /**
  44969. * If the drag plane orientation should be updated during the dragging (Default: true)
  44970. */
  44971. updateDragPlane: boolean;
  44972. private _debugMode;
  44973. private _moving;
  44974. /**
  44975. * Fires each time the attached mesh is dragged with the pointer
  44976. * * delta between last drag position and current drag position in world space
  44977. * * dragDistance along the drag axis
  44978. * * dragPlaneNormal normal of the current drag plane used during the drag
  44979. * * dragPlanePoint in world space where the drag intersects the drag plane
  44980. */
  44981. onDragObservable: Observable<{
  44982. delta: Vector3;
  44983. dragPlanePoint: Vector3;
  44984. dragPlaneNormal: Vector3;
  44985. dragDistance: number;
  44986. pointerId: number;
  44987. }>;
  44988. /**
  44989. * Fires each time a drag begins (eg. mouse down on mesh)
  44990. */
  44991. onDragStartObservable: Observable<{
  44992. dragPlanePoint: Vector3;
  44993. pointerId: number;
  44994. }>;
  44995. /**
  44996. * Fires each time a drag ends (eg. mouse release after drag)
  44997. */
  44998. onDragEndObservable: Observable<{
  44999. dragPlanePoint: Vector3;
  45000. pointerId: number;
  45001. }>;
  45002. /**
  45003. * If the attached mesh should be moved when dragged
  45004. */
  45005. moveAttached: boolean;
  45006. /**
  45007. * If the drag behavior will react to drag events (Default: true)
  45008. */
  45009. enabled: boolean;
  45010. /**
  45011. * If pointer events should start and release the drag (Default: true)
  45012. */
  45013. startAndReleaseDragOnPointerEvents: boolean;
  45014. /**
  45015. * If camera controls should be detached during the drag
  45016. */
  45017. detachCameraControls: boolean;
  45018. /**
  45019. * If set, the drag plane/axis will be rotated based on the attached mesh's world rotation (Default: true)
  45020. */
  45021. useObjectOrientationForDragging: boolean;
  45022. private _options;
  45023. /**
  45024. * Gets the options used by the behavior
  45025. */
  45026. get options(): {
  45027. dragAxis?: Vector3;
  45028. dragPlaneNormal?: Vector3;
  45029. };
  45030. /**
  45031. * Sets the options used by the behavior
  45032. */
  45033. set options(options: {
  45034. dragAxis?: Vector3;
  45035. dragPlaneNormal?: Vector3;
  45036. });
  45037. /**
  45038. * Creates a pointer drag behavior that can be attached to a mesh
  45039. * @param options The drag axis or normal of the plane that will be dragged across. If no options are specified the drag plane will always face the ray's origin (eg. camera)
  45040. */
  45041. constructor(options?: {
  45042. dragAxis?: Vector3;
  45043. dragPlaneNormal?: Vector3;
  45044. });
  45045. /**
  45046. * Predicate to determine if it is valid to move the object to a new position when it is moved
  45047. */
  45048. validateDrag: (targetPosition: Vector3) => boolean;
  45049. /**
  45050. * The name of the behavior
  45051. */
  45052. get name(): string;
  45053. /**
  45054. * Initializes the behavior
  45055. */
  45056. init(): void;
  45057. private _tmpVector;
  45058. private _alternatePickedPoint;
  45059. private _worldDragAxis;
  45060. private _targetPosition;
  45061. private _attachedElement;
  45062. /**
  45063. * Attaches the drag behavior the passed in mesh
  45064. * @param ownerNode The mesh that will be dragged around once attached
  45065. * @param predicate Predicate to use for pick filtering
  45066. */
  45067. attach(ownerNode: AbstractMesh, predicate?: (m: AbstractMesh) => boolean): void;
  45068. /**
  45069. * Force relase the drag action by code.
  45070. */
  45071. releaseDrag(): void;
  45072. private _startDragRay;
  45073. private _lastPointerRay;
  45074. /**
  45075. * Simulates the start of a pointer drag event on the behavior
  45076. * @param pointerId pointerID of the pointer that should be simulated (Default: Any mouse pointer ID)
  45077. * @param fromRay initial ray of the pointer to be simulated (Default: Ray from camera to attached mesh)
  45078. * @param startPickedPoint picked point of the pointer to be simulated (Default: attached mesh position)
  45079. */
  45080. startDrag(pointerId?: number, fromRay?: Ray, startPickedPoint?: Vector3): void;
  45081. private _startDrag;
  45082. private _dragDelta;
  45083. private _moveDrag;
  45084. private _pickWithRayOnDragPlane;
  45085. private _pointA;
  45086. private _pointC;
  45087. private _localAxis;
  45088. private _lookAt;
  45089. private _updateDragPlanePosition;
  45090. /**
  45091. * Detaches the behavior from the mesh
  45092. */
  45093. detach(): void;
  45094. }
  45095. }
  45096. declare module "babylonjs/Behaviors/Meshes/multiPointerScaleBehavior" {
  45097. import { Mesh } from "babylonjs/Meshes/mesh";
  45098. import { Behavior } from "babylonjs/Behaviors/behavior";
  45099. /**
  45100. * A behavior that when attached to a mesh will allow the mesh to be scaled
  45101. */
  45102. export class MultiPointerScaleBehavior implements Behavior<Mesh> {
  45103. private _dragBehaviorA;
  45104. private _dragBehaviorB;
  45105. private _startDistance;
  45106. private _initialScale;
  45107. private _targetScale;
  45108. private _ownerNode;
  45109. private _sceneRenderObserver;
  45110. /**
  45111. * Instantiate a new behavior that when attached to a mesh will allow the mesh to be scaled
  45112. */
  45113. constructor();
  45114. /**
  45115. * The name of the behavior
  45116. */
  45117. get name(): string;
  45118. /**
  45119. * Initializes the behavior
  45120. */
  45121. init(): void;
  45122. private _getCurrentDistance;
  45123. /**
  45124. * Attaches the scale behavior the passed in mesh
  45125. * @param ownerNode The mesh that will be scaled around once attached
  45126. */
  45127. attach(ownerNode: Mesh): void;
  45128. /**
  45129. * Detaches the behavior from the mesh
  45130. */
  45131. detach(): void;
  45132. }
  45133. }
  45134. declare module "babylonjs/Behaviors/Meshes/sixDofDragBehavior" {
  45135. import { Behavior } from "babylonjs/Behaviors/behavior";
  45136. import { Mesh } from "babylonjs/Meshes/mesh";
  45137. import { Observable } from "babylonjs/Misc/observable";
  45138. /**
  45139. * A behavior that when attached to a mesh will allow the mesh to be dragged around based on directions and origin of the pointer's ray
  45140. */
  45141. export class SixDofDragBehavior implements Behavior<Mesh> {
  45142. private static _virtualScene;
  45143. private _ownerNode;
  45144. private _sceneRenderObserver;
  45145. private _scene;
  45146. private _targetPosition;
  45147. private _virtualOriginMesh;
  45148. private _virtualDragMesh;
  45149. private _pointerObserver;
  45150. private _moving;
  45151. private _startingOrientation;
  45152. private _attachedElement;
  45153. /**
  45154. * How much faster the object should move when the controller is moving towards it. This is useful to bring objects that are far away from the user to them faster. Set this to 0 to avoid any speed increase. (Default: 3)
  45155. */
  45156. private zDragFactor;
  45157. /**
  45158. * If the object should rotate to face the drag origin
  45159. */
  45160. rotateDraggedObject: boolean;
  45161. /**
  45162. * If the behavior is currently in a dragging state
  45163. */
  45164. dragging: boolean;
  45165. /**
  45166. * The distance towards the target drag position to move each frame. This can be useful to avoid jitter. Set this to 1 for no delay. (Default: 0.2)
  45167. */
  45168. dragDeltaRatio: number;
  45169. /**
  45170. * The id of the pointer that is currently interacting with the behavior (-1 when no pointer is active)
  45171. */
  45172. currentDraggingPointerID: number;
  45173. /**
  45174. * If camera controls should be detached during the drag
  45175. */
  45176. detachCameraControls: boolean;
  45177. /**
  45178. * Fires each time a drag starts
  45179. */
  45180. onDragStartObservable: Observable<{}>;
  45181. /**
  45182. * Fires each time a drag ends (eg. mouse release after drag)
  45183. */
  45184. onDragEndObservable: Observable<{}>;
  45185. /**
  45186. * Instantiates a behavior that when attached to a mesh will allow the mesh to be dragged around based on directions and origin of the pointer's ray
  45187. */
  45188. constructor();
  45189. /**
  45190. * The name of the behavior
  45191. */
  45192. get name(): string;
  45193. /**
  45194. * Initializes the behavior
  45195. */
  45196. init(): void;
  45197. /**
  45198. * In the case of multiplea active cameras, the cameraToUseForPointers should be used if set instead of active camera
  45199. */
  45200. private get _pointerCamera();
  45201. /**
  45202. * Attaches the scale behavior the passed in mesh
  45203. * @param ownerNode The mesh that will be scaled around once attached
  45204. */
  45205. attach(ownerNode: Mesh): void;
  45206. /**
  45207. * Detaches the behavior from the mesh
  45208. */
  45209. detach(): void;
  45210. }
  45211. }
  45212. declare module "babylonjs/Behaviors/Meshes/index" {
  45213. export * from "babylonjs/Behaviors/Meshes/attachToBoxBehavior";
  45214. export * from "babylonjs/Behaviors/Meshes/fadeInOutBehavior";
  45215. export * from "babylonjs/Behaviors/Meshes/multiPointerScaleBehavior";
  45216. export * from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  45217. export * from "babylonjs/Behaviors/Meshes/sixDofDragBehavior";
  45218. }
  45219. declare module "babylonjs/Behaviors/index" {
  45220. export * from "babylonjs/Behaviors/behavior";
  45221. export * from "babylonjs/Behaviors/Cameras/index";
  45222. export * from "babylonjs/Behaviors/Meshes/index";
  45223. }
  45224. declare module "babylonjs/Bones/boneIKController" {
  45225. import { Bone } from "babylonjs/Bones/bone";
  45226. import { Vector3 } from "babylonjs/Maths/math.vector";
  45227. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  45228. import { Nullable } from "babylonjs/types";
  45229. /**
  45230. * Class used to apply inverse kinematics to bones
  45231. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons#boneikcontroller
  45232. */
  45233. export class BoneIKController {
  45234. private static _tmpVecs;
  45235. private static _tmpQuat;
  45236. private static _tmpMats;
  45237. /**
  45238. * Gets or sets the target mesh
  45239. */
  45240. targetMesh: AbstractMesh;
  45241. /** Gets or sets the mesh used as pole */
  45242. poleTargetMesh: AbstractMesh;
  45243. /**
  45244. * Gets or sets the bone used as pole
  45245. */
  45246. poleTargetBone: Nullable<Bone>;
  45247. /**
  45248. * Gets or sets the target position
  45249. */
  45250. targetPosition: Vector3;
  45251. /**
  45252. * Gets or sets the pole target position
  45253. */
  45254. poleTargetPosition: Vector3;
  45255. /**
  45256. * Gets or sets the pole target local offset
  45257. */
  45258. poleTargetLocalOffset: Vector3;
  45259. /**
  45260. * Gets or sets the pole angle
  45261. */
  45262. poleAngle: number;
  45263. /**
  45264. * Gets or sets the mesh associated with the controller
  45265. */
  45266. mesh: AbstractMesh;
  45267. /**
  45268. * The amount to slerp (spherical linear interpolation) to the target. Set this to a value between 0 and 1 (a value of 1 disables slerp)
  45269. */
  45270. slerpAmount: number;
  45271. private _bone1Quat;
  45272. private _bone1Mat;
  45273. private _bone2Ang;
  45274. private _bone1;
  45275. private _bone2;
  45276. private _bone1Length;
  45277. private _bone2Length;
  45278. private _maxAngle;
  45279. private _maxReach;
  45280. private _rightHandedSystem;
  45281. private _bendAxis;
  45282. private _slerping;
  45283. private _adjustRoll;
  45284. /**
  45285. * Gets or sets maximum allowed angle
  45286. */
  45287. get maxAngle(): number;
  45288. set maxAngle(value: number);
  45289. /**
  45290. * Creates a new BoneIKController
  45291. * @param mesh defines the mesh to control
  45292. * @param bone defines the bone to control
  45293. * @param options defines options to set up the controller
  45294. */
  45295. constructor(mesh: AbstractMesh, bone: Bone, options?: {
  45296. targetMesh?: AbstractMesh;
  45297. poleTargetMesh?: AbstractMesh;
  45298. poleTargetBone?: Bone;
  45299. poleTargetLocalOffset?: Vector3;
  45300. poleAngle?: number;
  45301. bendAxis?: Vector3;
  45302. maxAngle?: number;
  45303. slerpAmount?: number;
  45304. });
  45305. private _setMaxAngle;
  45306. /**
  45307. * Force the controller to update the bones
  45308. */
  45309. update(): void;
  45310. }
  45311. }
  45312. declare module "babylonjs/Bones/boneLookController" {
  45313. import { Vector3 } from "babylonjs/Maths/math.vector";
  45314. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  45315. import { Bone } from "babylonjs/Bones/bone";
  45316. import { Space } from "babylonjs/Maths/math.axis";
  45317. /**
  45318. * Class used to make a bone look toward a point in space
  45319. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons#bonelookcontroller
  45320. */
  45321. export class BoneLookController {
  45322. private static _tmpVecs;
  45323. private static _tmpQuat;
  45324. private static _tmpMats;
  45325. /**
  45326. * The target Vector3 that the bone will look at
  45327. */
  45328. target: Vector3;
  45329. /**
  45330. * The mesh that the bone is attached to
  45331. */
  45332. mesh: AbstractMesh;
  45333. /**
  45334. * The bone that will be looking to the target
  45335. */
  45336. bone: Bone;
  45337. /**
  45338. * The up axis of the coordinate system that is used when the bone is rotated
  45339. */
  45340. upAxis: Vector3;
  45341. /**
  45342. * The space that the up axis is in - Space.BONE, Space.LOCAL (default), or Space.WORLD
  45343. */
  45344. upAxisSpace: Space;
  45345. /**
  45346. * Used to make an adjustment to the yaw of the bone
  45347. */
  45348. adjustYaw: number;
  45349. /**
  45350. * Used to make an adjustment to the pitch of the bone
  45351. */
  45352. adjustPitch: number;
  45353. /**
  45354. * Used to make an adjustment to the roll of the bone
  45355. */
  45356. adjustRoll: number;
  45357. /**
  45358. * The amount to slerp (spherical linear interpolation) to the target. Set this to a value between 0 and 1 (a value of 1 disables slerp)
  45359. */
  45360. slerpAmount: number;
  45361. private _minYaw;
  45362. private _maxYaw;
  45363. private _minPitch;
  45364. private _maxPitch;
  45365. private _minYawSin;
  45366. private _minYawCos;
  45367. private _maxYawSin;
  45368. private _maxYawCos;
  45369. private _midYawConstraint;
  45370. private _minPitchTan;
  45371. private _maxPitchTan;
  45372. private _boneQuat;
  45373. private _slerping;
  45374. private _transformYawPitch;
  45375. private _transformYawPitchInv;
  45376. private _firstFrameSkipped;
  45377. private _yawRange;
  45378. private _fowardAxis;
  45379. /**
  45380. * Gets or sets the minimum yaw angle that the bone can look to
  45381. */
  45382. get minYaw(): number;
  45383. set minYaw(value: number);
  45384. /**
  45385. * Gets or sets the maximum yaw angle that the bone can look to
  45386. */
  45387. get maxYaw(): number;
  45388. set maxYaw(value: number);
  45389. /**
  45390. * Gets or sets the minimum pitch angle that the bone can look to
  45391. */
  45392. get minPitch(): number;
  45393. set minPitch(value: number);
  45394. /**
  45395. * Gets or sets the maximum pitch angle that the bone can look to
  45396. */
  45397. get maxPitch(): number;
  45398. set maxPitch(value: number);
  45399. /**
  45400. * Create a BoneLookController
  45401. * @param mesh the mesh that the bone belongs to
  45402. * @param bone the bone that will be looking to the target
  45403. * @param target the target Vector3 to look at
  45404. * @param options optional settings:
  45405. * * maxYaw: the maximum angle the bone will yaw to
  45406. * * minYaw: the minimum angle the bone will yaw to
  45407. * * maxPitch: the maximum angle the bone will pitch to
  45408. * * minPitch: the minimum angle the bone will yaw to
  45409. * * slerpAmount: set the between 0 and 1 to make the bone slerp to the target.
  45410. * * upAxis: the up axis of the coordinate system
  45411. * * upAxisSpace: the space that the up axis is in - Space.BONE, Space.LOCAL (default), or Space.WORLD.
  45412. * * yawAxis: set yawAxis if the bone does not yaw on the y axis
  45413. * * pitchAxis: set pitchAxis if the bone does not pitch on the x axis
  45414. * * adjustYaw: used to make an adjustment to the yaw of the bone
  45415. * * adjustPitch: used to make an adjustment to the pitch of the bone
  45416. * * adjustRoll: used to make an adjustment to the roll of the bone
  45417. **/
  45418. constructor(mesh: AbstractMesh, bone: Bone, target: Vector3, options?: {
  45419. maxYaw?: number;
  45420. minYaw?: number;
  45421. maxPitch?: number;
  45422. minPitch?: number;
  45423. slerpAmount?: number;
  45424. upAxis?: Vector3;
  45425. upAxisSpace?: Space;
  45426. yawAxis?: Vector3;
  45427. pitchAxis?: Vector3;
  45428. adjustYaw?: number;
  45429. adjustPitch?: number;
  45430. adjustRoll?: number;
  45431. });
  45432. /**
  45433. * Update the bone to look at the target. This should be called before the scene is rendered (use scene.registerBeforeRender())
  45434. */
  45435. update(): void;
  45436. private _getAngleDiff;
  45437. private _getAngleBetween;
  45438. private _isAngleBetween;
  45439. }
  45440. }
  45441. declare module "babylonjs/Bones/index" {
  45442. export * from "babylonjs/Bones/bone";
  45443. export * from "babylonjs/Bones/boneIKController";
  45444. export * from "babylonjs/Bones/boneLookController";
  45445. export * from "babylonjs/Bones/skeleton";
  45446. }
  45447. declare module "babylonjs/Cameras/Inputs/arcRotateCameraGamepadInput" {
  45448. import { Nullable } from "babylonjs/types";
  45449. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  45450. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  45451. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  45452. /**
  45453. * Manage the gamepad inputs to control an arc rotate camera.
  45454. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  45455. */
  45456. export class ArcRotateCameraGamepadInput implements ICameraInput<ArcRotateCamera> {
  45457. /**
  45458. * Defines the camera the input is attached to.
  45459. */
  45460. camera: ArcRotateCamera;
  45461. /**
  45462. * Defines the gamepad the input is gathering event from.
  45463. */
  45464. gamepad: Nullable<Gamepad>;
  45465. /**
  45466. * Defines the gamepad rotation sensiblity.
  45467. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  45468. */
  45469. gamepadRotationSensibility: number;
  45470. /**
  45471. * Defines the gamepad move sensiblity.
  45472. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  45473. */
  45474. gamepadMoveSensibility: number;
  45475. private _yAxisScale;
  45476. /**
  45477. * Gets or sets a boolean indicating that Yaxis (for right stick) should be inverted
  45478. */
  45479. get invertYAxis(): boolean;
  45480. set invertYAxis(value: boolean);
  45481. private _onGamepadConnectedObserver;
  45482. private _onGamepadDisconnectedObserver;
  45483. /**
  45484. * Attach the input controls to a specific dom element to get the input from.
  45485. * @param element Defines the element the controls should be listened from
  45486. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  45487. */
  45488. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  45489. /**
  45490. * Detach the current controls from the specified dom element.
  45491. * @param element Defines the element to stop listening the inputs from
  45492. */
  45493. detachControl(element: Nullable<HTMLElement>): void;
  45494. /**
  45495. * Update the current camera state depending on the inputs that have been used this frame.
  45496. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  45497. */
  45498. checkInputs(): void;
  45499. /**
  45500. * Gets the class name of the current intput.
  45501. * @returns the class name
  45502. */
  45503. getClassName(): string;
  45504. /**
  45505. * Get the friendly name associated with the input class.
  45506. * @returns the input friendly name
  45507. */
  45508. getSimpleName(): string;
  45509. }
  45510. }
  45511. declare module "babylonjs/Cameras/Inputs/arcRotateCameraVRDeviceOrientationInput" {
  45512. import { Nullable } from "babylonjs/types";
  45513. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  45514. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  45515. module "babylonjs/Cameras/arcRotateCameraInputsManager" {
  45516. interface ArcRotateCameraInputsManager {
  45517. /**
  45518. * Add orientation input support to the input manager.
  45519. * @returns the current input manager
  45520. */
  45521. addVRDeviceOrientation(): ArcRotateCameraInputsManager;
  45522. }
  45523. }
  45524. /**
  45525. * Manage the device orientation inputs (gyroscope) to control an arc rotate camera.
  45526. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  45527. */
  45528. export class ArcRotateCameraVRDeviceOrientationInput implements ICameraInput<ArcRotateCamera> {
  45529. /**
  45530. * Defines the camera the input is attached to.
  45531. */
  45532. camera: ArcRotateCamera;
  45533. /**
  45534. * Defines a correction factor applied on the alpha value retrieved from the orientation events.
  45535. */
  45536. alphaCorrection: number;
  45537. /**
  45538. * Defines a correction factor applied on the gamma value retrieved from the orientation events.
  45539. */
  45540. gammaCorrection: number;
  45541. private _alpha;
  45542. private _gamma;
  45543. private _dirty;
  45544. private _deviceOrientationHandler;
  45545. /**
  45546. * Instantiate a new ArcRotateCameraVRDeviceOrientationInput.
  45547. */
  45548. constructor();
  45549. /**
  45550. * Attach the input controls to a specific dom element to get the input from.
  45551. * @param element Defines the element the controls should be listened from
  45552. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  45553. */
  45554. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  45555. /** @hidden */
  45556. _onOrientationEvent(evt: DeviceOrientationEvent): void;
  45557. /**
  45558. * Update the current camera state depending on the inputs that have been used this frame.
  45559. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  45560. */
  45561. checkInputs(): void;
  45562. /**
  45563. * Detach the current controls from the specified dom element.
  45564. * @param element Defines the element to stop listening the inputs from
  45565. */
  45566. detachControl(element: Nullable<HTMLElement>): void;
  45567. /**
  45568. * Gets the class name of the current intput.
  45569. * @returns the class name
  45570. */
  45571. getClassName(): string;
  45572. /**
  45573. * Get the friendly name associated with the input class.
  45574. * @returns the input friendly name
  45575. */
  45576. getSimpleName(): string;
  45577. }
  45578. }
  45579. declare module "babylonjs/Cameras/Inputs/flyCameraMouseInput" {
  45580. import { Nullable } from "babylonjs/types";
  45581. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  45582. import { FlyCamera } from "babylonjs/Cameras/flyCamera";
  45583. /**
  45584. * Listen to mouse events to control the camera.
  45585. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  45586. */
  45587. export class FlyCameraMouseInput implements ICameraInput<FlyCamera> {
  45588. /**
  45589. * Defines the camera the input is attached to.
  45590. */
  45591. camera: FlyCamera;
  45592. /**
  45593. * Defines if touch is enabled. (Default is true.)
  45594. */
  45595. touchEnabled: boolean;
  45596. /**
  45597. * Defines the buttons associated with the input to handle camera rotation.
  45598. */
  45599. buttons: number[];
  45600. /**
  45601. * Assign buttons for Yaw control.
  45602. */
  45603. buttonsYaw: number[];
  45604. /**
  45605. * Assign buttons for Pitch control.
  45606. */
  45607. buttonsPitch: number[];
  45608. /**
  45609. * Assign buttons for Roll control.
  45610. */
  45611. buttonsRoll: number[];
  45612. /**
  45613. * Detect if any button is being pressed while mouse is moved.
  45614. * -1 = Mouse locked.
  45615. * 0 = Left button.
  45616. * 1 = Middle Button.
  45617. * 2 = Right Button.
  45618. */
  45619. activeButton: number;
  45620. /**
  45621. * Defines the pointer's angular sensibility, to control the camera rotation speed.
  45622. * Higher values reduce its sensitivity.
  45623. */
  45624. angularSensibility: number;
  45625. private _mousemoveCallback;
  45626. private _observer;
  45627. private _rollObserver;
  45628. private previousPosition;
  45629. private noPreventDefault;
  45630. private element;
  45631. /**
  45632. * Listen to mouse events to control the camera.
  45633. * @param touchEnabled Define if touch is enabled. (Default is true.)
  45634. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  45635. */
  45636. constructor(touchEnabled?: boolean);
  45637. /**
  45638. * Attach the mouse control to the HTML DOM element.
  45639. * @param element Defines the element that listens to the input events.
  45640. * @param noPreventDefault Defines whether events caught by the controls should call preventdefault().
  45641. */
  45642. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  45643. /**
  45644. * Detach the current controls from the specified dom element.
  45645. * @param element Defines the element to stop listening the inputs from
  45646. */
  45647. detachControl(element: Nullable<HTMLElement>): void;
  45648. /**
  45649. * Gets the class name of the current input.
  45650. * @returns the class name.
  45651. */
  45652. getClassName(): string;
  45653. /**
  45654. * Get the friendly name associated with the input class.
  45655. * @returns the input's friendly name.
  45656. */
  45657. getSimpleName(): string;
  45658. private _pointerInput;
  45659. private _onMouseMove;
  45660. /**
  45661. * Rotate camera by mouse offset.
  45662. */
  45663. private rotateCamera;
  45664. }
  45665. }
  45666. declare module "babylonjs/Cameras/flyCameraInputsManager" {
  45667. import { FlyCamera } from "babylonjs/Cameras/flyCamera";
  45668. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  45669. /**
  45670. * Default Inputs manager for the FlyCamera.
  45671. * It groups all the default supported inputs for ease of use.
  45672. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  45673. */
  45674. export class FlyCameraInputsManager extends CameraInputsManager<FlyCamera> {
  45675. /**
  45676. * Instantiates a new FlyCameraInputsManager.
  45677. * @param camera Defines the camera the inputs belong to.
  45678. */
  45679. constructor(camera: FlyCamera);
  45680. /**
  45681. * Add keyboard input support to the input manager.
  45682. * @returns the new FlyCameraKeyboardMoveInput().
  45683. */
  45684. addKeyboard(): FlyCameraInputsManager;
  45685. /**
  45686. * Add mouse input support to the input manager.
  45687. * @param touchEnabled Enable touch screen support.
  45688. * @returns the new FlyCameraMouseInput().
  45689. */
  45690. addMouse(touchEnabled?: boolean): FlyCameraInputsManager;
  45691. }
  45692. }
  45693. declare module "babylonjs/Cameras/flyCamera" {
  45694. import { Scene } from "babylonjs/scene";
  45695. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  45696. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  45697. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  45698. import { FlyCameraInputsManager } from "babylonjs/Cameras/flyCameraInputsManager";
  45699. /**
  45700. * This is a flying camera, designed for 3D movement and rotation in all directions,
  45701. * such as in a 3D Space Shooter or a Flight Simulator.
  45702. */
  45703. export class FlyCamera extends TargetCamera {
  45704. /**
  45705. * Define the collision ellipsoid of the camera.
  45706. * This is helpful for simulating a camera body, like a player's body.
  45707. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  45708. */
  45709. ellipsoid: Vector3;
  45710. /**
  45711. * Define an offset for the position of the ellipsoid around the camera.
  45712. * This can be helpful if the camera is attached away from the player's body center,
  45713. * such as at its head.
  45714. */
  45715. ellipsoidOffset: Vector3;
  45716. /**
  45717. * Enable or disable collisions of the camera with the rest of the scene objects.
  45718. */
  45719. checkCollisions: boolean;
  45720. /**
  45721. * Enable or disable gravity on the camera.
  45722. */
  45723. applyGravity: boolean;
  45724. /**
  45725. * Define the current direction the camera is moving to.
  45726. */
  45727. cameraDirection: Vector3;
  45728. /**
  45729. * Define the current local rotation of the camera as a quaternion to prevent Gimbal lock.
  45730. * This overrides and empties cameraRotation.
  45731. */
  45732. rotationQuaternion: Quaternion;
  45733. /**
  45734. * Track Roll to maintain the wanted Rolling when looking around.
  45735. */
  45736. _trackRoll: number;
  45737. /**
  45738. * Slowly correct the Roll to its original value after a Pitch+Yaw rotation.
  45739. */
  45740. rollCorrect: number;
  45741. /**
  45742. * Mimic a banked turn, Rolling the camera when Yawing.
  45743. * It's recommended to use rollCorrect = 10 for faster banking correction.
  45744. */
  45745. bankedTurn: boolean;
  45746. /**
  45747. * Limit in radians for how much Roll banking will add. (Default: 90°)
  45748. */
  45749. bankedTurnLimit: number;
  45750. /**
  45751. * Value of 0 disables the banked Roll.
  45752. * Value of 1 is equal to the Yaw angle in radians.
  45753. */
  45754. bankedTurnMultiplier: number;
  45755. /**
  45756. * The inputs manager loads all the input sources, such as keyboard and mouse.
  45757. */
  45758. inputs: FlyCameraInputsManager;
  45759. /**
  45760. * Gets the input sensibility for mouse input.
  45761. * Higher values reduce sensitivity.
  45762. */
  45763. get angularSensibility(): number;
  45764. /**
  45765. * Sets the input sensibility for a mouse input.
  45766. * Higher values reduce sensitivity.
  45767. */
  45768. set angularSensibility(value: number);
  45769. /**
  45770. * Get the keys for camera movement forward.
  45771. */
  45772. get keysForward(): number[];
  45773. /**
  45774. * Set the keys for camera movement forward.
  45775. */
  45776. set keysForward(value: number[]);
  45777. /**
  45778. * Get the keys for camera movement backward.
  45779. */
  45780. get keysBackward(): number[];
  45781. set keysBackward(value: number[]);
  45782. /**
  45783. * Get the keys for camera movement up.
  45784. */
  45785. get keysUp(): number[];
  45786. /**
  45787. * Set the keys for camera movement up.
  45788. */
  45789. set keysUp(value: number[]);
  45790. /**
  45791. * Get the keys for camera movement down.
  45792. */
  45793. get keysDown(): number[];
  45794. /**
  45795. * Set the keys for camera movement down.
  45796. */
  45797. set keysDown(value: number[]);
  45798. /**
  45799. * Get the keys for camera movement left.
  45800. */
  45801. get keysLeft(): number[];
  45802. /**
  45803. * Set the keys for camera movement left.
  45804. */
  45805. set keysLeft(value: number[]);
  45806. /**
  45807. * Set the keys for camera movement right.
  45808. */
  45809. get keysRight(): number[];
  45810. /**
  45811. * Set the keys for camera movement right.
  45812. */
  45813. set keysRight(value: number[]);
  45814. /**
  45815. * Event raised when the camera collides with a mesh in the scene.
  45816. */
  45817. onCollide: (collidedMesh: AbstractMesh) => void;
  45818. private _collider;
  45819. private _needMoveForGravity;
  45820. private _oldPosition;
  45821. private _diffPosition;
  45822. private _newPosition;
  45823. /** @hidden */
  45824. _localDirection: Vector3;
  45825. /** @hidden */
  45826. _transformedDirection: Vector3;
  45827. /**
  45828. * Instantiates a FlyCamera.
  45829. * This is a flying camera, designed for 3D movement and rotation in all directions,
  45830. * such as in a 3D Space Shooter or a Flight Simulator.
  45831. * @param name Define the name of the camera in the scene.
  45832. * @param position Define the starting position of the camera in the scene.
  45833. * @param scene Define the scene the camera belongs to.
  45834. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active, if no other camera has been defined as active.
  45835. */
  45836. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  45837. /**
  45838. * Attach a control to the HTML DOM element.
  45839. * @param element Defines the element that listens to the input events.
  45840. * @param noPreventDefault Defines whether events caught by the controls should call preventdefault(). https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault
  45841. */
  45842. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  45843. /**
  45844. * Detach a control from the HTML DOM element.
  45845. * The camera will stop reacting to that input.
  45846. * @param element Defines the element that listens to the input events.
  45847. */
  45848. detachControl(element: HTMLElement): void;
  45849. private _collisionMask;
  45850. /**
  45851. * Get the mask that the camera ignores in collision events.
  45852. */
  45853. get collisionMask(): number;
  45854. /**
  45855. * Set the mask that the camera ignores in collision events.
  45856. */
  45857. set collisionMask(mask: number);
  45858. /** @hidden */
  45859. _collideWithWorld(displacement: Vector3): void;
  45860. /** @hidden */
  45861. private _onCollisionPositionChange;
  45862. /** @hidden */
  45863. _checkInputs(): void;
  45864. /** @hidden */
  45865. _decideIfNeedsToMove(): boolean;
  45866. /** @hidden */
  45867. _updatePosition(): void;
  45868. /**
  45869. * Restore the Roll to its target value at the rate specified.
  45870. * @param rate - Higher means slower restoring.
  45871. * @hidden
  45872. */
  45873. restoreRoll(rate: number): void;
  45874. /**
  45875. * Destroy the camera and release the current resources held by it.
  45876. */
  45877. dispose(): void;
  45878. /**
  45879. * Get the current object class name.
  45880. * @returns the class name.
  45881. */
  45882. getClassName(): string;
  45883. }
  45884. }
  45885. declare module "babylonjs/Cameras/Inputs/flyCameraKeyboardInput" {
  45886. import { Nullable } from "babylonjs/types";
  45887. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  45888. import { FlyCamera } from "babylonjs/Cameras/flyCamera";
  45889. /**
  45890. * Listen to keyboard events to control the camera.
  45891. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  45892. */
  45893. export class FlyCameraKeyboardInput implements ICameraInput<FlyCamera> {
  45894. /**
  45895. * Defines the camera the input is attached to.
  45896. */
  45897. camera: FlyCamera;
  45898. /**
  45899. * The list of keyboard keys used to control the forward move of the camera.
  45900. */
  45901. keysForward: number[];
  45902. /**
  45903. * The list of keyboard keys used to control the backward move of the camera.
  45904. */
  45905. keysBackward: number[];
  45906. /**
  45907. * The list of keyboard keys used to control the forward move of the camera.
  45908. */
  45909. keysUp: number[];
  45910. /**
  45911. * The list of keyboard keys used to control the backward move of the camera.
  45912. */
  45913. keysDown: number[];
  45914. /**
  45915. * The list of keyboard keys used to control the right strafe move of the camera.
  45916. */
  45917. keysRight: number[];
  45918. /**
  45919. * The list of keyboard keys used to control the left strafe move of the camera.
  45920. */
  45921. keysLeft: number[];
  45922. private _keys;
  45923. private _onCanvasBlurObserver;
  45924. private _onKeyboardObserver;
  45925. private _engine;
  45926. private _scene;
  45927. /**
  45928. * Attach the input controls to a specific dom element to get the input from.
  45929. * @param element Defines the element the controls should be listened from
  45930. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  45931. */
  45932. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  45933. /**
  45934. * Detach the current controls from the specified dom element.
  45935. * @param element Defines the element to stop listening the inputs from
  45936. */
  45937. detachControl(element: Nullable<HTMLElement>): void;
  45938. /**
  45939. * Gets the class name of the current intput.
  45940. * @returns the class name
  45941. */
  45942. getClassName(): string;
  45943. /** @hidden */
  45944. _onLostFocus(e: FocusEvent): void;
  45945. /**
  45946. * Get the friendly name associated with the input class.
  45947. * @returns the input friendly name
  45948. */
  45949. getSimpleName(): string;
  45950. /**
  45951. * Update the current camera state depending on the inputs that have been used this frame.
  45952. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  45953. */
  45954. checkInputs(): void;
  45955. }
  45956. }
  45957. declare module "babylonjs/Cameras/Inputs/followCameraMouseWheelInput" {
  45958. import { Nullable } from "babylonjs/types";
  45959. import { FollowCamera } from "babylonjs/Cameras/followCamera";
  45960. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  45961. /**
  45962. * Manage the mouse wheel inputs to control a follow camera.
  45963. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  45964. */
  45965. export class FollowCameraMouseWheelInput implements ICameraInput<FollowCamera> {
  45966. /**
  45967. * Defines the camera the input is attached to.
  45968. */
  45969. camera: FollowCamera;
  45970. /**
  45971. * Moue wheel controls zoom. (Mouse wheel modifies camera.radius value.)
  45972. */
  45973. axisControlRadius: boolean;
  45974. /**
  45975. * Moue wheel controls height. (Mouse wheel modifies camera.heightOffset value.)
  45976. */
  45977. axisControlHeight: boolean;
  45978. /**
  45979. * Moue wheel controls angle. (Mouse wheel modifies camera.rotationOffset value.)
  45980. */
  45981. axisControlRotation: boolean;
  45982. /**
  45983. * Gets or Set the mouse wheel precision or how fast is the camera moves in
  45984. * relation to mouseWheel events.
  45985. */
  45986. wheelPrecision: number;
  45987. /**
  45988. * wheelDeltaPercentage will be used instead of wheelPrecision if different from 0.
  45989. * It defines the percentage of current camera.radius to use as delta when wheel is used.
  45990. */
  45991. wheelDeltaPercentage: number;
  45992. private _wheel;
  45993. private _observer;
  45994. /**
  45995. * Attach the input controls to a specific dom element to get the input from.
  45996. * @param element Defines the element the controls should be listened from
  45997. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  45998. */
  45999. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  46000. /**
  46001. * Detach the current controls from the specified dom element.
  46002. * @param element Defines the element to stop listening the inputs from
  46003. */
  46004. detachControl(element: Nullable<HTMLElement>): void;
  46005. /**
  46006. * Gets the class name of the current intput.
  46007. * @returns the class name
  46008. */
  46009. getClassName(): string;
  46010. /**
  46011. * Get the friendly name associated with the input class.
  46012. * @returns the input friendly name
  46013. */
  46014. getSimpleName(): string;
  46015. }
  46016. }
  46017. declare module "babylonjs/Cameras/Inputs/followCameraPointersInput" {
  46018. import { Nullable } from "babylonjs/types";
  46019. import { FollowCamera } from "babylonjs/Cameras/followCamera";
  46020. import { BaseCameraPointersInput } from "babylonjs/Cameras/Inputs/BaseCameraPointersInput";
  46021. import { PointerTouch } from "babylonjs/Events/pointerEvents";
  46022. /**
  46023. * Manage the pointers inputs to control an follow camera.
  46024. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46025. */
  46026. export class FollowCameraPointersInput extends BaseCameraPointersInput {
  46027. /**
  46028. * Defines the camera the input is attached to.
  46029. */
  46030. camera: FollowCamera;
  46031. /**
  46032. * Gets the class name of the current input.
  46033. * @returns the class name
  46034. */
  46035. getClassName(): string;
  46036. /**
  46037. * Defines the pointer angular sensibility along the X axis or how fast is
  46038. * the camera rotating.
  46039. * A negative number will reverse the axis direction.
  46040. */
  46041. angularSensibilityX: number;
  46042. /**
  46043. * Defines the pointer angular sensibility along the Y axis or how fast is
  46044. * the camera rotating.
  46045. * A negative number will reverse the axis direction.
  46046. */
  46047. angularSensibilityY: number;
  46048. /**
  46049. * Defines the pointer pinch precision or how fast is the camera zooming.
  46050. * A negative number will reverse the axis direction.
  46051. */
  46052. pinchPrecision: number;
  46053. /**
  46054. * pinchDeltaPercentage will be used instead of pinchPrecision if different
  46055. * from 0.
  46056. * It defines the percentage of current camera.radius to use as delta when
  46057. * pinch zoom is used.
  46058. */
  46059. pinchDeltaPercentage: number;
  46060. /**
  46061. * Pointer X axis controls zoom. (X axis modifies camera.radius value.)
  46062. */
  46063. axisXControlRadius: boolean;
  46064. /**
  46065. * Pointer X axis controls height. (X axis modifies camera.heightOffset value.)
  46066. */
  46067. axisXControlHeight: boolean;
  46068. /**
  46069. * Pointer X axis controls angle. (X axis modifies camera.rotationOffset value.)
  46070. */
  46071. axisXControlRotation: boolean;
  46072. /**
  46073. * Pointer Y axis controls zoom. (Y axis modifies camera.radius value.)
  46074. */
  46075. axisYControlRadius: boolean;
  46076. /**
  46077. * Pointer Y axis controls height. (Y axis modifies camera.heightOffset value.)
  46078. */
  46079. axisYControlHeight: boolean;
  46080. /**
  46081. * Pointer Y axis controls angle. (Y axis modifies camera.rotationOffset value.)
  46082. */
  46083. axisYControlRotation: boolean;
  46084. /**
  46085. * Pinch controls zoom. (Pinch modifies camera.radius value.)
  46086. */
  46087. axisPinchControlRadius: boolean;
  46088. /**
  46089. * Pinch controls height. (Pinch modifies camera.heightOffset value.)
  46090. */
  46091. axisPinchControlHeight: boolean;
  46092. /**
  46093. * Pinch controls angle. (Pinch modifies camera.rotationOffset value.)
  46094. */
  46095. axisPinchControlRotation: boolean;
  46096. /**
  46097. * Log error messages if basic misconfiguration has occurred.
  46098. */
  46099. warningEnable: boolean;
  46100. protected onTouch(pointA: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  46101. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  46102. private _warningCounter;
  46103. private _warning;
  46104. }
  46105. }
  46106. declare module "babylonjs/Cameras/followCameraInputsManager" {
  46107. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  46108. import { FollowCamera } from "babylonjs/Cameras/followCamera";
  46109. /**
  46110. * Default Inputs manager for the FollowCamera.
  46111. * It groups all the default supported inputs for ease of use.
  46112. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46113. */
  46114. export class FollowCameraInputsManager extends CameraInputsManager<FollowCamera> {
  46115. /**
  46116. * Instantiates a new FollowCameraInputsManager.
  46117. * @param camera Defines the camera the inputs belong to
  46118. */
  46119. constructor(camera: FollowCamera);
  46120. /**
  46121. * Add keyboard input support to the input manager.
  46122. * @returns the current input manager
  46123. */
  46124. addKeyboard(): FollowCameraInputsManager;
  46125. /**
  46126. * Add mouse wheel input support to the input manager.
  46127. * @returns the current input manager
  46128. */
  46129. addMouseWheel(): FollowCameraInputsManager;
  46130. /**
  46131. * Add pointers input support to the input manager.
  46132. * @returns the current input manager
  46133. */
  46134. addPointers(): FollowCameraInputsManager;
  46135. /**
  46136. * Add orientation input support to the input manager.
  46137. * @returns the current input manager
  46138. */
  46139. addVRDeviceOrientation(): FollowCameraInputsManager;
  46140. }
  46141. }
  46142. declare module "babylonjs/Cameras/followCamera" {
  46143. import { Nullable } from "babylonjs/types";
  46144. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  46145. import { Scene } from "babylonjs/scene";
  46146. import { Vector3 } from "babylonjs/Maths/math.vector";
  46147. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  46148. import { FollowCameraInputsManager } from "babylonjs/Cameras/followCameraInputsManager";
  46149. /**
  46150. * A follow camera takes a mesh as a target and follows it as it moves. Both a free camera version followCamera and
  46151. * an arc rotate version arcFollowCamera are available.
  46152. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  46153. */
  46154. export class FollowCamera extends TargetCamera {
  46155. /**
  46156. * Distance the follow camera should follow an object at
  46157. */
  46158. radius: number;
  46159. /**
  46160. * Minimum allowed distance of the camera to the axis of rotation
  46161. * (The camera can not get closer).
  46162. * This can help limiting how the Camera is able to move in the scene.
  46163. */
  46164. lowerRadiusLimit: Nullable<number>;
  46165. /**
  46166. * Maximum allowed distance of the camera to the axis of rotation
  46167. * (The camera can not get further).
  46168. * This can help limiting how the Camera is able to move in the scene.
  46169. */
  46170. upperRadiusLimit: Nullable<number>;
  46171. /**
  46172. * Define a rotation offset between the camera and the object it follows
  46173. */
  46174. rotationOffset: number;
  46175. /**
  46176. * Minimum allowed angle to camera position relative to target object.
  46177. * This can help limiting how the Camera is able to move in the scene.
  46178. */
  46179. lowerRotationOffsetLimit: Nullable<number>;
  46180. /**
  46181. * Maximum allowed angle to camera position relative to target object.
  46182. * This can help limiting how the Camera is able to move in the scene.
  46183. */
  46184. upperRotationOffsetLimit: Nullable<number>;
  46185. /**
  46186. * Define a height offset between the camera and the object it follows.
  46187. * It can help following an object from the top (like a car chaing a plane)
  46188. */
  46189. heightOffset: number;
  46190. /**
  46191. * Minimum allowed height of camera position relative to target object.
  46192. * This can help limiting how the Camera is able to move in the scene.
  46193. */
  46194. lowerHeightOffsetLimit: Nullable<number>;
  46195. /**
  46196. * Maximum allowed height of camera position relative to target object.
  46197. * This can help limiting how the Camera is able to move in the scene.
  46198. */
  46199. upperHeightOffsetLimit: Nullable<number>;
  46200. /**
  46201. * Define how fast the camera can accelerate to follow it s target.
  46202. */
  46203. cameraAcceleration: number;
  46204. /**
  46205. * Define the speed limit of the camera following an object.
  46206. */
  46207. maxCameraSpeed: number;
  46208. /**
  46209. * Define the target of the camera.
  46210. */
  46211. lockedTarget: Nullable<AbstractMesh>;
  46212. /**
  46213. * Defines the input associated with the camera.
  46214. */
  46215. inputs: FollowCameraInputsManager;
  46216. /**
  46217. * Instantiates the follow camera.
  46218. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  46219. * @param name Define the name of the camera in the scene
  46220. * @param position Define the position of the camera
  46221. * @param scene Define the scene the camera belong to
  46222. * @param lockedTarget Define the target of the camera
  46223. */
  46224. constructor(name: string, position: Vector3, scene: Scene, lockedTarget?: Nullable<AbstractMesh>);
  46225. private _follow;
  46226. /**
  46227. * Attached controls to the current camera.
  46228. * @param element Defines the element the controls should be listened from
  46229. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  46230. */
  46231. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  46232. /**
  46233. * Detach the current controls from the camera.
  46234. * The camera will stop reacting to inputs.
  46235. * @param element Defines the element to stop listening the inputs from
  46236. */
  46237. detachControl(element: HTMLElement): void;
  46238. /** @hidden */
  46239. _checkInputs(): void;
  46240. private _checkLimits;
  46241. /**
  46242. * Gets the camera class name.
  46243. * @returns the class name
  46244. */
  46245. getClassName(): string;
  46246. }
  46247. /**
  46248. * Arc Rotate version of the follow camera.
  46249. * It still follows a Defined mesh but in an Arc Rotate Camera fashion.
  46250. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  46251. */
  46252. export class ArcFollowCamera extends TargetCamera {
  46253. /** The longitudinal angle of the camera */
  46254. alpha: number;
  46255. /** The latitudinal angle of the camera */
  46256. beta: number;
  46257. /** The radius of the camera from its target */
  46258. radius: number;
  46259. private _cartesianCoordinates;
  46260. /** Define the camera target (the mesh it should follow) */
  46261. private _meshTarget;
  46262. /**
  46263. * Instantiates a new ArcFollowCamera
  46264. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  46265. * @param name Define the name of the camera
  46266. * @param alpha Define the rotation angle of the camera around the logitudinal axis
  46267. * @param beta Define the rotation angle of the camera around the elevation axis
  46268. * @param radius Define the radius of the camera from its target point
  46269. * @param target Define the target of the camera
  46270. * @param scene Define the scene the camera belongs to
  46271. */
  46272. constructor(name: string,
  46273. /** The longitudinal angle of the camera */
  46274. alpha: number,
  46275. /** The latitudinal angle of the camera */
  46276. beta: number,
  46277. /** The radius of the camera from its target */
  46278. radius: number,
  46279. /** Define the camera target (the mesh it should follow) */
  46280. target: Nullable<AbstractMesh>, scene: Scene);
  46281. private _follow;
  46282. /** @hidden */
  46283. _checkInputs(): void;
  46284. /**
  46285. * Returns the class name of the object.
  46286. * It is mostly used internally for serialization purposes.
  46287. */
  46288. getClassName(): string;
  46289. }
  46290. }
  46291. declare module "babylonjs/Cameras/Inputs/followCameraKeyboardMoveInput" {
  46292. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  46293. import { FollowCamera } from "babylonjs/Cameras/followCamera";
  46294. import { Nullable } from "babylonjs/types";
  46295. /**
  46296. * Manage the keyboard inputs to control the movement of a follow camera.
  46297. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46298. */
  46299. export class FollowCameraKeyboardMoveInput implements ICameraInput<FollowCamera> {
  46300. /**
  46301. * Defines the camera the input is attached to.
  46302. */
  46303. camera: FollowCamera;
  46304. /**
  46305. * Defines the list of key codes associated with the up action (increase heightOffset)
  46306. */
  46307. keysHeightOffsetIncr: number[];
  46308. /**
  46309. * Defines the list of key codes associated with the down action (decrease heightOffset)
  46310. */
  46311. keysHeightOffsetDecr: number[];
  46312. /**
  46313. * Defines whether the Alt modifier key is required to move up/down (alter heightOffset)
  46314. */
  46315. keysHeightOffsetModifierAlt: boolean;
  46316. /**
  46317. * Defines whether the Ctrl modifier key is required to move up/down (alter heightOffset)
  46318. */
  46319. keysHeightOffsetModifierCtrl: boolean;
  46320. /**
  46321. * Defines whether the Shift modifier key is required to move up/down (alter heightOffset)
  46322. */
  46323. keysHeightOffsetModifierShift: boolean;
  46324. /**
  46325. * Defines the list of key codes associated with the left action (increase rotationOffset)
  46326. */
  46327. keysRotationOffsetIncr: number[];
  46328. /**
  46329. * Defines the list of key codes associated with the right action (decrease rotationOffset)
  46330. */
  46331. keysRotationOffsetDecr: number[];
  46332. /**
  46333. * Defines whether the Alt modifier key is required to move left/right (alter rotationOffset)
  46334. */
  46335. keysRotationOffsetModifierAlt: boolean;
  46336. /**
  46337. * Defines whether the Ctrl modifier key is required to move left/right (alter rotationOffset)
  46338. */
  46339. keysRotationOffsetModifierCtrl: boolean;
  46340. /**
  46341. * Defines whether the Shift modifier key is required to move left/right (alter rotationOffset)
  46342. */
  46343. keysRotationOffsetModifierShift: boolean;
  46344. /**
  46345. * Defines the list of key codes associated with the zoom-in action (decrease radius)
  46346. */
  46347. keysRadiusIncr: number[];
  46348. /**
  46349. * Defines the list of key codes associated with the zoom-out action (increase radius)
  46350. */
  46351. keysRadiusDecr: number[];
  46352. /**
  46353. * Defines whether the Alt modifier key is required to zoom in/out (alter radius value)
  46354. */
  46355. keysRadiusModifierAlt: boolean;
  46356. /**
  46357. * Defines whether the Ctrl modifier key is required to zoom in/out (alter radius value)
  46358. */
  46359. keysRadiusModifierCtrl: boolean;
  46360. /**
  46361. * Defines whether the Shift modifier key is required to zoom in/out (alter radius value)
  46362. */
  46363. keysRadiusModifierShift: boolean;
  46364. /**
  46365. * Defines the rate of change of heightOffset.
  46366. */
  46367. heightSensibility: number;
  46368. /**
  46369. * Defines the rate of change of rotationOffset.
  46370. */
  46371. rotationSensibility: number;
  46372. /**
  46373. * Defines the rate of change of radius.
  46374. */
  46375. radiusSensibility: number;
  46376. private _keys;
  46377. private _ctrlPressed;
  46378. private _altPressed;
  46379. private _shiftPressed;
  46380. private _onCanvasBlurObserver;
  46381. private _onKeyboardObserver;
  46382. private _engine;
  46383. private _scene;
  46384. /**
  46385. * Attach the input controls to a specific dom element to get the input from.
  46386. * @param element Defines the element the controls should be listened from
  46387. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  46388. */
  46389. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  46390. /**
  46391. * Detach the current controls from the specified dom element.
  46392. * @param element Defines the element to stop listening the inputs from
  46393. */
  46394. detachControl(element: Nullable<HTMLElement>): void;
  46395. /**
  46396. * Update the current camera state depending on the inputs that have been used this frame.
  46397. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  46398. */
  46399. checkInputs(): void;
  46400. /**
  46401. * Gets the class name of the current input.
  46402. * @returns the class name
  46403. */
  46404. getClassName(): string;
  46405. /**
  46406. * Get the friendly name associated with the input class.
  46407. * @returns the input friendly name
  46408. */
  46409. getSimpleName(): string;
  46410. /**
  46411. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  46412. * allow modification of the heightOffset value.
  46413. */
  46414. private _modifierHeightOffset;
  46415. /**
  46416. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  46417. * allow modification of the rotationOffset value.
  46418. */
  46419. private _modifierRotationOffset;
  46420. /**
  46421. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  46422. * allow modification of the radius value.
  46423. */
  46424. private _modifierRadius;
  46425. }
  46426. }
  46427. declare module "babylonjs/Cameras/Inputs/freeCameraDeviceOrientationInput" {
  46428. import { Nullable } from "babylonjs/types";
  46429. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  46430. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  46431. import { Observable } from "babylonjs/Misc/observable";
  46432. module "babylonjs/Cameras/freeCameraInputsManager" {
  46433. interface FreeCameraInputsManager {
  46434. /**
  46435. * @hidden
  46436. */
  46437. _deviceOrientationInput: Nullable<FreeCameraDeviceOrientationInput>;
  46438. /**
  46439. * Add orientation input support to the input manager.
  46440. * @returns the current input manager
  46441. */
  46442. addDeviceOrientation(): FreeCameraInputsManager;
  46443. }
  46444. }
  46445. /**
  46446. * Takes information about the orientation of the device as reported by the deviceorientation event to orient the camera.
  46447. * Screen rotation is taken into account.
  46448. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46449. */
  46450. export class FreeCameraDeviceOrientationInput implements ICameraInput<FreeCamera> {
  46451. private _camera;
  46452. private _screenOrientationAngle;
  46453. private _constantTranform;
  46454. private _screenQuaternion;
  46455. private _alpha;
  46456. private _beta;
  46457. private _gamma;
  46458. /**
  46459. * Can be used to detect if a device orientation sensor is available on a device
  46460. * @param timeout amount of time in milliseconds to wait for a response from the sensor (default: infinite)
  46461. * @returns a promise that will resolve on orientation change
  46462. */
  46463. static WaitForOrientationChangeAsync(timeout?: number): Promise<unknown>;
  46464. /**
  46465. * @hidden
  46466. */
  46467. _onDeviceOrientationChangedObservable: Observable<void>;
  46468. /**
  46469. * Instantiates a new input
  46470. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46471. */
  46472. constructor();
  46473. /**
  46474. * Define the camera controlled by the input.
  46475. */
  46476. get camera(): FreeCamera;
  46477. set camera(camera: FreeCamera);
  46478. /**
  46479. * Attach the input controls to a specific dom element to get the input from.
  46480. * @param element Defines the element the controls should be listened from
  46481. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  46482. */
  46483. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  46484. private _orientationChanged;
  46485. private _deviceOrientation;
  46486. /**
  46487. * Detach the current controls from the specified dom element.
  46488. * @param element Defines the element to stop listening the inputs from
  46489. */
  46490. detachControl(element: Nullable<HTMLElement>): void;
  46491. /**
  46492. * Update the current camera state depending on the inputs that have been used this frame.
  46493. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  46494. */
  46495. checkInputs(): void;
  46496. /**
  46497. * Gets the class name of the current intput.
  46498. * @returns the class name
  46499. */
  46500. getClassName(): string;
  46501. /**
  46502. * Get the friendly name associated with the input class.
  46503. * @returns the input friendly name
  46504. */
  46505. getSimpleName(): string;
  46506. }
  46507. }
  46508. declare module "babylonjs/Cameras/Inputs/freeCameraGamepadInput" {
  46509. import { Nullable } from "babylonjs/types";
  46510. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  46511. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  46512. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  46513. /**
  46514. * Manage the gamepad inputs to control a free camera.
  46515. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46516. */
  46517. export class FreeCameraGamepadInput implements ICameraInput<FreeCamera> {
  46518. /**
  46519. * Define the camera the input is attached to.
  46520. */
  46521. camera: FreeCamera;
  46522. /**
  46523. * Define the Gamepad controlling the input
  46524. */
  46525. gamepad: Nullable<Gamepad>;
  46526. /**
  46527. * Defines the gamepad rotation sensiblity.
  46528. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  46529. */
  46530. gamepadAngularSensibility: number;
  46531. /**
  46532. * Defines the gamepad move sensiblity.
  46533. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  46534. */
  46535. gamepadMoveSensibility: number;
  46536. private _yAxisScale;
  46537. /**
  46538. * Gets or sets a boolean indicating that Yaxis (for right stick) should be inverted
  46539. */
  46540. get invertYAxis(): boolean;
  46541. set invertYAxis(value: boolean);
  46542. private _onGamepadConnectedObserver;
  46543. private _onGamepadDisconnectedObserver;
  46544. private _cameraTransform;
  46545. private _deltaTransform;
  46546. private _vector3;
  46547. private _vector2;
  46548. /**
  46549. * Attach the input controls to a specific dom element to get the input from.
  46550. * @param element Defines the element the controls should be listened from
  46551. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  46552. */
  46553. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  46554. /**
  46555. * Detach the current controls from the specified dom element.
  46556. * @param element Defines the element to stop listening the inputs from
  46557. */
  46558. detachControl(element: Nullable<HTMLElement>): void;
  46559. /**
  46560. * Update the current camera state depending on the inputs that have been used this frame.
  46561. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  46562. */
  46563. checkInputs(): void;
  46564. /**
  46565. * Gets the class name of the current intput.
  46566. * @returns the class name
  46567. */
  46568. getClassName(): string;
  46569. /**
  46570. * Get the friendly name associated with the input class.
  46571. * @returns the input friendly name
  46572. */
  46573. getSimpleName(): string;
  46574. }
  46575. }
  46576. declare module "babylonjs/Misc/virtualJoystick" {
  46577. import { Nullable } from "babylonjs/types";
  46578. import { Vector3 } from "babylonjs/Maths/math.vector";
  46579. /**
  46580. * Defines the potential axis of a Joystick
  46581. */
  46582. export enum JoystickAxis {
  46583. /** X axis */
  46584. X = 0,
  46585. /** Y axis */
  46586. Y = 1,
  46587. /** Z axis */
  46588. Z = 2
  46589. }
  46590. /**
  46591. * Represents the different customization options available
  46592. * for VirtualJoystick
  46593. */
  46594. interface VirtualJoystickCustomizations {
  46595. /**
  46596. * Size of the joystick's puck
  46597. */
  46598. puckSize: number;
  46599. /**
  46600. * Size of the joystick's container
  46601. */
  46602. containerSize: number;
  46603. /**
  46604. * Color of the joystick && puck
  46605. */
  46606. color: string;
  46607. /**
  46608. * Image URL for the joystick's puck
  46609. */
  46610. puckImage?: string;
  46611. /**
  46612. * Image URL for the joystick's container
  46613. */
  46614. containerImage?: string;
  46615. /**
  46616. * Defines the unmoving position of the joystick container
  46617. */
  46618. position?: {
  46619. x: number;
  46620. y: number;
  46621. };
  46622. /**
  46623. * Defines whether or not the joystick container is always visible
  46624. */
  46625. alwaysVisible: boolean;
  46626. /**
  46627. * Defines whether or not to limit the movement of the puck to the joystick's container
  46628. */
  46629. limitToContainer: boolean;
  46630. }
  46631. /**
  46632. * Class used to define virtual joystick (used in touch mode)
  46633. */
  46634. export class VirtualJoystick {
  46635. /**
  46636. * Gets or sets a boolean indicating that left and right values must be inverted
  46637. */
  46638. reverseLeftRight: boolean;
  46639. /**
  46640. * Gets or sets a boolean indicating that up and down values must be inverted
  46641. */
  46642. reverseUpDown: boolean;
  46643. /**
  46644. * Gets the offset value for the position (ie. the change of the position value)
  46645. */
  46646. deltaPosition: Vector3;
  46647. /**
  46648. * Gets a boolean indicating if the virtual joystick was pressed
  46649. */
  46650. pressed: boolean;
  46651. /**
  46652. * Canvas the virtual joystick will render onto, default z-index of this is 5
  46653. */
  46654. static Canvas: Nullable<HTMLCanvasElement>;
  46655. /**
  46656. * boolean indicating whether or not the joystick's puck's movement should be limited to the joystick's container area
  46657. */
  46658. limitToContainer: boolean;
  46659. private static _globalJoystickIndex;
  46660. private static _alwaysVisibleSticks;
  46661. private static vjCanvasContext;
  46662. private static vjCanvasWidth;
  46663. private static vjCanvasHeight;
  46664. private static halfWidth;
  46665. private static _GetDefaultOptions;
  46666. private _action;
  46667. private _axisTargetedByLeftAndRight;
  46668. private _axisTargetedByUpAndDown;
  46669. private _joystickSensibility;
  46670. private _inversedSensibility;
  46671. private _joystickPointerID;
  46672. private _joystickColor;
  46673. private _joystickPointerPos;
  46674. private _joystickPreviousPointerPos;
  46675. private _joystickPointerStartPos;
  46676. private _deltaJoystickVector;
  46677. private _leftJoystick;
  46678. private _touches;
  46679. private _joystickPosition;
  46680. private _alwaysVisible;
  46681. private _puckImage;
  46682. private _containerImage;
  46683. private _joystickPuckSize;
  46684. private _joystickContainerSize;
  46685. private _clearPuckSize;
  46686. private _clearContainerSize;
  46687. private _clearPuckSizeOffset;
  46688. private _clearContainerSizeOffset;
  46689. private _onPointerDownHandlerRef;
  46690. private _onPointerMoveHandlerRef;
  46691. private _onPointerUpHandlerRef;
  46692. private _onResize;
  46693. /**
  46694. * Creates a new virtual joystick
  46695. * @param leftJoystick defines that the joystick is for left hand (false by default)
  46696. * @param customizations Defines the options we want to customize the VirtualJoystick
  46697. */
  46698. constructor(leftJoystick?: boolean, customizations?: Partial<VirtualJoystickCustomizations>);
  46699. /**
  46700. * Defines joystick sensibility (ie. the ratio beteen a physical move and virtual joystick position change)
  46701. * @param newJoystickSensibility defines the new sensibility
  46702. */
  46703. setJoystickSensibility(newJoystickSensibility: number): void;
  46704. private _onPointerDown;
  46705. private _onPointerMove;
  46706. private _onPointerUp;
  46707. /**
  46708. * Change the color of the virtual joystick
  46709. * @param newColor a string that must be a CSS color value (like "red") or the hexa value (like "#FF0000")
  46710. */
  46711. setJoystickColor(newColor: string): void;
  46712. /**
  46713. * Size of the joystick's container
  46714. */
  46715. set containerSize(newSize: number);
  46716. get containerSize(): number;
  46717. /**
  46718. * Size of the joystick's puck
  46719. */
  46720. set puckSize(newSize: number);
  46721. get puckSize(): number;
  46722. /**
  46723. * Clears the set position of the joystick
  46724. */
  46725. clearPosition(): void;
  46726. /**
  46727. * Defines whether or not the joystick container is always visible
  46728. */
  46729. set alwaysVisible(value: boolean);
  46730. get alwaysVisible(): boolean;
  46731. /**
  46732. * Sets the constant position of the Joystick container
  46733. * @param x X axis coordinate
  46734. * @param y Y axis coordinate
  46735. */
  46736. setPosition(x: number, y: number): void;
  46737. /**
  46738. * Defines a callback to call when the joystick is touched
  46739. * @param action defines the callback
  46740. */
  46741. setActionOnTouch(action: () => any): void;
  46742. /**
  46743. * Defines which axis you'd like to control for left & right
  46744. * @param axis defines the axis to use
  46745. */
  46746. setAxisForLeftRight(axis: JoystickAxis): void;
  46747. /**
  46748. * Defines which axis you'd like to control for up & down
  46749. * @param axis defines the axis to use
  46750. */
  46751. setAxisForUpDown(axis: JoystickAxis): void;
  46752. /**
  46753. * Clears the canvas from the previous puck / container draw
  46754. */
  46755. private _clearPreviousDraw;
  46756. /**
  46757. * Loads `urlPath` to be used for the container's image
  46758. * @param urlPath defines the urlPath of an image to use
  46759. */
  46760. setContainerImage(urlPath: string): void;
  46761. /**
  46762. * Loads `urlPath` to be used for the puck's image
  46763. * @param urlPath defines the urlPath of an image to use
  46764. */
  46765. setPuckImage(urlPath: string): void;
  46766. /**
  46767. * Draws the Virtual Joystick's container
  46768. */
  46769. private _drawContainer;
  46770. /**
  46771. * Draws the Virtual Joystick's puck
  46772. */
  46773. private _drawPuck;
  46774. private _drawVirtualJoystick;
  46775. /**
  46776. * Release internal HTML canvas
  46777. */
  46778. releaseCanvas(): void;
  46779. }
  46780. }
  46781. declare module "babylonjs/Cameras/Inputs/freeCameraVirtualJoystickInput" {
  46782. import { VirtualJoystick } from "babylonjs/Misc/virtualJoystick";
  46783. import { Nullable } from "babylonjs/types";
  46784. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  46785. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  46786. module "babylonjs/Cameras/freeCameraInputsManager" {
  46787. interface FreeCameraInputsManager {
  46788. /**
  46789. * Add virtual joystick input support to the input manager.
  46790. * @returns the current input manager
  46791. */
  46792. addVirtualJoystick(): FreeCameraInputsManager;
  46793. }
  46794. }
  46795. /**
  46796. * Manage the Virtual Joystick inputs to control the movement of a free camera.
  46797. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46798. */
  46799. export class FreeCameraVirtualJoystickInput implements ICameraInput<FreeCamera> {
  46800. /**
  46801. * Defines the camera the input is attached to.
  46802. */
  46803. camera: FreeCamera;
  46804. private _leftjoystick;
  46805. private _rightjoystick;
  46806. /**
  46807. * Gets the left stick of the virtual joystick.
  46808. * @returns The virtual Joystick
  46809. */
  46810. getLeftJoystick(): VirtualJoystick;
  46811. /**
  46812. * Gets the right stick of the virtual joystick.
  46813. * @returns The virtual Joystick
  46814. */
  46815. getRightJoystick(): VirtualJoystick;
  46816. /**
  46817. * Update the current camera state depending on the inputs that have been used this frame.
  46818. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  46819. */
  46820. checkInputs(): void;
  46821. /**
  46822. * Attach the input controls to a specific dom element to get the input from.
  46823. * @param element Defines the element the controls should be listened from
  46824. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  46825. */
  46826. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  46827. /**
  46828. * Detach the current controls from the specified dom element.
  46829. * @param element Defines the element to stop listening the inputs from
  46830. */
  46831. detachControl(element: Nullable<HTMLElement>): void;
  46832. /**
  46833. * Gets the class name of the current intput.
  46834. * @returns the class name
  46835. */
  46836. getClassName(): string;
  46837. /**
  46838. * Get the friendly name associated with the input class.
  46839. * @returns the input friendly name
  46840. */
  46841. getSimpleName(): string;
  46842. }
  46843. }
  46844. declare module "babylonjs/Cameras/Inputs/index" {
  46845. export * from "babylonjs/Cameras/Inputs/arcRotateCameraGamepadInput";
  46846. export * from "babylonjs/Cameras/Inputs/arcRotateCameraKeyboardMoveInput";
  46847. export * from "babylonjs/Cameras/Inputs/arcRotateCameraMouseWheelInput";
  46848. export * from "babylonjs/Cameras/Inputs/arcRotateCameraPointersInput";
  46849. export * from "babylonjs/Cameras/Inputs/arcRotateCameraVRDeviceOrientationInput";
  46850. export * from "babylonjs/Cameras/Inputs/flyCameraKeyboardInput";
  46851. export * from "babylonjs/Cameras/Inputs/flyCameraMouseInput";
  46852. export * from "babylonjs/Cameras/Inputs/followCameraKeyboardMoveInput";
  46853. export * from "babylonjs/Cameras/Inputs/followCameraMouseWheelInput";
  46854. export * from "babylonjs/Cameras/Inputs/followCameraPointersInput";
  46855. export * from "babylonjs/Cameras/Inputs/freeCameraDeviceOrientationInput";
  46856. export * from "babylonjs/Cameras/Inputs/freeCameraGamepadInput";
  46857. export * from "babylonjs/Cameras/Inputs/freeCameraKeyboardMoveInput";
  46858. export * from "babylonjs/Cameras/Inputs/freeCameraMouseInput";
  46859. export * from "babylonjs/Cameras/Inputs/freeCameraTouchInput";
  46860. export * from "babylonjs/Cameras/Inputs/freeCameraVirtualJoystickInput";
  46861. }
  46862. declare module "babylonjs/Cameras/touchCamera" {
  46863. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  46864. import { Scene } from "babylonjs/scene";
  46865. import { Vector3 } from "babylonjs/Maths/math.vector";
  46866. /**
  46867. * This represents a FPS type of camera controlled by touch.
  46868. * This is like a universal camera minus the Gamepad controls.
  46869. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  46870. */
  46871. export class TouchCamera extends FreeCamera {
  46872. /**
  46873. * Defines the touch sensibility for rotation.
  46874. * The higher the faster.
  46875. */
  46876. get touchAngularSensibility(): number;
  46877. set touchAngularSensibility(value: number);
  46878. /**
  46879. * Defines the touch sensibility for move.
  46880. * The higher the faster.
  46881. */
  46882. get touchMoveSensibility(): number;
  46883. set touchMoveSensibility(value: number);
  46884. /**
  46885. * Instantiates a new touch camera.
  46886. * This represents a FPS type of camera controlled by touch.
  46887. * This is like a universal camera minus the Gamepad controls.
  46888. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  46889. * @param name Define the name of the camera in the scene
  46890. * @param position Define the start position of the camera in the scene
  46891. * @param scene Define the scene the camera belongs to
  46892. */
  46893. constructor(name: string, position: Vector3, scene: Scene);
  46894. /**
  46895. * Gets the current object class name.
  46896. * @return the class name
  46897. */
  46898. getClassName(): string;
  46899. /** @hidden */
  46900. _setupInputs(): void;
  46901. }
  46902. }
  46903. declare module "babylonjs/Cameras/deviceOrientationCamera" {
  46904. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  46905. import { Scene } from "babylonjs/scene";
  46906. import { Vector3 } from "babylonjs/Maths/math.vector";
  46907. import "babylonjs/Cameras/Inputs/freeCameraDeviceOrientationInput";
  46908. import { Axis } from "babylonjs/Maths/math.axis";
  46909. /**
  46910. * This is a camera specifically designed to react to device orientation events such as a modern mobile device
  46911. * being tilted forward or back and left or right.
  46912. */
  46913. export class DeviceOrientationCamera extends FreeCamera {
  46914. private _initialQuaternion;
  46915. private _quaternionCache;
  46916. private _tmpDragQuaternion;
  46917. private _disablePointerInputWhenUsingDeviceOrientation;
  46918. /**
  46919. * Creates a new device orientation camera
  46920. * @param name The name of the camera
  46921. * @param position The start position camera
  46922. * @param scene The scene the camera belongs to
  46923. */
  46924. constructor(name: string, position: Vector3, scene: Scene);
  46925. /**
  46926. * Gets or sets a boolean indicating that pointer input must be disabled on first orientation sensor update (Default: true)
  46927. */
  46928. get disablePointerInputWhenUsingDeviceOrientation(): boolean;
  46929. set disablePointerInputWhenUsingDeviceOrientation(value: boolean);
  46930. private _dragFactor;
  46931. /**
  46932. * Enabled turning on the y axis when the orientation sensor is active
  46933. * @param dragFactor the factor that controls the turn speed (default: 1/300)
  46934. */
  46935. enableHorizontalDragging(dragFactor?: number): void;
  46936. /**
  46937. * Gets the current instance class name ("DeviceOrientationCamera").
  46938. * This helps avoiding instanceof at run time.
  46939. * @returns the class name
  46940. */
  46941. getClassName(): string;
  46942. /**
  46943. * @hidden
  46944. * Checks and applies the current values of the inputs to the camera. (Internal use only)
  46945. */
  46946. _checkInputs(): void;
  46947. /**
  46948. * Reset the camera to its default orientation on the specified axis only.
  46949. * @param axis The axis to reset
  46950. */
  46951. resetToCurrentRotation(axis?: Axis): void;
  46952. }
  46953. }
  46954. declare module "babylonjs/Gamepads/xboxGamepad" {
  46955. import { Observable } from "babylonjs/Misc/observable";
  46956. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  46957. /**
  46958. * Defines supported buttons for XBox360 compatible gamepads
  46959. */
  46960. export enum Xbox360Button {
  46961. /** A */
  46962. A = 0,
  46963. /** B */
  46964. B = 1,
  46965. /** X */
  46966. X = 2,
  46967. /** Y */
  46968. Y = 3,
  46969. /** Left button */
  46970. LB = 4,
  46971. /** Right button */
  46972. RB = 5,
  46973. /** Back */
  46974. Back = 8,
  46975. /** Start */
  46976. Start = 9,
  46977. /** Left stick */
  46978. LeftStick = 10,
  46979. /** Right stick */
  46980. RightStick = 11
  46981. }
  46982. /** Defines values for XBox360 DPad */
  46983. export enum Xbox360Dpad {
  46984. /** Up */
  46985. Up = 12,
  46986. /** Down */
  46987. Down = 13,
  46988. /** Left */
  46989. Left = 14,
  46990. /** Right */
  46991. Right = 15
  46992. }
  46993. /**
  46994. * Defines a XBox360 gamepad
  46995. */
  46996. export class Xbox360Pad extends Gamepad {
  46997. private _leftTrigger;
  46998. private _rightTrigger;
  46999. private _onlefttriggerchanged;
  47000. private _onrighttriggerchanged;
  47001. private _onbuttondown;
  47002. private _onbuttonup;
  47003. private _ondpaddown;
  47004. private _ondpadup;
  47005. /** Observable raised when a button is pressed */
  47006. onButtonDownObservable: Observable<Xbox360Button>;
  47007. /** Observable raised when a button is released */
  47008. onButtonUpObservable: Observable<Xbox360Button>;
  47009. /** Observable raised when a pad is pressed */
  47010. onPadDownObservable: Observable<Xbox360Dpad>;
  47011. /** Observable raised when a pad is released */
  47012. onPadUpObservable: Observable<Xbox360Dpad>;
  47013. private _buttonA;
  47014. private _buttonB;
  47015. private _buttonX;
  47016. private _buttonY;
  47017. private _buttonBack;
  47018. private _buttonStart;
  47019. private _buttonLB;
  47020. private _buttonRB;
  47021. private _buttonLeftStick;
  47022. private _buttonRightStick;
  47023. private _dPadUp;
  47024. private _dPadDown;
  47025. private _dPadLeft;
  47026. private _dPadRight;
  47027. private _isXboxOnePad;
  47028. /**
  47029. * Creates a new XBox360 gamepad object
  47030. * @param id defines the id of this gamepad
  47031. * @param index defines its index
  47032. * @param gamepad defines the internal HTML gamepad object
  47033. * @param xboxOne defines if it is a XBox One gamepad
  47034. */
  47035. constructor(id: string, index: number, gamepad: any, xboxOne?: boolean);
  47036. /**
  47037. * Defines the callback to call when left trigger is pressed
  47038. * @param callback defines the callback to use
  47039. */
  47040. onlefttriggerchanged(callback: (value: number) => void): void;
  47041. /**
  47042. * Defines the callback to call when right trigger is pressed
  47043. * @param callback defines the callback to use
  47044. */
  47045. onrighttriggerchanged(callback: (value: number) => void): void;
  47046. /**
  47047. * Gets the left trigger value
  47048. */
  47049. get leftTrigger(): number;
  47050. /**
  47051. * Sets the left trigger value
  47052. */
  47053. set leftTrigger(newValue: number);
  47054. /**
  47055. * Gets the right trigger value
  47056. */
  47057. get rightTrigger(): number;
  47058. /**
  47059. * Sets the right trigger value
  47060. */
  47061. set rightTrigger(newValue: number);
  47062. /**
  47063. * Defines the callback to call when a button is pressed
  47064. * @param callback defines the callback to use
  47065. */
  47066. onbuttondown(callback: (buttonPressed: Xbox360Button) => void): void;
  47067. /**
  47068. * Defines the callback to call when a button is released
  47069. * @param callback defines the callback to use
  47070. */
  47071. onbuttonup(callback: (buttonReleased: Xbox360Button) => void): void;
  47072. /**
  47073. * Defines the callback to call when a pad is pressed
  47074. * @param callback defines the callback to use
  47075. */
  47076. ondpaddown(callback: (dPadPressed: Xbox360Dpad) => void): void;
  47077. /**
  47078. * Defines the callback to call when a pad is released
  47079. * @param callback defines the callback to use
  47080. */
  47081. ondpadup(callback: (dPadReleased: Xbox360Dpad) => void): void;
  47082. private _setButtonValue;
  47083. private _setDPadValue;
  47084. /**
  47085. * Gets the value of the `A` button
  47086. */
  47087. get buttonA(): number;
  47088. /**
  47089. * Sets the value of the `A` button
  47090. */
  47091. set buttonA(value: number);
  47092. /**
  47093. * Gets the value of the `B` button
  47094. */
  47095. get buttonB(): number;
  47096. /**
  47097. * Sets the value of the `B` button
  47098. */
  47099. set buttonB(value: number);
  47100. /**
  47101. * Gets the value of the `X` button
  47102. */
  47103. get buttonX(): number;
  47104. /**
  47105. * Sets the value of the `X` button
  47106. */
  47107. set buttonX(value: number);
  47108. /**
  47109. * Gets the value of the `Y` button
  47110. */
  47111. get buttonY(): number;
  47112. /**
  47113. * Sets the value of the `Y` button
  47114. */
  47115. set buttonY(value: number);
  47116. /**
  47117. * Gets the value of the `Start` button
  47118. */
  47119. get buttonStart(): number;
  47120. /**
  47121. * Sets the value of the `Start` button
  47122. */
  47123. set buttonStart(value: number);
  47124. /**
  47125. * Gets the value of the `Back` button
  47126. */
  47127. get buttonBack(): number;
  47128. /**
  47129. * Sets the value of the `Back` button
  47130. */
  47131. set buttonBack(value: number);
  47132. /**
  47133. * Gets the value of the `Left` button
  47134. */
  47135. get buttonLB(): number;
  47136. /**
  47137. * Sets the value of the `Left` button
  47138. */
  47139. set buttonLB(value: number);
  47140. /**
  47141. * Gets the value of the `Right` button
  47142. */
  47143. get buttonRB(): number;
  47144. /**
  47145. * Sets the value of the `Right` button
  47146. */
  47147. set buttonRB(value: number);
  47148. /**
  47149. * Gets the value of the Left joystick
  47150. */
  47151. get buttonLeftStick(): number;
  47152. /**
  47153. * Sets the value of the Left joystick
  47154. */
  47155. set buttonLeftStick(value: number);
  47156. /**
  47157. * Gets the value of the Right joystick
  47158. */
  47159. get buttonRightStick(): number;
  47160. /**
  47161. * Sets the value of the Right joystick
  47162. */
  47163. set buttonRightStick(value: number);
  47164. /**
  47165. * Gets the value of D-pad up
  47166. */
  47167. get dPadUp(): number;
  47168. /**
  47169. * Sets the value of D-pad up
  47170. */
  47171. set dPadUp(value: number);
  47172. /**
  47173. * Gets the value of D-pad down
  47174. */
  47175. get dPadDown(): number;
  47176. /**
  47177. * Sets the value of D-pad down
  47178. */
  47179. set dPadDown(value: number);
  47180. /**
  47181. * Gets the value of D-pad left
  47182. */
  47183. get dPadLeft(): number;
  47184. /**
  47185. * Sets the value of D-pad left
  47186. */
  47187. set dPadLeft(value: number);
  47188. /**
  47189. * Gets the value of D-pad right
  47190. */
  47191. get dPadRight(): number;
  47192. /**
  47193. * Sets the value of D-pad right
  47194. */
  47195. set dPadRight(value: number);
  47196. /**
  47197. * Force the gamepad to synchronize with device values
  47198. */
  47199. update(): void;
  47200. /**
  47201. * Disposes the gamepad
  47202. */
  47203. dispose(): void;
  47204. }
  47205. }
  47206. declare module "babylonjs/Gamepads/dualShockGamepad" {
  47207. import { Observable } from "babylonjs/Misc/observable";
  47208. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  47209. /**
  47210. * Defines supported buttons for DualShock compatible gamepads
  47211. */
  47212. export enum DualShockButton {
  47213. /** Cross */
  47214. Cross = 0,
  47215. /** Circle */
  47216. Circle = 1,
  47217. /** Square */
  47218. Square = 2,
  47219. /** Triangle */
  47220. Triangle = 3,
  47221. /** L1 */
  47222. L1 = 4,
  47223. /** R1 */
  47224. R1 = 5,
  47225. /** Share */
  47226. Share = 8,
  47227. /** Options */
  47228. Options = 9,
  47229. /** Left stick */
  47230. LeftStick = 10,
  47231. /** Right stick */
  47232. RightStick = 11
  47233. }
  47234. /** Defines values for DualShock DPad */
  47235. export enum DualShockDpad {
  47236. /** Up */
  47237. Up = 12,
  47238. /** Down */
  47239. Down = 13,
  47240. /** Left */
  47241. Left = 14,
  47242. /** Right */
  47243. Right = 15
  47244. }
  47245. /**
  47246. * Defines a DualShock gamepad
  47247. */
  47248. export class DualShockPad extends Gamepad {
  47249. private _leftTrigger;
  47250. private _rightTrigger;
  47251. private _onlefttriggerchanged;
  47252. private _onrighttriggerchanged;
  47253. private _onbuttondown;
  47254. private _onbuttonup;
  47255. private _ondpaddown;
  47256. private _ondpadup;
  47257. /** Observable raised when a button is pressed */
  47258. onButtonDownObservable: Observable<DualShockButton>;
  47259. /** Observable raised when a button is released */
  47260. onButtonUpObservable: Observable<DualShockButton>;
  47261. /** Observable raised when a pad is pressed */
  47262. onPadDownObservable: Observable<DualShockDpad>;
  47263. /** Observable raised when a pad is released */
  47264. onPadUpObservable: Observable<DualShockDpad>;
  47265. private _buttonCross;
  47266. private _buttonCircle;
  47267. private _buttonSquare;
  47268. private _buttonTriangle;
  47269. private _buttonShare;
  47270. private _buttonOptions;
  47271. private _buttonL1;
  47272. private _buttonR1;
  47273. private _buttonLeftStick;
  47274. private _buttonRightStick;
  47275. private _dPadUp;
  47276. private _dPadDown;
  47277. private _dPadLeft;
  47278. private _dPadRight;
  47279. /**
  47280. * Creates a new DualShock gamepad object
  47281. * @param id defines the id of this gamepad
  47282. * @param index defines its index
  47283. * @param gamepad defines the internal HTML gamepad object
  47284. */
  47285. constructor(id: string, index: number, gamepad: any);
  47286. /**
  47287. * Defines the callback to call when left trigger is pressed
  47288. * @param callback defines the callback to use
  47289. */
  47290. onlefttriggerchanged(callback: (value: number) => void): void;
  47291. /**
  47292. * Defines the callback to call when right trigger is pressed
  47293. * @param callback defines the callback to use
  47294. */
  47295. onrighttriggerchanged(callback: (value: number) => void): void;
  47296. /**
  47297. * Gets the left trigger value
  47298. */
  47299. get leftTrigger(): number;
  47300. /**
  47301. * Sets the left trigger value
  47302. */
  47303. set leftTrigger(newValue: number);
  47304. /**
  47305. * Gets the right trigger value
  47306. */
  47307. get rightTrigger(): number;
  47308. /**
  47309. * Sets the right trigger value
  47310. */
  47311. set rightTrigger(newValue: number);
  47312. /**
  47313. * Defines the callback to call when a button is pressed
  47314. * @param callback defines the callback to use
  47315. */
  47316. onbuttondown(callback: (buttonPressed: DualShockButton) => void): void;
  47317. /**
  47318. * Defines the callback to call when a button is released
  47319. * @param callback defines the callback to use
  47320. */
  47321. onbuttonup(callback: (buttonReleased: DualShockButton) => void): void;
  47322. /**
  47323. * Defines the callback to call when a pad is pressed
  47324. * @param callback defines the callback to use
  47325. */
  47326. ondpaddown(callback: (dPadPressed: DualShockDpad) => void): void;
  47327. /**
  47328. * Defines the callback to call when a pad is released
  47329. * @param callback defines the callback to use
  47330. */
  47331. ondpadup(callback: (dPadReleased: DualShockDpad) => void): void;
  47332. private _setButtonValue;
  47333. private _setDPadValue;
  47334. /**
  47335. * Gets the value of the `Cross` button
  47336. */
  47337. get buttonCross(): number;
  47338. /**
  47339. * Sets the value of the `Cross` button
  47340. */
  47341. set buttonCross(value: number);
  47342. /**
  47343. * Gets the value of the `Circle` button
  47344. */
  47345. get buttonCircle(): number;
  47346. /**
  47347. * Sets the value of the `Circle` button
  47348. */
  47349. set buttonCircle(value: number);
  47350. /**
  47351. * Gets the value of the `Square` button
  47352. */
  47353. get buttonSquare(): number;
  47354. /**
  47355. * Sets the value of the `Square` button
  47356. */
  47357. set buttonSquare(value: number);
  47358. /**
  47359. * Gets the value of the `Triangle` button
  47360. */
  47361. get buttonTriangle(): number;
  47362. /**
  47363. * Sets the value of the `Triangle` button
  47364. */
  47365. set buttonTriangle(value: number);
  47366. /**
  47367. * Gets the value of the `Options` button
  47368. */
  47369. get buttonOptions(): number;
  47370. /**
  47371. * Sets the value of the `Options` button
  47372. */
  47373. set buttonOptions(value: number);
  47374. /**
  47375. * Gets the value of the `Share` button
  47376. */
  47377. get buttonShare(): number;
  47378. /**
  47379. * Sets the value of the `Share` button
  47380. */
  47381. set buttonShare(value: number);
  47382. /**
  47383. * Gets the value of the `L1` button
  47384. */
  47385. get buttonL1(): number;
  47386. /**
  47387. * Sets the value of the `L1` button
  47388. */
  47389. set buttonL1(value: number);
  47390. /**
  47391. * Gets the value of the `R1` button
  47392. */
  47393. get buttonR1(): number;
  47394. /**
  47395. * Sets the value of the `R1` button
  47396. */
  47397. set buttonR1(value: number);
  47398. /**
  47399. * Gets the value of the Left joystick
  47400. */
  47401. get buttonLeftStick(): number;
  47402. /**
  47403. * Sets the value of the Left joystick
  47404. */
  47405. set buttonLeftStick(value: number);
  47406. /**
  47407. * Gets the value of the Right joystick
  47408. */
  47409. get buttonRightStick(): number;
  47410. /**
  47411. * Sets the value of the Right joystick
  47412. */
  47413. set buttonRightStick(value: number);
  47414. /**
  47415. * Gets the value of D-pad up
  47416. */
  47417. get dPadUp(): number;
  47418. /**
  47419. * Sets the value of D-pad up
  47420. */
  47421. set dPadUp(value: number);
  47422. /**
  47423. * Gets the value of D-pad down
  47424. */
  47425. get dPadDown(): number;
  47426. /**
  47427. * Sets the value of D-pad down
  47428. */
  47429. set dPadDown(value: number);
  47430. /**
  47431. * Gets the value of D-pad left
  47432. */
  47433. get dPadLeft(): number;
  47434. /**
  47435. * Sets the value of D-pad left
  47436. */
  47437. set dPadLeft(value: number);
  47438. /**
  47439. * Gets the value of D-pad right
  47440. */
  47441. get dPadRight(): number;
  47442. /**
  47443. * Sets the value of D-pad right
  47444. */
  47445. set dPadRight(value: number);
  47446. /**
  47447. * Force the gamepad to synchronize with device values
  47448. */
  47449. update(): void;
  47450. /**
  47451. * Disposes the gamepad
  47452. */
  47453. dispose(): void;
  47454. }
  47455. }
  47456. declare module "babylonjs/Gamepads/gamepadManager" {
  47457. import { Observable } from "babylonjs/Misc/observable";
  47458. import { Nullable } from "babylonjs/types";
  47459. import { Scene } from "babylonjs/scene";
  47460. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  47461. /**
  47462. * Manager for handling gamepads
  47463. */
  47464. export class GamepadManager {
  47465. private _scene?;
  47466. private _babylonGamepads;
  47467. private _oneGamepadConnected;
  47468. /** @hidden */
  47469. _isMonitoring: boolean;
  47470. private _gamepadEventSupported;
  47471. private _gamepadSupport?;
  47472. /**
  47473. * observable to be triggered when the gamepad controller has been connected
  47474. */
  47475. onGamepadConnectedObservable: Observable<Gamepad>;
  47476. /**
  47477. * observable to be triggered when the gamepad controller has been disconnected
  47478. */
  47479. onGamepadDisconnectedObservable: Observable<Gamepad>;
  47480. private _onGamepadConnectedEvent;
  47481. private _onGamepadDisconnectedEvent;
  47482. /**
  47483. * Initializes the gamepad manager
  47484. * @param _scene BabylonJS scene
  47485. */
  47486. constructor(_scene?: Scene | undefined);
  47487. /**
  47488. * The gamepads in the game pad manager
  47489. */
  47490. get gamepads(): Gamepad[];
  47491. /**
  47492. * Get the gamepad controllers based on type
  47493. * @param type The type of gamepad controller
  47494. * @returns Nullable gamepad
  47495. */
  47496. getGamepadByType(type?: number): Nullable<Gamepad>;
  47497. /**
  47498. * Disposes the gamepad manager
  47499. */
  47500. dispose(): void;
  47501. private _addNewGamepad;
  47502. private _startMonitoringGamepads;
  47503. private _stopMonitoringGamepads;
  47504. /** @hidden */
  47505. _checkGamepadsStatus(): void;
  47506. private _updateGamepadObjects;
  47507. }
  47508. }
  47509. declare module "babylonjs/Gamepads/gamepadSceneComponent" {
  47510. import { Nullable } from "babylonjs/types";
  47511. import { Scene } from "babylonjs/scene";
  47512. import { ISceneComponent } from "babylonjs/sceneComponent";
  47513. import { GamepadManager } from "babylonjs/Gamepads/gamepadManager";
  47514. module "babylonjs/scene" {
  47515. interface Scene {
  47516. /** @hidden */
  47517. _gamepadManager: Nullable<GamepadManager>;
  47518. /**
  47519. * Gets the gamepad manager associated with the scene
  47520. * @see https://doc.babylonjs.com/how_to/how_to_use_gamepads
  47521. */
  47522. gamepadManager: GamepadManager;
  47523. }
  47524. }
  47525. module "babylonjs/Cameras/freeCameraInputsManager" {
  47526. /**
  47527. * Interface representing a free camera inputs manager
  47528. */
  47529. interface FreeCameraInputsManager {
  47530. /**
  47531. * Adds gamepad input support to the FreeCameraInputsManager.
  47532. * @returns the FreeCameraInputsManager
  47533. */
  47534. addGamepad(): FreeCameraInputsManager;
  47535. }
  47536. }
  47537. module "babylonjs/Cameras/arcRotateCameraInputsManager" {
  47538. /**
  47539. * Interface representing an arc rotate camera inputs manager
  47540. */
  47541. interface ArcRotateCameraInputsManager {
  47542. /**
  47543. * Adds gamepad input support to the ArcRotateCamera InputManager.
  47544. * @returns the camera inputs manager
  47545. */
  47546. addGamepad(): ArcRotateCameraInputsManager;
  47547. }
  47548. }
  47549. /**
  47550. * Defines the gamepad scene component responsible to manage gamepads in a given scene
  47551. */
  47552. export class GamepadSystemSceneComponent implements ISceneComponent {
  47553. /**
  47554. * The component name helpfull to identify the component in the list of scene components.
  47555. */
  47556. readonly name: string;
  47557. /**
  47558. * The scene the component belongs to.
  47559. */
  47560. scene: Scene;
  47561. /**
  47562. * Creates a new instance of the component for the given scene
  47563. * @param scene Defines the scene to register the component in
  47564. */
  47565. constructor(scene: Scene);
  47566. /**
  47567. * Registers the component in a given scene
  47568. */
  47569. register(): void;
  47570. /**
  47571. * Rebuilds the elements related to this component in case of
  47572. * context lost for instance.
  47573. */
  47574. rebuild(): void;
  47575. /**
  47576. * Disposes the component and the associated ressources
  47577. */
  47578. dispose(): void;
  47579. private _beforeCameraUpdate;
  47580. }
  47581. }
  47582. declare module "babylonjs/Cameras/universalCamera" {
  47583. import { TouchCamera } from "babylonjs/Cameras/touchCamera";
  47584. import { Scene } from "babylonjs/scene";
  47585. import { Vector3 } from "babylonjs/Maths/math.vector";
  47586. import "babylonjs/Gamepads/gamepadSceneComponent";
  47587. /**
  47588. * The Universal Camera is the one to choose for first person shooter type games, and works with all the keyboard, mouse, touch and gamepads. This replaces the earlier Free Camera,
  47589. * which still works and will still be found in many Playgrounds.
  47590. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  47591. */
  47592. export class UniversalCamera extends TouchCamera {
  47593. /**
  47594. * Defines the gamepad rotation sensiblity.
  47595. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  47596. */
  47597. get gamepadAngularSensibility(): number;
  47598. set gamepadAngularSensibility(value: number);
  47599. /**
  47600. * Defines the gamepad move sensiblity.
  47601. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  47602. */
  47603. get gamepadMoveSensibility(): number;
  47604. set gamepadMoveSensibility(value: number);
  47605. /**
  47606. * The Universal Camera is the one to choose for first person shooter type games, and works with all the keyboard, mouse, touch and gamepads. This replaces the earlier Free Camera,
  47607. * which still works and will still be found in many Playgrounds.
  47608. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  47609. * @param name Define the name of the camera in the scene
  47610. * @param position Define the start position of the camera in the scene
  47611. * @param scene Define the scene the camera belongs to
  47612. */
  47613. constructor(name: string, position: Vector3, scene: Scene);
  47614. /**
  47615. * Gets the current object class name.
  47616. * @return the class name
  47617. */
  47618. getClassName(): string;
  47619. }
  47620. }
  47621. declare module "babylonjs/Cameras/gamepadCamera" {
  47622. import { UniversalCamera } from "babylonjs/Cameras/universalCamera";
  47623. import { Scene } from "babylonjs/scene";
  47624. import { Vector3 } from "babylonjs/Maths/math.vector";
  47625. /**
  47626. * This represents a FPS type of camera. This is only here for back compat purpose.
  47627. * Please use the UniversalCamera instead as both are identical.
  47628. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  47629. */
  47630. export class GamepadCamera extends UniversalCamera {
  47631. /**
  47632. * Instantiates a new Gamepad Camera
  47633. * This represents a FPS type of camera. This is only here for back compat purpose.
  47634. * Please use the UniversalCamera instead as both are identical.
  47635. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  47636. * @param name Define the name of the camera in the scene
  47637. * @param position Define the start position of the camera in the scene
  47638. * @param scene Define the scene the camera belongs to
  47639. */
  47640. constructor(name: string, position: Vector3, scene: Scene);
  47641. /**
  47642. * Gets the current object class name.
  47643. * @return the class name
  47644. */
  47645. getClassName(): string;
  47646. }
  47647. }
  47648. declare module "babylonjs/Shaders/pass.fragment" {
  47649. /** @hidden */
  47650. export var passPixelShader: {
  47651. name: string;
  47652. shader: string;
  47653. };
  47654. }
  47655. declare module "babylonjs/Shaders/passCube.fragment" {
  47656. /** @hidden */
  47657. export var passCubePixelShader: {
  47658. name: string;
  47659. shader: string;
  47660. };
  47661. }
  47662. declare module "babylonjs/PostProcesses/passPostProcess" {
  47663. import { Nullable } from "babylonjs/types";
  47664. import { Camera } from "babylonjs/Cameras/camera";
  47665. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  47666. import { Engine } from "babylonjs/Engines/engine";
  47667. import "babylonjs/Shaders/pass.fragment";
  47668. import "babylonjs/Shaders/passCube.fragment";
  47669. import { Scene } from "babylonjs/scene";
  47670. /**
  47671. * PassPostProcess which produces an output the same as it's input
  47672. */
  47673. export class PassPostProcess extends PostProcess {
  47674. /**
  47675. * Gets a string identifying the name of the class
  47676. * @returns "PassPostProcess" string
  47677. */
  47678. getClassName(): string;
  47679. /**
  47680. * Creates the PassPostProcess
  47681. * @param name The name of the effect.
  47682. * @param options The required width/height ratio to downsize to before computing the render pass.
  47683. * @param camera The camera to apply the render pass to.
  47684. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  47685. * @param engine The engine which the post process will be applied. (default: current engine)
  47686. * @param reusable If the post process can be reused on the same frame. (default: false)
  47687. * @param textureType The type of texture to be used when performing the post processing.
  47688. * @param blockCompilation If compilation of the shader should not be done in the constructor. The updateEffect method can be used to compile the shader at a later time. (default: false)
  47689. */
  47690. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  47691. /** @hidden */
  47692. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): PassPostProcess;
  47693. }
  47694. /**
  47695. * PassCubePostProcess which produces an output the same as it's input (which must be a cube texture)
  47696. */
  47697. export class PassCubePostProcess extends PostProcess {
  47698. private _face;
  47699. /**
  47700. * Gets or sets the cube face to display.
  47701. * * 0 is +X
  47702. * * 1 is -X
  47703. * * 2 is +Y
  47704. * * 3 is -Y
  47705. * * 4 is +Z
  47706. * * 5 is -Z
  47707. */
  47708. get face(): number;
  47709. set face(value: number);
  47710. /**
  47711. * Gets a string identifying the name of the class
  47712. * @returns "PassCubePostProcess" string
  47713. */
  47714. getClassName(): string;
  47715. /**
  47716. * Creates the PassCubePostProcess
  47717. * @param name The name of the effect.
  47718. * @param options The required width/height ratio to downsize to before computing the render pass.
  47719. * @param camera The camera to apply the render pass to.
  47720. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  47721. * @param engine The engine which the post process will be applied. (default: current engine)
  47722. * @param reusable If the post process can be reused on the same frame. (default: false)
  47723. * @param textureType The type of texture to be used when performing the post processing.
  47724. * @param blockCompilation If compilation of the shader should not be done in the constructor. The updateEffect method can be used to compile the shader at a later time. (default: false)
  47725. */
  47726. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  47727. /** @hidden */
  47728. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): PassCubePostProcess;
  47729. }
  47730. }
  47731. declare module "babylonjs/Shaders/anaglyph.fragment" {
  47732. /** @hidden */
  47733. export var anaglyphPixelShader: {
  47734. name: string;
  47735. shader: string;
  47736. };
  47737. }
  47738. declare module "babylonjs/PostProcesses/anaglyphPostProcess" {
  47739. import { Engine } from "babylonjs/Engines/engine";
  47740. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  47741. import { Camera } from "babylonjs/Cameras/camera";
  47742. import "babylonjs/Shaders/anaglyph.fragment";
  47743. /**
  47744. * Postprocess used to generate anaglyphic rendering
  47745. */
  47746. export class AnaglyphPostProcess extends PostProcess {
  47747. private _passedProcess;
  47748. /**
  47749. * Gets a string identifying the name of the class
  47750. * @returns "AnaglyphPostProcess" string
  47751. */
  47752. getClassName(): string;
  47753. /**
  47754. * Creates a new AnaglyphPostProcess
  47755. * @param name defines postprocess name
  47756. * @param options defines creation options or target ratio scale
  47757. * @param rigCameras defines cameras using this postprocess
  47758. * @param samplingMode defines required sampling mode (BABYLON.Texture.NEAREST_SAMPLINGMODE by default)
  47759. * @param engine defines hosting engine
  47760. * @param reusable defines if the postprocess will be reused multiple times per frame
  47761. */
  47762. constructor(name: string, options: number | PostProcessOptions, rigCameras: Camera[], samplingMode?: number, engine?: Engine, reusable?: boolean);
  47763. }
  47764. }
  47765. declare module "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode" { }
  47766. declare module "babylonjs/Cameras/Stereoscopic/anaglyphArcRotateCamera" {
  47767. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  47768. import { Scene } from "babylonjs/scene";
  47769. import { Vector3 } from "babylonjs/Maths/math.vector";
  47770. import "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  47771. /**
  47772. * Camera used to simulate anaglyphic rendering (based on ArcRotateCamera)
  47773. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  47774. */
  47775. export class AnaglyphArcRotateCamera extends ArcRotateCamera {
  47776. /**
  47777. * Creates a new AnaglyphArcRotateCamera
  47778. * @param name defines camera name
  47779. * @param alpha defines alpha angle (in radians)
  47780. * @param beta defines beta angle (in radians)
  47781. * @param radius defines radius
  47782. * @param target defines camera target
  47783. * @param interaxialDistance defines distance between each color axis
  47784. * @param scene defines the hosting scene
  47785. */
  47786. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, interaxialDistance: number, scene: Scene);
  47787. /**
  47788. * Gets camera class name
  47789. * @returns AnaglyphArcRotateCamera
  47790. */
  47791. getClassName(): string;
  47792. }
  47793. }
  47794. declare module "babylonjs/Cameras/Stereoscopic/anaglyphFreeCamera" {
  47795. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  47796. import { Scene } from "babylonjs/scene";
  47797. import { Vector3 } from "babylonjs/Maths/math.vector";
  47798. import "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  47799. /**
  47800. * Camera used to simulate anaglyphic rendering (based on FreeCamera)
  47801. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  47802. */
  47803. export class AnaglyphFreeCamera extends FreeCamera {
  47804. /**
  47805. * Creates a new AnaglyphFreeCamera
  47806. * @param name defines camera name
  47807. * @param position defines initial position
  47808. * @param interaxialDistance defines distance between each color axis
  47809. * @param scene defines the hosting scene
  47810. */
  47811. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  47812. /**
  47813. * Gets camera class name
  47814. * @returns AnaglyphFreeCamera
  47815. */
  47816. getClassName(): string;
  47817. }
  47818. }
  47819. declare module "babylonjs/Cameras/Stereoscopic/anaglyphGamepadCamera" {
  47820. import { GamepadCamera } from "babylonjs/Cameras/gamepadCamera";
  47821. import { Scene } from "babylonjs/scene";
  47822. import { Vector3 } from "babylonjs/Maths/math.vector";
  47823. import "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  47824. /**
  47825. * Camera used to simulate anaglyphic rendering (based on GamepadCamera)
  47826. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  47827. */
  47828. export class AnaglyphGamepadCamera extends GamepadCamera {
  47829. /**
  47830. * Creates a new AnaglyphGamepadCamera
  47831. * @param name defines camera name
  47832. * @param position defines initial position
  47833. * @param interaxialDistance defines distance between each color axis
  47834. * @param scene defines the hosting scene
  47835. */
  47836. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  47837. /**
  47838. * Gets camera class name
  47839. * @returns AnaglyphGamepadCamera
  47840. */
  47841. getClassName(): string;
  47842. }
  47843. }
  47844. declare module "babylonjs/Cameras/Stereoscopic/anaglyphUniversalCamera" {
  47845. import { UniversalCamera } from "babylonjs/Cameras/universalCamera";
  47846. import { Scene } from "babylonjs/scene";
  47847. import { Vector3 } from "babylonjs/Maths/math.vector";
  47848. import "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  47849. /**
  47850. * Camera used to simulate anaglyphic rendering (based on UniversalCamera)
  47851. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  47852. */
  47853. export class AnaglyphUniversalCamera extends UniversalCamera {
  47854. /**
  47855. * Creates a new AnaglyphUniversalCamera
  47856. * @param name defines camera name
  47857. * @param position defines initial position
  47858. * @param interaxialDistance defines distance between each color axis
  47859. * @param scene defines the hosting scene
  47860. */
  47861. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  47862. /**
  47863. * Gets camera class name
  47864. * @returns AnaglyphUniversalCamera
  47865. */
  47866. getClassName(): string;
  47867. }
  47868. }
  47869. declare module "babylonjs/Cameras/RigModes/stereoscopicRigMode" { }
  47870. declare module "babylonjs/Cameras/Stereoscopic/stereoscopicArcRotateCamera" {
  47871. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  47872. import { Scene } from "babylonjs/scene";
  47873. import { Vector3 } from "babylonjs/Maths/math.vector";
  47874. import "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  47875. /**
  47876. * Camera used to simulate stereoscopic rendering (based on ArcRotateCamera)
  47877. * @see https://doc.babylonjs.com/features/cameras
  47878. */
  47879. export class StereoscopicArcRotateCamera extends ArcRotateCamera {
  47880. /**
  47881. * Creates a new StereoscopicArcRotateCamera
  47882. * @param name defines camera name
  47883. * @param alpha defines alpha angle (in radians)
  47884. * @param beta defines beta angle (in radians)
  47885. * @param radius defines radius
  47886. * @param target defines camera target
  47887. * @param interaxialDistance defines distance between each color axis
  47888. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  47889. * @param scene defines the hosting scene
  47890. */
  47891. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  47892. /**
  47893. * Gets camera class name
  47894. * @returns StereoscopicArcRotateCamera
  47895. */
  47896. getClassName(): string;
  47897. }
  47898. }
  47899. declare module "babylonjs/Cameras/Stereoscopic/stereoscopicFreeCamera" {
  47900. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  47901. import { Scene } from "babylonjs/scene";
  47902. import { Vector3 } from "babylonjs/Maths/math.vector";
  47903. import "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  47904. /**
  47905. * Camera used to simulate stereoscopic rendering (based on FreeCamera)
  47906. * @see https://doc.babylonjs.com/features/cameras
  47907. */
  47908. export class StereoscopicFreeCamera extends FreeCamera {
  47909. /**
  47910. * Creates a new StereoscopicFreeCamera
  47911. * @param name defines camera name
  47912. * @param position defines initial position
  47913. * @param interaxialDistance defines distance between each color axis
  47914. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  47915. * @param scene defines the hosting scene
  47916. */
  47917. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  47918. /**
  47919. * Gets camera class name
  47920. * @returns StereoscopicFreeCamera
  47921. */
  47922. getClassName(): string;
  47923. }
  47924. }
  47925. declare module "babylonjs/Cameras/Stereoscopic/stereoscopicGamepadCamera" {
  47926. import { GamepadCamera } from "babylonjs/Cameras/gamepadCamera";
  47927. import { Scene } from "babylonjs/scene";
  47928. import { Vector3 } from "babylonjs/Maths/math.vector";
  47929. import "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  47930. /**
  47931. * Camera used to simulate stereoscopic rendering (based on GamepadCamera)
  47932. * @see https://doc.babylonjs.com/features/cameras
  47933. */
  47934. export class StereoscopicGamepadCamera extends GamepadCamera {
  47935. /**
  47936. * Creates a new StereoscopicGamepadCamera
  47937. * @param name defines camera name
  47938. * @param position defines initial position
  47939. * @param interaxialDistance defines distance between each color axis
  47940. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  47941. * @param scene defines the hosting scene
  47942. */
  47943. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  47944. /**
  47945. * Gets camera class name
  47946. * @returns StereoscopicGamepadCamera
  47947. */
  47948. getClassName(): string;
  47949. }
  47950. }
  47951. declare module "babylonjs/Cameras/Stereoscopic/stereoscopicUniversalCamera" {
  47952. import { UniversalCamera } from "babylonjs/Cameras/universalCamera";
  47953. import { Scene } from "babylonjs/scene";
  47954. import { Vector3 } from "babylonjs/Maths/math.vector";
  47955. import "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  47956. /**
  47957. * Camera used to simulate stereoscopic rendering (based on UniversalCamera)
  47958. * @see https://doc.babylonjs.com/features/cameras
  47959. */
  47960. export class StereoscopicUniversalCamera extends UniversalCamera {
  47961. /**
  47962. * Creates a new StereoscopicUniversalCamera
  47963. * @param name defines camera name
  47964. * @param position defines initial position
  47965. * @param interaxialDistance defines distance between each color axis
  47966. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  47967. * @param scene defines the hosting scene
  47968. */
  47969. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  47970. /**
  47971. * Gets camera class name
  47972. * @returns StereoscopicUniversalCamera
  47973. */
  47974. getClassName(): string;
  47975. }
  47976. }
  47977. declare module "babylonjs/Cameras/Stereoscopic/index" {
  47978. export * from "babylonjs/Cameras/Stereoscopic/anaglyphArcRotateCamera";
  47979. export * from "babylonjs/Cameras/Stereoscopic/anaglyphFreeCamera";
  47980. export * from "babylonjs/Cameras/Stereoscopic/anaglyphGamepadCamera";
  47981. export * from "babylonjs/Cameras/Stereoscopic/anaglyphUniversalCamera";
  47982. export * from "babylonjs/Cameras/Stereoscopic/stereoscopicArcRotateCamera";
  47983. export * from "babylonjs/Cameras/Stereoscopic/stereoscopicFreeCamera";
  47984. export * from "babylonjs/Cameras/Stereoscopic/stereoscopicGamepadCamera";
  47985. export * from "babylonjs/Cameras/Stereoscopic/stereoscopicUniversalCamera";
  47986. }
  47987. declare module "babylonjs/Cameras/virtualJoysticksCamera" {
  47988. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  47989. import { Scene } from "babylonjs/scene";
  47990. import { Vector3 } from "babylonjs/Maths/math.vector";
  47991. import "babylonjs/Cameras/Inputs/freeCameraVirtualJoystickInput";
  47992. /**
  47993. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  47994. * It is identical to the Free Camera and simply adds by default a virtual joystick.
  47995. * Virtual Joysticks are on-screen 2D graphics that are used to control the camera or other scene items.
  47996. * @see https://doc.babylonjs.com/features/cameras#virtual-joysticks-camera
  47997. */
  47998. export class VirtualJoysticksCamera extends FreeCamera {
  47999. /**
  48000. * Intantiates a VirtualJoysticksCamera. It can be useful in First Person Shooter game for instance.
  48001. * It is identical to the Free Camera and simply adds by default a virtual joystick.
  48002. * Virtual Joysticks are on-screen 2D graphics that are used to control the camera or other scene items.
  48003. * @see https://doc.babylonjs.com/features/cameras#virtual-joysticks-camera
  48004. * @param name Define the name of the camera in the scene
  48005. * @param position Define the start position of the camera in the scene
  48006. * @param scene Define the scene the camera belongs to
  48007. */
  48008. constructor(name: string, position: Vector3, scene: Scene);
  48009. /**
  48010. * Gets the current object class name.
  48011. * @return the class name
  48012. */
  48013. getClassName(): string;
  48014. }
  48015. }
  48016. declare module "babylonjs/Cameras/VR/vrCameraMetrics" {
  48017. import { Matrix } from "babylonjs/Maths/math.vector";
  48018. /**
  48019. * This represents all the required metrics to create a VR camera.
  48020. * @see https://doc.babylonjs.com/babylon101/cameras#device-orientation-camera
  48021. */
  48022. export class VRCameraMetrics {
  48023. /**
  48024. * Define the horizontal resolution off the screen.
  48025. */
  48026. hResolution: number;
  48027. /**
  48028. * Define the vertical resolution off the screen.
  48029. */
  48030. vResolution: number;
  48031. /**
  48032. * Define the horizontal screen size.
  48033. */
  48034. hScreenSize: number;
  48035. /**
  48036. * Define the vertical screen size.
  48037. */
  48038. vScreenSize: number;
  48039. /**
  48040. * Define the vertical screen center position.
  48041. */
  48042. vScreenCenter: number;
  48043. /**
  48044. * Define the distance of the eyes to the screen.
  48045. */
  48046. eyeToScreenDistance: number;
  48047. /**
  48048. * Define the distance between both lenses
  48049. */
  48050. lensSeparationDistance: number;
  48051. /**
  48052. * Define the distance between both viewer's eyes.
  48053. */
  48054. interpupillaryDistance: number;
  48055. /**
  48056. * Define the distortion factor of the VR postprocess.
  48057. * Please, touch with care.
  48058. */
  48059. distortionK: number[];
  48060. /**
  48061. * Define the chromatic aberration correction factors for the VR post process.
  48062. */
  48063. chromaAbCorrection: number[];
  48064. /**
  48065. * Define the scale factor of the post process.
  48066. * The smaller the better but the slower.
  48067. */
  48068. postProcessScaleFactor: number;
  48069. /**
  48070. * Define an offset for the lens center.
  48071. */
  48072. lensCenterOffset: number;
  48073. /**
  48074. * Define if the current vr camera should compensate the distortion of the lense or not.
  48075. */
  48076. compensateDistortion: boolean;
  48077. /**
  48078. * Defines if multiview should be enabled when rendering (Default: false)
  48079. */
  48080. multiviewEnabled: boolean;
  48081. /**
  48082. * Gets the rendering aspect ratio based on the provided resolutions.
  48083. */
  48084. get aspectRatio(): number;
  48085. /**
  48086. * Gets the aspect ratio based on the FOV, scale factors, and real screen sizes.
  48087. */
  48088. get aspectRatioFov(): number;
  48089. /**
  48090. * @hidden
  48091. */
  48092. get leftHMatrix(): Matrix;
  48093. /**
  48094. * @hidden
  48095. */
  48096. get rightHMatrix(): Matrix;
  48097. /**
  48098. * @hidden
  48099. */
  48100. get leftPreViewMatrix(): Matrix;
  48101. /**
  48102. * @hidden
  48103. */
  48104. get rightPreViewMatrix(): Matrix;
  48105. /**
  48106. * Get the default VRMetrics based on the most generic setup.
  48107. * @returns the default vr metrics
  48108. */
  48109. static GetDefault(): VRCameraMetrics;
  48110. }
  48111. }
  48112. declare module "babylonjs/Shaders/vrDistortionCorrection.fragment" {
  48113. /** @hidden */
  48114. export var vrDistortionCorrectionPixelShader: {
  48115. name: string;
  48116. shader: string;
  48117. };
  48118. }
  48119. declare module "babylonjs/PostProcesses/vrDistortionCorrectionPostProcess" {
  48120. import { Camera } from "babylonjs/Cameras/camera";
  48121. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  48122. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  48123. import "babylonjs/Shaders/vrDistortionCorrection.fragment";
  48124. /**
  48125. * VRDistortionCorrectionPostProcess used for mobile VR
  48126. */
  48127. export class VRDistortionCorrectionPostProcess extends PostProcess {
  48128. private _isRightEye;
  48129. private _distortionFactors;
  48130. private _postProcessScaleFactor;
  48131. private _lensCenterOffset;
  48132. private _scaleIn;
  48133. private _scaleFactor;
  48134. private _lensCenter;
  48135. /**
  48136. * Gets a string identifying the name of the class
  48137. * @returns "VRDistortionCorrectionPostProcess" string
  48138. */
  48139. getClassName(): string;
  48140. /**
  48141. * Initializes the VRDistortionCorrectionPostProcess
  48142. * @param name The name of the effect.
  48143. * @param camera The camera to apply the render pass to.
  48144. * @param isRightEye If this is for the right eye distortion
  48145. * @param vrMetrics All the required metrics for the VR camera
  48146. */
  48147. constructor(name: string, camera: Camera, isRightEye: boolean, vrMetrics: VRCameraMetrics);
  48148. }
  48149. }
  48150. declare module "babylonjs/Cameras/RigModes/vrRigMode" { }
  48151. declare module "babylonjs/Cameras/VR/vrDeviceOrientationArcRotateCamera" {
  48152. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  48153. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  48154. import { Scene } from "babylonjs/scene";
  48155. import { Vector3 } from "babylonjs/Maths/math.vector";
  48156. import "babylonjs/Cameras/Inputs/arcRotateCameraVRDeviceOrientationInput";
  48157. import "babylonjs/Cameras/RigModes/vrRigMode";
  48158. /**
  48159. * Camera used to simulate VR rendering (based on ArcRotateCamera)
  48160. * @see https://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  48161. */
  48162. export class VRDeviceOrientationArcRotateCamera extends ArcRotateCamera {
  48163. /**
  48164. * Creates a new VRDeviceOrientationArcRotateCamera
  48165. * @param name defines camera name
  48166. * @param alpha defines the camera rotation along the logitudinal axis
  48167. * @param beta defines the camera rotation along the latitudinal axis
  48168. * @param radius defines the camera distance from its target
  48169. * @param target defines the camera target
  48170. * @param scene defines the scene the camera belongs to
  48171. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  48172. * @param vrCameraMetrics defines the vr metrics associated to the camera
  48173. */
  48174. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  48175. /**
  48176. * Gets camera class name
  48177. * @returns VRDeviceOrientationArcRotateCamera
  48178. */
  48179. getClassName(): string;
  48180. }
  48181. }
  48182. declare module "babylonjs/Cameras/VR/vrDeviceOrientationFreeCamera" {
  48183. import { DeviceOrientationCamera } from "babylonjs/Cameras/deviceOrientationCamera";
  48184. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  48185. import { Scene } from "babylonjs/scene";
  48186. import { Vector3 } from "babylonjs/Maths/math.vector";
  48187. import "babylonjs/Cameras/RigModes/vrRigMode";
  48188. /**
  48189. * Camera used to simulate VR rendering (based on FreeCamera)
  48190. * @see https://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  48191. */
  48192. export class VRDeviceOrientationFreeCamera extends DeviceOrientationCamera {
  48193. /**
  48194. * Creates a new VRDeviceOrientationFreeCamera
  48195. * @param name defines camera name
  48196. * @param position defines the start position of the camera
  48197. * @param scene defines the scene the camera belongs to
  48198. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  48199. * @param vrCameraMetrics defines the vr metrics associated to the camera
  48200. */
  48201. constructor(name: string, position: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  48202. /**
  48203. * Gets camera class name
  48204. * @returns VRDeviceOrientationFreeCamera
  48205. */
  48206. getClassName(): string;
  48207. }
  48208. }
  48209. declare module "babylonjs/Cameras/VR/vrDeviceOrientationGamepadCamera" {
  48210. import { VRDeviceOrientationFreeCamera } from "babylonjs/Cameras/VR/vrDeviceOrientationFreeCamera";
  48211. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  48212. import { Scene } from "babylonjs/scene";
  48213. import { Vector3 } from "babylonjs/Maths/math.vector";
  48214. import "babylonjs/Gamepads/gamepadSceneComponent";
  48215. /**
  48216. * Camera used to simulate VR rendering (based on VRDeviceOrientationFreeCamera)
  48217. * @see https://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  48218. */
  48219. export class VRDeviceOrientationGamepadCamera extends VRDeviceOrientationFreeCamera {
  48220. /**
  48221. * Creates a new VRDeviceOrientationGamepadCamera
  48222. * @param name defines camera name
  48223. * @param position defines the start position of the camera
  48224. * @param scene defines the scene the camera belongs to
  48225. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  48226. * @param vrCameraMetrics defines the vr metrics associated to the camera
  48227. */
  48228. constructor(name: string, position: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  48229. /**
  48230. * Gets camera class name
  48231. * @returns VRDeviceOrientationGamepadCamera
  48232. */
  48233. getClassName(): string;
  48234. }
  48235. }
  48236. declare module "babylonjs/Materials/Textures/dynamicTexture" {
  48237. import { Scene } from "babylonjs/scene";
  48238. import { Texture } from "babylonjs/Materials/Textures/texture";
  48239. import "babylonjs/Engines/Extensions/engine.dynamicTexture";
  48240. /**
  48241. * A class extending Texture allowing drawing on a texture
  48242. * @see https://doc.babylonjs.com/how_to/dynamictexture
  48243. */
  48244. export class DynamicTexture extends Texture {
  48245. private _generateMipMaps;
  48246. private _canvas;
  48247. private _context;
  48248. /**
  48249. * Creates a DynamicTexture
  48250. * @param name defines the name of the texture
  48251. * @param options provides 3 alternatives for width and height of texture, a canvas, object with width and height properties, number for both width and height
  48252. * @param scene defines the scene where you want the texture
  48253. * @param generateMipMaps defines the use of MinMaps or not (default is false)
  48254. * @param samplingMode defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  48255. * @param format defines the texture format to use (default is Engine.TEXTUREFORMAT_RGBA)
  48256. */
  48257. constructor(name: string, options: any, scene: Scene | null | undefined, generateMipMaps: boolean, samplingMode?: number, format?: number);
  48258. /**
  48259. * Get the current class name of the texture useful for serialization or dynamic coding.
  48260. * @returns "DynamicTexture"
  48261. */
  48262. getClassName(): string;
  48263. /**
  48264. * Gets the current state of canRescale
  48265. */
  48266. get canRescale(): boolean;
  48267. private _recreate;
  48268. /**
  48269. * Scales the texture
  48270. * @param ratio the scale factor to apply to both width and height
  48271. */
  48272. scale(ratio: number): void;
  48273. /**
  48274. * Resizes the texture
  48275. * @param width the new width
  48276. * @param height the new height
  48277. */
  48278. scaleTo(width: number, height: number): void;
  48279. /**
  48280. * Gets the context of the canvas used by the texture
  48281. * @returns the canvas context of the dynamic texture
  48282. */
  48283. getContext(): CanvasRenderingContext2D;
  48284. /**
  48285. * Clears the texture
  48286. */
  48287. clear(): void;
  48288. /**
  48289. * Updates the texture
  48290. * @param invertY defines the direction for the Y axis (default is true - y increases downwards)
  48291. * @param premulAlpha defines if alpha is stored as premultiplied (default is false)
  48292. */
  48293. update(invertY?: boolean, premulAlpha?: boolean): void;
  48294. /**
  48295. * Draws text onto the texture
  48296. * @param text defines the text to be drawn
  48297. * @param x defines the placement of the text from the left
  48298. * @param y defines the placement of the text from the top when invertY is true and from the bottom when false
  48299. * @param font defines the font to be used with font-style, font-size, font-name
  48300. * @param color defines the color used for the text
  48301. * @param clearColor defines the color for the canvas, use null to not overwrite canvas
  48302. * @param invertY defines the direction for the Y axis (default is true - y increases downwards)
  48303. * @param update defines whether texture is immediately update (default is true)
  48304. */
  48305. drawText(text: string, x: number | null | undefined, y: number | null | undefined, font: string, color: string | null, clearColor: string, invertY?: boolean, update?: boolean): void;
  48306. /**
  48307. * Clones the texture
  48308. * @returns the clone of the texture.
  48309. */
  48310. clone(): DynamicTexture;
  48311. /**
  48312. * Serializes the dynamic texture. The scene should be ready before the dynamic texture is serialized
  48313. * @returns a serialized dynamic texture object
  48314. */
  48315. serialize(): any;
  48316. private _IsCanvasElement;
  48317. /** @hidden */
  48318. _rebuild(): void;
  48319. }
  48320. }
  48321. declare module "babylonjs/Meshes/Builders/groundBuilder" {
  48322. import { Scene } from "babylonjs/scene";
  48323. import { Color3 } from "babylonjs/Maths/math.color";
  48324. import { Mesh } from "babylonjs/Meshes/mesh";
  48325. import { GroundMesh } from "babylonjs/Meshes/groundMesh";
  48326. import { Nullable } from "babylonjs/types";
  48327. /**
  48328. * Class containing static functions to help procedurally build meshes
  48329. */
  48330. export class GroundBuilder {
  48331. /**
  48332. * Creates a ground mesh
  48333. * * The parameters `width` and `height` (floats, default 1) set the width and height sizes of the ground
  48334. * * The parameter `subdivisions` (positive integer) sets the number of subdivisions per side
  48335. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  48336. * @param name defines the name of the mesh
  48337. * @param options defines the options used to create the mesh
  48338. * @param scene defines the hosting scene
  48339. * @returns the ground mesh
  48340. * @see https://doc.babylonjs.com/how_to/set_shapes#ground
  48341. */
  48342. static CreateGround(name: string, options: {
  48343. width?: number;
  48344. height?: number;
  48345. subdivisions?: number;
  48346. subdivisionsX?: number;
  48347. subdivisionsY?: number;
  48348. updatable?: boolean;
  48349. }, scene: any): Mesh;
  48350. /**
  48351. * Creates a tiled ground mesh
  48352. * * The parameters `xmin` and `xmax` (floats, default -1 and 1) set the ground minimum and maximum X coordinates
  48353. * * The parameters `zmin` and `zmax` (floats, default -1 and 1) set the ground minimum and maximum Z coordinates
  48354. * * The parameter `subdivisions` is a javascript object `{w: positive integer, h: positive integer}` (default `{w: 6, h: 6}`). `w` and `h` are the numbers of subdivisions on the ground width and height. Each subdivision is called a tile
  48355. * * The parameter `precision` is a javascript object `{w: positive integer, h: positive integer}` (default `{w: 2, h: 2}`). `w` and `h` are the numbers of subdivisions on the ground width and height of each tile
  48356. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  48357. * @param name defines the name of the mesh
  48358. * @param options defines the options used to create the mesh
  48359. * @param scene defines the hosting scene
  48360. * @returns the tiled ground mesh
  48361. * @see https://doc.babylonjs.com/how_to/set_shapes#tiled-ground
  48362. */
  48363. static CreateTiledGround(name: string, options: {
  48364. xmin: number;
  48365. zmin: number;
  48366. xmax: number;
  48367. zmax: number;
  48368. subdivisions?: {
  48369. w: number;
  48370. h: number;
  48371. };
  48372. precision?: {
  48373. w: number;
  48374. h: number;
  48375. };
  48376. updatable?: boolean;
  48377. }, scene?: Nullable<Scene>): Mesh;
  48378. /**
  48379. * Creates a ground mesh from a height map
  48380. * * The parameter `url` sets the URL of the height map image resource.
  48381. * * The parameters `width` and `height` (positive floats, default 10) set the ground width and height sizes.
  48382. * * The parameter `subdivisions` (positive integer, default 1) sets the number of subdivision per side.
  48383. * * The parameter `minHeight` (float, default 0) is the minimum altitude on the ground.
  48384. * * The parameter `maxHeight` (float, default 1) is the maximum altitude on the ground.
  48385. * * The parameter `colorFilter` (optional Color3, default (0.3, 0.59, 0.11) ) is the filter to apply to the image pixel colors to compute the height.
  48386. * * The parameter `onReady` is a javascript callback function that will be called once the mesh is just built (the height map download can last some time).
  48387. * * The parameter `alphaFilter` will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  48388. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  48389. * @param name defines the name of the mesh
  48390. * @param url defines the url to the height map
  48391. * @param options defines the options used to create the mesh
  48392. * @param scene defines the hosting scene
  48393. * @returns the ground mesh
  48394. * @see https://doc.babylonjs.com/babylon101/height_map
  48395. * @see https://doc.babylonjs.com/how_to/set_shapes#ground-from-a-height-map
  48396. */
  48397. static CreateGroundFromHeightMap(name: string, url: string, options: {
  48398. width?: number;
  48399. height?: number;
  48400. subdivisions?: number;
  48401. minHeight?: number;
  48402. maxHeight?: number;
  48403. colorFilter?: Color3;
  48404. alphaFilter?: number;
  48405. updatable?: boolean;
  48406. onReady?: (mesh: GroundMesh) => void;
  48407. }, scene?: Nullable<Scene>): GroundMesh;
  48408. }
  48409. }
  48410. declare module "babylonjs/Meshes/Builders/torusBuilder" {
  48411. import { Vector4 } from "babylonjs/Maths/math.vector";
  48412. import { Mesh } from "babylonjs/Meshes/mesh";
  48413. /**
  48414. * Class containing static functions to help procedurally build meshes
  48415. */
  48416. export class TorusBuilder {
  48417. /**
  48418. * Creates a torus mesh
  48419. * * The parameter `diameter` sets the diameter size (float) of the torus (default 1)
  48420. * * The parameter `thickness` sets the diameter size of the tube of the torus (float, default 0.5)
  48421. * * The parameter `tessellation` sets the number of torus sides (postive integer, default 16)
  48422. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  48423. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  48424. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  48425. * @param name defines the name of the mesh
  48426. * @param options defines the options used to create the mesh
  48427. * @param scene defines the hosting scene
  48428. * @returns the torus mesh
  48429. * @see https://doc.babylonjs.com/how_to/set_shapes#torus
  48430. */
  48431. static CreateTorus(name: string, options: {
  48432. diameter?: number;
  48433. thickness?: number;
  48434. tessellation?: number;
  48435. updatable?: boolean;
  48436. sideOrientation?: number;
  48437. frontUVs?: Vector4;
  48438. backUVs?: Vector4;
  48439. }, scene: any): Mesh;
  48440. }
  48441. }
  48442. declare module "babylonjs/Meshes/Builders/cylinderBuilder" {
  48443. import { Vector4 } from "babylonjs/Maths/math.vector";
  48444. import { Color4 } from "babylonjs/Maths/math.color";
  48445. import { Mesh } from "babylonjs/Meshes/mesh";
  48446. /**
  48447. * Class containing static functions to help procedurally build meshes
  48448. */
  48449. export class CylinderBuilder {
  48450. /**
  48451. * Creates a cylinder or a cone mesh
  48452. * * The parameter `height` sets the height size (float) of the cylinder/cone (float, default 2).
  48453. * * The parameter `diameter` sets the diameter of the top and bottom cap at once (float, default 1).
  48454. * * The parameters `diameterTop` and `diameterBottom` overwrite the parameter `diameter` and set respectively the top cap and bottom cap diameter (floats, default 1). The parameter "diameterBottom" can't be zero.
  48455. * * The parameter `tessellation` sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance.
  48456. * * The parameter `subdivisions` sets the number of rings along the cylinder height (positive integer, default 1).
  48457. * * The parameter `hasRings` (boolean, default false) makes the subdivisions independent from each other, so they become different faces.
  48458. * * The parameter `enclose` (boolean, default false) adds two extra faces per subdivision to a sliced cylinder to close it around its height axis.
  48459. * * The parameter `cap` sets the way the cylinder is capped. Possible values : BABYLON.Mesh.NO_CAP, BABYLON.Mesh.CAP_START, BABYLON.Mesh.CAP_END, BABYLON.Mesh.CAP_ALL (default).
  48460. * * The parameter `arc` (float, default 1) is the ratio (max 1) to apply to the circumference to slice the cylinder.
  48461. * * You can set different colors and different images to each box side by using the parameters `faceColors` (an array of n Color3 elements) and `faceUV` (an array of n Vector4 elements).
  48462. * * The value of n is the number of cylinder faces. If the cylinder has only 1 subdivisions, n equals : top face + cylinder surface + bottom face = 3
  48463. * * Now, if the cylinder has 5 independent subdivisions (hasRings = true), n equals : top face + 5 stripe surfaces + bottom face = 2 + 5 = 7
  48464. * * Finally, if the cylinder has 5 independent subdivisions and is enclose, n equals : top face + 5 x (stripe surface + 2 closing faces) + bottom face = 2 + 5 * 3 = 17
  48465. * * Each array (color or UVs) is always ordered the same way : the first element is the bottom cap, the last element is the top cap. The other elements are each a ring surface.
  48466. * * If `enclose` is false, a ring surface is one element.
  48467. * * If `enclose` is true, a ring surface is 3 successive elements in the array : the tubular surface, then the two closing faces.
  48468. * * Example how to set colors and textures on a sliced cylinder : https://www.html5gamedevs.com/topic/17945-creating-a-closed-slice-of-a-cylinder/#comment-106379
  48469. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  48470. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  48471. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  48472. * @param name defines the name of the mesh
  48473. * @param options defines the options used to create the mesh
  48474. * @param scene defines the hosting scene
  48475. * @returns the cylinder mesh
  48476. * @see https://doc.babylonjs.com/how_to/set_shapes#cylinder-or-cone
  48477. */
  48478. static CreateCylinder(name: string, options: {
  48479. height?: number;
  48480. diameterTop?: number;
  48481. diameterBottom?: number;
  48482. diameter?: number;
  48483. tessellation?: number;
  48484. subdivisions?: number;
  48485. arc?: number;
  48486. faceColors?: Color4[];
  48487. faceUV?: Vector4[];
  48488. updatable?: boolean;
  48489. hasRings?: boolean;
  48490. enclose?: boolean;
  48491. cap?: number;
  48492. sideOrientation?: number;
  48493. frontUVs?: Vector4;
  48494. backUVs?: Vector4;
  48495. }, scene: any): Mesh;
  48496. }
  48497. }
  48498. declare module "babylonjs/XR/webXRTypes" {
  48499. import { Nullable } from "babylonjs/types";
  48500. import { IDisposable } from "babylonjs/scene";
  48501. /**
  48502. * States of the webXR experience
  48503. */
  48504. export enum WebXRState {
  48505. /**
  48506. * Transitioning to being in XR mode
  48507. */
  48508. ENTERING_XR = 0,
  48509. /**
  48510. * Transitioning to non XR mode
  48511. */
  48512. EXITING_XR = 1,
  48513. /**
  48514. * In XR mode and presenting
  48515. */
  48516. IN_XR = 2,
  48517. /**
  48518. * Not entered XR mode
  48519. */
  48520. NOT_IN_XR = 3
  48521. }
  48522. /**
  48523. * Abstraction of the XR render target
  48524. */
  48525. export interface WebXRRenderTarget extends IDisposable {
  48526. /**
  48527. * xrpresent context of the canvas which can be used to display/mirror xr content
  48528. */
  48529. canvasContext: WebGLRenderingContext;
  48530. /**
  48531. * xr layer for the canvas
  48532. */
  48533. xrLayer: Nullable<XRWebGLLayer>;
  48534. /**
  48535. * Initializes the xr layer for the session
  48536. * @param xrSession xr session
  48537. * @returns a promise that will resolve once the XR Layer has been created
  48538. */
  48539. initializeXRLayerAsync(xrSession: XRSession): Promise<XRWebGLLayer>;
  48540. }
  48541. }
  48542. declare module "babylonjs/XR/webXRManagedOutputCanvas" {
  48543. import { Nullable } from "babylonjs/types";
  48544. import { WebXRRenderTarget } from "babylonjs/XR/webXRTypes";
  48545. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  48546. import { Observable } from "babylonjs/Misc/observable";
  48547. /**
  48548. * COnfiguration object for WebXR output canvas
  48549. */
  48550. export class WebXRManagedOutputCanvasOptions {
  48551. /**
  48552. * An optional canvas in case you wish to create it yourself and provide it here.
  48553. * If not provided, a new canvas will be created
  48554. */
  48555. canvasElement?: HTMLCanvasElement;
  48556. /**
  48557. * Options for this XR Layer output
  48558. */
  48559. canvasOptions?: XRWebGLLayerOptions;
  48560. /**
  48561. * CSS styling for a newly created canvas (if not provided)
  48562. */
  48563. newCanvasCssStyle?: string;
  48564. /**
  48565. * Get the default values of the configuration object
  48566. * @returns default values of this configuration object
  48567. */
  48568. static GetDefaults(): WebXRManagedOutputCanvasOptions;
  48569. }
  48570. /**
  48571. * Creates a canvas that is added/removed from the webpage when entering/exiting XR
  48572. */
  48573. export class WebXRManagedOutputCanvas implements WebXRRenderTarget {
  48574. private _options;
  48575. private _canvas;
  48576. private _engine;
  48577. private _originalCanvasSize;
  48578. /**
  48579. * Rendering context of the canvas which can be used to display/mirror xr content
  48580. */
  48581. canvasContext: WebGLRenderingContext;
  48582. /**
  48583. * xr layer for the canvas
  48584. */
  48585. xrLayer: Nullable<XRWebGLLayer>;
  48586. /**
  48587. * Obseervers registered here will be triggered when the xr layer was initialized
  48588. */
  48589. onXRLayerInitObservable: Observable<XRWebGLLayer>;
  48590. /**
  48591. * Initializes the canvas to be added/removed upon entering/exiting xr
  48592. * @param _xrSessionManager The XR Session manager
  48593. * @param _options optional configuration for this canvas output. defaults will be used if not provided
  48594. */
  48595. constructor(_xrSessionManager: WebXRSessionManager, _options?: WebXRManagedOutputCanvasOptions);
  48596. /**
  48597. * Disposes of the object
  48598. */
  48599. dispose(): void;
  48600. /**
  48601. * Initializes the xr layer for the session
  48602. * @param xrSession xr session
  48603. * @returns a promise that will resolve once the XR Layer has been created
  48604. */
  48605. initializeXRLayerAsync(xrSession: XRSession): Promise<XRWebGLLayer>;
  48606. private _addCanvas;
  48607. private _removeCanvas;
  48608. private _setCanvasSize;
  48609. private _setManagedOutputCanvas;
  48610. }
  48611. }
  48612. declare module "babylonjs/XR/webXRSessionManager" {
  48613. import { Observable } from "babylonjs/Misc/observable";
  48614. import { Nullable } from "babylonjs/types";
  48615. import { IDisposable, Scene } from "babylonjs/scene";
  48616. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  48617. import { WebXRRenderTarget } from "babylonjs/XR/webXRTypes";
  48618. import { WebXRManagedOutputCanvasOptions } from "babylonjs/XR/webXRManagedOutputCanvas";
  48619. /**
  48620. * Manages an XRSession to work with Babylon's engine
  48621. * @see https://doc.babylonjs.com/how_to/webxr_session_manager
  48622. */
  48623. export class WebXRSessionManager implements IDisposable {
  48624. /** The scene which the session should be created for */
  48625. scene: Scene;
  48626. private _referenceSpace;
  48627. private _rttProvider;
  48628. private _sessionEnded;
  48629. private _xrNavigator;
  48630. private baseLayer;
  48631. /**
  48632. * The base reference space from which the session started. good if you want to reset your
  48633. * reference space
  48634. */
  48635. baseReferenceSpace: XRReferenceSpace;
  48636. /**
  48637. * Current XR frame
  48638. */
  48639. currentFrame: Nullable<XRFrame>;
  48640. /** WebXR timestamp updated every frame */
  48641. currentTimestamp: number;
  48642. /**
  48643. * Used just in case of a failure to initialize an immersive session.
  48644. * The viewer reference space is compensated using this height, creating a kind of "viewer-floor" reference space
  48645. */
  48646. defaultHeightCompensation: number;
  48647. /**
  48648. * Fires every time a new xrFrame arrives which can be used to update the camera
  48649. */
  48650. onXRFrameObservable: Observable<XRFrame>;
  48651. /**
  48652. * Fires when the reference space changed
  48653. */
  48654. onXRReferenceSpaceChanged: Observable<XRReferenceSpace>;
  48655. /**
  48656. * Fires when the xr session is ended either by the device or manually done
  48657. */
  48658. onXRSessionEnded: Observable<any>;
  48659. /**
  48660. * Fires when the xr session is ended either by the device or manually done
  48661. */
  48662. onXRSessionInit: Observable<XRSession>;
  48663. /**
  48664. * Underlying xr session
  48665. */
  48666. session: XRSession;
  48667. /**
  48668. * The viewer (head position) reference space. This can be used to get the XR world coordinates
  48669. * or get the offset the player is currently at.
  48670. */
  48671. viewerReferenceSpace: XRReferenceSpace;
  48672. /**
  48673. * Constructs a WebXRSessionManager, this must be initialized within a user action before usage
  48674. * @param scene The scene which the session should be created for
  48675. */
  48676. constructor(
  48677. /** The scene which the session should be created for */
  48678. scene: Scene);
  48679. /**
  48680. * The current reference space used in this session. This reference space can constantly change!
  48681. * It is mainly used to offset the camera's position.
  48682. */
  48683. get referenceSpace(): XRReferenceSpace;
  48684. /**
  48685. * Set a new reference space and triggers the observable
  48686. */
  48687. set referenceSpace(newReferenceSpace: XRReferenceSpace);
  48688. /**
  48689. * Disposes of the session manager
  48690. */
  48691. dispose(): void;
  48692. /**
  48693. * Stops the xrSession and restores the render loop
  48694. * @returns Promise which resolves after it exits XR
  48695. */
  48696. exitXRAsync(): Promise<void>;
  48697. /**
  48698. * Gets the correct render target texture to be rendered this frame for this eye
  48699. * @param eye the eye for which to get the render target
  48700. * @returns the render target for the specified eye
  48701. */
  48702. getRenderTargetTextureForEye(eye: XREye): RenderTargetTexture;
  48703. /**
  48704. * Creates a WebXRRenderTarget object for the XR session
  48705. * @param onStateChangedObservable optional, mechanism for enabling/disabling XR rendering canvas, used only on Web
  48706. * @param options optional options to provide when creating a new render target
  48707. * @returns a WebXR render target to which the session can render
  48708. */
  48709. getWebXRRenderTarget(options?: WebXRManagedOutputCanvasOptions): WebXRRenderTarget;
  48710. /**
  48711. * Initializes the manager
  48712. * After initialization enterXR can be called to start an XR session
  48713. * @returns Promise which resolves after it is initialized
  48714. */
  48715. initializeAsync(): Promise<void>;
  48716. /**
  48717. * Initializes an xr session
  48718. * @param xrSessionMode mode to initialize
  48719. * @param xrSessionInit defines optional and required values to pass to the session builder
  48720. * @returns a promise which will resolve once the session has been initialized
  48721. */
  48722. initializeSessionAsync(xrSessionMode?: XRSessionMode, xrSessionInit?: XRSessionInit): Promise<XRSession>;
  48723. /**
  48724. * Checks if a session would be supported for the creation options specified
  48725. * @param sessionMode session mode to check if supported eg. immersive-vr
  48726. * @returns A Promise that resolves to true if supported and false if not
  48727. */
  48728. isSessionSupportedAsync(sessionMode: XRSessionMode): Promise<boolean>;
  48729. /**
  48730. * Resets the reference space to the one started the session
  48731. */
  48732. resetReferenceSpace(): void;
  48733. /**
  48734. * Starts rendering to the xr layer
  48735. */
  48736. runXRRenderLoop(): void;
  48737. /**
  48738. * Sets the reference space on the xr session
  48739. * @param referenceSpaceType space to set
  48740. * @returns a promise that will resolve once the reference space has been set
  48741. */
  48742. setReferenceSpaceTypeAsync(referenceSpaceType?: XRReferenceSpaceType): Promise<XRReferenceSpace>;
  48743. /**
  48744. * Updates the render state of the session
  48745. * @param state state to set
  48746. * @returns a promise that resolves once the render state has been updated
  48747. */
  48748. updateRenderStateAsync(state: XRRenderState): Promise<void>;
  48749. /**
  48750. * Returns a promise that resolves with a boolean indicating if the provided session mode is supported by this browser
  48751. * @param sessionMode defines the session to test
  48752. * @returns a promise with boolean as final value
  48753. */
  48754. static IsSessionSupportedAsync(sessionMode: XRSessionMode): Promise<boolean>;
  48755. private _createRenderTargetTexture;
  48756. }
  48757. }
  48758. declare module "babylonjs/XR/webXRCamera" {
  48759. import { Vector3 } from "babylonjs/Maths/math.vector";
  48760. import { Scene } from "babylonjs/scene";
  48761. import { Camera } from "babylonjs/Cameras/camera";
  48762. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  48763. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  48764. import { Observable } from "babylonjs/Misc/observable";
  48765. /**
  48766. * WebXR Camera which holds the views for the xrSession
  48767. * @see https://doc.babylonjs.com/how_to/webxr_camera
  48768. */
  48769. export class WebXRCamera extends FreeCamera {
  48770. private _xrSessionManager;
  48771. private _firstFrame;
  48772. private _referenceQuaternion;
  48773. private _referencedPosition;
  48774. private _xrInvPositionCache;
  48775. private _xrInvQuaternionCache;
  48776. /**
  48777. * Observable raised before camera teleportation
  48778. */
  48779. onBeforeCameraTeleport: Observable<Vector3>;
  48780. /**
  48781. * Observable raised after camera teleportation
  48782. */
  48783. onAfterCameraTeleport: Observable<Vector3>;
  48784. /**
  48785. * Should position compensation execute on first frame.
  48786. * This is used when copying the position from a native (non XR) camera
  48787. */
  48788. compensateOnFirstFrame: boolean;
  48789. /**
  48790. * Creates a new webXRCamera, this should only be set at the camera after it has been updated by the xrSessionManager
  48791. * @param name the name of the camera
  48792. * @param scene the scene to add the camera to
  48793. * @param _xrSessionManager a constructed xr session manager
  48794. */
  48795. constructor(name: string, scene: Scene, _xrSessionManager: WebXRSessionManager);
  48796. /**
  48797. * Return the user's height, unrelated to the current ground.
  48798. * This will be the y position of this camera, when ground level is 0.
  48799. */
  48800. get realWorldHeight(): number;
  48801. /** @hidden */
  48802. _updateForDualEyeDebugging(): void;
  48803. /**
  48804. * Sets this camera's transformation based on a non-vr camera
  48805. * @param otherCamera the non-vr camera to copy the transformation from
  48806. * @param resetToBaseReferenceSpace should XR reset to the base reference space
  48807. */
  48808. setTransformationFromNonVRCamera(otherCamera?: Camera, resetToBaseReferenceSpace?: boolean): void;
  48809. /**
  48810. * Gets the current instance class name ("WebXRCamera").
  48811. * @returns the class name
  48812. */
  48813. getClassName(): string;
  48814. private _rotate180;
  48815. private _updateFromXRSession;
  48816. private _updateNumberOfRigCameras;
  48817. private _updateReferenceSpace;
  48818. private _updateReferenceSpaceOffset;
  48819. }
  48820. }
  48821. declare module "babylonjs/XR/webXRFeaturesManager" {
  48822. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  48823. import { IDisposable } from "babylonjs/scene";
  48824. /**
  48825. * Defining the interface required for a (webxr) feature
  48826. */
  48827. export interface IWebXRFeature extends IDisposable {
  48828. /**
  48829. * Is this feature attached
  48830. */
  48831. attached: boolean;
  48832. /**
  48833. * Should auto-attach be disabled?
  48834. */
  48835. disableAutoAttach: boolean;
  48836. /**
  48837. * Attach the feature to the session
  48838. * Will usually be called by the features manager
  48839. *
  48840. * @param force should attachment be forced (even when already attached)
  48841. * @returns true if successful.
  48842. */
  48843. attach(force?: boolean): boolean;
  48844. /**
  48845. * Detach the feature from the session
  48846. * Will usually be called by the features manager
  48847. *
  48848. * @returns true if successful.
  48849. */
  48850. detach(): boolean;
  48851. /**
  48852. * This function will be executed during before enabling the feature and can be used to not-allow enabling it.
  48853. * Note that at this point the session has NOT started, so this is purely checking if the browser supports it
  48854. *
  48855. * @returns whether or not the feature is compatible in this environment
  48856. */
  48857. isCompatible(): boolean;
  48858. /**
  48859. * The name of the native xr feature name, if applicable (like anchor, hit-test, or hand-tracking)
  48860. */
  48861. xrNativeFeatureName?: string;
  48862. }
  48863. /**
  48864. * A list of the currently available features without referencing them
  48865. */
  48866. export class WebXRFeatureName {
  48867. /**
  48868. * The name of the anchor system feature
  48869. */
  48870. static readonly ANCHOR_SYSTEM: string;
  48871. /**
  48872. * The name of the background remover feature
  48873. */
  48874. static readonly BACKGROUND_REMOVER: string;
  48875. /**
  48876. * The name of the hit test feature
  48877. */
  48878. static readonly HIT_TEST: string;
  48879. /**
  48880. * physics impostors for xr controllers feature
  48881. */
  48882. static readonly PHYSICS_CONTROLLERS: string;
  48883. /**
  48884. * The name of the plane detection feature
  48885. */
  48886. static readonly PLANE_DETECTION: string;
  48887. /**
  48888. * The name of the pointer selection feature
  48889. */
  48890. static readonly POINTER_SELECTION: string;
  48891. /**
  48892. * The name of the teleportation feature
  48893. */
  48894. static readonly TELEPORTATION: string;
  48895. /**
  48896. * The name of the feature points feature.
  48897. */
  48898. static readonly FEATURE_POINTS: string;
  48899. }
  48900. /**
  48901. * Defining the constructor of a feature. Used to register the modules.
  48902. */
  48903. export type WebXRFeatureConstructor = (xrSessionManager: WebXRSessionManager, options?: any) => () => IWebXRFeature;
  48904. /**
  48905. * The WebXR features manager is responsible of enabling or disabling features required for the current XR session.
  48906. * It is mainly used in AR sessions.
  48907. *
  48908. * A feature can have a version that is defined by Babylon (and does not correspond with the webxr version).
  48909. */
  48910. export class WebXRFeaturesManager implements IDisposable {
  48911. private _xrSessionManager;
  48912. private static readonly _AvailableFeatures;
  48913. private _features;
  48914. /**
  48915. * constructs a new features manages.
  48916. *
  48917. * @param _xrSessionManager an instance of WebXRSessionManager
  48918. */
  48919. constructor(_xrSessionManager: WebXRSessionManager);
  48920. /**
  48921. * Used to register a module. After calling this function a developer can use this feature in the scene.
  48922. * Mainly used internally.
  48923. *
  48924. * @param featureName the name of the feature to register
  48925. * @param constructorFunction the function used to construct the module
  48926. * @param version the (babylon) version of the module
  48927. * @param stable is that a stable version of this module
  48928. */
  48929. static AddWebXRFeature(featureName: string, constructorFunction: WebXRFeatureConstructor, version?: number, stable?: boolean): void;
  48930. /**
  48931. * Returns a constructor of a specific feature.
  48932. *
  48933. * @param featureName the name of the feature to construct
  48934. * @param version the version of the feature to load
  48935. * @param xrSessionManager the xrSessionManager. Used to construct the module
  48936. * @param options optional options provided to the module.
  48937. * @returns a function that, when called, will return a new instance of this feature
  48938. */
  48939. static ConstructFeature(featureName: string, version: number | undefined, xrSessionManager: WebXRSessionManager, options?: any): () => IWebXRFeature;
  48940. /**
  48941. * Can be used to return the list of features currently registered
  48942. *
  48943. * @returns an Array of available features
  48944. */
  48945. static GetAvailableFeatures(): string[];
  48946. /**
  48947. * Gets the versions available for a specific feature
  48948. * @param featureName the name of the feature
  48949. * @returns an array with the available versions
  48950. */
  48951. static GetAvailableVersions(featureName: string): string[];
  48952. /**
  48953. * Return the latest unstable version of this feature
  48954. * @param featureName the name of the feature to search
  48955. * @returns the version number. if not found will return -1
  48956. */
  48957. static GetLatestVersionOfFeature(featureName: string): number;
  48958. /**
  48959. * Return the latest stable version of this feature
  48960. * @param featureName the name of the feature to search
  48961. * @returns the version number. if not found will return -1
  48962. */
  48963. static GetStableVersionOfFeature(featureName: string): number;
  48964. /**
  48965. * Attach a feature to the current session. Mainly used when session started to start the feature effect.
  48966. * Can be used during a session to start a feature
  48967. * @param featureName the name of feature to attach
  48968. */
  48969. attachFeature(featureName: string): void;
  48970. /**
  48971. * Can be used inside a session or when the session ends to detach a specific feature
  48972. * @param featureName the name of the feature to detach
  48973. */
  48974. detachFeature(featureName: string): void;
  48975. /**
  48976. * Used to disable an already-enabled feature
  48977. * The feature will be disposed and will be recreated once enabled.
  48978. * @param featureName the feature to disable
  48979. * @returns true if disable was successful
  48980. */
  48981. disableFeature(featureName: string | {
  48982. Name: string;
  48983. }): boolean;
  48984. /**
  48985. * dispose this features manager
  48986. */
  48987. dispose(): void;
  48988. /**
  48989. * 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.
  48990. * 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.
  48991. *
  48992. * @param featureName the name of the feature to load or the class of the feature
  48993. * @param version optional version to load. if not provided the latest version will be enabled
  48994. * @param moduleOptions options provided to the module. Ses the module documentation / constructor
  48995. * @param attachIfPossible if set to true (default) the feature will be automatically attached, if it is currently possible
  48996. * @param required is this feature required to the app. If set to true the session init will fail if the feature is not available.
  48997. * @returns a new constructed feature or throws an error if feature not found.
  48998. */
  48999. enableFeature(featureName: string | {
  49000. Name: string;
  49001. }, version?: number | string, moduleOptions?: any, attachIfPossible?: boolean, required?: boolean): IWebXRFeature;
  49002. /**
  49003. * get the implementation of an enabled feature.
  49004. * @param featureName the name of the feature to load
  49005. * @returns the feature class, if found
  49006. */
  49007. getEnabledFeature(featureName: string): IWebXRFeature;
  49008. /**
  49009. * Get the list of enabled features
  49010. * @returns an array of enabled features
  49011. */
  49012. getEnabledFeatures(): string[];
  49013. /**
  49014. * This function will exten the session creation configuration object with enabled features.
  49015. * If, for example, the anchors feature is enabled, it will be automatically added to the optional or required features list,
  49016. * according to the defined "required" variable, provided during enableFeature call
  49017. * @param xrSessionInit the xr Session init object to extend
  49018. *
  49019. * @returns an extended XRSessionInit object
  49020. */
  49021. extendXRSessionInitObject(xrSessionInit: XRSessionInit): XRSessionInit;
  49022. }
  49023. }
  49024. declare module "babylonjs/XR/webXRExperienceHelper" {
  49025. import { Observable } from "babylonjs/Misc/observable";
  49026. import { IDisposable, Scene } from "babylonjs/scene";
  49027. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  49028. import { WebXRCamera } from "babylonjs/XR/webXRCamera";
  49029. import { WebXRState, WebXRRenderTarget } from "babylonjs/XR/webXRTypes";
  49030. import { WebXRFeaturesManager } from "babylonjs/XR/webXRFeaturesManager";
  49031. /**
  49032. * Base set of functionality needed to create an XR experience (WebXRSessionManager, Camera, StateManagement, etc.)
  49033. * @see https://doc.babylonjs.com/how_to/webxr_experience_helpers
  49034. */
  49035. export class WebXRExperienceHelper implements IDisposable {
  49036. private scene;
  49037. private _nonVRCamera;
  49038. private _originalSceneAutoClear;
  49039. private _supported;
  49040. /**
  49041. * Camera used to render xr content
  49042. */
  49043. camera: WebXRCamera;
  49044. /** A features manager for this xr session */
  49045. featuresManager: WebXRFeaturesManager;
  49046. /**
  49047. * Observers registered here will be triggered after the camera's initial transformation is set
  49048. * This can be used to set a different ground level or an extra rotation.
  49049. *
  49050. * Note that ground level is considered to be at 0. The height defined by the XR camera will be added
  49051. * to the position set after this observable is done executing.
  49052. */
  49053. onInitialXRPoseSetObservable: Observable<WebXRCamera>;
  49054. /**
  49055. * Fires when the state of the experience helper has changed
  49056. */
  49057. onStateChangedObservable: Observable<WebXRState>;
  49058. /** Session manager used to keep track of xr session */
  49059. sessionManager: WebXRSessionManager;
  49060. /**
  49061. * The current state of the XR experience (eg. transitioning, in XR or not in XR)
  49062. */
  49063. state: WebXRState;
  49064. /**
  49065. * Creates a WebXRExperienceHelper
  49066. * @param scene The scene the helper should be created in
  49067. */
  49068. private constructor();
  49069. /**
  49070. * Creates the experience helper
  49071. * @param scene the scene to attach the experience helper to
  49072. * @returns a promise for the experience helper
  49073. */
  49074. static CreateAsync(scene: Scene): Promise<WebXRExperienceHelper>;
  49075. /**
  49076. * Disposes of the experience helper
  49077. */
  49078. dispose(): void;
  49079. /**
  49080. * Enters XR mode (This must be done within a user interaction in most browsers eg. button click)
  49081. * @param sessionMode options for the XR session
  49082. * @param referenceSpaceType frame of reference of the XR session
  49083. * @param renderTarget the output canvas that will be used to enter XR mode
  49084. * @param sessionCreationOptions optional XRSessionInit object to init the session with
  49085. * @returns promise that resolves after xr mode has entered
  49086. */
  49087. enterXRAsync(sessionMode: XRSessionMode, referenceSpaceType: XRReferenceSpaceType, renderTarget?: WebXRRenderTarget, sessionCreationOptions?: XRSessionInit): Promise<WebXRSessionManager>;
  49088. /**
  49089. * Exits XR mode and returns the scene to its original state
  49090. * @returns promise that resolves after xr mode has exited
  49091. */
  49092. exitXRAsync(): Promise<void>;
  49093. private _nonXRToXRCamera;
  49094. private _setState;
  49095. }
  49096. }
  49097. declare module "babylonjs/XR/motionController/webXRControllerComponent" {
  49098. import { IMinimalMotionControllerObject, MotionControllerComponentType } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  49099. import { Observable } from "babylonjs/Misc/observable";
  49100. import { IDisposable } from "babylonjs/scene";
  49101. /**
  49102. * X-Y values for axes in WebXR
  49103. */
  49104. export interface IWebXRMotionControllerAxesValue {
  49105. /**
  49106. * The value of the x axis
  49107. */
  49108. x: number;
  49109. /**
  49110. * The value of the y-axis
  49111. */
  49112. y: number;
  49113. }
  49114. /**
  49115. * changed / previous values for the values of this component
  49116. */
  49117. export interface IWebXRMotionControllerComponentChangesValues<T> {
  49118. /**
  49119. * current (this frame) value
  49120. */
  49121. current: T;
  49122. /**
  49123. * previous (last change) value
  49124. */
  49125. previous: T;
  49126. }
  49127. /**
  49128. * Represents changes in the component between current frame and last values recorded
  49129. */
  49130. export interface IWebXRMotionControllerComponentChanges {
  49131. /**
  49132. * will be populated with previous and current values if axes changed
  49133. */
  49134. axes?: IWebXRMotionControllerComponentChangesValues<IWebXRMotionControllerAxesValue>;
  49135. /**
  49136. * will be populated with previous and current values if pressed changed
  49137. */
  49138. pressed?: IWebXRMotionControllerComponentChangesValues<boolean>;
  49139. /**
  49140. * will be populated with previous and current values if touched changed
  49141. */
  49142. touched?: IWebXRMotionControllerComponentChangesValues<boolean>;
  49143. /**
  49144. * will be populated with previous and current values if value changed
  49145. */
  49146. value?: IWebXRMotionControllerComponentChangesValues<number>;
  49147. }
  49148. /**
  49149. * This class represents a single component (for example button or thumbstick) of a motion controller
  49150. */
  49151. export class WebXRControllerComponent implements IDisposable {
  49152. /**
  49153. * the id of this component
  49154. */
  49155. id: string;
  49156. /**
  49157. * the type of the component
  49158. */
  49159. type: MotionControllerComponentType;
  49160. private _buttonIndex;
  49161. private _axesIndices;
  49162. private _axes;
  49163. private _changes;
  49164. private _currentValue;
  49165. private _hasChanges;
  49166. private _pressed;
  49167. private _touched;
  49168. /**
  49169. * button component type
  49170. */
  49171. static BUTTON_TYPE: MotionControllerComponentType;
  49172. /**
  49173. * squeeze component type
  49174. */
  49175. static SQUEEZE_TYPE: MotionControllerComponentType;
  49176. /**
  49177. * Thumbstick component type
  49178. */
  49179. static THUMBSTICK_TYPE: MotionControllerComponentType;
  49180. /**
  49181. * Touchpad component type
  49182. */
  49183. static TOUCHPAD_TYPE: MotionControllerComponentType;
  49184. /**
  49185. * trigger component type
  49186. */
  49187. static TRIGGER_TYPE: MotionControllerComponentType;
  49188. /**
  49189. * If axes are available for this component (like a touchpad or thumbstick) the observers will be notified when
  49190. * the axes data changes
  49191. */
  49192. onAxisValueChangedObservable: Observable<{
  49193. x: number;
  49194. y: number;
  49195. }>;
  49196. /**
  49197. * Observers registered here will be triggered when the state of a button changes
  49198. * State change is either pressed / touched / value
  49199. */
  49200. onButtonStateChangedObservable: Observable<WebXRControllerComponent>;
  49201. /**
  49202. * Creates a new component for a motion controller.
  49203. * It is created by the motion controller itself
  49204. *
  49205. * @param id the id of this component
  49206. * @param type the type of the component
  49207. * @param _buttonIndex index in the buttons array of the gamepad
  49208. * @param _axesIndices indices of the values in the axes array of the gamepad
  49209. */
  49210. constructor(
  49211. /**
  49212. * the id of this component
  49213. */
  49214. id: string,
  49215. /**
  49216. * the type of the component
  49217. */
  49218. type: MotionControllerComponentType, _buttonIndex?: number, _axesIndices?: number[]);
  49219. /**
  49220. * The current axes data. If this component has no axes it will still return an object { x: 0, y: 0 }
  49221. */
  49222. get axes(): IWebXRMotionControllerAxesValue;
  49223. /**
  49224. * Get the changes. Elements will be populated only if they changed with their previous and current value
  49225. */
  49226. get changes(): IWebXRMotionControllerComponentChanges;
  49227. /**
  49228. * Return whether or not the component changed the last frame
  49229. */
  49230. get hasChanges(): boolean;
  49231. /**
  49232. * is the button currently pressed
  49233. */
  49234. get pressed(): boolean;
  49235. /**
  49236. * is the button currently touched
  49237. */
  49238. get touched(): boolean;
  49239. /**
  49240. * Get the current value of this component
  49241. */
  49242. get value(): number;
  49243. /**
  49244. * Dispose this component
  49245. */
  49246. dispose(): void;
  49247. /**
  49248. * Are there axes correlating to this component
  49249. * @return true is axes data is available
  49250. */
  49251. isAxes(): boolean;
  49252. /**
  49253. * Is this component a button (hence - pressable)
  49254. * @returns true if can be pressed
  49255. */
  49256. isButton(): boolean;
  49257. /**
  49258. * update this component using the gamepad object it is in. Called on every frame
  49259. * @param nativeController the native gamepad controller object
  49260. */
  49261. update(nativeController: IMinimalMotionControllerObject): void;
  49262. }
  49263. }
  49264. declare module "babylonjs/Loading/sceneLoader" {
  49265. import { Observable } from "babylonjs/Misc/observable";
  49266. import { Nullable } from "babylonjs/types";
  49267. import { Scene } from "babylonjs/scene";
  49268. import { Engine } from "babylonjs/Engines/engine";
  49269. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  49270. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  49271. import { AssetContainer } from "babylonjs/assetContainer";
  49272. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  49273. import { Skeleton } from "babylonjs/Bones/skeleton";
  49274. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  49275. import { WebRequest } from "babylonjs/Misc/webRequest";
  49276. /**
  49277. * Interface used to represent data loading progression
  49278. */
  49279. export interface ISceneLoaderProgressEvent {
  49280. /**
  49281. * Defines if data length to load can be evaluated
  49282. */
  49283. readonly lengthComputable: boolean;
  49284. /**
  49285. * Defines the loaded data length
  49286. */
  49287. readonly loaded: number;
  49288. /**
  49289. * Defines the data length to load
  49290. */
  49291. readonly total: number;
  49292. }
  49293. /**
  49294. * Interface used by SceneLoader plugins to define supported file extensions
  49295. */
  49296. export interface ISceneLoaderPluginExtensions {
  49297. /**
  49298. * Defines the list of supported extensions
  49299. */
  49300. [extension: string]: {
  49301. isBinary: boolean;
  49302. };
  49303. }
  49304. /**
  49305. * Interface used by SceneLoader plugin factory
  49306. */
  49307. export interface ISceneLoaderPluginFactory {
  49308. /**
  49309. * Defines the name of the factory
  49310. */
  49311. name: string;
  49312. /**
  49313. * Function called to create a new plugin
  49314. * @return the new plugin
  49315. */
  49316. createPlugin(): ISceneLoaderPlugin | ISceneLoaderPluginAsync;
  49317. /**
  49318. * The callback that returns true if the data can be directly loaded.
  49319. * @param data string containing the file data
  49320. * @returns if the data can be loaded directly
  49321. */
  49322. canDirectLoad?(data: string): boolean;
  49323. }
  49324. /**
  49325. * Interface used to define the base of ISceneLoaderPlugin and ISceneLoaderPluginAsync
  49326. */
  49327. export interface ISceneLoaderPluginBase {
  49328. /**
  49329. * The friendly name of this plugin.
  49330. */
  49331. name: string;
  49332. /**
  49333. * The file extensions supported by this plugin.
  49334. */
  49335. extensions: string | ISceneLoaderPluginExtensions;
  49336. /**
  49337. * The callback called when loading from a url.
  49338. * @param scene scene loading this url
  49339. * @param url url to load
  49340. * @param onSuccess callback called when the file successfully loads
  49341. * @param onProgress callback called while file is loading (if the server supports this mode)
  49342. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  49343. * @param onError callback called when the file fails to load
  49344. * @returns a file request object
  49345. */
  49346. requestFile?(scene: Scene, url: string, onSuccess: (data: any, request?: WebRequest) => void, onProgress?: (ev: ISceneLoaderProgressEvent) => void, useArrayBuffer?: boolean, onError?: (error: any) => void): IFileRequest;
  49347. /**
  49348. * The callback called when loading from a file object.
  49349. * @param scene scene loading this file
  49350. * @param file defines the file to load
  49351. * @param onSuccess defines the callback to call when data is loaded
  49352. * @param onProgress defines the callback to call during loading process
  49353. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  49354. * @param onError defines the callback to call when an error occurs
  49355. * @returns a file request object
  49356. */
  49357. readFile?(scene: Scene, file: File, onSuccess: (data: any) => void, onProgress?: (ev: ISceneLoaderProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: any) => void): IFileRequest;
  49358. /**
  49359. * The callback that returns true if the data can be directly loaded.
  49360. * @param data string containing the file data
  49361. * @returns if the data can be loaded directly
  49362. */
  49363. canDirectLoad?(data: string): boolean;
  49364. /**
  49365. * The callback that returns the data to pass to the plugin if the data can be directly loaded.
  49366. * @param scene scene loading this data
  49367. * @param data string containing the data
  49368. * @returns data to pass to the plugin
  49369. */
  49370. directLoad?(scene: Scene, data: string): any;
  49371. /**
  49372. * The callback that allows custom handling of the root url based on the response url.
  49373. * @param rootUrl the original root url
  49374. * @param responseURL the response url if available
  49375. * @returns the new root url
  49376. */
  49377. rewriteRootURL?(rootUrl: string, responseURL?: string): string;
  49378. }
  49379. /**
  49380. * Interface used to define a SceneLoader plugin
  49381. */
  49382. export interface ISceneLoaderPlugin extends ISceneLoaderPluginBase {
  49383. /**
  49384. * Import meshes into a scene.
  49385. * @param meshesNames An array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  49386. * @param scene The scene to import into
  49387. * @param data The data to import
  49388. * @param rootUrl The root url for scene and resources
  49389. * @param meshes The meshes array to import into
  49390. * @param particleSystems The particle systems array to import into
  49391. * @param skeletons The skeletons array to import into
  49392. * @param onError The callback when import fails
  49393. * @returns True if successful or false otherwise
  49394. */
  49395. importMesh(meshesNames: any, scene: Scene, data: any, rootUrl: string, meshes: AbstractMesh[], particleSystems: IParticleSystem[], skeletons: Skeleton[], onError?: (message: string, exception?: any) => void): boolean;
  49396. /**
  49397. * Load into a scene.
  49398. * @param scene The scene to load into
  49399. * @param data The data to import
  49400. * @param rootUrl The root url for scene and resources
  49401. * @param onError The callback when import fails
  49402. * @returns True if successful or false otherwise
  49403. */
  49404. load(scene: Scene, data: any, rootUrl: string, onError?: (message: string, exception?: any) => void): boolean;
  49405. /**
  49406. * Load into an asset container.
  49407. * @param scene The scene to load into
  49408. * @param data The data to import
  49409. * @param rootUrl The root url for scene and resources
  49410. * @param onError The callback when import fails
  49411. * @returns The loaded asset container
  49412. */
  49413. loadAssetContainer(scene: Scene, data: any, rootUrl: string, onError?: (message: string, exception?: any) => void): AssetContainer;
  49414. }
  49415. /**
  49416. * Interface used to define an async SceneLoader plugin
  49417. */
  49418. export interface ISceneLoaderPluginAsync extends ISceneLoaderPluginBase {
  49419. /**
  49420. * Import meshes into a scene.
  49421. * @param meshesNames An array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  49422. * @param scene The scene to import into
  49423. * @param data The data to import
  49424. * @param rootUrl The root url for scene and resources
  49425. * @param onProgress The callback when the load progresses
  49426. * @param fileName Defines the name of the file to load
  49427. * @returns The loaded meshes, particle systems, skeletons, and animation groups
  49428. */
  49429. importMeshAsync(meshesNames: any, scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<{
  49430. meshes: AbstractMesh[];
  49431. particleSystems: IParticleSystem[];
  49432. skeletons: Skeleton[];
  49433. animationGroups: AnimationGroup[];
  49434. }>;
  49435. /**
  49436. * Load into a scene.
  49437. * @param scene The scene to load into
  49438. * @param data The data to import
  49439. * @param rootUrl The root url for scene and resources
  49440. * @param onProgress The callback when the load progresses
  49441. * @param fileName Defines the name of the file to load
  49442. * @returns Nothing
  49443. */
  49444. loadAsync(scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<void>;
  49445. /**
  49446. * Load into an asset container.
  49447. * @param scene The scene to load into
  49448. * @param data The data to import
  49449. * @param rootUrl The root url for scene and resources
  49450. * @param onProgress The callback when the load progresses
  49451. * @param fileName Defines the name of the file to load
  49452. * @returns The loaded asset container
  49453. */
  49454. loadAssetContainerAsync(scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<AssetContainer>;
  49455. }
  49456. /**
  49457. * Mode that determines how to handle old animation groups before loading new ones.
  49458. */
  49459. export enum SceneLoaderAnimationGroupLoadingMode {
  49460. /**
  49461. * Reset all old animations to initial state then dispose them.
  49462. */
  49463. Clean = 0,
  49464. /**
  49465. * Stop all old animations.
  49466. */
  49467. Stop = 1,
  49468. /**
  49469. * Restart old animations from first frame.
  49470. */
  49471. Sync = 2,
  49472. /**
  49473. * Old animations remains untouched.
  49474. */
  49475. NoSync = 3
  49476. }
  49477. /**
  49478. * Defines a plugin registered by the SceneLoader
  49479. */
  49480. interface IRegisteredPlugin {
  49481. /**
  49482. * Defines the plugin to use
  49483. */
  49484. plugin: ISceneLoaderPlugin | ISceneLoaderPluginAsync | ISceneLoaderPluginFactory;
  49485. /**
  49486. * Defines if the plugin supports binary data
  49487. */
  49488. isBinary: boolean;
  49489. }
  49490. /**
  49491. * Class used to load scene from various file formats using registered plugins
  49492. * @see https://doc.babylonjs.com/how_to/load_from_any_file_type
  49493. */
  49494. export class SceneLoader {
  49495. /**
  49496. * No logging while loading
  49497. */
  49498. static readonly NO_LOGGING: number;
  49499. /**
  49500. * Minimal logging while loading
  49501. */
  49502. static readonly MINIMAL_LOGGING: number;
  49503. /**
  49504. * Summary logging while loading
  49505. */
  49506. static readonly SUMMARY_LOGGING: number;
  49507. /**
  49508. * Detailled logging while loading
  49509. */
  49510. static readonly DETAILED_LOGGING: number;
  49511. /**
  49512. * Gets or sets a boolean indicating if entire scene must be loaded even if scene contains incremental data
  49513. */
  49514. static get ForceFullSceneLoadingForIncremental(): boolean;
  49515. static set ForceFullSceneLoadingForIncremental(value: boolean);
  49516. /**
  49517. * Gets or sets a boolean indicating if loading screen must be displayed while loading a scene
  49518. */
  49519. static get ShowLoadingScreen(): boolean;
  49520. static set ShowLoadingScreen(value: boolean);
  49521. /**
  49522. * Defines the current logging level (while loading the scene)
  49523. * @ignorenaming
  49524. */
  49525. static get loggingLevel(): number;
  49526. static set loggingLevel(value: number);
  49527. /**
  49528. * Gets or set a boolean indicating if matrix weights must be cleaned upon loading
  49529. */
  49530. static get CleanBoneMatrixWeights(): boolean;
  49531. static set CleanBoneMatrixWeights(value: boolean);
  49532. /**
  49533. * Event raised when a plugin is used to load a scene
  49534. */
  49535. static OnPluginActivatedObservable: Observable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
  49536. private static _registeredPlugins;
  49537. private static _showingLoadingScreen;
  49538. /**
  49539. * Gets the default plugin (used to load Babylon files)
  49540. * @returns the .babylon plugin
  49541. */
  49542. static GetDefaultPlugin(): IRegisteredPlugin;
  49543. private static _GetPluginForExtension;
  49544. private static _GetPluginForDirectLoad;
  49545. private static _GetPluginForFilename;
  49546. private static _GetDirectLoad;
  49547. private static _LoadData;
  49548. private static _GetFileInfo;
  49549. /**
  49550. * Gets a plugin that can load the given extension
  49551. * @param extension defines the extension to load
  49552. * @returns a plugin or null if none works
  49553. */
  49554. static GetPluginForExtension(extension: string): ISceneLoaderPlugin | ISceneLoaderPluginAsync | ISceneLoaderPluginFactory;
  49555. /**
  49556. * Gets a boolean indicating that the given extension can be loaded
  49557. * @param extension defines the extension to load
  49558. * @returns true if the extension is supported
  49559. */
  49560. static IsPluginForExtensionAvailable(extension: string): boolean;
  49561. /**
  49562. * Adds a new plugin to the list of registered plugins
  49563. * @param plugin defines the plugin to add
  49564. */
  49565. static RegisterPlugin(plugin: ISceneLoaderPlugin | ISceneLoaderPluginAsync): void;
  49566. /**
  49567. * Import meshes into a scene
  49568. * @param meshNames an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  49569. * @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)
  49570. * @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)
  49571. * @param scene the instance of BABYLON.Scene to append to
  49572. * @param onSuccess a callback with a list of imported meshes, particleSystems, and skeletons when import succeeds
  49573. * @param onProgress a callback with a progress event for each file being loaded
  49574. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  49575. * @param pluginExtension the extension used to determine the plugin
  49576. * @returns The loaded plugin
  49577. */
  49578. 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>;
  49579. /**
  49580. * Import meshes into a scene
  49581. * @param meshNames an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  49582. * @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)
  49583. * @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)
  49584. * @param scene the instance of BABYLON.Scene to append to
  49585. * @param onProgress a callback with a progress event for each file being loaded
  49586. * @param pluginExtension the extension used to determine the plugin
  49587. * @returns The loaded list of imported meshes, particle systems, skeletons, and animation groups
  49588. */
  49589. static ImportMeshAsync(meshNames: any, rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<{
  49590. meshes: AbstractMesh[];
  49591. particleSystems: IParticleSystem[];
  49592. skeletons: Skeleton[];
  49593. animationGroups: AnimationGroup[];
  49594. }>;
  49595. /**
  49596. * Load a scene
  49597. * @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)
  49598. * @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)
  49599. * @param engine is the instance of BABYLON.Engine to use to create the scene
  49600. * @param onSuccess a callback with the scene when import succeeds
  49601. * @param onProgress a callback with a progress event for each file being loaded
  49602. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  49603. * @param pluginExtension the extension used to determine the plugin
  49604. * @returns The loaded plugin
  49605. */
  49606. 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>;
  49607. /**
  49608. * Load a scene
  49609. * @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)
  49610. * @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)
  49611. * @param engine is the instance of BABYLON.Engine to use to create the scene
  49612. * @param onProgress a callback with a progress event for each file being loaded
  49613. * @param pluginExtension the extension used to determine the plugin
  49614. * @returns The loaded scene
  49615. */
  49616. static LoadAsync(rootUrl: string, sceneFilename?: string | File, engine?: Nullable<Engine>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<Scene>;
  49617. /**
  49618. * Append a scene
  49619. * @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)
  49620. * @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)
  49621. * @param scene is the instance of BABYLON.Scene to append to
  49622. * @param onSuccess a callback with the scene when import succeeds
  49623. * @param onProgress a callback with a progress event for each file being loaded
  49624. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  49625. * @param pluginExtension the extension used to determine the plugin
  49626. * @returns The loaded plugin
  49627. */
  49628. 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>;
  49629. /**
  49630. * Append a scene
  49631. * @param rootUrl a string that defines the root url for the scene and resources or the concatenation of rootURL and filename (e.g. http://example.com/test.glb)
  49632. * @param sceneFilename a string that defines the name of the scene file or starts with "data:" following by the stringified version of the scene or a File object (default: empty string)
  49633. * @param scene is the instance of BABYLON.Scene to append to
  49634. * @param onProgress a callback with a progress event for each file being loaded
  49635. * @param pluginExtension the extension used to determine the plugin
  49636. * @returns The given scene
  49637. */
  49638. static AppendAsync(rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<Scene>;
  49639. /**
  49640. * Load a scene into an asset container
  49641. * @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)
  49642. * @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)
  49643. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  49644. * @param onSuccess a callback with the scene when import succeeds
  49645. * @param onProgress a callback with a progress event for each file being loaded
  49646. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  49647. * @param pluginExtension the extension used to determine the plugin
  49648. * @returns The loaded plugin
  49649. */
  49650. 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>;
  49651. /**
  49652. * Load a scene into an asset container
  49653. * @param rootUrl a string that defines the root url for the scene and resources or the concatenation of rootURL and filename (e.g. http://example.com/test.glb)
  49654. * @param sceneFilename a string that defines the name of the scene file or starts with "data:" following by the stringified version of the scene (default: empty string)
  49655. * @param scene is the instance of Scene to append to
  49656. * @param onProgress a callback with a progress event for each file being loaded
  49657. * @param pluginExtension the extension used to determine the plugin
  49658. * @returns The loaded asset container
  49659. */
  49660. static LoadAssetContainerAsync(rootUrl: string, sceneFilename?: string, scene?: Nullable<Scene>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<AssetContainer>;
  49661. /**
  49662. * Import animations from a file into a scene
  49663. * @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)
  49664. * @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)
  49665. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  49666. * @param overwriteAnimations when true, animations are cleaned before importing new ones. Animations are appended otherwise
  49667. * @param animationGroupLoadingMode defines how to handle old animations groups before importing new ones
  49668. * @param targetConverter defines a function used to convert animation targets from loaded scene to current scene (default: search node by name)
  49669. * @param onSuccess a callback with the scene when import succeeds
  49670. * @param onProgress a callback with a progress event for each file being loaded
  49671. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  49672. * @param pluginExtension the extension used to determine the plugin
  49673. */
  49674. 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;
  49675. /**
  49676. * Import animations from a file into a scene
  49677. * @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)
  49678. * @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)
  49679. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  49680. * @param overwriteAnimations when true, animations are cleaned before importing new ones. Animations are appended otherwise
  49681. * @param animationGroupLoadingMode defines how to handle old animations groups before importing new ones
  49682. * @param targetConverter defines a function used to convert animation targets from loaded scene to current scene (default: search node by name)
  49683. * @param onSuccess a callback with the scene when import succeeds
  49684. * @param onProgress a callback with a progress event for each file being loaded
  49685. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  49686. * @param pluginExtension the extension used to determine the plugin
  49687. * @returns the updated scene with imported animations
  49688. */
  49689. 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>;
  49690. }
  49691. }
  49692. declare module "babylonjs/XR/motionController/webXRAbstractMotionController" {
  49693. import { IDisposable, Scene } from "babylonjs/scene";
  49694. import { WebXRControllerComponent } from "babylonjs/XR/motionController/webXRControllerComponent";
  49695. import { Observable } from "babylonjs/Misc/observable";
  49696. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  49697. import { Nullable } from "babylonjs/types";
  49698. /**
  49699. * Handedness type in xrInput profiles. These can be used to define layouts in the Layout Map.
  49700. */
  49701. export type MotionControllerHandedness = "none" | "left" | "right";
  49702. /**
  49703. * The type of components available in motion controllers.
  49704. * This is not the name of the component.
  49705. */
  49706. export type MotionControllerComponentType = "trigger" | "squeeze" | "touchpad" | "thumbstick" | "button";
  49707. /**
  49708. * The state of a controller component
  49709. */
  49710. export type MotionControllerComponentStateType = "default" | "touched" | "pressed";
  49711. /**
  49712. * The schema of motion controller layout.
  49713. * No object will be initialized using this interface
  49714. * This is used just to define the profile.
  49715. */
  49716. export interface IMotionControllerLayout {
  49717. /**
  49718. * Path to load the assets. Usually relative to the base path
  49719. */
  49720. assetPath: string;
  49721. /**
  49722. * Available components (unsorted)
  49723. */
  49724. components: {
  49725. /**
  49726. * A map of component Ids
  49727. */
  49728. [componentId: string]: {
  49729. /**
  49730. * The type of input the component outputs
  49731. */
  49732. type: MotionControllerComponentType;
  49733. /**
  49734. * The indices of this component in the gamepad object
  49735. */
  49736. gamepadIndices: {
  49737. /**
  49738. * Index of button
  49739. */
  49740. button?: number;
  49741. /**
  49742. * If available, index of x-axis
  49743. */
  49744. xAxis?: number;
  49745. /**
  49746. * If available, index of y-axis
  49747. */
  49748. yAxis?: number;
  49749. };
  49750. /**
  49751. * The mesh's root node name
  49752. */
  49753. rootNodeName: string;
  49754. /**
  49755. * Animation definitions for this model
  49756. */
  49757. visualResponses: {
  49758. [stateKey: string]: {
  49759. /**
  49760. * What property will be animated
  49761. */
  49762. componentProperty: "xAxis" | "yAxis" | "button" | "state";
  49763. /**
  49764. * What states influence this visual response
  49765. */
  49766. states: MotionControllerComponentStateType[];
  49767. /**
  49768. * Type of animation - movement or visibility
  49769. */
  49770. valueNodeProperty: "transform" | "visibility";
  49771. /**
  49772. * Base node name to move. Its position will be calculated according to the min and max nodes
  49773. */
  49774. valueNodeName?: string;
  49775. /**
  49776. * Minimum movement node
  49777. */
  49778. minNodeName?: string;
  49779. /**
  49780. * Max movement node
  49781. */
  49782. maxNodeName?: string;
  49783. };
  49784. };
  49785. /**
  49786. * If touch enabled, what is the name of node to display user feedback
  49787. */
  49788. touchPointNodeName?: string;
  49789. };
  49790. };
  49791. /**
  49792. * Is it xr standard mapping or not
  49793. */
  49794. gamepadMapping: "" | "xr-standard";
  49795. /**
  49796. * Base root node of this entire model
  49797. */
  49798. rootNodeName: string;
  49799. /**
  49800. * Defines the main button component id
  49801. */
  49802. selectComponentId: string;
  49803. }
  49804. /**
  49805. * A definition for the layout map in the input profile
  49806. */
  49807. export interface IMotionControllerLayoutMap {
  49808. /**
  49809. * Layouts with handedness type as a key
  49810. */
  49811. [handedness: string]: IMotionControllerLayout;
  49812. }
  49813. /**
  49814. * The XR Input profile schema
  49815. * Profiles can be found here:
  49816. * https://github.com/immersive-web/webxr-input-profiles/tree/master/packages/registry/profiles
  49817. */
  49818. export interface IMotionControllerProfile {
  49819. /**
  49820. * fallback profiles for this profileId
  49821. */
  49822. fallbackProfileIds: string[];
  49823. /**
  49824. * The layout map, with handedness as key
  49825. */
  49826. layouts: IMotionControllerLayoutMap;
  49827. /**
  49828. * The id of this profile
  49829. * correlates to the profile(s) in the xrInput.profiles array
  49830. */
  49831. profileId: string;
  49832. }
  49833. /**
  49834. * A helper-interface for the 3 meshes needed for controller button animation
  49835. * The meshes are provided to the _lerpButtonTransform function to calculate the current position of the value mesh
  49836. */
  49837. export interface IMotionControllerButtonMeshMap {
  49838. /**
  49839. * the mesh that defines the pressed value mesh position.
  49840. * This is used to find the max-position of this button
  49841. */
  49842. pressedMesh: AbstractMesh;
  49843. /**
  49844. * the mesh that defines the unpressed value mesh position.
  49845. * This is used to find the min (or initial) position of this button
  49846. */
  49847. unpressedMesh: AbstractMesh;
  49848. /**
  49849. * The mesh that will be changed when value changes
  49850. */
  49851. valueMesh: AbstractMesh;
  49852. }
  49853. /**
  49854. * A helper-interface for the 3 meshes needed for controller axis animation.
  49855. * This will be expanded when touchpad animations are fully supported
  49856. * The meshes are provided to the _lerpAxisTransform function to calculate the current position of the value mesh
  49857. */
  49858. export interface IMotionControllerMeshMap {
  49859. /**
  49860. * the mesh that defines the maximum value mesh position.
  49861. */
  49862. maxMesh?: AbstractMesh;
  49863. /**
  49864. * the mesh that defines the minimum value mesh position.
  49865. */
  49866. minMesh?: AbstractMesh;
  49867. /**
  49868. * The mesh that will be changed when axis value changes
  49869. */
  49870. valueMesh: AbstractMesh;
  49871. }
  49872. /**
  49873. * The elements needed for change-detection of the gamepad objects in motion controllers
  49874. */
  49875. export interface IMinimalMotionControllerObject {
  49876. /**
  49877. * Available axes of this controller
  49878. */
  49879. axes: number[];
  49880. /**
  49881. * An array of available buttons
  49882. */
  49883. buttons: Array<{
  49884. /**
  49885. * Value of the button/trigger
  49886. */
  49887. value: number;
  49888. /**
  49889. * If the button/trigger is currently touched
  49890. */
  49891. touched: boolean;
  49892. /**
  49893. * If the button/trigger is currently pressed
  49894. */
  49895. pressed: boolean;
  49896. }>;
  49897. /**
  49898. * EXPERIMENTAL haptic support.
  49899. */
  49900. hapticActuators?: Array<{
  49901. pulse: (value: number, duration: number) => Promise<boolean>;
  49902. }>;
  49903. }
  49904. /**
  49905. * An Abstract Motion controller
  49906. * This class receives an xrInput and a profile layout and uses those to initialize the components
  49907. * Each component has an observable to check for changes in value and state
  49908. */
  49909. export abstract class WebXRAbstractMotionController implements IDisposable {
  49910. protected scene: Scene;
  49911. protected layout: IMotionControllerLayout;
  49912. /**
  49913. * The gamepad object correlating to this controller
  49914. */
  49915. gamepadObject: IMinimalMotionControllerObject;
  49916. /**
  49917. * handedness (left/right/none) of this controller
  49918. */
  49919. handedness: MotionControllerHandedness;
  49920. private _initComponent;
  49921. private _modelReady;
  49922. /**
  49923. * A map of components (WebXRControllerComponent) in this motion controller
  49924. * Components have a ComponentType and can also have both button and axis definitions
  49925. */
  49926. readonly components: {
  49927. [id: string]: WebXRControllerComponent;
  49928. };
  49929. /**
  49930. * Disable the model's animation. Can be set at any time.
  49931. */
  49932. disableAnimation: boolean;
  49933. /**
  49934. * Observers registered here will be triggered when the model of this controller is done loading
  49935. */
  49936. onModelLoadedObservable: Observable<WebXRAbstractMotionController>;
  49937. /**
  49938. * The profile id of this motion controller
  49939. */
  49940. abstract profileId: string;
  49941. /**
  49942. * The root mesh of the model. It is null if the model was not yet initialized
  49943. */
  49944. rootMesh: Nullable<AbstractMesh>;
  49945. /**
  49946. * constructs a new abstract motion controller
  49947. * @param scene the scene to which the model of the controller will be added
  49948. * @param layout The profile layout to load
  49949. * @param gamepadObject The gamepad object correlating to this controller
  49950. * @param handedness handedness (left/right/none) of this controller
  49951. * @param _doNotLoadControllerMesh set this flag to ignore the mesh loading
  49952. */
  49953. constructor(scene: Scene, layout: IMotionControllerLayout,
  49954. /**
  49955. * The gamepad object correlating to this controller
  49956. */
  49957. gamepadObject: IMinimalMotionControllerObject,
  49958. /**
  49959. * handedness (left/right/none) of this controller
  49960. */
  49961. handedness: MotionControllerHandedness, _doNotLoadControllerMesh?: boolean);
  49962. /**
  49963. * Dispose this controller, the model mesh and all its components
  49964. */
  49965. dispose(): void;
  49966. /**
  49967. * Returns all components of specific type
  49968. * @param type the type to search for
  49969. * @return an array of components with this type
  49970. */
  49971. getAllComponentsOfType(type: MotionControllerComponentType): WebXRControllerComponent[];
  49972. /**
  49973. * get a component based an its component id as defined in layout.components
  49974. * @param id the id of the component
  49975. * @returns the component correlates to the id or undefined if not found
  49976. */
  49977. getComponent(id: string): WebXRControllerComponent;
  49978. /**
  49979. * Get the list of components available in this motion controller
  49980. * @returns an array of strings correlating to available components
  49981. */
  49982. getComponentIds(): string[];
  49983. /**
  49984. * Get the first component of specific type
  49985. * @param type type of component to find
  49986. * @return a controller component or null if not found
  49987. */
  49988. getComponentOfType(type: MotionControllerComponentType): Nullable<WebXRControllerComponent>;
  49989. /**
  49990. * Get the main (Select) component of this controller as defined in the layout
  49991. * @returns the main component of this controller
  49992. */
  49993. getMainComponent(): WebXRControllerComponent;
  49994. /**
  49995. * Loads the model correlating to this controller
  49996. * When the mesh is loaded, the onModelLoadedObservable will be triggered
  49997. * @returns A promise fulfilled with the result of the model loading
  49998. */
  49999. loadModel(): Promise<boolean>;
  50000. /**
  50001. * Update this model using the current XRFrame
  50002. * @param xrFrame the current xr frame to use and update the model
  50003. */
  50004. updateFromXRFrame(xrFrame: XRFrame): void;
  50005. /**
  50006. * Backwards compatibility due to a deeply-integrated typo
  50007. */
  50008. get handness(): XREye;
  50009. /**
  50010. * Pulse (vibrate) this controller
  50011. * If the controller does not support pulses, this function will fail silently and return Promise<false> directly after called
  50012. * Consecutive calls to this function will cancel the last pulse call
  50013. *
  50014. * @param value the strength of the pulse in 0.0...1.0 range
  50015. * @param duration Duration of the pulse in milliseconds
  50016. * @param hapticActuatorIndex optional index of actuator (will usually be 0)
  50017. * @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
  50018. */
  50019. pulse(value: number, duration: number, hapticActuatorIndex?: number): Promise<boolean>;
  50020. protected _getChildByName(node: AbstractMesh, name: string): AbstractMesh;
  50021. protected _getImmediateChildByName(node: AbstractMesh, name: string): AbstractMesh;
  50022. /**
  50023. * Moves the axis on the controller mesh based on its current state
  50024. * @param axis the index of the axis
  50025. * @param axisValue the value of the axis which determines the meshes new position
  50026. * @hidden
  50027. */
  50028. protected _lerpTransform(axisMap: IMotionControllerMeshMap, axisValue: number, fixValueCoordinates?: boolean): void;
  50029. /**
  50030. * Update the model itself with the current frame data
  50031. * @param xrFrame the frame to use for updating the model mesh
  50032. */
  50033. protected updateModel(xrFrame: XRFrame): void;
  50034. /**
  50035. * Get the filename and path for this controller's model
  50036. * @returns a map of filename and path
  50037. */
  50038. protected abstract _getFilenameAndPath(): {
  50039. filename: string;
  50040. path: string;
  50041. };
  50042. /**
  50043. * This function is called before the mesh is loaded. It checks for loading constraints.
  50044. * For example, this function can check if the GLB loader is available
  50045. * If this function returns false, the generic controller will be loaded instead
  50046. * @returns Is the client ready to load the mesh
  50047. */
  50048. protected abstract _getModelLoadingConstraints(): boolean;
  50049. /**
  50050. * This function will be called after the model was successfully loaded and can be used
  50051. * for mesh transformations before it is available for the user
  50052. * @param meshes the loaded meshes
  50053. */
  50054. protected abstract _processLoadedModel(meshes: AbstractMesh[]): void;
  50055. /**
  50056. * Set the root mesh for this controller. Important for the WebXR controller class
  50057. * @param meshes the loaded meshes
  50058. */
  50059. protected abstract _setRootMesh(meshes: AbstractMesh[]): void;
  50060. /**
  50061. * A function executed each frame that updates the mesh (if needed)
  50062. * @param xrFrame the current xrFrame
  50063. */
  50064. protected abstract _updateModel(xrFrame: XRFrame): void;
  50065. private _getGenericFilenameAndPath;
  50066. private _getGenericParentMesh;
  50067. }
  50068. }
  50069. declare module "babylonjs/XR/motionController/webXRGenericMotionController" {
  50070. import { WebXRAbstractMotionController, IMinimalMotionControllerObject, MotionControllerHandedness } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  50071. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  50072. import { Scene } from "babylonjs/scene";
  50073. /**
  50074. * A generic trigger-only motion controller for WebXR
  50075. */
  50076. export class WebXRGenericTriggerMotionController extends WebXRAbstractMotionController {
  50077. /**
  50078. * Static version of the profile id of this controller
  50079. */
  50080. static ProfileId: string;
  50081. profileId: string;
  50082. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  50083. protected _getFilenameAndPath(): {
  50084. filename: string;
  50085. path: string;
  50086. };
  50087. protected _getModelLoadingConstraints(): boolean;
  50088. protected _processLoadedModel(meshes: AbstractMesh[]): void;
  50089. protected _setRootMesh(meshes: AbstractMesh[]): void;
  50090. protected _updateModel(): void;
  50091. }
  50092. }
  50093. declare module "babylonjs/Meshes/Builders/sphereBuilder" {
  50094. import { Vector4 } from "babylonjs/Maths/math.vector";
  50095. import { Mesh } from "babylonjs/Meshes/mesh";
  50096. import { Scene } from "babylonjs/scene";
  50097. import { Nullable } from "babylonjs/types";
  50098. /**
  50099. * Class containing static functions to help procedurally build meshes
  50100. */
  50101. export class SphereBuilder {
  50102. /**
  50103. * Creates a sphere mesh
  50104. * * The parameter `diameter` sets the diameter size (float) of the sphere (default 1)
  50105. * * 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`)
  50106. * * The parameter `segments` sets the sphere number of horizontal stripes (positive integer, default 32)
  50107. * * 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
  50108. * * 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)
  50109. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  50110. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  50111. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  50112. * @param name defines the name of the mesh
  50113. * @param options defines the options used to create the mesh
  50114. * @param scene defines the hosting scene
  50115. * @returns the sphere mesh
  50116. * @see https://doc.babylonjs.com/how_to/set_shapes#sphere
  50117. */
  50118. static CreateSphere(name: string, options: {
  50119. segments?: number;
  50120. diameter?: number;
  50121. diameterX?: number;
  50122. diameterY?: number;
  50123. diameterZ?: number;
  50124. arc?: number;
  50125. slice?: number;
  50126. sideOrientation?: number;
  50127. frontUVs?: Vector4;
  50128. backUVs?: Vector4;
  50129. updatable?: boolean;
  50130. }, scene?: Nullable<Scene>): Mesh;
  50131. }
  50132. }
  50133. declare module "babylonjs/XR/motionController/webXRProfiledMotionController" {
  50134. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  50135. import { WebXRAbstractMotionController, IMotionControllerProfile } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  50136. import { Scene } from "babylonjs/scene";
  50137. /**
  50138. * A profiled motion controller has its profile loaded from an online repository.
  50139. * The class is responsible of loading the model, mapping the keys and enabling model-animations
  50140. */
  50141. export class WebXRProfiledMotionController extends WebXRAbstractMotionController {
  50142. private _repositoryUrl;
  50143. private _buttonMeshMapping;
  50144. private _touchDots;
  50145. /**
  50146. * The profile ID of this controller. Will be populated when the controller initializes.
  50147. */
  50148. profileId: string;
  50149. constructor(scene: Scene, xrInput: XRInputSource, _profile: IMotionControllerProfile, _repositoryUrl: string);
  50150. dispose(): void;
  50151. protected _getFilenameAndPath(): {
  50152. filename: string;
  50153. path: string;
  50154. };
  50155. protected _getModelLoadingConstraints(): boolean;
  50156. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  50157. protected _setRootMesh(meshes: AbstractMesh[]): void;
  50158. protected _updateModel(_xrFrame: XRFrame): void;
  50159. }
  50160. }
  50161. declare module "babylonjs/XR/motionController/webXRMotionControllerManager" {
  50162. import { WebXRAbstractMotionController } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  50163. import { Scene } from "babylonjs/scene";
  50164. /**
  50165. * A construction function type to create a new controller based on an xrInput object
  50166. */
  50167. export type MotionControllerConstructor = (xrInput: XRInputSource, scene: Scene) => WebXRAbstractMotionController;
  50168. /**
  50169. * The MotionController Manager manages all registered motion controllers and loads the right one when needed.
  50170. *
  50171. * When this repository is complete: https://github.com/immersive-web/webxr-input-profiles/tree/master/packages/assets
  50172. * it should be replaced with auto-loaded controllers.
  50173. *
  50174. * When using a model try to stay as generic as possible. Eventually there will be no need in any of the controller classes
  50175. */
  50176. export class WebXRMotionControllerManager {
  50177. private static _AvailableControllers;
  50178. private static _Fallbacks;
  50179. private static _ProfileLoadingPromises;
  50180. private static _ProfilesList;
  50181. /**
  50182. * The base URL of the online controller repository. Can be changed at any time.
  50183. */
  50184. static BaseRepositoryUrl: string;
  50185. /**
  50186. * Which repository gets priority - local or online
  50187. */
  50188. static PrioritizeOnlineRepository: boolean;
  50189. /**
  50190. * Use the online repository, or use only locally-defined controllers
  50191. */
  50192. static UseOnlineRepository: boolean;
  50193. /**
  50194. * Clear the cache used for profile loading and reload when requested again
  50195. */
  50196. static ClearProfilesCache(): void;
  50197. /**
  50198. * Register the default fallbacks.
  50199. * This function is called automatically when this file is imported.
  50200. */
  50201. static DefaultFallbacks(): void;
  50202. /**
  50203. * Find a fallback profile if the profile was not found. There are a few predefined generic profiles.
  50204. * @param profileId the profile to which a fallback needs to be found
  50205. * @return an array with corresponding fallback profiles
  50206. */
  50207. static FindFallbackWithProfileId(profileId: string): string[];
  50208. /**
  50209. * When acquiring a new xrInput object (usually by the WebXRInput class), match it with the correct profile.
  50210. * The order of search:
  50211. *
  50212. * 1) Iterate the profiles array of the xr input and try finding a corresponding motion controller
  50213. * 2) (If not found) search in the gamepad id and try using it (legacy versions only)
  50214. * 3) search for registered fallbacks (should be redundant, nonetheless it makes sense to check)
  50215. * 4) return the generic trigger controller if none were found
  50216. *
  50217. * @param xrInput the xrInput to which a new controller is initialized
  50218. * @param scene the scene to which the model will be added
  50219. * @param forceProfile force a certain profile for this controller
  50220. * @return A promise that fulfils with the motion controller class for this profile id or the generic standard class if none was found
  50221. */
  50222. static GetMotionControllerWithXRInput(xrInput: XRInputSource, scene: Scene, forceProfile?: string): Promise<WebXRAbstractMotionController>;
  50223. /**
  50224. * Register a new controller based on its profile. This function will be called by the controller classes themselves.
  50225. *
  50226. * If you are missing a profile, make sure it is imported in your source, otherwise it will not register.
  50227. *
  50228. * @param type the profile type to register
  50229. * @param constructFunction the function to be called when loading this profile
  50230. */
  50231. static RegisterController(type: string, constructFunction: MotionControllerConstructor): void;
  50232. /**
  50233. * Register a fallback to a specific profile.
  50234. * @param profileId the profileId that will receive the fallbacks
  50235. * @param fallbacks A list of fallback profiles
  50236. */
  50237. static RegisterFallbacksForProfileId(profileId: string, fallbacks: string[]): void;
  50238. /**
  50239. * Will update the list of profiles available in the repository
  50240. * @return a promise that resolves to a map of profiles available online
  50241. */
  50242. static UpdateProfilesList(): Promise<{
  50243. [profile: string]: string;
  50244. }>;
  50245. private static _LoadProfileFromRepository;
  50246. private static _LoadProfilesFromAvailableControllers;
  50247. }
  50248. }
  50249. declare module "babylonjs/XR/webXRInputSource" {
  50250. import { Observable } from "babylonjs/Misc/observable";
  50251. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  50252. import { Ray } from "babylonjs/Culling/ray";
  50253. import { Scene } from "babylonjs/scene";
  50254. import { WebXRAbstractMotionController } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  50255. /**
  50256. * Configuration options for the WebXR controller creation
  50257. */
  50258. export interface IWebXRControllerOptions {
  50259. /**
  50260. * Should the controller mesh be animated when a user interacts with it
  50261. * The pressed buttons / thumbstick and touchpad animations will be disabled
  50262. */
  50263. disableMotionControllerAnimation?: boolean;
  50264. /**
  50265. * Do not load the controller mesh, in case a different mesh needs to be loaded.
  50266. */
  50267. doNotLoadControllerMesh?: boolean;
  50268. /**
  50269. * Force a specific controller type for this controller.
  50270. * This can be used when creating your own profile or when testing different controllers
  50271. */
  50272. forceControllerProfile?: string;
  50273. /**
  50274. * Defines a rendering group ID for meshes that will be loaded.
  50275. * This is for the default controllers only.
  50276. */
  50277. renderingGroupId?: number;
  50278. }
  50279. /**
  50280. * Represents an XR controller
  50281. */
  50282. export class WebXRInputSource {
  50283. private _scene;
  50284. /** The underlying input source for the controller */
  50285. inputSource: XRInputSource;
  50286. private _options;
  50287. private _tmpVector;
  50288. private _uniqueId;
  50289. /**
  50290. * 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
  50291. */
  50292. grip?: AbstractMesh;
  50293. /**
  50294. * If available, this is the gamepad object related to this controller.
  50295. * Using this object it is possible to get click events and trackpad changes of the
  50296. * webxr controller that is currently being used.
  50297. */
  50298. motionController?: WebXRAbstractMotionController;
  50299. /**
  50300. * Event that fires when the controller is removed/disposed.
  50301. * The object provided as event data is this controller, after associated assets were disposed.
  50302. * uniqueId is still available.
  50303. */
  50304. onDisposeObservable: Observable<WebXRInputSource>;
  50305. /**
  50306. * Will be triggered when the mesh associated with the motion controller is done loading.
  50307. * It is also possible that this will never trigger (!) if no mesh was loaded, or if the developer decides to load a different mesh
  50308. * A shortened version of controller -> motion controller -> on mesh loaded.
  50309. */
  50310. onMeshLoadedObservable: Observable<AbstractMesh>;
  50311. /**
  50312. * Observers registered here will trigger when a motion controller profile was assigned to this xr controller
  50313. */
  50314. onMotionControllerInitObservable: Observable<WebXRAbstractMotionController>;
  50315. /**
  50316. * Pointer which can be used to select objects or attach a visible laser to
  50317. */
  50318. pointer: AbstractMesh;
  50319. /**
  50320. * Creates the input source object
  50321. * @see https://doc.babylonjs.com/how_to/webxr_controllers_support
  50322. * @param _scene the scene which the controller should be associated to
  50323. * @param inputSource the underlying input source for the controller
  50324. * @param _options options for this controller creation
  50325. */
  50326. constructor(_scene: Scene,
  50327. /** The underlying input source for the controller */
  50328. inputSource: XRInputSource, _options?: IWebXRControllerOptions);
  50329. /**
  50330. * Get this controllers unique id
  50331. */
  50332. get uniqueId(): string;
  50333. /**
  50334. * Disposes of the object
  50335. */
  50336. dispose(): void;
  50337. /**
  50338. * Gets a world space ray coming from the pointer or grip
  50339. * @param result the resulting ray
  50340. * @param gripIfAvailable use the grip mesh instead of the pointer, if available
  50341. */
  50342. getWorldPointerRayToRef(result: Ray, gripIfAvailable?: boolean): void;
  50343. /**
  50344. * Updates the controller pose based on the given XRFrame
  50345. * @param xrFrame xr frame to update the pose with
  50346. * @param referenceSpace reference space to use
  50347. */
  50348. updateFromXRFrame(xrFrame: XRFrame, referenceSpace: XRReferenceSpace): void;
  50349. }
  50350. }
  50351. declare module "babylonjs/XR/webXRInput" {
  50352. import { Observable } from "babylonjs/Misc/observable";
  50353. import { IDisposable } from "babylonjs/scene";
  50354. import { WebXRInputSource, IWebXRControllerOptions } from "babylonjs/XR/webXRInputSource";
  50355. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  50356. import { WebXRCamera } from "babylonjs/XR/webXRCamera";
  50357. /**
  50358. * The schema for initialization options of the XR Input class
  50359. */
  50360. export interface IWebXRInputOptions {
  50361. /**
  50362. * If set to true no model will be automatically loaded
  50363. */
  50364. doNotLoadControllerMeshes?: boolean;
  50365. /**
  50366. * If set, this profile will be used for all controllers loaded (for example "microsoft-mixed-reality")
  50367. * If not found, the xr input profile data will be used.
  50368. * Profiles are defined here - https://github.com/immersive-web/webxr-input-profiles/
  50369. */
  50370. forceInputProfile?: string;
  50371. /**
  50372. * Do not send a request to the controller repository to load the profile.
  50373. *
  50374. * Instead, use the controllers available in babylon itself.
  50375. */
  50376. disableOnlineControllerRepository?: boolean;
  50377. /**
  50378. * A custom URL for the controllers repository
  50379. */
  50380. customControllersRepositoryURL?: string;
  50381. /**
  50382. * Should the controller model's components not move according to the user input
  50383. */
  50384. disableControllerAnimation?: boolean;
  50385. /**
  50386. * Optional options to pass to the controller. Will be overridden by the Input options where applicable
  50387. */
  50388. controllerOptions?: IWebXRControllerOptions;
  50389. }
  50390. /**
  50391. * XR input used to track XR inputs such as controllers/rays
  50392. */
  50393. export class WebXRInput implements IDisposable {
  50394. /**
  50395. * the xr session manager for this session
  50396. */
  50397. xrSessionManager: WebXRSessionManager;
  50398. /**
  50399. * the WebXR camera for this session. Mainly used for teleportation
  50400. */
  50401. xrCamera: WebXRCamera;
  50402. private readonly options;
  50403. /**
  50404. * XR controllers being tracked
  50405. */
  50406. controllers: Array<WebXRInputSource>;
  50407. private _frameObserver;
  50408. private _sessionEndedObserver;
  50409. private _sessionInitObserver;
  50410. /**
  50411. * Event when a controller has been connected/added
  50412. */
  50413. onControllerAddedObservable: Observable<WebXRInputSource>;
  50414. /**
  50415. * Event when a controller has been removed/disconnected
  50416. */
  50417. onControllerRemovedObservable: Observable<WebXRInputSource>;
  50418. /**
  50419. * Initializes the WebXRInput
  50420. * @param xrSessionManager the xr session manager for this session
  50421. * @param xrCamera the WebXR camera for this session. Mainly used for teleportation
  50422. * @param options = initialization options for this xr input
  50423. */
  50424. constructor(
  50425. /**
  50426. * the xr session manager for this session
  50427. */
  50428. xrSessionManager: WebXRSessionManager,
  50429. /**
  50430. * the WebXR camera for this session. Mainly used for teleportation
  50431. */
  50432. xrCamera: WebXRCamera, options?: IWebXRInputOptions);
  50433. private _onInputSourcesChange;
  50434. private _addAndRemoveControllers;
  50435. /**
  50436. * Disposes of the object
  50437. */
  50438. dispose(): void;
  50439. }
  50440. }
  50441. declare module "babylonjs/XR/features/WebXRAbstractFeature" {
  50442. import { IWebXRFeature } from "babylonjs/XR/webXRFeaturesManager";
  50443. import { Observable, EventState } from "babylonjs/Misc/observable";
  50444. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  50445. /**
  50446. * This is the base class for all WebXR features.
  50447. * Since most features require almost the same resources and callbacks, this class can be used to simplify the development
  50448. * Note that since the features manager is using the `IWebXRFeature` you are in no way obligated to use this class
  50449. */
  50450. export abstract class WebXRAbstractFeature implements IWebXRFeature {
  50451. protected _xrSessionManager: WebXRSessionManager;
  50452. private _attached;
  50453. private _removeOnDetach;
  50454. /**
  50455. * Should auto-attach be disabled?
  50456. */
  50457. disableAutoAttach: boolean;
  50458. /**
  50459. * The name of the native xr feature name (like anchor, hit-test, or hand-tracking)
  50460. */
  50461. xrNativeFeatureName: string;
  50462. /**
  50463. * Construct a new (abstract) WebXR feature
  50464. * @param _xrSessionManager the xr session manager for this feature
  50465. */
  50466. constructor(_xrSessionManager: WebXRSessionManager);
  50467. /**
  50468. * Is this feature attached
  50469. */
  50470. get attached(): boolean;
  50471. /**
  50472. * attach this feature
  50473. *
  50474. * @param force should attachment be forced (even when already attached)
  50475. * @returns true if successful, false is failed or already attached
  50476. */
  50477. attach(force?: boolean): boolean;
  50478. /**
  50479. * detach this feature.
  50480. *
  50481. * @returns true if successful, false if failed or already detached
  50482. */
  50483. detach(): boolean;
  50484. /**
  50485. * Dispose this feature and all of the resources attached
  50486. */
  50487. dispose(): void;
  50488. /**
  50489. * This function will be executed during before enabling the feature and can be used to not-allow enabling it.
  50490. * Note that at this point the session has NOT started, so this is purely checking if the browser supports it
  50491. *
  50492. * @returns whether or not the feature is compatible in this environment
  50493. */
  50494. isCompatible(): boolean;
  50495. /**
  50496. * This is used to register callbacks that will automatically be removed when detach is called.
  50497. * @param observable the observable to which the observer will be attached
  50498. * @param callback the callback to register
  50499. */
  50500. protected _addNewAttachObserver<T>(observable: Observable<T>, callback: (eventData: T, eventState: EventState) => void): void;
  50501. /**
  50502. * Code in this function will be executed on each xrFrame received from the browser.
  50503. * This function will not execute after the feature is detached.
  50504. * @param _xrFrame the current frame
  50505. */
  50506. protected abstract _onXRFrame(_xrFrame: XRFrame): void;
  50507. }
  50508. }
  50509. declare module "babylonjs/Rendering/utilityLayerRenderer" {
  50510. import { IDisposable, Scene } from "babylonjs/scene";
  50511. import { Nullable } from "babylonjs/types";
  50512. import { Observable } from "babylonjs/Misc/observable";
  50513. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  50514. import { HemisphericLight } from "babylonjs/Lights/hemisphericLight";
  50515. import { Camera } from "babylonjs/Cameras/camera";
  50516. /**
  50517. * Renders a layer on top of an existing scene
  50518. */
  50519. export class UtilityLayerRenderer implements IDisposable {
  50520. /** the original scene that will be rendered on top of */
  50521. originalScene: Scene;
  50522. private _pointerCaptures;
  50523. private _lastPointerEvents;
  50524. private static _DefaultUtilityLayer;
  50525. private static _DefaultKeepDepthUtilityLayer;
  50526. private _sharedGizmoLight;
  50527. private _renderCamera;
  50528. /**
  50529. * Gets the camera that is used to render the utility layer (when not set, this will be the last active camera)
  50530. * @param getRigParentIfPossible if the current active camera is a rig camera, should its parent camera be returned
  50531. * @returns the camera that is used when rendering the utility layer
  50532. */
  50533. getRenderCamera(getRigParentIfPossible?: boolean): Camera;
  50534. /**
  50535. * Sets the camera that should be used when rendering the utility layer (If set to null the last active camera will be used)
  50536. * @param cam the camera that should be used when rendering the utility layer
  50537. */
  50538. setRenderCamera(cam: Nullable<Camera>): void;
  50539. /**
  50540. * @hidden
  50541. * Light which used by gizmos to get light shading
  50542. */
  50543. _getSharedGizmoLight(): HemisphericLight;
  50544. /**
  50545. * If the picking should be done on the utility layer prior to the actual scene (Default: true)
  50546. */
  50547. pickUtilitySceneFirst: boolean;
  50548. /**
  50549. * 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)
  50550. */
  50551. static get DefaultUtilityLayer(): UtilityLayerRenderer;
  50552. /**
  50553. * 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)
  50554. */
  50555. static get DefaultKeepDepthUtilityLayer(): UtilityLayerRenderer;
  50556. /**
  50557. * The scene that is rendered on top of the original scene
  50558. */
  50559. utilityLayerScene: Scene;
  50560. /**
  50561. * If the utility layer should automatically be rendered on top of existing scene
  50562. */
  50563. shouldRender: boolean;
  50564. /**
  50565. * If set to true, only pointer down onPointerObservable events will be blocked when picking is occluded by original scene
  50566. */
  50567. onlyCheckPointerDownEvents: boolean;
  50568. /**
  50569. * If set to false, only pointerUp, pointerDown and pointerMove will be sent to the utilityLayerScene (false by default)
  50570. */
  50571. processAllEvents: boolean;
  50572. /**
  50573. * Observable raised when the pointer move from the utility layer scene to the main scene
  50574. */
  50575. onPointerOutObservable: Observable<number>;
  50576. /** Gets or sets a predicate that will be used to indicate utility meshes present in the main scene */
  50577. mainSceneTrackerPredicate: (mesh: Nullable<AbstractMesh>) => boolean;
  50578. private _afterRenderObserver;
  50579. private _sceneDisposeObserver;
  50580. private _originalPointerObserver;
  50581. /**
  50582. * Instantiates a UtilityLayerRenderer
  50583. * @param originalScene the original scene that will be rendered on top of
  50584. * @param handleEvents boolean indicating if the utility layer should handle events
  50585. */
  50586. constructor(
  50587. /** the original scene that will be rendered on top of */
  50588. originalScene: Scene, handleEvents?: boolean);
  50589. private _notifyObservers;
  50590. /**
  50591. * Renders the utility layers scene on top of the original scene
  50592. */
  50593. render(): void;
  50594. /**
  50595. * Disposes of the renderer
  50596. */
  50597. dispose(): void;
  50598. private _updateCamera;
  50599. }
  50600. }
  50601. declare module "babylonjs/XR/features/WebXRControllerPointerSelection" {
  50602. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  50603. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  50604. import { WebXRInput } from "babylonjs/XR/webXRInput";
  50605. import { WebXRInputSource } from "babylonjs/XR/webXRInputSource";
  50606. import { Scene } from "babylonjs/scene";
  50607. import { Nullable } from "babylonjs/types";
  50608. import { Color3 } from "babylonjs/Maths/math.color";
  50609. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  50610. import { WebXRCamera } from "babylonjs/XR/webXRCamera";
  50611. /**
  50612. * Options interface for the pointer selection module
  50613. */
  50614. export interface IWebXRControllerPointerSelectionOptions {
  50615. /**
  50616. * if provided, this scene will be used to render meshes.
  50617. */
  50618. customUtilityLayerScene?: Scene;
  50619. /**
  50620. * 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)
  50621. * If not disabled, the last picked point will be used to execute a pointer up event
  50622. * If disabled, pointer up event will be triggered right after the pointer down event.
  50623. * Used in screen and gaze target ray mode only
  50624. */
  50625. disablePointerUpOnTouchOut: boolean;
  50626. /**
  50627. * For gaze mode for tracked-pointer / controllers (time to select instead of button press)
  50628. */
  50629. forceGazeMode: boolean;
  50630. /**
  50631. * 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
  50632. * to start a new countdown to the pointer down event.
  50633. * Defaults to 1.
  50634. */
  50635. gazeModePointerMovedFactor?: number;
  50636. /**
  50637. * Different button type to use instead of the main component
  50638. */
  50639. overrideButtonId?: string;
  50640. /**
  50641. * use this rendering group id for the meshes (optional)
  50642. */
  50643. renderingGroupId?: number;
  50644. /**
  50645. * The amount of time in milliseconds it takes between pick found something to a pointer down event.
  50646. * Used in gaze modes. Tracked pointer uses the trigger, screen uses touch events
  50647. * 3000 means 3 seconds between pointing at something and selecting it
  50648. */
  50649. timeToSelect?: number;
  50650. /**
  50651. * Should meshes created here be added to a utility layer or the main scene
  50652. */
  50653. useUtilityLayer?: boolean;
  50654. /**
  50655. * Optional WebXR camera to be used for gaze selection
  50656. */
  50657. gazeCamera?: WebXRCamera;
  50658. /**
  50659. * the xr input to use with this pointer selection
  50660. */
  50661. xrInput: WebXRInput;
  50662. }
  50663. /**
  50664. * A module that will enable pointer selection for motion controllers of XR Input Sources
  50665. */
  50666. export class WebXRControllerPointerSelection extends WebXRAbstractFeature {
  50667. private readonly _options;
  50668. private static _idCounter;
  50669. private _attachController;
  50670. private _controllers;
  50671. private _scene;
  50672. private _tmpVectorForPickCompare;
  50673. /**
  50674. * The module's name
  50675. */
  50676. static readonly Name: string;
  50677. /**
  50678. * The (Babylon) version of this module.
  50679. * This is an integer representing the implementation version.
  50680. * This number does not correspond to the WebXR specs version
  50681. */
  50682. static readonly Version: number;
  50683. /**
  50684. * Disable lighting on the laser pointer (so it will always be visible)
  50685. */
  50686. disablePointerLighting: boolean;
  50687. /**
  50688. * Disable lighting on the selection mesh (so it will always be visible)
  50689. */
  50690. disableSelectionMeshLighting: boolean;
  50691. /**
  50692. * Should the laser pointer be displayed
  50693. */
  50694. displayLaserPointer: boolean;
  50695. /**
  50696. * Should the selection mesh be displayed (The ring at the end of the laser pointer)
  50697. */
  50698. displaySelectionMesh: boolean;
  50699. /**
  50700. * This color will be set to the laser pointer when selection is triggered
  50701. */
  50702. laserPointerPickedColor: Color3;
  50703. /**
  50704. * Default color of the laser pointer
  50705. */
  50706. laserPointerDefaultColor: Color3;
  50707. /**
  50708. * default color of the selection ring
  50709. */
  50710. selectionMeshDefaultColor: Color3;
  50711. /**
  50712. * This color will be applied to the selection ring when selection is triggered
  50713. */
  50714. selectionMeshPickedColor: Color3;
  50715. /**
  50716. * Optional filter to be used for ray selection. This predicate shares behavior with
  50717. * scene.pointerMovePredicate which takes priority if it is also assigned.
  50718. */
  50719. raySelectionPredicate: (mesh: AbstractMesh) => boolean;
  50720. /**
  50721. * constructs a new background remover module
  50722. * @param _xrSessionManager the session manager for this module
  50723. * @param _options read-only options to be used in this module
  50724. */
  50725. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRControllerPointerSelectionOptions);
  50726. /**
  50727. * attach this feature
  50728. * Will usually be called by the features manager
  50729. *
  50730. * @returns true if successful.
  50731. */
  50732. attach(): boolean;
  50733. /**
  50734. * detach this feature.
  50735. * Will usually be called by the features manager
  50736. *
  50737. * @returns true if successful.
  50738. */
  50739. detach(): boolean;
  50740. /**
  50741. * Will get the mesh under a specific pointer.
  50742. * `scene.meshUnderPointer` will only return one mesh - either left or right.
  50743. * @param controllerId the controllerId to check
  50744. * @returns The mesh under pointer or null if no mesh is under the pointer
  50745. */
  50746. getMeshUnderPointer(controllerId: string): Nullable<AbstractMesh>;
  50747. /**
  50748. * Get the xr controller that correlates to the pointer id in the pointer event
  50749. *
  50750. * @param id the pointer id to search for
  50751. * @returns the controller that correlates to this id or null if not found
  50752. */
  50753. getXRControllerByPointerId(id: number): Nullable<WebXRInputSource>;
  50754. protected _onXRFrame(_xrFrame: XRFrame): void;
  50755. private _attachGazeMode;
  50756. private _attachScreenRayMode;
  50757. private _attachTrackedPointerRayMode;
  50758. private _convertNormalToDirectionOfRay;
  50759. private _detachController;
  50760. private _generateNewMeshPair;
  50761. private _pickingMoved;
  50762. private _updatePointerDistance;
  50763. /** @hidden */
  50764. get lasterPointerDefaultColor(): Color3;
  50765. }
  50766. }
  50767. declare module "babylonjs/XR/webXREnterExitUI" {
  50768. import { Nullable } from "babylonjs/types";
  50769. import { Observable } from "babylonjs/Misc/observable";
  50770. import { IDisposable, Scene } from "babylonjs/scene";
  50771. import { WebXRExperienceHelper } from "babylonjs/XR/webXRExperienceHelper";
  50772. import { WebXRRenderTarget } from "babylonjs/XR/webXRTypes";
  50773. /**
  50774. * Button which can be used to enter a different mode of XR
  50775. */
  50776. export class WebXREnterExitUIButton {
  50777. /** button element */
  50778. element: HTMLElement;
  50779. /** XR initialization options for the button */
  50780. sessionMode: XRSessionMode;
  50781. /** Reference space type */
  50782. referenceSpaceType: XRReferenceSpaceType;
  50783. /**
  50784. * Creates a WebXREnterExitUIButton
  50785. * @param element button element
  50786. * @param sessionMode XR initialization session mode
  50787. * @param referenceSpaceType the type of reference space to be used
  50788. */
  50789. constructor(
  50790. /** button element */
  50791. element: HTMLElement,
  50792. /** XR initialization options for the button */
  50793. sessionMode: XRSessionMode,
  50794. /** Reference space type */
  50795. referenceSpaceType: XRReferenceSpaceType);
  50796. /**
  50797. * Extendable function which can be used to update the button's visuals when the state changes
  50798. * @param activeButton the current active button in the UI
  50799. */
  50800. update(activeButton: Nullable<WebXREnterExitUIButton>): void;
  50801. }
  50802. /**
  50803. * Options to create the webXR UI
  50804. */
  50805. export class WebXREnterExitUIOptions {
  50806. /**
  50807. * User provided buttons to enable/disable WebXR. The system will provide default if not set
  50808. */
  50809. customButtons?: Array<WebXREnterExitUIButton>;
  50810. /**
  50811. * A reference space type to use when creating the default button.
  50812. * Default is local-floor
  50813. */
  50814. referenceSpaceType?: XRReferenceSpaceType;
  50815. /**
  50816. * Context to enter xr with
  50817. */
  50818. renderTarget?: Nullable<WebXRRenderTarget>;
  50819. /**
  50820. * A session mode to use when creating the default button.
  50821. * Default is immersive-vr
  50822. */
  50823. sessionMode?: XRSessionMode;
  50824. /**
  50825. * A list of optional features to init the session with
  50826. */
  50827. optionalFeatures?: string[];
  50828. /**
  50829. * A list of optional features to init the session with
  50830. */
  50831. requiredFeatures?: string[];
  50832. }
  50833. /**
  50834. * UI to allow the user to enter/exit XR mode
  50835. */
  50836. export class WebXREnterExitUI implements IDisposable {
  50837. private scene;
  50838. /** version of the options passed to this UI */
  50839. options: WebXREnterExitUIOptions;
  50840. private _activeButton;
  50841. private _buttons;
  50842. private _overlay;
  50843. /**
  50844. * Fired every time the active button is changed.
  50845. *
  50846. * When xr is entered via a button that launches xr that button will be the callback parameter
  50847. *
  50848. * When exiting xr the callback parameter will be null)
  50849. */
  50850. activeButtonChangedObservable: Observable<Nullable<WebXREnterExitUIButton>>;
  50851. /**
  50852. *
  50853. * @param scene babylon scene object to use
  50854. * @param options (read-only) version of the options passed to this UI
  50855. */
  50856. private constructor();
  50857. /**
  50858. * Creates UI to allow the user to enter/exit XR mode
  50859. * @param scene the scene to add the ui to
  50860. * @param helper the xr experience helper to enter/exit xr with
  50861. * @param options options to configure the UI
  50862. * @returns the created ui
  50863. */
  50864. static CreateAsync(scene: Scene, helper: WebXRExperienceHelper, options: WebXREnterExitUIOptions): Promise<WebXREnterExitUI>;
  50865. /**
  50866. * Disposes of the XR UI component
  50867. */
  50868. dispose(): void;
  50869. private _updateButtons;
  50870. }
  50871. }
  50872. declare module "babylonjs/Meshes/Builders/linesBuilder" {
  50873. import { Vector3 } from "babylonjs/Maths/math.vector";
  50874. import { Color4 } from "babylonjs/Maths/math.color";
  50875. import { Nullable } from "babylonjs/types";
  50876. import { LinesMesh } from "babylonjs/Meshes/linesMesh";
  50877. import { Scene } from "babylonjs/scene";
  50878. /**
  50879. * Class containing static functions to help procedurally build meshes
  50880. */
  50881. export class LinesBuilder {
  50882. /**
  50883. * Creates a line system mesh. A line system is a pool of many lines gathered in a single mesh
  50884. * * 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
  50885. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineSystem to this static function
  50886. * * The parameter `lines` is an array of lines, each line being an array of successive Vector3
  50887. * * The optional parameter `instance` is an instance of an existing LineSystem object to be updated with the passed `lines` parameter
  50888. * * The optional parameter `colors` is an array of line colors, each line colors being an array of successive Color4, one per line point
  50889. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  50890. * * 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
  50891. * * When updating an instance, remember that only line point positions can change, not the number of points, neither the number of lines
  50892. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  50893. * @see https://doc.babylonjs.com/how_to/parametric_shapes#line-system
  50894. * @param name defines the name of the new line system
  50895. * @param options defines the options used to create the line system
  50896. * @param scene defines the hosting scene
  50897. * @returns a new line system mesh
  50898. */
  50899. static CreateLineSystem(name: string, options: {
  50900. lines: Vector3[][];
  50901. updatable?: boolean;
  50902. instance?: Nullable<LinesMesh>;
  50903. colors?: Nullable<Color4[][]>;
  50904. useVertexAlpha?: boolean;
  50905. }, scene: Nullable<Scene>): LinesMesh;
  50906. /**
  50907. * Creates a line mesh
  50908. * 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
  50909. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  50910. * * The parameter `points` is an array successive Vector3
  50911. * * 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
  50912. * * The optional parameter `colors` is an array of successive Color4, one per line point
  50913. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need alpha blending (faster)
  50914. * * When updating an instance, remember that only point positions can change, not the number of points
  50915. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  50916. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lines
  50917. * @param name defines the name of the new line system
  50918. * @param options defines the options used to create the line system
  50919. * @param scene defines the hosting scene
  50920. * @returns a new line mesh
  50921. */
  50922. static CreateLines(name: string, options: {
  50923. points: Vector3[];
  50924. updatable?: boolean;
  50925. instance?: Nullable<LinesMesh>;
  50926. colors?: Color4[];
  50927. useVertexAlpha?: boolean;
  50928. }, scene?: Nullable<Scene>): LinesMesh;
  50929. /**
  50930. * Creates a dashed line mesh
  50931. * * 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
  50932. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  50933. * * The parameter `points` is an array successive Vector3
  50934. * * The parameter `dashNb` is the intended total number of dashes (positive integer, default 200)
  50935. * * The parameter `dashSize` is the size of the dashes relatively the dash number (positive float, default 3)
  50936. * * The parameter `gapSize` is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  50937. * * 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
  50938. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  50939. * * When updating an instance, remember that only point positions can change, not the number of points
  50940. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  50941. * @param name defines the name of the mesh
  50942. * @param options defines the options used to create the mesh
  50943. * @param scene defines the hosting scene
  50944. * @returns the dashed line mesh
  50945. * @see https://doc.babylonjs.com/how_to/parametric_shapes#dashed-lines
  50946. */
  50947. static CreateDashedLines(name: string, options: {
  50948. points: Vector3[];
  50949. dashSize?: number;
  50950. gapSize?: number;
  50951. dashNb?: number;
  50952. updatable?: boolean;
  50953. instance?: LinesMesh;
  50954. useVertexAlpha?: boolean;
  50955. }, scene?: Nullable<Scene>): LinesMesh;
  50956. }
  50957. }
  50958. declare module "babylonjs/Misc/timer" {
  50959. import { Observable, Observer } from "babylonjs/Misc/observable";
  50960. import { Nullable } from "babylonjs/types";
  50961. import { IDisposable } from "babylonjs/scene";
  50962. /**
  50963. * Construction options for a timer
  50964. */
  50965. export interface ITimerOptions<T> {
  50966. /**
  50967. * Time-to-end
  50968. */
  50969. timeout: number;
  50970. /**
  50971. * The context observable is used to calculate time deltas and provides the context of the timer's callbacks. Will usually be OnBeforeRenderObservable.
  50972. * Countdown calculation is done ONLY when the observable is notifying its observers, meaning that if
  50973. * you choose an observable that doesn't trigger too often, the wait time might extend further than the requested max time
  50974. */
  50975. contextObservable: Observable<T>;
  50976. /**
  50977. * Optional parameters when adding an observer to the observable
  50978. */
  50979. observableParameters?: {
  50980. mask?: number;
  50981. insertFirst?: boolean;
  50982. scope?: any;
  50983. };
  50984. /**
  50985. * An optional break condition that will stop the times prematurely. In this case onEnded will not be triggered!
  50986. */
  50987. breakCondition?: (data?: ITimerData<T>) => boolean;
  50988. /**
  50989. * Will be triggered when the time condition has met
  50990. */
  50991. onEnded?: (data: ITimerData<any>) => void;
  50992. /**
  50993. * Will be triggered when the break condition has met (prematurely ended)
  50994. */
  50995. onAborted?: (data: ITimerData<any>) => void;
  50996. /**
  50997. * Optional function to execute on each tick (or count)
  50998. */
  50999. onTick?: (data: ITimerData<any>) => void;
  51000. }
  51001. /**
  51002. * An interface defining the data sent by the timer
  51003. */
  51004. export interface ITimerData<T> {
  51005. /**
  51006. * When did it start
  51007. */
  51008. startTime: number;
  51009. /**
  51010. * Time now
  51011. */
  51012. currentTime: number;
  51013. /**
  51014. * Time passed since started
  51015. */
  51016. deltaTime: number;
  51017. /**
  51018. * How much is completed, in [0.0...1.0].
  51019. * Note that this CAN be higher than 1 due to the fact that we don't actually measure time but delta between observable calls
  51020. */
  51021. completeRate: number;
  51022. /**
  51023. * What the registered observable sent in the last count
  51024. */
  51025. payload: T;
  51026. }
  51027. /**
  51028. * The current state of the timer
  51029. */
  51030. export enum TimerState {
  51031. /**
  51032. * Timer initialized, not yet started
  51033. */
  51034. INIT = 0,
  51035. /**
  51036. * Timer started and counting
  51037. */
  51038. STARTED = 1,
  51039. /**
  51040. * Timer ended (whether aborted or time reached)
  51041. */
  51042. ENDED = 2
  51043. }
  51044. /**
  51045. * A simple version of the timer. Will take options and start the timer immediately after calling it
  51046. *
  51047. * @param options options with which to initialize this timer
  51048. */
  51049. export function setAndStartTimer(options: ITimerOptions<any>): Nullable<Observer<any>>;
  51050. /**
  51051. * An advanced implementation of a timer class
  51052. */
  51053. export class AdvancedTimer<T = any> implements IDisposable {
  51054. /**
  51055. * Will notify each time the timer calculates the remaining time
  51056. */
  51057. onEachCountObservable: Observable<ITimerData<T>>;
  51058. /**
  51059. * Will trigger when the timer was aborted due to the break condition
  51060. */
  51061. onTimerAbortedObservable: Observable<ITimerData<T>>;
  51062. /**
  51063. * Will trigger when the timer ended successfully
  51064. */
  51065. onTimerEndedObservable: Observable<ITimerData<T>>;
  51066. /**
  51067. * Will trigger when the timer state has changed
  51068. */
  51069. onStateChangedObservable: Observable<TimerState>;
  51070. private _observer;
  51071. private _contextObservable;
  51072. private _observableParameters;
  51073. private _startTime;
  51074. private _timer;
  51075. private _state;
  51076. private _breakCondition;
  51077. private _timeToEnd;
  51078. private _breakOnNextTick;
  51079. /**
  51080. * Will construct a new advanced timer based on the options provided. Timer will not start until start() is called.
  51081. * @param options construction options for this advanced timer
  51082. */
  51083. constructor(options: ITimerOptions<T>);
  51084. /**
  51085. * set a breaking condition for this timer. Default is to never break during count
  51086. * @param predicate the new break condition. Returns true to break, false otherwise
  51087. */
  51088. set breakCondition(predicate: (data: ITimerData<T>) => boolean);
  51089. /**
  51090. * Reset ALL associated observables in this advanced timer
  51091. */
  51092. clearObservables(): void;
  51093. /**
  51094. * Will start a new iteration of this timer. Only one instance of this timer can run at a time.
  51095. *
  51096. * @param timeToEnd how much time to measure until timer ended
  51097. */
  51098. start(timeToEnd?: number): void;
  51099. /**
  51100. * Will force a stop on the next tick.
  51101. */
  51102. stop(): void;
  51103. /**
  51104. * Dispose this timer, clearing all resources
  51105. */
  51106. dispose(): void;
  51107. private _setState;
  51108. private _tick;
  51109. private _stop;
  51110. }
  51111. }
  51112. declare module "babylonjs/XR/features/WebXRControllerTeleportation" {
  51113. import { IWebXRFeature } from "babylonjs/XR/webXRFeaturesManager";
  51114. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  51115. import { WebXRInput } from "babylonjs/XR/webXRInput";
  51116. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  51117. import { Vector3 } from "babylonjs/Maths/math.vector";
  51118. import { Material } from "babylonjs/Materials/material";
  51119. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  51120. import { Scene } from "babylonjs/scene";
  51121. /**
  51122. * The options container for the teleportation module
  51123. */
  51124. export interface IWebXRTeleportationOptions {
  51125. /**
  51126. * if provided, this scene will be used to render meshes.
  51127. */
  51128. customUtilityLayerScene?: Scene;
  51129. /**
  51130. * Values to configure the default target mesh
  51131. */
  51132. defaultTargetMeshOptions?: {
  51133. /**
  51134. * Fill color of the teleportation area
  51135. */
  51136. teleportationFillColor?: string;
  51137. /**
  51138. * Border color for the teleportation area
  51139. */
  51140. teleportationBorderColor?: string;
  51141. /**
  51142. * Disable the mesh's animation sequence
  51143. */
  51144. disableAnimation?: boolean;
  51145. /**
  51146. * Disable lighting on the material or the ring and arrow
  51147. */
  51148. disableLighting?: boolean;
  51149. /**
  51150. * Override the default material of the torus and arrow
  51151. */
  51152. torusArrowMaterial?: Material;
  51153. };
  51154. /**
  51155. * A list of meshes to use as floor meshes.
  51156. * Meshes can be added and removed after initializing the feature using the
  51157. * addFloorMesh and removeFloorMesh functions
  51158. * If empty, rotation will still work
  51159. */
  51160. floorMeshes?: AbstractMesh[];
  51161. /**
  51162. * use this rendering group id for the meshes (optional)
  51163. */
  51164. renderingGroupId?: number;
  51165. /**
  51166. * Should teleportation move only to snap points
  51167. */
  51168. snapPointsOnly?: boolean;
  51169. /**
  51170. * An array of points to which the teleportation will snap to.
  51171. * If the teleportation ray is in the proximity of one of those points, it will be corrected to this point.
  51172. */
  51173. snapPositions?: Vector3[];
  51174. /**
  51175. * How close should the teleportation ray be in order to snap to position.
  51176. * Default to 0.8 units (meters)
  51177. */
  51178. snapToPositionRadius?: number;
  51179. /**
  51180. * Provide your own teleportation mesh instead of babylon's wonderful doughnut.
  51181. * If you want to support rotation, make sure your mesh has a direction indicator.
  51182. *
  51183. * When left untouched, the default mesh will be initialized.
  51184. */
  51185. teleportationTargetMesh?: AbstractMesh;
  51186. /**
  51187. * If main component is used (no thumbstick), how long should the "long press" take before teleport
  51188. */
  51189. timeToTeleport?: number;
  51190. /**
  51191. * Disable using the thumbstick and use the main component (usually trigger) on long press.
  51192. * This will be automatically true if the controller doesn't have a thumbstick or touchpad.
  51193. */
  51194. useMainComponentOnly?: boolean;
  51195. /**
  51196. * Should meshes created here be added to a utility layer or the main scene
  51197. */
  51198. useUtilityLayer?: boolean;
  51199. /**
  51200. * Babylon XR Input class for controller
  51201. */
  51202. xrInput: WebXRInput;
  51203. }
  51204. /**
  51205. * This is a teleportation feature to be used with WebXR-enabled motion controllers.
  51206. * When enabled and attached, the feature will allow a user to move around and rotate in the scene using
  51207. * the input of the attached controllers.
  51208. */
  51209. export class WebXRMotionControllerTeleportation extends WebXRAbstractFeature {
  51210. private _options;
  51211. private _controllers;
  51212. private _currentTeleportationControllerId;
  51213. private _floorMeshes;
  51214. private _quadraticBezierCurve;
  51215. private _selectionFeature;
  51216. private _snapToPositions;
  51217. private _snappedToPoint;
  51218. private _teleportationRingMaterial?;
  51219. private _tmpRay;
  51220. private _tmpVector;
  51221. /**
  51222. * The module's name
  51223. */
  51224. static readonly Name: string;
  51225. /**
  51226. * The (Babylon) version of this module.
  51227. * This is an integer representing the implementation version.
  51228. * This number does not correspond to the webxr specs version
  51229. */
  51230. static readonly Version: number;
  51231. /**
  51232. * Is movement backwards enabled
  51233. */
  51234. backwardsMovementEnabled: boolean;
  51235. /**
  51236. * Distance to travel when moving backwards
  51237. */
  51238. backwardsTeleportationDistance: number;
  51239. /**
  51240. * The distance from the user to the inspection point in the direction of the controller
  51241. * A higher number will allow the user to move further
  51242. * defaults to 5 (meters, in xr units)
  51243. */
  51244. parabolicCheckRadius: number;
  51245. /**
  51246. * Should the module support parabolic ray on top of direct ray
  51247. * If enabled, the user will be able to point "at the sky" and move according to predefined radius distance
  51248. * Very helpful when moving between floors / different heights
  51249. */
  51250. parabolicRayEnabled: boolean;
  51251. /**
  51252. * How much rotation should be applied when rotating right and left
  51253. */
  51254. rotationAngle: number;
  51255. /**
  51256. * Is rotation enabled when moving forward?
  51257. * Disabling this feature will prevent the user from deciding the direction when teleporting
  51258. */
  51259. rotationEnabled: boolean;
  51260. /**
  51261. * constructs a new anchor system
  51262. * @param _xrSessionManager an instance of WebXRSessionManager
  51263. * @param _options configuration object for this feature
  51264. */
  51265. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRTeleportationOptions);
  51266. /**
  51267. * Get the snapPointsOnly flag
  51268. */
  51269. get snapPointsOnly(): boolean;
  51270. /**
  51271. * Sets the snapPointsOnly flag
  51272. * @param snapToPoints should teleportation be exclusively to snap points
  51273. */
  51274. set snapPointsOnly(snapToPoints: boolean);
  51275. /**
  51276. * Add a new mesh to the floor meshes array
  51277. * @param mesh the mesh to use as floor mesh
  51278. */
  51279. addFloorMesh(mesh: AbstractMesh): void;
  51280. /**
  51281. * Add a new snap-to point to fix teleportation to this position
  51282. * @param newSnapPoint The new Snap-To point
  51283. */
  51284. addSnapPoint(newSnapPoint: Vector3): void;
  51285. attach(): boolean;
  51286. detach(): boolean;
  51287. dispose(): void;
  51288. /**
  51289. * Remove a mesh from the floor meshes array
  51290. * @param mesh the mesh to remove
  51291. */
  51292. removeFloorMesh(mesh: AbstractMesh): void;
  51293. /**
  51294. * Remove a mesh from the floor meshes array using its name
  51295. * @param name the mesh name to remove
  51296. */
  51297. removeFloorMeshByName(name: string): void;
  51298. /**
  51299. * 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
  51300. * @param snapPointToRemove the point (or a clone of it) to be removed from the array
  51301. * @returns was the point found and removed or not
  51302. */
  51303. removeSnapPoint(snapPointToRemove: Vector3): boolean;
  51304. /**
  51305. * This function sets a selection feature that will be disabled when
  51306. * the forward ray is shown and will be reattached when hidden.
  51307. * This is used to remove the selection rays when moving.
  51308. * @param selectionFeature the feature to disable when forward movement is enabled
  51309. */
  51310. setSelectionFeature(selectionFeature: IWebXRFeature): void;
  51311. protected _onXRFrame(_xrFrame: XRFrame): void;
  51312. private _attachController;
  51313. private _createDefaultTargetMesh;
  51314. private _detachController;
  51315. private _findClosestSnapPointWithRadius;
  51316. private _setTargetMeshPosition;
  51317. private _setTargetMeshVisibility;
  51318. private _showParabolicPath;
  51319. private _teleportForward;
  51320. }
  51321. }
  51322. declare module "babylonjs/XR/webXRDefaultExperience" {
  51323. import { WebXRExperienceHelper } from "babylonjs/XR/webXRExperienceHelper";
  51324. import { Scene } from "babylonjs/scene";
  51325. import { WebXRInput, IWebXRInputOptions } from "babylonjs/XR/webXRInput";
  51326. import { WebXRControllerPointerSelection } from "babylonjs/XR/features/WebXRControllerPointerSelection";
  51327. import { WebXRRenderTarget } from "babylonjs/XR/webXRTypes";
  51328. import { WebXREnterExitUI, WebXREnterExitUIOptions } from "babylonjs/XR/webXREnterExitUI";
  51329. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  51330. import { WebXRManagedOutputCanvasOptions } from "babylonjs/XR/webXRManagedOutputCanvas";
  51331. import { WebXRMotionControllerTeleportation } from "babylonjs/XR/features/WebXRControllerTeleportation";
  51332. /**
  51333. * Options for the default xr helper
  51334. */
  51335. export class WebXRDefaultExperienceOptions {
  51336. /**
  51337. * Enable or disable default UI to enter XR
  51338. */
  51339. disableDefaultUI?: boolean;
  51340. /**
  51341. * Should teleportation not initialize. defaults to false.
  51342. */
  51343. disableTeleportation?: boolean;
  51344. /**
  51345. * Floor meshes that will be used for teleport
  51346. */
  51347. floorMeshes?: Array<AbstractMesh>;
  51348. /**
  51349. * If set to true, the first frame will not be used to reset position
  51350. * The first frame is mainly used when copying transformation from the old camera
  51351. * Mainly used in AR
  51352. */
  51353. ignoreNativeCameraTransformation?: boolean;
  51354. /**
  51355. * Disable the controller mesh-loading. Can be used if you want to load your own meshes
  51356. */
  51357. inputOptions?: IWebXRInputOptions;
  51358. /**
  51359. * optional configuration for the output canvas
  51360. */
  51361. outputCanvasOptions?: WebXRManagedOutputCanvasOptions;
  51362. /**
  51363. * optional UI options. This can be used among other to change session mode and reference space type
  51364. */
  51365. uiOptions?: WebXREnterExitUIOptions;
  51366. /**
  51367. * When loading teleportation and pointer select, use stable versions instead of latest.
  51368. */
  51369. useStablePlugins?: boolean;
  51370. /**
  51371. * An optional rendering group id that will be set globally for teleportation, pointer selection and default controller meshes
  51372. */
  51373. renderingGroupId?: number;
  51374. /**
  51375. * A list of optional features to init the session with
  51376. * If set to true, all features we support will be added
  51377. */
  51378. optionalFeatures?: boolean | string[];
  51379. }
  51380. /**
  51381. * Default experience which provides a similar setup to the previous webVRExperience
  51382. */
  51383. export class WebXRDefaultExperience {
  51384. /**
  51385. * Base experience
  51386. */
  51387. baseExperience: WebXRExperienceHelper;
  51388. /**
  51389. * Enables ui for entering/exiting xr
  51390. */
  51391. enterExitUI: WebXREnterExitUI;
  51392. /**
  51393. * Input experience extension
  51394. */
  51395. input: WebXRInput;
  51396. /**
  51397. * Enables laser pointer and selection
  51398. */
  51399. pointerSelection: WebXRControllerPointerSelection;
  51400. /**
  51401. * Default target xr should render to
  51402. */
  51403. renderTarget: WebXRRenderTarget;
  51404. /**
  51405. * Enables teleportation
  51406. */
  51407. teleportation: WebXRMotionControllerTeleportation;
  51408. private constructor();
  51409. /**
  51410. * Creates the default xr experience
  51411. * @param scene scene
  51412. * @param options options for basic configuration
  51413. * @returns resulting WebXRDefaultExperience
  51414. */
  51415. static CreateAsync(scene: Scene, options?: WebXRDefaultExperienceOptions): Promise<WebXRDefaultExperience>;
  51416. /**
  51417. * DIsposes of the experience helper
  51418. */
  51419. dispose(): void;
  51420. }
  51421. }
  51422. declare module "babylonjs/Cameras/VR/vrExperienceHelper" {
  51423. import { Observable } from "babylonjs/Misc/observable";
  51424. import { Nullable } from "babylonjs/types";
  51425. import { Camera } from "babylonjs/Cameras/camera";
  51426. import { DeviceOrientationCamera } from "babylonjs/Cameras/deviceOrientationCamera";
  51427. import { VRDeviceOrientationFreeCamera } from "babylonjs/Cameras/VR/vrDeviceOrientationFreeCamera";
  51428. import { WebVROptions, WebVRFreeCamera } from "babylonjs/Cameras/VR/webVRCamera";
  51429. import { Scene } from "babylonjs/scene";
  51430. import { Vector3 } from "babylonjs/Maths/math.vector";
  51431. import { Color3 } from "babylonjs/Maths/math.color";
  51432. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  51433. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  51434. import { Mesh } from "babylonjs/Meshes/mesh";
  51435. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  51436. import { EasingFunction } from "babylonjs/Animations/easing";
  51437. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  51438. import "babylonjs/Meshes/Builders/groundBuilder";
  51439. import "babylonjs/Meshes/Builders/torusBuilder";
  51440. import "babylonjs/Meshes/Builders/cylinderBuilder";
  51441. import "babylonjs/Gamepads/gamepadSceneComponent";
  51442. import "babylonjs/Animations/animatable";
  51443. import { WebXRDefaultExperience } from "babylonjs/XR/webXRDefaultExperience";
  51444. /**
  51445. * Options to modify the vr teleportation behavior.
  51446. */
  51447. export interface VRTeleportationOptions {
  51448. /**
  51449. * The name of the mesh which should be used as the teleportation floor. (default: null)
  51450. */
  51451. floorMeshName?: string;
  51452. /**
  51453. * A list of meshes to be used as the teleportation floor. (default: empty)
  51454. */
  51455. floorMeshes?: Mesh[];
  51456. /**
  51457. * The teleportation mode. (default: TELEPORTATIONMODE_CONSTANTTIME)
  51458. */
  51459. teleportationMode?: number;
  51460. /**
  51461. * The duration of the animation in ms, apply when animationMode is TELEPORTATIONMODE_CONSTANTTIME. (default 122ms)
  51462. */
  51463. teleportationTime?: number;
  51464. /**
  51465. * The speed of the animation in distance/sec, apply when animationMode is TELEPORTATIONMODE_CONSTANTSPEED. (default 20 units / sec)
  51466. */
  51467. teleportationSpeed?: number;
  51468. /**
  51469. * The easing function used in the animation or null for Linear. (default CircleEase)
  51470. */
  51471. easingFunction?: EasingFunction;
  51472. }
  51473. /**
  51474. * Options to modify the vr experience helper's behavior.
  51475. */
  51476. export interface VRExperienceHelperOptions extends WebVROptions {
  51477. /**
  51478. * Create a DeviceOrientationCamera to be used as your out of vr camera. (default: true)
  51479. */
  51480. createDeviceOrientationCamera?: boolean;
  51481. /**
  51482. * Create a VRDeviceOrientationFreeCamera to be used for VR when no external HMD is found. (default: true)
  51483. */
  51484. createFallbackVRDeviceOrientationFreeCamera?: boolean;
  51485. /**
  51486. * Uses the main button on the controller to toggle the laser casted. (default: true)
  51487. */
  51488. laserToggle?: boolean;
  51489. /**
  51490. * A list of meshes to be used as the teleportation floor. If specified, teleportation will be enabled (default: undefined)
  51491. */
  51492. floorMeshes?: Mesh[];
  51493. /**
  51494. * Distortion metrics for the fallback vrDeviceOrientationCamera (default: VRCameraMetrics.Default)
  51495. */
  51496. vrDeviceOrientationCameraMetrics?: VRCameraMetrics;
  51497. /**
  51498. * Defines if WebXR should be used instead of WebVR (if available)
  51499. */
  51500. useXR?: boolean;
  51501. }
  51502. /**
  51503. * Event containing information after VR has been entered
  51504. */
  51505. export class OnAfterEnteringVRObservableEvent {
  51506. /**
  51507. * If entering vr was successful
  51508. */
  51509. success: boolean;
  51510. }
  51511. /**
  51512. * Helps to quickly add VR support to an existing scene.
  51513. * See https://doc.babylonjs.com/how_to/webvr_helper
  51514. */
  51515. export class VRExperienceHelper {
  51516. /** Options to modify the vr experience helper's behavior. */
  51517. webVROptions: VRExperienceHelperOptions;
  51518. private _scene;
  51519. private _position;
  51520. private _btnVR;
  51521. private _btnVRDisplayed;
  51522. private _webVRsupported;
  51523. private _webVRready;
  51524. private _webVRrequesting;
  51525. private _webVRpresenting;
  51526. private _hasEnteredVR;
  51527. private _fullscreenVRpresenting;
  51528. private _inputElement;
  51529. private _webVRCamera;
  51530. private _vrDeviceOrientationCamera;
  51531. private _deviceOrientationCamera;
  51532. private _existingCamera;
  51533. private _onKeyDown;
  51534. private _onVrDisplayPresentChange;
  51535. private _onVRDisplayChanged;
  51536. private _onVRRequestPresentStart;
  51537. private _onVRRequestPresentComplete;
  51538. /**
  51539. * 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)
  51540. */
  51541. enableGazeEvenWhenNoPointerLock: boolean;
  51542. /**
  51543. * Gets or sets a boolean indicating that the VREXperienceHelper will exit VR if double tap is detected
  51544. */
  51545. exitVROnDoubleTap: boolean;
  51546. /**
  51547. * Observable raised right before entering VR.
  51548. */
  51549. onEnteringVRObservable: Observable<VRExperienceHelper>;
  51550. /**
  51551. * Observable raised when entering VR has completed.
  51552. */
  51553. onAfterEnteringVRObservable: Observable<OnAfterEnteringVRObservableEvent>;
  51554. /**
  51555. * Observable raised when exiting VR.
  51556. */
  51557. onExitingVRObservable: Observable<VRExperienceHelper>;
  51558. /**
  51559. * Observable raised when controller mesh is loaded.
  51560. */
  51561. onControllerMeshLoadedObservable: Observable<WebVRController>;
  51562. /** Return this.onEnteringVRObservable
  51563. * Note: This one is for backward compatibility. Please use onEnteringVRObservable directly
  51564. */
  51565. get onEnteringVR(): Observable<VRExperienceHelper>;
  51566. /** Return this.onExitingVRObservable
  51567. * Note: This one is for backward compatibility. Please use onExitingVRObservable directly
  51568. */
  51569. get onExitingVR(): Observable<VRExperienceHelper>;
  51570. /** Return this.onControllerMeshLoadedObservable
  51571. * Note: This one is for backward compatibility. Please use onControllerMeshLoadedObservable directly
  51572. */
  51573. get onControllerMeshLoaded(): Observable<WebVRController>;
  51574. private _rayLength;
  51575. private _useCustomVRButton;
  51576. private _teleportationRequested;
  51577. private _teleportActive;
  51578. private _floorMeshName;
  51579. private _floorMeshesCollection;
  51580. private _teleportationMode;
  51581. private _teleportationTime;
  51582. private _teleportationSpeed;
  51583. private _teleportationEasing;
  51584. private _rotationAllowed;
  51585. private _teleportBackwardsVector;
  51586. private _teleportationTarget;
  51587. private _isDefaultTeleportationTarget;
  51588. private _postProcessMove;
  51589. private _teleportationFillColor;
  51590. private _teleportationBorderColor;
  51591. private _rotationAngle;
  51592. private _haloCenter;
  51593. private _cameraGazer;
  51594. private _padSensibilityUp;
  51595. private _padSensibilityDown;
  51596. private _leftController;
  51597. private _rightController;
  51598. private _gazeColor;
  51599. private _laserColor;
  51600. private _pickedLaserColor;
  51601. private _pickedGazeColor;
  51602. /**
  51603. * Observable raised when a new mesh is selected based on meshSelectionPredicate
  51604. */
  51605. onNewMeshSelected: Observable<AbstractMesh>;
  51606. /**
  51607. * Observable raised when a new mesh is selected based on meshSelectionPredicate.
  51608. * This observable will provide the mesh and the controller used to select the mesh
  51609. */
  51610. onMeshSelectedWithController: Observable<{
  51611. mesh: AbstractMesh;
  51612. controller: WebVRController;
  51613. }>;
  51614. /**
  51615. * Observable raised when a new mesh is picked based on meshSelectionPredicate
  51616. */
  51617. onNewMeshPicked: Observable<PickingInfo>;
  51618. private _circleEase;
  51619. /**
  51620. * Observable raised before camera teleportation
  51621. */
  51622. onBeforeCameraTeleport: Observable<Vector3>;
  51623. /**
  51624. * Observable raised after camera teleportation
  51625. */
  51626. onAfterCameraTeleport: Observable<Vector3>;
  51627. /**
  51628. * Observable raised when current selected mesh gets unselected
  51629. */
  51630. onSelectedMeshUnselected: Observable<AbstractMesh>;
  51631. private _raySelectionPredicate;
  51632. /**
  51633. * To be optionaly changed by user to define custom ray selection
  51634. */
  51635. raySelectionPredicate: (mesh: AbstractMesh) => boolean;
  51636. /**
  51637. * To be optionaly changed by user to define custom selection logic (after ray selection)
  51638. */
  51639. meshSelectionPredicate: (mesh: AbstractMesh) => boolean;
  51640. /**
  51641. * Set teleportation enabled. If set to false camera teleportation will be disabled but camera rotation will be kept.
  51642. */
  51643. teleportationEnabled: boolean;
  51644. private _defaultHeight;
  51645. private _teleportationInitialized;
  51646. private _interactionsEnabled;
  51647. private _interactionsRequested;
  51648. private _displayGaze;
  51649. private _displayLaserPointer;
  51650. /**
  51651. * The mesh used to display where the user is going to teleport.
  51652. */
  51653. get teleportationTarget(): Mesh;
  51654. /**
  51655. * Sets the mesh to be used to display where the user is going to teleport.
  51656. */
  51657. set teleportationTarget(value: Mesh);
  51658. /**
  51659. * 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
  51660. * when set bakeCurrentTransformIntoVertices will be called on the mesh.
  51661. * See https://doc.babylonjs.com/resources/baking_transformations
  51662. */
  51663. get gazeTrackerMesh(): Mesh;
  51664. set gazeTrackerMesh(value: Mesh);
  51665. /**
  51666. * If the gaze trackers scale should be updated to be constant size when pointing at near/far meshes
  51667. */
  51668. updateGazeTrackerScale: boolean;
  51669. /**
  51670. * If the gaze trackers color should be updated when selecting meshes
  51671. */
  51672. updateGazeTrackerColor: boolean;
  51673. /**
  51674. * If the controller laser color should be updated when selecting meshes
  51675. */
  51676. updateControllerLaserColor: boolean;
  51677. /**
  51678. * The gaze tracking mesh corresponding to the left controller
  51679. */
  51680. get leftControllerGazeTrackerMesh(): Nullable<Mesh>;
  51681. /**
  51682. * The gaze tracking mesh corresponding to the right controller
  51683. */
  51684. get rightControllerGazeTrackerMesh(): Nullable<Mesh>;
  51685. /**
  51686. * If the ray of the gaze should be displayed.
  51687. */
  51688. get displayGaze(): boolean;
  51689. /**
  51690. * Sets if the ray of the gaze should be displayed.
  51691. */
  51692. set displayGaze(value: boolean);
  51693. /**
  51694. * If the ray of the LaserPointer should be displayed.
  51695. */
  51696. get displayLaserPointer(): boolean;
  51697. /**
  51698. * Sets if the ray of the LaserPointer should be displayed.
  51699. */
  51700. set displayLaserPointer(value: boolean);
  51701. /**
  51702. * The deviceOrientationCamera used as the camera when not in VR.
  51703. */
  51704. get deviceOrientationCamera(): Nullable<DeviceOrientationCamera>;
  51705. /**
  51706. * Based on the current WebVR support, returns the current VR camera used.
  51707. */
  51708. get currentVRCamera(): Nullable<Camera>;
  51709. /**
  51710. * The webVRCamera which is used when in VR.
  51711. */
  51712. get webVRCamera(): WebVRFreeCamera;
  51713. /**
  51714. * The deviceOrientationCamera that is used as a fallback when vr device is not connected.
  51715. */
  51716. get vrDeviceOrientationCamera(): Nullable<VRDeviceOrientationFreeCamera>;
  51717. /**
  51718. * The html button that is used to trigger entering into VR.
  51719. */
  51720. get vrButton(): Nullable<HTMLButtonElement>;
  51721. private get _teleportationRequestInitiated();
  51722. /**
  51723. * Defines whether or not Pointer lock should be requested when switching to
  51724. * full screen.
  51725. */
  51726. requestPointerLockOnFullScreen: boolean;
  51727. /**
  51728. * If asking to force XR, this will be populated with the default xr experience
  51729. */
  51730. xr: WebXRDefaultExperience;
  51731. /**
  51732. * Was the XR test done already. If this is true AND this.xr exists, xr is initialized.
  51733. * If this is true and no this.xr, xr exists but is not supported, using WebVR.
  51734. */
  51735. xrTestDone: boolean;
  51736. /**
  51737. * Instantiates a VRExperienceHelper.
  51738. * Helps to quickly add VR support to an existing scene.
  51739. * @param scene The scene the VRExperienceHelper belongs to.
  51740. * @param webVROptions Options to modify the vr experience helper's behavior.
  51741. */
  51742. constructor(scene: Scene,
  51743. /** Options to modify the vr experience helper's behavior. */
  51744. webVROptions?: VRExperienceHelperOptions);
  51745. private completeVRInit;
  51746. private _onDefaultMeshLoaded;
  51747. private _onResize;
  51748. private _onFullscreenChange;
  51749. /**
  51750. * Gets a value indicating if we are currently in VR mode.
  51751. */
  51752. get isInVRMode(): boolean;
  51753. private onVrDisplayPresentChange;
  51754. private onVRDisplayChanged;
  51755. private moveButtonToBottomRight;
  51756. private displayVRButton;
  51757. private updateButtonVisibility;
  51758. private _cachedAngularSensibility;
  51759. /**
  51760. * Attempt to enter VR. If a headset is connected and ready, will request present on that.
  51761. * Otherwise, will use the fullscreen API.
  51762. */
  51763. enterVR(): void;
  51764. /**
  51765. * Attempt to exit VR, or fullscreen.
  51766. */
  51767. exitVR(): void;
  51768. /**
  51769. * The position of the vr experience helper.
  51770. */
  51771. get position(): Vector3;
  51772. /**
  51773. * Sets the position of the vr experience helper.
  51774. */
  51775. set position(value: Vector3);
  51776. /**
  51777. * Enables controllers and user interactions such as selecting and object or clicking on an object.
  51778. */
  51779. enableInteractions(): void;
  51780. private get _noControllerIsActive();
  51781. private beforeRender;
  51782. private _isTeleportationFloor;
  51783. /**
  51784. * Adds a floor mesh to be used for teleportation.
  51785. * @param floorMesh the mesh to be used for teleportation.
  51786. */
  51787. addFloorMesh(floorMesh: Mesh): void;
  51788. /**
  51789. * Removes a floor mesh from being used for teleportation.
  51790. * @param floorMesh the mesh to be removed.
  51791. */
  51792. removeFloorMesh(floorMesh: Mesh): void;
  51793. /**
  51794. * Enables interactions and teleportation using the VR controllers and gaze.
  51795. * @param vrTeleportationOptions options to modify teleportation behavior.
  51796. */
  51797. enableTeleportation(vrTeleportationOptions?: VRTeleportationOptions): void;
  51798. private _onNewGamepadConnected;
  51799. private _tryEnableInteractionOnController;
  51800. private _onNewGamepadDisconnected;
  51801. private _enableInteractionOnController;
  51802. private _checkTeleportWithRay;
  51803. private _checkRotate;
  51804. private _checkTeleportBackwards;
  51805. private _enableTeleportationOnController;
  51806. private _createTeleportationCircles;
  51807. private _displayTeleportationTarget;
  51808. private _hideTeleportationTarget;
  51809. private _rotateCamera;
  51810. private _moveTeleportationSelectorTo;
  51811. private _workingVector;
  51812. private _workingQuaternion;
  51813. private _workingMatrix;
  51814. /**
  51815. * Time Constant Teleportation Mode
  51816. */
  51817. static readonly TELEPORTATIONMODE_CONSTANTTIME: number;
  51818. /**
  51819. * Speed Constant Teleportation Mode
  51820. */
  51821. static readonly TELEPORTATIONMODE_CONSTANTSPEED: number;
  51822. /**
  51823. * Teleports the users feet to the desired location
  51824. * @param location The location where the user's feet should be placed
  51825. */
  51826. teleportCamera(location: Vector3): void;
  51827. private _convertNormalToDirectionOfRay;
  51828. private _castRayAndSelectObject;
  51829. private _notifySelectedMeshUnselected;
  51830. /**
  51831. * Permanently set new colors for the laser pointer
  51832. * @param color the new laser color
  51833. * @param pickedColor the new laser color when picked mesh detected
  51834. */
  51835. setLaserColor(color: Color3, pickedColor?: Color3): void;
  51836. /**
  51837. * Set lighting enabled / disabled on the laser pointer of both controllers
  51838. * @param enabled should the lighting be enabled on the laser pointer
  51839. */
  51840. setLaserLightingState(enabled?: boolean): void;
  51841. /**
  51842. * Permanently set new colors for the gaze pointer
  51843. * @param color the new gaze color
  51844. * @param pickedColor the new gaze color when picked mesh detected
  51845. */
  51846. setGazeColor(color: Color3, pickedColor?: Color3): void;
  51847. /**
  51848. * Sets the color of the laser ray from the vr controllers.
  51849. * @param color new color for the ray.
  51850. */
  51851. changeLaserColor(color: Color3): void;
  51852. /**
  51853. * Sets the color of the ray from the vr headsets gaze.
  51854. * @param color new color for the ray.
  51855. */
  51856. changeGazeColor(color: Color3): void;
  51857. /**
  51858. * Exits VR and disposes of the vr experience helper
  51859. */
  51860. dispose(): void;
  51861. /**
  51862. * Gets the name of the VRExperienceHelper class
  51863. * @returns "VRExperienceHelper"
  51864. */
  51865. getClassName(): string;
  51866. }
  51867. }
  51868. declare module "babylonjs/Cameras/VR/index" {
  51869. export * from "babylonjs/Cameras/VR/vrCameraMetrics";
  51870. export * from "babylonjs/Cameras/VR/vrDeviceOrientationArcRotateCamera";
  51871. export * from "babylonjs/Cameras/VR/vrDeviceOrientationFreeCamera";
  51872. export * from "babylonjs/Cameras/VR/vrDeviceOrientationGamepadCamera";
  51873. export * from "babylonjs/Cameras/VR/vrExperienceHelper";
  51874. export * from "babylonjs/Cameras/VR/webVRCamera";
  51875. }
  51876. declare module "babylonjs/Cameras/RigModes/index" {
  51877. export * from "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  51878. export * from "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  51879. export * from "babylonjs/Cameras/RigModes/vrRigMode";
  51880. export * from "babylonjs/Cameras/RigModes/webVRRigMode";
  51881. }
  51882. declare module "babylonjs/Cameras/index" {
  51883. export * from "babylonjs/Cameras/Inputs/index";
  51884. export * from "babylonjs/Cameras/cameraInputsManager";
  51885. export * from "babylonjs/Cameras/camera";
  51886. export * from "babylonjs/Cameras/targetCamera";
  51887. export * from "babylonjs/Cameras/freeCamera";
  51888. export * from "babylonjs/Cameras/freeCameraInputsManager";
  51889. export * from "babylonjs/Cameras/touchCamera";
  51890. export * from "babylonjs/Cameras/arcRotateCamera";
  51891. export * from "babylonjs/Cameras/arcRotateCameraInputsManager";
  51892. export * from "babylonjs/Cameras/deviceOrientationCamera";
  51893. export * from "babylonjs/Cameras/flyCamera";
  51894. export * from "babylonjs/Cameras/flyCameraInputsManager";
  51895. export * from "babylonjs/Cameras/followCamera";
  51896. export * from "babylonjs/Cameras/followCameraInputsManager";
  51897. export * from "babylonjs/Cameras/gamepadCamera";
  51898. export * from "babylonjs/Cameras/Stereoscopic/index";
  51899. export * from "babylonjs/Cameras/universalCamera";
  51900. export * from "babylonjs/Cameras/virtualJoysticksCamera";
  51901. export * from "babylonjs/Cameras/VR/index";
  51902. export * from "babylonjs/Cameras/RigModes/index";
  51903. }
  51904. declare module "babylonjs/Collisions/index" {
  51905. export * from "babylonjs/Collisions/collider";
  51906. export * from "babylonjs/Collisions/collisionCoordinator";
  51907. export * from "babylonjs/Collisions/pickingInfo";
  51908. export * from "babylonjs/Collisions/intersectionInfo";
  51909. export * from "babylonjs/Collisions/meshCollisionData";
  51910. }
  51911. declare module "babylonjs/Culling/Octrees/octreeBlock" {
  51912. import { SmartArrayNoDuplicate } from "babylonjs/Misc/smartArray";
  51913. import { Vector3 } from "babylonjs/Maths/math.vector";
  51914. import { Ray } from "babylonjs/Culling/ray";
  51915. import { Plane } from "babylonjs/Maths/math.plane";
  51916. /**
  51917. * Contains an array of blocks representing the octree
  51918. */
  51919. export interface IOctreeContainer<T> {
  51920. /**
  51921. * Blocks within the octree
  51922. */
  51923. blocks: Array<OctreeBlock<T>>;
  51924. }
  51925. /**
  51926. * Class used to store a cell in an octree
  51927. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  51928. */
  51929. export class OctreeBlock<T> {
  51930. /**
  51931. * Gets the content of the current block
  51932. */
  51933. entries: T[];
  51934. /**
  51935. * Gets the list of block children
  51936. */
  51937. blocks: Array<OctreeBlock<T>>;
  51938. private _depth;
  51939. private _maxDepth;
  51940. private _capacity;
  51941. private _minPoint;
  51942. private _maxPoint;
  51943. private _boundingVectors;
  51944. private _creationFunc;
  51945. /**
  51946. * Creates a new block
  51947. * @param minPoint defines the minimum vector (in world space) of the block's bounding box
  51948. * @param maxPoint defines the maximum vector (in world space) of the block's bounding box
  51949. * @param capacity defines the maximum capacity of this block (if capacity is reached the block will be split into sub blocks)
  51950. * @param depth defines the current depth of this block in the octree
  51951. * @param maxDepth defines the maximal depth allowed (beyond this value, the capacity is ignored)
  51952. * @param creationFunc defines a callback to call when an element is added to the block
  51953. */
  51954. constructor(minPoint: Vector3, maxPoint: Vector3, capacity: number, depth: number, maxDepth: number, creationFunc: (entry: T, block: OctreeBlock<T>) => void);
  51955. /**
  51956. * Gets the maximum capacity of this block (if capacity is reached the block will be split into sub blocks)
  51957. */
  51958. get capacity(): number;
  51959. /**
  51960. * Gets the minimum vector (in world space) of the block's bounding box
  51961. */
  51962. get minPoint(): Vector3;
  51963. /**
  51964. * Gets the maximum vector (in world space) of the block's bounding box
  51965. */
  51966. get maxPoint(): Vector3;
  51967. /**
  51968. * Add a new element to this block
  51969. * @param entry defines the element to add
  51970. */
  51971. addEntry(entry: T): void;
  51972. /**
  51973. * Remove an element from this block
  51974. * @param entry defines the element to remove
  51975. */
  51976. removeEntry(entry: T): void;
  51977. /**
  51978. * Add an array of elements to this block
  51979. * @param entries defines the array of elements to add
  51980. */
  51981. addEntries(entries: T[]): void;
  51982. /**
  51983. * Test if the current block intersects the furstum planes and if yes, then add its content to the selection array
  51984. * @param frustumPlanes defines the frustum planes to test
  51985. * @param selection defines the array to store current content if selection is positive
  51986. * @param allowDuplicate defines if the selection array can contains duplicated entries
  51987. */
  51988. select(frustumPlanes: Plane[], selection: SmartArrayNoDuplicate<T>, allowDuplicate?: boolean): void;
  51989. /**
  51990. * Test if the current block intersect with the given bounding sphere and if yes, then add its content to the selection array
  51991. * @param sphereCenter defines the bounding sphere center
  51992. * @param sphereRadius defines the bounding sphere radius
  51993. * @param selection defines the array to store current content if selection is positive
  51994. * @param allowDuplicate defines if the selection array can contains duplicated entries
  51995. */
  51996. intersects(sphereCenter: Vector3, sphereRadius: number, selection: SmartArrayNoDuplicate<T>, allowDuplicate?: boolean): void;
  51997. /**
  51998. * Test if the current block intersect with the given ray and if yes, then add its content to the selection array
  51999. * @param ray defines the ray to test with
  52000. * @param selection defines the array to store current content if selection is positive
  52001. */
  52002. intersectsRay(ray: Ray, selection: SmartArrayNoDuplicate<T>): void;
  52003. /**
  52004. * Subdivide the content into child blocks (this block will then be empty)
  52005. */
  52006. createInnerBlocks(): void;
  52007. /**
  52008. * @hidden
  52009. */
  52010. 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;
  52011. }
  52012. }
  52013. declare module "babylonjs/Culling/Octrees/octree" {
  52014. import { SmartArray } from "babylonjs/Misc/smartArray";
  52015. import { Vector3 } from "babylonjs/Maths/math.vector";
  52016. import { SubMesh } from "babylonjs/Meshes/subMesh";
  52017. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  52018. import { Ray } from "babylonjs/Culling/ray";
  52019. import { OctreeBlock } from "babylonjs/Culling/Octrees/octreeBlock";
  52020. import { Plane } from "babylonjs/Maths/math.plane";
  52021. /**
  52022. * Octrees are a really powerful data structure that can quickly select entities based on space coordinates.
  52023. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  52024. */
  52025. export class Octree<T> {
  52026. /** 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.) */
  52027. maxDepth: number;
  52028. /**
  52029. * Blocks within the octree containing objects
  52030. */
  52031. blocks: Array<OctreeBlock<T>>;
  52032. /**
  52033. * Content stored in the octree
  52034. */
  52035. dynamicContent: T[];
  52036. private _maxBlockCapacity;
  52037. private _selectionContent;
  52038. private _creationFunc;
  52039. /**
  52040. * Creates a octree
  52041. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  52042. * @param creationFunc function to be used to instatiate the octree
  52043. * @param maxBlockCapacity defines the maximum number of meshes you want on your octree's leaves (default: 64)
  52044. * @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.)
  52045. */
  52046. constructor(creationFunc: (entry: T, block: OctreeBlock<T>) => void, maxBlockCapacity?: number,
  52047. /** 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.) */
  52048. maxDepth?: number);
  52049. /**
  52050. * Updates the octree by adding blocks for the passed in meshes within the min and max world parameters
  52051. * @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);
  52052. * @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);
  52053. * @param entries meshes to be added to the octree blocks
  52054. */
  52055. update(worldMin: Vector3, worldMax: Vector3, entries: T[]): void;
  52056. /**
  52057. * Adds a mesh to the octree
  52058. * @param entry Mesh to add to the octree
  52059. */
  52060. addMesh(entry: T): void;
  52061. /**
  52062. * Remove an element from the octree
  52063. * @param entry defines the element to remove
  52064. */
  52065. removeMesh(entry: T): void;
  52066. /**
  52067. * Selects an array of meshes within the frustum
  52068. * @param frustumPlanes The frustum planes to use which will select all meshes within it
  52069. * @param allowDuplicate If duplicate objects are allowed in the resulting object array
  52070. * @returns array of meshes within the frustum
  52071. */
  52072. select(frustumPlanes: Plane[], allowDuplicate?: boolean): SmartArray<T>;
  52073. /**
  52074. * Test if the octree intersect with the given bounding sphere and if yes, then add its content to the selection array
  52075. * @param sphereCenter defines the bounding sphere center
  52076. * @param sphereRadius defines the bounding sphere radius
  52077. * @param allowDuplicate defines if the selection array can contains duplicated entries
  52078. * @returns an array of objects that intersect the sphere
  52079. */
  52080. intersects(sphereCenter: Vector3, sphereRadius: number, allowDuplicate?: boolean): SmartArray<T>;
  52081. /**
  52082. * Test if the octree intersect with the given ray and if yes, then add its content to resulting array
  52083. * @param ray defines the ray to test with
  52084. * @returns array of intersected objects
  52085. */
  52086. intersectsRay(ray: Ray): SmartArray<T>;
  52087. /**
  52088. * Adds a mesh into the octree block if it intersects the block
  52089. */
  52090. static CreationFuncForMeshes: (entry: AbstractMesh, block: OctreeBlock<AbstractMesh>) => void;
  52091. /**
  52092. * Adds a submesh into the octree block if it intersects the block
  52093. */
  52094. static CreationFuncForSubMeshes: (entry: SubMesh, block: OctreeBlock<SubMesh>) => void;
  52095. }
  52096. }
  52097. declare module "babylonjs/Culling/Octrees/octreeSceneComponent" {
  52098. import { ISmartArrayLike } from "babylonjs/Misc/smartArray";
  52099. import { Scene } from "babylonjs/scene";
  52100. import { SubMesh } from "babylonjs/Meshes/subMesh";
  52101. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  52102. import { Ray } from "babylonjs/Culling/ray";
  52103. import { Octree } from "babylonjs/Culling/Octrees/octree";
  52104. import { Collider } from "babylonjs/Collisions/collider";
  52105. module "babylonjs/scene" {
  52106. interface Scene {
  52107. /**
  52108. * @hidden
  52109. * Backing Filed
  52110. */
  52111. _selectionOctree: Octree<AbstractMesh>;
  52112. /**
  52113. * Gets the octree used to boost mesh selection (picking)
  52114. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  52115. */
  52116. selectionOctree: Octree<AbstractMesh>;
  52117. /**
  52118. * Creates or updates the octree used to boost selection (picking)
  52119. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  52120. * @param maxCapacity defines the maximum capacity per leaf
  52121. * @param maxDepth defines the maximum depth of the octree
  52122. * @returns an octree of AbstractMesh
  52123. */
  52124. createOrUpdateSelectionOctree(maxCapacity?: number, maxDepth?: number): Octree<AbstractMesh>;
  52125. }
  52126. }
  52127. module "babylonjs/Meshes/abstractMesh" {
  52128. interface AbstractMesh {
  52129. /**
  52130. * @hidden
  52131. * Backing Field
  52132. */
  52133. _submeshesOctree: Octree<SubMesh>;
  52134. /**
  52135. * This function will create an octree to help to select the right submeshes for rendering, picking and collision computations.
  52136. * Please note that you must have a decent number of submeshes to get performance improvements when using an octree
  52137. * @param maxCapacity defines the maximum size of each block (64 by default)
  52138. * @param maxDepth defines the maximum depth to use (no more than 2 levels by default)
  52139. * @returns the new octree
  52140. * @see https://www.babylonjs-playground.com/#NA4OQ#12
  52141. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  52142. */
  52143. createOrUpdateSubmeshesOctree(maxCapacity?: number, maxDepth?: number): Octree<SubMesh>;
  52144. }
  52145. }
  52146. /**
  52147. * Defines the octree scene component responsible to manage any octrees
  52148. * in a given scene.
  52149. */
  52150. export class OctreeSceneComponent {
  52151. /**
  52152. * The component name help to identify the component in the list of scene components.
  52153. */
  52154. readonly name: string;
  52155. /**
  52156. * The scene the component belongs to.
  52157. */
  52158. scene: Scene;
  52159. /**
  52160. * Indicates if the meshes have been checked to make sure they are isEnabled()
  52161. */
  52162. readonly checksIsEnabled: boolean;
  52163. /**
  52164. * Creates a new instance of the component for the given scene
  52165. * @param scene Defines the scene to register the component in
  52166. */
  52167. constructor(scene: Scene);
  52168. /**
  52169. * Registers the component in a given scene
  52170. */
  52171. register(): void;
  52172. /**
  52173. * Return the list of active meshes
  52174. * @returns the list of active meshes
  52175. */
  52176. getActiveMeshCandidates(): ISmartArrayLike<AbstractMesh>;
  52177. /**
  52178. * Return the list of active sub meshes
  52179. * @param mesh The mesh to get the candidates sub meshes from
  52180. * @returns the list of active sub meshes
  52181. */
  52182. getActiveSubMeshCandidates(mesh: AbstractMesh): ISmartArrayLike<SubMesh>;
  52183. private _tempRay;
  52184. /**
  52185. * Return the list of sub meshes intersecting with a given local ray
  52186. * @param mesh defines the mesh to find the submesh for
  52187. * @param localRay defines the ray in local space
  52188. * @returns the list of intersecting sub meshes
  52189. */
  52190. getIntersectingSubMeshCandidates(mesh: AbstractMesh, localRay: Ray): ISmartArrayLike<SubMesh>;
  52191. /**
  52192. * Return the list of sub meshes colliding with a collider
  52193. * @param mesh defines the mesh to find the submesh for
  52194. * @param collider defines the collider to evaluate the collision against
  52195. * @returns the list of colliding sub meshes
  52196. */
  52197. getCollidingSubMeshCandidates(mesh: AbstractMesh, collider: Collider): ISmartArrayLike<SubMesh>;
  52198. /**
  52199. * Rebuilds the elements related to this component in case of
  52200. * context lost for instance.
  52201. */
  52202. rebuild(): void;
  52203. /**
  52204. * Disposes the component and the associated ressources.
  52205. */
  52206. dispose(): void;
  52207. }
  52208. }
  52209. declare module "babylonjs/Culling/Octrees/index" {
  52210. export * from "babylonjs/Culling/Octrees/octree";
  52211. export * from "babylonjs/Culling/Octrees/octreeBlock";
  52212. export * from "babylonjs/Culling/Octrees/octreeSceneComponent";
  52213. }
  52214. declare module "babylonjs/Culling/index" {
  52215. export * from "babylonjs/Culling/boundingBox";
  52216. export * from "babylonjs/Culling/boundingInfo";
  52217. export * from "babylonjs/Culling/boundingSphere";
  52218. export * from "babylonjs/Culling/Octrees/index";
  52219. export * from "babylonjs/Culling/ray";
  52220. }
  52221. declare module "babylonjs/Gizmos/gizmo" {
  52222. import { Nullable } from "babylonjs/types";
  52223. import { IDisposable } from "babylonjs/scene";
  52224. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  52225. import { Mesh } from "babylonjs/Meshes/mesh";
  52226. import { Node } from "babylonjs/node";
  52227. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  52228. /**
  52229. * Renders gizmos on top of an existing scene which provide controls for position, rotation, etc.
  52230. */
  52231. export class Gizmo implements IDisposable {
  52232. /** The utility layer the gizmo will be added to */
  52233. gizmoLayer: UtilityLayerRenderer;
  52234. /**
  52235. * The root mesh of the gizmo
  52236. */
  52237. _rootMesh: Mesh;
  52238. private _attachedMesh;
  52239. private _attachedNode;
  52240. /**
  52241. * Ratio for the scale of the gizmo (Default: 1)
  52242. */
  52243. scaleRatio: number;
  52244. /**
  52245. * If a custom mesh has been set (Default: false)
  52246. */
  52247. protected _customMeshSet: boolean;
  52248. /**
  52249. * Mesh that the gizmo will be attached to. (eg. on a drag gizmo the mesh that will be dragged)
  52250. * * When set, interactions will be enabled
  52251. */
  52252. get attachedMesh(): Nullable<AbstractMesh>;
  52253. set attachedMesh(value: Nullable<AbstractMesh>);
  52254. /**
  52255. * Node that the gizmo will be attached to. (eg. on a drag gizmo the mesh, bone or NodeTransform that will be dragged)
  52256. * * When set, interactions will be enabled
  52257. */
  52258. get attachedNode(): Nullable<Node>;
  52259. set attachedNode(value: Nullable<Node>);
  52260. /**
  52261. * Disposes and replaces the current meshes in the gizmo with the specified mesh
  52262. * @param mesh The mesh to replace the default mesh of the gizmo
  52263. */
  52264. setCustomMesh(mesh: Mesh): void;
  52265. /**
  52266. * If set the gizmo's rotation will be updated to match the attached mesh each frame (Default: true)
  52267. */
  52268. updateGizmoRotationToMatchAttachedMesh: boolean;
  52269. /**
  52270. * If set the gizmo's position will be updated to match the attached mesh each frame (Default: true)
  52271. */
  52272. updateGizmoPositionToMatchAttachedMesh: boolean;
  52273. /**
  52274. * When set, the gizmo will always appear the same size no matter where the camera is (default: true)
  52275. */
  52276. updateScale: boolean;
  52277. protected _interactionsEnabled: boolean;
  52278. protected _attachedNodeChanged(value: Nullable<Node>): void;
  52279. private _beforeRenderObserver;
  52280. private _tempQuaternion;
  52281. private _tempVector;
  52282. private _tempVector2;
  52283. /**
  52284. * Creates a gizmo
  52285. * @param gizmoLayer The utility layer the gizmo will be added to
  52286. */
  52287. constructor(
  52288. /** The utility layer the gizmo will be added to */
  52289. gizmoLayer?: UtilityLayerRenderer);
  52290. /**
  52291. * Updates the gizmo to match the attached mesh's position/rotation
  52292. */
  52293. protected _update(): void;
  52294. /**
  52295. * computes the rotation/scaling/position of the transform once the Node world matrix has changed.
  52296. * @param value Node, TransformNode or mesh
  52297. */
  52298. protected _matrixChanged(): void;
  52299. /**
  52300. * Disposes of the gizmo
  52301. */
  52302. dispose(): void;
  52303. }
  52304. }
  52305. declare module "babylonjs/Gizmos/planeDragGizmo" {
  52306. import { Observable } from "babylonjs/Misc/observable";
  52307. import { Nullable } from "babylonjs/types";
  52308. import { Vector3 } from "babylonjs/Maths/math.vector";
  52309. import { Color3 } from "babylonjs/Maths/math.color";
  52310. import { TransformNode } from "babylonjs/Meshes/transformNode";
  52311. import { Node } from "babylonjs/node";
  52312. import { PointerDragBehavior } from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  52313. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  52314. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  52315. import { StandardMaterial } from "babylonjs/Materials/standardMaterial";
  52316. import { Scene } from "babylonjs/scene";
  52317. import { PositionGizmo } from "babylonjs/Gizmos/positionGizmo";
  52318. /**
  52319. * Single plane drag gizmo
  52320. */
  52321. export class PlaneDragGizmo extends Gizmo {
  52322. /**
  52323. * Drag behavior responsible for the gizmos dragging interactions
  52324. */
  52325. dragBehavior: PointerDragBehavior;
  52326. private _pointerObserver;
  52327. /**
  52328. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  52329. */
  52330. snapDistance: number;
  52331. /**
  52332. * Event that fires each time the gizmo snaps to a new location.
  52333. * * snapDistance is the the change in distance
  52334. */
  52335. onSnapObservable: Observable<{
  52336. snapDistance: number;
  52337. }>;
  52338. private _plane;
  52339. private _coloredMaterial;
  52340. private _hoverMaterial;
  52341. private _isEnabled;
  52342. private _parent;
  52343. /** @hidden */
  52344. static _CreatePlane(scene: Scene, material: StandardMaterial): TransformNode;
  52345. /** @hidden */
  52346. static _CreateArrowInstance(scene: Scene, arrow: TransformNode): TransformNode;
  52347. /**
  52348. * Creates a PlaneDragGizmo
  52349. * @param gizmoLayer The utility layer the gizmo will be added to
  52350. * @param dragPlaneNormal The axis normal to which the gizmo will be able to drag on
  52351. * @param color The color of the gizmo
  52352. */
  52353. constructor(dragPlaneNormal: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<PositionGizmo>);
  52354. protected _attachedNodeChanged(value: Nullable<Node>): void;
  52355. /**
  52356. * If the gizmo is enabled
  52357. */
  52358. set isEnabled(value: boolean);
  52359. get isEnabled(): boolean;
  52360. /**
  52361. * Disposes of the gizmo
  52362. */
  52363. dispose(): void;
  52364. }
  52365. }
  52366. declare module "babylonjs/Gizmos/positionGizmo" {
  52367. import { Observable } from "babylonjs/Misc/observable";
  52368. import { Nullable } from "babylonjs/types";
  52369. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  52370. import { Node } from "babylonjs/node";
  52371. import { Mesh } from "babylonjs/Meshes/mesh";
  52372. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  52373. import { AxisDragGizmo } from "babylonjs/Gizmos/axisDragGizmo";
  52374. import { PlaneDragGizmo } from "babylonjs/Gizmos/planeDragGizmo";
  52375. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  52376. /**
  52377. * Gizmo that enables dragging a mesh along 3 axis
  52378. */
  52379. export class PositionGizmo extends Gizmo {
  52380. /**
  52381. * Internal gizmo used for interactions on the x axis
  52382. */
  52383. xGizmo: AxisDragGizmo;
  52384. /**
  52385. * Internal gizmo used for interactions on the y axis
  52386. */
  52387. yGizmo: AxisDragGizmo;
  52388. /**
  52389. * Internal gizmo used for interactions on the z axis
  52390. */
  52391. zGizmo: AxisDragGizmo;
  52392. /**
  52393. * Internal gizmo used for interactions on the yz plane
  52394. */
  52395. xPlaneGizmo: PlaneDragGizmo;
  52396. /**
  52397. * Internal gizmo used for interactions on the xz plane
  52398. */
  52399. yPlaneGizmo: PlaneDragGizmo;
  52400. /**
  52401. * Internal gizmo used for interactions on the xy plane
  52402. */
  52403. zPlaneGizmo: PlaneDragGizmo;
  52404. /**
  52405. * private variables
  52406. */
  52407. private _meshAttached;
  52408. private _nodeAttached;
  52409. private _updateGizmoRotationToMatchAttachedMesh;
  52410. private _snapDistance;
  52411. private _scaleRatio;
  52412. /** Fires an event when any of it's sub gizmos are dragged */
  52413. onDragStartObservable: Observable<unknown>;
  52414. /** Fires an event when any of it's sub gizmos are released from dragging */
  52415. onDragEndObservable: Observable<unknown>;
  52416. /**
  52417. * If set to true, planar drag is enabled
  52418. */
  52419. private _planarGizmoEnabled;
  52420. get attachedMesh(): Nullable<AbstractMesh>;
  52421. set attachedMesh(mesh: Nullable<AbstractMesh>);
  52422. get attachedNode(): Nullable<Node>;
  52423. set attachedNode(node: Nullable<Node>);
  52424. /**
  52425. * Creates a PositionGizmo
  52426. * @param gizmoLayer The utility layer the gizmo will be added to
  52427. @param thickness display gizmo axis thickness
  52428. */
  52429. constructor(gizmoLayer?: UtilityLayerRenderer, thickness?: number);
  52430. /**
  52431. * If the planar drag gizmo is enabled
  52432. * setting this will enable/disable XY, XZ and YZ planes regardless of individual gizmo settings.
  52433. */
  52434. set planarGizmoEnabled(value: boolean);
  52435. get planarGizmoEnabled(): boolean;
  52436. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  52437. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  52438. /**
  52439. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  52440. */
  52441. set snapDistance(value: number);
  52442. get snapDistance(): number;
  52443. /**
  52444. * Ratio for the scale of the gizmo (Default: 1)
  52445. */
  52446. set scaleRatio(value: number);
  52447. get scaleRatio(): number;
  52448. /**
  52449. * Disposes of the gizmo
  52450. */
  52451. dispose(): void;
  52452. /**
  52453. * CustomMeshes are not supported by this gizmo
  52454. * @param mesh The mesh to replace the default mesh of the gizmo
  52455. */
  52456. setCustomMesh(mesh: Mesh): void;
  52457. }
  52458. }
  52459. declare module "babylonjs/Gizmos/axisDragGizmo" {
  52460. import { Observable } from "babylonjs/Misc/observable";
  52461. import { Nullable } from "babylonjs/types";
  52462. import { Vector3 } from "babylonjs/Maths/math.vector";
  52463. import { TransformNode } from "babylonjs/Meshes/transformNode";
  52464. import { Node } from "babylonjs/node";
  52465. import { PointerDragBehavior } from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  52466. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  52467. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  52468. import { StandardMaterial } from "babylonjs/Materials/standardMaterial";
  52469. import { Scene } from "babylonjs/scene";
  52470. import { PositionGizmo } from "babylonjs/Gizmos/positionGizmo";
  52471. import { Color3 } from "babylonjs/Maths/math.color";
  52472. /**
  52473. * Single axis drag gizmo
  52474. */
  52475. export class AxisDragGizmo extends Gizmo {
  52476. /**
  52477. * Drag behavior responsible for the gizmos dragging interactions
  52478. */
  52479. dragBehavior: PointerDragBehavior;
  52480. private _pointerObserver;
  52481. /**
  52482. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  52483. */
  52484. snapDistance: number;
  52485. /**
  52486. * Event that fires each time the gizmo snaps to a new location.
  52487. * * snapDistance is the the change in distance
  52488. */
  52489. onSnapObservable: Observable<{
  52490. snapDistance: number;
  52491. }>;
  52492. private _isEnabled;
  52493. private _parent;
  52494. private _arrow;
  52495. private _coloredMaterial;
  52496. private _hoverMaterial;
  52497. /** @hidden */
  52498. static _CreateArrow(scene: Scene, material: StandardMaterial, thickness?: number): TransformNode;
  52499. /** @hidden */
  52500. static _CreateArrowInstance(scene: Scene, arrow: TransformNode): TransformNode;
  52501. /**
  52502. * Creates an AxisDragGizmo
  52503. * @param gizmoLayer The utility layer the gizmo will be added to
  52504. * @param dragAxis The axis which the gizmo will be able to drag on
  52505. * @param color The color of the gizmo
  52506. * @param thickness display gizmo axis thickness
  52507. */
  52508. constructor(dragAxis: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<PositionGizmo>, thickness?: number);
  52509. protected _attachedNodeChanged(value: Nullable<Node>): void;
  52510. /**
  52511. * If the gizmo is enabled
  52512. */
  52513. set isEnabled(value: boolean);
  52514. get isEnabled(): boolean;
  52515. /**
  52516. * Disposes of the gizmo
  52517. */
  52518. dispose(): void;
  52519. }
  52520. }
  52521. declare module "babylonjs/Debug/axesViewer" {
  52522. import { Vector3 } from "babylonjs/Maths/math.vector";
  52523. import { Nullable } from "babylonjs/types";
  52524. import { Scene } from "babylonjs/scene";
  52525. import { TransformNode } from "babylonjs/Meshes/transformNode";
  52526. /**
  52527. * The Axes viewer will show 3 axes in a specific point in space
  52528. */
  52529. export class AxesViewer {
  52530. private _xAxis;
  52531. private _yAxis;
  52532. private _zAxis;
  52533. private _scaleLinesFactor;
  52534. private _instanced;
  52535. /**
  52536. * Gets the hosting scene
  52537. */
  52538. scene: Scene;
  52539. /**
  52540. * Gets or sets a number used to scale line length
  52541. */
  52542. scaleLines: number;
  52543. /** Gets the node hierarchy used to render x-axis */
  52544. get xAxis(): TransformNode;
  52545. /** Gets the node hierarchy used to render y-axis */
  52546. get yAxis(): TransformNode;
  52547. /** Gets the node hierarchy used to render z-axis */
  52548. get zAxis(): TransformNode;
  52549. /**
  52550. * Creates a new AxesViewer
  52551. * @param scene defines the hosting scene
  52552. * @param scaleLines defines a number used to scale line length (1 by default)
  52553. * @param renderingGroupId defines a number used to set the renderingGroupId of the meshes (2 by default)
  52554. * @param xAxis defines the node hierarchy used to render the x-axis
  52555. * @param yAxis defines the node hierarchy used to render the y-axis
  52556. * @param zAxis defines the node hierarchy used to render the z-axis
  52557. */
  52558. constructor(scene: Scene, scaleLines?: number, renderingGroupId?: Nullable<number>, xAxis?: TransformNode, yAxis?: TransformNode, zAxis?: TransformNode);
  52559. /**
  52560. * Force the viewer to update
  52561. * @param position defines the position of the viewer
  52562. * @param xaxis defines the x axis of the viewer
  52563. * @param yaxis defines the y axis of the viewer
  52564. * @param zaxis defines the z axis of the viewer
  52565. */
  52566. update(position: Vector3, xaxis: Vector3, yaxis: Vector3, zaxis: Vector3): void;
  52567. /**
  52568. * Creates an instance of this axes viewer.
  52569. * @returns a new axes viewer with instanced meshes
  52570. */
  52571. createInstance(): AxesViewer;
  52572. /** Releases resources */
  52573. dispose(): void;
  52574. private static _SetRenderingGroupId;
  52575. }
  52576. }
  52577. declare module "babylonjs/Debug/boneAxesViewer" {
  52578. import { Nullable } from "babylonjs/types";
  52579. import { AxesViewer } from "babylonjs/Debug/axesViewer";
  52580. import { Vector3 } from "babylonjs/Maths/math.vector";
  52581. import { Mesh } from "babylonjs/Meshes/mesh";
  52582. import { Bone } from "babylonjs/Bones/bone";
  52583. import { Scene } from "babylonjs/scene";
  52584. /**
  52585. * The BoneAxesViewer will attach 3 axes to a specific bone of a specific mesh
  52586. * @see demo here: https://www.babylonjs-playground.com/#0DE8F4#8
  52587. */
  52588. export class BoneAxesViewer extends AxesViewer {
  52589. /**
  52590. * Gets or sets the target mesh where to display the axes viewer
  52591. */
  52592. mesh: Nullable<Mesh>;
  52593. /**
  52594. * Gets or sets the target bone where to display the axes viewer
  52595. */
  52596. bone: Nullable<Bone>;
  52597. /** Gets current position */
  52598. pos: Vector3;
  52599. /** Gets direction of X axis */
  52600. xaxis: Vector3;
  52601. /** Gets direction of Y axis */
  52602. yaxis: Vector3;
  52603. /** Gets direction of Z axis */
  52604. zaxis: Vector3;
  52605. /**
  52606. * Creates a new BoneAxesViewer
  52607. * @param scene defines the hosting scene
  52608. * @param bone defines the target bone
  52609. * @param mesh defines the target mesh
  52610. * @param scaleLines defines a scaling factor for line length (1 by default)
  52611. */
  52612. constructor(scene: Scene, bone: Bone, mesh: Mesh, scaleLines?: number);
  52613. /**
  52614. * Force the viewer to update
  52615. */
  52616. update(): void;
  52617. /** Releases resources */
  52618. dispose(): void;
  52619. }
  52620. }
  52621. declare module "babylonjs/Debug/debugLayer" {
  52622. import { Scene } from "babylonjs/scene";
  52623. /**
  52624. * Interface used to define scene explorer extensibility option
  52625. */
  52626. export interface IExplorerExtensibilityOption {
  52627. /**
  52628. * Define the option label
  52629. */
  52630. label: string;
  52631. /**
  52632. * Defines the action to execute on click
  52633. */
  52634. action: (entity: any) => void;
  52635. }
  52636. /**
  52637. * Defines a group of actions associated with a predicate to use when extending the Inspector scene explorer
  52638. */
  52639. export interface IExplorerExtensibilityGroup {
  52640. /**
  52641. * Defines a predicate to test if a given type mut be extended
  52642. */
  52643. predicate: (entity: any) => boolean;
  52644. /**
  52645. * Gets the list of options added to a type
  52646. */
  52647. entries: IExplorerExtensibilityOption[];
  52648. }
  52649. /**
  52650. * Interface used to define the options to use to create the Inspector
  52651. */
  52652. export interface IInspectorOptions {
  52653. /**
  52654. * Display in overlay mode (default: false)
  52655. */
  52656. overlay?: boolean;
  52657. /**
  52658. * HTML element to use as root (the parent of the rendering canvas will be used as default value)
  52659. */
  52660. globalRoot?: HTMLElement;
  52661. /**
  52662. * Display the Scene explorer
  52663. */
  52664. showExplorer?: boolean;
  52665. /**
  52666. * Display the property inspector
  52667. */
  52668. showInspector?: boolean;
  52669. /**
  52670. * Display in embed mode (both panes on the right)
  52671. */
  52672. embedMode?: boolean;
  52673. /**
  52674. * let the Inspector handles resize of the canvas when panes are resized (default to true)
  52675. */
  52676. handleResize?: boolean;
  52677. /**
  52678. * Allow the panes to popup (default: true)
  52679. */
  52680. enablePopup?: boolean;
  52681. /**
  52682. * Allow the panes to be closed by users (default: true)
  52683. */
  52684. enableClose?: boolean;
  52685. /**
  52686. * Optional list of extensibility entries
  52687. */
  52688. explorerExtensibility?: IExplorerExtensibilityGroup[];
  52689. /**
  52690. * Optional URL to get the inspector script from (by default it uses the babylonjs CDN).
  52691. */
  52692. inspectorURL?: string;
  52693. /**
  52694. * Optional initial tab (default to DebugLayerTab.Properties)
  52695. */
  52696. initialTab?: DebugLayerTab;
  52697. }
  52698. module "babylonjs/scene" {
  52699. interface Scene {
  52700. /**
  52701. * @hidden
  52702. * Backing field
  52703. */
  52704. _debugLayer: DebugLayer;
  52705. /**
  52706. * Gets the debug layer (aka Inspector) associated with the scene
  52707. * @see https://doc.babylonjs.com/features/playground_debuglayer
  52708. */
  52709. debugLayer: DebugLayer;
  52710. }
  52711. }
  52712. /**
  52713. * Enum of inspector action tab
  52714. */
  52715. export enum DebugLayerTab {
  52716. /**
  52717. * Properties tag (default)
  52718. */
  52719. Properties = 0,
  52720. /**
  52721. * Debug tab
  52722. */
  52723. Debug = 1,
  52724. /**
  52725. * Statistics tab
  52726. */
  52727. Statistics = 2,
  52728. /**
  52729. * Tools tab
  52730. */
  52731. Tools = 3,
  52732. /**
  52733. * Settings tab
  52734. */
  52735. Settings = 4
  52736. }
  52737. /**
  52738. * The debug layer (aka Inspector) is the go to tool in order to better understand
  52739. * what is happening in your scene
  52740. * @see https://doc.babylonjs.com/features/playground_debuglayer
  52741. */
  52742. export class DebugLayer {
  52743. /**
  52744. * Define the url to get the inspector script from.
  52745. * By default it uses the babylonjs CDN.
  52746. * @ignoreNaming
  52747. */
  52748. static InspectorURL: string;
  52749. private _scene;
  52750. private BJSINSPECTOR;
  52751. private _onPropertyChangedObservable?;
  52752. /**
  52753. * Observable triggered when a property is changed through the inspector.
  52754. */
  52755. get onPropertyChangedObservable(): any;
  52756. /**
  52757. * Instantiates a new debug layer.
  52758. * The debug layer (aka Inspector) is the go to tool in order to better understand
  52759. * what is happening in your scene
  52760. * @see https://doc.babylonjs.com/features/playground_debuglayer
  52761. * @param scene Defines the scene to inspect
  52762. */
  52763. constructor(scene: Scene);
  52764. /** Creates the inspector window. */
  52765. private _createInspector;
  52766. /**
  52767. * Select a specific entity in the scene explorer and highlight a specific block in that entity property grid
  52768. * @param entity defines the entity to select
  52769. * @param lineContainerTitles defines the specific blocks to highlight (could be a string or an array of strings)
  52770. */
  52771. select(entity: any, lineContainerTitles?: string | string[]): void;
  52772. /** Get the inspector from bundle or global */
  52773. private _getGlobalInspector;
  52774. /**
  52775. * Get if the inspector is visible or not.
  52776. * @returns true if visible otherwise, false
  52777. */
  52778. isVisible(): boolean;
  52779. /**
  52780. * Hide the inspector and close its window.
  52781. */
  52782. hide(): void;
  52783. /**
  52784. * Update the scene in the inspector
  52785. */
  52786. setAsActiveScene(): void;
  52787. /**
  52788. * Launch the debugLayer.
  52789. * @param config Define the configuration of the inspector
  52790. * @return a promise fulfilled when the debug layer is visible
  52791. */
  52792. show(config?: IInspectorOptions): Promise<DebugLayer>;
  52793. }
  52794. }
  52795. declare module "babylonjs/Meshes/Builders/boxBuilder" {
  52796. import { Nullable } from "babylonjs/types";
  52797. import { Scene } from "babylonjs/scene";
  52798. import { Vector4 } from "babylonjs/Maths/math.vector";
  52799. import { Color4 } from "babylonjs/Maths/math.color";
  52800. import { Mesh } from "babylonjs/Meshes/mesh";
  52801. /**
  52802. * Class containing static functions to help procedurally build meshes
  52803. */
  52804. export class BoxBuilder {
  52805. /**
  52806. * Creates a box mesh
  52807. * * The parameter `size` sets the size (float) of each box side (default 1)
  52808. * * You can set some different box dimensions by using the parameters `width`, `height` and `depth` (all by default have the same value of `size`)
  52809. * * 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)
  52810. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  52811. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  52812. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  52813. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  52814. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  52815. * @param name defines the name of the mesh
  52816. * @param options defines the options used to create the mesh
  52817. * @param scene defines the hosting scene
  52818. * @returns the box mesh
  52819. */
  52820. static CreateBox(name: string, options: {
  52821. size?: number;
  52822. width?: number;
  52823. height?: number;
  52824. depth?: number;
  52825. faceUV?: Vector4[];
  52826. faceColors?: Color4[];
  52827. sideOrientation?: number;
  52828. frontUVs?: Vector4;
  52829. backUVs?: Vector4;
  52830. wrap?: boolean;
  52831. topBaseAt?: number;
  52832. bottomBaseAt?: number;
  52833. updatable?: boolean;
  52834. }, scene?: Nullable<Scene>): Mesh;
  52835. }
  52836. }
  52837. declare module "babylonjs/Debug/physicsViewer" {
  52838. import { Nullable } from "babylonjs/types";
  52839. import { Scene } from "babylonjs/scene";
  52840. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  52841. import { Mesh } from "babylonjs/Meshes/mesh";
  52842. import { IPhysicsEnginePlugin } from "babylonjs/Physics/IPhysicsEngine";
  52843. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  52844. /**
  52845. * Used to show the physics impostor around the specific mesh
  52846. */
  52847. export class PhysicsViewer {
  52848. /** @hidden */
  52849. protected _impostors: Array<Nullable<PhysicsImpostor>>;
  52850. /** @hidden */
  52851. protected _meshes: Array<Nullable<AbstractMesh>>;
  52852. /** @hidden */
  52853. protected _scene: Nullable<Scene>;
  52854. /** @hidden */
  52855. protected _numMeshes: number;
  52856. /** @hidden */
  52857. protected _physicsEnginePlugin: Nullable<IPhysicsEnginePlugin>;
  52858. private _renderFunction;
  52859. private _utilityLayer;
  52860. private _debugBoxMesh;
  52861. private _debugSphereMesh;
  52862. private _debugCylinderMesh;
  52863. private _debugMaterial;
  52864. private _debugMeshMeshes;
  52865. /**
  52866. * Creates a new PhysicsViewer
  52867. * @param scene defines the hosting scene
  52868. */
  52869. constructor(scene: Scene);
  52870. /** @hidden */
  52871. protected _updateDebugMeshes(): void;
  52872. /**
  52873. * Renders a specified physic impostor
  52874. * @param impostor defines the impostor to render
  52875. * @param targetMesh defines the mesh represented by the impostor
  52876. * @returns the new debug mesh used to render the impostor
  52877. */
  52878. showImpostor(impostor: PhysicsImpostor, targetMesh?: Mesh): Nullable<AbstractMesh>;
  52879. /**
  52880. * Hides a specified physic impostor
  52881. * @param impostor defines the impostor to hide
  52882. */
  52883. hideImpostor(impostor: Nullable<PhysicsImpostor>): void;
  52884. private _getDebugMaterial;
  52885. private _getDebugBoxMesh;
  52886. private _getDebugSphereMesh;
  52887. private _getDebugCylinderMesh;
  52888. private _getDebugMeshMesh;
  52889. private _getDebugMesh;
  52890. /** Releases all resources */
  52891. dispose(): void;
  52892. }
  52893. }
  52894. declare module "babylonjs/Debug/rayHelper" {
  52895. import { Nullable } from "babylonjs/types";
  52896. import { Ray } from "babylonjs/Culling/ray";
  52897. import { Vector3 } from "babylonjs/Maths/math.vector";
  52898. import { Color3 } from "babylonjs/Maths/math.color";
  52899. import { Scene } from "babylonjs/scene";
  52900. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  52901. import "babylonjs/Meshes/Builders/linesBuilder";
  52902. /**
  52903. * As raycast might be hard to debug, the RayHelper can help rendering the different rays
  52904. * in order to better appreciate the issue one might have.
  52905. * @see https://doc.babylonjs.com/babylon101/raycasts#debugging
  52906. */
  52907. export class RayHelper {
  52908. /**
  52909. * Defines the ray we are currently tryin to visualize.
  52910. */
  52911. ray: Nullable<Ray>;
  52912. private _renderPoints;
  52913. private _renderLine;
  52914. private _renderFunction;
  52915. private _scene;
  52916. private _onAfterRenderObserver;
  52917. private _onAfterStepObserver;
  52918. private _attachedToMesh;
  52919. private _meshSpaceDirection;
  52920. private _meshSpaceOrigin;
  52921. /**
  52922. * Helper function to create a colored helper in a scene in one line.
  52923. * @param ray Defines the ray we are currently tryin to visualize
  52924. * @param scene Defines the scene the ray is used in
  52925. * @param color Defines the color we want to see the ray in
  52926. * @returns The newly created ray helper.
  52927. */
  52928. static CreateAndShow(ray: Ray, scene: Scene, color: Color3): RayHelper;
  52929. /**
  52930. * Instantiate a new ray helper.
  52931. * As raycast might be hard to debug, the RayHelper can help rendering the different rays
  52932. * in order to better appreciate the issue one might have.
  52933. * @see https://doc.babylonjs.com/babylon101/raycasts#debugging
  52934. * @param ray Defines the ray we are currently tryin to visualize
  52935. */
  52936. constructor(ray: Ray);
  52937. /**
  52938. * Shows the ray we are willing to debug.
  52939. * @param scene Defines the scene the ray needs to be rendered in
  52940. * @param color Defines the color the ray needs to be rendered in
  52941. */
  52942. show(scene: Scene, color?: Color3): void;
  52943. /**
  52944. * Hides the ray we are debugging.
  52945. */
  52946. hide(): void;
  52947. private _render;
  52948. /**
  52949. * Attach a ray helper to a mesh so that we can easily see its orientation for instance or information like its normals.
  52950. * @param mesh Defines the mesh we want the helper attached to
  52951. * @param meshSpaceDirection Defines the direction of the Ray in mesh space (local space of the mesh node)
  52952. * @param meshSpaceOrigin Defines the origin of the Ray in mesh space (local space of the mesh node)
  52953. * @param length Defines the length of the ray
  52954. */
  52955. attachToMesh(mesh: AbstractMesh, meshSpaceDirection?: Vector3, meshSpaceOrigin?: Vector3, length?: number): void;
  52956. /**
  52957. * Detach the ray helper from the mesh it has previously been attached to.
  52958. */
  52959. detachFromMesh(): void;
  52960. private _updateToMesh;
  52961. /**
  52962. * Dispose the helper and release its associated resources.
  52963. */
  52964. dispose(): void;
  52965. }
  52966. }
  52967. declare module "babylonjs/Debug/ISkeletonViewer" {
  52968. /**
  52969. * Defines the options associated with the creation of a SkeletonViewer.
  52970. */
  52971. export interface ISkeletonViewerOptions {
  52972. /** Should the system pause animations before building the Viewer? */
  52973. pauseAnimations: boolean;
  52974. /** Should the system return the skeleton to rest before building? */
  52975. returnToRest: boolean;
  52976. /** public Display Mode of the Viewer */
  52977. displayMode: number;
  52978. /** Flag to toggle if the Viewer should use the CPU for animations or not? */
  52979. displayOptions: ISkeletonViewerDisplayOptions;
  52980. /** Flag to toggle if the Viewer should use the CPU for animations or not? */
  52981. computeBonesUsingShaders: boolean;
  52982. }
  52983. /**
  52984. * Defines how to display the various bone meshes for the viewer.
  52985. */
  52986. export interface ISkeletonViewerDisplayOptions {
  52987. /** How far down to start tapering the bone spurs */
  52988. midStep?: number;
  52989. /** How big is the midStep? */
  52990. midStepFactor?: number;
  52991. /** Base for the Sphere Size */
  52992. sphereBaseSize?: number;
  52993. /** The ratio of the sphere to the longest bone in units */
  52994. sphereScaleUnit?: number;
  52995. /** Ratio for the Sphere Size */
  52996. sphereFactor?: number;
  52997. }
  52998. }
  52999. declare module "babylonjs/Meshes/Builders/ribbonBuilder" {
  53000. import { Nullable } from "babylonjs/types";
  53001. import { Scene } from "babylonjs/scene";
  53002. import { Vector3, Vector2, Vector4 } from "babylonjs/Maths/math.vector";
  53003. import { Color4 } from "babylonjs/Maths/math.color";
  53004. import { Mesh } from "babylonjs/Meshes/mesh";
  53005. /**
  53006. * Class containing static functions to help procedurally build meshes
  53007. */
  53008. export class RibbonBuilder {
  53009. /**
  53010. * Creates a ribbon mesh. The ribbon is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  53011. * * The parameter `pathArray` is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry
  53012. * * The parameter `closeArray` (boolean, default false) creates a seam between the first and the last paths of the path array
  53013. * * The parameter `closePath` (boolean, default false) creates a seam between the first and the last points of each path of the path array
  53014. * * 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
  53015. * * 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
  53016. * * 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
  53017. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  53018. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  53019. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  53020. * * 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
  53021. * * The parameters `colors` is an optional flat array of `Color4` to set/update each ribbon vertex with its own custom color values
  53022. * * 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
  53023. * * Moreover, you can use the parameter `color` with `instance` (to update the ribbon), only if you previously used it at creation time
  53024. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  53025. * @param name defines the name of the mesh
  53026. * @param options defines the options used to create the mesh
  53027. * @param scene defines the hosting scene
  53028. * @returns the ribbon mesh
  53029. * @see https://doc.babylonjs.com/how_to/ribbon_tutorial
  53030. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  53031. */
  53032. static CreateRibbon(name: string, options: {
  53033. pathArray: Vector3[][];
  53034. closeArray?: boolean;
  53035. closePath?: boolean;
  53036. offset?: number;
  53037. updatable?: boolean;
  53038. sideOrientation?: number;
  53039. frontUVs?: Vector4;
  53040. backUVs?: Vector4;
  53041. instance?: Mesh;
  53042. invertUV?: boolean;
  53043. uvs?: Vector2[];
  53044. colors?: Color4[];
  53045. }, scene?: Nullable<Scene>): Mesh;
  53046. }
  53047. }
  53048. declare module "babylonjs/Meshes/Builders/shapeBuilder" {
  53049. import { Nullable } from "babylonjs/types";
  53050. import { Scene } from "babylonjs/scene";
  53051. import { Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  53052. import { Mesh } from "babylonjs/Meshes/mesh";
  53053. /**
  53054. * Class containing static functions to help procedurally build meshes
  53055. */
  53056. export class ShapeBuilder {
  53057. /**
  53058. * 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.
  53059. * * 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.
  53060. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  53061. * * 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.
  53062. * * The parameter `scale` (float, default 1) is the value to scale the shape.
  53063. * * 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
  53064. * * 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
  53065. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape.
  53066. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  53067. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  53068. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture.
  53069. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  53070. * @param name defines the name of the mesh
  53071. * @param options defines the options used to create the mesh
  53072. * @param scene defines the hosting scene
  53073. * @returns the extruded shape mesh
  53074. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  53075. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  53076. */
  53077. static ExtrudeShape(name: string, options: {
  53078. shape: Vector3[];
  53079. path: Vector3[];
  53080. scale?: number;
  53081. rotation?: number;
  53082. cap?: number;
  53083. updatable?: boolean;
  53084. sideOrientation?: number;
  53085. frontUVs?: Vector4;
  53086. backUVs?: Vector4;
  53087. instance?: Mesh;
  53088. invertUV?: boolean;
  53089. }, scene?: Nullable<Scene>): Mesh;
  53090. /**
  53091. * Creates an custom extruded shape mesh.
  53092. * The custom extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  53093. * * 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.
  53094. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  53095. * * 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
  53096. * * It must returns a float value that will be the rotation in radians applied to the shape on each path point.
  53097. * * 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
  53098. * * It must returns a float value that will be the scale value applied to the shape on each path point
  53099. * * The parameter `ribbonClosePath` (boolean, default false) forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  53100. * * The parameter `ribbonCloseArray` (boolean, default false) forces the extrusion underlying ribbon to close its `pathArray`
  53101. * * 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
  53102. * * 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
  53103. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape
  53104. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  53105. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  53106. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  53107. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  53108. * @param name defines the name of the mesh
  53109. * @param options defines the options used to create the mesh
  53110. * @param scene defines the hosting scene
  53111. * @returns the custom extruded shape mesh
  53112. * @see https://doc.babylonjs.com/how_to/parametric_shapes#custom-extruded-shapes
  53113. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  53114. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  53115. */
  53116. static ExtrudeShapeCustom(name: string, options: {
  53117. shape: Vector3[];
  53118. path: Vector3[];
  53119. scaleFunction?: any;
  53120. rotationFunction?: any;
  53121. ribbonCloseArray?: boolean;
  53122. ribbonClosePath?: boolean;
  53123. cap?: number;
  53124. updatable?: boolean;
  53125. sideOrientation?: number;
  53126. frontUVs?: Vector4;
  53127. backUVs?: Vector4;
  53128. instance?: Mesh;
  53129. invertUV?: boolean;
  53130. }, scene?: Nullable<Scene>): Mesh;
  53131. private static _ExtrudeShapeGeneric;
  53132. }
  53133. }
  53134. declare module "babylonjs/Debug/skeletonViewer" {
  53135. import { Color3 } from "babylonjs/Maths/math.color";
  53136. import { Scene } from "babylonjs/scene";
  53137. import { Nullable } from "babylonjs/types";
  53138. import { Skeleton } from "babylonjs/Bones/skeleton";
  53139. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  53140. import { LinesMesh } from "babylonjs/Meshes/linesMesh";
  53141. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  53142. import { StandardMaterial } from "babylonjs/Materials/standardMaterial";
  53143. import { ISkeletonViewerOptions } from "babylonjs/Debug/ISkeletonViewer";
  53144. /**
  53145. * Class used to render a debug view of a given skeleton
  53146. * @see http://www.babylonjs-playground.com/#1BZJVJ#8
  53147. */
  53148. export class SkeletonViewer {
  53149. /** defines the skeleton to render */
  53150. skeleton: Skeleton;
  53151. /** defines the mesh attached to the skeleton */
  53152. mesh: AbstractMesh;
  53153. /** defines a boolean indicating if bones matrices must be forced to update before rendering (true by default) */
  53154. autoUpdateBonesMatrices: boolean;
  53155. /** defines the rendering group id to use with the viewer */
  53156. renderingGroupId: number;
  53157. /** is the options for the viewer */
  53158. options: Partial<ISkeletonViewerOptions>;
  53159. /** public Display constants BABYLON.SkeletonViewer.DISPLAY_LINES */
  53160. static readonly DISPLAY_LINES: number;
  53161. /** public Display constants BABYLON.SkeletonViewer.DISPLAY_SPHERES */
  53162. static readonly DISPLAY_SPHERES: number;
  53163. /** public Display constants BABYLON.SkeletonViewer.DISPLAY_SPHERE_AND_SPURS */
  53164. static readonly DISPLAY_SPHERE_AND_SPURS: number;
  53165. /** If SkeletonViewer scene scope. */
  53166. private _scene;
  53167. /** Gets or sets the color used to render the skeleton */
  53168. color: Color3;
  53169. /** Array of the points of the skeleton fo the line view. */
  53170. private _debugLines;
  53171. /** The SkeletonViewers Mesh. */
  53172. private _debugMesh;
  53173. /** If SkeletonViewer is enabled. */
  53174. private _isEnabled;
  53175. /** If SkeletonViewer is ready. */
  53176. private _ready;
  53177. /** SkeletonViewer render observable. */
  53178. private _obs;
  53179. /** The Utility Layer to render the gizmos in. */
  53180. private _utilityLayer;
  53181. private _boneIndices;
  53182. /** Gets the Scene. */
  53183. get scene(): Scene;
  53184. /** Gets the utilityLayer. */
  53185. get utilityLayer(): Nullable<UtilityLayerRenderer>;
  53186. /** Checks Ready Status. */
  53187. get isReady(): Boolean;
  53188. /** Sets Ready Status. */
  53189. set ready(value: boolean);
  53190. /** Gets the debugMesh */
  53191. get debugMesh(): Nullable<AbstractMesh> | Nullable<LinesMesh>;
  53192. /** Sets the debugMesh */
  53193. set debugMesh(value: Nullable<AbstractMesh> | Nullable<LinesMesh>);
  53194. /** Gets the material */
  53195. get material(): StandardMaterial;
  53196. /** Sets the material */
  53197. set material(value: StandardMaterial);
  53198. /** Gets the material */
  53199. get displayMode(): number;
  53200. /** Sets the material */
  53201. set displayMode(value: number);
  53202. /**
  53203. * Creates a new SkeletonViewer
  53204. * @param skeleton defines the skeleton to render
  53205. * @param mesh defines the mesh attached to the skeleton
  53206. * @param scene defines the hosting scene
  53207. * @param autoUpdateBonesMatrices defines a boolean indicating if bones matrices must be forced to update before rendering (true by default)
  53208. * @param renderingGroupId defines the rendering group id to use with the viewer
  53209. * @param options All of the extra constructor options for the SkeletonViewer
  53210. */
  53211. constructor(
  53212. /** defines the skeleton to render */
  53213. skeleton: Skeleton,
  53214. /** defines the mesh attached to the skeleton */
  53215. mesh: AbstractMesh,
  53216. /** The Scene scope*/
  53217. scene: Scene,
  53218. /** defines a boolean indicating if bones matrices must be forced to update before rendering (true by default) */
  53219. autoUpdateBonesMatrices?: boolean,
  53220. /** defines the rendering group id to use with the viewer */
  53221. renderingGroupId?: number,
  53222. /** is the options for the viewer */
  53223. options?: Partial<ISkeletonViewerOptions>);
  53224. /** The Dynamic bindings for the update functions */
  53225. private _bindObs;
  53226. /** Update the viewer to sync with current skeleton state, only used to manually update. */
  53227. update(): void;
  53228. /** Gets or sets a boolean indicating if the viewer is enabled */
  53229. set isEnabled(value: boolean);
  53230. get isEnabled(): boolean;
  53231. private _getBonePosition;
  53232. private _getLinesForBonesWithLength;
  53233. private _getLinesForBonesNoLength;
  53234. /** function to revert the mesh and scene back to the initial state. */
  53235. private _revert;
  53236. /** function to build and bind sphere joint points and spur bone representations. */
  53237. private _buildSpheresAndSpurs;
  53238. /** Update the viewer to sync with current skeleton state, only used for the line display. */
  53239. private _displayLinesUpdate;
  53240. /** Changes the displayMode of the skeleton viewer
  53241. * @param mode The displayMode numerical value
  53242. */
  53243. changeDisplayMode(mode: number): void;
  53244. /** Changes the displayMode of the skeleton viewer
  53245. * @param option String of the option name
  53246. * @param value The numerical option value
  53247. */
  53248. changeDisplayOptions(option: string, value: number): void;
  53249. /** Release associated resources */
  53250. dispose(): void;
  53251. }
  53252. }
  53253. declare module "babylonjs/Debug/index" {
  53254. export * from "babylonjs/Debug/axesViewer";
  53255. export * from "babylonjs/Debug/boneAxesViewer";
  53256. export * from "babylonjs/Debug/debugLayer";
  53257. export * from "babylonjs/Debug/physicsViewer";
  53258. export * from "babylonjs/Debug/rayHelper";
  53259. export * from "babylonjs/Debug/skeletonViewer";
  53260. export * from "babylonjs/Debug/ISkeletonViewer";
  53261. }
  53262. declare module "babylonjs/DeviceInput/InputDevices/deviceEnums" {
  53263. /**
  53264. * Enum for Device Types
  53265. */
  53266. export enum DeviceType {
  53267. /** Generic */
  53268. Generic = 0,
  53269. /** Keyboard */
  53270. Keyboard = 1,
  53271. /** Mouse */
  53272. Mouse = 2,
  53273. /** Touch Pointers */
  53274. Touch = 3,
  53275. /** PS4 Dual Shock */
  53276. DualShock = 4,
  53277. /** Xbox */
  53278. Xbox = 5,
  53279. /** Switch Controller */
  53280. Switch = 6
  53281. }
  53282. /**
  53283. * Enum for All Pointers (Touch/Mouse)
  53284. */
  53285. export enum PointerInput {
  53286. /** Horizontal Axis */
  53287. Horizontal = 0,
  53288. /** Vertical Axis */
  53289. Vertical = 1,
  53290. /** Left Click or Touch */
  53291. LeftClick = 2,
  53292. /** Middle Click */
  53293. MiddleClick = 3,
  53294. /** Right Click */
  53295. RightClick = 4,
  53296. /** Browser Back */
  53297. BrowserBack = 5,
  53298. /** Browser Forward */
  53299. BrowserForward = 6
  53300. }
  53301. /**
  53302. * Enum for Dual Shock Gamepad
  53303. */
  53304. export enum DualShockInput {
  53305. /** Cross */
  53306. Cross = 0,
  53307. /** Circle */
  53308. Circle = 1,
  53309. /** Square */
  53310. Square = 2,
  53311. /** Triangle */
  53312. Triangle = 3,
  53313. /** L1 */
  53314. L1 = 4,
  53315. /** R1 */
  53316. R1 = 5,
  53317. /** L2 */
  53318. L2 = 6,
  53319. /** R2 */
  53320. R2 = 7,
  53321. /** Share */
  53322. Share = 8,
  53323. /** Options */
  53324. Options = 9,
  53325. /** L3 */
  53326. L3 = 10,
  53327. /** R3 */
  53328. R3 = 11,
  53329. /** DPadUp */
  53330. DPadUp = 12,
  53331. /** DPadDown */
  53332. DPadDown = 13,
  53333. /** DPadLeft */
  53334. DPadLeft = 14,
  53335. /** DRight */
  53336. DPadRight = 15,
  53337. /** Home */
  53338. Home = 16,
  53339. /** TouchPad */
  53340. TouchPad = 17,
  53341. /** LStickXAxis */
  53342. LStickXAxis = 18,
  53343. /** LStickYAxis */
  53344. LStickYAxis = 19,
  53345. /** RStickXAxis */
  53346. RStickXAxis = 20,
  53347. /** RStickYAxis */
  53348. RStickYAxis = 21
  53349. }
  53350. /**
  53351. * Enum for Xbox Gamepad
  53352. */
  53353. export enum XboxInput {
  53354. /** A */
  53355. A = 0,
  53356. /** B */
  53357. B = 1,
  53358. /** X */
  53359. X = 2,
  53360. /** Y */
  53361. Y = 3,
  53362. /** LB */
  53363. LB = 4,
  53364. /** RB */
  53365. RB = 5,
  53366. /** LT */
  53367. LT = 6,
  53368. /** RT */
  53369. RT = 7,
  53370. /** Back */
  53371. Back = 8,
  53372. /** Start */
  53373. Start = 9,
  53374. /** LS */
  53375. LS = 10,
  53376. /** RS */
  53377. RS = 11,
  53378. /** DPadUp */
  53379. DPadUp = 12,
  53380. /** DPadDown */
  53381. DPadDown = 13,
  53382. /** DPadLeft */
  53383. DPadLeft = 14,
  53384. /** DRight */
  53385. DPadRight = 15,
  53386. /** Home */
  53387. Home = 16,
  53388. /** LStickXAxis */
  53389. LStickXAxis = 17,
  53390. /** LStickYAxis */
  53391. LStickYAxis = 18,
  53392. /** RStickXAxis */
  53393. RStickXAxis = 19,
  53394. /** RStickYAxis */
  53395. RStickYAxis = 20
  53396. }
  53397. /**
  53398. * Enum for Switch (Pro/JoyCon L+R) Gamepad
  53399. */
  53400. export enum SwitchInput {
  53401. /** B */
  53402. B = 0,
  53403. /** A */
  53404. A = 1,
  53405. /** Y */
  53406. Y = 2,
  53407. /** X */
  53408. X = 3,
  53409. /** L */
  53410. L = 4,
  53411. /** R */
  53412. R = 5,
  53413. /** ZL */
  53414. ZL = 6,
  53415. /** ZR */
  53416. ZR = 7,
  53417. /** Minus */
  53418. Minus = 8,
  53419. /** Plus */
  53420. Plus = 9,
  53421. /** LS */
  53422. LS = 10,
  53423. /** RS */
  53424. RS = 11,
  53425. /** DPadUp */
  53426. DPadUp = 12,
  53427. /** DPadDown */
  53428. DPadDown = 13,
  53429. /** DPadLeft */
  53430. DPadLeft = 14,
  53431. /** DRight */
  53432. DPadRight = 15,
  53433. /** Home */
  53434. Home = 16,
  53435. /** Capture */
  53436. Capture = 17,
  53437. /** LStickXAxis */
  53438. LStickXAxis = 18,
  53439. /** LStickYAxis */
  53440. LStickYAxis = 19,
  53441. /** RStickXAxis */
  53442. RStickXAxis = 20,
  53443. /** RStickYAxis */
  53444. RStickYAxis = 21
  53445. }
  53446. }
  53447. declare module "babylonjs/DeviceInput/deviceInputSystem" {
  53448. import { Engine } from "babylonjs/Engines/engine";
  53449. import { IDisposable } from "babylonjs/scene";
  53450. import { Nullable } from "babylonjs/types";
  53451. import { DeviceType } from "babylonjs/DeviceInput/InputDevices/deviceEnums";
  53452. /**
  53453. * This class will take all inputs from Keyboard, Pointer, and
  53454. * any Gamepads and provide a polling system that all devices
  53455. * will use. This class assumes that there will only be one
  53456. * pointer device and one keyboard.
  53457. */
  53458. export class DeviceInputSystem implements IDisposable {
  53459. /**
  53460. * Callback to be triggered when a device is connected
  53461. */
  53462. onDeviceConnected: (deviceType: DeviceType, deviceSlot: number) => void;
  53463. /**
  53464. * Callback to be triggered when a device is disconnected
  53465. */
  53466. onDeviceDisconnected: (deviceType: DeviceType, deviceSlot: number) => void;
  53467. /**
  53468. * Callback to be triggered when event driven input is updated
  53469. */
  53470. onInputChanged: (deviceType: DeviceType, deviceSlot: number, inputIndex: number, previousState: Nullable<number>, currentState: Nullable<number>) => void;
  53471. private _inputs;
  53472. private _gamepads;
  53473. private _keyboardActive;
  53474. private _pointerActive;
  53475. private _elementToAttachTo;
  53476. private _keyboardDownEvent;
  53477. private _keyboardUpEvent;
  53478. private _pointerMoveEvent;
  53479. private _pointerDownEvent;
  53480. private _pointerUpEvent;
  53481. private _gamepadConnectedEvent;
  53482. private _gamepadDisconnectedEvent;
  53483. private static _MAX_KEYCODES;
  53484. private static _MAX_POINTER_INPUTS;
  53485. private constructor();
  53486. /**
  53487. * Creates a new DeviceInputSystem instance
  53488. * @param engine Engine to pull input element from
  53489. * @returns The new instance
  53490. */
  53491. static Create(engine: Engine): DeviceInputSystem;
  53492. /**
  53493. * Checks for current device input value, given an id and input index
  53494. * @param deviceName Id of connected device
  53495. * @param inputIndex Index of device input
  53496. * @returns Current value of input
  53497. */
  53498. /**
  53499. * Checks for current device input value, given an id and input index. Throws exception if requested device not initialized.
  53500. * @param deviceType Enum specifiying device type
  53501. * @param deviceSlot "Slot" or index that device is referenced in
  53502. * @param inputIndex Id of input to be checked
  53503. * @returns Current value of input
  53504. */
  53505. pollInput(deviceType: DeviceType, deviceSlot: number, inputIndex: number): number;
  53506. /**
  53507. * Dispose of all the eventlisteners
  53508. */
  53509. dispose(): void;
  53510. /**
  53511. * Add device and inputs to device array
  53512. * @param deviceType Enum specifiying device type
  53513. * @param deviceSlot "Slot" or index that device is referenced in
  53514. * @param numberOfInputs Number of input entries to create for given device
  53515. */
  53516. private _registerDevice;
  53517. /**
  53518. * Given a specific device name, remove that device from the device map
  53519. * @param deviceType Enum specifiying device type
  53520. * @param deviceSlot "Slot" or index that device is referenced in
  53521. */
  53522. private _unregisterDevice;
  53523. /**
  53524. * Handle all actions that come from keyboard interaction
  53525. */
  53526. private _handleKeyActions;
  53527. /**
  53528. * Handle all actions that come from pointer interaction
  53529. */
  53530. private _handlePointerActions;
  53531. /**
  53532. * Handle all actions that come from gamepad interaction
  53533. */
  53534. private _handleGamepadActions;
  53535. /**
  53536. * Update all non-event based devices with each frame
  53537. * @param deviceType Enum specifiying device type
  53538. * @param deviceSlot "Slot" or index that device is referenced in
  53539. * @param inputIndex Id of input to be checked
  53540. */
  53541. private _updateDevice;
  53542. /**
  53543. * Gets DeviceType from the device name
  53544. * @param deviceName Name of Device from DeviceInputSystem
  53545. * @returns DeviceType enum value
  53546. */
  53547. private _getGamepadDeviceType;
  53548. }
  53549. }
  53550. declare module "babylonjs/DeviceInput/InputDevices/deviceTypes" {
  53551. import { DeviceType, PointerInput, DualShockInput, XboxInput, SwitchInput } from "babylonjs/DeviceInput/InputDevices/deviceEnums";
  53552. /**
  53553. * Type to handle enforcement of inputs
  53554. */
  53555. 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;
  53556. }
  53557. declare module "babylonjs/DeviceInput/InputDevices/deviceSourceManager" {
  53558. import { DeviceInputSystem } from "babylonjs/DeviceInput/deviceInputSystem";
  53559. import { Engine } from "babylonjs/Engines/engine";
  53560. import { IDisposable } from "babylonjs/scene";
  53561. import { DeviceType } from "babylonjs/DeviceInput/InputDevices/deviceEnums";
  53562. import { Nullable } from "babylonjs/types";
  53563. import { Observable } from "babylonjs/Misc/observable";
  53564. import { DeviceInput } from "babylonjs/DeviceInput/InputDevices/deviceTypes";
  53565. /**
  53566. * Class that handles all input for a specific device
  53567. */
  53568. export class DeviceSource<T extends DeviceType> {
  53569. /** Type of device */
  53570. readonly deviceType: DeviceType;
  53571. /** "Slot" or index that device is referenced in */
  53572. readonly deviceSlot: number;
  53573. /**
  53574. * Observable to handle device input changes per device
  53575. */
  53576. readonly onInputChangedObservable: Observable<{
  53577. inputIndex: DeviceInput<T>;
  53578. previousState: Nullable<number>;
  53579. currentState: Nullable<number>;
  53580. }>;
  53581. private readonly _deviceInputSystem;
  53582. /**
  53583. * Default Constructor
  53584. * @param deviceInputSystem Reference to DeviceInputSystem
  53585. * @param deviceType Type of device
  53586. * @param deviceSlot "Slot" or index that device is referenced in
  53587. */
  53588. constructor(deviceInputSystem: DeviceInputSystem,
  53589. /** Type of device */
  53590. deviceType: DeviceType,
  53591. /** "Slot" or index that device is referenced in */
  53592. deviceSlot?: number);
  53593. /**
  53594. * Get input for specific input
  53595. * @param inputIndex index of specific input on device
  53596. * @returns Input value from DeviceInputSystem
  53597. */
  53598. getInput(inputIndex: DeviceInput<T>): Nullable<number>;
  53599. }
  53600. /**
  53601. * Class to keep track of devices
  53602. */
  53603. export class DeviceSourceManager implements IDisposable {
  53604. /**
  53605. * Observable to be triggered when before a device is connected
  53606. */
  53607. readonly onBeforeDeviceConnectedObservable: Observable<{
  53608. deviceType: DeviceType;
  53609. deviceSlot: number;
  53610. }>;
  53611. /**
  53612. * Observable to be triggered when before a device is disconnected
  53613. */
  53614. readonly onBeforeDeviceDisconnectedObservable: Observable<{
  53615. deviceType: DeviceType;
  53616. deviceSlot: number;
  53617. }>;
  53618. /**
  53619. * Observable to be triggered when after a device is connected
  53620. */
  53621. readonly onAfterDeviceConnectedObservable: Observable<{
  53622. deviceType: DeviceType;
  53623. deviceSlot: number;
  53624. }>;
  53625. /**
  53626. * Observable to be triggered when after a device is disconnected
  53627. */
  53628. readonly onAfterDeviceDisconnectedObservable: Observable<{
  53629. deviceType: DeviceType;
  53630. deviceSlot: number;
  53631. }>;
  53632. private readonly _devices;
  53633. private readonly _firstDevice;
  53634. private readonly _deviceInputSystem;
  53635. /**
  53636. * Default Constructor
  53637. * @param engine engine to pull input element from
  53638. */
  53639. constructor(engine: Engine);
  53640. /**
  53641. * Gets a DeviceSource, given a type and slot
  53642. * @param deviceType Enum specifying device type
  53643. * @param deviceSlot "Slot" or index that device is referenced in
  53644. * @returns DeviceSource object
  53645. */
  53646. getDeviceSource<T extends DeviceType>(deviceType: T, deviceSlot?: number): Nullable<DeviceSource<T>>;
  53647. /**
  53648. * Gets an array of DeviceSource objects for a given device type
  53649. * @param deviceType Enum specifying device type
  53650. * @returns Array of DeviceSource objects
  53651. */
  53652. getDeviceSources<T extends DeviceType>(deviceType: T): ReadonlyArray<DeviceSource<T>>;
  53653. /**
  53654. * Dispose of DeviceInputSystem and other parts
  53655. */
  53656. dispose(): void;
  53657. /**
  53658. * Function to add device name to device list
  53659. * @param deviceType Enum specifying device type
  53660. * @param deviceSlot "Slot" or index that device is referenced in
  53661. */
  53662. private _addDevice;
  53663. /**
  53664. * Function to remove device name to device list
  53665. * @param deviceType Enum specifying device type
  53666. * @param deviceSlot "Slot" or index that device is referenced in
  53667. */
  53668. private _removeDevice;
  53669. /**
  53670. * Updates array storing first connected device of each type
  53671. * @param type Type of Device
  53672. */
  53673. private _updateFirstDevices;
  53674. }
  53675. }
  53676. declare module "babylonjs/DeviceInput/index" {
  53677. export * from "babylonjs/DeviceInput/deviceInputSystem";
  53678. export * from "babylonjs/DeviceInput/InputDevices/deviceEnums";
  53679. export * from "babylonjs/DeviceInput/InputDevices/deviceTypes";
  53680. import "babylonjs/DeviceInput/InputDevices/deviceSourceManager";
  53681. export * from "babylonjs/DeviceInput/InputDevices/deviceSourceManager";
  53682. }
  53683. declare module "babylonjs/Engines/nullEngine" {
  53684. import { Nullable, FloatArray, IndicesArray } from "babylonjs/types";
  53685. import { Engine } from "babylonjs/Engines/engine";
  53686. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  53687. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  53688. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  53689. import { Effect } from "babylonjs/Materials/effect";
  53690. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  53691. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  53692. import { IColor4Like, IViewportLike } from "babylonjs/Maths/math.like";
  53693. import { ISceneLike } from "babylonjs/Engines/thinEngine";
  53694. /**
  53695. * Options to create the null engine
  53696. */
  53697. export class NullEngineOptions {
  53698. /**
  53699. * Render width (Default: 512)
  53700. */
  53701. renderWidth: number;
  53702. /**
  53703. * Render height (Default: 256)
  53704. */
  53705. renderHeight: number;
  53706. /**
  53707. * Texture size (Default: 512)
  53708. */
  53709. textureSize: number;
  53710. /**
  53711. * If delta time between frames should be constant
  53712. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  53713. */
  53714. deterministicLockstep: boolean;
  53715. /**
  53716. * Maximum about of steps between frames (Default: 4)
  53717. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  53718. */
  53719. lockstepMaxSteps: number;
  53720. /**
  53721. * Make the matrix computations to be performed in 64 bits instead of 32 bits. False by default
  53722. */
  53723. useHighPrecisionMatrix?: boolean;
  53724. }
  53725. /**
  53726. * The null engine class provides support for headless version of babylon.js.
  53727. * This can be used in server side scenario or for testing purposes
  53728. */
  53729. export class NullEngine extends Engine {
  53730. private _options;
  53731. /**
  53732. * Gets a boolean indicating that the engine is running in deterministic lock step mode
  53733. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  53734. * @returns true if engine is in deterministic lock step mode
  53735. */
  53736. isDeterministicLockStep(): boolean;
  53737. /**
  53738. * Gets the max steps when engine is running in deterministic lock step
  53739. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  53740. * @returns the max steps
  53741. */
  53742. getLockstepMaxSteps(): number;
  53743. /**
  53744. * Gets the current hardware scaling level.
  53745. * By default the hardware scaling level is computed from the window device ratio.
  53746. * 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.
  53747. * @returns a number indicating the current hardware scaling level
  53748. */
  53749. getHardwareScalingLevel(): number;
  53750. constructor(options?: NullEngineOptions);
  53751. /**
  53752. * Creates a vertex buffer
  53753. * @param vertices the data for the vertex buffer
  53754. * @returns the new WebGL static buffer
  53755. */
  53756. createVertexBuffer(vertices: FloatArray): DataBuffer;
  53757. /**
  53758. * Creates a new index buffer
  53759. * @param indices defines the content of the index buffer
  53760. * @param updatable defines if the index buffer must be updatable
  53761. * @returns a new webGL buffer
  53762. */
  53763. createIndexBuffer(indices: IndicesArray): DataBuffer;
  53764. /**
  53765. * Clear the current render buffer or the current render target (if any is set up)
  53766. * @param color defines the color to use
  53767. * @param backBuffer defines if the back buffer must be cleared
  53768. * @param depth defines if the depth buffer must be cleared
  53769. * @param stencil defines if the stencil buffer must be cleared
  53770. */
  53771. clear(color: IColor4Like, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  53772. /**
  53773. * Gets the current render width
  53774. * @param useScreen defines if screen size must be used (or the current render target if any)
  53775. * @returns a number defining the current render width
  53776. */
  53777. getRenderWidth(useScreen?: boolean): number;
  53778. /**
  53779. * Gets the current render height
  53780. * @param useScreen defines if screen size must be used (or the current render target if any)
  53781. * @returns a number defining the current render height
  53782. */
  53783. getRenderHeight(useScreen?: boolean): number;
  53784. /**
  53785. * Set the WebGL's viewport
  53786. * @param viewport defines the viewport element to be used
  53787. * @param requiredWidth defines the width required for rendering. If not provided the rendering canvas' width is used
  53788. * @param requiredHeight defines the height required for rendering. If not provided the rendering canvas' height is used
  53789. */
  53790. setViewport(viewport: IViewportLike, requiredWidth?: number, requiredHeight?: number): void;
  53791. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: string, context?: WebGLRenderingContext): WebGLProgram;
  53792. /**
  53793. * Gets the list of webGL uniform locations associated with a specific program based on a list of uniform names
  53794. * @param pipelineContext defines the pipeline context to use
  53795. * @param uniformsNames defines the list of uniform names
  53796. * @returns an array of webGL uniform locations
  53797. */
  53798. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): Nullable<WebGLUniformLocation>[];
  53799. /**
  53800. * Gets the lsit of active attributes for a given webGL program
  53801. * @param pipelineContext defines the pipeline context to use
  53802. * @param attributesNames defines the list of attribute names to get
  53803. * @returns an array of indices indicating the offset of each attribute
  53804. */
  53805. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  53806. /**
  53807. * Binds an effect to the webGL context
  53808. * @param effect defines the effect to bind
  53809. */
  53810. bindSamplers(effect: Effect): void;
  53811. /**
  53812. * Activates an effect, mkaing it the current one (ie. the one used for rendering)
  53813. * @param effect defines the effect to activate
  53814. */
  53815. enableEffect(effect: Effect): void;
  53816. /**
  53817. * Set various states to the webGL context
  53818. * @param culling defines backface culling state
  53819. * @param zOffset defines the value to apply to zOffset (0 by default)
  53820. * @param force defines if states must be applied even if cache is up to date
  53821. * @param reverseSide defines if culling must be reversed (CCW instead of CW and CW instead of CCW)
  53822. */
  53823. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  53824. /**
  53825. * Set the value of an uniform to an array of int32
  53826. * @param uniform defines the webGL uniform location where to store the value
  53827. * @param array defines the array of int32 to store
  53828. */
  53829. setIntArray(uniform: WebGLUniformLocation, array: Int32Array): void;
  53830. /**
  53831. * Set the value of an uniform to an array of int32 (stored as vec2)
  53832. * @param uniform defines the webGL uniform location where to store the value
  53833. * @param array defines the array of int32 to store
  53834. */
  53835. setIntArray2(uniform: WebGLUniformLocation, array: Int32Array): void;
  53836. /**
  53837. * Set the value of an uniform to an array of int32 (stored as vec3)
  53838. * @param uniform defines the webGL uniform location where to store the value
  53839. * @param array defines the array of int32 to store
  53840. */
  53841. setIntArray3(uniform: WebGLUniformLocation, array: Int32Array): void;
  53842. /**
  53843. * Set the value of an uniform to an array of int32 (stored as vec4)
  53844. * @param uniform defines the webGL uniform location where to store the value
  53845. * @param array defines the array of int32 to store
  53846. */
  53847. setIntArray4(uniform: WebGLUniformLocation, array: Int32Array): void;
  53848. /**
  53849. * Set the value of an uniform to an array of float32
  53850. * @param uniform defines the webGL uniform location where to store the value
  53851. * @param array defines the array of float32 to store
  53852. */
  53853. setFloatArray(uniform: WebGLUniformLocation, array: Float32Array): void;
  53854. /**
  53855. * Set the value of an uniform to an array of float32 (stored as vec2)
  53856. * @param uniform defines the webGL uniform location where to store the value
  53857. * @param array defines the array of float32 to store
  53858. */
  53859. setFloatArray2(uniform: WebGLUniformLocation, array: Float32Array): void;
  53860. /**
  53861. * Set the value of an uniform to an array of float32 (stored as vec3)
  53862. * @param uniform defines the webGL uniform location where to store the value
  53863. * @param array defines the array of float32 to store
  53864. */
  53865. setFloatArray3(uniform: WebGLUniformLocation, array: Float32Array): void;
  53866. /**
  53867. * Set the value of an uniform to an array of float32 (stored as vec4)
  53868. * @param uniform defines the webGL uniform location where to store the value
  53869. * @param array defines the array of float32 to store
  53870. */
  53871. setFloatArray4(uniform: WebGLUniformLocation, array: Float32Array): void;
  53872. /**
  53873. * Set the value of an uniform to an array of number
  53874. * @param uniform defines the webGL uniform location where to store the value
  53875. * @param array defines the array of number to store
  53876. */
  53877. setArray(uniform: WebGLUniformLocation, array: number[]): void;
  53878. /**
  53879. * Set the value of an uniform to an array of number (stored as vec2)
  53880. * @param uniform defines the webGL uniform location where to store the value
  53881. * @param array defines the array of number to store
  53882. */
  53883. setArray2(uniform: WebGLUniformLocation, array: number[]): void;
  53884. /**
  53885. * Set the value of an uniform to an array of number (stored as vec3)
  53886. * @param uniform defines the webGL uniform location where to store the value
  53887. * @param array defines the array of number to store
  53888. */
  53889. setArray3(uniform: WebGLUniformLocation, array: number[]): void;
  53890. /**
  53891. * Set the value of an uniform to an array of number (stored as vec4)
  53892. * @param uniform defines the webGL uniform location where to store the value
  53893. * @param array defines the array of number to store
  53894. */
  53895. setArray4(uniform: WebGLUniformLocation, array: number[]): void;
  53896. /**
  53897. * Set the value of an uniform to an array of float32 (stored as matrices)
  53898. * @param uniform defines the webGL uniform location where to store the value
  53899. * @param matrices defines the array of float32 to store
  53900. */
  53901. setMatrices(uniform: WebGLUniformLocation, matrices: Float32Array): void;
  53902. /**
  53903. * Set the value of an uniform to a matrix (3x3)
  53904. * @param uniform defines the webGL uniform location where to store the value
  53905. * @param matrix defines the Float32Array representing the 3x3 matrix to store
  53906. */
  53907. setMatrix3x3(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  53908. /**
  53909. * Set the value of an uniform to a matrix (2x2)
  53910. * @param uniform defines the webGL uniform location where to store the value
  53911. * @param matrix defines the Float32Array representing the 2x2 matrix to store
  53912. */
  53913. setMatrix2x2(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  53914. /**
  53915. * Set the value of an uniform to a number (float)
  53916. * @param uniform defines the webGL uniform location where to store the value
  53917. * @param value defines the float number to store
  53918. */
  53919. setFloat(uniform: WebGLUniformLocation, value: number): void;
  53920. /**
  53921. * Set the value of an uniform to a vec2
  53922. * @param uniform defines the webGL uniform location where to store the value
  53923. * @param x defines the 1st component of the value
  53924. * @param y defines the 2nd component of the value
  53925. */
  53926. setFloat2(uniform: WebGLUniformLocation, x: number, y: number): void;
  53927. /**
  53928. * Set the value of an uniform to a vec3
  53929. * @param uniform defines the webGL uniform location where to store the value
  53930. * @param x defines the 1st component of the value
  53931. * @param y defines the 2nd component of the value
  53932. * @param z defines the 3rd component of the value
  53933. */
  53934. setFloat3(uniform: WebGLUniformLocation, x: number, y: number, z: number): void;
  53935. /**
  53936. * Set the value of an uniform to a boolean
  53937. * @param uniform defines the webGL uniform location where to store the value
  53938. * @param bool defines the boolean to store
  53939. */
  53940. setBool(uniform: WebGLUniformLocation, bool: number): void;
  53941. /**
  53942. * Set the value of an uniform to a vec4
  53943. * @param uniform defines the webGL uniform location where to store the value
  53944. * @param x defines the 1st component of the value
  53945. * @param y defines the 2nd component of the value
  53946. * @param z defines the 3rd component of the value
  53947. * @param w defines the 4th component of the value
  53948. */
  53949. setFloat4(uniform: WebGLUniformLocation, x: number, y: number, z: number, w: number): void;
  53950. /**
  53951. * Sets the current alpha mode
  53952. * @param mode defines the mode to use (one of the Engine.ALPHA_XXX)
  53953. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  53954. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  53955. */
  53956. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  53957. /**
  53958. * Bind webGl buffers directly to the webGL context
  53959. * @param vertexBuffers defines the vertex buffer to bind
  53960. * @param indexBuffer defines the index buffer to bind
  53961. * @param vertexDeclaration defines the vertex declaration to use with the vertex buffer
  53962. * @param vertexStrideSize defines the vertex stride of the vertex buffer
  53963. * @param effect defines the effect associated with the vertex buffer
  53964. */
  53965. bindBuffers(vertexBuffers: {
  53966. [key: string]: VertexBuffer;
  53967. }, indexBuffer: DataBuffer, effect: Effect): void;
  53968. /**
  53969. * Force the entire cache to be cleared
  53970. * You should not have to use this function unless your engine needs to share the webGL context with another engine
  53971. * @param bruteForce defines a boolean to force clearing ALL caches (including stencil, detoh and alpha states)
  53972. */
  53973. wipeCaches(bruteForce?: boolean): void;
  53974. /**
  53975. * Send a draw order
  53976. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  53977. * @param indexStart defines the starting index
  53978. * @param indexCount defines the number of index to draw
  53979. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  53980. */
  53981. draw(useTriangles: boolean, indexStart: number, indexCount: number, instancesCount?: number): void;
  53982. /**
  53983. * Draw a list of indexed primitives
  53984. * @param fillMode defines the primitive to use
  53985. * @param indexStart defines the starting index
  53986. * @param indexCount defines the number of index to draw
  53987. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  53988. */
  53989. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  53990. /**
  53991. * Draw a list of unindexed primitives
  53992. * @param fillMode defines the primitive to use
  53993. * @param verticesStart defines the index of first vertex to draw
  53994. * @param verticesCount defines the count of vertices to draw
  53995. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  53996. */
  53997. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  53998. /** @hidden */
  53999. _createTexture(): WebGLTexture;
  54000. /** @hidden */
  54001. _releaseTexture(texture: InternalTexture): void;
  54002. /**
  54003. * Usually called from Texture.ts.
  54004. * Passed information to create a WebGLTexture
  54005. * @param urlArg defines a value which contains one of the following:
  54006. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  54007. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  54008. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  54009. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  54010. * @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)
  54011. * @param scene needed for loading to the correct scene
  54012. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  54013. * @param onLoad optional callback to be called upon successful completion
  54014. * @param onError optional callback to be called upon failure
  54015. * @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
  54016. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  54017. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  54018. * @param forcedExtension defines the extension to use to pick the right loader
  54019. * @param mimeType defines an optional mime type
  54020. * @returns a InternalTexture for assignment back into BABYLON.Texture
  54021. */
  54022. 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;
  54023. /**
  54024. * Creates a new render target texture
  54025. * @param size defines the size of the texture
  54026. * @param options defines the options used to create the texture
  54027. * @returns a new render target texture stored in an InternalTexture
  54028. */
  54029. createRenderTargetTexture(size: any, options: boolean | RenderTargetCreationOptions): InternalTexture;
  54030. /**
  54031. * Update the sampling mode of a given texture
  54032. * @param samplingMode defines the required sampling mode
  54033. * @param texture defines the texture to update
  54034. */
  54035. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  54036. /**
  54037. * Binds the frame buffer to the specified texture.
  54038. * @param texture The texture to render to or null for the default canvas
  54039. * @param faceIndex The face of the texture to render to in case of cube texture
  54040. * @param requiredWidth The width of the target to render to
  54041. * @param requiredHeight The height of the target to render to
  54042. * @param forceFullscreenViewport Forces the viewport to be the entire texture/screen if true
  54043. * @param lodLevel defines le lod level to bind to the frame buffer
  54044. */
  54045. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean): void;
  54046. /**
  54047. * Unbind the current render target texture from the webGL context
  54048. * @param texture defines the render target texture to unbind
  54049. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  54050. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  54051. */
  54052. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  54053. /**
  54054. * Creates a dynamic vertex buffer
  54055. * @param vertices the data for the dynamic vertex buffer
  54056. * @returns the new WebGL dynamic buffer
  54057. */
  54058. createDynamicVertexBuffer(vertices: FloatArray): DataBuffer;
  54059. /**
  54060. * Update the content of a dynamic texture
  54061. * @param texture defines the texture to update
  54062. * @param canvas defines the canvas containing the source
  54063. * @param invertY defines if data must be stored with Y axis inverted
  54064. * @param premulAlpha defines if alpha is stored as premultiplied
  54065. * @param format defines the format of the data
  54066. * @param forceBindTexture if the texture should be forced to be bound eg. after a graphics context loss (Default: false)
  54067. */
  54068. updateDynamicTexture(texture: Nullable<InternalTexture>, canvas: HTMLCanvasElement, invertY: boolean, premulAlpha?: boolean, format?: number): void;
  54069. /**
  54070. * Gets a boolean indicating if all created effects are ready
  54071. * @returns true if all effects are ready
  54072. */
  54073. areAllEffectsReady(): boolean;
  54074. /**
  54075. * @hidden
  54076. * Get the current error code of the webGL context
  54077. * @returns the error code
  54078. * @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getError
  54079. */
  54080. getError(): number;
  54081. /** @hidden */
  54082. _getUnpackAlignement(): number;
  54083. /** @hidden */
  54084. _unpackFlipY(value: boolean): void;
  54085. /**
  54086. * Update a dynamic index buffer
  54087. * @param indexBuffer defines the target index buffer
  54088. * @param indices defines the data to update
  54089. * @param offset defines the offset in the target index buffer where update should start
  54090. */
  54091. updateDynamicIndexBuffer(indexBuffer: WebGLBuffer, indices: IndicesArray, offset?: number): void;
  54092. /**
  54093. * Updates a dynamic vertex buffer.
  54094. * @param vertexBuffer the vertex buffer to update
  54095. * @param vertices the data used to update the vertex buffer
  54096. * @param byteOffset the byte offset of the data (optional)
  54097. * @param byteLength the byte length of the data (optional)
  54098. */
  54099. updateDynamicVertexBuffer(vertexBuffer: WebGLBuffer, vertices: FloatArray, byteOffset?: number, byteLength?: number): void;
  54100. /** @hidden */
  54101. _bindTextureDirectly(target: number, texture: InternalTexture): boolean;
  54102. /** @hidden */
  54103. _bindTexture(channel: number, texture: InternalTexture): void;
  54104. protected _deleteBuffer(buffer: WebGLBuffer): void;
  54105. /**
  54106. * 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
  54107. */
  54108. releaseEffects(): void;
  54109. displayLoadingUI(): void;
  54110. hideLoadingUI(): void;
  54111. /** @hidden */
  54112. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  54113. /** @hidden */
  54114. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  54115. /** @hidden */
  54116. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  54117. /** @hidden */
  54118. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement, faceIndex?: number, lod?: number): void;
  54119. }
  54120. }
  54121. declare module "babylonjs/Instrumentation/timeToken" {
  54122. import { Nullable } from "babylonjs/types";
  54123. /**
  54124. * @hidden
  54125. **/
  54126. export class _TimeToken {
  54127. _startTimeQuery: Nullable<WebGLQuery>;
  54128. _endTimeQuery: Nullable<WebGLQuery>;
  54129. _timeElapsedQuery: Nullable<WebGLQuery>;
  54130. _timeElapsedQueryEnded: boolean;
  54131. }
  54132. }
  54133. declare module "babylonjs/Engines/Extensions/engine.occlusionQuery" {
  54134. import { Nullable, int } from "babylonjs/types";
  54135. import { _TimeToken } from "babylonjs/Instrumentation/timeToken";
  54136. /** @hidden */
  54137. export class _OcclusionDataStorage {
  54138. /** @hidden */
  54139. occlusionInternalRetryCounter: number;
  54140. /** @hidden */
  54141. isOcclusionQueryInProgress: boolean;
  54142. /** @hidden */
  54143. isOccluded: boolean;
  54144. /** @hidden */
  54145. occlusionRetryCount: number;
  54146. /** @hidden */
  54147. occlusionType: number;
  54148. /** @hidden */
  54149. occlusionQueryAlgorithmType: number;
  54150. }
  54151. module "babylonjs/Engines/engine" {
  54152. interface Engine {
  54153. /**
  54154. * Create a new webGL query (you must be sure that queries are supported by checking getCaps() function)
  54155. * @return the new query
  54156. */
  54157. createQuery(): WebGLQuery;
  54158. /**
  54159. * Delete and release a webGL query
  54160. * @param query defines the query to delete
  54161. * @return the current engine
  54162. */
  54163. deleteQuery(query: WebGLQuery): Engine;
  54164. /**
  54165. * Check if a given query has resolved and got its value
  54166. * @param query defines the query to check
  54167. * @returns true if the query got its value
  54168. */
  54169. isQueryResultAvailable(query: WebGLQuery): boolean;
  54170. /**
  54171. * Gets the value of a given query
  54172. * @param query defines the query to check
  54173. * @returns the value of the query
  54174. */
  54175. getQueryResult(query: WebGLQuery): number;
  54176. /**
  54177. * Initiates an occlusion query
  54178. * @param algorithmType defines the algorithm to use
  54179. * @param query defines the query to use
  54180. * @returns the current engine
  54181. * @see https://doc.babylonjs.com/features/occlusionquery
  54182. */
  54183. beginOcclusionQuery(algorithmType: number, query: WebGLQuery): Engine;
  54184. /**
  54185. * Ends an occlusion query
  54186. * @see https://doc.babylonjs.com/features/occlusionquery
  54187. * @param algorithmType defines the algorithm to use
  54188. * @returns the current engine
  54189. */
  54190. endOcclusionQuery(algorithmType: number): Engine;
  54191. /**
  54192. * Starts a time query (used to measure time spent by the GPU on a specific frame)
  54193. * Please note that only one query can be issued at a time
  54194. * @returns a time token used to track the time span
  54195. */
  54196. startTimeQuery(): Nullable<_TimeToken>;
  54197. /**
  54198. * Ends a time query
  54199. * @param token defines the token used to measure the time span
  54200. * @returns the time spent (in ns)
  54201. */
  54202. endTimeQuery(token: _TimeToken): int;
  54203. /** @hidden */
  54204. _currentNonTimestampToken: Nullable<_TimeToken>;
  54205. /** @hidden */
  54206. _createTimeQuery(): WebGLQuery;
  54207. /** @hidden */
  54208. _deleteTimeQuery(query: WebGLQuery): void;
  54209. /** @hidden */
  54210. _getGlAlgorithmType(algorithmType: number): number;
  54211. /** @hidden */
  54212. _getTimeQueryResult(query: WebGLQuery): any;
  54213. /** @hidden */
  54214. _getTimeQueryAvailability(query: WebGLQuery): any;
  54215. }
  54216. }
  54217. module "babylonjs/Meshes/abstractMesh" {
  54218. interface AbstractMesh {
  54219. /**
  54220. * Backing filed
  54221. * @hidden
  54222. */
  54223. __occlusionDataStorage: _OcclusionDataStorage;
  54224. /**
  54225. * Access property
  54226. * @hidden
  54227. */
  54228. _occlusionDataStorage: _OcclusionDataStorage;
  54229. /**
  54230. * 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.
  54231. * The default value is -1 which means don't break the query and wait till the result
  54232. * @see https://doc.babylonjs.com/features/occlusionquery
  54233. */
  54234. occlusionRetryCount: number;
  54235. /**
  54236. * 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:
  54237. * * OCCLUSION_TYPE_NONE (Default Value): this option means no occlusion query whith the Mesh.
  54238. * * OCCLUSION_TYPE_OPTIMISTIC: this option is means use occlusion query and if occlusionRetryCount is reached and the query is broken show the mesh.
  54239. * * 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.
  54240. * @see https://doc.babylonjs.com/features/occlusionquery
  54241. */
  54242. occlusionType: number;
  54243. /**
  54244. * This property determines the type of occlusion query algorithm to run in WebGl, you can use:
  54245. * * AbstractMesh.OCCLUSION_ALGORITHM_TYPE_ACCURATE which is mapped to GL_ANY_SAMPLES_PASSED.
  54246. * * 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.
  54247. * @see https://doc.babylonjs.com/features/occlusionquery
  54248. */
  54249. occlusionQueryAlgorithmType: number;
  54250. /**
  54251. * 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
  54252. * @see https://doc.babylonjs.com/features/occlusionquery
  54253. */
  54254. isOccluded: boolean;
  54255. /**
  54256. * Flag to check the progress status of the query
  54257. * @see https://doc.babylonjs.com/features/occlusionquery
  54258. */
  54259. isOcclusionQueryInProgress: boolean;
  54260. }
  54261. }
  54262. }
  54263. declare module "babylonjs/Engines/Extensions/engine.transformFeedback" {
  54264. import { Nullable } from "babylonjs/types";
  54265. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  54266. /** @hidden */
  54267. export var _forceTransformFeedbackToBundle: boolean;
  54268. module "babylonjs/Engines/engine" {
  54269. interface Engine {
  54270. /**
  54271. * Creates a webGL transform feedback object
  54272. * Please makes sure to check webGLVersion property to check if you are running webGL 2+
  54273. * @returns the webGL transform feedback object
  54274. */
  54275. createTransformFeedback(): WebGLTransformFeedback;
  54276. /**
  54277. * Delete a webGL transform feedback object
  54278. * @param value defines the webGL transform feedback object to delete
  54279. */
  54280. deleteTransformFeedback(value: WebGLTransformFeedback): void;
  54281. /**
  54282. * Bind a webGL transform feedback object to the webgl context
  54283. * @param value defines the webGL transform feedback object to bind
  54284. */
  54285. bindTransformFeedback(value: Nullable<WebGLTransformFeedback>): void;
  54286. /**
  54287. * Begins a transform feedback operation
  54288. * @param usePoints defines if points or triangles must be used
  54289. */
  54290. beginTransformFeedback(usePoints: boolean): void;
  54291. /**
  54292. * Ends a transform feedback operation
  54293. */
  54294. endTransformFeedback(): void;
  54295. /**
  54296. * Specify the varyings to use with transform feedback
  54297. * @param program defines the associated webGL program
  54298. * @param value defines the list of strings representing the varying names
  54299. */
  54300. setTranformFeedbackVaryings(program: WebGLProgram, value: string[]): void;
  54301. /**
  54302. * Bind a webGL buffer for a transform feedback operation
  54303. * @param value defines the webGL buffer to bind
  54304. */
  54305. bindTransformFeedbackBuffer(value: Nullable<DataBuffer>): void;
  54306. }
  54307. }
  54308. }
  54309. declare module "babylonjs/Engines/Extensions/engine.views" {
  54310. import { Camera } from "babylonjs/Cameras/camera";
  54311. import { Nullable } from "babylonjs/types";
  54312. /**
  54313. * Class used to define an additional view for the engine
  54314. * @see https://doc.babylonjs.com/how_to/multi_canvases
  54315. */
  54316. export class EngineView {
  54317. /** Defines the canvas where to render the view */
  54318. target: HTMLCanvasElement;
  54319. /** Defines an optional camera used to render the view (will use active camera else) */
  54320. camera?: Camera;
  54321. }
  54322. module "babylonjs/Engines/engine" {
  54323. interface Engine {
  54324. /**
  54325. * Gets or sets the HTML element to use for attaching events
  54326. */
  54327. inputElement: Nullable<HTMLElement>;
  54328. /**
  54329. * Gets the current engine view
  54330. * @see https://doc.babylonjs.com/how_to/multi_canvases
  54331. */
  54332. activeView: Nullable<EngineView>;
  54333. /** Gets or sets the list of views */
  54334. views: EngineView[];
  54335. /**
  54336. * Register a new child canvas
  54337. * @param canvas defines the canvas to register
  54338. * @param camera defines an optional camera to use with this canvas (it will overwrite the scene.camera for this view)
  54339. * @returns the associated view
  54340. */
  54341. registerView(canvas: HTMLCanvasElement, camera?: Camera): EngineView;
  54342. /**
  54343. * Remove a registered child canvas
  54344. * @param canvas defines the canvas to remove
  54345. * @returns the current engine
  54346. */
  54347. unRegisterView(canvas: HTMLCanvasElement): Engine;
  54348. }
  54349. }
  54350. }
  54351. declare module "babylonjs/Engines/Extensions/engine.textureSelector" {
  54352. import { Nullable } from "babylonjs/types";
  54353. module "babylonjs/Engines/engine" {
  54354. interface Engine {
  54355. /** @hidden */
  54356. _excludedCompressedTextures: string[];
  54357. /** @hidden */
  54358. _textureFormatInUse: string;
  54359. /**
  54360. * Gets the list of texture formats supported
  54361. */
  54362. readonly texturesSupported: Array<string>;
  54363. /**
  54364. * Gets the texture format in use
  54365. */
  54366. readonly textureFormatInUse: Nullable<string>;
  54367. /**
  54368. * Set the compressed texture extensions or file names to skip.
  54369. *
  54370. * @param skippedFiles defines the list of those texture files you want to skip
  54371. * Example: [".dds", ".env", "myfile.png"]
  54372. */
  54373. setCompressedTextureExclusions(skippedFiles: Array<string>): void;
  54374. /**
  54375. * Set the compressed texture format to use, based on the formats you have, and the formats
  54376. * supported by the hardware / browser.
  54377. *
  54378. * Khronos Texture Container (.ktx) files are used to support this. This format has the
  54379. * advantage of being specifically designed for OpenGL. Header elements directly correspond
  54380. * to API arguments needed to compressed textures. This puts the burden on the container
  54381. * generator to house the arcane code for determining these for current & future formats.
  54382. *
  54383. * for description see https://www.khronos.org/opengles/sdk/tools/KTX/
  54384. * for file layout see https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/
  54385. *
  54386. * Note: The result of this call is not taken into account when a texture is base64.
  54387. *
  54388. * @param formatsAvailable defines the list of those format families you have created
  54389. * on your server. Syntax: '-' + format family + '.ktx'. (Case and order do not matter.)
  54390. *
  54391. * Current families are astc, dxt, pvrtc, etc2, & etc1.
  54392. * @returns The extension selected.
  54393. */
  54394. setTextureFormatToUse(formatsAvailable: Array<string>): Nullable<string>;
  54395. }
  54396. }
  54397. }
  54398. declare module "babylonjs/Engines/Extensions/index" {
  54399. export * from "babylonjs/Engines/Extensions/engine.alpha";
  54400. export * from "babylonjs/Engines/Extensions/engine.occlusionQuery";
  54401. export * from "babylonjs/Engines/Extensions/engine.transformFeedback";
  54402. export * from "babylonjs/Engines/Extensions/engine.multiview";
  54403. export * from "babylonjs/Engines/Extensions/engine.rawTexture";
  54404. export * from "babylonjs/Engines/Extensions/engine.dynamicTexture";
  54405. export * from "babylonjs/Engines/Extensions/engine.videoTexture";
  54406. export * from "babylonjs/Engines/Extensions/engine.multiRender";
  54407. export * from "babylonjs/Engines/Extensions/engine.cubeTexture";
  54408. export * from "babylonjs/Engines/Extensions/engine.renderTarget";
  54409. export * from "babylonjs/Engines/Extensions/engine.renderTargetCube";
  54410. export * from "babylonjs/Engines/Extensions/engine.webVR";
  54411. export * from "babylonjs/Engines/Extensions/engine.uniformBuffer";
  54412. export * from "babylonjs/Engines/Extensions/engine.dynamicBuffer";
  54413. export * from "babylonjs/Engines/Extensions/engine.views";
  54414. export * from "babylonjs/Engines/Extensions/engine.readTexture";
  54415. import "babylonjs/Engines/Extensions/engine.textureSelector";
  54416. export * from "babylonjs/Engines/Extensions/engine.textureSelector";
  54417. }
  54418. declare module "babylonjs/Misc/HighDynamicRange/panoramaToCubemap" {
  54419. import { Nullable } from "babylonjs/types";
  54420. /**
  54421. * CubeMap information grouping all the data for each faces as well as the cubemap size.
  54422. */
  54423. export interface CubeMapInfo {
  54424. /**
  54425. * The pixel array for the front face.
  54426. * This is stored in format, left to right, up to down format.
  54427. */
  54428. front: Nullable<ArrayBufferView>;
  54429. /**
  54430. * The pixel array for the back face.
  54431. * This is stored in format, left to right, up to down format.
  54432. */
  54433. back: Nullable<ArrayBufferView>;
  54434. /**
  54435. * The pixel array for the left face.
  54436. * This is stored in format, left to right, up to down format.
  54437. */
  54438. left: Nullable<ArrayBufferView>;
  54439. /**
  54440. * The pixel array for the right face.
  54441. * This is stored in format, left to right, up to down format.
  54442. */
  54443. right: Nullable<ArrayBufferView>;
  54444. /**
  54445. * The pixel array for the up face.
  54446. * This is stored in format, left to right, up to down format.
  54447. */
  54448. up: Nullable<ArrayBufferView>;
  54449. /**
  54450. * The pixel array for the down face.
  54451. * This is stored in format, left to right, up to down format.
  54452. */
  54453. down: Nullable<ArrayBufferView>;
  54454. /**
  54455. * The size of the cubemap stored.
  54456. *
  54457. * Each faces will be size * size pixels.
  54458. */
  54459. size: number;
  54460. /**
  54461. * The format of the texture.
  54462. *
  54463. * RGBA, RGB.
  54464. */
  54465. format: number;
  54466. /**
  54467. * The type of the texture data.
  54468. *
  54469. * UNSIGNED_INT, FLOAT.
  54470. */
  54471. type: number;
  54472. /**
  54473. * Specifies whether the texture is in gamma space.
  54474. */
  54475. gammaSpace: boolean;
  54476. }
  54477. /**
  54478. * Helper class useful to convert panorama picture to their cubemap representation in 6 faces.
  54479. */
  54480. export class PanoramaToCubeMapTools {
  54481. private static FACE_LEFT;
  54482. private static FACE_RIGHT;
  54483. private static FACE_FRONT;
  54484. private static FACE_BACK;
  54485. private static FACE_DOWN;
  54486. private static FACE_UP;
  54487. /**
  54488. * Converts a panorma stored in RGB right to left up to down format into a cubemap (6 faces).
  54489. *
  54490. * @param float32Array The source data.
  54491. * @param inputWidth The width of the input panorama.
  54492. * @param inputHeight The height of the input panorama.
  54493. * @param size The willing size of the generated cubemap (each faces will be size * size pixels)
  54494. * @return The cubemap data
  54495. */
  54496. static ConvertPanoramaToCubemap(float32Array: Float32Array, inputWidth: number, inputHeight: number, size: number): CubeMapInfo;
  54497. private static CreateCubemapTexture;
  54498. private static CalcProjectionSpherical;
  54499. }
  54500. }
  54501. declare module "babylonjs/Misc/HighDynamicRange/cubemapToSphericalPolynomial" {
  54502. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  54503. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  54504. import { Nullable } from "babylonjs/types";
  54505. import { CubeMapInfo } from "babylonjs/Misc/HighDynamicRange/panoramaToCubemap";
  54506. /**
  54507. * Helper class dealing with the extraction of spherical polynomial dataArray
  54508. * from a cube map.
  54509. */
  54510. export class CubeMapToSphericalPolynomialTools {
  54511. private static FileFaces;
  54512. /**
  54513. * Converts a texture to the according Spherical Polynomial data.
  54514. * This extracts the first 3 orders only as they are the only one used in the lighting.
  54515. *
  54516. * @param texture The texture to extract the information from.
  54517. * @return The Spherical Polynomial data.
  54518. */
  54519. static ConvertCubeMapTextureToSphericalPolynomial(texture: BaseTexture): Nullable<SphericalPolynomial>;
  54520. /**
  54521. * Converts a cubemap to the according Spherical Polynomial data.
  54522. * This extracts the first 3 orders only as they are the only one used in the lighting.
  54523. *
  54524. * @param cubeInfo The Cube map to extract the information from.
  54525. * @return The Spherical Polynomial data.
  54526. */
  54527. static ConvertCubeMapToSphericalPolynomial(cubeInfo: CubeMapInfo): SphericalPolynomial;
  54528. }
  54529. }
  54530. declare module "babylonjs/Materials/Textures/baseTexture.polynomial" {
  54531. import { Nullable } from "babylonjs/types";
  54532. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  54533. module "babylonjs/Materials/Textures/baseTexture" {
  54534. interface BaseTexture {
  54535. /**
  54536. * Get the polynomial representation of the texture data.
  54537. * This is mainly use as a fast way to recover IBL Diffuse irradiance data.
  54538. * @see https://learnopengl.com/PBR/IBL/Diffuse-irradiance
  54539. */
  54540. sphericalPolynomial: Nullable<SphericalPolynomial>;
  54541. }
  54542. }
  54543. }
  54544. declare module "babylonjs/Shaders/rgbdEncode.fragment" {
  54545. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  54546. /** @hidden */
  54547. export var rgbdEncodePixelShader: {
  54548. name: string;
  54549. shader: string;
  54550. };
  54551. }
  54552. declare module "babylonjs/Shaders/rgbdDecode.fragment" {
  54553. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  54554. /** @hidden */
  54555. export var rgbdDecodePixelShader: {
  54556. name: string;
  54557. shader: string;
  54558. };
  54559. }
  54560. declare module "babylonjs/Misc/environmentTextureTools" {
  54561. import { Nullable } from "babylonjs/types";
  54562. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  54563. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  54564. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  54565. import "babylonjs/Engines/Extensions/engine.renderTargetCube";
  54566. import "babylonjs/Engines/Extensions/engine.readTexture";
  54567. import "babylonjs/Materials/Textures/baseTexture.polynomial";
  54568. import "babylonjs/Shaders/rgbdEncode.fragment";
  54569. import "babylonjs/Shaders/rgbdDecode.fragment";
  54570. /**
  54571. * Raw texture data and descriptor sufficient for WebGL texture upload
  54572. */
  54573. export interface EnvironmentTextureInfo {
  54574. /**
  54575. * Version of the environment map
  54576. */
  54577. version: number;
  54578. /**
  54579. * Width of image
  54580. */
  54581. width: number;
  54582. /**
  54583. * Irradiance information stored in the file.
  54584. */
  54585. irradiance: any;
  54586. /**
  54587. * Specular information stored in the file.
  54588. */
  54589. specular: any;
  54590. }
  54591. /**
  54592. * Defines One Image in the file. It requires only the position in the file
  54593. * as well as the length.
  54594. */
  54595. interface BufferImageData {
  54596. /**
  54597. * Length of the image data.
  54598. */
  54599. length: number;
  54600. /**
  54601. * Position of the data from the null terminator delimiting the end of the JSON.
  54602. */
  54603. position: number;
  54604. }
  54605. /**
  54606. * Defines the specular data enclosed in the file.
  54607. * This corresponds to the version 1 of the data.
  54608. */
  54609. export interface EnvironmentTextureSpecularInfoV1 {
  54610. /**
  54611. * Defines where the specular Payload is located. It is a runtime value only not stored in the file.
  54612. */
  54613. specularDataPosition?: number;
  54614. /**
  54615. * This contains all the images data needed to reconstruct the cubemap.
  54616. */
  54617. mipmaps: Array<BufferImageData>;
  54618. /**
  54619. * Defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness.
  54620. */
  54621. lodGenerationScale: number;
  54622. }
  54623. /**
  54624. * Sets of helpers addressing the serialization and deserialization of environment texture
  54625. * stored in a BabylonJS env file.
  54626. * Those files are usually stored as .env files.
  54627. */
  54628. export class EnvironmentTextureTools {
  54629. /**
  54630. * Magic number identifying the env file.
  54631. */
  54632. private static _MagicBytes;
  54633. /**
  54634. * Gets the environment info from an env file.
  54635. * @param data The array buffer containing the .env bytes.
  54636. * @returns the environment file info (the json header) if successfully parsed.
  54637. */
  54638. static GetEnvInfo(data: ArrayBufferView): Nullable<EnvironmentTextureInfo>;
  54639. /**
  54640. * Creates an environment texture from a loaded cube texture.
  54641. * @param texture defines the cube texture to convert in env file
  54642. * @return a promise containing the environment data if succesfull.
  54643. */
  54644. static CreateEnvTextureAsync(texture: BaseTexture): Promise<ArrayBuffer>;
  54645. /**
  54646. * Creates a JSON representation of the spherical data.
  54647. * @param texture defines the texture containing the polynomials
  54648. * @return the JSON representation of the spherical info
  54649. */
  54650. private static _CreateEnvTextureIrradiance;
  54651. /**
  54652. * Creates the ArrayBufferViews used for initializing environment texture image data.
  54653. * @param data the image data
  54654. * @param info parameters that determine what views will be created for accessing the underlying buffer
  54655. * @return the views described by info providing access to the underlying buffer
  54656. */
  54657. static CreateImageDataArrayBufferViews(data: ArrayBufferView, info: EnvironmentTextureInfo): Array<Array<ArrayBufferView>>;
  54658. /**
  54659. * Uploads the texture info contained in the env file to the GPU.
  54660. * @param texture defines the internal texture to upload to
  54661. * @param data defines the data to load
  54662. * @param info defines the texture info retrieved through the GetEnvInfo method
  54663. * @returns a promise
  54664. */
  54665. static UploadEnvLevelsAsync(texture: InternalTexture, data: ArrayBufferView, info: EnvironmentTextureInfo): Promise<void>;
  54666. private static _OnImageReadyAsync;
  54667. /**
  54668. * Uploads the levels of image data to the GPU.
  54669. * @param texture defines the internal texture to upload to
  54670. * @param imageData defines the array buffer views of image data [mipmap][face]
  54671. * @returns a promise
  54672. */
  54673. static UploadLevelsAsync(texture: InternalTexture, imageData: ArrayBufferView[][]): Promise<void>;
  54674. /**
  54675. * Uploads spherical polynomials information to the texture.
  54676. * @param texture defines the texture we are trying to upload the information to
  54677. * @param info defines the environment texture info retrieved through the GetEnvInfo method
  54678. */
  54679. static UploadEnvSpherical(texture: InternalTexture, info: EnvironmentTextureInfo): void;
  54680. /** @hidden */
  54681. static _UpdateRGBDAsync(internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number): Promise<void>;
  54682. }
  54683. }
  54684. declare module "babylonjs/Engines/Processors/shaderCodeInliner" {
  54685. /**
  54686. * Class used to inline functions in shader code
  54687. */
  54688. export class ShaderCodeInliner {
  54689. private static readonly _RegexpFindFunctionNameAndType;
  54690. private _sourceCode;
  54691. private _functionDescr;
  54692. private _numMaxIterations;
  54693. /** Gets or sets the token used to mark the functions to inline */
  54694. inlineToken: string;
  54695. /** Gets or sets the debug mode */
  54696. debug: boolean;
  54697. /** Gets the code after the inlining process */
  54698. get code(): string;
  54699. /**
  54700. * Initializes the inliner
  54701. * @param sourceCode shader code source to inline
  54702. * @param numMaxIterations maximum number of iterations (used to detect recursive calls)
  54703. */
  54704. constructor(sourceCode: string, numMaxIterations?: number);
  54705. /**
  54706. * Start the processing of the shader code
  54707. */
  54708. processCode(): void;
  54709. private _collectFunctions;
  54710. private _processInlining;
  54711. private _extractBetweenMarkers;
  54712. private _skipWhitespaces;
  54713. private _removeComments;
  54714. private _replaceFunctionCallsByCode;
  54715. private _findBackward;
  54716. private _escapeRegExp;
  54717. private _replaceNames;
  54718. }
  54719. }
  54720. declare module "babylonjs/Engines/nativeEngine" {
  54721. import { Nullable, IndicesArray, DataArray } from "babylonjs/types";
  54722. import { Engine } from "babylonjs/Engines/engine";
  54723. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  54724. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  54725. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  54726. import { Effect } from "babylonjs/Materials/effect";
  54727. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  54728. import { Matrix, Viewport, Color3 } from "babylonjs/Maths/math";
  54729. import { IColor4Like } from "babylonjs/Maths/math.like";
  54730. import { Scene } from "babylonjs/scene";
  54731. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  54732. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  54733. import { ISceneLike } from "babylonjs/Engines/thinEngine";
  54734. /**
  54735. * Container for accessors for natively-stored mesh data buffers.
  54736. */
  54737. class NativeDataBuffer extends DataBuffer {
  54738. /**
  54739. * Accessor value used to identify/retrieve a natively-stored index buffer.
  54740. */
  54741. nativeIndexBuffer?: any;
  54742. /**
  54743. * Accessor value used to identify/retrieve a natively-stored vertex buffer.
  54744. */
  54745. nativeVertexBuffer?: any;
  54746. }
  54747. /** @hidden */
  54748. class NativeTexture extends InternalTexture {
  54749. getInternalTexture(): InternalTexture;
  54750. getViewCount(): number;
  54751. }
  54752. /** @hidden */
  54753. export class NativeEngine extends Engine {
  54754. private readonly _native;
  54755. /** Defines the invalid handle returned by bgfx when resource creation goes wrong */
  54756. private readonly INVALID_HANDLE;
  54757. private _boundBuffersVertexArray;
  54758. getHardwareScalingLevel(): number;
  54759. constructor();
  54760. dispose(): void;
  54761. /**
  54762. * Can be used to override the current requestAnimationFrame requester.
  54763. * @hidden
  54764. */
  54765. protected _queueNewFrame(bindedRenderFunction: any, requester?: any): number;
  54766. /**
  54767. * Override default engine behavior.
  54768. * @param color
  54769. * @param backBuffer
  54770. * @param depth
  54771. * @param stencil
  54772. */
  54773. _bindUnboundFramebuffer(framebuffer: Nullable<WebGLFramebuffer>): void;
  54774. /**
  54775. * Gets host document
  54776. * @returns the host document object
  54777. */
  54778. getHostDocument(): Nullable<Document>;
  54779. clear(color: Nullable<IColor4Like>, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  54780. createIndexBuffer(indices: IndicesArray, updateable?: boolean): NativeDataBuffer;
  54781. createVertexBuffer(data: DataArray, updateable?: boolean): NativeDataBuffer;
  54782. protected _recordVertexArrayObject(vertexArray: any, vertexBuffers: {
  54783. [key: string]: VertexBuffer;
  54784. }, indexBuffer: Nullable<NativeDataBuffer>, effect: Effect): void;
  54785. bindBuffers(vertexBuffers: {
  54786. [key: string]: VertexBuffer;
  54787. }, indexBuffer: Nullable<NativeDataBuffer>, effect: Effect): void;
  54788. recordVertexArrayObject(vertexBuffers: {
  54789. [key: string]: VertexBuffer;
  54790. }, indexBuffer: Nullable<NativeDataBuffer>, effect: Effect): WebGLVertexArrayObject;
  54791. bindVertexArrayObject(vertexArray: WebGLVertexArrayObject): void;
  54792. releaseVertexArrayObject(vertexArray: WebGLVertexArrayObject): void;
  54793. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  54794. /**
  54795. * Draw a list of indexed primitives
  54796. * @param fillMode defines the primitive to use
  54797. * @param indexStart defines the starting index
  54798. * @param indexCount defines the number of index to draw
  54799. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  54800. */
  54801. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  54802. /**
  54803. * Draw a list of unindexed primitives
  54804. * @param fillMode defines the primitive to use
  54805. * @param verticesStart defines the index of first vertex to draw
  54806. * @param verticesCount defines the count of vertices to draw
  54807. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  54808. */
  54809. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  54810. createPipelineContext(): IPipelineContext;
  54811. _preparePipelineContext(pipelineContext: IPipelineContext, vertexSourceCode: string, fragmentSourceCode: string, createAsRaw: boolean, rebuildRebind: any, defines: Nullable<string>, transformFeedbackVaryings: Nullable<string[]>): void;
  54812. /** @hidden */
  54813. _isRenderingStateCompiled(pipelineContext: IPipelineContext): boolean;
  54814. /** @hidden */
  54815. _executeWhenRenderingStateIsCompiled(pipelineContext: IPipelineContext, action: () => void): void;
  54816. createRawShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): any;
  54817. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): any;
  54818. protected _setProgram(program: WebGLProgram): void;
  54819. _releaseEffect(effect: Effect): void;
  54820. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  54821. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): WebGLUniformLocation[];
  54822. bindUniformBlock(pipelineContext: IPipelineContext, blockName: string, index: number): void;
  54823. bindSamplers(effect: Effect): void;
  54824. setMatrix(uniform: WebGLUniformLocation, matrix: Matrix): void;
  54825. getRenderWidth(useScreen?: boolean): number;
  54826. getRenderHeight(useScreen?: boolean): number;
  54827. setViewport(viewport: Viewport, requiredWidth?: number, requiredHeight?: number): void;
  54828. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  54829. /**
  54830. * Set the z offset to apply to current rendering
  54831. * @param value defines the offset to apply
  54832. */
  54833. setZOffset(value: number): void;
  54834. /**
  54835. * Gets the current value of the zOffset
  54836. * @returns the current zOffset state
  54837. */
  54838. getZOffset(): number;
  54839. /**
  54840. * Enable or disable depth buffering
  54841. * @param enable defines the state to set
  54842. */
  54843. setDepthBuffer(enable: boolean): void;
  54844. /**
  54845. * Gets a boolean indicating if depth writing is enabled
  54846. * @returns the current depth writing state
  54847. */
  54848. getDepthWrite(): boolean;
  54849. /**
  54850. * Enable or disable depth writing
  54851. * @param enable defines the state to set
  54852. */
  54853. setDepthWrite(enable: boolean): void;
  54854. /**
  54855. * Enable or disable color writing
  54856. * @param enable defines the state to set
  54857. */
  54858. setColorWrite(enable: boolean): void;
  54859. /**
  54860. * Gets a boolean indicating if color writing is enabled
  54861. * @returns the current color writing state
  54862. */
  54863. getColorWrite(): boolean;
  54864. /**
  54865. * Sets alpha constants used by some alpha blending modes
  54866. * @param r defines the red component
  54867. * @param g defines the green component
  54868. * @param b defines the blue component
  54869. * @param a defines the alpha component
  54870. */
  54871. setAlphaConstants(r: number, g: number, b: number, a: number): void;
  54872. /**
  54873. * Sets the current alpha mode
  54874. * @param mode defines the mode to use (one of the BABYLON.Constants.ALPHA_XXX)
  54875. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  54876. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  54877. */
  54878. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  54879. /**
  54880. * Gets the current alpha mode
  54881. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  54882. * @returns the current alpha mode
  54883. */
  54884. getAlphaMode(): number;
  54885. setInt(uniform: WebGLUniformLocation, int: number): void;
  54886. setIntArray(uniform: WebGLUniformLocation, array: Int32Array): void;
  54887. setIntArray2(uniform: WebGLUniformLocation, array: Int32Array): void;
  54888. setIntArray3(uniform: WebGLUniformLocation, array: Int32Array): void;
  54889. setIntArray4(uniform: WebGLUniformLocation, array: Int32Array): void;
  54890. setFloatArray(uniform: WebGLUniformLocation, array: Float32Array): void;
  54891. setFloatArray2(uniform: WebGLUniformLocation, array: Float32Array): void;
  54892. setFloatArray3(uniform: WebGLUniformLocation, array: Float32Array): void;
  54893. setFloatArray4(uniform: WebGLUniformLocation, array: Float32Array): void;
  54894. setArray(uniform: WebGLUniformLocation, array: number[]): void;
  54895. setArray2(uniform: WebGLUniformLocation, array: number[]): void;
  54896. setArray3(uniform: WebGLUniformLocation, array: number[]): void;
  54897. setArray4(uniform: WebGLUniformLocation, array: number[]): void;
  54898. setMatrices(uniform: WebGLUniformLocation, matrices: Float32Array): void;
  54899. setMatrix3x3(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  54900. setMatrix2x2(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  54901. setFloat(uniform: WebGLUniformLocation, value: number): void;
  54902. setFloat2(uniform: WebGLUniformLocation, x: number, y: number): void;
  54903. setFloat3(uniform: WebGLUniformLocation, x: number, y: number, z: number): void;
  54904. setFloat4(uniform: WebGLUniformLocation, x: number, y: number, z: number, w: number): void;
  54905. setColor3(uniform: WebGLUniformLocation, color3: Color3): void;
  54906. setColor4(uniform: WebGLUniformLocation, color3: Color3, alpha: number): void;
  54907. wipeCaches(bruteForce?: boolean): void;
  54908. _createTexture(): WebGLTexture;
  54909. protected _deleteTexture(texture: Nullable<WebGLTexture>): void;
  54910. /**
  54911. * Usually called from Texture.ts.
  54912. * Passed information to create a WebGLTexture
  54913. * @param url defines a value which contains one of the following:
  54914. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  54915. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  54916. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  54917. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  54918. * @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)
  54919. * @param scene needed for loading to the correct scene
  54920. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  54921. * @param onLoad optional callback to be called upon successful completion
  54922. * @param onError optional callback to be called upon failure
  54923. * @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
  54924. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  54925. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  54926. * @param forcedExtension defines the extension to use to pick the right loader
  54927. * @param mimeType defines an optional mime type
  54928. * @returns a InternalTexture for assignment back into BABYLON.Texture
  54929. */
  54930. 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;
  54931. /**
  54932. * Creates a cube texture
  54933. * @param rootUrl defines the url where the files to load is located
  54934. * @param scene defines the current scene
  54935. * @param files defines the list of files to load (1 per face)
  54936. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  54937. * @param onLoad defines an optional callback raised when the texture is loaded
  54938. * @param onError defines an optional callback raised if there is an issue to load the texture
  54939. * @param format defines the format of the data
  54940. * @param forcedExtension defines the extension to use to pick the right loader
  54941. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  54942. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  54943. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  54944. * @param fallback defines texture to use while falling back when (compressed) texture file not found.
  54945. * @returns the cube texture as an InternalTexture
  54946. */
  54947. 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;
  54948. private _getSamplingFilter;
  54949. private static _GetNativeTextureFormat;
  54950. createRenderTargetTexture(size: number | {
  54951. width: number;
  54952. height: number;
  54953. }, options: boolean | RenderTargetCreationOptions): NativeTexture;
  54954. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  54955. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean): void;
  54956. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  54957. createDynamicVertexBuffer(data: DataArray): DataBuffer;
  54958. updateDynamicIndexBuffer(indexBuffer: DataBuffer, indices: IndicesArray, offset?: number): void;
  54959. /**
  54960. * Updates a dynamic vertex buffer.
  54961. * @param vertexBuffer the vertex buffer to update
  54962. * @param data the data used to update the vertex buffer
  54963. * @param byteOffset the byte offset of the data (optional)
  54964. * @param byteLength the byte length of the data (optional)
  54965. */
  54966. updateDynamicVertexBuffer(vertexBuffer: DataBuffer, data: DataArray, byteOffset?: number, byteLength?: number): void;
  54967. protected _setTexture(channel: number, texture: Nullable<BaseTexture>, isPartOfTextureArray?: boolean, depthStencilTexture?: boolean): boolean;
  54968. private _updateAnisotropicLevel;
  54969. private _getAddressMode;
  54970. /** @hidden */
  54971. _bindTexture(channel: number, texture: InternalTexture): void;
  54972. protected _deleteBuffer(buffer: NativeDataBuffer): void;
  54973. releaseEffects(): void;
  54974. /** @hidden */
  54975. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  54976. /** @hidden */
  54977. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  54978. /** @hidden */
  54979. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  54980. /** @hidden */
  54981. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement, faceIndex?: number, lod?: number): void;
  54982. }
  54983. }
  54984. declare module "babylonjs/Engines/index" {
  54985. export * from "babylonjs/Engines/constants";
  54986. export * from "babylonjs/Engines/engineCapabilities";
  54987. export * from "babylonjs/Engines/instancingAttributeInfo";
  54988. export * from "babylonjs/Engines/thinEngine";
  54989. export * from "babylonjs/Engines/engine";
  54990. export * from "babylonjs/Engines/engineStore";
  54991. export * from "babylonjs/Engines/nullEngine";
  54992. export * from "babylonjs/Engines/Extensions/index";
  54993. export * from "babylonjs/Engines/IPipelineContext";
  54994. export * from "babylonjs/Engines/WebGL/webGLPipelineContext";
  54995. export * from "babylonjs/Engines/WebGL/webGL2ShaderProcessors";
  54996. export * from "babylonjs/Engines/nativeEngine";
  54997. export * from "babylonjs/Engines/Processors/shaderCodeInliner";
  54998. export * from "babylonjs/Engines/performanceConfigurator";
  54999. }
  55000. declare module "babylonjs/Events/clipboardEvents" {
  55001. /**
  55002. * Gather the list of clipboard event types as constants.
  55003. */
  55004. export class ClipboardEventTypes {
  55005. /**
  55006. * The clipboard event is fired when a copy command is active (pressed).
  55007. */
  55008. static readonly COPY: number;
  55009. /**
  55010. * The clipboard event is fired when a cut command is active (pressed).
  55011. */
  55012. static readonly CUT: number;
  55013. /**
  55014. * The clipboard event is fired when a paste command is active (pressed).
  55015. */
  55016. static readonly PASTE: number;
  55017. }
  55018. /**
  55019. * This class is used to store clipboard related info for the onClipboardObservable event.
  55020. */
  55021. export class ClipboardInfo {
  55022. /**
  55023. * Defines the type of event (BABYLON.ClipboardEventTypes)
  55024. */
  55025. type: number;
  55026. /**
  55027. * Defines the related dom event
  55028. */
  55029. event: ClipboardEvent;
  55030. /**
  55031. *Creates an instance of ClipboardInfo.
  55032. * @param type Defines the type of event (BABYLON.ClipboardEventTypes)
  55033. * @param event Defines the related dom event
  55034. */
  55035. constructor(
  55036. /**
  55037. * Defines the type of event (BABYLON.ClipboardEventTypes)
  55038. */
  55039. type: number,
  55040. /**
  55041. * Defines the related dom event
  55042. */
  55043. event: ClipboardEvent);
  55044. /**
  55045. * Get the clipboard event's type from the keycode.
  55046. * @param keyCode Defines the keyCode for the current keyboard event.
  55047. * @return {number}
  55048. */
  55049. static GetTypeFromCharacter(keyCode: number): number;
  55050. }
  55051. }
  55052. declare module "babylonjs/Events/index" {
  55053. export * from "babylonjs/Events/keyboardEvents";
  55054. export * from "babylonjs/Events/pointerEvents";
  55055. export * from "babylonjs/Events/clipboardEvents";
  55056. }
  55057. declare module "babylonjs/Gamepads/Controllers/daydreamController" {
  55058. import { Scene } from "babylonjs/scene";
  55059. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55060. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  55061. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  55062. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  55063. /**
  55064. * Google Daydream controller
  55065. */
  55066. export class DaydreamController extends WebVRController {
  55067. /**
  55068. * Base Url for the controller model.
  55069. */
  55070. static MODEL_BASE_URL: string;
  55071. /**
  55072. * File name for the controller model.
  55073. */
  55074. static MODEL_FILENAME: string;
  55075. /**
  55076. * Gamepad Id prefix used to identify Daydream Controller.
  55077. */
  55078. static readonly GAMEPAD_ID_PREFIX: string;
  55079. /**
  55080. * Creates a new DaydreamController from a gamepad
  55081. * @param vrGamepad the gamepad that the controller should be created from
  55082. */
  55083. constructor(vrGamepad: any);
  55084. /**
  55085. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  55086. * @param scene scene in which to add meshes
  55087. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  55088. */
  55089. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  55090. /**
  55091. * Called once for each button that changed state since the last frame
  55092. * @param buttonIdx Which button index changed
  55093. * @param state New state of the button
  55094. * @param changes Which properties on the state changed since last frame
  55095. */
  55096. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  55097. }
  55098. }
  55099. declare module "babylonjs/Gamepads/Controllers/gearVRController" {
  55100. import { Scene } from "babylonjs/scene";
  55101. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55102. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  55103. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  55104. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  55105. /**
  55106. * Gear VR Controller
  55107. */
  55108. export class GearVRController extends WebVRController {
  55109. /**
  55110. * Base Url for the controller model.
  55111. */
  55112. static MODEL_BASE_URL: string;
  55113. /**
  55114. * File name for the controller model.
  55115. */
  55116. static MODEL_FILENAME: string;
  55117. /**
  55118. * Gamepad Id prefix used to identify this controller.
  55119. */
  55120. static readonly GAMEPAD_ID_PREFIX: string;
  55121. private readonly _buttonIndexToObservableNameMap;
  55122. /**
  55123. * Creates a new GearVRController from a gamepad
  55124. * @param vrGamepad the gamepad that the controller should be created from
  55125. */
  55126. constructor(vrGamepad: any);
  55127. /**
  55128. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  55129. * @param scene scene in which to add meshes
  55130. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  55131. */
  55132. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  55133. /**
  55134. * Called once for each button that changed state since the last frame
  55135. * @param buttonIdx Which button index changed
  55136. * @param state New state of the button
  55137. * @param changes Which properties on the state changed since last frame
  55138. */
  55139. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  55140. }
  55141. }
  55142. declare module "babylonjs/Gamepads/Controllers/genericController" {
  55143. import { Scene } from "babylonjs/scene";
  55144. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55145. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  55146. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  55147. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  55148. /**
  55149. * Generic Controller
  55150. */
  55151. export class GenericController extends WebVRController {
  55152. /**
  55153. * Base Url for the controller model.
  55154. */
  55155. static readonly MODEL_BASE_URL: string;
  55156. /**
  55157. * File name for the controller model.
  55158. */
  55159. static readonly MODEL_FILENAME: string;
  55160. /**
  55161. * Creates a new GenericController from a gamepad
  55162. * @param vrGamepad the gamepad that the controller should be created from
  55163. */
  55164. constructor(vrGamepad: any);
  55165. /**
  55166. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  55167. * @param scene scene in which to add meshes
  55168. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  55169. */
  55170. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  55171. /**
  55172. * Called once for each button that changed state since the last frame
  55173. * @param buttonIdx Which button index changed
  55174. * @param state New state of the button
  55175. * @param changes Which properties on the state changed since last frame
  55176. */
  55177. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  55178. }
  55179. }
  55180. declare module "babylonjs/Gamepads/Controllers/oculusTouchController" {
  55181. import { Observable } from "babylonjs/Misc/observable";
  55182. import { Scene } from "babylonjs/scene";
  55183. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55184. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  55185. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  55186. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  55187. /**
  55188. * Oculus Touch Controller
  55189. */
  55190. export class OculusTouchController extends WebVRController {
  55191. /**
  55192. * Base Url for the controller model.
  55193. */
  55194. static MODEL_BASE_URL: string;
  55195. /**
  55196. * File name for the left controller model.
  55197. */
  55198. static MODEL_LEFT_FILENAME: string;
  55199. /**
  55200. * File name for the right controller model.
  55201. */
  55202. static MODEL_RIGHT_FILENAME: string;
  55203. /**
  55204. * Base Url for the Quest controller model.
  55205. */
  55206. static QUEST_MODEL_BASE_URL: string;
  55207. /**
  55208. * @hidden
  55209. * If the controllers are running on a device that needs the updated Quest controller models
  55210. */
  55211. static _IsQuest: boolean;
  55212. /**
  55213. * Fired when the secondary trigger on this controller is modified
  55214. */
  55215. onSecondaryTriggerStateChangedObservable: Observable<ExtendedGamepadButton>;
  55216. /**
  55217. * Fired when the thumb rest on this controller is modified
  55218. */
  55219. onThumbRestChangedObservable: Observable<ExtendedGamepadButton>;
  55220. /**
  55221. * Creates a new OculusTouchController from a gamepad
  55222. * @param vrGamepad the gamepad that the controller should be created from
  55223. */
  55224. constructor(vrGamepad: any);
  55225. /**
  55226. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  55227. * @param scene scene in which to add meshes
  55228. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  55229. */
  55230. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  55231. /**
  55232. * Fired when the A button on this controller is modified
  55233. */
  55234. get onAButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55235. /**
  55236. * Fired when the B button on this controller is modified
  55237. */
  55238. get onBButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55239. /**
  55240. * Fired when the X button on this controller is modified
  55241. */
  55242. get onXButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55243. /**
  55244. * Fired when the Y button on this controller is modified
  55245. */
  55246. get onYButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55247. /**
  55248. * Called once for each button that changed state since the last frame
  55249. * 0) thumb stick (touch, press, value = pressed (0,1)). value is in this.leftStick
  55250. * 1) index trigger (touch (?), press (only when value > 0.1), value 0 to 1)
  55251. * 2) secondary trigger (same)
  55252. * 3) A (right) X (left), touch, pressed = value
  55253. * 4) B / Y
  55254. * 5) thumb rest
  55255. * @param buttonIdx Which button index changed
  55256. * @param state New state of the button
  55257. * @param changes Which properties on the state changed since last frame
  55258. */
  55259. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  55260. }
  55261. }
  55262. declare module "babylonjs/Gamepads/Controllers/viveController" {
  55263. import { Scene } from "babylonjs/scene";
  55264. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55265. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  55266. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  55267. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  55268. import { Observable } from "babylonjs/Misc/observable";
  55269. /**
  55270. * Vive Controller
  55271. */
  55272. export class ViveController extends WebVRController {
  55273. /**
  55274. * Base Url for the controller model.
  55275. */
  55276. static MODEL_BASE_URL: string;
  55277. /**
  55278. * File name for the controller model.
  55279. */
  55280. static MODEL_FILENAME: string;
  55281. /**
  55282. * Creates a new ViveController from a gamepad
  55283. * @param vrGamepad the gamepad that the controller should be created from
  55284. */
  55285. constructor(vrGamepad: any);
  55286. /**
  55287. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  55288. * @param scene scene in which to add meshes
  55289. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  55290. */
  55291. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  55292. /**
  55293. * Fired when the left button on this controller is modified
  55294. */
  55295. get onLeftButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55296. /**
  55297. * Fired when the right button on this controller is modified
  55298. */
  55299. get onRightButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55300. /**
  55301. * Fired when the menu button on this controller is modified
  55302. */
  55303. get onMenuButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55304. /**
  55305. * Called once for each button that changed state since the last frame
  55306. * Vive mapping:
  55307. * 0: touchpad
  55308. * 1: trigger
  55309. * 2: left AND right buttons
  55310. * 3: menu button
  55311. * @param buttonIdx Which button index changed
  55312. * @param state New state of the button
  55313. * @param changes Which properties on the state changed since last frame
  55314. */
  55315. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  55316. }
  55317. }
  55318. declare module "babylonjs/Gamepads/Controllers/windowsMotionController" {
  55319. import { Observable } from "babylonjs/Misc/observable";
  55320. import { Scene } from "babylonjs/scene";
  55321. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55322. import { Ray } from "babylonjs/Culling/ray";
  55323. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  55324. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  55325. import { StickValues, GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  55326. /**
  55327. * Defines the WindowsMotionController object that the state of the windows motion controller
  55328. */
  55329. export class WindowsMotionController extends WebVRController {
  55330. /**
  55331. * The base url used to load the left and right controller models
  55332. */
  55333. static MODEL_BASE_URL: string;
  55334. /**
  55335. * The name of the left controller model file
  55336. */
  55337. static MODEL_LEFT_FILENAME: string;
  55338. /**
  55339. * The name of the right controller model file
  55340. */
  55341. static MODEL_RIGHT_FILENAME: string;
  55342. /**
  55343. * The controller name prefix for this controller type
  55344. */
  55345. static readonly GAMEPAD_ID_PREFIX: string;
  55346. /**
  55347. * The controller id pattern for this controller type
  55348. */
  55349. private static readonly GAMEPAD_ID_PATTERN;
  55350. private _loadedMeshInfo;
  55351. protected readonly _mapping: {
  55352. buttons: string[];
  55353. buttonMeshNames: {
  55354. trigger: string;
  55355. menu: string;
  55356. grip: string;
  55357. thumbstick: string;
  55358. trackpad: string;
  55359. };
  55360. buttonObservableNames: {
  55361. trigger: string;
  55362. menu: string;
  55363. grip: string;
  55364. thumbstick: string;
  55365. trackpad: string;
  55366. };
  55367. axisMeshNames: string[];
  55368. pointingPoseMeshName: string;
  55369. };
  55370. /**
  55371. * Fired when the trackpad on this controller is clicked
  55372. */
  55373. onTrackpadChangedObservable: Observable<ExtendedGamepadButton>;
  55374. /**
  55375. * Fired when the trackpad on this controller is modified
  55376. */
  55377. onTrackpadValuesChangedObservable: Observable<StickValues>;
  55378. /**
  55379. * The current x and y values of this controller's trackpad
  55380. */
  55381. trackpad: StickValues;
  55382. /**
  55383. * Creates a new WindowsMotionController from a gamepad
  55384. * @param vrGamepad the gamepad that the controller should be created from
  55385. */
  55386. constructor(vrGamepad: any);
  55387. /**
  55388. * Fired when the trigger on this controller is modified
  55389. */
  55390. get onTriggerButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55391. /**
  55392. * Fired when the menu button on this controller is modified
  55393. */
  55394. get onMenuButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55395. /**
  55396. * Fired when the grip button on this controller is modified
  55397. */
  55398. get onGripButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55399. /**
  55400. * Fired when the thumbstick button on this controller is modified
  55401. */
  55402. get onThumbstickButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55403. /**
  55404. * Fired when the touchpad button on this controller is modified
  55405. */
  55406. get onTouchpadButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55407. /**
  55408. * Fired when the touchpad values on this controller are modified
  55409. */
  55410. get onTouchpadValuesChangedObservable(): Observable<StickValues>;
  55411. protected _updateTrackpad(): void;
  55412. /**
  55413. * Called once per frame by the engine.
  55414. */
  55415. update(): void;
  55416. /**
  55417. * Called once for each button that changed state since the last frame
  55418. * @param buttonIdx Which button index changed
  55419. * @param state New state of the button
  55420. * @param changes Which properties on the state changed since last frame
  55421. */
  55422. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  55423. /**
  55424. * Moves the buttons on the controller mesh based on their current state
  55425. * @param buttonName the name of the button to move
  55426. * @param buttonValue the value of the button which determines the buttons new position
  55427. */
  55428. protected _lerpButtonTransform(buttonName: string, buttonValue: number): void;
  55429. /**
  55430. * Moves the axis on the controller mesh based on its current state
  55431. * @param axis the index of the axis
  55432. * @param axisValue the value of the axis which determines the meshes new position
  55433. * @hidden
  55434. */
  55435. protected _lerpAxisTransform(axis: number, axisValue: number): void;
  55436. /**
  55437. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  55438. * @param scene scene in which to add meshes
  55439. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  55440. */
  55441. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void, forceDefault?: boolean): void;
  55442. /**
  55443. * Takes a list of meshes (as loaded from the glTF file) and finds the root node, as well as nodes that
  55444. * can be transformed by button presses and axes values, based on this._mapping.
  55445. *
  55446. * @param scene scene in which the meshes exist
  55447. * @param meshes list of meshes that make up the controller model to process
  55448. * @return structured view of the given meshes, with mapping of buttons and axes to meshes that can be transformed.
  55449. */
  55450. private processModel;
  55451. private createMeshInfo;
  55452. /**
  55453. * Gets the ray of the controller in the direction the controller is pointing
  55454. * @param length the length the resulting ray should be
  55455. * @returns a ray in the direction the controller is pointing
  55456. */
  55457. getForwardRay(length?: number): Ray;
  55458. /**
  55459. * Disposes of the controller
  55460. */
  55461. dispose(): void;
  55462. }
  55463. /**
  55464. * This class represents a new windows motion controller in XR.
  55465. */
  55466. export class XRWindowsMotionController extends WindowsMotionController {
  55467. /**
  55468. * Changing the original WIndowsMotionController mapping to fir the new mapping
  55469. */
  55470. protected readonly _mapping: {
  55471. buttons: string[];
  55472. buttonMeshNames: {
  55473. trigger: string;
  55474. menu: string;
  55475. grip: string;
  55476. thumbstick: string;
  55477. trackpad: string;
  55478. };
  55479. buttonObservableNames: {
  55480. trigger: string;
  55481. menu: string;
  55482. grip: string;
  55483. thumbstick: string;
  55484. trackpad: string;
  55485. };
  55486. axisMeshNames: string[];
  55487. pointingPoseMeshName: string;
  55488. };
  55489. /**
  55490. * Construct a new XR-Based windows motion controller
  55491. *
  55492. * @param gamepadInfo the gamepad object from the browser
  55493. */
  55494. constructor(gamepadInfo: any);
  55495. /**
  55496. * holds the thumbstick values (X,Y)
  55497. */
  55498. thumbstickValues: StickValues;
  55499. /**
  55500. * Fired when the thumbstick on this controller is clicked
  55501. */
  55502. onThumbstickStateChangedObservable: Observable<ExtendedGamepadButton>;
  55503. /**
  55504. * Fired when the thumbstick on this controller is modified
  55505. */
  55506. onThumbstickValuesChangedObservable: Observable<StickValues>;
  55507. /**
  55508. * Fired when the touchpad button on this controller is modified
  55509. */
  55510. onTrackpadChangedObservable: Observable<ExtendedGamepadButton>;
  55511. /**
  55512. * Fired when the touchpad values on this controller are modified
  55513. */
  55514. onTrackpadValuesChangedObservable: Observable<StickValues>;
  55515. /**
  55516. * Fired when the thumbstick button on this controller is modified
  55517. * here to prevent breaking changes
  55518. */
  55519. get onThumbstickButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55520. /**
  55521. * updating the thumbstick(!) and not the trackpad.
  55522. * This is named this way due to the difference between WebVR and XR and to avoid
  55523. * changing the parent class.
  55524. */
  55525. protected _updateTrackpad(): void;
  55526. /**
  55527. * Disposes the class with joy
  55528. */
  55529. dispose(): void;
  55530. }
  55531. }
  55532. declare module "babylonjs/Gamepads/Controllers/index" {
  55533. export * from "babylonjs/Gamepads/Controllers/daydreamController";
  55534. export * from "babylonjs/Gamepads/Controllers/gearVRController";
  55535. export * from "babylonjs/Gamepads/Controllers/genericController";
  55536. export * from "babylonjs/Gamepads/Controllers/oculusTouchController";
  55537. export * from "babylonjs/Gamepads/Controllers/poseEnabledController";
  55538. export * from "babylonjs/Gamepads/Controllers/viveController";
  55539. export * from "babylonjs/Gamepads/Controllers/webVRController";
  55540. export * from "babylonjs/Gamepads/Controllers/windowsMotionController";
  55541. }
  55542. declare module "babylonjs/Gamepads/index" {
  55543. export * from "babylonjs/Gamepads/Controllers/index";
  55544. export * from "babylonjs/Gamepads/gamepad";
  55545. export * from "babylonjs/Gamepads/gamepadManager";
  55546. export * from "babylonjs/Gamepads/gamepadSceneComponent";
  55547. export * from "babylonjs/Gamepads/xboxGamepad";
  55548. export * from "babylonjs/Gamepads/dualShockGamepad";
  55549. }
  55550. declare module "babylonjs/Meshes/Builders/polyhedronBuilder" {
  55551. import { Scene } from "babylonjs/scene";
  55552. import { Vector4 } from "babylonjs/Maths/math.vector";
  55553. import { Color4 } from "babylonjs/Maths/math.color";
  55554. import { Mesh } from "babylonjs/Meshes/mesh";
  55555. import { Nullable } from "babylonjs/types";
  55556. /**
  55557. * Class containing static functions to help procedurally build meshes
  55558. */
  55559. export class PolyhedronBuilder {
  55560. /**
  55561. * Creates a polyhedron mesh
  55562. * * 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
  55563. * * The parameter `size` (positive float, default 1) sets the polygon size
  55564. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  55565. * * 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`
  55566. * * 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
  55567. * * 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)`)
  55568. * * 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
  55569. * * 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
  55570. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  55571. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  55572. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  55573. * @param name defines the name of the mesh
  55574. * @param options defines the options used to create the mesh
  55575. * @param scene defines the hosting scene
  55576. * @returns the polyhedron mesh
  55577. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes
  55578. */
  55579. static CreatePolyhedron(name: string, options: {
  55580. type?: number;
  55581. size?: number;
  55582. sizeX?: number;
  55583. sizeY?: number;
  55584. sizeZ?: number;
  55585. custom?: any;
  55586. faceUV?: Vector4[];
  55587. faceColors?: Color4[];
  55588. flat?: boolean;
  55589. updatable?: boolean;
  55590. sideOrientation?: number;
  55591. frontUVs?: Vector4;
  55592. backUVs?: Vector4;
  55593. }, scene?: Nullable<Scene>): Mesh;
  55594. }
  55595. }
  55596. declare module "babylonjs/Gizmos/scaleGizmo" {
  55597. import { Observable } from "babylonjs/Misc/observable";
  55598. import { Nullable } from "babylonjs/types";
  55599. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55600. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  55601. import { AxisScaleGizmo } from "babylonjs/Gizmos/axisScaleGizmo";
  55602. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  55603. import { Node } from "babylonjs/node";
  55604. /**
  55605. * Gizmo that enables scaling a mesh along 3 axis
  55606. */
  55607. export class ScaleGizmo extends Gizmo {
  55608. /**
  55609. * Internal gizmo used for interactions on the x axis
  55610. */
  55611. xGizmo: AxisScaleGizmo;
  55612. /**
  55613. * Internal gizmo used for interactions on the y axis
  55614. */
  55615. yGizmo: AxisScaleGizmo;
  55616. /**
  55617. * Internal gizmo used for interactions on the z axis
  55618. */
  55619. zGizmo: AxisScaleGizmo;
  55620. /**
  55621. * Internal gizmo used to scale all axis equally
  55622. */
  55623. uniformScaleGizmo: AxisScaleGizmo;
  55624. private _meshAttached;
  55625. private _nodeAttached;
  55626. private _updateGizmoRotationToMatchAttachedMesh;
  55627. private _snapDistance;
  55628. private _scaleRatio;
  55629. private _uniformScalingMesh;
  55630. private _octahedron;
  55631. private _sensitivity;
  55632. /** Fires an event when any of it's sub gizmos are dragged */
  55633. onDragStartObservable: Observable<unknown>;
  55634. /** Fires an event when any of it's sub gizmos are released from dragging */
  55635. onDragEndObservable: Observable<unknown>;
  55636. get attachedMesh(): Nullable<AbstractMesh>;
  55637. set attachedMesh(mesh: Nullable<AbstractMesh>);
  55638. get attachedNode(): Nullable<Node>;
  55639. set attachedNode(node: Nullable<Node>);
  55640. /**
  55641. * Creates a ScaleGizmo
  55642. * @param gizmoLayer The utility layer the gizmo will be added to
  55643. * @param thickness display gizmo axis thickness
  55644. */
  55645. constructor(gizmoLayer?: UtilityLayerRenderer, thickness?: number);
  55646. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  55647. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  55648. /**
  55649. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  55650. */
  55651. set snapDistance(value: number);
  55652. get snapDistance(): number;
  55653. /**
  55654. * Ratio for the scale of the gizmo (Default: 1)
  55655. */
  55656. set scaleRatio(value: number);
  55657. get scaleRatio(): number;
  55658. /**
  55659. * Sensitivity factor for dragging (Default: 1)
  55660. */
  55661. set sensitivity(value: number);
  55662. get sensitivity(): number;
  55663. /**
  55664. * Disposes of the gizmo
  55665. */
  55666. dispose(): void;
  55667. }
  55668. }
  55669. declare module "babylonjs/Gizmos/axisScaleGizmo" {
  55670. import { Observable } from "babylonjs/Misc/observable";
  55671. import { Nullable } from "babylonjs/types";
  55672. import { Vector3 } from "babylonjs/Maths/math.vector";
  55673. import { Node } from "babylonjs/node";
  55674. import { Mesh } from "babylonjs/Meshes/mesh";
  55675. import { PointerDragBehavior } from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  55676. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  55677. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  55678. import { ScaleGizmo } from "babylonjs/Gizmos/scaleGizmo";
  55679. import { Color3 } from "babylonjs/Maths/math.color";
  55680. /**
  55681. * Single axis scale gizmo
  55682. */
  55683. export class AxisScaleGizmo extends Gizmo {
  55684. /**
  55685. * Drag behavior responsible for the gizmos dragging interactions
  55686. */
  55687. dragBehavior: PointerDragBehavior;
  55688. private _pointerObserver;
  55689. /**
  55690. * Scale distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  55691. */
  55692. snapDistance: number;
  55693. /**
  55694. * Event that fires each time the gizmo snaps to a new location.
  55695. * * snapDistance is the the change in distance
  55696. */
  55697. onSnapObservable: Observable<{
  55698. snapDistance: number;
  55699. }>;
  55700. /**
  55701. * If the scaling operation should be done on all axis (default: false)
  55702. */
  55703. uniformScaling: boolean;
  55704. /**
  55705. * Custom sensitivity value for the drag strength
  55706. */
  55707. sensitivity: number;
  55708. private _isEnabled;
  55709. private _parent;
  55710. private _arrow;
  55711. private _coloredMaterial;
  55712. private _hoverMaterial;
  55713. /**
  55714. * Creates an AxisScaleGizmo
  55715. * @param gizmoLayer The utility layer the gizmo will be added to
  55716. * @param dragAxis The axis which the gizmo will be able to scale on
  55717. * @param color The color of the gizmo
  55718. * @param thickness display gizmo axis thickness
  55719. */
  55720. constructor(dragAxis: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<ScaleGizmo>, thickness?: number);
  55721. protected _attachedNodeChanged(value: Nullable<Node>): void;
  55722. /**
  55723. * If the gizmo is enabled
  55724. */
  55725. set isEnabled(value: boolean);
  55726. get isEnabled(): boolean;
  55727. /**
  55728. * Disposes of the gizmo
  55729. */
  55730. dispose(): void;
  55731. /**
  55732. * Disposes and replaces the current meshes in the gizmo with the specified mesh
  55733. * @param mesh The mesh to replace the default mesh of the gizmo
  55734. * @param useGizmoMaterial If the gizmo's default material should be used (default: false)
  55735. */
  55736. setCustomMesh(mesh: Mesh, useGizmoMaterial?: boolean): void;
  55737. }
  55738. }
  55739. declare module "babylonjs/Gizmos/boundingBoxGizmo" {
  55740. import { Observable } from "babylonjs/Misc/observable";
  55741. import { Nullable } from "babylonjs/types";
  55742. import { Vector3 } from "babylonjs/Maths/math.vector";
  55743. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55744. import { Mesh } from "babylonjs/Meshes/mesh";
  55745. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  55746. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  55747. import { Color3 } from "babylonjs/Maths/math.color";
  55748. import "babylonjs/Meshes/Builders/boxBuilder";
  55749. /**
  55750. * Bounding box gizmo
  55751. */
  55752. export class BoundingBoxGizmo extends Gizmo {
  55753. private _lineBoundingBox;
  55754. private _rotateSpheresParent;
  55755. private _scaleBoxesParent;
  55756. private _boundingDimensions;
  55757. private _renderObserver;
  55758. private _pointerObserver;
  55759. private _scaleDragSpeed;
  55760. private _tmpQuaternion;
  55761. private _tmpVector;
  55762. private _tmpRotationMatrix;
  55763. /**
  55764. * 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)
  55765. */
  55766. ignoreChildren: boolean;
  55767. /**
  55768. * 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)
  55769. */
  55770. includeChildPredicate: Nullable<(abstractMesh: AbstractMesh) => boolean>;
  55771. /**
  55772. * The size of the rotation spheres attached to the bounding box (Default: 0.1)
  55773. */
  55774. rotationSphereSize: number;
  55775. /**
  55776. * The size of the scale boxes attached to the bounding box (Default: 0.1)
  55777. */
  55778. scaleBoxSize: number;
  55779. /**
  55780. * 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)
  55781. */
  55782. fixedDragMeshScreenSize: boolean;
  55783. /**
  55784. * The distance away from the object which the draggable meshes should appear world sized when fixedDragMeshScreenSize is set to true (default: 10)
  55785. */
  55786. fixedDragMeshScreenSizeDistanceFactor: number;
  55787. /**
  55788. * Fired when a rotation sphere or scale box is dragged
  55789. */
  55790. onDragStartObservable: Observable<{}>;
  55791. /**
  55792. * Fired when a scale box is dragged
  55793. */
  55794. onScaleBoxDragObservable: Observable<{}>;
  55795. /**
  55796. * Fired when a scale box drag is ended
  55797. */
  55798. onScaleBoxDragEndObservable: Observable<{}>;
  55799. /**
  55800. * Fired when a rotation sphere is dragged
  55801. */
  55802. onRotationSphereDragObservable: Observable<{}>;
  55803. /**
  55804. * Fired when a rotation sphere drag is ended
  55805. */
  55806. onRotationSphereDragEndObservable: Observable<{}>;
  55807. /**
  55808. * 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)
  55809. */
  55810. scalePivot: Nullable<Vector3>;
  55811. /**
  55812. * Mesh used as a pivot to rotate the attached node
  55813. */
  55814. private _anchorMesh;
  55815. private _existingMeshScale;
  55816. private _dragMesh;
  55817. private pointerDragBehavior;
  55818. private coloredMaterial;
  55819. private hoverColoredMaterial;
  55820. /**
  55821. * Sets the color of the bounding box gizmo
  55822. * @param color the color to set
  55823. */
  55824. setColor(color: Color3): void;
  55825. /**
  55826. * Creates an BoundingBoxGizmo
  55827. * @param gizmoLayer The utility layer the gizmo will be added to
  55828. * @param color The color of the gizmo
  55829. */
  55830. constructor(color?: Color3, gizmoLayer?: UtilityLayerRenderer);
  55831. protected _attachedNodeChanged(value: Nullable<AbstractMesh>): void;
  55832. private _selectNode;
  55833. /**
  55834. * Updates the bounding box information for the Gizmo
  55835. */
  55836. updateBoundingBox(): void;
  55837. private _updateRotationSpheres;
  55838. private _updateScaleBoxes;
  55839. /**
  55840. * Enables rotation on the specified axis and disables rotation on the others
  55841. * @param axis The list of axis that should be enabled (eg. "xy" or "xyz")
  55842. */
  55843. setEnabledRotationAxis(axis: string): void;
  55844. /**
  55845. * Enables/disables scaling
  55846. * @param enable if scaling should be enabled
  55847. * @param homogeneousScaling defines if scaling should only be homogeneous
  55848. */
  55849. setEnabledScaling(enable: boolean, homogeneousScaling?: boolean): void;
  55850. private _updateDummy;
  55851. /**
  55852. * Enables a pointer drag behavior on the bounding box of the gizmo
  55853. */
  55854. enableDragBehavior(): void;
  55855. /**
  55856. * Disposes of the gizmo
  55857. */
  55858. dispose(): void;
  55859. /**
  55860. * 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)
  55861. * @param mesh the mesh to wrap in the bounding box mesh and make not pickable
  55862. * @returns the bounding box mesh with the passed in mesh as a child
  55863. */
  55864. static MakeNotPickableAndWrapInBoundingBox(mesh: Mesh): Mesh;
  55865. /**
  55866. * CustomMeshes are not supported by this gizmo
  55867. * @param mesh The mesh to replace the default mesh of the gizmo
  55868. */
  55869. setCustomMesh(mesh: Mesh): void;
  55870. }
  55871. }
  55872. declare module "babylonjs/Gizmos/planeRotationGizmo" {
  55873. import { Observable } from "babylonjs/Misc/observable";
  55874. import { Nullable } from "babylonjs/types";
  55875. import { Vector3 } from "babylonjs/Maths/math.vector";
  55876. import { Color3 } from "babylonjs/Maths/math.color";
  55877. import { Node } from "babylonjs/node";
  55878. import { PointerDragBehavior } from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  55879. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  55880. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  55881. import "babylonjs/Meshes/Builders/linesBuilder";
  55882. import { RotationGizmo } from "babylonjs/Gizmos/rotationGizmo";
  55883. /**
  55884. * Single plane rotation gizmo
  55885. */
  55886. export class PlaneRotationGizmo extends Gizmo {
  55887. /**
  55888. * Drag behavior responsible for the gizmos dragging interactions
  55889. */
  55890. dragBehavior: PointerDragBehavior;
  55891. private _pointerObserver;
  55892. /**
  55893. * Rotation distance in radians that the gizmo will snap to (Default: 0)
  55894. */
  55895. snapDistance: number;
  55896. /**
  55897. * Event that fires each time the gizmo snaps to a new location.
  55898. * * snapDistance is the the change in distance
  55899. */
  55900. onSnapObservable: Observable<{
  55901. snapDistance: number;
  55902. }>;
  55903. private _isEnabled;
  55904. private _parent;
  55905. /**
  55906. * Creates a PlaneRotationGizmo
  55907. * @param gizmoLayer The utility layer the gizmo will be added to
  55908. * @param planeNormal The normal of the plane which the gizmo will be able to rotate on
  55909. * @param color The color of the gizmo
  55910. * @param tessellation Amount of tessellation to be used when creating rotation circles
  55911. * @param useEulerRotation Use and update Euler angle instead of quaternion
  55912. * @param thickness display gizmo axis thickness
  55913. */
  55914. constructor(planeNormal: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, tessellation?: number, parent?: Nullable<RotationGizmo>, useEulerRotation?: boolean, thickness?: number);
  55915. protected _attachedNodeChanged(value: Nullable<Node>): void;
  55916. /**
  55917. * If the gizmo is enabled
  55918. */
  55919. set isEnabled(value: boolean);
  55920. get isEnabled(): boolean;
  55921. /**
  55922. * Disposes of the gizmo
  55923. */
  55924. dispose(): void;
  55925. }
  55926. }
  55927. declare module "babylonjs/Gizmos/rotationGizmo" {
  55928. import { Observable } from "babylonjs/Misc/observable";
  55929. import { Nullable } from "babylonjs/types";
  55930. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55931. import { Mesh } from "babylonjs/Meshes/mesh";
  55932. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  55933. import { PlaneRotationGizmo } from "babylonjs/Gizmos/planeRotationGizmo";
  55934. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  55935. import { Node } from "babylonjs/node";
  55936. /**
  55937. * Gizmo that enables rotating a mesh along 3 axis
  55938. */
  55939. export class RotationGizmo extends Gizmo {
  55940. /**
  55941. * Internal gizmo used for interactions on the x axis
  55942. */
  55943. xGizmo: PlaneRotationGizmo;
  55944. /**
  55945. * Internal gizmo used for interactions on the y axis
  55946. */
  55947. yGizmo: PlaneRotationGizmo;
  55948. /**
  55949. * Internal gizmo used for interactions on the z axis
  55950. */
  55951. zGizmo: PlaneRotationGizmo;
  55952. /** Fires an event when any of it's sub gizmos are dragged */
  55953. onDragStartObservable: Observable<unknown>;
  55954. /** Fires an event when any of it's sub gizmos are released from dragging */
  55955. onDragEndObservable: Observable<unknown>;
  55956. private _meshAttached;
  55957. private _nodeAttached;
  55958. get attachedMesh(): Nullable<AbstractMesh>;
  55959. set attachedMesh(mesh: Nullable<AbstractMesh>);
  55960. get attachedNode(): Nullable<Node>;
  55961. set attachedNode(node: Nullable<Node>);
  55962. /**
  55963. * Creates a RotationGizmo
  55964. * @param gizmoLayer The utility layer the gizmo will be added to
  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(gizmoLayer?: UtilityLayerRenderer, tessellation?: number, useEulerRotation?: boolean, thickness?: number);
  55970. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  55971. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  55972. /**
  55973. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  55974. */
  55975. set snapDistance(value: number);
  55976. get snapDistance(): number;
  55977. /**
  55978. * Ratio for the scale of the gizmo (Default: 1)
  55979. */
  55980. set scaleRatio(value: number);
  55981. get scaleRatio(): number;
  55982. /**
  55983. * Disposes of the gizmo
  55984. */
  55985. dispose(): void;
  55986. /**
  55987. * CustomMeshes are not supported by this gizmo
  55988. * @param mesh The mesh to replace the default mesh of the gizmo
  55989. */
  55990. setCustomMesh(mesh: Mesh): void;
  55991. }
  55992. }
  55993. declare module "babylonjs/Gizmos/gizmoManager" {
  55994. import { Observable } from "babylonjs/Misc/observable";
  55995. import { Nullable } from "babylonjs/types";
  55996. import { Scene, IDisposable } from "babylonjs/scene";
  55997. import { Node } from "babylonjs/node";
  55998. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55999. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  56000. import { SixDofDragBehavior } from "babylonjs/Behaviors/Meshes/sixDofDragBehavior";
  56001. import { RotationGizmo } from "babylonjs/Gizmos/rotationGizmo";
  56002. import { PositionGizmo } from "babylonjs/Gizmos/positionGizmo";
  56003. import { ScaleGizmo } from "babylonjs/Gizmos/scaleGizmo";
  56004. import { BoundingBoxGizmo } from "babylonjs/Gizmos/boundingBoxGizmo";
  56005. /**
  56006. * Helps setup gizmo's in the scene to rotate/scale/position nodes
  56007. */
  56008. export class GizmoManager implements IDisposable {
  56009. private scene;
  56010. /**
  56011. * Gizmo's created by the gizmo manager, gizmo will be null until gizmo has been enabled for the first time
  56012. */
  56013. gizmos: {
  56014. positionGizmo: Nullable<PositionGizmo>;
  56015. rotationGizmo: Nullable<RotationGizmo>;
  56016. scaleGizmo: Nullable<ScaleGizmo>;
  56017. boundingBoxGizmo: Nullable<BoundingBoxGizmo>;
  56018. };
  56019. /** When true, the gizmo will be detached from the current object when a pointer down occurs with an empty picked mesh */
  56020. clearGizmoOnEmptyPointerEvent: boolean;
  56021. /** Fires an event when the manager is attached to a mesh */
  56022. onAttachedToMeshObservable: Observable<Nullable<AbstractMesh>>;
  56023. /** Fires an event when the manager is attached to a node */
  56024. onAttachedToNodeObservable: Observable<Nullable<Node>>;
  56025. private _gizmosEnabled;
  56026. private _pointerObserver;
  56027. private _attachedMesh;
  56028. private _attachedNode;
  56029. private _boundingBoxColor;
  56030. private _defaultUtilityLayer;
  56031. private _defaultKeepDepthUtilityLayer;
  56032. private _thickness;
  56033. /**
  56034. * When bounding box gizmo is enabled, this can be used to track drag/end events
  56035. */
  56036. boundingBoxDragBehavior: SixDofDragBehavior;
  56037. /**
  56038. * Array of meshes which will have the gizmo attached when a pointer selected them. If null, all meshes are attachable. (Default: null)
  56039. */
  56040. attachableMeshes: Nullable<Array<AbstractMesh>>;
  56041. /**
  56042. * Array of nodes which will have the gizmo attached when a pointer selected them. If null, all nodes are attachable. (Default: null)
  56043. */
  56044. attachableNodes: Nullable<Array<Node>>;
  56045. /**
  56046. * If pointer events should perform attaching/detaching a gizmo, if false this can be done manually via attachToMesh/attachToNode. (Default: true)
  56047. */
  56048. usePointerToAttachGizmos: boolean;
  56049. /**
  56050. * Utility layer that the bounding box gizmo belongs to
  56051. */
  56052. get keepDepthUtilityLayer(): UtilityLayerRenderer;
  56053. /**
  56054. * Utility layer that all gizmos besides bounding box belong to
  56055. */
  56056. get utilityLayer(): UtilityLayerRenderer;
  56057. /**
  56058. * Instatiates a gizmo manager
  56059. * @param scene the scene to overlay the gizmos on top of
  56060. * @param thickness display gizmo axis thickness
  56061. */
  56062. constructor(scene: Scene, thickness?: number);
  56063. /**
  56064. * Attaches a set of gizmos to the specified mesh
  56065. * @param mesh The mesh the gizmo's should be attached to
  56066. */
  56067. attachToMesh(mesh: Nullable<AbstractMesh>): void;
  56068. /**
  56069. * Attaches a set of gizmos to the specified node
  56070. * @param node The node the gizmo's should be attached to
  56071. */
  56072. attachToNode(node: Nullable<Node>): void;
  56073. /**
  56074. * If the position gizmo is enabled
  56075. */
  56076. set positionGizmoEnabled(value: boolean);
  56077. get positionGizmoEnabled(): boolean;
  56078. /**
  56079. * If the rotation gizmo is enabled
  56080. */
  56081. set rotationGizmoEnabled(value: boolean);
  56082. get rotationGizmoEnabled(): boolean;
  56083. /**
  56084. * If the scale gizmo is enabled
  56085. */
  56086. set scaleGizmoEnabled(value: boolean);
  56087. get scaleGizmoEnabled(): boolean;
  56088. /**
  56089. * If the boundingBox gizmo is enabled
  56090. */
  56091. set boundingBoxGizmoEnabled(value: boolean);
  56092. get boundingBoxGizmoEnabled(): boolean;
  56093. /**
  56094. * Disposes of the gizmo manager
  56095. */
  56096. dispose(): void;
  56097. }
  56098. }
  56099. declare module "babylonjs/Lights/directionalLight" {
  56100. import { Camera } from "babylonjs/Cameras/camera";
  56101. import { Scene } from "babylonjs/scene";
  56102. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  56103. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  56104. import { Light } from "babylonjs/Lights/light";
  56105. import { ShadowLight } from "babylonjs/Lights/shadowLight";
  56106. import { Effect } from "babylonjs/Materials/effect";
  56107. /**
  56108. * A directional light is defined by a direction (what a surprise!).
  56109. * The light is emitted from everywhere in the specified direction, and has an infinite range.
  56110. * 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.
  56111. * Documentation: https://doc.babylonjs.com/babylon101/lights
  56112. */
  56113. export class DirectionalLight extends ShadowLight {
  56114. private _shadowFrustumSize;
  56115. /**
  56116. * Fix frustum size for the shadow generation. This is disabled if the value is 0.
  56117. */
  56118. get shadowFrustumSize(): number;
  56119. /**
  56120. * Specifies a fix frustum size for the shadow generation.
  56121. */
  56122. set shadowFrustumSize(value: number);
  56123. private _shadowOrthoScale;
  56124. /**
  56125. * Gets the shadow projection scale against the optimal computed one.
  56126. * 0.1 by default which means that the projection window is increase by 10% from the optimal size.
  56127. * This does not impact in fixed frustum size (shadowFrustumSize being set)
  56128. */
  56129. get shadowOrthoScale(): number;
  56130. /**
  56131. * Sets the shadow projection scale against the optimal computed one.
  56132. * 0.1 by default which means that the projection window is increase by 10% from the optimal size.
  56133. * This does not impact in fixed frustum size (shadowFrustumSize being set)
  56134. */
  56135. set shadowOrthoScale(value: number);
  56136. /**
  56137. * Automatically compute the projection matrix to best fit (including all the casters)
  56138. * on each frame.
  56139. */
  56140. autoUpdateExtends: boolean;
  56141. /**
  56142. * Automatically compute the shadowMinZ and shadowMaxZ for the projection matrix to best fit (including all the casters)
  56143. * on each frame. autoUpdateExtends must be set to true for this to work
  56144. */
  56145. autoCalcShadowZBounds: boolean;
  56146. private _orthoLeft;
  56147. private _orthoRight;
  56148. private _orthoTop;
  56149. private _orthoBottom;
  56150. /**
  56151. * Creates a DirectionalLight object in the scene, oriented towards the passed direction (Vector3).
  56152. * The directional light is emitted from everywhere in the given direction.
  56153. * It can cast shadows.
  56154. * Documentation : https://doc.babylonjs.com/babylon101/lights
  56155. * @param name The friendly name of the light
  56156. * @param direction The direction of the light
  56157. * @param scene The scene the light belongs to
  56158. */
  56159. constructor(name: string, direction: Vector3, scene: Scene);
  56160. /**
  56161. * Returns the string "DirectionalLight".
  56162. * @return The class name
  56163. */
  56164. getClassName(): string;
  56165. /**
  56166. * Returns the integer 1.
  56167. * @return The light Type id as a constant defines in Light.LIGHTTYPEID_x
  56168. */
  56169. getTypeID(): number;
  56170. /**
  56171. * Sets the passed matrix "matrix" as projection matrix for the shadows cast by the light according to the passed view matrix.
  56172. * Returns the DirectionalLight Shadow projection matrix.
  56173. */
  56174. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  56175. /**
  56176. * Sets the passed matrix "matrix" as fixed frustum projection matrix for the shadows cast by the light according to the passed view matrix.
  56177. * Returns the DirectionalLight Shadow projection matrix.
  56178. */
  56179. protected _setDefaultFixedFrustumShadowProjectionMatrix(matrix: Matrix): void;
  56180. /**
  56181. * Sets the passed matrix "matrix" as auto extend projection matrix for the shadows cast by the light according to the passed view matrix.
  56182. * Returns the DirectionalLight Shadow projection matrix.
  56183. */
  56184. protected _setDefaultAutoExtendShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  56185. protected _buildUniformLayout(): void;
  56186. /**
  56187. * Sets the passed Effect object with the DirectionalLight transformed position (or position if not parented) and the passed name.
  56188. * @param effect The effect to update
  56189. * @param lightIndex The index of the light in the effect to update
  56190. * @returns The directional light
  56191. */
  56192. transferToEffect(effect: Effect, lightIndex: string): DirectionalLight;
  56193. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): Light;
  56194. /**
  56195. * Gets the minZ used for shadow according to both the scene and the light.
  56196. *
  56197. * Values are fixed on directional lights as it relies on an ortho projection hence the need to convert being
  56198. * -1 and 1 to 0 and 1 doing (depth + min) / (min + max) -> (depth + 1) / (1 + 1) -> (depth * 0.5) + 0.5.
  56199. * @param activeCamera The camera we are returning the min for
  56200. * @returns the depth min z
  56201. */
  56202. getDepthMinZ(activeCamera: Camera): number;
  56203. /**
  56204. * Gets the maxZ used for shadow according to both the scene and the light.
  56205. *
  56206. * Values are fixed on directional lights as it relies on an ortho projection hence the need to convert being
  56207. * -1 and 1 to 0 and 1 doing (depth + min) / (min + max) -> (depth + 1) / (1 + 1) -> (depth * 0.5) + 0.5.
  56208. * @param activeCamera The camera we are returning the max for
  56209. * @returns the depth max z
  56210. */
  56211. getDepthMaxZ(activeCamera: Camera): number;
  56212. /**
  56213. * Prepares the list of defines specific to the light type.
  56214. * @param defines the list of defines
  56215. * @param lightIndex defines the index of the light for the effect
  56216. */
  56217. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  56218. }
  56219. }
  56220. declare module "babylonjs/Meshes/Builders/hemisphereBuilder" {
  56221. import { Mesh } from "babylonjs/Meshes/mesh";
  56222. /**
  56223. * Class containing static functions to help procedurally build meshes
  56224. */
  56225. export class HemisphereBuilder {
  56226. /**
  56227. * Creates a hemisphere mesh
  56228. * @param name defines the name of the mesh
  56229. * @param options defines the options used to create the mesh
  56230. * @param scene defines the hosting scene
  56231. * @returns the hemisphere mesh
  56232. */
  56233. static CreateHemisphere(name: string, options: {
  56234. segments?: number;
  56235. diameter?: number;
  56236. sideOrientation?: number;
  56237. }, scene: any): Mesh;
  56238. }
  56239. }
  56240. declare module "babylonjs/Lights/spotLight" {
  56241. import { Nullable } from "babylonjs/types";
  56242. import { Scene } from "babylonjs/scene";
  56243. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  56244. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  56245. import { Effect } from "babylonjs/Materials/effect";
  56246. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  56247. import { Light } from "babylonjs/Lights/light";
  56248. import { ShadowLight } from "babylonjs/Lights/shadowLight";
  56249. /**
  56250. * A spot light is defined by a position, a direction, an angle, and an exponent.
  56251. * These values define a cone of light starting from the position, emitting toward the direction.
  56252. * The angle, in radians, defines the size (field of illumination) of the spotlight's conical beam,
  56253. * and the exponent defines the speed of the decay of the light with distance (reach).
  56254. * Documentation: https://doc.babylonjs.com/babylon101/lights
  56255. */
  56256. export class SpotLight extends ShadowLight {
  56257. private _angle;
  56258. private _innerAngle;
  56259. private _cosHalfAngle;
  56260. private _lightAngleScale;
  56261. private _lightAngleOffset;
  56262. /**
  56263. * Gets the cone angle of the spot light in Radians.
  56264. */
  56265. get angle(): number;
  56266. /**
  56267. * Sets the cone angle of the spot light in Radians.
  56268. */
  56269. set angle(value: number);
  56270. /**
  56271. * Only used in gltf falloff mode, this defines the angle where
  56272. * the directional falloff will start before cutting at angle which could be seen
  56273. * as outer angle.
  56274. */
  56275. get innerAngle(): number;
  56276. /**
  56277. * Only used in gltf falloff mode, this defines the angle where
  56278. * the directional falloff will start before cutting at angle which could be seen
  56279. * as outer angle.
  56280. */
  56281. set innerAngle(value: number);
  56282. private _shadowAngleScale;
  56283. /**
  56284. * Allows scaling the angle of the light for shadow generation only.
  56285. */
  56286. get shadowAngleScale(): number;
  56287. /**
  56288. * Allows scaling the angle of the light for shadow generation only.
  56289. */
  56290. set shadowAngleScale(value: number);
  56291. /**
  56292. * The light decay speed with the distance from the emission spot.
  56293. */
  56294. exponent: number;
  56295. private _projectionTextureMatrix;
  56296. /**
  56297. * Allows reading the projecton texture
  56298. */
  56299. get projectionTextureMatrix(): Matrix;
  56300. protected _projectionTextureLightNear: number;
  56301. /**
  56302. * Gets the near clip of the Spotlight for texture projection.
  56303. */
  56304. get projectionTextureLightNear(): number;
  56305. /**
  56306. * Sets the near clip of the Spotlight for texture projection.
  56307. */
  56308. set projectionTextureLightNear(value: number);
  56309. protected _projectionTextureLightFar: number;
  56310. /**
  56311. * Gets the far clip of the Spotlight for texture projection.
  56312. */
  56313. get projectionTextureLightFar(): number;
  56314. /**
  56315. * Sets the far clip of the Spotlight for texture projection.
  56316. */
  56317. set projectionTextureLightFar(value: number);
  56318. protected _projectionTextureUpDirection: Vector3;
  56319. /**
  56320. * Gets the Up vector of the Spotlight for texture projection.
  56321. */
  56322. get projectionTextureUpDirection(): Vector3;
  56323. /**
  56324. * Sets the Up vector of the Spotlight for texture projection.
  56325. */
  56326. set projectionTextureUpDirection(value: Vector3);
  56327. private _projectionTexture;
  56328. /**
  56329. * Gets the projection texture of the light.
  56330. */
  56331. get projectionTexture(): Nullable<BaseTexture>;
  56332. /**
  56333. * Sets the projection texture of the light.
  56334. */
  56335. set projectionTexture(value: Nullable<BaseTexture>);
  56336. private _projectionTextureViewLightDirty;
  56337. private _projectionTextureProjectionLightDirty;
  56338. private _projectionTextureDirty;
  56339. private _projectionTextureViewTargetVector;
  56340. private _projectionTextureViewLightMatrix;
  56341. private _projectionTextureProjectionLightMatrix;
  56342. private _projectionTextureScalingMatrix;
  56343. /**
  56344. * Creates a SpotLight object in the scene. A spot light is a simply light oriented cone.
  56345. * It can cast shadows.
  56346. * Documentation : https://doc.babylonjs.com/babylon101/lights
  56347. * @param name The light friendly name
  56348. * @param position The position of the spot light in the scene
  56349. * @param direction The direction of the light in the scene
  56350. * @param angle The cone angle of the light in Radians
  56351. * @param exponent The light decay speed with the distance from the emission spot
  56352. * @param scene The scene the lights belongs to
  56353. */
  56354. constructor(name: string, position: Vector3, direction: Vector3, angle: number, exponent: number, scene: Scene);
  56355. /**
  56356. * Returns the string "SpotLight".
  56357. * @returns the class name
  56358. */
  56359. getClassName(): string;
  56360. /**
  56361. * Returns the integer 2.
  56362. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  56363. */
  56364. getTypeID(): number;
  56365. /**
  56366. * Overrides the direction setter to recompute the projection texture view light Matrix.
  56367. */
  56368. protected _setDirection(value: Vector3): void;
  56369. /**
  56370. * Overrides the position setter to recompute the projection texture view light Matrix.
  56371. */
  56372. protected _setPosition(value: Vector3): void;
  56373. /**
  56374. * 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.
  56375. * Returns the SpotLight.
  56376. */
  56377. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  56378. protected _computeProjectionTextureViewLightMatrix(): void;
  56379. protected _computeProjectionTextureProjectionLightMatrix(): void;
  56380. /**
  56381. * Main function for light texture projection matrix computing.
  56382. */
  56383. protected _computeProjectionTextureMatrix(): void;
  56384. protected _buildUniformLayout(): void;
  56385. private _computeAngleValues;
  56386. /**
  56387. * Sets the passed Effect "effect" with the Light textures.
  56388. * @param effect The effect to update
  56389. * @param lightIndex The index of the light in the effect to update
  56390. * @returns The light
  56391. */
  56392. transferTexturesToEffect(effect: Effect, lightIndex: string): Light;
  56393. /**
  56394. * Sets the passed Effect object with the SpotLight transfomed position (or position if not parented) and normalized direction.
  56395. * @param effect The effect to update
  56396. * @param lightIndex The index of the light in the effect to update
  56397. * @returns The spot light
  56398. */
  56399. transferToEffect(effect: Effect, lightIndex: string): SpotLight;
  56400. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  56401. /**
  56402. * Disposes the light and the associated resources.
  56403. */
  56404. dispose(): void;
  56405. /**
  56406. * Prepares the list of defines specific to the light type.
  56407. * @param defines the list of defines
  56408. * @param lightIndex defines the index of the light for the effect
  56409. */
  56410. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  56411. }
  56412. }
  56413. declare module "babylonjs/Gizmos/lightGizmo" {
  56414. import { Nullable } from "babylonjs/types";
  56415. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  56416. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  56417. import { StandardMaterial } from "babylonjs/Materials/standardMaterial";
  56418. import { Light } from "babylonjs/Lights/light";
  56419. /**
  56420. * Gizmo that enables viewing a light
  56421. */
  56422. export class LightGizmo extends Gizmo {
  56423. private _lightMesh;
  56424. private _material;
  56425. private _cachedPosition;
  56426. private _cachedForward;
  56427. private _attachedMeshParent;
  56428. /**
  56429. * Creates a LightGizmo
  56430. * @param gizmoLayer The utility layer the gizmo will be added to
  56431. */
  56432. constructor(gizmoLayer?: UtilityLayerRenderer);
  56433. private _light;
  56434. /**
  56435. * The light that the gizmo is attached to
  56436. */
  56437. set light(light: Nullable<Light>);
  56438. get light(): Nullable<Light>;
  56439. /**
  56440. * Gets the material used to render the light gizmo
  56441. */
  56442. get material(): StandardMaterial;
  56443. /**
  56444. * @hidden
  56445. * Updates the gizmo to match the attached mesh's position/rotation
  56446. */
  56447. protected _update(): void;
  56448. private static _Scale;
  56449. /**
  56450. * Creates the lines for a light mesh
  56451. */
  56452. private static _CreateLightLines;
  56453. /**
  56454. * Disposes of the light gizmo
  56455. */
  56456. dispose(): void;
  56457. private static _CreateHemisphericLightMesh;
  56458. private static _CreatePointLightMesh;
  56459. private static _CreateSpotLightMesh;
  56460. private static _CreateDirectionalLightMesh;
  56461. }
  56462. }
  56463. declare module "babylonjs/Gizmos/cameraGizmo" {
  56464. import { Nullable } from "babylonjs/types";
  56465. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  56466. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  56467. import { StandardMaterial } from "babylonjs/Materials/standardMaterial";
  56468. import { Camera } from "babylonjs/Cameras/camera";
  56469. /**
  56470. * Gizmo that enables viewing a camera
  56471. */
  56472. export class CameraGizmo extends Gizmo {
  56473. private _cameraMesh;
  56474. private _cameraLinesMesh;
  56475. private _material;
  56476. /**
  56477. * Creates a CameraGizmo
  56478. * @param gizmoLayer The utility layer the gizmo will be added to
  56479. */
  56480. constructor(gizmoLayer?: UtilityLayerRenderer);
  56481. private _camera;
  56482. /** Gets or sets a boolean indicating if frustum lines must be rendered (true by default)) */
  56483. get displayFrustum(): boolean;
  56484. set displayFrustum(value: boolean);
  56485. /**
  56486. * The camera that the gizmo is attached to
  56487. */
  56488. set camera(camera: Nullable<Camera>);
  56489. get camera(): Nullable<Camera>;
  56490. /**
  56491. * Gets the material used to render the camera gizmo
  56492. */
  56493. get material(): StandardMaterial;
  56494. /**
  56495. * @hidden
  56496. * Updates the gizmo to match the attached mesh's position/rotation
  56497. */
  56498. protected _update(): void;
  56499. private static _Scale;
  56500. private _invProjection;
  56501. /**
  56502. * Disposes of the camera gizmo
  56503. */
  56504. dispose(): void;
  56505. private static _CreateCameraMesh;
  56506. private static _CreateCameraFrustum;
  56507. }
  56508. }
  56509. declare module "babylonjs/Gizmos/index" {
  56510. export * from "babylonjs/Gizmos/axisDragGizmo";
  56511. export * from "babylonjs/Gizmos/axisScaleGizmo";
  56512. export * from "babylonjs/Gizmos/boundingBoxGizmo";
  56513. export * from "babylonjs/Gizmos/gizmo";
  56514. export * from "babylonjs/Gizmos/gizmoManager";
  56515. export * from "babylonjs/Gizmos/planeRotationGizmo";
  56516. export * from "babylonjs/Gizmos/positionGizmo";
  56517. export * from "babylonjs/Gizmos/rotationGizmo";
  56518. export * from "babylonjs/Gizmos/scaleGizmo";
  56519. export * from "babylonjs/Gizmos/lightGizmo";
  56520. export * from "babylonjs/Gizmos/cameraGizmo";
  56521. export * from "babylonjs/Gizmos/planeDragGizmo";
  56522. }
  56523. declare module "babylonjs/Shaders/ShadersInclude/backgroundFragmentDeclaration" {
  56524. /** @hidden */
  56525. export var backgroundFragmentDeclaration: {
  56526. name: string;
  56527. shader: string;
  56528. };
  56529. }
  56530. declare module "babylonjs/Shaders/ShadersInclude/backgroundUboDeclaration" {
  56531. /** @hidden */
  56532. export var backgroundUboDeclaration: {
  56533. name: string;
  56534. shader: string;
  56535. };
  56536. }
  56537. declare module "babylonjs/Shaders/background.fragment" {
  56538. import "babylonjs/Shaders/ShadersInclude/backgroundFragmentDeclaration";
  56539. import "babylonjs/Shaders/ShadersInclude/backgroundUboDeclaration";
  56540. import "babylonjs/Shaders/ShadersInclude/reflectionFunction";
  56541. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  56542. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  56543. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  56544. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  56545. import "babylonjs/Shaders/ShadersInclude/lightsFragmentFunctions";
  56546. import "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions";
  56547. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  56548. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  56549. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  56550. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  56551. import "babylonjs/Shaders/ShadersInclude/lightFragment";
  56552. import "babylonjs/Shaders/ShadersInclude/fogFragment";
  56553. /** @hidden */
  56554. export var backgroundPixelShader: {
  56555. name: string;
  56556. shader: string;
  56557. };
  56558. }
  56559. declare module "babylonjs/Shaders/ShadersInclude/backgroundVertexDeclaration" {
  56560. /** @hidden */
  56561. export var backgroundVertexDeclaration: {
  56562. name: string;
  56563. shader: string;
  56564. };
  56565. }
  56566. declare module "babylonjs/Shaders/background.vertex" {
  56567. import "babylonjs/Shaders/ShadersInclude/backgroundVertexDeclaration";
  56568. import "babylonjs/Shaders/ShadersInclude/backgroundUboDeclaration";
  56569. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  56570. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  56571. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  56572. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  56573. import "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration";
  56574. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  56575. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  56576. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  56577. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  56578. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  56579. import "babylonjs/Shaders/ShadersInclude/fogVertex";
  56580. import "babylonjs/Shaders/ShadersInclude/shadowsVertex";
  56581. /** @hidden */
  56582. export var backgroundVertexShader: {
  56583. name: string;
  56584. shader: string;
  56585. };
  56586. }
  56587. declare module "babylonjs/Materials/Background/backgroundMaterial" {
  56588. import { Nullable, int, float } from "babylonjs/types";
  56589. import { Scene } from "babylonjs/scene";
  56590. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  56591. import { SubMesh } from "babylonjs/Meshes/subMesh";
  56592. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  56593. import { Mesh } from "babylonjs/Meshes/mesh";
  56594. import { PushMaterial } from "babylonjs/Materials/pushMaterial";
  56595. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  56596. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  56597. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  56598. import { IShadowLight } from "babylonjs/Lights/shadowLight";
  56599. import { Color3 } from "babylonjs/Maths/math.color";
  56600. import "babylonjs/Shaders/background.fragment";
  56601. import "babylonjs/Shaders/background.vertex";
  56602. /**
  56603. * Background material used to create an efficient environement around your scene.
  56604. */
  56605. export class BackgroundMaterial extends PushMaterial {
  56606. /**
  56607. * Standard reflectance value at parallel view angle.
  56608. */
  56609. static StandardReflectance0: number;
  56610. /**
  56611. * Standard reflectance value at grazing angle.
  56612. */
  56613. static StandardReflectance90: number;
  56614. protected _primaryColor: Color3;
  56615. /**
  56616. * Key light Color (multiply against the environement texture)
  56617. */
  56618. primaryColor: Color3;
  56619. protected __perceptualColor: Nullable<Color3>;
  56620. /**
  56621. * Experimental Internal Use Only.
  56622. *
  56623. * Key light Color in "perceptual value" meaning the color you would like to see on screen.
  56624. * This acts as a helper to set the primary color to a more "human friendly" value.
  56625. * Conversion to linear space as well as exposure and tone mapping correction will be applied to keep the
  56626. * output color as close as possible from the chosen value.
  56627. * (This does not account for contrast color grading and color curves as they are considered post effect and not directly
  56628. * part of lighting setup.)
  56629. */
  56630. get _perceptualColor(): Nullable<Color3>;
  56631. set _perceptualColor(value: Nullable<Color3>);
  56632. protected _primaryColorShadowLevel: float;
  56633. /**
  56634. * Defines the level of the shadows (dark area of the reflection map) in order to help scaling the colors.
  56635. * The color opposite to the primary color is used at the level chosen to define what the black area would look.
  56636. */
  56637. get primaryColorShadowLevel(): float;
  56638. set primaryColorShadowLevel(value: float);
  56639. protected _primaryColorHighlightLevel: float;
  56640. /**
  56641. * Defines the level of the highliights (highlight area of the reflection map) in order to help scaling the colors.
  56642. * The primary color is used at the level chosen to define what the white area would look.
  56643. */
  56644. get primaryColorHighlightLevel(): float;
  56645. set primaryColorHighlightLevel(value: float);
  56646. protected _reflectionTexture: Nullable<BaseTexture>;
  56647. /**
  56648. * Reflection Texture used in the material.
  56649. * Should be author in a specific way for the best result (refer to the documentation).
  56650. */
  56651. reflectionTexture: Nullable<BaseTexture>;
  56652. protected _reflectionBlur: float;
  56653. /**
  56654. * Reflection Texture level of blur.
  56655. *
  56656. * Can be use to reuse an existing HDR Texture and target a specific LOD to prevent authoring the
  56657. * texture twice.
  56658. */
  56659. reflectionBlur: float;
  56660. protected _diffuseTexture: Nullable<BaseTexture>;
  56661. /**
  56662. * Diffuse Texture used in the material.
  56663. * Should be author in a specific way for the best result (refer to the documentation).
  56664. */
  56665. diffuseTexture: Nullable<BaseTexture>;
  56666. protected _shadowLights: Nullable<IShadowLight[]>;
  56667. /**
  56668. * Specify the list of lights casting shadow on the material.
  56669. * All scene shadow lights will be included if null.
  56670. */
  56671. shadowLights: Nullable<IShadowLight[]>;
  56672. protected _shadowLevel: float;
  56673. /**
  56674. * Helps adjusting the shadow to a softer level if required.
  56675. * 0 means black shadows and 1 means no shadows.
  56676. */
  56677. shadowLevel: float;
  56678. protected _sceneCenter: Vector3;
  56679. /**
  56680. * In case of opacity Fresnel or reflection falloff, this is use as a scene center.
  56681. * It is usually zero but might be interesting to modify according to your setup.
  56682. */
  56683. sceneCenter: Vector3;
  56684. protected _opacityFresnel: boolean;
  56685. /**
  56686. * This helps specifying that the material is falling off to the sky box at grazing angle.
  56687. * This helps ensuring a nice transition when the camera goes under the ground.
  56688. */
  56689. opacityFresnel: boolean;
  56690. protected _reflectionFresnel: boolean;
  56691. /**
  56692. * This helps specifying that the material is falling off from diffuse to the reflection texture at grazing angle.
  56693. * This helps adding a mirror texture on the ground.
  56694. */
  56695. reflectionFresnel: boolean;
  56696. protected _reflectionFalloffDistance: number;
  56697. /**
  56698. * This helps specifying the falloff radius off the reflection texture from the sceneCenter.
  56699. * This helps adding a nice falloff effect to the reflection if used as a mirror for instance.
  56700. */
  56701. reflectionFalloffDistance: number;
  56702. protected _reflectionAmount: number;
  56703. /**
  56704. * This specifies the weight of the reflection against the background in case of reflection Fresnel.
  56705. */
  56706. reflectionAmount: number;
  56707. protected _reflectionReflectance0: number;
  56708. /**
  56709. * This specifies the weight of the reflection at grazing angle.
  56710. */
  56711. reflectionReflectance0: number;
  56712. protected _reflectionReflectance90: number;
  56713. /**
  56714. * This specifies the weight of the reflection at a perpendicular point of view.
  56715. */
  56716. reflectionReflectance90: number;
  56717. /**
  56718. * Sets the reflection reflectance fresnel values according to the default standard
  56719. * empirically know to work well :-)
  56720. */
  56721. set reflectionStandardFresnelWeight(value: number);
  56722. protected _useRGBColor: boolean;
  56723. /**
  56724. * Helps to directly use the maps channels instead of their level.
  56725. */
  56726. useRGBColor: boolean;
  56727. protected _enableNoise: boolean;
  56728. /**
  56729. * This helps reducing the banding effect that could occur on the background.
  56730. */
  56731. enableNoise: boolean;
  56732. /**
  56733. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  56734. * Best used when trying to implement visual zoom effects like fish-eye or binoculars while not adjusting camera fov.
  56735. * Recommended to be keep at 1.0 except for special cases.
  56736. */
  56737. get fovMultiplier(): number;
  56738. set fovMultiplier(value: number);
  56739. private _fovMultiplier;
  56740. /**
  56741. * Enable the FOV adjustment feature controlled by fovMultiplier.
  56742. */
  56743. useEquirectangularFOV: boolean;
  56744. private _maxSimultaneousLights;
  56745. /**
  56746. * Number of Simultaneous lights allowed on the material.
  56747. */
  56748. maxSimultaneousLights: int;
  56749. private _shadowOnly;
  56750. /**
  56751. * Make the material only render shadows
  56752. */
  56753. shadowOnly: boolean;
  56754. /**
  56755. * Default configuration related to image processing available in the Background Material.
  56756. */
  56757. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  56758. /**
  56759. * Keep track of the image processing observer to allow dispose and replace.
  56760. */
  56761. private _imageProcessingObserver;
  56762. /**
  56763. * Attaches a new image processing configuration to the PBR Material.
  56764. * @param configuration (if null the scene configuration will be use)
  56765. */
  56766. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  56767. /**
  56768. * Gets the image processing configuration used either in this material.
  56769. */
  56770. get imageProcessingConfiguration(): Nullable<ImageProcessingConfiguration>;
  56771. /**
  56772. * Sets the Default image processing configuration used either in the this material.
  56773. *
  56774. * If sets to null, the scene one is in use.
  56775. */
  56776. set imageProcessingConfiguration(value: Nullable<ImageProcessingConfiguration>);
  56777. /**
  56778. * Gets wether the color curves effect is enabled.
  56779. */
  56780. get cameraColorCurvesEnabled(): boolean;
  56781. /**
  56782. * Sets wether the color curves effect is enabled.
  56783. */
  56784. set cameraColorCurvesEnabled(value: boolean);
  56785. /**
  56786. * Gets wether the color grading effect is enabled.
  56787. */
  56788. get cameraColorGradingEnabled(): boolean;
  56789. /**
  56790. * Gets wether the color grading effect is enabled.
  56791. */
  56792. set cameraColorGradingEnabled(value: boolean);
  56793. /**
  56794. * Gets wether tonemapping is enabled or not.
  56795. */
  56796. get cameraToneMappingEnabled(): boolean;
  56797. /**
  56798. * Sets wether tonemapping is enabled or not
  56799. */
  56800. set cameraToneMappingEnabled(value: boolean);
  56801. /**
  56802. * The camera exposure used on this material.
  56803. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  56804. * This corresponds to a photographic exposure.
  56805. */
  56806. get cameraExposure(): float;
  56807. /**
  56808. * The camera exposure used on this material.
  56809. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  56810. * This corresponds to a photographic exposure.
  56811. */
  56812. set cameraExposure(value: float);
  56813. /**
  56814. * Gets The camera contrast used on this material.
  56815. */
  56816. get cameraContrast(): float;
  56817. /**
  56818. * Sets The camera contrast used on this material.
  56819. */
  56820. set cameraContrast(value: float);
  56821. /**
  56822. * Gets the Color Grading 2D Lookup Texture.
  56823. */
  56824. get cameraColorGradingTexture(): Nullable<BaseTexture>;
  56825. /**
  56826. * Sets the Color Grading 2D Lookup Texture.
  56827. */
  56828. set cameraColorGradingTexture(value: Nullable<BaseTexture>);
  56829. /**
  56830. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  56831. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  56832. * 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;
  56833. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  56834. */
  56835. get cameraColorCurves(): Nullable<ColorCurves>;
  56836. /**
  56837. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  56838. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  56839. * 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;
  56840. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  56841. */
  56842. set cameraColorCurves(value: Nullable<ColorCurves>);
  56843. /**
  56844. * Due to a bug in iOS10, video tags (which are using the background material) are in BGR and not RGB.
  56845. * Setting this flag to true (not done automatically!) will convert it back to RGB.
  56846. */
  56847. switchToBGR: boolean;
  56848. private _renderTargets;
  56849. private _reflectionControls;
  56850. private _white;
  56851. private _primaryShadowColor;
  56852. private _primaryHighlightColor;
  56853. /**
  56854. * Instantiates a Background Material in the given scene
  56855. * @param name The friendly name of the material
  56856. * @param scene The scene to add the material to
  56857. */
  56858. constructor(name: string, scene: Scene);
  56859. /**
  56860. * Gets a boolean indicating that current material needs to register RTT
  56861. */
  56862. get hasRenderTargetTextures(): boolean;
  56863. /**
  56864. * The entire material has been created in order to prevent overdraw.
  56865. * @returns false
  56866. */
  56867. needAlphaTesting(): boolean;
  56868. /**
  56869. * The entire material has been created in order to prevent overdraw.
  56870. * @returns true if blending is enable
  56871. */
  56872. needAlphaBlending(): boolean;
  56873. /**
  56874. * Checks wether the material is ready to be rendered for a given mesh.
  56875. * @param mesh The mesh to render
  56876. * @param subMesh The submesh to check against
  56877. * @param useInstances Specify wether or not the material is used with instances
  56878. * @returns true if all the dependencies are ready (Textures, Effects...)
  56879. */
  56880. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  56881. /**
  56882. * Compute the primary color according to the chosen perceptual color.
  56883. */
  56884. private _computePrimaryColorFromPerceptualColor;
  56885. /**
  56886. * Compute the highlights and shadow colors according to their chosen levels.
  56887. */
  56888. private _computePrimaryColors;
  56889. /**
  56890. * Build the uniform buffer used in the material.
  56891. */
  56892. buildUniformLayout(): void;
  56893. /**
  56894. * Unbind the material.
  56895. */
  56896. unbind(): void;
  56897. /**
  56898. * Bind only the world matrix to the material.
  56899. * @param world The world matrix to bind.
  56900. */
  56901. bindOnlyWorldMatrix(world: Matrix): void;
  56902. /**
  56903. * Bind the material for a dedicated submeh (every used meshes will be considered opaque).
  56904. * @param world The world matrix to bind.
  56905. * @param subMesh The submesh to bind for.
  56906. */
  56907. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  56908. /**
  56909. * Checks to see if a texture is used in the material.
  56910. * @param texture - Base texture to use.
  56911. * @returns - Boolean specifying if a texture is used in the material.
  56912. */
  56913. hasTexture(texture: BaseTexture): boolean;
  56914. /**
  56915. * Dispose the material.
  56916. * @param forceDisposeEffect Force disposal of the associated effect.
  56917. * @param forceDisposeTextures Force disposal of the associated textures.
  56918. */
  56919. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  56920. /**
  56921. * Clones the material.
  56922. * @param name The cloned name.
  56923. * @returns The cloned material.
  56924. */
  56925. clone(name: string): BackgroundMaterial;
  56926. /**
  56927. * Serializes the current material to its JSON representation.
  56928. * @returns The JSON representation.
  56929. */
  56930. serialize(): any;
  56931. /**
  56932. * Gets the class name of the material
  56933. * @returns "BackgroundMaterial"
  56934. */
  56935. getClassName(): string;
  56936. /**
  56937. * Parse a JSON input to create back a background material.
  56938. * @param source The JSON data to parse
  56939. * @param scene The scene to create the parsed material in
  56940. * @param rootUrl The root url of the assets the material depends upon
  56941. * @returns the instantiated BackgroundMaterial.
  56942. */
  56943. static Parse(source: any, scene: Scene, rootUrl: string): BackgroundMaterial;
  56944. }
  56945. }
  56946. declare module "babylonjs/Helpers/environmentHelper" {
  56947. import { Observable } from "babylonjs/Misc/observable";
  56948. import { Nullable } from "babylonjs/types";
  56949. import { Scene } from "babylonjs/scene";
  56950. import { Vector3 } from "babylonjs/Maths/math.vector";
  56951. import { Color3 } from "babylonjs/Maths/math.color";
  56952. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  56953. import { Mesh } from "babylonjs/Meshes/mesh";
  56954. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  56955. import { MirrorTexture } from "babylonjs/Materials/Textures/mirrorTexture";
  56956. import { BackgroundMaterial } from "babylonjs/Materials/Background/backgroundMaterial";
  56957. import "babylonjs/Meshes/Builders/planeBuilder";
  56958. import "babylonjs/Meshes/Builders/boxBuilder";
  56959. /**
  56960. * Represents the different options available during the creation of
  56961. * a Environment helper.
  56962. *
  56963. * This can control the default ground, skybox and image processing setup of your scene.
  56964. */
  56965. export interface IEnvironmentHelperOptions {
  56966. /**
  56967. * Specifies whether or not to create a ground.
  56968. * True by default.
  56969. */
  56970. createGround: boolean;
  56971. /**
  56972. * Specifies the ground size.
  56973. * 15 by default.
  56974. */
  56975. groundSize: number;
  56976. /**
  56977. * The texture used on the ground for the main color.
  56978. * Comes from the BabylonJS CDN by default.
  56979. *
  56980. * Remarks: Can be either a texture or a url.
  56981. */
  56982. groundTexture: string | BaseTexture;
  56983. /**
  56984. * The color mixed in the ground texture by default.
  56985. * BabylonJS clearColor by default.
  56986. */
  56987. groundColor: Color3;
  56988. /**
  56989. * Specifies the ground opacity.
  56990. * 1 by default.
  56991. */
  56992. groundOpacity: number;
  56993. /**
  56994. * Enables the ground to receive shadows.
  56995. * True by default.
  56996. */
  56997. enableGroundShadow: boolean;
  56998. /**
  56999. * Helps preventing the shadow to be fully black on the ground.
  57000. * 0.5 by default.
  57001. */
  57002. groundShadowLevel: number;
  57003. /**
  57004. * Creates a mirror texture attach to the ground.
  57005. * false by default.
  57006. */
  57007. enableGroundMirror: boolean;
  57008. /**
  57009. * Specifies the ground mirror size ratio.
  57010. * 0.3 by default as the default kernel is 64.
  57011. */
  57012. groundMirrorSizeRatio: number;
  57013. /**
  57014. * Specifies the ground mirror blur kernel size.
  57015. * 64 by default.
  57016. */
  57017. groundMirrorBlurKernel: number;
  57018. /**
  57019. * Specifies the ground mirror visibility amount.
  57020. * 1 by default
  57021. */
  57022. groundMirrorAmount: number;
  57023. /**
  57024. * Specifies the ground mirror reflectance weight.
  57025. * This uses the standard weight of the background material to setup the fresnel effect
  57026. * of the mirror.
  57027. * 1 by default.
  57028. */
  57029. groundMirrorFresnelWeight: number;
  57030. /**
  57031. * Specifies the ground mirror Falloff distance.
  57032. * This can helps reducing the size of the reflection.
  57033. * 0 by Default.
  57034. */
  57035. groundMirrorFallOffDistance: number;
  57036. /**
  57037. * Specifies the ground mirror texture type.
  57038. * Unsigned Int by Default.
  57039. */
  57040. groundMirrorTextureType: number;
  57041. /**
  57042. * Specifies a bias applied to the ground vertical position to prevent z-fighting with
  57043. * the shown objects.
  57044. */
  57045. groundYBias: number;
  57046. /**
  57047. * Specifies whether or not to create a skybox.
  57048. * True by default.
  57049. */
  57050. createSkybox: boolean;
  57051. /**
  57052. * Specifies the skybox size.
  57053. * 20 by default.
  57054. */
  57055. skyboxSize: number;
  57056. /**
  57057. * The texture used on the skybox for the main color.
  57058. * Comes from the BabylonJS CDN by default.
  57059. *
  57060. * Remarks: Can be either a texture or a url.
  57061. */
  57062. skyboxTexture: string | BaseTexture;
  57063. /**
  57064. * The color mixed in the skybox texture by default.
  57065. * BabylonJS clearColor by default.
  57066. */
  57067. skyboxColor: Color3;
  57068. /**
  57069. * The background rotation around the Y axis of the scene.
  57070. * This helps aligning the key lights of your scene with the background.
  57071. * 0 by default.
  57072. */
  57073. backgroundYRotation: number;
  57074. /**
  57075. * Compute automatically the size of the elements to best fit with the scene.
  57076. */
  57077. sizeAuto: boolean;
  57078. /**
  57079. * Default position of the rootMesh if autoSize is not true.
  57080. */
  57081. rootPosition: Vector3;
  57082. /**
  57083. * Sets up the image processing in the scene.
  57084. * true by default.
  57085. */
  57086. setupImageProcessing: boolean;
  57087. /**
  57088. * The texture used as your environment texture in the scene.
  57089. * Comes from the BabylonJS CDN by default and in use if setupImageProcessing is true.
  57090. *
  57091. * Remarks: Can be either a texture or a url.
  57092. */
  57093. environmentTexture: string | BaseTexture;
  57094. /**
  57095. * The value of the exposure to apply to the scene.
  57096. * 0.6 by default if setupImageProcessing is true.
  57097. */
  57098. cameraExposure: number;
  57099. /**
  57100. * The value of the contrast to apply to the scene.
  57101. * 1.6 by default if setupImageProcessing is true.
  57102. */
  57103. cameraContrast: number;
  57104. /**
  57105. * Specifies whether or not tonemapping should be enabled in the scene.
  57106. * true by default if setupImageProcessing is true.
  57107. */
  57108. toneMappingEnabled: boolean;
  57109. }
  57110. /**
  57111. * The Environment helper class can be used to add a fully featuread none expensive background to your scene.
  57112. * It includes by default a skybox and a ground relying on the BackgroundMaterial.
  57113. * It also helps with the default setup of your imageProcessing configuration.
  57114. */
  57115. export class EnvironmentHelper {
  57116. /**
  57117. * Default ground texture URL.
  57118. */
  57119. private static _groundTextureCDNUrl;
  57120. /**
  57121. * Default skybox texture URL.
  57122. */
  57123. private static _skyboxTextureCDNUrl;
  57124. /**
  57125. * Default environment texture URL.
  57126. */
  57127. private static _environmentTextureCDNUrl;
  57128. /**
  57129. * Creates the default options for the helper.
  57130. */
  57131. private static _getDefaultOptions;
  57132. private _rootMesh;
  57133. /**
  57134. * Gets the root mesh created by the helper.
  57135. */
  57136. get rootMesh(): Mesh;
  57137. private _skybox;
  57138. /**
  57139. * Gets the skybox created by the helper.
  57140. */
  57141. get skybox(): Nullable<Mesh>;
  57142. private _skyboxTexture;
  57143. /**
  57144. * Gets the skybox texture created by the helper.
  57145. */
  57146. get skyboxTexture(): Nullable<BaseTexture>;
  57147. private _skyboxMaterial;
  57148. /**
  57149. * Gets the skybox material created by the helper.
  57150. */
  57151. get skyboxMaterial(): Nullable<BackgroundMaterial>;
  57152. private _ground;
  57153. /**
  57154. * Gets the ground mesh created by the helper.
  57155. */
  57156. get ground(): Nullable<Mesh>;
  57157. private _groundTexture;
  57158. /**
  57159. * Gets the ground texture created by the helper.
  57160. */
  57161. get groundTexture(): Nullable<BaseTexture>;
  57162. private _groundMirror;
  57163. /**
  57164. * Gets the ground mirror created by the helper.
  57165. */
  57166. get groundMirror(): Nullable<MirrorTexture>;
  57167. /**
  57168. * Gets the ground mirror render list to helps pushing the meshes
  57169. * you wish in the ground reflection.
  57170. */
  57171. get groundMirrorRenderList(): Nullable<AbstractMesh[]>;
  57172. private _groundMaterial;
  57173. /**
  57174. * Gets the ground material created by the helper.
  57175. */
  57176. get groundMaterial(): Nullable<BackgroundMaterial>;
  57177. /**
  57178. * Stores the creation options.
  57179. */
  57180. private readonly _scene;
  57181. private _options;
  57182. /**
  57183. * This observable will be notified with any error during the creation of the environment,
  57184. * mainly texture creation errors.
  57185. */
  57186. onErrorObservable: Observable<{
  57187. message?: string;
  57188. exception?: any;
  57189. }>;
  57190. /**
  57191. * constructor
  57192. * @param options Defines the options we want to customize the helper
  57193. * @param scene The scene to add the material to
  57194. */
  57195. constructor(options: Partial<IEnvironmentHelperOptions>, scene: Scene);
  57196. /**
  57197. * Updates the background according to the new options
  57198. * @param options
  57199. */
  57200. updateOptions(options: Partial<IEnvironmentHelperOptions>): void;
  57201. /**
  57202. * Sets the primary color of all the available elements.
  57203. * @param color the main color to affect to the ground and the background
  57204. */
  57205. setMainColor(color: Color3): void;
  57206. /**
  57207. * Setup the image processing according to the specified options.
  57208. */
  57209. private _setupImageProcessing;
  57210. /**
  57211. * Setup the environment texture according to the specified options.
  57212. */
  57213. private _setupEnvironmentTexture;
  57214. /**
  57215. * Setup the background according to the specified options.
  57216. */
  57217. private _setupBackground;
  57218. /**
  57219. * Get the scene sizes according to the setup.
  57220. */
  57221. private _getSceneSize;
  57222. /**
  57223. * Setup the ground according to the specified options.
  57224. */
  57225. private _setupGround;
  57226. /**
  57227. * Setup the ground material according to the specified options.
  57228. */
  57229. private _setupGroundMaterial;
  57230. /**
  57231. * Setup the ground diffuse texture according to the specified options.
  57232. */
  57233. private _setupGroundDiffuseTexture;
  57234. /**
  57235. * Setup the ground mirror texture according to the specified options.
  57236. */
  57237. private _setupGroundMirrorTexture;
  57238. /**
  57239. * Setup the ground to receive the mirror texture.
  57240. */
  57241. private _setupMirrorInGroundMaterial;
  57242. /**
  57243. * Setup the skybox according to the specified options.
  57244. */
  57245. private _setupSkybox;
  57246. /**
  57247. * Setup the skybox material according to the specified options.
  57248. */
  57249. private _setupSkyboxMaterial;
  57250. /**
  57251. * Setup the skybox reflection texture according to the specified options.
  57252. */
  57253. private _setupSkyboxReflectionTexture;
  57254. private _errorHandler;
  57255. /**
  57256. * Dispose all the elements created by the Helper.
  57257. */
  57258. dispose(): void;
  57259. }
  57260. }
  57261. declare module "babylonjs/Helpers/photoDome" {
  57262. import { Observable } from "babylonjs/Misc/observable";
  57263. import { Nullable } from "babylonjs/types";
  57264. import { Scene } from "babylonjs/scene";
  57265. import { TransformNode } from "babylonjs/Meshes/transformNode";
  57266. import { Mesh } from "babylonjs/Meshes/mesh";
  57267. import { Texture } from "babylonjs/Materials/Textures/texture";
  57268. import { BackgroundMaterial } from "babylonjs/Materials/Background/backgroundMaterial";
  57269. import "babylonjs/Meshes/Builders/sphereBuilder";
  57270. /**
  57271. * Display a 360 degree photo on an approximately spherical surface, useful for VR applications or skyboxes.
  57272. * As a subclass of TransformNode, this allow parenting to the camera with different locations in the scene.
  57273. * This class achieves its effect with a Texture and a correctly configured BackgroundMaterial on an inverted sphere.
  57274. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  57275. */
  57276. export class PhotoDome extends TransformNode {
  57277. /**
  57278. * Define the image as a Monoscopic panoramic 360 image.
  57279. */
  57280. static readonly MODE_MONOSCOPIC: number;
  57281. /**
  57282. * Define the image as a Stereoscopic TopBottom/OverUnder panoramic 360 image.
  57283. */
  57284. static readonly MODE_TOPBOTTOM: number;
  57285. /**
  57286. * Define the image as a Stereoscopic Side by Side panoramic 360 image.
  57287. */
  57288. static readonly MODE_SIDEBYSIDE: number;
  57289. private _useDirectMapping;
  57290. /**
  57291. * The texture being displayed on the sphere
  57292. */
  57293. protected _photoTexture: Texture;
  57294. /**
  57295. * Gets or sets the texture being displayed on the sphere
  57296. */
  57297. get photoTexture(): Texture;
  57298. set photoTexture(value: Texture);
  57299. /**
  57300. * Observable raised when an error occured while loading the 360 image
  57301. */
  57302. onLoadErrorObservable: Observable<string>;
  57303. /**
  57304. * The skybox material
  57305. */
  57306. protected _material: BackgroundMaterial;
  57307. /**
  57308. * The surface used for the skybox
  57309. */
  57310. protected _mesh: Mesh;
  57311. /**
  57312. * Gets the mesh used for the skybox.
  57313. */
  57314. get mesh(): Mesh;
  57315. /**
  57316. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  57317. * Also see the options.resolution property.
  57318. */
  57319. get fovMultiplier(): number;
  57320. set fovMultiplier(value: number);
  57321. private _imageMode;
  57322. /**
  57323. * Gets or set the current video mode for the video. It can be:
  57324. * * PhotoDome.MODE_MONOSCOPIC : Define the image as a Monoscopic panoramic 360 image.
  57325. * * PhotoDome.MODE_TOPBOTTOM : Define the image as a Stereoscopic TopBottom/OverUnder panoramic 360 image.
  57326. * * PhotoDome.MODE_SIDEBYSIDE : Define the image as a Stereoscopic Side by Side panoramic 360 image.
  57327. */
  57328. get imageMode(): number;
  57329. set imageMode(value: number);
  57330. /**
  57331. * Create an instance of this class and pass through the parameters to the relevant classes, Texture, StandardMaterial, and Mesh.
  57332. * @param name Element's name, child elements will append suffixes for their own names.
  57333. * @param urlsOfPhoto defines the url of the photo to display
  57334. * @param options defines an object containing optional or exposed sub element properties
  57335. * @param onError defines a callback called when an error occured while loading the texture
  57336. */
  57337. constructor(name: string, urlOfPhoto: string, options: {
  57338. resolution?: number;
  57339. size?: number;
  57340. useDirectMapping?: boolean;
  57341. faceForward?: boolean;
  57342. }, scene: Scene, onError?: Nullable<(message?: string, exception?: any) => void>);
  57343. private _onBeforeCameraRenderObserver;
  57344. private _changeImageMode;
  57345. /**
  57346. * Releases resources associated with this node.
  57347. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  57348. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  57349. */
  57350. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  57351. }
  57352. }
  57353. declare module "babylonjs/Misc/rgbdTextureTools" {
  57354. import "babylonjs/Shaders/rgbdDecode.fragment";
  57355. import "babylonjs/Engines/Extensions/engine.renderTarget";
  57356. import { Texture } from "babylonjs/Materials/Textures/texture";
  57357. /**
  57358. * Class used to host RGBD texture specific utilities
  57359. */
  57360. export class RGBDTextureTools {
  57361. /**
  57362. * Expand the RGBD Texture from RGBD to Half Float if possible.
  57363. * @param texture the texture to expand.
  57364. */
  57365. static ExpandRGBDTexture(texture: Texture): void;
  57366. }
  57367. }
  57368. declare module "babylonjs/Misc/brdfTextureTools" {
  57369. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  57370. import { Scene } from "babylonjs/scene";
  57371. /**
  57372. * Class used to host texture specific utilities
  57373. */
  57374. export class BRDFTextureTools {
  57375. /**
  57376. * Prevents texture cache collision
  57377. */
  57378. private static _instanceNumber;
  57379. /**
  57380. * Gets a default environment BRDF for MS-BRDF Height Correlated BRDF
  57381. * @param scene defines the hosting scene
  57382. * @returns the environment BRDF texture
  57383. */
  57384. static GetEnvironmentBRDFTexture(scene: Scene): BaseTexture;
  57385. private static _environmentBRDFBase64Texture;
  57386. }
  57387. }
  57388. declare module "babylonjs/Materials/PBR/pbrClearCoatConfiguration" {
  57389. import { Nullable } from "babylonjs/types";
  57390. import { Color3 } from "babylonjs/Maths/math.color";
  57391. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  57392. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  57393. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  57394. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  57395. import { Engine } from "babylonjs/Engines/engine";
  57396. import { Scene } from "babylonjs/scene";
  57397. /**
  57398. * @hidden
  57399. */
  57400. export interface IMaterialClearCoatDefines {
  57401. CLEARCOAT: boolean;
  57402. CLEARCOAT_DEFAULTIOR: boolean;
  57403. CLEARCOAT_TEXTURE: boolean;
  57404. CLEARCOAT_TEXTUREDIRECTUV: number;
  57405. CLEARCOAT_BUMP: boolean;
  57406. CLEARCOAT_BUMPDIRECTUV: number;
  57407. CLEARCOAT_TINT: boolean;
  57408. CLEARCOAT_TINT_TEXTURE: boolean;
  57409. CLEARCOAT_TINT_TEXTUREDIRECTUV: number;
  57410. /** @hidden */
  57411. _areTexturesDirty: boolean;
  57412. }
  57413. /**
  57414. * Define the code related to the clear coat parameters of the pbr material.
  57415. */
  57416. export class PBRClearCoatConfiguration {
  57417. /**
  57418. * This defaults to 1.5 corresponding to a 0.04 f0 or a 4% reflectance at normal incidence
  57419. * The default fits with a polyurethane material.
  57420. */
  57421. private static readonly _DefaultIndexOfRefraction;
  57422. private _isEnabled;
  57423. /**
  57424. * Defines if the clear coat is enabled in the material.
  57425. */
  57426. isEnabled: boolean;
  57427. /**
  57428. * Defines the clear coat layer strength (between 0 and 1) it defaults to 1.
  57429. */
  57430. intensity: number;
  57431. /**
  57432. * Defines the clear coat layer roughness.
  57433. */
  57434. roughness: number;
  57435. private _indexOfRefraction;
  57436. /**
  57437. * Defines the index of refraction of the clear coat.
  57438. * This defaults to 1.5 corresponding to a 0.04 f0 or a 4% reflectance at normal incidence
  57439. * The default fits with a polyurethane material.
  57440. * Changing the default value is more performance intensive.
  57441. */
  57442. indexOfRefraction: number;
  57443. private _texture;
  57444. /**
  57445. * Stores the clear coat values in a texture.
  57446. */
  57447. texture: Nullable<BaseTexture>;
  57448. private _bumpTexture;
  57449. /**
  57450. * Define the clear coat specific bump texture.
  57451. */
  57452. bumpTexture: Nullable<BaseTexture>;
  57453. private _isTintEnabled;
  57454. /**
  57455. * Defines if the clear coat tint is enabled in the material.
  57456. */
  57457. isTintEnabled: boolean;
  57458. /**
  57459. * Defines the clear coat tint of the material.
  57460. * This is only use if tint is enabled
  57461. */
  57462. tintColor: Color3;
  57463. /**
  57464. * Defines the distance at which the tint color should be found in the
  57465. * clear coat media.
  57466. * This is only use if tint is enabled
  57467. */
  57468. tintColorAtDistance: number;
  57469. /**
  57470. * Defines the clear coat layer thickness.
  57471. * This is only use if tint is enabled
  57472. */
  57473. tintThickness: number;
  57474. private _tintTexture;
  57475. /**
  57476. * Stores the clear tint values in a texture.
  57477. * rgb is tint
  57478. * a is a thickness factor
  57479. */
  57480. tintTexture: Nullable<BaseTexture>;
  57481. /** @hidden */
  57482. private _internalMarkAllSubMeshesAsTexturesDirty;
  57483. /** @hidden */
  57484. _markAllSubMeshesAsTexturesDirty(): void;
  57485. /**
  57486. * Instantiate a new istance of clear coat configuration.
  57487. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  57488. */
  57489. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  57490. /**
  57491. * Gets wehter the submesh is ready to be used or not.
  57492. * @param defines the list of "defines" to update.
  57493. * @param scene defines the scene the material belongs to.
  57494. * @param engine defines the engine the material belongs to.
  57495. * @param disableBumpMap defines wether the material disables bump or not.
  57496. * @returns - boolean indicating that the submesh is ready or not.
  57497. */
  57498. isReadyForSubMesh(defines: IMaterialClearCoatDefines, scene: Scene, engine: Engine, disableBumpMap: boolean): boolean;
  57499. /**
  57500. * Checks to see if a texture is used in the material.
  57501. * @param defines the list of "defines" to update.
  57502. * @param scene defines the scene to the material belongs to.
  57503. */
  57504. prepareDefines(defines: IMaterialClearCoatDefines, scene: Scene): void;
  57505. /**
  57506. * Binds the material data.
  57507. * @param uniformBuffer defines the Uniform buffer to fill in.
  57508. * @param scene defines the scene the material belongs to.
  57509. * @param engine defines the engine the material belongs to.
  57510. * @param disableBumpMap defines wether the material disables bump or not.
  57511. * @param isFrozen defines wether the material is frozen or not.
  57512. * @param invertNormalMapX If sets to true, x component of normal map value will be inverted (x = 1.0 - x).
  57513. * @param invertNormalMapY If sets to true, y component of normal map value will be inverted (y = 1.0 - y).
  57514. */
  57515. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, engine: Engine, disableBumpMap: boolean, isFrozen: boolean, invertNormalMapX: boolean, invertNormalMapY: boolean): void;
  57516. /**
  57517. * Checks to see if a texture is used in the material.
  57518. * @param texture - Base texture to use.
  57519. * @returns - Boolean specifying if a texture is used in the material.
  57520. */
  57521. hasTexture(texture: BaseTexture): boolean;
  57522. /**
  57523. * Returns an array of the actively used textures.
  57524. * @param activeTextures Array of BaseTextures
  57525. */
  57526. getActiveTextures(activeTextures: BaseTexture[]): void;
  57527. /**
  57528. * Returns the animatable textures.
  57529. * @param animatables Array of animatable textures.
  57530. */
  57531. getAnimatables(animatables: IAnimatable[]): void;
  57532. /**
  57533. * Disposes the resources of the material.
  57534. * @param forceDisposeTextures - Forces the disposal of all textures.
  57535. */
  57536. dispose(forceDisposeTextures?: boolean): void;
  57537. /**
  57538. * Get the current class name of the texture useful for serialization or dynamic coding.
  57539. * @returns "PBRClearCoatConfiguration"
  57540. */
  57541. getClassName(): string;
  57542. /**
  57543. * Add fallbacks to the effect fallbacks list.
  57544. * @param defines defines the Base texture to use.
  57545. * @param fallbacks defines the current fallback list.
  57546. * @param currentRank defines the current fallback rank.
  57547. * @returns the new fallback rank.
  57548. */
  57549. static AddFallbacks(defines: IMaterialClearCoatDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  57550. /**
  57551. * Add the required uniforms to the current list.
  57552. * @param uniforms defines the current uniform list.
  57553. */
  57554. static AddUniforms(uniforms: string[]): void;
  57555. /**
  57556. * Add the required samplers to the current list.
  57557. * @param samplers defines the current sampler list.
  57558. */
  57559. static AddSamplers(samplers: string[]): void;
  57560. /**
  57561. * Add the required uniforms to the current buffer.
  57562. * @param uniformBuffer defines the current uniform buffer.
  57563. */
  57564. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  57565. /**
  57566. * Makes a duplicate of the current configuration into another one.
  57567. * @param clearCoatConfiguration define the config where to copy the info
  57568. */
  57569. copyTo(clearCoatConfiguration: PBRClearCoatConfiguration): void;
  57570. /**
  57571. * Serializes this clear coat configuration.
  57572. * @returns - An object with the serialized config.
  57573. */
  57574. serialize(): any;
  57575. /**
  57576. * Parses a anisotropy Configuration from a serialized object.
  57577. * @param source - Serialized object.
  57578. * @param scene Defines the scene we are parsing for
  57579. * @param rootUrl Defines the rootUrl to load from
  57580. */
  57581. parse(source: any, scene: Scene, rootUrl: string): void;
  57582. }
  57583. }
  57584. declare module "babylonjs/Materials/PBR/pbrAnisotropicConfiguration" {
  57585. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  57586. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  57587. import { Vector2 } from "babylonjs/Maths/math.vector";
  57588. import { Scene } from "babylonjs/scene";
  57589. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  57590. import { Nullable } from "babylonjs/types";
  57591. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  57592. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  57593. /**
  57594. * @hidden
  57595. */
  57596. export interface IMaterialAnisotropicDefines {
  57597. ANISOTROPIC: boolean;
  57598. ANISOTROPIC_TEXTURE: boolean;
  57599. ANISOTROPIC_TEXTUREDIRECTUV: number;
  57600. MAINUV1: boolean;
  57601. _areTexturesDirty: boolean;
  57602. _needUVs: boolean;
  57603. }
  57604. /**
  57605. * Define the code related to the anisotropic parameters of the pbr material.
  57606. */
  57607. export class PBRAnisotropicConfiguration {
  57608. private _isEnabled;
  57609. /**
  57610. * Defines if the anisotropy is enabled in the material.
  57611. */
  57612. isEnabled: boolean;
  57613. /**
  57614. * Defines the anisotropy strength (between 0 and 1) it defaults to 1.
  57615. */
  57616. intensity: number;
  57617. /**
  57618. * Defines if the effect is along the tangents, bitangents or in between.
  57619. * By default, the effect is "strectching" the highlights along the tangents.
  57620. */
  57621. direction: Vector2;
  57622. private _texture;
  57623. /**
  57624. * Stores the anisotropy values in a texture.
  57625. * rg is direction (like normal from -1 to 1)
  57626. * b is a intensity
  57627. */
  57628. texture: Nullable<BaseTexture>;
  57629. /** @hidden */
  57630. private _internalMarkAllSubMeshesAsTexturesDirty;
  57631. /** @hidden */
  57632. _markAllSubMeshesAsTexturesDirty(): void;
  57633. /**
  57634. * Instantiate a new istance of anisotropy configuration.
  57635. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  57636. */
  57637. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  57638. /**
  57639. * Specifies that the submesh is ready to be used.
  57640. * @param defines the list of "defines" to update.
  57641. * @param scene defines the scene the material belongs to.
  57642. * @returns - boolean indicating that the submesh is ready or not.
  57643. */
  57644. isReadyForSubMesh(defines: IMaterialAnisotropicDefines, scene: Scene): boolean;
  57645. /**
  57646. * Checks to see if a texture is used in the material.
  57647. * @param defines the list of "defines" to update.
  57648. * @param mesh the mesh we are preparing the defines for.
  57649. * @param scene defines the scene the material belongs to.
  57650. */
  57651. prepareDefines(defines: IMaterialAnisotropicDefines, mesh: AbstractMesh, scene: Scene): void;
  57652. /**
  57653. * Binds the material data.
  57654. * @param uniformBuffer defines the Uniform buffer to fill in.
  57655. * @param scene defines the scene the material belongs to.
  57656. * @param isFrozen defines wether the material is frozen or not.
  57657. */
  57658. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  57659. /**
  57660. * Checks to see if a texture is used in the material.
  57661. * @param texture - Base texture to use.
  57662. * @returns - Boolean specifying if a texture is used in the material.
  57663. */
  57664. hasTexture(texture: BaseTexture): boolean;
  57665. /**
  57666. * Returns an array of the actively used textures.
  57667. * @param activeTextures Array of BaseTextures
  57668. */
  57669. getActiveTextures(activeTextures: BaseTexture[]): void;
  57670. /**
  57671. * Returns the animatable textures.
  57672. * @param animatables Array of animatable textures.
  57673. */
  57674. getAnimatables(animatables: IAnimatable[]): void;
  57675. /**
  57676. * Disposes the resources of the material.
  57677. * @param forceDisposeTextures - Forces the disposal of all textures.
  57678. */
  57679. dispose(forceDisposeTextures?: boolean): void;
  57680. /**
  57681. * Get the current class name of the texture useful for serialization or dynamic coding.
  57682. * @returns "PBRAnisotropicConfiguration"
  57683. */
  57684. getClassName(): string;
  57685. /**
  57686. * Add fallbacks to the effect fallbacks list.
  57687. * @param defines defines the Base texture to use.
  57688. * @param fallbacks defines the current fallback list.
  57689. * @param currentRank defines the current fallback rank.
  57690. * @returns the new fallback rank.
  57691. */
  57692. static AddFallbacks(defines: IMaterialAnisotropicDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  57693. /**
  57694. * Add the required uniforms to the current list.
  57695. * @param uniforms defines the current uniform list.
  57696. */
  57697. static AddUniforms(uniforms: string[]): void;
  57698. /**
  57699. * Add the required uniforms to the current buffer.
  57700. * @param uniformBuffer defines the current uniform buffer.
  57701. */
  57702. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  57703. /**
  57704. * Add the required samplers to the current list.
  57705. * @param samplers defines the current sampler list.
  57706. */
  57707. static AddSamplers(samplers: string[]): void;
  57708. /**
  57709. * Makes a duplicate of the current configuration into another one.
  57710. * @param anisotropicConfiguration define the config where to copy the info
  57711. */
  57712. copyTo(anisotropicConfiguration: PBRAnisotropicConfiguration): void;
  57713. /**
  57714. * Serializes this anisotropy configuration.
  57715. * @returns - An object with the serialized config.
  57716. */
  57717. serialize(): any;
  57718. /**
  57719. * Parses a anisotropy Configuration from a serialized object.
  57720. * @param source - Serialized object.
  57721. * @param scene Defines the scene we are parsing for
  57722. * @param rootUrl Defines the rootUrl to load from
  57723. */
  57724. parse(source: any, scene: Scene, rootUrl: string): void;
  57725. }
  57726. }
  57727. declare module "babylonjs/Materials/PBR/pbrBRDFConfiguration" {
  57728. import { Scene } from "babylonjs/scene";
  57729. /**
  57730. * @hidden
  57731. */
  57732. export interface IMaterialBRDFDefines {
  57733. BRDF_V_HEIGHT_CORRELATED: boolean;
  57734. MS_BRDF_ENERGY_CONSERVATION: boolean;
  57735. SPHERICAL_HARMONICS: boolean;
  57736. SPECULAR_GLOSSINESS_ENERGY_CONSERVATION: boolean;
  57737. /** @hidden */
  57738. _areMiscDirty: boolean;
  57739. }
  57740. /**
  57741. * Define the code related to the BRDF parameters of the pbr material.
  57742. */
  57743. export class PBRBRDFConfiguration {
  57744. /**
  57745. * Default value used for the energy conservation.
  57746. * This should only be changed to adapt to the type of texture in scene.environmentBRDFTexture.
  57747. */
  57748. static DEFAULT_USE_ENERGY_CONSERVATION: boolean;
  57749. /**
  57750. * Default value used for the Smith Visibility Height Correlated mode.
  57751. * This should only be changed to adapt to the type of texture in scene.environmentBRDFTexture.
  57752. */
  57753. static DEFAULT_USE_SMITH_VISIBILITY_HEIGHT_CORRELATED: boolean;
  57754. /**
  57755. * Default value used for the IBL diffuse part.
  57756. * This can help switching back to the polynomials mode globally which is a tiny bit
  57757. * less GPU intensive at the drawback of a lower quality.
  57758. */
  57759. static DEFAULT_USE_SPHERICAL_HARMONICS: boolean;
  57760. /**
  57761. * Default value used for activating energy conservation for the specular workflow.
  57762. * If activated, the albedo color is multiplied with (1. - maxChannel(specular color)).
  57763. * If deactivated, a material is only physically plausible, when (albedo color + specular color) < 1.
  57764. */
  57765. static DEFAULT_USE_SPECULAR_GLOSSINESS_INPUT_ENERGY_CONSERVATION: boolean;
  57766. private _useEnergyConservation;
  57767. /**
  57768. * Defines if the material uses energy conservation.
  57769. */
  57770. useEnergyConservation: boolean;
  57771. private _useSmithVisibilityHeightCorrelated;
  57772. /**
  57773. * LEGACY Mode set to false
  57774. * Defines if the material uses height smith correlated visibility term.
  57775. * If you intent to not use our default BRDF, you need to load a separate BRDF Texture for the PBR
  57776. * You can either load https://assets.babylonjs.com/environments/uncorrelatedBRDF.png
  57777. * or https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds to have more precision
  57778. * Not relying on height correlated will also disable energy conservation.
  57779. */
  57780. useSmithVisibilityHeightCorrelated: boolean;
  57781. private _useSphericalHarmonics;
  57782. /**
  57783. * LEGACY Mode set to false
  57784. * Defines if the material uses spherical harmonics vs spherical polynomials for the
  57785. * diffuse part of the IBL.
  57786. * The harmonics despite a tiny bigger cost has been proven to provide closer results
  57787. * to the ground truth.
  57788. */
  57789. useSphericalHarmonics: boolean;
  57790. private _useSpecularGlossinessInputEnergyConservation;
  57791. /**
  57792. * Defines if the material uses energy conservation, when the specular workflow is active.
  57793. * If activated, the albedo color is multiplied with (1. - maxChannel(specular color)).
  57794. * If deactivated, a material is only physically plausible, when (albedo color + specular color) < 1.
  57795. * In the deactivated case, the material author has to ensure energy conservation, for a physically plausible rendering.
  57796. */
  57797. useSpecularGlossinessInputEnergyConservation: boolean;
  57798. /** @hidden */
  57799. private _internalMarkAllSubMeshesAsMiscDirty;
  57800. /** @hidden */
  57801. _markAllSubMeshesAsMiscDirty(): void;
  57802. /**
  57803. * Instantiate a new istance of clear coat configuration.
  57804. * @param markAllSubMeshesAsMiscDirty Callback to flag the material to dirty
  57805. */
  57806. constructor(markAllSubMeshesAsMiscDirty: () => void);
  57807. /**
  57808. * Checks to see if a texture is used in the material.
  57809. * @param defines the list of "defines" to update.
  57810. */
  57811. prepareDefines(defines: IMaterialBRDFDefines): void;
  57812. /**
  57813. * Get the current class name of the texture useful for serialization or dynamic coding.
  57814. * @returns "PBRClearCoatConfiguration"
  57815. */
  57816. getClassName(): string;
  57817. /**
  57818. * Makes a duplicate of the current configuration into another one.
  57819. * @param brdfConfiguration define the config where to copy the info
  57820. */
  57821. copyTo(brdfConfiguration: PBRBRDFConfiguration): void;
  57822. /**
  57823. * Serializes this BRDF configuration.
  57824. * @returns - An object with the serialized config.
  57825. */
  57826. serialize(): any;
  57827. /**
  57828. * Parses a anisotropy Configuration from a serialized object.
  57829. * @param source - Serialized object.
  57830. * @param scene Defines the scene we are parsing for
  57831. * @param rootUrl Defines the rootUrl to load from
  57832. */
  57833. parse(source: any, scene: Scene, rootUrl: string): void;
  57834. }
  57835. }
  57836. declare module "babylonjs/Materials/PBR/pbrSheenConfiguration" {
  57837. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  57838. import { Color3 } from "babylonjs/Maths/math.color";
  57839. import { Scene } from "babylonjs/scene";
  57840. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  57841. import { Nullable } from "babylonjs/types";
  57842. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  57843. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  57844. /**
  57845. * @hidden
  57846. */
  57847. export interface IMaterialSheenDefines {
  57848. SHEEN: boolean;
  57849. SHEEN_TEXTURE: boolean;
  57850. SHEEN_TEXTUREDIRECTUV: number;
  57851. SHEEN_LINKWITHALBEDO: boolean;
  57852. SHEEN_ROUGHNESS: boolean;
  57853. SHEEN_ALBEDOSCALING: boolean;
  57854. /** @hidden */
  57855. _areTexturesDirty: boolean;
  57856. }
  57857. /**
  57858. * Define the code related to the Sheen parameters of the pbr material.
  57859. */
  57860. export class PBRSheenConfiguration {
  57861. private _isEnabled;
  57862. /**
  57863. * Defines if the material uses sheen.
  57864. */
  57865. isEnabled: boolean;
  57866. private _linkSheenWithAlbedo;
  57867. /**
  57868. * Defines if the sheen is linked to the sheen color.
  57869. */
  57870. linkSheenWithAlbedo: boolean;
  57871. /**
  57872. * Defines the sheen intensity.
  57873. */
  57874. intensity: number;
  57875. /**
  57876. * Defines the sheen color.
  57877. */
  57878. color: Color3;
  57879. private _texture;
  57880. /**
  57881. * Stores the sheen tint values in a texture.
  57882. * rgb is tint
  57883. * a is a intensity or roughness if roughness has been defined
  57884. */
  57885. texture: Nullable<BaseTexture>;
  57886. private _roughness;
  57887. /**
  57888. * Defines the sheen roughness.
  57889. * It is not taken into account if linkSheenWithAlbedo is true.
  57890. * To stay backward compatible, material roughness is used instead if sheen roughness = null
  57891. */
  57892. roughness: Nullable<number>;
  57893. private _albedoScaling;
  57894. /**
  57895. * If true, the sheen effect is layered above the base BRDF with the albedo-scaling technique.
  57896. * It allows the strength of the sheen effect to not depend on the base color of the material,
  57897. * making it easier to setup and tweak the effect
  57898. */
  57899. albedoScaling: boolean;
  57900. /** @hidden */
  57901. private _internalMarkAllSubMeshesAsTexturesDirty;
  57902. /** @hidden */
  57903. _markAllSubMeshesAsTexturesDirty(): void;
  57904. /**
  57905. * Instantiate a new istance of clear coat configuration.
  57906. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  57907. */
  57908. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  57909. /**
  57910. * Specifies that the submesh is ready to be used.
  57911. * @param defines the list of "defines" to update.
  57912. * @param scene defines the scene the material belongs to.
  57913. * @returns - boolean indicating that the submesh is ready or not.
  57914. */
  57915. isReadyForSubMesh(defines: IMaterialSheenDefines, scene: Scene): boolean;
  57916. /**
  57917. * Checks to see if a texture is used in the material.
  57918. * @param defines the list of "defines" to update.
  57919. * @param scene defines the scene the material belongs to.
  57920. */
  57921. prepareDefines(defines: IMaterialSheenDefines, scene: Scene): void;
  57922. /**
  57923. * Binds the material data.
  57924. * @param uniformBuffer defines the Uniform buffer to fill in.
  57925. * @param scene defines the scene the material belongs to.
  57926. * @param isFrozen defines wether the material is frozen or not.
  57927. */
  57928. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  57929. /**
  57930. * Checks to see if a texture is used in the material.
  57931. * @param texture - Base texture to use.
  57932. * @returns - Boolean specifying if a texture is used in the material.
  57933. */
  57934. hasTexture(texture: BaseTexture): boolean;
  57935. /**
  57936. * Returns an array of the actively used textures.
  57937. * @param activeTextures Array of BaseTextures
  57938. */
  57939. getActiveTextures(activeTextures: BaseTexture[]): void;
  57940. /**
  57941. * Returns the animatable textures.
  57942. * @param animatables Array of animatable textures.
  57943. */
  57944. getAnimatables(animatables: IAnimatable[]): void;
  57945. /**
  57946. * Disposes the resources of the material.
  57947. * @param forceDisposeTextures - Forces the disposal of all textures.
  57948. */
  57949. dispose(forceDisposeTextures?: boolean): void;
  57950. /**
  57951. * Get the current class name of the texture useful for serialization or dynamic coding.
  57952. * @returns "PBRSheenConfiguration"
  57953. */
  57954. getClassName(): string;
  57955. /**
  57956. * Add fallbacks to the effect fallbacks list.
  57957. * @param defines defines the Base texture to use.
  57958. * @param fallbacks defines the current fallback list.
  57959. * @param currentRank defines the current fallback rank.
  57960. * @returns the new fallback rank.
  57961. */
  57962. static AddFallbacks(defines: IMaterialSheenDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  57963. /**
  57964. * Add the required uniforms to the current list.
  57965. * @param uniforms defines the current uniform list.
  57966. */
  57967. static AddUniforms(uniforms: string[]): void;
  57968. /**
  57969. * Add the required uniforms to the current buffer.
  57970. * @param uniformBuffer defines the current uniform buffer.
  57971. */
  57972. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  57973. /**
  57974. * Add the required samplers to the current list.
  57975. * @param samplers defines the current sampler list.
  57976. */
  57977. static AddSamplers(samplers: string[]): void;
  57978. /**
  57979. * Makes a duplicate of the current configuration into another one.
  57980. * @param sheenConfiguration define the config where to copy the info
  57981. */
  57982. copyTo(sheenConfiguration: PBRSheenConfiguration): void;
  57983. /**
  57984. * Serializes this BRDF configuration.
  57985. * @returns - An object with the serialized config.
  57986. */
  57987. serialize(): any;
  57988. /**
  57989. * Parses a anisotropy Configuration from a serialized object.
  57990. * @param source - Serialized object.
  57991. * @param scene Defines the scene we are parsing for
  57992. * @param rootUrl Defines the rootUrl to load from
  57993. */
  57994. parse(source: any, scene: Scene, rootUrl: string): void;
  57995. }
  57996. }
  57997. declare module "babylonjs/Materials/PBR/pbrSubSurfaceConfiguration" {
  57998. import { Nullable } from "babylonjs/types";
  57999. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  58000. import { Color3 } from "babylonjs/Maths/math.color";
  58001. import { SmartArray } from "babylonjs/Misc/smartArray";
  58002. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  58003. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  58004. import { Effect } from "babylonjs/Materials/effect";
  58005. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  58006. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  58007. import { Engine } from "babylonjs/Engines/engine";
  58008. import { Scene } from "babylonjs/scene";
  58009. /**
  58010. * @hidden
  58011. */
  58012. export interface IMaterialSubSurfaceDefines {
  58013. SUBSURFACE: boolean;
  58014. SS_REFRACTION: boolean;
  58015. SS_TRANSLUCENCY: boolean;
  58016. SS_SCATTERING: boolean;
  58017. SS_THICKNESSANDMASK_TEXTURE: boolean;
  58018. SS_THICKNESSANDMASK_TEXTUREDIRECTUV: number;
  58019. SS_REFRACTIONMAP_3D: boolean;
  58020. SS_REFRACTIONMAP_OPPOSITEZ: boolean;
  58021. SS_LODINREFRACTIONALPHA: boolean;
  58022. SS_GAMMAREFRACTION: boolean;
  58023. SS_RGBDREFRACTION: boolean;
  58024. SS_LINEARSPECULARREFRACTION: boolean;
  58025. SS_LINKREFRACTIONTOTRANSPARENCY: boolean;
  58026. SS_ALBEDOFORREFRACTIONTINT: boolean;
  58027. SS_MASK_FROM_THICKNESS_TEXTURE: boolean;
  58028. /** @hidden */
  58029. _areTexturesDirty: boolean;
  58030. }
  58031. /**
  58032. * Define the code related to the sub surface parameters of the pbr material.
  58033. */
  58034. export class PBRSubSurfaceConfiguration {
  58035. private _isRefractionEnabled;
  58036. /**
  58037. * Defines if the refraction is enabled in the material.
  58038. */
  58039. isRefractionEnabled: boolean;
  58040. private _isTranslucencyEnabled;
  58041. /**
  58042. * Defines if the translucency is enabled in the material.
  58043. */
  58044. isTranslucencyEnabled: boolean;
  58045. private _isScatteringEnabled;
  58046. /**
  58047. * Defines if the sub surface scattering is enabled in the material.
  58048. */
  58049. isScatteringEnabled: boolean;
  58050. private _scatteringDiffusionProfileIndex;
  58051. /**
  58052. * Diffusion profile for subsurface scattering.
  58053. * Useful for better scattering in the skins or foliages.
  58054. */
  58055. get scatteringDiffusionProfile(): Nullable<Color3>;
  58056. set scatteringDiffusionProfile(c: Nullable<Color3>);
  58057. /**
  58058. * Defines the refraction intensity of the material.
  58059. * The refraction when enabled replaces the Diffuse part of the material.
  58060. * The intensity helps transitionning between diffuse and refraction.
  58061. */
  58062. refractionIntensity: number;
  58063. /**
  58064. * Defines the translucency intensity of the material.
  58065. * When translucency has been enabled, this defines how much of the "translucency"
  58066. * is addded to the diffuse part of the material.
  58067. */
  58068. translucencyIntensity: number;
  58069. /**
  58070. * When enabled, transparent surfaces will be tinted with the albedo colour (independent of thickness)
  58071. */
  58072. useAlbedoToTintRefraction: boolean;
  58073. private _thicknessTexture;
  58074. /**
  58075. * Stores the average thickness of a mesh in a texture (The texture is holding the values linearly).
  58076. * The red channel of the texture should contain the thickness remapped between 0 and 1.
  58077. * 0 would mean minimumThickness
  58078. * 1 would mean maximumThickness
  58079. * The other channels might be use as a mask to vary the different effects intensity.
  58080. */
  58081. thicknessTexture: Nullable<BaseTexture>;
  58082. private _refractionTexture;
  58083. /**
  58084. * Defines the texture to use for refraction.
  58085. */
  58086. refractionTexture: Nullable<BaseTexture>;
  58087. private _indexOfRefraction;
  58088. /**
  58089. * Index of refraction of the material base layer.
  58090. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  58091. *
  58092. * This does not only impact refraction but also the Base F0 of Dielectric Materials.
  58093. *
  58094. * From dielectric fresnel rules: F0 = square((iorT - iorI) / (iorT + iorI))
  58095. */
  58096. indexOfRefraction: number;
  58097. private _volumeIndexOfRefraction;
  58098. /**
  58099. * Index of refraction of the material's volume.
  58100. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  58101. *
  58102. * This ONLY impacts refraction. If not provided or given a non-valid value,
  58103. * the volume will use the same IOR as the surface.
  58104. */
  58105. get volumeIndexOfRefraction(): number;
  58106. set volumeIndexOfRefraction(value: number);
  58107. private _invertRefractionY;
  58108. /**
  58109. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  58110. */
  58111. invertRefractionY: boolean;
  58112. private _linkRefractionWithTransparency;
  58113. /**
  58114. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  58115. * Materials half opaque for instance using refraction could benefit from this control.
  58116. */
  58117. linkRefractionWithTransparency: boolean;
  58118. /**
  58119. * Defines the minimum thickness stored in the thickness map.
  58120. * If no thickness map is defined, this value will be used to simulate thickness.
  58121. */
  58122. minimumThickness: number;
  58123. /**
  58124. * Defines the maximum thickness stored in the thickness map.
  58125. */
  58126. maximumThickness: number;
  58127. /**
  58128. * Defines the volume tint of the material.
  58129. * This is used for both translucency and scattering.
  58130. */
  58131. tintColor: Color3;
  58132. /**
  58133. * Defines the distance at which the tint color should be found in the media.
  58134. * This is used for refraction only.
  58135. */
  58136. tintColorAtDistance: number;
  58137. /**
  58138. * Defines how far each channel transmit through the media.
  58139. * It is defined as a color to simplify it selection.
  58140. */
  58141. diffusionDistance: Color3;
  58142. private _useMaskFromThicknessTexture;
  58143. /**
  58144. * Stores the intensity of the different subsurface effects in the thickness texture.
  58145. * * the green channel is the translucency intensity.
  58146. * * the blue channel is the scattering intensity.
  58147. * * the alpha channel is the refraction intensity.
  58148. */
  58149. useMaskFromThicknessTexture: boolean;
  58150. private _scene;
  58151. /** @hidden */
  58152. private _internalMarkAllSubMeshesAsTexturesDirty;
  58153. private _internalMarkScenePrePassDirty;
  58154. /** @hidden */
  58155. _markAllSubMeshesAsTexturesDirty(): void;
  58156. /** @hidden */
  58157. _markScenePrePassDirty(): void;
  58158. /**
  58159. * Instantiate a new istance of sub surface configuration.
  58160. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  58161. * @param markScenePrePassDirty Callback to flag the scene as prepass dirty
  58162. * @param scene The scene
  58163. */
  58164. constructor(markAllSubMeshesAsTexturesDirty: () => void, markScenePrePassDirty: () => void, scene: Scene);
  58165. /**
  58166. * Gets wehter the submesh is ready to be used or not.
  58167. * @param defines the list of "defines" to update.
  58168. * @param scene defines the scene the material belongs to.
  58169. * @returns - boolean indicating that the submesh is ready or not.
  58170. */
  58171. isReadyForSubMesh(defines: IMaterialSubSurfaceDefines, scene: Scene): boolean;
  58172. /**
  58173. * Checks to see if a texture is used in the material.
  58174. * @param defines the list of "defines" to update.
  58175. * @param scene defines the scene to the material belongs to.
  58176. */
  58177. prepareDefines(defines: IMaterialSubSurfaceDefines, scene: Scene): void;
  58178. /**
  58179. * Binds the material data.
  58180. * @param uniformBuffer defines the Uniform buffer to fill in.
  58181. * @param scene defines the scene the material belongs to.
  58182. * @param engine defines the engine the material belongs to.
  58183. * @param isFrozen defines whether the material is frozen or not.
  58184. * @param lodBasedMicrosurface defines whether the material relies on lod based microsurface or not.
  58185. * @param realTimeFiltering defines whether the textures should be filtered on the fly.
  58186. */
  58187. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, engine: Engine, isFrozen: boolean, lodBasedMicrosurface: boolean, realTimeFiltering: boolean): void;
  58188. /**
  58189. * Unbinds the material from the mesh.
  58190. * @param activeEffect defines the effect that should be unbound from.
  58191. * @returns true if unbound, otherwise false
  58192. */
  58193. unbind(activeEffect: Effect): boolean;
  58194. /**
  58195. * Returns the texture used for refraction or null if none is used.
  58196. * @param scene defines the scene the material belongs to.
  58197. * @returns - Refraction texture if present. If no refraction texture and refraction
  58198. * is linked with transparency, returns environment texture. Otherwise, returns null.
  58199. */
  58200. private _getRefractionTexture;
  58201. /**
  58202. * Returns true if alpha blending should be disabled.
  58203. */
  58204. get disableAlphaBlending(): boolean;
  58205. /**
  58206. * Fills the list of render target textures.
  58207. * @param renderTargets the list of render targets to update
  58208. */
  58209. fillRenderTargetTextures(renderTargets: SmartArray<RenderTargetTexture>): void;
  58210. /**
  58211. * Checks to see if a texture is used in the material.
  58212. * @param texture - Base texture to use.
  58213. * @returns - Boolean specifying if a texture is used in the material.
  58214. */
  58215. hasTexture(texture: BaseTexture): boolean;
  58216. /**
  58217. * Gets a boolean indicating that current material needs to register RTT
  58218. * @returns true if this uses a render target otherwise false.
  58219. */
  58220. hasRenderTargetTextures(): boolean;
  58221. /**
  58222. * Returns an array of the actively used textures.
  58223. * @param activeTextures Array of BaseTextures
  58224. */
  58225. getActiveTextures(activeTextures: BaseTexture[]): void;
  58226. /**
  58227. * Returns the animatable textures.
  58228. * @param animatables Array of animatable textures.
  58229. */
  58230. getAnimatables(animatables: IAnimatable[]): void;
  58231. /**
  58232. * Disposes the resources of the material.
  58233. * @param forceDisposeTextures - Forces the disposal of all textures.
  58234. */
  58235. dispose(forceDisposeTextures?: boolean): void;
  58236. /**
  58237. * Get the current class name of the texture useful for serialization or dynamic coding.
  58238. * @returns "PBRSubSurfaceConfiguration"
  58239. */
  58240. getClassName(): string;
  58241. /**
  58242. * Add fallbacks to the effect fallbacks list.
  58243. * @param defines defines the Base texture to use.
  58244. * @param fallbacks defines the current fallback list.
  58245. * @param currentRank defines the current fallback rank.
  58246. * @returns the new fallback rank.
  58247. */
  58248. static AddFallbacks(defines: IMaterialSubSurfaceDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  58249. /**
  58250. * Add the required uniforms to the current list.
  58251. * @param uniforms defines the current uniform list.
  58252. */
  58253. static AddUniforms(uniforms: string[]): void;
  58254. /**
  58255. * Add the required samplers to the current list.
  58256. * @param samplers defines the current sampler list.
  58257. */
  58258. static AddSamplers(samplers: string[]): void;
  58259. /**
  58260. * Add the required uniforms to the current buffer.
  58261. * @param uniformBuffer defines the current uniform buffer.
  58262. */
  58263. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  58264. /**
  58265. * Makes a duplicate of the current configuration into another one.
  58266. * @param configuration define the config where to copy the info
  58267. */
  58268. copyTo(configuration: PBRSubSurfaceConfiguration): void;
  58269. /**
  58270. * Serializes this Sub Surface configuration.
  58271. * @returns - An object with the serialized config.
  58272. */
  58273. serialize(): any;
  58274. /**
  58275. * Parses a anisotropy Configuration from a serialized object.
  58276. * @param source - Serialized object.
  58277. * @param scene Defines the scene we are parsing for
  58278. * @param rootUrl Defines the rootUrl to load from
  58279. */
  58280. parse(source: any, scene: Scene, rootUrl: string): void;
  58281. }
  58282. }
  58283. declare module "babylonjs/Shaders/ShadersInclude/pbrFragmentDeclaration" {
  58284. /** @hidden */
  58285. export var pbrFragmentDeclaration: {
  58286. name: string;
  58287. shader: string;
  58288. };
  58289. }
  58290. declare module "babylonjs/Shaders/ShadersInclude/pbrUboDeclaration" {
  58291. /** @hidden */
  58292. export var pbrUboDeclaration: {
  58293. name: string;
  58294. shader: string;
  58295. };
  58296. }
  58297. declare module "babylonjs/Shaders/ShadersInclude/pbrFragmentExtraDeclaration" {
  58298. /** @hidden */
  58299. export var pbrFragmentExtraDeclaration: {
  58300. name: string;
  58301. shader: string;
  58302. };
  58303. }
  58304. declare module "babylonjs/Shaders/ShadersInclude/pbrFragmentSamplersDeclaration" {
  58305. /** @hidden */
  58306. export var pbrFragmentSamplersDeclaration: {
  58307. name: string;
  58308. shader: string;
  58309. };
  58310. }
  58311. declare module "babylonjs/Shaders/ShadersInclude/importanceSampling" {
  58312. /** @hidden */
  58313. export var importanceSampling: {
  58314. name: string;
  58315. shader: string;
  58316. };
  58317. }
  58318. declare module "babylonjs/Shaders/ShadersInclude/pbrHelperFunctions" {
  58319. /** @hidden */
  58320. export var pbrHelperFunctions: {
  58321. name: string;
  58322. shader: string;
  58323. };
  58324. }
  58325. declare module "babylonjs/Shaders/ShadersInclude/harmonicsFunctions" {
  58326. /** @hidden */
  58327. export var harmonicsFunctions: {
  58328. name: string;
  58329. shader: string;
  58330. };
  58331. }
  58332. declare module "babylonjs/Shaders/ShadersInclude/pbrDirectLightingSetupFunctions" {
  58333. /** @hidden */
  58334. export var pbrDirectLightingSetupFunctions: {
  58335. name: string;
  58336. shader: string;
  58337. };
  58338. }
  58339. declare module "babylonjs/Shaders/ShadersInclude/pbrDirectLightingFalloffFunctions" {
  58340. /** @hidden */
  58341. export var pbrDirectLightingFalloffFunctions: {
  58342. name: string;
  58343. shader: string;
  58344. };
  58345. }
  58346. declare module "babylonjs/Shaders/ShadersInclude/pbrBRDFFunctions" {
  58347. /** @hidden */
  58348. export var pbrBRDFFunctions: {
  58349. name: string;
  58350. shader: string;
  58351. };
  58352. }
  58353. declare module "babylonjs/Shaders/ShadersInclude/hdrFilteringFunctions" {
  58354. /** @hidden */
  58355. export var hdrFilteringFunctions: {
  58356. name: string;
  58357. shader: string;
  58358. };
  58359. }
  58360. declare module "babylonjs/Shaders/ShadersInclude/pbrDirectLightingFunctions" {
  58361. /** @hidden */
  58362. export var pbrDirectLightingFunctions: {
  58363. name: string;
  58364. shader: string;
  58365. };
  58366. }
  58367. declare module "babylonjs/Shaders/ShadersInclude/pbrIBLFunctions" {
  58368. /** @hidden */
  58369. export var pbrIBLFunctions: {
  58370. name: string;
  58371. shader: string;
  58372. };
  58373. }
  58374. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockAlbedoOpacity" {
  58375. /** @hidden */
  58376. export var pbrBlockAlbedoOpacity: {
  58377. name: string;
  58378. shader: string;
  58379. };
  58380. }
  58381. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockReflectivity" {
  58382. /** @hidden */
  58383. export var pbrBlockReflectivity: {
  58384. name: string;
  58385. shader: string;
  58386. };
  58387. }
  58388. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockAmbientOcclusion" {
  58389. /** @hidden */
  58390. export var pbrBlockAmbientOcclusion: {
  58391. name: string;
  58392. shader: string;
  58393. };
  58394. }
  58395. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockAlphaFresnel" {
  58396. /** @hidden */
  58397. export var pbrBlockAlphaFresnel: {
  58398. name: string;
  58399. shader: string;
  58400. };
  58401. }
  58402. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockAnisotropic" {
  58403. /** @hidden */
  58404. export var pbrBlockAnisotropic: {
  58405. name: string;
  58406. shader: string;
  58407. };
  58408. }
  58409. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockReflection" {
  58410. /** @hidden */
  58411. export var pbrBlockReflection: {
  58412. name: string;
  58413. shader: string;
  58414. };
  58415. }
  58416. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockSheen" {
  58417. /** @hidden */
  58418. export var pbrBlockSheen: {
  58419. name: string;
  58420. shader: string;
  58421. };
  58422. }
  58423. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockClearcoat" {
  58424. /** @hidden */
  58425. export var pbrBlockClearcoat: {
  58426. name: string;
  58427. shader: string;
  58428. };
  58429. }
  58430. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockSubSurface" {
  58431. /** @hidden */
  58432. export var pbrBlockSubSurface: {
  58433. name: string;
  58434. shader: string;
  58435. };
  58436. }
  58437. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockNormalGeometric" {
  58438. /** @hidden */
  58439. export var pbrBlockNormalGeometric: {
  58440. name: string;
  58441. shader: string;
  58442. };
  58443. }
  58444. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockNormalFinal" {
  58445. /** @hidden */
  58446. export var pbrBlockNormalFinal: {
  58447. name: string;
  58448. shader: string;
  58449. };
  58450. }
  58451. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockLightmapInit" {
  58452. /** @hidden */
  58453. export var pbrBlockLightmapInit: {
  58454. name: string;
  58455. shader: string;
  58456. };
  58457. }
  58458. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockGeometryInfo" {
  58459. /** @hidden */
  58460. export var pbrBlockGeometryInfo: {
  58461. name: string;
  58462. shader: string;
  58463. };
  58464. }
  58465. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockReflectance0" {
  58466. /** @hidden */
  58467. export var pbrBlockReflectance0: {
  58468. name: string;
  58469. shader: string;
  58470. };
  58471. }
  58472. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockReflectance" {
  58473. /** @hidden */
  58474. export var pbrBlockReflectance: {
  58475. name: string;
  58476. shader: string;
  58477. };
  58478. }
  58479. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockDirectLighting" {
  58480. /** @hidden */
  58481. export var pbrBlockDirectLighting: {
  58482. name: string;
  58483. shader: string;
  58484. };
  58485. }
  58486. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockFinalLitComponents" {
  58487. /** @hidden */
  58488. export var pbrBlockFinalLitComponents: {
  58489. name: string;
  58490. shader: string;
  58491. };
  58492. }
  58493. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockFinalUnlitComponents" {
  58494. /** @hidden */
  58495. export var pbrBlockFinalUnlitComponents: {
  58496. name: string;
  58497. shader: string;
  58498. };
  58499. }
  58500. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockFinalColorComposition" {
  58501. /** @hidden */
  58502. export var pbrBlockFinalColorComposition: {
  58503. name: string;
  58504. shader: string;
  58505. };
  58506. }
  58507. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockImageProcessing" {
  58508. /** @hidden */
  58509. export var pbrBlockImageProcessing: {
  58510. name: string;
  58511. shader: string;
  58512. };
  58513. }
  58514. declare module "babylonjs/Shaders/ShadersInclude/pbrDebug" {
  58515. /** @hidden */
  58516. export var pbrDebug: {
  58517. name: string;
  58518. shader: string;
  58519. };
  58520. }
  58521. declare module "babylonjs/Shaders/pbr.fragment" {
  58522. import "babylonjs/Shaders/ShadersInclude/prePassDeclaration";
  58523. import "babylonjs/Shaders/ShadersInclude/pbrFragmentDeclaration";
  58524. import "babylonjs/Shaders/ShadersInclude/pbrUboDeclaration";
  58525. import "babylonjs/Shaders/ShadersInclude/pbrFragmentExtraDeclaration";
  58526. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  58527. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  58528. import "babylonjs/Shaders/ShadersInclude/pbrFragmentSamplersDeclaration";
  58529. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  58530. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  58531. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  58532. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  58533. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  58534. import "babylonjs/Shaders/ShadersInclude/subSurfaceScatteringFunctions";
  58535. import "babylonjs/Shaders/ShadersInclude/importanceSampling";
  58536. import "babylonjs/Shaders/ShadersInclude/pbrHelperFunctions";
  58537. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  58538. import "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions";
  58539. import "babylonjs/Shaders/ShadersInclude/harmonicsFunctions";
  58540. import "babylonjs/Shaders/ShadersInclude/pbrDirectLightingSetupFunctions";
  58541. import "babylonjs/Shaders/ShadersInclude/pbrDirectLightingFalloffFunctions";
  58542. import "babylonjs/Shaders/ShadersInclude/pbrBRDFFunctions";
  58543. import "babylonjs/Shaders/ShadersInclude/hdrFilteringFunctions";
  58544. import "babylonjs/Shaders/ShadersInclude/pbrDirectLightingFunctions";
  58545. import "babylonjs/Shaders/ShadersInclude/pbrIBLFunctions";
  58546. import "babylonjs/Shaders/ShadersInclude/bumpFragmentMainFunctions";
  58547. import "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions";
  58548. import "babylonjs/Shaders/ShadersInclude/reflectionFunction";
  58549. import "babylonjs/Shaders/ShadersInclude/pbrBlockAlbedoOpacity";
  58550. import "babylonjs/Shaders/ShadersInclude/pbrBlockReflectivity";
  58551. import "babylonjs/Shaders/ShadersInclude/pbrBlockAmbientOcclusion";
  58552. import "babylonjs/Shaders/ShadersInclude/pbrBlockAlphaFresnel";
  58553. import "babylonjs/Shaders/ShadersInclude/pbrBlockAnisotropic";
  58554. import "babylonjs/Shaders/ShadersInclude/pbrBlockReflection";
  58555. import "babylonjs/Shaders/ShadersInclude/pbrBlockSheen";
  58556. import "babylonjs/Shaders/ShadersInclude/pbrBlockClearcoat";
  58557. import "babylonjs/Shaders/ShadersInclude/pbrBlockSubSurface";
  58558. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  58559. import "babylonjs/Shaders/ShadersInclude/pbrBlockNormalGeometric";
  58560. import "babylonjs/Shaders/ShadersInclude/bumpFragment";
  58561. import "babylonjs/Shaders/ShadersInclude/pbrBlockNormalFinal";
  58562. import "babylonjs/Shaders/ShadersInclude/depthPrePass";
  58563. import "babylonjs/Shaders/ShadersInclude/pbrBlockLightmapInit";
  58564. import "babylonjs/Shaders/ShadersInclude/pbrBlockGeometryInfo";
  58565. import "babylonjs/Shaders/ShadersInclude/pbrBlockReflectance0";
  58566. import "babylonjs/Shaders/ShadersInclude/pbrBlockReflectance";
  58567. import "babylonjs/Shaders/ShadersInclude/pbrBlockDirectLighting";
  58568. import "babylonjs/Shaders/ShadersInclude/lightFragment";
  58569. import "babylonjs/Shaders/ShadersInclude/pbrBlockFinalLitComponents";
  58570. import "babylonjs/Shaders/ShadersInclude/pbrBlockFinalUnlitComponents";
  58571. import "babylonjs/Shaders/ShadersInclude/pbrBlockFinalColorComposition";
  58572. import "babylonjs/Shaders/ShadersInclude/logDepthFragment";
  58573. import "babylonjs/Shaders/ShadersInclude/fogFragment";
  58574. import "babylonjs/Shaders/ShadersInclude/pbrBlockImageProcessing";
  58575. import "babylonjs/Shaders/ShadersInclude/pbrDebug";
  58576. /** @hidden */
  58577. export var pbrPixelShader: {
  58578. name: string;
  58579. shader: string;
  58580. };
  58581. }
  58582. declare module "babylonjs/Shaders/ShadersInclude/pbrVertexDeclaration" {
  58583. /** @hidden */
  58584. export var pbrVertexDeclaration: {
  58585. name: string;
  58586. shader: string;
  58587. };
  58588. }
  58589. declare module "babylonjs/Shaders/pbr.vertex" {
  58590. import "babylonjs/Shaders/ShadersInclude/pbrVertexDeclaration";
  58591. import "babylonjs/Shaders/ShadersInclude/pbrUboDeclaration";
  58592. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  58593. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  58594. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  58595. import "babylonjs/Shaders/ShadersInclude/harmonicsFunctions";
  58596. import "babylonjs/Shaders/ShadersInclude/bumpVertexDeclaration";
  58597. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  58598. import "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration";
  58599. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  58600. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  58601. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  58602. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  58603. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  58604. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  58605. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  58606. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  58607. import "babylonjs/Shaders/ShadersInclude/bumpVertex";
  58608. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  58609. import "babylonjs/Shaders/ShadersInclude/fogVertex";
  58610. import "babylonjs/Shaders/ShadersInclude/shadowsVertex";
  58611. import "babylonjs/Shaders/ShadersInclude/logDepthVertex";
  58612. /** @hidden */
  58613. export var pbrVertexShader: {
  58614. name: string;
  58615. shader: string;
  58616. };
  58617. }
  58618. declare module "babylonjs/Materials/PBR/pbrBaseMaterial" {
  58619. import { Nullable } from "babylonjs/types";
  58620. import { Scene } from "babylonjs/scene";
  58621. import { Matrix } from "babylonjs/Maths/math.vector";
  58622. import { SubMesh } from "babylonjs/Meshes/subMesh";
  58623. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  58624. import { Mesh } from "babylonjs/Meshes/mesh";
  58625. import { IMaterialClearCoatDefines, PBRClearCoatConfiguration } from "babylonjs/Materials/PBR/pbrClearCoatConfiguration";
  58626. import { IMaterialAnisotropicDefines, PBRAnisotropicConfiguration } from "babylonjs/Materials/PBR/pbrAnisotropicConfiguration";
  58627. import { IMaterialBRDFDefines, PBRBRDFConfiguration } from "babylonjs/Materials/PBR/pbrBRDFConfiguration";
  58628. import { IMaterialSheenDefines, PBRSheenConfiguration } from "babylonjs/Materials/PBR/pbrSheenConfiguration";
  58629. import { IMaterialSubSurfaceDefines, PBRSubSurfaceConfiguration } from "babylonjs/Materials/PBR/pbrSubSurfaceConfiguration";
  58630. import { Color3 } from "babylonjs/Maths/math.color";
  58631. import { ImageProcessingConfiguration, IImageProcessingConfigurationDefines } from "babylonjs/Materials/imageProcessingConfiguration";
  58632. import { Material, IMaterialCompilationOptions } from "babylonjs/Materials/material";
  58633. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  58634. import { PushMaterial } from "babylonjs/Materials/pushMaterial";
  58635. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  58636. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  58637. import "babylonjs/Materials/Textures/baseTexture.polynomial";
  58638. import "babylonjs/Shaders/pbr.fragment";
  58639. import "babylonjs/Shaders/pbr.vertex";
  58640. import { IMaterialDetailMapDefines, DetailMapConfiguration } from "babylonjs/Materials/material.detailMapConfiguration";
  58641. import { PrePassRenderer } from "babylonjs/Rendering/prePassRenderer";
  58642. /**
  58643. * Manages the defines for the PBR Material.
  58644. * @hidden
  58645. */
  58646. export class PBRMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines, IMaterialClearCoatDefines, IMaterialAnisotropicDefines, IMaterialBRDFDefines, IMaterialSheenDefines, IMaterialSubSurfaceDefines, IMaterialDetailMapDefines {
  58647. PBR: boolean;
  58648. NUM_SAMPLES: string;
  58649. REALTIME_FILTERING: boolean;
  58650. MAINUV1: boolean;
  58651. MAINUV2: boolean;
  58652. UV1: boolean;
  58653. UV2: boolean;
  58654. ALBEDO: boolean;
  58655. GAMMAALBEDO: boolean;
  58656. ALBEDODIRECTUV: number;
  58657. VERTEXCOLOR: boolean;
  58658. DETAIL: boolean;
  58659. DETAILDIRECTUV: number;
  58660. DETAIL_NORMALBLENDMETHOD: number;
  58661. AMBIENT: boolean;
  58662. AMBIENTDIRECTUV: number;
  58663. AMBIENTINGRAYSCALE: boolean;
  58664. OPACITY: boolean;
  58665. VERTEXALPHA: boolean;
  58666. OPACITYDIRECTUV: number;
  58667. OPACITYRGB: boolean;
  58668. ALPHATEST: boolean;
  58669. DEPTHPREPASS: boolean;
  58670. ALPHABLEND: boolean;
  58671. ALPHAFROMALBEDO: boolean;
  58672. ALPHATESTVALUE: string;
  58673. SPECULAROVERALPHA: boolean;
  58674. RADIANCEOVERALPHA: boolean;
  58675. ALPHAFRESNEL: boolean;
  58676. LINEARALPHAFRESNEL: boolean;
  58677. PREMULTIPLYALPHA: boolean;
  58678. EMISSIVE: boolean;
  58679. EMISSIVEDIRECTUV: number;
  58680. REFLECTIVITY: boolean;
  58681. REFLECTIVITYDIRECTUV: number;
  58682. SPECULARTERM: boolean;
  58683. MICROSURFACEFROMREFLECTIVITYMAP: boolean;
  58684. MICROSURFACEAUTOMATIC: boolean;
  58685. LODBASEDMICROSFURACE: boolean;
  58686. MICROSURFACEMAP: boolean;
  58687. MICROSURFACEMAPDIRECTUV: number;
  58688. METALLICWORKFLOW: boolean;
  58689. ROUGHNESSSTOREINMETALMAPALPHA: boolean;
  58690. ROUGHNESSSTOREINMETALMAPGREEN: boolean;
  58691. METALLNESSSTOREINMETALMAPBLUE: boolean;
  58692. AOSTOREINMETALMAPRED: boolean;
  58693. METALLIC_REFLECTANCE: boolean;
  58694. METALLIC_REFLECTANCEDIRECTUV: number;
  58695. ENVIRONMENTBRDF: boolean;
  58696. ENVIRONMENTBRDF_RGBD: boolean;
  58697. NORMAL: boolean;
  58698. TANGENT: boolean;
  58699. BUMP: boolean;
  58700. BUMPDIRECTUV: number;
  58701. OBJECTSPACE_NORMALMAP: boolean;
  58702. PARALLAX: boolean;
  58703. PARALLAXOCCLUSION: boolean;
  58704. NORMALXYSCALE: boolean;
  58705. LIGHTMAP: boolean;
  58706. LIGHTMAPDIRECTUV: number;
  58707. USELIGHTMAPASSHADOWMAP: boolean;
  58708. GAMMALIGHTMAP: boolean;
  58709. RGBDLIGHTMAP: boolean;
  58710. REFLECTION: boolean;
  58711. REFLECTIONMAP_3D: boolean;
  58712. REFLECTIONMAP_SPHERICAL: boolean;
  58713. REFLECTIONMAP_PLANAR: boolean;
  58714. REFLECTIONMAP_CUBIC: boolean;
  58715. USE_LOCAL_REFLECTIONMAP_CUBIC: boolean;
  58716. REFLECTIONMAP_PROJECTION: boolean;
  58717. REFLECTIONMAP_SKYBOX: boolean;
  58718. REFLECTIONMAP_EXPLICIT: boolean;
  58719. REFLECTIONMAP_EQUIRECTANGULAR: boolean;
  58720. REFLECTIONMAP_EQUIRECTANGULAR_FIXED: boolean;
  58721. REFLECTIONMAP_MIRROREDEQUIRECTANGULAR_FIXED: boolean;
  58722. INVERTCUBICMAP: boolean;
  58723. USESPHERICALFROMREFLECTIONMAP: boolean;
  58724. USEIRRADIANCEMAP: boolean;
  58725. SPHERICAL_HARMONICS: boolean;
  58726. USESPHERICALINVERTEX: boolean;
  58727. REFLECTIONMAP_OPPOSITEZ: boolean;
  58728. LODINREFLECTIONALPHA: boolean;
  58729. GAMMAREFLECTION: boolean;
  58730. RGBDREFLECTION: boolean;
  58731. LINEARSPECULARREFLECTION: boolean;
  58732. RADIANCEOCCLUSION: boolean;
  58733. HORIZONOCCLUSION: boolean;
  58734. INSTANCES: boolean;
  58735. THIN_INSTANCES: boolean;
  58736. PREPASS: boolean;
  58737. SCENE_MRT_COUNT: number;
  58738. NUM_BONE_INFLUENCERS: number;
  58739. BonesPerMesh: number;
  58740. BONETEXTURE: boolean;
  58741. NONUNIFORMSCALING: boolean;
  58742. MORPHTARGETS: boolean;
  58743. MORPHTARGETS_NORMAL: boolean;
  58744. MORPHTARGETS_TANGENT: boolean;
  58745. MORPHTARGETS_UV: boolean;
  58746. NUM_MORPH_INFLUENCERS: number;
  58747. IMAGEPROCESSING: boolean;
  58748. VIGNETTE: boolean;
  58749. VIGNETTEBLENDMODEMULTIPLY: boolean;
  58750. VIGNETTEBLENDMODEOPAQUE: boolean;
  58751. TONEMAPPING: boolean;
  58752. TONEMAPPING_ACES: boolean;
  58753. CONTRAST: boolean;
  58754. COLORCURVES: boolean;
  58755. COLORGRADING: boolean;
  58756. COLORGRADING3D: boolean;
  58757. SAMPLER3DGREENDEPTH: boolean;
  58758. SAMPLER3DBGRMAP: boolean;
  58759. IMAGEPROCESSINGPOSTPROCESS: boolean;
  58760. EXPOSURE: boolean;
  58761. MULTIVIEW: boolean;
  58762. USEPHYSICALLIGHTFALLOFF: boolean;
  58763. USEGLTFLIGHTFALLOFF: boolean;
  58764. TWOSIDEDLIGHTING: boolean;
  58765. SHADOWFLOAT: boolean;
  58766. CLIPPLANE: boolean;
  58767. CLIPPLANE2: boolean;
  58768. CLIPPLANE3: boolean;
  58769. CLIPPLANE4: boolean;
  58770. CLIPPLANE5: boolean;
  58771. CLIPPLANE6: boolean;
  58772. POINTSIZE: boolean;
  58773. FOG: boolean;
  58774. LOGARITHMICDEPTH: boolean;
  58775. FORCENORMALFORWARD: boolean;
  58776. SPECULARAA: boolean;
  58777. CLEARCOAT: boolean;
  58778. CLEARCOAT_DEFAULTIOR: boolean;
  58779. CLEARCOAT_TEXTURE: boolean;
  58780. CLEARCOAT_TEXTUREDIRECTUV: number;
  58781. CLEARCOAT_BUMP: boolean;
  58782. CLEARCOAT_BUMPDIRECTUV: number;
  58783. CLEARCOAT_TINT: boolean;
  58784. CLEARCOAT_TINT_TEXTURE: boolean;
  58785. CLEARCOAT_TINT_TEXTUREDIRECTUV: number;
  58786. ANISOTROPIC: boolean;
  58787. ANISOTROPIC_TEXTURE: boolean;
  58788. ANISOTROPIC_TEXTUREDIRECTUV: number;
  58789. BRDF_V_HEIGHT_CORRELATED: boolean;
  58790. MS_BRDF_ENERGY_CONSERVATION: boolean;
  58791. SPECULAR_GLOSSINESS_ENERGY_CONSERVATION: boolean;
  58792. SHEEN: boolean;
  58793. SHEEN_TEXTURE: boolean;
  58794. SHEEN_TEXTUREDIRECTUV: number;
  58795. SHEEN_LINKWITHALBEDO: boolean;
  58796. SHEEN_ROUGHNESS: boolean;
  58797. SHEEN_ALBEDOSCALING: boolean;
  58798. SUBSURFACE: boolean;
  58799. SS_REFRACTION: boolean;
  58800. SS_TRANSLUCENCY: boolean;
  58801. SS_SCATTERING: boolean;
  58802. SS_THICKNESSANDMASK_TEXTURE: boolean;
  58803. SS_THICKNESSANDMASK_TEXTUREDIRECTUV: number;
  58804. SS_REFRACTIONMAP_3D: boolean;
  58805. SS_REFRACTIONMAP_OPPOSITEZ: boolean;
  58806. SS_LODINREFRACTIONALPHA: boolean;
  58807. SS_GAMMAREFRACTION: boolean;
  58808. SS_RGBDREFRACTION: boolean;
  58809. SS_LINEARSPECULARREFRACTION: boolean;
  58810. SS_LINKREFRACTIONTOTRANSPARENCY: boolean;
  58811. SS_ALBEDOFORREFRACTIONTINT: boolean;
  58812. SS_MASK_FROM_THICKNESS_TEXTURE: boolean;
  58813. UNLIT: boolean;
  58814. DEBUGMODE: number;
  58815. /**
  58816. * Initializes the PBR Material defines.
  58817. */
  58818. constructor();
  58819. /**
  58820. * Resets the PBR Material defines.
  58821. */
  58822. reset(): void;
  58823. }
  58824. /**
  58825. * The Physically based material base class of BJS.
  58826. *
  58827. * This offers the main features of a standard PBR material.
  58828. * For more information, please refer to the documentation :
  58829. * https://doc.babylonjs.com/how_to/physically_based_rendering
  58830. */
  58831. export abstract class PBRBaseMaterial extends PushMaterial {
  58832. /**
  58833. * PBRMaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  58834. */
  58835. static readonly PBRMATERIAL_OPAQUE: number;
  58836. /**
  58837. * PBRMaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  58838. */
  58839. static readonly PBRMATERIAL_ALPHATEST: number;
  58840. /**
  58841. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  58842. */
  58843. static readonly PBRMATERIAL_ALPHABLEND: number;
  58844. /**
  58845. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  58846. * They are also discarded below the alpha cutoff threshold to improve performances.
  58847. */
  58848. static readonly PBRMATERIAL_ALPHATESTANDBLEND: number;
  58849. /**
  58850. * Defines the default value of how much AO map is occluding the analytical lights
  58851. * (point spot...).
  58852. */
  58853. static DEFAULT_AO_ON_ANALYTICAL_LIGHTS: number;
  58854. /**
  58855. * PBRMaterialLightFalloff Physical: light is falling off following the inverse squared distance law.
  58856. */
  58857. static readonly LIGHTFALLOFF_PHYSICAL: number;
  58858. /**
  58859. * PBRMaterialLightFalloff gltf: light is falling off as described in the gltf moving to PBR document
  58860. * to enhance interoperability with other engines.
  58861. */
  58862. static readonly LIGHTFALLOFF_GLTF: number;
  58863. /**
  58864. * PBRMaterialLightFalloff Standard: light is falling off like in the standard material
  58865. * to enhance interoperability with other materials.
  58866. */
  58867. static readonly LIGHTFALLOFF_STANDARD: number;
  58868. /**
  58869. * Intensity of the direct lights e.g. the four lights available in your scene.
  58870. * This impacts both the direct diffuse and specular highlights.
  58871. */
  58872. protected _directIntensity: number;
  58873. /**
  58874. * Intensity of the emissive part of the material.
  58875. * This helps controlling the emissive effect without modifying the emissive color.
  58876. */
  58877. protected _emissiveIntensity: number;
  58878. /**
  58879. * Intensity of the environment e.g. how much the environment will light the object
  58880. * either through harmonics for rough material or through the refelction for shiny ones.
  58881. */
  58882. protected _environmentIntensity: number;
  58883. /**
  58884. * This is a special control allowing the reduction of the specular highlights coming from the
  58885. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  58886. */
  58887. protected _specularIntensity: number;
  58888. /**
  58889. * This stores the direct, emissive, environment, and specular light intensities into a Vector4.
  58890. */
  58891. private _lightingInfos;
  58892. /**
  58893. * Debug Control allowing disabling the bump map on this material.
  58894. */
  58895. protected _disableBumpMap: boolean;
  58896. /**
  58897. * AKA Diffuse Texture in standard nomenclature.
  58898. */
  58899. protected _albedoTexture: Nullable<BaseTexture>;
  58900. /**
  58901. * AKA Occlusion Texture in other nomenclature.
  58902. */
  58903. protected _ambientTexture: Nullable<BaseTexture>;
  58904. /**
  58905. * AKA Occlusion Texture Intensity in other nomenclature.
  58906. */
  58907. protected _ambientTextureStrength: number;
  58908. /**
  58909. * Defines how much the AO map is occluding the analytical lights (point spot...).
  58910. * 1 means it completely occludes it
  58911. * 0 mean it has no impact
  58912. */
  58913. protected _ambientTextureImpactOnAnalyticalLights: number;
  58914. /**
  58915. * Stores the alpha values in a texture.
  58916. */
  58917. protected _opacityTexture: Nullable<BaseTexture>;
  58918. /**
  58919. * Stores the reflection values in a texture.
  58920. */
  58921. protected _reflectionTexture: Nullable<BaseTexture>;
  58922. /**
  58923. * Stores the emissive values in a texture.
  58924. */
  58925. protected _emissiveTexture: Nullable<BaseTexture>;
  58926. /**
  58927. * AKA Specular texture in other nomenclature.
  58928. */
  58929. protected _reflectivityTexture: Nullable<BaseTexture>;
  58930. /**
  58931. * Used to switch from specular/glossiness to metallic/roughness workflow.
  58932. */
  58933. protected _metallicTexture: Nullable<BaseTexture>;
  58934. /**
  58935. * Specifies the metallic scalar of the metallic/roughness workflow.
  58936. * Can also be used to scale the metalness values of the metallic texture.
  58937. */
  58938. protected _metallic: Nullable<number>;
  58939. /**
  58940. * Specifies the roughness scalar of the metallic/roughness workflow.
  58941. * Can also be used to scale the roughness values of the metallic texture.
  58942. */
  58943. protected _roughness: Nullable<number>;
  58944. /**
  58945. * In metallic workflow, specifies an F0 factor to help configuring the material F0.
  58946. * By default the indexOfrefraction is used to compute F0;
  58947. *
  58948. * This is used as a factor against the default reflectance at normal incidence to tweak it.
  58949. *
  58950. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor;
  58951. * F90 = metallicReflectanceColor;
  58952. */
  58953. protected _metallicF0Factor: number;
  58954. /**
  58955. * In metallic workflow, specifies an F90 color to help configuring the material F90.
  58956. * By default the F90 is always 1;
  58957. *
  58958. * Please note that this factor is also used as a factor against the default reflectance at normal incidence.
  58959. *
  58960. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor
  58961. * F90 = metallicReflectanceColor;
  58962. */
  58963. protected _metallicReflectanceColor: Color3;
  58964. /**
  58965. * Defines to store metallicReflectanceColor in RGB and metallicF0Factor in A
  58966. * This is multiply against the scalar values defined in the material.
  58967. */
  58968. protected _metallicReflectanceTexture: Nullable<BaseTexture>;
  58969. /**
  58970. * Used to enable roughness/glossiness fetch from a separate channel depending on the current mode.
  58971. * Gray Scale represents roughness in metallic mode and glossiness in specular mode.
  58972. */
  58973. protected _microSurfaceTexture: Nullable<BaseTexture>;
  58974. /**
  58975. * Stores surface normal data used to displace a mesh in a texture.
  58976. */
  58977. protected _bumpTexture: Nullable<BaseTexture>;
  58978. /**
  58979. * Stores the pre-calculated light information of a mesh in a texture.
  58980. */
  58981. protected _lightmapTexture: Nullable<BaseTexture>;
  58982. /**
  58983. * The color of a material in ambient lighting.
  58984. */
  58985. protected _ambientColor: Color3;
  58986. /**
  58987. * AKA Diffuse Color in other nomenclature.
  58988. */
  58989. protected _albedoColor: Color3;
  58990. /**
  58991. * AKA Specular Color in other nomenclature.
  58992. */
  58993. protected _reflectivityColor: Color3;
  58994. /**
  58995. * The color applied when light is reflected from a material.
  58996. */
  58997. protected _reflectionColor: Color3;
  58998. /**
  58999. * The color applied when light is emitted from a material.
  59000. */
  59001. protected _emissiveColor: Color3;
  59002. /**
  59003. * AKA Glossiness in other nomenclature.
  59004. */
  59005. protected _microSurface: number;
  59006. /**
  59007. * Specifies that the material will use the light map as a show map.
  59008. */
  59009. protected _useLightmapAsShadowmap: boolean;
  59010. /**
  59011. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  59012. * makes the reflect vector face the model (under horizon).
  59013. */
  59014. protected _useHorizonOcclusion: boolean;
  59015. /**
  59016. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  59017. * too much the area relying on ambient texture to define their ambient occlusion.
  59018. */
  59019. protected _useRadianceOcclusion: boolean;
  59020. /**
  59021. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  59022. */
  59023. protected _useAlphaFromAlbedoTexture: boolean;
  59024. /**
  59025. * Specifies that the material will keeps the specular highlights over a transparent surface (only the most limunous ones).
  59026. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  59027. */
  59028. protected _useSpecularOverAlpha: boolean;
  59029. /**
  59030. * Specifies if the reflectivity texture contains the glossiness information in its alpha channel.
  59031. */
  59032. protected _useMicroSurfaceFromReflectivityMapAlpha: boolean;
  59033. /**
  59034. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  59035. */
  59036. protected _useRoughnessFromMetallicTextureAlpha: boolean;
  59037. /**
  59038. * Specifies if the metallic texture contains the roughness information in its green channel.
  59039. */
  59040. protected _useRoughnessFromMetallicTextureGreen: boolean;
  59041. /**
  59042. * Specifies if the metallic texture contains the metallness information in its blue channel.
  59043. */
  59044. protected _useMetallnessFromMetallicTextureBlue: boolean;
  59045. /**
  59046. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  59047. */
  59048. protected _useAmbientOcclusionFromMetallicTextureRed: boolean;
  59049. /**
  59050. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  59051. */
  59052. protected _useAmbientInGrayScale: boolean;
  59053. /**
  59054. * In case the reflectivity map does not contain the microsurface information in its alpha channel,
  59055. * The material will try to infer what glossiness each pixel should be.
  59056. */
  59057. protected _useAutoMicroSurfaceFromReflectivityMap: boolean;
  59058. /**
  59059. * Defines the falloff type used in this material.
  59060. * It by default is Physical.
  59061. */
  59062. protected _lightFalloff: number;
  59063. /**
  59064. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  59065. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  59066. */
  59067. protected _useRadianceOverAlpha: boolean;
  59068. /**
  59069. * Allows using an object space normal map (instead of tangent space).
  59070. */
  59071. protected _useObjectSpaceNormalMap: boolean;
  59072. /**
  59073. * Allows using the bump map in parallax mode.
  59074. */
  59075. protected _useParallax: boolean;
  59076. /**
  59077. * Allows using the bump map in parallax occlusion mode.
  59078. */
  59079. protected _useParallaxOcclusion: boolean;
  59080. /**
  59081. * Controls the scale bias of the parallax mode.
  59082. */
  59083. protected _parallaxScaleBias: number;
  59084. /**
  59085. * If sets to true, disables all the lights affecting the material.
  59086. */
  59087. protected _disableLighting: boolean;
  59088. /**
  59089. * Number of Simultaneous lights allowed on the material.
  59090. */
  59091. protected _maxSimultaneousLights: number;
  59092. /**
  59093. * If sets to true, x component of normal map value will be inverted (x = 1.0 - x).
  59094. */
  59095. protected _invertNormalMapX: boolean;
  59096. /**
  59097. * If sets to true, y component of normal map value will be inverted (y = 1.0 - y).
  59098. */
  59099. protected _invertNormalMapY: boolean;
  59100. /**
  59101. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  59102. */
  59103. protected _twoSidedLighting: boolean;
  59104. /**
  59105. * Defines the alpha limits in alpha test mode.
  59106. */
  59107. protected _alphaCutOff: number;
  59108. /**
  59109. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  59110. */
  59111. protected _forceAlphaTest: boolean;
  59112. /**
  59113. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  59114. * And/Or occlude the blended part. (alpha is converted to gamma to compute the fresnel)
  59115. */
  59116. protected _useAlphaFresnel: boolean;
  59117. /**
  59118. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  59119. * And/Or occlude the blended part. (alpha stays linear to compute the fresnel)
  59120. */
  59121. protected _useLinearAlphaFresnel: boolean;
  59122. /**
  59123. * Specifies the environment BRDF texture used to comput the scale and offset roughness values
  59124. * from cos thetav and roughness:
  59125. * http://blog.selfshadow.com/publications/s2013-shading-course/karis/s2013_pbs_epic_notes_v2.pdf
  59126. */
  59127. protected _environmentBRDFTexture: Nullable<BaseTexture>;
  59128. /**
  59129. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  59130. */
  59131. protected _forceIrradianceInFragment: boolean;
  59132. private _realTimeFiltering;
  59133. /**
  59134. * Enables realtime filtering on the texture.
  59135. */
  59136. get realTimeFiltering(): boolean;
  59137. set realTimeFiltering(b: boolean);
  59138. private _realTimeFilteringQuality;
  59139. /**
  59140. * Quality switch for realtime filtering
  59141. */
  59142. get realTimeFilteringQuality(): number;
  59143. set realTimeFilteringQuality(n: number);
  59144. /**
  59145. * Can this material render to several textures at once
  59146. */
  59147. get canRenderToMRT(): boolean;
  59148. /**
  59149. * Force normal to face away from face.
  59150. */
  59151. protected _forceNormalForward: boolean;
  59152. /**
  59153. * Enables specular anti aliasing in the PBR shader.
  59154. * It will both interacts on the Geometry for analytical and IBL lighting.
  59155. * It also prefilter the roughness map based on the bump values.
  59156. */
  59157. protected _enableSpecularAntiAliasing: boolean;
  59158. /**
  59159. * Default configuration related to image processing available in the PBR Material.
  59160. */
  59161. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  59162. /**
  59163. * Keep track of the image processing observer to allow dispose and replace.
  59164. */
  59165. private _imageProcessingObserver;
  59166. /**
  59167. * Attaches a new image processing configuration to the PBR Material.
  59168. * @param configuration
  59169. */
  59170. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  59171. /**
  59172. * Stores the available render targets.
  59173. */
  59174. private _renderTargets;
  59175. /**
  59176. * Sets the global ambient color for the material used in lighting calculations.
  59177. */
  59178. private _globalAmbientColor;
  59179. /**
  59180. * Enables the use of logarithmic depth buffers, which is good for wide depth buffers.
  59181. */
  59182. private _useLogarithmicDepth;
  59183. /**
  59184. * If set to true, no lighting calculations will be applied.
  59185. */
  59186. private _unlit;
  59187. private _debugMode;
  59188. /**
  59189. * @hidden
  59190. * This is reserved for the inspector.
  59191. * Defines the material debug mode.
  59192. * It helps seeing only some components of the material while troubleshooting.
  59193. */
  59194. debugMode: number;
  59195. /**
  59196. * @hidden
  59197. * This is reserved for the inspector.
  59198. * Specify from where on screen the debug mode should start.
  59199. * The value goes from -1 (full screen) to 1 (not visible)
  59200. * It helps with side by side comparison against the final render
  59201. * This defaults to -1
  59202. */
  59203. private debugLimit;
  59204. /**
  59205. * @hidden
  59206. * This is reserved for the inspector.
  59207. * As the default viewing range might not be enough (if the ambient is really small for instance)
  59208. * You can use the factor to better multiply the final value.
  59209. */
  59210. private debugFactor;
  59211. /**
  59212. * Defines the clear coat layer parameters for the material.
  59213. */
  59214. readonly clearCoat: PBRClearCoatConfiguration;
  59215. /**
  59216. * Defines the anisotropic parameters for the material.
  59217. */
  59218. readonly anisotropy: PBRAnisotropicConfiguration;
  59219. /**
  59220. * Defines the BRDF parameters for the material.
  59221. */
  59222. readonly brdf: PBRBRDFConfiguration;
  59223. /**
  59224. * Defines the Sheen parameters for the material.
  59225. */
  59226. readonly sheen: PBRSheenConfiguration;
  59227. /**
  59228. * Defines the SubSurface parameters for the material.
  59229. */
  59230. readonly subSurface: PBRSubSurfaceConfiguration;
  59231. /**
  59232. * Defines the detail map parameters for the material.
  59233. */
  59234. readonly detailMap: DetailMapConfiguration;
  59235. protected _rebuildInParallel: boolean;
  59236. /**
  59237. * Instantiates a new PBRMaterial instance.
  59238. *
  59239. * @param name The material name
  59240. * @param scene The scene the material will be use in.
  59241. */
  59242. constructor(name: string, scene: Scene);
  59243. /**
  59244. * Gets a boolean indicating that current material needs to register RTT
  59245. */
  59246. get hasRenderTargetTextures(): boolean;
  59247. /**
  59248. * Gets the name of the material class.
  59249. */
  59250. getClassName(): string;
  59251. /**
  59252. * Enabled the use of logarithmic depth buffers, which is good for wide depth buffers.
  59253. */
  59254. get useLogarithmicDepth(): boolean;
  59255. /**
  59256. * Enabled the use of logarithmic depth buffers, which is good for wide depth buffers.
  59257. */
  59258. set useLogarithmicDepth(value: boolean);
  59259. /**
  59260. * Returns true if alpha blending should be disabled.
  59261. */
  59262. protected get _disableAlphaBlending(): boolean;
  59263. /**
  59264. * Specifies whether or not this material should be rendered in alpha blend mode.
  59265. */
  59266. needAlphaBlending(): boolean;
  59267. /**
  59268. * Specifies whether or not this material should be rendered in alpha test mode.
  59269. */
  59270. needAlphaTesting(): boolean;
  59271. /**
  59272. * Specifies whether or not the alpha value of the albedo texture should be used for alpha blending.
  59273. */
  59274. protected _shouldUseAlphaFromAlbedoTexture(): boolean;
  59275. /**
  59276. * Gets the texture used for the alpha test.
  59277. */
  59278. getAlphaTestTexture(): Nullable<BaseTexture>;
  59279. /**
  59280. * Specifies that the submesh is ready to be used.
  59281. * @param mesh - BJS mesh.
  59282. * @param subMesh - A submesh of the BJS mesh. Used to check if it is ready.
  59283. * @param useInstances - Specifies that instances should be used.
  59284. * @returns - boolean indicating that the submesh is ready or not.
  59285. */
  59286. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  59287. /**
  59288. * Specifies if the material uses metallic roughness workflow.
  59289. * @returns boolean specifiying if the material uses metallic roughness workflow.
  59290. */
  59291. isMetallicWorkflow(): boolean;
  59292. private _prepareEffect;
  59293. private _prepareDefines;
  59294. /**
  59295. * Force shader compilation
  59296. */
  59297. forceCompilation(mesh: AbstractMesh, onCompiled?: (material: Material) => void, options?: Partial<IMaterialCompilationOptions>): void;
  59298. /**
  59299. * Initializes the uniform buffer layout for the shader.
  59300. */
  59301. buildUniformLayout(): void;
  59302. /**
  59303. * Unbinds the material from the mesh
  59304. */
  59305. unbind(): void;
  59306. /**
  59307. * Binds the submesh data.
  59308. * @param world - The world matrix.
  59309. * @param mesh - The BJS mesh.
  59310. * @param subMesh - A submesh of the BJS mesh.
  59311. */
  59312. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  59313. /**
  59314. * Returns the animatable textures.
  59315. * @returns - Array of animatable textures.
  59316. */
  59317. getAnimatables(): IAnimatable[];
  59318. /**
  59319. * Returns the texture used for reflections.
  59320. * @returns - Reflection texture if present. Otherwise, returns the environment texture.
  59321. */
  59322. private _getReflectionTexture;
  59323. /**
  59324. * Returns an array of the actively used textures.
  59325. * @returns - Array of BaseTextures
  59326. */
  59327. getActiveTextures(): BaseTexture[];
  59328. /**
  59329. * Checks to see if a texture is used in the material.
  59330. * @param texture - Base texture to use.
  59331. * @returns - Boolean specifying if a texture is used in the material.
  59332. */
  59333. hasTexture(texture: BaseTexture): boolean;
  59334. /**
  59335. * Sets the required values to the prepass renderer.
  59336. * @param prePassRenderer defines the prepass renderer to setup
  59337. */
  59338. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  59339. /**
  59340. * Disposes the resources of the material.
  59341. * @param forceDisposeEffect - Forces the disposal of effects.
  59342. * @param forceDisposeTextures - Forces the disposal of all textures.
  59343. */
  59344. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  59345. }
  59346. }
  59347. declare module "babylonjs/Materials/PBR/pbrMaterial" {
  59348. import { Nullable } from "babylonjs/types";
  59349. import { Scene } from "babylonjs/scene";
  59350. import { Color3 } from "babylonjs/Maths/math.color";
  59351. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  59352. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  59353. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  59354. import { PBRBaseMaterial } from "babylonjs/Materials/PBR/pbrBaseMaterial";
  59355. /**
  59356. * The Physically based material of BJS.
  59357. *
  59358. * This offers the main features of a standard PBR material.
  59359. * For more information, please refer to the documentation :
  59360. * https://doc.babylonjs.com/how_to/physically_based_rendering
  59361. */
  59362. export class PBRMaterial extends PBRBaseMaterial {
  59363. /**
  59364. * PBRMaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  59365. */
  59366. static readonly PBRMATERIAL_OPAQUE: number;
  59367. /**
  59368. * PBRMaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  59369. */
  59370. static readonly PBRMATERIAL_ALPHATEST: number;
  59371. /**
  59372. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  59373. */
  59374. static readonly PBRMATERIAL_ALPHABLEND: number;
  59375. /**
  59376. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  59377. * They are also discarded below the alpha cutoff threshold to improve performances.
  59378. */
  59379. static readonly PBRMATERIAL_ALPHATESTANDBLEND: number;
  59380. /**
  59381. * Defines the default value of how much AO map is occluding the analytical lights
  59382. * (point spot...).
  59383. */
  59384. static DEFAULT_AO_ON_ANALYTICAL_LIGHTS: number;
  59385. /**
  59386. * Intensity of the direct lights e.g. the four lights available in your scene.
  59387. * This impacts both the direct diffuse and specular highlights.
  59388. */
  59389. directIntensity: number;
  59390. /**
  59391. * Intensity of the emissive part of the material.
  59392. * This helps controlling the emissive effect without modifying the emissive color.
  59393. */
  59394. emissiveIntensity: number;
  59395. /**
  59396. * Intensity of the environment e.g. how much the environment will light the object
  59397. * either through harmonics for rough material or through the refelction for shiny ones.
  59398. */
  59399. environmentIntensity: number;
  59400. /**
  59401. * This is a special control allowing the reduction of the specular highlights coming from the
  59402. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  59403. */
  59404. specularIntensity: number;
  59405. /**
  59406. * Debug Control allowing disabling the bump map on this material.
  59407. */
  59408. disableBumpMap: boolean;
  59409. /**
  59410. * AKA Diffuse Texture in standard nomenclature.
  59411. */
  59412. albedoTexture: BaseTexture;
  59413. /**
  59414. * AKA Occlusion Texture in other nomenclature.
  59415. */
  59416. ambientTexture: BaseTexture;
  59417. /**
  59418. * AKA Occlusion Texture Intensity in other nomenclature.
  59419. */
  59420. ambientTextureStrength: number;
  59421. /**
  59422. * Defines how much the AO map is occluding the analytical lights (point spot...).
  59423. * 1 means it completely occludes it
  59424. * 0 mean it has no impact
  59425. */
  59426. ambientTextureImpactOnAnalyticalLights: number;
  59427. /**
  59428. * Stores the alpha values in a texture. Use luminance if texture.getAlphaFromRGB is true.
  59429. */
  59430. opacityTexture: BaseTexture;
  59431. /**
  59432. * Stores the reflection values in a texture.
  59433. */
  59434. reflectionTexture: Nullable<BaseTexture>;
  59435. /**
  59436. * Stores the emissive values in a texture.
  59437. */
  59438. emissiveTexture: BaseTexture;
  59439. /**
  59440. * AKA Specular texture in other nomenclature.
  59441. */
  59442. reflectivityTexture: BaseTexture;
  59443. /**
  59444. * Used to switch from specular/glossiness to metallic/roughness workflow.
  59445. */
  59446. metallicTexture: BaseTexture;
  59447. /**
  59448. * Specifies the metallic scalar of the metallic/roughness workflow.
  59449. * Can also be used to scale the metalness values of the metallic texture.
  59450. */
  59451. metallic: Nullable<number>;
  59452. /**
  59453. * Specifies the roughness scalar of the metallic/roughness workflow.
  59454. * Can also be used to scale the roughness values of the metallic texture.
  59455. */
  59456. roughness: Nullable<number>;
  59457. /**
  59458. * In metallic workflow, specifies an F0 factor to help configuring the material F0.
  59459. * By default the indexOfrefraction is used to compute F0;
  59460. *
  59461. * This is used as a factor against the default reflectance at normal incidence to tweak it.
  59462. *
  59463. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor;
  59464. * F90 = metallicReflectanceColor;
  59465. */
  59466. metallicF0Factor: number;
  59467. /**
  59468. * In metallic workflow, specifies an F90 color to help configuring the material F90.
  59469. * By default the F90 is always 1;
  59470. *
  59471. * Please note that this factor is also used as a factor against the default reflectance at normal incidence.
  59472. *
  59473. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor
  59474. * F90 = metallicReflectanceColor;
  59475. */
  59476. metallicReflectanceColor: Color3;
  59477. /**
  59478. * Defines to store metallicReflectanceColor in RGB and metallicF0Factor in A
  59479. * This is multiply against the scalar values defined in the material.
  59480. */
  59481. metallicReflectanceTexture: Nullable<BaseTexture>;
  59482. /**
  59483. * Used to enable roughness/glossiness fetch from a separate channel depending on the current mode.
  59484. * Gray Scale represents roughness in metallic mode and glossiness in specular mode.
  59485. */
  59486. microSurfaceTexture: BaseTexture;
  59487. /**
  59488. * Stores surface normal data used to displace a mesh in a texture.
  59489. */
  59490. bumpTexture: BaseTexture;
  59491. /**
  59492. * Stores the pre-calculated light information of a mesh in a texture.
  59493. */
  59494. lightmapTexture: BaseTexture;
  59495. /**
  59496. * Stores the refracted light information in a texture.
  59497. */
  59498. get refractionTexture(): Nullable<BaseTexture>;
  59499. set refractionTexture(value: Nullable<BaseTexture>);
  59500. /**
  59501. * The color of a material in ambient lighting.
  59502. */
  59503. ambientColor: Color3;
  59504. /**
  59505. * AKA Diffuse Color in other nomenclature.
  59506. */
  59507. albedoColor: Color3;
  59508. /**
  59509. * AKA Specular Color in other nomenclature.
  59510. */
  59511. reflectivityColor: Color3;
  59512. /**
  59513. * The color reflected from the material.
  59514. */
  59515. reflectionColor: Color3;
  59516. /**
  59517. * The color emitted from the material.
  59518. */
  59519. emissiveColor: Color3;
  59520. /**
  59521. * AKA Glossiness in other nomenclature.
  59522. */
  59523. microSurface: number;
  59524. /**
  59525. * Index of refraction of the material base layer.
  59526. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  59527. *
  59528. * This does not only impact refraction but also the Base F0 of Dielectric Materials.
  59529. *
  59530. * From dielectric fresnel rules: F0 = square((iorT - iorI) / (iorT + iorI))
  59531. */
  59532. get indexOfRefraction(): number;
  59533. set indexOfRefraction(value: number);
  59534. /**
  59535. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  59536. */
  59537. get invertRefractionY(): boolean;
  59538. set invertRefractionY(value: boolean);
  59539. /**
  59540. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  59541. * Materials half opaque for instance using refraction could benefit from this control.
  59542. */
  59543. get linkRefractionWithTransparency(): boolean;
  59544. set linkRefractionWithTransparency(value: boolean);
  59545. /**
  59546. * If true, the light map contains occlusion information instead of lighting info.
  59547. */
  59548. useLightmapAsShadowmap: boolean;
  59549. /**
  59550. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  59551. */
  59552. useAlphaFromAlbedoTexture: boolean;
  59553. /**
  59554. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  59555. */
  59556. forceAlphaTest: boolean;
  59557. /**
  59558. * Defines the alpha limits in alpha test mode.
  59559. */
  59560. alphaCutOff: number;
  59561. /**
  59562. * Specifies that the material will keep the specular highlights over a transparent surface (only the most limunous ones).
  59563. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  59564. */
  59565. useSpecularOverAlpha: boolean;
  59566. /**
  59567. * Specifies if the reflectivity texture contains the glossiness information in its alpha channel.
  59568. */
  59569. useMicroSurfaceFromReflectivityMapAlpha: boolean;
  59570. /**
  59571. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  59572. */
  59573. useRoughnessFromMetallicTextureAlpha: boolean;
  59574. /**
  59575. * Specifies if the metallic texture contains the roughness information in its green channel.
  59576. */
  59577. useRoughnessFromMetallicTextureGreen: boolean;
  59578. /**
  59579. * Specifies if the metallic texture contains the metallness information in its blue channel.
  59580. */
  59581. useMetallnessFromMetallicTextureBlue: boolean;
  59582. /**
  59583. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  59584. */
  59585. useAmbientOcclusionFromMetallicTextureRed: boolean;
  59586. /**
  59587. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  59588. */
  59589. useAmbientInGrayScale: boolean;
  59590. /**
  59591. * In case the reflectivity map does not contain the microsurface information in its alpha channel,
  59592. * The material will try to infer what glossiness each pixel should be.
  59593. */
  59594. useAutoMicroSurfaceFromReflectivityMap: boolean;
  59595. /**
  59596. * BJS is using an harcoded light falloff based on a manually sets up range.
  59597. * In PBR, one way to represents the fallof is to use the inverse squared root algorythm.
  59598. * This parameter can help you switch back to the BJS mode in order to create scenes using both materials.
  59599. */
  59600. get usePhysicalLightFalloff(): boolean;
  59601. /**
  59602. * BJS is using an harcoded light falloff based on a manually sets up range.
  59603. * In PBR, one way to represents the fallof is to use the inverse squared root algorythm.
  59604. * This parameter can help you switch back to the BJS mode in order to create scenes using both materials.
  59605. */
  59606. set usePhysicalLightFalloff(value: boolean);
  59607. /**
  59608. * In order to support the falloff compatibility with gltf, a special mode has been added
  59609. * to reproduce the gltf light falloff.
  59610. */
  59611. get useGLTFLightFalloff(): boolean;
  59612. /**
  59613. * In order to support the falloff compatibility with gltf, a special mode has been added
  59614. * to reproduce the gltf light falloff.
  59615. */
  59616. set useGLTFLightFalloff(value: boolean);
  59617. /**
  59618. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  59619. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  59620. */
  59621. useRadianceOverAlpha: boolean;
  59622. /**
  59623. * Allows using an object space normal map (instead of tangent space).
  59624. */
  59625. useObjectSpaceNormalMap: boolean;
  59626. /**
  59627. * Allows using the bump map in parallax mode.
  59628. */
  59629. useParallax: boolean;
  59630. /**
  59631. * Allows using the bump map in parallax occlusion mode.
  59632. */
  59633. useParallaxOcclusion: boolean;
  59634. /**
  59635. * Controls the scale bias of the parallax mode.
  59636. */
  59637. parallaxScaleBias: number;
  59638. /**
  59639. * If sets to true, disables all the lights affecting the material.
  59640. */
  59641. disableLighting: boolean;
  59642. /**
  59643. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  59644. */
  59645. forceIrradianceInFragment: boolean;
  59646. /**
  59647. * Number of Simultaneous lights allowed on the material.
  59648. */
  59649. maxSimultaneousLights: number;
  59650. /**
  59651. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  59652. */
  59653. invertNormalMapX: boolean;
  59654. /**
  59655. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  59656. */
  59657. invertNormalMapY: boolean;
  59658. /**
  59659. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  59660. */
  59661. twoSidedLighting: boolean;
  59662. /**
  59663. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  59664. * And/Or occlude the blended part. (alpha is converted to gamma to compute the fresnel)
  59665. */
  59666. useAlphaFresnel: boolean;
  59667. /**
  59668. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  59669. * And/Or occlude the blended part. (alpha stays linear to compute the fresnel)
  59670. */
  59671. useLinearAlphaFresnel: boolean;
  59672. /**
  59673. * Let user defines the brdf lookup texture used for IBL.
  59674. * A default 8bit version is embedded but you could point at :
  59675. * * Default texture: https://assets.babylonjs.com/environments/correlatedMSBRDF_RGBD.png
  59676. * * Default 16bit pixel depth texture: https://assets.babylonjs.com/environments/correlatedMSBRDF.dds
  59677. * * LEGACY Default None correlated https://assets.babylonjs.com/environments/uncorrelatedBRDF_RGBD.png
  59678. * * LEGACY Default None correlated 16bit pixel depth https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds
  59679. */
  59680. environmentBRDFTexture: Nullable<BaseTexture>;
  59681. /**
  59682. * Force normal to face away from face.
  59683. */
  59684. forceNormalForward: boolean;
  59685. /**
  59686. * Enables specular anti aliasing in the PBR shader.
  59687. * It will both interacts on the Geometry for analytical and IBL lighting.
  59688. * It also prefilter the roughness map based on the bump values.
  59689. */
  59690. enableSpecularAntiAliasing: boolean;
  59691. /**
  59692. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  59693. * makes the reflect vector face the model (under horizon).
  59694. */
  59695. useHorizonOcclusion: boolean;
  59696. /**
  59697. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  59698. * too much the area relying on ambient texture to define their ambient occlusion.
  59699. */
  59700. useRadianceOcclusion: boolean;
  59701. /**
  59702. * If set to true, no lighting calculations will be applied.
  59703. */
  59704. unlit: boolean;
  59705. /**
  59706. * Gets the image processing configuration used either in this material.
  59707. */
  59708. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  59709. /**
  59710. * Sets the Default image processing configuration used either in the this material.
  59711. *
  59712. * If sets to null, the scene one is in use.
  59713. */
  59714. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  59715. /**
  59716. * Gets wether the color curves effect is enabled.
  59717. */
  59718. get cameraColorCurvesEnabled(): boolean;
  59719. /**
  59720. * Sets wether the color curves effect is enabled.
  59721. */
  59722. set cameraColorCurvesEnabled(value: boolean);
  59723. /**
  59724. * Gets wether the color grading effect is enabled.
  59725. */
  59726. get cameraColorGradingEnabled(): boolean;
  59727. /**
  59728. * Gets wether the color grading effect is enabled.
  59729. */
  59730. set cameraColorGradingEnabled(value: boolean);
  59731. /**
  59732. * Gets wether tonemapping is enabled or not.
  59733. */
  59734. get cameraToneMappingEnabled(): boolean;
  59735. /**
  59736. * Sets wether tonemapping is enabled or not
  59737. */
  59738. set cameraToneMappingEnabled(value: boolean);
  59739. /**
  59740. * The camera exposure used on this material.
  59741. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  59742. * This corresponds to a photographic exposure.
  59743. */
  59744. get cameraExposure(): number;
  59745. /**
  59746. * The camera exposure used on this material.
  59747. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  59748. * This corresponds to a photographic exposure.
  59749. */
  59750. set cameraExposure(value: number);
  59751. /**
  59752. * Gets The camera contrast used on this material.
  59753. */
  59754. get cameraContrast(): number;
  59755. /**
  59756. * Sets The camera contrast used on this material.
  59757. */
  59758. set cameraContrast(value: number);
  59759. /**
  59760. * Gets the Color Grading 2D Lookup Texture.
  59761. */
  59762. get cameraColorGradingTexture(): Nullable<BaseTexture>;
  59763. /**
  59764. * Sets the Color Grading 2D Lookup Texture.
  59765. */
  59766. set cameraColorGradingTexture(value: Nullable<BaseTexture>);
  59767. /**
  59768. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  59769. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  59770. * 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;
  59771. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  59772. */
  59773. get cameraColorCurves(): Nullable<ColorCurves>;
  59774. /**
  59775. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  59776. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  59777. * 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;
  59778. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  59779. */
  59780. set cameraColorCurves(value: Nullable<ColorCurves>);
  59781. /**
  59782. * Instantiates a new PBRMaterial instance.
  59783. *
  59784. * @param name The material name
  59785. * @param scene The scene the material will be use in.
  59786. */
  59787. constructor(name: string, scene: Scene);
  59788. /**
  59789. * Returns the name of this material class.
  59790. */
  59791. getClassName(): string;
  59792. /**
  59793. * Makes a duplicate of the current material.
  59794. * @param name - name to use for the new material.
  59795. */
  59796. clone(name: string): PBRMaterial;
  59797. /**
  59798. * Serializes this PBR Material.
  59799. * @returns - An object with the serialized material.
  59800. */
  59801. serialize(): any;
  59802. /**
  59803. * Parses a PBR Material from a serialized object.
  59804. * @param source - Serialized object.
  59805. * @param scene - BJS scene instance.
  59806. * @param rootUrl - url for the scene object
  59807. * @returns - PBRMaterial
  59808. */
  59809. static Parse(source: any, scene: Scene, rootUrl: string): PBRMaterial;
  59810. }
  59811. }
  59812. declare module "babylonjs/Misc/dds" {
  59813. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  59814. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  59815. import { Nullable } from "babylonjs/types";
  59816. import { Scene } from "babylonjs/scene";
  59817. import "babylonjs/Engines/Extensions/engine.cubeTexture";
  59818. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  59819. /**
  59820. * Direct draw surface info
  59821. * @see https://docs.microsoft.com/en-us/windows/desktop/direct3ddds/dx-graphics-dds-pguide
  59822. */
  59823. export interface DDSInfo {
  59824. /**
  59825. * Width of the texture
  59826. */
  59827. width: number;
  59828. /**
  59829. * Width of the texture
  59830. */
  59831. height: number;
  59832. /**
  59833. * Number of Mipmaps for the texture
  59834. * @see https://en.wikipedia.org/wiki/Mipmap
  59835. */
  59836. mipmapCount: number;
  59837. /**
  59838. * If the textures format is a known fourCC format
  59839. * @see https://www.fourcc.org/
  59840. */
  59841. isFourCC: boolean;
  59842. /**
  59843. * If the texture is an RGB format eg. DXGI_FORMAT_B8G8R8X8_UNORM format
  59844. */
  59845. isRGB: boolean;
  59846. /**
  59847. * If the texture is a lumincance format
  59848. */
  59849. isLuminance: boolean;
  59850. /**
  59851. * If this is a cube texture
  59852. * @see https://docs.microsoft.com/en-us/windows/desktop/direct3ddds/dds-file-layout-for-cubic-environment-maps
  59853. */
  59854. isCube: boolean;
  59855. /**
  59856. * If the texture is a compressed format eg. FOURCC_DXT1
  59857. */
  59858. isCompressed: boolean;
  59859. /**
  59860. * The dxgiFormat of the texture
  59861. * @see https://docs.microsoft.com/en-us/windows/desktop/api/dxgiformat/ne-dxgiformat-dxgi_format
  59862. */
  59863. dxgiFormat: number;
  59864. /**
  59865. * Texture type eg. Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT
  59866. */
  59867. textureType: number;
  59868. /**
  59869. * Sphericle polynomial created for the dds texture
  59870. */
  59871. sphericalPolynomial?: SphericalPolynomial;
  59872. }
  59873. /**
  59874. * Class used to provide DDS decompression tools
  59875. */
  59876. export class DDSTools {
  59877. /**
  59878. * Gets or sets a boolean indicating that LOD info is stored in alpha channel (false by default)
  59879. */
  59880. static StoreLODInAlphaChannel: boolean;
  59881. /**
  59882. * Gets DDS information from an array buffer
  59883. * @param data defines the array buffer view to read data from
  59884. * @returns the DDS information
  59885. */
  59886. static GetDDSInfo(data: ArrayBufferView): DDSInfo;
  59887. private static _FloatView;
  59888. private static _Int32View;
  59889. private static _ToHalfFloat;
  59890. private static _FromHalfFloat;
  59891. private static _GetHalfFloatAsFloatRGBAArrayBuffer;
  59892. private static _GetHalfFloatRGBAArrayBuffer;
  59893. private static _GetFloatRGBAArrayBuffer;
  59894. private static _GetFloatAsUIntRGBAArrayBuffer;
  59895. private static _GetHalfFloatAsUIntRGBAArrayBuffer;
  59896. private static _GetRGBAArrayBuffer;
  59897. private static _ExtractLongWordOrder;
  59898. private static _GetRGBArrayBuffer;
  59899. private static _GetLuminanceArrayBuffer;
  59900. /**
  59901. * Uploads DDS Levels to a Babylon Texture
  59902. * @hidden
  59903. */
  59904. static UploadDDSLevels(engine: ThinEngine, texture: InternalTexture, data: ArrayBufferView, info: DDSInfo, loadMipmaps: boolean, faces: number, lodIndex?: number, currentFace?: number): void;
  59905. }
  59906. module "babylonjs/Engines/thinEngine" {
  59907. interface ThinEngine {
  59908. /**
  59909. * Create a cube texture from prefiltered data (ie. the mipmaps contain ready to use data for PBR reflection)
  59910. * @param rootUrl defines the url where the file to load is located
  59911. * @param scene defines the current scene
  59912. * @param lodScale defines scale to apply to the mip map selection
  59913. * @param lodOffset defines offset to apply to the mip map selection
  59914. * @param onLoad defines an optional callback raised when the texture is loaded
  59915. * @param onError defines an optional callback raised if there is an issue to load the texture
  59916. * @param format defines the format of the data
  59917. * @param forcedExtension defines the extension to use to pick the right loader
  59918. * @param createPolynomials defines wheter or not to create polynomails harmonics for the texture
  59919. * @returns the cube texture as an InternalTexture
  59920. */
  59921. 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;
  59922. }
  59923. }
  59924. }
  59925. declare module "babylonjs/Materials/Textures/Loaders/ddsTextureLoader" {
  59926. import { Nullable } from "babylonjs/types";
  59927. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  59928. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  59929. /**
  59930. * Implementation of the DDS Texture Loader.
  59931. * @hidden
  59932. */
  59933. export class _DDSTextureLoader implements IInternalTextureLoader {
  59934. /**
  59935. * Defines wether the loader supports cascade loading the different faces.
  59936. */
  59937. readonly supportCascades: boolean;
  59938. /**
  59939. * This returns if the loader support the current file information.
  59940. * @param extension defines the file extension of the file being loaded
  59941. * @returns true if the loader can load the specified file
  59942. */
  59943. canLoad(extension: string): boolean;
  59944. /**
  59945. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  59946. * @param data contains the texture data
  59947. * @param texture defines the BabylonJS internal texture
  59948. * @param createPolynomials will be true if polynomials have been requested
  59949. * @param onLoad defines the callback to trigger once the texture is ready
  59950. * @param onError defines the callback to trigger in case of error
  59951. */
  59952. loadCubeData(imgs: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  59953. /**
  59954. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  59955. * @param data contains the texture data
  59956. * @param texture defines the BabylonJS internal texture
  59957. * @param callback defines the method to call once ready to upload
  59958. */
  59959. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  59960. }
  59961. }
  59962. declare module "babylonjs/Materials/Textures/Loaders/envTextureLoader" {
  59963. import { Nullable } from "babylonjs/types";
  59964. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  59965. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  59966. /**
  59967. * Implementation of the ENV Texture Loader.
  59968. * @hidden
  59969. */
  59970. export class _ENVTextureLoader implements IInternalTextureLoader {
  59971. /**
  59972. * Defines wether the loader supports cascade loading the different faces.
  59973. */
  59974. readonly supportCascades: boolean;
  59975. /**
  59976. * This returns if the loader support the current file information.
  59977. * @param extension defines the file extension of the file being loaded
  59978. * @returns true if the loader can load the specified file
  59979. */
  59980. canLoad(extension: string): boolean;
  59981. /**
  59982. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  59983. * @param data contains the texture data
  59984. * @param texture defines the BabylonJS internal texture
  59985. * @param createPolynomials will be true if polynomials have been requested
  59986. * @param onLoad defines the callback to trigger once the texture is ready
  59987. * @param onError defines the callback to trigger in case of error
  59988. */
  59989. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  59990. /**
  59991. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  59992. * @param data contains the texture data
  59993. * @param texture defines the BabylonJS internal texture
  59994. * @param callback defines the method to call once ready to upload
  59995. */
  59996. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  59997. }
  59998. }
  59999. declare module "babylonjs/Misc/khronosTextureContainer" {
  60000. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  60001. /**
  60002. * for description see https://www.khronos.org/opengles/sdk/tools/KTX/
  60003. * for file layout see https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/
  60004. */
  60005. export class KhronosTextureContainer {
  60006. /** contents of the KTX container file */
  60007. data: ArrayBufferView;
  60008. private static HEADER_LEN;
  60009. private static COMPRESSED_2D;
  60010. private static COMPRESSED_3D;
  60011. private static TEX_2D;
  60012. private static TEX_3D;
  60013. /**
  60014. * Gets the openGL type
  60015. */
  60016. glType: number;
  60017. /**
  60018. * Gets the openGL type size
  60019. */
  60020. glTypeSize: number;
  60021. /**
  60022. * Gets the openGL format
  60023. */
  60024. glFormat: number;
  60025. /**
  60026. * Gets the openGL internal format
  60027. */
  60028. glInternalFormat: number;
  60029. /**
  60030. * Gets the base internal format
  60031. */
  60032. glBaseInternalFormat: number;
  60033. /**
  60034. * Gets image width in pixel
  60035. */
  60036. pixelWidth: number;
  60037. /**
  60038. * Gets image height in pixel
  60039. */
  60040. pixelHeight: number;
  60041. /**
  60042. * Gets image depth in pixels
  60043. */
  60044. pixelDepth: number;
  60045. /**
  60046. * Gets the number of array elements
  60047. */
  60048. numberOfArrayElements: number;
  60049. /**
  60050. * Gets the number of faces
  60051. */
  60052. numberOfFaces: number;
  60053. /**
  60054. * Gets the number of mipmap levels
  60055. */
  60056. numberOfMipmapLevels: number;
  60057. /**
  60058. * Gets the bytes of key value data
  60059. */
  60060. bytesOfKeyValueData: number;
  60061. /**
  60062. * Gets the load type
  60063. */
  60064. loadType: number;
  60065. /**
  60066. * If the container has been made invalid (eg. constructor failed to correctly load array buffer)
  60067. */
  60068. isInvalid: boolean;
  60069. /**
  60070. * Creates a new KhronosTextureContainer
  60071. * @param data contents of the KTX container file
  60072. * @param facesExpected should be either 1 or 6, based whether a cube texture or or
  60073. * @param threeDExpected provision for indicating that data should be a 3D texture, not implemented
  60074. * @param textureArrayExpected provision for indicating that data should be a texture array, not implemented
  60075. */
  60076. constructor(
  60077. /** contents of the KTX container file */
  60078. data: ArrayBufferView, facesExpected: number, threeDExpected?: boolean, textureArrayExpected?: boolean);
  60079. /**
  60080. * Uploads KTX content to a Babylon Texture.
  60081. * It is assumed that the texture has already been created & is currently bound
  60082. * @hidden
  60083. */
  60084. uploadLevels(texture: InternalTexture, loadMipmaps: boolean): void;
  60085. private _upload2DCompressedLevels;
  60086. /**
  60087. * Checks if the given data starts with a KTX file identifier.
  60088. * @param data the data to check
  60089. * @returns true if the data is a KTX file or false otherwise
  60090. */
  60091. static IsValid(data: ArrayBufferView): boolean;
  60092. }
  60093. }
  60094. declare module "babylonjs/Misc/khronosTextureContainer2" {
  60095. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  60096. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  60097. /**
  60098. * Class for loading KTX2 files
  60099. * !!! Experimental Extension Subject to Changes !!!
  60100. * @hidden
  60101. */
  60102. export class KhronosTextureContainer2 {
  60103. private static _ModulePromise;
  60104. private static _TranscodeFormat;
  60105. constructor(engine: ThinEngine);
  60106. uploadAsync(data: ArrayBufferView, internalTexture: InternalTexture): Promise<void>;
  60107. private _determineTranscodeFormat;
  60108. /**
  60109. * Checks if the given data starts with a KTX2 file identifier.
  60110. * @param data the data to check
  60111. * @returns true if the data is a KTX2 file or false otherwise
  60112. */
  60113. static IsValid(data: ArrayBufferView): boolean;
  60114. }
  60115. }
  60116. declare module "babylonjs/Materials/Textures/Loaders/ktxTextureLoader" {
  60117. import { Nullable } from "babylonjs/types";
  60118. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  60119. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  60120. /**
  60121. * Implementation of the KTX Texture Loader.
  60122. * @hidden
  60123. */
  60124. export class _KTXTextureLoader implements IInternalTextureLoader {
  60125. /**
  60126. * Defines wether the loader supports cascade loading the different faces.
  60127. */
  60128. readonly supportCascades: boolean;
  60129. /**
  60130. * This returns if the loader support the current file information.
  60131. * @param extension defines the file extension of the file being loaded
  60132. * @param mimeType defines the optional mime type of the file being loaded
  60133. * @returns true if the loader can load the specified file
  60134. */
  60135. canLoad(extension: string, mimeType?: string): boolean;
  60136. /**
  60137. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  60138. * @param data contains the texture data
  60139. * @param texture defines the BabylonJS internal texture
  60140. * @param createPolynomials will be true if polynomials have been requested
  60141. * @param onLoad defines the callback to trigger once the texture is ready
  60142. * @param onError defines the callback to trigger in case of error
  60143. */
  60144. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  60145. /**
  60146. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  60147. * @param data contains the texture data
  60148. * @param texture defines the BabylonJS internal texture
  60149. * @param callback defines the method to call once ready to upload
  60150. */
  60151. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void, loadFailed: boolean) => void): void;
  60152. }
  60153. }
  60154. declare module "babylonjs/Helpers/sceneHelpers" {
  60155. import { Nullable } from "babylonjs/types";
  60156. import { Mesh } from "babylonjs/Meshes/mesh";
  60157. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  60158. import { IEnvironmentHelperOptions, EnvironmentHelper } from "babylonjs/Helpers/environmentHelper";
  60159. import { VRExperienceHelperOptions, VRExperienceHelper } from "babylonjs/Cameras/VR/vrExperienceHelper";
  60160. import "babylonjs/Materials/Textures/Loaders/ddsTextureLoader";
  60161. import "babylonjs/Materials/Textures/Loaders/envTextureLoader";
  60162. import "babylonjs/Materials/Textures/Loaders/ktxTextureLoader";
  60163. import "babylonjs/Meshes/Builders/boxBuilder";
  60164. import { WebXRDefaultExperience, WebXRDefaultExperienceOptions } from "babylonjs/XR/webXRDefaultExperience";
  60165. /** @hidden */
  60166. export var _forceSceneHelpersToBundle: boolean;
  60167. module "babylonjs/scene" {
  60168. interface Scene {
  60169. /**
  60170. * Creates a default light for the scene.
  60171. * @see https://doc.babylonjs.com/How_To/Fast_Build#create-default-light
  60172. * @param replace has the default false, when true replaces the existing lights in the scene with a hemispheric light
  60173. */
  60174. createDefaultLight(replace?: boolean): void;
  60175. /**
  60176. * Creates a default camera for the scene.
  60177. * @see https://doc.babylonjs.com/How_To/Fast_Build#create-default-camera
  60178. * @param createArcRotateCamera has the default false which creates a free camera, when true creates an arc rotate camera
  60179. * @param replace has default false, when true replaces the active camera in the scene
  60180. * @param attachCameraControls has default false, when true attaches camera controls to the canvas.
  60181. */
  60182. createDefaultCamera(createArcRotateCamera?: boolean, replace?: boolean, attachCameraControls?: boolean): void;
  60183. /**
  60184. * Creates a default camera and a default light.
  60185. * @see https://doc.babylonjs.com/how_to/Fast_Build#create-default-camera-or-light
  60186. * @param createArcRotateCamera has the default false which creates a free camera, when true creates an arc rotate camera
  60187. * @param replace has the default false, when true replaces the active camera/light in the scene
  60188. * @param attachCameraControls has the default false, when true attaches camera controls to the canvas.
  60189. */
  60190. createDefaultCameraOrLight(createArcRotateCamera?: boolean, replace?: boolean, attachCameraControls?: boolean): void;
  60191. /**
  60192. * Creates a new sky box
  60193. * @see https://doc.babylonjs.com/how_to/Fast_Build#create-default-skybox
  60194. * @param environmentTexture defines the texture to use as environment texture
  60195. * @param pbr has default false which requires the StandardMaterial to be used, when true PBRMaterial must be used
  60196. * @param scale defines the overall scale of the skybox
  60197. * @param blur is only available when pbr is true, default is 0, no blur, maximum value is 1
  60198. * @param setGlobalEnvTexture has default true indicating that scene.environmentTexture must match the current skybox texture
  60199. * @returns a new mesh holding the sky box
  60200. */
  60201. createDefaultSkybox(environmentTexture?: BaseTexture, pbr?: boolean, scale?: number, blur?: number, setGlobalEnvTexture?: boolean): Nullable<Mesh>;
  60202. /**
  60203. * Creates a new environment
  60204. * @see https://doc.babylonjs.com/How_To/Fast_Build#create-default-environment
  60205. * @param options defines the options you can use to configure the environment
  60206. * @returns the new EnvironmentHelper
  60207. */
  60208. createDefaultEnvironment(options?: Partial<IEnvironmentHelperOptions>): Nullable<EnvironmentHelper>;
  60209. /**
  60210. * Creates a new VREXperienceHelper
  60211. * @see https://doc.babylonjs.com/how_to/webvr_helper
  60212. * @param webVROptions defines the options used to create the new VREXperienceHelper
  60213. * @returns a new VREXperienceHelper
  60214. */
  60215. createDefaultVRExperience(webVROptions?: VRExperienceHelperOptions): VRExperienceHelper;
  60216. /**
  60217. * Creates a new WebXRDefaultExperience
  60218. * @see https://doc.babylonjs.com/how_to/introduction_to_webxr
  60219. * @param options experience options
  60220. * @returns a promise for a new WebXRDefaultExperience
  60221. */
  60222. createDefaultXRExperienceAsync(options: WebXRDefaultExperienceOptions): Promise<WebXRDefaultExperience>;
  60223. }
  60224. }
  60225. }
  60226. declare module "babylonjs/Helpers/videoDome" {
  60227. import { Scene } from "babylonjs/scene";
  60228. import { TransformNode } from "babylonjs/Meshes/transformNode";
  60229. import { Mesh } from "babylonjs/Meshes/mesh";
  60230. import { VideoTexture } from "babylonjs/Materials/Textures/videoTexture";
  60231. import { BackgroundMaterial } from "babylonjs/Materials/Background/backgroundMaterial";
  60232. import "babylonjs/Meshes/Builders/sphereBuilder";
  60233. /**
  60234. * Display a 360/180 degree video on an approximately spherical surface, useful for VR applications or skyboxes.
  60235. * As a subclass of TransformNode, this allow parenting to the camera or multiple videos with different locations in the scene.
  60236. * This class achieves its effect with a VideoTexture and a correctly configured BackgroundMaterial on an inverted sphere.
  60237. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  60238. */
  60239. export class VideoDome extends TransformNode {
  60240. /**
  60241. * Define the video source as a Monoscopic panoramic 360 video.
  60242. */
  60243. static readonly MODE_MONOSCOPIC: number;
  60244. /**
  60245. * Define the video source as a Stereoscopic TopBottom/OverUnder panoramic 360 video.
  60246. */
  60247. static readonly MODE_TOPBOTTOM: number;
  60248. /**
  60249. * Define the video source as a Stereoscopic Side by Side panoramic 360 video.
  60250. */
  60251. static readonly MODE_SIDEBYSIDE: number;
  60252. private _halfDome;
  60253. private _useDirectMapping;
  60254. /**
  60255. * The video texture being displayed on the sphere
  60256. */
  60257. protected _videoTexture: VideoTexture;
  60258. /**
  60259. * Gets the video texture being displayed on the sphere
  60260. */
  60261. get videoTexture(): VideoTexture;
  60262. /**
  60263. * The skybox material
  60264. */
  60265. protected _material: BackgroundMaterial;
  60266. /**
  60267. * The surface used for the video dome
  60268. */
  60269. protected _mesh: Mesh;
  60270. /**
  60271. * Gets the mesh used for the video dome.
  60272. */
  60273. get mesh(): Mesh;
  60274. /**
  60275. * A mesh that will be used to mask the back of the video dome in case it is a 180 degree movie.
  60276. */
  60277. private _halfDomeMask;
  60278. /**
  60279. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  60280. * Also see the options.resolution property.
  60281. */
  60282. get fovMultiplier(): number;
  60283. set fovMultiplier(value: number);
  60284. private _videoMode;
  60285. /**
  60286. * Gets or set the current video mode for the video. It can be:
  60287. * * VideoDome.MODE_MONOSCOPIC : Define the video source as a Monoscopic panoramic 360 video.
  60288. * * VideoDome.MODE_TOPBOTTOM : Define the video source as a Stereoscopic TopBottom/OverUnder panoramic 360 video.
  60289. * * VideoDome.MODE_SIDEBYSIDE : Define the video source as a Stereoscopic Side by Side panoramic 360 video.
  60290. */
  60291. get videoMode(): number;
  60292. set videoMode(value: number);
  60293. /**
  60294. * Is the video a 180 degrees video (half dome) or 360 video (full dome)
  60295. *
  60296. */
  60297. get halfDome(): boolean;
  60298. /**
  60299. * Set the halfDome mode. If set, only the front (180 degrees) will be displayed and the back will be blacked out.
  60300. */
  60301. set halfDome(enabled: boolean);
  60302. /**
  60303. * Oberserver used in Stereoscopic VR Mode.
  60304. */
  60305. private _onBeforeCameraRenderObserver;
  60306. /**
  60307. * Create an instance of this class and pass through the parameters to the relevant classes, VideoTexture, StandardMaterial, and Mesh.
  60308. * @param name Element's name, child elements will append suffixes for their own names.
  60309. * @param urlsOrVideo defines the url(s) or the video element to use
  60310. * @param options An object containing optional or exposed sub element properties
  60311. */
  60312. constructor(name: string, urlsOrVideo: string | string[] | HTMLVideoElement, options: {
  60313. resolution?: number;
  60314. clickToPlay?: boolean;
  60315. autoPlay?: boolean;
  60316. loop?: boolean;
  60317. size?: number;
  60318. poster?: string;
  60319. faceForward?: boolean;
  60320. useDirectMapping?: boolean;
  60321. halfDomeMode?: boolean;
  60322. }, scene: Scene);
  60323. private _changeVideoMode;
  60324. /**
  60325. * Releases resources associated with this node.
  60326. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  60327. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  60328. */
  60329. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  60330. }
  60331. }
  60332. declare module "babylonjs/Helpers/index" {
  60333. export * from "babylonjs/Helpers/environmentHelper";
  60334. export * from "babylonjs/Helpers/photoDome";
  60335. export * from "babylonjs/Helpers/sceneHelpers";
  60336. export * from "babylonjs/Helpers/videoDome";
  60337. }
  60338. declare module "babylonjs/Instrumentation/engineInstrumentation" {
  60339. import { PerfCounter } from "babylonjs/Misc/perfCounter";
  60340. import { IDisposable } from "babylonjs/scene";
  60341. import { Engine } from "babylonjs/Engines/engine";
  60342. /**
  60343. * This class can be used to get instrumentation data from a Babylon engine
  60344. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  60345. */
  60346. export class EngineInstrumentation implements IDisposable {
  60347. /**
  60348. * Define the instrumented engine.
  60349. */
  60350. engine: Engine;
  60351. private _captureGPUFrameTime;
  60352. private _gpuFrameTimeToken;
  60353. private _gpuFrameTime;
  60354. private _captureShaderCompilationTime;
  60355. private _shaderCompilationTime;
  60356. private _onBeginFrameObserver;
  60357. private _onEndFrameObserver;
  60358. private _onBeforeShaderCompilationObserver;
  60359. private _onAfterShaderCompilationObserver;
  60360. /**
  60361. * Gets the perf counter used for GPU frame time
  60362. */
  60363. get gpuFrameTimeCounter(): PerfCounter;
  60364. /**
  60365. * Gets the GPU frame time capture status
  60366. */
  60367. get captureGPUFrameTime(): boolean;
  60368. /**
  60369. * Enable or disable the GPU frame time capture
  60370. */
  60371. set captureGPUFrameTime(value: boolean);
  60372. /**
  60373. * Gets the perf counter used for shader compilation time
  60374. */
  60375. get shaderCompilationTimeCounter(): PerfCounter;
  60376. /**
  60377. * Gets the shader compilation time capture status
  60378. */
  60379. get captureShaderCompilationTime(): boolean;
  60380. /**
  60381. * Enable or disable the shader compilation time capture
  60382. */
  60383. set captureShaderCompilationTime(value: boolean);
  60384. /**
  60385. * Instantiates a new engine instrumentation.
  60386. * This class can be used to get instrumentation data from a Babylon engine
  60387. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  60388. * @param engine Defines the engine to instrument
  60389. */
  60390. constructor(
  60391. /**
  60392. * Define the instrumented engine.
  60393. */
  60394. engine: Engine);
  60395. /**
  60396. * Dispose and release associated resources.
  60397. */
  60398. dispose(): void;
  60399. }
  60400. }
  60401. declare module "babylonjs/Instrumentation/sceneInstrumentation" {
  60402. import { Scene, IDisposable } from "babylonjs/scene";
  60403. import { PerfCounter } from "babylonjs/Misc/perfCounter";
  60404. /**
  60405. * This class can be used to get instrumentation data from a Babylon engine
  60406. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#sceneinstrumentation
  60407. */
  60408. export class SceneInstrumentation implements IDisposable {
  60409. /**
  60410. * Defines the scene to instrument
  60411. */
  60412. scene: Scene;
  60413. private _captureActiveMeshesEvaluationTime;
  60414. private _activeMeshesEvaluationTime;
  60415. private _captureRenderTargetsRenderTime;
  60416. private _renderTargetsRenderTime;
  60417. private _captureFrameTime;
  60418. private _frameTime;
  60419. private _captureRenderTime;
  60420. private _renderTime;
  60421. private _captureInterFrameTime;
  60422. private _interFrameTime;
  60423. private _captureParticlesRenderTime;
  60424. private _particlesRenderTime;
  60425. private _captureSpritesRenderTime;
  60426. private _spritesRenderTime;
  60427. private _capturePhysicsTime;
  60428. private _physicsTime;
  60429. private _captureAnimationsTime;
  60430. private _animationsTime;
  60431. private _captureCameraRenderTime;
  60432. private _cameraRenderTime;
  60433. private _onBeforeActiveMeshesEvaluationObserver;
  60434. private _onAfterActiveMeshesEvaluationObserver;
  60435. private _onBeforeRenderTargetsRenderObserver;
  60436. private _onAfterRenderTargetsRenderObserver;
  60437. private _onAfterRenderObserver;
  60438. private _onBeforeDrawPhaseObserver;
  60439. private _onAfterDrawPhaseObserver;
  60440. private _onBeforeAnimationsObserver;
  60441. private _onBeforeParticlesRenderingObserver;
  60442. private _onAfterParticlesRenderingObserver;
  60443. private _onBeforeSpritesRenderingObserver;
  60444. private _onAfterSpritesRenderingObserver;
  60445. private _onBeforePhysicsObserver;
  60446. private _onAfterPhysicsObserver;
  60447. private _onAfterAnimationsObserver;
  60448. private _onBeforeCameraRenderObserver;
  60449. private _onAfterCameraRenderObserver;
  60450. /**
  60451. * Gets the perf counter used for active meshes evaluation time
  60452. */
  60453. get activeMeshesEvaluationTimeCounter(): PerfCounter;
  60454. /**
  60455. * Gets the active meshes evaluation time capture status
  60456. */
  60457. get captureActiveMeshesEvaluationTime(): boolean;
  60458. /**
  60459. * Enable or disable the active meshes evaluation time capture
  60460. */
  60461. set captureActiveMeshesEvaluationTime(value: boolean);
  60462. /**
  60463. * Gets the perf counter used for render targets render time
  60464. */
  60465. get renderTargetsRenderTimeCounter(): PerfCounter;
  60466. /**
  60467. * Gets the render targets render time capture status
  60468. */
  60469. get captureRenderTargetsRenderTime(): boolean;
  60470. /**
  60471. * Enable or disable the render targets render time capture
  60472. */
  60473. set captureRenderTargetsRenderTime(value: boolean);
  60474. /**
  60475. * Gets the perf counter used for particles render time
  60476. */
  60477. get particlesRenderTimeCounter(): PerfCounter;
  60478. /**
  60479. * Gets the particles render time capture status
  60480. */
  60481. get captureParticlesRenderTime(): boolean;
  60482. /**
  60483. * Enable or disable the particles render time capture
  60484. */
  60485. set captureParticlesRenderTime(value: boolean);
  60486. /**
  60487. * Gets the perf counter used for sprites render time
  60488. */
  60489. get spritesRenderTimeCounter(): PerfCounter;
  60490. /**
  60491. * Gets the sprites render time capture status
  60492. */
  60493. get captureSpritesRenderTime(): boolean;
  60494. /**
  60495. * Enable or disable the sprites render time capture
  60496. */
  60497. set captureSpritesRenderTime(value: boolean);
  60498. /**
  60499. * Gets the perf counter used for physics time
  60500. */
  60501. get physicsTimeCounter(): PerfCounter;
  60502. /**
  60503. * Gets the physics time capture status
  60504. */
  60505. get capturePhysicsTime(): boolean;
  60506. /**
  60507. * Enable or disable the physics time capture
  60508. */
  60509. set capturePhysicsTime(value: boolean);
  60510. /**
  60511. * Gets the perf counter used for animations time
  60512. */
  60513. get animationsTimeCounter(): PerfCounter;
  60514. /**
  60515. * Gets the animations time capture status
  60516. */
  60517. get captureAnimationsTime(): boolean;
  60518. /**
  60519. * Enable or disable the animations time capture
  60520. */
  60521. set captureAnimationsTime(value: boolean);
  60522. /**
  60523. * Gets the perf counter used for frame time capture
  60524. */
  60525. get frameTimeCounter(): PerfCounter;
  60526. /**
  60527. * Gets the frame time capture status
  60528. */
  60529. get captureFrameTime(): boolean;
  60530. /**
  60531. * Enable or disable the frame time capture
  60532. */
  60533. set captureFrameTime(value: boolean);
  60534. /**
  60535. * Gets the perf counter used for inter-frames time capture
  60536. */
  60537. get interFrameTimeCounter(): PerfCounter;
  60538. /**
  60539. * Gets the inter-frames time capture status
  60540. */
  60541. get captureInterFrameTime(): boolean;
  60542. /**
  60543. * Enable or disable the inter-frames time capture
  60544. */
  60545. set captureInterFrameTime(value: boolean);
  60546. /**
  60547. * Gets the perf counter used for render time capture
  60548. */
  60549. get renderTimeCounter(): PerfCounter;
  60550. /**
  60551. * Gets the render time capture status
  60552. */
  60553. get captureRenderTime(): boolean;
  60554. /**
  60555. * Enable or disable the render time capture
  60556. */
  60557. set captureRenderTime(value: boolean);
  60558. /**
  60559. * Gets the perf counter used for camera render time capture
  60560. */
  60561. get cameraRenderTimeCounter(): PerfCounter;
  60562. /**
  60563. * Gets the camera render time capture status
  60564. */
  60565. get captureCameraRenderTime(): boolean;
  60566. /**
  60567. * Enable or disable the camera render time capture
  60568. */
  60569. set captureCameraRenderTime(value: boolean);
  60570. /**
  60571. * Gets the perf counter used for draw calls
  60572. */
  60573. get drawCallsCounter(): PerfCounter;
  60574. /**
  60575. * Instantiates a new scene instrumentation.
  60576. * This class can be used to get instrumentation data from a Babylon engine
  60577. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#sceneinstrumentation
  60578. * @param scene Defines the scene to instrument
  60579. */
  60580. constructor(
  60581. /**
  60582. * Defines the scene to instrument
  60583. */
  60584. scene: Scene);
  60585. /**
  60586. * Dispose and release associated resources.
  60587. */
  60588. dispose(): void;
  60589. }
  60590. }
  60591. declare module "babylonjs/Instrumentation/index" {
  60592. export * from "babylonjs/Instrumentation/engineInstrumentation";
  60593. export * from "babylonjs/Instrumentation/sceneInstrumentation";
  60594. export * from "babylonjs/Instrumentation/timeToken";
  60595. }
  60596. declare module "babylonjs/Shaders/glowMapGeneration.fragment" {
  60597. /** @hidden */
  60598. export var glowMapGenerationPixelShader: {
  60599. name: string;
  60600. shader: string;
  60601. };
  60602. }
  60603. declare module "babylonjs/Shaders/glowMapGeneration.vertex" {
  60604. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  60605. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  60606. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  60607. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  60608. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  60609. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  60610. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  60611. /** @hidden */
  60612. export var glowMapGenerationVertexShader: {
  60613. name: string;
  60614. shader: string;
  60615. };
  60616. }
  60617. declare module "babylonjs/Layers/effectLayer" {
  60618. import { Observable } from "babylonjs/Misc/observable";
  60619. import { Nullable } from "babylonjs/types";
  60620. import { Camera } from "babylonjs/Cameras/camera";
  60621. import { Scene } from "babylonjs/scene";
  60622. import { ISize } from "babylonjs/Maths/math.size";
  60623. import { Color4 } from "babylonjs/Maths/math.color";
  60624. import { Engine } from "babylonjs/Engines/engine";
  60625. import { SubMesh } from "babylonjs/Meshes/subMesh";
  60626. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  60627. import { Mesh } from "babylonjs/Meshes/mesh";
  60628. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  60629. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  60630. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  60631. import { Effect } from "babylonjs/Materials/effect";
  60632. import { Material } from "babylonjs/Materials/material";
  60633. import "babylonjs/Shaders/glowMapGeneration.fragment";
  60634. import "babylonjs/Shaders/glowMapGeneration.vertex";
  60635. /**
  60636. * Effect layer options. This helps customizing the behaviour
  60637. * of the effect layer.
  60638. */
  60639. export interface IEffectLayerOptions {
  60640. /**
  60641. * Multiplication factor apply to the canvas size to compute the render target size
  60642. * used to generated the objects (the smaller the faster).
  60643. */
  60644. mainTextureRatio: number;
  60645. /**
  60646. * Enforces a fixed size texture to ensure effect stability across devices.
  60647. */
  60648. mainTextureFixedSize?: number;
  60649. /**
  60650. * Alpha blending mode used to apply the blur. Default depends of the implementation.
  60651. */
  60652. alphaBlendingMode: number;
  60653. /**
  60654. * The camera attached to the layer.
  60655. */
  60656. camera: Nullable<Camera>;
  60657. /**
  60658. * The rendering group to draw the layer in.
  60659. */
  60660. renderingGroupId: number;
  60661. }
  60662. /**
  60663. * The effect layer Helps adding post process effect blended with the main pass.
  60664. *
  60665. * This can be for instance use to generate glow or higlight effects on the scene.
  60666. *
  60667. * The effect layer class can not be used directly and is intented to inherited from to be
  60668. * customized per effects.
  60669. */
  60670. export abstract class EffectLayer {
  60671. private _vertexBuffers;
  60672. private _indexBuffer;
  60673. private _cachedDefines;
  60674. private _effectLayerMapGenerationEffect;
  60675. private _effectLayerOptions;
  60676. private _mergeEffect;
  60677. protected _scene: Scene;
  60678. protected _engine: Engine;
  60679. protected _maxSize: number;
  60680. protected _mainTextureDesiredSize: ISize;
  60681. protected _mainTexture: RenderTargetTexture;
  60682. protected _shouldRender: boolean;
  60683. protected _postProcesses: PostProcess[];
  60684. protected _textures: BaseTexture[];
  60685. protected _emissiveTextureAndColor: {
  60686. texture: Nullable<BaseTexture>;
  60687. color: Color4;
  60688. };
  60689. /**
  60690. * The name of the layer
  60691. */
  60692. name: string;
  60693. /**
  60694. * The clear color of the texture used to generate the glow map.
  60695. */
  60696. neutralColor: Color4;
  60697. /**
  60698. * Specifies whether the highlight layer is enabled or not.
  60699. */
  60700. isEnabled: boolean;
  60701. /**
  60702. * Gets the camera attached to the layer.
  60703. */
  60704. get camera(): Nullable<Camera>;
  60705. /**
  60706. * Gets the rendering group id the layer should render in.
  60707. */
  60708. get renderingGroupId(): number;
  60709. set renderingGroupId(renderingGroupId: number);
  60710. /**
  60711. * An event triggered when the effect layer has been disposed.
  60712. */
  60713. onDisposeObservable: Observable<EffectLayer>;
  60714. /**
  60715. * An event triggered when the effect layer is about rendering the main texture with the glowy parts.
  60716. */
  60717. onBeforeRenderMainTextureObservable: Observable<EffectLayer>;
  60718. /**
  60719. * An event triggered when the generated texture is being merged in the scene.
  60720. */
  60721. onBeforeComposeObservable: Observable<EffectLayer>;
  60722. /**
  60723. * An event triggered when the mesh is rendered into the effect render target.
  60724. */
  60725. onBeforeRenderMeshToEffect: Observable<AbstractMesh>;
  60726. /**
  60727. * An event triggered after the mesh has been rendered into the effect render target.
  60728. */
  60729. onAfterRenderMeshToEffect: Observable<AbstractMesh>;
  60730. /**
  60731. * An event triggered when the generated texture has been merged in the scene.
  60732. */
  60733. onAfterComposeObservable: Observable<EffectLayer>;
  60734. /**
  60735. * An event triggered when the efffect layer changes its size.
  60736. */
  60737. onSizeChangedObservable: Observable<EffectLayer>;
  60738. /** @hidden */
  60739. static _SceneComponentInitialization: (scene: Scene) => void;
  60740. /**
  60741. * Instantiates a new effect Layer and references it in the scene.
  60742. * @param name The name of the layer
  60743. * @param scene The scene to use the layer in
  60744. */
  60745. constructor(
  60746. /** The Friendly of the effect in the scene */
  60747. name: string, scene: Scene);
  60748. /**
  60749. * Get the effect name of the layer.
  60750. * @return The effect name
  60751. */
  60752. abstract getEffectName(): string;
  60753. /**
  60754. * Checks for the readiness of the element composing the layer.
  60755. * @param subMesh the mesh to check for
  60756. * @param useInstances specify whether or not to use instances to render the mesh
  60757. * @return true if ready otherwise, false
  60758. */
  60759. abstract isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  60760. /**
  60761. * Returns whether or nood the layer needs stencil enabled during the mesh rendering.
  60762. * @returns true if the effect requires stencil during the main canvas render pass.
  60763. */
  60764. abstract needStencil(): boolean;
  60765. /**
  60766. * Create the merge effect. This is the shader use to blit the information back
  60767. * to the main canvas at the end of the scene rendering.
  60768. * @returns The effect containing the shader used to merge the effect on the main canvas
  60769. */
  60770. protected abstract _createMergeEffect(): Effect;
  60771. /**
  60772. * Creates the render target textures and post processes used in the effect layer.
  60773. */
  60774. protected abstract _createTextureAndPostProcesses(): void;
  60775. /**
  60776. * Implementation specific of rendering the generating effect on the main canvas.
  60777. * @param effect The effect used to render through
  60778. */
  60779. protected abstract _internalRender(effect: Effect): void;
  60780. /**
  60781. * Sets the required values for both the emissive texture and and the main color.
  60782. */
  60783. protected abstract _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  60784. /**
  60785. * Free any resources and references associated to a mesh.
  60786. * Internal use
  60787. * @param mesh The mesh to free.
  60788. */
  60789. abstract _disposeMesh(mesh: Mesh): void;
  60790. /**
  60791. * Serializes this layer (Glow or Highlight for example)
  60792. * @returns a serialized layer object
  60793. */
  60794. abstract serialize?(): any;
  60795. /**
  60796. * Initializes the effect layer with the required options.
  60797. * @param options Sets of none mandatory options to use with the layer (see IEffectLayerOptions for more information)
  60798. */
  60799. protected _init(options: Partial<IEffectLayerOptions>): void;
  60800. /**
  60801. * Generates the index buffer of the full screen quad blending to the main canvas.
  60802. */
  60803. private _generateIndexBuffer;
  60804. /**
  60805. * Generates the vertex buffer of the full screen quad blending to the main canvas.
  60806. */
  60807. private _generateVertexBuffer;
  60808. /**
  60809. * Sets the main texture desired size which is the closest power of two
  60810. * of the engine canvas size.
  60811. */
  60812. private _setMainTextureSize;
  60813. /**
  60814. * Creates the main texture for the effect layer.
  60815. */
  60816. protected _createMainTexture(): void;
  60817. /**
  60818. * Adds specific effects defines.
  60819. * @param defines The defines to add specifics to.
  60820. */
  60821. protected _addCustomEffectDefines(defines: string[]): void;
  60822. /**
  60823. * Checks for the readiness of the element composing the layer.
  60824. * @param subMesh the mesh to check for
  60825. * @param useInstances specify whether or not to use instances to render the mesh
  60826. * @param emissiveTexture the associated emissive texture used to generate the glow
  60827. * @return true if ready otherwise, false
  60828. */
  60829. protected _isReady(subMesh: SubMesh, useInstances: boolean, emissiveTexture: Nullable<BaseTexture>): boolean;
  60830. /**
  60831. * Renders the glowing part of the scene by blending the blurred glowing meshes on top of the rendered scene.
  60832. */
  60833. render(): void;
  60834. /**
  60835. * Determine if a given mesh will be used in the current effect.
  60836. * @param mesh mesh to test
  60837. * @returns true if the mesh will be used
  60838. */
  60839. hasMesh(mesh: AbstractMesh): boolean;
  60840. /**
  60841. * Returns true if the layer contains information to display, otherwise false.
  60842. * @returns true if the glow layer should be rendered
  60843. */
  60844. shouldRender(): boolean;
  60845. /**
  60846. * Returns true if the mesh should render, otherwise false.
  60847. * @param mesh The mesh to render
  60848. * @returns true if it should render otherwise false
  60849. */
  60850. protected _shouldRenderMesh(mesh: AbstractMesh): boolean;
  60851. /**
  60852. * Returns true if the mesh can be rendered, otherwise false.
  60853. * @param mesh The mesh to render
  60854. * @param material The material used on the mesh
  60855. * @returns true if it can be rendered otherwise false
  60856. */
  60857. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  60858. /**
  60859. * Returns true if the mesh should render, otherwise false.
  60860. * @param mesh The mesh to render
  60861. * @returns true if it should render otherwise false
  60862. */
  60863. protected _shouldRenderEmissiveTextureForMesh(): boolean;
  60864. /**
  60865. * Renders the submesh passed in parameter to the generation map.
  60866. */
  60867. protected _renderSubMesh(subMesh: SubMesh, enableAlphaMode?: boolean): void;
  60868. /**
  60869. * Defines whether the current material of the mesh should be use to render the effect.
  60870. * @param mesh defines the current mesh to render
  60871. */
  60872. protected _useMeshMaterial(mesh: AbstractMesh): boolean;
  60873. /**
  60874. * Rebuild the required buffers.
  60875. * @hidden Internal use only.
  60876. */
  60877. _rebuild(): void;
  60878. /**
  60879. * Dispose only the render target textures and post process.
  60880. */
  60881. private _disposeTextureAndPostProcesses;
  60882. /**
  60883. * Dispose the highlight layer and free resources.
  60884. */
  60885. dispose(): void;
  60886. /**
  60887. * Gets the class name of the effect layer
  60888. * @returns the string with the class name of the effect layer
  60889. */
  60890. getClassName(): string;
  60891. /**
  60892. * Creates an effect layer from parsed effect layer data
  60893. * @param parsedEffectLayer defines effect layer data
  60894. * @param scene defines the current scene
  60895. * @param rootUrl defines the root URL containing the effect layer information
  60896. * @returns a parsed effect Layer
  60897. */
  60898. static Parse(parsedEffectLayer: any, scene: Scene, rootUrl: string): EffectLayer;
  60899. }
  60900. }
  60901. declare module "babylonjs/Layers/effectLayerSceneComponent" {
  60902. import { Scene } from "babylonjs/scene";
  60903. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  60904. import { EffectLayer } from "babylonjs/Layers/effectLayer";
  60905. import { AbstractScene } from "babylonjs/abstractScene";
  60906. module "babylonjs/abstractScene" {
  60907. interface AbstractScene {
  60908. /**
  60909. * The list of effect layers (highlights/glow) added to the scene
  60910. * @see https://doc.babylonjs.com/how_to/highlight_layer
  60911. * @see https://doc.babylonjs.com/how_to/glow_layer
  60912. */
  60913. effectLayers: Array<EffectLayer>;
  60914. /**
  60915. * Removes the given effect layer from this scene.
  60916. * @param toRemove defines the effect layer to remove
  60917. * @returns the index of the removed effect layer
  60918. */
  60919. removeEffectLayer(toRemove: EffectLayer): number;
  60920. /**
  60921. * Adds the given effect layer to this scene
  60922. * @param newEffectLayer defines the effect layer to add
  60923. */
  60924. addEffectLayer(newEffectLayer: EffectLayer): void;
  60925. }
  60926. }
  60927. /**
  60928. * Defines the layer scene component responsible to manage any effect layers
  60929. * in a given scene.
  60930. */
  60931. export class EffectLayerSceneComponent implements ISceneSerializableComponent {
  60932. /**
  60933. * The component name helpfull to identify the component in the list of scene components.
  60934. */
  60935. readonly name: string;
  60936. /**
  60937. * The scene the component belongs to.
  60938. */
  60939. scene: Scene;
  60940. private _engine;
  60941. private _renderEffects;
  60942. private _needStencil;
  60943. private _previousStencilState;
  60944. /**
  60945. * Creates a new instance of the component for the given scene
  60946. * @param scene Defines the scene to register the component in
  60947. */
  60948. constructor(scene: Scene);
  60949. /**
  60950. * Registers the component in a given scene
  60951. */
  60952. register(): void;
  60953. /**
  60954. * Rebuilds the elements related to this component in case of
  60955. * context lost for instance.
  60956. */
  60957. rebuild(): void;
  60958. /**
  60959. * Serializes the component data to the specified json object
  60960. * @param serializationObject The object to serialize to
  60961. */
  60962. serialize(serializationObject: any): void;
  60963. /**
  60964. * Adds all the elements from the container to the scene
  60965. * @param container the container holding the elements
  60966. */
  60967. addFromContainer(container: AbstractScene): void;
  60968. /**
  60969. * Removes all the elements in the container from the scene
  60970. * @param container contains the elements to remove
  60971. * @param dispose if the removed element should be disposed (default: false)
  60972. */
  60973. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  60974. /**
  60975. * Disposes the component and the associated ressources.
  60976. */
  60977. dispose(): void;
  60978. private _isReadyForMesh;
  60979. private _renderMainTexture;
  60980. private _setStencil;
  60981. private _setStencilBack;
  60982. private _draw;
  60983. private _drawCamera;
  60984. private _drawRenderingGroup;
  60985. }
  60986. }
  60987. declare module "babylonjs/Shaders/glowMapMerge.fragment" {
  60988. /** @hidden */
  60989. export var glowMapMergePixelShader: {
  60990. name: string;
  60991. shader: string;
  60992. };
  60993. }
  60994. declare module "babylonjs/Shaders/glowMapMerge.vertex" {
  60995. /** @hidden */
  60996. export var glowMapMergeVertexShader: {
  60997. name: string;
  60998. shader: string;
  60999. };
  61000. }
  61001. declare module "babylonjs/Layers/glowLayer" {
  61002. import { Nullable } from "babylonjs/types";
  61003. import { Camera } from "babylonjs/Cameras/camera";
  61004. import { Scene } from "babylonjs/scene";
  61005. import { SubMesh } from "babylonjs/Meshes/subMesh";
  61006. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  61007. import { Mesh } from "babylonjs/Meshes/mesh";
  61008. import { Texture } from "babylonjs/Materials/Textures/texture";
  61009. import { Effect } from "babylonjs/Materials/effect";
  61010. import { Material } from "babylonjs/Materials/material";
  61011. import { EffectLayer } from "babylonjs/Layers/effectLayer";
  61012. import { Color4 } from "babylonjs/Maths/math.color";
  61013. import "babylonjs/Shaders/glowMapMerge.fragment";
  61014. import "babylonjs/Shaders/glowMapMerge.vertex";
  61015. import "babylonjs/Layers/effectLayerSceneComponent";
  61016. module "babylonjs/abstractScene" {
  61017. interface AbstractScene {
  61018. /**
  61019. * Return a the first highlight layer of the scene with a given name.
  61020. * @param name The name of the highlight layer to look for.
  61021. * @return The highlight layer if found otherwise null.
  61022. */
  61023. getGlowLayerByName(name: string): Nullable<GlowLayer>;
  61024. }
  61025. }
  61026. /**
  61027. * Glow layer options. This helps customizing the behaviour
  61028. * of the glow layer.
  61029. */
  61030. export interface IGlowLayerOptions {
  61031. /**
  61032. * Multiplication factor apply to the canvas size to compute the render target size
  61033. * used to generated the glowing objects (the smaller the faster).
  61034. */
  61035. mainTextureRatio: number;
  61036. /**
  61037. * Enforces a fixed size texture to ensure resize independant blur.
  61038. */
  61039. mainTextureFixedSize?: number;
  61040. /**
  61041. * How big is the kernel of the blur texture.
  61042. */
  61043. blurKernelSize: number;
  61044. /**
  61045. * The camera attached to the layer.
  61046. */
  61047. camera: Nullable<Camera>;
  61048. /**
  61049. * Enable MSAA by chosing the number of samples.
  61050. */
  61051. mainTextureSamples?: number;
  61052. /**
  61053. * The rendering group to draw the layer in.
  61054. */
  61055. renderingGroupId: number;
  61056. }
  61057. /**
  61058. * The glow layer Helps adding a glow effect around the emissive parts of a mesh.
  61059. *
  61060. * Once instantiated in a scene, by default, all the emissive meshes will glow.
  61061. *
  61062. * Documentation: https://doc.babylonjs.com/how_to/glow_layer
  61063. */
  61064. export class GlowLayer extends EffectLayer {
  61065. /**
  61066. * Effect Name of the layer.
  61067. */
  61068. static readonly EffectName: string;
  61069. /**
  61070. * The default blur kernel size used for the glow.
  61071. */
  61072. static DefaultBlurKernelSize: number;
  61073. /**
  61074. * The default texture size ratio used for the glow.
  61075. */
  61076. static DefaultTextureRatio: number;
  61077. /**
  61078. * Sets the kernel size of the blur.
  61079. */
  61080. set blurKernelSize(value: number);
  61081. /**
  61082. * Gets the kernel size of the blur.
  61083. */
  61084. get blurKernelSize(): number;
  61085. /**
  61086. * Sets the glow intensity.
  61087. */
  61088. set intensity(value: number);
  61089. /**
  61090. * Gets the glow intensity.
  61091. */
  61092. get intensity(): number;
  61093. private _options;
  61094. private _intensity;
  61095. private _horizontalBlurPostprocess1;
  61096. private _verticalBlurPostprocess1;
  61097. private _horizontalBlurPostprocess2;
  61098. private _verticalBlurPostprocess2;
  61099. private _blurTexture1;
  61100. private _blurTexture2;
  61101. private _postProcesses1;
  61102. private _postProcesses2;
  61103. private _includedOnlyMeshes;
  61104. private _excludedMeshes;
  61105. private _meshesUsingTheirOwnMaterials;
  61106. /**
  61107. * Callback used to let the user override the color selection on a per mesh basis
  61108. */
  61109. customEmissiveColorSelector: (mesh: Mesh, subMesh: SubMesh, material: Material, result: Color4) => void;
  61110. /**
  61111. * Callback used to let the user override the texture selection on a per mesh basis
  61112. */
  61113. customEmissiveTextureSelector: (mesh: Mesh, subMesh: SubMesh, material: Material) => Texture;
  61114. /**
  61115. * Instantiates a new glow Layer and references it to the scene.
  61116. * @param name The name of the layer
  61117. * @param scene The scene to use the layer in
  61118. * @param options Sets of none mandatory options to use with the layer (see IGlowLayerOptions for more information)
  61119. */
  61120. constructor(name: string, scene: Scene, options?: Partial<IGlowLayerOptions>);
  61121. /**
  61122. * Get the effect name of the layer.
  61123. * @return The effect name
  61124. */
  61125. getEffectName(): string;
  61126. /**
  61127. * Create the merge effect. This is the shader use to blit the information back
  61128. * to the main canvas at the end of the scene rendering.
  61129. */
  61130. protected _createMergeEffect(): Effect;
  61131. /**
  61132. * Creates the render target textures and post processes used in the glow layer.
  61133. */
  61134. protected _createTextureAndPostProcesses(): void;
  61135. /**
  61136. * Checks for the readiness of the element composing the layer.
  61137. * @param subMesh the mesh to check for
  61138. * @param useInstances specify wether or not to use instances to render the mesh
  61139. * @param emissiveTexture the associated emissive texture used to generate the glow
  61140. * @return true if ready otherwise, false
  61141. */
  61142. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  61143. /**
  61144. * Returns whether or nood the layer needs stencil enabled during the mesh rendering.
  61145. */
  61146. needStencil(): boolean;
  61147. /**
  61148. * Returns true if the mesh can be rendered, otherwise false.
  61149. * @param mesh The mesh to render
  61150. * @param material The material used on the mesh
  61151. * @returns true if it can be rendered otherwise false
  61152. */
  61153. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  61154. /**
  61155. * Implementation specific of rendering the generating effect on the main canvas.
  61156. * @param effect The effect used to render through
  61157. */
  61158. protected _internalRender(effect: Effect): void;
  61159. /**
  61160. * Sets the required values for both the emissive texture and and the main color.
  61161. */
  61162. protected _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  61163. /**
  61164. * Returns true if the mesh should render, otherwise false.
  61165. * @param mesh The mesh to render
  61166. * @returns true if it should render otherwise false
  61167. */
  61168. protected _shouldRenderMesh(mesh: Mesh): boolean;
  61169. /**
  61170. * Adds specific effects defines.
  61171. * @param defines The defines to add specifics to.
  61172. */
  61173. protected _addCustomEffectDefines(defines: string[]): void;
  61174. /**
  61175. * Add a mesh in the exclusion list to prevent it to impact or being impacted by the glow layer.
  61176. * @param mesh The mesh to exclude from the glow layer
  61177. */
  61178. addExcludedMesh(mesh: Mesh): void;
  61179. /**
  61180. * Remove a mesh from the exclusion list to let it impact or being impacted by the glow layer.
  61181. * @param mesh The mesh to remove
  61182. */
  61183. removeExcludedMesh(mesh: Mesh): void;
  61184. /**
  61185. * Add a mesh in the inclusion list to impact or being impacted by the glow layer.
  61186. * @param mesh The mesh to include in the glow layer
  61187. */
  61188. addIncludedOnlyMesh(mesh: Mesh): void;
  61189. /**
  61190. * Remove a mesh from the Inclusion list to prevent it to impact or being impacted by the glow layer.
  61191. * @param mesh The mesh to remove
  61192. */
  61193. removeIncludedOnlyMesh(mesh: Mesh): void;
  61194. /**
  61195. * Determine if a given mesh will be used in the glow layer
  61196. * @param mesh The mesh to test
  61197. * @returns true if the mesh will be highlighted by the current glow layer
  61198. */
  61199. hasMesh(mesh: AbstractMesh): boolean;
  61200. /**
  61201. * Defines whether the current material of the mesh should be use to render the effect.
  61202. * @param mesh defines the current mesh to render
  61203. */
  61204. protected _useMeshMaterial(mesh: AbstractMesh): boolean;
  61205. /**
  61206. * Add a mesh to be rendered through its own material and not with emissive only.
  61207. * @param mesh The mesh for which we need to use its material
  61208. */
  61209. referenceMeshToUseItsOwnMaterial(mesh: AbstractMesh): void;
  61210. /**
  61211. * Remove a mesh from being rendered through its own material and not with emissive only.
  61212. * @param mesh The mesh for which we need to not use its material
  61213. */
  61214. unReferenceMeshFromUsingItsOwnMaterial(mesh: AbstractMesh): void;
  61215. /**
  61216. * Free any resources and references associated to a mesh.
  61217. * Internal use
  61218. * @param mesh The mesh to free.
  61219. * @hidden
  61220. */
  61221. _disposeMesh(mesh: Mesh): void;
  61222. /**
  61223. * Gets the class name of the effect layer
  61224. * @returns the string with the class name of the effect layer
  61225. */
  61226. getClassName(): string;
  61227. /**
  61228. * Serializes this glow layer
  61229. * @returns a serialized glow layer object
  61230. */
  61231. serialize(): any;
  61232. /**
  61233. * Creates a Glow Layer from parsed glow layer data
  61234. * @param parsedGlowLayer defines glow layer data
  61235. * @param scene defines the current scene
  61236. * @param rootUrl defines the root URL containing the glow layer information
  61237. * @returns a parsed Glow Layer
  61238. */
  61239. static Parse(parsedGlowLayer: any, scene: Scene, rootUrl: string): GlowLayer;
  61240. }
  61241. }
  61242. declare module "babylonjs/Shaders/glowBlurPostProcess.fragment" {
  61243. /** @hidden */
  61244. export var glowBlurPostProcessPixelShader: {
  61245. name: string;
  61246. shader: string;
  61247. };
  61248. }
  61249. declare module "babylonjs/Layers/highlightLayer" {
  61250. import { Observable } from "babylonjs/Misc/observable";
  61251. import { Nullable } from "babylonjs/types";
  61252. import { Camera } from "babylonjs/Cameras/camera";
  61253. import { Scene } from "babylonjs/scene";
  61254. import { SubMesh } from "babylonjs/Meshes/subMesh";
  61255. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  61256. import { Mesh } from "babylonjs/Meshes/mesh";
  61257. import { Effect } from "babylonjs/Materials/effect";
  61258. import { Material } from "babylonjs/Materials/material";
  61259. import { EffectLayer } from "babylonjs/Layers/effectLayer";
  61260. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  61261. import "babylonjs/Shaders/glowMapMerge.fragment";
  61262. import "babylonjs/Shaders/glowMapMerge.vertex";
  61263. import "babylonjs/Shaders/glowBlurPostProcess.fragment";
  61264. module "babylonjs/abstractScene" {
  61265. interface AbstractScene {
  61266. /**
  61267. * Return a the first highlight layer of the scene with a given name.
  61268. * @param name The name of the highlight layer to look for.
  61269. * @return The highlight layer if found otherwise null.
  61270. */
  61271. getHighlightLayerByName(name: string): Nullable<HighlightLayer>;
  61272. }
  61273. }
  61274. /**
  61275. * Highlight layer options. This helps customizing the behaviour
  61276. * of the highlight layer.
  61277. */
  61278. export interface IHighlightLayerOptions {
  61279. /**
  61280. * Multiplication factor apply to the canvas size to compute the render target size
  61281. * used to generated the glowing objects (the smaller the faster).
  61282. */
  61283. mainTextureRatio: number;
  61284. /**
  61285. * Enforces a fixed size texture to ensure resize independant blur.
  61286. */
  61287. mainTextureFixedSize?: number;
  61288. /**
  61289. * Multiplication factor apply to the main texture size in the first step of the blur to reduce the size
  61290. * of the picture to blur (the smaller the faster).
  61291. */
  61292. blurTextureSizeRatio: number;
  61293. /**
  61294. * How big in texel of the blur texture is the vertical blur.
  61295. */
  61296. blurVerticalSize: number;
  61297. /**
  61298. * How big in texel of the blur texture is the horizontal blur.
  61299. */
  61300. blurHorizontalSize: number;
  61301. /**
  61302. * Alpha blending mode used to apply the blur. Default is combine.
  61303. */
  61304. alphaBlendingMode: number;
  61305. /**
  61306. * The camera attached to the layer.
  61307. */
  61308. camera: Nullable<Camera>;
  61309. /**
  61310. * Should we display highlight as a solid stroke?
  61311. */
  61312. isStroke?: boolean;
  61313. /**
  61314. * The rendering group to draw the layer in.
  61315. */
  61316. renderingGroupId: number;
  61317. }
  61318. /**
  61319. * The highlight layer Helps adding a glow effect around a mesh.
  61320. *
  61321. * Once instantiated in a scene, simply use the addMesh or removeMesh method to add or remove
  61322. * glowy meshes to your scene.
  61323. *
  61324. * !!! THIS REQUIRES AN ACTIVE STENCIL BUFFER ON THE CANVAS !!!
  61325. */
  61326. export class HighlightLayer extends EffectLayer {
  61327. name: string;
  61328. /**
  61329. * Effect Name of the highlight layer.
  61330. */
  61331. static readonly EffectName: string;
  61332. /**
  61333. * The neutral color used during the preparation of the glow effect.
  61334. * This is black by default as the blend operation is a blend operation.
  61335. */
  61336. static NeutralColor: Color4;
  61337. /**
  61338. * Stencil value used for glowing meshes.
  61339. */
  61340. static GlowingMeshStencilReference: number;
  61341. /**
  61342. * Stencil value used for the other meshes in the scene.
  61343. */
  61344. static NormalMeshStencilReference: number;
  61345. /**
  61346. * Specifies whether or not the inner glow is ACTIVE in the layer.
  61347. */
  61348. innerGlow: boolean;
  61349. /**
  61350. * Specifies whether or not the outer glow is ACTIVE in the layer.
  61351. */
  61352. outerGlow: boolean;
  61353. /**
  61354. * Specifies the horizontal size of the blur.
  61355. */
  61356. set blurHorizontalSize(value: number);
  61357. /**
  61358. * Specifies the vertical size of the blur.
  61359. */
  61360. set blurVerticalSize(value: number);
  61361. /**
  61362. * Gets the horizontal size of the blur.
  61363. */
  61364. get blurHorizontalSize(): number;
  61365. /**
  61366. * Gets the vertical size of the blur.
  61367. */
  61368. get blurVerticalSize(): number;
  61369. /**
  61370. * An event triggered when the highlight layer is being blurred.
  61371. */
  61372. onBeforeBlurObservable: Observable<HighlightLayer>;
  61373. /**
  61374. * An event triggered when the highlight layer has been blurred.
  61375. */
  61376. onAfterBlurObservable: Observable<HighlightLayer>;
  61377. private _instanceGlowingMeshStencilReference;
  61378. private _options;
  61379. private _downSamplePostprocess;
  61380. private _horizontalBlurPostprocess;
  61381. private _verticalBlurPostprocess;
  61382. private _blurTexture;
  61383. private _meshes;
  61384. private _excludedMeshes;
  61385. /**
  61386. * Instantiates a new highlight Layer and references it to the scene..
  61387. * @param name The name of the layer
  61388. * @param scene The scene to use the layer in
  61389. * @param options Sets of none mandatory options to use with the layer (see IHighlightLayerOptions for more information)
  61390. */
  61391. constructor(name: string, scene: Scene, options?: Partial<IHighlightLayerOptions>);
  61392. /**
  61393. * Get the effect name of the layer.
  61394. * @return The effect name
  61395. */
  61396. getEffectName(): string;
  61397. /**
  61398. * Create the merge effect. This is the shader use to blit the information back
  61399. * to the main canvas at the end of the scene rendering.
  61400. */
  61401. protected _createMergeEffect(): Effect;
  61402. /**
  61403. * Creates the render target textures and post processes used in the highlight layer.
  61404. */
  61405. protected _createTextureAndPostProcesses(): void;
  61406. /**
  61407. * Returns wether or nood the layer needs stencil enabled during the mesh rendering.
  61408. */
  61409. needStencil(): boolean;
  61410. /**
  61411. * Checks for the readiness of the element composing the layer.
  61412. * @param subMesh the mesh to check for
  61413. * @param useInstances specify wether or not to use instances to render the mesh
  61414. * @param emissiveTexture the associated emissive texture used to generate the glow
  61415. * @return true if ready otherwise, false
  61416. */
  61417. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  61418. /**
  61419. * Implementation specific of rendering the generating effect on the main canvas.
  61420. * @param effect The effect used to render through
  61421. */
  61422. protected _internalRender(effect: Effect): void;
  61423. /**
  61424. * Returns true if the layer contains information to display, otherwise false.
  61425. */
  61426. shouldRender(): boolean;
  61427. /**
  61428. * Returns true if the mesh should render, otherwise false.
  61429. * @param mesh The mesh to render
  61430. * @returns true if it should render otherwise false
  61431. */
  61432. protected _shouldRenderMesh(mesh: Mesh): boolean;
  61433. /**
  61434. * Returns true if the mesh can be rendered, otherwise false.
  61435. * @param mesh The mesh to render
  61436. * @param material The material used on the mesh
  61437. * @returns true if it can be rendered otherwise false
  61438. */
  61439. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  61440. /**
  61441. * Adds specific effects defines.
  61442. * @param defines The defines to add specifics to.
  61443. */
  61444. protected _addCustomEffectDefines(defines: string[]): void;
  61445. /**
  61446. * Sets the required values for both the emissive texture and and the main color.
  61447. */
  61448. protected _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  61449. /**
  61450. * Add a mesh in the exclusion list to prevent it to impact or being impacted by the highlight layer.
  61451. * @param mesh The mesh to exclude from the highlight layer
  61452. */
  61453. addExcludedMesh(mesh: Mesh): void;
  61454. /**
  61455. * Remove a mesh from the exclusion list to let it impact or being impacted by the highlight layer.
  61456. * @param mesh The mesh to highlight
  61457. */
  61458. removeExcludedMesh(mesh: Mesh): void;
  61459. /**
  61460. * Determine if a given mesh will be highlighted by the current HighlightLayer
  61461. * @param mesh mesh to test
  61462. * @returns true if the mesh will be highlighted by the current HighlightLayer
  61463. */
  61464. hasMesh(mesh: AbstractMesh): boolean;
  61465. /**
  61466. * Add a mesh in the highlight layer in order to make it glow with the chosen color.
  61467. * @param mesh The mesh to highlight
  61468. * @param color The color of the highlight
  61469. * @param glowEmissiveOnly Extract the glow from the emissive texture
  61470. */
  61471. addMesh(mesh: Mesh, color: Color3, glowEmissiveOnly?: boolean): void;
  61472. /**
  61473. * Remove a mesh from the highlight layer in order to make it stop glowing.
  61474. * @param mesh The mesh to highlight
  61475. */
  61476. removeMesh(mesh: Mesh): void;
  61477. /**
  61478. * Remove all the meshes currently referenced in the highlight layer
  61479. */
  61480. removeAllMeshes(): void;
  61481. /**
  61482. * Force the stencil to the normal expected value for none glowing parts
  61483. */
  61484. private _defaultStencilReference;
  61485. /**
  61486. * Free any resources and references associated to a mesh.
  61487. * Internal use
  61488. * @param mesh The mesh to free.
  61489. * @hidden
  61490. */
  61491. _disposeMesh(mesh: Mesh): void;
  61492. /**
  61493. * Dispose the highlight layer and free resources.
  61494. */
  61495. dispose(): void;
  61496. /**
  61497. * Gets the class name of the effect layer
  61498. * @returns the string with the class name of the effect layer
  61499. */
  61500. getClassName(): string;
  61501. /**
  61502. * Serializes this Highlight layer
  61503. * @returns a serialized Highlight layer object
  61504. */
  61505. serialize(): any;
  61506. /**
  61507. * Creates a Highlight layer from parsed Highlight layer data
  61508. * @param parsedHightlightLayer defines the Highlight layer data
  61509. * @param scene defines the current scene
  61510. * @param rootUrl defines the root URL containing the Highlight layer information
  61511. * @returns a parsed Highlight layer
  61512. */
  61513. static Parse(parsedHightlightLayer: any, scene: Scene, rootUrl: string): HighlightLayer;
  61514. }
  61515. }
  61516. declare module "babylonjs/Layers/layerSceneComponent" {
  61517. import { Scene } from "babylonjs/scene";
  61518. import { ISceneComponent } from "babylonjs/sceneComponent";
  61519. import { Layer } from "babylonjs/Layers/layer";
  61520. import { AbstractScene } from "babylonjs/abstractScene";
  61521. module "babylonjs/abstractScene" {
  61522. interface AbstractScene {
  61523. /**
  61524. * The list of layers (background and foreground) of the scene
  61525. */
  61526. layers: Array<Layer>;
  61527. }
  61528. }
  61529. /**
  61530. * Defines the layer scene component responsible to manage any layers
  61531. * in a given scene.
  61532. */
  61533. export class LayerSceneComponent implements ISceneComponent {
  61534. /**
  61535. * The component name helpfull to identify the component in the list of scene components.
  61536. */
  61537. readonly name: string;
  61538. /**
  61539. * The scene the component belongs to.
  61540. */
  61541. scene: Scene;
  61542. private _engine;
  61543. /**
  61544. * Creates a new instance of the component for the given scene
  61545. * @param scene Defines the scene to register the component in
  61546. */
  61547. constructor(scene: Scene);
  61548. /**
  61549. * Registers the component in a given scene
  61550. */
  61551. register(): void;
  61552. /**
  61553. * Rebuilds the elements related to this component in case of
  61554. * context lost for instance.
  61555. */
  61556. rebuild(): void;
  61557. /**
  61558. * Disposes the component and the associated ressources.
  61559. */
  61560. dispose(): void;
  61561. private _draw;
  61562. private _drawCameraPredicate;
  61563. private _drawCameraBackground;
  61564. private _drawCameraForeground;
  61565. private _drawRenderTargetPredicate;
  61566. private _drawRenderTargetBackground;
  61567. private _drawRenderTargetForeground;
  61568. /**
  61569. * Adds all the elements from the container to the scene
  61570. * @param container the container holding the elements
  61571. */
  61572. addFromContainer(container: AbstractScene): void;
  61573. /**
  61574. * Removes all the elements in the container from the scene
  61575. * @param container contains the elements to remove
  61576. * @param dispose if the removed element should be disposed (default: false)
  61577. */
  61578. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  61579. }
  61580. }
  61581. declare module "babylonjs/Shaders/layer.fragment" {
  61582. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  61583. /** @hidden */
  61584. export var layerPixelShader: {
  61585. name: string;
  61586. shader: string;
  61587. };
  61588. }
  61589. declare module "babylonjs/Shaders/layer.vertex" {
  61590. /** @hidden */
  61591. export var layerVertexShader: {
  61592. name: string;
  61593. shader: string;
  61594. };
  61595. }
  61596. declare module "babylonjs/Layers/layer" {
  61597. import { Observable } from "babylonjs/Misc/observable";
  61598. import { Nullable } from "babylonjs/types";
  61599. import { Scene } from "babylonjs/scene";
  61600. import { Vector2 } from "babylonjs/Maths/math.vector";
  61601. import { Color4 } from "babylonjs/Maths/math.color";
  61602. import { Texture } from "babylonjs/Materials/Textures/texture";
  61603. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  61604. import "babylonjs/Shaders/layer.fragment";
  61605. import "babylonjs/Shaders/layer.vertex";
  61606. /**
  61607. * This represents a full screen 2d layer.
  61608. * This can be useful to display a picture in the background of your scene for instance.
  61609. * @see https://www.babylonjs-playground.com/#08A2BS#1
  61610. */
  61611. export class Layer {
  61612. /**
  61613. * Define the name of the layer.
  61614. */
  61615. name: string;
  61616. /**
  61617. * Define the texture the layer should display.
  61618. */
  61619. texture: Nullable<Texture>;
  61620. /**
  61621. * Is the layer in background or foreground.
  61622. */
  61623. isBackground: boolean;
  61624. /**
  61625. * Define the color of the layer (instead of texture).
  61626. */
  61627. color: Color4;
  61628. /**
  61629. * Define the scale of the layer in order to zoom in out of the texture.
  61630. */
  61631. scale: Vector2;
  61632. /**
  61633. * Define an offset for the layer in order to shift the texture.
  61634. */
  61635. offset: Vector2;
  61636. /**
  61637. * Define the alpha blending mode used in the layer in case the texture or color has an alpha.
  61638. */
  61639. alphaBlendingMode: number;
  61640. /**
  61641. * Define if the layer should alpha test or alpha blend with the rest of the scene.
  61642. * Alpha test will not mix with the background color in case of transparency.
  61643. * It will either use the texture color or the background depending on the alpha value of the current pixel.
  61644. */
  61645. alphaTest: boolean;
  61646. /**
  61647. * Define a mask to restrict the layer to only some of the scene cameras.
  61648. */
  61649. layerMask: number;
  61650. /**
  61651. * Define the list of render target the layer is visible into.
  61652. */
  61653. renderTargetTextures: RenderTargetTexture[];
  61654. /**
  61655. * Define if the layer is only used in renderTarget or if it also
  61656. * renders in the main frame buffer of the canvas.
  61657. */
  61658. renderOnlyInRenderTargetTextures: boolean;
  61659. private _scene;
  61660. private _vertexBuffers;
  61661. private _indexBuffer;
  61662. private _effect;
  61663. private _previousDefines;
  61664. /**
  61665. * An event triggered when the layer is disposed.
  61666. */
  61667. onDisposeObservable: Observable<Layer>;
  61668. private _onDisposeObserver;
  61669. /**
  61670. * Back compatibility with callback before the onDisposeObservable existed.
  61671. * The set callback will be triggered when the layer has been disposed.
  61672. */
  61673. set onDispose(callback: () => void);
  61674. /**
  61675. * An event triggered before rendering the scene
  61676. */
  61677. onBeforeRenderObservable: Observable<Layer>;
  61678. private _onBeforeRenderObserver;
  61679. /**
  61680. * Back compatibility with callback before the onBeforeRenderObservable existed.
  61681. * The set callback will be triggered just before rendering the layer.
  61682. */
  61683. set onBeforeRender(callback: () => void);
  61684. /**
  61685. * An event triggered after rendering the scene
  61686. */
  61687. onAfterRenderObservable: Observable<Layer>;
  61688. private _onAfterRenderObserver;
  61689. /**
  61690. * Back compatibility with callback before the onAfterRenderObservable existed.
  61691. * The set callback will be triggered just after rendering the layer.
  61692. */
  61693. set onAfterRender(callback: () => void);
  61694. /**
  61695. * Instantiates a new layer.
  61696. * This represents a full screen 2d layer.
  61697. * This can be useful to display a picture in the background of your scene for instance.
  61698. * @see https://www.babylonjs-playground.com/#08A2BS#1
  61699. * @param name Define the name of the layer in the scene
  61700. * @param imgUrl Define the url of the texture to display in the layer
  61701. * @param scene Define the scene the layer belongs to
  61702. * @param isBackground Defines whether the layer is displayed in front or behind the scene
  61703. * @param color Defines a color for the layer
  61704. */
  61705. constructor(
  61706. /**
  61707. * Define the name of the layer.
  61708. */
  61709. name: string, imgUrl: Nullable<string>, scene: Nullable<Scene>, isBackground?: boolean, color?: Color4);
  61710. private _createIndexBuffer;
  61711. /** @hidden */
  61712. _rebuild(): void;
  61713. /**
  61714. * Renders the layer in the scene.
  61715. */
  61716. render(): void;
  61717. /**
  61718. * Disposes and releases the associated ressources.
  61719. */
  61720. dispose(): void;
  61721. }
  61722. }
  61723. declare module "babylonjs/Layers/index" {
  61724. export * from "babylonjs/Layers/effectLayer";
  61725. export * from "babylonjs/Layers/effectLayerSceneComponent";
  61726. export * from "babylonjs/Layers/glowLayer";
  61727. export * from "babylonjs/Layers/highlightLayer";
  61728. export * from "babylonjs/Layers/layer";
  61729. export * from "babylonjs/Layers/layerSceneComponent";
  61730. }
  61731. declare module "babylonjs/Shaders/lensFlare.fragment" {
  61732. /** @hidden */
  61733. export var lensFlarePixelShader: {
  61734. name: string;
  61735. shader: string;
  61736. };
  61737. }
  61738. declare module "babylonjs/Shaders/lensFlare.vertex" {
  61739. /** @hidden */
  61740. export var lensFlareVertexShader: {
  61741. name: string;
  61742. shader: string;
  61743. };
  61744. }
  61745. declare module "babylonjs/LensFlares/lensFlareSystem" {
  61746. import { Scene } from "babylonjs/scene";
  61747. import { Vector3 } from "babylonjs/Maths/math.vector";
  61748. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  61749. import { LensFlare } from "babylonjs/LensFlares/lensFlare";
  61750. import "babylonjs/Shaders/lensFlare.fragment";
  61751. import "babylonjs/Shaders/lensFlare.vertex";
  61752. import { Viewport } from "babylonjs/Maths/math.viewport";
  61753. /**
  61754. * This represents a Lens Flare System or the shiny effect created by the light reflection on the camera lenses.
  61755. * It is usually composed of several `lensFlare`.
  61756. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  61757. */
  61758. export class LensFlareSystem {
  61759. /**
  61760. * Define the name of the lens flare system
  61761. */
  61762. name: string;
  61763. /**
  61764. * List of lens flares used in this system.
  61765. */
  61766. lensFlares: LensFlare[];
  61767. /**
  61768. * Define a limit from the border the lens flare can be visible.
  61769. */
  61770. borderLimit: number;
  61771. /**
  61772. * Define a viewport border we do not want to see the lens flare in.
  61773. */
  61774. viewportBorder: number;
  61775. /**
  61776. * Define a predicate which could limit the list of meshes able to occlude the effect.
  61777. */
  61778. meshesSelectionPredicate: (mesh: AbstractMesh) => boolean;
  61779. /**
  61780. * Restricts the rendering of the effect to only the camera rendering this layer mask.
  61781. */
  61782. layerMask: number;
  61783. /**
  61784. * Define the id of the lens flare system in the scene.
  61785. * (equal to name by default)
  61786. */
  61787. id: string;
  61788. private _scene;
  61789. private _emitter;
  61790. private _vertexBuffers;
  61791. private _indexBuffer;
  61792. private _effect;
  61793. private _positionX;
  61794. private _positionY;
  61795. private _isEnabled;
  61796. /** @hidden */
  61797. static _SceneComponentInitialization: (scene: Scene) => void;
  61798. /**
  61799. * Instantiates a lens flare system.
  61800. * This represents a Lens Flare System or the shiny effect created by the light reflection on the camera lenses.
  61801. * It is usually composed of several `lensFlare`.
  61802. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  61803. * @param name Define the name of the lens flare system in the scene
  61804. * @param emitter Define the source (the emitter) of the lens flares (it can be a camera, a light or a mesh).
  61805. * @param scene Define the scene the lens flare system belongs to
  61806. */
  61807. constructor(
  61808. /**
  61809. * Define the name of the lens flare system
  61810. */
  61811. name: string, emitter: any, scene: Scene);
  61812. /**
  61813. * Define if the lens flare system is enabled.
  61814. */
  61815. get isEnabled(): boolean;
  61816. set isEnabled(value: boolean);
  61817. /**
  61818. * Get the scene the effects belongs to.
  61819. * @returns the scene holding the lens flare system
  61820. */
  61821. getScene(): Scene;
  61822. /**
  61823. * Get the emitter of the lens flare system.
  61824. * It defines the source of the lens flares (it can be a camera, a light or a mesh).
  61825. * @returns the emitter of the lens flare system
  61826. */
  61827. getEmitter(): any;
  61828. /**
  61829. * Set the emitter of the lens flare system.
  61830. * It defines the source of the lens flares (it can be a camera, a light or a mesh).
  61831. * @param newEmitter Define the new emitter of the system
  61832. */
  61833. setEmitter(newEmitter: any): void;
  61834. /**
  61835. * Get the lens flare system emitter position.
  61836. * The emitter defines the source of the lens flares (it can be a camera, a light or a mesh).
  61837. * @returns the position
  61838. */
  61839. getEmitterPosition(): Vector3;
  61840. /**
  61841. * @hidden
  61842. */
  61843. computeEffectivePosition(globalViewport: Viewport): boolean;
  61844. /** @hidden */
  61845. _isVisible(): boolean;
  61846. /**
  61847. * @hidden
  61848. */
  61849. render(): boolean;
  61850. /**
  61851. * Dispose and release the lens flare with its associated resources.
  61852. */
  61853. dispose(): void;
  61854. /**
  61855. * Parse a lens flare system from a JSON repressentation
  61856. * @param parsedLensFlareSystem Define the JSON to parse
  61857. * @param scene Define the scene the parsed system should be instantiated in
  61858. * @param rootUrl Define the rootUrl of the load sequence to easily find a load relative dependencies such as textures
  61859. * @returns the parsed system
  61860. */
  61861. static Parse(parsedLensFlareSystem: any, scene: Scene, rootUrl: string): LensFlareSystem;
  61862. /**
  61863. * Serialize the current Lens Flare System into a JSON representation.
  61864. * @returns the serialized JSON
  61865. */
  61866. serialize(): any;
  61867. }
  61868. }
  61869. declare module "babylonjs/LensFlares/lensFlare" {
  61870. import { Nullable } from "babylonjs/types";
  61871. import { Color3 } from "babylonjs/Maths/math.color";
  61872. import { Texture } from "babylonjs/Materials/Textures/texture";
  61873. import { LensFlareSystem } from "babylonjs/LensFlares/lensFlareSystem";
  61874. /**
  61875. * This represents one of the lens effect in a `lensFlareSystem`.
  61876. * It controls one of the indiviual texture used in the effect.
  61877. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  61878. */
  61879. export class LensFlare {
  61880. /**
  61881. * Define the size of the lens flare in the system (a floating value between 0 and 1)
  61882. */
  61883. size: number;
  61884. /**
  61885. * 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.
  61886. */
  61887. position: number;
  61888. /**
  61889. * Define the lens color.
  61890. */
  61891. color: Color3;
  61892. /**
  61893. * Define the lens texture.
  61894. */
  61895. texture: Nullable<Texture>;
  61896. /**
  61897. * Define the alpha mode to render this particular lens.
  61898. */
  61899. alphaMode: number;
  61900. private _system;
  61901. /**
  61902. * Creates a new Lens Flare.
  61903. * This represents one of the lens effect in a `lensFlareSystem`.
  61904. * It controls one of the indiviual texture used in the effect.
  61905. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  61906. * @param size Define the size of the lens flare (a floating value between 0 and 1)
  61907. * @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.
  61908. * @param color Define the lens color
  61909. * @param imgUrl Define the lens texture url
  61910. * @param system Define the `lensFlareSystem` this flare is part of
  61911. * @returns The newly created Lens Flare
  61912. */
  61913. static AddFlare(size: number, position: number, color: Color3, imgUrl: string, system: LensFlareSystem): LensFlare;
  61914. /**
  61915. * Instantiates a new Lens Flare.
  61916. * This represents one of the lens effect in a `lensFlareSystem`.
  61917. * It controls one of the indiviual texture used in the effect.
  61918. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  61919. * @param size Define the size of the lens flare in the system (a floating value between 0 and 1)
  61920. * @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.
  61921. * @param color Define the lens color
  61922. * @param imgUrl Define the lens texture url
  61923. * @param system Define the `lensFlareSystem` this flare is part of
  61924. */
  61925. constructor(
  61926. /**
  61927. * Define the size of the lens flare in the system (a floating value between 0 and 1)
  61928. */
  61929. size: number,
  61930. /**
  61931. * 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.
  61932. */
  61933. position: number, color: Color3, imgUrl: string, system: LensFlareSystem);
  61934. /**
  61935. * Dispose and release the lens flare with its associated resources.
  61936. */
  61937. dispose(): void;
  61938. }
  61939. }
  61940. declare module "babylonjs/LensFlares/lensFlareSystemSceneComponent" {
  61941. import { Nullable } from "babylonjs/types";
  61942. import { Scene } from "babylonjs/scene";
  61943. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  61944. import { AbstractScene } from "babylonjs/abstractScene";
  61945. import { LensFlareSystem } from "babylonjs/LensFlares/lensFlareSystem";
  61946. module "babylonjs/abstractScene" {
  61947. interface AbstractScene {
  61948. /**
  61949. * The list of lens flare system added to the scene
  61950. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  61951. */
  61952. lensFlareSystems: Array<LensFlareSystem>;
  61953. /**
  61954. * Removes the given lens flare system from this scene.
  61955. * @param toRemove The lens flare system to remove
  61956. * @returns The index of the removed lens flare system
  61957. */
  61958. removeLensFlareSystem(toRemove: LensFlareSystem): number;
  61959. /**
  61960. * Adds the given lens flare system to this scene
  61961. * @param newLensFlareSystem The lens flare system to add
  61962. */
  61963. addLensFlareSystem(newLensFlareSystem: LensFlareSystem): void;
  61964. /**
  61965. * Gets a lens flare system using its name
  61966. * @param name defines the name to look for
  61967. * @returns the lens flare system or null if not found
  61968. */
  61969. getLensFlareSystemByName(name: string): Nullable<LensFlareSystem>;
  61970. /**
  61971. * Gets a lens flare system using its id
  61972. * @param id defines the id to look for
  61973. * @returns the lens flare system or null if not found
  61974. */
  61975. getLensFlareSystemByID(id: string): Nullable<LensFlareSystem>;
  61976. }
  61977. }
  61978. /**
  61979. * Defines the lens flare scene component responsible to manage any lens flares
  61980. * in a given scene.
  61981. */
  61982. export class LensFlareSystemSceneComponent implements ISceneSerializableComponent {
  61983. /**
  61984. * The component name helpfull to identify the component in the list of scene components.
  61985. */
  61986. readonly name: string;
  61987. /**
  61988. * The scene the component belongs to.
  61989. */
  61990. scene: Scene;
  61991. /**
  61992. * Creates a new instance of the component for the given scene
  61993. * @param scene Defines the scene to register the component in
  61994. */
  61995. constructor(scene: Scene);
  61996. /**
  61997. * Registers the component in a given scene
  61998. */
  61999. register(): void;
  62000. /**
  62001. * Rebuilds the elements related to this component in case of
  62002. * context lost for instance.
  62003. */
  62004. rebuild(): void;
  62005. /**
  62006. * Adds all the elements from the container to the scene
  62007. * @param container the container holding the elements
  62008. */
  62009. addFromContainer(container: AbstractScene): void;
  62010. /**
  62011. * Removes all the elements in the container from the scene
  62012. * @param container contains the elements to remove
  62013. * @param dispose if the removed element should be disposed (default: false)
  62014. */
  62015. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  62016. /**
  62017. * Serializes the component data to the specified json object
  62018. * @param serializationObject The object to serialize to
  62019. */
  62020. serialize(serializationObject: any): void;
  62021. /**
  62022. * Disposes the component and the associated ressources.
  62023. */
  62024. dispose(): void;
  62025. private _draw;
  62026. }
  62027. }
  62028. declare module "babylonjs/LensFlares/index" {
  62029. export * from "babylonjs/LensFlares/lensFlare";
  62030. export * from "babylonjs/LensFlares/lensFlareSystem";
  62031. export * from "babylonjs/LensFlares/lensFlareSystemSceneComponent";
  62032. }
  62033. declare module "babylonjs/Shaders/depth.fragment" {
  62034. import "babylonjs/Shaders/ShadersInclude/packingFunctions";
  62035. /** @hidden */
  62036. export var depthPixelShader: {
  62037. name: string;
  62038. shader: string;
  62039. };
  62040. }
  62041. declare module "babylonjs/Shaders/depth.vertex" {
  62042. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  62043. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  62044. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  62045. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  62046. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  62047. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  62048. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  62049. /** @hidden */
  62050. export var depthVertexShader: {
  62051. name: string;
  62052. shader: string;
  62053. };
  62054. }
  62055. declare module "babylonjs/Rendering/depthRenderer" {
  62056. import { Nullable } from "babylonjs/types";
  62057. import { SubMesh } from "babylonjs/Meshes/subMesh";
  62058. import { Scene } from "babylonjs/scene";
  62059. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  62060. import { Camera } from "babylonjs/Cameras/camera";
  62061. import "babylonjs/Shaders/depth.fragment";
  62062. import "babylonjs/Shaders/depth.vertex";
  62063. /**
  62064. * This represents a depth renderer in Babylon.
  62065. * A depth renderer will render to it's depth map every frame which can be displayed or used in post processing
  62066. */
  62067. export class DepthRenderer {
  62068. private _scene;
  62069. private _depthMap;
  62070. private _effect;
  62071. private readonly _storeNonLinearDepth;
  62072. private readonly _clearColor;
  62073. /** Get if the depth renderer is using packed depth or not */
  62074. readonly isPacked: boolean;
  62075. private _cachedDefines;
  62076. private _camera;
  62077. /** Enable or disable the depth renderer. When disabled, the depth texture is not updated */
  62078. enabled: boolean;
  62079. /**
  62080. * Specifiess that the depth renderer will only be used within
  62081. * the camera it is created for.
  62082. * This can help forcing its rendering during the camera processing.
  62083. */
  62084. useOnlyInActiveCamera: boolean;
  62085. /** @hidden */
  62086. static _SceneComponentInitialization: (scene: Scene) => void;
  62087. /**
  62088. * Instantiates a depth renderer
  62089. * @param scene The scene the renderer belongs to
  62090. * @param type The texture type of the depth map (default: Engine.TEXTURETYPE_FLOAT)
  62091. * @param camera The camera to be used to render the depth map (default: scene's active camera)
  62092. * @param storeNonLinearDepth Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z
  62093. */
  62094. constructor(scene: Scene, type?: number, camera?: Nullable<Camera>, storeNonLinearDepth?: boolean);
  62095. /**
  62096. * Creates the depth rendering effect and checks if the effect is ready.
  62097. * @param subMesh The submesh to be used to render the depth map of
  62098. * @param useInstances If multiple world instances should be used
  62099. * @returns if the depth renderer is ready to render the depth map
  62100. */
  62101. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  62102. /**
  62103. * Gets the texture which the depth map will be written to.
  62104. * @returns The depth map texture
  62105. */
  62106. getDepthMap(): RenderTargetTexture;
  62107. /**
  62108. * Disposes of the depth renderer.
  62109. */
  62110. dispose(): void;
  62111. }
  62112. }
  62113. declare module "babylonjs/Shaders/minmaxRedux.fragment" {
  62114. /** @hidden */
  62115. export var minmaxReduxPixelShader: {
  62116. name: string;
  62117. shader: string;
  62118. };
  62119. }
  62120. declare module "babylonjs/Misc/minMaxReducer" {
  62121. import { Nullable } from "babylonjs/types";
  62122. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  62123. import { Camera } from "babylonjs/Cameras/camera";
  62124. import { Observer } from "babylonjs/Misc/observable";
  62125. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  62126. import { PostProcessManager } from "babylonjs/PostProcesses/postProcessManager";
  62127. import { Observable } from "babylonjs/Misc/observable";
  62128. import "babylonjs/Shaders/minmaxRedux.fragment";
  62129. /**
  62130. * This class computes a min/max reduction from a texture: it means it computes the minimum
  62131. * and maximum values from all values of the texture.
  62132. * It is performed on the GPU for better performances, thanks to a succession of post processes.
  62133. * The source values are read from the red channel of the texture.
  62134. */
  62135. export class MinMaxReducer {
  62136. /**
  62137. * Observable triggered when the computation has been performed
  62138. */
  62139. onAfterReductionPerformed: Observable<{
  62140. min: number;
  62141. max: number;
  62142. }>;
  62143. protected _camera: Camera;
  62144. protected _sourceTexture: Nullable<RenderTargetTexture>;
  62145. protected _reductionSteps: Nullable<Array<PostProcess>>;
  62146. protected _postProcessManager: PostProcessManager;
  62147. protected _onAfterUnbindObserver: Nullable<Observer<RenderTargetTexture>>;
  62148. protected _forceFullscreenViewport: boolean;
  62149. /**
  62150. * Creates a min/max reducer
  62151. * @param camera The camera to use for the post processes
  62152. */
  62153. constructor(camera: Camera);
  62154. /**
  62155. * Gets the texture used to read the values from.
  62156. */
  62157. get sourceTexture(): Nullable<RenderTargetTexture>;
  62158. /**
  62159. * Sets the source texture to read the values from.
  62160. * One must indicate if the texture is a depth texture or not through the depthRedux parameter
  62161. * because in such textures '1' value must not be taken into account to compute the maximum
  62162. * as this value is used to clear the texture.
  62163. * Note that the computation is not activated by calling this function, you must call activate() for that!
  62164. * @param sourceTexture The texture to read the values from. The values should be in the red channel.
  62165. * @param depthRedux Indicates if the texture is a depth texture or not
  62166. * @param type The type of the textures created for the reduction (defaults to TEXTURETYPE_HALF_FLOAT)
  62167. * @param forceFullscreenViewport Forces the post processes used for the reduction to be applied without taking into account viewport (defaults to true)
  62168. */
  62169. setSourceTexture(sourceTexture: RenderTargetTexture, depthRedux: boolean, type?: number, forceFullscreenViewport?: boolean): void;
  62170. /**
  62171. * Defines the refresh rate of the computation.
  62172. * Use 0 to compute just once, 1 to compute on every frame, 2 to compute every two frames and so on...
  62173. */
  62174. get refreshRate(): number;
  62175. set refreshRate(value: number);
  62176. protected _activated: boolean;
  62177. /**
  62178. * Gets the activation status of the reducer
  62179. */
  62180. get activated(): boolean;
  62181. /**
  62182. * Activates the reduction computation.
  62183. * When activated, the observers registered in onAfterReductionPerformed are
  62184. * called after the compuation is performed
  62185. */
  62186. activate(): void;
  62187. /**
  62188. * Deactivates the reduction computation.
  62189. */
  62190. deactivate(): void;
  62191. /**
  62192. * Disposes the min/max reducer
  62193. * @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.
  62194. */
  62195. dispose(disposeAll?: boolean): void;
  62196. }
  62197. }
  62198. declare module "babylonjs/Misc/depthReducer" {
  62199. import { Nullable } from "babylonjs/types";
  62200. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  62201. import { Camera } from "babylonjs/Cameras/camera";
  62202. import { DepthRenderer } from "babylonjs/Rendering/depthRenderer";
  62203. import { MinMaxReducer } from "babylonjs/Misc/minMaxReducer";
  62204. /**
  62205. * This class is a small wrapper around the MinMaxReducer class to compute the min/max values of a depth texture
  62206. */
  62207. export class DepthReducer extends MinMaxReducer {
  62208. private _depthRenderer;
  62209. private _depthRendererId;
  62210. /**
  62211. * Gets the depth renderer used for the computation.
  62212. * Note that the result is null if you provide your own renderer when calling setDepthRenderer.
  62213. */
  62214. get depthRenderer(): Nullable<DepthRenderer>;
  62215. /**
  62216. * Creates a depth reducer
  62217. * @param camera The camera used to render the depth texture
  62218. */
  62219. constructor(camera: Camera);
  62220. /**
  62221. * Sets the depth renderer to use to generate the depth map
  62222. * @param depthRenderer The depth renderer to use. If not provided, a new one will be created automatically
  62223. * @param type The texture type of the depth map (default: TEXTURETYPE_HALF_FLOAT)
  62224. * @param forceFullscreenViewport Forces the post processes used for the reduction to be applied without taking into account viewport (defaults to true)
  62225. */
  62226. setDepthRenderer(depthRenderer?: Nullable<DepthRenderer>, type?: number, forceFullscreenViewport?: boolean): void;
  62227. /** @hidden */
  62228. setSourceTexture(sourceTexture: RenderTargetTexture, depthRedux: boolean, type?: number, forceFullscreenViewport?: boolean): void;
  62229. /**
  62230. * Activates the reduction computation.
  62231. * When activated, the observers registered in onAfterReductionPerformed are
  62232. * called after the compuation is performed
  62233. */
  62234. activate(): void;
  62235. /**
  62236. * Deactivates the reduction computation.
  62237. */
  62238. deactivate(): void;
  62239. /**
  62240. * Disposes the depth reducer
  62241. * @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.
  62242. */
  62243. dispose(disposeAll?: boolean): void;
  62244. }
  62245. }
  62246. declare module "babylonjs/Lights/Shadows/cascadedShadowGenerator" {
  62247. import { Nullable } from "babylonjs/types";
  62248. import { Scene } from "babylonjs/scene";
  62249. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  62250. import { SubMesh } from "babylonjs/Meshes/subMesh";
  62251. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  62252. import { Effect } from "babylonjs/Materials/effect";
  62253. import "babylonjs/Shaders/shadowMap.fragment";
  62254. import "babylonjs/Shaders/shadowMap.vertex";
  62255. import "babylonjs/Shaders/depthBoxBlur.fragment";
  62256. import { ShadowGenerator } from "babylonjs/Lights/Shadows/shadowGenerator";
  62257. import { DirectionalLight } from "babylonjs/Lights/directionalLight";
  62258. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  62259. import { DepthRenderer } from "babylonjs/Rendering/depthRenderer";
  62260. /**
  62261. * A CSM implementation allowing casting shadows on large scenes.
  62262. * Documentation : https://doc.babylonjs.com/babylon101/cascadedShadows
  62263. * Based on: https://github.com/TheRealMJP/Shadows and https://johanmedestrom.wordpress.com/2016/03/18/opengl-cascaded-shadow-maps/
  62264. */
  62265. export class CascadedShadowGenerator extends ShadowGenerator {
  62266. private static readonly frustumCornersNDCSpace;
  62267. /**
  62268. * Name of the CSM class
  62269. */
  62270. static CLASSNAME: string;
  62271. /**
  62272. * Defines the default number of cascades used by the CSM.
  62273. */
  62274. static readonly DEFAULT_CASCADES_COUNT: number;
  62275. /**
  62276. * Defines the minimum number of cascades used by the CSM.
  62277. */
  62278. static readonly MIN_CASCADES_COUNT: number;
  62279. /**
  62280. * Defines the maximum number of cascades used by the CSM.
  62281. */
  62282. static readonly MAX_CASCADES_COUNT: number;
  62283. protected _validateFilter(filter: number): number;
  62284. /**
  62285. * Gets or sets the actual darkness of the soft shadows while using PCSS filtering (value between 0. and 1.)
  62286. */
  62287. penumbraDarkness: number;
  62288. private _numCascades;
  62289. /**
  62290. * Gets or set the number of cascades used by the CSM.
  62291. */
  62292. get numCascades(): number;
  62293. set numCascades(value: number);
  62294. /**
  62295. * Sets this to true if you want that the edges of the shadows don't "swimm" / "shimmer" when rotating the camera.
  62296. * The trade off is that you lose some precision in the shadow rendering when enabling this setting.
  62297. */
  62298. stabilizeCascades: boolean;
  62299. private _freezeShadowCastersBoundingInfo;
  62300. private _freezeShadowCastersBoundingInfoObservable;
  62301. /**
  62302. * Enables or disables the shadow casters bounding info computation.
  62303. * If your shadow casters don't move, you can disable this feature.
  62304. * If it is enabled, the bounding box computation is done every frame.
  62305. */
  62306. get freezeShadowCastersBoundingInfo(): boolean;
  62307. set freezeShadowCastersBoundingInfo(freeze: boolean);
  62308. private _scbiMin;
  62309. private _scbiMax;
  62310. protected _computeShadowCastersBoundingInfo(): void;
  62311. protected _shadowCastersBoundingInfo: BoundingInfo;
  62312. /**
  62313. * Gets or sets the shadow casters bounding info.
  62314. * If you provide your own shadow casters bounding info, first enable freezeShadowCastersBoundingInfo
  62315. * so that the system won't overwrite the bounds you provide
  62316. */
  62317. get shadowCastersBoundingInfo(): BoundingInfo;
  62318. set shadowCastersBoundingInfo(boundingInfo: BoundingInfo);
  62319. protected _breaksAreDirty: boolean;
  62320. protected _minDistance: number;
  62321. protected _maxDistance: number;
  62322. /**
  62323. * Sets the minimal and maximal distances to use when computing the cascade breaks.
  62324. *
  62325. * The values of min / max are typically the depth zmin and zmax values of your scene, for a given frame.
  62326. * If you don't know these values, simply leave them to their defaults and don't call this function.
  62327. * @param min minimal distance for the breaks (default to 0.)
  62328. * @param max maximal distance for the breaks (default to 1.)
  62329. */
  62330. setMinMaxDistance(min: number, max: number): void;
  62331. /** Gets the minimal distance used in the cascade break computation */
  62332. get minDistance(): number;
  62333. /** Gets the maximal distance used in the cascade break computation */
  62334. get maxDistance(): number;
  62335. /**
  62336. * Gets the class name of that object
  62337. * @returns "CascadedShadowGenerator"
  62338. */
  62339. getClassName(): string;
  62340. private _cascadeMinExtents;
  62341. private _cascadeMaxExtents;
  62342. /**
  62343. * Gets a cascade minimum extents
  62344. * @param cascadeIndex index of the cascade
  62345. * @returns the minimum cascade extents
  62346. */
  62347. getCascadeMinExtents(cascadeIndex: number): Nullable<Vector3>;
  62348. /**
  62349. * Gets a cascade maximum extents
  62350. * @param cascadeIndex index of the cascade
  62351. * @returns the maximum cascade extents
  62352. */
  62353. getCascadeMaxExtents(cascadeIndex: number): Nullable<Vector3>;
  62354. private _cascades;
  62355. private _currentLayer;
  62356. private _viewSpaceFrustumsZ;
  62357. private _viewMatrices;
  62358. private _projectionMatrices;
  62359. private _transformMatrices;
  62360. private _transformMatricesAsArray;
  62361. private _frustumLengths;
  62362. private _lightSizeUVCorrection;
  62363. private _depthCorrection;
  62364. private _frustumCornersWorldSpace;
  62365. private _frustumCenter;
  62366. private _shadowCameraPos;
  62367. private _shadowMaxZ;
  62368. /**
  62369. * Gets the shadow max z distance. It's the limit beyond which shadows are not displayed.
  62370. * It defaults to camera.maxZ
  62371. */
  62372. get shadowMaxZ(): number;
  62373. /**
  62374. * Sets the shadow max z distance.
  62375. */
  62376. set shadowMaxZ(value: number);
  62377. protected _debug: boolean;
  62378. /**
  62379. * Gets or sets the debug flag.
  62380. * When enabled, the cascades are materialized by different colors on the screen.
  62381. */
  62382. get debug(): boolean;
  62383. set debug(dbg: boolean);
  62384. private _depthClamp;
  62385. /**
  62386. * Gets or sets the depth clamping value.
  62387. *
  62388. * When enabled, it improves the shadow quality because the near z plane of the light frustum don't need to be adjusted
  62389. * to account for the shadow casters far away.
  62390. *
  62391. * Note that this property is incompatible with PCSS filtering, so it won't be used in that case.
  62392. */
  62393. get depthClamp(): boolean;
  62394. set depthClamp(value: boolean);
  62395. private _cascadeBlendPercentage;
  62396. /**
  62397. * Gets or sets the percentage of blending between two cascades (value between 0. and 1.).
  62398. * It defaults to 0.1 (10% blending).
  62399. */
  62400. get cascadeBlendPercentage(): number;
  62401. set cascadeBlendPercentage(value: number);
  62402. private _lambda;
  62403. /**
  62404. * Gets or set the lambda parameter.
  62405. * This parameter is used to split the camera frustum and create the cascades.
  62406. * 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.
  62407. * For all values in-between, it's a linear combination of the uniform and logarithm split algorithm.
  62408. */
  62409. get lambda(): number;
  62410. set lambda(value: number);
  62411. /**
  62412. * Gets the view matrix corresponding to a given cascade
  62413. * @param cascadeNum cascade to retrieve the view matrix from
  62414. * @returns the cascade view matrix
  62415. */
  62416. getCascadeViewMatrix(cascadeNum: number): Nullable<Matrix>;
  62417. /**
  62418. * Gets the projection matrix corresponding to a given cascade
  62419. * @param cascadeNum cascade to retrieve the projection matrix from
  62420. * @returns the cascade projection matrix
  62421. */
  62422. getCascadeProjectionMatrix(cascadeNum: number): Nullable<Matrix>;
  62423. /**
  62424. * Gets the transformation matrix corresponding to a given cascade
  62425. * @param cascadeNum cascade to retrieve the transformation matrix from
  62426. * @returns the cascade transformation matrix
  62427. */
  62428. getCascadeTransformMatrix(cascadeNum: number): Nullable<Matrix>;
  62429. private _depthRenderer;
  62430. /**
  62431. * Sets the depth renderer to use when autoCalcDepthBounds is enabled.
  62432. *
  62433. * Note that if no depth renderer is set, a new one will be automatically created internally when necessary.
  62434. *
  62435. * You should call this function if you already have a depth renderer enabled in your scene, to avoid
  62436. * doing multiple depth rendering each frame. If you provide your own depth renderer, make sure it stores linear depth!
  62437. * @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
  62438. */
  62439. setDepthRenderer(depthRenderer: Nullable<DepthRenderer>): void;
  62440. private _depthReducer;
  62441. private _autoCalcDepthBounds;
  62442. /**
  62443. * Gets or sets the autoCalcDepthBounds property.
  62444. *
  62445. * When enabled, a depth rendering pass is first performed (with an internally created depth renderer or with the one
  62446. * you provide by calling setDepthRenderer). Then, a min/max reducing is applied on the depth map to compute the
  62447. * minimal and maximal depth of the map and those values are used as inputs for the setMinMaxDistance() function.
  62448. * It can greatly enhance the shadow quality, at the expense of more GPU works.
  62449. * When using this option, you should increase the value of the lambda parameter, and even set it to 1 for best results.
  62450. */
  62451. get autoCalcDepthBounds(): boolean;
  62452. set autoCalcDepthBounds(value: boolean);
  62453. /**
  62454. * Defines the refresh rate of the min/max computation used when autoCalcDepthBounds is set to true
  62455. * Use 0 to compute just once, 1 to compute on every frame, 2 to compute every two frames and so on...
  62456. * Note that if you provided your own depth renderer through a call to setDepthRenderer, you are responsible
  62457. * for setting the refresh rate on the renderer yourself!
  62458. */
  62459. get autoCalcDepthBoundsRefreshRate(): number;
  62460. set autoCalcDepthBoundsRefreshRate(value: number);
  62461. /**
  62462. * Create the cascade breaks according to the lambda, shadowMaxZ and min/max distance properties, as well as the camera near and far planes.
  62463. * This function is automatically called when updating lambda, shadowMaxZ and min/max distances, however you should call it yourself if
  62464. * you change the camera near/far planes!
  62465. */
  62466. splitFrustum(): void;
  62467. private _splitFrustum;
  62468. private _computeMatrices;
  62469. private _computeFrustumInWorldSpace;
  62470. private _computeCascadeFrustum;
  62471. /**
  62472. * Support test.
  62473. */
  62474. static get IsSupported(): boolean;
  62475. /** @hidden */
  62476. static _SceneComponentInitialization: (scene: Scene) => void;
  62477. /**
  62478. * Creates a Cascaded Shadow Generator object.
  62479. * A ShadowGenerator is the required tool to use the shadows.
  62480. * Each directional light casting shadows needs to use its own ShadowGenerator.
  62481. * Documentation : https://doc.babylonjs.com/babylon101/cascadedShadows
  62482. * @param mapSize The size of the texture what stores the shadows. Example : 1024.
  62483. * @param light The directional light object generating the shadows.
  62484. * @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.
  62485. */
  62486. constructor(mapSize: number, light: DirectionalLight, usefulFloatFirst?: boolean);
  62487. protected _initializeGenerator(): void;
  62488. protected _createTargetRenderTexture(): void;
  62489. protected _initializeShadowMap(): void;
  62490. protected _bindCustomEffectForRenderSubMeshForShadowMap(subMesh: SubMesh, effect: Effect, matriceNames: any, mesh: AbstractMesh): void;
  62491. protected _isReadyCustomDefines(defines: any, subMesh: SubMesh, useInstances: boolean): void;
  62492. /**
  62493. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  62494. * @param defines Defines of the material we want to update
  62495. * @param lightIndex Index of the light in the enabled light list of the material
  62496. */
  62497. prepareDefines(defines: any, lightIndex: number): void;
  62498. /**
  62499. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  62500. * defined in the generator but impacting the effect).
  62501. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  62502. * @param effect The effect we are binfing the information for
  62503. */
  62504. bindShadowLight(lightIndex: string, effect: Effect): void;
  62505. /**
  62506. * Gets the transformation matrix of the first cascade used to project the meshes into the map from the light point of view.
  62507. * (eq to view projection * shadow projection matrices)
  62508. * @returns The transform matrix used to create the shadow map
  62509. */
  62510. getTransformMatrix(): Matrix;
  62511. /**
  62512. * Disposes the ShadowGenerator.
  62513. * Returns nothing.
  62514. */
  62515. dispose(): void;
  62516. /**
  62517. * Serializes the shadow generator setup to a json object.
  62518. * @returns The serialized JSON object
  62519. */
  62520. serialize(): any;
  62521. /**
  62522. * Parses a serialized ShadowGenerator and returns a new ShadowGenerator.
  62523. * @param parsedShadowGenerator The JSON object to parse
  62524. * @param scene The scene to create the shadow map for
  62525. * @returns The parsed shadow generator
  62526. */
  62527. static Parse(parsedShadowGenerator: any, scene: Scene): ShadowGenerator;
  62528. }
  62529. }
  62530. declare module "babylonjs/Lights/Shadows/shadowGeneratorSceneComponent" {
  62531. import { Scene } from "babylonjs/scene";
  62532. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  62533. import { AbstractScene } from "babylonjs/abstractScene";
  62534. /**
  62535. * Defines the shadow generator component responsible to manage any shadow generators
  62536. * in a given scene.
  62537. */
  62538. export class ShadowGeneratorSceneComponent implements ISceneSerializableComponent {
  62539. /**
  62540. * The component name helpfull to identify the component in the list of scene components.
  62541. */
  62542. readonly name: string;
  62543. /**
  62544. * The scene the component belongs to.
  62545. */
  62546. scene: Scene;
  62547. /**
  62548. * Creates a new instance of the component for the given scene
  62549. * @param scene Defines the scene to register the component in
  62550. */
  62551. constructor(scene: Scene);
  62552. /**
  62553. * Registers the component in a given scene
  62554. */
  62555. register(): void;
  62556. /**
  62557. * Rebuilds the elements related to this component in case of
  62558. * context lost for instance.
  62559. */
  62560. rebuild(): void;
  62561. /**
  62562. * Serializes the component data to the specified json object
  62563. * @param serializationObject The object to serialize to
  62564. */
  62565. serialize(serializationObject: any): void;
  62566. /**
  62567. * Adds all the elements from the container to the scene
  62568. * @param container the container holding the elements
  62569. */
  62570. addFromContainer(container: AbstractScene): void;
  62571. /**
  62572. * Removes all the elements in the container from the scene
  62573. * @param container contains the elements to remove
  62574. * @param dispose if the removed element should be disposed (default: false)
  62575. */
  62576. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  62577. /**
  62578. * Rebuilds the elements related to this component in case of
  62579. * context lost for instance.
  62580. */
  62581. dispose(): void;
  62582. private _gatherRenderTargets;
  62583. }
  62584. }
  62585. declare module "babylonjs/Lights/Shadows/index" {
  62586. export * from "babylonjs/Lights/Shadows/shadowGenerator";
  62587. export * from "babylonjs/Lights/Shadows/cascadedShadowGenerator";
  62588. export * from "babylonjs/Lights/Shadows/shadowGeneratorSceneComponent";
  62589. }
  62590. declare module "babylonjs/Lights/pointLight" {
  62591. import { Scene } from "babylonjs/scene";
  62592. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  62593. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  62594. import { ShadowLight } from "babylonjs/Lights/shadowLight";
  62595. import { Effect } from "babylonjs/Materials/effect";
  62596. /**
  62597. * A point light is a light defined by an unique point in world space.
  62598. * The light is emitted in every direction from this point.
  62599. * A good example of a point light is a standard light bulb.
  62600. * Documentation: https://doc.babylonjs.com/babylon101/lights
  62601. */
  62602. export class PointLight extends ShadowLight {
  62603. private _shadowAngle;
  62604. /**
  62605. * Getter: In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  62606. * This specifies what angle the shadow will use to be created.
  62607. *
  62608. * It default to 90 degrees to work nicely with the cube texture generation for point lights shadow maps.
  62609. */
  62610. get shadowAngle(): number;
  62611. /**
  62612. * Setter: In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  62613. * This specifies what angle the shadow will use to be created.
  62614. *
  62615. * It default to 90 degrees to work nicely with the cube texture generation for point lights shadow maps.
  62616. */
  62617. set shadowAngle(value: number);
  62618. /**
  62619. * Gets the direction if it has been set.
  62620. * In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  62621. */
  62622. get direction(): Vector3;
  62623. /**
  62624. * In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  62625. */
  62626. set direction(value: Vector3);
  62627. /**
  62628. * Creates a PointLight object from the passed name and position (Vector3) and adds it in the scene.
  62629. * A PointLight emits the light in every direction.
  62630. * It can cast shadows.
  62631. * If the scene camera is already defined and you want to set your PointLight at the camera position, just set it :
  62632. * ```javascript
  62633. * var pointLight = new PointLight("pl", camera.position, scene);
  62634. * ```
  62635. * Documentation : https://doc.babylonjs.com/babylon101/lights
  62636. * @param name The light friendly name
  62637. * @param position The position of the point light in the scene
  62638. * @param scene The scene the lights belongs to
  62639. */
  62640. constructor(name: string, position: Vector3, scene: Scene);
  62641. /**
  62642. * Returns the string "PointLight"
  62643. * @returns the class name
  62644. */
  62645. getClassName(): string;
  62646. /**
  62647. * Returns the integer 0.
  62648. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  62649. */
  62650. getTypeID(): number;
  62651. /**
  62652. * Specifies wether or not the shadowmap should be a cube texture.
  62653. * @returns true if the shadowmap needs to be a cube texture.
  62654. */
  62655. needCube(): boolean;
  62656. /**
  62657. * Returns a new Vector3 aligned with the PointLight cube system according to the passed cube face index (integer).
  62658. * @param faceIndex The index of the face we are computed the direction to generate shadow
  62659. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  62660. */
  62661. getShadowDirection(faceIndex?: number): Vector3;
  62662. /**
  62663. * Sets the passed matrix "matrix" as a left-handed perspective projection matrix with the following settings :
  62664. * - fov = PI / 2
  62665. * - aspect ratio : 1.0
  62666. * - z-near and far equal to the active camera minZ and maxZ.
  62667. * Returns the PointLight.
  62668. */
  62669. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  62670. protected _buildUniformLayout(): void;
  62671. /**
  62672. * Sets the passed Effect "effect" with the PointLight transformed position (or position, if none) and passed name (string).
  62673. * @param effect The effect to update
  62674. * @param lightIndex The index of the light in the effect to update
  62675. * @returns The point light
  62676. */
  62677. transferToEffect(effect: Effect, lightIndex: string): PointLight;
  62678. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  62679. /**
  62680. * Prepares the list of defines specific to the light type.
  62681. * @param defines the list of defines
  62682. * @param lightIndex defines the index of the light for the effect
  62683. */
  62684. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  62685. }
  62686. }
  62687. declare module "babylonjs/Lights/index" {
  62688. export * from "babylonjs/Lights/light";
  62689. export * from "babylonjs/Lights/shadowLight";
  62690. export * from "babylonjs/Lights/Shadows/index";
  62691. export * from "babylonjs/Lights/directionalLight";
  62692. export * from "babylonjs/Lights/hemisphericLight";
  62693. export * from "babylonjs/Lights/pointLight";
  62694. export * from "babylonjs/Lights/spotLight";
  62695. }
  62696. declare module "babylonjs/Misc/HighDynamicRange/hdr" {
  62697. import { CubeMapInfo } from "babylonjs/Misc/HighDynamicRange/panoramaToCubemap";
  62698. /**
  62699. * Header information of HDR texture files.
  62700. */
  62701. export interface HDRInfo {
  62702. /**
  62703. * The height of the texture in pixels.
  62704. */
  62705. height: number;
  62706. /**
  62707. * The width of the texture in pixels.
  62708. */
  62709. width: number;
  62710. /**
  62711. * The index of the beginning of the data in the binary file.
  62712. */
  62713. dataPosition: number;
  62714. }
  62715. /**
  62716. * This groups tools to convert HDR texture to native colors array.
  62717. */
  62718. export class HDRTools {
  62719. private static Ldexp;
  62720. private static Rgbe2float;
  62721. private static readStringLine;
  62722. /**
  62723. * Reads header information from an RGBE texture stored in a native array.
  62724. * More information on this format are available here:
  62725. * https://en.wikipedia.org/wiki/RGBE_image_format
  62726. *
  62727. * @param uint8array The binary file stored in native array.
  62728. * @return The header information.
  62729. */
  62730. static RGBE_ReadHeader(uint8array: Uint8Array): HDRInfo;
  62731. /**
  62732. * Returns the cubemap information (each faces texture data) extracted from an RGBE texture.
  62733. * This RGBE texture needs to store the information as a panorama.
  62734. *
  62735. * More information on this format are available here:
  62736. * https://en.wikipedia.org/wiki/RGBE_image_format
  62737. *
  62738. * @param buffer The binary file stored in an array buffer.
  62739. * @param size The expected size of the extracted cubemap.
  62740. * @return The Cube Map information.
  62741. */
  62742. static GetCubeMapTextureData(buffer: ArrayBuffer, size: number): CubeMapInfo;
  62743. /**
  62744. * Returns the pixels data extracted from an RGBE texture.
  62745. * This pixels will be stored left to right up to down in the R G B order in one array.
  62746. *
  62747. * More information on this format are available here:
  62748. * https://en.wikipedia.org/wiki/RGBE_image_format
  62749. *
  62750. * @param uint8array The binary file stored in an array buffer.
  62751. * @param hdrInfo The header information of the file.
  62752. * @return The pixels data in RGB right to left up to down order.
  62753. */
  62754. static RGBE_ReadPixels(uint8array: Uint8Array, hdrInfo: HDRInfo): Float32Array;
  62755. private static RGBE_ReadPixels_RLE;
  62756. private static RGBE_ReadPixels_NOT_RLE;
  62757. }
  62758. }
  62759. declare module "babylonjs/Materials/effectRenderer" {
  62760. import { Nullable } from "babylonjs/types";
  62761. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  62762. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  62763. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  62764. import { Viewport } from "babylonjs/Maths/math.viewport";
  62765. import { Observable } from "babylonjs/Misc/observable";
  62766. import { Effect } from "babylonjs/Materials/effect";
  62767. import "babylonjs/Shaders/postprocess.vertex";
  62768. /**
  62769. * Effect Render Options
  62770. */
  62771. export interface IEffectRendererOptions {
  62772. /**
  62773. * Defines the vertices positions.
  62774. */
  62775. positions?: number[];
  62776. /**
  62777. * Defines the indices.
  62778. */
  62779. indices?: number[];
  62780. }
  62781. /**
  62782. * Helper class to render one or more effects.
  62783. * You can access the previous rendering in your shader by declaring a sampler named textureSampler
  62784. */
  62785. export class EffectRenderer {
  62786. private engine;
  62787. private static _DefaultOptions;
  62788. private _vertexBuffers;
  62789. private _indexBuffer;
  62790. private _fullscreenViewport;
  62791. /**
  62792. * Creates an effect renderer
  62793. * @param engine the engine to use for rendering
  62794. * @param options defines the options of the effect renderer
  62795. */
  62796. constructor(engine: ThinEngine, options?: IEffectRendererOptions);
  62797. /**
  62798. * Sets the current viewport in normalized coordinates 0-1
  62799. * @param viewport Defines the viewport to set (defaults to 0 0 1 1)
  62800. */
  62801. setViewport(viewport?: Viewport): void;
  62802. /**
  62803. * Binds the embedded attributes buffer to the effect.
  62804. * @param effect Defines the effect to bind the attributes for
  62805. */
  62806. bindBuffers(effect: Effect): void;
  62807. /**
  62808. * Sets the current effect wrapper to use during draw.
  62809. * The effect needs to be ready before calling this api.
  62810. * This also sets the default full screen position attribute.
  62811. * @param effectWrapper Defines the effect to draw with
  62812. */
  62813. applyEffectWrapper(effectWrapper: EffectWrapper): void;
  62814. /**
  62815. * Restores engine states
  62816. */
  62817. restoreStates(): void;
  62818. /**
  62819. * Draws a full screen quad.
  62820. */
  62821. draw(): void;
  62822. private isRenderTargetTexture;
  62823. /**
  62824. * renders one or more effects to a specified texture
  62825. * @param effectWrapper the effect to renderer
  62826. * @param outputTexture texture to draw to, if null it will render to the screen.
  62827. */
  62828. render(effectWrapper: EffectWrapper, outputTexture?: Nullable<InternalTexture | RenderTargetTexture>): void;
  62829. /**
  62830. * Disposes of the effect renderer
  62831. */
  62832. dispose(): void;
  62833. }
  62834. /**
  62835. * Options to create an EffectWrapper
  62836. */
  62837. interface EffectWrapperCreationOptions {
  62838. /**
  62839. * Engine to use to create the effect
  62840. */
  62841. engine: ThinEngine;
  62842. /**
  62843. * Fragment shader for the effect
  62844. */
  62845. fragmentShader: string;
  62846. /**
  62847. * Use the shader store instead of direct source code
  62848. */
  62849. useShaderStore?: boolean;
  62850. /**
  62851. * Vertex shader for the effect
  62852. */
  62853. vertexShader?: string;
  62854. /**
  62855. * Attributes to use in the shader
  62856. */
  62857. attributeNames?: Array<string>;
  62858. /**
  62859. * Uniforms to use in the shader
  62860. */
  62861. uniformNames?: Array<string>;
  62862. /**
  62863. * Texture sampler names to use in the shader
  62864. */
  62865. samplerNames?: Array<string>;
  62866. /**
  62867. * Defines to use in the shader
  62868. */
  62869. defines?: Array<string>;
  62870. /**
  62871. * Callback when effect is compiled
  62872. */
  62873. onCompiled?: Nullable<(effect: Effect) => void>;
  62874. /**
  62875. * The friendly name of the effect displayed in Spector.
  62876. */
  62877. name?: string;
  62878. }
  62879. /**
  62880. * Wraps an effect to be used for rendering
  62881. */
  62882. export class EffectWrapper {
  62883. /**
  62884. * Event that is fired right before the effect is drawn (should be used to update uniforms)
  62885. */
  62886. onApplyObservable: Observable<{}>;
  62887. /**
  62888. * The underlying effect
  62889. */
  62890. effect: Effect;
  62891. /**
  62892. * Creates an effect to be renderer
  62893. * @param creationOptions options to create the effect
  62894. */
  62895. constructor(creationOptions: EffectWrapperCreationOptions);
  62896. /**
  62897. * Disposes of the effect wrapper
  62898. */
  62899. dispose(): void;
  62900. }
  62901. }
  62902. declare module "babylonjs/Shaders/hdrFiltering.vertex" {
  62903. /** @hidden */
  62904. export var hdrFilteringVertexShader: {
  62905. name: string;
  62906. shader: string;
  62907. };
  62908. }
  62909. declare module "babylonjs/Shaders/hdrFiltering.fragment" {
  62910. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  62911. import "babylonjs/Shaders/ShadersInclude/importanceSampling";
  62912. import "babylonjs/Shaders/ShadersInclude/pbrBRDFFunctions";
  62913. import "babylonjs/Shaders/ShadersInclude/hdrFilteringFunctions";
  62914. /** @hidden */
  62915. export var hdrFilteringPixelShader: {
  62916. name: string;
  62917. shader: string;
  62918. };
  62919. }
  62920. declare module "babylonjs/Materials/Textures/Filtering/hdrFiltering" {
  62921. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  62922. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  62923. import { Nullable } from "babylonjs/types";
  62924. import "babylonjs/Shaders/hdrFiltering.vertex";
  62925. import "babylonjs/Shaders/hdrFiltering.fragment";
  62926. /**
  62927. * Options for texture filtering
  62928. */
  62929. interface IHDRFilteringOptions {
  62930. /**
  62931. * Scales pixel intensity for the input HDR map.
  62932. */
  62933. hdrScale?: number;
  62934. /**
  62935. * Quality of the filter. Should be `Constants.TEXTURE_FILTERING_QUALITY_OFFLINE` for prefiltering
  62936. */
  62937. quality?: number;
  62938. }
  62939. /**
  62940. * Filters HDR maps to get correct renderings of PBR reflections
  62941. */
  62942. export class HDRFiltering {
  62943. private _engine;
  62944. private _effectRenderer;
  62945. private _effectWrapper;
  62946. private _lodGenerationOffset;
  62947. private _lodGenerationScale;
  62948. /**
  62949. * Quality switch for prefiltering. Should be set to `Constants.TEXTURE_FILTERING_QUALITY_OFFLINE` unless
  62950. * you care about baking speed.
  62951. */
  62952. quality: number;
  62953. /**
  62954. * Scales pixel intensity for the input HDR map.
  62955. */
  62956. hdrScale: number;
  62957. /**
  62958. * Instantiates HDR filter for reflection maps
  62959. *
  62960. * @param engine Thin engine
  62961. * @param options Options
  62962. */
  62963. constructor(engine: ThinEngine, options?: IHDRFilteringOptions);
  62964. private _createRenderTarget;
  62965. private _prefilterInternal;
  62966. private _createEffect;
  62967. /**
  62968. * Get a value indicating if the filter is ready to be used
  62969. * @param texture Texture to filter
  62970. * @returns true if the filter is ready
  62971. */
  62972. isReady(texture: BaseTexture): boolean;
  62973. /**
  62974. * Prefilters a cube texture to have mipmap levels representing roughness values.
  62975. * Prefiltering will be invoked at the end of next rendering pass.
  62976. * This has to be done once the map is loaded, and has not been prefiltered by a third party software.
  62977. * See http://blog.selfshadow.com/publications/s2013-shading-course/karis/s2013_pbs_epic_notes_v2.pdf for more information
  62978. * @param texture Texture to filter
  62979. * @param onFinished Callback when filtering is done
  62980. * @return Promise called when prefiltering is done
  62981. */
  62982. prefilter(texture: BaseTexture, onFinished?: Nullable<() => void>): Promise<unknown> | undefined;
  62983. }
  62984. }
  62985. declare module "babylonjs/Materials/Textures/hdrCubeTexture" {
  62986. import { Nullable } from "babylonjs/types";
  62987. import { Scene } from "babylonjs/scene";
  62988. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  62989. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  62990. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  62991. import "babylonjs/Engines/Extensions/engine.rawTexture";
  62992. import "babylonjs/Materials/Textures/baseTexture.polynomial";
  62993. /**
  62994. * This represents a texture coming from an HDR input.
  62995. *
  62996. * The only supported format is currently panorama picture stored in RGBE format.
  62997. * Example of such files can be found on HDRLib: http://hdrlib.com/
  62998. */
  62999. export class HDRCubeTexture extends BaseTexture {
  63000. private static _facesMapping;
  63001. private _generateHarmonics;
  63002. private _noMipmap;
  63003. private _prefilterOnLoad;
  63004. private _textureMatrix;
  63005. private _size;
  63006. private _onLoad;
  63007. private _onError;
  63008. /**
  63009. * The texture URL.
  63010. */
  63011. url: string;
  63012. /**
  63013. * The texture coordinates mode. As this texture is stored in a cube format, please modify carefully.
  63014. */
  63015. coordinatesMode: number;
  63016. protected _isBlocking: boolean;
  63017. /**
  63018. * Sets wether or not the texture is blocking during loading.
  63019. */
  63020. set isBlocking(value: boolean);
  63021. /**
  63022. * Gets wether or not the texture is blocking during loading.
  63023. */
  63024. get isBlocking(): boolean;
  63025. protected _rotationY: number;
  63026. /**
  63027. * Sets texture matrix rotation angle around Y axis in radians.
  63028. */
  63029. set rotationY(value: number);
  63030. /**
  63031. * Gets texture matrix rotation angle around Y axis radians.
  63032. */
  63033. get rotationY(): number;
  63034. /**
  63035. * Gets or sets the center of the bounding box associated with the cube texture
  63036. * It must define where the camera used to render the texture was set
  63037. */
  63038. boundingBoxPosition: Vector3;
  63039. private _boundingBoxSize;
  63040. /**
  63041. * Gets or sets the size of the bounding box associated with the cube texture
  63042. * When defined, the cubemap will switch to local mode
  63043. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  63044. * @example https://www.babylonjs-playground.com/#RNASML
  63045. */
  63046. set boundingBoxSize(value: Vector3);
  63047. get boundingBoxSize(): Vector3;
  63048. /**
  63049. * Instantiates an HDRTexture from the following parameters.
  63050. *
  63051. * @param url The location of the HDR raw data (Panorama stored in RGBE format)
  63052. * @param sceneOrEngine The scene or engine the texture will be used in
  63053. * @param size The cubemap desired size (the more it increases the longer the generation will be)
  63054. * @param noMipmap Forces to not generate the mipmap if true
  63055. * @param generateHarmonics Specifies whether you want to extract the polynomial harmonics during the generation process
  63056. * @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)
  63057. * @param prefilterOnLoad Prefilters HDR texture to allow use of this texture as a PBR reflection texture.
  63058. */
  63059. 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>);
  63060. /**
  63061. * Get the current class name of the texture useful for serialization or dynamic coding.
  63062. * @returns "HDRCubeTexture"
  63063. */
  63064. getClassName(): string;
  63065. /**
  63066. * Occurs when the file is raw .hdr file.
  63067. */
  63068. private loadTexture;
  63069. clone(): HDRCubeTexture;
  63070. delayLoad(): void;
  63071. /**
  63072. * Get the texture reflection matrix used to rotate/transform the reflection.
  63073. * @returns the reflection matrix
  63074. */
  63075. getReflectionTextureMatrix(): Matrix;
  63076. /**
  63077. * Set the texture reflection matrix used to rotate/transform the reflection.
  63078. * @param value Define the reflection matrix to set
  63079. */
  63080. setReflectionTextureMatrix(value: Matrix): void;
  63081. /**
  63082. * Parses a JSON representation of an HDR Texture in order to create the texture
  63083. * @param parsedTexture Define the JSON representation
  63084. * @param scene Define the scene the texture should be created in
  63085. * @param rootUrl Define the root url in case we need to load relative dependencies
  63086. * @returns the newly created texture after parsing
  63087. */
  63088. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): Nullable<HDRCubeTexture>;
  63089. serialize(): any;
  63090. }
  63091. }
  63092. declare module "babylonjs/Physics/physicsEngine" {
  63093. import { Nullable } from "babylonjs/types";
  63094. import { Vector3 } from "babylonjs/Maths/math.vector";
  63095. import { IPhysicsEngine, IPhysicsEnginePlugin } from "babylonjs/Physics/IPhysicsEngine";
  63096. import { PhysicsImpostor, IPhysicsEnabledObject } from "babylonjs/Physics/physicsImpostor";
  63097. import { PhysicsJoint } from "babylonjs/Physics/physicsJoint";
  63098. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  63099. /**
  63100. * Class used to control physics engine
  63101. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  63102. */
  63103. export class PhysicsEngine implements IPhysicsEngine {
  63104. private _physicsPlugin;
  63105. /**
  63106. * Global value used to control the smallest number supported by the simulation
  63107. */
  63108. static Epsilon: number;
  63109. private _impostors;
  63110. private _joints;
  63111. private _subTimeStep;
  63112. /**
  63113. * Gets the gravity vector used by the simulation
  63114. */
  63115. gravity: Vector3;
  63116. /**
  63117. * Factory used to create the default physics plugin.
  63118. * @returns The default physics plugin
  63119. */
  63120. static DefaultPluginFactory(): IPhysicsEnginePlugin;
  63121. /**
  63122. * Creates a new Physics Engine
  63123. * @param gravity defines the gravity vector used by the simulation
  63124. * @param _physicsPlugin defines the plugin to use (CannonJS by default)
  63125. */
  63126. constructor(gravity: Nullable<Vector3>, _physicsPlugin?: IPhysicsEnginePlugin);
  63127. /**
  63128. * Sets the gravity vector used by the simulation
  63129. * @param gravity defines the gravity vector to use
  63130. */
  63131. setGravity(gravity: Vector3): void;
  63132. /**
  63133. * Set the time step of the physics engine.
  63134. * Default is 1/60.
  63135. * To slow it down, enter 1/600 for example.
  63136. * To speed it up, 1/30
  63137. * @param newTimeStep defines the new timestep to apply to this world.
  63138. */
  63139. setTimeStep(newTimeStep?: number): void;
  63140. /**
  63141. * Get the time step of the physics engine.
  63142. * @returns the current time step
  63143. */
  63144. getTimeStep(): number;
  63145. /**
  63146. * Set the sub time step of the physics engine.
  63147. * Default is 0 meaning there is no sub steps
  63148. * To increase physics resolution precision, set a small value (like 1 ms)
  63149. * @param subTimeStep defines the new sub timestep used for physics resolution.
  63150. */
  63151. setSubTimeStep(subTimeStep?: number): void;
  63152. /**
  63153. * Get the sub time step of the physics engine.
  63154. * @returns the current sub time step
  63155. */
  63156. getSubTimeStep(): number;
  63157. /**
  63158. * Release all resources
  63159. */
  63160. dispose(): void;
  63161. /**
  63162. * Gets the name of the current physics plugin
  63163. * @returns the name of the plugin
  63164. */
  63165. getPhysicsPluginName(): string;
  63166. /**
  63167. * Adding a new impostor for the impostor tracking.
  63168. * This will be done by the impostor itself.
  63169. * @param impostor the impostor to add
  63170. */
  63171. addImpostor(impostor: PhysicsImpostor): void;
  63172. /**
  63173. * Remove an impostor from the engine.
  63174. * This impostor and its mesh will not longer be updated by the physics engine.
  63175. * @param impostor the impostor to remove
  63176. */
  63177. removeImpostor(impostor: PhysicsImpostor): void;
  63178. /**
  63179. * Add a joint to the physics engine
  63180. * @param mainImpostor defines the main impostor to which the joint is added.
  63181. * @param connectedImpostor defines the impostor that is connected to the main impostor using this joint
  63182. * @param joint defines the joint that will connect both impostors.
  63183. */
  63184. addJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  63185. /**
  63186. * Removes a joint from the simulation
  63187. * @param mainImpostor defines the impostor used with the joint
  63188. * @param connectedImpostor defines the other impostor connected to the main one by the joint
  63189. * @param joint defines the joint to remove
  63190. */
  63191. removeJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  63192. /**
  63193. * Called by the scene. No need to call it.
  63194. * @param delta defines the timespam between frames
  63195. */
  63196. _step(delta: number): void;
  63197. /**
  63198. * Gets the current plugin used to run the simulation
  63199. * @returns current plugin
  63200. */
  63201. getPhysicsPlugin(): IPhysicsEnginePlugin;
  63202. /**
  63203. * Gets the list of physic impostors
  63204. * @returns an array of PhysicsImpostor
  63205. */
  63206. getImpostors(): Array<PhysicsImpostor>;
  63207. /**
  63208. * Gets the impostor for a physics enabled object
  63209. * @param object defines the object impersonated by the impostor
  63210. * @returns the PhysicsImpostor or null if not found
  63211. */
  63212. getImpostorForPhysicsObject(object: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  63213. /**
  63214. * Gets the impostor for a physics body object
  63215. * @param body defines physics body used by the impostor
  63216. * @returns the PhysicsImpostor or null if not found
  63217. */
  63218. getImpostorWithPhysicsBody(body: any): Nullable<PhysicsImpostor>;
  63219. /**
  63220. * Does a raycast in the physics world
  63221. * @param from when should the ray start?
  63222. * @param to when should the ray end?
  63223. * @returns PhysicsRaycastResult
  63224. */
  63225. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  63226. }
  63227. }
  63228. declare module "babylonjs/Physics/Plugins/cannonJSPlugin" {
  63229. import { Nullable } from "babylonjs/types";
  63230. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  63231. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  63232. import { IPhysicsEnginePlugin, PhysicsImpostorJoint } from "babylonjs/Physics/IPhysicsEngine";
  63233. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  63234. import { PhysicsJoint, IMotorEnabledJoint } from "babylonjs/Physics/physicsJoint";
  63235. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  63236. /** @hidden */
  63237. export class CannonJSPlugin implements IPhysicsEnginePlugin {
  63238. private _useDeltaForWorldStep;
  63239. world: any;
  63240. name: string;
  63241. private _physicsMaterials;
  63242. private _fixedTimeStep;
  63243. private _cannonRaycastResult;
  63244. private _raycastResult;
  63245. private _physicsBodysToRemoveAfterStep;
  63246. private _firstFrame;
  63247. BJSCANNON: any;
  63248. constructor(_useDeltaForWorldStep?: boolean, iterations?: number, cannonInjection?: any);
  63249. setGravity(gravity: Vector3): void;
  63250. setTimeStep(timeStep: number): void;
  63251. getTimeStep(): number;
  63252. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  63253. private _removeMarkedPhysicsBodiesFromWorld;
  63254. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  63255. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  63256. generatePhysicsBody(impostor: PhysicsImpostor): void;
  63257. private _processChildMeshes;
  63258. removePhysicsBody(impostor: PhysicsImpostor): void;
  63259. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  63260. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  63261. private _addMaterial;
  63262. private _checkWithEpsilon;
  63263. private _createShape;
  63264. private _createHeightmap;
  63265. private _minus90X;
  63266. private _plus90X;
  63267. private _tmpPosition;
  63268. private _tmpDeltaPosition;
  63269. private _tmpUnityRotation;
  63270. private _updatePhysicsBodyTransformation;
  63271. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  63272. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  63273. isSupported(): boolean;
  63274. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  63275. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  63276. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  63277. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  63278. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  63279. getBodyMass(impostor: PhysicsImpostor): number;
  63280. getBodyFriction(impostor: PhysicsImpostor): number;
  63281. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  63282. getBodyRestitution(impostor: PhysicsImpostor): number;
  63283. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  63284. sleepBody(impostor: PhysicsImpostor): void;
  63285. wakeUpBody(impostor: PhysicsImpostor): void;
  63286. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number): void;
  63287. setMotor(joint: IMotorEnabledJoint, speed?: number, maxForce?: number, motorIndex?: number): void;
  63288. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number): void;
  63289. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  63290. getRadius(impostor: PhysicsImpostor): number;
  63291. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  63292. dispose(): void;
  63293. private _extendNamespace;
  63294. /**
  63295. * Does a raycast in the physics world
  63296. * @param from when should the ray start?
  63297. * @param to when should the ray end?
  63298. * @returns PhysicsRaycastResult
  63299. */
  63300. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  63301. }
  63302. }
  63303. declare module "babylonjs/Physics/Plugins/oimoJSPlugin" {
  63304. import { IPhysicsEnginePlugin, PhysicsImpostorJoint } from "babylonjs/Physics/IPhysicsEngine";
  63305. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  63306. import { PhysicsJoint, IMotorEnabledJoint } from "babylonjs/Physics/physicsJoint";
  63307. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  63308. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  63309. import { Nullable } from "babylonjs/types";
  63310. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  63311. /** @hidden */
  63312. export class OimoJSPlugin implements IPhysicsEnginePlugin {
  63313. private _useDeltaForWorldStep;
  63314. world: any;
  63315. name: string;
  63316. BJSOIMO: any;
  63317. private _raycastResult;
  63318. private _fixedTimeStep;
  63319. constructor(_useDeltaForWorldStep?: boolean, iterations?: number, oimoInjection?: any);
  63320. setGravity(gravity: Vector3): void;
  63321. setTimeStep(timeStep: number): void;
  63322. getTimeStep(): number;
  63323. private _tmpImpostorsArray;
  63324. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  63325. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  63326. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  63327. generatePhysicsBody(impostor: PhysicsImpostor): void;
  63328. private _tmpPositionVector;
  63329. removePhysicsBody(impostor: PhysicsImpostor): void;
  63330. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  63331. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  63332. isSupported(): boolean;
  63333. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  63334. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  63335. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  63336. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  63337. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  63338. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  63339. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  63340. getBodyMass(impostor: PhysicsImpostor): number;
  63341. getBodyFriction(impostor: PhysicsImpostor): number;
  63342. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  63343. getBodyRestitution(impostor: PhysicsImpostor): number;
  63344. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  63345. sleepBody(impostor: PhysicsImpostor): void;
  63346. wakeUpBody(impostor: PhysicsImpostor): void;
  63347. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  63348. setMotor(joint: IMotorEnabledJoint, speed: number, force?: number, motorIndex?: number): void;
  63349. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  63350. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  63351. getRadius(impostor: PhysicsImpostor): number;
  63352. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  63353. dispose(): void;
  63354. /**
  63355. * Does a raycast in the physics world
  63356. * @param from when should the ray start?
  63357. * @param to when should the ray end?
  63358. * @returns PhysicsRaycastResult
  63359. */
  63360. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  63361. }
  63362. }
  63363. declare module "babylonjs/Physics/Plugins/ammoJSPlugin" {
  63364. import { Quaternion, Vector3 } from "babylonjs/Maths/math.vector";
  63365. import { IPhysicsEnginePlugin, PhysicsImpostorJoint } from "babylonjs/Physics/IPhysicsEngine";
  63366. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  63367. import { PhysicsJoint, IMotorEnabledJoint } from "babylonjs/Physics/physicsJoint";
  63368. import { Nullable } from "babylonjs/types";
  63369. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  63370. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  63371. /**
  63372. * AmmoJS Physics plugin
  63373. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  63374. * @see https://github.com/kripken/ammo.js/
  63375. */
  63376. export class AmmoJSPlugin implements IPhysicsEnginePlugin {
  63377. private _useDeltaForWorldStep;
  63378. /**
  63379. * Reference to the Ammo library
  63380. */
  63381. bjsAMMO: any;
  63382. /**
  63383. * Created ammoJS world which physics bodies are added to
  63384. */
  63385. world: any;
  63386. /**
  63387. * Name of the plugin
  63388. */
  63389. name: string;
  63390. private _timeStep;
  63391. private _fixedTimeStep;
  63392. private _maxSteps;
  63393. private _tmpQuaternion;
  63394. private _tmpAmmoTransform;
  63395. private _tmpAmmoQuaternion;
  63396. private _tmpAmmoConcreteContactResultCallback;
  63397. private _collisionConfiguration;
  63398. private _dispatcher;
  63399. private _overlappingPairCache;
  63400. private _solver;
  63401. private _softBodySolver;
  63402. private _tmpAmmoVectorA;
  63403. private _tmpAmmoVectorB;
  63404. private _tmpAmmoVectorC;
  63405. private _tmpAmmoVectorD;
  63406. private _tmpContactCallbackResult;
  63407. private _tmpAmmoVectorRCA;
  63408. private _tmpAmmoVectorRCB;
  63409. private _raycastResult;
  63410. private static readonly DISABLE_COLLISION_FLAG;
  63411. private static readonly KINEMATIC_FLAG;
  63412. private static readonly DISABLE_DEACTIVATION_FLAG;
  63413. /**
  63414. * Initializes the ammoJS plugin
  63415. * @param _useDeltaForWorldStep if the time between frames should be used when calculating physics steps (Default: true)
  63416. * @param ammoInjection can be used to inject your own ammo reference
  63417. * @param overlappingPairCache can be used to specify your own overlapping pair cache
  63418. */
  63419. constructor(_useDeltaForWorldStep?: boolean, ammoInjection?: any, overlappingPairCache?: any);
  63420. /**
  63421. * Sets the gravity of the physics world (m/(s^2))
  63422. * @param gravity Gravity to set
  63423. */
  63424. setGravity(gravity: Vector3): void;
  63425. /**
  63426. * Amount of time to step forward on each frame (only used if useDeltaForWorldStep is false in the constructor)
  63427. * @param timeStep timestep to use in seconds
  63428. */
  63429. setTimeStep(timeStep: number): void;
  63430. /**
  63431. * 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)
  63432. * @param fixedTimeStep fixedTimeStep to use in seconds
  63433. */
  63434. setFixedTimeStep(fixedTimeStep: number): void;
  63435. /**
  63436. * Sets the maximum number of steps by the physics engine per frame (Default: 5)
  63437. * @param maxSteps the maximum number of steps by the physics engine per frame
  63438. */
  63439. setMaxSteps(maxSteps: number): void;
  63440. /**
  63441. * Gets the current timestep (only used if useDeltaForWorldStep is false in the constructor)
  63442. * @returns the current timestep in seconds
  63443. */
  63444. getTimeStep(): number;
  63445. /**
  63446. * The create custom shape handler function to be called when using BABYLON.PhysicsImposter.CustomImpostor
  63447. */
  63448. onCreateCustomShape: (impostor: PhysicsImpostor) => any;
  63449. private _isImpostorInContact;
  63450. private _isImpostorPairInContact;
  63451. private _stepSimulation;
  63452. /**
  63453. * Moves the physics simulation forward delta seconds and updates the given physics imposters
  63454. * Prior to the step the imposters physics location is set to the position of the babylon meshes
  63455. * After the step the babylon meshes are set to the position of the physics imposters
  63456. * @param delta amount of time to step forward
  63457. * @param impostors array of imposters to update before/after the step
  63458. */
  63459. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  63460. /**
  63461. * Update babylon mesh to match physics world object
  63462. * @param impostor imposter to match
  63463. */
  63464. private _afterSoftStep;
  63465. /**
  63466. * Update babylon mesh vertices vertices to match physics world softbody or cloth
  63467. * @param impostor imposter to match
  63468. */
  63469. private _ropeStep;
  63470. /**
  63471. * Update babylon mesh vertices vertices to match physics world softbody or cloth
  63472. * @param impostor imposter to match
  63473. */
  63474. private _softbodyOrClothStep;
  63475. private _tmpMatrix;
  63476. /**
  63477. * Applies an impulse on the imposter
  63478. * @param impostor imposter to apply impulse to
  63479. * @param force amount of force to be applied to the imposter
  63480. * @param contactPoint the location to apply the impulse on the imposter
  63481. */
  63482. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  63483. /**
  63484. * Applies a force on the imposter
  63485. * @param impostor imposter to apply force
  63486. * @param force amount of force to be applied to the imposter
  63487. * @param contactPoint the location to apply the force on the imposter
  63488. */
  63489. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  63490. /**
  63491. * Creates a physics body using the plugin
  63492. * @param impostor the imposter to create the physics body on
  63493. */
  63494. generatePhysicsBody(impostor: PhysicsImpostor): void;
  63495. /**
  63496. * Removes the physics body from the imposter and disposes of the body's memory
  63497. * @param impostor imposter to remove the physics body from
  63498. */
  63499. removePhysicsBody(impostor: PhysicsImpostor): void;
  63500. /**
  63501. * Generates a joint
  63502. * @param impostorJoint the imposter joint to create the joint with
  63503. */
  63504. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  63505. /**
  63506. * Removes a joint
  63507. * @param impostorJoint the imposter joint to remove the joint from
  63508. */
  63509. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  63510. private _addMeshVerts;
  63511. /**
  63512. * Initialise the soft body vertices to match its object's (mesh) vertices
  63513. * Softbody vertices (nodes) are in world space and to match this
  63514. * The object's position and rotation is set to zero and so its vertices are also then set in world space
  63515. * @param impostor to create the softbody for
  63516. */
  63517. private _softVertexData;
  63518. /**
  63519. * Create an impostor's soft body
  63520. * @param impostor to create the softbody for
  63521. */
  63522. private _createSoftbody;
  63523. /**
  63524. * Create cloth for an impostor
  63525. * @param impostor to create the softbody for
  63526. */
  63527. private _createCloth;
  63528. /**
  63529. * Create rope for an impostor
  63530. * @param impostor to create the softbody for
  63531. */
  63532. private _createRope;
  63533. /**
  63534. * Create a custom physics impostor shape using the plugin's onCreateCustomShape handler
  63535. * @param impostor to create the custom physics shape for
  63536. */
  63537. private _createCustom;
  63538. private _addHullVerts;
  63539. private _createShape;
  63540. /**
  63541. * Sets the physics body position/rotation from the babylon mesh's position/rotation
  63542. * @param impostor imposter containing the physics body and babylon object
  63543. */
  63544. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  63545. /**
  63546. * Sets the babylon object's position/rotation from the physics body's position/rotation
  63547. * @param impostor imposter containing the physics body and babylon object
  63548. * @param newPosition new position
  63549. * @param newRotation new rotation
  63550. */
  63551. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  63552. /**
  63553. * If this plugin is supported
  63554. * @returns true if its supported
  63555. */
  63556. isSupported(): boolean;
  63557. /**
  63558. * Sets the linear velocity of the physics body
  63559. * @param impostor imposter to set the velocity on
  63560. * @param velocity velocity to set
  63561. */
  63562. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  63563. /**
  63564. * Sets the angular velocity of the physics body
  63565. * @param impostor imposter to set the velocity on
  63566. * @param velocity velocity to set
  63567. */
  63568. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  63569. /**
  63570. * gets the linear velocity
  63571. * @param impostor imposter to get linear velocity from
  63572. * @returns linear velocity
  63573. */
  63574. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  63575. /**
  63576. * gets the angular velocity
  63577. * @param impostor imposter to get angular velocity from
  63578. * @returns angular velocity
  63579. */
  63580. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  63581. /**
  63582. * Sets the mass of physics body
  63583. * @param impostor imposter to set the mass on
  63584. * @param mass mass to set
  63585. */
  63586. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  63587. /**
  63588. * Gets the mass of the physics body
  63589. * @param impostor imposter to get the mass from
  63590. * @returns mass
  63591. */
  63592. getBodyMass(impostor: PhysicsImpostor): number;
  63593. /**
  63594. * Gets friction of the impostor
  63595. * @param impostor impostor to get friction from
  63596. * @returns friction value
  63597. */
  63598. getBodyFriction(impostor: PhysicsImpostor): number;
  63599. /**
  63600. * Sets friction of the impostor
  63601. * @param impostor impostor to set friction on
  63602. * @param friction friction value
  63603. */
  63604. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  63605. /**
  63606. * Gets restitution of the impostor
  63607. * @param impostor impostor to get restitution from
  63608. * @returns restitution value
  63609. */
  63610. getBodyRestitution(impostor: PhysicsImpostor): number;
  63611. /**
  63612. * Sets resitution of the impostor
  63613. * @param impostor impostor to set resitution on
  63614. * @param restitution resitution value
  63615. */
  63616. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  63617. /**
  63618. * Gets pressure inside the impostor
  63619. * @param impostor impostor to get pressure from
  63620. * @returns pressure value
  63621. */
  63622. getBodyPressure(impostor: PhysicsImpostor): number;
  63623. /**
  63624. * Sets pressure inside a soft body impostor
  63625. * Cloth and rope must remain 0 pressure
  63626. * @param impostor impostor to set pressure on
  63627. * @param pressure pressure value
  63628. */
  63629. setBodyPressure(impostor: PhysicsImpostor, pressure: number): void;
  63630. /**
  63631. * Gets stiffness of the impostor
  63632. * @param impostor impostor to get stiffness from
  63633. * @returns pressure value
  63634. */
  63635. getBodyStiffness(impostor: PhysicsImpostor): number;
  63636. /**
  63637. * Sets stiffness of the impostor
  63638. * @param impostor impostor to set stiffness on
  63639. * @param stiffness stiffness value from 0 to 1
  63640. */
  63641. setBodyStiffness(impostor: PhysicsImpostor, stiffness: number): void;
  63642. /**
  63643. * Gets velocityIterations of the impostor
  63644. * @param impostor impostor to get velocity iterations from
  63645. * @returns velocityIterations value
  63646. */
  63647. getBodyVelocityIterations(impostor: PhysicsImpostor): number;
  63648. /**
  63649. * Sets velocityIterations of the impostor
  63650. * @param impostor impostor to set velocity iterations on
  63651. * @param velocityIterations velocityIterations value
  63652. */
  63653. setBodyVelocityIterations(impostor: PhysicsImpostor, velocityIterations: number): void;
  63654. /**
  63655. * Gets positionIterations of the impostor
  63656. * @param impostor impostor to get position iterations from
  63657. * @returns positionIterations value
  63658. */
  63659. getBodyPositionIterations(impostor: PhysicsImpostor): number;
  63660. /**
  63661. * Sets positionIterations of the impostor
  63662. * @param impostor impostor to set position on
  63663. * @param positionIterations positionIterations value
  63664. */
  63665. setBodyPositionIterations(impostor: PhysicsImpostor, positionIterations: number): void;
  63666. /**
  63667. * Append an anchor to a cloth object
  63668. * @param impostor is the cloth impostor to add anchor to
  63669. * @param otherImpostor is the rigid impostor to anchor to
  63670. * @param width ratio across width from 0 to 1
  63671. * @param height ratio up height from 0 to 1
  63672. * @param influence the elasticity between cloth impostor and anchor from 0, very stretchy to 1, little strech
  63673. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  63674. */
  63675. appendAnchor(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, width: number, height: number, influence?: number, noCollisionBetweenLinkedBodies?: boolean): void;
  63676. /**
  63677. * Append an hook to a rope object
  63678. * @param impostor is the rope impostor to add hook to
  63679. * @param otherImpostor is the rigid impostor to hook to
  63680. * @param length ratio along the rope from 0 to 1
  63681. * @param influence the elasticity between soft impostor and anchor from 0, very stretchy to 1, little strech
  63682. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  63683. */
  63684. appendHook(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, length: number, influence?: number, noCollisionBetweenLinkedBodies?: boolean): void;
  63685. /**
  63686. * Sleeps the physics body and stops it from being active
  63687. * @param impostor impostor to sleep
  63688. */
  63689. sleepBody(impostor: PhysicsImpostor): void;
  63690. /**
  63691. * Activates the physics body
  63692. * @param impostor impostor to activate
  63693. */
  63694. wakeUpBody(impostor: PhysicsImpostor): void;
  63695. /**
  63696. * Updates the distance parameters of the joint
  63697. * @param joint joint to update
  63698. * @param maxDistance maximum distance of the joint
  63699. * @param minDistance minimum distance of the joint
  63700. */
  63701. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  63702. /**
  63703. * Sets a motor on the joint
  63704. * @param joint joint to set motor on
  63705. * @param speed speed of the motor
  63706. * @param maxForce maximum force of the motor
  63707. * @param motorIndex index of the motor
  63708. */
  63709. setMotor(joint: IMotorEnabledJoint, speed?: number, maxForce?: number, motorIndex?: number): void;
  63710. /**
  63711. * Sets the motors limit
  63712. * @param joint joint to set limit on
  63713. * @param upperLimit upper limit
  63714. * @param lowerLimit lower limit
  63715. */
  63716. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number): void;
  63717. /**
  63718. * Syncs the position and rotation of a mesh with the impostor
  63719. * @param mesh mesh to sync
  63720. * @param impostor impostor to update the mesh with
  63721. */
  63722. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  63723. /**
  63724. * Gets the radius of the impostor
  63725. * @param impostor impostor to get radius from
  63726. * @returns the radius
  63727. */
  63728. getRadius(impostor: PhysicsImpostor): number;
  63729. /**
  63730. * Gets the box size of the impostor
  63731. * @param impostor impostor to get box size from
  63732. * @param result the resulting box size
  63733. */
  63734. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  63735. /**
  63736. * Disposes of the impostor
  63737. */
  63738. dispose(): void;
  63739. /**
  63740. * Does a raycast in the physics world
  63741. * @param from when should the ray start?
  63742. * @param to when should the ray end?
  63743. * @returns PhysicsRaycastResult
  63744. */
  63745. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  63746. }
  63747. }
  63748. declare module "babylonjs/Probes/reflectionProbe" {
  63749. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  63750. import { Vector3 } from "babylonjs/Maths/math.vector";
  63751. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  63752. import { Nullable } from "babylonjs/types";
  63753. import { Scene } from "babylonjs/scene";
  63754. module "babylonjs/abstractScene" {
  63755. interface AbstractScene {
  63756. /**
  63757. * The list of reflection probes added to the scene
  63758. * @see https://doc.babylonjs.com/how_to/how_to_use_reflection_probes
  63759. */
  63760. reflectionProbes: Array<ReflectionProbe>;
  63761. /**
  63762. * Removes the given reflection probe from this scene.
  63763. * @param toRemove The reflection probe to remove
  63764. * @returns The index of the removed reflection probe
  63765. */
  63766. removeReflectionProbe(toRemove: ReflectionProbe): number;
  63767. /**
  63768. * Adds the given reflection probe to this scene.
  63769. * @param newReflectionProbe The reflection probe to add
  63770. */
  63771. addReflectionProbe(newReflectionProbe: ReflectionProbe): void;
  63772. }
  63773. }
  63774. /**
  63775. * Class used to generate realtime reflection / refraction cube textures
  63776. * @see https://doc.babylonjs.com/how_to/how_to_use_reflection_probes
  63777. */
  63778. export class ReflectionProbe {
  63779. /** defines the name of the probe */
  63780. name: string;
  63781. private _scene;
  63782. private _renderTargetTexture;
  63783. private _projectionMatrix;
  63784. private _viewMatrix;
  63785. private _target;
  63786. private _add;
  63787. private _attachedMesh;
  63788. private _invertYAxis;
  63789. /** Gets or sets probe position (center of the cube map) */
  63790. position: Vector3;
  63791. /**
  63792. * Creates a new reflection probe
  63793. * @param name defines the name of the probe
  63794. * @param size defines the texture resolution (for each face)
  63795. * @param scene defines the hosting scene
  63796. * @param generateMipMaps defines if mip maps should be generated automatically (true by default)
  63797. * @param useFloat defines if HDR data (flaot data) should be used to store colors (false by default)
  63798. */
  63799. constructor(
  63800. /** defines the name of the probe */
  63801. name: string, size: number, scene: Scene, generateMipMaps?: boolean, useFloat?: boolean);
  63802. /** Gets or sets the number of samples to use for multi-sampling (0 by default). Required WebGL2 */
  63803. get samples(): number;
  63804. set samples(value: number);
  63805. /** Gets or sets the refresh rate to use (on every frame by default) */
  63806. get refreshRate(): number;
  63807. set refreshRate(value: number);
  63808. /**
  63809. * Gets the hosting scene
  63810. * @returns a Scene
  63811. */
  63812. getScene(): Scene;
  63813. /** Gets the internal CubeTexture used to render to */
  63814. get cubeTexture(): RenderTargetTexture;
  63815. /** Gets the list of meshes to render */
  63816. get renderList(): Nullable<AbstractMesh[]>;
  63817. /**
  63818. * Attach the probe to a specific mesh (Rendering will be done from attached mesh's position)
  63819. * @param mesh defines the mesh to attach to
  63820. */
  63821. attachToMesh(mesh: Nullable<AbstractMesh>): void;
  63822. /**
  63823. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups
  63824. * @param renderingGroupId The rendering group id corresponding to its index
  63825. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  63826. */
  63827. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean): void;
  63828. /**
  63829. * Clean all associated resources
  63830. */
  63831. dispose(): void;
  63832. /**
  63833. * Converts the reflection probe information to a readable string for debug purpose.
  63834. * @param fullDetails Supports for multiple levels of logging within scene loading
  63835. * @returns the human readable reflection probe info
  63836. */
  63837. toString(fullDetails?: boolean): string;
  63838. /**
  63839. * Get the class name of the relfection probe.
  63840. * @returns "ReflectionProbe"
  63841. */
  63842. getClassName(): string;
  63843. /**
  63844. * Serialize the reflection probe to a JSON representation we can easily use in the resepective Parse function.
  63845. * @returns The JSON representation of the texture
  63846. */
  63847. serialize(): any;
  63848. /**
  63849. * Parse the JSON representation of a reflection probe in order to recreate the reflection probe in the given scene.
  63850. * @param parsedReflectionProbe Define the JSON representation of the reflection probe
  63851. * @param scene Define the scene the parsed reflection probe should be instantiated in
  63852. * @param rootUrl Define the root url of the parsing sequence in the case of relative dependencies
  63853. * @returns The parsed reflection probe if successful
  63854. */
  63855. static Parse(parsedReflectionProbe: any, scene: Scene, rootUrl: string): Nullable<ReflectionProbe>;
  63856. }
  63857. }
  63858. declare module "babylonjs/Loading/Plugins/babylonFileLoader" {
  63859. /** @hidden */
  63860. export var _BabylonLoaderRegistered: boolean;
  63861. /**
  63862. * Helps setting up some configuration for the babylon file loader.
  63863. */
  63864. export class BabylonFileLoaderConfiguration {
  63865. /**
  63866. * The loader does not allow injecting custom physix engine into the plugins.
  63867. * Unfortunately in ES6, we need to manually inject them into the plugin.
  63868. * So you could set this variable to your engine import to make it work.
  63869. */
  63870. static LoaderInjectedPhysicsEngine: any;
  63871. }
  63872. }
  63873. declare module "babylonjs/Loading/Plugins/index" {
  63874. export * from "babylonjs/Loading/Plugins/babylonFileLoader";
  63875. }
  63876. declare module "babylonjs/Loading/index" {
  63877. export * from "babylonjs/Loading/loadingScreen";
  63878. export * from "babylonjs/Loading/Plugins/index";
  63879. export * from "babylonjs/Loading/sceneLoader";
  63880. export * from "babylonjs/Loading/sceneLoaderFlags";
  63881. }
  63882. declare module "babylonjs/Materials/Background/index" {
  63883. export * from "babylonjs/Materials/Background/backgroundMaterial";
  63884. }
  63885. declare module "babylonjs/Materials/PBR/pbrBaseSimpleMaterial" {
  63886. import { Scene } from "babylonjs/scene";
  63887. import { Color3 } from "babylonjs/Maths/math.color";
  63888. import { PBRBaseMaterial } from "babylonjs/Materials/PBR/pbrBaseMaterial";
  63889. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  63890. /**
  63891. * The Physically based simple base material of BJS.
  63892. *
  63893. * This enables better naming and convention enforcements on top of the pbrMaterial.
  63894. * It is used as the base class for both the specGloss and metalRough conventions.
  63895. */
  63896. export abstract class PBRBaseSimpleMaterial extends PBRBaseMaterial {
  63897. /**
  63898. * Number of Simultaneous lights allowed on the material.
  63899. */
  63900. maxSimultaneousLights: number;
  63901. /**
  63902. * If sets to true, disables all the lights affecting the material.
  63903. */
  63904. disableLighting: boolean;
  63905. /**
  63906. * Environment Texture used in the material (this is use for both reflection and environment lighting).
  63907. */
  63908. environmentTexture: BaseTexture;
  63909. /**
  63910. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  63911. */
  63912. invertNormalMapX: boolean;
  63913. /**
  63914. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  63915. */
  63916. invertNormalMapY: boolean;
  63917. /**
  63918. * Normal map used in the model.
  63919. */
  63920. normalTexture: BaseTexture;
  63921. /**
  63922. * Emissivie color used to self-illuminate the model.
  63923. */
  63924. emissiveColor: Color3;
  63925. /**
  63926. * Emissivie texture used to self-illuminate the model.
  63927. */
  63928. emissiveTexture: BaseTexture;
  63929. /**
  63930. * Occlusion Channel Strenght.
  63931. */
  63932. occlusionStrength: number;
  63933. /**
  63934. * Occlusion Texture of the material (adding extra occlusion effects).
  63935. */
  63936. occlusionTexture: BaseTexture;
  63937. /**
  63938. * Defines the alpha limits in alpha test mode.
  63939. */
  63940. alphaCutOff: number;
  63941. /**
  63942. * Gets the current double sided mode.
  63943. */
  63944. get doubleSided(): boolean;
  63945. /**
  63946. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  63947. */
  63948. set doubleSided(value: boolean);
  63949. /**
  63950. * Stores the pre-calculated light information of a mesh in a texture.
  63951. */
  63952. lightmapTexture: BaseTexture;
  63953. /**
  63954. * If true, the light map contains occlusion information instead of lighting info.
  63955. */
  63956. useLightmapAsShadowmap: boolean;
  63957. /**
  63958. * Instantiates a new PBRMaterial instance.
  63959. *
  63960. * @param name The material name
  63961. * @param scene The scene the material will be use in.
  63962. */
  63963. constructor(name: string, scene: Scene);
  63964. getClassName(): string;
  63965. }
  63966. }
  63967. declare module "babylonjs/Materials/PBR/pbrMetallicRoughnessMaterial" {
  63968. import { Scene } from "babylonjs/scene";
  63969. import { Color3 } from "babylonjs/Maths/math.color";
  63970. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  63971. import { PBRBaseSimpleMaterial } from "babylonjs/Materials/PBR/pbrBaseSimpleMaterial";
  63972. /**
  63973. * The PBR material of BJS following the metal roughness convention.
  63974. *
  63975. * This fits to the PBR convention in the GLTF definition:
  63976. * https://github.com/KhronosGroup/glTF/tree/2.0/specification/2.0
  63977. */
  63978. export class PBRMetallicRoughnessMaterial extends PBRBaseSimpleMaterial {
  63979. /**
  63980. * The base color has two different interpretations depending on the value of metalness.
  63981. * When the material is a metal, the base color is the specific measured reflectance value
  63982. * at normal incidence (F0). For a non-metal the base color represents the reflected diffuse color
  63983. * of the material.
  63984. */
  63985. baseColor: Color3;
  63986. /**
  63987. * Base texture of the metallic workflow. It contains both the baseColor information in RGB as
  63988. * well as opacity information in the alpha channel.
  63989. */
  63990. baseTexture: BaseTexture;
  63991. /**
  63992. * Specifies the metallic scalar value of the material.
  63993. * Can also be used to scale the metalness values of the metallic texture.
  63994. */
  63995. metallic: number;
  63996. /**
  63997. * Specifies the roughness scalar value of the material.
  63998. * Can also be used to scale the roughness values of the metallic texture.
  63999. */
  64000. roughness: number;
  64001. /**
  64002. * Texture containing both the metallic value in the B channel and the
  64003. * roughness value in the G channel to keep better precision.
  64004. */
  64005. metallicRoughnessTexture: BaseTexture;
  64006. /**
  64007. * Instantiates a new PBRMetalRoughnessMaterial instance.
  64008. *
  64009. * @param name The material name
  64010. * @param scene The scene the material will be use in.
  64011. */
  64012. constructor(name: string, scene: Scene);
  64013. /**
  64014. * Return the currrent class name of the material.
  64015. */
  64016. getClassName(): string;
  64017. /**
  64018. * Makes a duplicate of the current material.
  64019. * @param name - name to use for the new material.
  64020. */
  64021. clone(name: string): PBRMetallicRoughnessMaterial;
  64022. /**
  64023. * Serialize the material to a parsable JSON object.
  64024. */
  64025. serialize(): any;
  64026. /**
  64027. * Parses a JSON object correponding to the serialize function.
  64028. */
  64029. static Parse(source: any, scene: Scene, rootUrl: string): PBRMetallicRoughnessMaterial;
  64030. }
  64031. }
  64032. declare module "babylonjs/Materials/PBR/pbrSpecularGlossinessMaterial" {
  64033. import { Scene } from "babylonjs/scene";
  64034. import { Color3 } from "babylonjs/Maths/math.color";
  64035. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  64036. import { PBRBaseSimpleMaterial } from "babylonjs/Materials/PBR/pbrBaseSimpleMaterial";
  64037. /**
  64038. * The PBR material of BJS following the specular glossiness convention.
  64039. *
  64040. * This fits to the PBR convention in the GLTF definition:
  64041. * https://github.com/KhronosGroup/glTF/tree/2.0/extensions/Khronos/KHR_materials_pbrSpecularGlossiness
  64042. */
  64043. export class PBRSpecularGlossinessMaterial extends PBRBaseSimpleMaterial {
  64044. /**
  64045. * Specifies the diffuse color of the material.
  64046. */
  64047. diffuseColor: Color3;
  64048. /**
  64049. * Specifies the diffuse texture of the material. This can also contains the opcity value in its alpha
  64050. * channel.
  64051. */
  64052. diffuseTexture: BaseTexture;
  64053. /**
  64054. * Specifies the specular color of the material. This indicates how reflective is the material (none to mirror).
  64055. */
  64056. specularColor: Color3;
  64057. /**
  64058. * Specifies the glossiness of the material. This indicates "how sharp is the reflection".
  64059. */
  64060. glossiness: number;
  64061. /**
  64062. * Specifies both the specular color RGB and the glossiness A of the material per pixels.
  64063. */
  64064. specularGlossinessTexture: BaseTexture;
  64065. /**
  64066. * Instantiates a new PBRSpecularGlossinessMaterial instance.
  64067. *
  64068. * @param name The material name
  64069. * @param scene The scene the material will be use in.
  64070. */
  64071. constructor(name: string, scene: Scene);
  64072. /**
  64073. * Return the currrent class name of the material.
  64074. */
  64075. getClassName(): string;
  64076. /**
  64077. * Makes a duplicate of the current material.
  64078. * @param name - name to use for the new material.
  64079. */
  64080. clone(name: string): PBRSpecularGlossinessMaterial;
  64081. /**
  64082. * Serialize the material to a parsable JSON object.
  64083. */
  64084. serialize(): any;
  64085. /**
  64086. * Parses a JSON object correponding to the serialize function.
  64087. */
  64088. static Parse(source: any, scene: Scene, rootUrl: string): PBRSpecularGlossinessMaterial;
  64089. }
  64090. }
  64091. declare module "babylonjs/Materials/PBR/index" {
  64092. export * from "babylonjs/Materials/PBR/pbrBaseMaterial";
  64093. export * from "babylonjs/Materials/PBR/pbrBaseSimpleMaterial";
  64094. export * from "babylonjs/Materials/PBR/pbrMaterial";
  64095. export * from "babylonjs/Materials/PBR/pbrMetallicRoughnessMaterial";
  64096. export * from "babylonjs/Materials/PBR/pbrSpecularGlossinessMaterial";
  64097. }
  64098. declare module "babylonjs/Materials/Textures/colorGradingTexture" {
  64099. import { Nullable } from "babylonjs/types";
  64100. import { Scene } from "babylonjs/scene";
  64101. import { Matrix } from "babylonjs/Maths/math.vector";
  64102. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  64103. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  64104. import "babylonjs/Engines/Extensions/engine.rawTexture";
  64105. /**
  64106. * This represents a color grading texture. This acts as a lookup table LUT, useful during post process
  64107. * It can help converting any input color in a desired output one. This can then be used to create effects
  64108. * from sepia, black and white to sixties or futuristic rendering...
  64109. *
  64110. * The only supported format is currently 3dl.
  64111. * More information on LUT: https://en.wikipedia.org/wiki/3D_lookup_table
  64112. */
  64113. export class ColorGradingTexture extends BaseTexture {
  64114. /**
  64115. * The texture URL.
  64116. */
  64117. url: string;
  64118. /**
  64119. * Empty line regex stored for GC.
  64120. */
  64121. private static _noneEmptyLineRegex;
  64122. private _textureMatrix;
  64123. private _onLoad;
  64124. /**
  64125. * Instantiates a ColorGradingTexture from the following parameters.
  64126. *
  64127. * @param url The location of the color gradind data (currently only supporting 3dl)
  64128. * @param sceneOrEngine The scene or engine the texture will be used in
  64129. * @param onLoad defines a callback triggered when the texture has been loaded
  64130. */
  64131. constructor(url: string, sceneOrEngine: Scene | ThinEngine, onLoad?: Nullable<() => void>);
  64132. /**
  64133. * Fires the onload event from the constructor if requested.
  64134. */
  64135. private _triggerOnLoad;
  64136. /**
  64137. * Returns the texture matrix used in most of the material.
  64138. * This is not used in color grading but keep for troubleshooting purpose (easily swap diffuse by colorgrading to look in).
  64139. */
  64140. getTextureMatrix(): Matrix;
  64141. /**
  64142. * Occurs when the file being loaded is a .3dl LUT file.
  64143. */
  64144. private load3dlTexture;
  64145. /**
  64146. * Starts the loading process of the texture.
  64147. */
  64148. private loadTexture;
  64149. /**
  64150. * Clones the color gradind texture.
  64151. */
  64152. clone(): ColorGradingTexture;
  64153. /**
  64154. * Called during delayed load for textures.
  64155. */
  64156. delayLoad(): void;
  64157. /**
  64158. * Parses a color grading texture serialized by Babylon.
  64159. * @param parsedTexture The texture information being parsedTexture
  64160. * @param scene The scene to load the texture in
  64161. * @param rootUrl The root url of the data assets to load
  64162. * @return A color gradind texture
  64163. */
  64164. static Parse(parsedTexture: any, scene: Scene): Nullable<ColorGradingTexture>;
  64165. /**
  64166. * Serializes the LUT texture to json format.
  64167. */
  64168. serialize(): any;
  64169. }
  64170. }
  64171. declare module "babylonjs/Materials/Textures/equiRectangularCubeTexture" {
  64172. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  64173. import { Scene } from "babylonjs/scene";
  64174. import { Nullable } from "babylonjs/types";
  64175. import "babylonjs/Engines/Extensions/engine.rawTexture";
  64176. /**
  64177. * This represents a texture coming from an equirectangular image supported by the web browser canvas.
  64178. */
  64179. export class EquiRectangularCubeTexture extends BaseTexture {
  64180. /** The six faces of the cube. */
  64181. private static _FacesMapping;
  64182. private _noMipmap;
  64183. private _onLoad;
  64184. private _onError;
  64185. /** The size of the cubemap. */
  64186. private _size;
  64187. /** The buffer of the image. */
  64188. private _buffer;
  64189. /** The width of the input image. */
  64190. private _width;
  64191. /** The height of the input image. */
  64192. private _height;
  64193. /** The URL to the image. */
  64194. url: string;
  64195. /** The texture coordinates mode. As this texture is stored in a cube format, please modify carefully. */
  64196. coordinatesMode: number;
  64197. /**
  64198. * Instantiates an EquiRectangularCubeTexture from the following parameters.
  64199. * @param url The location of the image
  64200. * @param scene The scene the texture will be used in
  64201. * @param size The cubemap desired size (the more it increases the longer the generation will be)
  64202. * @param noMipmap Forces to not generate the mipmap if true
  64203. * @param gammaSpace Specifies if the texture will be used in gamma or linear space
  64204. * (the PBR material requires those textures in linear space, but the standard material would require them in Gamma space)
  64205. * @param onLoad — defines a callback called when texture is loaded
  64206. * @param onError — defines a callback called if there is an error
  64207. */
  64208. constructor(url: string, scene: Scene, size: number, noMipmap?: boolean, gammaSpace?: boolean, onLoad?: Nullable<() => void>, onError?: Nullable<(message?: string, exception?: any) => void>);
  64209. /**
  64210. * Load the image data, by putting the image on a canvas and extracting its buffer.
  64211. */
  64212. private loadImage;
  64213. /**
  64214. * Convert the image buffer into a cubemap and create a CubeTexture.
  64215. */
  64216. private loadTexture;
  64217. /**
  64218. * Convert the ArrayBuffer into a Float32Array and drop the transparency channel.
  64219. * @param buffer The ArrayBuffer that should be converted.
  64220. * @returns The buffer as Float32Array.
  64221. */
  64222. private getFloat32ArrayFromArrayBuffer;
  64223. /**
  64224. * Get the current class name of the texture useful for serialization or dynamic coding.
  64225. * @returns "EquiRectangularCubeTexture"
  64226. */
  64227. getClassName(): string;
  64228. /**
  64229. * Create a clone of the current EquiRectangularCubeTexture and return it.
  64230. * @returns A clone of the current EquiRectangularCubeTexture.
  64231. */
  64232. clone(): EquiRectangularCubeTexture;
  64233. }
  64234. }
  64235. declare module "babylonjs/Materials/Textures/htmlElementTexture" {
  64236. import { Nullable } from "babylonjs/types";
  64237. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  64238. import { Matrix } from "babylonjs/Maths/math.vector";
  64239. import "babylonjs/Engines/Extensions/engine.dynamicTexture";
  64240. import "babylonjs/Engines/Extensions/engine.videoTexture";
  64241. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  64242. import { Scene } from "babylonjs/scene";
  64243. /**
  64244. * Defines the options related to the creation of an HtmlElementTexture
  64245. */
  64246. export interface IHtmlElementTextureOptions {
  64247. /**
  64248. * Defines wether mip maps should be created or not.
  64249. */
  64250. generateMipMaps?: boolean;
  64251. /**
  64252. * Defines the sampling mode of the texture.
  64253. */
  64254. samplingMode?: number;
  64255. /**
  64256. * Defines the engine instance to use the texture with. It is not mandatory if you define a scene.
  64257. */
  64258. engine: Nullable<ThinEngine>;
  64259. /**
  64260. * Defines the scene the texture belongs to. It is not mandatory if you define an engine.
  64261. */
  64262. scene: Nullable<Scene>;
  64263. }
  64264. /**
  64265. * This represents the smallest workload to use an already existing element (Canvas or Video) as a texture.
  64266. * To be as efficient as possible depending on your constraints nothing aside the first upload
  64267. * is automatically managed.
  64268. * It is a cheap VideoTexture or DynamicTexture if you prefer to keep full control of the elements
  64269. * in your application.
  64270. *
  64271. * As the update is not automatic, you need to call them manually.
  64272. */
  64273. export class HtmlElementTexture extends BaseTexture {
  64274. /**
  64275. * The texture URL.
  64276. */
  64277. element: HTMLVideoElement | HTMLCanvasElement;
  64278. private static readonly DefaultOptions;
  64279. private _textureMatrix;
  64280. private _isVideo;
  64281. private _generateMipMaps;
  64282. private _samplingMode;
  64283. /**
  64284. * Instantiates a HtmlElementTexture from the following parameters.
  64285. *
  64286. * @param name Defines the name of the texture
  64287. * @param element Defines the video or canvas the texture is filled with
  64288. * @param options Defines the other none mandatory texture creation options
  64289. */
  64290. constructor(name: string, element: HTMLVideoElement | HTMLCanvasElement, options: IHtmlElementTextureOptions);
  64291. private _createInternalTexture;
  64292. /**
  64293. * Returns the texture matrix used in most of the material.
  64294. */
  64295. getTextureMatrix(): Matrix;
  64296. /**
  64297. * Updates the content of the texture.
  64298. * @param invertY Defines wether the texture should be inverted on Y (false by default on video and true on canvas)
  64299. */
  64300. update(invertY?: Nullable<boolean>): void;
  64301. }
  64302. }
  64303. declare module "babylonjs/Misc/tga" {
  64304. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  64305. /**
  64306. * Based on jsTGALoader - Javascript loader for TGA file
  64307. * By Vincent Thibault
  64308. * @see http://blog.robrowser.com/javascript-tga-loader.html
  64309. */
  64310. export class TGATools {
  64311. private static _TYPE_INDEXED;
  64312. private static _TYPE_RGB;
  64313. private static _TYPE_GREY;
  64314. private static _TYPE_RLE_INDEXED;
  64315. private static _TYPE_RLE_RGB;
  64316. private static _TYPE_RLE_GREY;
  64317. private static _ORIGIN_MASK;
  64318. private static _ORIGIN_SHIFT;
  64319. private static _ORIGIN_BL;
  64320. private static _ORIGIN_BR;
  64321. private static _ORIGIN_UL;
  64322. private static _ORIGIN_UR;
  64323. /**
  64324. * Gets the header of a TGA file
  64325. * @param data defines the TGA data
  64326. * @returns the header
  64327. */
  64328. static GetTGAHeader(data: Uint8Array): any;
  64329. /**
  64330. * Uploads TGA content to a Babylon Texture
  64331. * @hidden
  64332. */
  64333. static UploadContent(texture: InternalTexture, data: Uint8Array): void;
  64334. /** @hidden */
  64335. 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;
  64336. /** @hidden */
  64337. 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;
  64338. /** @hidden */
  64339. 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;
  64340. /** @hidden */
  64341. 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;
  64342. /** @hidden */
  64343. 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;
  64344. /** @hidden */
  64345. 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;
  64346. }
  64347. }
  64348. declare module "babylonjs/Materials/Textures/Loaders/tgaTextureLoader" {
  64349. import { Nullable } from "babylonjs/types";
  64350. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  64351. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  64352. /**
  64353. * Implementation of the TGA Texture Loader.
  64354. * @hidden
  64355. */
  64356. export class _TGATextureLoader implements IInternalTextureLoader {
  64357. /**
  64358. * Defines wether the loader supports cascade loading the different faces.
  64359. */
  64360. readonly supportCascades: boolean;
  64361. /**
  64362. * This returns if the loader support the current file information.
  64363. * @param extension defines the file extension of the file being loaded
  64364. * @returns true if the loader can load the specified file
  64365. */
  64366. canLoad(extension: string): boolean;
  64367. /**
  64368. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  64369. * @param data contains the texture data
  64370. * @param texture defines the BabylonJS internal texture
  64371. * @param createPolynomials will be true if polynomials have been requested
  64372. * @param onLoad defines the callback to trigger once the texture is ready
  64373. * @param onError defines the callback to trigger in case of error
  64374. */
  64375. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  64376. /**
  64377. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  64378. * @param data contains the texture data
  64379. * @param texture defines the BabylonJS internal texture
  64380. * @param callback defines the method to call once ready to upload
  64381. */
  64382. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  64383. }
  64384. }
  64385. declare module "babylonjs/Misc/basis" {
  64386. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  64387. /**
  64388. * Info about the .basis files
  64389. */
  64390. class BasisFileInfo {
  64391. /**
  64392. * If the file has alpha
  64393. */
  64394. hasAlpha: boolean;
  64395. /**
  64396. * Info about each image of the basis file
  64397. */
  64398. images: Array<{
  64399. levels: Array<{
  64400. width: number;
  64401. height: number;
  64402. transcodedPixels: ArrayBufferView;
  64403. }>;
  64404. }>;
  64405. }
  64406. /**
  64407. * Result of transcoding a basis file
  64408. */
  64409. class TranscodeResult {
  64410. /**
  64411. * Info about the .basis file
  64412. */
  64413. fileInfo: BasisFileInfo;
  64414. /**
  64415. * Format to use when loading the file
  64416. */
  64417. format: number;
  64418. }
  64419. /**
  64420. * Configuration options for the Basis transcoder
  64421. */
  64422. export class BasisTranscodeConfiguration {
  64423. /**
  64424. * Supported compression formats used to determine the supported output format of the transcoder
  64425. */
  64426. supportedCompressionFormats?: {
  64427. /**
  64428. * etc1 compression format
  64429. */
  64430. etc1?: boolean;
  64431. /**
  64432. * s3tc compression format
  64433. */
  64434. s3tc?: boolean;
  64435. /**
  64436. * pvrtc compression format
  64437. */
  64438. pvrtc?: boolean;
  64439. /**
  64440. * etc2 compression format
  64441. */
  64442. etc2?: boolean;
  64443. };
  64444. /**
  64445. * If mipmap levels should be loaded for transcoded images (Default: true)
  64446. */
  64447. loadMipmapLevels?: boolean;
  64448. /**
  64449. * Index of a single image to load (Default: all images)
  64450. */
  64451. loadSingleImage?: number;
  64452. }
  64453. /**
  64454. * Used to load .Basis files
  64455. * See https://github.com/BinomialLLC/basis_universal/tree/master/webgl
  64456. */
  64457. export class BasisTools {
  64458. private static _IgnoreSupportedFormats;
  64459. /**
  64460. * URL to use when loading the basis transcoder
  64461. */
  64462. static JSModuleURL: string;
  64463. /**
  64464. * URL to use when loading the wasm module for the transcoder
  64465. */
  64466. static WasmModuleURL: string;
  64467. /**
  64468. * Get the internal format to be passed to texImage2D corresponding to the .basis format value
  64469. * @param basisFormat format chosen from GetSupportedTranscodeFormat
  64470. * @returns internal format corresponding to the Basis format
  64471. */
  64472. static GetInternalFormatFromBasisFormat(basisFormat: number): number;
  64473. private static _WorkerPromise;
  64474. private static _Worker;
  64475. private static _actionId;
  64476. private static _CreateWorkerAsync;
  64477. /**
  64478. * Transcodes a loaded image file to compressed pixel data
  64479. * @param data image data to transcode
  64480. * @param config configuration options for the transcoding
  64481. * @returns a promise resulting in the transcoded image
  64482. */
  64483. static TranscodeAsync(data: ArrayBuffer | ArrayBufferView, config: BasisTranscodeConfiguration): Promise<TranscodeResult>;
  64484. /**
  64485. * Loads a texture from the transcode result
  64486. * @param texture texture load to
  64487. * @param transcodeResult the result of transcoding the basis file to load from
  64488. */
  64489. static LoadTextureFromTranscodeResult(texture: InternalTexture, transcodeResult: TranscodeResult): void;
  64490. }
  64491. }
  64492. declare module "babylonjs/Materials/Textures/Loaders/basisTextureLoader" {
  64493. import { Nullable } from "babylonjs/types";
  64494. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  64495. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  64496. /**
  64497. * Loader for .basis file format
  64498. */
  64499. export class _BasisTextureLoader implements IInternalTextureLoader {
  64500. /**
  64501. * Defines whether the loader supports cascade loading the different faces.
  64502. */
  64503. readonly supportCascades: boolean;
  64504. /**
  64505. * This returns if the loader support the current file information.
  64506. * @param extension defines the file extension of the file being loaded
  64507. * @returns true if the loader can load the specified file
  64508. */
  64509. canLoad(extension: string): boolean;
  64510. /**
  64511. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  64512. * @param data contains the texture data
  64513. * @param texture defines the BabylonJS internal texture
  64514. * @param createPolynomials will be true if polynomials have been requested
  64515. * @param onLoad defines the callback to trigger once the texture is ready
  64516. * @param onError defines the callback to trigger in case of error
  64517. */
  64518. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  64519. /**
  64520. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  64521. * @param data contains the texture data
  64522. * @param texture defines the BabylonJS internal texture
  64523. * @param callback defines the method to call once ready to upload
  64524. */
  64525. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  64526. }
  64527. }
  64528. declare module "babylonjs/Materials/Textures/Loaders/index" {
  64529. export * from "babylonjs/Materials/Textures/Loaders/ddsTextureLoader";
  64530. export * from "babylonjs/Materials/Textures/Loaders/envTextureLoader";
  64531. export * from "babylonjs/Materials/Textures/Loaders/ktxTextureLoader";
  64532. export * from "babylonjs/Materials/Textures/Loaders/tgaTextureLoader";
  64533. export * from "babylonjs/Materials/Textures/Loaders/basisTextureLoader";
  64534. }
  64535. declare module "babylonjs/Materials/Textures/Packer/frame" {
  64536. import { Vector2 } from "babylonjs/Maths/math.vector";
  64537. /**
  64538. * Defines the basic options interface of a TexturePacker Frame
  64539. */
  64540. export interface ITexturePackerFrame {
  64541. /**
  64542. * The frame ID
  64543. */
  64544. id: number;
  64545. /**
  64546. * The frames Scale
  64547. */
  64548. scale: Vector2;
  64549. /**
  64550. * The Frames offset
  64551. */
  64552. offset: Vector2;
  64553. }
  64554. /**
  64555. * This is a support class for frame Data on texture packer sets.
  64556. */
  64557. export class TexturePackerFrame implements ITexturePackerFrame {
  64558. /**
  64559. * The frame ID
  64560. */
  64561. id: number;
  64562. /**
  64563. * The frames Scale
  64564. */
  64565. scale: Vector2;
  64566. /**
  64567. * The Frames offset
  64568. */
  64569. offset: Vector2;
  64570. /**
  64571. * Initializes a texture package frame.
  64572. * @param id The numerical frame identifier
  64573. * @param scale Scalar Vector2 for UV frame
  64574. * @param offset Vector2 for the frame position in UV units.
  64575. * @returns TexturePackerFrame
  64576. */
  64577. constructor(id: number, scale: Vector2, offset: Vector2);
  64578. }
  64579. }
  64580. declare module "babylonjs/Materials/Textures/Packer/packer" {
  64581. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  64582. import { Scene } from "babylonjs/scene";
  64583. import { Nullable } from "babylonjs/types";
  64584. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  64585. import { TexturePackerFrame } from "babylonjs/Materials/Textures/Packer/frame";
  64586. /**
  64587. * Defines the basic options interface of a TexturePacker
  64588. */
  64589. export interface ITexturePackerOptions {
  64590. /**
  64591. * Custom targets for the channels of a texture packer. Default is all the channels of the Standard Material
  64592. */
  64593. map?: string[];
  64594. /**
  64595. * the UV input targets, as a single value for all meshes. Defaults to VertexBuffer.UVKind
  64596. */
  64597. uvsIn?: string;
  64598. /**
  64599. * the UV output targets, as a single value for all meshes. Defaults to VertexBuffer.UVKind
  64600. */
  64601. uvsOut?: string;
  64602. /**
  64603. * number representing the layout style. Defaults to LAYOUT_STRIP
  64604. */
  64605. layout?: number;
  64606. /**
  64607. * number of columns if using custom column count layout(2). This defaults to 4.
  64608. */
  64609. colnum?: number;
  64610. /**
  64611. * flag to update the input meshes to the new packed texture after compilation. Defaults to true.
  64612. */
  64613. updateInputMeshes?: boolean;
  64614. /**
  64615. * boolean flag to dispose all the source textures. Defaults to true.
  64616. */
  64617. disposeSources?: boolean;
  64618. /**
  64619. * Fills the blank cells in a set to the customFillColor. Defaults to true.
  64620. */
  64621. fillBlanks?: boolean;
  64622. /**
  64623. * string value representing the context fill style color. Defaults to 'black'.
  64624. */
  64625. customFillColor?: string;
  64626. /**
  64627. * Width and Height Value of each Frame in the TexturePacker Sets
  64628. */
  64629. frameSize?: number;
  64630. /**
  64631. * Ratio of the value to add padding wise to each cell. Defaults to 0.0115
  64632. */
  64633. paddingRatio?: number;
  64634. /**
  64635. * Number that declares the fill method for the padding gutter.
  64636. */
  64637. paddingMode?: number;
  64638. /**
  64639. * If in SUBUV_COLOR padding mode what color to use.
  64640. */
  64641. paddingColor?: Color3 | Color4;
  64642. }
  64643. /**
  64644. * Defines the basic interface of a TexturePacker JSON File
  64645. */
  64646. export interface ITexturePackerJSON {
  64647. /**
  64648. * The frame ID
  64649. */
  64650. name: string;
  64651. /**
  64652. * The base64 channel data
  64653. */
  64654. sets: any;
  64655. /**
  64656. * The options of the Packer
  64657. */
  64658. options: ITexturePackerOptions;
  64659. /**
  64660. * The frame data of the Packer
  64661. */
  64662. frames: Array<number>;
  64663. }
  64664. /**
  64665. * This is a support class that generates a series of packed texture sets.
  64666. * @see https://doc.babylonjs.com/babylon101/materials
  64667. */
  64668. export class TexturePacker {
  64669. /** Packer Layout Constant 0 */
  64670. static readonly LAYOUT_STRIP: number;
  64671. /** Packer Layout Constant 1 */
  64672. static readonly LAYOUT_POWER2: number;
  64673. /** Packer Layout Constant 2 */
  64674. static readonly LAYOUT_COLNUM: number;
  64675. /** Packer Layout Constant 0 */
  64676. static readonly SUBUV_WRAP: number;
  64677. /** Packer Layout Constant 1 */
  64678. static readonly SUBUV_EXTEND: number;
  64679. /** Packer Layout Constant 2 */
  64680. static readonly SUBUV_COLOR: number;
  64681. /** The Name of the Texture Package */
  64682. name: string;
  64683. /** The scene scope of the TexturePacker */
  64684. scene: Scene;
  64685. /** The Meshes to target */
  64686. meshes: AbstractMesh[];
  64687. /** Arguments passed with the Constructor */
  64688. options: ITexturePackerOptions;
  64689. /** The promise that is started upon initialization */
  64690. promise: Nullable<Promise<TexturePacker | string>>;
  64691. /** The Container object for the channel sets that are generated */
  64692. sets: object;
  64693. /** The Container array for the frames that are generated */
  64694. frames: TexturePackerFrame[];
  64695. /** The expected number of textures the system is parsing. */
  64696. private _expecting;
  64697. /** The padding value from Math.ceil(frameSize * paddingRatio) */
  64698. private _paddingValue;
  64699. /**
  64700. * Initializes a texture package series from an array of meshes or a single mesh.
  64701. * @param name The name of the package
  64702. * @param meshes The target meshes to compose the package from
  64703. * @param options The arguments that texture packer should follow while building.
  64704. * @param scene The scene which the textures are scoped to.
  64705. * @returns TexturePacker
  64706. */
  64707. constructor(name: string, meshes: AbstractMesh[], options: ITexturePackerOptions, scene: Scene);
  64708. /**
  64709. * Starts the package process
  64710. * @param resolve The promises resolution function
  64711. * @returns TexturePacker
  64712. */
  64713. private _createFrames;
  64714. /**
  64715. * Calculates the Size of the Channel Sets
  64716. * @returns Vector2
  64717. */
  64718. private _calculateSize;
  64719. /**
  64720. * Calculates the UV data for the frames.
  64721. * @param baseSize the base frameSize
  64722. * @param padding the base frame padding
  64723. * @param dtSize size of the Dynamic Texture for that channel
  64724. * @param dtUnits is 1/dtSize
  64725. * @param update flag to update the input meshes
  64726. */
  64727. private _calculateMeshUVFrames;
  64728. /**
  64729. * Calculates the frames Offset.
  64730. * @param index of the frame
  64731. * @returns Vector2
  64732. */
  64733. private _getFrameOffset;
  64734. /**
  64735. * Updates a Mesh to the frame data
  64736. * @param mesh that is the target
  64737. * @param frameID or the frame index
  64738. */
  64739. private _updateMeshUV;
  64740. /**
  64741. * Updates a Meshes materials to use the texture packer channels
  64742. * @param m is the mesh to target
  64743. * @param force all channels on the packer to be set.
  64744. */
  64745. private _updateTextureReferences;
  64746. /**
  64747. * Public method to set a Mesh to a frame
  64748. * @param m that is the target
  64749. * @param frameID or the frame index
  64750. * @param updateMaterial trigger for if the Meshes attached Material be updated?
  64751. */
  64752. setMeshToFrame(m: AbstractMesh, frameID: number, updateMaterial?: boolean): void;
  64753. /**
  64754. * Starts the async promise to compile the texture packer.
  64755. * @returns Promise<void>
  64756. */
  64757. processAsync(): Promise<void>;
  64758. /**
  64759. * Disposes all textures associated with this packer
  64760. */
  64761. dispose(): void;
  64762. /**
  64763. * Starts the download process for all the channels converting them to base64 data and embedding it all in a JSON file.
  64764. * @param imageType is the image type to use.
  64765. * @param quality of the image if downloading as jpeg, Ranges from >0 to 1.
  64766. */
  64767. download(imageType?: string, quality?: number): void;
  64768. /**
  64769. * Public method to load a texturePacker JSON file.
  64770. * @param data of the JSON file in string format.
  64771. */
  64772. updateFromJSON(data: string): void;
  64773. }
  64774. }
  64775. declare module "babylonjs/Materials/Textures/Packer/index" {
  64776. export * from "babylonjs/Materials/Textures/Packer/packer";
  64777. export * from "babylonjs/Materials/Textures/Packer/frame";
  64778. }
  64779. declare module "babylonjs/Materials/Textures/Procedurals/customProceduralTexture" {
  64780. import { Scene } from "babylonjs/scene";
  64781. import { Texture } from "babylonjs/Materials/Textures/texture";
  64782. import { ProceduralTexture } from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  64783. /**
  64784. * 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.
  64785. * Custom Procedural textures are the easiest way to create your own procedural in your application.
  64786. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures#creating-custom-procedural-textures
  64787. */
  64788. export class CustomProceduralTexture extends ProceduralTexture {
  64789. private _animate;
  64790. private _time;
  64791. private _config;
  64792. private _texturePath;
  64793. /**
  64794. * Instantiates a new Custom Procedural Texture.
  64795. * 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.
  64796. * Custom Procedural textures are the easiest way to create your own procedural in your application.
  64797. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures#creating-custom-procedural-textures
  64798. * @param name Define the name of the texture
  64799. * @param texturePath Define the folder path containing all the cutom texture related files (config, shaders...)
  64800. * @param size Define the size of the texture to create
  64801. * @param scene Define the scene the texture belongs to
  64802. * @param fallbackTexture Define a fallback texture in case there were issues to create the custom texture
  64803. * @param generateMipMaps Define if the texture should creates mip maps or not
  64804. */
  64805. constructor(name: string, texturePath: string, size: number, scene: Scene, fallbackTexture?: Texture, generateMipMaps?: boolean);
  64806. private _loadJson;
  64807. /**
  64808. * Is the texture ready to be used ? (rendered at least once)
  64809. * @returns true if ready, otherwise, false.
  64810. */
  64811. isReady(): boolean;
  64812. /**
  64813. * Render the texture to its associated render target.
  64814. * @param useCameraPostProcess Define if camera post process should be applied to the texture
  64815. */
  64816. render(useCameraPostProcess?: boolean): void;
  64817. /**
  64818. * Update the list of dependant textures samplers in the shader.
  64819. */
  64820. updateTextures(): void;
  64821. /**
  64822. * Update the uniform values of the procedural texture in the shader.
  64823. */
  64824. updateShaderUniforms(): void;
  64825. /**
  64826. * Define if the texture animates or not.
  64827. */
  64828. get animate(): boolean;
  64829. set animate(value: boolean);
  64830. }
  64831. }
  64832. declare module "babylonjs/Shaders/noise.fragment" {
  64833. /** @hidden */
  64834. export var noisePixelShader: {
  64835. name: string;
  64836. shader: string;
  64837. };
  64838. }
  64839. declare module "babylonjs/Materials/Textures/Procedurals/noiseProceduralTexture" {
  64840. import { Nullable } from "babylonjs/types";
  64841. import { Scene } from "babylonjs/scene";
  64842. import { Texture } from "babylonjs/Materials/Textures/texture";
  64843. import { ProceduralTexture } from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  64844. import "babylonjs/Shaders/noise.fragment";
  64845. /**
  64846. * Class used to generate noise procedural textures
  64847. */
  64848. export class NoiseProceduralTexture extends ProceduralTexture {
  64849. private _time;
  64850. /** Gets or sets a value between 0 and 1 indicating the overall brightness of the texture (default is 0.2) */
  64851. brightness: number;
  64852. /** Defines the number of octaves to process */
  64853. octaves: number;
  64854. /** Defines the level of persistence (0.8 by default) */
  64855. persistence: number;
  64856. /** Gets or sets animation speed factor (default is 1) */
  64857. animationSpeedFactor: number;
  64858. /**
  64859. * Creates a new NoiseProceduralTexture
  64860. * @param name defines the name fo the texture
  64861. * @param size defines the size of the texture (default is 256)
  64862. * @param scene defines the hosting scene
  64863. * @param fallbackTexture defines the texture to use if the NoiseProceduralTexture can't be created
  64864. * @param generateMipMaps defines if mipmaps must be generated (true by default)
  64865. */
  64866. constructor(name: string, size?: number, scene?: Nullable<Scene>, fallbackTexture?: Texture, generateMipMaps?: boolean);
  64867. private _updateShaderUniforms;
  64868. protected _getDefines(): string;
  64869. /** Generate the current state of the procedural texture */
  64870. render(useCameraPostProcess?: boolean): void;
  64871. /**
  64872. * Serializes this noise procedural texture
  64873. * @returns a serialized noise procedural texture object
  64874. */
  64875. serialize(): any;
  64876. /**
  64877. * Clone the texture.
  64878. * @returns the cloned texture
  64879. */
  64880. clone(): NoiseProceduralTexture;
  64881. /**
  64882. * Creates a NoiseProceduralTexture from parsed noise procedural texture data
  64883. * @param parsedTexture defines parsed texture data
  64884. * @param scene defines the current scene
  64885. * @param rootUrl defines the root URL containing noise procedural texture information
  64886. * @returns a parsed NoiseProceduralTexture
  64887. */
  64888. static Parse(parsedTexture: any, scene: Scene): NoiseProceduralTexture;
  64889. }
  64890. }
  64891. declare module "babylonjs/Materials/Textures/Procedurals/index" {
  64892. export * from "babylonjs/Materials/Textures/Procedurals/customProceduralTexture";
  64893. export * from "babylonjs/Materials/Textures/Procedurals/noiseProceduralTexture";
  64894. export * from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  64895. export * from "babylonjs/Materials/Textures/Procedurals/proceduralTextureSceneComponent";
  64896. }
  64897. declare module "babylonjs/Materials/Textures/rawCubeTexture" {
  64898. import { Nullable } from "babylonjs/types";
  64899. import { Scene } from "babylonjs/scene";
  64900. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  64901. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  64902. import { CubeTexture } from "babylonjs/Materials/Textures/cubeTexture";
  64903. import "babylonjs/Engines/Extensions/engine.rawTexture";
  64904. /**
  64905. * Raw cube texture where the raw buffers are passed in
  64906. */
  64907. export class RawCubeTexture extends CubeTexture {
  64908. /**
  64909. * Creates a cube texture where the raw buffers are passed in.
  64910. * @param scene defines the scene the texture is attached to
  64911. * @param data defines the array of data to use to create each face
  64912. * @param size defines the size of the textures
  64913. * @param format defines the format of the data
  64914. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  64915. * @param generateMipMaps defines if the engine should generate the mip levels
  64916. * @param invertY defines if data must be stored with Y axis inverted
  64917. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  64918. * @param compression defines the compression used (null by default)
  64919. */
  64920. constructor(scene: Scene, data: Nullable<ArrayBufferView[]>, size: number, format?: number, type?: number, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, compression?: Nullable<string>);
  64921. /**
  64922. * Updates the raw cube texture.
  64923. * @param data defines the data to store
  64924. * @param format defines the data format
  64925. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  64926. * @param invertY defines if data must be stored with Y axis inverted
  64927. * @param compression defines the compression used (null by default)
  64928. * @param level defines which level of the texture to update
  64929. */
  64930. update(data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression?: Nullable<string>): void;
  64931. /**
  64932. * Updates a raw cube texture with RGBD encoded data.
  64933. * @param data defines the array of data [mipmap][face] to use to create each face
  64934. * @param sphericalPolynomial defines the spherical polynomial for irradiance
  64935. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  64936. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  64937. * @returns a promsie that resolves when the operation is complete
  64938. */
  64939. updateRGBDAsync(data: ArrayBufferView[][], sphericalPolynomial?: Nullable<SphericalPolynomial>, lodScale?: number, lodOffset?: number): Promise<void>;
  64940. /**
  64941. * Clones the raw cube texture.
  64942. * @return a new cube texture
  64943. */
  64944. clone(): CubeTexture;
  64945. /** @hidden */
  64946. static _UpdateRGBDAsync(internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number): Promise<void>;
  64947. }
  64948. }
  64949. declare module "babylonjs/Materials/Textures/rawTexture2DArray" {
  64950. import { Scene } from "babylonjs/scene";
  64951. import { Texture } from "babylonjs/Materials/Textures/texture";
  64952. import "babylonjs/Engines/Extensions/engine.rawTexture";
  64953. /**
  64954. * Class used to store 2D array textures containing user data
  64955. */
  64956. export class RawTexture2DArray extends Texture {
  64957. /** Gets or sets the texture format to use */
  64958. format: number;
  64959. /**
  64960. * Create a new RawTexture2DArray
  64961. * @param data defines the data of the texture
  64962. * @param width defines the width of the texture
  64963. * @param height defines the height of the texture
  64964. * @param depth defines the number of layers of the texture
  64965. * @param format defines the texture format to use
  64966. * @param scene defines the hosting scene
  64967. * @param generateMipMaps defines a boolean indicating if mip levels should be generated (true by default)
  64968. * @param invertY defines if texture must be stored with Y axis inverted
  64969. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  64970. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  64971. */
  64972. constructor(data: ArrayBufferView, width: number, height: number, depth: number,
  64973. /** Gets or sets the texture format to use */
  64974. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, textureType?: number);
  64975. /**
  64976. * Update the texture with new data
  64977. * @param data defines the data to store in the texture
  64978. */
  64979. update(data: ArrayBufferView): void;
  64980. }
  64981. }
  64982. declare module "babylonjs/Materials/Textures/rawTexture3D" {
  64983. import { Scene } from "babylonjs/scene";
  64984. import { Texture } from "babylonjs/Materials/Textures/texture";
  64985. import "babylonjs/Engines/Extensions/engine.rawTexture";
  64986. /**
  64987. * Class used to store 3D textures containing user data
  64988. */
  64989. export class RawTexture3D extends Texture {
  64990. /** Gets or sets the texture format to use */
  64991. format: number;
  64992. /**
  64993. * Create a new RawTexture3D
  64994. * @param data defines the data of the texture
  64995. * @param width defines the width of the texture
  64996. * @param height defines the height of the texture
  64997. * @param depth defines the depth of the texture
  64998. * @param format defines the texture format to use
  64999. * @param scene defines the hosting scene
  65000. * @param generateMipMaps defines a boolean indicating if mip levels should be generated (true by default)
  65001. * @param invertY defines if texture must be stored with Y axis inverted
  65002. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  65003. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  65004. */
  65005. constructor(data: ArrayBufferView, width: number, height: number, depth: number,
  65006. /** Gets or sets the texture format to use */
  65007. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, textureType?: number);
  65008. /**
  65009. * Update the texture with new data
  65010. * @param data defines the data to store in the texture
  65011. */
  65012. update(data: ArrayBufferView): void;
  65013. }
  65014. }
  65015. declare module "babylonjs/Materials/Textures/refractionTexture" {
  65016. import { Scene } from "babylonjs/scene";
  65017. import { Plane } from "babylonjs/Maths/math.plane";
  65018. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  65019. /**
  65020. * Creates a refraction texture used by refraction channel of the standard material.
  65021. * It is like a mirror but to see through a material.
  65022. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  65023. */
  65024. export class RefractionTexture extends RenderTargetTexture {
  65025. /**
  65026. * Define the reflection plane we want to use. The refractionPlane is usually set to the constructed refractor.
  65027. * 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.
  65028. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  65029. */
  65030. refractionPlane: Plane;
  65031. /**
  65032. * Define how deep under the surface we should see.
  65033. */
  65034. depth: number;
  65035. /**
  65036. * Creates a refraction texture used by refraction channel of the standard material.
  65037. * It is like a mirror but to see through a material.
  65038. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  65039. * @param name Define the texture name
  65040. * @param size Define the size of the underlying texture
  65041. * @param scene Define the scene the refraction belongs to
  65042. * @param generateMipMaps Define if we need to generate mips level for the refraction
  65043. */
  65044. constructor(name: string, size: number, scene: Scene, generateMipMaps?: boolean);
  65045. /**
  65046. * Clone the refraction texture.
  65047. * @returns the cloned texture
  65048. */
  65049. clone(): RefractionTexture;
  65050. /**
  65051. * Serialize the texture to a JSON representation you could use in Parse later on
  65052. * @returns the serialized JSON representation
  65053. */
  65054. serialize(): any;
  65055. }
  65056. }
  65057. declare module "babylonjs/Materials/Textures/index" {
  65058. export * from "babylonjs/Materials/Textures/baseTexture";
  65059. export * from "babylonjs/Materials/Textures/baseTexture.polynomial";
  65060. export * from "babylonjs/Materials/Textures/colorGradingTexture";
  65061. export * from "babylonjs/Materials/Textures/cubeTexture";
  65062. export * from "babylonjs/Materials/Textures/dynamicTexture";
  65063. export * from "babylonjs/Materials/Textures/equiRectangularCubeTexture";
  65064. export * from "babylonjs/Materials/Textures/Filtering/hdrFiltering";
  65065. export * from "babylonjs/Materials/Textures/hdrCubeTexture";
  65066. export * from "babylonjs/Materials/Textures/htmlElementTexture";
  65067. export * from "babylonjs/Materials/Textures/internalTexture";
  65068. export * from "babylonjs/Materials/Textures/internalTextureLoader";
  65069. export * from "babylonjs/Materials/Textures/Loaders/index";
  65070. export * from "babylonjs/Materials/Textures/mirrorTexture";
  65071. export * from "babylonjs/Materials/Textures/multiRenderTarget";
  65072. export * from "babylonjs/Materials/Textures/Packer/index";
  65073. export * from "babylonjs/Materials/Textures/Procedurals/index";
  65074. export * from "babylonjs/Materials/Textures/rawCubeTexture";
  65075. export * from "babylonjs/Materials/Textures/rawTexture";
  65076. export * from "babylonjs/Materials/Textures/rawTexture2DArray";
  65077. export * from "babylonjs/Materials/Textures/rawTexture3D";
  65078. export * from "babylonjs/Materials/Textures/refractionTexture";
  65079. export * from "babylonjs/Materials/Textures/renderTargetTexture";
  65080. export * from "babylonjs/Materials/Textures/texture";
  65081. export * from "babylonjs/Materials/Textures/videoTexture";
  65082. }
  65083. declare module "babylonjs/Materials/Node/Enums/index" {
  65084. export * from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  65085. export * from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  65086. export * from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointMode";
  65087. export * from "babylonjs/Materials/Node/Enums/nodeMaterialSystemValues";
  65088. export * from "babylonjs/Materials/Node/Enums/nodeMaterialModes";
  65089. }
  65090. declare module "babylonjs/Materials/Node/Blocks/Vertex/bonesBlock" {
  65091. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65092. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65093. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65094. import { Mesh } from "babylonjs/Meshes/mesh";
  65095. import { Effect } from "babylonjs/Materials/effect";
  65096. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65097. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65098. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  65099. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  65100. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  65101. /**
  65102. * Block used to add support for vertex skinning (bones)
  65103. */
  65104. export class BonesBlock extends NodeMaterialBlock {
  65105. /**
  65106. * Creates a new BonesBlock
  65107. * @param name defines the block name
  65108. */
  65109. constructor(name: string);
  65110. /**
  65111. * Initialize the block and prepare the context for build
  65112. * @param state defines the state that will be used for the build
  65113. */
  65114. initialize(state: NodeMaterialBuildState): void;
  65115. /**
  65116. * Gets the current class name
  65117. * @returns the class name
  65118. */
  65119. getClassName(): string;
  65120. /**
  65121. * Gets the matrix indices input component
  65122. */
  65123. get matricesIndices(): NodeMaterialConnectionPoint;
  65124. /**
  65125. * Gets the matrix weights input component
  65126. */
  65127. get matricesWeights(): NodeMaterialConnectionPoint;
  65128. /**
  65129. * Gets the extra matrix indices input component
  65130. */
  65131. get matricesIndicesExtra(): NodeMaterialConnectionPoint;
  65132. /**
  65133. * Gets the extra matrix weights input component
  65134. */
  65135. get matricesWeightsExtra(): NodeMaterialConnectionPoint;
  65136. /**
  65137. * Gets the world input component
  65138. */
  65139. get world(): NodeMaterialConnectionPoint;
  65140. /**
  65141. * Gets the output component
  65142. */
  65143. get output(): NodeMaterialConnectionPoint;
  65144. autoConfigure(material: NodeMaterial): void;
  65145. provideFallbacks(mesh: AbstractMesh, fallbacks: EffectFallbacks): void;
  65146. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65147. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  65148. protected _buildBlock(state: NodeMaterialBuildState): this;
  65149. }
  65150. }
  65151. declare module "babylonjs/Materials/Node/Blocks/Vertex/instancesBlock" {
  65152. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65153. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65154. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65155. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65156. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65157. import { SubMesh } from "babylonjs/Meshes/subMesh";
  65158. /**
  65159. * Block used to add support for instances
  65160. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  65161. */
  65162. export class InstancesBlock extends NodeMaterialBlock {
  65163. /**
  65164. * Creates a new InstancesBlock
  65165. * @param name defines the block name
  65166. */
  65167. constructor(name: string);
  65168. /**
  65169. * Gets the current class name
  65170. * @returns the class name
  65171. */
  65172. getClassName(): string;
  65173. /**
  65174. * Gets the first world row input component
  65175. */
  65176. get world0(): NodeMaterialConnectionPoint;
  65177. /**
  65178. * Gets the second world row input component
  65179. */
  65180. get world1(): NodeMaterialConnectionPoint;
  65181. /**
  65182. * Gets the third world row input component
  65183. */
  65184. get world2(): NodeMaterialConnectionPoint;
  65185. /**
  65186. * Gets the forth world row input component
  65187. */
  65188. get world3(): NodeMaterialConnectionPoint;
  65189. /**
  65190. * Gets the world input component
  65191. */
  65192. get world(): NodeMaterialConnectionPoint;
  65193. /**
  65194. * Gets the output component
  65195. */
  65196. get output(): NodeMaterialConnectionPoint;
  65197. /**
  65198. * Gets the isntanceID component
  65199. */
  65200. get instanceID(): NodeMaterialConnectionPoint;
  65201. autoConfigure(material: NodeMaterial): void;
  65202. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  65203. protected _buildBlock(state: NodeMaterialBuildState): this;
  65204. }
  65205. }
  65206. declare module "babylonjs/Materials/Node/Blocks/Vertex/morphTargetsBlock" {
  65207. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65208. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65209. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65210. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65211. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65212. import { Effect } from "babylonjs/Materials/effect";
  65213. import { Mesh } from "babylonjs/Meshes/mesh";
  65214. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  65215. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  65216. /**
  65217. * Block used to add morph targets support to vertex shader
  65218. */
  65219. export class MorphTargetsBlock extends NodeMaterialBlock {
  65220. private _repeatableContentAnchor;
  65221. /**
  65222. * Create a new MorphTargetsBlock
  65223. * @param name defines the block name
  65224. */
  65225. constructor(name: string);
  65226. /**
  65227. * Gets the current class name
  65228. * @returns the class name
  65229. */
  65230. getClassName(): string;
  65231. /**
  65232. * Gets the position input component
  65233. */
  65234. get position(): NodeMaterialConnectionPoint;
  65235. /**
  65236. * Gets the normal input component
  65237. */
  65238. get normal(): NodeMaterialConnectionPoint;
  65239. /**
  65240. * Gets the tangent input component
  65241. */
  65242. get tangent(): NodeMaterialConnectionPoint;
  65243. /**
  65244. * Gets the tangent input component
  65245. */
  65246. get uv(): NodeMaterialConnectionPoint;
  65247. /**
  65248. * Gets the position output component
  65249. */
  65250. get positionOutput(): NodeMaterialConnectionPoint;
  65251. /**
  65252. * Gets the normal output component
  65253. */
  65254. get normalOutput(): NodeMaterialConnectionPoint;
  65255. /**
  65256. * Gets the tangent output component
  65257. */
  65258. get tangentOutput(): NodeMaterialConnectionPoint;
  65259. /**
  65260. * Gets the tangent output component
  65261. */
  65262. get uvOutput(): NodeMaterialConnectionPoint;
  65263. initialize(state: NodeMaterialBuildState): void;
  65264. autoConfigure(material: NodeMaterial): void;
  65265. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  65266. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65267. replaceRepeatableContent(vertexShaderState: NodeMaterialBuildState, fragmentShaderState: NodeMaterialBuildState, mesh: AbstractMesh, defines: NodeMaterialDefines): void;
  65268. protected _buildBlock(state: NodeMaterialBuildState): this;
  65269. }
  65270. }
  65271. declare module "babylonjs/Materials/Node/Blocks/Vertex/lightInformationBlock" {
  65272. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65273. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65274. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65275. import { Nullable } from "babylonjs/types";
  65276. import { Scene } from "babylonjs/scene";
  65277. import { Effect } from "babylonjs/Materials/effect";
  65278. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65279. import { Mesh } from "babylonjs/Meshes/mesh";
  65280. import { Light } from "babylonjs/Lights/light";
  65281. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65282. /**
  65283. * Block used to get data information from a light
  65284. */
  65285. export class LightInformationBlock extends NodeMaterialBlock {
  65286. private _lightDataUniformName;
  65287. private _lightColorUniformName;
  65288. private _lightTypeDefineName;
  65289. /**
  65290. * Gets or sets the light associated with this block
  65291. */
  65292. light: Nullable<Light>;
  65293. /**
  65294. * Creates a new LightInformationBlock
  65295. * @param name defines the block name
  65296. */
  65297. constructor(name: string);
  65298. /**
  65299. * Gets the current class name
  65300. * @returns the class name
  65301. */
  65302. getClassName(): string;
  65303. /**
  65304. * Gets the world position input component
  65305. */
  65306. get worldPosition(): NodeMaterialConnectionPoint;
  65307. /**
  65308. * Gets the direction output component
  65309. */
  65310. get direction(): NodeMaterialConnectionPoint;
  65311. /**
  65312. * Gets the direction output component
  65313. */
  65314. get color(): NodeMaterialConnectionPoint;
  65315. /**
  65316. * Gets the direction output component
  65317. */
  65318. get intensity(): NodeMaterialConnectionPoint;
  65319. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65320. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  65321. protected _buildBlock(state: NodeMaterialBuildState): this;
  65322. serialize(): any;
  65323. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  65324. }
  65325. }
  65326. declare module "babylonjs/Materials/Node/Blocks/Vertex/index" {
  65327. export * from "babylonjs/Materials/Node/Blocks/Vertex/vertexOutputBlock";
  65328. export * from "babylonjs/Materials/Node/Blocks/Vertex/bonesBlock";
  65329. export * from "babylonjs/Materials/Node/Blocks/Vertex/instancesBlock";
  65330. export * from "babylonjs/Materials/Node/Blocks/Vertex/morphTargetsBlock";
  65331. export * from "babylonjs/Materials/Node/Blocks/Vertex/lightInformationBlock";
  65332. }
  65333. declare module "babylonjs/Materials/Node/Blocks/Fragment/imageProcessingBlock" {
  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 { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65338. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65339. import { Effect } from "babylonjs/Materials/effect";
  65340. import { Mesh } from "babylonjs/Meshes/mesh";
  65341. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  65342. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  65343. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  65344. /**
  65345. * Block used to add image processing support to fragment shader
  65346. */
  65347. export class ImageProcessingBlock extends NodeMaterialBlock {
  65348. /**
  65349. * Create a new ImageProcessingBlock
  65350. * @param name defines the block name
  65351. */
  65352. constructor(name: string);
  65353. /**
  65354. * Gets the current class name
  65355. * @returns the class name
  65356. */
  65357. getClassName(): string;
  65358. /**
  65359. * Gets the color input component
  65360. */
  65361. get color(): NodeMaterialConnectionPoint;
  65362. /**
  65363. * Gets the output component
  65364. */
  65365. get output(): NodeMaterialConnectionPoint;
  65366. /**
  65367. * Initialize the block and prepare the context for build
  65368. * @param state defines the state that will be used for the build
  65369. */
  65370. initialize(state: NodeMaterialBuildState): void;
  65371. isReady(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): boolean;
  65372. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  65373. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65374. protected _buildBlock(state: NodeMaterialBuildState): this;
  65375. }
  65376. }
  65377. declare module "babylonjs/Materials/Node/Blocks/Fragment/perturbNormalBlock" {
  65378. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65379. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65380. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65381. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65382. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65383. import { Effect } from "babylonjs/Materials/effect";
  65384. import { Mesh } from "babylonjs/Meshes/mesh";
  65385. import { Scene } from "babylonjs/scene";
  65386. import "babylonjs/Shaders/ShadersInclude/bumpFragmentMainFunctions";
  65387. import "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions";
  65388. import "babylonjs/Shaders/ShadersInclude/bumpFragment";
  65389. /**
  65390. * Block used to pertub normals based on a normal map
  65391. */
  65392. export class PerturbNormalBlock extends NodeMaterialBlock {
  65393. private _tangentSpaceParameterName;
  65394. /** Gets or sets a boolean indicating that normal should be inverted on X axis */
  65395. invertX: boolean;
  65396. /** Gets or sets a boolean indicating that normal should be inverted on Y axis */
  65397. invertY: boolean;
  65398. /**
  65399. * Create a new PerturbNormalBlock
  65400. * @param name defines the block name
  65401. */
  65402. constructor(name: string);
  65403. /**
  65404. * Gets the current class name
  65405. * @returns the class name
  65406. */
  65407. getClassName(): string;
  65408. /**
  65409. * Gets the world position input component
  65410. */
  65411. get worldPosition(): NodeMaterialConnectionPoint;
  65412. /**
  65413. * Gets the world normal input component
  65414. */
  65415. get worldNormal(): NodeMaterialConnectionPoint;
  65416. /**
  65417. * Gets the world tangent input component
  65418. */
  65419. get worldTangent(): NodeMaterialConnectionPoint;
  65420. /**
  65421. * Gets the uv input component
  65422. */
  65423. get uv(): NodeMaterialConnectionPoint;
  65424. /**
  65425. * Gets the normal map color input component
  65426. */
  65427. get normalMapColor(): NodeMaterialConnectionPoint;
  65428. /**
  65429. * Gets the strength input component
  65430. */
  65431. get strength(): NodeMaterialConnectionPoint;
  65432. /**
  65433. * Gets the output component
  65434. */
  65435. get output(): NodeMaterialConnectionPoint;
  65436. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  65437. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65438. autoConfigure(material: NodeMaterial): void;
  65439. protected _buildBlock(state: NodeMaterialBuildState): this;
  65440. protected _dumpPropertiesCode(): string;
  65441. serialize(): any;
  65442. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  65443. }
  65444. }
  65445. declare module "babylonjs/Materials/Node/Blocks/Fragment/discardBlock" {
  65446. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65447. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65448. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65449. /**
  65450. * Block used to discard a pixel if a value is smaller than a cutoff
  65451. */
  65452. export class DiscardBlock extends NodeMaterialBlock {
  65453. /**
  65454. * Create a new DiscardBlock
  65455. * @param name defines the block name
  65456. */
  65457. constructor(name: string);
  65458. /**
  65459. * Gets the current class name
  65460. * @returns the class name
  65461. */
  65462. getClassName(): string;
  65463. /**
  65464. * Gets the color input component
  65465. */
  65466. get value(): NodeMaterialConnectionPoint;
  65467. /**
  65468. * Gets the cutoff input component
  65469. */
  65470. get cutoff(): NodeMaterialConnectionPoint;
  65471. protected _buildBlock(state: NodeMaterialBuildState): this;
  65472. }
  65473. }
  65474. declare module "babylonjs/Materials/Node/Blocks/Fragment/frontFacingBlock" {
  65475. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65476. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65477. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65478. /**
  65479. * Block used to test if the fragment shader is front facing
  65480. */
  65481. export class FrontFacingBlock extends NodeMaterialBlock {
  65482. /**
  65483. * Creates a new FrontFacingBlock
  65484. * @param name defines the block name
  65485. */
  65486. constructor(name: string);
  65487. /**
  65488. * Gets the current class name
  65489. * @returns the class name
  65490. */
  65491. getClassName(): string;
  65492. /**
  65493. * Gets the output component
  65494. */
  65495. get output(): NodeMaterialConnectionPoint;
  65496. protected _buildBlock(state: NodeMaterialBuildState): this;
  65497. }
  65498. }
  65499. declare module "babylonjs/Materials/Node/Blocks/Fragment/derivativeBlock" {
  65500. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65501. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65502. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65503. /**
  65504. * Block used to get the derivative value on x and y of a given input
  65505. */
  65506. export class DerivativeBlock extends NodeMaterialBlock {
  65507. /**
  65508. * Create a new DerivativeBlock
  65509. * @param name defines the block name
  65510. */
  65511. constructor(name: string);
  65512. /**
  65513. * Gets the current class name
  65514. * @returns the class name
  65515. */
  65516. getClassName(): string;
  65517. /**
  65518. * Gets the input component
  65519. */
  65520. get input(): NodeMaterialConnectionPoint;
  65521. /**
  65522. * Gets the derivative output on x
  65523. */
  65524. get dx(): NodeMaterialConnectionPoint;
  65525. /**
  65526. * Gets the derivative output on y
  65527. */
  65528. get dy(): NodeMaterialConnectionPoint;
  65529. protected _buildBlock(state: NodeMaterialBuildState): this;
  65530. }
  65531. }
  65532. declare module "babylonjs/Materials/Node/Blocks/Fragment/fragCoordBlock" {
  65533. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65534. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65535. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65536. /**
  65537. * Block used to make gl_FragCoord available
  65538. */
  65539. export class FragCoordBlock extends NodeMaterialBlock {
  65540. /**
  65541. * Creates a new FragCoordBlock
  65542. * @param name defines the block name
  65543. */
  65544. constructor(name: string);
  65545. /**
  65546. * Gets the current class name
  65547. * @returns the class name
  65548. */
  65549. getClassName(): string;
  65550. /**
  65551. * Gets the xy component
  65552. */
  65553. get xy(): NodeMaterialConnectionPoint;
  65554. /**
  65555. * Gets the xyz component
  65556. */
  65557. get xyz(): NodeMaterialConnectionPoint;
  65558. /**
  65559. * Gets the xyzw component
  65560. */
  65561. get xyzw(): NodeMaterialConnectionPoint;
  65562. /**
  65563. * Gets the x component
  65564. */
  65565. get x(): NodeMaterialConnectionPoint;
  65566. /**
  65567. * Gets the y component
  65568. */
  65569. get y(): NodeMaterialConnectionPoint;
  65570. /**
  65571. * Gets the z component
  65572. */
  65573. get z(): NodeMaterialConnectionPoint;
  65574. /**
  65575. * Gets the w component
  65576. */
  65577. get output(): NodeMaterialConnectionPoint;
  65578. protected writeOutputs(state: NodeMaterialBuildState): string;
  65579. protected _buildBlock(state: NodeMaterialBuildState): this;
  65580. }
  65581. }
  65582. declare module "babylonjs/Materials/Node/Blocks/Fragment/screenSizeBlock" {
  65583. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65584. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65585. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65586. import { Effect } from "babylonjs/Materials/effect";
  65587. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  65588. import { Mesh } from "babylonjs/Meshes/mesh";
  65589. /**
  65590. * Block used to get the screen sizes
  65591. */
  65592. export class ScreenSizeBlock extends NodeMaterialBlock {
  65593. private _varName;
  65594. private _scene;
  65595. /**
  65596. * Creates a new ScreenSizeBlock
  65597. * @param name defines the block name
  65598. */
  65599. constructor(name: string);
  65600. /**
  65601. * Gets the current class name
  65602. * @returns the class name
  65603. */
  65604. getClassName(): string;
  65605. /**
  65606. * Gets the xy component
  65607. */
  65608. get xy(): NodeMaterialConnectionPoint;
  65609. /**
  65610. * Gets the x component
  65611. */
  65612. get x(): NodeMaterialConnectionPoint;
  65613. /**
  65614. * Gets the y component
  65615. */
  65616. get y(): NodeMaterialConnectionPoint;
  65617. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65618. protected writeOutputs(state: NodeMaterialBuildState, varName: string): string;
  65619. protected _buildBlock(state: NodeMaterialBuildState): this;
  65620. }
  65621. }
  65622. declare module "babylonjs/Materials/Node/Blocks/Fragment/index" {
  65623. export * from "babylonjs/Materials/Node/Blocks/Fragment/fragmentOutputBlock";
  65624. export * from "babylonjs/Materials/Node/Blocks/Fragment/imageProcessingBlock";
  65625. export * from "babylonjs/Materials/Node/Blocks/Fragment/perturbNormalBlock";
  65626. export * from "babylonjs/Materials/Node/Blocks/Fragment/discardBlock";
  65627. export * from "babylonjs/Materials/Node/Blocks/Fragment/frontFacingBlock";
  65628. export * from "babylonjs/Materials/Node/Blocks/Fragment/derivativeBlock";
  65629. export * from "babylonjs/Materials/Node/Blocks/Fragment/fragCoordBlock";
  65630. export * from "babylonjs/Materials/Node/Blocks/Fragment/screenSizeBlock";
  65631. }
  65632. declare module "babylonjs/Materials/Node/Blocks/Dual/fogBlock" {
  65633. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65634. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65635. import { Mesh } from "babylonjs/Meshes/mesh";
  65636. import { Effect } from "babylonjs/Materials/effect";
  65637. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65638. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65639. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65640. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  65641. /**
  65642. * Block used to add support for scene fog
  65643. */
  65644. export class FogBlock extends NodeMaterialBlock {
  65645. private _fogDistanceName;
  65646. private _fogParameters;
  65647. /**
  65648. * Create a new FogBlock
  65649. * @param name defines the block name
  65650. */
  65651. constructor(name: string);
  65652. /**
  65653. * Gets the current class name
  65654. * @returns the class name
  65655. */
  65656. getClassName(): string;
  65657. /**
  65658. * Gets the world position input component
  65659. */
  65660. get worldPosition(): NodeMaterialConnectionPoint;
  65661. /**
  65662. * Gets the view input component
  65663. */
  65664. get view(): NodeMaterialConnectionPoint;
  65665. /**
  65666. * Gets the color input component
  65667. */
  65668. get input(): NodeMaterialConnectionPoint;
  65669. /**
  65670. * Gets the fog color input component
  65671. */
  65672. get fogColor(): NodeMaterialConnectionPoint;
  65673. /**
  65674. * Gets the output component
  65675. */
  65676. get output(): NodeMaterialConnectionPoint;
  65677. autoConfigure(material: NodeMaterial): void;
  65678. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  65679. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65680. protected _buildBlock(state: NodeMaterialBuildState): this;
  65681. }
  65682. }
  65683. declare module "babylonjs/Materials/Node/Blocks/Dual/lightBlock" {
  65684. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65685. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65686. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65687. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65688. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65689. import { Effect } from "babylonjs/Materials/effect";
  65690. import { Mesh } from "babylonjs/Meshes/mesh";
  65691. import { Light } from "babylonjs/Lights/light";
  65692. import { Nullable } from "babylonjs/types";
  65693. import { Scene } from "babylonjs/scene";
  65694. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  65695. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  65696. import "babylonjs/Shaders/ShadersInclude/lightFragment";
  65697. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  65698. import "babylonjs/Shaders/ShadersInclude/lightsFragmentFunctions";
  65699. import "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions";
  65700. import "babylonjs/Shaders/ShadersInclude/shadowsVertex";
  65701. /**
  65702. * Block used to add light in the fragment shader
  65703. */
  65704. export class LightBlock extends NodeMaterialBlock {
  65705. private _lightId;
  65706. /**
  65707. * Gets or sets the light associated with this block
  65708. */
  65709. light: Nullable<Light>;
  65710. /**
  65711. * Create a new LightBlock
  65712. * @param name defines the block name
  65713. */
  65714. constructor(name: string);
  65715. /**
  65716. * Gets the current class name
  65717. * @returns the class name
  65718. */
  65719. getClassName(): string;
  65720. /**
  65721. * Gets the world position input component
  65722. */
  65723. get worldPosition(): NodeMaterialConnectionPoint;
  65724. /**
  65725. * Gets the world normal input component
  65726. */
  65727. get worldNormal(): NodeMaterialConnectionPoint;
  65728. /**
  65729. * Gets the camera (or eye) position component
  65730. */
  65731. get cameraPosition(): NodeMaterialConnectionPoint;
  65732. /**
  65733. * Gets the glossiness component
  65734. */
  65735. get glossiness(): NodeMaterialConnectionPoint;
  65736. /**
  65737. * Gets the glossinness power component
  65738. */
  65739. get glossPower(): NodeMaterialConnectionPoint;
  65740. /**
  65741. * Gets the diffuse color component
  65742. */
  65743. get diffuseColor(): NodeMaterialConnectionPoint;
  65744. /**
  65745. * Gets the specular color component
  65746. */
  65747. get specularColor(): NodeMaterialConnectionPoint;
  65748. /**
  65749. * Gets the diffuse output component
  65750. */
  65751. get diffuseOutput(): NodeMaterialConnectionPoint;
  65752. /**
  65753. * Gets the specular output component
  65754. */
  65755. get specularOutput(): NodeMaterialConnectionPoint;
  65756. /**
  65757. * Gets the shadow output component
  65758. */
  65759. get shadow(): NodeMaterialConnectionPoint;
  65760. autoConfigure(material: NodeMaterial): void;
  65761. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  65762. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  65763. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65764. private _injectVertexCode;
  65765. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  65766. serialize(): any;
  65767. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  65768. }
  65769. }
  65770. declare module "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBlock" {
  65771. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65772. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65773. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  65774. import { ReflectionTextureBaseBlock } from "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBaseBlock";
  65775. /**
  65776. * Block used to read a reflection texture from a sampler
  65777. */
  65778. export class ReflectionTextureBlock extends ReflectionTextureBaseBlock {
  65779. /**
  65780. * Create a new ReflectionTextureBlock
  65781. * @param name defines the block name
  65782. */
  65783. constructor(name: string);
  65784. /**
  65785. * Gets the current class name
  65786. * @returns the class name
  65787. */
  65788. getClassName(): string;
  65789. /**
  65790. * Gets the world position input component
  65791. */
  65792. get position(): NodeMaterialConnectionPoint;
  65793. /**
  65794. * Gets the world position input component
  65795. */
  65796. get worldPosition(): NodeMaterialConnectionPoint;
  65797. /**
  65798. * Gets the world normal input component
  65799. */
  65800. get worldNormal(): NodeMaterialConnectionPoint;
  65801. /**
  65802. * Gets the world input component
  65803. */
  65804. get world(): NodeMaterialConnectionPoint;
  65805. /**
  65806. * Gets the camera (or eye) position component
  65807. */
  65808. get cameraPosition(): NodeMaterialConnectionPoint;
  65809. /**
  65810. * Gets the view input component
  65811. */
  65812. get view(): NodeMaterialConnectionPoint;
  65813. /**
  65814. * Gets the rgb output component
  65815. */
  65816. get rgb(): NodeMaterialConnectionPoint;
  65817. /**
  65818. * Gets the rgba output component
  65819. */
  65820. get rgba(): NodeMaterialConnectionPoint;
  65821. /**
  65822. * Gets the r output component
  65823. */
  65824. get r(): NodeMaterialConnectionPoint;
  65825. /**
  65826. * Gets the g output component
  65827. */
  65828. get g(): NodeMaterialConnectionPoint;
  65829. /**
  65830. * Gets the b output component
  65831. */
  65832. get b(): NodeMaterialConnectionPoint;
  65833. /**
  65834. * Gets the a output component
  65835. */
  65836. get a(): NodeMaterialConnectionPoint;
  65837. autoConfigure(material: NodeMaterial): void;
  65838. protected _buildBlock(state: NodeMaterialBuildState): this;
  65839. }
  65840. }
  65841. declare module "babylonjs/Materials/Node/Blocks/Dual/index" {
  65842. export * from "babylonjs/Materials/Node/Blocks/Dual/fogBlock";
  65843. export * from "babylonjs/Materials/Node/Blocks/Dual/lightBlock";
  65844. export * from "babylonjs/Materials/Node/Blocks/Dual/textureBlock";
  65845. export * from "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBlock";
  65846. export * from "babylonjs/Materials/Node/Blocks/Dual/currentScreenBlock";
  65847. }
  65848. declare module "babylonjs/Materials/Node/Blocks/Input/index" {
  65849. export * from "babylonjs/Materials/Node/Blocks/Input/inputBlock";
  65850. export * from "babylonjs/Materials/Node/Blocks/Input/animatedInputBlockTypes";
  65851. }
  65852. declare module "babylonjs/Materials/Node/Blocks/addBlock" {
  65853. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65854. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65855. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65856. /**
  65857. * Block used to add 2 vectors
  65858. */
  65859. export class AddBlock extends NodeMaterialBlock {
  65860. /**
  65861. * Creates a new AddBlock
  65862. * @param name defines the block name
  65863. */
  65864. constructor(name: string);
  65865. /**
  65866. * Gets the current class name
  65867. * @returns the class name
  65868. */
  65869. getClassName(): string;
  65870. /**
  65871. * Gets the left operand input component
  65872. */
  65873. get left(): NodeMaterialConnectionPoint;
  65874. /**
  65875. * Gets the right operand input component
  65876. */
  65877. get right(): NodeMaterialConnectionPoint;
  65878. /**
  65879. * Gets the output component
  65880. */
  65881. get output(): NodeMaterialConnectionPoint;
  65882. protected _buildBlock(state: NodeMaterialBuildState): this;
  65883. }
  65884. }
  65885. declare module "babylonjs/Materials/Node/Blocks/scaleBlock" {
  65886. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65887. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65888. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65889. /**
  65890. * Block used to scale a vector by a float
  65891. */
  65892. export class ScaleBlock extends NodeMaterialBlock {
  65893. /**
  65894. * Creates a new ScaleBlock
  65895. * @param name defines the block name
  65896. */
  65897. constructor(name: string);
  65898. /**
  65899. * Gets the current class name
  65900. * @returns the class name
  65901. */
  65902. getClassName(): string;
  65903. /**
  65904. * Gets the input component
  65905. */
  65906. get input(): NodeMaterialConnectionPoint;
  65907. /**
  65908. * Gets the factor input component
  65909. */
  65910. get factor(): NodeMaterialConnectionPoint;
  65911. /**
  65912. * Gets the output component
  65913. */
  65914. get output(): NodeMaterialConnectionPoint;
  65915. protected _buildBlock(state: NodeMaterialBuildState): this;
  65916. }
  65917. }
  65918. declare module "babylonjs/Materials/Node/Blocks/clampBlock" {
  65919. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65920. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65921. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65922. import { Scene } from "babylonjs/scene";
  65923. /**
  65924. * Block used to clamp a float
  65925. */
  65926. export class ClampBlock extends NodeMaterialBlock {
  65927. /** Gets or sets the minimum range */
  65928. minimum: number;
  65929. /** Gets or sets the maximum range */
  65930. maximum: number;
  65931. /**
  65932. * Creates a new ClampBlock
  65933. * @param name defines the block name
  65934. */
  65935. constructor(name: string);
  65936. /**
  65937. * Gets the current class name
  65938. * @returns the class name
  65939. */
  65940. getClassName(): string;
  65941. /**
  65942. * Gets the value input component
  65943. */
  65944. get value(): NodeMaterialConnectionPoint;
  65945. /**
  65946. * Gets the output component
  65947. */
  65948. get output(): NodeMaterialConnectionPoint;
  65949. protected _buildBlock(state: NodeMaterialBuildState): this;
  65950. protected _dumpPropertiesCode(): string;
  65951. serialize(): any;
  65952. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  65953. }
  65954. }
  65955. declare module "babylonjs/Materials/Node/Blocks/crossBlock" {
  65956. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65957. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65958. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65959. /**
  65960. * Block used to apply a cross product between 2 vectors
  65961. */
  65962. export class CrossBlock extends NodeMaterialBlock {
  65963. /**
  65964. * Creates a new CrossBlock
  65965. * @param name defines the block name
  65966. */
  65967. constructor(name: string);
  65968. /**
  65969. * Gets the current class name
  65970. * @returns the class name
  65971. */
  65972. getClassName(): string;
  65973. /**
  65974. * Gets the left operand input component
  65975. */
  65976. get left(): NodeMaterialConnectionPoint;
  65977. /**
  65978. * Gets the right operand input component
  65979. */
  65980. get right(): NodeMaterialConnectionPoint;
  65981. /**
  65982. * Gets the output component
  65983. */
  65984. get output(): NodeMaterialConnectionPoint;
  65985. protected _buildBlock(state: NodeMaterialBuildState): this;
  65986. }
  65987. }
  65988. declare module "babylonjs/Materials/Node/Blocks/dotBlock" {
  65989. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65990. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65991. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65992. /**
  65993. * Block used to apply a dot product between 2 vectors
  65994. */
  65995. export class DotBlock extends NodeMaterialBlock {
  65996. /**
  65997. * Creates a new DotBlock
  65998. * @param name defines the block name
  65999. */
  66000. constructor(name: string);
  66001. /**
  66002. * Gets the current class name
  66003. * @returns the class name
  66004. */
  66005. getClassName(): string;
  66006. /**
  66007. * Gets the left operand input component
  66008. */
  66009. get left(): NodeMaterialConnectionPoint;
  66010. /**
  66011. * Gets the right operand input component
  66012. */
  66013. get right(): NodeMaterialConnectionPoint;
  66014. /**
  66015. * Gets the output component
  66016. */
  66017. get output(): NodeMaterialConnectionPoint;
  66018. protected _buildBlock(state: NodeMaterialBuildState): this;
  66019. }
  66020. }
  66021. declare module "babylonjs/Materials/Node/Blocks/normalizeBlock" {
  66022. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66023. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66024. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66025. /**
  66026. * Block used to normalize a vector
  66027. */
  66028. export class NormalizeBlock extends NodeMaterialBlock {
  66029. /**
  66030. * Creates a new NormalizeBlock
  66031. * @param name defines the block name
  66032. */
  66033. constructor(name: string);
  66034. /**
  66035. * Gets the current class name
  66036. * @returns the class name
  66037. */
  66038. getClassName(): string;
  66039. /**
  66040. * Gets the input component
  66041. */
  66042. get input(): 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/trigonometryBlock" {
  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. import { Scene } from "babylonjs/scene";
  66055. /**
  66056. * Operations supported by the Trigonometry block
  66057. */
  66058. export enum TrigonometryBlockOperations {
  66059. /** Cos */
  66060. Cos = 0,
  66061. /** Sin */
  66062. Sin = 1,
  66063. /** Abs */
  66064. Abs = 2,
  66065. /** Exp */
  66066. Exp = 3,
  66067. /** Exp2 */
  66068. Exp2 = 4,
  66069. /** Round */
  66070. Round = 5,
  66071. /** Floor */
  66072. Floor = 6,
  66073. /** Ceiling */
  66074. Ceiling = 7,
  66075. /** Square root */
  66076. Sqrt = 8,
  66077. /** Log */
  66078. Log = 9,
  66079. /** Tangent */
  66080. Tan = 10,
  66081. /** Arc tangent */
  66082. ArcTan = 11,
  66083. /** Arc cosinus */
  66084. ArcCos = 12,
  66085. /** Arc sinus */
  66086. ArcSin = 13,
  66087. /** Fraction */
  66088. Fract = 14,
  66089. /** Sign */
  66090. Sign = 15,
  66091. /** To radians (from degrees) */
  66092. Radians = 16,
  66093. /** To degrees (from radians) */
  66094. Degrees = 17
  66095. }
  66096. /**
  66097. * Block used to apply trigonometry operation to floats
  66098. */
  66099. export class TrigonometryBlock extends NodeMaterialBlock {
  66100. /**
  66101. * Gets or sets the operation applied by the block
  66102. */
  66103. operation: TrigonometryBlockOperations;
  66104. /**
  66105. * Creates a new TrigonometryBlock
  66106. * @param name defines the block name
  66107. */
  66108. constructor(name: string);
  66109. /**
  66110. * Gets the current class name
  66111. * @returns the class name
  66112. */
  66113. getClassName(): string;
  66114. /**
  66115. * Gets the input component
  66116. */
  66117. get input(): NodeMaterialConnectionPoint;
  66118. /**
  66119. * Gets the output component
  66120. */
  66121. get output(): NodeMaterialConnectionPoint;
  66122. protected _buildBlock(state: NodeMaterialBuildState): this;
  66123. serialize(): any;
  66124. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  66125. protected _dumpPropertiesCode(): string;
  66126. }
  66127. }
  66128. declare module "babylonjs/Materials/Node/Blocks/colorMergerBlock" {
  66129. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66130. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66131. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66132. /**
  66133. * Block used to create a Color3/4 out of individual inputs (one for each component)
  66134. */
  66135. export class ColorMergerBlock extends NodeMaterialBlock {
  66136. /**
  66137. * Create a new ColorMergerBlock
  66138. * @param name defines the block name
  66139. */
  66140. constructor(name: string);
  66141. /**
  66142. * Gets the current class name
  66143. * @returns the class name
  66144. */
  66145. getClassName(): string;
  66146. /**
  66147. * Gets the rgb component (input)
  66148. */
  66149. get rgbIn(): NodeMaterialConnectionPoint;
  66150. /**
  66151. * Gets the r component (input)
  66152. */
  66153. get r(): NodeMaterialConnectionPoint;
  66154. /**
  66155. * Gets the g component (input)
  66156. */
  66157. get g(): NodeMaterialConnectionPoint;
  66158. /**
  66159. * Gets the b component (input)
  66160. */
  66161. get b(): NodeMaterialConnectionPoint;
  66162. /**
  66163. * Gets the a component (input)
  66164. */
  66165. get a(): NodeMaterialConnectionPoint;
  66166. /**
  66167. * Gets the rgba component (output)
  66168. */
  66169. get rgba(): NodeMaterialConnectionPoint;
  66170. /**
  66171. * Gets the rgb component (output)
  66172. */
  66173. get rgbOut(): NodeMaterialConnectionPoint;
  66174. /**
  66175. * Gets the rgb component (output)
  66176. * @deprecated Please use rgbOut instead.
  66177. */
  66178. get rgb(): NodeMaterialConnectionPoint;
  66179. protected _buildBlock(state: NodeMaterialBuildState): this;
  66180. }
  66181. }
  66182. declare module "babylonjs/Materials/Node/Blocks/vectorSplitterBlock" {
  66183. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66184. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66185. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66186. /**
  66187. * Block used to expand a Vector3/4 into 4 outputs (one for each component)
  66188. */
  66189. export class VectorSplitterBlock extends NodeMaterialBlock {
  66190. /**
  66191. * Create a new VectorSplitterBlock
  66192. * @param name defines the block name
  66193. */
  66194. constructor(name: string);
  66195. /**
  66196. * Gets the current class name
  66197. * @returns the class name
  66198. */
  66199. getClassName(): string;
  66200. /**
  66201. * Gets the xyzw component (input)
  66202. */
  66203. get xyzw(): NodeMaterialConnectionPoint;
  66204. /**
  66205. * Gets the xyz component (input)
  66206. */
  66207. get xyzIn(): NodeMaterialConnectionPoint;
  66208. /**
  66209. * Gets the xy component (input)
  66210. */
  66211. get xyIn(): NodeMaterialConnectionPoint;
  66212. /**
  66213. * Gets the xyz component (output)
  66214. */
  66215. get xyzOut(): NodeMaterialConnectionPoint;
  66216. /**
  66217. * Gets the xy component (output)
  66218. */
  66219. get xyOut(): NodeMaterialConnectionPoint;
  66220. /**
  66221. * Gets the x component (output)
  66222. */
  66223. get x(): NodeMaterialConnectionPoint;
  66224. /**
  66225. * Gets the y component (output)
  66226. */
  66227. get y(): NodeMaterialConnectionPoint;
  66228. /**
  66229. * Gets the z component (output)
  66230. */
  66231. get z(): NodeMaterialConnectionPoint;
  66232. /**
  66233. * Gets the w component (output)
  66234. */
  66235. get w(): NodeMaterialConnectionPoint;
  66236. protected _inputRename(name: string): string;
  66237. protected _outputRename(name: string): string;
  66238. protected _buildBlock(state: NodeMaterialBuildState): this;
  66239. }
  66240. }
  66241. declare module "babylonjs/Materials/Node/Blocks/lerpBlock" {
  66242. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66243. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66244. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66245. /**
  66246. * Block used to lerp between 2 values
  66247. */
  66248. export class LerpBlock extends NodeMaterialBlock {
  66249. /**
  66250. * Creates a new LerpBlock
  66251. * @param name defines the block name
  66252. */
  66253. constructor(name: string);
  66254. /**
  66255. * Gets the current class name
  66256. * @returns the class name
  66257. */
  66258. getClassName(): string;
  66259. /**
  66260. * Gets the left operand input component
  66261. */
  66262. get left(): NodeMaterialConnectionPoint;
  66263. /**
  66264. * Gets the right operand input component
  66265. */
  66266. get right(): NodeMaterialConnectionPoint;
  66267. /**
  66268. * Gets the gradient operand input component
  66269. */
  66270. get gradient(): NodeMaterialConnectionPoint;
  66271. /**
  66272. * Gets the output component
  66273. */
  66274. get output(): NodeMaterialConnectionPoint;
  66275. protected _buildBlock(state: NodeMaterialBuildState): this;
  66276. }
  66277. }
  66278. declare module "babylonjs/Materials/Node/Blocks/divideBlock" {
  66279. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66280. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66281. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66282. /**
  66283. * Block used to divide 2 vectors
  66284. */
  66285. export class DivideBlock extends NodeMaterialBlock {
  66286. /**
  66287. * Creates a new DivideBlock
  66288. * @param name defines the block name
  66289. */
  66290. constructor(name: string);
  66291. /**
  66292. * Gets the current class name
  66293. * @returns the class name
  66294. */
  66295. getClassName(): string;
  66296. /**
  66297. * Gets the left operand input component
  66298. */
  66299. get left(): NodeMaterialConnectionPoint;
  66300. /**
  66301. * Gets the right operand input component
  66302. */
  66303. get right(): NodeMaterialConnectionPoint;
  66304. /**
  66305. * Gets the output component
  66306. */
  66307. get output(): NodeMaterialConnectionPoint;
  66308. protected _buildBlock(state: NodeMaterialBuildState): this;
  66309. }
  66310. }
  66311. declare module "babylonjs/Materials/Node/Blocks/subtractBlock" {
  66312. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66313. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66314. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66315. /**
  66316. * Block used to subtract 2 vectors
  66317. */
  66318. export class SubtractBlock extends NodeMaterialBlock {
  66319. /**
  66320. * Creates a new SubtractBlock
  66321. * @param name defines the block name
  66322. */
  66323. constructor(name: string);
  66324. /**
  66325. * Gets the current class name
  66326. * @returns the class name
  66327. */
  66328. getClassName(): string;
  66329. /**
  66330. * Gets the left operand input component
  66331. */
  66332. get left(): NodeMaterialConnectionPoint;
  66333. /**
  66334. * Gets the right operand input component
  66335. */
  66336. get right(): NodeMaterialConnectionPoint;
  66337. /**
  66338. * Gets the output component
  66339. */
  66340. get output(): NodeMaterialConnectionPoint;
  66341. protected _buildBlock(state: NodeMaterialBuildState): this;
  66342. }
  66343. }
  66344. declare module "babylonjs/Materials/Node/Blocks/stepBlock" {
  66345. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66346. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66347. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66348. /**
  66349. * Block used to step a value
  66350. */
  66351. export class StepBlock extends NodeMaterialBlock {
  66352. /**
  66353. * Creates a new StepBlock
  66354. * @param name defines the block name
  66355. */
  66356. constructor(name: string);
  66357. /**
  66358. * Gets the current class name
  66359. * @returns the class name
  66360. */
  66361. getClassName(): string;
  66362. /**
  66363. * Gets the value operand input component
  66364. */
  66365. get value(): NodeMaterialConnectionPoint;
  66366. /**
  66367. * Gets the edge operand input component
  66368. */
  66369. get edge(): NodeMaterialConnectionPoint;
  66370. /**
  66371. * Gets the output component
  66372. */
  66373. get output(): NodeMaterialConnectionPoint;
  66374. protected _buildBlock(state: NodeMaterialBuildState): this;
  66375. }
  66376. }
  66377. declare module "babylonjs/Materials/Node/Blocks/oneMinusBlock" {
  66378. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66379. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66380. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66381. /**
  66382. * Block used to get the opposite (1 - x) of a value
  66383. */
  66384. export class OneMinusBlock extends NodeMaterialBlock {
  66385. /**
  66386. * Creates a new OneMinusBlock
  66387. * @param name defines the block name
  66388. */
  66389. constructor(name: string);
  66390. /**
  66391. * Gets the current class name
  66392. * @returns the class name
  66393. */
  66394. getClassName(): string;
  66395. /**
  66396. * Gets the input component
  66397. */
  66398. get input(): 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/viewDirectionBlock" {
  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. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  66411. /**
  66412. * Block used to get the view direction
  66413. */
  66414. export class ViewDirectionBlock extends NodeMaterialBlock {
  66415. /**
  66416. * Creates a new ViewDirectionBlock
  66417. * @param name defines the block name
  66418. */
  66419. constructor(name: string);
  66420. /**
  66421. * Gets the current class name
  66422. * @returns the class name
  66423. */
  66424. getClassName(): string;
  66425. /**
  66426. * Gets the world position component
  66427. */
  66428. get worldPosition(): NodeMaterialConnectionPoint;
  66429. /**
  66430. * Gets the camera position component
  66431. */
  66432. get cameraPosition(): NodeMaterialConnectionPoint;
  66433. /**
  66434. * Gets the output component
  66435. */
  66436. get output(): NodeMaterialConnectionPoint;
  66437. autoConfigure(material: NodeMaterial): void;
  66438. protected _buildBlock(state: NodeMaterialBuildState): this;
  66439. }
  66440. }
  66441. declare module "babylonjs/Materials/Node/Blocks/fresnelBlock" {
  66442. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66443. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66444. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66445. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  66446. import "babylonjs/Shaders/ShadersInclude/fresnelFunction";
  66447. /**
  66448. * Block used to compute fresnel value
  66449. */
  66450. export class FresnelBlock extends NodeMaterialBlock {
  66451. /**
  66452. * Create a new FresnelBlock
  66453. * @param name defines the block name
  66454. */
  66455. constructor(name: string);
  66456. /**
  66457. * Gets the current class name
  66458. * @returns the class name
  66459. */
  66460. getClassName(): string;
  66461. /**
  66462. * Gets the world normal input component
  66463. */
  66464. get worldNormal(): NodeMaterialConnectionPoint;
  66465. /**
  66466. * Gets the view direction input component
  66467. */
  66468. get viewDirection(): NodeMaterialConnectionPoint;
  66469. /**
  66470. * Gets the bias input component
  66471. */
  66472. get bias(): NodeMaterialConnectionPoint;
  66473. /**
  66474. * Gets the camera (or eye) position component
  66475. */
  66476. get power(): NodeMaterialConnectionPoint;
  66477. /**
  66478. * Gets the fresnel output component
  66479. */
  66480. get fresnel(): NodeMaterialConnectionPoint;
  66481. autoConfigure(material: NodeMaterial): void;
  66482. protected _buildBlock(state: NodeMaterialBuildState): this;
  66483. }
  66484. }
  66485. declare module "babylonjs/Materials/Node/Blocks/maxBlock" {
  66486. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66487. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66488. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66489. /**
  66490. * Block used to get the max of 2 values
  66491. */
  66492. export class MaxBlock extends NodeMaterialBlock {
  66493. /**
  66494. * Creates a new MaxBlock
  66495. * @param name defines the block name
  66496. */
  66497. constructor(name: string);
  66498. /**
  66499. * Gets the current class name
  66500. * @returns the class name
  66501. */
  66502. getClassName(): string;
  66503. /**
  66504. * Gets the left operand input component
  66505. */
  66506. get left(): NodeMaterialConnectionPoint;
  66507. /**
  66508. * Gets the right operand input component
  66509. */
  66510. get right(): NodeMaterialConnectionPoint;
  66511. /**
  66512. * Gets the output component
  66513. */
  66514. get output(): NodeMaterialConnectionPoint;
  66515. protected _buildBlock(state: NodeMaterialBuildState): this;
  66516. }
  66517. }
  66518. declare module "babylonjs/Materials/Node/Blocks/minBlock" {
  66519. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66520. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66521. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66522. /**
  66523. * Block used to get the min of 2 values
  66524. */
  66525. export class MinBlock extends NodeMaterialBlock {
  66526. /**
  66527. * Creates a new MinBlock
  66528. * @param name defines the block name
  66529. */
  66530. constructor(name: string);
  66531. /**
  66532. * Gets the current class name
  66533. * @returns the class name
  66534. */
  66535. getClassName(): string;
  66536. /**
  66537. * Gets the left operand input component
  66538. */
  66539. get left(): NodeMaterialConnectionPoint;
  66540. /**
  66541. * Gets the right operand input component
  66542. */
  66543. get right(): NodeMaterialConnectionPoint;
  66544. /**
  66545. * Gets the output component
  66546. */
  66547. get output(): NodeMaterialConnectionPoint;
  66548. protected _buildBlock(state: NodeMaterialBuildState): this;
  66549. }
  66550. }
  66551. declare module "babylonjs/Materials/Node/Blocks/distanceBlock" {
  66552. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66553. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66554. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66555. /**
  66556. * Block used to get the distance between 2 values
  66557. */
  66558. export class DistanceBlock extends NodeMaterialBlock {
  66559. /**
  66560. * Creates a new DistanceBlock
  66561. * @param name defines the block name
  66562. */
  66563. constructor(name: string);
  66564. /**
  66565. * Gets the current class name
  66566. * @returns the class name
  66567. */
  66568. getClassName(): string;
  66569. /**
  66570. * Gets the left operand input component
  66571. */
  66572. get left(): NodeMaterialConnectionPoint;
  66573. /**
  66574. * Gets the right operand input component
  66575. */
  66576. get right(): NodeMaterialConnectionPoint;
  66577. /**
  66578. * Gets the output component
  66579. */
  66580. get output(): NodeMaterialConnectionPoint;
  66581. protected _buildBlock(state: NodeMaterialBuildState): this;
  66582. }
  66583. }
  66584. declare module "babylonjs/Materials/Node/Blocks/lengthBlock" {
  66585. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66586. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66587. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66588. /**
  66589. * Block used to get the length of a vector
  66590. */
  66591. export class LengthBlock extends NodeMaterialBlock {
  66592. /**
  66593. * Creates a new LengthBlock
  66594. * @param name defines the block name
  66595. */
  66596. constructor(name: string);
  66597. /**
  66598. * Gets the current class name
  66599. * @returns the class name
  66600. */
  66601. getClassName(): string;
  66602. /**
  66603. * Gets the value input component
  66604. */
  66605. get value(): 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/negateBlock" {
  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 negative version of a value (i.e. x * -1)
  66619. */
  66620. export class NegateBlock extends NodeMaterialBlock {
  66621. /**
  66622. * Creates a new NegateBlock
  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 value input component
  66633. */
  66634. get value(): NodeMaterialConnectionPoint;
  66635. /**
  66636. * Gets the output component
  66637. */
  66638. get output(): NodeMaterialConnectionPoint;
  66639. protected _buildBlock(state: NodeMaterialBuildState): this;
  66640. }
  66641. }
  66642. declare module "babylonjs/Materials/Node/Blocks/powBlock" {
  66643. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66644. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66645. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66646. /**
  66647. * Block used to get the value of the first parameter raised to the power of the second
  66648. */
  66649. export class PowBlock extends NodeMaterialBlock {
  66650. /**
  66651. * Creates a new PowBlock
  66652. * @param name defines the block name
  66653. */
  66654. constructor(name: string);
  66655. /**
  66656. * Gets the current class name
  66657. * @returns the class name
  66658. */
  66659. getClassName(): string;
  66660. /**
  66661. * Gets the value operand input component
  66662. */
  66663. get value(): NodeMaterialConnectionPoint;
  66664. /**
  66665. * Gets the power operand input component
  66666. */
  66667. get power(): 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/randomNumberBlock" {
  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. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  66680. /**
  66681. * Block used to get a random number
  66682. */
  66683. export class RandomNumberBlock extends NodeMaterialBlock {
  66684. /**
  66685. * Creates a new RandomNumberBlock
  66686. * @param name defines the block name
  66687. */
  66688. constructor(name: string);
  66689. /**
  66690. * Gets the current class name
  66691. * @returns the class name
  66692. */
  66693. getClassName(): string;
  66694. /**
  66695. * Gets the seed input component
  66696. */
  66697. get seed(): NodeMaterialConnectionPoint;
  66698. /**
  66699. * Gets the output component
  66700. */
  66701. get output(): NodeMaterialConnectionPoint;
  66702. protected _buildBlock(state: NodeMaterialBuildState): this;
  66703. }
  66704. }
  66705. declare module "babylonjs/Materials/Node/Blocks/arcTan2Block" {
  66706. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66707. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66708. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66709. /**
  66710. * Block used to compute arc tangent of 2 values
  66711. */
  66712. export class ArcTan2Block extends NodeMaterialBlock {
  66713. /**
  66714. * Creates a new ArcTan2Block
  66715. * @param name defines the block name
  66716. */
  66717. constructor(name: string);
  66718. /**
  66719. * Gets the current class name
  66720. * @returns the class name
  66721. */
  66722. getClassName(): string;
  66723. /**
  66724. * Gets the x operand input component
  66725. */
  66726. get x(): NodeMaterialConnectionPoint;
  66727. /**
  66728. * Gets the y operand input component
  66729. */
  66730. get y(): NodeMaterialConnectionPoint;
  66731. /**
  66732. * Gets the output component
  66733. */
  66734. get output(): NodeMaterialConnectionPoint;
  66735. protected _buildBlock(state: NodeMaterialBuildState): this;
  66736. }
  66737. }
  66738. declare module "babylonjs/Materials/Node/Blocks/smoothStepBlock" {
  66739. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66740. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66741. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66742. /**
  66743. * Block used to smooth step a value
  66744. */
  66745. export class SmoothStepBlock extends NodeMaterialBlock {
  66746. /**
  66747. * Creates a new SmoothStepBlock
  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 value operand input component
  66758. */
  66759. get value(): NodeMaterialConnectionPoint;
  66760. /**
  66761. * Gets the first edge operand input component
  66762. */
  66763. get edge0(): NodeMaterialConnectionPoint;
  66764. /**
  66765. * Gets the second edge operand input component
  66766. */
  66767. get edge1(): NodeMaterialConnectionPoint;
  66768. /**
  66769. * Gets the output component
  66770. */
  66771. get output(): NodeMaterialConnectionPoint;
  66772. protected _buildBlock(state: NodeMaterialBuildState): this;
  66773. }
  66774. }
  66775. declare module "babylonjs/Materials/Node/Blocks/reciprocalBlock" {
  66776. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66777. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66778. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66779. /**
  66780. * Block used to get the reciprocal (1 / x) of a value
  66781. */
  66782. export class ReciprocalBlock extends NodeMaterialBlock {
  66783. /**
  66784. * Creates a new ReciprocalBlock
  66785. * @param name defines the block name
  66786. */
  66787. constructor(name: string);
  66788. /**
  66789. * Gets the current class name
  66790. * @returns the class name
  66791. */
  66792. getClassName(): string;
  66793. /**
  66794. * Gets the input component
  66795. */
  66796. get input(): NodeMaterialConnectionPoint;
  66797. /**
  66798. * Gets the output component
  66799. */
  66800. get output(): NodeMaterialConnectionPoint;
  66801. protected _buildBlock(state: NodeMaterialBuildState): this;
  66802. }
  66803. }
  66804. declare module "babylonjs/Materials/Node/Blocks/replaceColorBlock" {
  66805. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66806. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66807. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66808. /**
  66809. * Block used to replace a color by another one
  66810. */
  66811. export class ReplaceColorBlock extends NodeMaterialBlock {
  66812. /**
  66813. * Creates a new ReplaceColorBlock
  66814. * @param name defines the block name
  66815. */
  66816. constructor(name: string);
  66817. /**
  66818. * Gets the current class name
  66819. * @returns the class name
  66820. */
  66821. getClassName(): string;
  66822. /**
  66823. * Gets the value input component
  66824. */
  66825. get value(): NodeMaterialConnectionPoint;
  66826. /**
  66827. * Gets the reference input component
  66828. */
  66829. get reference(): NodeMaterialConnectionPoint;
  66830. /**
  66831. * Gets the distance input component
  66832. */
  66833. get distance(): NodeMaterialConnectionPoint;
  66834. /**
  66835. * Gets the replacement input component
  66836. */
  66837. get replacement(): NodeMaterialConnectionPoint;
  66838. /**
  66839. * Gets the output component
  66840. */
  66841. get output(): NodeMaterialConnectionPoint;
  66842. protected _buildBlock(state: NodeMaterialBuildState): this;
  66843. }
  66844. }
  66845. declare module "babylonjs/Materials/Node/Blocks/posterizeBlock" {
  66846. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66847. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66848. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66849. /**
  66850. * Block used to posterize a value
  66851. * @see https://en.wikipedia.org/wiki/Posterization
  66852. */
  66853. export class PosterizeBlock extends NodeMaterialBlock {
  66854. /**
  66855. * Creates a new PosterizeBlock
  66856. * @param name defines the block name
  66857. */
  66858. constructor(name: string);
  66859. /**
  66860. * Gets the current class name
  66861. * @returns the class name
  66862. */
  66863. getClassName(): string;
  66864. /**
  66865. * Gets the value input component
  66866. */
  66867. get value(): NodeMaterialConnectionPoint;
  66868. /**
  66869. * Gets the steps input component
  66870. */
  66871. get steps(): NodeMaterialConnectionPoint;
  66872. /**
  66873. * Gets the output component
  66874. */
  66875. get output(): NodeMaterialConnectionPoint;
  66876. protected _buildBlock(state: NodeMaterialBuildState): this;
  66877. }
  66878. }
  66879. declare module "babylonjs/Materials/Node/Blocks/waveBlock" {
  66880. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66881. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66882. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66883. import { Scene } from "babylonjs/scene";
  66884. /**
  66885. * Operations supported by the Wave block
  66886. */
  66887. export enum WaveBlockKind {
  66888. /** SawTooth */
  66889. SawTooth = 0,
  66890. /** Square */
  66891. Square = 1,
  66892. /** Triangle */
  66893. Triangle = 2
  66894. }
  66895. /**
  66896. * Block used to apply wave operation to floats
  66897. */
  66898. export class WaveBlock extends NodeMaterialBlock {
  66899. /**
  66900. * Gets or sets the kibnd of wave to be applied by the block
  66901. */
  66902. kind: WaveBlockKind;
  66903. /**
  66904. * Creates a new WaveBlock
  66905. * @param name defines the block name
  66906. */
  66907. constructor(name: string);
  66908. /**
  66909. * Gets the current class name
  66910. * @returns the class name
  66911. */
  66912. getClassName(): string;
  66913. /**
  66914. * Gets the input component
  66915. */
  66916. get input(): NodeMaterialConnectionPoint;
  66917. /**
  66918. * Gets the output component
  66919. */
  66920. get output(): NodeMaterialConnectionPoint;
  66921. protected _buildBlock(state: NodeMaterialBuildState): this;
  66922. serialize(): any;
  66923. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  66924. }
  66925. }
  66926. declare module "babylonjs/Materials/Node/Blocks/gradientBlock" {
  66927. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66928. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66929. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66930. import { Color3 } from "babylonjs/Maths/math.color";
  66931. import { Scene } from "babylonjs/scene";
  66932. /**
  66933. * Class used to store a color step for the GradientBlock
  66934. */
  66935. export class GradientBlockColorStep {
  66936. /**
  66937. * Gets or sets a value indicating which step this color is associated with (between 0 and 1)
  66938. */
  66939. step: number;
  66940. /**
  66941. * Gets or sets the color associated with this step
  66942. */
  66943. color: Color3;
  66944. /**
  66945. * Creates a new GradientBlockColorStep
  66946. * @param step defines a value indicating which step this color is associated with (between 0 and 1)
  66947. * @param color defines the color associated with this step
  66948. */
  66949. constructor(
  66950. /**
  66951. * Gets or sets a value indicating which step this color is associated with (between 0 and 1)
  66952. */
  66953. step: number,
  66954. /**
  66955. * Gets or sets the color associated with this step
  66956. */
  66957. color: Color3);
  66958. }
  66959. /**
  66960. * Block used to return a color from a gradient based on an input value between 0 and 1
  66961. */
  66962. export class GradientBlock extends NodeMaterialBlock {
  66963. /**
  66964. * Gets or sets the list of color steps
  66965. */
  66966. colorSteps: GradientBlockColorStep[];
  66967. /**
  66968. * Creates a new GradientBlock
  66969. * @param name defines the block name
  66970. */
  66971. constructor(name: string);
  66972. /**
  66973. * Gets the current class name
  66974. * @returns the class name
  66975. */
  66976. getClassName(): string;
  66977. /**
  66978. * Gets the gradient input component
  66979. */
  66980. get gradient(): NodeMaterialConnectionPoint;
  66981. /**
  66982. * Gets the output component
  66983. */
  66984. get output(): NodeMaterialConnectionPoint;
  66985. private _writeColorConstant;
  66986. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  66987. serialize(): any;
  66988. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  66989. protected _dumpPropertiesCode(): string;
  66990. }
  66991. }
  66992. declare module "babylonjs/Materials/Node/Blocks/nLerpBlock" {
  66993. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66994. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66995. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66996. /**
  66997. * Block used to normalize lerp between 2 values
  66998. */
  66999. export class NLerpBlock extends NodeMaterialBlock {
  67000. /**
  67001. * Creates a new NLerpBlock
  67002. * @param name defines the block name
  67003. */
  67004. constructor(name: string);
  67005. /**
  67006. * Gets the current class name
  67007. * @returns the class name
  67008. */
  67009. getClassName(): string;
  67010. /**
  67011. * Gets the left operand input component
  67012. */
  67013. get left(): NodeMaterialConnectionPoint;
  67014. /**
  67015. * Gets the right operand input component
  67016. */
  67017. get right(): NodeMaterialConnectionPoint;
  67018. /**
  67019. * Gets the gradient operand input component
  67020. */
  67021. get gradient(): NodeMaterialConnectionPoint;
  67022. /**
  67023. * Gets the output component
  67024. */
  67025. get output(): NodeMaterialConnectionPoint;
  67026. protected _buildBlock(state: NodeMaterialBuildState): this;
  67027. }
  67028. }
  67029. declare module "babylonjs/Materials/Node/Blocks/worleyNoise3DBlock" {
  67030. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67031. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67032. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67033. import { Scene } from "babylonjs/scene";
  67034. /**
  67035. * block used to Generate a Worley Noise 3D Noise Pattern
  67036. */
  67037. export class WorleyNoise3DBlock extends NodeMaterialBlock {
  67038. /** Gets or sets a boolean indicating that normal should be inverted on X axis */
  67039. manhattanDistance: boolean;
  67040. /**
  67041. * Creates a new WorleyNoise3DBlock
  67042. * @param name defines the block name
  67043. */
  67044. constructor(name: string);
  67045. /**
  67046. * Gets the current class name
  67047. * @returns the class name
  67048. */
  67049. getClassName(): string;
  67050. /**
  67051. * Gets the seed input component
  67052. */
  67053. get seed(): NodeMaterialConnectionPoint;
  67054. /**
  67055. * Gets the jitter input component
  67056. */
  67057. get jitter(): NodeMaterialConnectionPoint;
  67058. /**
  67059. * Gets the output component
  67060. */
  67061. get output(): NodeMaterialConnectionPoint;
  67062. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  67063. /**
  67064. * Exposes the properties to the UI?
  67065. */
  67066. protected _dumpPropertiesCode(): string;
  67067. /**
  67068. * Exposes the properties to the Seralize?
  67069. */
  67070. serialize(): any;
  67071. /**
  67072. * Exposes the properties to the deseralize?
  67073. */
  67074. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  67075. }
  67076. }
  67077. declare module "babylonjs/Materials/Node/Blocks/simplexPerlin3DBlock" {
  67078. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67079. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67080. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67081. /**
  67082. * block used to Generate a Simplex Perlin 3d Noise Pattern
  67083. */
  67084. export class SimplexPerlin3DBlock extends NodeMaterialBlock {
  67085. /**
  67086. * Creates a new SimplexPerlin3DBlock
  67087. * @param name defines the block name
  67088. */
  67089. constructor(name: string);
  67090. /**
  67091. * Gets the current class name
  67092. * @returns the class name
  67093. */
  67094. getClassName(): string;
  67095. /**
  67096. * Gets the seed operand input component
  67097. */
  67098. get seed(): NodeMaterialConnectionPoint;
  67099. /**
  67100. * Gets the output component
  67101. */
  67102. get output(): NodeMaterialConnectionPoint;
  67103. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  67104. }
  67105. }
  67106. declare module "babylonjs/Materials/Node/Blocks/normalBlendBlock" {
  67107. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67108. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67109. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67110. /**
  67111. * Block used to blend normals
  67112. */
  67113. export class NormalBlendBlock extends NodeMaterialBlock {
  67114. /**
  67115. * Creates a new NormalBlendBlock
  67116. * @param name defines the block name
  67117. */
  67118. constructor(name: string);
  67119. /**
  67120. * Gets the current class name
  67121. * @returns the class name
  67122. */
  67123. getClassName(): string;
  67124. /**
  67125. * Gets the first input component
  67126. */
  67127. get normalMap0(): NodeMaterialConnectionPoint;
  67128. /**
  67129. * Gets the second input component
  67130. */
  67131. get normalMap1(): NodeMaterialConnectionPoint;
  67132. /**
  67133. * Gets the output component
  67134. */
  67135. get output(): NodeMaterialConnectionPoint;
  67136. protected _buildBlock(state: NodeMaterialBuildState): this;
  67137. }
  67138. }
  67139. declare module "babylonjs/Materials/Node/Blocks/rotate2dBlock" {
  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. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  67144. /**
  67145. * Block used to rotate a 2d vector by a given angle
  67146. */
  67147. export class Rotate2dBlock extends NodeMaterialBlock {
  67148. /**
  67149. * Creates a new Rotate2dBlock
  67150. * @param name defines the block name
  67151. */
  67152. constructor(name: string);
  67153. /**
  67154. * Gets the current class name
  67155. * @returns the class name
  67156. */
  67157. getClassName(): string;
  67158. /**
  67159. * Gets the input vector
  67160. */
  67161. get input(): NodeMaterialConnectionPoint;
  67162. /**
  67163. * Gets the input angle
  67164. */
  67165. get angle(): NodeMaterialConnectionPoint;
  67166. /**
  67167. * Gets the output component
  67168. */
  67169. get output(): NodeMaterialConnectionPoint;
  67170. autoConfigure(material: NodeMaterial): void;
  67171. protected _buildBlock(state: NodeMaterialBuildState): this;
  67172. }
  67173. }
  67174. declare module "babylonjs/Materials/Node/Blocks/reflectBlock" {
  67175. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67176. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67177. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67178. /**
  67179. * Block used to get the reflected vector from a direction and a normal
  67180. */
  67181. export class ReflectBlock extends NodeMaterialBlock {
  67182. /**
  67183. * Creates a new ReflectBlock
  67184. * @param name defines the block name
  67185. */
  67186. constructor(name: string);
  67187. /**
  67188. * Gets the current class name
  67189. * @returns the class name
  67190. */
  67191. getClassName(): string;
  67192. /**
  67193. * Gets the incident component
  67194. */
  67195. get incident(): NodeMaterialConnectionPoint;
  67196. /**
  67197. * Gets the normal component
  67198. */
  67199. get normal(): NodeMaterialConnectionPoint;
  67200. /**
  67201. * Gets the output component
  67202. */
  67203. get output(): NodeMaterialConnectionPoint;
  67204. protected _buildBlock(state: NodeMaterialBuildState): this;
  67205. }
  67206. }
  67207. declare module "babylonjs/Materials/Node/Blocks/refractBlock" {
  67208. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67209. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67210. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67211. /**
  67212. * Block used to get the refracted vector from a direction and a normal
  67213. */
  67214. export class RefractBlock extends NodeMaterialBlock {
  67215. /**
  67216. * Creates a new RefractBlock
  67217. * @param name defines the block name
  67218. */
  67219. constructor(name: string);
  67220. /**
  67221. * Gets the current class name
  67222. * @returns the class name
  67223. */
  67224. getClassName(): string;
  67225. /**
  67226. * Gets the incident component
  67227. */
  67228. get incident(): NodeMaterialConnectionPoint;
  67229. /**
  67230. * Gets the normal component
  67231. */
  67232. get normal(): NodeMaterialConnectionPoint;
  67233. /**
  67234. * Gets the index of refraction component
  67235. */
  67236. get ior(): NodeMaterialConnectionPoint;
  67237. /**
  67238. * Gets the output component
  67239. */
  67240. get output(): NodeMaterialConnectionPoint;
  67241. protected _buildBlock(state: NodeMaterialBuildState): this;
  67242. }
  67243. }
  67244. declare module "babylonjs/Materials/Node/Blocks/desaturateBlock" {
  67245. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67246. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67247. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67248. /**
  67249. * Block used to desaturate a color
  67250. */
  67251. export class DesaturateBlock extends NodeMaterialBlock {
  67252. /**
  67253. * Creates a new DesaturateBlock
  67254. * @param name defines the block name
  67255. */
  67256. constructor(name: string);
  67257. /**
  67258. * Gets the current class name
  67259. * @returns the class name
  67260. */
  67261. getClassName(): string;
  67262. /**
  67263. * Gets the color operand input component
  67264. */
  67265. get color(): NodeMaterialConnectionPoint;
  67266. /**
  67267. * Gets the level operand input component
  67268. */
  67269. get level(): NodeMaterialConnectionPoint;
  67270. /**
  67271. * Gets the output component
  67272. */
  67273. get output(): NodeMaterialConnectionPoint;
  67274. protected _buildBlock(state: NodeMaterialBuildState): this;
  67275. }
  67276. }
  67277. declare module "babylonjs/Materials/Node/Blocks/PBR/ambientOcclusionBlock" {
  67278. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67279. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67280. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67281. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67282. import { Nullable } from "babylonjs/types";
  67283. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67284. import { Scene } from "babylonjs/scene";
  67285. /**
  67286. * Block used to implement the ambient occlusion module of the PBR material
  67287. */
  67288. export class AmbientOcclusionBlock extends NodeMaterialBlock {
  67289. /**
  67290. * Create a new AmbientOcclusionBlock
  67291. * @param name defines the block name
  67292. */
  67293. constructor(name: string);
  67294. /**
  67295. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  67296. */
  67297. useAmbientInGrayScale: boolean;
  67298. /**
  67299. * Initialize the block and prepare the context for build
  67300. * @param state defines the state that will be used for the build
  67301. */
  67302. initialize(state: NodeMaterialBuildState): void;
  67303. /**
  67304. * Gets the current class name
  67305. * @returns the class name
  67306. */
  67307. getClassName(): string;
  67308. /**
  67309. * Gets the texture input component
  67310. */
  67311. get texture(): NodeMaterialConnectionPoint;
  67312. /**
  67313. * Gets the texture intensity component
  67314. */
  67315. get intensity(): NodeMaterialConnectionPoint;
  67316. /**
  67317. * Gets the direct light intensity input component
  67318. */
  67319. get directLightIntensity(): NodeMaterialConnectionPoint;
  67320. /**
  67321. * Gets the ambient occlusion object output component
  67322. */
  67323. get ambientOcclusion(): NodeMaterialConnectionPoint;
  67324. /**
  67325. * Gets the main code of the block (fragment side)
  67326. * @param block instance of an AmbientOcclusionBlock or null if the code must be generated without an active ambient occlusion module
  67327. * @returns the shader code
  67328. */
  67329. static GetCode(block: Nullable<AmbientOcclusionBlock>): string;
  67330. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  67331. protected _buildBlock(state: NodeMaterialBuildState): this;
  67332. protected _dumpPropertiesCode(): string;
  67333. serialize(): any;
  67334. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  67335. }
  67336. }
  67337. declare module "babylonjs/Materials/Node/Blocks/PBR/reflectionBlock" {
  67338. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67339. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67340. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67341. import { ReflectionTextureBaseBlock } from "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBaseBlock";
  67342. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67343. import { Nullable } from "babylonjs/types";
  67344. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  67345. import { Mesh } from "babylonjs/Meshes/mesh";
  67346. import { SubMesh } from "babylonjs/Meshes/subMesh";
  67347. import { Effect } from "babylonjs/Materials/effect";
  67348. import { Scene } from "babylonjs/scene";
  67349. /**
  67350. * Block used to implement the reflection module of the PBR material
  67351. */
  67352. export class ReflectionBlock extends ReflectionTextureBaseBlock {
  67353. /** @hidden */
  67354. _defineLODReflectionAlpha: string;
  67355. /** @hidden */
  67356. _defineLinearSpecularReflection: string;
  67357. private _vEnvironmentIrradianceName;
  67358. /** @hidden */
  67359. _vReflectionMicrosurfaceInfosName: string;
  67360. /** @hidden */
  67361. _vReflectionInfosName: string;
  67362. /** @hidden */
  67363. _vReflectionFilteringInfoName: string;
  67364. private _scene;
  67365. /**
  67366. * The three properties below are set by the main PBR block prior to calling methods of this class.
  67367. * This is to avoid having to add them as inputs here whereas they are already inputs of the main block, so already known.
  67368. * It's less burden on the user side in the editor part.
  67369. */
  67370. /** @hidden */
  67371. worldPositionConnectionPoint: NodeMaterialConnectionPoint;
  67372. /** @hidden */
  67373. worldNormalConnectionPoint: NodeMaterialConnectionPoint;
  67374. /** @hidden */
  67375. cameraPositionConnectionPoint: NodeMaterialConnectionPoint;
  67376. /**
  67377. * Defines if the material uses spherical harmonics vs spherical polynomials for the
  67378. * diffuse part of the IBL.
  67379. */
  67380. useSphericalHarmonics: boolean;
  67381. /**
  67382. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  67383. */
  67384. forceIrradianceInFragment: boolean;
  67385. /**
  67386. * Create a new ReflectionBlock
  67387. * @param name defines the block name
  67388. */
  67389. constructor(name: string);
  67390. /**
  67391. * Gets the current class name
  67392. * @returns the class name
  67393. */
  67394. getClassName(): string;
  67395. /**
  67396. * Gets the position input component
  67397. */
  67398. get position(): NodeMaterialConnectionPoint;
  67399. /**
  67400. * Gets the world position input component
  67401. */
  67402. get worldPosition(): NodeMaterialConnectionPoint;
  67403. /**
  67404. * Gets the world normal input component
  67405. */
  67406. get worldNormal(): NodeMaterialConnectionPoint;
  67407. /**
  67408. * Gets the world input component
  67409. */
  67410. get world(): NodeMaterialConnectionPoint;
  67411. /**
  67412. * Gets the camera (or eye) position component
  67413. */
  67414. get cameraPosition(): NodeMaterialConnectionPoint;
  67415. /**
  67416. * Gets the view input component
  67417. */
  67418. get view(): NodeMaterialConnectionPoint;
  67419. /**
  67420. * Gets the color input component
  67421. */
  67422. get color(): NodeMaterialConnectionPoint;
  67423. /**
  67424. * Gets the reflection object output component
  67425. */
  67426. get reflection(): NodeMaterialConnectionPoint;
  67427. /**
  67428. * Returns true if the block has a texture (either its own texture or the environment texture from the scene, if set)
  67429. */
  67430. get hasTexture(): boolean;
  67431. /**
  67432. * Gets the reflection color (either the name of the variable if the color input is connected, else a default value)
  67433. */
  67434. get reflectionColor(): string;
  67435. protected _getTexture(): Nullable<BaseTexture>;
  67436. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  67437. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  67438. /**
  67439. * Gets the code to inject in the vertex shader
  67440. * @param state current state of the node material building
  67441. * @returns the shader code
  67442. */
  67443. handleVertexSide(state: NodeMaterialBuildState): string;
  67444. /**
  67445. * Gets the main code of the block (fragment side)
  67446. * @param state current state of the node material building
  67447. * @param normalVarName name of the existing variable corresponding to the normal
  67448. * @returns the shader code
  67449. */
  67450. getCode(state: NodeMaterialBuildState, normalVarName: string): string;
  67451. protected _buildBlock(state: NodeMaterialBuildState): this;
  67452. protected _dumpPropertiesCode(): string;
  67453. serialize(): any;
  67454. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  67455. }
  67456. }
  67457. declare module "babylonjs/Materials/Node/Blocks/PBR/sheenBlock" {
  67458. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67459. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67460. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67461. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67462. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67463. import { ReflectionBlock } from "babylonjs/Materials/Node/Blocks/PBR/reflectionBlock";
  67464. import { Scene } from "babylonjs/scene";
  67465. import { Nullable } from "babylonjs/types";
  67466. /**
  67467. * Block used to implement the sheen module of the PBR material
  67468. */
  67469. export class SheenBlock extends NodeMaterialBlock {
  67470. /**
  67471. * Create a new SheenBlock
  67472. * @param name defines the block name
  67473. */
  67474. constructor(name: string);
  67475. /**
  67476. * If true, the sheen effect is layered above the base BRDF with the albedo-scaling technique.
  67477. * It allows the strength of the sheen effect to not depend on the base color of the material,
  67478. * making it easier to setup and tweak the effect
  67479. */
  67480. albedoScaling: boolean;
  67481. /**
  67482. * Defines if the sheen is linked to the sheen color.
  67483. */
  67484. linkSheenWithAlbedo: boolean;
  67485. /**
  67486. * Initialize the block and prepare the context for build
  67487. * @param state defines the state that will be used for the build
  67488. */
  67489. initialize(state: NodeMaterialBuildState): void;
  67490. /**
  67491. * Gets the current class name
  67492. * @returns the class name
  67493. */
  67494. getClassName(): string;
  67495. /**
  67496. * Gets the intensity input component
  67497. */
  67498. get intensity(): NodeMaterialConnectionPoint;
  67499. /**
  67500. * Gets the color input component
  67501. */
  67502. get color(): NodeMaterialConnectionPoint;
  67503. /**
  67504. * Gets the roughness input component
  67505. */
  67506. get roughness(): NodeMaterialConnectionPoint;
  67507. /**
  67508. * Gets the sheen object output component
  67509. */
  67510. get sheen(): NodeMaterialConnectionPoint;
  67511. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  67512. /**
  67513. * Gets the main code of the block (fragment side)
  67514. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  67515. * @returns the shader code
  67516. */
  67517. getCode(reflectionBlock: Nullable<ReflectionBlock>): string;
  67518. protected _buildBlock(state: NodeMaterialBuildState): this;
  67519. protected _dumpPropertiesCode(): string;
  67520. serialize(): any;
  67521. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  67522. }
  67523. }
  67524. declare module "babylonjs/Materials/Node/Blocks/PBR/reflectivityBlock" {
  67525. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67526. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67527. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67528. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67529. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67530. import { Scene } from "babylonjs/scene";
  67531. import { Nullable } from "babylonjs/types";
  67532. import { Mesh } from "babylonjs/Meshes/mesh";
  67533. import { SubMesh } from "babylonjs/Meshes/subMesh";
  67534. import { Effect } from "babylonjs/Materials/effect";
  67535. /**
  67536. * Block used to implement the reflectivity module of the PBR material
  67537. */
  67538. export class ReflectivityBlock extends NodeMaterialBlock {
  67539. private _metallicReflectanceColor;
  67540. private _metallicF0Factor;
  67541. /** @hidden */
  67542. _vMetallicReflectanceFactorsName: string;
  67543. /**
  67544. * The property below is set by the main PBR block prior to calling methods of this class.
  67545. */
  67546. /** @hidden */
  67547. indexOfRefractionConnectionPoint: Nullable<NodeMaterialConnectionPoint>;
  67548. /**
  67549. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  67550. */
  67551. useAmbientOcclusionFromMetallicTextureRed: boolean;
  67552. /**
  67553. * Specifies if the metallic texture contains the metallness information in its blue channel.
  67554. */
  67555. useMetallnessFromMetallicTextureBlue: boolean;
  67556. /**
  67557. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  67558. */
  67559. useRoughnessFromMetallicTextureAlpha: boolean;
  67560. /**
  67561. * Specifies if the metallic texture contains the roughness information in its green channel.
  67562. */
  67563. useRoughnessFromMetallicTextureGreen: boolean;
  67564. /**
  67565. * Create a new ReflectivityBlock
  67566. * @param name defines the block name
  67567. */
  67568. constructor(name: string);
  67569. /**
  67570. * Initialize the block and prepare the context for build
  67571. * @param state defines the state that will be used for the build
  67572. */
  67573. initialize(state: NodeMaterialBuildState): void;
  67574. /**
  67575. * Gets the current class name
  67576. * @returns the class name
  67577. */
  67578. getClassName(): string;
  67579. /**
  67580. * Gets the metallic input component
  67581. */
  67582. get metallic(): NodeMaterialConnectionPoint;
  67583. /**
  67584. * Gets the roughness input component
  67585. */
  67586. get roughness(): NodeMaterialConnectionPoint;
  67587. /**
  67588. * Gets the texture input component
  67589. */
  67590. get texture(): NodeMaterialConnectionPoint;
  67591. /**
  67592. * Gets the reflectivity object output component
  67593. */
  67594. get reflectivity(): NodeMaterialConnectionPoint;
  67595. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  67596. /**
  67597. * Gets the main code of the block (fragment side)
  67598. * @param state current state of the node material building
  67599. * @param aoIntensityVarName name of the variable with the ambient occlusion intensity
  67600. * @returns the shader code
  67601. */
  67602. getCode(state: NodeMaterialBuildState, aoIntensityVarName: string): string;
  67603. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  67604. protected _buildBlock(state: NodeMaterialBuildState): this;
  67605. protected _dumpPropertiesCode(): string;
  67606. serialize(): any;
  67607. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  67608. }
  67609. }
  67610. declare module "babylonjs/Materials/Node/Blocks/PBR/anisotropyBlock" {
  67611. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67612. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67613. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67614. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67615. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67616. /**
  67617. * Block used to implement the anisotropy module of the PBR material
  67618. */
  67619. export class AnisotropyBlock extends NodeMaterialBlock {
  67620. /**
  67621. * The two properties below are set by the main PBR block prior to calling methods of this class.
  67622. * This is to avoid having to add them as inputs here whereas they are already inputs of the main block, so already known.
  67623. * It's less burden on the user side in the editor part.
  67624. */
  67625. /** @hidden */
  67626. worldPositionConnectionPoint: NodeMaterialConnectionPoint;
  67627. /** @hidden */
  67628. worldNormalConnectionPoint: NodeMaterialConnectionPoint;
  67629. /**
  67630. * Create a new AnisotropyBlock
  67631. * @param name defines the block name
  67632. */
  67633. constructor(name: string);
  67634. /**
  67635. * Initialize the block and prepare the context for build
  67636. * @param state defines the state that will be used for the build
  67637. */
  67638. initialize(state: NodeMaterialBuildState): void;
  67639. /**
  67640. * Gets the current class name
  67641. * @returns the class name
  67642. */
  67643. getClassName(): string;
  67644. /**
  67645. * Gets the intensity input component
  67646. */
  67647. get intensity(): NodeMaterialConnectionPoint;
  67648. /**
  67649. * Gets the direction input component
  67650. */
  67651. get direction(): NodeMaterialConnectionPoint;
  67652. /**
  67653. * Gets the texture input component
  67654. */
  67655. get texture(): NodeMaterialConnectionPoint;
  67656. /**
  67657. * Gets the uv input component
  67658. */
  67659. get uv(): NodeMaterialConnectionPoint;
  67660. /**
  67661. * Gets the worldTangent input component
  67662. */
  67663. get worldTangent(): NodeMaterialConnectionPoint;
  67664. /**
  67665. * Gets the anisotropy object output component
  67666. */
  67667. get anisotropy(): NodeMaterialConnectionPoint;
  67668. private _generateTBNSpace;
  67669. /**
  67670. * Gets the main code of the block (fragment side)
  67671. * @param state current state of the node material building
  67672. * @param generateTBNSpace if true, the code needed to create the TBN coordinate space is generated
  67673. * @returns the shader code
  67674. */
  67675. getCode(state: NodeMaterialBuildState, generateTBNSpace?: boolean): string;
  67676. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  67677. protected _buildBlock(state: NodeMaterialBuildState): this;
  67678. }
  67679. }
  67680. declare module "babylonjs/Materials/Node/Blocks/PBR/clearCoatBlock" {
  67681. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67682. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67683. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67684. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67685. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67686. import { ReflectionBlock } from "babylonjs/Materials/Node/Blocks/PBR/reflectionBlock";
  67687. import { Nullable } from "babylonjs/types";
  67688. import { Mesh } from "babylonjs/Meshes/mesh";
  67689. import { SubMesh } from "babylonjs/Meshes/subMesh";
  67690. import { Effect } from "babylonjs/Materials/effect";
  67691. /**
  67692. * Block used to implement the clear coat module of the PBR material
  67693. */
  67694. export class ClearCoatBlock extends NodeMaterialBlock {
  67695. private _scene;
  67696. /**
  67697. * Create a new ClearCoatBlock
  67698. * @param name defines the block name
  67699. */
  67700. constructor(name: string);
  67701. /**
  67702. * Initialize the block and prepare the context for build
  67703. * @param state defines the state that will be used for the build
  67704. */
  67705. initialize(state: NodeMaterialBuildState): void;
  67706. /**
  67707. * Gets the current class name
  67708. * @returns the class name
  67709. */
  67710. getClassName(): string;
  67711. /**
  67712. * Gets the intensity input component
  67713. */
  67714. get intensity(): NodeMaterialConnectionPoint;
  67715. /**
  67716. * Gets the roughness input component
  67717. */
  67718. get roughness(): NodeMaterialConnectionPoint;
  67719. /**
  67720. * Gets the ior input component
  67721. */
  67722. get ior(): NodeMaterialConnectionPoint;
  67723. /**
  67724. * Gets the texture input component
  67725. */
  67726. get texture(): NodeMaterialConnectionPoint;
  67727. /**
  67728. * Gets the bump texture input component
  67729. */
  67730. get bumpTexture(): NodeMaterialConnectionPoint;
  67731. /**
  67732. * Gets the uv input component
  67733. */
  67734. get uv(): NodeMaterialConnectionPoint;
  67735. /**
  67736. * Gets the tint color input component
  67737. */
  67738. get tintColor(): NodeMaterialConnectionPoint;
  67739. /**
  67740. * Gets the tint "at distance" input component
  67741. */
  67742. get tintAtDistance(): NodeMaterialConnectionPoint;
  67743. /**
  67744. * Gets the tint thickness input component
  67745. */
  67746. get tintThickness(): NodeMaterialConnectionPoint;
  67747. /**
  67748. * Gets the world tangent input component
  67749. */
  67750. get worldTangent(): NodeMaterialConnectionPoint;
  67751. /**
  67752. * Gets the clear coat object output component
  67753. */
  67754. get clearcoat(): NodeMaterialConnectionPoint;
  67755. autoConfigure(material: NodeMaterial): void;
  67756. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  67757. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  67758. private _generateTBNSpace;
  67759. /**
  67760. * Gets the main code of the block (fragment side)
  67761. * @param state current state of the node material building
  67762. * @param ccBlock instance of a ClearCoatBlock or null if the code must be generated without an active clear coat module
  67763. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  67764. * @param worldPosVarName name of the variable holding the world position
  67765. * @param generateTBNSpace if true, the code needed to create the TBN coordinate space is generated
  67766. * @param vTBNAvailable indicate that the vTBN variable is already existing because it has already been generated by another block (PerturbNormal or Anisotropy)
  67767. * @param worldNormalVarName name of the variable holding the world normal
  67768. * @returns the shader code
  67769. */
  67770. static GetCode(state: NodeMaterialBuildState, ccBlock: Nullable<ClearCoatBlock>, reflectionBlock: Nullable<ReflectionBlock>, worldPosVarName: string, generateTBNSpace: boolean, vTBNAvailable: boolean, worldNormalVarName: string): string;
  67771. protected _buildBlock(state: NodeMaterialBuildState): this;
  67772. }
  67773. }
  67774. declare module "babylonjs/Materials/Node/Blocks/PBR/subSurfaceBlock" {
  67775. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67776. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67777. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67778. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67779. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67780. import { ReflectionBlock } from "babylonjs/Materials/Node/Blocks/PBR/reflectionBlock";
  67781. import { Nullable } from "babylonjs/types";
  67782. /**
  67783. * Block used to implement the sub surface module of the PBR material
  67784. */
  67785. export class SubSurfaceBlock extends NodeMaterialBlock {
  67786. /**
  67787. * Create a new SubSurfaceBlock
  67788. * @param name defines the block name
  67789. */
  67790. constructor(name: string);
  67791. /**
  67792. * Stores the intensity of the different subsurface effects in the thickness texture.
  67793. * * the green channel is the translucency intensity.
  67794. * * the blue channel is the scattering intensity.
  67795. * * the alpha channel is the refraction intensity.
  67796. */
  67797. useMaskFromThicknessTexture: boolean;
  67798. /**
  67799. * Initialize the block and prepare the context for build
  67800. * @param state defines the state that will be used for the build
  67801. */
  67802. initialize(state: NodeMaterialBuildState): void;
  67803. /**
  67804. * Gets the current class name
  67805. * @returns the class name
  67806. */
  67807. getClassName(): string;
  67808. /**
  67809. * Gets the min thickness input component
  67810. */
  67811. get minThickness(): NodeMaterialConnectionPoint;
  67812. /**
  67813. * Gets the max thickness input component
  67814. */
  67815. get maxThickness(): NodeMaterialConnectionPoint;
  67816. /**
  67817. * Gets the thickness texture component
  67818. */
  67819. get thicknessTexture(): NodeMaterialConnectionPoint;
  67820. /**
  67821. * Gets the tint color input component
  67822. */
  67823. get tintColor(): NodeMaterialConnectionPoint;
  67824. /**
  67825. * Gets the translucency intensity input component
  67826. */
  67827. get translucencyIntensity(): NodeMaterialConnectionPoint;
  67828. /**
  67829. * Gets the translucency diffusion distance input component
  67830. */
  67831. get translucencyDiffusionDistance(): NodeMaterialConnectionPoint;
  67832. /**
  67833. * Gets the refraction object parameters
  67834. */
  67835. get refraction(): NodeMaterialConnectionPoint;
  67836. /**
  67837. * Gets the sub surface object output component
  67838. */
  67839. get subsurface(): NodeMaterialConnectionPoint;
  67840. autoConfigure(material: NodeMaterial): void;
  67841. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  67842. /**
  67843. * Gets the main code of the block (fragment side)
  67844. * @param state current state of the node material building
  67845. * @param ssBlock instance of a SubSurfaceBlock or null if the code must be generated without an active sub surface module
  67846. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  67847. * @param worldPosVarName name of the variable holding the world position
  67848. * @returns the shader code
  67849. */
  67850. static GetCode(state: NodeMaterialBuildState, ssBlock: Nullable<SubSurfaceBlock>, reflectionBlock: Nullable<ReflectionBlock>, worldPosVarName: string): string;
  67851. protected _buildBlock(state: NodeMaterialBuildState): this;
  67852. }
  67853. }
  67854. declare module "babylonjs/Materials/Node/Blocks/PBR/pbrMetallicRoughnessBlock" {
  67855. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67856. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67857. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67858. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67859. import { Light } from "babylonjs/Lights/light";
  67860. import { Nullable } from "babylonjs/types";
  67861. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67862. import { Effect } from "babylonjs/Materials/effect";
  67863. import { Mesh } from "babylonjs/Meshes/mesh";
  67864. import { Scene } from "babylonjs/scene";
  67865. /**
  67866. * Block used to implement the PBR metallic/roughness model
  67867. */
  67868. export class PBRMetallicRoughnessBlock extends NodeMaterialBlock {
  67869. /**
  67870. * Gets or sets the light associated with this block
  67871. */
  67872. light: Nullable<Light>;
  67873. private _lightId;
  67874. private _scene;
  67875. private _environmentBRDFTexture;
  67876. private _environmentBrdfSamplerName;
  67877. private _vNormalWName;
  67878. private _invertNormalName;
  67879. /**
  67880. * Create a new ReflectionBlock
  67881. * @param name defines the block name
  67882. */
  67883. constructor(name: string);
  67884. /**
  67885. * Intensity of the direct lights e.g. the four lights available in your scene.
  67886. * This impacts both the direct diffuse and specular highlights.
  67887. */
  67888. directIntensity: number;
  67889. /**
  67890. * Intensity of the environment e.g. how much the environment will light the object
  67891. * either through harmonics for rough material or through the refelction for shiny ones.
  67892. */
  67893. environmentIntensity: number;
  67894. /**
  67895. * This is a special control allowing the reduction of the specular highlights coming from the
  67896. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  67897. */
  67898. specularIntensity: number;
  67899. /**
  67900. * Defines the falloff type used in this material.
  67901. * It by default is Physical.
  67902. */
  67903. lightFalloff: number;
  67904. /**
  67905. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  67906. */
  67907. useAlphaFromAlbedoTexture: boolean;
  67908. /**
  67909. * Specifies that alpha test should be used
  67910. */
  67911. useAlphaTest: boolean;
  67912. /**
  67913. * Defines the alpha limits in alpha test mode.
  67914. */
  67915. alphaTestCutoff: number;
  67916. /**
  67917. * Specifies that alpha blending should be used
  67918. */
  67919. useAlphaBlending: boolean;
  67920. /**
  67921. * Defines if the alpha value should be determined via the rgb values.
  67922. * If true the luminance of the pixel might be used to find the corresponding alpha value.
  67923. */
  67924. opacityRGB: boolean;
  67925. /**
  67926. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most luminous ones).
  67927. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  67928. */
  67929. useRadianceOverAlpha: boolean;
  67930. /**
  67931. * Specifies that the material will keeps the specular highlights over a transparent surface (only the most luminous ones).
  67932. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  67933. */
  67934. useSpecularOverAlpha: boolean;
  67935. /**
  67936. * Enables specular anti aliasing in the PBR shader.
  67937. * It will both interacts on the Geometry for analytical and IBL lighting.
  67938. * It also prefilter the roughness map based on the bump values.
  67939. */
  67940. enableSpecularAntiAliasing: boolean;
  67941. /**
  67942. * Enables realtime filtering on the texture.
  67943. */
  67944. realTimeFiltering: boolean;
  67945. /**
  67946. * Quality switch for realtime filtering
  67947. */
  67948. realTimeFilteringQuality: number;
  67949. /**
  67950. * Defines if the material uses energy conservation.
  67951. */
  67952. useEnergyConservation: boolean;
  67953. /**
  67954. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  67955. * too much the area relying on ambient texture to define their ambient occlusion.
  67956. */
  67957. useRadianceOcclusion: boolean;
  67958. /**
  67959. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  67960. * makes the reflect vector face the model (under horizon).
  67961. */
  67962. useHorizonOcclusion: boolean;
  67963. /**
  67964. * If set to true, no lighting calculations will be applied.
  67965. */
  67966. unlit: boolean;
  67967. /**
  67968. * Force normal to face away from face.
  67969. */
  67970. forceNormalForward: boolean;
  67971. /**
  67972. * Defines the material debug mode.
  67973. * It helps seeing only some components of the material while troubleshooting.
  67974. */
  67975. debugMode: number;
  67976. /**
  67977. * Specify from where on screen the debug mode should start.
  67978. * The value goes from -1 (full screen) to 1 (not visible)
  67979. * It helps with side by side comparison against the final render
  67980. * This defaults to 0
  67981. */
  67982. debugLimit: number;
  67983. /**
  67984. * As the default viewing range might not be enough (if the ambient is really small for instance)
  67985. * You can use the factor to better multiply the final value.
  67986. */
  67987. debugFactor: number;
  67988. /**
  67989. * Initialize the block and prepare the context for build
  67990. * @param state defines the state that will be used for the build
  67991. */
  67992. initialize(state: NodeMaterialBuildState): void;
  67993. /**
  67994. * Gets the current class name
  67995. * @returns the class name
  67996. */
  67997. getClassName(): string;
  67998. /**
  67999. * Gets the world position input component
  68000. */
  68001. get worldPosition(): NodeMaterialConnectionPoint;
  68002. /**
  68003. * Gets the world normal input component
  68004. */
  68005. get worldNormal(): NodeMaterialConnectionPoint;
  68006. /**
  68007. * Gets the perturbed normal input component
  68008. */
  68009. get perturbedNormal(): NodeMaterialConnectionPoint;
  68010. /**
  68011. * Gets the camera position input component
  68012. */
  68013. get cameraPosition(): NodeMaterialConnectionPoint;
  68014. /**
  68015. * Gets the base color input component
  68016. */
  68017. get baseColor(): NodeMaterialConnectionPoint;
  68018. /**
  68019. * Gets the opacity texture input component
  68020. */
  68021. get opacityTexture(): NodeMaterialConnectionPoint;
  68022. /**
  68023. * Gets the ambient color input component
  68024. */
  68025. get ambientColor(): NodeMaterialConnectionPoint;
  68026. /**
  68027. * Gets the reflectivity object parameters
  68028. */
  68029. get reflectivity(): NodeMaterialConnectionPoint;
  68030. /**
  68031. * Gets the ambient occlusion object parameters
  68032. */
  68033. get ambientOcclusion(): NodeMaterialConnectionPoint;
  68034. /**
  68035. * Gets the reflection object parameters
  68036. */
  68037. get reflection(): NodeMaterialConnectionPoint;
  68038. /**
  68039. * Gets the sheen object parameters
  68040. */
  68041. get sheen(): NodeMaterialConnectionPoint;
  68042. /**
  68043. * Gets the clear coat object parameters
  68044. */
  68045. get clearcoat(): NodeMaterialConnectionPoint;
  68046. /**
  68047. * Gets the sub surface object parameters
  68048. */
  68049. get subsurface(): NodeMaterialConnectionPoint;
  68050. /**
  68051. * Gets the anisotropy object parameters
  68052. */
  68053. get anisotropy(): NodeMaterialConnectionPoint;
  68054. /**
  68055. * Gets the ambient output component
  68056. */
  68057. get ambient(): NodeMaterialConnectionPoint;
  68058. /**
  68059. * Gets the diffuse output component
  68060. */
  68061. get diffuse(): NodeMaterialConnectionPoint;
  68062. /**
  68063. * Gets the specular output component
  68064. */
  68065. get specular(): NodeMaterialConnectionPoint;
  68066. /**
  68067. * Gets the sheen output component
  68068. */
  68069. get sheenDir(): NodeMaterialConnectionPoint;
  68070. /**
  68071. * Gets the clear coat output component
  68072. */
  68073. get clearcoatDir(): NodeMaterialConnectionPoint;
  68074. /**
  68075. * Gets the indirect diffuse output component
  68076. */
  68077. get diffuseIndirect(): NodeMaterialConnectionPoint;
  68078. /**
  68079. * Gets the indirect specular output component
  68080. */
  68081. get specularIndirect(): NodeMaterialConnectionPoint;
  68082. /**
  68083. * Gets the indirect sheen output component
  68084. */
  68085. get sheenIndirect(): NodeMaterialConnectionPoint;
  68086. /**
  68087. * Gets the indirect clear coat output component
  68088. */
  68089. get clearcoatIndirect(): NodeMaterialConnectionPoint;
  68090. /**
  68091. * Gets the refraction output component
  68092. */
  68093. get refraction(): NodeMaterialConnectionPoint;
  68094. /**
  68095. * Gets the global lighting output component
  68096. */
  68097. get lighting(): NodeMaterialConnectionPoint;
  68098. /**
  68099. * Gets the shadow output component
  68100. */
  68101. get shadow(): NodeMaterialConnectionPoint;
  68102. /**
  68103. * Gets the alpha output component
  68104. */
  68105. get alpha(): NodeMaterialConnectionPoint;
  68106. autoConfigure(material: NodeMaterial): void;
  68107. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  68108. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  68109. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  68110. private _injectVertexCode;
  68111. /**
  68112. * Gets the code corresponding to the albedo/opacity module
  68113. * @returns the shader code
  68114. */
  68115. getAlbedoOpacityCode(): string;
  68116. protected _buildBlock(state: NodeMaterialBuildState): this;
  68117. protected _dumpPropertiesCode(): string;
  68118. serialize(): any;
  68119. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  68120. }
  68121. }
  68122. declare module "babylonjs/Materials/Node/Blocks/PBR/index" {
  68123. export * from "babylonjs/Materials/Node/Blocks/PBR/pbrMetallicRoughnessBlock";
  68124. export * from "babylonjs/Materials/Node/Blocks/PBR/sheenBlock";
  68125. export * from "babylonjs/Materials/Node/Blocks/PBR/ambientOcclusionBlock";
  68126. export * from "babylonjs/Materials/Node/Blocks/PBR/reflectivityBlock";
  68127. export * from "babylonjs/Materials/Node/Blocks/PBR/anisotropyBlock";
  68128. export * from "babylonjs/Materials/Node/Blocks/PBR/reflectionBlock";
  68129. export * from "babylonjs/Materials/Node/Blocks/PBR/clearCoatBlock";
  68130. export * from "babylonjs/Materials/Node/Blocks/PBR/refractionBlock";
  68131. export * from "babylonjs/Materials/Node/Blocks/PBR/subSurfaceBlock";
  68132. }
  68133. declare module "babylonjs/Materials/Node/Blocks/Particle/index" {
  68134. export * from "babylonjs/Materials/Node/Blocks/Particle/particleTextureBlock";
  68135. export * from "babylonjs/Materials/Node/Blocks/Particle/particleRampGradientBlock";
  68136. export * from "babylonjs/Materials/Node/Blocks/Particle/particleBlendMultiplyBlock";
  68137. }
  68138. declare module "babylonjs/Materials/Node/Blocks/modBlock" {
  68139. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  68140. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  68141. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  68142. /**
  68143. * Block used to compute value of one parameter modulo another
  68144. */
  68145. export class ModBlock extends NodeMaterialBlock {
  68146. /**
  68147. * Creates a new ModBlock
  68148. * @param name defines the block name
  68149. */
  68150. constructor(name: string);
  68151. /**
  68152. * Gets the current class name
  68153. * @returns the class name
  68154. */
  68155. getClassName(): string;
  68156. /**
  68157. * Gets the left operand input component
  68158. */
  68159. get left(): NodeMaterialConnectionPoint;
  68160. /**
  68161. * Gets the right operand input component
  68162. */
  68163. get right(): NodeMaterialConnectionPoint;
  68164. /**
  68165. * Gets the output component
  68166. */
  68167. get output(): NodeMaterialConnectionPoint;
  68168. protected _buildBlock(state: NodeMaterialBuildState): this;
  68169. }
  68170. }
  68171. declare module "babylonjs/Materials/Node/Blocks/index" {
  68172. export * from "babylonjs/Materials/Node/Blocks/Vertex/index";
  68173. export * from "babylonjs/Materials/Node/Blocks/Fragment/index";
  68174. export * from "babylonjs/Materials/Node/Blocks/Dual/index";
  68175. export * from "babylonjs/Materials/Node/Blocks/Input/index";
  68176. export * from "babylonjs/Materials/Node/Blocks/multiplyBlock";
  68177. export * from "babylonjs/Materials/Node/Blocks/addBlock";
  68178. export * from "babylonjs/Materials/Node/Blocks/scaleBlock";
  68179. export * from "babylonjs/Materials/Node/Blocks/clampBlock";
  68180. export * from "babylonjs/Materials/Node/Blocks/crossBlock";
  68181. export * from "babylonjs/Materials/Node/Blocks/dotBlock";
  68182. export * from "babylonjs/Materials/Node/Blocks/transformBlock";
  68183. export * from "babylonjs/Materials/Node/Blocks/remapBlock";
  68184. export * from "babylonjs/Materials/Node/Blocks/normalizeBlock";
  68185. export * from "babylonjs/Materials/Node/Blocks/trigonometryBlock";
  68186. export * from "babylonjs/Materials/Node/Blocks/colorMergerBlock";
  68187. export * from "babylonjs/Materials/Node/Blocks/vectorMergerBlock";
  68188. export * from "babylonjs/Materials/Node/Blocks/colorSplitterBlock";
  68189. export * from "babylonjs/Materials/Node/Blocks/vectorSplitterBlock";
  68190. export * from "babylonjs/Materials/Node/Blocks/lerpBlock";
  68191. export * from "babylonjs/Materials/Node/Blocks/divideBlock";
  68192. export * from "babylonjs/Materials/Node/Blocks/subtractBlock";
  68193. export * from "babylonjs/Materials/Node/Blocks/stepBlock";
  68194. export * from "babylonjs/Materials/Node/Blocks/oneMinusBlock";
  68195. export * from "babylonjs/Materials/Node/Blocks/viewDirectionBlock";
  68196. export * from "babylonjs/Materials/Node/Blocks/fresnelBlock";
  68197. export * from "babylonjs/Materials/Node/Blocks/maxBlock";
  68198. export * from "babylonjs/Materials/Node/Blocks/minBlock";
  68199. export * from "babylonjs/Materials/Node/Blocks/distanceBlock";
  68200. export * from "babylonjs/Materials/Node/Blocks/lengthBlock";
  68201. export * from "babylonjs/Materials/Node/Blocks/negateBlock";
  68202. export * from "babylonjs/Materials/Node/Blocks/powBlock";
  68203. export * from "babylonjs/Materials/Node/Blocks/randomNumberBlock";
  68204. export * from "babylonjs/Materials/Node/Blocks/arcTan2Block";
  68205. export * from "babylonjs/Materials/Node/Blocks/smoothStepBlock";
  68206. export * from "babylonjs/Materials/Node/Blocks/reciprocalBlock";
  68207. export * from "babylonjs/Materials/Node/Blocks/replaceColorBlock";
  68208. export * from "babylonjs/Materials/Node/Blocks/posterizeBlock";
  68209. export * from "babylonjs/Materials/Node/Blocks/waveBlock";
  68210. export * from "babylonjs/Materials/Node/Blocks/gradientBlock";
  68211. export * from "babylonjs/Materials/Node/Blocks/nLerpBlock";
  68212. export * from "babylonjs/Materials/Node/Blocks/worleyNoise3DBlock";
  68213. export * from "babylonjs/Materials/Node/Blocks/simplexPerlin3DBlock";
  68214. export * from "babylonjs/Materials/Node/Blocks/normalBlendBlock";
  68215. export * from "babylonjs/Materials/Node/Blocks/rotate2dBlock";
  68216. export * from "babylonjs/Materials/Node/Blocks/reflectBlock";
  68217. export * from "babylonjs/Materials/Node/Blocks/refractBlock";
  68218. export * from "babylonjs/Materials/Node/Blocks/desaturateBlock";
  68219. export * from "babylonjs/Materials/Node/Blocks/PBR/index";
  68220. export * from "babylonjs/Materials/Node/Blocks/Particle/index";
  68221. export * from "babylonjs/Materials/Node/Blocks/modBlock";
  68222. }
  68223. declare module "babylonjs/Materials/Node/Optimizers/index" {
  68224. export * from "babylonjs/Materials/Node/Optimizers/nodeMaterialOptimizer";
  68225. }
  68226. declare module "babylonjs/Materials/Node/index" {
  68227. export * from "babylonjs/Materials/Node/Enums/index";
  68228. export * from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  68229. export * from "babylonjs/Materials/Node/nodeMaterialBlock";
  68230. export * from "babylonjs/Materials/Node/nodeMaterial";
  68231. export * from "babylonjs/Materials/Node/Blocks/index";
  68232. export * from "babylonjs/Materials/Node/Optimizers/index";
  68233. export * from "babylonjs/Materials/Node/nodeMaterialDecorator";
  68234. }
  68235. declare module "babylonjs/Materials/index" {
  68236. export * from "babylonjs/Materials/Background/index";
  68237. export * from "babylonjs/Materials/colorCurves";
  68238. export * from "babylonjs/Materials/iEffectFallbacks";
  68239. export * from "babylonjs/Materials/effectFallbacks";
  68240. export * from "babylonjs/Materials/effect";
  68241. export * from "babylonjs/Materials/fresnelParameters";
  68242. export * from "babylonjs/Materials/imageProcessingConfiguration";
  68243. export * from "babylonjs/Materials/material";
  68244. export * from "babylonjs/Materials/materialDefines";
  68245. export * from "babylonjs/Materials/thinMaterialHelper";
  68246. export * from "babylonjs/Materials/materialHelper";
  68247. export * from "babylonjs/Materials/multiMaterial";
  68248. export * from "babylonjs/Materials/PBR/index";
  68249. export * from "babylonjs/Materials/pushMaterial";
  68250. export * from "babylonjs/Materials/shaderMaterial";
  68251. export * from "babylonjs/Materials/standardMaterial";
  68252. export * from "babylonjs/Materials/Textures/index";
  68253. export * from "babylonjs/Materials/uniformBuffer";
  68254. export * from "babylonjs/Materials/materialFlags";
  68255. export * from "babylonjs/Materials/Node/index";
  68256. export * from "babylonjs/Materials/effectRenderer";
  68257. export * from "babylonjs/Materials/shadowDepthWrapper";
  68258. }
  68259. declare module "babylonjs/Maths/index" {
  68260. export * from "babylonjs/Maths/math.scalar";
  68261. export * from "babylonjs/Maths/math";
  68262. export * from "babylonjs/Maths/sphericalPolynomial";
  68263. }
  68264. declare module "babylonjs/Misc/workerPool" {
  68265. import { IDisposable } from "babylonjs/scene";
  68266. /**
  68267. * Helper class to push actions to a pool of workers.
  68268. */
  68269. export class WorkerPool implements IDisposable {
  68270. private _workerInfos;
  68271. private _pendingActions;
  68272. /**
  68273. * Constructor
  68274. * @param workers Array of workers to use for actions
  68275. */
  68276. constructor(workers: Array<Worker>);
  68277. /**
  68278. * Terminates all workers and clears any pending actions.
  68279. */
  68280. dispose(): void;
  68281. /**
  68282. * Pushes an action to the worker pool. If all the workers are active, the action will be
  68283. * pended until a worker has completed its action.
  68284. * @param action The action to perform. Call onComplete when the action is complete.
  68285. */
  68286. push(action: (worker: Worker, onComplete: () => void) => void): void;
  68287. private _execute;
  68288. }
  68289. }
  68290. declare module "babylonjs/Meshes/Compression/dracoCompression" {
  68291. import { IDisposable } from "babylonjs/scene";
  68292. import { VertexData } from "babylonjs/Meshes/mesh.vertexData";
  68293. /**
  68294. * Configuration for Draco compression
  68295. */
  68296. export interface IDracoCompressionConfiguration {
  68297. /**
  68298. * Configuration for the decoder.
  68299. */
  68300. decoder: {
  68301. /**
  68302. * The url to the WebAssembly module.
  68303. */
  68304. wasmUrl?: string;
  68305. /**
  68306. * The url to the WebAssembly binary.
  68307. */
  68308. wasmBinaryUrl?: string;
  68309. /**
  68310. * The url to the fallback JavaScript module.
  68311. */
  68312. fallbackUrl?: string;
  68313. };
  68314. }
  68315. /**
  68316. * Draco compression (https://google.github.io/draco/)
  68317. *
  68318. * This class wraps the Draco module.
  68319. *
  68320. * **Encoder**
  68321. *
  68322. * The encoder is not currently implemented.
  68323. *
  68324. * **Decoder**
  68325. *
  68326. * 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.
  68327. *
  68328. * To update the configuration, use the following code:
  68329. * ```javascript
  68330. * DracoCompression.Configuration = {
  68331. * decoder: {
  68332. * wasmUrl: "<url to the WebAssembly library>",
  68333. * wasmBinaryUrl: "<url to the WebAssembly binary>",
  68334. * fallbackUrl: "<url to the fallback JavaScript library>",
  68335. * }
  68336. * };
  68337. * ```
  68338. *
  68339. * 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.
  68340. * Decoding will automatically fallback to the JavaScript version if WebAssembly version is not configured or if WebAssembly is not supported by the browser.
  68341. * Use `DracoCompression.DecoderAvailable` to determine if the decoder configuration is available for the current context.
  68342. *
  68343. * To decode Draco compressed data, get the default DracoCompression object and call decodeMeshAsync:
  68344. * ```javascript
  68345. * var vertexData = await DracoCompression.Default.decodeMeshAsync(data);
  68346. * ```
  68347. *
  68348. * @see https://www.babylonjs-playground.com/#N3EK4B#0
  68349. */
  68350. export class DracoCompression implements IDisposable {
  68351. private _workerPoolPromise?;
  68352. private _decoderModulePromise?;
  68353. /**
  68354. * The configuration. Defaults to the following urls:
  68355. * - wasmUrl: "https://preview.babylonjs.com/draco_wasm_wrapper_gltf.js"
  68356. * - wasmBinaryUrl: "https://preview.babylonjs.com/draco_decoder_gltf.wasm"
  68357. * - fallbackUrl: "https://preview.babylonjs.com/draco_decoder_gltf.js"
  68358. */
  68359. static Configuration: IDracoCompressionConfiguration;
  68360. /**
  68361. * Returns true if the decoder configuration is available.
  68362. */
  68363. static get DecoderAvailable(): boolean;
  68364. /**
  68365. * Default number of workers to create when creating the draco compression object.
  68366. */
  68367. static DefaultNumWorkers: number;
  68368. private static GetDefaultNumWorkers;
  68369. private static _Default;
  68370. /**
  68371. * Default instance for the draco compression object.
  68372. */
  68373. static get Default(): DracoCompression;
  68374. /**
  68375. * Constructor
  68376. * @param numWorkers The number of workers for async operations. Specify `0` to disable web workers and run synchronously in the current context.
  68377. */
  68378. constructor(numWorkers?: number);
  68379. /**
  68380. * Stop all async operations and release resources.
  68381. */
  68382. dispose(): void;
  68383. /**
  68384. * Returns a promise that resolves when ready. Call this manually to ensure draco compression is ready before use.
  68385. * @returns a promise that resolves when ready
  68386. */
  68387. whenReadyAsync(): Promise<void>;
  68388. /**
  68389. * Decode Draco compressed mesh data to vertex data.
  68390. * @param data The ArrayBuffer or ArrayBufferView for the Draco compression data
  68391. * @param attributes A map of attributes from vertex buffer kinds to Draco unique ids
  68392. * @returns A promise that resolves with the decoded vertex data
  68393. */
  68394. decodeMeshAsync(data: ArrayBuffer | ArrayBufferView, attributes?: {
  68395. [kind: string]: number;
  68396. }): Promise<VertexData>;
  68397. }
  68398. }
  68399. declare module "babylonjs/Meshes/Compression/index" {
  68400. export * from "babylonjs/Meshes/Compression/dracoCompression";
  68401. }
  68402. declare module "babylonjs/Meshes/csg" {
  68403. import { Nullable } from "babylonjs/types";
  68404. import { Scene } from "babylonjs/scene";
  68405. import { Quaternion, Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  68406. import { Mesh } from "babylonjs/Meshes/mesh";
  68407. import { Material } from "babylonjs/Materials/material";
  68408. /**
  68409. * Class for building Constructive Solid Geometry
  68410. */
  68411. export class CSG {
  68412. private polygons;
  68413. /**
  68414. * The world matrix
  68415. */
  68416. matrix: Matrix;
  68417. /**
  68418. * Stores the position
  68419. */
  68420. position: Vector3;
  68421. /**
  68422. * Stores the rotation
  68423. */
  68424. rotation: Vector3;
  68425. /**
  68426. * Stores the rotation quaternion
  68427. */
  68428. rotationQuaternion: Nullable<Quaternion>;
  68429. /**
  68430. * Stores the scaling vector
  68431. */
  68432. scaling: Vector3;
  68433. /**
  68434. * Convert the Mesh to CSG
  68435. * @param mesh The Mesh to convert to CSG
  68436. * @returns A new CSG from the Mesh
  68437. */
  68438. static FromMesh(mesh: Mesh): CSG;
  68439. /**
  68440. * Construct a CSG solid from a list of `CSG.Polygon` instances.
  68441. * @param polygons Polygons used to construct a CSG solid
  68442. */
  68443. private static FromPolygons;
  68444. /**
  68445. * Clones, or makes a deep copy, of the CSG
  68446. * @returns A new CSG
  68447. */
  68448. clone(): CSG;
  68449. /**
  68450. * Unions this CSG with another CSG
  68451. * @param csg The CSG to union against this CSG
  68452. * @returns The unioned CSG
  68453. */
  68454. union(csg: CSG): CSG;
  68455. /**
  68456. * Unions this CSG with another CSG in place
  68457. * @param csg The CSG to union against this CSG
  68458. */
  68459. unionInPlace(csg: CSG): void;
  68460. /**
  68461. * Subtracts this CSG with another CSG
  68462. * @param csg The CSG to subtract against this CSG
  68463. * @returns A new CSG
  68464. */
  68465. subtract(csg: CSG): CSG;
  68466. /**
  68467. * Subtracts this CSG with another CSG in place
  68468. * @param csg The CSG to subtact against this CSG
  68469. */
  68470. subtractInPlace(csg: CSG): void;
  68471. /**
  68472. * Intersect this CSG with another CSG
  68473. * @param csg The CSG to intersect against this CSG
  68474. * @returns A new CSG
  68475. */
  68476. intersect(csg: CSG): CSG;
  68477. /**
  68478. * Intersects this CSG with another CSG in place
  68479. * @param csg The CSG to intersect against this CSG
  68480. */
  68481. intersectInPlace(csg: CSG): void;
  68482. /**
  68483. * Return a new CSG solid with solid and empty space switched. This solid is
  68484. * not modified.
  68485. * @returns A new CSG solid with solid and empty space switched
  68486. */
  68487. inverse(): CSG;
  68488. /**
  68489. * Inverses the CSG in place
  68490. */
  68491. inverseInPlace(): void;
  68492. /**
  68493. * This is used to keep meshes transformations so they can be restored
  68494. * when we build back a Babylon Mesh
  68495. * NB : All CSG operations are performed in world coordinates
  68496. * @param csg The CSG to copy the transform attributes from
  68497. * @returns This CSG
  68498. */
  68499. copyTransformAttributes(csg: CSG): CSG;
  68500. /**
  68501. * Build Raw mesh from CSG
  68502. * Coordinates here are in world space
  68503. * @param name The name of the mesh geometry
  68504. * @param scene The Scene
  68505. * @param keepSubMeshes Specifies if the submeshes should be kept
  68506. * @returns A new Mesh
  68507. */
  68508. buildMeshGeometry(name: string, scene?: Scene, keepSubMeshes?: boolean): Mesh;
  68509. /**
  68510. * Build Mesh from CSG taking material and transforms into account
  68511. * @param name The name of the Mesh
  68512. * @param material The material of the Mesh
  68513. * @param scene The Scene
  68514. * @param keepSubMeshes Specifies if submeshes should be kept
  68515. * @returns The new Mesh
  68516. */
  68517. toMesh(name: string, material?: Nullable<Material>, scene?: Scene, keepSubMeshes?: boolean): Mesh;
  68518. }
  68519. }
  68520. declare module "babylonjs/Meshes/trailMesh" {
  68521. import { Mesh } from "babylonjs/Meshes/mesh";
  68522. import { Scene } from "babylonjs/scene";
  68523. import { TransformNode } from "babylonjs/Meshes/transformNode";
  68524. /**
  68525. * Class used to create a trail following a mesh
  68526. */
  68527. export class TrailMesh extends Mesh {
  68528. private _generator;
  68529. private _autoStart;
  68530. private _running;
  68531. private _diameter;
  68532. private _length;
  68533. private _sectionPolygonPointsCount;
  68534. private _sectionVectors;
  68535. private _sectionNormalVectors;
  68536. private _beforeRenderObserver;
  68537. /**
  68538. * @constructor
  68539. * @param name The value used by scene.getMeshByName() to do a lookup.
  68540. * @param generator The mesh or transform node to generate a trail.
  68541. * @param scene The scene to add this mesh to.
  68542. * @param diameter Diameter of trailing mesh. Default is 1.
  68543. * @param length Length of trailing mesh. Default is 60.
  68544. * @param autoStart Automatically start trailing mesh. Default true.
  68545. */
  68546. constructor(name: string, generator: TransformNode, scene: Scene, diameter?: number, length?: number, autoStart?: boolean);
  68547. /**
  68548. * "TrailMesh"
  68549. * @returns "TrailMesh"
  68550. */
  68551. getClassName(): string;
  68552. private _createMesh;
  68553. /**
  68554. * Start trailing mesh.
  68555. */
  68556. start(): void;
  68557. /**
  68558. * Stop trailing mesh.
  68559. */
  68560. stop(): void;
  68561. /**
  68562. * Update trailing mesh geometry.
  68563. */
  68564. update(): void;
  68565. /**
  68566. * Returns a new TrailMesh object.
  68567. * @param name is a string, the name given to the new mesh
  68568. * @param newGenerator use new generator object for cloned trail mesh
  68569. * @returns a new mesh
  68570. */
  68571. clone(name: string | undefined, newGenerator: TransformNode): TrailMesh;
  68572. /**
  68573. * Serializes this trail mesh
  68574. * @param serializationObject object to write serialization to
  68575. */
  68576. serialize(serializationObject: any): void;
  68577. /**
  68578. * Parses a serialized trail mesh
  68579. * @param parsedMesh the serialized mesh
  68580. * @param scene the scene to create the trail mesh in
  68581. * @returns the created trail mesh
  68582. */
  68583. static Parse(parsedMesh: any, scene: Scene): TrailMesh;
  68584. }
  68585. }
  68586. declare module "babylonjs/Meshes/Builders/tiledBoxBuilder" {
  68587. import { Nullable } from "babylonjs/types";
  68588. import { Scene } from "babylonjs/scene";
  68589. import { Vector4 } from "babylonjs/Maths/math.vector";
  68590. import { Color4 } from "babylonjs/Maths/math.color";
  68591. import { Mesh } from "babylonjs/Meshes/mesh";
  68592. /**
  68593. * Class containing static functions to help procedurally build meshes
  68594. */
  68595. export class TiledBoxBuilder {
  68596. /**
  68597. * Creates a box mesh
  68598. * 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)
  68599. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  68600. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  68601. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  68602. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  68603. * @param name defines the name of the mesh
  68604. * @param options defines the options used to create the mesh
  68605. * @param scene defines the hosting scene
  68606. * @returns the box mesh
  68607. */
  68608. static CreateTiledBox(name: string, options: {
  68609. pattern?: number;
  68610. width?: number;
  68611. height?: number;
  68612. depth?: number;
  68613. tileSize?: number;
  68614. tileWidth?: number;
  68615. tileHeight?: number;
  68616. alignHorizontal?: number;
  68617. alignVertical?: number;
  68618. faceUV?: Vector4[];
  68619. faceColors?: Color4[];
  68620. sideOrientation?: number;
  68621. updatable?: boolean;
  68622. }, scene?: Nullable<Scene>): Mesh;
  68623. }
  68624. }
  68625. declare module "babylonjs/Meshes/Builders/torusKnotBuilder" {
  68626. import { Vector4 } from "babylonjs/Maths/math.vector";
  68627. import { Mesh } from "babylonjs/Meshes/mesh";
  68628. /**
  68629. * Class containing static functions to help procedurally build meshes
  68630. */
  68631. export class TorusKnotBuilder {
  68632. /**
  68633. * Creates a torus knot mesh
  68634. * * The parameter `radius` sets the global radius size (float) of the torus knot (default 2)
  68635. * * The parameter `radialSegments` sets the number of sides on each tube segments (positive integer, default 32)
  68636. * * The parameter `tubularSegments` sets the number of tubes to decompose the knot into (positive integer, default 32)
  68637. * * The parameters `p` and `q` are the number of windings on each axis (positive integers, default 2 and 3)
  68638. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  68639. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  68640. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  68641. * @param name defines the name of the mesh
  68642. * @param options defines the options used to create the mesh
  68643. * @param scene defines the hosting scene
  68644. * @returns the torus knot mesh
  68645. * @see https://doc.babylonjs.com/how_to/set_shapes#torus-knot
  68646. */
  68647. static CreateTorusKnot(name: string, options: {
  68648. radius?: number;
  68649. tube?: number;
  68650. radialSegments?: number;
  68651. tubularSegments?: number;
  68652. p?: number;
  68653. q?: number;
  68654. updatable?: boolean;
  68655. sideOrientation?: number;
  68656. frontUVs?: Vector4;
  68657. backUVs?: Vector4;
  68658. }, scene: any): Mesh;
  68659. }
  68660. }
  68661. declare module "babylonjs/Meshes/polygonMesh" {
  68662. import { Scene } from "babylonjs/scene";
  68663. import { Vector2 } from "babylonjs/Maths/math.vector";
  68664. import { Mesh } from "babylonjs/Meshes/mesh";
  68665. import { VertexData } from "babylonjs/Meshes/mesh.vertexData";
  68666. import { Path2 } from "babylonjs/Maths/math.path";
  68667. /**
  68668. * Polygon
  68669. * @see https://doc.babylonjs.com/how_to/parametric_shapes#non-regular-polygon
  68670. */
  68671. export class Polygon {
  68672. /**
  68673. * Creates a rectangle
  68674. * @param xmin bottom X coord
  68675. * @param ymin bottom Y coord
  68676. * @param xmax top X coord
  68677. * @param ymax top Y coord
  68678. * @returns points that make the resulting rectation
  68679. */
  68680. static Rectangle(xmin: number, ymin: number, xmax: number, ymax: number): Vector2[];
  68681. /**
  68682. * Creates a circle
  68683. * @param radius radius of circle
  68684. * @param cx scale in x
  68685. * @param cy scale in y
  68686. * @param numberOfSides number of sides that make up the circle
  68687. * @returns points that make the resulting circle
  68688. */
  68689. static Circle(radius: number, cx?: number, cy?: number, numberOfSides?: number): Vector2[];
  68690. /**
  68691. * Creates a polygon from input string
  68692. * @param input Input polygon data
  68693. * @returns the parsed points
  68694. */
  68695. static Parse(input: string): Vector2[];
  68696. /**
  68697. * Starts building a polygon from x and y coordinates
  68698. * @param x x coordinate
  68699. * @param y y coordinate
  68700. * @returns the started path2
  68701. */
  68702. static StartingAt(x: number, y: number): Path2;
  68703. }
  68704. /**
  68705. * Builds a polygon
  68706. * @see https://doc.babylonjs.com/how_to/polygonmeshbuilder
  68707. */
  68708. export class PolygonMeshBuilder {
  68709. private _points;
  68710. private _outlinepoints;
  68711. private _holes;
  68712. private _name;
  68713. private _scene;
  68714. private _epoints;
  68715. private _eholes;
  68716. private _addToepoint;
  68717. /**
  68718. * Babylon reference to the earcut plugin.
  68719. */
  68720. bjsEarcut: any;
  68721. /**
  68722. * Creates a PolygonMeshBuilder
  68723. * @param name name of the builder
  68724. * @param contours Path of the polygon
  68725. * @param scene scene to add to when creating the mesh
  68726. * @param earcutInjection can be used to inject your own earcut reference
  68727. */
  68728. constructor(name: string, contours: Path2 | Vector2[] | any, scene?: Scene, earcutInjection?: any);
  68729. /**
  68730. * Adds a whole within the polygon
  68731. * @param hole Array of points defining the hole
  68732. * @returns this
  68733. */
  68734. addHole(hole: Vector2[]): PolygonMeshBuilder;
  68735. /**
  68736. * Creates the polygon
  68737. * @param updatable If the mesh should be updatable
  68738. * @param depth The depth of the mesh created
  68739. * @returns the created mesh
  68740. */
  68741. build(updatable?: boolean, depth?: number): Mesh;
  68742. /**
  68743. * Creates the polygon
  68744. * @param depth The depth of the mesh created
  68745. * @returns the created VertexData
  68746. */
  68747. buildVertexData(depth?: number): VertexData;
  68748. /**
  68749. * Adds a side to the polygon
  68750. * @param positions points that make the polygon
  68751. * @param normals normals of the polygon
  68752. * @param uvs uvs of the polygon
  68753. * @param indices indices of the polygon
  68754. * @param bounds bounds of the polygon
  68755. * @param points points of the polygon
  68756. * @param depth depth of the polygon
  68757. * @param flip flip of the polygon
  68758. */
  68759. private addSide;
  68760. }
  68761. }
  68762. declare module "babylonjs/Meshes/Builders/polygonBuilder" {
  68763. import { Scene } from "babylonjs/scene";
  68764. import { Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  68765. import { Color4 } from "babylonjs/Maths/math.color";
  68766. import { Mesh } from "babylonjs/Meshes/mesh";
  68767. import { Nullable } from "babylonjs/types";
  68768. /**
  68769. * Class containing static functions to help procedurally build meshes
  68770. */
  68771. export class PolygonBuilder {
  68772. /**
  68773. * Creates a polygon mesh
  68774. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh
  68775. * * 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
  68776. * * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  68777. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  68778. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4)
  68779. * * Remember you can only change the shape positions, not their number when updating a polygon
  68780. * @param name defines the name of the mesh
  68781. * @param options defines the options used to create the mesh
  68782. * @param scene defines the hosting scene
  68783. * @param earcutInjection can be used to inject your own earcut reference
  68784. * @returns the polygon mesh
  68785. */
  68786. static CreatePolygon(name: string, options: {
  68787. shape: Vector3[];
  68788. holes?: Vector3[][];
  68789. depth?: number;
  68790. faceUV?: Vector4[];
  68791. faceColors?: Color4[];
  68792. updatable?: boolean;
  68793. sideOrientation?: number;
  68794. frontUVs?: Vector4;
  68795. backUVs?: Vector4;
  68796. wrap?: boolean;
  68797. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  68798. /**
  68799. * Creates an extruded polygon mesh, with depth in the Y direction.
  68800. * * 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)
  68801. * @see https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  68802. * @param name defines the name of the mesh
  68803. * @param options defines the options used to create the mesh
  68804. * @param scene defines the hosting scene
  68805. * @param earcutInjection can be used to inject your own earcut reference
  68806. * @returns the polygon mesh
  68807. */
  68808. static ExtrudePolygon(name: string, options: {
  68809. shape: Vector3[];
  68810. holes?: Vector3[][];
  68811. depth?: number;
  68812. faceUV?: Vector4[];
  68813. faceColors?: Color4[];
  68814. updatable?: boolean;
  68815. sideOrientation?: number;
  68816. frontUVs?: Vector4;
  68817. backUVs?: Vector4;
  68818. wrap?: boolean;
  68819. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  68820. }
  68821. }
  68822. declare module "babylonjs/Meshes/Builders/latheBuilder" {
  68823. import { Scene } from "babylonjs/scene";
  68824. import { Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  68825. import { Mesh } from "babylonjs/Meshes/mesh";
  68826. import { Nullable } from "babylonjs/types";
  68827. /**
  68828. * Class containing static functions to help procedurally build meshes
  68829. */
  68830. export class LatheBuilder {
  68831. /**
  68832. * Creates lathe mesh.
  68833. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe
  68834. * * 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
  68835. * * The parameter `radius` (positive float, default 1) is the radius value of the lathe
  68836. * * The parameter `tessellation` (positive integer, default 64) is the side number of the lathe
  68837. * * The parameter `clip` (positive integer, default 0) is the number of sides to not create without effecting the general shape of the sides
  68838. * * 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
  68839. * * The parameter `closed` (boolean, default true) opens/closes the lathe circumference. This should be set to false when used with the parameter "arc"
  68840. * * 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
  68841. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  68842. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  68843. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  68844. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  68845. * @param name defines the name of the mesh
  68846. * @param options defines the options used to create the mesh
  68847. * @param scene defines the hosting scene
  68848. * @returns the lathe mesh
  68849. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lathe
  68850. */
  68851. static CreateLathe(name: string, options: {
  68852. shape: Vector3[];
  68853. radius?: number;
  68854. tessellation?: number;
  68855. clip?: number;
  68856. arc?: number;
  68857. closed?: boolean;
  68858. updatable?: boolean;
  68859. sideOrientation?: number;
  68860. frontUVs?: Vector4;
  68861. backUVs?: Vector4;
  68862. cap?: number;
  68863. invertUV?: boolean;
  68864. }, scene?: Nullable<Scene>): Mesh;
  68865. }
  68866. }
  68867. declare module "babylonjs/Meshes/Builders/tiledPlaneBuilder" {
  68868. import { Nullable } from "babylonjs/types";
  68869. import { Scene } from "babylonjs/scene";
  68870. import { Vector4 } from "babylonjs/Maths/math.vector";
  68871. import { Mesh } from "babylonjs/Meshes/mesh";
  68872. /**
  68873. * Class containing static functions to help procedurally build meshes
  68874. */
  68875. export class TiledPlaneBuilder {
  68876. /**
  68877. * Creates a tiled plane mesh
  68878. * * The parameter `pattern` will, depending on value, do nothing or
  68879. * * * flip (reflect about central vertical) alternate tiles across and up
  68880. * * * flip every tile on alternate rows
  68881. * * * rotate (180 degs) alternate tiles across and up
  68882. * * * rotate every tile on alternate rows
  68883. * * * flip and rotate alternate tiles across and up
  68884. * * * flip and rotate every tile on alternate rows
  68885. * * The parameter `tileSize` sets the size (float) of each tile side (default 1)
  68886. * * You can set some different tile dimensions by using the parameters `tileWidth` and `tileHeight` (both by default have the same value of `tileSize`)
  68887. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  68888. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  68889. * * 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)
  68890. * * 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)
  68891. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  68892. * @param name defines the name of the mesh
  68893. * @param options defines the options used to create the mesh
  68894. * @param scene defines the hosting scene
  68895. * @returns the box mesh
  68896. */
  68897. static CreateTiledPlane(name: string, options: {
  68898. pattern?: number;
  68899. tileSize?: number;
  68900. tileWidth?: number;
  68901. tileHeight?: number;
  68902. size?: number;
  68903. width?: number;
  68904. height?: number;
  68905. alignHorizontal?: number;
  68906. alignVertical?: number;
  68907. sideOrientation?: number;
  68908. frontUVs?: Vector4;
  68909. backUVs?: Vector4;
  68910. updatable?: boolean;
  68911. }, scene?: Nullable<Scene>): Mesh;
  68912. }
  68913. }
  68914. declare module "babylonjs/Meshes/Builders/tubeBuilder" {
  68915. import { Nullable } from "babylonjs/types";
  68916. import { Scene } from "babylonjs/scene";
  68917. import { Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  68918. import { Mesh } from "babylonjs/Meshes/mesh";
  68919. /**
  68920. * Class containing static functions to help procedurally build meshes
  68921. */
  68922. export class TubeBuilder {
  68923. /**
  68924. * Creates a tube mesh.
  68925. * The tube is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  68926. * * The parameter `path` is a required array of successive Vector3. It is the curve used as the axis of the tube
  68927. * * The parameter `radius` (positive float, default 1) sets the tube radius size
  68928. * * The parameter `tessellation` (positive float, default 64) is the number of sides on the tubular surface
  68929. * * The parameter `radiusFunction` (javascript function, default null) is a vanilla javascript function. If it is not null, it overwrittes the parameter `radius`
  68930. * * 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)
  68931. * * The parameter `arc` (positive float, maximum 1, default 1) is the ratio to apply to the tube circumference : 2 x PI x arc
  68932. * * 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
  68933. * * 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
  68934. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  68935. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  68936. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  68937. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  68938. * @param name defines the name of the mesh
  68939. * @param options defines the options used to create the mesh
  68940. * @param scene defines the hosting scene
  68941. * @returns the tube mesh
  68942. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  68943. * @see https://doc.babylonjs.com/how_to/set_shapes#tube
  68944. */
  68945. static CreateTube(name: string, options: {
  68946. path: Vector3[];
  68947. radius?: number;
  68948. tessellation?: number;
  68949. radiusFunction?: {
  68950. (i: number, distance: number): number;
  68951. };
  68952. cap?: number;
  68953. arc?: number;
  68954. updatable?: boolean;
  68955. sideOrientation?: number;
  68956. frontUVs?: Vector4;
  68957. backUVs?: Vector4;
  68958. instance?: Mesh;
  68959. invertUV?: boolean;
  68960. }, scene?: Nullable<Scene>): Mesh;
  68961. }
  68962. }
  68963. declare module "babylonjs/Meshes/Builders/icoSphereBuilder" {
  68964. import { Scene } from "babylonjs/scene";
  68965. import { Vector4 } from "babylonjs/Maths/math.vector";
  68966. import { Mesh } from "babylonjs/Meshes/mesh";
  68967. import { Nullable } from "babylonjs/types";
  68968. /**
  68969. * Class containing static functions to help procedurally build meshes
  68970. */
  68971. export class IcoSphereBuilder {
  68972. /**
  68973. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  68974. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  68975. * * 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`)
  68976. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  68977. * * 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
  68978. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  68979. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  68980. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  68981. * @param name defines the name of the mesh
  68982. * @param options defines the options used to create the mesh
  68983. * @param scene defines the hosting scene
  68984. * @returns the icosahedron mesh
  68985. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  68986. */
  68987. static CreateIcoSphere(name: string, options: {
  68988. radius?: number;
  68989. radiusX?: number;
  68990. radiusY?: number;
  68991. radiusZ?: number;
  68992. flat?: boolean;
  68993. subdivisions?: number;
  68994. sideOrientation?: number;
  68995. frontUVs?: Vector4;
  68996. backUVs?: Vector4;
  68997. updatable?: boolean;
  68998. }, scene?: Nullable<Scene>): Mesh;
  68999. }
  69000. }
  69001. declare module "babylonjs/Meshes/Builders/decalBuilder" {
  69002. import { Vector3 } from "babylonjs/Maths/math.vector";
  69003. import { Mesh } from "babylonjs/Meshes/mesh";
  69004. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  69005. /**
  69006. * Class containing static functions to help procedurally build meshes
  69007. */
  69008. export class DecalBuilder {
  69009. /**
  69010. * Creates a decal mesh.
  69011. * 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
  69012. * * The parameter `position` (Vector3, default `(0, 0, 0)`) sets the position of the decal in World coordinates
  69013. * * The parameter `normal` (Vector3, default `Vector3.Up`) sets the normal of the mesh where the decal is applied onto in World coordinates
  69014. * * The parameter `size` (Vector3, default `(1, 1, 1)`) sets the decal scaling
  69015. * * The parameter `angle` (float in radian, default 0) sets the angle to rotate the decal
  69016. * @param name defines the name of the mesh
  69017. * @param sourceMesh defines the mesh where the decal must be applied
  69018. * @param options defines the options used to create the mesh
  69019. * @param scene defines the hosting scene
  69020. * @returns the decal mesh
  69021. * @see https://doc.babylonjs.com/how_to/decals
  69022. */
  69023. static CreateDecal(name: string, sourceMesh: AbstractMesh, options: {
  69024. position?: Vector3;
  69025. normal?: Vector3;
  69026. size?: Vector3;
  69027. angle?: number;
  69028. }): Mesh;
  69029. }
  69030. }
  69031. declare module "babylonjs/Meshes/meshBuilder" {
  69032. import { Vector4, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  69033. import { Nullable } from "babylonjs/types";
  69034. import { Scene } from "babylonjs/scene";
  69035. import { Mesh } from "babylonjs/Meshes/mesh";
  69036. import { LinesMesh } from "babylonjs/Meshes/linesMesh";
  69037. import { GroundMesh } from "babylonjs/Meshes/groundMesh";
  69038. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  69039. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  69040. import { Plane } from "babylonjs/Maths/math.plane";
  69041. /**
  69042. * Class containing static functions to help procedurally build meshes
  69043. */
  69044. export class MeshBuilder {
  69045. /**
  69046. * Creates a box mesh
  69047. * * The parameter `size` sets the size (float) of each box side (default 1)
  69048. * * You can set some different box dimensions by using the parameters `width`, `height` and `depth` (all by default have the same value of `size`)
  69049. * * 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)
  69050. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  69051. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69052. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69053. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69054. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  69055. * @param name defines the name of the mesh
  69056. * @param options defines the options used to create the mesh
  69057. * @param scene defines the hosting scene
  69058. * @returns the box mesh
  69059. */
  69060. static CreateBox(name: string, options: {
  69061. size?: number;
  69062. width?: number;
  69063. height?: number;
  69064. depth?: number;
  69065. faceUV?: Vector4[];
  69066. faceColors?: Color4[];
  69067. sideOrientation?: number;
  69068. frontUVs?: Vector4;
  69069. backUVs?: Vector4;
  69070. wrap?: boolean;
  69071. topBaseAt?: number;
  69072. bottomBaseAt?: number;
  69073. updatable?: boolean;
  69074. }, scene?: Nullable<Scene>): Mesh;
  69075. /**
  69076. * Creates a tiled box mesh
  69077. * * faceTiles sets the pattern, tile size and number of tiles for a face
  69078. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69079. * @param name defines the name of the mesh
  69080. * @param options defines the options used to create the mesh
  69081. * @param scene defines the hosting scene
  69082. * @returns the tiled box mesh
  69083. */
  69084. static CreateTiledBox(name: string, options: {
  69085. pattern?: number;
  69086. size?: number;
  69087. width?: number;
  69088. height?: number;
  69089. depth: number;
  69090. tileSize?: number;
  69091. tileWidth?: number;
  69092. tileHeight?: number;
  69093. faceUV?: Vector4[];
  69094. faceColors?: Color4[];
  69095. alignHorizontal?: number;
  69096. alignVertical?: number;
  69097. sideOrientation?: number;
  69098. updatable?: boolean;
  69099. }, scene?: Nullable<Scene>): Mesh;
  69100. /**
  69101. * Creates a sphere mesh
  69102. * * The parameter `diameter` sets the diameter size (float) of the sphere (default 1)
  69103. * * 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`)
  69104. * * The parameter `segments` sets the sphere number of horizontal stripes (positive integer, default 32)
  69105. * * 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
  69106. * * 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)
  69107. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69108. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69109. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69110. * @param name defines the name of the mesh
  69111. * @param options defines the options used to create the mesh
  69112. * @param scene defines the hosting scene
  69113. * @returns the sphere mesh
  69114. * @see https://doc.babylonjs.com/how_to/set_shapes#sphere
  69115. */
  69116. static CreateSphere(name: string, options: {
  69117. segments?: number;
  69118. diameter?: number;
  69119. diameterX?: number;
  69120. diameterY?: number;
  69121. diameterZ?: number;
  69122. arc?: number;
  69123. slice?: number;
  69124. sideOrientation?: number;
  69125. frontUVs?: Vector4;
  69126. backUVs?: Vector4;
  69127. updatable?: boolean;
  69128. }, scene?: Nullable<Scene>): Mesh;
  69129. /**
  69130. * Creates a plane polygonal mesh. By default, this is a disc
  69131. * * The parameter `radius` sets the radius size (float) of the polygon (default 0.5)
  69132. * * 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
  69133. * * 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
  69134. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69135. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69136. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69137. * @param name defines the name of the mesh
  69138. * @param options defines the options used to create the mesh
  69139. * @param scene defines the hosting scene
  69140. * @returns the plane polygonal mesh
  69141. * @see https://doc.babylonjs.com/how_to/set_shapes#disc-or-regular-polygon
  69142. */
  69143. static CreateDisc(name: string, options: {
  69144. radius?: number;
  69145. tessellation?: number;
  69146. arc?: number;
  69147. updatable?: boolean;
  69148. sideOrientation?: number;
  69149. frontUVs?: Vector4;
  69150. backUVs?: Vector4;
  69151. }, scene?: Nullable<Scene>): Mesh;
  69152. /**
  69153. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  69154. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  69155. * * 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`)
  69156. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  69157. * * 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
  69158. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69159. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69160. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69161. * @param name defines the name of the mesh
  69162. * @param options defines the options used to create the mesh
  69163. * @param scene defines the hosting scene
  69164. * @returns the icosahedron mesh
  69165. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  69166. */
  69167. static CreateIcoSphere(name: string, options: {
  69168. radius?: number;
  69169. radiusX?: number;
  69170. radiusY?: number;
  69171. radiusZ?: number;
  69172. flat?: boolean;
  69173. subdivisions?: number;
  69174. sideOrientation?: number;
  69175. frontUVs?: Vector4;
  69176. backUVs?: Vector4;
  69177. updatable?: boolean;
  69178. }, scene?: Nullable<Scene>): Mesh;
  69179. /**
  69180. * Creates a ribbon mesh. The ribbon is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  69181. * * The parameter `pathArray` is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry
  69182. * * The parameter `closeArray` (boolean, default false) creates a seam between the first and the last paths of the path array
  69183. * * The parameter `closePath` (boolean, default false) creates a seam between the first and the last points of each path of the path array
  69184. * * 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
  69185. * * 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
  69186. * * 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
  69187. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69188. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69189. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  69190. * * 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
  69191. * * The parameters `colors` is an optional flat array of `Color4` to set/update each ribbon vertex with its own custom color values
  69192. * * 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
  69193. * * Moreover, you can use the parameter `color` with `instance` (to update the ribbon), only if you previously used it at creation time
  69194. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69195. * @param name defines the name of the mesh
  69196. * @param options defines the options used to create the mesh
  69197. * @param scene defines the hosting scene
  69198. * @returns the ribbon mesh
  69199. * @see https://doc.babylonjs.com/how_to/ribbon_tutorial
  69200. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  69201. */
  69202. static CreateRibbon(name: string, options: {
  69203. pathArray: Vector3[][];
  69204. closeArray?: boolean;
  69205. closePath?: boolean;
  69206. offset?: number;
  69207. updatable?: boolean;
  69208. sideOrientation?: number;
  69209. frontUVs?: Vector4;
  69210. backUVs?: Vector4;
  69211. instance?: Mesh;
  69212. invertUV?: boolean;
  69213. uvs?: Vector2[];
  69214. colors?: Color4[];
  69215. }, scene?: Nullable<Scene>): Mesh;
  69216. /**
  69217. * Creates a cylinder or a cone mesh
  69218. * * The parameter `height` sets the height size (float) of the cylinder/cone (float, default 2).
  69219. * * The parameter `diameter` sets the diameter of the top and bottom cap at once (float, default 1).
  69220. * * 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.
  69221. * * The parameter `tessellation` sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance.
  69222. * * The parameter `subdivisions` sets the number of rings along the cylinder height (positive integer, default 1).
  69223. * * The parameter `hasRings` (boolean, default false) makes the subdivisions independent from each other, so they become different faces.
  69224. * * The parameter `enclose` (boolean, default false) adds two extra faces per subdivision to a sliced cylinder to close it around its height axis.
  69225. * * 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).
  69226. * * The parameter `arc` (float, default 1) is the ratio (max 1) to apply to the circumference to slice the cylinder.
  69227. * * 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).
  69228. * * 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
  69229. * * Now, if the cylinder has 5 independent subdivisions (hasRings = true), n equals : top face + 5 stripe surfaces + bottom face = 2 + 5 = 7
  69230. * * 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
  69231. * * 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.
  69232. * * If `enclose` is false, a ring surface is one element.
  69233. * * If `enclose` is true, a ring surface is 3 successive elements in the array : the tubular surface, then the two closing faces.
  69234. * * 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
  69235. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69236. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69237. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  69238. * @param name defines the name of the mesh
  69239. * @param options defines the options used to create the mesh
  69240. * @param scene defines the hosting scene
  69241. * @returns the cylinder mesh
  69242. * @see https://doc.babylonjs.com/how_to/set_shapes#cylinder-or-cone
  69243. */
  69244. static CreateCylinder(name: string, options: {
  69245. height?: number;
  69246. diameterTop?: number;
  69247. diameterBottom?: number;
  69248. diameter?: number;
  69249. tessellation?: number;
  69250. subdivisions?: number;
  69251. arc?: number;
  69252. faceColors?: Color4[];
  69253. faceUV?: Vector4[];
  69254. updatable?: boolean;
  69255. hasRings?: boolean;
  69256. enclose?: boolean;
  69257. cap?: number;
  69258. sideOrientation?: number;
  69259. frontUVs?: Vector4;
  69260. backUVs?: Vector4;
  69261. }, scene?: Nullable<Scene>): Mesh;
  69262. /**
  69263. * Creates a torus mesh
  69264. * * The parameter `diameter` sets the diameter size (float) of the torus (default 1)
  69265. * * The parameter `thickness` sets the diameter size of the tube of the torus (float, default 0.5)
  69266. * * The parameter `tessellation` sets the number of torus sides (postive integer, default 16)
  69267. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69268. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69269. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  69270. * @param name defines the name of the mesh
  69271. * @param options defines the options used to create the mesh
  69272. * @param scene defines the hosting scene
  69273. * @returns the torus mesh
  69274. * @see https://doc.babylonjs.com/how_to/set_shapes#torus
  69275. */
  69276. static CreateTorus(name: string, options: {
  69277. diameter?: number;
  69278. thickness?: number;
  69279. tessellation?: number;
  69280. updatable?: boolean;
  69281. sideOrientation?: number;
  69282. frontUVs?: Vector4;
  69283. backUVs?: Vector4;
  69284. }, scene?: Nullable<Scene>): Mesh;
  69285. /**
  69286. * Creates a torus knot mesh
  69287. * * The parameter `radius` sets the global radius size (float) of the torus knot (default 2)
  69288. * * The parameter `radialSegments` sets the number of sides on each tube segments (positive integer, default 32)
  69289. * * The parameter `tubularSegments` sets the number of tubes to decompose the knot into (positive integer, default 32)
  69290. * * The parameters `p` and `q` are the number of windings on each axis (positive integers, default 2 and 3)
  69291. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69292. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69293. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  69294. * @param name defines the name of the mesh
  69295. * @param options defines the options used to create the mesh
  69296. * @param scene defines the hosting scene
  69297. * @returns the torus knot mesh
  69298. * @see https://doc.babylonjs.com/how_to/set_shapes#torus-knot
  69299. */
  69300. static CreateTorusKnot(name: string, options: {
  69301. radius?: number;
  69302. tube?: number;
  69303. radialSegments?: number;
  69304. tubularSegments?: number;
  69305. p?: number;
  69306. q?: number;
  69307. updatable?: boolean;
  69308. sideOrientation?: number;
  69309. frontUVs?: Vector4;
  69310. backUVs?: Vector4;
  69311. }, scene?: Nullable<Scene>): Mesh;
  69312. /**
  69313. * Creates a line system mesh. A line system is a pool of many lines gathered in a single mesh
  69314. * * 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
  69315. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineSystem to this static function
  69316. * * The parameter `lines` is an array of lines, each line being an array of successive Vector3
  69317. * * The optional parameter `instance` is an instance of an existing LineSystem object to be updated with the passed `lines` parameter
  69318. * * The optional parameter `colors` is an array of line colors, each line colors being an array of successive Color4, one per line point
  69319. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  69320. * * 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
  69321. * * When updating an instance, remember that only line point positions can change, not the number of points, neither the number of lines
  69322. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69323. * @see https://doc.babylonjs.com/how_to/parametric_shapes#line-system
  69324. * @param name defines the name of the new line system
  69325. * @param options defines the options used to create the line system
  69326. * @param scene defines the hosting scene
  69327. * @returns a new line system mesh
  69328. */
  69329. static CreateLineSystem(name: string, options: {
  69330. lines: Vector3[][];
  69331. updatable?: boolean;
  69332. instance?: Nullable<LinesMesh>;
  69333. colors?: Nullable<Color4[][]>;
  69334. useVertexAlpha?: boolean;
  69335. }, scene: Nullable<Scene>): LinesMesh;
  69336. /**
  69337. * Creates a line mesh
  69338. * 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
  69339. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  69340. * * The parameter `points` is an array successive Vector3
  69341. * * 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
  69342. * * The optional parameter `colors` is an array of successive Color4, one per line point
  69343. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need alpha blending (faster)
  69344. * * When updating an instance, remember that only point positions can change, not the number of points
  69345. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69346. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lines
  69347. * @param name defines the name of the new line system
  69348. * @param options defines the options used to create the line system
  69349. * @param scene defines the hosting scene
  69350. * @returns a new line mesh
  69351. */
  69352. static CreateLines(name: string, options: {
  69353. points: Vector3[];
  69354. updatable?: boolean;
  69355. instance?: Nullable<LinesMesh>;
  69356. colors?: Color4[];
  69357. useVertexAlpha?: boolean;
  69358. }, scene?: Nullable<Scene>): LinesMesh;
  69359. /**
  69360. * Creates a dashed line mesh
  69361. * * 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
  69362. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  69363. * * The parameter `points` is an array successive Vector3
  69364. * * The parameter `dashNb` is the intended total number of dashes (positive integer, default 200)
  69365. * * The parameter `dashSize` is the size of the dashes relatively the dash number (positive float, default 3)
  69366. * * The parameter `gapSize` is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  69367. * * 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
  69368. * * When updating an instance, remember that only point positions can change, not the number of points
  69369. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69370. * @param name defines the name of the mesh
  69371. * @param options defines the options used to create the mesh
  69372. * @param scene defines the hosting scene
  69373. * @returns the dashed line mesh
  69374. * @see https://doc.babylonjs.com/how_to/parametric_shapes#dashed-lines
  69375. */
  69376. static CreateDashedLines(name: string, options: {
  69377. points: Vector3[];
  69378. dashSize?: number;
  69379. gapSize?: number;
  69380. dashNb?: number;
  69381. updatable?: boolean;
  69382. instance?: LinesMesh;
  69383. }, scene?: Nullable<Scene>): LinesMesh;
  69384. /**
  69385. * 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.
  69386. * * 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.
  69387. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  69388. * * 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.
  69389. * * The parameter `scale` (float, default 1) is the value to scale the shape.
  69390. * * 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
  69391. * * 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
  69392. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape.
  69393. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69394. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69395. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture.
  69396. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  69397. * @param name defines the name of the mesh
  69398. * @param options defines the options used to create the mesh
  69399. * @param scene defines the hosting scene
  69400. * @returns the extruded shape mesh
  69401. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  69402. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  69403. */
  69404. static ExtrudeShape(name: string, options: {
  69405. shape: Vector3[];
  69406. path: Vector3[];
  69407. scale?: number;
  69408. rotation?: number;
  69409. cap?: number;
  69410. updatable?: boolean;
  69411. sideOrientation?: number;
  69412. frontUVs?: Vector4;
  69413. backUVs?: Vector4;
  69414. instance?: Mesh;
  69415. invertUV?: boolean;
  69416. }, scene?: Nullable<Scene>): Mesh;
  69417. /**
  69418. * Creates an custom extruded shape mesh.
  69419. * The custom extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  69420. * * 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.
  69421. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  69422. * * 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
  69423. * * It must returns a float value that will be the rotation in radians applied to the shape on each path point.
  69424. * * 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
  69425. * * It must returns a float value that will be the scale value applied to the shape on each path point
  69426. * * The parameter `ribbonClosePath` (boolean, default false) forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  69427. * * The parameter `ribbonCloseArray` (boolean, default false) forces the extrusion underlying ribbon to close its `pathArray`
  69428. * * 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
  69429. * * 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
  69430. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape
  69431. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69432. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69433. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  69434. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69435. * @param name defines the name of the mesh
  69436. * @param options defines the options used to create the mesh
  69437. * @param scene defines the hosting scene
  69438. * @returns the custom extruded shape mesh
  69439. * @see https://doc.babylonjs.com/how_to/parametric_shapes#custom-extruded-shapes
  69440. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  69441. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  69442. */
  69443. static ExtrudeShapeCustom(name: string, options: {
  69444. shape: Vector3[];
  69445. path: Vector3[];
  69446. scaleFunction?: any;
  69447. rotationFunction?: any;
  69448. ribbonCloseArray?: boolean;
  69449. ribbonClosePath?: boolean;
  69450. cap?: number;
  69451. updatable?: boolean;
  69452. sideOrientation?: number;
  69453. frontUVs?: Vector4;
  69454. backUVs?: Vector4;
  69455. instance?: Mesh;
  69456. invertUV?: boolean;
  69457. }, scene?: Nullable<Scene>): Mesh;
  69458. /**
  69459. * Creates lathe mesh.
  69460. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe
  69461. * * 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
  69462. * * The parameter `radius` (positive float, default 1) is the radius value of the lathe
  69463. * * The parameter `tessellation` (positive integer, default 64) is the side number of the lathe
  69464. * * The parameter `clip` (positive integer, default 0) is the number of sides to not create without effecting the general shape of the sides
  69465. * * 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
  69466. * * The parameter `closed` (boolean, default true) opens/closes the lathe circumference. This should be set to false when used with the parameter "arc"
  69467. * * 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
  69468. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69469. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69470. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  69471. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69472. * @param name defines the name of the mesh
  69473. * @param options defines the options used to create the mesh
  69474. * @param scene defines the hosting scene
  69475. * @returns the lathe mesh
  69476. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lathe
  69477. */
  69478. static CreateLathe(name: string, options: {
  69479. shape: Vector3[];
  69480. radius?: number;
  69481. tessellation?: number;
  69482. clip?: number;
  69483. arc?: number;
  69484. closed?: boolean;
  69485. updatable?: boolean;
  69486. sideOrientation?: number;
  69487. frontUVs?: Vector4;
  69488. backUVs?: Vector4;
  69489. cap?: number;
  69490. invertUV?: boolean;
  69491. }, scene?: Nullable<Scene>): Mesh;
  69492. /**
  69493. * Creates a tiled plane mesh
  69494. * * You can set a limited pattern arrangement with the tiles
  69495. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69496. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69497. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69498. * @param name defines the name of the mesh
  69499. * @param options defines the options used to create the mesh
  69500. * @param scene defines the hosting scene
  69501. * @returns the plane mesh
  69502. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  69503. */
  69504. static CreateTiledPlane(name: string, options: {
  69505. pattern?: number;
  69506. tileSize?: number;
  69507. tileWidth?: number;
  69508. tileHeight?: number;
  69509. size?: number;
  69510. width?: number;
  69511. height?: number;
  69512. alignHorizontal?: number;
  69513. alignVertical?: number;
  69514. sideOrientation?: number;
  69515. frontUVs?: Vector4;
  69516. backUVs?: Vector4;
  69517. updatable?: boolean;
  69518. }, scene?: Nullable<Scene>): Mesh;
  69519. /**
  69520. * Creates a plane mesh
  69521. * * The parameter `size` sets the size (float) of both sides of the plane at once (default 1)
  69522. * * You can set some different plane dimensions by using the parameters `width` and `height` (both by default have the same value of `size`)
  69523. * * The parameter `sourcePlane` is a Plane instance. It builds a mesh plane from a Math plane
  69524. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69525. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69526. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69527. * @param name defines the name of the mesh
  69528. * @param options defines the options used to create the mesh
  69529. * @param scene defines the hosting scene
  69530. * @returns the plane mesh
  69531. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  69532. */
  69533. static CreatePlane(name: string, options: {
  69534. size?: number;
  69535. width?: number;
  69536. height?: number;
  69537. sideOrientation?: number;
  69538. frontUVs?: Vector4;
  69539. backUVs?: Vector4;
  69540. updatable?: boolean;
  69541. sourcePlane?: Plane;
  69542. }, scene?: Nullable<Scene>): Mesh;
  69543. /**
  69544. * Creates a ground mesh
  69545. * * The parameters `width` and `height` (floats, default 1) set the width and height sizes of the ground
  69546. * * The parameter `subdivisions` (positive integer) sets the number of subdivisions per side
  69547. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69548. * @param name defines the name of the mesh
  69549. * @param options defines the options used to create the mesh
  69550. * @param scene defines the hosting scene
  69551. * @returns the ground mesh
  69552. * @see https://doc.babylonjs.com/how_to/set_shapes#ground
  69553. */
  69554. static CreateGround(name: string, options: {
  69555. width?: number;
  69556. height?: number;
  69557. subdivisions?: number;
  69558. subdivisionsX?: number;
  69559. subdivisionsY?: number;
  69560. updatable?: boolean;
  69561. }, scene?: Nullable<Scene>): Mesh;
  69562. /**
  69563. * Creates a tiled ground mesh
  69564. * * The parameters `xmin` and `xmax` (floats, default -1 and 1) set the ground minimum and maximum X coordinates
  69565. * * The parameters `zmin` and `zmax` (floats, default -1 and 1) set the ground minimum and maximum Z coordinates
  69566. * * 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
  69567. * * 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
  69568. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  69569. * @param name defines the name of the mesh
  69570. * @param options defines the options used to create the mesh
  69571. * @param scene defines the hosting scene
  69572. * @returns the tiled ground mesh
  69573. * @see https://doc.babylonjs.com/how_to/set_shapes#tiled-ground
  69574. */
  69575. static CreateTiledGround(name: string, options: {
  69576. xmin: number;
  69577. zmin: number;
  69578. xmax: number;
  69579. zmax: number;
  69580. subdivisions?: {
  69581. w: number;
  69582. h: number;
  69583. };
  69584. precision?: {
  69585. w: number;
  69586. h: number;
  69587. };
  69588. updatable?: boolean;
  69589. }, scene?: Nullable<Scene>): Mesh;
  69590. /**
  69591. * Creates a ground mesh from a height map
  69592. * * The parameter `url` sets the URL of the height map image resource.
  69593. * * The parameters `width` and `height` (positive floats, default 10) set the ground width and height sizes.
  69594. * * The parameter `subdivisions` (positive integer, default 1) sets the number of subdivision per side.
  69595. * * The parameter `minHeight` (float, default 0) is the minimum altitude on the ground.
  69596. * * The parameter `maxHeight` (float, default 1) is the maximum altitude on the ground.
  69597. * * 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.
  69598. * * 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).
  69599. * * The parameter `alphaFilter` will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  69600. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  69601. * @param name defines the name of the mesh
  69602. * @param url defines the url to the height map
  69603. * @param options defines the options used to create the mesh
  69604. * @param scene defines the hosting scene
  69605. * @returns the ground mesh
  69606. * @see https://doc.babylonjs.com/babylon101/height_map
  69607. * @see https://doc.babylonjs.com/how_to/set_shapes#ground-from-a-height-map
  69608. */
  69609. static CreateGroundFromHeightMap(name: string, url: string, options: {
  69610. width?: number;
  69611. height?: number;
  69612. subdivisions?: number;
  69613. minHeight?: number;
  69614. maxHeight?: number;
  69615. colorFilter?: Color3;
  69616. alphaFilter?: number;
  69617. updatable?: boolean;
  69618. onReady?: (mesh: GroundMesh) => void;
  69619. }, scene?: Nullable<Scene>): GroundMesh;
  69620. /**
  69621. * Creates a polygon mesh
  69622. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh
  69623. * * 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
  69624. * * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  69625. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69626. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4)
  69627. * * Remember you can only change the shape positions, not their number when updating a polygon
  69628. * @param name defines the name of the mesh
  69629. * @param options defines the options used to create the mesh
  69630. * @param scene defines the hosting scene
  69631. * @param earcutInjection can be used to inject your own earcut reference
  69632. * @returns the polygon mesh
  69633. */
  69634. static CreatePolygon(name: string, options: {
  69635. shape: Vector3[];
  69636. holes?: Vector3[][];
  69637. depth?: number;
  69638. faceUV?: Vector4[];
  69639. faceColors?: Color4[];
  69640. updatable?: boolean;
  69641. sideOrientation?: number;
  69642. frontUVs?: Vector4;
  69643. backUVs?: Vector4;
  69644. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  69645. /**
  69646. * Creates an extruded polygon mesh, with depth in the Y direction.
  69647. * * 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)
  69648. * @see https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  69649. * @param name defines the name of the mesh
  69650. * @param options defines the options used to create the mesh
  69651. * @param scene defines the hosting scene
  69652. * @param earcutInjection can be used to inject your own earcut reference
  69653. * @returns the polygon mesh
  69654. */
  69655. static ExtrudePolygon(name: string, options: {
  69656. shape: Vector3[];
  69657. holes?: Vector3[][];
  69658. depth?: number;
  69659. faceUV?: Vector4[];
  69660. faceColors?: Color4[];
  69661. updatable?: boolean;
  69662. sideOrientation?: number;
  69663. frontUVs?: Vector4;
  69664. backUVs?: Vector4;
  69665. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  69666. /**
  69667. * Creates a tube mesh.
  69668. * The tube is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  69669. * * The parameter `path` is a required array of successive Vector3. It is the curve used as the axis of the tube
  69670. * * The parameter `radius` (positive float, default 1) sets the tube radius size
  69671. * * The parameter `tessellation` (positive float, default 64) is the number of sides on the tubular surface
  69672. * * The parameter `radiusFunction` (javascript function, default null) is a vanilla javascript function. If it is not null, it overwrittes the parameter `radius`
  69673. * * 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)
  69674. * * The parameter `arc` (positive float, maximum 1, default 1) is the ratio to apply to the tube circumference : 2 x PI x arc
  69675. * * 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
  69676. * * 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
  69677. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69678. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69679. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  69680. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69681. * @param name defines the name of the mesh
  69682. * @param options defines the options used to create the mesh
  69683. * @param scene defines the hosting scene
  69684. * @returns the tube mesh
  69685. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  69686. * @see https://doc.babylonjs.com/how_to/set_shapes#tube
  69687. */
  69688. static CreateTube(name: string, options: {
  69689. path: Vector3[];
  69690. radius?: number;
  69691. tessellation?: number;
  69692. radiusFunction?: {
  69693. (i: number, distance: number): number;
  69694. };
  69695. cap?: number;
  69696. arc?: number;
  69697. updatable?: boolean;
  69698. sideOrientation?: number;
  69699. frontUVs?: Vector4;
  69700. backUVs?: Vector4;
  69701. instance?: Mesh;
  69702. invertUV?: boolean;
  69703. }, scene?: Nullable<Scene>): Mesh;
  69704. /**
  69705. * Creates a polyhedron mesh
  69706. * * 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
  69707. * * The parameter `size` (positive float, default 1) sets the polygon size
  69708. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  69709. * * 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`
  69710. * * 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
  69711. * * 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)`)
  69712. * * 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
  69713. * * 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
  69714. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69715. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69716. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69717. * @param name defines the name of the mesh
  69718. * @param options defines the options used to create the mesh
  69719. * @param scene defines the hosting scene
  69720. * @returns the polyhedron mesh
  69721. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes
  69722. */
  69723. static CreatePolyhedron(name: string, options: {
  69724. type?: number;
  69725. size?: number;
  69726. sizeX?: number;
  69727. sizeY?: number;
  69728. sizeZ?: number;
  69729. custom?: any;
  69730. faceUV?: Vector4[];
  69731. faceColors?: Color4[];
  69732. flat?: boolean;
  69733. updatable?: boolean;
  69734. sideOrientation?: number;
  69735. frontUVs?: Vector4;
  69736. backUVs?: Vector4;
  69737. }, scene?: Nullable<Scene>): Mesh;
  69738. /**
  69739. * Creates a decal mesh.
  69740. * 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
  69741. * * The parameter `position` (Vector3, default `(0, 0, 0)`) sets the position of the decal in World coordinates
  69742. * * The parameter `normal` (Vector3, default `Vector3.Up`) sets the normal of the mesh where the decal is applied onto in World coordinates
  69743. * * The parameter `size` (Vector3, default `(1, 1, 1)`) sets the decal scaling
  69744. * * The parameter `angle` (float in radian, default 0) sets the angle to rotate the decal
  69745. * @param name defines the name of the mesh
  69746. * @param sourceMesh defines the mesh where the decal must be applied
  69747. * @param options defines the options used to create the mesh
  69748. * @param scene defines the hosting scene
  69749. * @returns the decal mesh
  69750. * @see https://doc.babylonjs.com/how_to/decals
  69751. */
  69752. static CreateDecal(name: string, sourceMesh: AbstractMesh, options: {
  69753. position?: Vector3;
  69754. normal?: Vector3;
  69755. size?: Vector3;
  69756. angle?: number;
  69757. }): Mesh;
  69758. }
  69759. }
  69760. declare module "babylonjs/Meshes/meshSimplification" {
  69761. import { Mesh } from "babylonjs/Meshes/mesh";
  69762. /**
  69763. * A simplifier interface for future simplification implementations
  69764. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  69765. */
  69766. export interface ISimplifier {
  69767. /**
  69768. * Simplification of a given mesh according to the given settings.
  69769. * Since this requires computation, it is assumed that the function runs async.
  69770. * @param settings The settings of the simplification, including quality and distance
  69771. * @param successCallback A callback that will be called after the mesh was simplified.
  69772. * @param errorCallback in case of an error, this callback will be called. optional.
  69773. */
  69774. simplify(settings: ISimplificationSettings, successCallback: (simplifiedMeshes: Mesh) => void, errorCallback?: () => void): void;
  69775. }
  69776. /**
  69777. * Expected simplification settings.
  69778. * Quality should be between 0 and 1 (1 being 100%, 0 being 0%)
  69779. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  69780. */
  69781. export interface ISimplificationSettings {
  69782. /**
  69783. * Gets or sets the expected quality
  69784. */
  69785. quality: number;
  69786. /**
  69787. * Gets or sets the distance when this optimized version should be used
  69788. */
  69789. distance: number;
  69790. /**
  69791. * Gets an already optimized mesh
  69792. */
  69793. optimizeMesh?: boolean;
  69794. }
  69795. /**
  69796. * Class used to specify simplification options
  69797. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  69798. */
  69799. export class SimplificationSettings implements ISimplificationSettings {
  69800. /** expected quality */
  69801. quality: number;
  69802. /** distance when this optimized version should be used */
  69803. distance: number;
  69804. /** already optimized mesh */
  69805. optimizeMesh?: boolean | undefined;
  69806. /**
  69807. * Creates a SimplificationSettings
  69808. * @param quality expected quality
  69809. * @param distance distance when this optimized version should be used
  69810. * @param optimizeMesh already optimized mesh
  69811. */
  69812. constructor(
  69813. /** expected quality */
  69814. quality: number,
  69815. /** distance when this optimized version should be used */
  69816. distance: number,
  69817. /** already optimized mesh */
  69818. optimizeMesh?: boolean | undefined);
  69819. }
  69820. /**
  69821. * Interface used to define a simplification task
  69822. */
  69823. export interface ISimplificationTask {
  69824. /**
  69825. * Array of settings
  69826. */
  69827. settings: Array<ISimplificationSettings>;
  69828. /**
  69829. * Simplification type
  69830. */
  69831. simplificationType: SimplificationType;
  69832. /**
  69833. * Mesh to simplify
  69834. */
  69835. mesh: Mesh;
  69836. /**
  69837. * Callback called on success
  69838. */
  69839. successCallback?: () => void;
  69840. /**
  69841. * Defines if parallel processing can be used
  69842. */
  69843. parallelProcessing: boolean;
  69844. }
  69845. /**
  69846. * Queue used to order the simplification tasks
  69847. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  69848. */
  69849. export class SimplificationQueue {
  69850. private _simplificationArray;
  69851. /**
  69852. * Gets a boolean indicating that the process is still running
  69853. */
  69854. running: boolean;
  69855. /**
  69856. * Creates a new queue
  69857. */
  69858. constructor();
  69859. /**
  69860. * Adds a new simplification task
  69861. * @param task defines a task to add
  69862. */
  69863. addTask(task: ISimplificationTask): void;
  69864. /**
  69865. * Execute next task
  69866. */
  69867. executeNext(): void;
  69868. /**
  69869. * Execute a simplification task
  69870. * @param task defines the task to run
  69871. */
  69872. runSimplification(task: ISimplificationTask): void;
  69873. private getSimplifier;
  69874. }
  69875. /**
  69876. * The implemented types of simplification
  69877. * At the moment only Quadratic Error Decimation is implemented
  69878. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  69879. */
  69880. export enum SimplificationType {
  69881. /** Quadratic error decimation */
  69882. QUADRATIC = 0
  69883. }
  69884. /**
  69885. * An implementation of the Quadratic Error simplification algorithm.
  69886. * Original paper : http://www1.cs.columbia.edu/~cs4162/html05s/garland97.pdf
  69887. * Ported mostly from QSlim and http://voxels.blogspot.de/2014/05/quadric-mesh-simplification-with-source.html to babylon JS
  69888. * @author RaananW
  69889. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  69890. */
  69891. export class QuadraticErrorSimplification implements ISimplifier {
  69892. private _mesh;
  69893. private triangles;
  69894. private vertices;
  69895. private references;
  69896. private _reconstructedMesh;
  69897. /** Gets or sets the number pf sync interations */
  69898. syncIterations: number;
  69899. /** Gets or sets the aggressiveness of the simplifier */
  69900. aggressiveness: number;
  69901. /** Gets or sets the number of allowed iterations for decimation */
  69902. decimationIterations: number;
  69903. /** Gets or sets the espilon to use for bounding box computation */
  69904. boundingBoxEpsilon: number;
  69905. /**
  69906. * Creates a new QuadraticErrorSimplification
  69907. * @param _mesh defines the target mesh
  69908. */
  69909. constructor(_mesh: Mesh);
  69910. /**
  69911. * Simplification of a given mesh according to the given settings.
  69912. * Since this requires computation, it is assumed that the function runs async.
  69913. * @param settings The settings of the simplification, including quality and distance
  69914. * @param successCallback A callback that will be called after the mesh was simplified.
  69915. */
  69916. simplify(settings: ISimplificationSettings, successCallback: (simplifiedMesh: Mesh) => void): void;
  69917. private runDecimation;
  69918. private initWithMesh;
  69919. private init;
  69920. private reconstructMesh;
  69921. private initDecimatedMesh;
  69922. private isFlipped;
  69923. private updateTriangles;
  69924. private identifyBorder;
  69925. private updateMesh;
  69926. private vertexError;
  69927. private calculateError;
  69928. }
  69929. }
  69930. declare module "babylonjs/Meshes/meshSimplificationSceneComponent" {
  69931. import { Scene } from "babylonjs/scene";
  69932. import { SimplificationQueue, ISimplificationSettings, SimplificationType } from "babylonjs/Meshes/meshSimplification";
  69933. import { ISceneComponent } from "babylonjs/sceneComponent";
  69934. module "babylonjs/scene" {
  69935. interface Scene {
  69936. /** @hidden (Backing field) */
  69937. _simplificationQueue: SimplificationQueue;
  69938. /**
  69939. * Gets or sets the simplification queue attached to the scene
  69940. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  69941. */
  69942. simplificationQueue: SimplificationQueue;
  69943. }
  69944. }
  69945. module "babylonjs/Meshes/mesh" {
  69946. interface Mesh {
  69947. /**
  69948. * Simplify the mesh according to the given array of settings.
  69949. * Function will return immediately and will simplify async
  69950. * @param settings a collection of simplification settings
  69951. * @param parallelProcessing should all levels calculate parallel or one after the other
  69952. * @param simplificationType the type of simplification to run
  69953. * @param successCallback optional success callback to be called after the simplification finished processing all settings
  69954. * @returns the current mesh
  69955. */
  69956. simplify(settings: Array<ISimplificationSettings>, parallelProcessing?: boolean, simplificationType?: SimplificationType, successCallback?: (mesh?: Mesh, submeshIndex?: number) => void): Mesh;
  69957. }
  69958. }
  69959. /**
  69960. * Defines the simplification queue scene component responsible to help scheduling the various simplification task
  69961. * created in a scene
  69962. */
  69963. export class SimplicationQueueSceneComponent implements ISceneComponent {
  69964. /**
  69965. * The component name helpfull to identify the component in the list of scene components.
  69966. */
  69967. readonly name: string;
  69968. /**
  69969. * The scene the component belongs to.
  69970. */
  69971. scene: Scene;
  69972. /**
  69973. * Creates a new instance of the component for the given scene
  69974. * @param scene Defines the scene to register the component in
  69975. */
  69976. constructor(scene: Scene);
  69977. /**
  69978. * Registers the component in a given scene
  69979. */
  69980. register(): void;
  69981. /**
  69982. * Rebuilds the elements related to this component in case of
  69983. * context lost for instance.
  69984. */
  69985. rebuild(): void;
  69986. /**
  69987. * Disposes the component and the associated ressources
  69988. */
  69989. dispose(): void;
  69990. private _beforeCameraUpdate;
  69991. }
  69992. }
  69993. declare module "babylonjs/Meshes/Builders/index" {
  69994. export * from "babylonjs/Meshes/Builders/boxBuilder";
  69995. export * from "babylonjs/Meshes/Builders/tiledBoxBuilder";
  69996. export * from "babylonjs/Meshes/Builders/discBuilder";
  69997. export * from "babylonjs/Meshes/Builders/ribbonBuilder";
  69998. export * from "babylonjs/Meshes/Builders/sphereBuilder";
  69999. export * from "babylonjs/Meshes/Builders/hemisphereBuilder";
  70000. export * from "babylonjs/Meshes/Builders/cylinderBuilder";
  70001. export * from "babylonjs/Meshes/Builders/torusBuilder";
  70002. export * from "babylonjs/Meshes/Builders/torusKnotBuilder";
  70003. export * from "babylonjs/Meshes/Builders/linesBuilder";
  70004. export * from "babylonjs/Meshes/Builders/polygonBuilder";
  70005. export * from "babylonjs/Meshes/Builders/shapeBuilder";
  70006. export * from "babylonjs/Meshes/Builders/latheBuilder";
  70007. export * from "babylonjs/Meshes/Builders/planeBuilder";
  70008. export * from "babylonjs/Meshes/Builders/tiledPlaneBuilder";
  70009. export * from "babylonjs/Meshes/Builders/groundBuilder";
  70010. export * from "babylonjs/Meshes/Builders/tubeBuilder";
  70011. export * from "babylonjs/Meshes/Builders/polyhedronBuilder";
  70012. export * from "babylonjs/Meshes/Builders/icoSphereBuilder";
  70013. export * from "babylonjs/Meshes/Builders/decalBuilder";
  70014. }
  70015. declare module "babylonjs/Meshes/thinInstanceMesh" {
  70016. import { Nullable, DeepImmutableObject } from "babylonjs/types";
  70017. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  70018. import { Matrix } from "babylonjs/Maths/math.vector";
  70019. module "babylonjs/Meshes/mesh" {
  70020. interface Mesh {
  70021. /**
  70022. * Gets or sets a boolean defining if we want picking to pick thin instances as well
  70023. */
  70024. thinInstanceEnablePicking: boolean;
  70025. /**
  70026. * Creates a new thin instance
  70027. * @param matrix the matrix or array of matrices (position, rotation, scale) of the thin instance(s) to create
  70028. * @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
  70029. * @returns the thin instance index number. If you pass an array of matrices, other instance indexes are index+1, index+2, etc
  70030. */
  70031. thinInstanceAdd(matrix: DeepImmutableObject<Matrix> | Array<DeepImmutableObject<Matrix>>, refresh: boolean): number;
  70032. /**
  70033. * Adds the transformation (matrix) of the current mesh as a thin instance
  70034. * @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
  70035. * @returns the thin instance index number
  70036. */
  70037. thinInstanceAddSelf(refresh: boolean): number;
  70038. /**
  70039. * Registers a custom attribute to be used with thin instances
  70040. * @param kind name of the attribute
  70041. * @param stride size in floats of the attribute
  70042. */
  70043. thinInstanceRegisterAttribute(kind: string, stride: number): void;
  70044. /**
  70045. * Sets the matrix of a thin instance
  70046. * @param index index of the thin instance
  70047. * @param matrix matrix to set
  70048. * @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
  70049. */
  70050. thinInstanceSetMatrixAt(index: number, matrix: DeepImmutableObject<Matrix>, refresh: boolean): void;
  70051. /**
  70052. * Sets the value of a custom attribute for a thin instance
  70053. * @param kind name of the attribute
  70054. * @param index index of the thin instance
  70055. * @param value value to set
  70056. * @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
  70057. */
  70058. thinInstanceSetAttributeAt(kind: string, index: number, value: Array<number>, refresh: boolean): void;
  70059. /**
  70060. * 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.
  70061. */
  70062. thinInstanceCount: number;
  70063. /**
  70064. * Sets a buffer to be used with thin instances. This method is a faster way to setup multiple instances than calling thinInstanceAdd repeatedly
  70065. * @param kind name of the attribute. Use "matrix" to setup the buffer of matrices
  70066. * @param buffer buffer to set
  70067. * @param stride size in floats of each value of the buffer
  70068. * @param staticBuffer indicates that the buffer is static, so that you won't change it after it is set (better performances - false by default)
  70069. */
  70070. thinInstanceSetBuffer(kind: string, buffer: Nullable<Float32Array>, stride: number, staticBuffer: boolean): void;
  70071. /**
  70072. * Gets the list of world matrices
  70073. * @return an array containing all the world matrices from the thin instances
  70074. */
  70075. thinInstanceGetWorldMatrices(): Matrix[];
  70076. /**
  70077. * Synchronize the gpu buffers with a thin instance buffer. Call this method if you update later on the buffers passed to thinInstanceSetBuffer
  70078. * @param kind name of the attribute to update. Use "matrix" to update the buffer of matrices
  70079. */
  70080. thinInstanceBufferUpdated(kind: string): void;
  70081. /**
  70082. * Refreshes the bounding info, taking into account all the thin instances defined
  70083. * @param forceRefreshParentInfo true to force recomputing the mesh bounding info and use it to compute the aggregated bounding info
  70084. */
  70085. thinInstanceRefreshBoundingInfo(forceRefreshParentInfo: boolean): void;
  70086. /** @hidden */
  70087. _thinInstanceInitializeUserStorage(): void;
  70088. /** @hidden */
  70089. _thinInstanceUpdateBufferSize(kind: string, numInstances: number): void;
  70090. /** @hidden */
  70091. _userThinInstanceBuffersStorage: {
  70092. data: {
  70093. [key: string]: Float32Array;
  70094. };
  70095. sizes: {
  70096. [key: string]: number;
  70097. };
  70098. vertexBuffers: {
  70099. [key: string]: Nullable<VertexBuffer>;
  70100. };
  70101. strides: {
  70102. [key: string]: number;
  70103. };
  70104. };
  70105. }
  70106. }
  70107. }
  70108. declare module "babylonjs/Meshes/index" {
  70109. export * from "babylonjs/Meshes/abstractMesh";
  70110. export * from "babylonjs/Meshes/buffer";
  70111. export * from "babylonjs/Meshes/Compression/index";
  70112. export * from "babylonjs/Meshes/csg";
  70113. export * from "babylonjs/Meshes/geometry";
  70114. export * from "babylonjs/Meshes/groundMesh";
  70115. export * from "babylonjs/Meshes/trailMesh";
  70116. export * from "babylonjs/Meshes/instancedMesh";
  70117. export * from "babylonjs/Meshes/linesMesh";
  70118. export * from "babylonjs/Meshes/mesh";
  70119. export * from "babylonjs/Meshes/mesh.vertexData";
  70120. export * from "babylonjs/Meshes/meshBuilder";
  70121. export * from "babylonjs/Meshes/meshSimplification";
  70122. export * from "babylonjs/Meshes/meshSimplificationSceneComponent";
  70123. export * from "babylonjs/Meshes/polygonMesh";
  70124. export * from "babylonjs/Meshes/subMesh";
  70125. export * from "babylonjs/Meshes/meshLODLevel";
  70126. export * from "babylonjs/Meshes/transformNode";
  70127. export * from "babylonjs/Meshes/Builders/index";
  70128. export * from "babylonjs/Meshes/dataBuffer";
  70129. export * from "babylonjs/Meshes/WebGL/webGLDataBuffer";
  70130. import "babylonjs/Meshes/thinInstanceMesh";
  70131. export * from "babylonjs/Meshes/thinInstanceMesh";
  70132. }
  70133. declare module "babylonjs/Morph/index" {
  70134. export * from "babylonjs/Morph/morphTarget";
  70135. export * from "babylonjs/Morph/morphTargetManager";
  70136. }
  70137. declare module "babylonjs/Navigation/INavigationEngine" {
  70138. import { TransformNode } from "babylonjs/Meshes/transformNode";
  70139. import { Vector3 } from "babylonjs/Maths/math";
  70140. import { Mesh } from "babylonjs/Meshes/mesh";
  70141. import { Scene } from "babylonjs/scene";
  70142. /**
  70143. * Navigation plugin interface to add navigation constrained by a navigation mesh
  70144. */
  70145. export interface INavigationEnginePlugin {
  70146. /**
  70147. * plugin name
  70148. */
  70149. name: string;
  70150. /**
  70151. * Creates a navigation mesh
  70152. * @param meshes array of all the geometry used to compute the navigatio mesh
  70153. * @param parameters bunch of parameters used to filter geometry
  70154. */
  70155. createNavMesh(meshes: Array<Mesh>, parameters: INavMeshParameters): void;
  70156. /**
  70157. * Create a navigation mesh debug mesh
  70158. * @param scene is where the mesh will be added
  70159. * @returns debug display mesh
  70160. */
  70161. createDebugNavMesh(scene: Scene): Mesh;
  70162. /**
  70163. * Get a navigation mesh constrained position, closest to the parameter position
  70164. * @param position world position
  70165. * @returns the closest point to position constrained by the navigation mesh
  70166. */
  70167. getClosestPoint(position: Vector3): Vector3;
  70168. /**
  70169. * Get a navigation mesh constrained position, closest to the parameter position
  70170. * @param position world position
  70171. * @param result output the closest point to position constrained by the navigation mesh
  70172. */
  70173. getClosestPointToRef(position: Vector3, result: Vector3): void;
  70174. /**
  70175. * Get a navigation mesh constrained position, within a particular radius
  70176. * @param position world position
  70177. * @param maxRadius the maximum distance to the constrained world position
  70178. * @returns the closest point to position constrained by the navigation mesh
  70179. */
  70180. getRandomPointAround(position: Vector3, maxRadius: number): Vector3;
  70181. /**
  70182. * Get a navigation mesh constrained position, within a particular radius
  70183. * @param position world position
  70184. * @param maxRadius the maximum distance to the constrained world position
  70185. * @param result output the closest point to position constrained by the navigation mesh
  70186. */
  70187. getRandomPointAroundToRef(position: Vector3, maxRadius: number, result: Vector3): void;
  70188. /**
  70189. * Compute the final position from a segment made of destination-position
  70190. * @param position world position
  70191. * @param destination world position
  70192. * @returns the resulting point along the navmesh
  70193. */
  70194. moveAlong(position: Vector3, destination: Vector3): Vector3;
  70195. /**
  70196. * Compute the final position from a segment made of destination-position
  70197. * @param position world position
  70198. * @param destination world position
  70199. * @param result output the resulting point along the navmesh
  70200. */
  70201. moveAlongToRef(position: Vector3, destination: Vector3, result: Vector3): void;
  70202. /**
  70203. * Compute a navigation path from start to end. Returns an empty array if no path can be computed
  70204. * @param start world position
  70205. * @param end world position
  70206. * @returns array containing world position composing the path
  70207. */
  70208. computePath(start: Vector3, end: Vector3): Vector3[];
  70209. /**
  70210. * If this plugin is supported
  70211. * @returns true if plugin is supported
  70212. */
  70213. isSupported(): boolean;
  70214. /**
  70215. * Create a new Crowd so you can add agents
  70216. * @param maxAgents the maximum agent count in the crowd
  70217. * @param maxAgentRadius the maximum radius an agent can have
  70218. * @param scene to attach the crowd to
  70219. * @returns the crowd you can add agents to
  70220. */
  70221. createCrowd(maxAgents: number, maxAgentRadius: number, scene: Scene): ICrowd;
  70222. /**
  70223. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  70224. * The queries will try to find a solution within those bounds
  70225. * default is (1,1,1)
  70226. * @param extent x,y,z value that define the extent around the queries point of reference
  70227. */
  70228. setDefaultQueryExtent(extent: Vector3): void;
  70229. /**
  70230. * Get the Bounding box extent specified by setDefaultQueryExtent
  70231. * @returns the box extent values
  70232. */
  70233. getDefaultQueryExtent(): Vector3;
  70234. /**
  70235. * build the navmesh from a previously saved state using getNavmeshData
  70236. * @param data the Uint8Array returned by getNavmeshData
  70237. */
  70238. buildFromNavmeshData(data: Uint8Array): void;
  70239. /**
  70240. * returns the navmesh data that can be used later. The navmesh must be built before retrieving the data
  70241. * @returns data the Uint8Array that can be saved and reused
  70242. */
  70243. getNavmeshData(): Uint8Array;
  70244. /**
  70245. * Get the Bounding box extent result specified by setDefaultQueryExtent
  70246. * @param result output the box extent values
  70247. */
  70248. getDefaultQueryExtentToRef(result: Vector3): void;
  70249. /**
  70250. * Release all resources
  70251. */
  70252. dispose(): void;
  70253. }
  70254. /**
  70255. * Crowd Interface. A Crowd is a collection of moving agents constrained by a navigation mesh
  70256. */
  70257. export interface ICrowd {
  70258. /**
  70259. * Add a new agent to the crowd with the specified parameter a corresponding transformNode.
  70260. * You can attach anything to that node. The node position is updated in the scene update tick.
  70261. * @param pos world position that will be constrained by the navigation mesh
  70262. * @param parameters agent parameters
  70263. * @param transform hooked to the agent that will be update by the scene
  70264. * @returns agent index
  70265. */
  70266. addAgent(pos: Vector3, parameters: IAgentParameters, transform: TransformNode): number;
  70267. /**
  70268. * Returns the agent position in world space
  70269. * @param index agent index returned by addAgent
  70270. * @returns world space position
  70271. */
  70272. getAgentPosition(index: number): Vector3;
  70273. /**
  70274. * Gets the agent position result in world space
  70275. * @param index agent index returned by addAgent
  70276. * @param result output world space position
  70277. */
  70278. getAgentPositionToRef(index: number, result: Vector3): void;
  70279. /**
  70280. * Gets the agent velocity in world space
  70281. * @param index agent index returned by addAgent
  70282. * @returns world space velocity
  70283. */
  70284. getAgentVelocity(index: number): Vector3;
  70285. /**
  70286. * Gets the agent velocity result in world space
  70287. * @param index agent index returned by addAgent
  70288. * @param result output world space velocity
  70289. */
  70290. getAgentVelocityToRef(index: number, result: Vector3): void;
  70291. /**
  70292. * remove a particular agent previously created
  70293. * @param index agent index returned by addAgent
  70294. */
  70295. removeAgent(index: number): void;
  70296. /**
  70297. * get the list of all agents attached to this crowd
  70298. * @returns list of agent indices
  70299. */
  70300. getAgents(): number[];
  70301. /**
  70302. * Tick update done by the Scene. Agent position/velocity/acceleration is updated by this function
  70303. * @param deltaTime in seconds
  70304. */
  70305. update(deltaTime: number): void;
  70306. /**
  70307. * Asks a particular agent to go to a destination. That destination is constrained by the navigation mesh
  70308. * @param index agent index returned by addAgent
  70309. * @param destination targeted world position
  70310. */
  70311. agentGoto(index: number, destination: Vector3): void;
  70312. /**
  70313. * Teleport the agent to a new position
  70314. * @param index agent index returned by addAgent
  70315. * @param destination targeted world position
  70316. */
  70317. agentTeleport(index: number, destination: Vector3): void;
  70318. /**
  70319. * Update agent parameters
  70320. * @param index agent index returned by addAgent
  70321. * @param parameters agent parameters
  70322. */
  70323. updateAgentParameters(index: number, parameters: IAgentParameters): void;
  70324. /**
  70325. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  70326. * The queries will try to find a solution within those bounds
  70327. * default is (1,1,1)
  70328. * @param extent x,y,z value that define the extent around the queries point of reference
  70329. */
  70330. setDefaultQueryExtent(extent: Vector3): void;
  70331. /**
  70332. * Get the Bounding box extent specified by setDefaultQueryExtent
  70333. * @returns the box extent values
  70334. */
  70335. getDefaultQueryExtent(): Vector3;
  70336. /**
  70337. * Get the Bounding box extent result specified by setDefaultQueryExtent
  70338. * @param result output the box extent values
  70339. */
  70340. getDefaultQueryExtentToRef(result: Vector3): void;
  70341. /**
  70342. * Release all resources
  70343. */
  70344. dispose(): void;
  70345. }
  70346. /**
  70347. * Configures an agent
  70348. */
  70349. export interface IAgentParameters {
  70350. /**
  70351. * Agent radius. [Limit: >= 0]
  70352. */
  70353. radius: number;
  70354. /**
  70355. * Agent height. [Limit: > 0]
  70356. */
  70357. height: number;
  70358. /**
  70359. * Maximum allowed acceleration. [Limit: >= 0]
  70360. */
  70361. maxAcceleration: number;
  70362. /**
  70363. * Maximum allowed speed. [Limit: >= 0]
  70364. */
  70365. maxSpeed: number;
  70366. /**
  70367. * Defines how close a collision element must be before it is considered for steering behaviors. [Limits: > 0]
  70368. */
  70369. collisionQueryRange: number;
  70370. /**
  70371. * The path visibility optimization range. [Limit: > 0]
  70372. */
  70373. pathOptimizationRange: number;
  70374. /**
  70375. * How aggresive the agent manager should be at avoiding collisions with this agent. [Limit: >= 0]
  70376. */
  70377. separationWeight: number;
  70378. }
  70379. /**
  70380. * Configures the navigation mesh creation
  70381. */
  70382. export interface INavMeshParameters {
  70383. /**
  70384. * The xz-plane cell size to use for fields. [Limit: > 0] [Units: wu]
  70385. */
  70386. cs: number;
  70387. /**
  70388. * The y-axis cell size to use for fields. [Limit: > 0] [Units: wu]
  70389. */
  70390. ch: number;
  70391. /**
  70392. * The maximum slope that is considered walkable. [Limits: 0 <= value < 90] [Units: Degrees]
  70393. */
  70394. walkableSlopeAngle: number;
  70395. /**
  70396. * Minimum floor to 'ceiling' height that will still allow the floor area to
  70397. * be considered walkable. [Limit: >= 3] [Units: vx]
  70398. */
  70399. walkableHeight: number;
  70400. /**
  70401. * Maximum ledge height that is considered to still be traversable. [Limit: >=0] [Units: vx]
  70402. */
  70403. walkableClimb: number;
  70404. /**
  70405. * The distance to erode/shrink the walkable area of the heightfield away from
  70406. * obstructions. [Limit: >=0] [Units: vx]
  70407. */
  70408. walkableRadius: number;
  70409. /**
  70410. * The maximum allowed length for contour edges along the border of the mesh. [Limit: >=0] [Units: vx]
  70411. */
  70412. maxEdgeLen: number;
  70413. /**
  70414. * The maximum distance a simplfied contour's border edges should deviate
  70415. * the original raw contour. [Limit: >=0] [Units: vx]
  70416. */
  70417. maxSimplificationError: number;
  70418. /**
  70419. * The minimum number of cells allowed to form isolated island areas. [Limit: >=0] [Units: vx]
  70420. */
  70421. minRegionArea: number;
  70422. /**
  70423. * Any regions with a span count smaller than this value will, if possible,
  70424. * be merged with larger regions. [Limit: >=0] [Units: vx]
  70425. */
  70426. mergeRegionArea: number;
  70427. /**
  70428. * The maximum number of vertices allowed for polygons generated during the
  70429. * contour to polygon conversion process. [Limit: >= 3]
  70430. */
  70431. maxVertsPerPoly: number;
  70432. /**
  70433. * Sets the sampling distance to use when generating the detail mesh.
  70434. * (For height detail only.) [Limits: 0 or >= 0.9] [Units: wu]
  70435. */
  70436. detailSampleDist: number;
  70437. /**
  70438. * The maximum distance the detail mesh surface should deviate from heightfield
  70439. * data. (For height detail only.) [Limit: >=0] [Units: wu]
  70440. */
  70441. detailSampleMaxError: number;
  70442. }
  70443. }
  70444. declare module "babylonjs/Navigation/Plugins/recastJSPlugin" {
  70445. import { INavigationEnginePlugin, ICrowd, IAgentParameters, INavMeshParameters } from "babylonjs/Navigation/INavigationEngine";
  70446. import { Mesh } from "babylonjs/Meshes/mesh";
  70447. import { Scene } from "babylonjs/scene";
  70448. import { Vector3 } from "babylonjs/Maths/math";
  70449. import { TransformNode } from "babylonjs/Meshes/transformNode";
  70450. /**
  70451. * RecastJS navigation plugin
  70452. */
  70453. export class RecastJSPlugin implements INavigationEnginePlugin {
  70454. /**
  70455. * Reference to the Recast library
  70456. */
  70457. bjsRECAST: any;
  70458. /**
  70459. * plugin name
  70460. */
  70461. name: string;
  70462. /**
  70463. * the first navmesh created. We might extend this to support multiple navmeshes
  70464. */
  70465. navMesh: any;
  70466. /**
  70467. * Initializes the recastJS plugin
  70468. * @param recastInjection can be used to inject your own recast reference
  70469. */
  70470. constructor(recastInjection?: any);
  70471. /**
  70472. * Creates a navigation mesh
  70473. * @param meshes array of all the geometry used to compute the navigatio mesh
  70474. * @param parameters bunch of parameters used to filter geometry
  70475. */
  70476. createNavMesh(meshes: Array<Mesh>, parameters: INavMeshParameters): void;
  70477. /**
  70478. * Create a navigation mesh debug mesh
  70479. * @param scene is where the mesh will be added
  70480. * @returns debug display mesh
  70481. */
  70482. createDebugNavMesh(scene: Scene): Mesh;
  70483. /**
  70484. * Get a navigation mesh constrained position, closest to the parameter position
  70485. * @param position world position
  70486. * @returns the closest point to position constrained by the navigation mesh
  70487. */
  70488. getClosestPoint(position: Vector3): Vector3;
  70489. /**
  70490. * Get a navigation mesh constrained position, closest to the parameter position
  70491. * @param position world position
  70492. * @param result output the closest point to position constrained by the navigation mesh
  70493. */
  70494. getClosestPointToRef(position: Vector3, result: Vector3): void;
  70495. /**
  70496. * Get a navigation mesh constrained position, within a particular radius
  70497. * @param position world position
  70498. * @param maxRadius the maximum distance to the constrained world position
  70499. * @returns the closest point to position constrained by the navigation mesh
  70500. */
  70501. getRandomPointAround(position: Vector3, maxRadius: number): Vector3;
  70502. /**
  70503. * Get a navigation mesh constrained position, within a particular radius
  70504. * @param position world position
  70505. * @param maxRadius the maximum distance to the constrained world position
  70506. * @param result output the closest point to position constrained by the navigation mesh
  70507. */
  70508. getRandomPointAroundToRef(position: Vector3, maxRadius: number, result: Vector3): void;
  70509. /**
  70510. * Compute the final position from a segment made of destination-position
  70511. * @param position world position
  70512. * @param destination world position
  70513. * @returns the resulting point along the navmesh
  70514. */
  70515. moveAlong(position: Vector3, destination: Vector3): Vector3;
  70516. /**
  70517. * Compute the final position from a segment made of destination-position
  70518. * @param position world position
  70519. * @param destination world position
  70520. * @param result output the resulting point along the navmesh
  70521. */
  70522. moveAlongToRef(position: Vector3, destination: Vector3, result: Vector3): void;
  70523. /**
  70524. * Compute a navigation path from start to end. Returns an empty array if no path can be computed
  70525. * @param start world position
  70526. * @param end world position
  70527. * @returns array containing world position composing the path
  70528. */
  70529. computePath(start: Vector3, end: Vector3): Vector3[];
  70530. /**
  70531. * Create a new Crowd so you can add agents
  70532. * @param maxAgents the maximum agent count in the crowd
  70533. * @param maxAgentRadius the maximum radius an agent can have
  70534. * @param scene to attach the crowd to
  70535. * @returns the crowd you can add agents to
  70536. */
  70537. createCrowd(maxAgents: number, maxAgentRadius: number, scene: Scene): ICrowd;
  70538. /**
  70539. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  70540. * The queries will try to find a solution within those bounds
  70541. * default is (1,1,1)
  70542. * @param extent x,y,z value that define the extent around the queries point of reference
  70543. */
  70544. setDefaultQueryExtent(extent: Vector3): void;
  70545. /**
  70546. * Get the Bounding box extent specified by setDefaultQueryExtent
  70547. * @returns the box extent values
  70548. */
  70549. getDefaultQueryExtent(): Vector3;
  70550. /**
  70551. * build the navmesh from a previously saved state using getNavmeshData
  70552. * @param data the Uint8Array returned by getNavmeshData
  70553. */
  70554. buildFromNavmeshData(data: Uint8Array): void;
  70555. /**
  70556. * returns the navmesh data that can be used later. The navmesh must be built before retrieving the data
  70557. * @returns data the Uint8Array that can be saved and reused
  70558. */
  70559. getNavmeshData(): Uint8Array;
  70560. /**
  70561. * Get the Bounding box extent result specified by setDefaultQueryExtent
  70562. * @param result output the box extent values
  70563. */
  70564. getDefaultQueryExtentToRef(result: Vector3): void;
  70565. /**
  70566. * Disposes
  70567. */
  70568. dispose(): void;
  70569. /**
  70570. * If this plugin is supported
  70571. * @returns true if plugin is supported
  70572. */
  70573. isSupported(): boolean;
  70574. }
  70575. /**
  70576. * Recast detour crowd implementation
  70577. */
  70578. export class RecastJSCrowd implements ICrowd {
  70579. /**
  70580. * Recast/detour plugin
  70581. */
  70582. bjsRECASTPlugin: RecastJSPlugin;
  70583. /**
  70584. * Link to the detour crowd
  70585. */
  70586. recastCrowd: any;
  70587. /**
  70588. * One transform per agent
  70589. */
  70590. transforms: TransformNode[];
  70591. /**
  70592. * All agents created
  70593. */
  70594. agents: number[];
  70595. /**
  70596. * Link to the scene is kept to unregister the crowd from the scene
  70597. */
  70598. private _scene;
  70599. /**
  70600. * Observer for crowd updates
  70601. */
  70602. private _onBeforeAnimationsObserver;
  70603. /**
  70604. * Constructor
  70605. * @param plugin recastJS plugin
  70606. * @param maxAgents the maximum agent count in the crowd
  70607. * @param maxAgentRadius the maximum radius an agent can have
  70608. * @param scene to attach the crowd to
  70609. * @returns the crowd you can add agents to
  70610. */
  70611. constructor(plugin: RecastJSPlugin, maxAgents: number, maxAgentRadius: number, scene: Scene);
  70612. /**
  70613. * Add a new agent to the crowd with the specified parameter a corresponding transformNode.
  70614. * You can attach anything to that node. The node position is updated in the scene update tick.
  70615. * @param pos world position that will be constrained by the navigation mesh
  70616. * @param parameters agent parameters
  70617. * @param transform hooked to the agent that will be update by the scene
  70618. * @returns agent index
  70619. */
  70620. addAgent(pos: Vector3, parameters: IAgentParameters, transform: TransformNode): number;
  70621. /**
  70622. * Returns the agent position in world space
  70623. * @param index agent index returned by addAgent
  70624. * @returns world space position
  70625. */
  70626. getAgentPosition(index: number): Vector3;
  70627. /**
  70628. * Returns the agent position result in world space
  70629. * @param index agent index returned by addAgent
  70630. * @param result output world space position
  70631. */
  70632. getAgentPositionToRef(index: number, result: Vector3): void;
  70633. /**
  70634. * Returns the agent velocity in world space
  70635. * @param index agent index returned by addAgent
  70636. * @returns world space velocity
  70637. */
  70638. getAgentVelocity(index: number): Vector3;
  70639. /**
  70640. * Returns the agent velocity result in world space
  70641. * @param index agent index returned by addAgent
  70642. * @param result output world space velocity
  70643. */
  70644. getAgentVelocityToRef(index: number, result: Vector3): void;
  70645. /**
  70646. * Asks a particular agent to go to a destination. That destination is constrained by the navigation mesh
  70647. * @param index agent index returned by addAgent
  70648. * @param destination targeted world position
  70649. */
  70650. agentGoto(index: number, destination: Vector3): void;
  70651. /**
  70652. * Teleport the agent to a new position
  70653. * @param index agent index returned by addAgent
  70654. * @param destination targeted world position
  70655. */
  70656. agentTeleport(index: number, destination: Vector3): void;
  70657. /**
  70658. * Update agent parameters
  70659. * @param index agent index returned by addAgent
  70660. * @param parameters agent parameters
  70661. */
  70662. updateAgentParameters(index: number, parameters: IAgentParameters): void;
  70663. /**
  70664. * remove a particular agent previously created
  70665. * @param index agent index returned by addAgent
  70666. */
  70667. removeAgent(index: number): void;
  70668. /**
  70669. * get the list of all agents attached to this crowd
  70670. * @returns list of agent indices
  70671. */
  70672. getAgents(): number[];
  70673. /**
  70674. * Tick update done by the Scene. Agent position/velocity/acceleration is updated by this function
  70675. * @param deltaTime in seconds
  70676. */
  70677. update(deltaTime: number): void;
  70678. /**
  70679. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  70680. * The queries will try to find a solution within those bounds
  70681. * default is (1,1,1)
  70682. * @param extent x,y,z value that define the extent around the queries point of reference
  70683. */
  70684. setDefaultQueryExtent(extent: Vector3): void;
  70685. /**
  70686. * Get the Bounding box extent specified by setDefaultQueryExtent
  70687. * @returns the box extent values
  70688. */
  70689. getDefaultQueryExtent(): Vector3;
  70690. /**
  70691. * Get the Bounding box extent result specified by setDefaultQueryExtent
  70692. * @param result output the box extent values
  70693. */
  70694. getDefaultQueryExtentToRef(result: Vector3): void;
  70695. /**
  70696. * Release all resources
  70697. */
  70698. dispose(): void;
  70699. }
  70700. }
  70701. declare module "babylonjs/Navigation/Plugins/index" {
  70702. export * from "babylonjs/Navigation/Plugins/recastJSPlugin";
  70703. }
  70704. declare module "babylonjs/Navigation/index" {
  70705. export * from "babylonjs/Navigation/INavigationEngine";
  70706. export * from "babylonjs/Navigation/Plugins/index";
  70707. }
  70708. declare module "babylonjs/Offline/database" {
  70709. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  70710. /**
  70711. * Class used to enable access to IndexedDB
  70712. * @see https://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  70713. */
  70714. export class Database implements IOfflineProvider {
  70715. private _callbackManifestChecked;
  70716. private _currentSceneUrl;
  70717. private _db;
  70718. private _enableSceneOffline;
  70719. private _enableTexturesOffline;
  70720. private _manifestVersionFound;
  70721. private _mustUpdateRessources;
  70722. private _hasReachedQuota;
  70723. private _isSupported;
  70724. private _idbFactory;
  70725. /** Gets a boolean indicating if the user agent supports blob storage (this value will be updated after creating the first Database object) */
  70726. private static IsUASupportingBlobStorage;
  70727. /**
  70728. * Gets a boolean indicating if Database storate is enabled (off by default)
  70729. */
  70730. static IDBStorageEnabled: boolean;
  70731. /**
  70732. * Gets a boolean indicating if scene must be saved in the database
  70733. */
  70734. get enableSceneOffline(): boolean;
  70735. /**
  70736. * Gets a boolean indicating if textures must be saved in the database
  70737. */
  70738. get enableTexturesOffline(): boolean;
  70739. /**
  70740. * Creates a new Database
  70741. * @param urlToScene defines the url to load the scene
  70742. * @param callbackManifestChecked defines the callback to use when manifest is checked
  70743. * @param disableManifestCheck defines a boolean indicating that we want to skip the manifest validation (it will be considered validated and up to date)
  70744. */
  70745. constructor(urlToScene: string, callbackManifestChecked: (checked: boolean) => any, disableManifestCheck?: boolean);
  70746. private static _ParseURL;
  70747. private static _ReturnFullUrlLocation;
  70748. private _checkManifestFile;
  70749. /**
  70750. * Open the database and make it available
  70751. * @param successCallback defines the callback to call on success
  70752. * @param errorCallback defines the callback to call on error
  70753. */
  70754. open(successCallback: () => void, errorCallback: () => void): void;
  70755. /**
  70756. * Loads an image from the database
  70757. * @param url defines the url to load from
  70758. * @param image defines the target DOM image
  70759. */
  70760. loadImage(url: string, image: HTMLImageElement): void;
  70761. private _loadImageFromDBAsync;
  70762. private _saveImageIntoDBAsync;
  70763. private _checkVersionFromDB;
  70764. private _loadVersionFromDBAsync;
  70765. private _saveVersionIntoDBAsync;
  70766. /**
  70767. * Loads a file from database
  70768. * @param url defines the URL to load from
  70769. * @param sceneLoaded defines a callback to call on success
  70770. * @param progressCallBack defines a callback to call when progress changed
  70771. * @param errorCallback defines a callback to call on error
  70772. * @param useArrayBuffer defines a boolean to use array buffer instead of text string
  70773. */
  70774. loadFile(url: string, sceneLoaded: (data: any) => void, progressCallBack?: (data: any) => void, errorCallback?: () => void, useArrayBuffer?: boolean): void;
  70775. private _loadFileAsync;
  70776. private _saveFileAsync;
  70777. /**
  70778. * Validates if xhr data is correct
  70779. * @param xhr defines the request to validate
  70780. * @param dataType defines the expected data type
  70781. * @returns true if data is correct
  70782. */
  70783. private static _ValidateXHRData;
  70784. }
  70785. }
  70786. declare module "babylonjs/Offline/index" {
  70787. export * from "babylonjs/Offline/database";
  70788. export * from "babylonjs/Offline/IOfflineProvider";
  70789. }
  70790. declare module "babylonjs/Shaders/gpuUpdateParticles.fragment" {
  70791. /** @hidden */
  70792. export var gpuUpdateParticlesPixelShader: {
  70793. name: string;
  70794. shader: string;
  70795. };
  70796. }
  70797. declare module "babylonjs/Shaders/gpuUpdateParticles.vertex" {
  70798. /** @hidden */
  70799. export var gpuUpdateParticlesVertexShader: {
  70800. name: string;
  70801. shader: string;
  70802. };
  70803. }
  70804. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration2" {
  70805. /** @hidden */
  70806. export var clipPlaneFragmentDeclaration2: {
  70807. name: string;
  70808. shader: string;
  70809. };
  70810. }
  70811. declare module "babylonjs/Shaders/gpuRenderParticles.fragment" {
  70812. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration2";
  70813. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  70814. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  70815. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  70816. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  70817. /** @hidden */
  70818. export var gpuRenderParticlesPixelShader: {
  70819. name: string;
  70820. shader: string;
  70821. };
  70822. }
  70823. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration2" {
  70824. /** @hidden */
  70825. export var clipPlaneVertexDeclaration2: {
  70826. name: string;
  70827. shader: string;
  70828. };
  70829. }
  70830. declare module "babylonjs/Shaders/gpuRenderParticles.vertex" {
  70831. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration2";
  70832. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  70833. /** @hidden */
  70834. export var gpuRenderParticlesVertexShader: {
  70835. name: string;
  70836. shader: string;
  70837. };
  70838. }
  70839. declare module "babylonjs/Particles/gpuParticleSystem" {
  70840. import { Nullable } from "babylonjs/types";
  70841. import { Color3Gradient, IValueGradient } from "babylonjs/Misc/gradients";
  70842. import { Observable } from "babylonjs/Misc/observable";
  70843. import { Matrix } from "babylonjs/Maths/math.vector";
  70844. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  70845. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  70846. import { BaseParticleSystem } from "babylonjs/Particles/baseParticleSystem";
  70847. import { IDisposable } from "babylonjs/scene";
  70848. import { Effect } from "babylonjs/Materials/effect";
  70849. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  70850. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  70851. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  70852. import { Scene } from "babylonjs/scene";
  70853. import "babylonjs/Shaders/gpuUpdateParticles.fragment";
  70854. import "babylonjs/Shaders/gpuUpdateParticles.vertex";
  70855. import "babylonjs/Shaders/gpuRenderParticles.fragment";
  70856. import "babylonjs/Shaders/gpuRenderParticles.vertex";
  70857. /**
  70858. * This represents a GPU particle system in Babylon
  70859. * This is the fastest particle system in Babylon as it uses the GPU to update the individual particle data
  70860. * @see https://www.babylonjs-playground.com/#PU4WYI#4
  70861. */
  70862. export class GPUParticleSystem extends BaseParticleSystem implements IDisposable, IParticleSystem, IAnimatable {
  70863. /**
  70864. * The layer mask we are rendering the particles through.
  70865. */
  70866. layerMask: number;
  70867. private _capacity;
  70868. private _activeCount;
  70869. private _currentActiveCount;
  70870. private _accumulatedCount;
  70871. private _renderEffect;
  70872. private _updateEffect;
  70873. private _buffer0;
  70874. private _buffer1;
  70875. private _spriteBuffer;
  70876. private _updateVAO;
  70877. private _renderVAO;
  70878. private _targetIndex;
  70879. private _sourceBuffer;
  70880. private _targetBuffer;
  70881. private _currentRenderId;
  70882. private _started;
  70883. private _stopped;
  70884. private _timeDelta;
  70885. private _randomTexture;
  70886. private _randomTexture2;
  70887. private _attributesStrideSize;
  70888. private _updateEffectOptions;
  70889. private _randomTextureSize;
  70890. private _actualFrame;
  70891. private _customEffect;
  70892. private readonly _rawTextureWidth;
  70893. /**
  70894. * Gets a boolean indicating if the GPU particles can be rendered on current browser
  70895. */
  70896. static get IsSupported(): boolean;
  70897. /**
  70898. * An event triggered when the system is disposed.
  70899. */
  70900. onDisposeObservable: Observable<IParticleSystem>;
  70901. /**
  70902. * Gets the maximum number of particles active at the same time.
  70903. * @returns The max number of active particles.
  70904. */
  70905. getCapacity(): number;
  70906. /**
  70907. * Forces the particle to write their depth information to the depth buffer. This can help preventing other draw calls
  70908. * to override the particles.
  70909. */
  70910. forceDepthWrite: boolean;
  70911. /**
  70912. * Gets or set the number of active particles
  70913. */
  70914. get activeParticleCount(): number;
  70915. set activeParticleCount(value: number);
  70916. private _preWarmDone;
  70917. /**
  70918. * Specifies if the particles are updated in emitter local space or world space.
  70919. */
  70920. isLocal: boolean;
  70921. /** Gets or sets a matrix to use to compute projection */
  70922. defaultProjectionMatrix: Matrix;
  70923. /**
  70924. * Is this system ready to be used/rendered
  70925. * @return true if the system is ready
  70926. */
  70927. isReady(): boolean;
  70928. /**
  70929. * Gets if the system has been started. (Note: this will still be true after stop is called)
  70930. * @returns True if it has been started, otherwise false.
  70931. */
  70932. isStarted(): boolean;
  70933. /**
  70934. * Gets if the system has been stopped. (Note: rendering is still happening but the system is frozen)
  70935. * @returns True if it has been stopped, otherwise false.
  70936. */
  70937. isStopped(): boolean;
  70938. /**
  70939. * Gets a boolean indicating that the system is stopping
  70940. * @returns true if the system is currently stopping
  70941. */
  70942. isStopping(): boolean;
  70943. /**
  70944. * Gets the number of particles active at the same time.
  70945. * @returns The number of active particles.
  70946. */
  70947. getActiveCount(): number;
  70948. /**
  70949. * Starts the particle system and begins to emit
  70950. * @param delay defines the delay in milliseconds before starting the system (this.startDelay by default)
  70951. */
  70952. start(delay?: number): void;
  70953. /**
  70954. * Stops the particle system.
  70955. */
  70956. stop(): void;
  70957. /**
  70958. * Remove all active particles
  70959. */
  70960. reset(): void;
  70961. /**
  70962. * Returns the string "GPUParticleSystem"
  70963. * @returns a string containing the class name
  70964. */
  70965. getClassName(): string;
  70966. /**
  70967. * Gets the custom effect used to render the particles
  70968. * @param blendMode Blend mode for which the effect should be retrieved
  70969. * @returns The effect
  70970. */
  70971. getCustomEffect(blendMode?: number): Nullable<Effect>;
  70972. /**
  70973. * Sets the custom effect used to render the particles
  70974. * @param effect The effect to set
  70975. * @param blendMode Blend mode for which the effect should be set
  70976. */
  70977. setCustomEffect(effect: Nullable<Effect>, blendMode?: number): void;
  70978. /** @hidden */
  70979. protected _onBeforeDrawParticlesObservable: Nullable<Observable<Nullable<Effect>>>;
  70980. /**
  70981. * Observable that will be called just before the particles are drawn
  70982. */
  70983. get onBeforeDrawParticlesObservable(): Observable<Nullable<Effect>>;
  70984. /**
  70985. * Gets the name of the particle vertex shader
  70986. */
  70987. get vertexShaderName(): string;
  70988. private _colorGradientsTexture;
  70989. protected _removeGradientAndTexture(gradient: number, gradients: Nullable<IValueGradient[]>, texture: RawTexture): BaseParticleSystem;
  70990. /**
  70991. * Adds a new color gradient
  70992. * @param gradient defines the gradient to use (between 0 and 1)
  70993. * @param color1 defines the color to affect to the specified gradient
  70994. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  70995. * @returns the current particle system
  70996. */
  70997. addColorGradient(gradient: number, color1: Color4, color2?: Color4): GPUParticleSystem;
  70998. private _refreshColorGradient;
  70999. /** Force the system to rebuild all gradients that need to be resync */
  71000. forceRefreshGradients(): void;
  71001. /**
  71002. * Remove a specific color gradient
  71003. * @param gradient defines the gradient to remove
  71004. * @returns the current particle system
  71005. */
  71006. removeColorGradient(gradient: number): GPUParticleSystem;
  71007. private _angularSpeedGradientsTexture;
  71008. private _sizeGradientsTexture;
  71009. private _velocityGradientsTexture;
  71010. private _limitVelocityGradientsTexture;
  71011. private _dragGradientsTexture;
  71012. private _addFactorGradient;
  71013. /**
  71014. * Adds a new size gradient
  71015. * @param gradient defines the gradient to use (between 0 and 1)
  71016. * @param factor defines the size factor to affect to the specified gradient
  71017. * @returns the current particle system
  71018. */
  71019. addSizeGradient(gradient: number, factor: number): GPUParticleSystem;
  71020. /**
  71021. * Remove a specific size gradient
  71022. * @param gradient defines the gradient to remove
  71023. * @returns the current particle system
  71024. */
  71025. removeSizeGradient(gradient: number): GPUParticleSystem;
  71026. private _refreshFactorGradient;
  71027. /**
  71028. * Adds a new angular speed gradient
  71029. * @param gradient defines the gradient to use (between 0 and 1)
  71030. * @param factor defines the angular speed to affect to the specified gradient
  71031. * @returns the current particle system
  71032. */
  71033. addAngularSpeedGradient(gradient: number, factor: number): GPUParticleSystem;
  71034. /**
  71035. * Remove a specific angular speed gradient
  71036. * @param gradient defines the gradient to remove
  71037. * @returns the current particle system
  71038. */
  71039. removeAngularSpeedGradient(gradient: number): GPUParticleSystem;
  71040. /**
  71041. * Adds a new velocity gradient
  71042. * @param gradient defines the gradient to use (between 0 and 1)
  71043. * @param factor defines the velocity to affect to the specified gradient
  71044. * @returns the current particle system
  71045. */
  71046. addVelocityGradient(gradient: number, factor: number): GPUParticleSystem;
  71047. /**
  71048. * Remove a specific velocity gradient
  71049. * @param gradient defines the gradient to remove
  71050. * @returns the current particle system
  71051. */
  71052. removeVelocityGradient(gradient: number): GPUParticleSystem;
  71053. /**
  71054. * Adds a new limit velocity gradient
  71055. * @param gradient defines the gradient to use (between 0 and 1)
  71056. * @param factor defines the limit velocity value to affect to the specified gradient
  71057. * @returns the current particle system
  71058. */
  71059. addLimitVelocityGradient(gradient: number, factor: number): GPUParticleSystem;
  71060. /**
  71061. * Remove a specific limit velocity gradient
  71062. * @param gradient defines the gradient to remove
  71063. * @returns the current particle system
  71064. */
  71065. removeLimitVelocityGradient(gradient: number): GPUParticleSystem;
  71066. /**
  71067. * Adds a new drag gradient
  71068. * @param gradient defines the gradient to use (between 0 and 1)
  71069. * @param factor defines the drag value to affect to the specified gradient
  71070. * @returns the current particle system
  71071. */
  71072. addDragGradient(gradient: number, factor: number): GPUParticleSystem;
  71073. /**
  71074. * Remove a specific drag gradient
  71075. * @param gradient defines the gradient to remove
  71076. * @returns the current particle system
  71077. */
  71078. removeDragGradient(gradient: number): GPUParticleSystem;
  71079. /**
  71080. * Not supported by GPUParticleSystem
  71081. * @param gradient defines the gradient to use (between 0 and 1)
  71082. * @param factor defines the emit rate value to affect to the specified gradient
  71083. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  71084. * @returns the current particle system
  71085. */
  71086. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  71087. /**
  71088. * Not supported by GPUParticleSystem
  71089. * @param gradient defines the gradient to remove
  71090. * @returns the current particle system
  71091. */
  71092. removeEmitRateGradient(gradient: number): IParticleSystem;
  71093. /**
  71094. * Not supported by GPUParticleSystem
  71095. * @param gradient defines the gradient to use (between 0 and 1)
  71096. * @param factor defines the start size value to affect to the specified gradient
  71097. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  71098. * @returns the current particle system
  71099. */
  71100. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  71101. /**
  71102. * Not supported by GPUParticleSystem
  71103. * @param gradient defines the gradient to remove
  71104. * @returns the current particle system
  71105. */
  71106. removeStartSizeGradient(gradient: number): IParticleSystem;
  71107. /**
  71108. * Not supported by GPUParticleSystem
  71109. * @param gradient defines the gradient to use (between 0 and 1)
  71110. * @param min defines the color remap minimal range
  71111. * @param max defines the color remap maximal range
  71112. * @returns the current particle system
  71113. */
  71114. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  71115. /**
  71116. * Not supported by GPUParticleSystem
  71117. * @param gradient defines the gradient to remove
  71118. * @returns the current particle system
  71119. */
  71120. removeColorRemapGradient(): IParticleSystem;
  71121. /**
  71122. * Not supported by GPUParticleSystem
  71123. * @param gradient defines the gradient to use (between 0 and 1)
  71124. * @param min defines the alpha remap minimal range
  71125. * @param max defines the alpha remap maximal range
  71126. * @returns the current particle system
  71127. */
  71128. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  71129. /**
  71130. * Not supported by GPUParticleSystem
  71131. * @param gradient defines the gradient to remove
  71132. * @returns the current particle system
  71133. */
  71134. removeAlphaRemapGradient(): IParticleSystem;
  71135. /**
  71136. * Not supported by GPUParticleSystem
  71137. * @param gradient defines the gradient to use (between 0 and 1)
  71138. * @param color defines the color to affect to the specified gradient
  71139. * @returns the current particle system
  71140. */
  71141. addRampGradient(gradient: number, color: Color3): IParticleSystem;
  71142. /**
  71143. * Not supported by GPUParticleSystem
  71144. * @param gradient defines the gradient to remove
  71145. * @returns the current particle system
  71146. */
  71147. removeRampGradient(): IParticleSystem;
  71148. /**
  71149. * Not supported by GPUParticleSystem
  71150. * @returns the list of ramp gradients
  71151. */
  71152. getRampGradients(): Nullable<Array<Color3Gradient>>;
  71153. /**
  71154. * Not supported by GPUParticleSystem
  71155. * Gets or sets a boolean indicating that ramp gradients must be used
  71156. * @see https://doc.babylonjs.com/babylon101/particles#ramp-gradients
  71157. */
  71158. get useRampGradients(): boolean;
  71159. set useRampGradients(value: boolean);
  71160. /**
  71161. * Not supported by GPUParticleSystem
  71162. * @param gradient defines the gradient to use (between 0 and 1)
  71163. * @param factor defines the life time factor to affect to the specified gradient
  71164. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  71165. * @returns the current particle system
  71166. */
  71167. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  71168. /**
  71169. * Not supported by GPUParticleSystem
  71170. * @param gradient defines the gradient to remove
  71171. * @returns the current particle system
  71172. */
  71173. removeLifeTimeGradient(gradient: number): IParticleSystem;
  71174. /**
  71175. * Instantiates a GPU particle system.
  71176. * 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.
  71177. * @param name The name of the particle system
  71178. * @param options The options used to create the system
  71179. * @param sceneOrEngine The scene the particle system belongs to or the engine to use if no scene
  71180. * @param isAnimationSheetEnabled Must be true if using a spritesheet to animate the particles texture
  71181. * @param customEffect a custom effect used to change the way particles are rendered by default
  71182. */
  71183. constructor(name: string, options: Partial<{
  71184. capacity: number;
  71185. randomTextureSize: number;
  71186. }>, sceneOrEngine: Scene | ThinEngine, isAnimationSheetEnabled?: boolean, customEffect?: Nullable<Effect>);
  71187. protected _reset(): void;
  71188. private _createUpdateVAO;
  71189. private _createRenderVAO;
  71190. private _initialize;
  71191. /** @hidden */
  71192. _recreateUpdateEffect(): void;
  71193. private _getEffect;
  71194. /**
  71195. * Fill the defines array according to the current settings of the particle system
  71196. * @param defines Array to be updated
  71197. * @param blendMode blend mode to take into account when updating the array
  71198. */
  71199. fillDefines(defines: Array<string>, blendMode?: number): void;
  71200. /**
  71201. * Fill the uniforms, attributes and samplers arrays according to the current settings of the particle system
  71202. * @param uniforms Uniforms array to fill
  71203. * @param attributes Attributes array to fill
  71204. * @param samplers Samplers array to fill
  71205. */
  71206. fillUniformsAttributesAndSamplerNames(uniforms: Array<string>, attributes: Array<string>, samplers: Array<string>): void;
  71207. /** @hidden */
  71208. _recreateRenderEffect(): Effect;
  71209. /**
  71210. * Animates the particle system for the current frame by emitting new particles and or animating the living ones.
  71211. * @param preWarm defines if we are in the pre-warmimg phase
  71212. */
  71213. animate(preWarm?: boolean): void;
  71214. private _createFactorGradientTexture;
  71215. private _createSizeGradientTexture;
  71216. private _createAngularSpeedGradientTexture;
  71217. private _createVelocityGradientTexture;
  71218. private _createLimitVelocityGradientTexture;
  71219. private _createDragGradientTexture;
  71220. private _createColorGradientTexture;
  71221. /**
  71222. * Renders the particle system in its current state
  71223. * @param preWarm defines if the system should only update the particles but not render them
  71224. * @returns the current number of particles
  71225. */
  71226. render(preWarm?: boolean): number;
  71227. /**
  71228. * Rebuilds the particle system
  71229. */
  71230. rebuild(): void;
  71231. private _releaseBuffers;
  71232. private _releaseVAOs;
  71233. /**
  71234. * Disposes the particle system and free the associated resources
  71235. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  71236. */
  71237. dispose(disposeTexture?: boolean): void;
  71238. /**
  71239. * Clones the particle system.
  71240. * @param name The name of the cloned object
  71241. * @param newEmitter The new emitter to use
  71242. * @returns the cloned particle system
  71243. */
  71244. clone(name: string, newEmitter: any): GPUParticleSystem;
  71245. /**
  71246. * Serializes the particle system to a JSON object
  71247. * @param serializeTexture defines if the texture must be serialized as well
  71248. * @returns the JSON object
  71249. */
  71250. serialize(serializeTexture?: boolean): any;
  71251. /**
  71252. * Parses a JSON object to create a GPU particle system.
  71253. * @param parsedParticleSystem The JSON object to parse
  71254. * @param sceneOrEngine The scene or the engine to create the particle system in
  71255. * @param rootUrl The root url to use to load external dependencies like texture
  71256. * @param doNotStart Ignore the preventAutoStart attribute and does not start
  71257. * @returns the parsed GPU particle system
  71258. */
  71259. static Parse(parsedParticleSystem: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string, doNotStart?: boolean): GPUParticleSystem;
  71260. }
  71261. }
  71262. declare module "babylonjs/Particles/particleSystemSet" {
  71263. import { Nullable } from "babylonjs/types";
  71264. import { Color3 } from "babylonjs/Maths/math.color";
  71265. import { TransformNode } from "babylonjs/Meshes/transformNode";
  71266. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  71267. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  71268. import { Scene, IDisposable } from "babylonjs/scene";
  71269. /**
  71270. * Represents a set of particle systems working together to create a specific effect
  71271. */
  71272. export class ParticleSystemSet implements IDisposable {
  71273. /**
  71274. * Gets or sets base Assets URL
  71275. */
  71276. static BaseAssetsUrl: string;
  71277. private _emitterCreationOptions;
  71278. private _emitterNode;
  71279. /**
  71280. * Gets the particle system list
  71281. */
  71282. systems: IParticleSystem[];
  71283. /**
  71284. * Gets the emitter node used with this set
  71285. */
  71286. get emitterNode(): Nullable<TransformNode>;
  71287. /**
  71288. * Creates a new emitter mesh as a sphere
  71289. * @param options defines the options used to create the sphere
  71290. * @param renderingGroupId defines the renderingGroupId to use for the sphere
  71291. * @param scene defines the hosting scene
  71292. */
  71293. setEmitterAsSphere(options: {
  71294. diameter: number;
  71295. segments: number;
  71296. color: Color3;
  71297. }, renderingGroupId: number, scene: Scene): void;
  71298. /**
  71299. * Starts all particle systems of the set
  71300. * @param emitter defines an optional mesh to use as emitter for the particle systems
  71301. */
  71302. start(emitter?: AbstractMesh): void;
  71303. /**
  71304. * Release all associated resources
  71305. */
  71306. dispose(): void;
  71307. /**
  71308. * Serialize the set into a JSON compatible object
  71309. * @param serializeTexture defines if the texture must be serialized as well
  71310. * @returns a JSON compatible representation of the set
  71311. */
  71312. serialize(serializeTexture?: boolean): any;
  71313. /**
  71314. * Parse a new ParticleSystemSet from a serialized source
  71315. * @param data defines a JSON compatible representation of the set
  71316. * @param scene defines the hosting scene
  71317. * @param gpu defines if we want GPU particles or CPU particles
  71318. * @returns a new ParticleSystemSet
  71319. */
  71320. static Parse(data: any, scene: Scene, gpu?: boolean): ParticleSystemSet;
  71321. }
  71322. }
  71323. declare module "babylonjs/Particles/particleHelper" {
  71324. import { Nullable } from "babylonjs/types";
  71325. import { Scene } from "babylonjs/scene";
  71326. import { Vector3 } from "babylonjs/Maths/math.vector";
  71327. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  71328. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  71329. import { ParticleSystemSet } from "babylonjs/Particles/particleSystemSet";
  71330. /**
  71331. * This class is made for on one-liner static method to help creating particle system set.
  71332. */
  71333. export class ParticleHelper {
  71334. /**
  71335. * Gets or sets base Assets URL
  71336. */
  71337. static BaseAssetsUrl: string;
  71338. /** Define the Url to load snippets */
  71339. static SnippetUrl: string;
  71340. /**
  71341. * Create a default particle system that you can tweak
  71342. * @param emitter defines the emitter to use
  71343. * @param capacity defines the system capacity (default is 500 particles)
  71344. * @param scene defines the hosting scene
  71345. * @param useGPU defines if a GPUParticleSystem must be created (default is false)
  71346. * @returns the new Particle system
  71347. */
  71348. static CreateDefault(emitter: Nullable<AbstractMesh | Vector3>, capacity?: number, scene?: Scene, useGPU?: boolean): IParticleSystem;
  71349. /**
  71350. * This is the main static method (one-liner) of this helper to create different particle systems
  71351. * @param type This string represents the type to the particle system to create
  71352. * @param scene The scene where the particle system should live
  71353. * @param gpu If the system will use gpu
  71354. * @returns the ParticleSystemSet created
  71355. */
  71356. static CreateAsync(type: string, scene: Nullable<Scene>, gpu?: boolean): Promise<ParticleSystemSet>;
  71357. /**
  71358. * Static function used to export a particle system to a ParticleSystemSet variable.
  71359. * Please note that the emitter shape is not exported
  71360. * @param systems defines the particle systems to export
  71361. * @returns the created particle system set
  71362. */
  71363. static ExportSet(systems: IParticleSystem[]): ParticleSystemSet;
  71364. /**
  71365. * Creates a particle system from a snippet saved in a remote file
  71366. * @param name defines the name of the particle system to create (can be null or empty to use the one from the json data)
  71367. * @param url defines the url to load from
  71368. * @param scene defines the hosting scene
  71369. * @param gpu If the system will use gpu
  71370. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  71371. * @returns a promise that will resolve to the new particle system
  71372. */
  71373. static ParseFromFileAsync(name: Nullable<string>, url: string, scene: Scene, gpu?: boolean, rootUrl?: string): Promise<IParticleSystem>;
  71374. /**
  71375. * Creates a particle system from a snippet saved by the particle system editor
  71376. * @param snippetId defines the snippet to load (can be set to _BLANK to create a default one)
  71377. * @param scene defines the hosting scene
  71378. * @param gpu If the system will use gpu
  71379. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  71380. * @returns a promise that will resolve to the new particle system
  71381. */
  71382. static CreateFromSnippetAsync(snippetId: string, scene: Scene, gpu?: boolean, rootUrl?: string): Promise<IParticleSystem>;
  71383. }
  71384. }
  71385. declare module "babylonjs/Particles/particleSystemComponent" {
  71386. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  71387. import { Effect } from "babylonjs/Materials/effect";
  71388. import "babylonjs/Shaders/particles.vertex";
  71389. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  71390. module "babylonjs/Engines/engine" {
  71391. interface Engine {
  71392. /**
  71393. * Create an effect to use with particle systems.
  71394. * Please note that some parameters like animation sheets or not being billboard are not supported in this configuration, except if you pass
  71395. * the particle system for which you want to create a custom effect in the last parameter
  71396. * @param fragmentName defines the base name of the effect (The name of file without .fragment.fx)
  71397. * @param uniformsNames defines a list of attribute names
  71398. * @param samplers defines an array of string used to represent textures
  71399. * @param defines defines the string containing the defines to use to compile the shaders
  71400. * @param fallbacks defines the list of potential fallbacks to use if shader conmpilation fails
  71401. * @param onCompiled defines a function to call when the effect creation is successful
  71402. * @param onError defines a function to call when the effect creation has failed
  71403. * @param particleSystem the particle system you want to create the effect for
  71404. * @returns the new Effect
  71405. */
  71406. createEffectForParticles(fragmentName: string, uniformsNames: string[], samplers: string[], defines: string, fallbacks?: EffectFallbacks, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void, particleSystem?: IParticleSystem): Effect;
  71407. }
  71408. }
  71409. module "babylonjs/Meshes/mesh" {
  71410. interface Mesh {
  71411. /**
  71412. * Returns an array populated with IParticleSystem objects whose the mesh is the emitter
  71413. * @returns an array of IParticleSystem
  71414. */
  71415. getEmittedParticleSystems(): IParticleSystem[];
  71416. /**
  71417. * Returns an array populated with IParticleSystem objects whose the mesh or its children are the emitter
  71418. * @returns an array of IParticleSystem
  71419. */
  71420. getHierarchyEmittedParticleSystems(): IParticleSystem[];
  71421. }
  71422. }
  71423. }
  71424. declare module "babylonjs/Particles/pointsCloudSystem" {
  71425. import { Color4 } from "babylonjs/Maths/math";
  71426. import { Mesh } from "babylonjs/Meshes/mesh";
  71427. import { Scene, IDisposable } from "babylonjs/scene";
  71428. import { CloudPoint } from "babylonjs/Particles/cloudPoint";
  71429. /** Defines the 4 color options */
  71430. export enum PointColor {
  71431. /** color value */
  71432. Color = 2,
  71433. /** uv value */
  71434. UV = 1,
  71435. /** random value */
  71436. Random = 0,
  71437. /** stated value */
  71438. Stated = 3
  71439. }
  71440. /**
  71441. * The PointCloudSystem (PCS) is a single updatable mesh. The points corresponding to the vertices of this big mesh.
  71442. * 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.
  71443. * The PointCloudSytem is also a particle system, with each point being a particle. It provides some methods to manage the particles.
  71444. * However it is behavior agnostic. This means it has no emitter, no particle physics, no particle recycler. You have to implement your own behavior.
  71445. *
  71446. * Full documentation here : TO BE ENTERED
  71447. */
  71448. export class PointsCloudSystem implements IDisposable {
  71449. /**
  71450. * The PCS array of cloud point objects. Just access each particle as with any classic array.
  71451. * Example : var p = SPS.particles[i];
  71452. */
  71453. particles: CloudPoint[];
  71454. /**
  71455. * The PCS total number of particles. Read only. Use PCS.counter instead if you need to set your own value.
  71456. */
  71457. nbParticles: number;
  71458. /**
  71459. * This a counter for your own usage. It's not set by any SPS functions.
  71460. */
  71461. counter: number;
  71462. /**
  71463. * The PCS name. This name is also given to the underlying mesh.
  71464. */
  71465. name: string;
  71466. /**
  71467. * The PCS mesh. It's a standard BJS Mesh, so all the methods from the Mesh class are avalaible.
  71468. */
  71469. mesh: Mesh;
  71470. /**
  71471. * This empty object is intended to store some PCS specific or temporary values in order to lower the Garbage Collector activity.
  71472. * Please read :
  71473. */
  71474. vars: any;
  71475. /**
  71476. * @hidden
  71477. */
  71478. _size: number;
  71479. private _scene;
  71480. private _promises;
  71481. private _positions;
  71482. private _indices;
  71483. private _normals;
  71484. private _colors;
  71485. private _uvs;
  71486. private _indices32;
  71487. private _positions32;
  71488. private _colors32;
  71489. private _uvs32;
  71490. private _updatable;
  71491. private _isVisibilityBoxLocked;
  71492. private _alwaysVisible;
  71493. private _groups;
  71494. private _groupCounter;
  71495. private _computeParticleColor;
  71496. private _computeParticleTexture;
  71497. private _computeParticleRotation;
  71498. private _computeBoundingBox;
  71499. private _isReady;
  71500. /**
  71501. * Creates a PCS (Points Cloud System) object
  71502. * @param name (String) is the PCS name, this will be the underlying mesh name
  71503. * @param pointSize (number) is the size for each point
  71504. * @param scene (Scene) is the scene in which the PCS is added
  71505. * @param options defines the options of the PCS e.g.
  71506. * * updatable (optional boolean, default true) : if the PCS must be updatable or immutable
  71507. */
  71508. constructor(name: string, pointSize: number, scene: Scene, options?: {
  71509. updatable?: boolean;
  71510. });
  71511. /**
  71512. * Builds the PCS underlying mesh. Returns a standard Mesh.
  71513. * If no points were added to the PCS, the returned mesh is just a single point.
  71514. * @returns a promise for the created mesh
  71515. */
  71516. buildMeshAsync(): Promise<Mesh>;
  71517. /**
  71518. * @hidden
  71519. */
  71520. private _buildMesh;
  71521. private _addParticle;
  71522. private _randomUnitVector;
  71523. private _getColorIndicesForCoord;
  71524. private _setPointsColorOrUV;
  71525. private _colorFromTexture;
  71526. private _calculateDensity;
  71527. /**
  71528. * Adds points to the PCS in random positions within a unit sphere
  71529. * @param nb (positive integer) the number of particles to be created from this model
  71530. * @param pointFunction is an optional javascript function to be called for each particle on PCS creation
  71531. * @returns the number of groups in the system
  71532. */
  71533. addPoints(nb: number, pointFunction?: any): number;
  71534. /**
  71535. * Adds points to the PCS from the surface of the model shape
  71536. * @param mesh is any Mesh object that will be used as a surface model for the points
  71537. * @param nb (positive integer) the number of particles to be created from this model
  71538. * @param colorWith determines whether a point is colored using color (default), uv, random, stated or none (invisible)
  71539. * @param color (color4) to be used when colorWith is stated or color (number) when used to specify texture position
  71540. * @param range (number from 0 to 1) to determine the variation in shape and tone for a stated color
  71541. * @returns the number of groups in the system
  71542. */
  71543. addSurfacePoints(mesh: Mesh, nb: number, colorWith?: number, color?: Color4 | number, range?: number): number;
  71544. /**
  71545. * Adds points to the PCS inside the model shape
  71546. * @param mesh is any Mesh object that will be used as a surface model for the points
  71547. * @param nb (positive integer) the number of particles to be created from this model
  71548. * @param colorWith determines whether a point is colored using color (default), uv, random, stated or none (invisible)
  71549. * @param color (color4) to be used when colorWith is stated or color (number) when used to specify texture position
  71550. * @param range (number from 0 to 1) to determine the variation in shape and tone for a stated color
  71551. * @returns the number of groups in the system
  71552. */
  71553. addVolumePoints(mesh: Mesh, nb: number, colorWith?: number, color?: Color4 | number, range?: number): number;
  71554. /**
  71555. * Sets all the particles : this method actually really updates the mesh according to the particle positions, rotations, colors, textures, etc.
  71556. * This method calls `updateParticle()` for each particle of the SPS.
  71557. * For an animated SPS, it is usually called within the render loop.
  71558. * @param start The particle index in the particle array where to start to compute the particle property values _(default 0)_
  71559. * @param end The particle index in the particle array where to stop to compute the particle property values _(default nbParticle - 1)_
  71560. * @param update If the mesh must be finally updated on this call after all the particle computations _(default true)_
  71561. * @returns the PCS.
  71562. */
  71563. setParticles(start?: number, end?: number, update?: boolean): PointsCloudSystem;
  71564. /**
  71565. * Disposes the PCS.
  71566. */
  71567. dispose(): void;
  71568. /**
  71569. * Visibilty helper : Recomputes the visible size according to the mesh bounding box
  71570. * doc :
  71571. * @returns the PCS.
  71572. */
  71573. refreshVisibleSize(): PointsCloudSystem;
  71574. /**
  71575. * Visibility helper : Sets the size of a visibility box, this sets the underlying mesh bounding box.
  71576. * @param size the size (float) of the visibility box
  71577. * note : this doesn't lock the PCS mesh bounding box.
  71578. * doc :
  71579. */
  71580. setVisibilityBox(size: number): void;
  71581. /**
  71582. * Gets whether the PCS is always visible or not
  71583. * doc :
  71584. */
  71585. get isAlwaysVisible(): boolean;
  71586. /**
  71587. * Sets the PCS as always visible or not
  71588. * doc :
  71589. */
  71590. set isAlwaysVisible(val: boolean);
  71591. /**
  71592. * Tells to `setParticles()` to compute the particle rotations or not
  71593. * Default value : false. The PCS is faster when it's set to false
  71594. * Note : particle rotations are only applied to parent particles
  71595. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate
  71596. */
  71597. set computeParticleRotation(val: boolean);
  71598. /**
  71599. * Tells to `setParticles()` to compute the particle colors or not.
  71600. * Default value : true. The PCS is faster when it's set to false.
  71601. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  71602. */
  71603. set computeParticleColor(val: boolean);
  71604. set computeParticleTexture(val: boolean);
  71605. /**
  71606. * Gets if `setParticles()` computes the particle colors or not.
  71607. * Default value : false. The PCS is faster when it's set to false.
  71608. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  71609. */
  71610. get computeParticleColor(): boolean;
  71611. /**
  71612. * Gets if `setParticles()` computes the particle textures or not.
  71613. * Default value : false. The PCS is faster when it's set to false.
  71614. * Note : the particle textures are stored values, so setting `computeParticleTexture` to false will keep yet the last colors set.
  71615. */
  71616. get computeParticleTexture(): boolean;
  71617. /**
  71618. * Tells to `setParticles()` to compute or not the mesh bounding box when computing the particle positions.
  71619. */
  71620. set computeBoundingBox(val: boolean);
  71621. /**
  71622. * Gets if `setParticles()` computes or not the mesh bounding box when computing the particle positions.
  71623. */
  71624. get computeBoundingBox(): boolean;
  71625. /**
  71626. * This function does nothing. It may be overwritten to set all the particle first values.
  71627. * The PCS doesn't call this function, you may have to call it by your own.
  71628. * doc :
  71629. */
  71630. initParticles(): void;
  71631. /**
  71632. * This function does nothing. It may be overwritten to recycle a particle
  71633. * The PCS doesn't call this function, you can to call it
  71634. * doc :
  71635. * @param particle The particle to recycle
  71636. * @returns the recycled particle
  71637. */
  71638. recycleParticle(particle: CloudPoint): CloudPoint;
  71639. /**
  71640. * Updates a particle : this function should be overwritten by the user.
  71641. * It is called on each particle by `setParticles()`. This is the place to code each particle behavior.
  71642. * doc :
  71643. * @example : just set a particle position or velocity and recycle conditions
  71644. * @param particle The particle to update
  71645. * @returns the updated particle
  71646. */
  71647. updateParticle(particle: CloudPoint): CloudPoint;
  71648. /**
  71649. * This will be called before any other treatment by `setParticles()` and will be passed three parameters.
  71650. * This does nothing and may be overwritten by the user.
  71651. * @param start the particle index in the particle array where to start to iterate, same than the value passed to setParticle()
  71652. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  71653. * @param update the boolean update value actually passed to setParticles()
  71654. */
  71655. beforeUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  71656. /**
  71657. * This will be called by `setParticles()` after all the other treatments and just before the actual mesh update.
  71658. * This will be passed three parameters.
  71659. * This does nothing and may be overwritten by the user.
  71660. * @param start the particle index in the particle array where to start to iterate, same than the value passed to setParticle()
  71661. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  71662. * @param update the boolean update value actually passed to setParticles()
  71663. */
  71664. afterUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  71665. }
  71666. }
  71667. declare module "babylonjs/Particles/cloudPoint" {
  71668. import { Nullable } from "babylonjs/types";
  71669. import { Color4, Vector2, Vector3, Matrix, Quaternion } from "babylonjs/Maths/math";
  71670. import { Mesh } from "babylonjs/Meshes/mesh";
  71671. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  71672. import { PointsCloudSystem } from "babylonjs/Particles/pointsCloudSystem";
  71673. /**
  71674. * Represents one particle of a points cloud system.
  71675. */
  71676. export class CloudPoint {
  71677. /**
  71678. * particle global index
  71679. */
  71680. idx: number;
  71681. /**
  71682. * The color of the particle
  71683. */
  71684. color: Nullable<Color4>;
  71685. /**
  71686. * The world space position of the particle.
  71687. */
  71688. position: Vector3;
  71689. /**
  71690. * The world space rotation of the particle. (Not use if rotationQuaternion is set)
  71691. */
  71692. rotation: Vector3;
  71693. /**
  71694. * The world space rotation quaternion of the particle.
  71695. */
  71696. rotationQuaternion: Nullable<Quaternion>;
  71697. /**
  71698. * The uv of the particle.
  71699. */
  71700. uv: Nullable<Vector2>;
  71701. /**
  71702. * The current speed of the particle.
  71703. */
  71704. velocity: Vector3;
  71705. /**
  71706. * The pivot point in the particle local space.
  71707. */
  71708. pivot: Vector3;
  71709. /**
  71710. * Must the particle be translated from its pivot point in its local space ?
  71711. * In this case, the pivot point is set at the origin of the particle local space and the particle is translated.
  71712. * Default : false
  71713. */
  71714. translateFromPivot: boolean;
  71715. /**
  71716. * Index of this particle in the global "positions" array (Internal use)
  71717. * @hidden
  71718. */
  71719. _pos: number;
  71720. /**
  71721. * @hidden Index of this particle in the global "indices" array (Internal use)
  71722. */
  71723. _ind: number;
  71724. /**
  71725. * Group this particle belongs to
  71726. */
  71727. _group: PointsGroup;
  71728. /**
  71729. * Group id of this particle
  71730. */
  71731. groupId: number;
  71732. /**
  71733. * Index of the particle in its group id (Internal use)
  71734. */
  71735. idxInGroup: number;
  71736. /**
  71737. * @hidden Particle BoundingInfo object (Internal use)
  71738. */
  71739. _boundingInfo: BoundingInfo;
  71740. /**
  71741. * @hidden Reference to the PCS that the particle belongs to (Internal use)
  71742. */
  71743. _pcs: PointsCloudSystem;
  71744. /**
  71745. * @hidden Still set as invisible in order to skip useless computations (Internal use)
  71746. */
  71747. _stillInvisible: boolean;
  71748. /**
  71749. * @hidden Last computed particle rotation matrix
  71750. */
  71751. _rotationMatrix: number[];
  71752. /**
  71753. * Parent particle Id, if any.
  71754. * Default null.
  71755. */
  71756. parentId: Nullable<number>;
  71757. /**
  71758. * @hidden Internal global position in the PCS.
  71759. */
  71760. _globalPosition: Vector3;
  71761. /**
  71762. * Creates a Point Cloud object.
  71763. * Don't create particles manually, use instead the PCS internal tools like _addParticle()
  71764. * @param particleIndex (integer) is the particle index in the PCS pool. It's also the particle identifier.
  71765. * @param group (PointsGroup) is the group the particle belongs to
  71766. * @param groupId (integer) is the group identifier in the PCS.
  71767. * @param idxInGroup (integer) is the index of the particle in the current point group (ex: the 10th point of addPoints(30))
  71768. * @param pcs defines the PCS it is associated to
  71769. */
  71770. constructor(particleIndex: number, group: PointsGroup, groupId: number, idxInGroup: number, pcs: PointsCloudSystem);
  71771. /**
  71772. * get point size
  71773. */
  71774. get size(): Vector3;
  71775. /**
  71776. * Set point size
  71777. */
  71778. set size(scale: Vector3);
  71779. /**
  71780. * Legacy support, changed quaternion to rotationQuaternion
  71781. */
  71782. get quaternion(): Nullable<Quaternion>;
  71783. /**
  71784. * Legacy support, changed quaternion to rotationQuaternion
  71785. */
  71786. set quaternion(q: Nullable<Quaternion>);
  71787. /**
  71788. * Returns a boolean. True if the particle intersects a mesh, else false
  71789. * The intersection is computed on the particle position and Axis Aligned Bounding Box (AABB) or Sphere
  71790. * @param target is the object (point or mesh) what the intersection is computed against
  71791. * @param isSphere is boolean flag when false (default) bounding box of mesh is used, when true the bouding sphere is used
  71792. * @returns true if it intersects
  71793. */
  71794. intersectsMesh(target: Mesh, isSphere: boolean): boolean;
  71795. /**
  71796. * get the rotation matrix of the particle
  71797. * @hidden
  71798. */
  71799. getRotationMatrix(m: Matrix): void;
  71800. }
  71801. /**
  71802. * Represents a group of points in a points cloud system
  71803. * * PCS internal tool, don't use it manually.
  71804. */
  71805. export class PointsGroup {
  71806. /**
  71807. * The group id
  71808. * @hidden
  71809. */
  71810. groupID: number;
  71811. /**
  71812. * image data for group (internal use)
  71813. * @hidden
  71814. */
  71815. _groupImageData: Nullable<ArrayBufferView>;
  71816. /**
  71817. * Image Width (internal use)
  71818. * @hidden
  71819. */
  71820. _groupImgWidth: number;
  71821. /**
  71822. * Image Height (internal use)
  71823. * @hidden
  71824. */
  71825. _groupImgHeight: number;
  71826. /**
  71827. * Custom position function (internal use)
  71828. * @hidden
  71829. */
  71830. _positionFunction: Nullable<(particle: CloudPoint, i?: number, s?: number) => void>;
  71831. /**
  71832. * density per facet for surface points
  71833. * @hidden
  71834. */
  71835. _groupDensity: number[];
  71836. /**
  71837. * Only when points are colored by texture carries pointer to texture list array
  71838. * @hidden
  71839. */
  71840. _textureNb: number;
  71841. /**
  71842. * Creates a points group object. This is an internal reference to produce particles for the PCS.
  71843. * PCS internal tool, don't use it manually.
  71844. * @hidden
  71845. */
  71846. constructor(id: number, posFunction: Nullable<(particle: CloudPoint, i?: number, s?: number) => void>);
  71847. }
  71848. }
  71849. declare module "babylonjs/Particles/index" {
  71850. export * from "babylonjs/Particles/baseParticleSystem";
  71851. export * from "babylonjs/Particles/EmitterTypes/index";
  71852. export * from "babylonjs/Particles/gpuParticleSystem";
  71853. export * from "babylonjs/Particles/IParticleSystem";
  71854. export * from "babylonjs/Particles/particle";
  71855. export * from "babylonjs/Particles/particleHelper";
  71856. export * from "babylonjs/Particles/particleSystem";
  71857. import "babylonjs/Particles/particleSystemComponent";
  71858. export * from "babylonjs/Particles/particleSystemComponent";
  71859. export * from "babylonjs/Particles/particleSystemSet";
  71860. export * from "babylonjs/Particles/solidParticle";
  71861. export * from "babylonjs/Particles/solidParticleSystem";
  71862. export * from "babylonjs/Particles/cloudPoint";
  71863. export * from "babylonjs/Particles/pointsCloudSystem";
  71864. export * from "babylonjs/Particles/subEmitter";
  71865. }
  71866. declare module "babylonjs/Physics/physicsEngineComponent" {
  71867. import { Nullable } from "babylonjs/types";
  71868. import { Observable, Observer } from "babylonjs/Misc/observable";
  71869. import { Vector3 } from "babylonjs/Maths/math.vector";
  71870. import { Mesh } from "babylonjs/Meshes/mesh";
  71871. import { ISceneComponent } from "babylonjs/sceneComponent";
  71872. import { Scene } from "babylonjs/scene";
  71873. import { Node } from "babylonjs/node";
  71874. import { IPhysicsEngine, IPhysicsEnginePlugin } from "babylonjs/Physics/IPhysicsEngine";
  71875. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  71876. module "babylonjs/scene" {
  71877. interface Scene {
  71878. /** @hidden (Backing field) */
  71879. _physicsEngine: Nullable<IPhysicsEngine>;
  71880. /** @hidden */
  71881. _physicsTimeAccumulator: number;
  71882. /**
  71883. * Gets the current physics engine
  71884. * @returns a IPhysicsEngine or null if none attached
  71885. */
  71886. getPhysicsEngine(): Nullable<IPhysicsEngine>;
  71887. /**
  71888. * Enables physics to the current scene
  71889. * @param gravity defines the scene's gravity for the physics engine
  71890. * @param plugin defines the physics engine to be used. defaults to OimoJS.
  71891. * @return a boolean indicating if the physics engine was initialized
  71892. */
  71893. enablePhysics(gravity: Nullable<Vector3>, plugin?: IPhysicsEnginePlugin): boolean;
  71894. /**
  71895. * Disables and disposes the physics engine associated with the scene
  71896. */
  71897. disablePhysicsEngine(): void;
  71898. /**
  71899. * Gets a boolean indicating if there is an active physics engine
  71900. * @returns a boolean indicating if there is an active physics engine
  71901. */
  71902. isPhysicsEnabled(): boolean;
  71903. /**
  71904. * Deletes a physics compound impostor
  71905. * @param compound defines the compound to delete
  71906. */
  71907. deleteCompoundImpostor(compound: any): void;
  71908. /**
  71909. * An event triggered when physic simulation is about to be run
  71910. */
  71911. onBeforePhysicsObservable: Observable<Scene>;
  71912. /**
  71913. * An event triggered when physic simulation has been done
  71914. */
  71915. onAfterPhysicsObservable: Observable<Scene>;
  71916. }
  71917. }
  71918. module "babylonjs/Meshes/abstractMesh" {
  71919. interface AbstractMesh {
  71920. /** @hidden */
  71921. _physicsImpostor: Nullable<PhysicsImpostor>;
  71922. /**
  71923. * Gets or sets impostor used for physic simulation
  71924. * @see https://doc.babylonjs.com/features/physics_engine
  71925. */
  71926. physicsImpostor: Nullable<PhysicsImpostor>;
  71927. /**
  71928. * Gets the current physics impostor
  71929. * @see https://doc.babylonjs.com/features/physics_engine
  71930. * @returns a physics impostor or null
  71931. */
  71932. getPhysicsImpostor(): Nullable<PhysicsImpostor>;
  71933. /** Apply a physic impulse to the mesh
  71934. * @param force defines the force to apply
  71935. * @param contactPoint defines where to apply the force
  71936. * @returns the current mesh
  71937. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  71938. */
  71939. applyImpulse(force: Vector3, contactPoint: Vector3): AbstractMesh;
  71940. /**
  71941. * Creates a physic joint between two meshes
  71942. * @param otherMesh defines the other mesh to use
  71943. * @param pivot1 defines the pivot to use on this mesh
  71944. * @param pivot2 defines the pivot to use on the other mesh
  71945. * @param options defines additional options (can be plugin dependent)
  71946. * @returns the current mesh
  71947. * @see https://www.babylonjs-playground.com/#0BS5U0#0
  71948. */
  71949. setPhysicsLinkWith(otherMesh: Mesh, pivot1: Vector3, pivot2: Vector3, options?: any): AbstractMesh;
  71950. /** @hidden */
  71951. _disposePhysicsObserver: Nullable<Observer<Node>>;
  71952. }
  71953. }
  71954. /**
  71955. * Defines the physics engine scene component responsible to manage a physics engine
  71956. */
  71957. export class PhysicsEngineSceneComponent implements ISceneComponent {
  71958. /**
  71959. * The component name helpful to identify the component in the list of scene components.
  71960. */
  71961. readonly name: string;
  71962. /**
  71963. * The scene the component belongs to.
  71964. */
  71965. scene: Scene;
  71966. /**
  71967. * Creates a new instance of the component for the given scene
  71968. * @param scene Defines the scene to register the component in
  71969. */
  71970. constructor(scene: Scene);
  71971. /**
  71972. * Registers the component in a given scene
  71973. */
  71974. register(): void;
  71975. /**
  71976. * Rebuilds the elements related to this component in case of
  71977. * context lost for instance.
  71978. */
  71979. rebuild(): void;
  71980. /**
  71981. * Disposes the component and the associated ressources
  71982. */
  71983. dispose(): void;
  71984. }
  71985. }
  71986. declare module "babylonjs/Physics/physicsHelper" {
  71987. import { Nullable } from "babylonjs/types";
  71988. import { Vector3 } from "babylonjs/Maths/math.vector";
  71989. import { Mesh } from "babylonjs/Meshes/mesh";
  71990. import { Scene } from "babylonjs/scene";
  71991. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  71992. /**
  71993. * A helper for physics simulations
  71994. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  71995. */
  71996. export class PhysicsHelper {
  71997. private _scene;
  71998. private _physicsEngine;
  71999. /**
  72000. * Initializes the Physics helper
  72001. * @param scene Babylon.js scene
  72002. */
  72003. constructor(scene: Scene);
  72004. /**
  72005. * Applies a radial explosion impulse
  72006. * @param origin the origin of the explosion
  72007. * @param radiusOrEventOptions the radius or the options of radial explosion
  72008. * @param strength the explosion strength
  72009. * @param falloff possible options: Constant & Linear. Defaults to Constant
  72010. * @returns A physics radial explosion event, or null
  72011. */
  72012. applyRadialExplosionImpulse(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsRadialExplosionEvent>;
  72013. /**
  72014. * Applies a radial explosion force
  72015. * @param origin the origin of the explosion
  72016. * @param radiusOrEventOptions the radius or the options of radial explosion
  72017. * @param strength the explosion strength
  72018. * @param falloff possible options: Constant & Linear. Defaults to Constant
  72019. * @returns A physics radial explosion event, or null
  72020. */
  72021. applyRadialExplosionForce(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsRadialExplosionEvent>;
  72022. /**
  72023. * Creates a gravitational field
  72024. * @param origin the origin of the explosion
  72025. * @param radiusOrEventOptions the radius or the options of radial explosion
  72026. * @param strength the explosion strength
  72027. * @param falloff possible options: Constant & Linear. Defaults to Constant
  72028. * @returns A physics gravitational field event, or null
  72029. */
  72030. gravitationalField(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsGravitationalFieldEvent>;
  72031. /**
  72032. * Creates a physics updraft event
  72033. * @param origin the origin of the updraft
  72034. * @param radiusOrEventOptions the radius or the options of the updraft
  72035. * @param strength the strength of the updraft
  72036. * @param height the height of the updraft
  72037. * @param updraftMode possible options: Center & Perpendicular. Defaults to Center
  72038. * @returns A physics updraft event, or null
  72039. */
  72040. updraft(origin: Vector3, radiusOrEventOptions: number | PhysicsUpdraftEventOptions, strength?: number, height?: number, updraftMode?: PhysicsUpdraftMode): Nullable<PhysicsUpdraftEvent>;
  72041. /**
  72042. * Creates a physics vortex event
  72043. * @param origin the of the vortex
  72044. * @param radiusOrEventOptions the radius or the options of the vortex
  72045. * @param strength the strength of the vortex
  72046. * @param height the height of the vortex
  72047. * @returns a Physics vortex event, or null
  72048. * A physics vortex event or null
  72049. */
  72050. vortex(origin: Vector3, radiusOrEventOptions: number | PhysicsVortexEventOptions, strength?: number, height?: number): Nullable<PhysicsVortexEvent>;
  72051. }
  72052. /**
  72053. * Represents a physics radial explosion event
  72054. */
  72055. class PhysicsRadialExplosionEvent {
  72056. private _scene;
  72057. private _options;
  72058. private _sphere;
  72059. private _dataFetched;
  72060. /**
  72061. * Initializes a radial explosioin event
  72062. * @param _scene BabylonJS scene
  72063. * @param _options The options for the vortex event
  72064. */
  72065. constructor(_scene: Scene, _options: PhysicsRadialExplosionEventOptions);
  72066. /**
  72067. * Returns the data related to the radial explosion event (sphere).
  72068. * @returns The radial explosion event data
  72069. */
  72070. getData(): PhysicsRadialExplosionEventData;
  72071. /**
  72072. * Returns the force and contact point of the impostor or false, if the impostor is not affected by the force/impulse.
  72073. * @param impostor A physics imposter
  72074. * @param origin the origin of the explosion
  72075. * @returns {Nullable<PhysicsHitData>} A physics force and contact point, or null
  72076. */
  72077. getImpostorHitData(impostor: PhysicsImpostor, origin: Vector3): Nullable<PhysicsHitData>;
  72078. /**
  72079. * Triggers affecterd impostors callbacks
  72080. * @param affectedImpostorsWithData defines the list of affected impostors (including associated data)
  72081. */
  72082. triggerAffectedImpostorsCallback(affectedImpostorsWithData: Array<PhysicsAffectedImpostorWithData>): void;
  72083. /**
  72084. * Disposes the sphere.
  72085. * @param force Specifies if the sphere should be disposed by force
  72086. */
  72087. dispose(force?: boolean): void;
  72088. /*** Helpers ***/
  72089. private _prepareSphere;
  72090. private _intersectsWithSphere;
  72091. }
  72092. /**
  72093. * Represents a gravitational field event
  72094. */
  72095. class PhysicsGravitationalFieldEvent {
  72096. private _physicsHelper;
  72097. private _scene;
  72098. private _origin;
  72099. private _options;
  72100. private _tickCallback;
  72101. private _sphere;
  72102. private _dataFetched;
  72103. /**
  72104. * Initializes the physics gravitational field event
  72105. * @param _physicsHelper A physics helper
  72106. * @param _scene BabylonJS scene
  72107. * @param _origin The origin position of the gravitational field event
  72108. * @param _options The options for the vortex event
  72109. */
  72110. constructor(_physicsHelper: PhysicsHelper, _scene: Scene, _origin: Vector3, _options: PhysicsRadialExplosionEventOptions);
  72111. /**
  72112. * Returns the data related to the gravitational field event (sphere).
  72113. * @returns A gravitational field event
  72114. */
  72115. getData(): PhysicsGravitationalFieldEventData;
  72116. /**
  72117. * Enables the gravitational field.
  72118. */
  72119. enable(): void;
  72120. /**
  72121. * Disables the gravitational field.
  72122. */
  72123. disable(): void;
  72124. /**
  72125. * Disposes the sphere.
  72126. * @param force The force to dispose from the gravitational field event
  72127. */
  72128. dispose(force?: boolean): void;
  72129. private _tick;
  72130. }
  72131. /**
  72132. * Represents a physics updraft event
  72133. */
  72134. class PhysicsUpdraftEvent {
  72135. private _scene;
  72136. private _origin;
  72137. private _options;
  72138. private _physicsEngine;
  72139. private _originTop;
  72140. private _originDirection;
  72141. private _tickCallback;
  72142. private _cylinder;
  72143. private _cylinderPosition;
  72144. private _dataFetched;
  72145. /**
  72146. * Initializes the physics updraft event
  72147. * @param _scene BabylonJS scene
  72148. * @param _origin The origin position of the updraft
  72149. * @param _options The options for the updraft event
  72150. */
  72151. constructor(_scene: Scene, _origin: Vector3, _options: PhysicsUpdraftEventOptions);
  72152. /**
  72153. * Returns the data related to the updraft event (cylinder).
  72154. * @returns A physics updraft event
  72155. */
  72156. getData(): PhysicsUpdraftEventData;
  72157. /**
  72158. * Enables the updraft.
  72159. */
  72160. enable(): void;
  72161. /**
  72162. * Disables the updraft.
  72163. */
  72164. disable(): void;
  72165. /**
  72166. * Disposes the cylinder.
  72167. * @param force Specifies if the updraft should be disposed by force
  72168. */
  72169. dispose(force?: boolean): void;
  72170. private getImpostorHitData;
  72171. private _tick;
  72172. /*** Helpers ***/
  72173. private _prepareCylinder;
  72174. private _intersectsWithCylinder;
  72175. }
  72176. /**
  72177. * Represents a physics vortex event
  72178. */
  72179. class PhysicsVortexEvent {
  72180. private _scene;
  72181. private _origin;
  72182. private _options;
  72183. private _physicsEngine;
  72184. private _originTop;
  72185. private _tickCallback;
  72186. private _cylinder;
  72187. private _cylinderPosition;
  72188. private _dataFetched;
  72189. /**
  72190. * Initializes the physics vortex event
  72191. * @param _scene The BabylonJS scene
  72192. * @param _origin The origin position of the vortex
  72193. * @param _options The options for the vortex event
  72194. */
  72195. constructor(_scene: Scene, _origin: Vector3, _options: PhysicsVortexEventOptions);
  72196. /**
  72197. * Returns the data related to the vortex event (cylinder).
  72198. * @returns The physics vortex event data
  72199. */
  72200. getData(): PhysicsVortexEventData;
  72201. /**
  72202. * Enables the vortex.
  72203. */
  72204. enable(): void;
  72205. /**
  72206. * Disables the cortex.
  72207. */
  72208. disable(): void;
  72209. /**
  72210. * Disposes the sphere.
  72211. * @param force
  72212. */
  72213. dispose(force?: boolean): void;
  72214. private getImpostorHitData;
  72215. private _tick;
  72216. /*** Helpers ***/
  72217. private _prepareCylinder;
  72218. private _intersectsWithCylinder;
  72219. }
  72220. /**
  72221. * Options fot the radial explosion event
  72222. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72223. */
  72224. export class PhysicsRadialExplosionEventOptions {
  72225. /**
  72226. * The radius of the sphere for the radial explosion.
  72227. */
  72228. radius: number;
  72229. /**
  72230. * The strenth of the explosion.
  72231. */
  72232. strength: number;
  72233. /**
  72234. * The strenght of the force in correspondence to the distance of the affected object
  72235. */
  72236. falloff: PhysicsRadialImpulseFalloff;
  72237. /**
  72238. * Sphere options for the radial explosion.
  72239. */
  72240. sphere: {
  72241. segments: number;
  72242. diameter: number;
  72243. };
  72244. /**
  72245. * Sphere options for the radial explosion.
  72246. */
  72247. affectedImpostorsCallback: (affectedImpostorsWithData: Array<PhysicsAffectedImpostorWithData>) => void;
  72248. }
  72249. /**
  72250. * Options fot the updraft event
  72251. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72252. */
  72253. export class PhysicsUpdraftEventOptions {
  72254. /**
  72255. * The radius of the cylinder for the vortex
  72256. */
  72257. radius: number;
  72258. /**
  72259. * The strenth of the updraft.
  72260. */
  72261. strength: number;
  72262. /**
  72263. * The height of the cylinder for the updraft.
  72264. */
  72265. height: number;
  72266. /**
  72267. * The mode for the the updraft.
  72268. */
  72269. updraftMode: PhysicsUpdraftMode;
  72270. }
  72271. /**
  72272. * Options fot the vortex event
  72273. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72274. */
  72275. export class PhysicsVortexEventOptions {
  72276. /**
  72277. * The radius of the cylinder for the vortex
  72278. */
  72279. radius: number;
  72280. /**
  72281. * The strenth of the vortex.
  72282. */
  72283. strength: number;
  72284. /**
  72285. * The height of the cylinder for the vortex.
  72286. */
  72287. height: number;
  72288. /**
  72289. * At which distance, relative to the radius the centripetal forces should kick in? Range: 0-1
  72290. */
  72291. centripetalForceThreshold: number;
  72292. /**
  72293. * This multiplier determines with how much force the objects will be pushed sideways/around the vortex, when below the treshold.
  72294. */
  72295. centripetalForceMultiplier: number;
  72296. /**
  72297. * This multiplier determines with how much force the objects will be pushed sideways/around the vortex, when above the treshold.
  72298. */
  72299. centrifugalForceMultiplier: number;
  72300. /**
  72301. * This multiplier determines with how much force the objects will be pushed upwards, when in the vortex.
  72302. */
  72303. updraftForceMultiplier: number;
  72304. }
  72305. /**
  72306. * The strenght of the force in correspondence to the distance of the affected object
  72307. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72308. */
  72309. export enum PhysicsRadialImpulseFalloff {
  72310. /** Defines that impulse is constant in strength across it's whole radius */
  72311. Constant = 0,
  72312. /** Defines that impulse gets weaker if it's further from the origin */
  72313. Linear = 1
  72314. }
  72315. /**
  72316. * The strength of the force in correspondence to the distance of the affected object
  72317. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72318. */
  72319. export enum PhysicsUpdraftMode {
  72320. /** Defines that the upstream forces will pull towards the top center of the cylinder */
  72321. Center = 0,
  72322. /** Defines that once a impostor is inside the cylinder, it will shoot out perpendicular from the ground of the cylinder */
  72323. Perpendicular = 1
  72324. }
  72325. /**
  72326. * Interface for a physics hit data
  72327. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72328. */
  72329. export interface PhysicsHitData {
  72330. /**
  72331. * The force applied at the contact point
  72332. */
  72333. force: Vector3;
  72334. /**
  72335. * The contact point
  72336. */
  72337. contactPoint: Vector3;
  72338. /**
  72339. * The distance from the origin to the contact point
  72340. */
  72341. distanceFromOrigin: number;
  72342. }
  72343. /**
  72344. * Interface for radial explosion event data
  72345. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72346. */
  72347. export interface PhysicsRadialExplosionEventData {
  72348. /**
  72349. * A sphere used for the radial explosion event
  72350. */
  72351. sphere: Mesh;
  72352. }
  72353. /**
  72354. * Interface for gravitational field event data
  72355. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72356. */
  72357. export interface PhysicsGravitationalFieldEventData {
  72358. /**
  72359. * A sphere mesh used for the gravitational field event
  72360. */
  72361. sphere: Mesh;
  72362. }
  72363. /**
  72364. * Interface for updraft event data
  72365. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72366. */
  72367. export interface PhysicsUpdraftEventData {
  72368. /**
  72369. * A cylinder used for the updraft event
  72370. */
  72371. cylinder: Mesh;
  72372. }
  72373. /**
  72374. * Interface for vortex event data
  72375. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72376. */
  72377. export interface PhysicsVortexEventData {
  72378. /**
  72379. * A cylinder used for the vortex event
  72380. */
  72381. cylinder: Mesh;
  72382. }
  72383. /**
  72384. * Interface for an affected physics impostor
  72385. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72386. */
  72387. export interface PhysicsAffectedImpostorWithData {
  72388. /**
  72389. * The impostor affected by the effect
  72390. */
  72391. impostor: PhysicsImpostor;
  72392. /**
  72393. * The data about the hit/horce from the explosion
  72394. */
  72395. hitData: PhysicsHitData;
  72396. }
  72397. }
  72398. declare module "babylonjs/Physics/Plugins/index" {
  72399. export * from "babylonjs/Physics/Plugins/cannonJSPlugin";
  72400. export * from "babylonjs/Physics/Plugins/ammoJSPlugin";
  72401. export * from "babylonjs/Physics/Plugins/oimoJSPlugin";
  72402. }
  72403. declare module "babylonjs/Physics/index" {
  72404. export * from "babylonjs/Physics/IPhysicsEngine";
  72405. export * from "babylonjs/Physics/physicsEngine";
  72406. export * from "babylonjs/Physics/physicsEngineComponent";
  72407. export * from "babylonjs/Physics/physicsHelper";
  72408. export * from "babylonjs/Physics/physicsImpostor";
  72409. export * from "babylonjs/Physics/physicsJoint";
  72410. export * from "babylonjs/Physics/Plugins/index";
  72411. }
  72412. declare module "babylonjs/Shaders/blackAndWhite.fragment" {
  72413. /** @hidden */
  72414. export var blackAndWhitePixelShader: {
  72415. name: string;
  72416. shader: string;
  72417. };
  72418. }
  72419. declare module "babylonjs/PostProcesses/blackAndWhitePostProcess" {
  72420. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72421. import { Camera } from "babylonjs/Cameras/camera";
  72422. import { Engine } from "babylonjs/Engines/engine";
  72423. import "babylonjs/Shaders/blackAndWhite.fragment";
  72424. import { Nullable } from "babylonjs/types";
  72425. import { Scene } from "babylonjs/scene";
  72426. /**
  72427. * Post process used to render in black and white
  72428. */
  72429. export class BlackAndWhitePostProcess extends PostProcess {
  72430. /**
  72431. * Linear about to convert he result to black and white (default: 1)
  72432. */
  72433. degree: number;
  72434. /**
  72435. * Gets a string identifying the name of the class
  72436. * @returns "BlackAndWhitePostProcess" string
  72437. */
  72438. getClassName(): string;
  72439. /**
  72440. * Creates a black and white post process
  72441. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#black-and-white
  72442. * @param name The name of the effect.
  72443. * @param options The required width/height ratio to downsize to before computing the render pass.
  72444. * @param camera The camera to apply the render pass to.
  72445. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  72446. * @param engine The engine which the post process will be applied. (default: current engine)
  72447. * @param reusable If the post process can be reused on the same frame. (default: false)
  72448. */
  72449. constructor(name: string, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  72450. /** @hidden */
  72451. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<BlackAndWhitePostProcess>;
  72452. }
  72453. }
  72454. declare module "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect" {
  72455. import { Nullable } from "babylonjs/types";
  72456. import { Camera } from "babylonjs/Cameras/camera";
  72457. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  72458. import { Engine } from "babylonjs/Engines/engine";
  72459. /**
  72460. * This represents a set of one or more post processes in Babylon.
  72461. * A post process can be used to apply a shader to a texture after it is rendered.
  72462. * @example https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  72463. */
  72464. export class PostProcessRenderEffect {
  72465. private _postProcesses;
  72466. private _getPostProcesses;
  72467. private _singleInstance;
  72468. private _cameras;
  72469. private _indicesForCamera;
  72470. /**
  72471. * Name of the effect
  72472. * @hidden
  72473. */
  72474. _name: string;
  72475. /**
  72476. * Instantiates a post process render effect.
  72477. * A post process can be used to apply a shader to a texture after it is rendered.
  72478. * @param engine The engine the effect is tied to
  72479. * @param name The name of the effect
  72480. * @param getPostProcesses A function that returns a set of post processes which the effect will run in order to be run.
  72481. * @param singleInstance False if this post process can be run on multiple cameras. (default: true)
  72482. */
  72483. constructor(engine: Engine, name: string, getPostProcesses: () => Nullable<PostProcess | Array<PostProcess>>, singleInstance?: boolean);
  72484. /**
  72485. * Checks if all the post processes in the effect are supported.
  72486. */
  72487. get isSupported(): boolean;
  72488. /**
  72489. * Updates the current state of the effect
  72490. * @hidden
  72491. */
  72492. _update(): void;
  72493. /**
  72494. * Attaches the effect on cameras
  72495. * @param cameras The camera to attach to.
  72496. * @hidden
  72497. */
  72498. _attachCameras(cameras: Camera): void;
  72499. /**
  72500. * Attaches the effect on cameras
  72501. * @param cameras The camera to attach to.
  72502. * @hidden
  72503. */
  72504. _attachCameras(cameras: Camera[]): void;
  72505. /**
  72506. * Detaches the effect on cameras
  72507. * @param cameras The camera to detatch from.
  72508. * @hidden
  72509. */
  72510. _detachCameras(cameras: Camera): void;
  72511. /**
  72512. * Detatches the effect on cameras
  72513. * @param cameras The camera to detatch from.
  72514. * @hidden
  72515. */
  72516. _detachCameras(cameras: Camera[]): void;
  72517. /**
  72518. * Enables the effect on given cameras
  72519. * @param cameras The camera to enable.
  72520. * @hidden
  72521. */
  72522. _enable(cameras: Camera): void;
  72523. /**
  72524. * Enables the effect on given cameras
  72525. * @param cameras The camera to enable.
  72526. * @hidden
  72527. */
  72528. _enable(cameras: Nullable<Camera[]>): void;
  72529. /**
  72530. * Disables the effect on the given cameras
  72531. * @param cameras The camera to disable.
  72532. * @hidden
  72533. */
  72534. _disable(cameras: Camera): void;
  72535. /**
  72536. * Disables the effect on the given cameras
  72537. * @param cameras The camera to disable.
  72538. * @hidden
  72539. */
  72540. _disable(cameras: Nullable<Camera[]>): void;
  72541. /**
  72542. * Gets a list of the post processes contained in the effect.
  72543. * @param camera The camera to get the post processes on.
  72544. * @returns The list of the post processes in the effect.
  72545. */
  72546. getPostProcesses(camera?: Camera): Nullable<Array<PostProcess>>;
  72547. }
  72548. }
  72549. declare module "babylonjs/Shaders/extractHighlights.fragment" {
  72550. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  72551. /** @hidden */
  72552. export var extractHighlightsPixelShader: {
  72553. name: string;
  72554. shader: string;
  72555. };
  72556. }
  72557. declare module "babylonjs/PostProcesses/extractHighlightsPostProcess" {
  72558. import { Nullable } from "babylonjs/types";
  72559. import { Camera } from "babylonjs/Cameras/camera";
  72560. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72561. import { Engine } from "babylonjs/Engines/engine";
  72562. import "babylonjs/Shaders/extractHighlights.fragment";
  72563. /**
  72564. * 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.
  72565. */
  72566. export class ExtractHighlightsPostProcess extends PostProcess {
  72567. /**
  72568. * The luminance threshold, pixels below this value will be set to black.
  72569. */
  72570. threshold: number;
  72571. /** @hidden */
  72572. _exposure: number;
  72573. /**
  72574. * Post process which has the input texture to be used when performing highlight extraction
  72575. * @hidden
  72576. */
  72577. _inputPostProcess: Nullable<PostProcess>;
  72578. /**
  72579. * Gets a string identifying the name of the class
  72580. * @returns "ExtractHighlightsPostProcess" string
  72581. */
  72582. getClassName(): string;
  72583. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  72584. }
  72585. }
  72586. declare module "babylonjs/Shaders/bloomMerge.fragment" {
  72587. /** @hidden */
  72588. export var bloomMergePixelShader: {
  72589. name: string;
  72590. shader: string;
  72591. };
  72592. }
  72593. declare module "babylonjs/PostProcesses/bloomMergePostProcess" {
  72594. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72595. import { Nullable } from "babylonjs/types";
  72596. import { Engine } from "babylonjs/Engines/engine";
  72597. import { Camera } from "babylonjs/Cameras/camera";
  72598. import "babylonjs/Shaders/bloomMerge.fragment";
  72599. /**
  72600. * The BloomMergePostProcess merges blurred images with the original based on the values of the circle of confusion.
  72601. */
  72602. export class BloomMergePostProcess extends PostProcess {
  72603. /** Weight of the bloom to be added to the original input. */
  72604. weight: number;
  72605. /**
  72606. * Gets a string identifying the name of the class
  72607. * @returns "BloomMergePostProcess" string
  72608. */
  72609. getClassName(): string;
  72610. /**
  72611. * Creates a new instance of @see BloomMergePostProcess
  72612. * @param name The name of the effect.
  72613. * @param originalFromInput Post process which's input will be used for the merge.
  72614. * @param blurred Blurred highlights post process which's output will be used.
  72615. * @param weight Weight of the bloom to be added to the original input.
  72616. * @param options The required width/height ratio to downsize to before computing the render pass.
  72617. * @param camera The camera to apply the render pass to.
  72618. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  72619. * @param engine The engine which the post process will be applied. (default: current engine)
  72620. * @param reusable If the post process can be reused on the same frame. (default: false)
  72621. * @param textureType Type of textures used when performing the post process. (default: 0)
  72622. * @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)
  72623. */
  72624. constructor(name: string, originalFromInput: PostProcess, blurred: PostProcess,
  72625. /** Weight of the bloom to be added to the original input. */
  72626. weight: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  72627. }
  72628. }
  72629. declare module "babylonjs/PostProcesses/bloomEffect" {
  72630. import { PostProcessRenderEffect } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect";
  72631. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  72632. import { ExtractHighlightsPostProcess } from "babylonjs/PostProcesses/extractHighlightsPostProcess";
  72633. import { Camera } from "babylonjs/Cameras/camera";
  72634. import { Scene } from "babylonjs/scene";
  72635. /**
  72636. * The bloom effect spreads bright areas of an image to simulate artifacts seen in cameras
  72637. */
  72638. export class BloomEffect extends PostProcessRenderEffect {
  72639. private bloomScale;
  72640. /**
  72641. * @hidden Internal
  72642. */
  72643. _effects: Array<PostProcess>;
  72644. /**
  72645. * @hidden Internal
  72646. */
  72647. _downscale: ExtractHighlightsPostProcess;
  72648. private _blurX;
  72649. private _blurY;
  72650. private _merge;
  72651. /**
  72652. * The luminance threshold to find bright areas of the image to bloom.
  72653. */
  72654. get threshold(): number;
  72655. set threshold(value: number);
  72656. /**
  72657. * The strength of the bloom.
  72658. */
  72659. get weight(): number;
  72660. set weight(value: number);
  72661. /**
  72662. * Specifies the size of the bloom blur kernel, relative to the final output size
  72663. */
  72664. get kernel(): number;
  72665. set kernel(value: number);
  72666. /**
  72667. * Creates a new instance of @see BloomEffect
  72668. * @param scene The scene the effect belongs to.
  72669. * @param bloomScale The ratio of the blur texture to the input texture that should be used to compute the bloom.
  72670. * @param bloomKernel The size of the kernel to be used when applying the blur.
  72671. * @param bloomWeight The the strength of bloom.
  72672. * @param pipelineTextureType The type of texture to be used when performing the post processing.
  72673. * @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)
  72674. */
  72675. constructor(scene: Scene, bloomScale: number, bloomWeight: number, bloomKernel: number, pipelineTextureType?: number, blockCompilation?: boolean);
  72676. /**
  72677. * Disposes each of the internal effects for a given camera.
  72678. * @param camera The camera to dispose the effect on.
  72679. */
  72680. disposeEffects(camera: Camera): void;
  72681. /**
  72682. * @hidden Internal
  72683. */
  72684. _updateEffects(): void;
  72685. /**
  72686. * Internal
  72687. * @returns if all the contained post processes are ready.
  72688. * @hidden
  72689. */
  72690. _isReady(): boolean;
  72691. }
  72692. }
  72693. declare module "babylonjs/Shaders/chromaticAberration.fragment" {
  72694. /** @hidden */
  72695. export var chromaticAberrationPixelShader: {
  72696. name: string;
  72697. shader: string;
  72698. };
  72699. }
  72700. declare module "babylonjs/PostProcesses/chromaticAberrationPostProcess" {
  72701. import { Vector2 } from "babylonjs/Maths/math.vector";
  72702. import { Nullable } from "babylonjs/types";
  72703. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72704. import { Camera } from "babylonjs/Cameras/camera";
  72705. import { Engine } from "babylonjs/Engines/engine";
  72706. import "babylonjs/Shaders/chromaticAberration.fragment";
  72707. import { Scene } from "babylonjs/scene";
  72708. /**
  72709. * The ChromaticAberrationPostProcess separates the rgb channels in an image to produce chromatic distortion around the edges of the screen
  72710. */
  72711. export class ChromaticAberrationPostProcess extends PostProcess {
  72712. /**
  72713. * The amount of seperation of rgb channels (default: 30)
  72714. */
  72715. aberrationAmount: number;
  72716. /**
  72717. * The amount the effect will increase for pixels closer to the edge of the screen. (default: 0)
  72718. */
  72719. radialIntensity: number;
  72720. /**
  72721. * 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))
  72722. */
  72723. direction: Vector2;
  72724. /**
  72725. * 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))
  72726. */
  72727. centerPosition: Vector2;
  72728. /** The width of the screen to apply the effect on */
  72729. screenWidth: number;
  72730. /** The height of the screen to apply the effect on */
  72731. screenHeight: number;
  72732. /**
  72733. * Gets a string identifying the name of the class
  72734. * @returns "ChromaticAberrationPostProcess" string
  72735. */
  72736. getClassName(): string;
  72737. /**
  72738. * Creates a new instance ChromaticAberrationPostProcess
  72739. * @param name The name of the effect.
  72740. * @param screenWidth The width of the screen to apply the effect on.
  72741. * @param screenHeight The height of the screen to apply the effect on.
  72742. * @param options The required width/height ratio to downsize to before computing the render pass.
  72743. * @param camera The camera to apply the render pass to.
  72744. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  72745. * @param engine The engine which the post process will be applied. (default: current engine)
  72746. * @param reusable If the post process can be reused on the same frame. (default: false)
  72747. * @param textureType Type of textures used when performing the post process. (default: 0)
  72748. * @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)
  72749. */
  72750. constructor(name: string, screenWidth: number, screenHeight: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  72751. /** @hidden */
  72752. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<ChromaticAberrationPostProcess>;
  72753. }
  72754. }
  72755. declare module "babylonjs/Shaders/circleOfConfusion.fragment" {
  72756. /** @hidden */
  72757. export var circleOfConfusionPixelShader: {
  72758. name: string;
  72759. shader: string;
  72760. };
  72761. }
  72762. declare module "babylonjs/PostProcesses/circleOfConfusionPostProcess" {
  72763. import { Nullable } from "babylonjs/types";
  72764. import { Engine } from "babylonjs/Engines/engine";
  72765. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72766. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  72767. import { Camera } from "babylonjs/Cameras/camera";
  72768. import "babylonjs/Shaders/circleOfConfusion.fragment";
  72769. /**
  72770. * The CircleOfConfusionPostProcess computes the circle of confusion value for each pixel given required lens parameters. See https://en.wikipedia.org/wiki/Circle_of_confusion
  72771. */
  72772. export class CircleOfConfusionPostProcess extends PostProcess {
  72773. /**
  72774. * 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.
  72775. */
  72776. lensSize: number;
  72777. /**
  72778. * F-Stop of the effect's camera. The diamater of the resulting aperture can be computed by lensSize/fStop. (default: 1.4)
  72779. */
  72780. fStop: number;
  72781. /**
  72782. * Distance away from the camera to focus on in scene units/1000 (eg. millimeter). (default: 2000)
  72783. */
  72784. focusDistance: number;
  72785. /**
  72786. * Focal length of the effect's camera in scene units/1000 (eg. millimeter). (default: 50)
  72787. */
  72788. focalLength: number;
  72789. /**
  72790. * Gets a string identifying the name of the class
  72791. * @returns "CircleOfConfusionPostProcess" string
  72792. */
  72793. getClassName(): string;
  72794. private _depthTexture;
  72795. /**
  72796. * Creates a new instance CircleOfConfusionPostProcess
  72797. * @param name The name of the effect.
  72798. * @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.
  72799. * @param options The required width/height ratio to downsize to before computing the render pass.
  72800. * @param camera The camera to apply the render pass to.
  72801. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  72802. * @param engine The engine which the post process will be applied. (default: current engine)
  72803. * @param reusable If the post process can be reused on the same frame. (default: false)
  72804. * @param textureType Type of textures used when performing the post process. (default: 0)
  72805. * @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)
  72806. */
  72807. constructor(name: string, depthTexture: Nullable<RenderTargetTexture>, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  72808. /**
  72809. * 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.
  72810. */
  72811. set depthTexture(value: RenderTargetTexture);
  72812. }
  72813. }
  72814. declare module "babylonjs/Shaders/colorCorrection.fragment" {
  72815. /** @hidden */
  72816. export var colorCorrectionPixelShader: {
  72817. name: string;
  72818. shader: string;
  72819. };
  72820. }
  72821. declare module "babylonjs/PostProcesses/colorCorrectionPostProcess" {
  72822. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72823. import { Engine } from "babylonjs/Engines/engine";
  72824. import { Camera } from "babylonjs/Cameras/camera";
  72825. import "babylonjs/Shaders/colorCorrection.fragment";
  72826. import { Nullable } from "babylonjs/types";
  72827. import { Scene } from "babylonjs/scene";
  72828. /**
  72829. *
  72830. * This post-process allows the modification of rendered colors by using
  72831. * a 'look-up table' (LUT). This effect is also called Color Grading.
  72832. *
  72833. * The object needs to be provided an url to a texture containing the color
  72834. * look-up table: the texture must be 256 pixels wide and 16 pixels high.
  72835. * Use an image editing software to tweak the LUT to match your needs.
  72836. *
  72837. * For an example of a color LUT, see here:
  72838. * @see http://udn.epicgames.com/Three/rsrc/Three/ColorGrading/RGBTable16x1.png
  72839. * For explanations on color grading, see here:
  72840. * @see http://udn.epicgames.com/Three/ColorGrading.html
  72841. *
  72842. */
  72843. export class ColorCorrectionPostProcess extends PostProcess {
  72844. private _colorTableTexture;
  72845. /**
  72846. * Gets the color table url used to create the LUT texture
  72847. */
  72848. colorTableUrl: string;
  72849. /**
  72850. * Gets a string identifying the name of the class
  72851. * @returns "ColorCorrectionPostProcess" string
  72852. */
  72853. getClassName(): string;
  72854. constructor(name: string, colorTableUrl: string, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  72855. /** @hidden */
  72856. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<ColorCorrectionPostProcess>;
  72857. }
  72858. }
  72859. declare module "babylonjs/Shaders/convolution.fragment" {
  72860. /** @hidden */
  72861. export var convolutionPixelShader: {
  72862. name: string;
  72863. shader: string;
  72864. };
  72865. }
  72866. declare module "babylonjs/PostProcesses/convolutionPostProcess" {
  72867. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72868. import { Nullable } from "babylonjs/types";
  72869. import { Camera } from "babylonjs/Cameras/camera";
  72870. import { Engine } from "babylonjs/Engines/engine";
  72871. import "babylonjs/Shaders/convolution.fragment";
  72872. import { Scene } from "babylonjs/scene";
  72873. /**
  72874. * The ConvolutionPostProcess applies a 3x3 kernel to every pixel of the
  72875. * input texture to perform effects such as edge detection or sharpening
  72876. * See http://en.wikipedia.org/wiki/Kernel_(image_processing)
  72877. */
  72878. export class ConvolutionPostProcess extends PostProcess {
  72879. /** Array of 9 values corresponding to the 3x3 kernel to be applied */
  72880. kernel: number[];
  72881. /**
  72882. * Gets a string identifying the name of the class
  72883. * @returns "ConvolutionPostProcess" string
  72884. */
  72885. getClassName(): string;
  72886. /**
  72887. * Creates a new instance ConvolutionPostProcess
  72888. * @param name The name of the effect.
  72889. * @param kernel Array of 9 values corresponding to the 3x3 kernel to be applied
  72890. * @param options The required width/height ratio to downsize to before computing the render pass.
  72891. * @param camera The camera to apply the render pass to.
  72892. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  72893. * @param engine The engine which the post process will be applied. (default: current engine)
  72894. * @param reusable If the post process can be reused on the same frame. (default: false)
  72895. * @param textureType Type of textures used when performing the post process. (default: 0)
  72896. */
  72897. constructor(name: string, kernel: number[], options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  72898. /** @hidden */
  72899. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<ConvolutionPostProcess>;
  72900. /**
  72901. * Edge detection 0 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  72902. */
  72903. static EdgeDetect0Kernel: number[];
  72904. /**
  72905. * Edge detection 1 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  72906. */
  72907. static EdgeDetect1Kernel: number[];
  72908. /**
  72909. * Edge detection 2 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  72910. */
  72911. static EdgeDetect2Kernel: number[];
  72912. /**
  72913. * Kernel to sharpen an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  72914. */
  72915. static SharpenKernel: number[];
  72916. /**
  72917. * Kernel to emboss an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  72918. */
  72919. static EmbossKernel: number[];
  72920. /**
  72921. * Kernel to blur an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  72922. */
  72923. static GaussianKernel: number[];
  72924. }
  72925. }
  72926. declare module "babylonjs/PostProcesses/depthOfFieldBlurPostProcess" {
  72927. import { Nullable } from "babylonjs/types";
  72928. import { Vector2 } from "babylonjs/Maths/math.vector";
  72929. import { Camera } from "babylonjs/Cameras/camera";
  72930. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72931. import { BlurPostProcess } from "babylonjs/PostProcesses/blurPostProcess";
  72932. import { Engine } from "babylonjs/Engines/engine";
  72933. import { Scene } from "babylonjs/scene";
  72934. /**
  72935. * The DepthOfFieldBlurPostProcess applied a blur in a give direction.
  72936. * This blur differs from the standard BlurPostProcess as it attempts to avoid blurring pixels
  72937. * based on samples that have a large difference in distance than the center pixel.
  72938. * See section 2.6.2 http://fileadmin.cs.lth.se/cs/education/edan35/lectures/12dof.pdf
  72939. */
  72940. export class DepthOfFieldBlurPostProcess extends BlurPostProcess {
  72941. /**
  72942. * The direction the blur should be applied
  72943. */
  72944. direction: Vector2;
  72945. /**
  72946. * Gets a string identifying the name of the class
  72947. * @returns "DepthOfFieldBlurPostProcess" string
  72948. */
  72949. getClassName(): string;
  72950. /**
  72951. * Creates a new instance CircleOfConfusionPostProcess
  72952. * @param name The name of the effect.
  72953. * @param scene The scene the effect belongs to.
  72954. * @param direction The direction the blur should be applied.
  72955. * @param kernel The size of the kernel used to blur.
  72956. * @param options The required width/height ratio to downsize to before computing the render pass.
  72957. * @param camera The camera to apply the render pass to.
  72958. * @param circleOfConfusion The circle of confusion + depth map to be used to avoid blurring accross edges
  72959. * @param imageToBlur The image to apply the blur to (default: Current rendered frame)
  72960. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  72961. * @param engine The engine which the post process will be applied. (default: current engine)
  72962. * @param reusable If the post process can be reused on the same frame. (default: false)
  72963. * @param textureType Type of textures used when performing the post process. (default: 0)
  72964. * @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)
  72965. */
  72966. 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);
  72967. }
  72968. }
  72969. declare module "babylonjs/Shaders/depthOfFieldMerge.fragment" {
  72970. /** @hidden */
  72971. export var depthOfFieldMergePixelShader: {
  72972. name: string;
  72973. shader: string;
  72974. };
  72975. }
  72976. declare module "babylonjs/PostProcesses/depthOfFieldMergePostProcess" {
  72977. import { Nullable } from "babylonjs/types";
  72978. import { Camera } from "babylonjs/Cameras/camera";
  72979. import { Effect } from "babylonjs/Materials/effect";
  72980. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72981. import { Engine } from "babylonjs/Engines/engine";
  72982. import "babylonjs/Shaders/depthOfFieldMerge.fragment";
  72983. /**
  72984. * Options to be set when merging outputs from the default pipeline.
  72985. */
  72986. export class DepthOfFieldMergePostProcessOptions {
  72987. /**
  72988. * The original image to merge on top of
  72989. */
  72990. originalFromInput: PostProcess;
  72991. /**
  72992. * Parameters to perform the merge of the depth of field effect
  72993. */
  72994. depthOfField?: {
  72995. circleOfConfusion: PostProcess;
  72996. blurSteps: Array<PostProcess>;
  72997. };
  72998. /**
  72999. * Parameters to perform the merge of bloom effect
  73000. */
  73001. bloom?: {
  73002. blurred: PostProcess;
  73003. weight: number;
  73004. };
  73005. }
  73006. /**
  73007. * The DepthOfFieldMergePostProcess merges blurred images with the original based on the values of the circle of confusion.
  73008. */
  73009. export class DepthOfFieldMergePostProcess extends PostProcess {
  73010. private blurSteps;
  73011. /**
  73012. * Gets a string identifying the name of the class
  73013. * @returns "DepthOfFieldMergePostProcess" string
  73014. */
  73015. getClassName(): string;
  73016. /**
  73017. * Creates a new instance of DepthOfFieldMergePostProcess
  73018. * @param name The name of the effect.
  73019. * @param originalFromInput Post process which's input will be used for the merge.
  73020. * @param circleOfConfusion Circle of confusion post process which's output will be used to blur each pixel.
  73021. * @param blurSteps Blur post processes from low to high which will be mixed with the original image.
  73022. * @param options The required width/height ratio to downsize to before computing the render pass.
  73023. * @param camera The camera to apply the render pass to.
  73024. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73025. * @param engine The engine which the post process will be applied. (default: current engine)
  73026. * @param reusable If the post process can be reused on the same frame. (default: false)
  73027. * @param textureType Type of textures used when performing the post process. (default: 0)
  73028. * @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)
  73029. */
  73030. 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);
  73031. /**
  73032. * Updates the effect with the current post process compile time values and recompiles the shader.
  73033. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  73034. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  73035. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  73036. * @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
  73037. * @param onCompiled Called when the shader has been compiled.
  73038. * @param onError Called if there is an error when compiling a shader.
  73039. */
  73040. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  73041. }
  73042. }
  73043. declare module "babylonjs/PostProcesses/depthOfFieldEffect" {
  73044. import { Nullable } from "babylonjs/types";
  73045. import { Camera } from "babylonjs/Cameras/camera";
  73046. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  73047. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  73048. import { PostProcessRenderEffect } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect";
  73049. import { DepthOfFieldBlurPostProcess } from "babylonjs/PostProcesses/depthOfFieldBlurPostProcess";
  73050. import { Scene } from "babylonjs/scene";
  73051. /**
  73052. * Specifies the level of max blur that should be applied when using the depth of field effect
  73053. */
  73054. export enum DepthOfFieldEffectBlurLevel {
  73055. /**
  73056. * Subtle blur
  73057. */
  73058. Low = 0,
  73059. /**
  73060. * Medium blur
  73061. */
  73062. Medium = 1,
  73063. /**
  73064. * Large blur
  73065. */
  73066. High = 2
  73067. }
  73068. /**
  73069. * The depth of field effect applies a blur to objects that are closer or further from where the camera is focusing.
  73070. */
  73071. export class DepthOfFieldEffect extends PostProcessRenderEffect {
  73072. private _circleOfConfusion;
  73073. /**
  73074. * @hidden Internal, blurs from high to low
  73075. */
  73076. _depthOfFieldBlurX: Array<DepthOfFieldBlurPostProcess>;
  73077. private _depthOfFieldBlurY;
  73078. private _dofMerge;
  73079. /**
  73080. * @hidden Internal post processes in depth of field effect
  73081. */
  73082. _effects: Array<PostProcess>;
  73083. /**
  73084. * The focal the length of the camera used in the effect in scene units/1000 (eg. millimeter)
  73085. */
  73086. set focalLength(value: number);
  73087. get focalLength(): number;
  73088. /**
  73089. * F-Stop of the effect's camera. The diameter of the resulting aperture can be computed by lensSize/fStop. (default: 1.4)
  73090. */
  73091. set fStop(value: number);
  73092. get fStop(): number;
  73093. /**
  73094. * Distance away from the camera to focus on in scene units/1000 (eg. millimeter). (default: 2000)
  73095. */
  73096. set focusDistance(value: number);
  73097. get focusDistance(): number;
  73098. /**
  73099. * 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.
  73100. */
  73101. set lensSize(value: number);
  73102. get lensSize(): number;
  73103. /**
  73104. * Creates a new instance DepthOfFieldEffect
  73105. * @param scene The scene the effect belongs to.
  73106. * @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.
  73107. * @param pipelineTextureType The type of texture to be used when performing the post processing.
  73108. * @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)
  73109. */
  73110. constructor(scene: Scene, depthTexture: Nullable<RenderTargetTexture>, blurLevel?: DepthOfFieldEffectBlurLevel, pipelineTextureType?: number, blockCompilation?: boolean);
  73111. /**
  73112. * Get the current class name of the current effet
  73113. * @returns "DepthOfFieldEffect"
  73114. */
  73115. getClassName(): string;
  73116. /**
  73117. * 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.
  73118. */
  73119. set depthTexture(value: RenderTargetTexture);
  73120. /**
  73121. * Disposes each of the internal effects for a given camera.
  73122. * @param camera The camera to dispose the effect on.
  73123. */
  73124. disposeEffects(camera: Camera): void;
  73125. /**
  73126. * @hidden Internal
  73127. */
  73128. _updateEffects(): void;
  73129. /**
  73130. * Internal
  73131. * @returns if all the contained post processes are ready.
  73132. * @hidden
  73133. */
  73134. _isReady(): boolean;
  73135. }
  73136. }
  73137. declare module "babylonjs/Shaders/displayPass.fragment" {
  73138. /** @hidden */
  73139. export var displayPassPixelShader: {
  73140. name: string;
  73141. shader: string;
  73142. };
  73143. }
  73144. declare module "babylonjs/PostProcesses/displayPassPostProcess" {
  73145. import { Nullable } from "babylonjs/types";
  73146. import { Camera } from "babylonjs/Cameras/camera";
  73147. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73148. import { Engine } from "babylonjs/Engines/engine";
  73149. import "babylonjs/Shaders/displayPass.fragment";
  73150. import { Scene } from "babylonjs/scene";
  73151. /**
  73152. * DisplayPassPostProcess which produces an output the same as it's input
  73153. */
  73154. export class DisplayPassPostProcess extends PostProcess {
  73155. /**
  73156. * Gets a string identifying the name of the class
  73157. * @returns "DisplayPassPostProcess" string
  73158. */
  73159. getClassName(): string;
  73160. /**
  73161. * Creates the DisplayPassPostProcess
  73162. * @param name The name of the effect.
  73163. * @param options The required width/height ratio to downsize to before computing the render pass.
  73164. * @param camera The camera to apply the render pass to.
  73165. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73166. * @param engine The engine which the post process will be applied. (default: current engine)
  73167. * @param reusable If the post process can be reused on the same frame. (default: false)
  73168. */
  73169. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean);
  73170. /** @hidden */
  73171. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<DisplayPassPostProcess>;
  73172. }
  73173. }
  73174. declare module "babylonjs/Shaders/filter.fragment" {
  73175. /** @hidden */
  73176. export var filterPixelShader: {
  73177. name: string;
  73178. shader: string;
  73179. };
  73180. }
  73181. declare module "babylonjs/PostProcesses/filterPostProcess" {
  73182. import { Nullable } from "babylonjs/types";
  73183. import { Matrix } from "babylonjs/Maths/math.vector";
  73184. import { Camera } from "babylonjs/Cameras/camera";
  73185. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73186. import { Engine } from "babylonjs/Engines/engine";
  73187. import "babylonjs/Shaders/filter.fragment";
  73188. import { Scene } from "babylonjs/scene";
  73189. /**
  73190. * Applies a kernel filter to the image
  73191. */
  73192. export class FilterPostProcess extends PostProcess {
  73193. /** The matrix to be applied to the image */
  73194. kernelMatrix: Matrix;
  73195. /**
  73196. * Gets a string identifying the name of the class
  73197. * @returns "FilterPostProcess" string
  73198. */
  73199. getClassName(): string;
  73200. /**
  73201. *
  73202. * @param name The name of the effect.
  73203. * @param kernelMatrix The matrix to be applied to the image
  73204. * @param options The required width/height ratio to downsize to before computing the render pass.
  73205. * @param camera The camera to apply the render pass to.
  73206. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73207. * @param engine The engine which the post process will be applied. (default: current engine)
  73208. * @param reusable If the post process can be reused on the same frame. (default: false)
  73209. */
  73210. constructor(name: string, kernelMatrix: Matrix, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean);
  73211. /** @hidden */
  73212. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<FilterPostProcess>;
  73213. }
  73214. }
  73215. declare module "babylonjs/Shaders/fxaa.fragment" {
  73216. /** @hidden */
  73217. export var fxaaPixelShader: {
  73218. name: string;
  73219. shader: string;
  73220. };
  73221. }
  73222. declare module "babylonjs/Shaders/fxaa.vertex" {
  73223. /** @hidden */
  73224. export var fxaaVertexShader: {
  73225. name: string;
  73226. shader: string;
  73227. };
  73228. }
  73229. declare module "babylonjs/PostProcesses/fxaaPostProcess" {
  73230. import { Nullable } from "babylonjs/types";
  73231. import { Camera } from "babylonjs/Cameras/camera";
  73232. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73233. import { Engine } from "babylonjs/Engines/engine";
  73234. import "babylonjs/Shaders/fxaa.fragment";
  73235. import "babylonjs/Shaders/fxaa.vertex";
  73236. import { Scene } from "babylonjs/scene";
  73237. /**
  73238. * Fxaa post process
  73239. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#fxaa
  73240. */
  73241. export class FxaaPostProcess extends PostProcess {
  73242. /**
  73243. * Gets a string identifying the name of the class
  73244. * @returns "FxaaPostProcess" string
  73245. */
  73246. getClassName(): string;
  73247. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  73248. private _getDefines;
  73249. /** @hidden */
  73250. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): FxaaPostProcess;
  73251. }
  73252. }
  73253. declare module "babylonjs/Shaders/grain.fragment" {
  73254. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  73255. /** @hidden */
  73256. export var grainPixelShader: {
  73257. name: string;
  73258. shader: string;
  73259. };
  73260. }
  73261. declare module "babylonjs/PostProcesses/grainPostProcess" {
  73262. import { Nullable } from "babylonjs/types";
  73263. import { Camera } from "babylonjs/Cameras/camera";
  73264. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73265. import { Engine } from "babylonjs/Engines/engine";
  73266. import "babylonjs/Shaders/grain.fragment";
  73267. import { Scene } from "babylonjs/scene";
  73268. /**
  73269. * The GrainPostProcess adds noise to the image at mid luminance levels
  73270. */
  73271. export class GrainPostProcess extends PostProcess {
  73272. /**
  73273. * The intensity of the grain added (default: 30)
  73274. */
  73275. intensity: number;
  73276. /**
  73277. * If the grain should be randomized on every frame
  73278. */
  73279. animated: boolean;
  73280. /**
  73281. * Gets a string identifying the name of the class
  73282. * @returns "GrainPostProcess" string
  73283. */
  73284. getClassName(): string;
  73285. /**
  73286. * Creates a new instance of @see GrainPostProcess
  73287. * @param name The name of the effect.
  73288. * @param options The required width/height ratio to downsize to before computing the render pass.
  73289. * @param camera The camera to apply the render pass to.
  73290. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73291. * @param engine The engine which the post process will be applied. (default: current engine)
  73292. * @param reusable If the post process can be reused on the same frame. (default: false)
  73293. * @param textureType Type of textures used when performing the post process. (default: 0)
  73294. * @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)
  73295. */
  73296. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  73297. /** @hidden */
  73298. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): GrainPostProcess;
  73299. }
  73300. }
  73301. declare module "babylonjs/Shaders/highlights.fragment" {
  73302. /** @hidden */
  73303. export var highlightsPixelShader: {
  73304. name: string;
  73305. shader: string;
  73306. };
  73307. }
  73308. declare module "babylonjs/PostProcesses/highlightsPostProcess" {
  73309. import { Nullable } from "babylonjs/types";
  73310. import { Camera } from "babylonjs/Cameras/camera";
  73311. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73312. import { Engine } from "babylonjs/Engines/engine";
  73313. import "babylonjs/Shaders/highlights.fragment";
  73314. /**
  73315. * Extracts highlights from the image
  73316. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  73317. */
  73318. export class HighlightsPostProcess extends PostProcess {
  73319. /**
  73320. * Gets a string identifying the name of the class
  73321. * @returns "HighlightsPostProcess" string
  73322. */
  73323. getClassName(): string;
  73324. /**
  73325. * Extracts highlights from the image
  73326. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  73327. * @param name The name of the effect.
  73328. * @param options The required width/height ratio to downsize to before computing the render pass.
  73329. * @param camera The camera to apply the render pass to.
  73330. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73331. * @param engine The engine which the post process will be applied. (default: current engine)
  73332. * @param reusable If the post process can be reused on the same frame. (default: false)
  73333. * @param textureType Type of texture for the post process (default: Engine.TEXTURETYPE_UNSIGNED_INT)
  73334. */
  73335. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  73336. }
  73337. }
  73338. declare module "babylonjs/Shaders/ShadersInclude/mrtFragmentDeclaration" {
  73339. /** @hidden */
  73340. export var mrtFragmentDeclaration: {
  73341. name: string;
  73342. shader: string;
  73343. };
  73344. }
  73345. declare module "babylonjs/Shaders/geometry.fragment" {
  73346. import "babylonjs/Shaders/ShadersInclude/mrtFragmentDeclaration";
  73347. import "babylonjs/Shaders/ShadersInclude/bumpFragmentMainFunctions";
  73348. import "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions";
  73349. import "babylonjs/Shaders/ShadersInclude/bumpFragment";
  73350. /** @hidden */
  73351. export var geometryPixelShader: {
  73352. name: string;
  73353. shader: string;
  73354. };
  73355. }
  73356. declare module "babylonjs/Shaders/geometry.vertex" {
  73357. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  73358. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  73359. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  73360. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  73361. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  73362. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  73363. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  73364. import "babylonjs/Shaders/ShadersInclude/bumpVertex";
  73365. /** @hidden */
  73366. export var geometryVertexShader: {
  73367. name: string;
  73368. shader: string;
  73369. };
  73370. }
  73371. declare module "babylonjs/Rendering/geometryBufferRenderer" {
  73372. import { Matrix } from "babylonjs/Maths/math.vector";
  73373. import { SubMesh } from "babylonjs/Meshes/subMesh";
  73374. import { Mesh } from "babylonjs/Meshes/mesh";
  73375. import { MultiRenderTarget } from "babylonjs/Materials/Textures/multiRenderTarget";
  73376. import { Effect } from "babylonjs/Materials/effect";
  73377. import { Scene } from "babylonjs/scene";
  73378. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  73379. import "babylonjs/Shaders/geometry.fragment";
  73380. import "babylonjs/Shaders/geometry.vertex";
  73381. /** @hidden */
  73382. interface ISavedTransformationMatrix {
  73383. world: Matrix;
  73384. viewProjection: Matrix;
  73385. }
  73386. /**
  73387. * This renderer is helpfull to fill one of the render target with a geometry buffer.
  73388. */
  73389. export class GeometryBufferRenderer {
  73390. /**
  73391. * Constant used to retrieve the position texture index in the G-Buffer textures array
  73392. * using getIndex(GeometryBufferRenderer.POSITION_TEXTURE_INDEX)
  73393. */
  73394. static readonly POSITION_TEXTURE_TYPE: number;
  73395. /**
  73396. * Constant used to retrieve the velocity texture index in the G-Buffer textures array
  73397. * using getIndex(GeometryBufferRenderer.VELOCITY_TEXTURE_INDEX)
  73398. */
  73399. static readonly VELOCITY_TEXTURE_TYPE: number;
  73400. /**
  73401. * Constant used to retrieve the reflectivity texture index in the G-Buffer textures array
  73402. * using the getIndex(GeometryBufferRenderer.REFLECTIVITY_TEXTURE_TYPE)
  73403. */
  73404. static readonly REFLECTIVITY_TEXTURE_TYPE: number;
  73405. /**
  73406. * Dictionary used to store the previous transformation matrices of each rendered mesh
  73407. * in order to compute objects velocities when enableVelocity is set to "true"
  73408. * @hidden
  73409. */
  73410. _previousTransformationMatrices: {
  73411. [index: number]: ISavedTransformationMatrix;
  73412. };
  73413. /**
  73414. * Dictionary used to store the previous bones transformation matrices of each rendered mesh
  73415. * in order to compute objects velocities when enableVelocity is set to "true"
  73416. * @hidden
  73417. */
  73418. _previousBonesTransformationMatrices: {
  73419. [index: number]: Float32Array;
  73420. };
  73421. /**
  73422. * Array used to store the ignored skinned meshes while computing velocity map (typically used by the motion blur post-process).
  73423. * Avoids computing bones velocities and computes only mesh's velocity itself (position, rotation, scaling).
  73424. */
  73425. excludedSkinnedMeshesFromVelocity: AbstractMesh[];
  73426. /** Gets or sets a boolean indicating if transparent meshes should be rendered */
  73427. renderTransparentMeshes: boolean;
  73428. private _scene;
  73429. private _resizeObserver;
  73430. private _multiRenderTarget;
  73431. private _ratio;
  73432. private _enablePosition;
  73433. private _enableVelocity;
  73434. private _enableReflectivity;
  73435. private _positionIndex;
  73436. private _velocityIndex;
  73437. private _reflectivityIndex;
  73438. protected _effect: Effect;
  73439. protected _cachedDefines: string;
  73440. /**
  73441. * Set the render list (meshes to be rendered) used in the G buffer.
  73442. */
  73443. set renderList(meshes: Mesh[]);
  73444. /**
  73445. * Gets wether or not G buffer are supported by the running hardware.
  73446. * This requires draw buffer supports
  73447. */
  73448. get isSupported(): boolean;
  73449. /**
  73450. * Returns the index of the given texture type in the G-Buffer textures array
  73451. * @param textureType The texture type constant. For example GeometryBufferRenderer.POSITION_TEXTURE_INDEX
  73452. * @returns the index of the given texture type in the G-Buffer textures array
  73453. */
  73454. getTextureIndex(textureType: number): number;
  73455. /**
  73456. * Gets a boolean indicating if objects positions are enabled for the G buffer.
  73457. */
  73458. get enablePosition(): boolean;
  73459. /**
  73460. * Sets whether or not objects positions are enabled for the G buffer.
  73461. */
  73462. set enablePosition(enable: boolean);
  73463. /**
  73464. * Gets a boolean indicating if objects velocities are enabled for the G buffer.
  73465. */
  73466. get enableVelocity(): boolean;
  73467. /**
  73468. * Sets wether or not objects velocities are enabled for the G buffer.
  73469. */
  73470. set enableVelocity(enable: boolean);
  73471. /**
  73472. * Gets a boolean indicating if objects roughness are enabled in the G buffer.
  73473. */
  73474. get enableReflectivity(): boolean;
  73475. /**
  73476. * Sets wether or not objects roughness are enabled for the G buffer.
  73477. */
  73478. set enableReflectivity(enable: boolean);
  73479. /**
  73480. * Gets the scene associated with the buffer.
  73481. */
  73482. get scene(): Scene;
  73483. /**
  73484. * Gets the ratio used by the buffer during its creation.
  73485. * How big is the buffer related to the main canvas.
  73486. */
  73487. get ratio(): number;
  73488. /** @hidden */
  73489. static _SceneComponentInitialization: (scene: Scene) => void;
  73490. /**
  73491. * Creates a new G Buffer for the scene
  73492. * @param scene The scene the buffer belongs to
  73493. * @param ratio How big is the buffer related to the main canvas.
  73494. */
  73495. constructor(scene: Scene, ratio?: number);
  73496. /**
  73497. * Checks wether everything is ready to render a submesh to the G buffer.
  73498. * @param subMesh the submesh to check readiness for
  73499. * @param useInstances is the mesh drawn using instance or not
  73500. * @returns true if ready otherwise false
  73501. */
  73502. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  73503. /**
  73504. * Gets the current underlying G Buffer.
  73505. * @returns the buffer
  73506. */
  73507. getGBuffer(): MultiRenderTarget;
  73508. /**
  73509. * Gets the number of samples used to render the buffer (anti aliasing).
  73510. */
  73511. get samples(): number;
  73512. /**
  73513. * Sets the number of samples used to render the buffer (anti aliasing).
  73514. */
  73515. set samples(value: number);
  73516. /**
  73517. * Disposes the renderer and frees up associated resources.
  73518. */
  73519. dispose(): void;
  73520. protected _createRenderTargets(): void;
  73521. private _copyBonesTransformationMatrices;
  73522. }
  73523. }
  73524. declare module "babylonjs/Rendering/geometryBufferRendererSceneComponent" {
  73525. import { Nullable } from "babylonjs/types";
  73526. import { Scene } from "babylonjs/scene";
  73527. import { ISceneComponent } from "babylonjs/sceneComponent";
  73528. import { GeometryBufferRenderer } from "babylonjs/Rendering/geometryBufferRenderer";
  73529. module "babylonjs/scene" {
  73530. interface Scene {
  73531. /** @hidden (Backing field) */
  73532. _geometryBufferRenderer: Nullable<GeometryBufferRenderer>;
  73533. /**
  73534. * Gets or Sets the current geometry buffer associated to the scene.
  73535. */
  73536. geometryBufferRenderer: Nullable<GeometryBufferRenderer>;
  73537. /**
  73538. * Enables a GeometryBufferRender and associates it with the scene
  73539. * @param ratio defines the scaling ratio to apply to the renderer (1 by default which means same resolution)
  73540. * @returns the GeometryBufferRenderer
  73541. */
  73542. enableGeometryBufferRenderer(ratio?: number): Nullable<GeometryBufferRenderer>;
  73543. /**
  73544. * Disables the GeometryBufferRender associated with the scene
  73545. */
  73546. disableGeometryBufferRenderer(): void;
  73547. }
  73548. }
  73549. /**
  73550. * Defines the Geometry Buffer scene component responsible to manage a G-Buffer useful
  73551. * in several rendering techniques.
  73552. */
  73553. export class GeometryBufferRendererSceneComponent implements ISceneComponent {
  73554. /**
  73555. * The component name helpful to identify the component in the list of scene components.
  73556. */
  73557. readonly name: string;
  73558. /**
  73559. * The scene the component belongs to.
  73560. */
  73561. scene: Scene;
  73562. /**
  73563. * Creates a new instance of the component for the given scene
  73564. * @param scene Defines the scene to register the component in
  73565. */
  73566. constructor(scene: Scene);
  73567. /**
  73568. * Registers the component in a given scene
  73569. */
  73570. register(): void;
  73571. /**
  73572. * Rebuilds the elements related to this component in case of
  73573. * context lost for instance.
  73574. */
  73575. rebuild(): void;
  73576. /**
  73577. * Disposes the component and the associated ressources
  73578. */
  73579. dispose(): void;
  73580. private _gatherRenderTargets;
  73581. }
  73582. }
  73583. declare module "babylonjs/Shaders/motionBlur.fragment" {
  73584. /** @hidden */
  73585. export var motionBlurPixelShader: {
  73586. name: string;
  73587. shader: string;
  73588. };
  73589. }
  73590. declare module "babylonjs/PostProcesses/motionBlurPostProcess" {
  73591. import { Nullable } from "babylonjs/types";
  73592. import { Camera } from "babylonjs/Cameras/camera";
  73593. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73594. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  73595. import "babylonjs/Animations/animatable";
  73596. import "babylonjs/Rendering/geometryBufferRendererSceneComponent";
  73597. import "babylonjs/Shaders/motionBlur.fragment";
  73598. import { Engine } from "babylonjs/Engines/engine";
  73599. import { Scene } from "babylonjs/scene";
  73600. /**
  73601. * The Motion Blur Post Process which blurs an image based on the objects velocity in scene.
  73602. * Velocity can be affected by each object's rotation, position and scale depending on the transformation speed.
  73603. * As an example, all you have to do is to create the post-process:
  73604. * var mb = new BABYLON.MotionBlurPostProcess(
  73605. * 'mb', // The name of the effect.
  73606. * scene, // The scene containing the objects to blur according to their velocity.
  73607. * 1.0, // The required width/height ratio to downsize to before computing the render pass.
  73608. * camera // The camera to apply the render pass to.
  73609. * );
  73610. * Then, all objects moving, rotating and/or scaling will be blurred depending on the transformation speed.
  73611. */
  73612. export class MotionBlurPostProcess extends PostProcess {
  73613. /**
  73614. * Defines how much the image is blurred by the movement. Default value is equal to 1
  73615. */
  73616. motionStrength: number;
  73617. /**
  73618. * Gets the number of iterations are used for motion blur quality. Default value is equal to 32
  73619. */
  73620. get motionBlurSamples(): number;
  73621. /**
  73622. * Sets the number of iterations to be used for motion blur quality
  73623. */
  73624. set motionBlurSamples(samples: number);
  73625. private _motionBlurSamples;
  73626. private _geometryBufferRenderer;
  73627. /**
  73628. * Gets a string identifying the name of the class
  73629. * @returns "MotionBlurPostProcess" string
  73630. */
  73631. getClassName(): string;
  73632. /**
  73633. * Creates a new instance MotionBlurPostProcess
  73634. * @param name The name of the effect.
  73635. * @param scene The scene containing the objects to blur according to their velocity.
  73636. * @param options The required width/height ratio to downsize to before computing the render pass.
  73637. * @param camera The camera to apply the render pass to.
  73638. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73639. * @param engine The engine which the post process will be applied. (default: current engine)
  73640. * @param reusable If the post process can be reused on the same frame. (default: false)
  73641. * @param textureType Type of textures used when performing the post process. (default: 0)
  73642. * @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)
  73643. */
  73644. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  73645. /**
  73646. * Excludes the given skinned mesh from computing bones velocities.
  73647. * 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.
  73648. * @param skinnedMesh The mesh containing the skeleton to ignore when computing the velocity map.
  73649. */
  73650. excludeSkinnedMesh(skinnedMesh: AbstractMesh): void;
  73651. /**
  73652. * Removes the given skinned mesh from the excluded meshes to integrate bones velocities while rendering the velocity map.
  73653. * @param skinnedMesh The mesh containing the skeleton that has been ignored previously.
  73654. * @see excludeSkinnedMesh to exclude a skinned mesh from bones velocity computation.
  73655. */
  73656. removeExcludedSkinnedMesh(skinnedMesh: AbstractMesh): void;
  73657. /**
  73658. * Disposes the post process.
  73659. * @param camera The camera to dispose the post process on.
  73660. */
  73661. dispose(camera?: Camera): void;
  73662. /** @hidden */
  73663. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<MotionBlurPostProcess>;
  73664. }
  73665. }
  73666. declare module "babylonjs/Shaders/refraction.fragment" {
  73667. /** @hidden */
  73668. export var refractionPixelShader: {
  73669. name: string;
  73670. shader: string;
  73671. };
  73672. }
  73673. declare module "babylonjs/PostProcesses/refractionPostProcess" {
  73674. import { Color3 } from "babylonjs/Maths/math.color";
  73675. import { Camera } from "babylonjs/Cameras/camera";
  73676. import { Texture } from "babylonjs/Materials/Textures/texture";
  73677. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73678. import { Engine } from "babylonjs/Engines/engine";
  73679. import "babylonjs/Shaders/refraction.fragment";
  73680. import { Scene } from "babylonjs/scene";
  73681. /**
  73682. * Post process which applies a refractin texture
  73683. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#refraction
  73684. */
  73685. export class RefractionPostProcess extends PostProcess {
  73686. private _refTexture;
  73687. private _ownRefractionTexture;
  73688. /** the base color of the refraction (used to taint the rendering) */
  73689. color: Color3;
  73690. /** simulated refraction depth */
  73691. depth: number;
  73692. /** the coefficient of the base color (0 to remove base color tainting) */
  73693. colorLevel: number;
  73694. /** Gets the url used to load the refraction texture */
  73695. refractionTextureUrl: string;
  73696. /**
  73697. * Gets or sets the refraction texture
  73698. * Please note that you are responsible for disposing the texture if you set it manually
  73699. */
  73700. get refractionTexture(): Texture;
  73701. set refractionTexture(value: Texture);
  73702. /**
  73703. * Gets a string identifying the name of the class
  73704. * @returns "RefractionPostProcess" string
  73705. */
  73706. getClassName(): string;
  73707. /**
  73708. * Initializes the RefractionPostProcess
  73709. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#refraction
  73710. * @param name The name of the effect.
  73711. * @param refractionTextureUrl Url of the refraction texture to use
  73712. * @param color the base color of the refraction (used to taint the rendering)
  73713. * @param depth simulated refraction depth
  73714. * @param colorLevel the coefficient of the base color (0 to remove base color tainting)
  73715. * @param camera The camera to apply the render pass to.
  73716. * @param options The required width/height ratio to downsize to before computing the render pass.
  73717. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73718. * @param engine The engine which the post process will be applied. (default: current engine)
  73719. * @param reusable If the post process can be reused on the same frame. (default: false)
  73720. */
  73721. constructor(name: string, refractionTextureUrl: string, color: Color3, depth: number, colorLevel: number, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  73722. /**
  73723. * Disposes of the post process
  73724. * @param camera Camera to dispose post process on
  73725. */
  73726. dispose(camera: Camera): void;
  73727. /** @hidden */
  73728. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): RefractionPostProcess;
  73729. }
  73730. }
  73731. declare module "babylonjs/Shaders/sharpen.fragment" {
  73732. /** @hidden */
  73733. export var sharpenPixelShader: {
  73734. name: string;
  73735. shader: string;
  73736. };
  73737. }
  73738. declare module "babylonjs/PostProcesses/sharpenPostProcess" {
  73739. import { Nullable } from "babylonjs/types";
  73740. import { Camera } from "babylonjs/Cameras/camera";
  73741. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73742. import "babylonjs/Shaders/sharpen.fragment";
  73743. import { Engine } from "babylonjs/Engines/engine";
  73744. import { Scene } from "babylonjs/scene";
  73745. /**
  73746. * The SharpenPostProcess applies a sharpen kernel to every pixel
  73747. * See http://en.wikipedia.org/wiki/Kernel_(image_processing)
  73748. */
  73749. export class SharpenPostProcess extends PostProcess {
  73750. /**
  73751. * How much of the original color should be applied. Setting this to 0 will display edge detection. (default: 1)
  73752. */
  73753. colorAmount: number;
  73754. /**
  73755. * How much sharpness should be applied (default: 0.3)
  73756. */
  73757. edgeAmount: number;
  73758. /**
  73759. * Gets a string identifying the name of the class
  73760. * @returns "SharpenPostProcess" string
  73761. */
  73762. getClassName(): string;
  73763. /**
  73764. * Creates a new instance ConvolutionPostProcess
  73765. * @param name The name of the effect.
  73766. * @param options The required width/height ratio to downsize to before computing the render pass.
  73767. * @param camera The camera to apply the render pass to.
  73768. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73769. * @param engine The engine which the post process will be applied. (default: current engine)
  73770. * @param reusable If the post process can be reused on the same frame. (default: false)
  73771. * @param textureType Type of textures used when performing the post process. (default: 0)
  73772. * @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)
  73773. */
  73774. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  73775. /** @hidden */
  73776. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): SharpenPostProcess;
  73777. }
  73778. }
  73779. declare module "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline" {
  73780. import { Nullable } from "babylonjs/types";
  73781. import { Camera } from "babylonjs/Cameras/camera";
  73782. import { Engine } from "babylonjs/Engines/engine";
  73783. import { PostProcessRenderEffect } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect";
  73784. import { IInspectable } from "babylonjs/Misc/iInspectable";
  73785. import { PrePassRenderer } from "babylonjs/Rendering/prePassRenderer";
  73786. /**
  73787. * PostProcessRenderPipeline
  73788. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  73789. */
  73790. export class PostProcessRenderPipeline {
  73791. private engine;
  73792. private _renderEffects;
  73793. private _renderEffectsForIsolatedPass;
  73794. /**
  73795. * List of inspectable custom properties (used by the Inspector)
  73796. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  73797. */
  73798. inspectableCustomProperties: IInspectable[];
  73799. /**
  73800. * @hidden
  73801. */
  73802. protected _cameras: Camera[];
  73803. /** @hidden */
  73804. _name: string;
  73805. /**
  73806. * Gets pipeline name
  73807. */
  73808. get name(): string;
  73809. /** Gets the list of attached cameras */
  73810. get cameras(): Camera[];
  73811. /**
  73812. * Initializes a PostProcessRenderPipeline
  73813. * @param engine engine to add the pipeline to
  73814. * @param name name of the pipeline
  73815. */
  73816. constructor(engine: Engine, name: string);
  73817. /**
  73818. * Gets the class name
  73819. * @returns "PostProcessRenderPipeline"
  73820. */
  73821. getClassName(): string;
  73822. /**
  73823. * If all the render effects in the pipeline are supported
  73824. */
  73825. get isSupported(): boolean;
  73826. /**
  73827. * Adds an effect to the pipeline
  73828. * @param renderEffect the effect to add
  73829. */
  73830. addEffect(renderEffect: PostProcessRenderEffect): void;
  73831. /** @hidden */
  73832. _rebuild(): void;
  73833. /** @hidden */
  73834. _enableEffect(renderEffectName: string, cameras: Camera): void;
  73835. /** @hidden */
  73836. _enableEffect(renderEffectName: string, cameras: Camera[]): void;
  73837. /** @hidden */
  73838. _disableEffect(renderEffectName: string, cameras: Nullable<Camera[]>): void;
  73839. /** @hidden */
  73840. _disableEffect(renderEffectName: string, cameras: Nullable<Camera[]>): void;
  73841. /** @hidden */
  73842. _attachCameras(cameras: Camera, unique: boolean): void;
  73843. /** @hidden */
  73844. _attachCameras(cameras: Camera[], unique: boolean): void;
  73845. /** @hidden */
  73846. _detachCameras(cameras: Camera): void;
  73847. /** @hidden */
  73848. _detachCameras(cameras: Nullable<Camera[]>): void;
  73849. /** @hidden */
  73850. _update(): void;
  73851. /** @hidden */
  73852. _reset(): void;
  73853. protected _enableMSAAOnFirstPostProcess(sampleCount: number): boolean;
  73854. /**
  73855. * Sets the required values to the prepass renderer.
  73856. * @param prePassRenderer defines the prepass renderer to setup.
  73857. * @returns true if the pre pass is needed.
  73858. */
  73859. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  73860. /**
  73861. * Disposes of the pipeline
  73862. */
  73863. dispose(): void;
  73864. }
  73865. }
  73866. declare module "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManager" {
  73867. import { Camera } from "babylonjs/Cameras/camera";
  73868. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  73869. /**
  73870. * PostProcessRenderPipelineManager class
  73871. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  73872. */
  73873. export class PostProcessRenderPipelineManager {
  73874. private _renderPipelines;
  73875. /**
  73876. * Initializes a PostProcessRenderPipelineManager
  73877. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  73878. */
  73879. constructor();
  73880. /**
  73881. * Gets the list of supported render pipelines
  73882. */
  73883. get supportedPipelines(): PostProcessRenderPipeline[];
  73884. /**
  73885. * Adds a pipeline to the manager
  73886. * @param renderPipeline The pipeline to add
  73887. */
  73888. addPipeline(renderPipeline: PostProcessRenderPipeline): void;
  73889. /**
  73890. * Attaches a camera to the pipeline
  73891. * @param renderPipelineName The name of the pipeline to attach to
  73892. * @param cameras the camera to attach
  73893. * @param unique if the camera can be attached multiple times to the pipeline
  73894. */
  73895. attachCamerasToRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera, unique?: boolean): void;
  73896. /**
  73897. * Detaches a camera from the pipeline
  73898. * @param renderPipelineName The name of the pipeline to detach from
  73899. * @param cameras the camera to detach
  73900. */
  73901. detachCamerasFromRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera): void;
  73902. /**
  73903. * Enables an effect by name on a pipeline
  73904. * @param renderPipelineName the name of the pipeline to enable the effect in
  73905. * @param renderEffectName the name of the effect to enable
  73906. * @param cameras the cameras that the effect should be enabled on
  73907. */
  73908. enableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void;
  73909. /**
  73910. * Disables an effect by name on a pipeline
  73911. * @param renderPipelineName the name of the pipeline to disable the effect in
  73912. * @param renderEffectName the name of the effect to disable
  73913. * @param cameras the cameras that the effect should be disabled on
  73914. */
  73915. disableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void;
  73916. /**
  73917. * Updates the state of all contained render pipelines and disposes of any non supported pipelines
  73918. */
  73919. update(): void;
  73920. /** @hidden */
  73921. _rebuild(): void;
  73922. /**
  73923. * Disposes of the manager and pipelines
  73924. */
  73925. dispose(): void;
  73926. }
  73927. }
  73928. declare module "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent" {
  73929. import { ISceneComponent } from "babylonjs/sceneComponent";
  73930. import { PostProcessRenderPipelineManager } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManager";
  73931. import { Scene } from "babylonjs/scene";
  73932. module "babylonjs/scene" {
  73933. interface Scene {
  73934. /** @hidden (Backing field) */
  73935. _postProcessRenderPipelineManager: PostProcessRenderPipelineManager;
  73936. /**
  73937. * Gets the postprocess render pipeline manager
  73938. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  73939. * @see https://doc.babylonjs.com/how_to/using_default_rendering_pipeline
  73940. */
  73941. readonly postProcessRenderPipelineManager: PostProcessRenderPipelineManager;
  73942. }
  73943. }
  73944. /**
  73945. * Defines the Render Pipeline scene component responsible to rendering pipelines
  73946. */
  73947. export class PostProcessRenderPipelineManagerSceneComponent implements ISceneComponent {
  73948. /**
  73949. * The component name helpfull to identify the component in the list of scene components.
  73950. */
  73951. readonly name: string;
  73952. /**
  73953. * The scene the component belongs to.
  73954. */
  73955. scene: Scene;
  73956. /**
  73957. * Creates a new instance of the component for the given scene
  73958. * @param scene Defines the scene to register the component in
  73959. */
  73960. constructor(scene: Scene);
  73961. /**
  73962. * Registers the component in a given scene
  73963. */
  73964. register(): void;
  73965. /**
  73966. * Rebuilds the elements related to this component in case of
  73967. * context lost for instance.
  73968. */
  73969. rebuild(): void;
  73970. /**
  73971. * Disposes the component and the associated ressources
  73972. */
  73973. dispose(): void;
  73974. private _gatherRenderTargets;
  73975. }
  73976. }
  73977. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/defaultRenderingPipeline" {
  73978. import { Nullable } from "babylonjs/types";
  73979. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  73980. import { Camera } from "babylonjs/Cameras/camera";
  73981. import { IDisposable } from "babylonjs/scene";
  73982. import { GlowLayer } from "babylonjs/Layers/glowLayer";
  73983. import { Scene } from "babylonjs/scene";
  73984. import { SharpenPostProcess } from "babylonjs/PostProcesses/sharpenPostProcess";
  73985. import { ImageProcessingPostProcess } from "babylonjs/PostProcesses/imageProcessingPostProcess";
  73986. import { ChromaticAberrationPostProcess } from "babylonjs/PostProcesses/chromaticAberrationPostProcess";
  73987. import { GrainPostProcess } from "babylonjs/PostProcesses/grainPostProcess";
  73988. import { FxaaPostProcess } from "babylonjs/PostProcesses/fxaaPostProcess";
  73989. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  73990. import { DepthOfFieldEffect, DepthOfFieldEffectBlurLevel } from "babylonjs/PostProcesses/depthOfFieldEffect";
  73991. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  73992. import { Animation } from "babylonjs/Animations/animation";
  73993. /**
  73994. * The default rendering pipeline can be added to a scene to apply common post processing effects such as anti-aliasing or depth of field.
  73995. * See https://doc.babylonjs.com/how_to/using_default_rendering_pipeline
  73996. */
  73997. export class DefaultRenderingPipeline extends PostProcessRenderPipeline implements IDisposable, IAnimatable {
  73998. private _scene;
  73999. private _camerasToBeAttached;
  74000. /**
  74001. * ID of the sharpen post process,
  74002. */
  74003. private readonly SharpenPostProcessId;
  74004. /**
  74005. * @ignore
  74006. * ID of the image processing post process;
  74007. */
  74008. readonly ImageProcessingPostProcessId: string;
  74009. /**
  74010. * @ignore
  74011. * ID of the Fast Approximate Anti-Aliasing post process;
  74012. */
  74013. readonly FxaaPostProcessId: string;
  74014. /**
  74015. * ID of the chromatic aberration post process,
  74016. */
  74017. private readonly ChromaticAberrationPostProcessId;
  74018. /**
  74019. * ID of the grain post process
  74020. */
  74021. private readonly GrainPostProcessId;
  74022. /**
  74023. * Sharpen post process which will apply a sharpen convolution to enhance edges
  74024. */
  74025. sharpen: SharpenPostProcess;
  74026. private _sharpenEffect;
  74027. private bloom;
  74028. /**
  74029. * Depth of field effect, applies a blur based on how far away objects are from the focus distance.
  74030. */
  74031. depthOfField: DepthOfFieldEffect;
  74032. /**
  74033. * The Fast Approximate Anti-Aliasing post process which attemps to remove aliasing from an image.
  74034. */
  74035. fxaa: FxaaPostProcess;
  74036. /**
  74037. * Image post processing pass used to perform operations such as tone mapping or color grading.
  74038. */
  74039. imageProcessing: ImageProcessingPostProcess;
  74040. /**
  74041. * Chromatic aberration post process which will shift rgb colors in the image
  74042. */
  74043. chromaticAberration: ChromaticAberrationPostProcess;
  74044. private _chromaticAberrationEffect;
  74045. /**
  74046. * Grain post process which add noise to the image
  74047. */
  74048. grain: GrainPostProcess;
  74049. private _grainEffect;
  74050. /**
  74051. * Glow post process which adds a glow to emissive areas of the image
  74052. */
  74053. private _glowLayer;
  74054. /**
  74055. * Animations which can be used to tweak settings over a period of time
  74056. */
  74057. animations: Animation[];
  74058. private _imageProcessingConfigurationObserver;
  74059. private _sharpenEnabled;
  74060. private _bloomEnabled;
  74061. private _depthOfFieldEnabled;
  74062. private _depthOfFieldBlurLevel;
  74063. private _fxaaEnabled;
  74064. private _imageProcessingEnabled;
  74065. private _defaultPipelineTextureType;
  74066. private _bloomScale;
  74067. private _chromaticAberrationEnabled;
  74068. private _grainEnabled;
  74069. private _buildAllowed;
  74070. /**
  74071. * Gets active scene
  74072. */
  74073. get scene(): Scene;
  74074. /**
  74075. * Enable or disable the sharpen process from the pipeline
  74076. */
  74077. set sharpenEnabled(enabled: boolean);
  74078. get sharpenEnabled(): boolean;
  74079. private _resizeObserver;
  74080. private _hardwareScaleLevel;
  74081. private _bloomKernel;
  74082. /**
  74083. * Specifies the size of the bloom blur kernel, relative to the final output size
  74084. */
  74085. get bloomKernel(): number;
  74086. set bloomKernel(value: number);
  74087. /**
  74088. * Specifies the weight of the bloom in the final rendering
  74089. */
  74090. private _bloomWeight;
  74091. /**
  74092. * Specifies the luma threshold for the area that will be blurred by the bloom
  74093. */
  74094. private _bloomThreshold;
  74095. private _hdr;
  74096. /**
  74097. * The strength of the bloom.
  74098. */
  74099. set bloomWeight(value: number);
  74100. get bloomWeight(): number;
  74101. /**
  74102. * The strength of the bloom.
  74103. */
  74104. set bloomThreshold(value: number);
  74105. get bloomThreshold(): number;
  74106. /**
  74107. * The scale of the bloom, lower value will provide better performance.
  74108. */
  74109. set bloomScale(value: number);
  74110. get bloomScale(): number;
  74111. /**
  74112. * Enable or disable the bloom from the pipeline
  74113. */
  74114. set bloomEnabled(enabled: boolean);
  74115. get bloomEnabled(): boolean;
  74116. private _rebuildBloom;
  74117. /**
  74118. * If the depth of field is enabled.
  74119. */
  74120. get depthOfFieldEnabled(): boolean;
  74121. set depthOfFieldEnabled(enabled: boolean);
  74122. /**
  74123. * Blur level of the depth of field effect. (Higher blur will effect performance)
  74124. */
  74125. get depthOfFieldBlurLevel(): DepthOfFieldEffectBlurLevel;
  74126. set depthOfFieldBlurLevel(value: DepthOfFieldEffectBlurLevel);
  74127. /**
  74128. * If the anti aliasing is enabled.
  74129. */
  74130. set fxaaEnabled(enabled: boolean);
  74131. get fxaaEnabled(): boolean;
  74132. private _samples;
  74133. /**
  74134. * MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
  74135. */
  74136. set samples(sampleCount: number);
  74137. get samples(): number;
  74138. /**
  74139. * If image processing is enabled.
  74140. */
  74141. set imageProcessingEnabled(enabled: boolean);
  74142. get imageProcessingEnabled(): boolean;
  74143. /**
  74144. * If glow layer is enabled. (Adds a glow effect to emmissive materials)
  74145. */
  74146. set glowLayerEnabled(enabled: boolean);
  74147. get glowLayerEnabled(): boolean;
  74148. /**
  74149. * Gets the glow layer (or null if not defined)
  74150. */
  74151. get glowLayer(): Nullable<GlowLayer>;
  74152. /**
  74153. * Enable or disable the chromaticAberration process from the pipeline
  74154. */
  74155. set chromaticAberrationEnabled(enabled: boolean);
  74156. get chromaticAberrationEnabled(): boolean;
  74157. /**
  74158. * Enable or disable the grain process from the pipeline
  74159. */
  74160. set grainEnabled(enabled: boolean);
  74161. get grainEnabled(): boolean;
  74162. /**
  74163. * @constructor
  74164. * @param name - The rendering pipeline name (default: "")
  74165. * @param hdr - If high dynamic range textures should be used (default: true)
  74166. * @param scene - The scene linked to this pipeline (default: the last created scene)
  74167. * @param cameras - The array of cameras that the rendering pipeline will be attached to (default: scene.cameras)
  74168. * @param automaticBuild - if false, you will have to manually call prepare() to update the pipeline (default: true)
  74169. */
  74170. constructor(name?: string, hdr?: boolean, scene?: Scene, cameras?: Camera[], automaticBuild?: boolean);
  74171. /**
  74172. * Get the class name
  74173. * @returns "DefaultRenderingPipeline"
  74174. */
  74175. getClassName(): string;
  74176. /**
  74177. * Force the compilation of the entire pipeline.
  74178. */
  74179. prepare(): void;
  74180. private _hasCleared;
  74181. private _prevPostProcess;
  74182. private _prevPrevPostProcess;
  74183. private _setAutoClearAndTextureSharing;
  74184. private _depthOfFieldSceneObserver;
  74185. private _buildPipeline;
  74186. private _disposePostProcesses;
  74187. /**
  74188. * Adds a camera to the pipeline
  74189. * @param camera the camera to be added
  74190. */
  74191. addCamera(camera: Camera): void;
  74192. /**
  74193. * Removes a camera from the pipeline
  74194. * @param camera the camera to remove
  74195. */
  74196. removeCamera(camera: Camera): void;
  74197. /**
  74198. * Dispose of the pipeline and stop all post processes
  74199. */
  74200. dispose(): void;
  74201. /**
  74202. * Serialize the rendering pipeline (Used when exporting)
  74203. * @returns the serialized object
  74204. */
  74205. serialize(): any;
  74206. /**
  74207. * Parse the serialized pipeline
  74208. * @param source Source pipeline.
  74209. * @param scene The scene to load the pipeline to.
  74210. * @param rootUrl The URL of the serialized pipeline.
  74211. * @returns An instantiated pipeline from the serialized object.
  74212. */
  74213. static Parse(source: any, scene: Scene, rootUrl: string): DefaultRenderingPipeline;
  74214. }
  74215. }
  74216. declare module "babylonjs/Shaders/lensHighlights.fragment" {
  74217. /** @hidden */
  74218. export var lensHighlightsPixelShader: {
  74219. name: string;
  74220. shader: string;
  74221. };
  74222. }
  74223. declare module "babylonjs/Shaders/depthOfField.fragment" {
  74224. /** @hidden */
  74225. export var depthOfFieldPixelShader: {
  74226. name: string;
  74227. shader: string;
  74228. };
  74229. }
  74230. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/lensRenderingPipeline" {
  74231. import { Camera } from "babylonjs/Cameras/camera";
  74232. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  74233. import { Scene } from "babylonjs/scene";
  74234. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  74235. import "babylonjs/Shaders/chromaticAberration.fragment";
  74236. import "babylonjs/Shaders/lensHighlights.fragment";
  74237. import "babylonjs/Shaders/depthOfField.fragment";
  74238. /**
  74239. * BABYLON.JS Chromatic Aberration GLSL Shader
  74240. * Author: Olivier Guyot
  74241. * Separates very slightly R, G and B colors on the edges of the screen
  74242. * Inspired by Francois Tarlier & Martins Upitis
  74243. */
  74244. export class LensRenderingPipeline extends PostProcessRenderPipeline {
  74245. /**
  74246. * @ignore
  74247. * The chromatic aberration PostProcess id in the pipeline
  74248. */
  74249. LensChromaticAberrationEffect: string;
  74250. /**
  74251. * @ignore
  74252. * The highlights enhancing PostProcess id in the pipeline
  74253. */
  74254. HighlightsEnhancingEffect: string;
  74255. /**
  74256. * @ignore
  74257. * The depth-of-field PostProcess id in the pipeline
  74258. */
  74259. LensDepthOfFieldEffect: string;
  74260. private _scene;
  74261. private _depthTexture;
  74262. private _grainTexture;
  74263. private _chromaticAberrationPostProcess;
  74264. private _highlightsPostProcess;
  74265. private _depthOfFieldPostProcess;
  74266. private _edgeBlur;
  74267. private _grainAmount;
  74268. private _chromaticAberration;
  74269. private _distortion;
  74270. private _highlightsGain;
  74271. private _highlightsThreshold;
  74272. private _dofDistance;
  74273. private _dofAperture;
  74274. private _dofDarken;
  74275. private _dofPentagon;
  74276. private _blurNoise;
  74277. /**
  74278. * @constructor
  74279. *
  74280. * Effect parameters are as follow:
  74281. * {
  74282. * chromatic_aberration: number; // from 0 to x (1 for realism)
  74283. * edge_blur: number; // from 0 to x (1 for realism)
  74284. * distortion: number; // from 0 to x (1 for realism)
  74285. * grain_amount: number; // from 0 to 1
  74286. * grain_texture: BABYLON.Texture; // texture to use for grain effect; if unset, use random B&W noise
  74287. * dof_focus_distance: number; // depth-of-field: focus distance; unset to disable (disabled by default)
  74288. * dof_aperture: number; // depth-of-field: focus blur bias (default: 1)
  74289. * dof_darken: number; // depth-of-field: darken that which is out of focus (from 0 to 1, disabled by default)
  74290. * dof_pentagon: boolean; // depth-of-field: makes a pentagon-like "bokeh" effect
  74291. * dof_gain: number; // depth-of-field: highlights gain; unset to disable (disabled by default)
  74292. * dof_threshold: number; // depth-of-field: highlights threshold (default: 1)
  74293. * blur_noise: boolean; // add a little bit of noise to the blur (default: true)
  74294. * }
  74295. * Note: if an effect parameter is unset, effect is disabled
  74296. *
  74297. * @param name The rendering pipeline name
  74298. * @param parameters - An object containing all parameters (see above)
  74299. * @param scene The scene linked to this pipeline
  74300. * @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)
  74301. * @param cameras The array of cameras that the rendering pipeline will be attached to
  74302. */
  74303. constructor(name: string, parameters: any, scene: Scene, ratio?: number, cameras?: Camera[]);
  74304. /**
  74305. * Get the class name
  74306. * @returns "LensRenderingPipeline"
  74307. */
  74308. getClassName(): string;
  74309. /**
  74310. * Gets associated scene
  74311. */
  74312. get scene(): Scene;
  74313. /**
  74314. * Gets or sets the edge blur
  74315. */
  74316. get edgeBlur(): number;
  74317. set edgeBlur(value: number);
  74318. /**
  74319. * Gets or sets the grain amount
  74320. */
  74321. get grainAmount(): number;
  74322. set grainAmount(value: number);
  74323. /**
  74324. * Gets or sets the chromatic aberration amount
  74325. */
  74326. get chromaticAberration(): number;
  74327. set chromaticAberration(value: number);
  74328. /**
  74329. * Gets or sets the depth of field aperture
  74330. */
  74331. get dofAperture(): number;
  74332. set dofAperture(value: number);
  74333. /**
  74334. * Gets or sets the edge distortion
  74335. */
  74336. get edgeDistortion(): number;
  74337. set edgeDistortion(value: number);
  74338. /**
  74339. * Gets or sets the depth of field distortion
  74340. */
  74341. get dofDistortion(): number;
  74342. set dofDistortion(value: number);
  74343. /**
  74344. * Gets or sets the darken out of focus amount
  74345. */
  74346. get darkenOutOfFocus(): number;
  74347. set darkenOutOfFocus(value: number);
  74348. /**
  74349. * Gets or sets a boolean indicating if blur noise is enabled
  74350. */
  74351. get blurNoise(): boolean;
  74352. set blurNoise(value: boolean);
  74353. /**
  74354. * Gets or sets a boolean indicating if pentagon bokeh is enabled
  74355. */
  74356. get pentagonBokeh(): boolean;
  74357. set pentagonBokeh(value: boolean);
  74358. /**
  74359. * Gets or sets the highlight grain amount
  74360. */
  74361. get highlightsGain(): number;
  74362. set highlightsGain(value: number);
  74363. /**
  74364. * Gets or sets the highlight threshold
  74365. */
  74366. get highlightsThreshold(): number;
  74367. set highlightsThreshold(value: number);
  74368. /**
  74369. * Sets the amount of blur at the edges
  74370. * @param amount blur amount
  74371. */
  74372. setEdgeBlur(amount: number): void;
  74373. /**
  74374. * Sets edge blur to 0
  74375. */
  74376. disableEdgeBlur(): void;
  74377. /**
  74378. * Sets the amout of grain
  74379. * @param amount Amount of grain
  74380. */
  74381. setGrainAmount(amount: number): void;
  74382. /**
  74383. * Set grain amount to 0
  74384. */
  74385. disableGrain(): void;
  74386. /**
  74387. * Sets the chromatic aberration amount
  74388. * @param amount amount of chromatic aberration
  74389. */
  74390. setChromaticAberration(amount: number): void;
  74391. /**
  74392. * Sets chromatic aberration amount to 0
  74393. */
  74394. disableChromaticAberration(): void;
  74395. /**
  74396. * Sets the EdgeDistortion amount
  74397. * @param amount amount of EdgeDistortion
  74398. */
  74399. setEdgeDistortion(amount: number): void;
  74400. /**
  74401. * Sets edge distortion to 0
  74402. */
  74403. disableEdgeDistortion(): void;
  74404. /**
  74405. * Sets the FocusDistance amount
  74406. * @param amount amount of FocusDistance
  74407. */
  74408. setFocusDistance(amount: number): void;
  74409. /**
  74410. * Disables depth of field
  74411. */
  74412. disableDepthOfField(): void;
  74413. /**
  74414. * Sets the Aperture amount
  74415. * @param amount amount of Aperture
  74416. */
  74417. setAperture(amount: number): void;
  74418. /**
  74419. * Sets the DarkenOutOfFocus amount
  74420. * @param amount amount of DarkenOutOfFocus
  74421. */
  74422. setDarkenOutOfFocus(amount: number): void;
  74423. private _pentagonBokehIsEnabled;
  74424. /**
  74425. * Creates a pentagon bokeh effect
  74426. */
  74427. enablePentagonBokeh(): void;
  74428. /**
  74429. * Disables the pentagon bokeh effect
  74430. */
  74431. disablePentagonBokeh(): void;
  74432. /**
  74433. * Enables noise blur
  74434. */
  74435. enableNoiseBlur(): void;
  74436. /**
  74437. * Disables noise blur
  74438. */
  74439. disableNoiseBlur(): void;
  74440. /**
  74441. * Sets the HighlightsGain amount
  74442. * @param amount amount of HighlightsGain
  74443. */
  74444. setHighlightsGain(amount: number): void;
  74445. /**
  74446. * Sets the HighlightsThreshold amount
  74447. * @param amount amount of HighlightsThreshold
  74448. */
  74449. setHighlightsThreshold(amount: number): void;
  74450. /**
  74451. * Disables highlights
  74452. */
  74453. disableHighlights(): void;
  74454. /**
  74455. * Removes the internal pipeline assets and detaches the pipeline from the scene cameras
  74456. * @param disableDepthRender If the scens depth rendering should be disabled (default: false)
  74457. */
  74458. dispose(disableDepthRender?: boolean): void;
  74459. private _createChromaticAberrationPostProcess;
  74460. private _createHighlightsPostProcess;
  74461. private _createDepthOfFieldPostProcess;
  74462. private _createGrainTexture;
  74463. }
  74464. }
  74465. declare module "babylonjs/Shaders/ssao2.fragment" {
  74466. /** @hidden */
  74467. export var ssao2PixelShader: {
  74468. name: string;
  74469. shader: string;
  74470. };
  74471. }
  74472. declare module "babylonjs/Shaders/ssaoCombine.fragment" {
  74473. /** @hidden */
  74474. export var ssaoCombinePixelShader: {
  74475. name: string;
  74476. shader: string;
  74477. };
  74478. }
  74479. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/ssao2RenderingPipeline" {
  74480. import { Camera } from "babylonjs/Cameras/camera";
  74481. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  74482. import { Scene } from "babylonjs/scene";
  74483. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  74484. import "babylonjs/Shaders/ssao2.fragment";
  74485. import "babylonjs/Shaders/ssaoCombine.fragment";
  74486. import { PrePassRenderer } from "babylonjs/Rendering/prePassRenderer";
  74487. /**
  74488. * Render pipeline to produce ssao effect
  74489. */
  74490. export class SSAO2RenderingPipeline extends PostProcessRenderPipeline {
  74491. /**
  74492. * @ignore
  74493. * The PassPostProcess id in the pipeline that contains the original scene color
  74494. */
  74495. SSAOOriginalSceneColorEffect: string;
  74496. /**
  74497. * @ignore
  74498. * The SSAO PostProcess id in the pipeline
  74499. */
  74500. SSAORenderEffect: string;
  74501. /**
  74502. * @ignore
  74503. * The horizontal blur PostProcess id in the pipeline
  74504. */
  74505. SSAOBlurHRenderEffect: string;
  74506. /**
  74507. * @ignore
  74508. * The vertical blur PostProcess id in the pipeline
  74509. */
  74510. SSAOBlurVRenderEffect: string;
  74511. /**
  74512. * @ignore
  74513. * The PostProcess id in the pipeline that combines the SSAO-Blur output with the original scene color (SSAOOriginalSceneColorEffect)
  74514. */
  74515. SSAOCombineRenderEffect: string;
  74516. /**
  74517. * The output strength of the SSAO post-process. Default value is 1.0.
  74518. */
  74519. totalStrength: number;
  74520. /**
  74521. * Maximum depth value to still render AO. A smooth falloff makes the dimming more natural, so there will be no abrupt shading change.
  74522. */
  74523. maxZ: number;
  74524. /**
  74525. * In order to save performances, SSAO radius is clamped on close geometry. This ratio changes by how much
  74526. */
  74527. minZAspect: number;
  74528. private _samples;
  74529. /**
  74530. * Number of samples used for the SSAO calculations. Default value is 8
  74531. */
  74532. set samples(n: number);
  74533. get samples(): number;
  74534. private _textureSamples;
  74535. /**
  74536. * Number of samples to use for antialiasing
  74537. */
  74538. set textureSamples(n: number);
  74539. get textureSamples(): number;
  74540. /**
  74541. * Force rendering the geometry through geometry buffer
  74542. */
  74543. private _forceGeometryBuffer;
  74544. /**
  74545. * Ratio object used for SSAO ratio and blur ratio
  74546. */
  74547. private _ratio;
  74548. /**
  74549. * Dynamically generated sphere sampler.
  74550. */
  74551. private _sampleSphere;
  74552. /**
  74553. * Blur filter offsets
  74554. */
  74555. private _samplerOffsets;
  74556. private _expensiveBlur;
  74557. /**
  74558. * If bilateral blur should be used
  74559. */
  74560. set expensiveBlur(b: boolean);
  74561. get expensiveBlur(): boolean;
  74562. /**
  74563. * The radius around the analyzed pixel used by the SSAO post-process. Default value is 2.0
  74564. */
  74565. radius: number;
  74566. /**
  74567. * The base color of the SSAO post-process
  74568. * The final result is "base + ssao" between [0, 1]
  74569. */
  74570. base: number;
  74571. /**
  74572. * Support test.
  74573. */
  74574. static get IsSupported(): boolean;
  74575. private _scene;
  74576. private _randomTexture;
  74577. private _originalColorPostProcess;
  74578. private _ssaoPostProcess;
  74579. private _blurHPostProcess;
  74580. private _blurVPostProcess;
  74581. private _ssaoCombinePostProcess;
  74582. private _prePassRenderer;
  74583. /**
  74584. * Gets active scene
  74585. */
  74586. get scene(): Scene;
  74587. /**
  74588. * @constructor
  74589. * @param name The rendering pipeline name
  74590. * @param scene The scene linked to this pipeline
  74591. * @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 }
  74592. * @param cameras The array of cameras that the rendering pipeline will be attached to
  74593. * @param forceGeometryBuffer Set to true if you want to use the legacy geometry buffer renderer
  74594. */
  74595. constructor(name: string, scene: Scene, ratio: any, cameras?: Camera[], forceGeometryBuffer?: boolean);
  74596. /**
  74597. * Get the class name
  74598. * @returns "SSAO2RenderingPipeline"
  74599. */
  74600. getClassName(): string;
  74601. /**
  74602. * Removes the internal pipeline assets and detatches the pipeline from the scene cameras
  74603. */
  74604. dispose(disableGeometryBufferRenderer?: boolean): void;
  74605. private _createBlurPostProcess;
  74606. /** @hidden */
  74607. _rebuild(): void;
  74608. private _bits;
  74609. private _radicalInverse_VdC;
  74610. private _hammersley;
  74611. private _hemisphereSample_uniform;
  74612. private _generateHemisphere;
  74613. private _getDefinesForSSAO;
  74614. private _createSSAOPostProcess;
  74615. private _createSSAOCombinePostProcess;
  74616. private _createRandomTexture;
  74617. /**
  74618. * Serialize the rendering pipeline (Used when exporting)
  74619. * @returns the serialized object
  74620. */
  74621. serialize(): any;
  74622. /**
  74623. * Parse the serialized pipeline
  74624. * @param source Source pipeline.
  74625. * @param scene The scene to load the pipeline to.
  74626. * @param rootUrl The URL of the serialized pipeline.
  74627. * @returns An instantiated pipeline from the serialized object.
  74628. */
  74629. static Parse(source: any, scene: Scene, rootUrl: string): SSAO2RenderingPipeline;
  74630. /**
  74631. * Sets the required values to the prepass renderer.
  74632. * @param prePassRenderer defines the prepass renderer to setup
  74633. * @returns true if the pre pass is needed.
  74634. */
  74635. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  74636. }
  74637. }
  74638. declare module "babylonjs/Shaders/ssao.fragment" {
  74639. /** @hidden */
  74640. export var ssaoPixelShader: {
  74641. name: string;
  74642. shader: string;
  74643. };
  74644. }
  74645. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/ssaoRenderingPipeline" {
  74646. import { Camera } from "babylonjs/Cameras/camera";
  74647. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  74648. import { Scene } from "babylonjs/scene";
  74649. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  74650. import "babylonjs/Shaders/ssao.fragment";
  74651. import "babylonjs/Shaders/ssaoCombine.fragment";
  74652. /**
  74653. * Render pipeline to produce ssao effect
  74654. */
  74655. export class SSAORenderingPipeline extends PostProcessRenderPipeline {
  74656. /**
  74657. * @ignore
  74658. * The PassPostProcess id in the pipeline that contains the original scene color
  74659. */
  74660. SSAOOriginalSceneColorEffect: string;
  74661. /**
  74662. * @ignore
  74663. * The SSAO PostProcess id in the pipeline
  74664. */
  74665. SSAORenderEffect: string;
  74666. /**
  74667. * @ignore
  74668. * The horizontal blur PostProcess id in the pipeline
  74669. */
  74670. SSAOBlurHRenderEffect: string;
  74671. /**
  74672. * @ignore
  74673. * The vertical blur PostProcess id in the pipeline
  74674. */
  74675. SSAOBlurVRenderEffect: string;
  74676. /**
  74677. * @ignore
  74678. * The PostProcess id in the pipeline that combines the SSAO-Blur output with the original scene color (SSAOOriginalSceneColorEffect)
  74679. */
  74680. SSAOCombineRenderEffect: string;
  74681. /**
  74682. * The output strength of the SSAO post-process. Default value is 1.0.
  74683. */
  74684. totalStrength: number;
  74685. /**
  74686. * The radius around the analyzed pixel used by the SSAO post-process. Default value is 0.0006
  74687. */
  74688. radius: number;
  74689. /**
  74690. * Related to fallOff, used to interpolate SSAO samples (first interpolate function input) based on the occlusion difference of each pixel
  74691. * Must not be equal to fallOff and superior to fallOff.
  74692. * Default value is 0.0075
  74693. */
  74694. area: number;
  74695. /**
  74696. * Related to area, used to interpolate SSAO samples (second interpolate function input) based on the occlusion difference of each pixel
  74697. * Must not be equal to area and inferior to area.
  74698. * Default value is 0.000001
  74699. */
  74700. fallOff: number;
  74701. /**
  74702. * The base color of the SSAO post-process
  74703. * The final result is "base + ssao" between [0, 1]
  74704. */
  74705. base: number;
  74706. private _scene;
  74707. private _depthTexture;
  74708. private _randomTexture;
  74709. private _originalColorPostProcess;
  74710. private _ssaoPostProcess;
  74711. private _blurHPostProcess;
  74712. private _blurVPostProcess;
  74713. private _ssaoCombinePostProcess;
  74714. private _firstUpdate;
  74715. /**
  74716. * Gets active scene
  74717. */
  74718. get scene(): Scene;
  74719. /**
  74720. * @constructor
  74721. * @param name - The rendering pipeline name
  74722. * @param scene - The scene linked to this pipeline
  74723. * @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 }
  74724. * @param cameras - The array of cameras that the rendering pipeline will be attached to
  74725. */
  74726. constructor(name: string, scene: Scene, ratio: any, cameras?: Camera[]);
  74727. /**
  74728. * Get the class name
  74729. * @returns "SSAORenderingPipeline"
  74730. */
  74731. getClassName(): string;
  74732. /**
  74733. * Removes the internal pipeline assets and detatches the pipeline from the scene cameras
  74734. */
  74735. dispose(disableDepthRender?: boolean): void;
  74736. private _createBlurPostProcess;
  74737. /** @hidden */
  74738. _rebuild(): void;
  74739. private _createSSAOPostProcess;
  74740. private _createSSAOCombinePostProcess;
  74741. private _createRandomTexture;
  74742. }
  74743. }
  74744. declare module "babylonjs/Shaders/screenSpaceReflection.fragment" {
  74745. /** @hidden */
  74746. export var screenSpaceReflectionPixelShader: {
  74747. name: string;
  74748. shader: string;
  74749. };
  74750. }
  74751. declare module "babylonjs/PostProcesses/screenSpaceReflectionPostProcess" {
  74752. import { Nullable } from "babylonjs/types";
  74753. import { Camera } from "babylonjs/Cameras/camera";
  74754. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  74755. import "babylonjs/Shaders/screenSpaceReflection.fragment";
  74756. import { Engine } from "babylonjs/Engines/engine";
  74757. import { Scene } from "babylonjs/scene";
  74758. /**
  74759. * The ScreenSpaceReflectionPostProcess performs realtime reflections using only and only the available informations on the screen (positions and normals).
  74760. * Basically, the screen space reflection post-process will compute reflections according the material's reflectivity.
  74761. */
  74762. export class ScreenSpaceReflectionPostProcess extends PostProcess {
  74763. /**
  74764. * Gets or sets a reflection threshold mainly used to adjust the reflection's height.
  74765. */
  74766. threshold: number;
  74767. /**
  74768. * Gets or sets the current reflection strength. 1.0 is an ideal value but can be increased/decreased for particular results.
  74769. */
  74770. strength: number;
  74771. /**
  74772. * Gets or sets the falloff exponent used while computing fresnel. More the exponent is high, more the reflections will be discrete.
  74773. */
  74774. reflectionSpecularFalloffExponent: number;
  74775. /**
  74776. * 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]
  74777. */
  74778. step: number;
  74779. /**
  74780. * Gets or sets the factor applied when computing roughness. Default value is 0.2.
  74781. */
  74782. roughnessFactor: number;
  74783. private _geometryBufferRenderer;
  74784. private _enableSmoothReflections;
  74785. private _reflectionSamples;
  74786. private _smoothSteps;
  74787. /**
  74788. * Gets a string identifying the name of the class
  74789. * @returns "ScreenSpaceReflectionPostProcess" string
  74790. */
  74791. getClassName(): string;
  74792. /**
  74793. * Creates a new instance of ScreenSpaceReflectionPostProcess.
  74794. * @param name The name of the effect.
  74795. * @param scene The scene containing the objects to calculate reflections.
  74796. * @param options The required width/height ratio to downsize to before computing the render pass.
  74797. * @param camera The camera to apply the render pass to.
  74798. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  74799. * @param engine The engine which the post process will be applied. (default: current engine)
  74800. * @param reusable If the post process can be reused on the same frame. (default: false)
  74801. * @param textureType Type of textures used when performing the post process. (default: 0)
  74802. * @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)
  74803. */
  74804. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  74805. /**
  74806. * Gets wether or not smoothing reflections is enabled.
  74807. * Enabling smoothing will require more GPU power and can generate a drop in FPS.
  74808. */
  74809. get enableSmoothReflections(): boolean;
  74810. /**
  74811. * Sets wether or not smoothing reflections is enabled.
  74812. * Enabling smoothing will require more GPU power and can generate a drop in FPS.
  74813. */
  74814. set enableSmoothReflections(enabled: boolean);
  74815. /**
  74816. * Gets the number of samples taken while computing reflections. More samples count is high,
  74817. * more the post-process wil require GPU power and can generate a drop in FPS. Basically in interval [25, 100].
  74818. */
  74819. get reflectionSamples(): number;
  74820. /**
  74821. * Sets the number of samples taken while computing reflections. More samples count is high,
  74822. * more the post-process wil require GPU power and can generate a drop in FPS. Basically in interval [25, 100].
  74823. */
  74824. set reflectionSamples(samples: number);
  74825. /**
  74826. * Gets the number of samples taken while smoothing reflections. More samples count is high,
  74827. * more the post-process will require GPU power and can generate a drop in FPS.
  74828. * Default value (5.0) work pretty well in all cases but can be adjusted.
  74829. */
  74830. get smoothSteps(): number;
  74831. set smoothSteps(steps: number);
  74832. private _updateEffectDefines;
  74833. /** @hidden */
  74834. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): ScreenSpaceReflectionPostProcess;
  74835. }
  74836. }
  74837. declare module "babylonjs/Shaders/standard.fragment" {
  74838. import "babylonjs/Shaders/ShadersInclude/packingFunctions";
  74839. /** @hidden */
  74840. export var standardPixelShader: {
  74841. name: string;
  74842. shader: string;
  74843. };
  74844. }
  74845. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/standardRenderingPipeline" {
  74846. import { Nullable } from "babylonjs/types";
  74847. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  74848. import { Camera } from "babylonjs/Cameras/camera";
  74849. import { Texture } from "babylonjs/Materials/Textures/texture";
  74850. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  74851. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  74852. import { BlurPostProcess } from "babylonjs/PostProcesses/blurPostProcess";
  74853. import { FxaaPostProcess } from "babylonjs/PostProcesses/fxaaPostProcess";
  74854. import { IDisposable } from "babylonjs/scene";
  74855. import { SpotLight } from "babylonjs/Lights/spotLight";
  74856. import { DirectionalLight } from "babylonjs/Lights/directionalLight";
  74857. import { Scene } from "babylonjs/scene";
  74858. import { ScreenSpaceReflectionPostProcess } from "babylonjs/PostProcesses/screenSpaceReflectionPostProcess";
  74859. import { Animation } from "babylonjs/Animations/animation";
  74860. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  74861. import "babylonjs/Shaders/standard.fragment";
  74862. /**
  74863. * Standard rendering pipeline
  74864. * Default pipeline should be used going forward but the standard pipeline will be kept for backwards compatibility.
  74865. * @see https://doc.babylonjs.com/how_to/using_standard_rendering_pipeline
  74866. */
  74867. export class StandardRenderingPipeline extends PostProcessRenderPipeline implements IDisposable, IAnimatable {
  74868. /**
  74869. * Public members
  74870. */
  74871. /**
  74872. * Post-process which contains the original scene color before the pipeline applies all the effects
  74873. */
  74874. originalPostProcess: Nullable<PostProcess>;
  74875. /**
  74876. * Post-process used to down scale an image x4
  74877. */
  74878. downSampleX4PostProcess: Nullable<PostProcess>;
  74879. /**
  74880. * Post-process used to calculate the illuminated surfaces controlled by a threshold
  74881. */
  74882. brightPassPostProcess: Nullable<PostProcess>;
  74883. /**
  74884. * Post-process array storing all the horizontal blur post-processes used by the pipeline
  74885. */
  74886. blurHPostProcesses: PostProcess[];
  74887. /**
  74888. * Post-process array storing all the vertical blur post-processes used by the pipeline
  74889. */
  74890. blurVPostProcesses: PostProcess[];
  74891. /**
  74892. * Post-process used to add colors of 2 textures (typically brightness + real scene color)
  74893. */
  74894. textureAdderPostProcess: Nullable<PostProcess>;
  74895. /**
  74896. * Post-process used to create volumetric lighting effect
  74897. */
  74898. volumetricLightPostProcess: Nullable<PostProcess>;
  74899. /**
  74900. * Post-process used to smooth the previous volumetric light post-process on the X axis
  74901. */
  74902. volumetricLightSmoothXPostProcess: Nullable<BlurPostProcess>;
  74903. /**
  74904. * Post-process used to smooth the previous volumetric light post-process on the Y axis
  74905. */
  74906. volumetricLightSmoothYPostProcess: Nullable<BlurPostProcess>;
  74907. /**
  74908. * Post-process used to merge the volumetric light effect and the real scene color
  74909. */
  74910. volumetricLightMergePostProces: Nullable<PostProcess>;
  74911. /**
  74912. * Post-process used to store the final volumetric light post-process (attach/detach for debug purpose)
  74913. */
  74914. volumetricLightFinalPostProcess: Nullable<PostProcess>;
  74915. /**
  74916. * Base post-process used to calculate the average luminance of the final image for HDR
  74917. */
  74918. luminancePostProcess: Nullable<PostProcess>;
  74919. /**
  74920. * Post-processes used to create down sample post-processes in order to get
  74921. * the average luminance of the final image for HDR
  74922. * Array of length "StandardRenderingPipeline.LuminanceSteps"
  74923. */
  74924. luminanceDownSamplePostProcesses: PostProcess[];
  74925. /**
  74926. * Post-process used to create a HDR effect (light adaptation)
  74927. */
  74928. hdrPostProcess: Nullable<PostProcess>;
  74929. /**
  74930. * Post-process used to store the final texture adder post-process (attach/detach for debug purpose)
  74931. */
  74932. textureAdderFinalPostProcess: Nullable<PostProcess>;
  74933. /**
  74934. * Post-process used to store the final lens flare post-process (attach/detach for debug purpose)
  74935. */
  74936. lensFlareFinalPostProcess: Nullable<PostProcess>;
  74937. /**
  74938. * Post-process used to merge the final HDR post-process and the real scene color
  74939. */
  74940. hdrFinalPostProcess: Nullable<PostProcess>;
  74941. /**
  74942. * Post-process used to create a lens flare effect
  74943. */
  74944. lensFlarePostProcess: Nullable<PostProcess>;
  74945. /**
  74946. * Post-process that merges the result of the lens flare post-process and the real scene color
  74947. */
  74948. lensFlareComposePostProcess: Nullable<PostProcess>;
  74949. /**
  74950. * Post-process used to create a motion blur effect
  74951. */
  74952. motionBlurPostProcess: Nullable<PostProcess>;
  74953. /**
  74954. * Post-process used to create a depth of field effect
  74955. */
  74956. depthOfFieldPostProcess: Nullable<PostProcess>;
  74957. /**
  74958. * The Fast Approximate Anti-Aliasing post process which attemps to remove aliasing from an image.
  74959. */
  74960. fxaaPostProcess: Nullable<FxaaPostProcess>;
  74961. /**
  74962. * Post-process used to simulate realtime reflections using the screen space and geometry renderer.
  74963. */
  74964. screenSpaceReflectionPostProcess: Nullable<ScreenSpaceReflectionPostProcess>;
  74965. /**
  74966. * Represents the brightness threshold in order to configure the illuminated surfaces
  74967. */
  74968. brightThreshold: number;
  74969. /**
  74970. * Configures the blur intensity used for surexposed surfaces are highlighted surfaces (light halo)
  74971. */
  74972. blurWidth: number;
  74973. /**
  74974. * Sets if the blur for highlighted surfaces must be only horizontal
  74975. */
  74976. horizontalBlur: boolean;
  74977. /**
  74978. * Gets the overall exposure used by the pipeline
  74979. */
  74980. get exposure(): number;
  74981. /**
  74982. * Sets the overall exposure used by the pipeline
  74983. */
  74984. set exposure(value: number);
  74985. /**
  74986. * Texture used typically to simulate "dirty" on camera lens
  74987. */
  74988. lensTexture: Nullable<Texture>;
  74989. /**
  74990. * Represents the offset coefficient based on Rayleigh principle. Typically in interval [-0.2, 0.2]
  74991. */
  74992. volumetricLightCoefficient: number;
  74993. /**
  74994. * The overall power of volumetric lights, typically in interval [0, 10] maximum
  74995. */
  74996. volumetricLightPower: number;
  74997. /**
  74998. * Used the set the blur intensity to smooth the volumetric lights
  74999. */
  75000. volumetricLightBlurScale: number;
  75001. /**
  75002. * Light (spot or directional) used to generate the volumetric lights rays
  75003. * The source light must have a shadow generate so the pipeline can get its
  75004. * depth map
  75005. */
  75006. sourceLight: Nullable<SpotLight | DirectionalLight>;
  75007. /**
  75008. * For eye adaptation, represents the minimum luminance the eye can see
  75009. */
  75010. hdrMinimumLuminance: number;
  75011. /**
  75012. * For eye adaptation, represents the decrease luminance speed
  75013. */
  75014. hdrDecreaseRate: number;
  75015. /**
  75016. * For eye adaptation, represents the increase luminance speed
  75017. */
  75018. hdrIncreaseRate: number;
  75019. /**
  75020. * Gets wether or not the exposure of the overall pipeline should be automatically adjusted by the HDR post-process
  75021. */
  75022. get hdrAutoExposure(): boolean;
  75023. /**
  75024. * Sets wether or not the exposure of the overall pipeline should be automatically adjusted by the HDR post-process
  75025. */
  75026. set hdrAutoExposure(value: boolean);
  75027. /**
  75028. * Lens color texture used by the lens flare effect. Mandatory if lens flare effect enabled
  75029. */
  75030. lensColorTexture: Nullable<Texture>;
  75031. /**
  75032. * The overall strengh for the lens flare effect
  75033. */
  75034. lensFlareStrength: number;
  75035. /**
  75036. * Dispersion coefficient for lens flare ghosts
  75037. */
  75038. lensFlareGhostDispersal: number;
  75039. /**
  75040. * Main lens flare halo width
  75041. */
  75042. lensFlareHaloWidth: number;
  75043. /**
  75044. * Based on the lens distortion effect, defines how much the lens flare result
  75045. * is distorted
  75046. */
  75047. lensFlareDistortionStrength: number;
  75048. /**
  75049. * Configures the blur intensity used for for lens flare (halo)
  75050. */
  75051. lensFlareBlurWidth: number;
  75052. /**
  75053. * Lens star texture must be used to simulate rays on the flares and is available
  75054. * in the documentation
  75055. */
  75056. lensStarTexture: Nullable<Texture>;
  75057. /**
  75058. * As the "lensTexture" (can be the same texture or different), it is used to apply the lens
  75059. * flare effect by taking account of the dirt texture
  75060. */
  75061. lensFlareDirtTexture: Nullable<Texture>;
  75062. /**
  75063. * Represents the focal length for the depth of field effect
  75064. */
  75065. depthOfFieldDistance: number;
  75066. /**
  75067. * Represents the blur intensity for the blurred part of the depth of field effect
  75068. */
  75069. depthOfFieldBlurWidth: number;
  75070. /**
  75071. * Gets how much the image is blurred by the movement while using the motion blur post-process
  75072. */
  75073. get motionStrength(): number;
  75074. /**
  75075. * Sets how much the image is blurred by the movement while using the motion blur post-process
  75076. */
  75077. set motionStrength(strength: number);
  75078. /**
  75079. * Gets wether or not the motion blur post-process is object based or screen based.
  75080. */
  75081. get objectBasedMotionBlur(): boolean;
  75082. /**
  75083. * Sets wether or not the motion blur post-process should be object based or screen based
  75084. */
  75085. set objectBasedMotionBlur(value: boolean);
  75086. /**
  75087. * List of animations for the pipeline (IAnimatable implementation)
  75088. */
  75089. animations: Animation[];
  75090. /**
  75091. * Private members
  75092. */
  75093. private _scene;
  75094. private _currentDepthOfFieldSource;
  75095. private _basePostProcess;
  75096. private _fixedExposure;
  75097. private _currentExposure;
  75098. private _hdrAutoExposure;
  75099. private _hdrCurrentLuminance;
  75100. private _motionStrength;
  75101. private _isObjectBasedMotionBlur;
  75102. private _floatTextureType;
  75103. private _camerasToBeAttached;
  75104. private _ratio;
  75105. private _bloomEnabled;
  75106. private _depthOfFieldEnabled;
  75107. private _vlsEnabled;
  75108. private _lensFlareEnabled;
  75109. private _hdrEnabled;
  75110. private _motionBlurEnabled;
  75111. private _fxaaEnabled;
  75112. private _screenSpaceReflectionsEnabled;
  75113. private _motionBlurSamples;
  75114. private _volumetricLightStepsCount;
  75115. private _samples;
  75116. /**
  75117. * @ignore
  75118. * Specifies if the bloom pipeline is enabled
  75119. */
  75120. get BloomEnabled(): boolean;
  75121. set BloomEnabled(enabled: boolean);
  75122. /**
  75123. * @ignore
  75124. * Specifies if the depth of field pipeline is enabed
  75125. */
  75126. get DepthOfFieldEnabled(): boolean;
  75127. set DepthOfFieldEnabled(enabled: boolean);
  75128. /**
  75129. * @ignore
  75130. * Specifies if the lens flare pipeline is enabed
  75131. */
  75132. get LensFlareEnabled(): boolean;
  75133. set LensFlareEnabled(enabled: boolean);
  75134. /**
  75135. * @ignore
  75136. * Specifies if the HDR pipeline is enabled
  75137. */
  75138. get HDREnabled(): boolean;
  75139. set HDREnabled(enabled: boolean);
  75140. /**
  75141. * @ignore
  75142. * Specifies if the volumetric lights scattering effect is enabled
  75143. */
  75144. get VLSEnabled(): boolean;
  75145. set VLSEnabled(enabled: boolean);
  75146. /**
  75147. * @ignore
  75148. * Specifies if the motion blur effect is enabled
  75149. */
  75150. get MotionBlurEnabled(): boolean;
  75151. set MotionBlurEnabled(enabled: boolean);
  75152. /**
  75153. * Specifies if anti-aliasing is enabled
  75154. */
  75155. get fxaaEnabled(): boolean;
  75156. set fxaaEnabled(enabled: boolean);
  75157. /**
  75158. * Specifies if screen space reflections are enabled.
  75159. */
  75160. get screenSpaceReflectionsEnabled(): boolean;
  75161. set screenSpaceReflectionsEnabled(enabled: boolean);
  75162. /**
  75163. * Specifies the number of steps used to calculate the volumetric lights
  75164. * Typically in interval [50, 200]
  75165. */
  75166. get volumetricLightStepsCount(): number;
  75167. set volumetricLightStepsCount(count: number);
  75168. /**
  75169. * Specifies the number of samples used for the motion blur effect
  75170. * Typically in interval [16, 64]
  75171. */
  75172. get motionBlurSamples(): number;
  75173. set motionBlurSamples(samples: number);
  75174. /**
  75175. * Specifies MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
  75176. */
  75177. get samples(): number;
  75178. set samples(sampleCount: number);
  75179. /**
  75180. * Default pipeline should be used going forward but the standard pipeline will be kept for backwards compatibility.
  75181. * @constructor
  75182. * @param name The rendering pipeline name
  75183. * @param scene The scene linked to this pipeline
  75184. * @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)
  75185. * @param originalPostProcess the custom original color post-process. Must be "reusable". Can be null.
  75186. * @param cameras The array of cameras that the rendering pipeline will be attached to
  75187. */
  75188. constructor(name: string, scene: Scene, ratio: number, originalPostProcess?: Nullable<PostProcess>, cameras?: Camera[]);
  75189. private _buildPipeline;
  75190. private _createDownSampleX4PostProcess;
  75191. private _createBrightPassPostProcess;
  75192. private _createBlurPostProcesses;
  75193. private _createTextureAdderPostProcess;
  75194. private _createVolumetricLightPostProcess;
  75195. private _createLuminancePostProcesses;
  75196. private _createHdrPostProcess;
  75197. private _createLensFlarePostProcess;
  75198. private _createDepthOfFieldPostProcess;
  75199. private _createMotionBlurPostProcess;
  75200. private _getDepthTexture;
  75201. private _disposePostProcesses;
  75202. /**
  75203. * Dispose of the pipeline and stop all post processes
  75204. */
  75205. dispose(): void;
  75206. /**
  75207. * Serialize the rendering pipeline (Used when exporting)
  75208. * @returns the serialized object
  75209. */
  75210. serialize(): any;
  75211. /**
  75212. * Parse the serialized pipeline
  75213. * @param source Source pipeline.
  75214. * @param scene The scene to load the pipeline to.
  75215. * @param rootUrl The URL of the serialized pipeline.
  75216. * @returns An instantiated pipeline from the serialized object.
  75217. */
  75218. static Parse(source: any, scene: Scene, rootUrl: string): StandardRenderingPipeline;
  75219. /**
  75220. * Luminance steps
  75221. */
  75222. static LuminanceSteps: number;
  75223. }
  75224. }
  75225. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/index" {
  75226. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/defaultRenderingPipeline";
  75227. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/lensRenderingPipeline";
  75228. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/ssao2RenderingPipeline";
  75229. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/ssaoRenderingPipeline";
  75230. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/standardRenderingPipeline";
  75231. }
  75232. declare module "babylonjs/PostProcesses/RenderPipeline/index" {
  75233. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/index";
  75234. export * from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect";
  75235. export * from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  75236. export * from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManager";
  75237. export * from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  75238. }
  75239. declare module "babylonjs/Shaders/stereoscopicInterlace.fragment" {
  75240. /** @hidden */
  75241. export var stereoscopicInterlacePixelShader: {
  75242. name: string;
  75243. shader: string;
  75244. };
  75245. }
  75246. declare module "babylonjs/PostProcesses/stereoscopicInterlacePostProcess" {
  75247. import { Camera } from "babylonjs/Cameras/camera";
  75248. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  75249. import { Engine } from "babylonjs/Engines/engine";
  75250. import "babylonjs/Shaders/stereoscopicInterlace.fragment";
  75251. /**
  75252. * StereoscopicInterlacePostProcessI used to render stereo views from a rigged camera with support for alternate line interlacing
  75253. */
  75254. export class StereoscopicInterlacePostProcessI extends PostProcess {
  75255. private _stepSize;
  75256. private _passedProcess;
  75257. /**
  75258. * Gets a string identifying the name of the class
  75259. * @returns "StereoscopicInterlacePostProcessI" string
  75260. */
  75261. getClassName(): string;
  75262. /**
  75263. * Initializes a StereoscopicInterlacePostProcessI
  75264. * @param name The name of the effect.
  75265. * @param rigCameras The rig cameras to be appled to the post process
  75266. * @param isStereoscopicHoriz If the rendered results are horizontal or vertical
  75267. * @param isStereoscopicInterlaced If the rendered results are alternate line interlaced
  75268. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  75269. * @param engine The engine which the post process will be applied. (default: current engine)
  75270. * @param reusable If the post process can be reused on the same frame. (default: false)
  75271. */
  75272. constructor(name: string, rigCameras: Camera[], isStereoscopicHoriz: boolean, isStereoscopicInterlaced: boolean, samplingMode?: number, engine?: Engine, reusable?: boolean);
  75273. }
  75274. /**
  75275. * StereoscopicInterlacePostProcess used to render stereo views from a rigged camera
  75276. */
  75277. export class StereoscopicInterlacePostProcess extends PostProcess {
  75278. private _stepSize;
  75279. private _passedProcess;
  75280. /**
  75281. * Gets a string identifying the name of the class
  75282. * @returns "StereoscopicInterlacePostProcess" string
  75283. */
  75284. getClassName(): string;
  75285. /**
  75286. * Initializes a StereoscopicInterlacePostProcess
  75287. * @param name The name of the effect.
  75288. * @param rigCameras The rig cameras to be appled to the post process
  75289. * @param isStereoscopicHoriz If the rendered results are horizontal or verticle
  75290. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  75291. * @param engine The engine which the post process will be applied. (default: current engine)
  75292. * @param reusable If the post process can be reused on the same frame. (default: false)
  75293. */
  75294. constructor(name: string, rigCameras: Camera[], isStereoscopicHoriz: boolean, samplingMode?: number, engine?: Engine, reusable?: boolean);
  75295. }
  75296. }
  75297. declare module "babylonjs/Shaders/tonemap.fragment" {
  75298. /** @hidden */
  75299. export var tonemapPixelShader: {
  75300. name: string;
  75301. shader: string;
  75302. };
  75303. }
  75304. declare module "babylonjs/PostProcesses/tonemapPostProcess" {
  75305. import { Camera } from "babylonjs/Cameras/camera";
  75306. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  75307. import "babylonjs/Shaders/tonemap.fragment";
  75308. import { Engine } from "babylonjs/Engines/engine";
  75309. /** Defines operator used for tonemapping */
  75310. export enum TonemappingOperator {
  75311. /** Hable */
  75312. Hable = 0,
  75313. /** Reinhard */
  75314. Reinhard = 1,
  75315. /** HejiDawson */
  75316. HejiDawson = 2,
  75317. /** Photographic */
  75318. Photographic = 3
  75319. }
  75320. /**
  75321. * Defines a post process to apply tone mapping
  75322. */
  75323. export class TonemapPostProcess extends PostProcess {
  75324. private _operator;
  75325. /** Defines the required exposure adjustement */
  75326. exposureAdjustment: number;
  75327. /**
  75328. * Gets a string identifying the name of the class
  75329. * @returns "TonemapPostProcess" string
  75330. */
  75331. getClassName(): string;
  75332. /**
  75333. * Creates a new TonemapPostProcess
  75334. * @param name defines the name of the postprocess
  75335. * @param _operator defines the operator to use
  75336. * @param exposureAdjustment defines the required exposure adjustement
  75337. * @param camera defines the camera to use (can be null)
  75338. * @param samplingMode defines the required sampling mode (BABYLON.Texture.BILINEAR_SAMPLINGMODE by default)
  75339. * @param engine defines the hosting engine (can be ignore if camera is set)
  75340. * @param textureFormat defines the texture format to use (BABYLON.Engine.TEXTURETYPE_UNSIGNED_INT by default)
  75341. */
  75342. constructor(name: string, _operator: TonemappingOperator,
  75343. /** Defines the required exposure adjustement */
  75344. exposureAdjustment: number, camera: Camera, samplingMode?: number, engine?: Engine, textureFormat?: number);
  75345. }
  75346. }
  75347. declare module "babylonjs/Shaders/volumetricLightScattering.fragment" {
  75348. /** @hidden */
  75349. export var volumetricLightScatteringPixelShader: {
  75350. name: string;
  75351. shader: string;
  75352. };
  75353. }
  75354. declare module "babylonjs/Shaders/volumetricLightScatteringPass.vertex" {
  75355. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  75356. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  75357. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  75358. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  75359. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  75360. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  75361. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  75362. /** @hidden */
  75363. export var volumetricLightScatteringPassVertexShader: {
  75364. name: string;
  75365. shader: string;
  75366. };
  75367. }
  75368. declare module "babylonjs/Shaders/volumetricLightScatteringPass.fragment" {
  75369. /** @hidden */
  75370. export var volumetricLightScatteringPassPixelShader: {
  75371. name: string;
  75372. shader: string;
  75373. };
  75374. }
  75375. declare module "babylonjs/PostProcesses/volumetricLightScatteringPostProcess" {
  75376. import { Vector3 } from "babylonjs/Maths/math.vector";
  75377. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  75378. import { Mesh } from "babylonjs/Meshes/mesh";
  75379. import { Camera } from "babylonjs/Cameras/camera";
  75380. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  75381. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  75382. import { Scene } from "babylonjs/scene";
  75383. import "babylonjs/Meshes/Builders/planeBuilder";
  75384. import "babylonjs/Shaders/depth.vertex";
  75385. import "babylonjs/Shaders/volumetricLightScattering.fragment";
  75386. import "babylonjs/Shaders/volumetricLightScatteringPass.vertex";
  75387. import "babylonjs/Shaders/volumetricLightScatteringPass.fragment";
  75388. import { Engine } from "babylonjs/Engines/engine";
  75389. /**
  75390. * Inspired by http://http.developer.nvidia.com/GPUGems3/gpugems3_ch13.html
  75391. */
  75392. export class VolumetricLightScatteringPostProcess extends PostProcess {
  75393. private _volumetricLightScatteringPass;
  75394. private _volumetricLightScatteringRTT;
  75395. private _viewPort;
  75396. private _screenCoordinates;
  75397. private _cachedDefines;
  75398. /**
  75399. * If not undefined, the mesh position is computed from the attached node position
  75400. */
  75401. attachedNode: {
  75402. position: Vector3;
  75403. };
  75404. /**
  75405. * Custom position of the mesh. Used if "useCustomMeshPosition" is set to "true"
  75406. */
  75407. customMeshPosition: Vector3;
  75408. /**
  75409. * Set if the post-process should use a custom position for the light source (true) or the internal mesh position (false)
  75410. */
  75411. useCustomMeshPosition: boolean;
  75412. /**
  75413. * If the post-process should inverse the light scattering direction
  75414. */
  75415. invert: boolean;
  75416. /**
  75417. * The internal mesh used by the post-process
  75418. */
  75419. mesh: Mesh;
  75420. /**
  75421. * @hidden
  75422. * VolumetricLightScatteringPostProcess.useDiffuseColor is no longer used, use the mesh material directly instead
  75423. */
  75424. get useDiffuseColor(): boolean;
  75425. set useDiffuseColor(useDiffuseColor: boolean);
  75426. /**
  75427. * Array containing the excluded meshes not rendered in the internal pass
  75428. */
  75429. excludedMeshes: AbstractMesh[];
  75430. /**
  75431. * Controls the overall intensity of the post-process
  75432. */
  75433. exposure: number;
  75434. /**
  75435. * Dissipates each sample's contribution in range [0, 1]
  75436. */
  75437. decay: number;
  75438. /**
  75439. * Controls the overall intensity of each sample
  75440. */
  75441. weight: number;
  75442. /**
  75443. * Controls the density of each sample
  75444. */
  75445. density: number;
  75446. /**
  75447. * @constructor
  75448. * @param name The post-process name
  75449. * @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)
  75450. * @param camera The camera that the post-process will be attached to
  75451. * @param mesh The mesh used to create the light scattering
  75452. * @param samples The post-process quality, default 100
  75453. * @param samplingModeThe post-process filtering mode
  75454. * @param engine The babylon engine
  75455. * @param reusable If the post-process is reusable
  75456. * @param scene The constructor needs a scene reference to initialize internal components. If "camera" is null a "scene" must be provided
  75457. */
  75458. constructor(name: string, ratio: any, camera: Camera, mesh?: Mesh, samples?: number, samplingMode?: number, engine?: Engine, reusable?: boolean, scene?: Scene);
  75459. /**
  75460. * Returns the string "VolumetricLightScatteringPostProcess"
  75461. * @returns "VolumetricLightScatteringPostProcess"
  75462. */
  75463. getClassName(): string;
  75464. private _isReady;
  75465. /**
  75466. * Sets the new light position for light scattering effect
  75467. * @param position The new custom light position
  75468. */
  75469. setCustomMeshPosition(position: Vector3): void;
  75470. /**
  75471. * Returns the light position for light scattering effect
  75472. * @return Vector3 The custom light position
  75473. */
  75474. getCustomMeshPosition(): Vector3;
  75475. /**
  75476. * Disposes the internal assets and detaches the post-process from the camera
  75477. */
  75478. dispose(camera: Camera): void;
  75479. /**
  75480. * Returns the render target texture used by the post-process
  75481. * @return the render target texture used by the post-process
  75482. */
  75483. getPass(): RenderTargetTexture;
  75484. private _meshExcluded;
  75485. private _createPass;
  75486. private _updateMeshScreenCoordinates;
  75487. /**
  75488. * Creates a default mesh for the Volumeric Light Scattering post-process
  75489. * @param name The mesh name
  75490. * @param scene The scene where to create the mesh
  75491. * @return the default mesh
  75492. */
  75493. static CreateDefaultMesh(name: string, scene: Scene): Mesh;
  75494. }
  75495. }
  75496. declare module "babylonjs/Shaders/screenSpaceCurvature.fragment" {
  75497. /** @hidden */
  75498. export var screenSpaceCurvaturePixelShader: {
  75499. name: string;
  75500. shader: string;
  75501. };
  75502. }
  75503. declare module "babylonjs/PostProcesses/screenSpaceCurvaturePostProcess" {
  75504. import { Nullable } from "babylonjs/types";
  75505. import { Camera } from "babylonjs/Cameras/camera";
  75506. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  75507. import "babylonjs/Rendering/geometryBufferRendererSceneComponent";
  75508. import "babylonjs/Shaders/screenSpaceCurvature.fragment";
  75509. import { Engine } from "babylonjs/Engines/engine";
  75510. import { Scene } from "babylonjs/scene";
  75511. /**
  75512. * The Screen Space curvature effect can help highlighting ridge and valley of a model.
  75513. */
  75514. export class ScreenSpaceCurvaturePostProcess extends PostProcess {
  75515. /**
  75516. * Defines how much ridge the curvature effect displays.
  75517. */
  75518. ridge: number;
  75519. /**
  75520. * Defines how much valley the curvature effect displays.
  75521. */
  75522. valley: number;
  75523. private _geometryBufferRenderer;
  75524. /**
  75525. * Gets a string identifying the name of the class
  75526. * @returns "ScreenSpaceCurvaturePostProcess" string
  75527. */
  75528. getClassName(): string;
  75529. /**
  75530. * Creates a new instance ScreenSpaceCurvaturePostProcess
  75531. * @param name The name of the effect.
  75532. * @param scene The scene containing the objects to blur according to their velocity.
  75533. * @param options The required width/height ratio to downsize to before computing the render pass.
  75534. * @param camera The camera to apply the render pass to.
  75535. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  75536. * @param engine The engine which the post process will be applied. (default: current engine)
  75537. * @param reusable If the post process can be reused on the same frame. (default: false)
  75538. * @param textureType Type of textures used when performing the post process. (default: 0)
  75539. * @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)
  75540. */
  75541. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  75542. /**
  75543. * Support test.
  75544. */
  75545. static get IsSupported(): boolean;
  75546. /** @hidden */
  75547. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): ScreenSpaceCurvaturePostProcess;
  75548. }
  75549. }
  75550. declare module "babylonjs/PostProcesses/index" {
  75551. export * from "babylonjs/PostProcesses/anaglyphPostProcess";
  75552. export * from "babylonjs/PostProcesses/blackAndWhitePostProcess";
  75553. export * from "babylonjs/PostProcesses/bloomEffect";
  75554. export * from "babylonjs/PostProcesses/bloomMergePostProcess";
  75555. export * from "babylonjs/PostProcesses/blurPostProcess";
  75556. export * from "babylonjs/PostProcesses/chromaticAberrationPostProcess";
  75557. export * from "babylonjs/PostProcesses/circleOfConfusionPostProcess";
  75558. export * from "babylonjs/PostProcesses/colorCorrectionPostProcess";
  75559. export * from "babylonjs/PostProcesses/convolutionPostProcess";
  75560. export * from "babylonjs/PostProcesses/depthOfFieldBlurPostProcess";
  75561. export * from "babylonjs/PostProcesses/depthOfFieldEffect";
  75562. export * from "babylonjs/PostProcesses/depthOfFieldMergePostProcess";
  75563. export * from "babylonjs/PostProcesses/displayPassPostProcess";
  75564. export * from "babylonjs/PostProcesses/extractHighlightsPostProcess";
  75565. export * from "babylonjs/PostProcesses/filterPostProcess";
  75566. export * from "babylonjs/PostProcesses/fxaaPostProcess";
  75567. export * from "babylonjs/PostProcesses/grainPostProcess";
  75568. export * from "babylonjs/PostProcesses/highlightsPostProcess";
  75569. export * from "babylonjs/PostProcesses/imageProcessingPostProcess";
  75570. export * from "babylonjs/PostProcesses/motionBlurPostProcess";
  75571. export * from "babylonjs/PostProcesses/passPostProcess";
  75572. export * from "babylonjs/PostProcesses/postProcess";
  75573. export * from "babylonjs/PostProcesses/postProcessManager";
  75574. export * from "babylonjs/PostProcesses/refractionPostProcess";
  75575. export * from "babylonjs/PostProcesses/RenderPipeline/index";
  75576. export * from "babylonjs/PostProcesses/sharpenPostProcess";
  75577. export * from "babylonjs/PostProcesses/stereoscopicInterlacePostProcess";
  75578. export * from "babylonjs/PostProcesses/tonemapPostProcess";
  75579. export * from "babylonjs/PostProcesses/volumetricLightScatteringPostProcess";
  75580. export * from "babylonjs/PostProcesses/vrDistortionCorrectionPostProcess";
  75581. export * from "babylonjs/PostProcesses/vrMultiviewToSingleviewPostProcess";
  75582. export * from "babylonjs/PostProcesses/screenSpaceReflectionPostProcess";
  75583. export * from "babylonjs/PostProcesses/screenSpaceCurvaturePostProcess";
  75584. }
  75585. declare module "babylonjs/Probes/index" {
  75586. export * from "babylonjs/Probes/reflectionProbe";
  75587. }
  75588. declare module "babylonjs/Rendering/boundingBoxRenderer" {
  75589. import { Scene } from "babylonjs/scene";
  75590. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  75591. import { SmartArray } from "babylonjs/Misc/smartArray";
  75592. import { ISceneComponent } from "babylonjs/sceneComponent";
  75593. import { BoundingBox } from "babylonjs/Culling/boundingBox";
  75594. import "babylonjs/Meshes/Builders/boxBuilder";
  75595. import "babylonjs/Shaders/color.fragment";
  75596. import "babylonjs/Shaders/color.vertex";
  75597. import { Color3 } from "babylonjs/Maths/math.color";
  75598. import { Observable } from "babylonjs/Misc/observable";
  75599. module "babylonjs/scene" {
  75600. interface Scene {
  75601. /** @hidden (Backing field) */
  75602. _boundingBoxRenderer: BoundingBoxRenderer;
  75603. /** @hidden (Backing field) */
  75604. _forceShowBoundingBoxes: boolean;
  75605. /**
  75606. * Gets or sets a boolean indicating if all bounding boxes must be rendered
  75607. */
  75608. forceShowBoundingBoxes: boolean;
  75609. /**
  75610. * Gets the bounding box renderer associated with the scene
  75611. * @returns a BoundingBoxRenderer
  75612. */
  75613. getBoundingBoxRenderer(): BoundingBoxRenderer;
  75614. }
  75615. }
  75616. module "babylonjs/Meshes/abstractMesh" {
  75617. interface AbstractMesh {
  75618. /** @hidden (Backing field) */
  75619. _showBoundingBox: boolean;
  75620. /**
  75621. * Gets or sets a boolean indicating if the bounding box must be rendered as well (false by default)
  75622. */
  75623. showBoundingBox: boolean;
  75624. }
  75625. }
  75626. /**
  75627. * Component responsible of rendering the bounding box of the meshes in a scene.
  75628. * This is usually used through the mesh.showBoundingBox or the scene.forceShowBoundingBoxes properties
  75629. */
  75630. export class BoundingBoxRenderer implements ISceneComponent {
  75631. /**
  75632. * The component name helpfull to identify the component in the list of scene components.
  75633. */
  75634. readonly name: string;
  75635. /**
  75636. * The scene the component belongs to.
  75637. */
  75638. scene: Scene;
  75639. /**
  75640. * Color of the bounding box lines placed in front of an object
  75641. */
  75642. frontColor: Color3;
  75643. /**
  75644. * Color of the bounding box lines placed behind an object
  75645. */
  75646. backColor: Color3;
  75647. /**
  75648. * Defines if the renderer should show the back lines or not
  75649. */
  75650. showBackLines: boolean;
  75651. /**
  75652. * Observable raised before rendering a bounding box
  75653. */
  75654. onBeforeBoxRenderingObservable: Observable<BoundingBox>;
  75655. /**
  75656. * Observable raised after rendering a bounding box
  75657. */
  75658. onAfterBoxRenderingObservable: Observable<BoundingBox>;
  75659. /**
  75660. * @hidden
  75661. */
  75662. renderList: SmartArray<BoundingBox>;
  75663. private _colorShader;
  75664. private _vertexBuffers;
  75665. private _indexBuffer;
  75666. private _fillIndexBuffer;
  75667. private _fillIndexData;
  75668. /**
  75669. * Instantiates a new bounding box renderer in a scene.
  75670. * @param scene the scene the renderer renders in
  75671. */
  75672. constructor(scene: Scene);
  75673. /**
  75674. * Registers the component in a given scene
  75675. */
  75676. register(): void;
  75677. private _evaluateSubMesh;
  75678. private _activeMesh;
  75679. private _prepareRessources;
  75680. private _createIndexBuffer;
  75681. /**
  75682. * Rebuilds the elements related to this component in case of
  75683. * context lost for instance.
  75684. */
  75685. rebuild(): void;
  75686. /**
  75687. * @hidden
  75688. */
  75689. reset(): void;
  75690. /**
  75691. * Render the bounding boxes of a specific rendering group
  75692. * @param renderingGroupId defines the rendering group to render
  75693. */
  75694. render(renderingGroupId: number): void;
  75695. /**
  75696. * In case of occlusion queries, we can render the occlusion bounding box through this method
  75697. * @param mesh Define the mesh to render the occlusion bounding box for
  75698. */
  75699. renderOcclusionBoundingBox(mesh: AbstractMesh): void;
  75700. /**
  75701. * Dispose and release the resources attached to this renderer.
  75702. */
  75703. dispose(): void;
  75704. }
  75705. }
  75706. declare module "babylonjs/Rendering/depthRendererSceneComponent" {
  75707. import { Nullable } from "babylonjs/types";
  75708. import { Scene } from "babylonjs/scene";
  75709. import { DepthRenderer } from "babylonjs/Rendering/depthRenderer";
  75710. import { Camera } from "babylonjs/Cameras/camera";
  75711. import { ISceneComponent } from "babylonjs/sceneComponent";
  75712. module "babylonjs/scene" {
  75713. interface Scene {
  75714. /** @hidden (Backing field) */
  75715. _depthRenderer: {
  75716. [id: string]: DepthRenderer;
  75717. };
  75718. /**
  75719. * Creates a depth renderer a given camera which contains a depth map which can be used for post processing.
  75720. * @param camera The camera to create the depth renderer on (default: scene's active camera)
  75721. * @param storeNonLinearDepth Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z
  75722. * @returns the created depth renderer
  75723. */
  75724. enableDepthRenderer(camera?: Nullable<Camera>, storeNonLinearDepth?: boolean): DepthRenderer;
  75725. /**
  75726. * Disables a depth renderer for a given camera
  75727. * @param camera The camera to disable the depth renderer on (default: scene's active camera)
  75728. */
  75729. disableDepthRenderer(camera?: Nullable<Camera>): void;
  75730. }
  75731. }
  75732. /**
  75733. * Defines the Depth Renderer scene component responsible to manage a depth buffer useful
  75734. * in several rendering techniques.
  75735. */
  75736. export class DepthRendererSceneComponent implements ISceneComponent {
  75737. /**
  75738. * The component name helpfull to identify the component in the list of scene components.
  75739. */
  75740. readonly name: string;
  75741. /**
  75742. * The scene the component belongs to.
  75743. */
  75744. scene: Scene;
  75745. /**
  75746. * Creates a new instance of the component for the given scene
  75747. * @param scene Defines the scene to register the component in
  75748. */
  75749. constructor(scene: Scene);
  75750. /**
  75751. * Registers the component in a given scene
  75752. */
  75753. register(): void;
  75754. /**
  75755. * Rebuilds the elements related to this component in case of
  75756. * context lost for instance.
  75757. */
  75758. rebuild(): void;
  75759. /**
  75760. * Disposes the component and the associated ressources
  75761. */
  75762. dispose(): void;
  75763. private _gatherRenderTargets;
  75764. private _gatherActiveCameraRenderTargets;
  75765. }
  75766. }
  75767. declare module "babylonjs/Rendering/prePassRendererSceneComponent" {
  75768. import { Nullable } from "babylonjs/types";
  75769. import { Scene } from "babylonjs/scene";
  75770. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  75771. import { PrePassRenderer } from "babylonjs/Rendering/prePassRenderer";
  75772. import { AbstractScene } from "babylonjs/abstractScene";
  75773. module "babylonjs/abstractScene" {
  75774. interface AbstractScene {
  75775. /** @hidden (Backing field) */
  75776. _prePassRenderer: Nullable<PrePassRenderer>;
  75777. /**
  75778. * Gets or Sets the current prepass renderer associated to the scene.
  75779. */
  75780. prePassRenderer: Nullable<PrePassRenderer>;
  75781. /**
  75782. * Enables the prepass and associates it with the scene
  75783. * @returns the PrePassRenderer
  75784. */
  75785. enablePrePassRenderer(): Nullable<PrePassRenderer>;
  75786. /**
  75787. * Disables the prepass associated with the scene
  75788. */
  75789. disablePrePassRenderer(): void;
  75790. }
  75791. }
  75792. /**
  75793. * Defines the Geometry Buffer scene component responsible to manage a G-Buffer useful
  75794. * in several rendering techniques.
  75795. */
  75796. export class PrePassRendererSceneComponent implements ISceneSerializableComponent {
  75797. /**
  75798. * The component name helpful to identify the component in the list of scene components.
  75799. */
  75800. readonly name: string;
  75801. /**
  75802. * The scene the component belongs to.
  75803. */
  75804. scene: Scene;
  75805. /**
  75806. * Creates a new instance of the component for the given scene
  75807. * @param scene Defines the scene to register the component in
  75808. */
  75809. constructor(scene: Scene);
  75810. /**
  75811. * Registers the component in a given scene
  75812. */
  75813. register(): void;
  75814. private _beforeCameraDraw;
  75815. private _afterCameraDraw;
  75816. private _beforeClearStage;
  75817. /**
  75818. * Serializes the component data to the specified json object
  75819. * @param serializationObject The object to serialize to
  75820. */
  75821. serialize(serializationObject: any): void;
  75822. /**
  75823. * Adds all the elements from the container to the scene
  75824. * @param container the container holding the elements
  75825. */
  75826. addFromContainer(container: AbstractScene): void;
  75827. /**
  75828. * Removes all the elements in the container from the scene
  75829. * @param container contains the elements to remove
  75830. * @param dispose if the removed element should be disposed (default: false)
  75831. */
  75832. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  75833. /**
  75834. * Rebuilds the elements related to this component in case of
  75835. * context lost for instance.
  75836. */
  75837. rebuild(): void;
  75838. /**
  75839. * Disposes the component and the associated ressources
  75840. */
  75841. dispose(): void;
  75842. }
  75843. }
  75844. declare module "babylonjs/Shaders/outline.fragment" {
  75845. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  75846. import "babylonjs/Shaders/ShadersInclude/logDepthFragment";
  75847. /** @hidden */
  75848. export var outlinePixelShader: {
  75849. name: string;
  75850. shader: string;
  75851. };
  75852. }
  75853. declare module "babylonjs/Shaders/outline.vertex" {
  75854. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  75855. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  75856. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  75857. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  75858. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  75859. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  75860. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  75861. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  75862. import "babylonjs/Shaders/ShadersInclude/logDepthVertex";
  75863. /** @hidden */
  75864. export var outlineVertexShader: {
  75865. name: string;
  75866. shader: string;
  75867. };
  75868. }
  75869. declare module "babylonjs/Rendering/outlineRenderer" {
  75870. import { SubMesh } from "babylonjs/Meshes/subMesh";
  75871. import { _InstancesBatch } from "babylonjs/Meshes/mesh";
  75872. import { Scene } from "babylonjs/scene";
  75873. import { ISceneComponent } from "babylonjs/sceneComponent";
  75874. import "babylonjs/Shaders/outline.fragment";
  75875. import "babylonjs/Shaders/outline.vertex";
  75876. module "babylonjs/scene" {
  75877. interface Scene {
  75878. /** @hidden */
  75879. _outlineRenderer: OutlineRenderer;
  75880. /**
  75881. * Gets the outline renderer associated with the scene
  75882. * @returns a OutlineRenderer
  75883. */
  75884. getOutlineRenderer(): OutlineRenderer;
  75885. }
  75886. }
  75887. module "babylonjs/Meshes/abstractMesh" {
  75888. interface AbstractMesh {
  75889. /** @hidden (Backing field) */
  75890. _renderOutline: boolean;
  75891. /**
  75892. * Gets or sets a boolean indicating if the outline must be rendered as well
  75893. * @see https://www.babylonjs-playground.com/#10WJ5S#3
  75894. */
  75895. renderOutline: boolean;
  75896. /** @hidden (Backing field) */
  75897. _renderOverlay: boolean;
  75898. /**
  75899. * Gets or sets a boolean indicating if the overlay must be rendered as well
  75900. * @see https://www.babylonjs-playground.com/#10WJ5S#2
  75901. */
  75902. renderOverlay: boolean;
  75903. }
  75904. }
  75905. /**
  75906. * This class is responsible to draw bothe outline/overlay of meshes.
  75907. * It should not be used directly but through the available method on mesh.
  75908. */
  75909. export class OutlineRenderer implements ISceneComponent {
  75910. /**
  75911. * Stencil value used to avoid outline being seen within the mesh when the mesh is transparent
  75912. */
  75913. private static _StencilReference;
  75914. /**
  75915. * The name of the component. Each component must have a unique name.
  75916. */
  75917. name: string;
  75918. /**
  75919. * The scene the component belongs to.
  75920. */
  75921. scene: Scene;
  75922. /**
  75923. * Defines a zOffset to prevent zFighting between the overlay and the mesh.
  75924. */
  75925. zOffset: number;
  75926. private _engine;
  75927. private _effect;
  75928. private _cachedDefines;
  75929. private _savedDepthWrite;
  75930. /**
  75931. * Instantiates a new outline renderer. (There could be only one per scene).
  75932. * @param scene Defines the scene it belongs to
  75933. */
  75934. constructor(scene: Scene);
  75935. /**
  75936. * Register the component to one instance of a scene.
  75937. */
  75938. register(): void;
  75939. /**
  75940. * Rebuilds the elements related to this component in case of
  75941. * context lost for instance.
  75942. */
  75943. rebuild(): void;
  75944. /**
  75945. * Disposes the component and the associated ressources.
  75946. */
  75947. dispose(): void;
  75948. /**
  75949. * Renders the outline in the canvas.
  75950. * @param subMesh Defines the sumesh to render
  75951. * @param batch Defines the batch of meshes in case of instances
  75952. * @param useOverlay Defines if the rendering is for the overlay or the outline
  75953. */
  75954. render(subMesh: SubMesh, batch: _InstancesBatch, useOverlay?: boolean): void;
  75955. /**
  75956. * Returns whether or not the outline renderer is ready for a given submesh.
  75957. * All the dependencies e.g. submeshes, texture, effect... mus be ready
  75958. * @param subMesh Defines the submesh to check readyness for
  75959. * @param useInstances Defines wheter wee are trying to render instances or not
  75960. * @returns true if ready otherwise false
  75961. */
  75962. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  75963. private _beforeRenderingMesh;
  75964. private _afterRenderingMesh;
  75965. }
  75966. }
  75967. declare module "babylonjs/Rendering/index" {
  75968. export * from "babylonjs/Rendering/boundingBoxRenderer";
  75969. export * from "babylonjs/Rendering/depthRenderer";
  75970. export * from "babylonjs/Rendering/depthRendererSceneComponent";
  75971. export * from "babylonjs/Rendering/edgesRenderer";
  75972. export * from "babylonjs/Rendering/geometryBufferRenderer";
  75973. export * from "babylonjs/Rendering/geometryBufferRendererSceneComponent";
  75974. export * from "babylonjs/Rendering/prePassRenderer";
  75975. export * from "babylonjs/Rendering/prePassRendererSceneComponent";
  75976. export * from "babylonjs/Rendering/outlineRenderer";
  75977. export * from "babylonjs/Rendering/renderingGroup";
  75978. export * from "babylonjs/Rendering/renderingManager";
  75979. export * from "babylonjs/Rendering/utilityLayerRenderer";
  75980. }
  75981. declare module "babylonjs/Sprites/ISprites" {
  75982. /**
  75983. * Defines the basic options interface of a Sprite Frame Source Size.
  75984. */
  75985. export interface ISpriteJSONSpriteSourceSize {
  75986. /**
  75987. * number of the original width of the Frame
  75988. */
  75989. w: number;
  75990. /**
  75991. * number of the original height of the Frame
  75992. */
  75993. h: number;
  75994. }
  75995. /**
  75996. * Defines the basic options interface of a Sprite Frame Data.
  75997. */
  75998. export interface ISpriteJSONSpriteFrameData {
  75999. /**
  76000. * number of the x offset of the Frame
  76001. */
  76002. x: number;
  76003. /**
  76004. * number of the y offset of the Frame
  76005. */
  76006. y: number;
  76007. /**
  76008. * number of the width of the Frame
  76009. */
  76010. w: number;
  76011. /**
  76012. * number of the height of the Frame
  76013. */
  76014. h: number;
  76015. }
  76016. /**
  76017. * Defines the basic options interface of a JSON Sprite.
  76018. */
  76019. export interface ISpriteJSONSprite {
  76020. /**
  76021. * string name of the Frame
  76022. */
  76023. filename: string;
  76024. /**
  76025. * ISpriteJSONSpriteFrame basic object of the frame data
  76026. */
  76027. frame: ISpriteJSONSpriteFrameData;
  76028. /**
  76029. * boolean to flag is the frame was rotated.
  76030. */
  76031. rotated: boolean;
  76032. /**
  76033. * boolean to flag is the frame was trimmed.
  76034. */
  76035. trimmed: boolean;
  76036. /**
  76037. * ISpriteJSONSpriteFrame basic object of the source data
  76038. */
  76039. spriteSourceSize: ISpriteJSONSpriteFrameData;
  76040. /**
  76041. * ISpriteJSONSpriteFrame basic object of the source data
  76042. */
  76043. sourceSize: ISpriteJSONSpriteSourceSize;
  76044. }
  76045. /**
  76046. * Defines the basic options interface of a JSON atlas.
  76047. */
  76048. export interface ISpriteJSONAtlas {
  76049. /**
  76050. * Array of objects that contain the frame data.
  76051. */
  76052. frames: Array<ISpriteJSONSprite>;
  76053. /**
  76054. * object basic object containing the sprite meta data.
  76055. */
  76056. meta?: object;
  76057. }
  76058. }
  76059. declare module "babylonjs/Shaders/spriteMap.fragment" {
  76060. /** @hidden */
  76061. export var spriteMapPixelShader: {
  76062. name: string;
  76063. shader: string;
  76064. };
  76065. }
  76066. declare module "babylonjs/Shaders/spriteMap.vertex" {
  76067. /** @hidden */
  76068. export var spriteMapVertexShader: {
  76069. name: string;
  76070. shader: string;
  76071. };
  76072. }
  76073. declare module "babylonjs/Sprites/spriteMap" {
  76074. import { IDisposable, Scene } from "babylonjs/scene";
  76075. import { Vector2, Vector3 } from "babylonjs/Maths/math.vector";
  76076. import { Texture } from "babylonjs/Materials/Textures/texture";
  76077. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  76078. import { ISpriteJSONSprite, ISpriteJSONAtlas } from "babylonjs/Sprites/ISprites";
  76079. import "babylonjs/Meshes/Builders/planeBuilder";
  76080. import "babylonjs/Shaders/spriteMap.fragment";
  76081. import "babylonjs/Shaders/spriteMap.vertex";
  76082. /**
  76083. * Defines the basic options interface of a SpriteMap
  76084. */
  76085. export interface ISpriteMapOptions {
  76086. /**
  76087. * Vector2 of the number of cells in the grid.
  76088. */
  76089. stageSize?: Vector2;
  76090. /**
  76091. * Vector2 of the size of the output plane in World Units.
  76092. */
  76093. outputSize?: Vector2;
  76094. /**
  76095. * Vector3 of the position of the output plane in World Units.
  76096. */
  76097. outputPosition?: Vector3;
  76098. /**
  76099. * Vector3 of the rotation of the output plane.
  76100. */
  76101. outputRotation?: Vector3;
  76102. /**
  76103. * number of layers that the system will reserve in resources.
  76104. */
  76105. layerCount?: number;
  76106. /**
  76107. * number of max animation frames a single cell will reserve in resources.
  76108. */
  76109. maxAnimationFrames?: number;
  76110. /**
  76111. * number cell index of the base tile when the system compiles.
  76112. */
  76113. baseTile?: number;
  76114. /**
  76115. * boolean flip the sprite after its been repositioned by the framing data.
  76116. */
  76117. flipU?: boolean;
  76118. /**
  76119. * Vector3 scalar of the global RGB values of the SpriteMap.
  76120. */
  76121. colorMultiply?: Vector3;
  76122. }
  76123. /**
  76124. * Defines the IDisposable interface in order to be cleanable from resources.
  76125. */
  76126. export interface ISpriteMap extends IDisposable {
  76127. /**
  76128. * String name of the SpriteMap.
  76129. */
  76130. name: string;
  76131. /**
  76132. * The JSON Array file from a https://www.codeandweb.com/texturepacker export. Or similar structure.
  76133. */
  76134. atlasJSON: ISpriteJSONAtlas;
  76135. /**
  76136. * Texture of the SpriteMap.
  76137. */
  76138. spriteSheet: Texture;
  76139. /**
  76140. * The parameters to initialize the SpriteMap with.
  76141. */
  76142. options: ISpriteMapOptions;
  76143. }
  76144. /**
  76145. * Class used to manage a grid restricted sprite deployment on an Output plane.
  76146. */
  76147. export class SpriteMap implements ISpriteMap {
  76148. /** The Name of the spriteMap */
  76149. name: string;
  76150. /** The JSON file with the frame and meta data */
  76151. atlasJSON: ISpriteJSONAtlas;
  76152. /** The systems Sprite Sheet Texture */
  76153. spriteSheet: Texture;
  76154. /** Arguments passed with the Constructor */
  76155. options: ISpriteMapOptions;
  76156. /** Public Sprite Storage array, parsed from atlasJSON */
  76157. sprites: Array<ISpriteJSONSprite>;
  76158. /** Returns the Number of Sprites in the System */
  76159. get spriteCount(): number;
  76160. /** Returns the Position of Output Plane*/
  76161. get position(): Vector3;
  76162. /** Returns the Position of Output Plane*/
  76163. set position(v: Vector3);
  76164. /** Returns the Rotation of Output Plane*/
  76165. get rotation(): Vector3;
  76166. /** Returns the Rotation of Output Plane*/
  76167. set rotation(v: Vector3);
  76168. /** Sets the AnimationMap*/
  76169. get animationMap(): RawTexture;
  76170. /** Sets the AnimationMap*/
  76171. set animationMap(v: RawTexture);
  76172. /** Scene that the SpriteMap was created in */
  76173. private _scene;
  76174. /** Texture Buffer of Float32 that holds tile frame data*/
  76175. private _frameMap;
  76176. /** Texture Buffers of Float32 that holds tileMap data*/
  76177. private _tileMaps;
  76178. /** Texture Buffer of Float32 that holds Animation Data*/
  76179. private _animationMap;
  76180. /** Custom ShaderMaterial Central to the System*/
  76181. private _material;
  76182. /** Custom ShaderMaterial Central to the System*/
  76183. private _output;
  76184. /** Systems Time Ticker*/
  76185. private _time;
  76186. /**
  76187. * Creates a new SpriteMap
  76188. * @param name defines the SpriteMaps Name
  76189. * @param atlasJSON is the JSON file that controls the Sprites Frames and Meta
  76190. * @param spriteSheet is the Texture that the Sprites are on.
  76191. * @param options a basic deployment configuration
  76192. * @param scene The Scene that the map is deployed on
  76193. */
  76194. constructor(name: string, atlasJSON: ISpriteJSONAtlas, spriteSheet: Texture, options: ISpriteMapOptions, scene: Scene);
  76195. /**
  76196. * Returns tileID location
  76197. * @returns Vector2 the cell position ID
  76198. */
  76199. getTileID(): Vector2;
  76200. /**
  76201. * Gets the UV location of the mouse over the SpriteMap.
  76202. * @returns Vector2 the UV position of the mouse interaction
  76203. */
  76204. getMousePosition(): Vector2;
  76205. /**
  76206. * Creates the "frame" texture Buffer
  76207. * -------------------------------------
  76208. * Structure of frames
  76209. * "filename": "Falling-Water-2.png",
  76210. * "frame": {"x":69,"y":103,"w":24,"h":32},
  76211. * "rotated": true,
  76212. * "trimmed": true,
  76213. * "spriteSourceSize": {"x":4,"y":0,"w":24,"h":32},
  76214. * "sourceSize": {"w":32,"h":32}
  76215. * @returns RawTexture of the frameMap
  76216. */
  76217. private _createFrameBuffer;
  76218. /**
  76219. * Creates the tileMap texture Buffer
  76220. * @param buffer normally and array of numbers, or a false to generate from scratch
  76221. * @param _layer indicates what layer for a logic trigger dealing with the baseTile. The system uses this
  76222. * @returns RawTexture of the tileMap
  76223. */
  76224. private _createTileBuffer;
  76225. /**
  76226. * Modifies the data of the tileMaps
  76227. * @param _layer is the ID of the layer you want to edit on the SpriteMap
  76228. * @param pos is the iVector2 Coordinates of the Tile
  76229. * @param tile The SpriteIndex of the new Tile
  76230. */
  76231. changeTiles(_layer: number | undefined, pos: Vector2 | Vector2[], tile?: number): void;
  76232. /**
  76233. * Creates the animationMap texture Buffer
  76234. * @param buffer normally and array of numbers, or a false to generate from scratch
  76235. * @returns RawTexture of the animationMap
  76236. */
  76237. private _createTileAnimationBuffer;
  76238. /**
  76239. * Modifies the data of the animationMap
  76240. * @param cellID is the Index of the Sprite
  76241. * @param _frame is the target Animation frame
  76242. * @param toCell is the Target Index of the next frame of the animation
  76243. * @param time is a value between 0-1 that is the trigger for when the frame should change tiles
  76244. * @param speed is a global scalar of the time variable on the map.
  76245. */
  76246. addAnimationToTile(cellID?: number, _frame?: number, toCell?: number, time?: number, speed?: number): void;
  76247. /**
  76248. * Exports the .tilemaps file
  76249. */
  76250. saveTileMaps(): void;
  76251. /**
  76252. * Imports the .tilemaps file
  76253. * @param url of the .tilemaps file
  76254. */
  76255. loadTileMaps(url: string): void;
  76256. /**
  76257. * Release associated resources
  76258. */
  76259. dispose(): void;
  76260. }
  76261. }
  76262. declare module "babylonjs/Sprites/spritePackedManager" {
  76263. import { SpriteManager } from "babylonjs/Sprites/spriteManager";
  76264. import { Scene } from "babylonjs/scene";
  76265. /**
  76266. * Class used to manage multiple sprites of different sizes on the same spritesheet
  76267. * @see https://doc.babylonjs.com/babylon101/sprites
  76268. */
  76269. export class SpritePackedManager extends SpriteManager {
  76270. /** defines the packed manager's name */
  76271. name: string;
  76272. /**
  76273. * Creates a new sprite manager from a packed sprite sheet
  76274. * @param name defines the manager's name
  76275. * @param imgUrl defines the sprite sheet url
  76276. * @param capacity defines the maximum allowed number of sprites
  76277. * @param scene defines the hosting scene
  76278. * @param spriteJSON null otherwise a JSON object defining sprite sheet data
  76279. * @param epsilon defines the epsilon value to align texture (0.01 by default)
  76280. * @param samplingMode defines the smapling mode to use with spritesheet
  76281. * @param fromPacked set to true; do not alter
  76282. */
  76283. constructor(
  76284. /** defines the packed manager's name */
  76285. name: string, imgUrl: string, capacity: number, scene: Scene, spriteJSON?: string | null, epsilon?: number, samplingMode?: number);
  76286. }
  76287. }
  76288. declare module "babylonjs/Sprites/index" {
  76289. export * from "babylonjs/Sprites/sprite";
  76290. export * from "babylonjs/Sprites/ISprites";
  76291. export * from "babylonjs/Sprites/spriteManager";
  76292. export * from "babylonjs/Sprites/spriteMap";
  76293. export * from "babylonjs/Sprites/spritePackedManager";
  76294. export * from "babylonjs/Sprites/spriteSceneComponent";
  76295. }
  76296. declare module "babylonjs/States/index" {
  76297. export * from "babylonjs/States/alphaCullingState";
  76298. export * from "babylonjs/States/depthCullingState";
  76299. export * from "babylonjs/States/stencilState";
  76300. }
  76301. declare module "babylonjs/Misc/assetsManager" {
  76302. import { Scene } from "babylonjs/scene";
  76303. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  76304. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  76305. import { Skeleton } from "babylonjs/Bones/skeleton";
  76306. import { Observable } from "babylonjs/Misc/observable";
  76307. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  76308. import { Texture } from "babylonjs/Materials/Textures/texture";
  76309. import { CubeTexture } from "babylonjs/Materials/Textures/cubeTexture";
  76310. import { HDRCubeTexture } from "babylonjs/Materials/Textures/hdrCubeTexture";
  76311. import { EquiRectangularCubeTexture } from "babylonjs/Materials/Textures/equiRectangularCubeTexture";
  76312. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  76313. import { AssetContainer } from "babylonjs/assetContainer";
  76314. /**
  76315. * Defines the list of states available for a task inside a AssetsManager
  76316. */
  76317. export enum AssetTaskState {
  76318. /**
  76319. * Initialization
  76320. */
  76321. INIT = 0,
  76322. /**
  76323. * Running
  76324. */
  76325. RUNNING = 1,
  76326. /**
  76327. * Done
  76328. */
  76329. DONE = 2,
  76330. /**
  76331. * Error
  76332. */
  76333. ERROR = 3
  76334. }
  76335. /**
  76336. * Define an abstract asset task used with a AssetsManager class to load assets into a scene
  76337. */
  76338. export abstract class AbstractAssetTask {
  76339. /**
  76340. * Task name
  76341. */ name: string;
  76342. /**
  76343. * Callback called when the task is successful
  76344. */
  76345. onSuccess: (task: any) => void;
  76346. /**
  76347. * Callback called when the task is not successful
  76348. */
  76349. onError: (task: any, message?: string, exception?: any) => void;
  76350. /**
  76351. * Creates a new AssetsManager
  76352. * @param name defines the name of the task
  76353. */
  76354. constructor(
  76355. /**
  76356. * Task name
  76357. */ name: string);
  76358. private _isCompleted;
  76359. private _taskState;
  76360. private _errorObject;
  76361. /**
  76362. * Get if the task is completed
  76363. */
  76364. get isCompleted(): boolean;
  76365. /**
  76366. * Gets the current state of the task
  76367. */
  76368. get taskState(): AssetTaskState;
  76369. /**
  76370. * Gets the current error object (if task is in error)
  76371. */
  76372. get errorObject(): {
  76373. message?: string;
  76374. exception?: any;
  76375. };
  76376. /**
  76377. * Internal only
  76378. * @hidden
  76379. */
  76380. _setErrorObject(message?: string, exception?: any): void;
  76381. /**
  76382. * Execute the current task
  76383. * @param scene defines the scene where you want your assets to be loaded
  76384. * @param onSuccess is a callback called when the task is successfully executed
  76385. * @param onError is a callback called if an error occurs
  76386. */
  76387. run(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76388. /**
  76389. * Execute the current task
  76390. * @param scene defines the scene where you want your assets to be loaded
  76391. * @param onSuccess is a callback called when the task is successfully executed
  76392. * @param onError is a callback called if an error occurs
  76393. */
  76394. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76395. /**
  76396. * Reset will set the task state back to INIT, so the next load call of the assets manager will execute this task again.
  76397. * This can be used with failed tasks that have the reason for failure fixed.
  76398. */
  76399. reset(): void;
  76400. private onErrorCallback;
  76401. private onDoneCallback;
  76402. }
  76403. /**
  76404. * Define the interface used by progress events raised during assets loading
  76405. */
  76406. export interface IAssetsProgressEvent {
  76407. /**
  76408. * Defines the number of remaining tasks to process
  76409. */
  76410. remainingCount: number;
  76411. /**
  76412. * Defines the total number of tasks
  76413. */
  76414. totalCount: number;
  76415. /**
  76416. * Defines the task that was just processed
  76417. */
  76418. task: AbstractAssetTask;
  76419. }
  76420. /**
  76421. * Class used to share progress information about assets loading
  76422. */
  76423. export class AssetsProgressEvent implements IAssetsProgressEvent {
  76424. /**
  76425. * Defines the number of remaining tasks to process
  76426. */
  76427. remainingCount: number;
  76428. /**
  76429. * Defines the total number of tasks
  76430. */
  76431. totalCount: number;
  76432. /**
  76433. * Defines the task that was just processed
  76434. */
  76435. task: AbstractAssetTask;
  76436. /**
  76437. * Creates a AssetsProgressEvent
  76438. * @param remainingCount defines the number of remaining tasks to process
  76439. * @param totalCount defines the total number of tasks
  76440. * @param task defines the task that was just processed
  76441. */
  76442. constructor(remainingCount: number, totalCount: number, task: AbstractAssetTask);
  76443. }
  76444. /**
  76445. * Define a task used by AssetsManager to load assets into a container
  76446. */
  76447. export class ContainerAssetTask extends AbstractAssetTask {
  76448. /**
  76449. * Defines the name of the task
  76450. */
  76451. name: string;
  76452. /**
  76453. * Defines the list of mesh's names you want to load
  76454. */
  76455. meshesNames: any;
  76456. /**
  76457. * Defines the root url to use as a base to load your meshes and associated resources
  76458. */
  76459. rootUrl: string;
  76460. /**
  76461. * Defines the filename or File of the scene to load from
  76462. */
  76463. sceneFilename: string | File;
  76464. /**
  76465. * Get the loaded asset container
  76466. */
  76467. loadedContainer: AssetContainer;
  76468. /**
  76469. * Gets the list of loaded meshes
  76470. */
  76471. loadedMeshes: Array<AbstractMesh>;
  76472. /**
  76473. * Gets the list of loaded particle systems
  76474. */
  76475. loadedParticleSystems: Array<IParticleSystem>;
  76476. /**
  76477. * Gets the list of loaded skeletons
  76478. */
  76479. loadedSkeletons: Array<Skeleton>;
  76480. /**
  76481. * Gets the list of loaded animation groups
  76482. */
  76483. loadedAnimationGroups: Array<AnimationGroup>;
  76484. /**
  76485. * Callback called when the task is successful
  76486. */
  76487. onSuccess: (task: ContainerAssetTask) => void;
  76488. /**
  76489. * Callback called when the task is successful
  76490. */
  76491. onError: (task: ContainerAssetTask, message?: string, exception?: any) => void;
  76492. /**
  76493. * Creates a new ContainerAssetTask
  76494. * @param name defines the name of the task
  76495. * @param meshesNames defines the list of mesh's names you want to load
  76496. * @param rootUrl defines the root url to use as a base to load your meshes and associated resources
  76497. * @param sceneFilename defines the filename or File of the scene to load from
  76498. */
  76499. constructor(
  76500. /**
  76501. * Defines the name of the task
  76502. */
  76503. name: string,
  76504. /**
  76505. * Defines the list of mesh's names you want to load
  76506. */
  76507. meshesNames: any,
  76508. /**
  76509. * Defines the root url to use as a base to load your meshes and associated resources
  76510. */
  76511. rootUrl: string,
  76512. /**
  76513. * Defines the filename or File of the scene to load from
  76514. */
  76515. sceneFilename: string | File);
  76516. /**
  76517. * Execute the current task
  76518. * @param scene defines the scene where you want your assets to be loaded
  76519. * @param onSuccess is a callback called when the task is successfully executed
  76520. * @param onError is a callback called if an error occurs
  76521. */
  76522. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76523. }
  76524. /**
  76525. * Define a task used by AssetsManager to load meshes
  76526. */
  76527. export class MeshAssetTask extends AbstractAssetTask {
  76528. /**
  76529. * Defines the name of the task
  76530. */
  76531. name: string;
  76532. /**
  76533. * Defines the list of mesh's names you want to load
  76534. */
  76535. meshesNames: any;
  76536. /**
  76537. * Defines the root url to use as a base to load your meshes and associated resources
  76538. */
  76539. rootUrl: string;
  76540. /**
  76541. * Defines the filename or File of the scene to load from
  76542. */
  76543. sceneFilename: string | File;
  76544. /**
  76545. * Gets the list of loaded meshes
  76546. */
  76547. loadedMeshes: Array<AbstractMesh>;
  76548. /**
  76549. * Gets the list of loaded particle systems
  76550. */
  76551. loadedParticleSystems: Array<IParticleSystem>;
  76552. /**
  76553. * Gets the list of loaded skeletons
  76554. */
  76555. loadedSkeletons: Array<Skeleton>;
  76556. /**
  76557. * Gets the list of loaded animation groups
  76558. */
  76559. loadedAnimationGroups: Array<AnimationGroup>;
  76560. /**
  76561. * Callback called when the task is successful
  76562. */
  76563. onSuccess: (task: MeshAssetTask) => void;
  76564. /**
  76565. * Callback called when the task is successful
  76566. */
  76567. onError: (task: MeshAssetTask, message?: string, exception?: any) => void;
  76568. /**
  76569. * Creates a new MeshAssetTask
  76570. * @param name defines the name of the task
  76571. * @param meshesNames defines the list of mesh's names you want to load
  76572. * @param rootUrl defines the root url to use as a base to load your meshes and associated resources
  76573. * @param sceneFilename defines the filename or File of the scene to load from
  76574. */
  76575. constructor(
  76576. /**
  76577. * Defines the name of the task
  76578. */
  76579. name: string,
  76580. /**
  76581. * Defines the list of mesh's names you want to load
  76582. */
  76583. meshesNames: any,
  76584. /**
  76585. * Defines the root url to use as a base to load your meshes and associated resources
  76586. */
  76587. rootUrl: string,
  76588. /**
  76589. * Defines the filename or File of the scene to load from
  76590. */
  76591. sceneFilename: string | File);
  76592. /**
  76593. * Execute the current task
  76594. * @param scene defines the scene where you want your assets to be loaded
  76595. * @param onSuccess is a callback called when the task is successfully executed
  76596. * @param onError is a callback called if an error occurs
  76597. */
  76598. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76599. }
  76600. /**
  76601. * Define a task used by AssetsManager to load text content
  76602. */
  76603. export class TextFileAssetTask extends AbstractAssetTask {
  76604. /**
  76605. * Defines the name of the task
  76606. */
  76607. name: string;
  76608. /**
  76609. * Defines the location of the file to load
  76610. */
  76611. url: string;
  76612. /**
  76613. * Gets the loaded text string
  76614. */
  76615. text: string;
  76616. /**
  76617. * Callback called when the task is successful
  76618. */
  76619. onSuccess: (task: TextFileAssetTask) => void;
  76620. /**
  76621. * Callback called when the task is successful
  76622. */
  76623. onError: (task: TextFileAssetTask, message?: string, exception?: any) => void;
  76624. /**
  76625. * Creates a new TextFileAssetTask object
  76626. * @param name defines the name of the task
  76627. * @param url defines the location of the file to load
  76628. */
  76629. constructor(
  76630. /**
  76631. * Defines the name of the task
  76632. */
  76633. name: string,
  76634. /**
  76635. * Defines the location of the file to load
  76636. */
  76637. url: string);
  76638. /**
  76639. * Execute the current task
  76640. * @param scene defines the scene where you want your assets to be loaded
  76641. * @param onSuccess is a callback called when the task is successfully executed
  76642. * @param onError is a callback called if an error occurs
  76643. */
  76644. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76645. }
  76646. /**
  76647. * Define a task used by AssetsManager to load binary data
  76648. */
  76649. export class BinaryFileAssetTask extends AbstractAssetTask {
  76650. /**
  76651. * Defines the name of the task
  76652. */
  76653. name: string;
  76654. /**
  76655. * Defines the location of the file to load
  76656. */
  76657. url: string;
  76658. /**
  76659. * Gets the lodaded data (as an array buffer)
  76660. */
  76661. data: ArrayBuffer;
  76662. /**
  76663. * Callback called when the task is successful
  76664. */
  76665. onSuccess: (task: BinaryFileAssetTask) => void;
  76666. /**
  76667. * Callback called when the task is successful
  76668. */
  76669. onError: (task: BinaryFileAssetTask, message?: string, exception?: any) => void;
  76670. /**
  76671. * Creates a new BinaryFileAssetTask object
  76672. * @param name defines the name of the new task
  76673. * @param url defines the location of the file to load
  76674. */
  76675. constructor(
  76676. /**
  76677. * Defines the name of the task
  76678. */
  76679. name: string,
  76680. /**
  76681. * Defines the location of the file to load
  76682. */
  76683. url: string);
  76684. /**
  76685. * Execute the current task
  76686. * @param scene defines the scene where you want your assets to be loaded
  76687. * @param onSuccess is a callback called when the task is successfully executed
  76688. * @param onError is a callback called if an error occurs
  76689. */
  76690. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76691. }
  76692. /**
  76693. * Define a task used by AssetsManager to load images
  76694. */
  76695. export class ImageAssetTask extends AbstractAssetTask {
  76696. /**
  76697. * Defines the name of the task
  76698. */
  76699. name: string;
  76700. /**
  76701. * Defines the location of the image to load
  76702. */
  76703. url: string;
  76704. /**
  76705. * Gets the loaded images
  76706. */
  76707. image: HTMLImageElement;
  76708. /**
  76709. * Callback called when the task is successful
  76710. */
  76711. onSuccess: (task: ImageAssetTask) => void;
  76712. /**
  76713. * Callback called when the task is successful
  76714. */
  76715. onError: (task: ImageAssetTask, message?: string, exception?: any) => void;
  76716. /**
  76717. * Creates a new ImageAssetTask
  76718. * @param name defines the name of the task
  76719. * @param url defines the location of the image to load
  76720. */
  76721. constructor(
  76722. /**
  76723. * Defines the name of the task
  76724. */
  76725. name: string,
  76726. /**
  76727. * Defines the location of the image to load
  76728. */
  76729. url: string);
  76730. /**
  76731. * Execute the current task
  76732. * @param scene defines the scene where you want your assets to be loaded
  76733. * @param onSuccess is a callback called when the task is successfully executed
  76734. * @param onError is a callback called if an error occurs
  76735. */
  76736. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76737. }
  76738. /**
  76739. * Defines the interface used by texture loading tasks
  76740. */
  76741. export interface ITextureAssetTask<TEX extends BaseTexture> {
  76742. /**
  76743. * Gets the loaded texture
  76744. */
  76745. texture: TEX;
  76746. }
  76747. /**
  76748. * Define a task used by AssetsManager to load 2D textures
  76749. */
  76750. export class TextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<Texture> {
  76751. /**
  76752. * Defines the name of the task
  76753. */
  76754. name: string;
  76755. /**
  76756. * Defines the location of the file to load
  76757. */
  76758. url: string;
  76759. /**
  76760. * Defines if mipmap should not be generated (default is false)
  76761. */
  76762. noMipmap?: boolean | undefined;
  76763. /**
  76764. * Defines if texture must be inverted on Y axis (default is true)
  76765. */
  76766. invertY: boolean;
  76767. /**
  76768. * Defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  76769. */
  76770. samplingMode: number;
  76771. /**
  76772. * Gets the loaded texture
  76773. */
  76774. texture: Texture;
  76775. /**
  76776. * Callback called when the task is successful
  76777. */
  76778. onSuccess: (task: TextureAssetTask) => void;
  76779. /**
  76780. * Callback called when the task is successful
  76781. */
  76782. onError: (task: TextureAssetTask, message?: string, exception?: any) => void;
  76783. /**
  76784. * Creates a new TextureAssetTask object
  76785. * @param name defines the name of the task
  76786. * @param url defines the location of the file to load
  76787. * @param noMipmap defines if mipmap should not be generated (default is false)
  76788. * @param invertY defines if texture must be inverted on Y axis (default is true)
  76789. * @param samplingMode defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  76790. */
  76791. constructor(
  76792. /**
  76793. * Defines the name of the task
  76794. */
  76795. name: string,
  76796. /**
  76797. * Defines the location of the file to load
  76798. */
  76799. url: string,
  76800. /**
  76801. * Defines if mipmap should not be generated (default is false)
  76802. */
  76803. noMipmap?: boolean | undefined,
  76804. /**
  76805. * Defines if texture must be inverted on Y axis (default is true)
  76806. */
  76807. invertY?: boolean,
  76808. /**
  76809. * Defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  76810. */
  76811. samplingMode?: number);
  76812. /**
  76813. * Execute the current task
  76814. * @param scene defines the scene where you want your assets to be loaded
  76815. * @param onSuccess is a callback called when the task is successfully executed
  76816. * @param onError is a callback called if an error occurs
  76817. */
  76818. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76819. }
  76820. /**
  76821. * Define a task used by AssetsManager to load cube textures
  76822. */
  76823. export class CubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<CubeTexture> {
  76824. /**
  76825. * Defines the name of the task
  76826. */
  76827. name: string;
  76828. /**
  76829. * Defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  76830. */
  76831. url: string;
  76832. /**
  76833. * Defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  76834. */
  76835. extensions?: string[] | undefined;
  76836. /**
  76837. * Defines if mipmaps should not be generated (default is false)
  76838. */
  76839. noMipmap?: boolean | undefined;
  76840. /**
  76841. * Defines the explicit list of files (undefined by default)
  76842. */
  76843. files?: string[] | undefined;
  76844. /**
  76845. * Gets the loaded texture
  76846. */
  76847. texture: CubeTexture;
  76848. /**
  76849. * Callback called when the task is successful
  76850. */
  76851. onSuccess: (task: CubeTextureAssetTask) => void;
  76852. /**
  76853. * Callback called when the task is successful
  76854. */
  76855. onError: (task: CubeTextureAssetTask, message?: string, exception?: any) => void;
  76856. /**
  76857. * Creates a new CubeTextureAssetTask
  76858. * @param name defines the name of the task
  76859. * @param url defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  76860. * @param extensions defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  76861. * @param noMipmap defines if mipmaps should not be generated (default is false)
  76862. * @param files defines the explicit list of files (undefined by default)
  76863. */
  76864. constructor(
  76865. /**
  76866. * Defines the name of the task
  76867. */
  76868. name: string,
  76869. /**
  76870. * Defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  76871. */
  76872. url: string,
  76873. /**
  76874. * Defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  76875. */
  76876. extensions?: string[] | undefined,
  76877. /**
  76878. * Defines if mipmaps should not be generated (default is false)
  76879. */
  76880. noMipmap?: boolean | undefined,
  76881. /**
  76882. * Defines the explicit list of files (undefined by default)
  76883. */
  76884. files?: string[] | undefined);
  76885. /**
  76886. * Execute the current task
  76887. * @param scene defines the scene where you want your assets to be loaded
  76888. * @param onSuccess is a callback called when the task is successfully executed
  76889. * @param onError is a callback called if an error occurs
  76890. */
  76891. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76892. }
  76893. /**
  76894. * Define a task used by AssetsManager to load HDR cube textures
  76895. */
  76896. export class HDRCubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<HDRCubeTexture> {
  76897. /**
  76898. * Defines the name of the task
  76899. */
  76900. name: string;
  76901. /**
  76902. * Defines the location of the file to load
  76903. */
  76904. url: string;
  76905. /**
  76906. * Defines the desired size (the more it increases the longer the generation will be)
  76907. */
  76908. size: number;
  76909. /**
  76910. * Defines if mipmaps should not be generated (default is false)
  76911. */
  76912. noMipmap: boolean;
  76913. /**
  76914. * Specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  76915. */
  76916. generateHarmonics: boolean;
  76917. /**
  76918. * 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)
  76919. */
  76920. gammaSpace: boolean;
  76921. /**
  76922. * Internal Use Only
  76923. */
  76924. reserved: boolean;
  76925. /**
  76926. * Gets the loaded texture
  76927. */
  76928. texture: HDRCubeTexture;
  76929. /**
  76930. * Callback called when the task is successful
  76931. */
  76932. onSuccess: (task: HDRCubeTextureAssetTask) => void;
  76933. /**
  76934. * Callback called when the task is successful
  76935. */
  76936. onError: (task: HDRCubeTextureAssetTask, message?: string, exception?: any) => void;
  76937. /**
  76938. * Creates a new HDRCubeTextureAssetTask object
  76939. * @param name defines the name of the task
  76940. * @param url defines the location of the file to load
  76941. * @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.
  76942. * @param noMipmap defines if mipmaps should not be generated (default is false)
  76943. * @param generateHarmonics specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  76944. * @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)
  76945. * @param reserved Internal use only
  76946. */
  76947. constructor(
  76948. /**
  76949. * Defines the name of the task
  76950. */
  76951. name: string,
  76952. /**
  76953. * Defines the location of the file to load
  76954. */
  76955. url: string,
  76956. /**
  76957. * Defines the desired size (the more it increases the longer the generation will be)
  76958. */
  76959. size: number,
  76960. /**
  76961. * Defines if mipmaps should not be generated (default is false)
  76962. */
  76963. noMipmap?: boolean,
  76964. /**
  76965. * Specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  76966. */
  76967. generateHarmonics?: boolean,
  76968. /**
  76969. * 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)
  76970. */
  76971. gammaSpace?: boolean,
  76972. /**
  76973. * Internal Use Only
  76974. */
  76975. reserved?: boolean);
  76976. /**
  76977. * Execute the current task
  76978. * @param scene defines the scene where you want your assets to be loaded
  76979. * @param onSuccess is a callback called when the task is successfully executed
  76980. * @param onError is a callback called if an error occurs
  76981. */
  76982. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76983. }
  76984. /**
  76985. * Define a task used by AssetsManager to load Equirectangular cube textures
  76986. */
  76987. export class EquiRectangularCubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<EquiRectangularCubeTexture> {
  76988. /**
  76989. * Defines the name of the task
  76990. */
  76991. name: string;
  76992. /**
  76993. * Defines the location of the file to load
  76994. */
  76995. url: string;
  76996. /**
  76997. * Defines the desired size (the more it increases the longer the generation will be)
  76998. */
  76999. size: number;
  77000. /**
  77001. * Defines if mipmaps should not be generated (default is false)
  77002. */
  77003. noMipmap: boolean;
  77004. /**
  77005. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space,
  77006. * but the standard material would require them in Gamma space) (default is true)
  77007. */
  77008. gammaSpace: boolean;
  77009. /**
  77010. * Gets the loaded texture
  77011. */
  77012. texture: EquiRectangularCubeTexture;
  77013. /**
  77014. * Callback called when the task is successful
  77015. */
  77016. onSuccess: (task: EquiRectangularCubeTextureAssetTask) => void;
  77017. /**
  77018. * Callback called when the task is successful
  77019. */
  77020. onError: (task: EquiRectangularCubeTextureAssetTask, message?: string, exception?: any) => void;
  77021. /**
  77022. * Creates a new EquiRectangularCubeTextureAssetTask object
  77023. * @param name defines the name of the task
  77024. * @param url defines the location of the file to load
  77025. * @param size defines the desired size (the more it increases the longer the generation will be)
  77026. * If the size is omitted this implies you are using a preprocessed cubemap.
  77027. * @param noMipmap defines if mipmaps should not be generated (default is false)
  77028. * @param gammaSpace specifies if the texture will be used in gamma or linear space
  77029. * (the PBR material requires those texture in linear space, but the standard material would require them in Gamma space)
  77030. * (default is true)
  77031. */
  77032. constructor(
  77033. /**
  77034. * Defines the name of the task
  77035. */
  77036. name: string,
  77037. /**
  77038. * Defines the location of the file to load
  77039. */
  77040. url: string,
  77041. /**
  77042. * Defines the desired size (the more it increases the longer the generation will be)
  77043. */
  77044. size: number,
  77045. /**
  77046. * Defines if mipmaps should not be generated (default is false)
  77047. */
  77048. noMipmap?: boolean,
  77049. /**
  77050. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space,
  77051. * but the standard material would require them in Gamma space) (default is true)
  77052. */
  77053. gammaSpace?: boolean);
  77054. /**
  77055. * Execute the current task
  77056. * @param scene defines the scene where you want your assets to be loaded
  77057. * @param onSuccess is a callback called when the task is successfully executed
  77058. * @param onError is a callback called if an error occurs
  77059. */
  77060. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  77061. }
  77062. /**
  77063. * This class can be used to easily import assets into a scene
  77064. * @see https://doc.babylonjs.com/how_to/how_to_use_assetsmanager
  77065. */
  77066. export class AssetsManager {
  77067. private _scene;
  77068. private _isLoading;
  77069. protected _tasks: AbstractAssetTask[];
  77070. protected _waitingTasksCount: number;
  77071. protected _totalTasksCount: number;
  77072. /**
  77073. * Callback called when all tasks are processed
  77074. */
  77075. onFinish: (tasks: AbstractAssetTask[]) => void;
  77076. /**
  77077. * Callback called when a task is successful
  77078. */
  77079. onTaskSuccess: (task: AbstractAssetTask) => void;
  77080. /**
  77081. * Callback called when a task had an error
  77082. */
  77083. onTaskError: (task: AbstractAssetTask) => void;
  77084. /**
  77085. * Callback called when a task is done (whatever the result is)
  77086. */
  77087. onProgress: (remainingCount: number, totalCount: number, task: AbstractAssetTask) => void;
  77088. /**
  77089. * Observable called when all tasks are processed
  77090. */
  77091. onTaskSuccessObservable: Observable<AbstractAssetTask>;
  77092. /**
  77093. * Observable called when a task had an error
  77094. */
  77095. onTaskErrorObservable: Observable<AbstractAssetTask>;
  77096. /**
  77097. * Observable called when all tasks were executed
  77098. */
  77099. onTasksDoneObservable: Observable<AbstractAssetTask[]>;
  77100. /**
  77101. * Observable called when a task is done (whatever the result is)
  77102. */
  77103. onProgressObservable: Observable<IAssetsProgressEvent>;
  77104. /**
  77105. * Gets or sets a boolean defining if the AssetsManager should use the default loading screen
  77106. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  77107. */
  77108. useDefaultLoadingScreen: boolean;
  77109. /**
  77110. * Gets or sets a boolean defining if the AssetsManager should automatically hide the loading screen
  77111. * when all assets have been downloaded.
  77112. * If set to false, you need to manually call in hideLoadingUI() once your scene is ready.
  77113. */
  77114. autoHideLoadingUI: boolean;
  77115. /**
  77116. * Creates a new AssetsManager
  77117. * @param scene defines the scene to work on
  77118. */
  77119. constructor(scene: Scene);
  77120. /**
  77121. * Add a ContainerAssetTask to the list of active tasks
  77122. * @param taskName defines the name of the new task
  77123. * @param meshesNames defines the name of meshes to load
  77124. * @param rootUrl defines the root url to use to locate files
  77125. * @param sceneFilename defines the filename of the scene file
  77126. * @returns a new ContainerAssetTask object
  77127. */
  77128. addContainerTask(taskName: string, meshesNames: any, rootUrl: string, sceneFilename: string): ContainerAssetTask;
  77129. /**
  77130. * Add a MeshAssetTask to the list of active tasks
  77131. * @param taskName defines the name of the new task
  77132. * @param meshesNames defines the name of meshes to load
  77133. * @param rootUrl defines the root url to use to locate files
  77134. * @param sceneFilename defines the filename of the scene file
  77135. * @returns a new MeshAssetTask object
  77136. */
  77137. addMeshTask(taskName: string, meshesNames: any, rootUrl: string, sceneFilename: string): MeshAssetTask;
  77138. /**
  77139. * Add a TextFileAssetTask to the list of active tasks
  77140. * @param taskName defines the name of the new task
  77141. * @param url defines the url of the file to load
  77142. * @returns a new TextFileAssetTask object
  77143. */
  77144. addTextFileTask(taskName: string, url: string): TextFileAssetTask;
  77145. /**
  77146. * Add a BinaryFileAssetTask to the list of active tasks
  77147. * @param taskName defines the name of the new task
  77148. * @param url defines the url of the file to load
  77149. * @returns a new BinaryFileAssetTask object
  77150. */
  77151. addBinaryFileTask(taskName: string, url: string): BinaryFileAssetTask;
  77152. /**
  77153. * Add a ImageAssetTask to the list of active tasks
  77154. * @param taskName defines the name of the new task
  77155. * @param url defines the url of the file to load
  77156. * @returns a new ImageAssetTask object
  77157. */
  77158. addImageTask(taskName: string, url: string): ImageAssetTask;
  77159. /**
  77160. * Add a TextureAssetTask to the list of active tasks
  77161. * @param taskName defines the name of the new task
  77162. * @param url defines the url of the file to load
  77163. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  77164. * @param invertY defines if you want to invert Y axis of the loaded texture (false by default)
  77165. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  77166. * @returns a new TextureAssetTask object
  77167. */
  77168. addTextureTask(taskName: string, url: string, noMipmap?: boolean, invertY?: boolean, samplingMode?: number): TextureAssetTask;
  77169. /**
  77170. * Add a CubeTextureAssetTask to the list of active tasks
  77171. * @param taskName defines the name of the new task
  77172. * @param url defines the url of the file to load
  77173. * @param extensions defines the extension to use to load the cube map (can be null)
  77174. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  77175. * @param files defines the list of files to load (can be null)
  77176. * @returns a new CubeTextureAssetTask object
  77177. */
  77178. addCubeTextureTask(taskName: string, url: string, extensions?: string[], noMipmap?: boolean, files?: string[]): CubeTextureAssetTask;
  77179. /**
  77180. *
  77181. * Add a HDRCubeTextureAssetTask to the list of active tasks
  77182. * @param taskName defines the name of the new task
  77183. * @param url defines the url of the file to load
  77184. * @param size defines the size you want for the cubemap (can be null)
  77185. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  77186. * @param generateHarmonics defines if you want to automatically generate (true by default)
  77187. * @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)
  77188. * @param reserved Internal use only
  77189. * @returns a new HDRCubeTextureAssetTask object
  77190. */
  77191. addHDRCubeTextureTask(taskName: string, url: string, size: number, noMipmap?: boolean, generateHarmonics?: boolean, gammaSpace?: boolean, reserved?: boolean): HDRCubeTextureAssetTask;
  77192. /**
  77193. *
  77194. * Add a EquiRectangularCubeTextureAssetTask to the list of active tasks
  77195. * @param taskName defines the name of the new task
  77196. * @param url defines the url of the file to load
  77197. * @param size defines the size you want for the cubemap (can be null)
  77198. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  77199. * @param gammaSpace Specifies if the texture will be used in gamma or linear space
  77200. * (the PBR material requires those textures in linear space, but the standard material would require them in Gamma space)
  77201. * @returns a new EquiRectangularCubeTextureAssetTask object
  77202. */
  77203. addEquiRectangularCubeTextureAssetTask(taskName: string, url: string, size: number, noMipmap?: boolean, gammaSpace?: boolean): EquiRectangularCubeTextureAssetTask;
  77204. /**
  77205. * Remove a task from the assets manager.
  77206. * @param task the task to remove
  77207. */
  77208. removeTask(task: AbstractAssetTask): void;
  77209. private _decreaseWaitingTasksCount;
  77210. private _runTask;
  77211. /**
  77212. * Reset the AssetsManager and remove all tasks
  77213. * @return the current instance of the AssetsManager
  77214. */
  77215. reset(): AssetsManager;
  77216. /**
  77217. * Start the loading process
  77218. * @return the current instance of the AssetsManager
  77219. */
  77220. load(): AssetsManager;
  77221. /**
  77222. * Start the loading process as an async operation
  77223. * @return a promise returning the list of failed tasks
  77224. */
  77225. loadAsync(): Promise<void>;
  77226. }
  77227. }
  77228. declare module "babylonjs/Misc/deferred" {
  77229. /**
  77230. * Wrapper class for promise with external resolve and reject.
  77231. */
  77232. export class Deferred<T> {
  77233. /**
  77234. * The promise associated with this deferred object.
  77235. */
  77236. readonly promise: Promise<T>;
  77237. private _resolve;
  77238. private _reject;
  77239. /**
  77240. * The resolve method of the promise associated with this deferred object.
  77241. */
  77242. get resolve(): (value?: T | PromiseLike<T> | undefined) => void;
  77243. /**
  77244. * The reject method of the promise associated with this deferred object.
  77245. */
  77246. get reject(): (reason?: any) => void;
  77247. /**
  77248. * Constructor for this deferred object.
  77249. */
  77250. constructor();
  77251. }
  77252. }
  77253. declare module "babylonjs/Misc/meshExploder" {
  77254. import { Mesh } from "babylonjs/Meshes/mesh";
  77255. /**
  77256. * Class used to explode meshes (ie. to have a center and move them away from that center to better see the overall organization)
  77257. */
  77258. export class MeshExploder {
  77259. private _centerMesh;
  77260. private _meshes;
  77261. private _meshesOrigins;
  77262. private _toCenterVectors;
  77263. private _scaledDirection;
  77264. private _newPosition;
  77265. private _centerPosition;
  77266. /**
  77267. * Explodes meshes from a center mesh.
  77268. * @param meshes The meshes to explode.
  77269. * @param centerMesh The mesh to be center of explosion.
  77270. */
  77271. constructor(meshes: Array<Mesh>, centerMesh?: Mesh);
  77272. private _setCenterMesh;
  77273. /**
  77274. * Get class name
  77275. * @returns "MeshExploder"
  77276. */
  77277. getClassName(): string;
  77278. /**
  77279. * "Exploded meshes"
  77280. * @returns Array of meshes with the centerMesh at index 0.
  77281. */
  77282. getMeshes(): Array<Mesh>;
  77283. /**
  77284. * Explodes meshes giving a specific direction
  77285. * @param direction Number to multiply distance of each mesh's origin from center. Use a negative number to implode, or zero to reset.
  77286. */
  77287. explode(direction?: number): void;
  77288. }
  77289. }
  77290. declare module "babylonjs/Misc/filesInput" {
  77291. import { Engine } from "babylonjs/Engines/engine";
  77292. import { Scene } from "babylonjs/scene";
  77293. import { ISceneLoaderProgressEvent } from "babylonjs/Loading/sceneLoader";
  77294. import { Nullable } from "babylonjs/types";
  77295. /**
  77296. * Class used to help managing file picking and drag'n'drop
  77297. */
  77298. export class FilesInput {
  77299. /**
  77300. * List of files ready to be loaded
  77301. */
  77302. static get FilesToLoad(): {
  77303. [key: string]: File;
  77304. };
  77305. /**
  77306. * Callback called when a file is processed
  77307. */
  77308. onProcessFileCallback: (file: File, name: string, extension: string) => boolean;
  77309. private _engine;
  77310. private _currentScene;
  77311. private _sceneLoadedCallback;
  77312. private _progressCallback;
  77313. private _additionalRenderLoopLogicCallback;
  77314. private _textureLoadingCallback;
  77315. private _startingProcessingFilesCallback;
  77316. private _onReloadCallback;
  77317. private _errorCallback;
  77318. private _elementToMonitor;
  77319. private _sceneFileToLoad;
  77320. private _filesToLoad;
  77321. /**
  77322. * Creates a new FilesInput
  77323. * @param engine defines the rendering engine
  77324. * @param scene defines the hosting scene
  77325. * @param sceneLoadedCallback callback called when scene is loaded
  77326. * @param progressCallback callback called to track progress
  77327. * @param additionalRenderLoopLogicCallback callback called to add user logic to the rendering loop
  77328. * @param textureLoadingCallback callback called when a texture is loading
  77329. * @param startingProcessingFilesCallback callback called when the system is about to process all files
  77330. * @param onReloadCallback callback called when a reload is requested
  77331. * @param errorCallback callback call if an error occurs
  77332. */
  77333. 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>);
  77334. private _dragEnterHandler;
  77335. private _dragOverHandler;
  77336. private _dropHandler;
  77337. /**
  77338. * Calls this function to listen to drag'n'drop events on a specific DOM element
  77339. * @param elementToMonitor defines the DOM element to track
  77340. */
  77341. monitorElementForDragNDrop(elementToMonitor: HTMLElement): void;
  77342. /** Gets the current list of files to load */
  77343. get filesToLoad(): File[];
  77344. /**
  77345. * Release all associated resources
  77346. */
  77347. dispose(): void;
  77348. private renderFunction;
  77349. private drag;
  77350. private drop;
  77351. private _traverseFolder;
  77352. private _processFiles;
  77353. /**
  77354. * Load files from a drop event
  77355. * @param event defines the drop event to use as source
  77356. */
  77357. loadFiles(event: any): void;
  77358. private _processReload;
  77359. /**
  77360. * Reload the current scene from the loaded files
  77361. */
  77362. reload(): void;
  77363. }
  77364. }
  77365. declare module "babylonjs/Misc/HighDynamicRange/index" {
  77366. export * from "babylonjs/Misc/HighDynamicRange/cubemapToSphericalPolynomial";
  77367. export * from "babylonjs/Misc/HighDynamicRange/hdr";
  77368. export * from "babylonjs/Misc/HighDynamicRange/panoramaToCubemap";
  77369. }
  77370. declare module "babylonjs/Misc/sceneOptimizer" {
  77371. import { Scene, IDisposable } from "babylonjs/scene";
  77372. import { Observable } from "babylonjs/Misc/observable";
  77373. /**
  77374. * Defines the root class used to create scene optimization to use with SceneOptimizer
  77375. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77376. */
  77377. export class SceneOptimization {
  77378. /**
  77379. * Defines the priority of this optimization (0 by default which means first in the list)
  77380. */
  77381. priority: number;
  77382. /**
  77383. * Gets a string describing the action executed by the current optimization
  77384. * @returns description string
  77385. */
  77386. getDescription(): string;
  77387. /**
  77388. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77389. * @param scene defines the current scene where to apply this optimization
  77390. * @param optimizer defines the current optimizer
  77391. * @returns true if everything that can be done was applied
  77392. */
  77393. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  77394. /**
  77395. * Creates the SceneOptimization object
  77396. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  77397. * @param desc defines the description associated with the optimization
  77398. */
  77399. constructor(
  77400. /**
  77401. * Defines the priority of this optimization (0 by default which means first in the list)
  77402. */
  77403. priority?: number);
  77404. }
  77405. /**
  77406. * Defines an optimization used to reduce the size of render target textures
  77407. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77408. */
  77409. export class TextureOptimization extends SceneOptimization {
  77410. /**
  77411. * Defines the priority of this optimization (0 by default which means first in the list)
  77412. */
  77413. priority: number;
  77414. /**
  77415. * 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
  77416. */
  77417. maximumSize: number;
  77418. /**
  77419. * Defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  77420. */
  77421. step: number;
  77422. /**
  77423. * Gets a string describing the action executed by the current optimization
  77424. * @returns description string
  77425. */
  77426. getDescription(): string;
  77427. /**
  77428. * Creates the TextureOptimization object
  77429. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  77430. * @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
  77431. * @param step defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  77432. */
  77433. constructor(
  77434. /**
  77435. * Defines the priority of this optimization (0 by default which means first in the list)
  77436. */
  77437. priority?: number,
  77438. /**
  77439. * 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
  77440. */
  77441. maximumSize?: number,
  77442. /**
  77443. * Defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  77444. */
  77445. step?: number);
  77446. /**
  77447. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77448. * @param scene defines the current scene where to apply this optimization
  77449. * @param optimizer defines the current optimizer
  77450. * @returns true if everything that can be done was applied
  77451. */
  77452. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  77453. }
  77454. /**
  77455. * Defines an optimization used to increase or decrease the rendering resolution
  77456. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77457. */
  77458. export class HardwareScalingOptimization extends SceneOptimization {
  77459. /**
  77460. * Defines the priority of this optimization (0 by default which means first in the list)
  77461. */
  77462. priority: number;
  77463. /**
  77464. * Defines the maximum scale to use (2 by default)
  77465. */
  77466. maximumScale: number;
  77467. /**
  77468. * Defines the step to use between two passes (0.5 by default)
  77469. */
  77470. step: number;
  77471. private _currentScale;
  77472. private _directionOffset;
  77473. /**
  77474. * Gets a string describing the action executed by the current optimization
  77475. * @return description string
  77476. */
  77477. getDescription(): string;
  77478. /**
  77479. * Creates the HardwareScalingOptimization object
  77480. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  77481. * @param maximumScale defines the maximum scale to use (2 by default)
  77482. * @param step defines the step to use between two passes (0.5 by default)
  77483. */
  77484. constructor(
  77485. /**
  77486. * Defines the priority of this optimization (0 by default which means first in the list)
  77487. */
  77488. priority?: number,
  77489. /**
  77490. * Defines the maximum scale to use (2 by default)
  77491. */
  77492. maximumScale?: number,
  77493. /**
  77494. * Defines the step to use between two passes (0.5 by default)
  77495. */
  77496. step?: number);
  77497. /**
  77498. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77499. * @param scene defines the current scene where to apply this optimization
  77500. * @param optimizer defines the current optimizer
  77501. * @returns true if everything that can be done was applied
  77502. */
  77503. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  77504. }
  77505. /**
  77506. * Defines an optimization used to remove shadows
  77507. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77508. */
  77509. export class ShadowsOptimization extends SceneOptimization {
  77510. /**
  77511. * Gets a string describing the action executed by the current optimization
  77512. * @return description string
  77513. */
  77514. getDescription(): string;
  77515. /**
  77516. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77517. * @param scene defines the current scene where to apply this optimization
  77518. * @param optimizer defines the current optimizer
  77519. * @returns true if everything that can be done was applied
  77520. */
  77521. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  77522. }
  77523. /**
  77524. * Defines an optimization used to turn post-processes off
  77525. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77526. */
  77527. export class PostProcessesOptimization extends SceneOptimization {
  77528. /**
  77529. * Gets a string describing the action executed by the current optimization
  77530. * @return description string
  77531. */
  77532. getDescription(): string;
  77533. /**
  77534. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77535. * @param scene defines the current scene where to apply this optimization
  77536. * @param optimizer defines the current optimizer
  77537. * @returns true if everything that can be done was applied
  77538. */
  77539. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  77540. }
  77541. /**
  77542. * Defines an optimization used to turn lens flares off
  77543. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77544. */
  77545. export class LensFlaresOptimization extends SceneOptimization {
  77546. /**
  77547. * Gets a string describing the action executed by the current optimization
  77548. * @return description string
  77549. */
  77550. getDescription(): string;
  77551. /**
  77552. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77553. * @param scene defines the current scene where to apply this optimization
  77554. * @param optimizer defines the current optimizer
  77555. * @returns true if everything that can be done was applied
  77556. */
  77557. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  77558. }
  77559. /**
  77560. * Defines an optimization based on user defined callback.
  77561. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77562. */
  77563. export class CustomOptimization extends SceneOptimization {
  77564. /**
  77565. * Callback called to apply the custom optimization.
  77566. */
  77567. onApply: (scene: Scene, optimizer: SceneOptimizer) => boolean;
  77568. /**
  77569. * Callback called to get custom description
  77570. */
  77571. onGetDescription: () => string;
  77572. /**
  77573. * Gets a string describing the action executed by the current optimization
  77574. * @returns description string
  77575. */
  77576. getDescription(): string;
  77577. /**
  77578. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77579. * @param scene defines the current scene where to apply this optimization
  77580. * @param optimizer defines the current optimizer
  77581. * @returns true if everything that can be done was applied
  77582. */
  77583. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  77584. }
  77585. /**
  77586. * Defines an optimization used to turn particles off
  77587. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77588. */
  77589. export class ParticlesOptimization extends SceneOptimization {
  77590. /**
  77591. * Gets a string describing the action executed by the current optimization
  77592. * @return description string
  77593. */
  77594. getDescription(): string;
  77595. /**
  77596. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77597. * @param scene defines the current scene where to apply this optimization
  77598. * @param optimizer defines the current optimizer
  77599. * @returns true if everything that can be done was applied
  77600. */
  77601. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  77602. }
  77603. /**
  77604. * Defines an optimization used to turn render targets off
  77605. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77606. */
  77607. export class RenderTargetsOptimization extends SceneOptimization {
  77608. /**
  77609. * Gets a string describing the action executed by the current optimization
  77610. * @return description string
  77611. */
  77612. getDescription(): string;
  77613. /**
  77614. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77615. * @param scene defines the current scene where to apply this optimization
  77616. * @param optimizer defines the current optimizer
  77617. * @returns true if everything that can be done was applied
  77618. */
  77619. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  77620. }
  77621. /**
  77622. * Defines an optimization used to merge meshes with compatible materials
  77623. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77624. */
  77625. export class MergeMeshesOptimization extends SceneOptimization {
  77626. private static _UpdateSelectionTree;
  77627. /**
  77628. * Gets or sets a boolean which defines if optimization octree has to be updated
  77629. */
  77630. static get UpdateSelectionTree(): boolean;
  77631. /**
  77632. * Gets or sets a boolean which defines if optimization octree has to be updated
  77633. */
  77634. static set UpdateSelectionTree(value: boolean);
  77635. /**
  77636. * Gets a string describing the action executed by the current optimization
  77637. * @return description string
  77638. */
  77639. getDescription(): string;
  77640. private _canBeMerged;
  77641. /**
  77642. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77643. * @param scene defines the current scene where to apply this optimization
  77644. * @param optimizer defines the current optimizer
  77645. * @param updateSelectionTree defines that the selection octree has to be updated (false by default)
  77646. * @returns true if everything that can be done was applied
  77647. */
  77648. apply(scene: Scene, optimizer: SceneOptimizer, updateSelectionTree?: boolean): boolean;
  77649. }
  77650. /**
  77651. * Defines a list of options used by SceneOptimizer
  77652. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77653. */
  77654. export class SceneOptimizerOptions {
  77655. /**
  77656. * Defines the target frame rate to reach (60 by default)
  77657. */
  77658. targetFrameRate: number;
  77659. /**
  77660. * Defines the interval between two checkes (2000ms by default)
  77661. */
  77662. trackerDuration: number;
  77663. /**
  77664. * Gets the list of optimizations to apply
  77665. */
  77666. optimizations: SceneOptimization[];
  77667. /**
  77668. * Creates a new list of options used by SceneOptimizer
  77669. * @param targetFrameRate defines the target frame rate to reach (60 by default)
  77670. * @param trackerDuration defines the interval between two checkes (2000ms by default)
  77671. */
  77672. constructor(
  77673. /**
  77674. * Defines the target frame rate to reach (60 by default)
  77675. */
  77676. targetFrameRate?: number,
  77677. /**
  77678. * Defines the interval between two checkes (2000ms by default)
  77679. */
  77680. trackerDuration?: number);
  77681. /**
  77682. * Add a new optimization
  77683. * @param optimization defines the SceneOptimization to add to the list of active optimizations
  77684. * @returns the current SceneOptimizerOptions
  77685. */
  77686. addOptimization(optimization: SceneOptimization): SceneOptimizerOptions;
  77687. /**
  77688. * Add a new custom optimization
  77689. * @param onApply defines the callback called to apply the custom optimization (true if everything that can be done was applied)
  77690. * @param onGetDescription defines the callback called to get the description attached with the optimization.
  77691. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  77692. * @returns the current SceneOptimizerOptions
  77693. */
  77694. addCustomOptimization(onApply: (scene: Scene) => boolean, onGetDescription: () => string, priority?: number): SceneOptimizerOptions;
  77695. /**
  77696. * Creates a list of pre-defined optimizations aimed to reduce the visual impact on the scene
  77697. * @param targetFrameRate defines the target frame rate (60 by default)
  77698. * @returns a SceneOptimizerOptions object
  77699. */
  77700. static LowDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  77701. /**
  77702. * Creates a list of pre-defined optimizations aimed to have a moderate impact on the scene visual
  77703. * @param targetFrameRate defines the target frame rate (60 by default)
  77704. * @returns a SceneOptimizerOptions object
  77705. */
  77706. static ModerateDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  77707. /**
  77708. * Creates a list of pre-defined optimizations aimed to have a big impact on the scene visual
  77709. * @param targetFrameRate defines the target frame rate (60 by default)
  77710. * @returns a SceneOptimizerOptions object
  77711. */
  77712. static HighDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  77713. }
  77714. /**
  77715. * Class used to run optimizations in order to reach a target frame rate
  77716. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77717. */
  77718. export class SceneOptimizer implements IDisposable {
  77719. private _isRunning;
  77720. private _options;
  77721. private _scene;
  77722. private _currentPriorityLevel;
  77723. private _targetFrameRate;
  77724. private _trackerDuration;
  77725. private _currentFrameRate;
  77726. private _sceneDisposeObserver;
  77727. private _improvementMode;
  77728. /**
  77729. * Defines an observable called when the optimizer reaches the target frame rate
  77730. */
  77731. onSuccessObservable: Observable<SceneOptimizer>;
  77732. /**
  77733. * Defines an observable called when the optimizer enables an optimization
  77734. */
  77735. onNewOptimizationAppliedObservable: Observable<SceneOptimization>;
  77736. /**
  77737. * Defines an observable called when the optimizer is not able to reach the target frame rate
  77738. */
  77739. onFailureObservable: Observable<SceneOptimizer>;
  77740. /**
  77741. * Gets a boolean indicating if the optimizer is in improvement mode
  77742. */
  77743. get isInImprovementMode(): boolean;
  77744. /**
  77745. * Gets the current priority level (0 at start)
  77746. */
  77747. get currentPriorityLevel(): number;
  77748. /**
  77749. * Gets the current frame rate checked by the SceneOptimizer
  77750. */
  77751. get currentFrameRate(): number;
  77752. /**
  77753. * Gets or sets the current target frame rate (60 by default)
  77754. */
  77755. get targetFrameRate(): number;
  77756. /**
  77757. * Gets or sets the current target frame rate (60 by default)
  77758. */
  77759. set targetFrameRate(value: number);
  77760. /**
  77761. * Gets or sets the current interval between two checks (every 2000ms by default)
  77762. */
  77763. get trackerDuration(): number;
  77764. /**
  77765. * Gets or sets the current interval between two checks (every 2000ms by default)
  77766. */
  77767. set trackerDuration(value: number);
  77768. /**
  77769. * Gets the list of active optimizations
  77770. */
  77771. get optimizations(): SceneOptimization[];
  77772. /**
  77773. * Creates a new SceneOptimizer
  77774. * @param scene defines the scene to work on
  77775. * @param options defines the options to use with the SceneOptimizer
  77776. * @param autoGeneratePriorities defines if priorities must be generated and not read from SceneOptimization property (true by default)
  77777. * @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)
  77778. */
  77779. constructor(scene: Scene, options?: SceneOptimizerOptions, autoGeneratePriorities?: boolean, improvementMode?: boolean);
  77780. /**
  77781. * Stops the current optimizer
  77782. */
  77783. stop(): void;
  77784. /**
  77785. * Reset the optimizer to initial step (current priority level = 0)
  77786. */
  77787. reset(): void;
  77788. /**
  77789. * Start the optimizer. By default it will try to reach a specific framerate
  77790. * but if the optimizer is set with improvementMode === true then it will run all optimiatiation while frame rate is above the target frame rate
  77791. */
  77792. start(): void;
  77793. private _checkCurrentState;
  77794. /**
  77795. * Release all resources
  77796. */
  77797. dispose(): void;
  77798. /**
  77799. * Helper function to create a SceneOptimizer with one single line of code
  77800. * @param scene defines the scene to work on
  77801. * @param options defines the options to use with the SceneOptimizer
  77802. * @param onSuccess defines a callback to call on success
  77803. * @param onFailure defines a callback to call on failure
  77804. * @returns the new SceneOptimizer object
  77805. */
  77806. static OptimizeAsync(scene: Scene, options?: SceneOptimizerOptions, onSuccess?: () => void, onFailure?: () => void): SceneOptimizer;
  77807. }
  77808. }
  77809. declare module "babylonjs/Misc/sceneSerializer" {
  77810. import { Scene } from "babylonjs/scene";
  77811. /**
  77812. * Class used to serialize a scene into a string
  77813. */
  77814. export class SceneSerializer {
  77815. /**
  77816. * Clear cache used by a previous serialization
  77817. */
  77818. static ClearCache(): void;
  77819. /**
  77820. * Serialize a scene into a JSON compatible object
  77821. * @param scene defines the scene to serialize
  77822. * @returns a JSON compatible object
  77823. */
  77824. static Serialize(scene: Scene): any;
  77825. /**
  77826. * Serialize a mesh into a JSON compatible object
  77827. * @param toSerialize defines the mesh to serialize
  77828. * @param withParents defines if parents must be serialized as well
  77829. * @param withChildren defines if children must be serialized as well
  77830. * @returns a JSON compatible object
  77831. */
  77832. static SerializeMesh(toSerialize: any, withParents?: boolean, withChildren?: boolean): any;
  77833. }
  77834. }
  77835. declare module "babylonjs/Misc/textureTools" {
  77836. import { Texture } from "babylonjs/Materials/Textures/texture";
  77837. /**
  77838. * Class used to host texture specific utilities
  77839. */
  77840. export class TextureTools {
  77841. /**
  77842. * Uses the GPU to create a copy texture rescaled at a given size
  77843. * @param texture Texture to copy from
  77844. * @param width defines the desired width
  77845. * @param height defines the desired height
  77846. * @param useBilinearMode defines if bilinear mode has to be used
  77847. * @return the generated texture
  77848. */
  77849. static CreateResizedCopy(texture: Texture, width: number, height: number, useBilinearMode?: boolean): Texture;
  77850. }
  77851. }
  77852. declare module "babylonjs/Misc/videoRecorder" {
  77853. import { Nullable } from "babylonjs/types";
  77854. import { Engine } from "babylonjs/Engines/engine";
  77855. /**
  77856. * This represents the different options available for the video capture.
  77857. */
  77858. export interface VideoRecorderOptions {
  77859. /** Defines the mime type of the video. */
  77860. mimeType: string;
  77861. /** Defines the FPS the video should be recorded at. */
  77862. fps: number;
  77863. /** Defines the chunk size for the recording data. */
  77864. recordChunckSize: number;
  77865. /** The audio tracks to attach to the recording. */
  77866. audioTracks?: MediaStreamTrack[];
  77867. }
  77868. /**
  77869. * This can help with recording videos from BabylonJS.
  77870. * This is based on the available WebRTC functionalities of the browser.
  77871. *
  77872. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_video
  77873. */
  77874. export class VideoRecorder {
  77875. private static readonly _defaultOptions;
  77876. /**
  77877. * Returns whether or not the VideoRecorder is available in your browser.
  77878. * @param engine Defines the Babylon Engine.
  77879. * @returns true if supported otherwise false.
  77880. */
  77881. static IsSupported(engine: Engine): boolean;
  77882. private readonly _options;
  77883. private _canvas;
  77884. private _mediaRecorder;
  77885. private _recordedChunks;
  77886. private _fileName;
  77887. private _resolve;
  77888. private _reject;
  77889. /**
  77890. * True when a recording is already in progress.
  77891. */
  77892. get isRecording(): boolean;
  77893. /**
  77894. * Create a new VideoCapture object which can help converting what you see in Babylon to a video file.
  77895. * @param engine Defines the BabylonJS Engine you wish to record.
  77896. * @param options Defines options that can be used to customize the capture.
  77897. */
  77898. constructor(engine: Engine, options?: Nullable<VideoRecorderOptions>);
  77899. /**
  77900. * Stops the current recording before the default capture timeout passed in the startRecording function.
  77901. */
  77902. stopRecording(): void;
  77903. /**
  77904. * Starts recording the canvas for a max duration specified in parameters.
  77905. * @param fileName Defines the name of the file to be downloaded when the recording stop.
  77906. * If null no automatic download will start and you can rely on the promise to get the data back.
  77907. * @param maxDuration Defines the maximum recording time in seconds.
  77908. * It defaults to 7 seconds. A value of zero will not stop automatically, you would need to call stopRecording manually.
  77909. * @return A promise callback at the end of the recording with the video data in Blob.
  77910. */
  77911. startRecording(fileName?: Nullable<string>, maxDuration?: number): Promise<Blob>;
  77912. /**
  77913. * Releases internal resources used during the recording.
  77914. */
  77915. dispose(): void;
  77916. private _handleDataAvailable;
  77917. private _handleError;
  77918. private _handleStop;
  77919. }
  77920. }
  77921. declare module "babylonjs/Misc/screenshotTools" {
  77922. import { Camera } from "babylonjs/Cameras/camera";
  77923. import { IScreenshotSize } from "babylonjs/Misc/interfaces/screenshotSize";
  77924. import { Engine } from "babylonjs/Engines/engine";
  77925. /**
  77926. * Class containing a set of static utilities functions for screenshots
  77927. */
  77928. export class ScreenshotTools {
  77929. /**
  77930. * Captures a screenshot of the current rendering
  77931. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  77932. * @param engine defines the rendering engine
  77933. * @param camera defines the source camera
  77934. * @param size This parameter can be set to a single number or to an object with the
  77935. * following (optional) properties: precision, width, height. If a single number is passed,
  77936. * it will be used for both width and height. If an object is passed, the screenshot size
  77937. * will be derived from the parameters. The precision property is a multiplier allowing
  77938. * rendering at a higher or lower resolution
  77939. * @param successCallback defines the callback receives a single parameter which contains the
  77940. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  77941. * src parameter of an <img> to display it
  77942. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  77943. * Check your browser for supported MIME types
  77944. */
  77945. static CreateScreenshot(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string): void;
  77946. /**
  77947. * Captures a screenshot of the current rendering
  77948. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  77949. * @param engine defines the rendering engine
  77950. * @param camera defines the source camera
  77951. * @param size This parameter can be set to a single number or to an object with the
  77952. * following (optional) properties: precision, width, height. If a single number is passed,
  77953. * it will be used for both width and height. If an object is passed, the screenshot size
  77954. * will be derived from the parameters. The precision property is a multiplier allowing
  77955. * rendering at a higher or lower resolution
  77956. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  77957. * Check your browser for supported MIME types
  77958. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  77959. * to the src parameter of an <img> to display it
  77960. */
  77961. static CreateScreenshotAsync(engine: Engine, camera: Camera, size: any, mimeType?: string): Promise<string>;
  77962. /**
  77963. * Generates an image screenshot from the specified camera.
  77964. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  77965. * @param engine The engine to use for rendering
  77966. * @param camera The camera to use for rendering
  77967. * @param size This parameter can be set to a single number or to an object with the
  77968. * following (optional) properties: precision, width, height. If a single number is passed,
  77969. * it will be used for both width and height. If an object is passed, the screenshot size
  77970. * will be derived from the parameters. The precision property is a multiplier allowing
  77971. * rendering at a higher or lower resolution
  77972. * @param successCallback The callback receives a single parameter which contains the
  77973. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  77974. * src parameter of an <img> to display it
  77975. * @param mimeType The MIME type of the screenshot image (default: image/png).
  77976. * Check your browser for supported MIME types
  77977. * @param samples Texture samples (default: 1)
  77978. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  77979. * @param fileName A name for for the downloaded file.
  77980. * @param renderSprites Whether the sprites should be rendered or not (default: false)
  77981. * @param enableStencilBuffer Whether the stencil buffer should be enabled or not (default: false)
  77982. */
  77983. 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;
  77984. /**
  77985. * Generates an image screenshot from the specified camera.
  77986. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  77987. * @param engine The engine to use for rendering
  77988. * @param camera The camera to use for rendering
  77989. * @param size This parameter can be set to a single number or to an object with the
  77990. * following (optional) properties: precision, width, height. If a single number is passed,
  77991. * it will be used for both width and height. If an object is passed, the screenshot size
  77992. * will be derived from the parameters. The precision property is a multiplier allowing
  77993. * rendering at a higher or lower resolution
  77994. * @param mimeType The MIME type of the screenshot image (default: image/png).
  77995. * Check your browser for supported MIME types
  77996. * @param samples Texture samples (default: 1)
  77997. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  77998. * @param fileName A name for for the downloaded file.
  77999. * @param renderSprites Whether the sprites should be rendered or not (default: false)
  78000. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  78001. * to the src parameter of an <img> to display it
  78002. */
  78003. static CreateScreenshotUsingRenderTargetAsync(engine: Engine, camera: Camera, size: any, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string, renderSprites?: boolean): Promise<string>;
  78004. /**
  78005. * Gets height and width for screenshot size
  78006. * @private
  78007. */
  78008. private static _getScreenshotSize;
  78009. }
  78010. }
  78011. declare module "babylonjs/Misc/dataReader" {
  78012. /**
  78013. * Interface for a data buffer
  78014. */
  78015. export interface IDataBuffer {
  78016. /**
  78017. * Reads bytes from the data buffer.
  78018. * @param byteOffset The byte offset to read
  78019. * @param byteLength The byte length to read
  78020. * @returns A promise that resolves when the bytes are read
  78021. */
  78022. readAsync(byteOffset: number, byteLength: number): Promise<ArrayBufferView>;
  78023. /**
  78024. * The byte length of the buffer.
  78025. */
  78026. readonly byteLength: number;
  78027. }
  78028. /**
  78029. * Utility class for reading from a data buffer
  78030. */
  78031. export class DataReader {
  78032. /**
  78033. * The data buffer associated with this data reader.
  78034. */
  78035. readonly buffer: IDataBuffer;
  78036. /**
  78037. * The current byte offset from the beginning of the data buffer.
  78038. */
  78039. byteOffset: number;
  78040. private _dataView;
  78041. private _dataByteOffset;
  78042. /**
  78043. * Constructor
  78044. * @param buffer The buffer to read
  78045. */
  78046. constructor(buffer: IDataBuffer);
  78047. /**
  78048. * Loads the given byte length.
  78049. * @param byteLength The byte length to load
  78050. * @returns A promise that resolves when the load is complete
  78051. */
  78052. loadAsync(byteLength: number): Promise<void>;
  78053. /**
  78054. * Read a unsigned 32-bit integer from the currently loaded data range.
  78055. * @returns The 32-bit integer read
  78056. */
  78057. readUint32(): number;
  78058. /**
  78059. * Read a byte array from the currently loaded data range.
  78060. * @param byteLength The byte length to read
  78061. * @returns The byte array read
  78062. */
  78063. readUint8Array(byteLength: number): Uint8Array;
  78064. /**
  78065. * Read a string from the currently loaded data range.
  78066. * @param byteLength The byte length to read
  78067. * @returns The string read
  78068. */
  78069. readString(byteLength: number): string;
  78070. /**
  78071. * Skips the given byte length the currently loaded data range.
  78072. * @param byteLength The byte length to skip
  78073. */
  78074. skipBytes(byteLength: number): void;
  78075. }
  78076. }
  78077. declare module "babylonjs/Misc/dataStorage" {
  78078. /**
  78079. * Class for storing data to local storage if available or in-memory storage otherwise
  78080. */
  78081. export class DataStorage {
  78082. private static _Storage;
  78083. private static _GetStorage;
  78084. /**
  78085. * Reads a string from the data storage
  78086. * @param key The key to read
  78087. * @param defaultValue The value if the key doesn't exist
  78088. * @returns The string value
  78089. */
  78090. static ReadString(key: string, defaultValue: string): string;
  78091. /**
  78092. * Writes a string to the data storage
  78093. * @param key The key to write
  78094. * @param value The value to write
  78095. */
  78096. static WriteString(key: string, value: string): void;
  78097. /**
  78098. * Reads a boolean from the data storage
  78099. * @param key The key to read
  78100. * @param defaultValue The value if the key doesn't exist
  78101. * @returns The boolean value
  78102. */
  78103. static ReadBoolean(key: string, defaultValue: boolean): boolean;
  78104. /**
  78105. * Writes a boolean to the data storage
  78106. * @param key The key to write
  78107. * @param value The value to write
  78108. */
  78109. static WriteBoolean(key: string, value: boolean): void;
  78110. /**
  78111. * Reads a number from the data storage
  78112. * @param key The key to read
  78113. * @param defaultValue The value if the key doesn't exist
  78114. * @returns The number value
  78115. */
  78116. static ReadNumber(key: string, defaultValue: number): number;
  78117. /**
  78118. * Writes a number to the data storage
  78119. * @param key The key to write
  78120. * @param value The value to write
  78121. */
  78122. static WriteNumber(key: string, value: number): void;
  78123. }
  78124. }
  78125. declare module "babylonjs/Misc/sceneRecorder" {
  78126. import { Scene } from "babylonjs/scene";
  78127. /**
  78128. * Class used to record delta files between 2 scene states
  78129. */
  78130. export class SceneRecorder {
  78131. private _trackedScene;
  78132. private _savedJSON;
  78133. /**
  78134. * Track a given scene. This means the current scene state will be considered the original state
  78135. * @param scene defines the scene to track
  78136. */
  78137. track(scene: Scene): void;
  78138. /**
  78139. * Get the delta between current state and original state
  78140. * @returns a string containing the delta
  78141. */
  78142. getDelta(): any;
  78143. private _compareArray;
  78144. private _compareObjects;
  78145. private _compareCollections;
  78146. private static GetShadowGeneratorById;
  78147. /**
  78148. * Apply a given delta to a given scene
  78149. * @param deltaJSON defines the JSON containing the delta
  78150. * @param scene defines the scene to apply the delta to
  78151. */
  78152. static ApplyDelta(deltaJSON: any | string, scene: Scene): void;
  78153. private static _ApplyPropertiesToEntity;
  78154. private static _ApplyDeltaForEntity;
  78155. }
  78156. }
  78157. declare module "babylonjs/Misc/index" {
  78158. export * from "babylonjs/Misc/andOrNotEvaluator";
  78159. export * from "babylonjs/Misc/assetsManager";
  78160. export * from "babylonjs/Misc/basis";
  78161. export * from "babylonjs/Misc/dds";
  78162. export * from "babylonjs/Misc/decorators";
  78163. export * from "babylonjs/Misc/deferred";
  78164. export * from "babylonjs/Misc/environmentTextureTools";
  78165. export * from "babylonjs/Misc/meshExploder";
  78166. export * from "babylonjs/Misc/filesInput";
  78167. export * from "babylonjs/Misc/HighDynamicRange/index";
  78168. export * from "babylonjs/Misc/khronosTextureContainer";
  78169. export * from "babylonjs/Misc/observable";
  78170. export * from "babylonjs/Misc/performanceMonitor";
  78171. export * from "babylonjs/Misc/promise";
  78172. export * from "babylonjs/Misc/sceneOptimizer";
  78173. export * from "babylonjs/Misc/sceneSerializer";
  78174. export * from "babylonjs/Misc/smartArray";
  78175. export * from "babylonjs/Misc/stringDictionary";
  78176. export * from "babylonjs/Misc/tags";
  78177. export * from "babylonjs/Misc/textureTools";
  78178. export * from "babylonjs/Misc/tga";
  78179. export * from "babylonjs/Misc/tools";
  78180. export * from "babylonjs/Misc/videoRecorder";
  78181. export * from "babylonjs/Misc/virtualJoystick";
  78182. export * from "babylonjs/Misc/workerPool";
  78183. export * from "babylonjs/Misc/logger";
  78184. export * from "babylonjs/Misc/typeStore";
  78185. export * from "babylonjs/Misc/filesInputStore";
  78186. export * from "babylonjs/Misc/deepCopier";
  78187. export * from "babylonjs/Misc/pivotTools";
  78188. export * from "babylonjs/Misc/precisionDate";
  78189. export * from "babylonjs/Misc/screenshotTools";
  78190. export * from "babylonjs/Misc/typeStore";
  78191. export * from "babylonjs/Misc/webRequest";
  78192. export * from "babylonjs/Misc/iInspectable";
  78193. export * from "babylonjs/Misc/brdfTextureTools";
  78194. export * from "babylonjs/Misc/rgbdTextureTools";
  78195. export * from "babylonjs/Misc/gradients";
  78196. export * from "babylonjs/Misc/perfCounter";
  78197. export * from "babylonjs/Misc/fileRequest";
  78198. export * from "babylonjs/Misc/customAnimationFrameRequester";
  78199. export * from "babylonjs/Misc/retryStrategy";
  78200. export * from "babylonjs/Misc/interfaces/screenshotSize";
  78201. export * from "babylonjs/Misc/canvasGenerator";
  78202. export * from "babylonjs/Misc/fileTools";
  78203. export * from "babylonjs/Misc/stringTools";
  78204. export * from "babylonjs/Misc/dataReader";
  78205. export * from "babylonjs/Misc/minMaxReducer";
  78206. export * from "babylonjs/Misc/depthReducer";
  78207. export * from "babylonjs/Misc/dataStorage";
  78208. export * from "babylonjs/Misc/sceneRecorder";
  78209. }
  78210. declare module "babylonjs/XR/features/WebXRHitTestLegacy" {
  78211. import { IWebXRFeature } from "babylonjs/XR/webXRFeaturesManager";
  78212. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  78213. import { Observable } from "babylonjs/Misc/observable";
  78214. import { Matrix } from "babylonjs/Maths/math.vector";
  78215. import { TransformNode } from "babylonjs/Meshes/transformNode";
  78216. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  78217. /**
  78218. * An interface for all Hit test features
  78219. */
  78220. export interface IWebXRHitTestFeature<T extends IWebXRLegacyHitResult> extends IWebXRFeature {
  78221. /**
  78222. * Triggered when new babylon (transformed) hit test results are available
  78223. */
  78224. onHitTestResultObservable: Observable<T[]>;
  78225. }
  78226. /**
  78227. * Options used for hit testing
  78228. */
  78229. export interface IWebXRLegacyHitTestOptions {
  78230. /**
  78231. * Only test when user interacted with the scene. Default - hit test every frame
  78232. */
  78233. testOnPointerDownOnly?: boolean;
  78234. /**
  78235. * The node to use to transform the local results to world coordinates
  78236. */
  78237. worldParentNode?: TransformNode;
  78238. }
  78239. /**
  78240. * Interface defining the babylon result of raycasting/hit-test
  78241. */
  78242. export interface IWebXRLegacyHitResult {
  78243. /**
  78244. * Transformation matrix that can be applied to a node that will put it in the hit point location
  78245. */
  78246. transformationMatrix: Matrix;
  78247. /**
  78248. * The native hit test result
  78249. */
  78250. xrHitResult: XRHitResult | XRHitTestResult;
  78251. }
  78252. /**
  78253. * The currently-working hit-test module.
  78254. * Hit test (or Ray-casting) is used to interact with the real world.
  78255. * For further information read here - https://github.com/immersive-web/hit-test
  78256. */
  78257. export class WebXRHitTestLegacy extends WebXRAbstractFeature implements IWebXRHitTestFeature<IWebXRLegacyHitResult> {
  78258. /**
  78259. * options to use when constructing this feature
  78260. */
  78261. readonly options: IWebXRLegacyHitTestOptions;
  78262. private _direction;
  78263. private _mat;
  78264. private _onSelectEnabled;
  78265. private _origin;
  78266. /**
  78267. * The module's name
  78268. */
  78269. static readonly Name: string;
  78270. /**
  78271. * The (Babylon) version of this module.
  78272. * This is an integer representing the implementation version.
  78273. * This number does not correspond to the WebXR specs version
  78274. */
  78275. static readonly Version: number;
  78276. /**
  78277. * Populated with the last native XR Hit Results
  78278. */
  78279. lastNativeXRHitResults: XRHitResult[];
  78280. /**
  78281. * Triggered when new babylon (transformed) hit test results are available
  78282. */
  78283. onHitTestResultObservable: Observable<IWebXRLegacyHitResult[]>;
  78284. /**
  78285. * Creates a new instance of the (legacy version) hit test feature
  78286. * @param _xrSessionManager an instance of WebXRSessionManager
  78287. * @param options options to use when constructing this feature
  78288. */
  78289. constructor(_xrSessionManager: WebXRSessionManager,
  78290. /**
  78291. * options to use when constructing this feature
  78292. */
  78293. options?: IWebXRLegacyHitTestOptions);
  78294. /**
  78295. * execute a hit test with an XR Ray
  78296. *
  78297. * @param xrSession a native xrSession that will execute this hit test
  78298. * @param xrRay the ray (position and direction) to use for ray-casting
  78299. * @param referenceSpace native XR reference space to use for the hit-test
  78300. * @param filter filter function that will filter the results
  78301. * @returns a promise that resolves with an array of native XR hit result in xr coordinates system
  78302. */
  78303. static XRHitTestWithRay(xrSession: XRSession, xrRay: XRRay, referenceSpace: XRReferenceSpace, filter?: (result: XRHitResult) => boolean): Promise<XRHitResult[]>;
  78304. /**
  78305. * Execute a hit test on the current running session using a select event returned from a transient input (such as touch)
  78306. * @param event the (select) event to use to select with
  78307. * @param referenceSpace the reference space to use for this hit test
  78308. * @returns a promise that resolves with an array of native XR hit result in xr coordinates system
  78309. */
  78310. static XRHitTestWithSelectEvent(event: XRInputSourceEvent, referenceSpace: XRReferenceSpace): Promise<XRHitResult[]>;
  78311. /**
  78312. * attach this feature
  78313. * Will usually be called by the features manager
  78314. *
  78315. * @returns true if successful.
  78316. */
  78317. attach(): boolean;
  78318. /**
  78319. * detach this feature.
  78320. * Will usually be called by the features manager
  78321. *
  78322. * @returns true if successful.
  78323. */
  78324. detach(): boolean;
  78325. /**
  78326. * Dispose this feature and all of the resources attached
  78327. */
  78328. dispose(): void;
  78329. protected _onXRFrame(frame: XRFrame): void;
  78330. private _onHitTestResults;
  78331. private _onSelect;
  78332. }
  78333. }
  78334. declare module "babylonjs/XR/features/WebXRHitTest" {
  78335. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  78336. import { Observable } from "babylonjs/Misc/observable";
  78337. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  78338. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  78339. import { IWebXRLegacyHitTestOptions, IWebXRLegacyHitResult, IWebXRHitTestFeature } from "babylonjs/XR/features/WebXRHitTestLegacy";
  78340. /**
  78341. * Options used for hit testing (version 2)
  78342. */
  78343. export interface IWebXRHitTestOptions extends IWebXRLegacyHitTestOptions {
  78344. /**
  78345. * Do not create a permanent hit test. Will usually be used when only
  78346. * transient inputs are needed.
  78347. */
  78348. disablePermanentHitTest?: boolean;
  78349. /**
  78350. * Enable transient (for example touch-based) hit test inspections
  78351. */
  78352. enableTransientHitTest?: boolean;
  78353. /**
  78354. * Offset ray for the permanent hit test
  78355. */
  78356. offsetRay?: Vector3;
  78357. /**
  78358. * Offset ray for the transient hit test
  78359. */
  78360. transientOffsetRay?: Vector3;
  78361. /**
  78362. * Instead of using viewer space for hit tests, use the reference space defined in the session manager
  78363. */
  78364. useReferenceSpace?: boolean;
  78365. /**
  78366. * Override the default entity type(s) of the hit-test result
  78367. */
  78368. entityTypes?: XRHitTestTrackableType[];
  78369. }
  78370. /**
  78371. * Interface defining the babylon result of hit-test
  78372. */
  78373. export interface IWebXRHitResult extends IWebXRLegacyHitResult {
  78374. /**
  78375. * The input source that generated this hit test (if transient)
  78376. */
  78377. inputSource?: XRInputSource;
  78378. /**
  78379. * Is this a transient hit test
  78380. */
  78381. isTransient?: boolean;
  78382. /**
  78383. * Position of the hit test result
  78384. */
  78385. position: Vector3;
  78386. /**
  78387. * Rotation of the hit test result
  78388. */
  78389. rotationQuaternion: Quaternion;
  78390. /**
  78391. * The native hit test result
  78392. */
  78393. xrHitResult: XRHitTestResult;
  78394. }
  78395. /**
  78396. * The currently-working hit-test module.
  78397. * Hit test (or Ray-casting) is used to interact with the real world.
  78398. * For further information read here - https://github.com/immersive-web/hit-test
  78399. *
  78400. * Tested on chrome (mobile) 80.
  78401. */
  78402. export class WebXRHitTest extends WebXRAbstractFeature implements IWebXRHitTestFeature<IWebXRHitResult> {
  78403. /**
  78404. * options to use when constructing this feature
  78405. */
  78406. readonly options: IWebXRHitTestOptions;
  78407. private _tmpMat;
  78408. private _tmpPos;
  78409. private _tmpQuat;
  78410. private _transientXrHitTestSource;
  78411. private _xrHitTestSource;
  78412. private initHitTestSource;
  78413. /**
  78414. * The module's name
  78415. */
  78416. static readonly Name: string;
  78417. /**
  78418. * The (Babylon) version of this module.
  78419. * This is an integer representing the implementation version.
  78420. * This number does not correspond to the WebXR specs version
  78421. */
  78422. static readonly Version: number;
  78423. /**
  78424. * When set to true, each hit test will have its own position/rotation objects
  78425. * When set to false, position and rotation objects will be reused for each hit test. It is expected that
  78426. * the developers will clone them or copy them as they see fit.
  78427. */
  78428. autoCloneTransformation: boolean;
  78429. /**
  78430. * Triggered when new babylon (transformed) hit test results are available
  78431. */
  78432. onHitTestResultObservable: Observable<IWebXRHitResult[]>;
  78433. /**
  78434. * Use this to temporarily pause hit test checks.
  78435. */
  78436. paused: boolean;
  78437. /**
  78438. * Creates a new instance of the hit test feature
  78439. * @param _xrSessionManager an instance of WebXRSessionManager
  78440. * @param options options to use when constructing this feature
  78441. */
  78442. constructor(_xrSessionManager: WebXRSessionManager,
  78443. /**
  78444. * options to use when constructing this feature
  78445. */
  78446. options?: IWebXRHitTestOptions);
  78447. /**
  78448. * attach this feature
  78449. * Will usually be called by the features manager
  78450. *
  78451. * @returns true if successful.
  78452. */
  78453. attach(): boolean;
  78454. /**
  78455. * detach this feature.
  78456. * Will usually be called by the features manager
  78457. *
  78458. * @returns true if successful.
  78459. */
  78460. detach(): boolean;
  78461. /**
  78462. * Dispose this feature and all of the resources attached
  78463. */
  78464. dispose(): void;
  78465. protected _onXRFrame(frame: XRFrame): void;
  78466. private _processWebXRHitTestResult;
  78467. }
  78468. }
  78469. declare module "babylonjs/XR/features/WebXRAnchorSystem" {
  78470. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  78471. import { Observable } from "babylonjs/Misc/observable";
  78472. import { Matrix, Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  78473. import { TransformNode } from "babylonjs/Meshes/transformNode";
  78474. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  78475. import { IWebXRHitResult } from "babylonjs/XR/features/WebXRHitTest";
  78476. /**
  78477. * Configuration options of the anchor system
  78478. */
  78479. export interface IWebXRAnchorSystemOptions {
  78480. /**
  78481. * a node that will be used to convert local to world coordinates
  78482. */
  78483. worldParentNode?: TransformNode;
  78484. /**
  78485. * If set to true a reference of the created anchors will be kept until the next session starts
  78486. * If not defined, anchors will be removed from the array when the feature is detached or the session ended.
  78487. */
  78488. doNotRemoveAnchorsOnSessionEnded?: boolean;
  78489. }
  78490. /**
  78491. * A babylon container for an XR Anchor
  78492. */
  78493. export interface IWebXRAnchor {
  78494. /**
  78495. * A babylon-assigned ID for this anchor
  78496. */
  78497. id: number;
  78498. /**
  78499. * Transformation matrix to apply to an object attached to this anchor
  78500. */
  78501. transformationMatrix: Matrix;
  78502. /**
  78503. * The native anchor object
  78504. */
  78505. xrAnchor: XRAnchor;
  78506. /**
  78507. * if defined, this object will be constantly updated by the anchor's position and rotation
  78508. */
  78509. attachedNode?: TransformNode;
  78510. }
  78511. /**
  78512. * An implementation of the anchor system for WebXR.
  78513. * For further information see https://github.com/immersive-web/anchors/
  78514. */
  78515. export class WebXRAnchorSystem extends WebXRAbstractFeature {
  78516. private _options;
  78517. private _lastFrameDetected;
  78518. private _trackedAnchors;
  78519. private _referenceSpaceForFrameAnchors;
  78520. private _futureAnchors;
  78521. /**
  78522. * The module's name
  78523. */
  78524. static readonly Name: string;
  78525. /**
  78526. * The (Babylon) version of this module.
  78527. * This is an integer representing the implementation version.
  78528. * This number does not correspond to the WebXR specs version
  78529. */
  78530. static readonly Version: number;
  78531. /**
  78532. * Observers registered here will be executed when a new anchor was added to the session
  78533. */
  78534. onAnchorAddedObservable: Observable<IWebXRAnchor>;
  78535. /**
  78536. * Observers registered here will be executed when an anchor was removed from the session
  78537. */
  78538. onAnchorRemovedObservable: Observable<IWebXRAnchor>;
  78539. /**
  78540. * Observers registered here will be executed when an existing anchor updates
  78541. * This can execute N times every frame
  78542. */
  78543. onAnchorUpdatedObservable: Observable<IWebXRAnchor>;
  78544. /**
  78545. * Set the reference space to use for anchor creation, when not using a hit test.
  78546. * Will default to the session's reference space if not defined
  78547. */
  78548. set referenceSpaceForFrameAnchors(referenceSpace: XRReferenceSpace);
  78549. /**
  78550. * constructs a new anchor system
  78551. * @param _xrSessionManager an instance of WebXRSessionManager
  78552. * @param _options configuration object for this feature
  78553. */
  78554. constructor(_xrSessionManager: WebXRSessionManager, _options?: IWebXRAnchorSystemOptions);
  78555. private _tmpVector;
  78556. private _tmpQuaternion;
  78557. private _populateTmpTransformation;
  78558. /**
  78559. * Create a new anchor point using a hit test result at a specific point in the scene
  78560. * An anchor is tracked only after it is added to the trackerAnchors in xrFrame. The promise returned here does not yet guaranty that.
  78561. * Use onAnchorAddedObservable to get newly added anchors if you require tracking guaranty.
  78562. *
  78563. * @param hitTestResult The hit test result to use for this anchor creation
  78564. * @param position an optional position offset for this anchor
  78565. * @param rotationQuaternion an optional rotation offset for this anchor
  78566. * @returns A promise that fulfills when the XR anchor was registered in the system (but not necessarily added to the tracked anchors)
  78567. */
  78568. addAnchorPointUsingHitTestResultAsync(hitTestResult: IWebXRHitResult, position?: Vector3, rotationQuaternion?: Quaternion): Promise<XRAnchor>;
  78569. /**
  78570. * Add a new anchor at a specific position and rotation
  78571. * This function will add a new anchor per default in the next available frame. Unless forced, the createAnchor function
  78572. * will be called in the next xrFrame loop to make sure that the anchor can be created correctly.
  78573. * An anchor is tracked only after it is added to the trackerAnchors in xrFrame. The promise returned here does not yet guaranty that.
  78574. * Use onAnchorAddedObservable to get newly added anchors if you require tracking guaranty.
  78575. *
  78576. * @param position the position in which to add an anchor
  78577. * @param rotationQuaternion an optional rotation for the anchor transformation
  78578. * @param forceCreateInCurrentFrame force the creation of this anchor in the current frame. Must be called inside xrFrame loop!
  78579. * @returns A promise that fulfills when the XR anchor was registered in the system (but not necessarily added to the tracked anchors)
  78580. */
  78581. addAnchorAtPositionAndRotationAsync(position: Vector3, rotationQuaternion?: Quaternion, forceCreateInCurrentFrame?: boolean): Promise<XRAnchor>;
  78582. /**
  78583. * detach this feature.
  78584. * Will usually be called by the features manager
  78585. *
  78586. * @returns true if successful.
  78587. */
  78588. detach(): boolean;
  78589. /**
  78590. * Dispose this feature and all of the resources attached
  78591. */
  78592. dispose(): void;
  78593. protected _onXRFrame(frame: XRFrame): void;
  78594. /**
  78595. * avoiding using Array.find for global support.
  78596. * @param xrAnchor the plane to find in the array
  78597. */
  78598. private _findIndexInAnchorArray;
  78599. private _updateAnchorWithXRFrame;
  78600. private _createAnchorAtTransformation;
  78601. }
  78602. }
  78603. declare module "babylonjs/XR/features/WebXRPlaneDetector" {
  78604. import { TransformNode } from "babylonjs/Meshes/transformNode";
  78605. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  78606. import { Observable } from "babylonjs/Misc/observable";
  78607. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  78608. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  78609. /**
  78610. * Options used in the plane detector module
  78611. */
  78612. export interface IWebXRPlaneDetectorOptions {
  78613. /**
  78614. * The node to use to transform the local results to world coordinates
  78615. */
  78616. worldParentNode?: TransformNode;
  78617. /**
  78618. * If set to true a reference of the created planes will be kept until the next session starts
  78619. * If not defined, planes will be removed from the array when the feature is detached or the session ended.
  78620. */
  78621. doNotRemovePlanesOnSessionEnded?: boolean;
  78622. }
  78623. /**
  78624. * A babylon interface for a WebXR plane.
  78625. * A Plane is actually a polygon, built from N points in space
  78626. *
  78627. * Supported in chrome 79, not supported in canary 81 ATM
  78628. */
  78629. export interface IWebXRPlane {
  78630. /**
  78631. * a babylon-assigned ID for this polygon
  78632. */
  78633. id: number;
  78634. /**
  78635. * an array of vector3 points in babylon space. right/left hand system is taken into account.
  78636. */
  78637. polygonDefinition: Array<Vector3>;
  78638. /**
  78639. * A transformation matrix to apply on the mesh that will be built using the polygonDefinition
  78640. * Local vs. World are decided if worldParentNode was provided or not in the options when constructing the module
  78641. */
  78642. transformationMatrix: Matrix;
  78643. /**
  78644. * the native xr-plane object
  78645. */
  78646. xrPlane: XRPlane;
  78647. }
  78648. /**
  78649. * The plane detector is used to detect planes in the real world when in AR
  78650. * For more information see https://github.com/immersive-web/real-world-geometry/
  78651. */
  78652. export class WebXRPlaneDetector extends WebXRAbstractFeature {
  78653. private _options;
  78654. private _detectedPlanes;
  78655. private _enabled;
  78656. private _lastFrameDetected;
  78657. /**
  78658. * The module's name
  78659. */
  78660. static readonly Name: string;
  78661. /**
  78662. * The (Babylon) version of this module.
  78663. * This is an integer representing the implementation version.
  78664. * This number does not correspond to the WebXR specs version
  78665. */
  78666. static readonly Version: number;
  78667. /**
  78668. * Observers registered here will be executed when a new plane was added to the session
  78669. */
  78670. onPlaneAddedObservable: Observable<IWebXRPlane>;
  78671. /**
  78672. * Observers registered here will be executed when a plane is no longer detected in the session
  78673. */
  78674. onPlaneRemovedObservable: Observable<IWebXRPlane>;
  78675. /**
  78676. * Observers registered here will be executed when an existing plane updates (for example - expanded)
  78677. * This can execute N times every frame
  78678. */
  78679. onPlaneUpdatedObservable: Observable<IWebXRPlane>;
  78680. /**
  78681. * construct a new Plane Detector
  78682. * @param _xrSessionManager an instance of xr Session manager
  78683. * @param _options configuration to use when constructing this feature
  78684. */
  78685. constructor(_xrSessionManager: WebXRSessionManager, _options?: IWebXRPlaneDetectorOptions);
  78686. /**
  78687. * detach this feature.
  78688. * Will usually be called by the features manager
  78689. *
  78690. * @returns true if successful.
  78691. */
  78692. detach(): boolean;
  78693. /**
  78694. * Dispose this feature and all of the resources attached
  78695. */
  78696. dispose(): void;
  78697. protected _onXRFrame(frame: XRFrame): void;
  78698. private _init;
  78699. private _updatePlaneWithXRPlane;
  78700. /**
  78701. * avoiding using Array.find for global support.
  78702. * @param xrPlane the plane to find in the array
  78703. */
  78704. private findIndexInPlaneArray;
  78705. }
  78706. }
  78707. declare module "babylonjs/XR/features/WebXRBackgroundRemover" {
  78708. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  78709. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  78710. import { Observable } from "babylonjs/Misc/observable";
  78711. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  78712. /**
  78713. * Options interface for the background remover plugin
  78714. */
  78715. export interface IWebXRBackgroundRemoverOptions {
  78716. /**
  78717. * Further background meshes to disable when entering AR
  78718. */
  78719. backgroundMeshes?: AbstractMesh[];
  78720. /**
  78721. * flags to configure the removal of the environment helper.
  78722. * If not set, the entire background will be removed. If set, flags should be set as well.
  78723. */
  78724. environmentHelperRemovalFlags?: {
  78725. /**
  78726. * Should the skybox be removed (default false)
  78727. */
  78728. skyBox?: boolean;
  78729. /**
  78730. * Should the ground be removed (default false)
  78731. */
  78732. ground?: boolean;
  78733. };
  78734. /**
  78735. * don't disable the environment helper
  78736. */
  78737. ignoreEnvironmentHelper?: boolean;
  78738. }
  78739. /**
  78740. * A module that will automatically disable background meshes when entering AR and will enable them when leaving AR.
  78741. */
  78742. export class WebXRBackgroundRemover extends WebXRAbstractFeature {
  78743. /**
  78744. * read-only options to be used in this module
  78745. */
  78746. readonly options: IWebXRBackgroundRemoverOptions;
  78747. /**
  78748. * The module's name
  78749. */
  78750. static readonly Name: string;
  78751. /**
  78752. * The (Babylon) version of this module.
  78753. * This is an integer representing the implementation version.
  78754. * This number does not correspond to the WebXR specs version
  78755. */
  78756. static readonly Version: number;
  78757. /**
  78758. * registered observers will be triggered when the background state changes
  78759. */
  78760. onBackgroundStateChangedObservable: Observable<boolean>;
  78761. /**
  78762. * constructs a new background remover module
  78763. * @param _xrSessionManager the session manager for this module
  78764. * @param options read-only options to be used in this module
  78765. */
  78766. constructor(_xrSessionManager: WebXRSessionManager,
  78767. /**
  78768. * read-only options to be used in this module
  78769. */
  78770. options?: IWebXRBackgroundRemoverOptions);
  78771. /**
  78772. * attach this feature
  78773. * Will usually be called by the features manager
  78774. *
  78775. * @returns true if successful.
  78776. */
  78777. attach(): boolean;
  78778. /**
  78779. * detach this feature.
  78780. * Will usually be called by the features manager
  78781. *
  78782. * @returns true if successful.
  78783. */
  78784. detach(): boolean;
  78785. /**
  78786. * Dispose this feature and all of the resources attached
  78787. */
  78788. dispose(): void;
  78789. protected _onXRFrame(_xrFrame: XRFrame): void;
  78790. private _setBackgroundState;
  78791. }
  78792. }
  78793. declare module "babylonjs/XR/features/WebXRControllerPhysics" {
  78794. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  78795. import { WebXRInputSource } from "babylonjs/XR/webXRInputSource";
  78796. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  78797. import { WebXRInput } from "babylonjs/XR/webXRInput";
  78798. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  78799. import { Nullable } from "babylonjs/types";
  78800. /**
  78801. * Options for the controller physics feature
  78802. */
  78803. export class IWebXRControllerPhysicsOptions {
  78804. /**
  78805. * Should the headset get its own impostor
  78806. */
  78807. enableHeadsetImpostor?: boolean;
  78808. /**
  78809. * Optional parameters for the headset impostor
  78810. */
  78811. headsetImpostorParams?: {
  78812. /**
  78813. * The type of impostor to create. Default is sphere
  78814. */
  78815. impostorType: number;
  78816. /**
  78817. * the size of the impostor. Defaults to 10cm
  78818. */
  78819. impostorSize?: number | {
  78820. width: number;
  78821. height: number;
  78822. depth: number;
  78823. };
  78824. /**
  78825. * Friction definitions
  78826. */
  78827. friction?: number;
  78828. /**
  78829. * Restitution
  78830. */
  78831. restitution?: number;
  78832. };
  78833. /**
  78834. * The physics properties of the future impostors
  78835. */
  78836. physicsProperties?: {
  78837. /**
  78838. * If set to true, a mesh impostor will be created when the controller mesh was loaded
  78839. * Note that this requires a physics engine that supports mesh impostors!
  78840. */
  78841. useControllerMesh?: boolean;
  78842. /**
  78843. * The type of impostor to create. Default is sphere
  78844. */
  78845. impostorType?: number;
  78846. /**
  78847. * the size of the impostor. Defaults to 10cm
  78848. */
  78849. impostorSize?: number | {
  78850. width: number;
  78851. height: number;
  78852. depth: number;
  78853. };
  78854. /**
  78855. * Friction definitions
  78856. */
  78857. friction?: number;
  78858. /**
  78859. * Restitution
  78860. */
  78861. restitution?: number;
  78862. };
  78863. /**
  78864. * the xr input to use with this pointer selection
  78865. */
  78866. xrInput: WebXRInput;
  78867. }
  78868. /**
  78869. * Add physics impostor to your webxr controllers,
  78870. * including naive calculation of their linear and angular velocity
  78871. */
  78872. export class WebXRControllerPhysics extends WebXRAbstractFeature {
  78873. private readonly _options;
  78874. private _attachController;
  78875. private _controllers;
  78876. private _debugMode;
  78877. private _delta;
  78878. private _headsetImpostor?;
  78879. private _headsetMesh?;
  78880. private _lastTimestamp;
  78881. private _tmpQuaternion;
  78882. private _tmpVector;
  78883. /**
  78884. * The module's name
  78885. */
  78886. static readonly Name: string;
  78887. /**
  78888. * The (Babylon) version of this module.
  78889. * This is an integer representing the implementation version.
  78890. * This number does not correspond to the webxr specs version
  78891. */
  78892. static readonly Version: number;
  78893. /**
  78894. * Construct a new Controller Physics Feature
  78895. * @param _xrSessionManager the corresponding xr session manager
  78896. * @param _options options to create this feature with
  78897. */
  78898. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRControllerPhysicsOptions);
  78899. /**
  78900. * @hidden
  78901. * enable debugging - will show console outputs and the impostor mesh
  78902. */
  78903. _enablePhysicsDebug(): void;
  78904. /**
  78905. * Manually add a controller (if no xrInput was provided or physics engine was not enabled)
  78906. * @param xrController the controller to add
  78907. */
  78908. addController(xrController: WebXRInputSource): void;
  78909. /**
  78910. * attach this feature
  78911. * Will usually be called by the features manager
  78912. *
  78913. * @returns true if successful.
  78914. */
  78915. attach(): boolean;
  78916. /**
  78917. * detach this feature.
  78918. * Will usually be called by the features manager
  78919. *
  78920. * @returns true if successful.
  78921. */
  78922. detach(): boolean;
  78923. /**
  78924. * Get the headset impostor, if enabled
  78925. * @returns the impostor
  78926. */
  78927. getHeadsetImpostor(): PhysicsImpostor | undefined;
  78928. /**
  78929. * Get the physics impostor of a specific controller.
  78930. * The impostor is not attached to a mesh because a mesh for each controller is not obligatory
  78931. * @param controller the controller or the controller id of which to get the impostor
  78932. * @returns the impostor or null
  78933. */
  78934. getImpostorForController(controller: WebXRInputSource | string): Nullable<PhysicsImpostor>;
  78935. /**
  78936. * Update the physics properties provided in the constructor
  78937. * @param newProperties the new properties object
  78938. */
  78939. setPhysicsProperties(newProperties: {
  78940. impostorType?: number;
  78941. impostorSize?: number | {
  78942. width: number;
  78943. height: number;
  78944. depth: number;
  78945. };
  78946. friction?: number;
  78947. restitution?: number;
  78948. }): void;
  78949. protected _onXRFrame(_xrFrame: any): void;
  78950. private _detachController;
  78951. }
  78952. }
  78953. declare module "babylonjs/XR/features/WebXRFeaturePointSystem" {
  78954. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  78955. import { Observable } from "babylonjs/Misc/observable";
  78956. import { Vector3 } from "babylonjs/Maths/math.vector";
  78957. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  78958. /**
  78959. * A babylon interface for a "WebXR" feature point.
  78960. * Represents the position and confidence value of a given feature point.
  78961. */
  78962. export interface IWebXRFeaturePoint {
  78963. /**
  78964. * Represents the position of the feature point in world space.
  78965. */
  78966. position: Vector3;
  78967. /**
  78968. * Represents the confidence value of the feature point in world space. 0 being least confident, and 1 being most confident.
  78969. */
  78970. confidenceValue: number;
  78971. }
  78972. /**
  78973. * The feature point system is used to detect feature points from real world geometry.
  78974. * This feature is currently experimental and only supported on BabylonNative, and should not be used in the browser.
  78975. * The newly introduced API can be seen in webxr.nativeextensions.d.ts and described in FeaturePoints.md.
  78976. */
  78977. export class WebXRFeaturePointSystem extends WebXRAbstractFeature {
  78978. private _enabled;
  78979. private _featurePointCloud;
  78980. /**
  78981. * The module's name
  78982. */
  78983. static readonly Name: string;
  78984. /**
  78985. * The (Babylon) version of this module.
  78986. * This is an integer representing the implementation version.
  78987. * This number does not correspond to the WebXR specs version
  78988. */
  78989. static readonly Version: number;
  78990. /**
  78991. * Observers registered here will be executed whenever new feature points are added (on XRFrame while the session is tracking).
  78992. * Will notify the observers about which feature points have been added.
  78993. */
  78994. readonly onFeaturePointsAddedObservable: Observable<number[]>;
  78995. /**
  78996. * Observers registered here will be executed whenever a feature point has been updated (on XRFrame while the session is tracking).
  78997. * Will notify the observers about which feature points have been updated.
  78998. */
  78999. readonly onFeaturePointsUpdatedObservable: Observable<number[]>;
  79000. /**
  79001. * The current feature point cloud maintained across frames.
  79002. */
  79003. get featurePointCloud(): Array<IWebXRFeaturePoint>;
  79004. /**
  79005. * construct the feature point system
  79006. * @param _xrSessionManager an instance of xr Session manager
  79007. */
  79008. constructor(_xrSessionManager: WebXRSessionManager);
  79009. /**
  79010. * Detach this feature.
  79011. * Will usually be called by the features manager
  79012. *
  79013. * @returns true if successful.
  79014. */
  79015. detach(): boolean;
  79016. /**
  79017. * Dispose this feature and all of the resources attached
  79018. */
  79019. dispose(): void;
  79020. /**
  79021. * On receiving a new XR frame if this feature is attached notify observers new feature point data is available.
  79022. */
  79023. protected _onXRFrame(frame: XRFrame): void;
  79024. /**
  79025. * Initializes the feature. If the feature point feature is not available for this environment do not mark the feature as enabled.
  79026. */
  79027. private _init;
  79028. }
  79029. }
  79030. declare module "babylonjs/XR/features/index" {
  79031. export * from "babylonjs/XR/features/WebXRHitTestLegacy";
  79032. export * from "babylonjs/XR/features/WebXRAnchorSystem";
  79033. export * from "babylonjs/XR/features/WebXRPlaneDetector";
  79034. export * from "babylonjs/XR/features/WebXRBackgroundRemover";
  79035. export * from "babylonjs/XR/features/WebXRControllerTeleportation";
  79036. export * from "babylonjs/XR/features/WebXRControllerPointerSelection";
  79037. export * from "babylonjs/XR/features/WebXRControllerPhysics";
  79038. export * from "babylonjs/XR/features/WebXRHitTest";
  79039. export * from "babylonjs/XR/features/WebXRFeaturePointSystem";
  79040. }
  79041. declare module "babylonjs/XR/motionController/webXRMicrosoftMixedRealityController" {
  79042. import { WebXRAbstractMotionController, IMinimalMotionControllerObject, MotionControllerHandedness } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  79043. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  79044. import { Scene } from "babylonjs/scene";
  79045. /**
  79046. * The motion controller class for all microsoft mixed reality controllers
  79047. */
  79048. export class WebXRMicrosoftMixedRealityController extends WebXRAbstractMotionController {
  79049. protected readonly _mapping: {
  79050. defaultButton: {
  79051. valueNodeName: string;
  79052. unpressedNodeName: string;
  79053. pressedNodeName: string;
  79054. };
  79055. defaultAxis: {
  79056. valueNodeName: string;
  79057. minNodeName: string;
  79058. maxNodeName: string;
  79059. };
  79060. buttons: {
  79061. "xr-standard-trigger": {
  79062. rootNodeName: string;
  79063. componentProperty: string;
  79064. states: string[];
  79065. };
  79066. "xr-standard-squeeze": {
  79067. rootNodeName: string;
  79068. componentProperty: string;
  79069. states: string[];
  79070. };
  79071. "xr-standard-touchpad": {
  79072. rootNodeName: string;
  79073. labelAnchorNodeName: string;
  79074. touchPointNodeName: string;
  79075. };
  79076. "xr-standard-thumbstick": {
  79077. rootNodeName: string;
  79078. componentProperty: string;
  79079. states: string[];
  79080. };
  79081. };
  79082. axes: {
  79083. "xr-standard-touchpad": {
  79084. "x-axis": {
  79085. rootNodeName: string;
  79086. };
  79087. "y-axis": {
  79088. rootNodeName: string;
  79089. };
  79090. };
  79091. "xr-standard-thumbstick": {
  79092. "x-axis": {
  79093. rootNodeName: string;
  79094. };
  79095. "y-axis": {
  79096. rootNodeName: string;
  79097. };
  79098. };
  79099. };
  79100. };
  79101. /**
  79102. * The base url used to load the left and right controller models
  79103. */
  79104. static MODEL_BASE_URL: string;
  79105. /**
  79106. * The name of the left controller model file
  79107. */
  79108. static MODEL_LEFT_FILENAME: string;
  79109. /**
  79110. * The name of the right controller model file
  79111. */
  79112. static MODEL_RIGHT_FILENAME: string;
  79113. profileId: string;
  79114. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  79115. protected _getFilenameAndPath(): {
  79116. filename: string;
  79117. path: string;
  79118. };
  79119. protected _getModelLoadingConstraints(): boolean;
  79120. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  79121. protected _setRootMesh(meshes: AbstractMesh[]): void;
  79122. protected _updateModel(): void;
  79123. }
  79124. }
  79125. declare module "babylonjs/XR/motionController/webXROculusTouchMotionController" {
  79126. import { WebXRAbstractMotionController, IMinimalMotionControllerObject, MotionControllerHandedness } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  79127. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  79128. import { Scene } from "babylonjs/scene";
  79129. /**
  79130. * The motion controller class for oculus touch (quest, rift).
  79131. * This class supports legacy mapping as well the standard xr mapping
  79132. */
  79133. export class WebXROculusTouchMotionController extends WebXRAbstractMotionController {
  79134. private _forceLegacyControllers;
  79135. private _modelRootNode;
  79136. /**
  79137. * The base url used to load the left and right controller models
  79138. */
  79139. static MODEL_BASE_URL: string;
  79140. /**
  79141. * The name of the left controller model file
  79142. */
  79143. static MODEL_LEFT_FILENAME: string;
  79144. /**
  79145. * The name of the right controller model file
  79146. */
  79147. static MODEL_RIGHT_FILENAME: string;
  79148. /**
  79149. * Base Url for the Quest controller model.
  79150. */
  79151. static QUEST_MODEL_BASE_URL: string;
  79152. profileId: string;
  79153. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness, legacyMapping?: boolean, _forceLegacyControllers?: boolean);
  79154. protected _getFilenameAndPath(): {
  79155. filename: string;
  79156. path: string;
  79157. };
  79158. protected _getModelLoadingConstraints(): boolean;
  79159. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  79160. protected _setRootMesh(meshes: AbstractMesh[]): void;
  79161. protected _updateModel(): void;
  79162. /**
  79163. * Is this the new type of oculus touch. At the moment both have the same profile and it is impossible to differentiate
  79164. * between the touch and touch 2.
  79165. */
  79166. private _isQuest;
  79167. }
  79168. }
  79169. declare module "babylonjs/XR/motionController/webXRHTCViveMotionController" {
  79170. import { IMinimalMotionControllerObject, MotionControllerHandedness, WebXRAbstractMotionController } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  79171. import { Scene } from "babylonjs/scene";
  79172. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  79173. /**
  79174. * The motion controller class for the standard HTC-Vive controllers
  79175. */
  79176. export class WebXRHTCViveMotionController extends WebXRAbstractMotionController {
  79177. private _modelRootNode;
  79178. /**
  79179. * The base url used to load the left and right controller models
  79180. */
  79181. static MODEL_BASE_URL: string;
  79182. /**
  79183. * File name for the controller model.
  79184. */
  79185. static MODEL_FILENAME: string;
  79186. profileId: string;
  79187. /**
  79188. * Create a new Vive motion controller object
  79189. * @param scene the scene to use to create this controller
  79190. * @param gamepadObject the corresponding gamepad object
  79191. * @param handedness the handedness of the controller
  79192. */
  79193. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  79194. protected _getFilenameAndPath(): {
  79195. filename: string;
  79196. path: string;
  79197. };
  79198. protected _getModelLoadingConstraints(): boolean;
  79199. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  79200. protected _setRootMesh(meshes: AbstractMesh[]): void;
  79201. protected _updateModel(): void;
  79202. }
  79203. }
  79204. declare module "babylonjs/XR/motionController/index" {
  79205. export * from "babylonjs/XR/motionController/webXRAbstractMotionController";
  79206. export * from "babylonjs/XR/motionController/webXRControllerComponent";
  79207. export * from "babylonjs/XR/motionController/webXRGenericMotionController";
  79208. export * from "babylonjs/XR/motionController/webXRMicrosoftMixedRealityController";
  79209. export * from "babylonjs/XR/motionController/webXRMotionControllerManager";
  79210. export * from "babylonjs/XR/motionController/webXROculusTouchMotionController";
  79211. export * from "babylonjs/XR/motionController/webXRHTCViveMotionController";
  79212. export * from "babylonjs/XR/motionController/webXRProfiledMotionController";
  79213. }
  79214. declare module "babylonjs/XR/index" {
  79215. export * from "babylonjs/XR/webXRCamera";
  79216. export * from "babylonjs/XR/webXREnterExitUI";
  79217. export * from "babylonjs/XR/webXRExperienceHelper";
  79218. export * from "babylonjs/XR/webXRInput";
  79219. export * from "babylonjs/XR/webXRInputSource";
  79220. export * from "babylonjs/XR/webXRManagedOutputCanvas";
  79221. export * from "babylonjs/XR/webXRTypes";
  79222. export * from "babylonjs/XR/webXRSessionManager";
  79223. export * from "babylonjs/XR/webXRDefaultExperience";
  79224. export * from "babylonjs/XR/webXRFeaturesManager";
  79225. export * from "babylonjs/XR/features/index";
  79226. export * from "babylonjs/XR/motionController/index";
  79227. }
  79228. declare module "babylonjs/index" {
  79229. export * from "babylonjs/abstractScene";
  79230. export * from "babylonjs/Actions/index";
  79231. export * from "babylonjs/Animations/index";
  79232. export * from "babylonjs/assetContainer";
  79233. export * from "babylonjs/Audio/index";
  79234. export * from "babylonjs/Behaviors/index";
  79235. export * from "babylonjs/Bones/index";
  79236. export * from "babylonjs/Cameras/index";
  79237. export * from "babylonjs/Collisions/index";
  79238. export * from "babylonjs/Culling/index";
  79239. export * from "babylonjs/Debug/index";
  79240. export * from "babylonjs/DeviceInput/index";
  79241. export * from "babylonjs/Engines/index";
  79242. export * from "babylonjs/Events/index";
  79243. export * from "babylonjs/Gamepads/index";
  79244. export * from "babylonjs/Gizmos/index";
  79245. export * from "babylonjs/Helpers/index";
  79246. export * from "babylonjs/Instrumentation/index";
  79247. export * from "babylonjs/Layers/index";
  79248. export * from "babylonjs/LensFlares/index";
  79249. export * from "babylonjs/Lights/index";
  79250. export * from "babylonjs/Loading/index";
  79251. export * from "babylonjs/Materials/index";
  79252. export * from "babylonjs/Maths/index";
  79253. export * from "babylonjs/Meshes/index";
  79254. export * from "babylonjs/Morph/index";
  79255. export * from "babylonjs/Navigation/index";
  79256. export * from "babylonjs/node";
  79257. export * from "babylonjs/Offline/index";
  79258. export * from "babylonjs/Particles/index";
  79259. export * from "babylonjs/Physics/index";
  79260. export * from "babylonjs/PostProcesses/index";
  79261. export * from "babylonjs/Probes/index";
  79262. export * from "babylonjs/Rendering/index";
  79263. export * from "babylonjs/scene";
  79264. export * from "babylonjs/sceneComponent";
  79265. export * from "babylonjs/Sprites/index";
  79266. export * from "babylonjs/States/index";
  79267. export * from "babylonjs/Misc/index";
  79268. export * from "babylonjs/XR/index";
  79269. export * from "babylonjs/types";
  79270. }
  79271. declare module "babylonjs/Animations/pathCursor" {
  79272. import { Vector3 } from "babylonjs/Maths/math.vector";
  79273. import { Path2 } from "babylonjs/Maths/math.path";
  79274. /**
  79275. * A cursor which tracks a point on a path
  79276. */
  79277. export class PathCursor {
  79278. private path;
  79279. /**
  79280. * Stores path cursor callbacks for when an onchange event is triggered
  79281. */
  79282. private _onchange;
  79283. /**
  79284. * The value of the path cursor
  79285. */
  79286. value: number;
  79287. /**
  79288. * The animation array of the path cursor
  79289. */
  79290. animations: Animation[];
  79291. /**
  79292. * Initializes the path cursor
  79293. * @param path The path to track
  79294. */
  79295. constructor(path: Path2);
  79296. /**
  79297. * Gets the cursor point on the path
  79298. * @returns A point on the path cursor at the cursor location
  79299. */
  79300. getPoint(): Vector3;
  79301. /**
  79302. * Moves the cursor ahead by the step amount
  79303. * @param step The amount to move the cursor forward
  79304. * @returns This path cursor
  79305. */
  79306. moveAhead(step?: number): PathCursor;
  79307. /**
  79308. * Moves the cursor behind by the step amount
  79309. * @param step The amount to move the cursor back
  79310. * @returns This path cursor
  79311. */
  79312. moveBack(step?: number): PathCursor;
  79313. /**
  79314. * Moves the cursor by the step amount
  79315. * If the step amount is greater than one, an exception is thrown
  79316. * @param step The amount to move the cursor
  79317. * @returns This path cursor
  79318. */
  79319. move(step: number): PathCursor;
  79320. /**
  79321. * Ensures that the value is limited between zero and one
  79322. * @returns This path cursor
  79323. */
  79324. private ensureLimits;
  79325. /**
  79326. * Runs onchange callbacks on change (used by the animation engine)
  79327. * @returns This path cursor
  79328. */
  79329. private raiseOnChange;
  79330. /**
  79331. * Executes a function on change
  79332. * @param f A path cursor onchange callback
  79333. * @returns This path cursor
  79334. */
  79335. onchange(f: (cursor: PathCursor) => void): PathCursor;
  79336. }
  79337. }
  79338. declare module "babylonjs/Engines/Processors/Expressions/Operators/index" {
  79339. export * from "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineAndOperator";
  79340. export * from "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineArithmeticOperator";
  79341. export * from "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineIsDefinedOperator";
  79342. export * from "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineOrOperator";
  79343. }
  79344. declare module "babylonjs/Engines/Processors/Expressions/index" {
  79345. export * from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  79346. export * from "babylonjs/Engines/Processors/Expressions/Operators/index";
  79347. }
  79348. declare module "babylonjs/Engines/Processors/index" {
  79349. export * from "babylonjs/Engines/Processors/iShaderProcessor";
  79350. export * from "babylonjs/Engines/Processors/Expressions/index";
  79351. export * from "babylonjs/Engines/Processors/shaderCodeConditionNode";
  79352. export * from "babylonjs/Engines/Processors/shaderCodeCursor";
  79353. export * from "babylonjs/Engines/Processors/shaderCodeNode";
  79354. export * from "babylonjs/Engines/Processors/shaderCodeTestNode";
  79355. export * from "babylonjs/Engines/Processors/shaderProcessingOptions";
  79356. export * from "babylonjs/Engines/Processors/shaderProcessor";
  79357. export * from "babylonjs/Engines/Processors/shaderCodeInliner";
  79358. }
  79359. declare module "babylonjs/Legacy/legacy" {
  79360. import * as Babylon from "babylonjs/index";
  79361. export * from "babylonjs/index";
  79362. }
  79363. declare module "babylonjs/Shaders/blur.fragment" {
  79364. /** @hidden */
  79365. export var blurPixelShader: {
  79366. name: string;
  79367. shader: string;
  79368. };
  79369. }
  79370. declare module "babylonjs/Shaders/ShadersInclude/pointCloudVertexDeclaration" {
  79371. /** @hidden */
  79372. export var pointCloudVertexDeclaration: {
  79373. name: string;
  79374. shader: string;
  79375. };
  79376. }
  79377. declare module "babylonjs" {
  79378. export * from "babylonjs/Legacy/legacy";
  79379. }
  79380. declare module BABYLON {
  79381. /** Alias type for value that can be null */
  79382. export type Nullable<T> = T | null;
  79383. /**
  79384. * Alias type for number that are floats
  79385. * @ignorenaming
  79386. */
  79387. export type float = number;
  79388. /**
  79389. * Alias type for number that are doubles.
  79390. * @ignorenaming
  79391. */
  79392. export type double = number;
  79393. /**
  79394. * Alias type for number that are integer
  79395. * @ignorenaming
  79396. */
  79397. export type int = number;
  79398. /** Alias type for number array or Float32Array */
  79399. export type FloatArray = number[] | Float32Array;
  79400. /** Alias type for number array or Float32Array or Int32Array or Uint32Array or Uint16Array */
  79401. export type IndicesArray = number[] | Int32Array | Uint32Array | Uint16Array;
  79402. /**
  79403. * Alias for types that can be used by a Buffer or VertexBuffer.
  79404. */
  79405. export type DataArray = number[] | ArrayBuffer | ArrayBufferView;
  79406. /**
  79407. * Alias type for primitive types
  79408. * @ignorenaming
  79409. */
  79410. type Primitive = undefined | null | boolean | string | number | Function;
  79411. /**
  79412. * Type modifier to make all the properties of an object Readonly
  79413. */
  79414. export type Immutable<T> = T extends Primitive ? T : T extends Array<infer U> ? ReadonlyArray<U> : DeepImmutable<T>;
  79415. /**
  79416. * Type modifier to make all the properties of an object Readonly recursively
  79417. */
  79418. export type DeepImmutable<T> = T extends Primitive ? T : T extends Array<infer U> ? DeepImmutableArray<U> : DeepImmutableObject<T>;
  79419. /**
  79420. * Type modifier to make object properties readonly.
  79421. */
  79422. export type DeepImmutableObject<T> = {
  79423. readonly [K in keyof T]: DeepImmutable<T[K]>;
  79424. };
  79425. /** @hidden */
  79426. interface DeepImmutableArray<T> extends ReadonlyArray<DeepImmutable<T>> {
  79427. }
  79428. }
  79429. declare module BABYLON {
  79430. /**
  79431. * A class serves as a medium between the observable and its observers
  79432. */
  79433. export class EventState {
  79434. /**
  79435. * Create a new EventState
  79436. * @param mask defines the mask associated with this state
  79437. * @param skipNextObservers defines a flag which will instruct the observable to skip following observers when set to true
  79438. * @param target defines the original target of the state
  79439. * @param currentTarget defines the current target of the state
  79440. */
  79441. constructor(mask: number, skipNextObservers?: boolean, target?: any, currentTarget?: any);
  79442. /**
  79443. * Initialize the current event state
  79444. * @param mask defines the mask associated with this state
  79445. * @param skipNextObservers defines a flag which will instruct the observable to skip following observers when set to true
  79446. * @param target defines the original target of the state
  79447. * @param currentTarget defines the current target of the state
  79448. * @returns the current event state
  79449. */
  79450. initalize(mask: number, skipNextObservers?: boolean, target?: any, currentTarget?: any): EventState;
  79451. /**
  79452. * An Observer can set this property to true to prevent subsequent observers of being notified
  79453. */
  79454. skipNextObservers: boolean;
  79455. /**
  79456. * Get the mask value that were used to trigger the event corresponding to this EventState object
  79457. */
  79458. mask: number;
  79459. /**
  79460. * The object that originally notified the event
  79461. */
  79462. target?: any;
  79463. /**
  79464. * The current object in the bubbling phase
  79465. */
  79466. currentTarget?: any;
  79467. /**
  79468. * This will be populated with the return value of the last function that was executed.
  79469. * If it is the first function in the callback chain it will be the event data.
  79470. */
  79471. lastReturnValue?: any;
  79472. }
  79473. /**
  79474. * Represent an Observer registered to a given Observable object.
  79475. */
  79476. export class Observer<T> {
  79477. /**
  79478. * Defines the callback to call when the observer is notified
  79479. */
  79480. callback: (eventData: T, eventState: EventState) => void;
  79481. /**
  79482. * Defines the mask of the observer (used to filter notifications)
  79483. */
  79484. mask: number;
  79485. /**
  79486. * Defines the current scope used to restore the JS context
  79487. */
  79488. scope: any;
  79489. /** @hidden */
  79490. _willBeUnregistered: boolean;
  79491. /**
  79492. * Gets or sets a property defining that the observer as to be unregistered after the next notification
  79493. */
  79494. unregisterOnNextCall: boolean;
  79495. /**
  79496. * Creates a new observer
  79497. * @param callback defines the callback to call when the observer is notified
  79498. * @param mask defines the mask of the observer (used to filter notifications)
  79499. * @param scope defines the current scope used to restore the JS context
  79500. */
  79501. constructor(
  79502. /**
  79503. * Defines the callback to call when the observer is notified
  79504. */
  79505. callback: (eventData: T, eventState: EventState) => void,
  79506. /**
  79507. * Defines the mask of the observer (used to filter notifications)
  79508. */
  79509. mask: number,
  79510. /**
  79511. * Defines the current scope used to restore the JS context
  79512. */
  79513. scope?: any);
  79514. }
  79515. /**
  79516. * Represent a list of observers registered to multiple Observables object.
  79517. */
  79518. export class MultiObserver<T> {
  79519. private _observers;
  79520. private _observables;
  79521. /**
  79522. * Release associated resources
  79523. */
  79524. dispose(): void;
  79525. /**
  79526. * Raise a callback when one of the observable will notify
  79527. * @param observables defines a list of observables to watch
  79528. * @param callback defines the callback to call on notification
  79529. * @param mask defines the mask used to filter notifications
  79530. * @param scope defines the current scope used to restore the JS context
  79531. * @returns the new MultiObserver
  79532. */
  79533. static Watch<T>(observables: Observable<T>[], callback: (eventData: T, eventState: EventState) => void, mask?: number, scope?: any): MultiObserver<T>;
  79534. }
  79535. /**
  79536. * The Observable class is a simple implementation of the Observable pattern.
  79537. *
  79538. * 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.
  79539. * This enable a more fine grained execution without having to rely on multiple different Observable objects.
  79540. * 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).
  79541. * 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.
  79542. */
  79543. export class Observable<T> {
  79544. private _observers;
  79545. private _eventState;
  79546. private _onObserverAdded;
  79547. /**
  79548. * Gets the list of observers
  79549. */
  79550. get observers(): Array<Observer<T>>;
  79551. /**
  79552. * Creates a new observable
  79553. * @param onObserverAdded defines a callback to call when a new observer is added
  79554. */
  79555. constructor(onObserverAdded?: (observer: Observer<T>) => void);
  79556. /**
  79557. * Create a new Observer with the specified callback
  79558. * @param callback the callback that will be executed for that Observer
  79559. * @param mask the mask used to filter observers
  79560. * @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.
  79561. * @param scope optional scope for the callback to be called from
  79562. * @param unregisterOnFirstCall defines if the observer as to be unregistered after the next notification
  79563. * @returns the new observer created for the callback
  79564. */
  79565. add(callback: (eventData: T, eventState: EventState) => void, mask?: number, insertFirst?: boolean, scope?: any, unregisterOnFirstCall?: boolean): Nullable<Observer<T>>;
  79566. /**
  79567. * Create a new Observer with the specified callback and unregisters after the next notification
  79568. * @param callback the callback that will be executed for that Observer
  79569. * @returns the new observer created for the callback
  79570. */
  79571. addOnce(callback: (eventData: T, eventState: EventState) => void): Nullable<Observer<T>>;
  79572. /**
  79573. * Remove an Observer from the Observable object
  79574. * @param observer the instance of the Observer to remove
  79575. * @returns false if it doesn't belong to this Observable
  79576. */
  79577. remove(observer: Nullable<Observer<T>>): boolean;
  79578. /**
  79579. * Remove a callback from the Observable object
  79580. * @param callback the callback to remove
  79581. * @param scope optional scope. If used only the callbacks with this scope will be removed
  79582. * @returns false if it doesn't belong to this Observable
  79583. */
  79584. removeCallback(callback: (eventData: T, eventState: EventState) => void, scope?: any): boolean;
  79585. private _deferUnregister;
  79586. private _remove;
  79587. /**
  79588. * Moves the observable to the top of the observer list making it get called first when notified
  79589. * @param observer the observer to move
  79590. */
  79591. makeObserverTopPriority(observer: Observer<T>): void;
  79592. /**
  79593. * Moves the observable to the bottom of the observer list making it get called last when notified
  79594. * @param observer the observer to move
  79595. */
  79596. makeObserverBottomPriority(observer: Observer<T>): void;
  79597. /**
  79598. * Notify all Observers by calling their respective callback with the given data
  79599. * Will return true if all observers were executed, false if an observer set skipNextObservers to true, then prevent the subsequent ones to execute
  79600. * @param eventData defines the data to send to all observers
  79601. * @param mask defines the mask of the current notification (observers with incompatible mask (ie mask & observer.mask === 0) will not be notified)
  79602. * @param target defines the original target of the state
  79603. * @param currentTarget defines the current target of the state
  79604. * @returns false if the complete observer chain was not processed (because one observer set the skipNextObservers to true)
  79605. */
  79606. notifyObservers(eventData: T, mask?: number, target?: any, currentTarget?: any): boolean;
  79607. /**
  79608. * Calling this will execute each callback, expecting it to be a promise or return a value.
  79609. * If at any point in the chain one function fails, the promise will fail and the execution will not continue.
  79610. * This is useful when a chain of events (sometimes async events) is needed to initialize a certain object
  79611. * and it is crucial that all callbacks will be executed.
  79612. * The order of the callbacks is kept, callbacks are not executed parallel.
  79613. *
  79614. * @param eventData The data to be sent to each callback
  79615. * @param mask is used to filter observers defaults to -1
  79616. * @param target defines the callback target (see EventState)
  79617. * @param currentTarget defines he current object in the bubbling phase
  79618. * @returns {Promise<T>} will return a Promise than resolves when all callbacks executed successfully.
  79619. */
  79620. notifyObserversWithPromise(eventData: T, mask?: number, target?: any, currentTarget?: any): Promise<T>;
  79621. /**
  79622. * Notify a specific observer
  79623. * @param observer defines the observer to notify
  79624. * @param eventData defines the data to be sent to each callback
  79625. * @param mask is used to filter observers defaults to -1
  79626. */
  79627. notifyObserver(observer: Observer<T>, eventData: T, mask?: number): void;
  79628. /**
  79629. * Gets a boolean indicating if the observable has at least one observer
  79630. * @returns true is the Observable has at least one Observer registered
  79631. */
  79632. hasObservers(): boolean;
  79633. /**
  79634. * Clear the list of observers
  79635. */
  79636. clear(): void;
  79637. /**
  79638. * Clone the current observable
  79639. * @returns a new observable
  79640. */
  79641. clone(): Observable<T>;
  79642. /**
  79643. * Does this observable handles observer registered with a given mask
  79644. * @param mask defines the mask to be tested
  79645. * @return whether or not one observer registered with the given mask is handeled
  79646. **/
  79647. hasSpecificMask(mask?: number): boolean;
  79648. }
  79649. }
  79650. declare module BABYLON {
  79651. /**
  79652. * Sets of helpers dealing with the DOM and some of the recurrent functions needed in
  79653. * Babylon.js
  79654. */
  79655. export class DomManagement {
  79656. /**
  79657. * Checks if the window object exists
  79658. * @returns true if the window object exists
  79659. */
  79660. static IsWindowObjectExist(): boolean;
  79661. /**
  79662. * Checks if the navigator object exists
  79663. * @returns true if the navigator object exists
  79664. */
  79665. static IsNavigatorAvailable(): boolean;
  79666. /**
  79667. * Check if the document object exists
  79668. * @returns true if the document object exists
  79669. */
  79670. static IsDocumentAvailable(): boolean;
  79671. /**
  79672. * Extracts text content from a DOM element hierarchy
  79673. * @param element defines the root element
  79674. * @returns a string
  79675. */
  79676. static GetDOMTextContent(element: HTMLElement): string;
  79677. }
  79678. }
  79679. declare module BABYLON {
  79680. /**
  79681. * Logger used througouht the application to allow configuration of
  79682. * the log level required for the messages.
  79683. */
  79684. export class Logger {
  79685. /**
  79686. * No log
  79687. */
  79688. static readonly NoneLogLevel: number;
  79689. /**
  79690. * Only message logs
  79691. */
  79692. static readonly MessageLogLevel: number;
  79693. /**
  79694. * Only warning logs
  79695. */
  79696. static readonly WarningLogLevel: number;
  79697. /**
  79698. * Only error logs
  79699. */
  79700. static readonly ErrorLogLevel: number;
  79701. /**
  79702. * All logs
  79703. */
  79704. static readonly AllLogLevel: number;
  79705. private static _LogCache;
  79706. /**
  79707. * Gets a value indicating the number of loading errors
  79708. * @ignorenaming
  79709. */
  79710. static errorsCount: number;
  79711. /**
  79712. * Callback called when a new log is added
  79713. */
  79714. static OnNewCacheEntry: (entry: string) => void;
  79715. private static _AddLogEntry;
  79716. private static _FormatMessage;
  79717. private static _LogDisabled;
  79718. private static _LogEnabled;
  79719. private static _WarnDisabled;
  79720. private static _WarnEnabled;
  79721. private static _ErrorDisabled;
  79722. private static _ErrorEnabled;
  79723. /**
  79724. * Log a message to the console
  79725. */
  79726. static Log: (message: string) => void;
  79727. /**
  79728. * Write a warning message to the console
  79729. */
  79730. static Warn: (message: string) => void;
  79731. /**
  79732. * Write an error message to the console
  79733. */
  79734. static Error: (message: string) => void;
  79735. /**
  79736. * Gets current log cache (list of logs)
  79737. */
  79738. static get LogCache(): string;
  79739. /**
  79740. * Clears the log cache
  79741. */
  79742. static ClearLogCache(): void;
  79743. /**
  79744. * Sets the current log level (MessageLogLevel / WarningLogLevel / ErrorLogLevel)
  79745. */
  79746. static set LogLevels(level: number);
  79747. }
  79748. }
  79749. declare module BABYLON {
  79750. /** @hidden */
  79751. export class _TypeStore {
  79752. /** @hidden */
  79753. static RegisteredTypes: {
  79754. [key: string]: Object;
  79755. };
  79756. /** @hidden */
  79757. static GetClass(fqdn: string): any;
  79758. }
  79759. }
  79760. declare module BABYLON {
  79761. /**
  79762. * Helper to manipulate strings
  79763. */
  79764. export class StringTools {
  79765. /**
  79766. * Checks for a matching suffix at the end of a string (for ES5 and lower)
  79767. * @param str Source string
  79768. * @param suffix Suffix to search for in the source string
  79769. * @returns Boolean indicating whether the suffix was found (true) or not (false)
  79770. */
  79771. static EndsWith(str: string, suffix: string): boolean;
  79772. /**
  79773. * Checks for a matching suffix at the beginning of a string (for ES5 and lower)
  79774. * @param str Source string
  79775. * @param suffix Suffix to search for in the source string
  79776. * @returns Boolean indicating whether the suffix was found (true) or not (false)
  79777. */
  79778. static StartsWith(str: string, suffix: string): boolean;
  79779. /**
  79780. * Decodes a buffer into a string
  79781. * @param buffer The buffer to decode
  79782. * @returns The decoded string
  79783. */
  79784. static Decode(buffer: Uint8Array | Uint16Array): string;
  79785. /**
  79786. * Encode a buffer to a base64 string
  79787. * @param buffer defines the buffer to encode
  79788. * @returns the encoded string
  79789. */
  79790. static EncodeArrayBufferToBase64(buffer: ArrayBuffer | ArrayBufferView): string;
  79791. /**
  79792. * Converts a number to string and pads with preceeding zeroes until it is of specified length.
  79793. * @param num the number to convert and pad
  79794. * @param length the expected length of the string
  79795. * @returns the padded string
  79796. */
  79797. static PadNumber(num: number, length: number): string;
  79798. }
  79799. }
  79800. declare module BABYLON {
  79801. /**
  79802. * Class containing a set of static utilities functions for deep copy.
  79803. */
  79804. export class DeepCopier {
  79805. /**
  79806. * Tries to copy an object by duplicating every property
  79807. * @param source defines the source object
  79808. * @param destination defines the target object
  79809. * @param doNotCopyList defines a list of properties to avoid
  79810. * @param mustCopyList defines a list of properties to copy (even if they start with _)
  79811. */
  79812. static DeepCopy(source: any, destination: any, doNotCopyList?: string[], mustCopyList?: string[]): void;
  79813. }
  79814. }
  79815. declare module BABYLON {
  79816. /**
  79817. * Class containing a set of static utilities functions for precision date
  79818. */
  79819. export class PrecisionDate {
  79820. /**
  79821. * Gets either window.performance.now() if supported or Date.now() else
  79822. */
  79823. static get Now(): number;
  79824. }
  79825. }
  79826. declare module BABYLON {
  79827. /** @hidden */
  79828. export class _DevTools {
  79829. static WarnImport(name: string): string;
  79830. }
  79831. }
  79832. declare module BABYLON {
  79833. /**
  79834. * Interface used to define the mechanism to get data from the network
  79835. */
  79836. export interface IWebRequest {
  79837. /**
  79838. * Returns client's response url
  79839. */
  79840. responseURL: string;
  79841. /**
  79842. * Returns client's status
  79843. */
  79844. status: number;
  79845. /**
  79846. * Returns client's status as a text
  79847. */
  79848. statusText: string;
  79849. }
  79850. }
  79851. declare module BABYLON {
  79852. /**
  79853. * Extended version of XMLHttpRequest with support for customizations (headers, ...)
  79854. */
  79855. export class WebRequest implements IWebRequest {
  79856. private _xhr;
  79857. /**
  79858. * Custom HTTP Request Headers to be sent with XMLHttpRequests
  79859. * i.e. when loading files, where the server/service expects an Authorization header
  79860. */
  79861. static CustomRequestHeaders: {
  79862. [key: string]: string;
  79863. };
  79864. /**
  79865. * Add callback functions in this array to update all the requests before they get sent to the network
  79866. */
  79867. static CustomRequestModifiers: ((request: XMLHttpRequest, url: string) => void)[];
  79868. private _injectCustomRequestHeaders;
  79869. /**
  79870. * Gets or sets a function to be called when loading progress changes
  79871. */
  79872. get onprogress(): ((this: XMLHttpRequest, ev: ProgressEvent) => any) | null;
  79873. set onprogress(value: ((this: XMLHttpRequest, ev: ProgressEvent) => any) | null);
  79874. /**
  79875. * Returns client's state
  79876. */
  79877. get readyState(): number;
  79878. /**
  79879. * Returns client's status
  79880. */
  79881. get status(): number;
  79882. /**
  79883. * Returns client's status as a text
  79884. */
  79885. get statusText(): string;
  79886. /**
  79887. * Returns client's response
  79888. */
  79889. get response(): any;
  79890. /**
  79891. * Returns client's response url
  79892. */
  79893. get responseURL(): string;
  79894. /**
  79895. * Returns client's response as text
  79896. */
  79897. get responseText(): string;
  79898. /**
  79899. * Gets or sets the expected response type
  79900. */
  79901. get responseType(): XMLHttpRequestResponseType;
  79902. set responseType(value: XMLHttpRequestResponseType);
  79903. /** @hidden */
  79904. addEventListener<K extends keyof XMLHttpRequestEventMap>(type: K, listener: (this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
  79905. /** @hidden */
  79906. removeEventListener<K extends keyof XMLHttpRequestEventMap>(type: K, listener: (this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
  79907. /**
  79908. * Cancels any network activity
  79909. */
  79910. abort(): void;
  79911. /**
  79912. * Initiates the request. The optional argument provides the request body. The argument is ignored if request method is GET or HEAD
  79913. * @param body defines an optional request body
  79914. */
  79915. send(body?: Document | BodyInit | null): void;
  79916. /**
  79917. * Sets the request method, request URL
  79918. * @param method defines the method to use (GET, POST, etc..)
  79919. * @param url defines the url to connect with
  79920. */
  79921. open(method: string, url: string): void;
  79922. /**
  79923. * Sets the value of a request header.
  79924. * @param name The name of the header whose value is to be set
  79925. * @param value The value to set as the body of the header
  79926. */
  79927. setRequestHeader(name: string, value: string): void;
  79928. /**
  79929. * Get the string containing the text of a particular header's value.
  79930. * @param name The name of the header
  79931. * @returns The string containing the text of the given header name
  79932. */
  79933. getResponseHeader(name: string): Nullable<string>;
  79934. }
  79935. }
  79936. declare module BABYLON {
  79937. /**
  79938. * File request interface
  79939. */
  79940. export interface IFileRequest {
  79941. /**
  79942. * Raised when the request is complete (success or error).
  79943. */
  79944. onCompleteObservable: Observable<IFileRequest>;
  79945. /**
  79946. * Aborts the request for a file.
  79947. */
  79948. abort: () => void;
  79949. }
  79950. }
  79951. declare module BABYLON {
  79952. /**
  79953. * Define options used to create a render target texture
  79954. */
  79955. export class RenderTargetCreationOptions {
  79956. /**
  79957. * Specifies is mipmaps must be generated
  79958. */
  79959. generateMipMaps?: boolean;
  79960. /** Specifies whether or not a depth should be allocated in the texture (true by default) */
  79961. generateDepthBuffer?: boolean;
  79962. /** Specifies whether or not a stencil should be allocated in the texture (false by default)*/
  79963. generateStencilBuffer?: boolean;
  79964. /** Defines texture type (int by default) */
  79965. type?: number;
  79966. /** Defines sampling mode (trilinear by default) */
  79967. samplingMode?: number;
  79968. /** Defines format (RGBA by default) */
  79969. format?: number;
  79970. }
  79971. }
  79972. declare module BABYLON {
  79973. /** Defines the cross module used constants to avoid circular dependncies */
  79974. export class Constants {
  79975. /** Defines that alpha blending is disabled */
  79976. static readonly ALPHA_DISABLE: number;
  79977. /** Defines that alpha blending is SRC ALPHA * SRC + DEST */
  79978. static readonly ALPHA_ADD: number;
  79979. /** Defines that alpha blending is SRC ALPHA * SRC + (1 - SRC ALPHA) * DEST */
  79980. static readonly ALPHA_COMBINE: number;
  79981. /** Defines that alpha blending is DEST - SRC * DEST */
  79982. static readonly ALPHA_SUBTRACT: number;
  79983. /** Defines that alpha blending is SRC * DEST */
  79984. static readonly ALPHA_MULTIPLY: number;
  79985. /** Defines that alpha blending is SRC ALPHA * SRC + (1 - SRC) * DEST */
  79986. static readonly ALPHA_MAXIMIZED: number;
  79987. /** Defines that alpha blending is SRC + DEST */
  79988. static readonly ALPHA_ONEONE: number;
  79989. /** Defines that alpha blending is SRC + (1 - SRC ALPHA) * DEST */
  79990. static readonly ALPHA_PREMULTIPLIED: number;
  79991. /**
  79992. * Defines that alpha blending is SRC + (1 - SRC ALPHA) * DEST
  79993. * Alpha will be set to (1 - SRC ALPHA) * DEST ALPHA
  79994. */
  79995. static readonly ALPHA_PREMULTIPLIED_PORTERDUFF: number;
  79996. /** Defines that alpha blending is CST * SRC + (1 - CST) * DEST */
  79997. static readonly ALPHA_INTERPOLATE: number;
  79998. /**
  79999. * Defines that alpha blending is SRC + (1 - SRC) * DEST
  80000. * Alpha will be set to SRC ALPHA + (1 - SRC ALPHA) * DEST ALPHA
  80001. */
  80002. static readonly ALPHA_SCREENMODE: number;
  80003. /**
  80004. * Defines that alpha blending is SRC + DST
  80005. * Alpha will be set to SRC ALPHA + DST ALPHA
  80006. */
  80007. static readonly ALPHA_ONEONE_ONEONE: number;
  80008. /**
  80009. * Defines that alpha blending is SRC * DST ALPHA + DST
  80010. * Alpha will be set to 0
  80011. */
  80012. static readonly ALPHA_ALPHATOCOLOR: number;
  80013. /**
  80014. * Defines that alpha blending is SRC * (1 - DST) + DST * (1 - SRC)
  80015. */
  80016. static readonly ALPHA_REVERSEONEMINUS: number;
  80017. /**
  80018. * Defines that alpha blending is SRC + DST * (1 - SRC ALPHA)
  80019. * Alpha will be set to SRC ALPHA + DST ALPHA * (1 - SRC ALPHA)
  80020. */
  80021. static readonly ALPHA_SRC_DSTONEMINUSSRCALPHA: number;
  80022. /**
  80023. * Defines that alpha blending is SRC + DST
  80024. * Alpha will be set to SRC ALPHA
  80025. */
  80026. static readonly ALPHA_ONEONE_ONEZERO: number;
  80027. /**
  80028. * Defines that alpha blending is SRC * (1 - DST) + DST * (1 - SRC)
  80029. * Alpha will be set to DST ALPHA
  80030. */
  80031. static readonly ALPHA_EXCLUSION: number;
  80032. /** Defines that alpha blending equation a SUM */
  80033. static readonly ALPHA_EQUATION_ADD: number;
  80034. /** Defines that alpha blending equation a SUBSTRACTION */
  80035. static readonly ALPHA_EQUATION_SUBSTRACT: number;
  80036. /** Defines that alpha blending equation a REVERSE SUBSTRACTION */
  80037. static readonly ALPHA_EQUATION_REVERSE_SUBTRACT: number;
  80038. /** Defines that alpha blending equation a MAX operation */
  80039. static readonly ALPHA_EQUATION_MAX: number;
  80040. /** Defines that alpha blending equation a MIN operation */
  80041. static readonly ALPHA_EQUATION_MIN: number;
  80042. /**
  80043. * Defines that alpha blending equation a DARKEN operation:
  80044. * It takes the min of the src and sums the alpha channels.
  80045. */
  80046. static readonly ALPHA_EQUATION_DARKEN: number;
  80047. /** Defines that the ressource is not delayed*/
  80048. static readonly DELAYLOADSTATE_NONE: number;
  80049. /** Defines that the ressource was successfully delay loaded */
  80050. static readonly DELAYLOADSTATE_LOADED: number;
  80051. /** Defines that the ressource is currently delay loading */
  80052. static readonly DELAYLOADSTATE_LOADING: number;
  80053. /** Defines that the ressource is delayed and has not started loading */
  80054. static readonly DELAYLOADSTATE_NOTLOADED: number;
  80055. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will never pass. i.e. Nothing will be drawn */
  80056. static readonly NEVER: number;
  80057. /** 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 */
  80058. static readonly ALWAYS: number;
  80059. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than the stored value */
  80060. static readonly LESS: number;
  80061. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is equals to the stored value */
  80062. static readonly EQUAL: number;
  80063. /** 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 */
  80064. static readonly LEQUAL: number;
  80065. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than the stored value */
  80066. static readonly GREATER: number;
  80067. /** 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 */
  80068. static readonly GEQUAL: number;
  80069. /** 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 */
  80070. static readonly NOTEQUAL: number;
  80071. /** Passed to stencilOperation to specify that stencil value must be kept */
  80072. static readonly KEEP: number;
  80073. /** Passed to stencilOperation to specify that stencil value must be replaced */
  80074. static readonly REPLACE: number;
  80075. /** Passed to stencilOperation to specify that stencil value must be incremented */
  80076. static readonly INCR: number;
  80077. /** Passed to stencilOperation to specify that stencil value must be decremented */
  80078. static readonly DECR: number;
  80079. /** Passed to stencilOperation to specify that stencil value must be inverted */
  80080. static readonly INVERT: number;
  80081. /** Passed to stencilOperation to specify that stencil value must be incremented with wrapping */
  80082. static readonly INCR_WRAP: number;
  80083. /** Passed to stencilOperation to specify that stencil value must be decremented with wrapping */
  80084. static readonly DECR_WRAP: number;
  80085. /** Texture is not repeating outside of 0..1 UVs */
  80086. static readonly TEXTURE_CLAMP_ADDRESSMODE: number;
  80087. /** Texture is repeating outside of 0..1 UVs */
  80088. static readonly TEXTURE_WRAP_ADDRESSMODE: number;
  80089. /** Texture is repeating and mirrored */
  80090. static readonly TEXTURE_MIRROR_ADDRESSMODE: number;
  80091. /** ALPHA */
  80092. static readonly TEXTUREFORMAT_ALPHA: number;
  80093. /** LUMINANCE */
  80094. static readonly TEXTUREFORMAT_LUMINANCE: number;
  80095. /** LUMINANCE_ALPHA */
  80096. static readonly TEXTUREFORMAT_LUMINANCE_ALPHA: number;
  80097. /** RGB */
  80098. static readonly TEXTUREFORMAT_RGB: number;
  80099. /** RGBA */
  80100. static readonly TEXTUREFORMAT_RGBA: number;
  80101. /** RED */
  80102. static readonly TEXTUREFORMAT_RED: number;
  80103. /** RED (2nd reference) */
  80104. static readonly TEXTUREFORMAT_R: number;
  80105. /** RG */
  80106. static readonly TEXTUREFORMAT_RG: number;
  80107. /** RED_INTEGER */
  80108. static readonly TEXTUREFORMAT_RED_INTEGER: number;
  80109. /** RED_INTEGER (2nd reference) */
  80110. static readonly TEXTUREFORMAT_R_INTEGER: number;
  80111. /** RG_INTEGER */
  80112. static readonly TEXTUREFORMAT_RG_INTEGER: number;
  80113. /** RGB_INTEGER */
  80114. static readonly TEXTUREFORMAT_RGB_INTEGER: number;
  80115. /** RGBA_INTEGER */
  80116. static readonly TEXTUREFORMAT_RGBA_INTEGER: number;
  80117. /** UNSIGNED_BYTE */
  80118. static readonly TEXTURETYPE_UNSIGNED_BYTE: number;
  80119. /** UNSIGNED_BYTE (2nd reference) */
  80120. static readonly TEXTURETYPE_UNSIGNED_INT: number;
  80121. /** FLOAT */
  80122. static readonly TEXTURETYPE_FLOAT: number;
  80123. /** HALF_FLOAT */
  80124. static readonly TEXTURETYPE_HALF_FLOAT: number;
  80125. /** BYTE */
  80126. static readonly TEXTURETYPE_BYTE: number;
  80127. /** SHORT */
  80128. static readonly TEXTURETYPE_SHORT: number;
  80129. /** UNSIGNED_SHORT */
  80130. static readonly TEXTURETYPE_UNSIGNED_SHORT: number;
  80131. /** INT */
  80132. static readonly TEXTURETYPE_INT: number;
  80133. /** UNSIGNED_INT */
  80134. static readonly TEXTURETYPE_UNSIGNED_INTEGER: number;
  80135. /** UNSIGNED_SHORT_4_4_4_4 */
  80136. static readonly TEXTURETYPE_UNSIGNED_SHORT_4_4_4_4: number;
  80137. /** UNSIGNED_SHORT_5_5_5_1 */
  80138. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_5_5_1: number;
  80139. /** UNSIGNED_SHORT_5_6_5 */
  80140. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_6_5: number;
  80141. /** UNSIGNED_INT_2_10_10_10_REV */
  80142. static readonly TEXTURETYPE_UNSIGNED_INT_2_10_10_10_REV: number;
  80143. /** UNSIGNED_INT_24_8 */
  80144. static readonly TEXTURETYPE_UNSIGNED_INT_24_8: number;
  80145. /** UNSIGNED_INT_10F_11F_11F_REV */
  80146. static readonly TEXTURETYPE_UNSIGNED_INT_10F_11F_11F_REV: number;
  80147. /** UNSIGNED_INT_5_9_9_9_REV */
  80148. static readonly TEXTURETYPE_UNSIGNED_INT_5_9_9_9_REV: number;
  80149. /** FLOAT_32_UNSIGNED_INT_24_8_REV */
  80150. static readonly TEXTURETYPE_FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  80151. /** nearest is mag = nearest and min = nearest and no mip */
  80152. static readonly TEXTURE_NEAREST_SAMPLINGMODE: number;
  80153. /** mag = nearest and min = nearest and mip = none */
  80154. static readonly TEXTURE_NEAREST_NEAREST: number;
  80155. /** Bilinear is mag = linear and min = linear and no mip */
  80156. static readonly TEXTURE_BILINEAR_SAMPLINGMODE: number;
  80157. /** mag = linear and min = linear and mip = none */
  80158. static readonly TEXTURE_LINEAR_LINEAR: number;
  80159. /** Trilinear is mag = linear and min = linear and mip = linear */
  80160. static readonly TEXTURE_TRILINEAR_SAMPLINGMODE: number;
  80161. /** Trilinear is mag = linear and min = linear and mip = linear */
  80162. static readonly TEXTURE_LINEAR_LINEAR_MIPLINEAR: number;
  80163. /** mag = nearest and min = nearest and mip = nearest */
  80164. static readonly TEXTURE_NEAREST_NEAREST_MIPNEAREST: number;
  80165. /** mag = nearest and min = linear and mip = nearest */
  80166. static readonly TEXTURE_NEAREST_LINEAR_MIPNEAREST: number;
  80167. /** mag = nearest and min = linear and mip = linear */
  80168. static readonly TEXTURE_NEAREST_LINEAR_MIPLINEAR: number;
  80169. /** mag = nearest and min = linear and mip = none */
  80170. static readonly TEXTURE_NEAREST_LINEAR: number;
  80171. /** nearest is mag = nearest and min = nearest and mip = linear */
  80172. static readonly TEXTURE_NEAREST_NEAREST_MIPLINEAR: number;
  80173. /** mag = linear and min = nearest and mip = nearest */
  80174. static readonly TEXTURE_LINEAR_NEAREST_MIPNEAREST: number;
  80175. /** mag = linear and min = nearest and mip = linear */
  80176. static readonly TEXTURE_LINEAR_NEAREST_MIPLINEAR: number;
  80177. /** Bilinear is mag = linear and min = linear and mip = nearest */
  80178. static readonly TEXTURE_LINEAR_LINEAR_MIPNEAREST: number;
  80179. /** mag = linear and min = nearest and mip = none */
  80180. static readonly TEXTURE_LINEAR_NEAREST: number;
  80181. /** Explicit coordinates mode */
  80182. static readonly TEXTURE_EXPLICIT_MODE: number;
  80183. /** Spherical coordinates mode */
  80184. static readonly TEXTURE_SPHERICAL_MODE: number;
  80185. /** Planar coordinates mode */
  80186. static readonly TEXTURE_PLANAR_MODE: number;
  80187. /** Cubic coordinates mode */
  80188. static readonly TEXTURE_CUBIC_MODE: number;
  80189. /** Projection coordinates mode */
  80190. static readonly TEXTURE_PROJECTION_MODE: number;
  80191. /** Skybox coordinates mode */
  80192. static readonly TEXTURE_SKYBOX_MODE: number;
  80193. /** Inverse Cubic coordinates mode */
  80194. static readonly TEXTURE_INVCUBIC_MODE: number;
  80195. /** Equirectangular coordinates mode */
  80196. static readonly TEXTURE_EQUIRECTANGULAR_MODE: number;
  80197. /** Equirectangular Fixed coordinates mode */
  80198. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MODE: number;
  80199. /** Equirectangular Fixed Mirrored coordinates mode */
  80200. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  80201. /** Offline (baking) quality for texture filtering */
  80202. static readonly TEXTURE_FILTERING_QUALITY_OFFLINE: number;
  80203. /** High quality for texture filtering */
  80204. static readonly TEXTURE_FILTERING_QUALITY_HIGH: number;
  80205. /** Medium quality for texture filtering */
  80206. static readonly TEXTURE_FILTERING_QUALITY_MEDIUM: number;
  80207. /** Low quality for texture filtering */
  80208. static readonly TEXTURE_FILTERING_QUALITY_LOW: number;
  80209. /** Defines that texture rescaling will use a floor to find the closer power of 2 size */
  80210. static readonly SCALEMODE_FLOOR: number;
  80211. /** Defines that texture rescaling will look for the nearest power of 2 size */
  80212. static readonly SCALEMODE_NEAREST: number;
  80213. /** Defines that texture rescaling will use a ceil to find the closer power of 2 size */
  80214. static readonly SCALEMODE_CEILING: number;
  80215. /**
  80216. * The dirty texture flag value
  80217. */
  80218. static readonly MATERIAL_TextureDirtyFlag: number;
  80219. /**
  80220. * The dirty light flag value
  80221. */
  80222. static readonly MATERIAL_LightDirtyFlag: number;
  80223. /**
  80224. * The dirty fresnel flag value
  80225. */
  80226. static readonly MATERIAL_FresnelDirtyFlag: number;
  80227. /**
  80228. * The dirty attribute flag value
  80229. */
  80230. static readonly MATERIAL_AttributesDirtyFlag: number;
  80231. /**
  80232. * The dirty misc flag value
  80233. */
  80234. static readonly MATERIAL_MiscDirtyFlag: number;
  80235. /**
  80236. * The all dirty flag value
  80237. */
  80238. static readonly MATERIAL_AllDirtyFlag: number;
  80239. /**
  80240. * Returns the triangle fill mode
  80241. */
  80242. static readonly MATERIAL_TriangleFillMode: number;
  80243. /**
  80244. * Returns the wireframe mode
  80245. */
  80246. static readonly MATERIAL_WireFrameFillMode: number;
  80247. /**
  80248. * Returns the point fill mode
  80249. */
  80250. static readonly MATERIAL_PointFillMode: number;
  80251. /**
  80252. * Returns the point list draw mode
  80253. */
  80254. static readonly MATERIAL_PointListDrawMode: number;
  80255. /**
  80256. * Returns the line list draw mode
  80257. */
  80258. static readonly MATERIAL_LineListDrawMode: number;
  80259. /**
  80260. * Returns the line loop draw mode
  80261. */
  80262. static readonly MATERIAL_LineLoopDrawMode: number;
  80263. /**
  80264. * Returns the line strip draw mode
  80265. */
  80266. static readonly MATERIAL_LineStripDrawMode: number;
  80267. /**
  80268. * Returns the triangle strip draw mode
  80269. */
  80270. static readonly MATERIAL_TriangleStripDrawMode: number;
  80271. /**
  80272. * Returns the triangle fan draw mode
  80273. */
  80274. static readonly MATERIAL_TriangleFanDrawMode: number;
  80275. /**
  80276. * Stores the clock-wise side orientation
  80277. */
  80278. static readonly MATERIAL_ClockWiseSideOrientation: number;
  80279. /**
  80280. * Stores the counter clock-wise side orientation
  80281. */
  80282. static readonly MATERIAL_CounterClockWiseSideOrientation: number;
  80283. /**
  80284. * Nothing
  80285. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80286. */
  80287. static readonly ACTION_NothingTrigger: number;
  80288. /**
  80289. * On pick
  80290. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80291. */
  80292. static readonly ACTION_OnPickTrigger: number;
  80293. /**
  80294. * On left pick
  80295. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80296. */
  80297. static readonly ACTION_OnLeftPickTrigger: number;
  80298. /**
  80299. * On right pick
  80300. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80301. */
  80302. static readonly ACTION_OnRightPickTrigger: number;
  80303. /**
  80304. * On center pick
  80305. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80306. */
  80307. static readonly ACTION_OnCenterPickTrigger: number;
  80308. /**
  80309. * On pick down
  80310. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80311. */
  80312. static readonly ACTION_OnPickDownTrigger: number;
  80313. /**
  80314. * On double pick
  80315. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80316. */
  80317. static readonly ACTION_OnDoublePickTrigger: number;
  80318. /**
  80319. * On pick up
  80320. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80321. */
  80322. static readonly ACTION_OnPickUpTrigger: number;
  80323. /**
  80324. * On pick out.
  80325. * This trigger will only be raised if you also declared a OnPickDown
  80326. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80327. */
  80328. static readonly ACTION_OnPickOutTrigger: number;
  80329. /**
  80330. * On long press
  80331. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80332. */
  80333. static readonly ACTION_OnLongPressTrigger: number;
  80334. /**
  80335. * On pointer over
  80336. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80337. */
  80338. static readonly ACTION_OnPointerOverTrigger: number;
  80339. /**
  80340. * On pointer out
  80341. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80342. */
  80343. static readonly ACTION_OnPointerOutTrigger: number;
  80344. /**
  80345. * On every frame
  80346. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80347. */
  80348. static readonly ACTION_OnEveryFrameTrigger: number;
  80349. /**
  80350. * On intersection enter
  80351. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80352. */
  80353. static readonly ACTION_OnIntersectionEnterTrigger: number;
  80354. /**
  80355. * On intersection exit
  80356. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80357. */
  80358. static readonly ACTION_OnIntersectionExitTrigger: number;
  80359. /**
  80360. * On key down
  80361. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80362. */
  80363. static readonly ACTION_OnKeyDownTrigger: number;
  80364. /**
  80365. * On key up
  80366. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80367. */
  80368. static readonly ACTION_OnKeyUpTrigger: number;
  80369. /**
  80370. * Billboard mode will only apply to Y axis
  80371. */
  80372. static readonly PARTICLES_BILLBOARDMODE_Y: number;
  80373. /**
  80374. * Billboard mode will apply to all axes
  80375. */
  80376. static readonly PARTICLES_BILLBOARDMODE_ALL: number;
  80377. /**
  80378. * Special billboard mode where the particle will be biilboard to the camera but rotated to align with direction
  80379. */
  80380. static readonly PARTICLES_BILLBOARDMODE_STRETCHED: number;
  80381. /** Default culling strategy : this is an exclusion test and it's the more accurate.
  80382. * Test order :
  80383. * Is the bounding sphere outside the frustum ?
  80384. * If not, are the bounding box vertices outside the frustum ?
  80385. * It not, then the cullable object is in the frustum.
  80386. */
  80387. static readonly MESHES_CULLINGSTRATEGY_STANDARD: number;
  80388. /** Culling strategy : Bounding Sphere Only.
  80389. * This is an exclusion test. It's faster than the standard strategy because the bounding box is not tested.
  80390. * It's also less accurate than the standard because some not visible objects can still be selected.
  80391. * Test : is the bounding sphere outside the frustum ?
  80392. * If not, then the cullable object is in the frustum.
  80393. */
  80394. static readonly MESHES_CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY: number;
  80395. /** Culling strategy : Optimistic Inclusion.
  80396. * This in an inclusion test first, then the standard exclusion test.
  80397. * This can be faster when a cullable object is expected to be almost always in the camera frustum.
  80398. * 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.
  80399. * Anyway, it's as accurate as the standard strategy.
  80400. * Test :
  80401. * Is the cullable object bounding sphere center in the frustum ?
  80402. * If not, apply the default culling strategy.
  80403. */
  80404. static readonly MESHES_CULLINGSTRATEGY_OPTIMISTIC_INCLUSION: number;
  80405. /** Culling strategy : Optimistic Inclusion then Bounding Sphere Only.
  80406. * This in an inclusion test first, then the bounding sphere only exclusion test.
  80407. * This can be the fastest test when a cullable object is expected to be almost always in the camera frustum.
  80408. * 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.
  80409. * It's less accurate than the standard strategy and as accurate as the BoundingSphereOnly strategy.
  80410. * Test :
  80411. * Is the cullable object bounding sphere center in the frustum ?
  80412. * If not, apply the Bounding Sphere Only strategy. No Bounding Box is tested here.
  80413. */
  80414. static readonly MESHES_CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY: number;
  80415. /**
  80416. * No logging while loading
  80417. */
  80418. static readonly SCENELOADER_NO_LOGGING: number;
  80419. /**
  80420. * Minimal logging while loading
  80421. */
  80422. static readonly SCENELOADER_MINIMAL_LOGGING: number;
  80423. /**
  80424. * Summary logging while loading
  80425. */
  80426. static readonly SCENELOADER_SUMMARY_LOGGING: number;
  80427. /**
  80428. * Detailled logging while loading
  80429. */
  80430. static readonly SCENELOADER_DETAILED_LOGGING: number;
  80431. /**
  80432. * Prepass texture index for color
  80433. */
  80434. static readonly PREPASS_COLOR_INDEX: number;
  80435. /**
  80436. * Prepass texture index for irradiance
  80437. */
  80438. static readonly PREPASS_IRRADIANCE_INDEX: number;
  80439. /**
  80440. * Prepass texture index for depth + normal
  80441. */
  80442. static readonly PREPASS_DEPTHNORMAL_INDEX: number;
  80443. /**
  80444. * Prepass texture index for albedo
  80445. */
  80446. static readonly PREPASS_ALBEDO_INDEX: number;
  80447. }
  80448. }
  80449. declare module BABYLON {
  80450. /**
  80451. * This represents the required contract to create a new type of texture loader.
  80452. */
  80453. export interface IInternalTextureLoader {
  80454. /**
  80455. * Defines wether the loader supports cascade loading the different faces.
  80456. */
  80457. supportCascades: boolean;
  80458. /**
  80459. * This returns if the loader support the current file information.
  80460. * @param extension defines the file extension of the file being loaded
  80461. * @param mimeType defines the optional mime type of the file being loaded
  80462. * @returns true if the loader can load the specified file
  80463. */
  80464. canLoad(extension: string, mimeType?: string): boolean;
  80465. /**
  80466. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  80467. * @param data contains the texture data
  80468. * @param texture defines the BabylonJS internal texture
  80469. * @param createPolynomials will be true if polynomials have been requested
  80470. * @param onLoad defines the callback to trigger once the texture is ready
  80471. * @param onError defines the callback to trigger in case of error
  80472. */
  80473. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  80474. /**
  80475. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  80476. * @param data contains the texture data
  80477. * @param texture defines the BabylonJS internal texture
  80478. * @param callback defines the method to call once ready to upload
  80479. */
  80480. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void, loadFailed?: boolean) => void): void;
  80481. }
  80482. }
  80483. declare module BABYLON {
  80484. /**
  80485. * Class used to store and describe the pipeline context associated with an effect
  80486. */
  80487. export interface IPipelineContext {
  80488. /**
  80489. * Gets a boolean indicating that this pipeline context is supporting asynchronous creating
  80490. */
  80491. isAsync: boolean;
  80492. /**
  80493. * Gets a boolean indicating that the context is ready to be used (like shaders / pipelines are compiled and ready for instance)
  80494. */
  80495. isReady: boolean;
  80496. /** @hidden */
  80497. _getVertexShaderCode(): string | null;
  80498. /** @hidden */
  80499. _getFragmentShaderCode(): string | null;
  80500. /** @hidden */
  80501. _handlesSpectorRebuildCallback(onCompiled: (compiledObject: any) => void): void;
  80502. }
  80503. }
  80504. declare module BABYLON {
  80505. /**
  80506. * Class used to store gfx data (like WebGLBuffer)
  80507. */
  80508. export class DataBuffer {
  80509. /**
  80510. * Gets or sets the number of objects referencing this buffer
  80511. */
  80512. references: number;
  80513. /** Gets or sets the size of the underlying buffer */
  80514. capacity: number;
  80515. /**
  80516. * Gets or sets a boolean indicating if the buffer contains 32bits indices
  80517. */
  80518. is32Bits: boolean;
  80519. /**
  80520. * Gets the underlying buffer
  80521. */
  80522. get underlyingResource(): any;
  80523. }
  80524. }
  80525. declare module BABYLON {
  80526. /** @hidden */
  80527. export interface IShaderProcessor {
  80528. attributeProcessor?: (attribute: string) => string;
  80529. varyingProcessor?: (varying: string, isFragment: boolean) => string;
  80530. uniformProcessor?: (uniform: string, isFragment: boolean) => string;
  80531. uniformBufferProcessor?: (uniformBuffer: string, isFragment: boolean) => string;
  80532. endOfUniformBufferProcessor?: (closingBracketLine: string, isFragment: boolean) => string;
  80533. lineProcessor?: (line: string, isFragment: boolean) => string;
  80534. preProcessor?: (code: string, defines: string[], isFragment: boolean) => string;
  80535. postProcessor?: (code: string, defines: string[], isFragment: boolean) => string;
  80536. }
  80537. }
  80538. declare module BABYLON {
  80539. /** @hidden */
  80540. export interface ProcessingOptions {
  80541. defines: string[];
  80542. indexParameters: any;
  80543. isFragment: boolean;
  80544. shouldUseHighPrecisionShader: boolean;
  80545. supportsUniformBuffers: boolean;
  80546. shadersRepository: string;
  80547. includesShadersStore: {
  80548. [key: string]: string;
  80549. };
  80550. processor?: IShaderProcessor;
  80551. version: string;
  80552. platformName: string;
  80553. lookForClosingBracketForUniformBuffer?: boolean;
  80554. }
  80555. }
  80556. declare module BABYLON {
  80557. /** @hidden */
  80558. export class ShaderCodeNode {
  80559. line: string;
  80560. children: ShaderCodeNode[];
  80561. additionalDefineKey?: string;
  80562. additionalDefineValue?: string;
  80563. isValid(preprocessors: {
  80564. [key: string]: string;
  80565. }): boolean;
  80566. process(preprocessors: {
  80567. [key: string]: string;
  80568. }, options: ProcessingOptions): string;
  80569. }
  80570. }
  80571. declare module BABYLON {
  80572. /** @hidden */
  80573. export class ShaderCodeCursor {
  80574. private _lines;
  80575. lineIndex: number;
  80576. get currentLine(): string;
  80577. get canRead(): boolean;
  80578. set lines(value: string[]);
  80579. }
  80580. }
  80581. declare module BABYLON {
  80582. /** @hidden */
  80583. export class ShaderCodeConditionNode extends ShaderCodeNode {
  80584. process(preprocessors: {
  80585. [key: string]: string;
  80586. }, options: ProcessingOptions): string;
  80587. }
  80588. }
  80589. declare module BABYLON {
  80590. /** @hidden */
  80591. export class ShaderDefineExpression {
  80592. isTrue(preprocessors: {
  80593. [key: string]: string;
  80594. }): boolean;
  80595. private static _OperatorPriority;
  80596. private static _Stack;
  80597. static postfixToInfix(postfix: string[]): string;
  80598. static infixToPostfix(infix: string): string[];
  80599. }
  80600. }
  80601. declare module BABYLON {
  80602. /** @hidden */
  80603. export class ShaderCodeTestNode extends ShaderCodeNode {
  80604. testExpression: ShaderDefineExpression;
  80605. isValid(preprocessors: {
  80606. [key: string]: string;
  80607. }): boolean;
  80608. }
  80609. }
  80610. declare module BABYLON {
  80611. /** @hidden */
  80612. export class ShaderDefineIsDefinedOperator extends ShaderDefineExpression {
  80613. define: string;
  80614. not: boolean;
  80615. constructor(define: string, not?: boolean);
  80616. isTrue(preprocessors: {
  80617. [key: string]: string;
  80618. }): boolean;
  80619. }
  80620. }
  80621. declare module BABYLON {
  80622. /** @hidden */
  80623. export class ShaderDefineOrOperator extends ShaderDefineExpression {
  80624. leftOperand: ShaderDefineExpression;
  80625. rightOperand: ShaderDefineExpression;
  80626. isTrue(preprocessors: {
  80627. [key: string]: string;
  80628. }): boolean;
  80629. }
  80630. }
  80631. declare module BABYLON {
  80632. /** @hidden */
  80633. export class ShaderDefineAndOperator extends ShaderDefineExpression {
  80634. leftOperand: ShaderDefineExpression;
  80635. rightOperand: ShaderDefineExpression;
  80636. isTrue(preprocessors: {
  80637. [key: string]: string;
  80638. }): boolean;
  80639. }
  80640. }
  80641. declare module BABYLON {
  80642. /** @hidden */
  80643. export class ShaderDefineArithmeticOperator extends ShaderDefineExpression {
  80644. define: string;
  80645. operand: string;
  80646. testValue: string;
  80647. constructor(define: string, operand: string, testValue: string);
  80648. isTrue(preprocessors: {
  80649. [key: string]: string;
  80650. }): boolean;
  80651. }
  80652. }
  80653. declare module BABYLON {
  80654. /**
  80655. * Class used to enable access to offline support
  80656. * @see https://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  80657. */
  80658. export interface IOfflineProvider {
  80659. /**
  80660. * Gets a boolean indicating if scene must be saved in the database
  80661. */
  80662. enableSceneOffline: boolean;
  80663. /**
  80664. * Gets a boolean indicating if textures must be saved in the database
  80665. */
  80666. enableTexturesOffline: boolean;
  80667. /**
  80668. * Open the offline support and make it available
  80669. * @param successCallback defines the callback to call on success
  80670. * @param errorCallback defines the callback to call on error
  80671. */
  80672. open(successCallback: () => void, errorCallback: () => void): void;
  80673. /**
  80674. * Loads an image from the offline support
  80675. * @param url defines the url to load from
  80676. * @param image defines the target DOM image
  80677. */
  80678. loadImage(url: string, image: HTMLImageElement): void;
  80679. /**
  80680. * Loads a file from offline support
  80681. * @param url defines the URL to load from
  80682. * @param sceneLoaded defines a callback to call on success
  80683. * @param progressCallBack defines a callback to call when progress changed
  80684. * @param errorCallback defines a callback to call on error
  80685. * @param useArrayBuffer defines a boolean to use array buffer instead of text string
  80686. */
  80687. loadFile(url: string, sceneLoaded: (data: any) => void, progressCallBack?: (data: any) => void, errorCallback?: () => void, useArrayBuffer?: boolean): void;
  80688. }
  80689. }
  80690. declare module BABYLON {
  80691. /**
  80692. * Class used to help managing file picking and drag'n'drop
  80693. * File Storage
  80694. */
  80695. export class FilesInputStore {
  80696. /**
  80697. * List of files ready to be loaded
  80698. */
  80699. static FilesToLoad: {
  80700. [key: string]: File;
  80701. };
  80702. }
  80703. }
  80704. declare module BABYLON {
  80705. /**
  80706. * Class used to define a retry strategy when error happens while loading assets
  80707. */
  80708. export class RetryStrategy {
  80709. /**
  80710. * Function used to defines an exponential back off strategy
  80711. * @param maxRetries defines the maximum number of retries (3 by default)
  80712. * @param baseInterval defines the interval between retries
  80713. * @returns the strategy function to use
  80714. */
  80715. static ExponentialBackoff(maxRetries?: number, baseInterval?: number): (url: string, request: WebRequest, retryIndex: number) => number;
  80716. }
  80717. }
  80718. declare module BABYLON {
  80719. /**
  80720. * @ignore
  80721. * Application error to support additional information when loading a file
  80722. */
  80723. export abstract class BaseError extends Error {
  80724. protected static _setPrototypeOf: (o: any, proto: object | null) => any;
  80725. }
  80726. }
  80727. declare module BABYLON {
  80728. /** @ignore */
  80729. export class LoadFileError extends BaseError {
  80730. request?: WebRequest;
  80731. file?: File;
  80732. /**
  80733. * Creates a new LoadFileError
  80734. * @param message defines the message of the error
  80735. * @param request defines the optional web request
  80736. * @param file defines the optional file
  80737. */
  80738. constructor(message: string, object?: WebRequest | File);
  80739. }
  80740. /** @ignore */
  80741. export class RequestFileError extends BaseError {
  80742. request: WebRequest;
  80743. /**
  80744. * Creates a new LoadFileError
  80745. * @param message defines the message of the error
  80746. * @param request defines the optional web request
  80747. */
  80748. constructor(message: string, request: WebRequest);
  80749. }
  80750. /** @ignore */
  80751. export class ReadFileError extends BaseError {
  80752. file: File;
  80753. /**
  80754. * Creates a new ReadFileError
  80755. * @param message defines the message of the error
  80756. * @param file defines the optional file
  80757. */
  80758. constructor(message: string, file: File);
  80759. }
  80760. /**
  80761. * @hidden
  80762. */
  80763. export class FileTools {
  80764. /**
  80765. * Gets or sets the retry strategy to apply when an error happens while loading an asset
  80766. */
  80767. static DefaultRetryStrategy: (url: string, request: WebRequest, retryIndex: number) => number;
  80768. /**
  80769. * Gets or sets the base URL to use to load assets
  80770. */
  80771. static BaseUrl: string;
  80772. /**
  80773. * Default behaviour for cors in the application.
  80774. * It can be a string if the expected behavior is identical in the entire app.
  80775. * Or a callback to be able to set it per url or on a group of them (in case of Video source for instance)
  80776. */
  80777. static CorsBehavior: string | ((url: string | string[]) => string);
  80778. /**
  80779. * Gets or sets a function used to pre-process url before using them to load assets
  80780. */
  80781. static PreprocessUrl: (url: string) => string;
  80782. /**
  80783. * Removes unwanted characters from an url
  80784. * @param url defines the url to clean
  80785. * @returns the cleaned url
  80786. */
  80787. private static _CleanUrl;
  80788. /**
  80789. * Sets the cors behavior on a dom element. This will add the required Tools.CorsBehavior to the element.
  80790. * @param url define the url we are trying
  80791. * @param element define the dom element where to configure the cors policy
  80792. */
  80793. static SetCorsBehavior(url: string | string[], element: {
  80794. crossOrigin: string | null;
  80795. }): void;
  80796. /**
  80797. * Loads an image as an HTMLImageElement.
  80798. * @param input url string, ArrayBuffer, or Blob to load
  80799. * @param onLoad callback called when the image successfully loads
  80800. * @param onError callback called when the image fails to load
  80801. * @param offlineProvider offline provider for caching
  80802. * @param mimeType optional mime type
  80803. * @returns the HTMLImageElement of the loaded image
  80804. */
  80805. 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>;
  80806. /**
  80807. * Reads a file from a File object
  80808. * @param file defines the file to load
  80809. * @param onSuccess defines the callback to call when data is loaded
  80810. * @param onProgress defines the callback to call during loading process
  80811. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  80812. * @param onError defines the callback to call when an error occurs
  80813. * @returns a file request object
  80814. */
  80815. static ReadFile(file: File, onSuccess: (data: any) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  80816. /**
  80817. * Loads a file from a url
  80818. * @param url url to load
  80819. * @param onSuccess callback called when the file successfully loads
  80820. * @param onProgress callback called while file is loading (if the server supports this mode)
  80821. * @param offlineProvider defines the offline provider for caching
  80822. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  80823. * @param onError callback called when the file fails to load
  80824. * @returns a file request object
  80825. */
  80826. 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;
  80827. /**
  80828. * Loads a file
  80829. * @param url url to load
  80830. * @param onSuccess callback called when the file successfully loads
  80831. * @param onProgress callback called while file is loading (if the server supports this mode)
  80832. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  80833. * @param onError callback called when the file fails to load
  80834. * @param onOpened callback called when the web request is opened
  80835. * @returns a file request object
  80836. */
  80837. 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;
  80838. /**
  80839. * Checks if the loaded document was accessed via `file:`-Protocol.
  80840. * @returns boolean
  80841. */
  80842. static IsFileURL(): boolean;
  80843. }
  80844. }
  80845. declare module BABYLON {
  80846. /** @hidden */
  80847. export class ShaderProcessor {
  80848. static Process(sourceCode: string, options: ProcessingOptions, callback: (migratedCode: string) => void): void;
  80849. private static _ProcessPrecision;
  80850. private static _ExtractOperation;
  80851. private static _BuildSubExpression;
  80852. private static _BuildExpression;
  80853. private static _MoveCursorWithinIf;
  80854. private static _MoveCursor;
  80855. private static _EvaluatePreProcessors;
  80856. private static _PreparePreProcessors;
  80857. private static _ProcessShaderConversion;
  80858. private static _ProcessIncludes;
  80859. /**
  80860. * Loads a file from a url
  80861. * @param url url to load
  80862. * @param onSuccess callback called when the file successfully loads
  80863. * @param onProgress callback called while file is loading (if the server supports this mode)
  80864. * @param offlineProvider defines the offline provider for caching
  80865. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  80866. * @param onError callback called when the file fails to load
  80867. * @returns a file request object
  80868. * @hidden
  80869. */
  80870. 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;
  80871. }
  80872. }
  80873. declare module BABYLON {
  80874. /**
  80875. * @hidden
  80876. */
  80877. export interface IColor4Like {
  80878. r: float;
  80879. g: float;
  80880. b: float;
  80881. a: float;
  80882. }
  80883. /**
  80884. * @hidden
  80885. */
  80886. export interface IColor3Like {
  80887. r: float;
  80888. g: float;
  80889. b: float;
  80890. }
  80891. /**
  80892. * @hidden
  80893. */
  80894. export interface IVector4Like {
  80895. x: float;
  80896. y: float;
  80897. z: float;
  80898. w: float;
  80899. }
  80900. /**
  80901. * @hidden
  80902. */
  80903. export interface IVector3Like {
  80904. x: float;
  80905. y: float;
  80906. z: float;
  80907. }
  80908. /**
  80909. * @hidden
  80910. */
  80911. export interface IVector2Like {
  80912. x: float;
  80913. y: float;
  80914. }
  80915. /**
  80916. * @hidden
  80917. */
  80918. export interface IMatrixLike {
  80919. toArray(): DeepImmutable<Float32Array | Array<number>>;
  80920. updateFlag: int;
  80921. }
  80922. /**
  80923. * @hidden
  80924. */
  80925. export interface IViewportLike {
  80926. x: float;
  80927. y: float;
  80928. width: float;
  80929. height: float;
  80930. }
  80931. /**
  80932. * @hidden
  80933. */
  80934. export interface IPlaneLike {
  80935. normal: IVector3Like;
  80936. d: float;
  80937. normalize(): void;
  80938. }
  80939. }
  80940. declare module BABYLON {
  80941. /**
  80942. * Interface used to define common properties for effect fallbacks
  80943. */
  80944. export interface IEffectFallbacks {
  80945. /**
  80946. * Removes the defines that should be removed when falling back.
  80947. * @param currentDefines defines the current define statements for the shader.
  80948. * @param effect defines the current effect we try to compile
  80949. * @returns The resulting defines with defines of the current rank removed.
  80950. */
  80951. reduce(currentDefines: string, effect: Effect): string;
  80952. /**
  80953. * Removes the fallback from the bound mesh.
  80954. */
  80955. unBindMesh(): void;
  80956. /**
  80957. * Checks to see if more fallbacks are still availible.
  80958. */
  80959. hasMoreFallbacks: boolean;
  80960. }
  80961. }
  80962. declare module BABYLON {
  80963. /**
  80964. * Class used to evalaute queries containing `and` and `or` operators
  80965. */
  80966. export class AndOrNotEvaluator {
  80967. /**
  80968. * Evaluate a query
  80969. * @param query defines the query to evaluate
  80970. * @param evaluateCallback defines the callback used to filter result
  80971. * @returns true if the query matches
  80972. */
  80973. static Eval(query: string, evaluateCallback: (val: any) => boolean): boolean;
  80974. private static _HandleParenthesisContent;
  80975. private static _SimplifyNegation;
  80976. }
  80977. }
  80978. declare module BABYLON {
  80979. /**
  80980. * Class used to store custom tags
  80981. */
  80982. export class Tags {
  80983. /**
  80984. * Adds support for tags on the given object
  80985. * @param obj defines the object to use
  80986. */
  80987. static EnableFor(obj: any): void;
  80988. /**
  80989. * Removes tags support
  80990. * @param obj defines the object to use
  80991. */
  80992. static DisableFor(obj: any): void;
  80993. /**
  80994. * Gets a boolean indicating if the given object has tags
  80995. * @param obj defines the object to use
  80996. * @returns a boolean
  80997. */
  80998. static HasTags(obj: any): boolean;
  80999. /**
  81000. * Gets the tags available on a given object
  81001. * @param obj defines the object to use
  81002. * @param asString defines if the tags must be returned as a string instead of an array of strings
  81003. * @returns the tags
  81004. */
  81005. static GetTags(obj: any, asString?: boolean): any;
  81006. /**
  81007. * Adds tags to an object
  81008. * @param obj defines the object to use
  81009. * @param tagsString defines the tag string. The tags 'true' and 'false' are reserved and cannot be used as tags.
  81010. * A tag cannot start with '||', '&&', and '!'. It cannot contain whitespaces
  81011. */
  81012. static AddTagsTo(obj: any, tagsString: string): void;
  81013. /**
  81014. * @hidden
  81015. */
  81016. static _AddTagTo(obj: any, tag: string): void;
  81017. /**
  81018. * Removes specific tags from a specific object
  81019. * @param obj defines the object to use
  81020. * @param tagsString defines the tags to remove
  81021. */
  81022. static RemoveTagsFrom(obj: any, tagsString: string): void;
  81023. /**
  81024. * @hidden
  81025. */
  81026. static _RemoveTagFrom(obj: any, tag: string): void;
  81027. /**
  81028. * Defines if tags hosted on an object match a given query
  81029. * @param obj defines the object to use
  81030. * @param tagsQuery defines the tag query
  81031. * @returns a boolean
  81032. */
  81033. static MatchesQuery(obj: any, tagsQuery: string): boolean;
  81034. }
  81035. }
  81036. declare module BABYLON {
  81037. /**
  81038. * Scalar computation library
  81039. */
  81040. export class Scalar {
  81041. /**
  81042. * Two pi constants convenient for computation.
  81043. */
  81044. static TwoPi: number;
  81045. /**
  81046. * Boolean : true if the absolute difference between a and b is lower than epsilon (default = 1.401298E-45)
  81047. * @param a number
  81048. * @param b number
  81049. * @param epsilon (default = 1.401298E-45)
  81050. * @returns true if the absolute difference between a and b is lower than epsilon (default = 1.401298E-45)
  81051. */
  81052. static WithinEpsilon(a: number, b: number, epsilon?: number): boolean;
  81053. /**
  81054. * Returns a string : the upper case translation of the number i to hexadecimal.
  81055. * @param i number
  81056. * @returns the upper case translation of the number i to hexadecimal.
  81057. */
  81058. static ToHex(i: number): string;
  81059. /**
  81060. * Returns -1 if value is negative and +1 is value is positive.
  81061. * @param value the value
  81062. * @returns the value itself if it's equal to zero.
  81063. */
  81064. static Sign(value: number): number;
  81065. /**
  81066. * Returns the value itself if it's between min and max.
  81067. * Returns min if the value is lower than min.
  81068. * Returns max if the value is greater than max.
  81069. * @param value the value to clmap
  81070. * @param min the min value to clamp to (default: 0)
  81071. * @param max the max value to clamp to (default: 1)
  81072. * @returns the clamped value
  81073. */
  81074. static Clamp(value: number, min?: number, max?: number): number;
  81075. /**
  81076. * the log2 of value.
  81077. * @param value the value to compute log2 of
  81078. * @returns the log2 of value.
  81079. */
  81080. static Log2(value: number): number;
  81081. /**
  81082. * Loops the value, so that it is never larger than length and never smaller than 0.
  81083. *
  81084. * This is similar to the modulo operator but it works with floating point numbers.
  81085. * For example, using 3.0 for t and 2.5 for length, the result would be 0.5.
  81086. * With t = 5 and length = 2.5, the result would be 0.0.
  81087. * Note, however, that the behaviour is not defined for negative numbers as it is for the modulo operator
  81088. * @param value the value
  81089. * @param length the length
  81090. * @returns the looped value
  81091. */
  81092. static Repeat(value: number, length: number): number;
  81093. /**
  81094. * Normalize the value between 0.0 and 1.0 using min and max values
  81095. * @param value value to normalize
  81096. * @param min max to normalize between
  81097. * @param max min to normalize between
  81098. * @returns the normalized value
  81099. */
  81100. static Normalize(value: number, min: number, max: number): number;
  81101. /**
  81102. * Denormalize the value from 0.0 and 1.0 using min and max values
  81103. * @param normalized value to denormalize
  81104. * @param min max to denormalize between
  81105. * @param max min to denormalize between
  81106. * @returns the denormalized value
  81107. */
  81108. static Denormalize(normalized: number, min: number, max: number): number;
  81109. /**
  81110. * Calculates the shortest difference between two given angles given in degrees.
  81111. * @param current current angle in degrees
  81112. * @param target target angle in degrees
  81113. * @returns the delta
  81114. */
  81115. static DeltaAngle(current: number, target: number): number;
  81116. /**
  81117. * PingPongs the value t, so that it is never larger than length and never smaller than 0.
  81118. * @param tx value
  81119. * @param length length
  81120. * @returns The returned value will move back and forth between 0 and length
  81121. */
  81122. static PingPong(tx: number, length: number): number;
  81123. /**
  81124. * Interpolates between min and max with smoothing at the limits.
  81125. *
  81126. * This function interpolates between min and max in a similar way to Lerp. However, the interpolation will gradually speed up
  81127. * from the start and slow down toward the end. This is useful for creating natural-looking animation, fading and other transitions.
  81128. * @param from from
  81129. * @param to to
  81130. * @param tx value
  81131. * @returns the smooth stepped value
  81132. */
  81133. static SmoothStep(from: number, to: number, tx: number): number;
  81134. /**
  81135. * Moves a value current towards target.
  81136. *
  81137. * This is essentially the same as Mathf.Lerp but instead the function will ensure that the speed never exceeds maxDelta.
  81138. * Negative values of maxDelta pushes the value away from target.
  81139. * @param current current value
  81140. * @param target target value
  81141. * @param maxDelta max distance to move
  81142. * @returns resulting value
  81143. */
  81144. static MoveTowards(current: number, target: number, maxDelta: number): number;
  81145. /**
  81146. * Same as MoveTowards but makes sure the values interpolate correctly when they wrap around 360 degrees.
  81147. *
  81148. * Variables current and target are assumed to be in degrees. For optimization reasons, negative values of maxDelta
  81149. * are not supported and may cause oscillation. To push current away from a target angle, add 180 to that angle instead.
  81150. * @param current current value
  81151. * @param target target value
  81152. * @param maxDelta max distance to move
  81153. * @returns resulting angle
  81154. */
  81155. static MoveTowardsAngle(current: number, target: number, maxDelta: number): number;
  81156. /**
  81157. * Creates a new scalar with values linearly interpolated of "amount" between the start scalar and the end scalar.
  81158. * @param start start value
  81159. * @param end target value
  81160. * @param amount amount to lerp between
  81161. * @returns the lerped value
  81162. */
  81163. static Lerp(start: number, end: number, amount: number): number;
  81164. /**
  81165. * Same as Lerp but makes sure the values interpolate correctly when they wrap around 360 degrees.
  81166. * The parameter t is clamped to the range [0, 1]. Variables a and b are assumed to be in degrees.
  81167. * @param start start value
  81168. * @param end target value
  81169. * @param amount amount to lerp between
  81170. * @returns the lerped value
  81171. */
  81172. static LerpAngle(start: number, end: number, amount: number): number;
  81173. /**
  81174. * Calculates the linear parameter t that produces the interpolant value within the range [a, b].
  81175. * @param a start value
  81176. * @param b target value
  81177. * @param value value between a and b
  81178. * @returns the inverseLerp value
  81179. */
  81180. static InverseLerp(a: number, b: number, value: number): number;
  81181. /**
  81182. * Returns a new scalar located for "amount" (float) on the Hermite spline defined by the scalars "value1", "value3", "tangent1", "tangent2".
  81183. * @see http://mathworld.wolfram.com/HermitePolynomial.html
  81184. * @param value1 spline value
  81185. * @param tangent1 spline value
  81186. * @param value2 spline value
  81187. * @param tangent2 spline value
  81188. * @param amount input value
  81189. * @returns hermite result
  81190. */
  81191. static Hermite(value1: number, tangent1: number, value2: number, tangent2: number, amount: number): number;
  81192. /**
  81193. * Returns a random float number between and min and max values
  81194. * @param min min value of random
  81195. * @param max max value of random
  81196. * @returns random value
  81197. */
  81198. static RandomRange(min: number, max: number): number;
  81199. /**
  81200. * This function returns percentage of a number in a given range.
  81201. *
  81202. * RangeToPercent(40,20,60) will return 0.5 (50%)
  81203. * RangeToPercent(34,0,100) will return 0.34 (34%)
  81204. * @param number to convert to percentage
  81205. * @param min min range
  81206. * @param max max range
  81207. * @returns the percentage
  81208. */
  81209. static RangeToPercent(number: number, min: number, max: number): number;
  81210. /**
  81211. * This function returns number that corresponds to the percentage in a given range.
  81212. *
  81213. * PercentToRange(0.34,0,100) will return 34.
  81214. * @param percent to convert to number
  81215. * @param min min range
  81216. * @param max max range
  81217. * @returns the number
  81218. */
  81219. static PercentToRange(percent: number, min: number, max: number): number;
  81220. /**
  81221. * Returns the angle converted to equivalent value between -Math.PI and Math.PI radians.
  81222. * @param angle The angle to normalize in radian.
  81223. * @return The converted angle.
  81224. */
  81225. static NormalizeRadians(angle: number): number;
  81226. }
  81227. }
  81228. declare module BABYLON {
  81229. /**
  81230. * Constant used to convert a value to gamma space
  81231. * @ignorenaming
  81232. */
  81233. export const ToGammaSpace: number;
  81234. /**
  81235. * Constant used to convert a value to linear space
  81236. * @ignorenaming
  81237. */
  81238. export const ToLinearSpace = 2.2;
  81239. /**
  81240. * Constant used to define the minimal number value in Babylon.js
  81241. * @ignorenaming
  81242. */
  81243. let Epsilon: number;
  81244. }
  81245. declare module BABYLON {
  81246. /**
  81247. * Class used to represent a viewport on screen
  81248. */
  81249. export class Viewport {
  81250. /** viewport left coordinate */
  81251. x: number;
  81252. /** viewport top coordinate */
  81253. y: number;
  81254. /**viewport width */
  81255. width: number;
  81256. /** viewport height */
  81257. height: number;
  81258. /**
  81259. * Creates a Viewport object located at (x, y) and sized (width, height)
  81260. * @param x defines viewport left coordinate
  81261. * @param y defines viewport top coordinate
  81262. * @param width defines the viewport width
  81263. * @param height defines the viewport height
  81264. */
  81265. constructor(
  81266. /** viewport left coordinate */
  81267. x: number,
  81268. /** viewport top coordinate */
  81269. y: number,
  81270. /**viewport width */
  81271. width: number,
  81272. /** viewport height */
  81273. height: number);
  81274. /**
  81275. * Creates a new viewport using absolute sizing (from 0-> width, 0-> height instead of 0->1)
  81276. * @param renderWidth defines the rendering width
  81277. * @param renderHeight defines the rendering height
  81278. * @returns a new Viewport
  81279. */
  81280. toGlobal(renderWidth: number, renderHeight: number): Viewport;
  81281. /**
  81282. * Stores absolute viewport value into a target viewport (from 0-> width, 0-> height instead of 0->1)
  81283. * @param renderWidth defines the rendering width
  81284. * @param renderHeight defines the rendering height
  81285. * @param ref defines the target viewport
  81286. * @returns the current viewport
  81287. */
  81288. toGlobalToRef(renderWidth: number, renderHeight: number, ref: Viewport): Viewport;
  81289. /**
  81290. * Returns a new Viewport copied from the current one
  81291. * @returns a new Viewport
  81292. */
  81293. clone(): Viewport;
  81294. }
  81295. }
  81296. declare module BABYLON {
  81297. /**
  81298. * Class containing a set of static utilities functions for arrays.
  81299. */
  81300. export class ArrayTools {
  81301. /**
  81302. * Returns an array of the given size filled with element built from the given constructor and the paramters
  81303. * @param size the number of element to construct and put in the array
  81304. * @param itemBuilder a callback responsible for creating new instance of item. Called once per array entry.
  81305. * @returns a new array filled with new objects
  81306. */
  81307. static BuildArray<T>(size: number, itemBuilder: () => T): Array<T>;
  81308. }
  81309. }
  81310. declare module BABYLON {
  81311. /**
  81312. * Represents a plane by the equation ax + by + cz + d = 0
  81313. */
  81314. export class Plane {
  81315. private static _TmpMatrix;
  81316. /**
  81317. * Normal of the plane (a,b,c)
  81318. */
  81319. normal: Vector3;
  81320. /**
  81321. * d component of the plane
  81322. */
  81323. d: number;
  81324. /**
  81325. * Creates a Plane object according to the given floats a, b, c, d and the plane equation : ax + by + cz + d = 0
  81326. * @param a a component of the plane
  81327. * @param b b component of the plane
  81328. * @param c c component of the plane
  81329. * @param d d component of the plane
  81330. */
  81331. constructor(a: number, b: number, c: number, d: number);
  81332. /**
  81333. * @returns the plane coordinates as a new array of 4 elements [a, b, c, d].
  81334. */
  81335. asArray(): number[];
  81336. /**
  81337. * @returns a new plane copied from the current Plane.
  81338. */
  81339. clone(): Plane;
  81340. /**
  81341. * @returns the string "Plane".
  81342. */
  81343. getClassName(): string;
  81344. /**
  81345. * @returns the Plane hash code.
  81346. */
  81347. getHashCode(): number;
  81348. /**
  81349. * Normalize the current Plane in place.
  81350. * @returns the updated Plane.
  81351. */
  81352. normalize(): Plane;
  81353. /**
  81354. * Applies a transformation the plane and returns the result
  81355. * @param transformation the transformation matrix to be applied to the plane
  81356. * @returns a new Plane as the result of the transformation of the current Plane by the given matrix.
  81357. */
  81358. transform(transformation: DeepImmutable<Matrix>): Plane;
  81359. /**
  81360. * Compute the dot product between the point and the plane normal
  81361. * @param point point to calculate the dot product with
  81362. * @returns the dot product (float) of the point coordinates and the plane normal.
  81363. */
  81364. dotCoordinate(point: DeepImmutable<Vector3>): number;
  81365. /**
  81366. * Updates the current Plane from the plane defined by the three given points.
  81367. * @param point1 one of the points used to contruct the plane
  81368. * @param point2 one of the points used to contruct the plane
  81369. * @param point3 one of the points used to contruct the plane
  81370. * @returns the updated Plane.
  81371. */
  81372. copyFromPoints(point1: DeepImmutable<Vector3>, point2: DeepImmutable<Vector3>, point3: DeepImmutable<Vector3>): Plane;
  81373. /**
  81374. * Checks if the plane is facing a given direction
  81375. * @param direction the direction to check if the plane is facing
  81376. * @param epsilon value the dot product is compared against (returns true if dot <= epsilon)
  81377. * @returns True is the vector "direction" is the same side than the plane normal.
  81378. */
  81379. isFrontFacingTo(direction: DeepImmutable<Vector3>, epsilon: number): boolean;
  81380. /**
  81381. * Calculates the distance to a point
  81382. * @param point point to calculate distance to
  81383. * @returns the signed distance (float) from the given point to the Plane.
  81384. */
  81385. signedDistanceTo(point: DeepImmutable<Vector3>): number;
  81386. /**
  81387. * Creates a plane from an array
  81388. * @param array the array to create a plane from
  81389. * @returns a new Plane from the given array.
  81390. */
  81391. static FromArray(array: DeepImmutable<ArrayLike<number>>): Plane;
  81392. /**
  81393. * Creates a plane from three points
  81394. * @param point1 point used to create the plane
  81395. * @param point2 point used to create the plane
  81396. * @param point3 point used to create the plane
  81397. * @returns a new Plane defined by the three given points.
  81398. */
  81399. static FromPoints(point1: DeepImmutable<Vector3>, point2: DeepImmutable<Vector3>, point3: DeepImmutable<Vector3>): Plane;
  81400. /**
  81401. * Creates a plane from an origin point and a normal
  81402. * @param origin origin of the plane to be constructed
  81403. * @param normal normal of the plane to be constructed
  81404. * @returns a new Plane the normal vector to this plane at the given origin point.
  81405. * Note : the vector "normal" is updated because normalized.
  81406. */
  81407. static FromPositionAndNormal(origin: DeepImmutable<Vector3>, normal: Vector3): Plane;
  81408. /**
  81409. * Calculates the distance from a plane and a point
  81410. * @param origin origin of the plane to be constructed
  81411. * @param normal normal of the plane to be constructed
  81412. * @param point point to calculate distance to
  81413. * @returns the signed distance between the plane defined by the normal vector at the "origin"" point and the given other point.
  81414. */
  81415. static SignedDistanceToPlaneFromPositionAndNormal(origin: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>, point: DeepImmutable<Vector3>): number;
  81416. }
  81417. }
  81418. declare module BABYLON {
  81419. /** @hidden */
  81420. export class PerformanceConfigurator {
  81421. /** @hidden */
  81422. static MatrixUse64Bits: boolean;
  81423. /** @hidden */
  81424. static MatrixTrackPrecisionChange: boolean;
  81425. /** @hidden */
  81426. static MatrixCurrentType: any;
  81427. /** @hidden */
  81428. static MatrixTrackedMatrices: Array<any> | null;
  81429. /** @hidden */
  81430. static SetMatrixPrecision(use64bits: boolean): void;
  81431. }
  81432. }
  81433. declare module BABYLON {
  81434. /**
  81435. * Class representing a vector containing 2 coordinates
  81436. */
  81437. export class Vector2 {
  81438. /** defines the first coordinate */
  81439. x: number;
  81440. /** defines the second coordinate */
  81441. y: number;
  81442. /**
  81443. * Creates a new Vector2 from the given x and y coordinates
  81444. * @param x defines the first coordinate
  81445. * @param y defines the second coordinate
  81446. */
  81447. constructor(
  81448. /** defines the first coordinate */
  81449. x?: number,
  81450. /** defines the second coordinate */
  81451. y?: number);
  81452. /**
  81453. * Gets a string with the Vector2 coordinates
  81454. * @returns a string with the Vector2 coordinates
  81455. */
  81456. toString(): string;
  81457. /**
  81458. * Gets class name
  81459. * @returns the string "Vector2"
  81460. */
  81461. getClassName(): string;
  81462. /**
  81463. * Gets current vector hash code
  81464. * @returns the Vector2 hash code as a number
  81465. */
  81466. getHashCode(): number;
  81467. /**
  81468. * Sets the Vector2 coordinates in the given array or Float32Array from the given index.
  81469. * @param array defines the source array
  81470. * @param index defines the offset in source array
  81471. * @returns the current Vector2
  81472. */
  81473. toArray(array: FloatArray, index?: number): Vector2;
  81474. /**
  81475. * Update the current vector from an array
  81476. * @param array defines the destination array
  81477. * @param index defines the offset in the destination array
  81478. * @returns the current Vector3
  81479. */
  81480. fromArray(array: FloatArray, index?: number): Vector2;
  81481. /**
  81482. * Copy the current vector to an array
  81483. * @returns a new array with 2 elements: the Vector2 coordinates.
  81484. */
  81485. asArray(): number[];
  81486. /**
  81487. * Sets the Vector2 coordinates with the given Vector2 coordinates
  81488. * @param source defines the source Vector2
  81489. * @returns the current updated Vector2
  81490. */
  81491. copyFrom(source: DeepImmutable<Vector2>): Vector2;
  81492. /**
  81493. * Sets the Vector2 coordinates with the given floats
  81494. * @param x defines the first coordinate
  81495. * @param y defines the second coordinate
  81496. * @returns the current updated Vector2
  81497. */
  81498. copyFromFloats(x: number, y: number): Vector2;
  81499. /**
  81500. * Sets the Vector2 coordinates with the given floats
  81501. * @param x defines the first coordinate
  81502. * @param y defines the second coordinate
  81503. * @returns the current updated Vector2
  81504. */
  81505. set(x: number, y: number): Vector2;
  81506. /**
  81507. * Add another vector with the current one
  81508. * @param otherVector defines the other vector
  81509. * @returns a new Vector2 set with the addition of the current Vector2 and the given one coordinates
  81510. */
  81511. add(otherVector: DeepImmutable<Vector2>): Vector2;
  81512. /**
  81513. * Sets the "result" coordinates with the addition of the current Vector2 and the given one coordinates
  81514. * @param otherVector defines the other vector
  81515. * @param result defines the target vector
  81516. * @returns the unmodified current Vector2
  81517. */
  81518. addToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  81519. /**
  81520. * Set the Vector2 coordinates by adding the given Vector2 coordinates
  81521. * @param otherVector defines the other vector
  81522. * @returns the current updated Vector2
  81523. */
  81524. addInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  81525. /**
  81526. * Gets a new Vector2 by adding the current Vector2 coordinates to the given Vector3 x, y coordinates
  81527. * @param otherVector defines the other vector
  81528. * @returns a new Vector2
  81529. */
  81530. addVector3(otherVector: Vector3): Vector2;
  81531. /**
  81532. * Gets a new Vector2 set with the subtracted coordinates of the given one from the current Vector2
  81533. * @param otherVector defines the other vector
  81534. * @returns a new Vector2
  81535. */
  81536. subtract(otherVector: Vector2): Vector2;
  81537. /**
  81538. * Sets the "result" coordinates with the subtraction of the given one from the current Vector2 coordinates.
  81539. * @param otherVector defines the other vector
  81540. * @param result defines the target vector
  81541. * @returns the unmodified current Vector2
  81542. */
  81543. subtractToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  81544. /**
  81545. * Sets the current Vector2 coordinates by subtracting from it the given one coordinates
  81546. * @param otherVector defines the other vector
  81547. * @returns the current updated Vector2
  81548. */
  81549. subtractInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  81550. /**
  81551. * Multiplies in place the current Vector2 coordinates by the given ones
  81552. * @param otherVector defines the other vector
  81553. * @returns the current updated Vector2
  81554. */
  81555. multiplyInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  81556. /**
  81557. * Returns a new Vector2 set with the multiplication of the current Vector2 and the given one coordinates
  81558. * @param otherVector defines the other vector
  81559. * @returns a new Vector2
  81560. */
  81561. multiply(otherVector: DeepImmutable<Vector2>): Vector2;
  81562. /**
  81563. * Sets "result" coordinates with the multiplication of the current Vector2 and the given one coordinates
  81564. * @param otherVector defines the other vector
  81565. * @param result defines the target vector
  81566. * @returns the unmodified current Vector2
  81567. */
  81568. multiplyToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  81569. /**
  81570. * Gets a new Vector2 set with the Vector2 coordinates multiplied by the given floats
  81571. * @param x defines the first coordinate
  81572. * @param y defines the second coordinate
  81573. * @returns a new Vector2
  81574. */
  81575. multiplyByFloats(x: number, y: number): Vector2;
  81576. /**
  81577. * Returns a new Vector2 set with the Vector2 coordinates divided by the given one coordinates
  81578. * @param otherVector defines the other vector
  81579. * @returns a new Vector2
  81580. */
  81581. divide(otherVector: Vector2): Vector2;
  81582. /**
  81583. * Sets the "result" coordinates with the Vector2 divided by the given one coordinates
  81584. * @param otherVector defines the other vector
  81585. * @param result defines the target vector
  81586. * @returns the unmodified current Vector2
  81587. */
  81588. divideToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  81589. /**
  81590. * Divides the current Vector2 coordinates by the given ones
  81591. * @param otherVector defines the other vector
  81592. * @returns the current updated Vector2
  81593. */
  81594. divideInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  81595. /**
  81596. * Gets a new Vector2 with current Vector2 negated coordinates
  81597. * @returns a new Vector2
  81598. */
  81599. negate(): Vector2;
  81600. /**
  81601. * Negate this vector in place
  81602. * @returns this
  81603. */
  81604. negateInPlace(): Vector2;
  81605. /**
  81606. * Negate the current Vector2 and stores the result in the given vector "result" coordinates
  81607. * @param result defines the Vector3 object where to store the result
  81608. * @returns the current Vector2
  81609. */
  81610. negateToRef(result: Vector2): Vector2;
  81611. /**
  81612. * Multiply the Vector2 coordinates by scale
  81613. * @param scale defines the scaling factor
  81614. * @returns the current updated Vector2
  81615. */
  81616. scaleInPlace(scale: number): Vector2;
  81617. /**
  81618. * Returns a new Vector2 scaled by "scale" from the current Vector2
  81619. * @param scale defines the scaling factor
  81620. * @returns a new Vector2
  81621. */
  81622. scale(scale: number): Vector2;
  81623. /**
  81624. * Scale the current Vector2 values by a factor to a given Vector2
  81625. * @param scale defines the scale factor
  81626. * @param result defines the Vector2 object where to store the result
  81627. * @returns the unmodified current Vector2
  81628. */
  81629. scaleToRef(scale: number, result: Vector2): Vector2;
  81630. /**
  81631. * Scale the current Vector2 values by a factor and add the result to a given Vector2
  81632. * @param scale defines the scale factor
  81633. * @param result defines the Vector2 object where to store the result
  81634. * @returns the unmodified current Vector2
  81635. */
  81636. scaleAndAddToRef(scale: number, result: Vector2): Vector2;
  81637. /**
  81638. * Gets a boolean if two vectors are equals
  81639. * @param otherVector defines the other vector
  81640. * @returns true if the given vector coordinates strictly equal the current Vector2 ones
  81641. */
  81642. equals(otherVector: DeepImmutable<Vector2>): boolean;
  81643. /**
  81644. * Gets a boolean if two vectors are equals (using an epsilon value)
  81645. * @param otherVector defines the other vector
  81646. * @param epsilon defines the minimal distance to consider equality
  81647. * @returns true if the given vector coordinates are close to the current ones by a distance of epsilon.
  81648. */
  81649. equalsWithEpsilon(otherVector: DeepImmutable<Vector2>, epsilon?: number): boolean;
  81650. /**
  81651. * Gets a new Vector2 from current Vector2 floored values
  81652. * @returns a new Vector2
  81653. */
  81654. floor(): Vector2;
  81655. /**
  81656. * Gets a new Vector2 from current Vector2 floored values
  81657. * @returns a new Vector2
  81658. */
  81659. fract(): Vector2;
  81660. /**
  81661. * Gets the length of the vector
  81662. * @returns the vector length (float)
  81663. */
  81664. length(): number;
  81665. /**
  81666. * Gets the vector squared length
  81667. * @returns the vector squared length (float)
  81668. */
  81669. lengthSquared(): number;
  81670. /**
  81671. * Normalize the vector
  81672. * @returns the current updated Vector2
  81673. */
  81674. normalize(): Vector2;
  81675. /**
  81676. * Gets a new Vector2 copied from the Vector2
  81677. * @returns a new Vector2
  81678. */
  81679. clone(): Vector2;
  81680. /**
  81681. * Gets a new Vector2(0, 0)
  81682. * @returns a new Vector2
  81683. */
  81684. static Zero(): Vector2;
  81685. /**
  81686. * Gets a new Vector2(1, 1)
  81687. * @returns a new Vector2
  81688. */
  81689. static One(): Vector2;
  81690. /**
  81691. * Gets a new Vector2 set from the given index element of the given array
  81692. * @param array defines the data source
  81693. * @param offset defines the offset in the data source
  81694. * @returns a new Vector2
  81695. */
  81696. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector2;
  81697. /**
  81698. * Sets "result" from the given index element of the given array
  81699. * @param array defines the data source
  81700. * @param offset defines the offset in the data source
  81701. * @param result defines the target vector
  81702. */
  81703. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector2): void;
  81704. /**
  81705. * Gets a new Vector2 located for "amount" (float) on the CatmullRom spline defined by the given four Vector2
  81706. * @param value1 defines 1st point of control
  81707. * @param value2 defines 2nd point of control
  81708. * @param value3 defines 3rd point of control
  81709. * @param value4 defines 4th point of control
  81710. * @param amount defines the interpolation factor
  81711. * @returns a new Vector2
  81712. */
  81713. static CatmullRom(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>, value3: DeepImmutable<Vector2>, value4: DeepImmutable<Vector2>, amount: number): Vector2;
  81714. /**
  81715. * 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".
  81716. * If a coordinate of "value" is lower than "min" coordinates, the returned Vector2 is given this "min" coordinate.
  81717. * If a coordinate of "value" is greater than "max" coordinates, the returned Vector2 is given this "max" coordinate
  81718. * @param value defines the value to clamp
  81719. * @param min defines the lower limit
  81720. * @param max defines the upper limit
  81721. * @returns a new Vector2
  81722. */
  81723. static Clamp(value: DeepImmutable<Vector2>, min: DeepImmutable<Vector2>, max: DeepImmutable<Vector2>): Vector2;
  81724. /**
  81725. * Returns a new Vector2 located for "amount" (float) on the Hermite spline defined by the vectors "value1", "value3", "tangent1", "tangent2"
  81726. * @param value1 defines the 1st control point
  81727. * @param tangent1 defines the outgoing tangent
  81728. * @param value2 defines the 2nd control point
  81729. * @param tangent2 defines the incoming tangent
  81730. * @param amount defines the interpolation factor
  81731. * @returns a new Vector2
  81732. */
  81733. static Hermite(value1: DeepImmutable<Vector2>, tangent1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>, tangent2: DeepImmutable<Vector2>, amount: number): Vector2;
  81734. /**
  81735. * Returns a new Vector2 located for "amount" (float) on the linear interpolation between the vector "start" adn the vector "end".
  81736. * @param start defines the start vector
  81737. * @param end defines the end vector
  81738. * @param amount defines the interpolation factor
  81739. * @returns a new Vector2
  81740. */
  81741. static Lerp(start: DeepImmutable<Vector2>, end: DeepImmutable<Vector2>, amount: number): Vector2;
  81742. /**
  81743. * Gets the dot product of the vector "left" and the vector "right"
  81744. * @param left defines first vector
  81745. * @param right defines second vector
  81746. * @returns the dot product (float)
  81747. */
  81748. static Dot(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): number;
  81749. /**
  81750. * Returns a new Vector2 equal to the normalized given vector
  81751. * @param vector defines the vector to normalize
  81752. * @returns a new Vector2
  81753. */
  81754. static Normalize(vector: DeepImmutable<Vector2>): Vector2;
  81755. /**
  81756. * Gets a new Vector2 set with the minimal coordinate values from the "left" and "right" vectors
  81757. * @param left defines 1st vector
  81758. * @param right defines 2nd vector
  81759. * @returns a new Vector2
  81760. */
  81761. static Minimize(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): Vector2;
  81762. /**
  81763. * Gets a new Vecto2 set with the maximal coordinate values from the "left" and "right" vectors
  81764. * @param left defines 1st vector
  81765. * @param right defines 2nd vector
  81766. * @returns a new Vector2
  81767. */
  81768. static Maximize(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): Vector2;
  81769. /**
  81770. * Gets a new Vector2 set with the transformed coordinates of the given vector by the given transformation matrix
  81771. * @param vector defines the vector to transform
  81772. * @param transformation defines the matrix to apply
  81773. * @returns a new Vector2
  81774. */
  81775. static Transform(vector: DeepImmutable<Vector2>, transformation: DeepImmutable<Matrix>): Vector2;
  81776. /**
  81777. * Transforms the given vector coordinates by the given transformation matrix and stores the result in the vector "result" coordinates
  81778. * @param vector defines the vector to transform
  81779. * @param transformation defines the matrix to apply
  81780. * @param result defines the target vector
  81781. */
  81782. static TransformToRef(vector: DeepImmutable<Vector2>, transformation: DeepImmutable<Matrix>, result: Vector2): void;
  81783. /**
  81784. * Determines if a given vector is included in a triangle
  81785. * @param p defines the vector to test
  81786. * @param p0 defines 1st triangle point
  81787. * @param p1 defines 2nd triangle point
  81788. * @param p2 defines 3rd triangle point
  81789. * @returns true if the point "p" is in the triangle defined by the vertors "p0", "p1", "p2"
  81790. */
  81791. static PointInTriangle(p: DeepImmutable<Vector2>, p0: DeepImmutable<Vector2>, p1: DeepImmutable<Vector2>, p2: DeepImmutable<Vector2>): boolean;
  81792. /**
  81793. * Gets the distance between the vectors "value1" and "value2"
  81794. * @param value1 defines first vector
  81795. * @param value2 defines second vector
  81796. * @returns the distance between vectors
  81797. */
  81798. static Distance(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): number;
  81799. /**
  81800. * Returns the squared distance between the vectors "value1" and "value2"
  81801. * @param value1 defines first vector
  81802. * @param value2 defines second vector
  81803. * @returns the squared distance between vectors
  81804. */
  81805. static DistanceSquared(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): number;
  81806. /**
  81807. * Gets a new Vector2 located at the center of the vectors "value1" and "value2"
  81808. * @param value1 defines first vector
  81809. * @param value2 defines second vector
  81810. * @returns a new Vector2
  81811. */
  81812. static Center(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): Vector2;
  81813. /**
  81814. * Gets the shortest distance (float) between the point "p" and the segment defined by the two points "segA" and "segB".
  81815. * @param p defines the middle point
  81816. * @param segA defines one point of the segment
  81817. * @param segB defines the other point of the segment
  81818. * @returns the shortest distance
  81819. */
  81820. static DistanceOfPointFromSegment(p: DeepImmutable<Vector2>, segA: DeepImmutable<Vector2>, segB: DeepImmutable<Vector2>): number;
  81821. }
  81822. /**
  81823. * Class used to store (x,y,z) vector representation
  81824. * A Vector3 is the main object used in 3D geometry
  81825. * It can represent etiher the coordinates of a point the space, either a direction
  81826. * Reminder: js uses a left handed forward facing system
  81827. */
  81828. export class Vector3 {
  81829. private static _UpReadOnly;
  81830. private static _ZeroReadOnly;
  81831. /** @hidden */
  81832. _x: number;
  81833. /** @hidden */
  81834. _y: number;
  81835. /** @hidden */
  81836. _z: number;
  81837. /** @hidden */
  81838. _isDirty: boolean;
  81839. /** Gets or sets the x coordinate */
  81840. get x(): number;
  81841. set x(value: number);
  81842. /** Gets or sets the y coordinate */
  81843. get y(): number;
  81844. set y(value: number);
  81845. /** Gets or sets the z coordinate */
  81846. get z(): number;
  81847. set z(value: number);
  81848. /**
  81849. * Creates a new Vector3 object from the given x, y, z (floats) coordinates.
  81850. * @param x defines the first coordinates (on X axis)
  81851. * @param y defines the second coordinates (on Y axis)
  81852. * @param z defines the third coordinates (on Z axis)
  81853. */
  81854. constructor(x?: number, y?: number, z?: number);
  81855. /**
  81856. * Creates a string representation of the Vector3
  81857. * @returns a string with the Vector3 coordinates.
  81858. */
  81859. toString(): string;
  81860. /**
  81861. * Gets the class name
  81862. * @returns the string "Vector3"
  81863. */
  81864. getClassName(): string;
  81865. /**
  81866. * Creates the Vector3 hash code
  81867. * @returns a number which tends to be unique between Vector3 instances
  81868. */
  81869. getHashCode(): number;
  81870. /**
  81871. * Creates an array containing three elements : the coordinates of the Vector3
  81872. * @returns a new array of numbers
  81873. */
  81874. asArray(): number[];
  81875. /**
  81876. * Populates the given array or Float32Array from the given index with the successive coordinates of the Vector3
  81877. * @param array defines the destination array
  81878. * @param index defines the offset in the destination array
  81879. * @returns the current Vector3
  81880. */
  81881. toArray(array: FloatArray, index?: number): Vector3;
  81882. /**
  81883. * Update the current vector from an array
  81884. * @param array defines the destination array
  81885. * @param index defines the offset in the destination array
  81886. * @returns the current Vector3
  81887. */
  81888. fromArray(array: FloatArray, index?: number): Vector3;
  81889. /**
  81890. * Converts the current Vector3 into a quaternion (considering that the Vector3 contains Euler angles representation of a rotation)
  81891. * @returns a new Quaternion object, computed from the Vector3 coordinates
  81892. */
  81893. toQuaternion(): Quaternion;
  81894. /**
  81895. * Adds the given vector to the current Vector3
  81896. * @param otherVector defines the second operand
  81897. * @returns the current updated Vector3
  81898. */
  81899. addInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  81900. /**
  81901. * Adds the given coordinates to the current Vector3
  81902. * @param x defines the x coordinate of the operand
  81903. * @param y defines the y coordinate of the operand
  81904. * @param z defines the z coordinate of the operand
  81905. * @returns the current updated Vector3
  81906. */
  81907. addInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  81908. /**
  81909. * Gets a new Vector3, result of the addition the current Vector3 and the given vector
  81910. * @param otherVector defines the second operand
  81911. * @returns the resulting Vector3
  81912. */
  81913. add(otherVector: DeepImmutable<Vector3>): Vector3;
  81914. /**
  81915. * Adds the current Vector3 to the given one and stores the result in the vector "result"
  81916. * @param otherVector defines the second operand
  81917. * @param result defines the Vector3 object where to store the result
  81918. * @returns the current Vector3
  81919. */
  81920. addToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  81921. /**
  81922. * Subtract the given vector from the current Vector3
  81923. * @param otherVector defines the second operand
  81924. * @returns the current updated Vector3
  81925. */
  81926. subtractInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  81927. /**
  81928. * Returns a new Vector3, result of the subtraction of the given vector from the current Vector3
  81929. * @param otherVector defines the second operand
  81930. * @returns the resulting Vector3
  81931. */
  81932. subtract(otherVector: DeepImmutable<Vector3>): Vector3;
  81933. /**
  81934. * Subtracts the given vector from the current Vector3 and stores the result in the vector "result".
  81935. * @param otherVector defines the second operand
  81936. * @param result defines the Vector3 object where to store the result
  81937. * @returns the current Vector3
  81938. */
  81939. subtractToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  81940. /**
  81941. * Returns a new Vector3 set with the subtraction of the given floats from the current Vector3 coordinates
  81942. * @param x defines the x coordinate of the operand
  81943. * @param y defines the y coordinate of the operand
  81944. * @param z defines the z coordinate of the operand
  81945. * @returns the resulting Vector3
  81946. */
  81947. subtractFromFloats(x: number, y: number, z: number): Vector3;
  81948. /**
  81949. * Subtracts the given floats from the current Vector3 coordinates and set the given vector "result" with this result
  81950. * @param x defines the x coordinate of the operand
  81951. * @param y defines the y coordinate of the operand
  81952. * @param z defines the z coordinate of the operand
  81953. * @param result defines the Vector3 object where to store the result
  81954. * @returns the current Vector3
  81955. */
  81956. subtractFromFloatsToRef(x: number, y: number, z: number, result: Vector3): Vector3;
  81957. /**
  81958. * Gets a new Vector3 set with the current Vector3 negated coordinates
  81959. * @returns a new Vector3
  81960. */
  81961. negate(): Vector3;
  81962. /**
  81963. * Negate this vector in place
  81964. * @returns this
  81965. */
  81966. negateInPlace(): Vector3;
  81967. /**
  81968. * Negate the current Vector3 and stores the result in the given vector "result" coordinates
  81969. * @param result defines the Vector3 object where to store the result
  81970. * @returns the current Vector3
  81971. */
  81972. negateToRef(result: Vector3): Vector3;
  81973. /**
  81974. * Multiplies the Vector3 coordinates by the float "scale"
  81975. * @param scale defines the multiplier factor
  81976. * @returns the current updated Vector3
  81977. */
  81978. scaleInPlace(scale: number): Vector3;
  81979. /**
  81980. * Returns a new Vector3 set with the current Vector3 coordinates multiplied by the float "scale"
  81981. * @param scale defines the multiplier factor
  81982. * @returns a new Vector3
  81983. */
  81984. scale(scale: number): Vector3;
  81985. /**
  81986. * Multiplies the current Vector3 coordinates by the float "scale" and stores the result in the given vector "result" coordinates
  81987. * @param scale defines the multiplier factor
  81988. * @param result defines the Vector3 object where to store the result
  81989. * @returns the current Vector3
  81990. */
  81991. scaleToRef(scale: number, result: Vector3): Vector3;
  81992. /**
  81993. * Scale the current Vector3 values by a factor and add the result to a given Vector3
  81994. * @param scale defines the scale factor
  81995. * @param result defines the Vector3 object where to store the result
  81996. * @returns the unmodified current Vector3
  81997. */
  81998. scaleAndAddToRef(scale: number, result: Vector3): Vector3;
  81999. /**
  82000. * Projects the current vector3 to a plane along a ray starting from a specified origin and directed towards the point.
  82001. * @param origin defines the origin of the projection ray
  82002. * @param plane defines the plane to project to
  82003. * @returns the projected vector3
  82004. */
  82005. projectOnPlane(plane: Plane, origin: Vector3): Vector3;
  82006. /**
  82007. * Projects the current vector3 to a plane along a ray starting from a specified origin and directed towards the point.
  82008. * @param origin defines the origin of the projection ray
  82009. * @param plane defines the plane to project to
  82010. * @param result defines the Vector3 where to store the result
  82011. */
  82012. projectOnPlaneToRef(plane: Plane, origin: Vector3, result: Vector3): void;
  82013. /**
  82014. * Returns true if the current Vector3 and the given vector coordinates are strictly equal
  82015. * @param otherVector defines the second operand
  82016. * @returns true if both vectors are equals
  82017. */
  82018. equals(otherVector: DeepImmutable<Vector3>): boolean;
  82019. /**
  82020. * Returns true if the current Vector3 and the given vector coordinates are distant less than epsilon
  82021. * @param otherVector defines the second operand
  82022. * @param epsilon defines the minimal distance to define values as equals
  82023. * @returns true if both vectors are distant less than epsilon
  82024. */
  82025. equalsWithEpsilon(otherVector: DeepImmutable<Vector3>, epsilon?: number): boolean;
  82026. /**
  82027. * Returns true if the current Vector3 coordinates equals the given floats
  82028. * @param x defines the x coordinate of the operand
  82029. * @param y defines the y coordinate of the operand
  82030. * @param z defines the z coordinate of the operand
  82031. * @returns true if both vectors are equals
  82032. */
  82033. equalsToFloats(x: number, y: number, z: number): boolean;
  82034. /**
  82035. * Multiplies the current Vector3 coordinates by the given ones
  82036. * @param otherVector defines the second operand
  82037. * @returns the current updated Vector3
  82038. */
  82039. multiplyInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  82040. /**
  82041. * Returns a new Vector3, result of the multiplication of the current Vector3 by the given vector
  82042. * @param otherVector defines the second operand
  82043. * @returns the new Vector3
  82044. */
  82045. multiply(otherVector: DeepImmutable<Vector3>): Vector3;
  82046. /**
  82047. * Multiplies the current Vector3 by the given one and stores the result in the given vector "result"
  82048. * @param otherVector defines the second operand
  82049. * @param result defines the Vector3 object where to store the result
  82050. * @returns the current Vector3
  82051. */
  82052. multiplyToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  82053. /**
  82054. * Returns a new Vector3 set with the result of the mulliplication of the current Vector3 coordinates by the given floats
  82055. * @param x defines the x coordinate of the operand
  82056. * @param y defines the y coordinate of the operand
  82057. * @param z defines the z coordinate of the operand
  82058. * @returns the new Vector3
  82059. */
  82060. multiplyByFloats(x: number, y: number, z: number): Vector3;
  82061. /**
  82062. * Returns a new Vector3 set with the result of the division of the current Vector3 coordinates by the given ones
  82063. * @param otherVector defines the second operand
  82064. * @returns the new Vector3
  82065. */
  82066. divide(otherVector: DeepImmutable<Vector3>): Vector3;
  82067. /**
  82068. * Divides the current Vector3 coordinates by the given ones and stores the result in the given vector "result"
  82069. * @param otherVector defines the second operand
  82070. * @param result defines the Vector3 object where to store the result
  82071. * @returns the current Vector3
  82072. */
  82073. divideToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  82074. /**
  82075. * Divides the current Vector3 coordinates by the given ones.
  82076. * @param otherVector defines the second operand
  82077. * @returns the current updated Vector3
  82078. */
  82079. divideInPlace(otherVector: Vector3): Vector3;
  82080. /**
  82081. * Updates the current Vector3 with the minimal coordinate values between its and the given vector ones
  82082. * @param other defines the second operand
  82083. * @returns the current updated Vector3
  82084. */
  82085. minimizeInPlace(other: DeepImmutable<Vector3>): Vector3;
  82086. /**
  82087. * Updates the current Vector3 with the maximal coordinate values between its and the given vector ones.
  82088. * @param other defines the second operand
  82089. * @returns the current updated Vector3
  82090. */
  82091. maximizeInPlace(other: DeepImmutable<Vector3>): Vector3;
  82092. /**
  82093. * Updates the current Vector3 with the minimal coordinate values between its and the given coordinates
  82094. * @param x defines the x coordinate of the operand
  82095. * @param y defines the y coordinate of the operand
  82096. * @param z defines the z coordinate of the operand
  82097. * @returns the current updated Vector3
  82098. */
  82099. minimizeInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  82100. /**
  82101. * Updates the current Vector3 with the maximal coordinate values between its and the given coordinates.
  82102. * @param x defines the x coordinate of the operand
  82103. * @param y defines the y coordinate of the operand
  82104. * @param z defines the z coordinate of the operand
  82105. * @returns the current updated Vector3
  82106. */
  82107. maximizeInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  82108. /**
  82109. * Due to float precision, scale of a mesh could be uniform but float values are off by a small fraction
  82110. * Check if is non uniform within a certain amount of decimal places to account for this
  82111. * @param epsilon the amount the values can differ
  82112. * @returns if the the vector is non uniform to a certain number of decimal places
  82113. */
  82114. isNonUniformWithinEpsilon(epsilon: number): boolean;
  82115. /**
  82116. * Gets a boolean indicating that the vector is non uniform meaning x, y or z are not all the same
  82117. */
  82118. get isNonUniform(): boolean;
  82119. /**
  82120. * Gets a new Vector3 from current Vector3 floored values
  82121. * @returns a new Vector3
  82122. */
  82123. floor(): Vector3;
  82124. /**
  82125. * Gets a new Vector3 from current Vector3 floored values
  82126. * @returns a new Vector3
  82127. */
  82128. fract(): Vector3;
  82129. /**
  82130. * Gets the length of the Vector3
  82131. * @returns the length of the Vector3
  82132. */
  82133. length(): number;
  82134. /**
  82135. * Gets the squared length of the Vector3
  82136. * @returns squared length of the Vector3
  82137. */
  82138. lengthSquared(): number;
  82139. /**
  82140. * Normalize the current Vector3.
  82141. * Please note that this is an in place operation.
  82142. * @returns the current updated Vector3
  82143. */
  82144. normalize(): Vector3;
  82145. /**
  82146. * Reorders the x y z properties of the vector in place
  82147. * @param order new ordering of the properties (eg. for vector 1,2,3 with "ZYX" will produce 3,2,1)
  82148. * @returns the current updated vector
  82149. */
  82150. reorderInPlace(order: string): this;
  82151. /**
  82152. * Rotates the vector around 0,0,0 by a quaternion
  82153. * @param quaternion the rotation quaternion
  82154. * @param result vector to store the result
  82155. * @returns the resulting vector
  82156. */
  82157. rotateByQuaternionToRef(quaternion: Quaternion, result: Vector3): Vector3;
  82158. /**
  82159. * Rotates a vector around a given point
  82160. * @param quaternion the rotation quaternion
  82161. * @param point the point to rotate around
  82162. * @param result vector to store the result
  82163. * @returns the resulting vector
  82164. */
  82165. rotateByQuaternionAroundPointToRef(quaternion: Quaternion, point: Vector3, result: Vector3): Vector3;
  82166. /**
  82167. * Returns a new Vector3 as the cross product of the current vector and the "other" one
  82168. * The cross product is then orthogonal to both current and "other"
  82169. * @param other defines the right operand
  82170. * @returns the cross product
  82171. */
  82172. cross(other: Vector3): Vector3;
  82173. /**
  82174. * Normalize the current Vector3 with the given input length.
  82175. * Please note that this is an in place operation.
  82176. * @param len the length of the vector
  82177. * @returns the current updated Vector3
  82178. */
  82179. normalizeFromLength(len: number): Vector3;
  82180. /**
  82181. * Normalize the current Vector3 to a new vector
  82182. * @returns the new Vector3
  82183. */
  82184. normalizeToNew(): Vector3;
  82185. /**
  82186. * Normalize the current Vector3 to the reference
  82187. * @param reference define the Vector3 to update
  82188. * @returns the updated Vector3
  82189. */
  82190. normalizeToRef(reference: Vector3): Vector3;
  82191. /**
  82192. * Creates a new Vector3 copied from the current Vector3
  82193. * @returns the new Vector3
  82194. */
  82195. clone(): Vector3;
  82196. /**
  82197. * Copies the given vector coordinates to the current Vector3 ones
  82198. * @param source defines the source Vector3
  82199. * @returns the current updated Vector3
  82200. */
  82201. copyFrom(source: DeepImmutable<Vector3>): Vector3;
  82202. /**
  82203. * Copies the given floats to the current Vector3 coordinates
  82204. * @param x defines the x coordinate of the operand
  82205. * @param y defines the y coordinate of the operand
  82206. * @param z defines the z coordinate of the operand
  82207. * @returns the current updated Vector3
  82208. */
  82209. copyFromFloats(x: number, y: number, z: number): Vector3;
  82210. /**
  82211. * Copies the given floats to the current Vector3 coordinates
  82212. * @param x defines the x coordinate of the operand
  82213. * @param y defines the y coordinate of the operand
  82214. * @param z defines the z coordinate of the operand
  82215. * @returns the current updated Vector3
  82216. */
  82217. set(x: number, y: number, z: number): Vector3;
  82218. /**
  82219. * Copies the given float to the current Vector3 coordinates
  82220. * @param v defines the x, y and z coordinates of the operand
  82221. * @returns the current updated Vector3
  82222. */
  82223. setAll(v: number): Vector3;
  82224. /**
  82225. * Get the clip factor between two vectors
  82226. * @param vector0 defines the first operand
  82227. * @param vector1 defines the second operand
  82228. * @param axis defines the axis to use
  82229. * @param size defines the size along the axis
  82230. * @returns the clip factor
  82231. */
  82232. static GetClipFactor(vector0: DeepImmutable<Vector3>, vector1: DeepImmutable<Vector3>, axis: DeepImmutable<Vector3>, size: number): number;
  82233. /**
  82234. * Get angle between two vectors
  82235. * @param vector0 angle between vector0 and vector1
  82236. * @param vector1 angle between vector0 and vector1
  82237. * @param normal direction of the normal
  82238. * @return the angle between vector0 and vector1
  82239. */
  82240. static GetAngleBetweenVectors(vector0: DeepImmutable<Vector3>, vector1: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>): number;
  82241. /**
  82242. * Returns a new Vector3 set from the index "offset" of the given array
  82243. * @param array defines the source array
  82244. * @param offset defines the offset in the source array
  82245. * @returns the new Vector3
  82246. */
  82247. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector3;
  82248. /**
  82249. * Returns a new Vector3 set from the index "offset" of the given Float32Array
  82250. * @param array defines the source array
  82251. * @param offset defines the offset in the source array
  82252. * @returns the new Vector3
  82253. * @deprecated Please use FromArray instead.
  82254. */
  82255. static FromFloatArray(array: DeepImmutable<Float32Array>, offset?: number): Vector3;
  82256. /**
  82257. * Sets the given vector "result" with the element values from the index "offset" of the given array
  82258. * @param array defines the source array
  82259. * @param offset defines the offset in the source array
  82260. * @param result defines the Vector3 where to store the result
  82261. */
  82262. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector3): void;
  82263. /**
  82264. * Sets the given vector "result" with the element values from the index "offset" of the given Float32Array
  82265. * @param array defines the source array
  82266. * @param offset defines the offset in the source array
  82267. * @param result defines the Vector3 where to store the result
  82268. * @deprecated Please use FromArrayToRef instead.
  82269. */
  82270. static FromFloatArrayToRef(array: DeepImmutable<Float32Array>, offset: number, result: Vector3): void;
  82271. /**
  82272. * Sets the given vector "result" with the given floats.
  82273. * @param x defines the x coordinate of the source
  82274. * @param y defines the y coordinate of the source
  82275. * @param z defines the z coordinate of the source
  82276. * @param result defines the Vector3 where to store the result
  82277. */
  82278. static FromFloatsToRef(x: number, y: number, z: number, result: Vector3): void;
  82279. /**
  82280. * Returns a new Vector3 set to (0.0, 0.0, 0.0)
  82281. * @returns a new empty Vector3
  82282. */
  82283. static Zero(): Vector3;
  82284. /**
  82285. * Returns a new Vector3 set to (1.0, 1.0, 1.0)
  82286. * @returns a new unit Vector3
  82287. */
  82288. static One(): Vector3;
  82289. /**
  82290. * Returns a new Vector3 set to (0.0, 1.0, 0.0)
  82291. * @returns a new up Vector3
  82292. */
  82293. static Up(): Vector3;
  82294. /**
  82295. * Gets a up Vector3 that must not be updated
  82296. */
  82297. static get UpReadOnly(): DeepImmutable<Vector3>;
  82298. /**
  82299. * Gets a zero Vector3 that must not be updated
  82300. */
  82301. static get ZeroReadOnly(): DeepImmutable<Vector3>;
  82302. /**
  82303. * Returns a new Vector3 set to (0.0, -1.0, 0.0)
  82304. * @returns a new down Vector3
  82305. */
  82306. static Down(): Vector3;
  82307. /**
  82308. * Returns a new Vector3 set to (0.0, 0.0, 1.0)
  82309. * @param rightHandedSystem is the scene right-handed (negative z)
  82310. * @returns a new forward Vector3
  82311. */
  82312. static Forward(rightHandedSystem?: boolean): Vector3;
  82313. /**
  82314. * Returns a new Vector3 set to (0.0, 0.0, -1.0)
  82315. * @param rightHandedSystem is the scene right-handed (negative-z)
  82316. * @returns a new forward Vector3
  82317. */
  82318. static Backward(rightHandedSystem?: boolean): Vector3;
  82319. /**
  82320. * Returns a new Vector3 set to (1.0, 0.0, 0.0)
  82321. * @returns a new right Vector3
  82322. */
  82323. static Right(): Vector3;
  82324. /**
  82325. * Returns a new Vector3 set to (-1.0, 0.0, 0.0)
  82326. * @returns a new left Vector3
  82327. */
  82328. static Left(): Vector3;
  82329. /**
  82330. * Returns a new Vector3 set with the result of the transformation by the given matrix of the given vector.
  82331. * This method computes tranformed coordinates only, not transformed direction vectors (ie. it takes translation in account)
  82332. * @param vector defines the Vector3 to transform
  82333. * @param transformation defines the transformation matrix
  82334. * @returns the transformed Vector3
  82335. */
  82336. static TransformCoordinates(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>): Vector3;
  82337. /**
  82338. * Sets the given vector "result" coordinates with the result of the transformation by the given matrix of the given vector
  82339. * This method computes tranformed coordinates only, not transformed direction vectors (ie. it takes translation in account)
  82340. * @param vector defines the Vector3 to transform
  82341. * @param transformation defines the transformation matrix
  82342. * @param result defines the Vector3 where to store the result
  82343. */
  82344. static TransformCoordinatesToRef(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  82345. /**
  82346. * Sets the given vector "result" coordinates with the result of the transformation by the given matrix of the given floats (x, y, z)
  82347. * This method computes tranformed coordinates only, not transformed direction vectors
  82348. * @param x define the x coordinate of the source vector
  82349. * @param y define the y coordinate of the source vector
  82350. * @param z define the z coordinate of the source vector
  82351. * @param transformation defines the transformation matrix
  82352. * @param result defines the Vector3 where to store the result
  82353. */
  82354. static TransformCoordinatesFromFloatsToRef(x: number, y: number, z: number, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  82355. /**
  82356. * Returns a new Vector3 set with the result of the normal transformation by the given matrix of the given vector
  82357. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  82358. * @param vector defines the Vector3 to transform
  82359. * @param transformation defines the transformation matrix
  82360. * @returns the new Vector3
  82361. */
  82362. static TransformNormal(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>): Vector3;
  82363. /**
  82364. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given vector
  82365. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  82366. * @param vector defines the Vector3 to transform
  82367. * @param transformation defines the transformation matrix
  82368. * @param result defines the Vector3 where to store the result
  82369. */
  82370. static TransformNormalToRef(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  82371. /**
  82372. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given floats (x, y, z)
  82373. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  82374. * @param x define the x coordinate of the source vector
  82375. * @param y define the y coordinate of the source vector
  82376. * @param z define the z coordinate of the source vector
  82377. * @param transformation defines the transformation matrix
  82378. * @param result defines the Vector3 where to store the result
  82379. */
  82380. static TransformNormalFromFloatsToRef(x: number, y: number, z: number, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  82381. /**
  82382. * Returns a new Vector3 located for "amount" on the CatmullRom interpolation spline defined by the vectors "value1", "value2", "value3", "value4"
  82383. * @param value1 defines the first control point
  82384. * @param value2 defines the second control point
  82385. * @param value3 defines the third control point
  82386. * @param value4 defines the fourth control point
  82387. * @param amount defines the amount on the spline to use
  82388. * @returns the new Vector3
  82389. */
  82390. static CatmullRom(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>, value3: DeepImmutable<Vector3>, value4: DeepImmutable<Vector3>, amount: number): Vector3;
  82391. /**
  82392. * 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"
  82393. * If a coordinate value of "value" is lower than one of the "min" coordinate, then this "value" coordinate is set with the "min" one
  82394. * If a coordinate value of "value" is greater than one of the "max" coordinate, then this "value" coordinate is set with the "max" one
  82395. * @param value defines the current value
  82396. * @param min defines the lower range value
  82397. * @param max defines the upper range value
  82398. * @returns the new Vector3
  82399. */
  82400. static Clamp(value: DeepImmutable<Vector3>, min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>): Vector3;
  82401. /**
  82402. * 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"
  82403. * If a coordinate value of "value" is lower than one of the "min" coordinate, then this "value" coordinate is set with the "min" one
  82404. * If a coordinate value of "value" is greater than one of the "max" coordinate, then this "value" coordinate is set with the "max" one
  82405. * @param value defines the current value
  82406. * @param min defines the lower range value
  82407. * @param max defines the upper range value
  82408. * @param result defines the Vector3 where to store the result
  82409. */
  82410. static ClampToRef(value: DeepImmutable<Vector3>, min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, result: Vector3): void;
  82411. /**
  82412. * Checks if a given vector is inside a specific range
  82413. * @param v defines the vector to test
  82414. * @param min defines the minimum range
  82415. * @param max defines the maximum range
  82416. */
  82417. static CheckExtends(v: Vector3, min: Vector3, max: Vector3): void;
  82418. /**
  82419. * Returns a new Vector3 located for "amount" (float) on the Hermite interpolation spline defined by the vectors "value1", "tangent1", "value2", "tangent2"
  82420. * @param value1 defines the first control point
  82421. * @param tangent1 defines the first tangent vector
  82422. * @param value2 defines the second control point
  82423. * @param tangent2 defines the second tangent vector
  82424. * @param amount defines the amount on the interpolation spline (between 0 and 1)
  82425. * @returns the new Vector3
  82426. */
  82427. static Hermite(value1: DeepImmutable<Vector3>, tangent1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>, tangent2: DeepImmutable<Vector3>, amount: number): Vector3;
  82428. /**
  82429. * Returns a new Vector3 located for "amount" (float) on the linear interpolation between the vectors "start" and "end"
  82430. * @param start defines the start value
  82431. * @param end defines the end value
  82432. * @param amount max defines amount between both (between 0 and 1)
  82433. * @returns the new Vector3
  82434. */
  82435. static Lerp(start: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, amount: number): Vector3;
  82436. /**
  82437. * Sets the given vector "result" with the result of the linear interpolation from the vector "start" for "amount" to the vector "end"
  82438. * @param start defines the start value
  82439. * @param end defines the end value
  82440. * @param amount max defines amount between both (between 0 and 1)
  82441. * @param result defines the Vector3 where to store the result
  82442. */
  82443. static LerpToRef(start: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, amount: number, result: Vector3): void;
  82444. /**
  82445. * Returns the dot product (float) between the vectors "left" and "right"
  82446. * @param left defines the left operand
  82447. * @param right defines the right operand
  82448. * @returns the dot product
  82449. */
  82450. static Dot(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): number;
  82451. /**
  82452. * Returns a new Vector3 as the cross product of the vectors "left" and "right"
  82453. * The cross product is then orthogonal to both "left" and "right"
  82454. * @param left defines the left operand
  82455. * @param right defines the right operand
  82456. * @returns the cross product
  82457. */
  82458. static Cross(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  82459. /**
  82460. * Sets the given vector "result" with the cross product of "left" and "right"
  82461. * The cross product is then orthogonal to both "left" and "right"
  82462. * @param left defines the left operand
  82463. * @param right defines the right operand
  82464. * @param result defines the Vector3 where to store the result
  82465. */
  82466. static CrossToRef(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>, result: Vector3): void;
  82467. /**
  82468. * Returns a new Vector3 as the normalization of the given vector
  82469. * @param vector defines the Vector3 to normalize
  82470. * @returns the new Vector3
  82471. */
  82472. static Normalize(vector: DeepImmutable<Vector3>): Vector3;
  82473. /**
  82474. * Sets the given vector "result" with the normalization of the given first vector
  82475. * @param vector defines the Vector3 to normalize
  82476. * @param result defines the Vector3 where to store the result
  82477. */
  82478. static NormalizeToRef(vector: DeepImmutable<Vector3>, result: Vector3): void;
  82479. /**
  82480. * Project a Vector3 onto screen space
  82481. * @param vector defines the Vector3 to project
  82482. * @param world defines the world matrix to use
  82483. * @param transform defines the transform (view x projection) matrix to use
  82484. * @param viewport defines the screen viewport to use
  82485. * @returns the new Vector3
  82486. */
  82487. static Project(vector: DeepImmutable<Vector3>, world: DeepImmutable<Matrix>, transform: DeepImmutable<Matrix>, viewport: DeepImmutable<Viewport>): Vector3;
  82488. /** @hidden */
  82489. static _UnprojectFromInvertedMatrixToRef(source: DeepImmutable<Vector3>, matrix: DeepImmutable<Matrix>, result: Vector3): void;
  82490. /**
  82491. * Unproject from screen space to object space
  82492. * @param source defines the screen space Vector3 to use
  82493. * @param viewportWidth defines the current width of the viewport
  82494. * @param viewportHeight defines the current height of the viewport
  82495. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  82496. * @param transform defines the transform (view x projection) matrix to use
  82497. * @returns the new Vector3
  82498. */
  82499. static UnprojectFromTransform(source: Vector3, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, transform: DeepImmutable<Matrix>): Vector3;
  82500. /**
  82501. * Unproject from screen space to object space
  82502. * @param source defines the screen space Vector3 to use
  82503. * @param viewportWidth defines the current width of the viewport
  82504. * @param viewportHeight defines the current height of the viewport
  82505. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  82506. * @param view defines the view matrix to use
  82507. * @param projection defines the projection matrix to use
  82508. * @returns the new Vector3
  82509. */
  82510. static Unproject(source: DeepImmutable<Vector3>, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Vector3;
  82511. /**
  82512. * Unproject from screen space to object space
  82513. * @param source defines the screen space Vector3 to use
  82514. * @param viewportWidth defines the current width of the viewport
  82515. * @param viewportHeight defines the current height of the viewport
  82516. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  82517. * @param view defines the view matrix to use
  82518. * @param projection defines the projection matrix to use
  82519. * @param result defines the Vector3 where to store the result
  82520. */
  82521. static UnprojectToRef(source: DeepImmutable<Vector3>, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, result: Vector3): void;
  82522. /**
  82523. * Unproject from screen space to object space
  82524. * @param sourceX defines the screen space x coordinate to use
  82525. * @param sourceY defines the screen space y coordinate to use
  82526. * @param sourceZ defines the screen space z coordinate to use
  82527. * @param viewportWidth defines the current width of the viewport
  82528. * @param viewportHeight defines the current height of the viewport
  82529. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  82530. * @param view defines the view matrix to use
  82531. * @param projection defines the projection matrix to use
  82532. * @param result defines the Vector3 where to store the result
  82533. */
  82534. static UnprojectFloatsToRef(sourceX: float, sourceY: float, sourceZ: float, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, result: Vector3): void;
  82535. /**
  82536. * Gets the minimal coordinate values between two Vector3
  82537. * @param left defines the first operand
  82538. * @param right defines the second operand
  82539. * @returns the new Vector3
  82540. */
  82541. static Minimize(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  82542. /**
  82543. * Gets the maximal coordinate values between two Vector3
  82544. * @param left defines the first operand
  82545. * @param right defines the second operand
  82546. * @returns the new Vector3
  82547. */
  82548. static Maximize(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  82549. /**
  82550. * Returns the distance between the vectors "value1" and "value2"
  82551. * @param value1 defines the first operand
  82552. * @param value2 defines the second operand
  82553. * @returns the distance
  82554. */
  82555. static Distance(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): number;
  82556. /**
  82557. * Returns the squared distance between the vectors "value1" and "value2"
  82558. * @param value1 defines the first operand
  82559. * @param value2 defines the second operand
  82560. * @returns the squared distance
  82561. */
  82562. static DistanceSquared(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): number;
  82563. /**
  82564. * Returns a new Vector3 located at the center between "value1" and "value2"
  82565. * @param value1 defines the first operand
  82566. * @param value2 defines the second operand
  82567. * @returns the new Vector3
  82568. */
  82569. static Center(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): Vector3;
  82570. /**
  82571. * Given three orthogonal normalized left-handed oriented Vector3 axis in space (target system),
  82572. * RotationFromAxis() returns the rotation Euler angles (ex : rotation.x, rotation.y, rotation.z) to apply
  82573. * to something in order to rotate it from its local system to the given target system
  82574. * Note: axis1, axis2 and axis3 are normalized during this operation
  82575. * @param axis1 defines the first axis
  82576. * @param axis2 defines the second axis
  82577. * @param axis3 defines the third axis
  82578. * @returns a new Vector3
  82579. */
  82580. static RotationFromAxis(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>): Vector3;
  82581. /**
  82582. * The same than RotationFromAxis but updates the given ref Vector3 parameter instead of returning a new Vector3
  82583. * @param axis1 defines the first axis
  82584. * @param axis2 defines the second axis
  82585. * @param axis3 defines the third axis
  82586. * @param ref defines the Vector3 where to store the result
  82587. */
  82588. static RotationFromAxisToRef(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>, ref: Vector3): void;
  82589. }
  82590. /**
  82591. * Vector4 class created for EulerAngle class conversion to Quaternion
  82592. */
  82593. export class Vector4 {
  82594. /** x value of the vector */
  82595. x: number;
  82596. /** y value of the vector */
  82597. y: number;
  82598. /** z value of the vector */
  82599. z: number;
  82600. /** w value of the vector */
  82601. w: number;
  82602. /**
  82603. * Creates a Vector4 object from the given floats.
  82604. * @param x x value of the vector
  82605. * @param y y value of the vector
  82606. * @param z z value of the vector
  82607. * @param w w value of the vector
  82608. */
  82609. constructor(
  82610. /** x value of the vector */
  82611. x: number,
  82612. /** y value of the vector */
  82613. y: number,
  82614. /** z value of the vector */
  82615. z: number,
  82616. /** w value of the vector */
  82617. w: number);
  82618. /**
  82619. * Returns the string with the Vector4 coordinates.
  82620. * @returns a string containing all the vector values
  82621. */
  82622. toString(): string;
  82623. /**
  82624. * Returns the string "Vector4".
  82625. * @returns "Vector4"
  82626. */
  82627. getClassName(): string;
  82628. /**
  82629. * Returns the Vector4 hash code.
  82630. * @returns a unique hash code
  82631. */
  82632. getHashCode(): number;
  82633. /**
  82634. * Returns a new array populated with 4 elements : the Vector4 coordinates.
  82635. * @returns the resulting array
  82636. */
  82637. asArray(): number[];
  82638. /**
  82639. * Populates the given array from the given index with the Vector4 coordinates.
  82640. * @param array array to populate
  82641. * @param index index of the array to start at (default: 0)
  82642. * @returns the Vector4.
  82643. */
  82644. toArray(array: FloatArray, index?: number): Vector4;
  82645. /**
  82646. * Update the current vector from an array
  82647. * @param array defines the destination array
  82648. * @param index defines the offset in the destination array
  82649. * @returns the current Vector3
  82650. */
  82651. fromArray(array: FloatArray, index?: number): Vector4;
  82652. /**
  82653. * Adds the given vector to the current Vector4.
  82654. * @param otherVector the vector to add
  82655. * @returns the updated Vector4.
  82656. */
  82657. addInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  82658. /**
  82659. * Returns a new Vector4 as the result of the addition of the current Vector4 and the given one.
  82660. * @param otherVector the vector to add
  82661. * @returns the resulting vector
  82662. */
  82663. add(otherVector: DeepImmutable<Vector4>): Vector4;
  82664. /**
  82665. * Updates the given vector "result" with the result of the addition of the current Vector4 and the given one.
  82666. * @param otherVector the vector to add
  82667. * @param result the vector to store the result
  82668. * @returns the current Vector4.
  82669. */
  82670. addToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  82671. /**
  82672. * Subtract in place the given vector from the current Vector4.
  82673. * @param otherVector the vector to subtract
  82674. * @returns the updated Vector4.
  82675. */
  82676. subtractInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  82677. /**
  82678. * Returns a new Vector4 with the result of the subtraction of the given vector from the current Vector4.
  82679. * @param otherVector the vector to add
  82680. * @returns the new vector with the result
  82681. */
  82682. subtract(otherVector: DeepImmutable<Vector4>): Vector4;
  82683. /**
  82684. * Sets the given vector "result" with the result of the subtraction of the given vector from the current Vector4.
  82685. * @param otherVector the vector to subtract
  82686. * @param result the vector to store the result
  82687. * @returns the current Vector4.
  82688. */
  82689. subtractToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  82690. /**
  82691. * Returns a new Vector4 set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  82692. */
  82693. /**
  82694. * Returns a new Vector4 set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  82695. * @param x value to subtract
  82696. * @param y value to subtract
  82697. * @param z value to subtract
  82698. * @param w value to subtract
  82699. * @returns new vector containing the result
  82700. */
  82701. subtractFromFloats(x: number, y: number, z: number, w: number): Vector4;
  82702. /**
  82703. * Sets the given vector "result" set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  82704. * @param x value to subtract
  82705. * @param y value to subtract
  82706. * @param z value to subtract
  82707. * @param w value to subtract
  82708. * @param result the vector to store the result in
  82709. * @returns the current Vector4.
  82710. */
  82711. subtractFromFloatsToRef(x: number, y: number, z: number, w: number, result: Vector4): Vector4;
  82712. /**
  82713. * Returns a new Vector4 set with the current Vector4 negated coordinates.
  82714. * @returns a new vector with the negated values
  82715. */
  82716. negate(): Vector4;
  82717. /**
  82718. * Negate this vector in place
  82719. * @returns this
  82720. */
  82721. negateInPlace(): Vector4;
  82722. /**
  82723. * Negate the current Vector4 and stores the result in the given vector "result" coordinates
  82724. * @param result defines the Vector3 object where to store the result
  82725. * @returns the current Vector4
  82726. */
  82727. negateToRef(result: Vector4): Vector4;
  82728. /**
  82729. * Multiplies the current Vector4 coordinates by scale (float).
  82730. * @param scale the number to scale with
  82731. * @returns the updated Vector4.
  82732. */
  82733. scaleInPlace(scale: number): Vector4;
  82734. /**
  82735. * Returns a new Vector4 set with the current Vector4 coordinates multiplied by scale (float).
  82736. * @param scale the number to scale with
  82737. * @returns a new vector with the result
  82738. */
  82739. scale(scale: number): Vector4;
  82740. /**
  82741. * Sets the given vector "result" with the current Vector4 coordinates multiplied by scale (float).
  82742. * @param scale the number to scale with
  82743. * @param result a vector to store the result in
  82744. * @returns the current Vector4.
  82745. */
  82746. scaleToRef(scale: number, result: Vector4): Vector4;
  82747. /**
  82748. * Scale the current Vector4 values by a factor and add the result to a given Vector4
  82749. * @param scale defines the scale factor
  82750. * @param result defines the Vector4 object where to store the result
  82751. * @returns the unmodified current Vector4
  82752. */
  82753. scaleAndAddToRef(scale: number, result: Vector4): Vector4;
  82754. /**
  82755. * Boolean : True if the current Vector4 coordinates are stricly equal to the given ones.
  82756. * @param otherVector the vector to compare against
  82757. * @returns true if they are equal
  82758. */
  82759. equals(otherVector: DeepImmutable<Vector4>): boolean;
  82760. /**
  82761. * Boolean : True if the current Vector4 coordinates are each beneath the distance "epsilon" from the given vector ones.
  82762. * @param otherVector vector to compare against
  82763. * @param epsilon (Default: very small number)
  82764. * @returns true if they are equal
  82765. */
  82766. equalsWithEpsilon(otherVector: DeepImmutable<Vector4>, epsilon?: number): boolean;
  82767. /**
  82768. * Boolean : True if the given floats are strictly equal to the current Vector4 coordinates.
  82769. * @param x x value to compare against
  82770. * @param y y value to compare against
  82771. * @param z z value to compare against
  82772. * @param w w value to compare against
  82773. * @returns true if equal
  82774. */
  82775. equalsToFloats(x: number, y: number, z: number, w: number): boolean;
  82776. /**
  82777. * Multiplies in place the current Vector4 by the given one.
  82778. * @param otherVector vector to multiple with
  82779. * @returns the updated Vector4.
  82780. */
  82781. multiplyInPlace(otherVector: Vector4): Vector4;
  82782. /**
  82783. * Returns a new Vector4 set with the multiplication result of the current Vector4 and the given one.
  82784. * @param otherVector vector to multiple with
  82785. * @returns resulting new vector
  82786. */
  82787. multiply(otherVector: DeepImmutable<Vector4>): Vector4;
  82788. /**
  82789. * Updates the given vector "result" with the multiplication result of the current Vector4 and the given one.
  82790. * @param otherVector vector to multiple with
  82791. * @param result vector to store the result
  82792. * @returns the current Vector4.
  82793. */
  82794. multiplyToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  82795. /**
  82796. * Returns a new Vector4 set with the multiplication result of the given floats and the current Vector4 coordinates.
  82797. * @param x x value multiply with
  82798. * @param y y value multiply with
  82799. * @param z z value multiply with
  82800. * @param w w value multiply with
  82801. * @returns resulting new vector
  82802. */
  82803. multiplyByFloats(x: number, y: number, z: number, w: number): Vector4;
  82804. /**
  82805. * Returns a new Vector4 set with the division result of the current Vector4 by the given one.
  82806. * @param otherVector vector to devide with
  82807. * @returns resulting new vector
  82808. */
  82809. divide(otherVector: DeepImmutable<Vector4>): Vector4;
  82810. /**
  82811. * Updates the given vector "result" with the division result of the current Vector4 by the given one.
  82812. * @param otherVector vector to devide with
  82813. * @param result vector to store the result
  82814. * @returns the current Vector4.
  82815. */
  82816. divideToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  82817. /**
  82818. * Divides the current Vector3 coordinates by the given ones.
  82819. * @param otherVector vector to devide with
  82820. * @returns the updated Vector3.
  82821. */
  82822. divideInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  82823. /**
  82824. * Updates the Vector4 coordinates with the minimum values between its own and the given vector ones
  82825. * @param other defines the second operand
  82826. * @returns the current updated Vector4
  82827. */
  82828. minimizeInPlace(other: DeepImmutable<Vector4>): Vector4;
  82829. /**
  82830. * Updates the Vector4 coordinates with the maximum values between its own and the given vector ones
  82831. * @param other defines the second operand
  82832. * @returns the current updated Vector4
  82833. */
  82834. maximizeInPlace(other: DeepImmutable<Vector4>): Vector4;
  82835. /**
  82836. * Gets a new Vector4 from current Vector4 floored values
  82837. * @returns a new Vector4
  82838. */
  82839. floor(): Vector4;
  82840. /**
  82841. * Gets a new Vector4 from current Vector3 floored values
  82842. * @returns a new Vector4
  82843. */
  82844. fract(): Vector4;
  82845. /**
  82846. * Returns the Vector4 length (float).
  82847. * @returns the length
  82848. */
  82849. length(): number;
  82850. /**
  82851. * Returns the Vector4 squared length (float).
  82852. * @returns the length squared
  82853. */
  82854. lengthSquared(): number;
  82855. /**
  82856. * Normalizes in place the Vector4.
  82857. * @returns the updated Vector4.
  82858. */
  82859. normalize(): Vector4;
  82860. /**
  82861. * Returns a new Vector3 from the Vector4 (x, y, z) coordinates.
  82862. * @returns this converted to a new vector3
  82863. */
  82864. toVector3(): Vector3;
  82865. /**
  82866. * Returns a new Vector4 copied from the current one.
  82867. * @returns the new cloned vector
  82868. */
  82869. clone(): Vector4;
  82870. /**
  82871. * Updates the current Vector4 with the given one coordinates.
  82872. * @param source the source vector to copy from
  82873. * @returns the updated Vector4.
  82874. */
  82875. copyFrom(source: DeepImmutable<Vector4>): Vector4;
  82876. /**
  82877. * Updates the current Vector4 coordinates with the given floats.
  82878. * @param x float to copy from
  82879. * @param y float to copy from
  82880. * @param z float to copy from
  82881. * @param w float to copy from
  82882. * @returns the updated Vector4.
  82883. */
  82884. copyFromFloats(x: number, y: number, z: number, w: number): Vector4;
  82885. /**
  82886. * Updates the current Vector4 coordinates with the given floats.
  82887. * @param x float to set from
  82888. * @param y float to set from
  82889. * @param z float to set from
  82890. * @param w float to set from
  82891. * @returns the updated Vector4.
  82892. */
  82893. set(x: number, y: number, z: number, w: number): Vector4;
  82894. /**
  82895. * Copies the given float to the current Vector3 coordinates
  82896. * @param v defines the x, y, z and w coordinates of the operand
  82897. * @returns the current updated Vector3
  82898. */
  82899. setAll(v: number): Vector4;
  82900. /**
  82901. * Returns a new Vector4 set from the starting index of the given array.
  82902. * @param array the array to pull values from
  82903. * @param offset the offset into the array to start at
  82904. * @returns the new vector
  82905. */
  82906. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector4;
  82907. /**
  82908. * Updates the given vector "result" from the starting index of the given array.
  82909. * @param array the array to pull values from
  82910. * @param offset the offset into the array to start at
  82911. * @param result the vector to store the result in
  82912. */
  82913. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector4): void;
  82914. /**
  82915. * Updates the given vector "result" from the starting index of the given Float32Array.
  82916. * @param array the array to pull values from
  82917. * @param offset the offset into the array to start at
  82918. * @param result the vector to store the result in
  82919. */
  82920. static FromFloatArrayToRef(array: DeepImmutable<Float32Array>, offset: number, result: Vector4): void;
  82921. /**
  82922. * Updates the given vector "result" coordinates from the given floats.
  82923. * @param x float to set from
  82924. * @param y float to set from
  82925. * @param z float to set from
  82926. * @param w float to set from
  82927. * @param result the vector to the floats in
  82928. */
  82929. static FromFloatsToRef(x: number, y: number, z: number, w: number, result: Vector4): void;
  82930. /**
  82931. * Returns a new Vector4 set to (0.0, 0.0, 0.0, 0.0)
  82932. * @returns the new vector
  82933. */
  82934. static Zero(): Vector4;
  82935. /**
  82936. * Returns a new Vector4 set to (1.0, 1.0, 1.0, 1.0)
  82937. * @returns the new vector
  82938. */
  82939. static One(): Vector4;
  82940. /**
  82941. * Returns a new normalized Vector4 from the given one.
  82942. * @param vector the vector to normalize
  82943. * @returns the vector
  82944. */
  82945. static Normalize(vector: DeepImmutable<Vector4>): Vector4;
  82946. /**
  82947. * Updates the given vector "result" from the normalization of the given one.
  82948. * @param vector the vector to normalize
  82949. * @param result the vector to store the result in
  82950. */
  82951. static NormalizeToRef(vector: DeepImmutable<Vector4>, result: Vector4): void;
  82952. /**
  82953. * Returns a vector with the minimum values from the left and right vectors
  82954. * @param left left vector to minimize
  82955. * @param right right vector to minimize
  82956. * @returns a new vector with the minimum of the left and right vector values
  82957. */
  82958. static Minimize(left: DeepImmutable<Vector4>, right: DeepImmutable<Vector4>): Vector4;
  82959. /**
  82960. * Returns a vector with the maximum values from the left and right vectors
  82961. * @param left left vector to maximize
  82962. * @param right right vector to maximize
  82963. * @returns a new vector with the maximum of the left and right vector values
  82964. */
  82965. static Maximize(left: DeepImmutable<Vector4>, right: DeepImmutable<Vector4>): Vector4;
  82966. /**
  82967. * Returns the distance (float) between the vectors "value1" and "value2".
  82968. * @param value1 value to calulate the distance between
  82969. * @param value2 value to calulate the distance between
  82970. * @return the distance between the two vectors
  82971. */
  82972. static Distance(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): number;
  82973. /**
  82974. * Returns the squared distance (float) between the vectors "value1" and "value2".
  82975. * @param value1 value to calulate the distance between
  82976. * @param value2 value to calulate the distance between
  82977. * @return the distance between the two vectors squared
  82978. */
  82979. static DistanceSquared(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): number;
  82980. /**
  82981. * Returns a new Vector4 located at the center between the vectors "value1" and "value2".
  82982. * @param value1 value to calulate the center between
  82983. * @param value2 value to calulate the center between
  82984. * @return the center between the two vectors
  82985. */
  82986. static Center(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): Vector4;
  82987. /**
  82988. * Returns a new Vector4 set with the result of the normal transformation by the given matrix of the given vector.
  82989. * This methods computes transformed normalized direction vectors only.
  82990. * @param vector the vector to transform
  82991. * @param transformation the transformation matrix to apply
  82992. * @returns the new vector
  82993. */
  82994. static TransformNormal(vector: DeepImmutable<Vector4>, transformation: DeepImmutable<Matrix>): Vector4;
  82995. /**
  82996. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given vector.
  82997. * This methods computes transformed normalized direction vectors only.
  82998. * @param vector the vector to transform
  82999. * @param transformation the transformation matrix to apply
  83000. * @param result the vector to store the result in
  83001. */
  83002. static TransformNormalToRef(vector: DeepImmutable<Vector4>, transformation: DeepImmutable<Matrix>, result: Vector4): void;
  83003. /**
  83004. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given floats (x, y, z, w).
  83005. * This methods computes transformed normalized direction vectors only.
  83006. * @param x value to transform
  83007. * @param y value to transform
  83008. * @param z value to transform
  83009. * @param w value to transform
  83010. * @param transformation the transformation matrix to apply
  83011. * @param result the vector to store the results in
  83012. */
  83013. static TransformNormalFromFloatsToRef(x: number, y: number, z: number, w: number, transformation: DeepImmutable<Matrix>, result: Vector4): void;
  83014. /**
  83015. * Creates a new Vector4 from a Vector3
  83016. * @param source defines the source data
  83017. * @param w defines the 4th component (default is 0)
  83018. * @returns a new Vector4
  83019. */
  83020. static FromVector3(source: Vector3, w?: number): Vector4;
  83021. }
  83022. /**
  83023. * Class used to store quaternion data
  83024. * @see https://en.wikipedia.org/wiki/Quaternion
  83025. * @see https://doc.babylonjs.com/features/position,_rotation,_scaling
  83026. */
  83027. export class Quaternion {
  83028. /** @hidden */
  83029. _x: number;
  83030. /** @hidden */
  83031. _y: number;
  83032. /** @hidden */
  83033. _z: number;
  83034. /** @hidden */
  83035. _w: number;
  83036. /** @hidden */
  83037. _isDirty: boolean;
  83038. /** Gets or sets the x coordinate */
  83039. get x(): number;
  83040. set x(value: number);
  83041. /** Gets or sets the y coordinate */
  83042. get y(): number;
  83043. set y(value: number);
  83044. /** Gets or sets the z coordinate */
  83045. get z(): number;
  83046. set z(value: number);
  83047. /** Gets or sets the w coordinate */
  83048. get w(): number;
  83049. set w(value: number);
  83050. /**
  83051. * Creates a new Quaternion from the given floats
  83052. * @param x defines the first component (0 by default)
  83053. * @param y defines the second component (0 by default)
  83054. * @param z defines the third component (0 by default)
  83055. * @param w defines the fourth component (1.0 by default)
  83056. */
  83057. constructor(x?: number, y?: number, z?: number, w?: number);
  83058. /**
  83059. * Gets a string representation for the current quaternion
  83060. * @returns a string with the Quaternion coordinates
  83061. */
  83062. toString(): string;
  83063. /**
  83064. * Gets the class name of the quaternion
  83065. * @returns the string "Quaternion"
  83066. */
  83067. getClassName(): string;
  83068. /**
  83069. * Gets a hash code for this quaternion
  83070. * @returns the quaternion hash code
  83071. */
  83072. getHashCode(): number;
  83073. /**
  83074. * Copy the quaternion to an array
  83075. * @returns a new array populated with 4 elements from the quaternion coordinates
  83076. */
  83077. asArray(): number[];
  83078. /**
  83079. * Check if two quaternions are equals
  83080. * @param otherQuaternion defines the second operand
  83081. * @return true if the current quaternion and the given one coordinates are strictly equals
  83082. */
  83083. equals(otherQuaternion: DeepImmutable<Quaternion>): boolean;
  83084. /**
  83085. * Gets a boolean if two quaternions are equals (using an epsilon value)
  83086. * @param otherQuaternion defines the other quaternion
  83087. * @param epsilon defines the minimal distance to consider equality
  83088. * @returns true if the given quaternion coordinates are close to the current ones by a distance of epsilon.
  83089. */
  83090. equalsWithEpsilon(otherQuaternion: DeepImmutable<Quaternion>, epsilon?: number): boolean;
  83091. /**
  83092. * Clone the current quaternion
  83093. * @returns a new quaternion copied from the current one
  83094. */
  83095. clone(): Quaternion;
  83096. /**
  83097. * Copy a quaternion to the current one
  83098. * @param other defines the other quaternion
  83099. * @returns the updated current quaternion
  83100. */
  83101. copyFrom(other: DeepImmutable<Quaternion>): Quaternion;
  83102. /**
  83103. * Updates the current quaternion with the given float coordinates
  83104. * @param x defines the x coordinate
  83105. * @param y defines the y coordinate
  83106. * @param z defines the z coordinate
  83107. * @param w defines the w coordinate
  83108. * @returns the updated current quaternion
  83109. */
  83110. copyFromFloats(x: number, y: number, z: number, w: number): Quaternion;
  83111. /**
  83112. * Updates the current quaternion from the given float coordinates
  83113. * @param x defines the x coordinate
  83114. * @param y defines the y coordinate
  83115. * @param z defines the z coordinate
  83116. * @param w defines the w coordinate
  83117. * @returns the updated current quaternion
  83118. */
  83119. set(x: number, y: number, z: number, w: number): Quaternion;
  83120. /**
  83121. * Adds two quaternions
  83122. * @param other defines the second operand
  83123. * @returns a new quaternion as the addition result of the given one and the current quaternion
  83124. */
  83125. add(other: DeepImmutable<Quaternion>): Quaternion;
  83126. /**
  83127. * Add a quaternion to the current one
  83128. * @param other defines the quaternion to add
  83129. * @returns the current quaternion
  83130. */
  83131. addInPlace(other: DeepImmutable<Quaternion>): Quaternion;
  83132. /**
  83133. * Subtract two quaternions
  83134. * @param other defines the second operand
  83135. * @returns a new quaternion as the subtraction result of the given one from the current one
  83136. */
  83137. subtract(other: Quaternion): Quaternion;
  83138. /**
  83139. * Multiplies the current quaternion by a scale factor
  83140. * @param value defines the scale factor
  83141. * @returns a new quaternion set by multiplying the current quaternion coordinates by the float "scale"
  83142. */
  83143. scale(value: number): Quaternion;
  83144. /**
  83145. * Scale the current quaternion values by a factor and stores the result to a given quaternion
  83146. * @param scale defines the scale factor
  83147. * @param result defines the Quaternion object where to store the result
  83148. * @returns the unmodified current quaternion
  83149. */
  83150. scaleToRef(scale: number, result: Quaternion): Quaternion;
  83151. /**
  83152. * Multiplies in place the current quaternion by a scale factor
  83153. * @param value defines the scale factor
  83154. * @returns the current modified quaternion
  83155. */
  83156. scaleInPlace(value: number): Quaternion;
  83157. /**
  83158. * Scale the current quaternion values by a factor and add the result to a given quaternion
  83159. * @param scale defines the scale factor
  83160. * @param result defines the Quaternion object where to store the result
  83161. * @returns the unmodified current quaternion
  83162. */
  83163. scaleAndAddToRef(scale: number, result: Quaternion): Quaternion;
  83164. /**
  83165. * Multiplies two quaternions
  83166. * @param q1 defines the second operand
  83167. * @returns a new quaternion set as the multiplication result of the current one with the given one "q1"
  83168. */
  83169. multiply(q1: DeepImmutable<Quaternion>): Quaternion;
  83170. /**
  83171. * Sets the given "result" as the the multiplication result of the current one with the given one "q1"
  83172. * @param q1 defines the second operand
  83173. * @param result defines the target quaternion
  83174. * @returns the current quaternion
  83175. */
  83176. multiplyToRef(q1: DeepImmutable<Quaternion>, result: Quaternion): Quaternion;
  83177. /**
  83178. * Updates the current quaternion with the multiplication of itself with the given one "q1"
  83179. * @param q1 defines the second operand
  83180. * @returns the currentupdated quaternion
  83181. */
  83182. multiplyInPlace(q1: DeepImmutable<Quaternion>): Quaternion;
  83183. /**
  83184. * Conjugates (1-q) the current quaternion and stores the result in the given quaternion
  83185. * @param ref defines the target quaternion
  83186. * @returns the current quaternion
  83187. */
  83188. conjugateToRef(ref: Quaternion): Quaternion;
  83189. /**
  83190. * Conjugates in place (1-q) the current quaternion
  83191. * @returns the current updated quaternion
  83192. */
  83193. conjugateInPlace(): Quaternion;
  83194. /**
  83195. * Conjugates in place (1-q) the current quaternion
  83196. * @returns a new quaternion
  83197. */
  83198. conjugate(): Quaternion;
  83199. /**
  83200. * Gets length of current quaternion
  83201. * @returns the quaternion length (float)
  83202. */
  83203. length(): number;
  83204. /**
  83205. * Normalize in place the current quaternion
  83206. * @returns the current updated quaternion
  83207. */
  83208. normalize(): Quaternion;
  83209. /**
  83210. * Returns a new Vector3 set with the Euler angles translated from the current quaternion
  83211. * @param order is a reserved parameter and is ignore for now
  83212. * @returns a new Vector3 containing the Euler angles
  83213. */
  83214. toEulerAngles(order?: string): Vector3;
  83215. /**
  83216. * Sets the given vector3 "result" with the Euler angles translated from the current quaternion
  83217. * @param result defines the vector which will be filled with the Euler angles
  83218. * @param order is a reserved parameter and is ignore for now
  83219. * @returns the current unchanged quaternion
  83220. */
  83221. toEulerAnglesToRef(result: Vector3): Quaternion;
  83222. /**
  83223. * Updates the given rotation matrix with the current quaternion values
  83224. * @param result defines the target matrix
  83225. * @returns the current unchanged quaternion
  83226. */
  83227. toRotationMatrix(result: Matrix): Quaternion;
  83228. /**
  83229. * Updates the current quaternion from the given rotation matrix values
  83230. * @param matrix defines the source matrix
  83231. * @returns the current updated quaternion
  83232. */
  83233. fromRotationMatrix(matrix: DeepImmutable<Matrix>): Quaternion;
  83234. /**
  83235. * Creates a new quaternion from a rotation matrix
  83236. * @param matrix defines the source matrix
  83237. * @returns a new quaternion created from the given rotation matrix values
  83238. */
  83239. static FromRotationMatrix(matrix: DeepImmutable<Matrix>): Quaternion;
  83240. /**
  83241. * Updates the given quaternion with the given rotation matrix values
  83242. * @param matrix defines the source matrix
  83243. * @param result defines the target quaternion
  83244. */
  83245. static FromRotationMatrixToRef(matrix: DeepImmutable<Matrix>, result: Quaternion): void;
  83246. /**
  83247. * Returns the dot product (float) between the quaternions "left" and "right"
  83248. * @param left defines the left operand
  83249. * @param right defines the right operand
  83250. * @returns the dot product
  83251. */
  83252. static Dot(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>): number;
  83253. /**
  83254. * Checks if the two quaternions are close to each other
  83255. * @param quat0 defines the first quaternion to check
  83256. * @param quat1 defines the second quaternion to check
  83257. * @returns true if the two quaternions are close to each other
  83258. */
  83259. static AreClose(quat0: DeepImmutable<Quaternion>, quat1: DeepImmutable<Quaternion>): boolean;
  83260. /**
  83261. * Creates an empty quaternion
  83262. * @returns a new quaternion set to (0.0, 0.0, 0.0)
  83263. */
  83264. static Zero(): Quaternion;
  83265. /**
  83266. * Inverse a given quaternion
  83267. * @param q defines the source quaternion
  83268. * @returns a new quaternion as the inverted current quaternion
  83269. */
  83270. static Inverse(q: DeepImmutable<Quaternion>): Quaternion;
  83271. /**
  83272. * Inverse a given quaternion
  83273. * @param q defines the source quaternion
  83274. * @param result the quaternion the result will be stored in
  83275. * @returns the result quaternion
  83276. */
  83277. static InverseToRef(q: Quaternion, result: Quaternion): Quaternion;
  83278. /**
  83279. * Creates an identity quaternion
  83280. * @returns the identity quaternion
  83281. */
  83282. static Identity(): Quaternion;
  83283. /**
  83284. * Gets a boolean indicating if the given quaternion is identity
  83285. * @param quaternion defines the quaternion to check
  83286. * @returns true if the quaternion is identity
  83287. */
  83288. static IsIdentity(quaternion: DeepImmutable<Quaternion>): boolean;
  83289. /**
  83290. * Creates a quaternion from a rotation around an axis
  83291. * @param axis defines the axis to use
  83292. * @param angle defines the angle to use
  83293. * @returns a new quaternion created from the given axis (Vector3) and angle in radians (float)
  83294. */
  83295. static RotationAxis(axis: DeepImmutable<Vector3>, angle: number): Quaternion;
  83296. /**
  83297. * Creates a rotation around an axis and stores it into the given quaternion
  83298. * @param axis defines the axis to use
  83299. * @param angle defines the angle to use
  83300. * @param result defines the target quaternion
  83301. * @returns the target quaternion
  83302. */
  83303. static RotationAxisToRef(axis: DeepImmutable<Vector3>, angle: number, result: Quaternion): Quaternion;
  83304. /**
  83305. * Creates a new quaternion from data stored into an array
  83306. * @param array defines the data source
  83307. * @param offset defines the offset in the source array where the data starts
  83308. * @returns a new quaternion
  83309. */
  83310. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Quaternion;
  83311. /**
  83312. * Updates the given quaternion "result" from the starting index of the given array.
  83313. * @param array the array to pull values from
  83314. * @param offset the offset into the array to start at
  83315. * @param result the quaternion to store the result in
  83316. */
  83317. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Quaternion): void;
  83318. /**
  83319. * Create a quaternion from Euler rotation angles
  83320. * @param x Pitch
  83321. * @param y Yaw
  83322. * @param z Roll
  83323. * @returns the new Quaternion
  83324. */
  83325. static FromEulerAngles(x: number, y: number, z: number): Quaternion;
  83326. /**
  83327. * Updates a quaternion from Euler rotation angles
  83328. * @param x Pitch
  83329. * @param y Yaw
  83330. * @param z Roll
  83331. * @param result the quaternion to store the result
  83332. * @returns the updated quaternion
  83333. */
  83334. static FromEulerAnglesToRef(x: number, y: number, z: number, result: Quaternion): Quaternion;
  83335. /**
  83336. * Create a quaternion from Euler rotation vector
  83337. * @param vec the Euler vector (x Pitch, y Yaw, z Roll)
  83338. * @returns the new Quaternion
  83339. */
  83340. static FromEulerVector(vec: DeepImmutable<Vector3>): Quaternion;
  83341. /**
  83342. * Updates a quaternion from Euler rotation vector
  83343. * @param vec the Euler vector (x Pitch, y Yaw, z Roll)
  83344. * @param result the quaternion to store the result
  83345. * @returns the updated quaternion
  83346. */
  83347. static FromEulerVectorToRef(vec: DeepImmutable<Vector3>, result: Quaternion): Quaternion;
  83348. /**
  83349. * Creates a new quaternion from the given Euler float angles (y, x, z)
  83350. * @param yaw defines the rotation around Y axis
  83351. * @param pitch defines the rotation around X axis
  83352. * @param roll defines the rotation around Z axis
  83353. * @returns the new quaternion
  83354. */
  83355. static RotationYawPitchRoll(yaw: number, pitch: number, roll: number): Quaternion;
  83356. /**
  83357. * Creates a new rotation from the given Euler float angles (y, x, z) and stores it in the target quaternion
  83358. * @param yaw defines the rotation around Y axis
  83359. * @param pitch defines the rotation around X axis
  83360. * @param roll defines the rotation around Z axis
  83361. * @param result defines the target quaternion
  83362. */
  83363. static RotationYawPitchRollToRef(yaw: number, pitch: number, roll: number, result: Quaternion): void;
  83364. /**
  83365. * Creates a new quaternion from the given Euler float angles expressed in z-x-z orientation
  83366. * @param alpha defines the rotation around first axis
  83367. * @param beta defines the rotation around second axis
  83368. * @param gamma defines the rotation around third axis
  83369. * @returns the new quaternion
  83370. */
  83371. static RotationAlphaBetaGamma(alpha: number, beta: number, gamma: number): Quaternion;
  83372. /**
  83373. * Creates a new quaternion from the given Euler float angles expressed in z-x-z orientation and stores it in the target quaternion
  83374. * @param alpha defines the rotation around first axis
  83375. * @param beta defines the rotation around second axis
  83376. * @param gamma defines the rotation around third axis
  83377. * @param result defines the target quaternion
  83378. */
  83379. static RotationAlphaBetaGammaToRef(alpha: number, beta: number, gamma: number, result: Quaternion): void;
  83380. /**
  83381. * 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)
  83382. * @param axis1 defines the first axis
  83383. * @param axis2 defines the second axis
  83384. * @param axis3 defines the third axis
  83385. * @returns the new quaternion
  83386. */
  83387. static RotationQuaternionFromAxis(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>): Quaternion;
  83388. /**
  83389. * 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
  83390. * @param axis1 defines the first axis
  83391. * @param axis2 defines the second axis
  83392. * @param axis3 defines the third axis
  83393. * @param ref defines the target quaternion
  83394. */
  83395. static RotationQuaternionFromAxisToRef(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>, ref: Quaternion): void;
  83396. /**
  83397. * Interpolates between two quaternions
  83398. * @param left defines first quaternion
  83399. * @param right defines second quaternion
  83400. * @param amount defines the gradient to use
  83401. * @returns the new interpolated quaternion
  83402. */
  83403. static Slerp(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>, amount: number): Quaternion;
  83404. /**
  83405. * Interpolates between two quaternions and stores it into a target quaternion
  83406. * @param left defines first quaternion
  83407. * @param right defines second quaternion
  83408. * @param amount defines the gradient to use
  83409. * @param result defines the target quaternion
  83410. */
  83411. static SlerpToRef(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>, amount: number, result: Quaternion): void;
  83412. /**
  83413. * Interpolate between two quaternions using Hermite interpolation
  83414. * @param value1 defines first quaternion
  83415. * @param tangent1 defines the incoming tangent
  83416. * @param value2 defines second quaternion
  83417. * @param tangent2 defines the outgoing tangent
  83418. * @param amount defines the target quaternion
  83419. * @returns the new interpolated quaternion
  83420. */
  83421. static Hermite(value1: DeepImmutable<Quaternion>, tangent1: DeepImmutable<Quaternion>, value2: DeepImmutable<Quaternion>, tangent2: DeepImmutable<Quaternion>, amount: number): Quaternion;
  83422. }
  83423. /**
  83424. * Class used to store matrix data (4x4)
  83425. */
  83426. export class Matrix {
  83427. /**
  83428. * Gets the precision of matrix computations
  83429. */
  83430. static get Use64Bits(): boolean;
  83431. private static _updateFlagSeed;
  83432. private static _identityReadOnly;
  83433. private _isIdentity;
  83434. private _isIdentityDirty;
  83435. private _isIdentity3x2;
  83436. private _isIdentity3x2Dirty;
  83437. /**
  83438. * Gets the update flag of the matrix which is an unique number for the matrix.
  83439. * It will be incremented every time the matrix data change.
  83440. * You can use it to speed the comparison between two versions of the same matrix.
  83441. */
  83442. updateFlag: number;
  83443. private readonly _m;
  83444. /**
  83445. * Gets the internal data of the matrix
  83446. */
  83447. get m(): DeepImmutable<Float32Array | Array<number>>;
  83448. /** @hidden */
  83449. _markAsUpdated(): void;
  83450. /** @hidden */
  83451. private _updateIdentityStatus;
  83452. /**
  83453. * Creates an empty matrix (filled with zeros)
  83454. */
  83455. constructor();
  83456. /**
  83457. * Check if the current matrix is identity
  83458. * @returns true is the matrix is the identity matrix
  83459. */
  83460. isIdentity(): boolean;
  83461. /**
  83462. * Check if the current matrix is identity as a texture matrix (3x2 store in 4x4)
  83463. * @returns true is the matrix is the identity matrix
  83464. */
  83465. isIdentityAs3x2(): boolean;
  83466. /**
  83467. * Gets the determinant of the matrix
  83468. * @returns the matrix determinant
  83469. */
  83470. determinant(): number;
  83471. /**
  83472. * Returns the matrix as a Float32Array or Array<number>
  83473. * @returns the matrix underlying array
  83474. */
  83475. toArray(): DeepImmutable<Float32Array | Array<number>>;
  83476. /**
  83477. * Returns the matrix as a Float32Array or Array<number>
  83478. * @returns the matrix underlying array.
  83479. */
  83480. asArray(): DeepImmutable<Float32Array | Array<number>>;
  83481. /**
  83482. * Inverts the current matrix in place
  83483. * @returns the current inverted matrix
  83484. */
  83485. invert(): Matrix;
  83486. /**
  83487. * Sets all the matrix elements to zero
  83488. * @returns the current matrix
  83489. */
  83490. reset(): Matrix;
  83491. /**
  83492. * Adds the current matrix with a second one
  83493. * @param other defines the matrix to add
  83494. * @returns a new matrix as the addition of the current matrix and the given one
  83495. */
  83496. add(other: DeepImmutable<Matrix>): Matrix;
  83497. /**
  83498. * Sets the given matrix "result" to the addition of the current matrix and the given one
  83499. * @param other defines the matrix to add
  83500. * @param result defines the target matrix
  83501. * @returns the current matrix
  83502. */
  83503. addToRef(other: DeepImmutable<Matrix>, result: Matrix): Matrix;
  83504. /**
  83505. * Adds in place the given matrix to the current matrix
  83506. * @param other defines the second operand
  83507. * @returns the current updated matrix
  83508. */
  83509. addToSelf(other: DeepImmutable<Matrix>): Matrix;
  83510. /**
  83511. * Sets the given matrix to the current inverted Matrix
  83512. * @param other defines the target matrix
  83513. * @returns the unmodified current matrix
  83514. */
  83515. invertToRef(other: Matrix): Matrix;
  83516. /**
  83517. * add a value at the specified position in the current Matrix
  83518. * @param index the index of the value within the matrix. between 0 and 15.
  83519. * @param value the value to be added
  83520. * @returns the current updated matrix
  83521. */
  83522. addAtIndex(index: number, value: number): Matrix;
  83523. /**
  83524. * mutiply the specified position in the current Matrix by a value
  83525. * @param index the index of the value within the matrix. between 0 and 15.
  83526. * @param value the value to be added
  83527. * @returns the current updated matrix
  83528. */
  83529. multiplyAtIndex(index: number, value: number): Matrix;
  83530. /**
  83531. * Inserts the translation vector (using 3 floats) in the current matrix
  83532. * @param x defines the 1st component of the translation
  83533. * @param y defines the 2nd component of the translation
  83534. * @param z defines the 3rd component of the translation
  83535. * @returns the current updated matrix
  83536. */
  83537. setTranslationFromFloats(x: number, y: number, z: number): Matrix;
  83538. /**
  83539. * Adds the translation vector (using 3 floats) in the current matrix
  83540. * @param x defines the 1st component of the translation
  83541. * @param y defines the 2nd component of the translation
  83542. * @param z defines the 3rd component of the translation
  83543. * @returns the current updated matrix
  83544. */
  83545. addTranslationFromFloats(x: number, y: number, z: number): Matrix;
  83546. /**
  83547. * Inserts the translation vector in the current matrix
  83548. * @param vector3 defines the translation to insert
  83549. * @returns the current updated matrix
  83550. */
  83551. setTranslation(vector3: DeepImmutable<Vector3>): Matrix;
  83552. /**
  83553. * Gets the translation value of the current matrix
  83554. * @returns a new Vector3 as the extracted translation from the matrix
  83555. */
  83556. getTranslation(): Vector3;
  83557. /**
  83558. * Fill a Vector3 with the extracted translation from the matrix
  83559. * @param result defines the Vector3 where to store the translation
  83560. * @returns the current matrix
  83561. */
  83562. getTranslationToRef(result: Vector3): Matrix;
  83563. /**
  83564. * Remove rotation and scaling part from the matrix
  83565. * @returns the updated matrix
  83566. */
  83567. removeRotationAndScaling(): Matrix;
  83568. /**
  83569. * Multiply two matrices
  83570. * @param other defines the second operand
  83571. * @returns a new matrix set with the multiplication result of the current Matrix and the given one
  83572. */
  83573. multiply(other: DeepImmutable<Matrix>): Matrix;
  83574. /**
  83575. * Copy the current matrix from the given one
  83576. * @param other defines the source matrix
  83577. * @returns the current updated matrix
  83578. */
  83579. copyFrom(other: DeepImmutable<Matrix>): Matrix;
  83580. /**
  83581. * Populates the given array from the starting index with the current matrix values
  83582. * @param array defines the target array
  83583. * @param offset defines the offset in the target array where to start storing values
  83584. * @returns the current matrix
  83585. */
  83586. copyToArray(array: Float32Array | Array<number>, offset?: number): Matrix;
  83587. /**
  83588. * Sets the given matrix "result" with the multiplication result of the current Matrix and the given one
  83589. * @param other defines the second operand
  83590. * @param result defines the matrix where to store the multiplication
  83591. * @returns the current matrix
  83592. */
  83593. multiplyToRef(other: DeepImmutable<Matrix>, result: Matrix): Matrix;
  83594. /**
  83595. * Sets the Float32Array "result" from the given index "offset" with the multiplication of the current matrix and the given one
  83596. * @param other defines the second operand
  83597. * @param result defines the array where to store the multiplication
  83598. * @param offset defines the offset in the target array where to start storing values
  83599. * @returns the current matrix
  83600. */
  83601. multiplyToArray(other: DeepImmutable<Matrix>, result: Float32Array | Array<number>, offset: number): Matrix;
  83602. /**
  83603. * Check equality between this matrix and a second one
  83604. * @param value defines the second matrix to compare
  83605. * @returns true is the current matrix and the given one values are strictly equal
  83606. */
  83607. equals(value: DeepImmutable<Matrix>): boolean;
  83608. /**
  83609. * Clone the current matrix
  83610. * @returns a new matrix from the current matrix
  83611. */
  83612. clone(): Matrix;
  83613. /**
  83614. * Returns the name of the current matrix class
  83615. * @returns the string "Matrix"
  83616. */
  83617. getClassName(): string;
  83618. /**
  83619. * Gets the hash code of the current matrix
  83620. * @returns the hash code
  83621. */
  83622. getHashCode(): number;
  83623. /**
  83624. * Decomposes the current Matrix into a translation, rotation and scaling components
  83625. * @param scale defines the scale vector3 given as a reference to update
  83626. * @param rotation defines the rotation quaternion given as a reference to update
  83627. * @param translation defines the translation vector3 given as a reference to update
  83628. * @returns true if operation was successful
  83629. */
  83630. decompose(scale?: Vector3, rotation?: Quaternion, translation?: Vector3): boolean;
  83631. /**
  83632. * Gets specific row of the matrix
  83633. * @param index defines the number of the row to get
  83634. * @returns the index-th row of the current matrix as a new Vector4
  83635. */
  83636. getRow(index: number): Nullable<Vector4>;
  83637. /**
  83638. * Sets the index-th row of the current matrix to the vector4 values
  83639. * @param index defines the number of the row to set
  83640. * @param row defines the target vector4
  83641. * @returns the updated current matrix
  83642. */
  83643. setRow(index: number, row: Vector4): Matrix;
  83644. /**
  83645. * Compute the transpose of the matrix
  83646. * @returns the new transposed matrix
  83647. */
  83648. transpose(): Matrix;
  83649. /**
  83650. * Compute the transpose of the matrix and store it in a given matrix
  83651. * @param result defines the target matrix
  83652. * @returns the current matrix
  83653. */
  83654. transposeToRef(result: Matrix): Matrix;
  83655. /**
  83656. * Sets the index-th row of the current matrix with the given 4 x float values
  83657. * @param index defines the row index
  83658. * @param x defines the x component to set
  83659. * @param y defines the y component to set
  83660. * @param z defines the z component to set
  83661. * @param w defines the w component to set
  83662. * @returns the updated current matrix
  83663. */
  83664. setRowFromFloats(index: number, x: number, y: number, z: number, w: number): Matrix;
  83665. /**
  83666. * Compute a new matrix set with the current matrix values multiplied by scale (float)
  83667. * @param scale defines the scale factor
  83668. * @returns a new matrix
  83669. */
  83670. scale(scale: number): Matrix;
  83671. /**
  83672. * Scale the current matrix values by a factor to a given result matrix
  83673. * @param scale defines the scale factor
  83674. * @param result defines the matrix to store the result
  83675. * @returns the current matrix
  83676. */
  83677. scaleToRef(scale: number, result: Matrix): Matrix;
  83678. /**
  83679. * Scale the current matrix values by a factor and add the result to a given matrix
  83680. * @param scale defines the scale factor
  83681. * @param result defines the Matrix to store the result
  83682. * @returns the current matrix
  83683. */
  83684. scaleAndAddToRef(scale: number, result: Matrix): Matrix;
  83685. /**
  83686. * Writes to the given matrix a normal matrix, computed from this one (using values from identity matrix for fourth row and column).
  83687. * @param ref matrix to store the result
  83688. */
  83689. toNormalMatrix(ref: Matrix): void;
  83690. /**
  83691. * Gets only rotation part of the current matrix
  83692. * @returns a new matrix sets to the extracted rotation matrix from the current one
  83693. */
  83694. getRotationMatrix(): Matrix;
  83695. /**
  83696. * Extracts the rotation matrix from the current one and sets it as the given "result"
  83697. * @param result defines the target matrix to store data to
  83698. * @returns the current matrix
  83699. */
  83700. getRotationMatrixToRef(result: Matrix): Matrix;
  83701. /**
  83702. * Toggles model matrix from being right handed to left handed in place and vice versa
  83703. */
  83704. toggleModelMatrixHandInPlace(): void;
  83705. /**
  83706. * Toggles projection matrix from being right handed to left handed in place and vice versa
  83707. */
  83708. toggleProjectionMatrixHandInPlace(): void;
  83709. /**
  83710. * Creates a matrix from an array
  83711. * @param array defines the source array
  83712. * @param offset defines an offset in the source array
  83713. * @returns a new Matrix set from the starting index of the given array
  83714. */
  83715. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Matrix;
  83716. /**
  83717. * Copy the content of an array into a given matrix
  83718. * @param array defines the source array
  83719. * @param offset defines an offset in the source array
  83720. * @param result defines the target matrix
  83721. */
  83722. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Matrix): void;
  83723. /**
  83724. * Stores an array into a matrix after having multiplied each component by a given factor
  83725. * @param array defines the source array
  83726. * @param offset defines the offset in the source array
  83727. * @param scale defines the scaling factor
  83728. * @param result defines the target matrix
  83729. */
  83730. static FromFloat32ArrayToRefScaled(array: DeepImmutable<Float32Array | Array<number>>, offset: number, scale: number, result: Matrix): void;
  83731. /**
  83732. * Gets an identity matrix that must not be updated
  83733. */
  83734. static get IdentityReadOnly(): DeepImmutable<Matrix>;
  83735. /**
  83736. * Stores a list of values (16) inside a given matrix
  83737. * @param initialM11 defines 1st value of 1st row
  83738. * @param initialM12 defines 2nd value of 1st row
  83739. * @param initialM13 defines 3rd value of 1st row
  83740. * @param initialM14 defines 4th value of 1st row
  83741. * @param initialM21 defines 1st value of 2nd row
  83742. * @param initialM22 defines 2nd value of 2nd row
  83743. * @param initialM23 defines 3rd value of 2nd row
  83744. * @param initialM24 defines 4th value of 2nd row
  83745. * @param initialM31 defines 1st value of 3rd row
  83746. * @param initialM32 defines 2nd value of 3rd row
  83747. * @param initialM33 defines 3rd value of 3rd row
  83748. * @param initialM34 defines 4th value of 3rd row
  83749. * @param initialM41 defines 1st value of 4th row
  83750. * @param initialM42 defines 2nd value of 4th row
  83751. * @param initialM43 defines 3rd value of 4th row
  83752. * @param initialM44 defines 4th value of 4th row
  83753. * @param result defines the target matrix
  83754. */
  83755. 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;
  83756. /**
  83757. * Creates new matrix from a list of values (16)
  83758. * @param initialM11 defines 1st value of 1st row
  83759. * @param initialM12 defines 2nd value of 1st row
  83760. * @param initialM13 defines 3rd value of 1st row
  83761. * @param initialM14 defines 4th value of 1st row
  83762. * @param initialM21 defines 1st value of 2nd row
  83763. * @param initialM22 defines 2nd value of 2nd row
  83764. * @param initialM23 defines 3rd value of 2nd row
  83765. * @param initialM24 defines 4th value of 2nd row
  83766. * @param initialM31 defines 1st value of 3rd row
  83767. * @param initialM32 defines 2nd value of 3rd row
  83768. * @param initialM33 defines 3rd value of 3rd row
  83769. * @param initialM34 defines 4th value of 3rd row
  83770. * @param initialM41 defines 1st value of 4th row
  83771. * @param initialM42 defines 2nd value of 4th row
  83772. * @param initialM43 defines 3rd value of 4th row
  83773. * @param initialM44 defines 4th value of 4th row
  83774. * @returns the new matrix
  83775. */
  83776. 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;
  83777. /**
  83778. * Creates a new matrix composed by merging scale (vector3), rotation (quaternion) and translation (vector3)
  83779. * @param scale defines the scale vector3
  83780. * @param rotation defines the rotation quaternion
  83781. * @param translation defines the translation vector3
  83782. * @returns a new matrix
  83783. */
  83784. static Compose(scale: DeepImmutable<Vector3>, rotation: DeepImmutable<Quaternion>, translation: DeepImmutable<Vector3>): Matrix;
  83785. /**
  83786. * Sets a matrix to a value composed by merging scale (vector3), rotation (quaternion) and translation (vector3)
  83787. * @param scale defines the scale vector3
  83788. * @param rotation defines the rotation quaternion
  83789. * @param translation defines the translation vector3
  83790. * @param result defines the target matrix
  83791. */
  83792. static ComposeToRef(scale: DeepImmutable<Vector3>, rotation: DeepImmutable<Quaternion>, translation: DeepImmutable<Vector3>, result: Matrix): void;
  83793. /**
  83794. * Creates a new identity matrix
  83795. * @returns a new identity matrix
  83796. */
  83797. static Identity(): Matrix;
  83798. /**
  83799. * Creates a new identity matrix and stores the result in a given matrix
  83800. * @param result defines the target matrix
  83801. */
  83802. static IdentityToRef(result: Matrix): void;
  83803. /**
  83804. * Creates a new zero matrix
  83805. * @returns a new zero matrix
  83806. */
  83807. static Zero(): Matrix;
  83808. /**
  83809. * Creates a new rotation matrix for "angle" radians around the X axis
  83810. * @param angle defines the angle (in radians) to use
  83811. * @return the new matrix
  83812. */
  83813. static RotationX(angle: number): Matrix;
  83814. /**
  83815. * Creates a new matrix as the invert of a given matrix
  83816. * @param source defines the source matrix
  83817. * @returns the new matrix
  83818. */
  83819. static Invert(source: DeepImmutable<Matrix>): Matrix;
  83820. /**
  83821. * Creates a new rotation matrix for "angle" radians around the X axis and stores it in a given matrix
  83822. * @param angle defines the angle (in radians) to use
  83823. * @param result defines the target matrix
  83824. */
  83825. static RotationXToRef(angle: number, result: Matrix): void;
  83826. /**
  83827. * Creates a new rotation matrix for "angle" radians around the Y axis
  83828. * @param angle defines the angle (in radians) to use
  83829. * @return the new matrix
  83830. */
  83831. static RotationY(angle: number): Matrix;
  83832. /**
  83833. * Creates a new rotation matrix for "angle" radians around the Y axis and stores it in a given matrix
  83834. * @param angle defines the angle (in radians) to use
  83835. * @param result defines the target matrix
  83836. */
  83837. static RotationYToRef(angle: number, result: Matrix): void;
  83838. /**
  83839. * Creates a new rotation matrix for "angle" radians around the Z axis
  83840. * @param angle defines the angle (in radians) to use
  83841. * @return the new matrix
  83842. */
  83843. static RotationZ(angle: number): Matrix;
  83844. /**
  83845. * Creates a new rotation matrix for "angle" radians around the Z axis and stores it in a given matrix
  83846. * @param angle defines the angle (in radians) to use
  83847. * @param result defines the target matrix
  83848. */
  83849. static RotationZToRef(angle: number, result: Matrix): void;
  83850. /**
  83851. * Creates a new rotation matrix for "angle" radians around the given axis
  83852. * @param axis defines the axis to use
  83853. * @param angle defines the angle (in radians) to use
  83854. * @return the new matrix
  83855. */
  83856. static RotationAxis(axis: DeepImmutable<Vector3>, angle: number): Matrix;
  83857. /**
  83858. * Creates a new rotation matrix for "angle" radians around the given axis and stores it in a given matrix
  83859. * @param axis defines the axis to use
  83860. * @param angle defines the angle (in radians) to use
  83861. * @param result defines the target matrix
  83862. */
  83863. static RotationAxisToRef(axis: DeepImmutable<Vector3>, angle: number, result: Matrix): void;
  83864. /**
  83865. * Takes normalised vectors and returns a rotation matrix to align "from" with "to".
  83866. * Taken from http://www.iquilezles.org/www/articles/noacos/noacos.htm
  83867. * @param from defines the vector to align
  83868. * @param to defines the vector to align to
  83869. * @param result defines the target matrix
  83870. */
  83871. static RotationAlignToRef(from: DeepImmutable<Vector3>, to: DeepImmutable<Vector3>, result: Matrix): void;
  83872. /**
  83873. * Creates a rotation matrix
  83874. * @param yaw defines the yaw angle in radians (Y axis)
  83875. * @param pitch defines the pitch angle in radians (X axis)
  83876. * @param roll defines the roll angle in radians (Z axis)
  83877. * @returns the new rotation matrix
  83878. */
  83879. static RotationYawPitchRoll(yaw: number, pitch: number, roll: number): Matrix;
  83880. /**
  83881. * Creates a rotation matrix and stores it in a given matrix
  83882. * @param yaw defines the yaw angle in radians (Y axis)
  83883. * @param pitch defines the pitch angle in radians (X axis)
  83884. * @param roll defines the roll angle in radians (Z axis)
  83885. * @param result defines the target matrix
  83886. */
  83887. static RotationYawPitchRollToRef(yaw: number, pitch: number, roll: number, result: Matrix): void;
  83888. /**
  83889. * Creates a scaling matrix
  83890. * @param x defines the scale factor on X axis
  83891. * @param y defines the scale factor on Y axis
  83892. * @param z defines the scale factor on Z axis
  83893. * @returns the new matrix
  83894. */
  83895. static Scaling(x: number, y: number, z: number): Matrix;
  83896. /**
  83897. * Creates a scaling matrix and stores it in a given matrix
  83898. * @param x defines the scale factor on X axis
  83899. * @param y defines the scale factor on Y axis
  83900. * @param z defines the scale factor on Z axis
  83901. * @param result defines the target matrix
  83902. */
  83903. static ScalingToRef(x: number, y: number, z: number, result: Matrix): void;
  83904. /**
  83905. * Creates a translation matrix
  83906. * @param x defines the translation on X axis
  83907. * @param y defines the translation on Y axis
  83908. * @param z defines the translationon Z axis
  83909. * @returns the new matrix
  83910. */
  83911. static Translation(x: number, y: number, z: number): Matrix;
  83912. /**
  83913. * Creates a translation matrix and stores it in a given matrix
  83914. * @param x defines the translation on X axis
  83915. * @param y defines the translation on Y axis
  83916. * @param z defines the translationon Z axis
  83917. * @param result defines the target matrix
  83918. */
  83919. static TranslationToRef(x: number, y: number, z: number, result: Matrix): void;
  83920. /**
  83921. * Returns a new Matrix whose values are the interpolated values for "gradient" (float) between the ones of the matrices "startValue" and "endValue".
  83922. * @param startValue defines the start value
  83923. * @param endValue defines the end value
  83924. * @param gradient defines the gradient factor
  83925. * @returns the new matrix
  83926. */
  83927. static Lerp(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number): Matrix;
  83928. /**
  83929. * Set the given matrix "result" as the interpolated values for "gradient" (float) between the ones of the matrices "startValue" and "endValue".
  83930. * @param startValue defines the start value
  83931. * @param endValue defines the end value
  83932. * @param gradient defines the gradient factor
  83933. * @param result defines the Matrix object where to store data
  83934. */
  83935. static LerpToRef(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number, result: Matrix): void;
  83936. /**
  83937. * Builds a new matrix whose values are computed by:
  83938. * * decomposing the the "startValue" and "endValue" matrices into their respective scale, rotation and translation matrices
  83939. * * interpolating for "gradient" (float) the values between each of these decomposed matrices between the start and the end
  83940. * * recomposing a new matrix from these 3 interpolated scale, rotation and translation matrices
  83941. * @param startValue defines the first matrix
  83942. * @param endValue defines the second matrix
  83943. * @param gradient defines the gradient between the two matrices
  83944. * @returns the new matrix
  83945. */
  83946. static DecomposeLerp(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number): Matrix;
  83947. /**
  83948. * Update a matrix to values which are computed by:
  83949. * * decomposing the the "startValue" and "endValue" matrices into their respective scale, rotation and translation matrices
  83950. * * interpolating for "gradient" (float) the values between each of these decomposed matrices between the start and the end
  83951. * * recomposing a new matrix from these 3 interpolated scale, rotation and translation matrices
  83952. * @param startValue defines the first matrix
  83953. * @param endValue defines the second matrix
  83954. * @param gradient defines the gradient between the two matrices
  83955. * @param result defines the target matrix
  83956. */
  83957. static DecomposeLerpToRef(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number, result: Matrix): void;
  83958. /**
  83959. * 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"
  83960. * This function works in left handed mode
  83961. * @param eye defines the final position of the entity
  83962. * @param target defines where the entity should look at
  83963. * @param up defines the up vector for the entity
  83964. * @returns the new matrix
  83965. */
  83966. static LookAtLH(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>): Matrix;
  83967. /**
  83968. * 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".
  83969. * This function works in left handed mode
  83970. * @param eye defines the final position of the entity
  83971. * @param target defines where the entity should look at
  83972. * @param up defines the up vector for the entity
  83973. * @param result defines the target matrix
  83974. */
  83975. static LookAtLHToRef(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>, result: Matrix): void;
  83976. /**
  83977. * 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"
  83978. * This function works in right handed mode
  83979. * @param eye defines the final position of the entity
  83980. * @param target defines where the entity should look at
  83981. * @param up defines the up vector for the entity
  83982. * @returns the new matrix
  83983. */
  83984. static LookAtRH(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>): Matrix;
  83985. /**
  83986. * 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".
  83987. * This function works in right handed mode
  83988. * @param eye defines the final position of the entity
  83989. * @param target defines where the entity should look at
  83990. * @param up defines the up vector for the entity
  83991. * @param result defines the target matrix
  83992. */
  83993. static LookAtRHToRef(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>, result: Matrix): void;
  83994. /**
  83995. * Create a left-handed orthographic projection matrix
  83996. * @param width defines the viewport width
  83997. * @param height defines the viewport height
  83998. * @param znear defines the near clip plane
  83999. * @param zfar defines the far clip plane
  84000. * @returns a new matrix as a left-handed orthographic projection matrix
  84001. */
  84002. static OrthoLH(width: number, height: number, znear: number, zfar: number): Matrix;
  84003. /**
  84004. * Store a left-handed orthographic projection to a given matrix
  84005. * @param width defines the viewport width
  84006. * @param height defines the viewport height
  84007. * @param znear defines the near clip plane
  84008. * @param zfar defines the far clip plane
  84009. * @param result defines the target matrix
  84010. */
  84011. static OrthoLHToRef(width: number, height: number, znear: number, zfar: number, result: Matrix): void;
  84012. /**
  84013. * Create a left-handed orthographic projection matrix
  84014. * @param left defines the viewport left coordinate
  84015. * @param right defines the viewport right coordinate
  84016. * @param bottom defines the viewport bottom coordinate
  84017. * @param top defines the viewport top coordinate
  84018. * @param znear defines the near clip plane
  84019. * @param zfar defines the far clip plane
  84020. * @returns a new matrix as a left-handed orthographic projection matrix
  84021. */
  84022. static OrthoOffCenterLH(left: number, right: number, bottom: number, top: number, znear: number, zfar: number): Matrix;
  84023. /**
  84024. * Stores a left-handed orthographic projection into a given matrix
  84025. * @param left defines the viewport left coordinate
  84026. * @param right defines the viewport right coordinate
  84027. * @param bottom defines the viewport bottom coordinate
  84028. * @param top defines the viewport top coordinate
  84029. * @param znear defines the near clip plane
  84030. * @param zfar defines the far clip plane
  84031. * @param result defines the target matrix
  84032. */
  84033. static OrthoOffCenterLHToRef(left: number, right: number, bottom: number, top: number, znear: number, zfar: number, result: Matrix): void;
  84034. /**
  84035. * Creates a right-handed orthographic projection matrix
  84036. * @param left defines the viewport left coordinate
  84037. * @param right defines the viewport right coordinate
  84038. * @param bottom defines the viewport bottom coordinate
  84039. * @param top defines the viewport top coordinate
  84040. * @param znear defines the near clip plane
  84041. * @param zfar defines the far clip plane
  84042. * @returns a new matrix as a right-handed orthographic projection matrix
  84043. */
  84044. static OrthoOffCenterRH(left: number, right: number, bottom: number, top: number, znear: number, zfar: number): Matrix;
  84045. /**
  84046. * Stores a right-handed orthographic projection into a given matrix
  84047. * @param left defines the viewport left coordinate
  84048. * @param right defines the viewport right coordinate
  84049. * @param bottom defines the viewport bottom coordinate
  84050. * @param top defines the viewport top coordinate
  84051. * @param znear defines the near clip plane
  84052. * @param zfar defines the far clip plane
  84053. * @param result defines the target matrix
  84054. */
  84055. static OrthoOffCenterRHToRef(left: number, right: number, bottom: number, top: number, znear: number, zfar: number, result: Matrix): void;
  84056. /**
  84057. * Creates a left-handed perspective projection matrix
  84058. * @param width defines the viewport width
  84059. * @param height defines the viewport height
  84060. * @param znear defines the near clip plane
  84061. * @param zfar defines the far clip plane
  84062. * @returns a new matrix as a left-handed perspective projection matrix
  84063. */
  84064. static PerspectiveLH(width: number, height: number, znear: number, zfar: number): Matrix;
  84065. /**
  84066. * Creates a left-handed perspective projection matrix
  84067. * @param fov defines the horizontal field of view
  84068. * @param aspect defines the aspect ratio
  84069. * @param znear defines the near clip plane
  84070. * @param zfar defines the far clip plane
  84071. * @returns a new matrix as a left-handed perspective projection matrix
  84072. */
  84073. static PerspectiveFovLH(fov: number, aspect: number, znear: number, zfar: number): Matrix;
  84074. /**
  84075. * Stores a left-handed perspective projection into a given matrix
  84076. * @param fov defines the horizontal field of view
  84077. * @param aspect defines the aspect ratio
  84078. * @param znear defines the near clip plane
  84079. * @param zfar defines the far clip plane
  84080. * @param result defines the target matrix
  84081. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  84082. */
  84083. static PerspectiveFovLHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  84084. /**
  84085. * Stores a left-handed perspective projection into a given matrix with depth reversed
  84086. * @param fov defines the horizontal field of view
  84087. * @param aspect defines the aspect ratio
  84088. * @param znear defines the near clip plane
  84089. * @param zfar not used as infinity is used as far clip
  84090. * @param result defines the target matrix
  84091. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  84092. */
  84093. static PerspectiveFovReverseLHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  84094. /**
  84095. * Creates a right-handed perspective projection matrix
  84096. * @param fov defines the horizontal field of view
  84097. * @param aspect defines the aspect ratio
  84098. * @param znear defines the near clip plane
  84099. * @param zfar defines the far clip plane
  84100. * @returns a new matrix as a right-handed perspective projection matrix
  84101. */
  84102. static PerspectiveFovRH(fov: number, aspect: number, znear: number, zfar: number): Matrix;
  84103. /**
  84104. * Stores a right-handed perspective projection into a given matrix
  84105. * @param fov defines the horizontal field of view
  84106. * @param aspect defines the aspect ratio
  84107. * @param znear defines the near clip plane
  84108. * @param zfar defines the far clip plane
  84109. * @param result defines the target matrix
  84110. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  84111. */
  84112. static PerspectiveFovRHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  84113. /**
  84114. * Stores a right-handed perspective projection into a given matrix
  84115. * @param fov defines the horizontal field of view
  84116. * @param aspect defines the aspect ratio
  84117. * @param znear defines the near clip plane
  84118. * @param zfar not used as infinity is used as far clip
  84119. * @param result defines the target matrix
  84120. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  84121. */
  84122. static PerspectiveFovReverseRHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  84123. /**
  84124. * Stores a perspective projection for WebVR info a given matrix
  84125. * @param fov defines the field of view
  84126. * @param znear defines the near clip plane
  84127. * @param zfar defines the far clip plane
  84128. * @param result defines the target matrix
  84129. * @param rightHanded defines if the matrix must be in right-handed mode (false by default)
  84130. */
  84131. static PerspectiveFovWebVRToRef(fov: {
  84132. upDegrees: number;
  84133. downDegrees: number;
  84134. leftDegrees: number;
  84135. rightDegrees: number;
  84136. }, znear: number, zfar: number, result: Matrix, rightHanded?: boolean): void;
  84137. /**
  84138. * Computes a complete transformation matrix
  84139. * @param viewport defines the viewport to use
  84140. * @param world defines the world matrix
  84141. * @param view defines the view matrix
  84142. * @param projection defines the projection matrix
  84143. * @param zmin defines the near clip plane
  84144. * @param zmax defines the far clip plane
  84145. * @returns the transformation matrix
  84146. */
  84147. static GetFinalMatrix(viewport: DeepImmutable<Viewport>, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, zmin: number, zmax: number): Matrix;
  84148. /**
  84149. * Extracts a 2x2 matrix from a given matrix and store the result in a Float32Array
  84150. * @param matrix defines the matrix to use
  84151. * @returns a new Float32Array array with 4 elements : the 2x2 matrix extracted from the given matrix
  84152. */
  84153. static GetAsMatrix2x2(matrix: DeepImmutable<Matrix>): Float32Array | Array<number>;
  84154. /**
  84155. * Extracts a 3x3 matrix from a given matrix and store the result in a Float32Array
  84156. * @param matrix defines the matrix to use
  84157. * @returns a new Float32Array array with 9 elements : the 3x3 matrix extracted from the given matrix
  84158. */
  84159. static GetAsMatrix3x3(matrix: DeepImmutable<Matrix>): Float32Array | Array<number>;
  84160. /**
  84161. * Compute the transpose of a given matrix
  84162. * @param matrix defines the matrix to transpose
  84163. * @returns the new matrix
  84164. */
  84165. static Transpose(matrix: DeepImmutable<Matrix>): Matrix;
  84166. /**
  84167. * Compute the transpose of a matrix and store it in a target matrix
  84168. * @param matrix defines the matrix to transpose
  84169. * @param result defines the target matrix
  84170. */
  84171. static TransposeToRef(matrix: DeepImmutable<Matrix>, result: Matrix): void;
  84172. /**
  84173. * Computes a reflection matrix from a plane
  84174. * @param plane defines the reflection plane
  84175. * @returns a new matrix
  84176. */
  84177. static Reflection(plane: DeepImmutable<IPlaneLike>): Matrix;
  84178. /**
  84179. * Computes a reflection matrix from a plane
  84180. * @param plane defines the reflection plane
  84181. * @param result defines the target matrix
  84182. */
  84183. static ReflectionToRef(plane: DeepImmutable<IPlaneLike>, result: Matrix): void;
  84184. /**
  84185. * Sets the given matrix as a rotation matrix composed from the 3 left handed axes
  84186. * @param xaxis defines the value of the 1st axis
  84187. * @param yaxis defines the value of the 2nd axis
  84188. * @param zaxis defines the value of the 3rd axis
  84189. * @param result defines the target matrix
  84190. */
  84191. static FromXYZAxesToRef(xaxis: DeepImmutable<Vector3>, yaxis: DeepImmutable<Vector3>, zaxis: DeepImmutable<Vector3>, result: Matrix): void;
  84192. /**
  84193. * Creates a rotation matrix from a quaternion and stores it in a target matrix
  84194. * @param quat defines the quaternion to use
  84195. * @param result defines the target matrix
  84196. */
  84197. static FromQuaternionToRef(quat: DeepImmutable<Quaternion>, result: Matrix): void;
  84198. }
  84199. /**
  84200. * @hidden
  84201. */
  84202. export class TmpVectors {
  84203. static Vector2: Vector2[];
  84204. static Vector3: Vector3[];
  84205. static Vector4: Vector4[];
  84206. static Quaternion: Quaternion[];
  84207. static Matrix: Matrix[];
  84208. }
  84209. }
  84210. declare module BABYLON {
  84211. /**
  84212. * Defines potential orientation for back face culling
  84213. */
  84214. export enum Orientation {
  84215. /**
  84216. * Clockwise
  84217. */
  84218. CW = 0,
  84219. /** Counter clockwise */
  84220. CCW = 1
  84221. }
  84222. /** Class used to represent a Bezier curve */
  84223. export class BezierCurve {
  84224. /**
  84225. * Returns the cubic Bezier interpolated value (float) at "t" (float) from the given x1, y1, x2, y2 floats
  84226. * @param t defines the time
  84227. * @param x1 defines the left coordinate on X axis
  84228. * @param y1 defines the left coordinate on Y axis
  84229. * @param x2 defines the right coordinate on X axis
  84230. * @param y2 defines the right coordinate on Y axis
  84231. * @returns the interpolated value
  84232. */
  84233. static Interpolate(t: number, x1: number, y1: number, x2: number, y2: number): number;
  84234. }
  84235. /**
  84236. * Defines angle representation
  84237. */
  84238. export class Angle {
  84239. private _radians;
  84240. /**
  84241. * Creates an Angle object of "radians" radians (float).
  84242. * @param radians the angle in radians
  84243. */
  84244. constructor(radians: number);
  84245. /**
  84246. * Get value in degrees
  84247. * @returns the Angle value in degrees (float)
  84248. */
  84249. degrees(): number;
  84250. /**
  84251. * Get value in radians
  84252. * @returns the Angle value in radians (float)
  84253. */
  84254. radians(): number;
  84255. /**
  84256. * Gets a new Angle object valued with the gradient angle, in radians, of the line joining two points
  84257. * @param a defines first point as the origin
  84258. * @param b defines point
  84259. * @returns a new Angle
  84260. */
  84261. static BetweenTwoPoints(a: DeepImmutable<Vector2>, b: DeepImmutable<Vector2>): Angle;
  84262. /**
  84263. * Gets a new Angle object from the given float in radians
  84264. * @param radians defines the angle value in radians
  84265. * @returns a new Angle
  84266. */
  84267. static FromRadians(radians: number): Angle;
  84268. /**
  84269. * Gets a new Angle object from the given float in degrees
  84270. * @param degrees defines the angle value in degrees
  84271. * @returns a new Angle
  84272. */
  84273. static FromDegrees(degrees: number): Angle;
  84274. }
  84275. /**
  84276. * This represents an arc in a 2d space.
  84277. */
  84278. export class Arc2 {
  84279. /** Defines the start point of the arc */
  84280. startPoint: Vector2;
  84281. /** Defines the mid point of the arc */
  84282. midPoint: Vector2;
  84283. /** Defines the end point of the arc */
  84284. endPoint: Vector2;
  84285. /**
  84286. * Defines the center point of the arc.
  84287. */
  84288. centerPoint: Vector2;
  84289. /**
  84290. * Defines the radius of the arc.
  84291. */
  84292. radius: number;
  84293. /**
  84294. * Defines the angle of the arc (from mid point to end point).
  84295. */
  84296. angle: Angle;
  84297. /**
  84298. * Defines the start angle of the arc (from start point to middle point).
  84299. */
  84300. startAngle: Angle;
  84301. /**
  84302. * Defines the orientation of the arc (clock wise/counter clock wise).
  84303. */
  84304. orientation: Orientation;
  84305. /**
  84306. * Creates an Arc object from the three given points : start, middle and end.
  84307. * @param startPoint Defines the start point of the arc
  84308. * @param midPoint Defines the midlle point of the arc
  84309. * @param endPoint Defines the end point of the arc
  84310. */
  84311. constructor(
  84312. /** Defines the start point of the arc */
  84313. startPoint: Vector2,
  84314. /** Defines the mid point of the arc */
  84315. midPoint: Vector2,
  84316. /** Defines the end point of the arc */
  84317. endPoint: Vector2);
  84318. }
  84319. /**
  84320. * Represents a 2D path made up of multiple 2D points
  84321. */
  84322. export class Path2 {
  84323. private _points;
  84324. private _length;
  84325. /**
  84326. * If the path start and end point are the same
  84327. */
  84328. closed: boolean;
  84329. /**
  84330. * Creates a Path2 object from the starting 2D coordinates x and y.
  84331. * @param x the starting points x value
  84332. * @param y the starting points y value
  84333. */
  84334. constructor(x: number, y: number);
  84335. /**
  84336. * Adds a new segment until the given coordinates (x, y) to the current Path2.
  84337. * @param x the added points x value
  84338. * @param y the added points y value
  84339. * @returns the updated Path2.
  84340. */
  84341. addLineTo(x: number, y: number): Path2;
  84342. /**
  84343. * 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.
  84344. * @param midX middle point x value
  84345. * @param midY middle point y value
  84346. * @param endX end point x value
  84347. * @param endY end point y value
  84348. * @param numberOfSegments (default: 36)
  84349. * @returns the updated Path2.
  84350. */
  84351. addArcTo(midX: number, midY: number, endX: number, endY: number, numberOfSegments?: number): Path2;
  84352. /**
  84353. * Closes the Path2.
  84354. * @returns the Path2.
  84355. */
  84356. close(): Path2;
  84357. /**
  84358. * Gets the sum of the distance between each sequential point in the path
  84359. * @returns the Path2 total length (float).
  84360. */
  84361. length(): number;
  84362. /**
  84363. * Gets the points which construct the path
  84364. * @returns the Path2 internal array of points.
  84365. */
  84366. getPoints(): Vector2[];
  84367. /**
  84368. * Retreives the point at the distance aways from the starting point
  84369. * @param normalizedLengthPosition the length along the path to retreive the point from
  84370. * @returns a new Vector2 located at a percentage of the Path2 total length on this path.
  84371. */
  84372. getPointAtLengthPosition(normalizedLengthPosition: number): Vector2;
  84373. /**
  84374. * Creates a new path starting from an x and y position
  84375. * @param x starting x value
  84376. * @param y starting y value
  84377. * @returns a new Path2 starting at the coordinates (x, y).
  84378. */
  84379. static StartingAt(x: number, y: number): Path2;
  84380. }
  84381. /**
  84382. * Represents a 3D path made up of multiple 3D points
  84383. */
  84384. export class Path3D {
  84385. /**
  84386. * an array of Vector3, the curve axis of the Path3D
  84387. */
  84388. path: Vector3[];
  84389. private _curve;
  84390. private _distances;
  84391. private _tangents;
  84392. private _normals;
  84393. private _binormals;
  84394. private _raw;
  84395. private _alignTangentsWithPath;
  84396. private readonly _pointAtData;
  84397. /**
  84398. * new Path3D(path, normal, raw)
  84399. * Creates a Path3D. A Path3D is a logical math object, so not a mesh.
  84400. * please read the description in the tutorial : https://doc.babylonjs.com/how_to/how_to_use_path3d
  84401. * @param path an array of Vector3, the curve axis of the Path3D
  84402. * @param firstNormal (options) Vector3, the first wanted normal to the curve. Ex (0, 1, 0) for a vertical normal.
  84403. * @param raw (optional, default false) : boolean, if true the returned Path3D isn't normalized. Useful to depict path acceleration or speed.
  84404. * @param alignTangentsWithPath (optional, default false) : boolean, if true the tangents will be aligned with the path.
  84405. */
  84406. constructor(
  84407. /**
  84408. * an array of Vector3, the curve axis of the Path3D
  84409. */
  84410. path: Vector3[], firstNormal?: Nullable<Vector3>, raw?: boolean, alignTangentsWithPath?: boolean);
  84411. /**
  84412. * Returns the Path3D array of successive Vector3 designing its curve.
  84413. * @returns the Path3D array of successive Vector3 designing its curve.
  84414. */
  84415. getCurve(): Vector3[];
  84416. /**
  84417. * Returns the Path3D array of successive Vector3 designing its curve.
  84418. * @returns the Path3D array of successive Vector3 designing its curve.
  84419. */
  84420. getPoints(): Vector3[];
  84421. /**
  84422. * @returns the computed length (float) of the path.
  84423. */
  84424. length(): number;
  84425. /**
  84426. * Returns an array populated with tangent vectors on each Path3D curve point.
  84427. * @returns an array populated with tangent vectors on each Path3D curve point.
  84428. */
  84429. getTangents(): Vector3[];
  84430. /**
  84431. * Returns an array populated with normal vectors on each Path3D curve point.
  84432. * @returns an array populated with normal vectors on each Path3D curve point.
  84433. */
  84434. getNormals(): Vector3[];
  84435. /**
  84436. * Returns an array populated with binormal vectors on each Path3D curve point.
  84437. * @returns an array populated with binormal vectors on each Path3D curve point.
  84438. */
  84439. getBinormals(): Vector3[];
  84440. /**
  84441. * Returns an array populated with distances (float) of the i-th point from the first curve point.
  84442. * @returns an array populated with distances (float) of the i-th point from the first curve point.
  84443. */
  84444. getDistances(): number[];
  84445. /**
  84446. * Returns an interpolated point along this path
  84447. * @param position the position of the point along this path, from 0.0 to 1.0
  84448. * @returns a new Vector3 as the point
  84449. */
  84450. getPointAt(position: number): Vector3;
  84451. /**
  84452. * Returns the tangent vector of an interpolated Path3D curve point at the specified position along this path.
  84453. * @param position the position of the point along this path, from 0.0 to 1.0
  84454. * @param interpolated (optional, default false) : boolean, if true returns an interpolated tangent instead of the tangent of the previous path point.
  84455. * @returns a tangent vector corresponding to the interpolated Path3D curve point, if not interpolated, the tangent is taken from the precomputed tangents array.
  84456. */
  84457. getTangentAt(position: number, interpolated?: boolean): Vector3;
  84458. /**
  84459. * Returns the tangent vector of an interpolated Path3D curve point at the specified position along this path.
  84460. * @param position the position of the point along this path, from 0.0 to 1.0
  84461. * @param interpolated (optional, default false) : boolean, if true returns an interpolated normal instead of the normal of the previous path point.
  84462. * @returns a normal vector corresponding to the interpolated Path3D curve point, if not interpolated, the normal is taken from the precomputed normals array.
  84463. */
  84464. getNormalAt(position: number, interpolated?: boolean): Vector3;
  84465. /**
  84466. * Returns the binormal vector of an interpolated Path3D curve point at the specified position along this path.
  84467. * @param position the position of the point along this path, from 0.0 to 1.0
  84468. * @param interpolated (optional, default false) : boolean, if true returns an interpolated binormal instead of the binormal of the previous path point.
  84469. * @returns a binormal vector corresponding to the interpolated Path3D curve point, if not interpolated, the binormal is taken from the precomputed binormals array.
  84470. */
  84471. getBinormalAt(position: number, interpolated?: boolean): Vector3;
  84472. /**
  84473. * Returns the distance (float) of an interpolated Path3D curve point at the specified position along this path.
  84474. * @param position the position of the point along this path, from 0.0 to 1.0
  84475. * @returns the distance of the interpolated Path3D curve point at the specified position along this path.
  84476. */
  84477. getDistanceAt(position: number): number;
  84478. /**
  84479. * Returns the array index of the previous point of an interpolated point along this path
  84480. * @param position the position of the point to interpolate along this path, from 0.0 to 1.0
  84481. * @returns the array index
  84482. */
  84483. getPreviousPointIndexAt(position: number): number;
  84484. /**
  84485. * 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)
  84486. * @param position the position of the point to interpolate along this path, from 0.0 to 1.0
  84487. * @returns the sub position
  84488. */
  84489. getSubPositionAt(position: number): number;
  84490. /**
  84491. * Returns the position of the closest virtual point on this path to an arbitrary Vector3, from 0.0 to 1.0
  84492. * @param target the vector of which to get the closest position to
  84493. * @returns the position of the closest virtual point on this path to the target vector
  84494. */
  84495. getClosestPositionTo(target: Vector3): number;
  84496. /**
  84497. * Returns a sub path (slice) of this path
  84498. * @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
  84499. * @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
  84500. * @returns a sub path (slice) of this path
  84501. */
  84502. slice(start?: number, end?: number): Path3D;
  84503. /**
  84504. * Forces the Path3D tangent, normal, binormal and distance recomputation.
  84505. * @param path path which all values are copied into the curves points
  84506. * @param firstNormal which should be projected onto the curve
  84507. * @param alignTangentsWithPath (optional, default false) : boolean, if true the tangents will be aligned with the path
  84508. * @returns the same object updated.
  84509. */
  84510. update(path: Vector3[], firstNormal?: Nullable<Vector3>, alignTangentsWithPath?: boolean): Path3D;
  84511. private _compute;
  84512. private _getFirstNonNullVector;
  84513. private _getLastNonNullVector;
  84514. private _normalVector;
  84515. /**
  84516. * Updates the point at data for an interpolated point along this curve
  84517. * @param position the position of the point along this curve, from 0.0 to 1.0
  84518. * @interpolateTNB wether to compute the interpolated tangent, normal and binormal
  84519. * @returns the (updated) point at data
  84520. */
  84521. private _updatePointAtData;
  84522. /**
  84523. * Updates the point at data from the specified parameters
  84524. * @param position where along the path the interpolated point is, from 0.0 to 1.0
  84525. * @param point the interpolated point
  84526. * @param parentIndex the index of an existing curve point that is on, or else positionally the first behind, the interpolated point
  84527. */
  84528. private _setPointAtData;
  84529. /**
  84530. * Updates the point at interpolation matrix for the tangents, normals and binormals
  84531. */
  84532. private _updateInterpolationMatrix;
  84533. }
  84534. /**
  84535. * A Curve3 object is a logical object, so not a mesh, to handle curves in the 3D geometric space.
  84536. * A Curve3 is designed from a series of successive Vector3.
  84537. * @see https://doc.babylonjs.com/how_to/how_to_use_curve3
  84538. */
  84539. export class Curve3 {
  84540. private _points;
  84541. private _length;
  84542. /**
  84543. * Returns a Curve3 object along a Quadratic Bezier curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#quadratic-bezier-curve
  84544. * @param v0 (Vector3) the origin point of the Quadratic Bezier
  84545. * @param v1 (Vector3) the control point
  84546. * @param v2 (Vector3) the end point of the Quadratic Bezier
  84547. * @param nbPoints (integer) the wanted number of points in the curve
  84548. * @returns the created Curve3
  84549. */
  84550. static CreateQuadraticBezier(v0: DeepImmutable<Vector3>, v1: DeepImmutable<Vector3>, v2: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  84551. /**
  84552. * Returns a Curve3 object along a Cubic Bezier curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#cubic-bezier-curve
  84553. * @param v0 (Vector3) the origin point of the Cubic Bezier
  84554. * @param v1 (Vector3) the first control point
  84555. * @param v2 (Vector3) the second control point
  84556. * @param v3 (Vector3) the end point of the Cubic Bezier
  84557. * @param nbPoints (integer) the wanted number of points in the curve
  84558. * @returns the created Curve3
  84559. */
  84560. static CreateCubicBezier(v0: DeepImmutable<Vector3>, v1: DeepImmutable<Vector3>, v2: DeepImmutable<Vector3>, v3: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  84561. /**
  84562. * Returns a Curve3 object along a Hermite Spline curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#hermite-spline
  84563. * @param p1 (Vector3) the origin point of the Hermite Spline
  84564. * @param t1 (Vector3) the tangent vector at the origin point
  84565. * @param p2 (Vector3) the end point of the Hermite Spline
  84566. * @param t2 (Vector3) the tangent vector at the end point
  84567. * @param nbPoints (integer) the wanted number of points in the curve
  84568. * @returns the created Curve3
  84569. */
  84570. static CreateHermiteSpline(p1: DeepImmutable<Vector3>, t1: DeepImmutable<Vector3>, p2: DeepImmutable<Vector3>, t2: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  84571. /**
  84572. * Returns a Curve3 object along a CatmullRom Spline curve :
  84573. * @param points (array of Vector3) the points the spline must pass through. At least, four points required
  84574. * @param nbPoints (integer) the wanted number of points between each curve control points
  84575. * @param closed (boolean) optional with default false, when true forms a closed loop from the points
  84576. * @returns the created Curve3
  84577. */
  84578. static CreateCatmullRomSpline(points: DeepImmutable<Vector3[]>, nbPoints: number, closed?: boolean): Curve3;
  84579. /**
  84580. * A Curve3 object is a logical object, so not a mesh, to handle curves in the 3D geometric space.
  84581. * A Curve3 is designed from a series of successive Vector3.
  84582. * Tuto : https://doc.babylonjs.com/how_to/how_to_use_curve3#curve3-object
  84583. * @param points points which make up the curve
  84584. */
  84585. constructor(points: Vector3[]);
  84586. /**
  84587. * @returns the Curve3 stored array of successive Vector3
  84588. */
  84589. getPoints(): Vector3[];
  84590. /**
  84591. * @returns the computed length (float) of the curve.
  84592. */
  84593. length(): number;
  84594. /**
  84595. * Returns a new instance of Curve3 object : var curve = curveA.continue(curveB);
  84596. * This new Curve3 is built by translating and sticking the curveB at the end of the curveA.
  84597. * curveA and curveB keep unchanged.
  84598. * @param curve the curve to continue from this curve
  84599. * @returns the newly constructed curve
  84600. */
  84601. continue(curve: DeepImmutable<Curve3>): Curve3;
  84602. private _computeLength;
  84603. }
  84604. }
  84605. declare module BABYLON {
  84606. /**
  84607. * This represents the main contract an easing function should follow.
  84608. * Easing functions are used throughout the animation system.
  84609. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  84610. */
  84611. export interface IEasingFunction {
  84612. /**
  84613. * Given an input gradient between 0 and 1, this returns the corrseponding value
  84614. * of the easing function.
  84615. * The link below provides some of the most common examples of easing functions.
  84616. * @see https://easings.net/
  84617. * @param gradient Defines the value between 0 and 1 we want the easing value for
  84618. * @returns the corresponding value on the curve defined by the easing function
  84619. */
  84620. ease(gradient: number): number;
  84621. }
  84622. /**
  84623. * Base class used for every default easing function.
  84624. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  84625. */
  84626. export class EasingFunction implements IEasingFunction {
  84627. /**
  84628. * Interpolation follows the mathematical formula associated with the easing function.
  84629. */
  84630. static readonly EASINGMODE_EASEIN: number;
  84631. /**
  84632. * Interpolation follows 100% interpolation minus the output of the formula associated with the easing function.
  84633. */
  84634. static readonly EASINGMODE_EASEOUT: number;
  84635. /**
  84636. * Interpolation uses EaseIn for the first half of the animation and EaseOut for the second half.
  84637. */
  84638. static readonly EASINGMODE_EASEINOUT: number;
  84639. private _easingMode;
  84640. /**
  84641. * Sets the easing mode of the current function.
  84642. * @param easingMode Defines the willing mode (EASINGMODE_EASEIN, EASINGMODE_EASEOUT or EASINGMODE_EASEINOUT)
  84643. */
  84644. setEasingMode(easingMode: number): void;
  84645. /**
  84646. * Gets the current easing mode.
  84647. * @returns the easing mode
  84648. */
  84649. getEasingMode(): number;
  84650. /**
  84651. * @hidden
  84652. */
  84653. easeInCore(gradient: number): number;
  84654. /**
  84655. * Given an input gradient between 0 and 1, this returns the corresponding value
  84656. * of the easing function.
  84657. * @param gradient Defines the value between 0 and 1 we want the easing value for
  84658. * @returns the corresponding value on the curve defined by the easing function
  84659. */
  84660. ease(gradient: number): number;
  84661. }
  84662. /**
  84663. * Easing function with a circle shape (see link below).
  84664. * @see https://easings.net/#easeInCirc
  84665. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  84666. */
  84667. export class CircleEase extends EasingFunction implements IEasingFunction {
  84668. /** @hidden */
  84669. easeInCore(gradient: number): number;
  84670. }
  84671. /**
  84672. * Easing function with a ease back shape (see link below).
  84673. * @see https://easings.net/#easeInBack
  84674. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  84675. */
  84676. export class BackEase extends EasingFunction implements IEasingFunction {
  84677. /** Defines the amplitude of the function */
  84678. amplitude: number;
  84679. /**
  84680. * Instantiates a back ease easing
  84681. * @see https://easings.net/#easeInBack
  84682. * @param amplitude Defines the amplitude of the function
  84683. */
  84684. constructor(
  84685. /** Defines the amplitude of the function */
  84686. amplitude?: number);
  84687. /** @hidden */
  84688. easeInCore(gradient: number): number;
  84689. }
  84690. /**
  84691. * Easing function with a bouncing shape (see link below).
  84692. * @see https://easings.net/#easeInBounce
  84693. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  84694. */
  84695. export class BounceEase extends EasingFunction implements IEasingFunction {
  84696. /** Defines the number of bounces */
  84697. bounces: number;
  84698. /** Defines the amplitude of the bounce */
  84699. bounciness: number;
  84700. /**
  84701. * Instantiates a bounce easing
  84702. * @see https://easings.net/#easeInBounce
  84703. * @param bounces Defines the number of bounces
  84704. * @param bounciness Defines the amplitude of the bounce
  84705. */
  84706. constructor(
  84707. /** Defines the number of bounces */
  84708. bounces?: number,
  84709. /** Defines the amplitude of the bounce */
  84710. bounciness?: number);
  84711. /** @hidden */
  84712. easeInCore(gradient: number): number;
  84713. }
  84714. /**
  84715. * Easing function with a power of 3 shape (see link below).
  84716. * @see https://easings.net/#easeInCubic
  84717. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  84718. */
  84719. export class CubicEase extends EasingFunction implements IEasingFunction {
  84720. /** @hidden */
  84721. easeInCore(gradient: number): number;
  84722. }
  84723. /**
  84724. * Easing function with an elastic shape (see link below).
  84725. * @see https://easings.net/#easeInElastic
  84726. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  84727. */
  84728. export class ElasticEase extends EasingFunction implements IEasingFunction {
  84729. /** Defines the number of oscillations*/
  84730. oscillations: number;
  84731. /** Defines the amplitude of the oscillations*/
  84732. springiness: number;
  84733. /**
  84734. * Instantiates an elastic easing function
  84735. * @see https://easings.net/#easeInElastic
  84736. * @param oscillations Defines the number of oscillations
  84737. * @param springiness Defines the amplitude of the oscillations
  84738. */
  84739. constructor(
  84740. /** Defines the number of oscillations*/
  84741. oscillations?: number,
  84742. /** Defines the amplitude of the oscillations*/
  84743. springiness?: number);
  84744. /** @hidden */
  84745. easeInCore(gradient: number): number;
  84746. }
  84747. /**
  84748. * Easing function with an exponential shape (see link below).
  84749. * @see https://easings.net/#easeInExpo
  84750. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  84751. */
  84752. export class ExponentialEase extends EasingFunction implements IEasingFunction {
  84753. /** Defines the exponent of the function */
  84754. exponent: number;
  84755. /**
  84756. * Instantiates an exponential easing function
  84757. * @see https://easings.net/#easeInExpo
  84758. * @param exponent Defines the exponent of the function
  84759. */
  84760. constructor(
  84761. /** Defines the exponent of the function */
  84762. exponent?: number);
  84763. /** @hidden */
  84764. easeInCore(gradient: number): number;
  84765. }
  84766. /**
  84767. * Easing function with a power shape (see link below).
  84768. * @see https://easings.net/#easeInQuad
  84769. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  84770. */
  84771. export class PowerEase extends EasingFunction implements IEasingFunction {
  84772. /** Defines the power of the function */
  84773. power: number;
  84774. /**
  84775. * Instantiates an power base easing function
  84776. * @see https://easings.net/#easeInQuad
  84777. * @param power Defines the power of the function
  84778. */
  84779. constructor(
  84780. /** Defines the power of the function */
  84781. power?: number);
  84782. /** @hidden */
  84783. easeInCore(gradient: number): number;
  84784. }
  84785. /**
  84786. * Easing function with a power of 2 shape (see link below).
  84787. * @see https://easings.net/#easeInQuad
  84788. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  84789. */
  84790. export class QuadraticEase extends EasingFunction implements IEasingFunction {
  84791. /** @hidden */
  84792. easeInCore(gradient: number): number;
  84793. }
  84794. /**
  84795. * Easing function with a power of 4 shape (see link below).
  84796. * @see https://easings.net/#easeInQuart
  84797. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  84798. */
  84799. export class QuarticEase extends EasingFunction implements IEasingFunction {
  84800. /** @hidden */
  84801. easeInCore(gradient: number): number;
  84802. }
  84803. /**
  84804. * Easing function with a power of 5 shape (see link below).
  84805. * @see https://easings.net/#easeInQuint
  84806. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  84807. */
  84808. export class QuinticEase extends EasingFunction implements IEasingFunction {
  84809. /** @hidden */
  84810. easeInCore(gradient: number): number;
  84811. }
  84812. /**
  84813. * Easing function with a sin shape (see link below).
  84814. * @see https://easings.net/#easeInSine
  84815. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  84816. */
  84817. export class SineEase extends EasingFunction implements IEasingFunction {
  84818. /** @hidden */
  84819. easeInCore(gradient: number): number;
  84820. }
  84821. /**
  84822. * Easing function with a bezier shape (see link below).
  84823. * @see http://cubic-bezier.com/#.17,.67,.83,.67
  84824. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  84825. */
  84826. export class BezierCurveEase extends EasingFunction implements IEasingFunction {
  84827. /** Defines the x component of the start tangent in the bezier curve */
  84828. x1: number;
  84829. /** Defines the y component of the start tangent in the bezier curve */
  84830. y1: number;
  84831. /** Defines the x component of the end tangent in the bezier curve */
  84832. x2: number;
  84833. /** Defines the y component of the end tangent in the bezier curve */
  84834. y2: number;
  84835. /**
  84836. * Instantiates a bezier function
  84837. * @see http://cubic-bezier.com/#.17,.67,.83,.67
  84838. * @param x1 Defines the x component of the start tangent in the bezier curve
  84839. * @param y1 Defines the y component of the start tangent in the bezier curve
  84840. * @param x2 Defines the x component of the end tangent in the bezier curve
  84841. * @param y2 Defines the y component of the end tangent in the bezier curve
  84842. */
  84843. constructor(
  84844. /** Defines the x component of the start tangent in the bezier curve */
  84845. x1?: number,
  84846. /** Defines the y component of the start tangent in the bezier curve */
  84847. y1?: number,
  84848. /** Defines the x component of the end tangent in the bezier curve */
  84849. x2?: number,
  84850. /** Defines the y component of the end tangent in the bezier curve */
  84851. y2?: number);
  84852. /** @hidden */
  84853. easeInCore(gradient: number): number;
  84854. }
  84855. }
  84856. declare module BABYLON {
  84857. /**
  84858. * Class used to hold a RBG color
  84859. */
  84860. export class Color3 {
  84861. /**
  84862. * Defines the red component (between 0 and 1, default is 0)
  84863. */
  84864. r: number;
  84865. /**
  84866. * Defines the green component (between 0 and 1, default is 0)
  84867. */
  84868. g: number;
  84869. /**
  84870. * Defines the blue component (between 0 and 1, default is 0)
  84871. */
  84872. b: number;
  84873. /**
  84874. * Creates a new Color3 object from red, green, blue values, all between 0 and 1
  84875. * @param r defines the red component (between 0 and 1, default is 0)
  84876. * @param g defines the green component (between 0 and 1, default is 0)
  84877. * @param b defines the blue component (between 0 and 1, default is 0)
  84878. */
  84879. constructor(
  84880. /**
  84881. * Defines the red component (between 0 and 1, default is 0)
  84882. */
  84883. r?: number,
  84884. /**
  84885. * Defines the green component (between 0 and 1, default is 0)
  84886. */
  84887. g?: number,
  84888. /**
  84889. * Defines the blue component (between 0 and 1, default is 0)
  84890. */
  84891. b?: number);
  84892. /**
  84893. * Creates a string with the Color3 current values
  84894. * @returns the string representation of the Color3 object
  84895. */
  84896. toString(): string;
  84897. /**
  84898. * Returns the string "Color3"
  84899. * @returns "Color3"
  84900. */
  84901. getClassName(): string;
  84902. /**
  84903. * Compute the Color3 hash code
  84904. * @returns an unique number that can be used to hash Color3 objects
  84905. */
  84906. getHashCode(): number;
  84907. /**
  84908. * Stores in the given array from the given starting index the red, green, blue values as successive elements
  84909. * @param array defines the array where to store the r,g,b components
  84910. * @param index defines an optional index in the target array to define where to start storing values
  84911. * @returns the current Color3 object
  84912. */
  84913. toArray(array: FloatArray, index?: number): Color3;
  84914. /**
  84915. * Update the current color with values stored in an array from the starting index of the given array
  84916. * @param array defines the source array
  84917. * @param offset defines an offset in the source array
  84918. * @returns the current Color3 object
  84919. */
  84920. fromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color3;
  84921. /**
  84922. * Returns a new Color4 object from the current Color3 and the given alpha
  84923. * @param alpha defines the alpha component on the new Color4 object (default is 1)
  84924. * @returns a new Color4 object
  84925. */
  84926. toColor4(alpha?: number): Color4;
  84927. /**
  84928. * Returns a new array populated with 3 numeric elements : red, green and blue values
  84929. * @returns the new array
  84930. */
  84931. asArray(): number[];
  84932. /**
  84933. * Returns the luminance value
  84934. * @returns a float value
  84935. */
  84936. toLuminance(): number;
  84937. /**
  84938. * Multiply each Color3 rgb values by the given Color3 rgb values in a new Color3 object
  84939. * @param otherColor defines the second operand
  84940. * @returns the new Color3 object
  84941. */
  84942. multiply(otherColor: DeepImmutable<Color3>): Color3;
  84943. /**
  84944. * Multiply the rgb values of the Color3 and the given Color3 and stores the result in the object "result"
  84945. * @param otherColor defines the second operand
  84946. * @param result defines the Color3 object where to store the result
  84947. * @returns the current Color3
  84948. */
  84949. multiplyToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  84950. /**
  84951. * Determines equality between Color3 objects
  84952. * @param otherColor defines the second operand
  84953. * @returns true if the rgb values are equal to the given ones
  84954. */
  84955. equals(otherColor: DeepImmutable<Color3>): boolean;
  84956. /**
  84957. * Determines equality between the current Color3 object and a set of r,b,g values
  84958. * @param r defines the red component to check
  84959. * @param g defines the green component to check
  84960. * @param b defines the blue component to check
  84961. * @returns true if the rgb values are equal to the given ones
  84962. */
  84963. equalsFloats(r: number, g: number, b: number): boolean;
  84964. /**
  84965. * Multiplies in place each rgb value by scale
  84966. * @param scale defines the scaling factor
  84967. * @returns the updated Color3
  84968. */
  84969. scale(scale: number): Color3;
  84970. /**
  84971. * Multiplies the rgb values by scale and stores the result into "result"
  84972. * @param scale defines the scaling factor
  84973. * @param result defines the Color3 object where to store the result
  84974. * @returns the unmodified current Color3
  84975. */
  84976. scaleToRef(scale: number, result: Color3): Color3;
  84977. /**
  84978. * Scale the current Color3 values by a factor and add the result to a given Color3
  84979. * @param scale defines the scale factor
  84980. * @param result defines color to store the result into
  84981. * @returns the unmodified current Color3
  84982. */
  84983. scaleAndAddToRef(scale: number, result: Color3): Color3;
  84984. /**
  84985. * Clamps the rgb values by the min and max values and stores the result into "result"
  84986. * @param min defines minimum clamping value (default is 0)
  84987. * @param max defines maximum clamping value (default is 1)
  84988. * @param result defines color to store the result into
  84989. * @returns the original Color3
  84990. */
  84991. clampToRef(min: number | undefined, max: number | undefined, result: Color3): Color3;
  84992. /**
  84993. * Creates a new Color3 set with the added values of the current Color3 and of the given one
  84994. * @param otherColor defines the second operand
  84995. * @returns the new Color3
  84996. */
  84997. add(otherColor: DeepImmutable<Color3>): Color3;
  84998. /**
  84999. * Stores the result of the addition of the current Color3 and given one rgb values into "result"
  85000. * @param otherColor defines the second operand
  85001. * @param result defines Color3 object to store the result into
  85002. * @returns the unmodified current Color3
  85003. */
  85004. addToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  85005. /**
  85006. * Returns a new Color3 set with the subtracted values of the given one from the current Color3
  85007. * @param otherColor defines the second operand
  85008. * @returns the new Color3
  85009. */
  85010. subtract(otherColor: DeepImmutable<Color3>): Color3;
  85011. /**
  85012. * Stores the result of the subtraction of given one from the current Color3 rgb values into "result"
  85013. * @param otherColor defines the second operand
  85014. * @param result defines Color3 object to store the result into
  85015. * @returns the unmodified current Color3
  85016. */
  85017. subtractToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  85018. /**
  85019. * Copy the current object
  85020. * @returns a new Color3 copied the current one
  85021. */
  85022. clone(): Color3;
  85023. /**
  85024. * Copies the rgb values from the source in the current Color3
  85025. * @param source defines the source Color3 object
  85026. * @returns the updated Color3 object
  85027. */
  85028. copyFrom(source: DeepImmutable<Color3>): Color3;
  85029. /**
  85030. * Updates the Color3 rgb values from the given floats
  85031. * @param r defines the red component to read from
  85032. * @param g defines the green component to read from
  85033. * @param b defines the blue component to read from
  85034. * @returns the current Color3 object
  85035. */
  85036. copyFromFloats(r: number, g: number, b: number): Color3;
  85037. /**
  85038. * Updates the Color3 rgb values from the given floats
  85039. * @param r defines the red component to read from
  85040. * @param g defines the green component to read from
  85041. * @param b defines the blue component to read from
  85042. * @returns the current Color3 object
  85043. */
  85044. set(r: number, g: number, b: number): Color3;
  85045. /**
  85046. * Compute the Color3 hexadecimal code as a string
  85047. * @returns a string containing the hexadecimal representation of the Color3 object
  85048. */
  85049. toHexString(): string;
  85050. /**
  85051. * Computes a new Color3 converted from the current one to linear space
  85052. * @returns a new Color3 object
  85053. */
  85054. toLinearSpace(): Color3;
  85055. /**
  85056. * Converts current color in rgb space to HSV values
  85057. * @returns a new color3 representing the HSV values
  85058. */
  85059. toHSV(): Color3;
  85060. /**
  85061. * Converts current color in rgb space to HSV values
  85062. * @param result defines the Color3 where to store the HSV values
  85063. */
  85064. toHSVToRef(result: Color3): void;
  85065. /**
  85066. * Converts the Color3 values to linear space and stores the result in "convertedColor"
  85067. * @param convertedColor defines the Color3 object where to store the linear space version
  85068. * @returns the unmodified Color3
  85069. */
  85070. toLinearSpaceToRef(convertedColor: Color3): Color3;
  85071. /**
  85072. * Computes a new Color3 converted from the current one to gamma space
  85073. * @returns a new Color3 object
  85074. */
  85075. toGammaSpace(): Color3;
  85076. /**
  85077. * Converts the Color3 values to gamma space and stores the result in "convertedColor"
  85078. * @param convertedColor defines the Color3 object where to store the gamma space version
  85079. * @returns the unmodified Color3
  85080. */
  85081. toGammaSpaceToRef(convertedColor: Color3): Color3;
  85082. private static _BlackReadOnly;
  85083. /**
  85084. * Convert Hue, saturation and value to a Color3 (RGB)
  85085. * @param hue defines the hue
  85086. * @param saturation defines the saturation
  85087. * @param value defines the value
  85088. * @param result defines the Color3 where to store the RGB values
  85089. */
  85090. static HSVtoRGBToRef(hue: number, saturation: number, value: number, result: Color3): void;
  85091. /**
  85092. * Creates a new Color3 from the string containing valid hexadecimal values
  85093. * @param hex defines a string containing valid hexadecimal values
  85094. * @returns a new Color3 object
  85095. */
  85096. static FromHexString(hex: string): Color3;
  85097. /**
  85098. * Creates a new Color3 from the starting index of the given array
  85099. * @param array defines the source array
  85100. * @param offset defines an offset in the source array
  85101. * @returns a new Color3 object
  85102. */
  85103. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color3;
  85104. /**
  85105. * Creates a new Color3 from the starting index element of the given array
  85106. * @param array defines the source array to read from
  85107. * @param offset defines the offset in the source array
  85108. * @param result defines the target Color3 object
  85109. */
  85110. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number | undefined, result: Color3): void;
  85111. /**
  85112. * Creates a new Color3 from integer values (< 256)
  85113. * @param r defines the red component to read from (value between 0 and 255)
  85114. * @param g defines the green component to read from (value between 0 and 255)
  85115. * @param b defines the blue component to read from (value between 0 and 255)
  85116. * @returns a new Color3 object
  85117. */
  85118. static FromInts(r: number, g: number, b: number): Color3;
  85119. /**
  85120. * Creates a new Color3 with values linearly interpolated of "amount" between the start Color3 and the end Color3
  85121. * @param start defines the start Color3 value
  85122. * @param end defines the end Color3 value
  85123. * @param amount defines the gradient value between start and end
  85124. * @returns a new Color3 object
  85125. */
  85126. static Lerp(start: DeepImmutable<Color3>, end: DeepImmutable<Color3>, amount: number): Color3;
  85127. /**
  85128. * Creates a new Color3 with values linearly interpolated of "amount" between the start Color3 and the end Color3
  85129. * @param left defines the start value
  85130. * @param right defines the end value
  85131. * @param amount defines the gradient factor
  85132. * @param result defines the Color3 object where to store the result
  85133. */
  85134. static LerpToRef(left: DeepImmutable<Color3>, right: DeepImmutable<Color3>, amount: number, result: Color3): void;
  85135. /**
  85136. * Returns a Color3 value containing a red color
  85137. * @returns a new Color3 object
  85138. */
  85139. static Red(): Color3;
  85140. /**
  85141. * Returns a Color3 value containing a green color
  85142. * @returns a new Color3 object
  85143. */
  85144. static Green(): Color3;
  85145. /**
  85146. * Returns a Color3 value containing a blue color
  85147. * @returns a new Color3 object
  85148. */
  85149. static Blue(): Color3;
  85150. /**
  85151. * Returns a Color3 value containing a black color
  85152. * @returns a new Color3 object
  85153. */
  85154. static Black(): Color3;
  85155. /**
  85156. * Gets a Color3 value containing a black color that must not be updated
  85157. */
  85158. static get BlackReadOnly(): DeepImmutable<Color3>;
  85159. /**
  85160. * Returns a Color3 value containing a white color
  85161. * @returns a new Color3 object
  85162. */
  85163. static White(): Color3;
  85164. /**
  85165. * Returns a Color3 value containing a purple color
  85166. * @returns a new Color3 object
  85167. */
  85168. static Purple(): Color3;
  85169. /**
  85170. * Returns a Color3 value containing a magenta color
  85171. * @returns a new Color3 object
  85172. */
  85173. static Magenta(): Color3;
  85174. /**
  85175. * Returns a Color3 value containing a yellow color
  85176. * @returns a new Color3 object
  85177. */
  85178. static Yellow(): Color3;
  85179. /**
  85180. * Returns a Color3 value containing a gray color
  85181. * @returns a new Color3 object
  85182. */
  85183. static Gray(): Color3;
  85184. /**
  85185. * Returns a Color3 value containing a teal color
  85186. * @returns a new Color3 object
  85187. */
  85188. static Teal(): Color3;
  85189. /**
  85190. * Returns a Color3 value containing a random color
  85191. * @returns a new Color3 object
  85192. */
  85193. static Random(): Color3;
  85194. }
  85195. /**
  85196. * Class used to hold a RBGA color
  85197. */
  85198. export class Color4 {
  85199. /**
  85200. * Defines the red component (between 0 and 1, default is 0)
  85201. */
  85202. r: number;
  85203. /**
  85204. * Defines the green component (between 0 and 1, default is 0)
  85205. */
  85206. g: number;
  85207. /**
  85208. * Defines the blue component (between 0 and 1, default is 0)
  85209. */
  85210. b: number;
  85211. /**
  85212. * Defines the alpha component (between 0 and 1, default is 1)
  85213. */
  85214. a: number;
  85215. /**
  85216. * Creates a new Color4 object from red, green, blue values, all between 0 and 1
  85217. * @param r defines the red component (between 0 and 1, default is 0)
  85218. * @param g defines the green component (between 0 and 1, default is 0)
  85219. * @param b defines the blue component (between 0 and 1, default is 0)
  85220. * @param a defines the alpha component (between 0 and 1, default is 1)
  85221. */
  85222. constructor(
  85223. /**
  85224. * Defines the red component (between 0 and 1, default is 0)
  85225. */
  85226. r?: number,
  85227. /**
  85228. * Defines the green component (between 0 and 1, default is 0)
  85229. */
  85230. g?: number,
  85231. /**
  85232. * Defines the blue component (between 0 and 1, default is 0)
  85233. */
  85234. b?: number,
  85235. /**
  85236. * Defines the alpha component (between 0 and 1, default is 1)
  85237. */
  85238. a?: number);
  85239. /**
  85240. * Adds in place the given Color4 values to the current Color4 object
  85241. * @param right defines the second operand
  85242. * @returns the current updated Color4 object
  85243. */
  85244. addInPlace(right: DeepImmutable<Color4>): Color4;
  85245. /**
  85246. * Creates a new array populated with 4 numeric elements : red, green, blue, alpha values
  85247. * @returns the new array
  85248. */
  85249. asArray(): number[];
  85250. /**
  85251. * Stores from the starting index in the given array the Color4 successive values
  85252. * @param array defines the array where to store the r,g,b components
  85253. * @param index defines an optional index in the target array to define where to start storing values
  85254. * @returns the current Color4 object
  85255. */
  85256. toArray(array: number[], index?: number): Color4;
  85257. /**
  85258. * Update the current color with values stored in an array from the starting index of the given array
  85259. * @param array defines the source array
  85260. * @param offset defines an offset in the source array
  85261. * @returns the current Color4 object
  85262. */
  85263. fromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color4;
  85264. /**
  85265. * Determines equality between Color4 objects
  85266. * @param otherColor defines the second operand
  85267. * @returns true if the rgba values are equal to the given ones
  85268. */
  85269. equals(otherColor: DeepImmutable<Color4>): boolean;
  85270. /**
  85271. * Creates a new Color4 set with the added values of the current Color4 and of the given one
  85272. * @param right defines the second operand
  85273. * @returns a new Color4 object
  85274. */
  85275. add(right: DeepImmutable<Color4>): Color4;
  85276. /**
  85277. * Creates a new Color4 set with the subtracted values of the given one from the current Color4
  85278. * @param right defines the second operand
  85279. * @returns a new Color4 object
  85280. */
  85281. subtract(right: DeepImmutable<Color4>): Color4;
  85282. /**
  85283. * Subtracts the given ones from the current Color4 values and stores the results in "result"
  85284. * @param right defines the second operand
  85285. * @param result defines the Color4 object where to store the result
  85286. * @returns the current Color4 object
  85287. */
  85288. subtractToRef(right: DeepImmutable<Color4>, result: Color4): Color4;
  85289. /**
  85290. * Creates a new Color4 with the current Color4 values multiplied by scale
  85291. * @param scale defines the scaling factor to apply
  85292. * @returns a new Color4 object
  85293. */
  85294. scale(scale: number): Color4;
  85295. /**
  85296. * Multiplies the current Color4 values by scale and stores the result in "result"
  85297. * @param scale defines the scaling factor to apply
  85298. * @param result defines the Color4 object where to store the result
  85299. * @returns the current unmodified Color4
  85300. */
  85301. scaleToRef(scale: number, result: Color4): Color4;
  85302. /**
  85303. * Scale the current Color4 values by a factor and add the result to a given Color4
  85304. * @param scale defines the scale factor
  85305. * @param result defines the Color4 object where to store the result
  85306. * @returns the unmodified current Color4
  85307. */
  85308. scaleAndAddToRef(scale: number, result: Color4): Color4;
  85309. /**
  85310. * Clamps the rgb values by the min and max values and stores the result into "result"
  85311. * @param min defines minimum clamping value (default is 0)
  85312. * @param max defines maximum clamping value (default is 1)
  85313. * @param result defines color to store the result into.
  85314. * @returns the cuurent Color4
  85315. */
  85316. clampToRef(min: number | undefined, max: number | undefined, result: Color4): Color4;
  85317. /**
  85318. * Multipy an Color4 value by another and return a new Color4 object
  85319. * @param color defines the Color4 value to multiply by
  85320. * @returns a new Color4 object
  85321. */
  85322. multiply(color: Color4): Color4;
  85323. /**
  85324. * Multipy a Color4 value by another and push the result in a reference value
  85325. * @param color defines the Color4 value to multiply by
  85326. * @param result defines the Color4 to fill the result in
  85327. * @returns the result Color4
  85328. */
  85329. multiplyToRef(color: Color4, result: Color4): Color4;
  85330. /**
  85331. * Creates a string with the Color4 current values
  85332. * @returns the string representation of the Color4 object
  85333. */
  85334. toString(): string;
  85335. /**
  85336. * Returns the string "Color4"
  85337. * @returns "Color4"
  85338. */
  85339. getClassName(): string;
  85340. /**
  85341. * Compute the Color4 hash code
  85342. * @returns an unique number that can be used to hash Color4 objects
  85343. */
  85344. getHashCode(): number;
  85345. /**
  85346. * Creates a new Color4 copied from the current one
  85347. * @returns a new Color4 object
  85348. */
  85349. clone(): Color4;
  85350. /**
  85351. * Copies the given Color4 values into the current one
  85352. * @param source defines the source Color4 object
  85353. * @returns the current updated Color4 object
  85354. */
  85355. copyFrom(source: Color4): Color4;
  85356. /**
  85357. * Copies the given float values into the current one
  85358. * @param r defines the red component to read from
  85359. * @param g defines the green component to read from
  85360. * @param b defines the blue component to read from
  85361. * @param a defines the alpha component to read from
  85362. * @returns the current updated Color4 object
  85363. */
  85364. copyFromFloats(r: number, g: number, b: number, a: number): Color4;
  85365. /**
  85366. * Copies the given float values into the current one
  85367. * @param r defines the red component to read from
  85368. * @param g defines the green component to read from
  85369. * @param b defines the blue component to read from
  85370. * @param a defines the alpha component to read from
  85371. * @returns the current updated Color4 object
  85372. */
  85373. set(r: number, g: number, b: number, a: number): Color4;
  85374. /**
  85375. * Compute the Color4 hexadecimal code as a string
  85376. * @param returnAsColor3 defines if the string should only contains RGB values (off by default)
  85377. * @returns a string containing the hexadecimal representation of the Color4 object
  85378. */
  85379. toHexString(returnAsColor3?: boolean): string;
  85380. /**
  85381. * Computes a new Color4 converted from the current one to linear space
  85382. * @returns a new Color4 object
  85383. */
  85384. toLinearSpace(): Color4;
  85385. /**
  85386. * Converts the Color4 values to linear space and stores the result in "convertedColor"
  85387. * @param convertedColor defines the Color4 object where to store the linear space version
  85388. * @returns the unmodified Color4
  85389. */
  85390. toLinearSpaceToRef(convertedColor: Color4): Color4;
  85391. /**
  85392. * Computes a new Color4 converted from the current one to gamma space
  85393. * @returns a new Color4 object
  85394. */
  85395. toGammaSpace(): Color4;
  85396. /**
  85397. * Converts the Color4 values to gamma space and stores the result in "convertedColor"
  85398. * @param convertedColor defines the Color4 object where to store the gamma space version
  85399. * @returns the unmodified Color4
  85400. */
  85401. toGammaSpaceToRef(convertedColor: Color4): Color4;
  85402. /**
  85403. * Creates a new Color4 from the string containing valid hexadecimal values
  85404. * @param hex defines a string containing valid hexadecimal values
  85405. * @returns a new Color4 object
  85406. */
  85407. static FromHexString(hex: string): Color4;
  85408. /**
  85409. * Creates a new Color4 object set with the linearly interpolated values of "amount" between the left Color4 object and the right Color4 object
  85410. * @param left defines the start value
  85411. * @param right defines the end value
  85412. * @param amount defines the gradient factor
  85413. * @returns a new Color4 object
  85414. */
  85415. static Lerp(left: DeepImmutable<Color4>, right: DeepImmutable<Color4>, amount: number): Color4;
  85416. /**
  85417. * Set the given "result" with the linearly interpolated values of "amount" between the left Color4 object and the right Color4 object
  85418. * @param left defines the start value
  85419. * @param right defines the end value
  85420. * @param amount defines the gradient factor
  85421. * @param result defines the Color4 object where to store data
  85422. */
  85423. static LerpToRef(left: DeepImmutable<Color4>, right: DeepImmutable<Color4>, amount: number, result: Color4): void;
  85424. /**
  85425. * Creates a new Color4 from a Color3 and an alpha value
  85426. * @param color3 defines the source Color3 to read from
  85427. * @param alpha defines the alpha component (1.0 by default)
  85428. * @returns a new Color4 object
  85429. */
  85430. static FromColor3(color3: DeepImmutable<Color3>, alpha?: number): Color4;
  85431. /**
  85432. * Creates a new Color4 from the starting index element of the given array
  85433. * @param array defines the source array to read from
  85434. * @param offset defines the offset in the source array
  85435. * @returns a new Color4 object
  85436. */
  85437. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color4;
  85438. /**
  85439. * Creates a new Color4 from the starting index element of the given array
  85440. * @param array defines the source array to read from
  85441. * @param offset defines the offset in the source array
  85442. * @param result defines the target Color4 object
  85443. */
  85444. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number | undefined, result: Color4): void;
  85445. /**
  85446. * Creates a new Color3 from integer values (< 256)
  85447. * @param r defines the red component to read from (value between 0 and 255)
  85448. * @param g defines the green component to read from (value between 0 and 255)
  85449. * @param b defines the blue component to read from (value between 0 and 255)
  85450. * @param a defines the alpha component to read from (value between 0 and 255)
  85451. * @returns a new Color3 object
  85452. */
  85453. static FromInts(r: number, g: number, b: number, a: number): Color4;
  85454. /**
  85455. * Check the content of a given array and convert it to an array containing RGBA data
  85456. * If the original array was already containing count * 4 values then it is returned directly
  85457. * @param colors defines the array to check
  85458. * @param count defines the number of RGBA data to expect
  85459. * @returns an array containing count * 4 values (RGBA)
  85460. */
  85461. static CheckColors4(colors: number[], count: number): number[];
  85462. }
  85463. /**
  85464. * @hidden
  85465. */
  85466. export class TmpColors {
  85467. static Color3: Color3[];
  85468. static Color4: Color4[];
  85469. }
  85470. }
  85471. declare module BABYLON {
  85472. /**
  85473. * Defines an interface which represents an animation key frame
  85474. */
  85475. export interface IAnimationKey {
  85476. /**
  85477. * Frame of the key frame
  85478. */
  85479. frame: number;
  85480. /**
  85481. * Value at the specifies key frame
  85482. */
  85483. value: any;
  85484. /**
  85485. * The input tangent for the cubic hermite spline
  85486. */
  85487. inTangent?: any;
  85488. /**
  85489. * The output tangent for the cubic hermite spline
  85490. */
  85491. outTangent?: any;
  85492. /**
  85493. * The animation interpolation type
  85494. */
  85495. interpolation?: AnimationKeyInterpolation;
  85496. }
  85497. /**
  85498. * Enum for the animation key frame interpolation type
  85499. */
  85500. export enum AnimationKeyInterpolation {
  85501. /**
  85502. * Do not interpolate between keys and use the start key value only. Tangents are ignored
  85503. */
  85504. STEP = 1
  85505. }
  85506. }
  85507. declare module BABYLON {
  85508. /**
  85509. * Represents the range of an animation
  85510. */
  85511. export class AnimationRange {
  85512. /**The name of the animation range**/
  85513. name: string;
  85514. /**The starting frame of the animation */
  85515. from: number;
  85516. /**The ending frame of the animation*/
  85517. to: number;
  85518. /**
  85519. * Initializes the range of an animation
  85520. * @param name The name of the animation range
  85521. * @param from The starting frame of the animation
  85522. * @param to The ending frame of the animation
  85523. */
  85524. constructor(
  85525. /**The name of the animation range**/
  85526. name: string,
  85527. /**The starting frame of the animation */
  85528. from: number,
  85529. /**The ending frame of the animation*/
  85530. to: number);
  85531. /**
  85532. * Makes a copy of the animation range
  85533. * @returns A copy of the animation range
  85534. */
  85535. clone(): AnimationRange;
  85536. }
  85537. }
  85538. declare module BABYLON {
  85539. /**
  85540. * Composed of a frame, and an action function
  85541. */
  85542. export class AnimationEvent {
  85543. /** The frame for which the event is triggered **/
  85544. frame: number;
  85545. /** The event to perform when triggered **/
  85546. action: (currentFrame: number) => void;
  85547. /** Specifies if the event should be triggered only once**/
  85548. onlyOnce?: boolean | undefined;
  85549. /**
  85550. * Specifies if the animation event is done
  85551. */
  85552. isDone: boolean;
  85553. /**
  85554. * Initializes the animation event
  85555. * @param frame The frame for which the event is triggered
  85556. * @param action The event to perform when triggered
  85557. * @param onlyOnce Specifies if the event should be triggered only once
  85558. */
  85559. constructor(
  85560. /** The frame for which the event is triggered **/
  85561. frame: number,
  85562. /** The event to perform when triggered **/
  85563. action: (currentFrame: number) => void,
  85564. /** Specifies if the event should be triggered only once**/
  85565. onlyOnce?: boolean | undefined);
  85566. /** @hidden */
  85567. _clone(): AnimationEvent;
  85568. }
  85569. }
  85570. declare module BABYLON {
  85571. /**
  85572. * Interface used to define a behavior
  85573. */
  85574. export interface Behavior<T> {
  85575. /** gets or sets behavior's name */
  85576. name: string;
  85577. /**
  85578. * Function called when the behavior needs to be initialized (after attaching it to a target)
  85579. */
  85580. init(): void;
  85581. /**
  85582. * Called when the behavior is attached to a target
  85583. * @param target defines the target where the behavior is attached to
  85584. */
  85585. attach(target: T): void;
  85586. /**
  85587. * Called when the behavior is detached from its target
  85588. */
  85589. detach(): void;
  85590. }
  85591. /**
  85592. * Interface implemented by classes supporting behaviors
  85593. */
  85594. export interface IBehaviorAware<T> {
  85595. /**
  85596. * Attach a behavior
  85597. * @param behavior defines the behavior to attach
  85598. * @returns the current host
  85599. */
  85600. addBehavior(behavior: Behavior<T>): T;
  85601. /**
  85602. * Remove a behavior from the current object
  85603. * @param behavior defines the behavior to detach
  85604. * @returns the current host
  85605. */
  85606. removeBehavior(behavior: Behavior<T>): T;
  85607. /**
  85608. * Gets a behavior using its name to search
  85609. * @param name defines the name to search
  85610. * @returns the behavior or null if not found
  85611. */
  85612. getBehaviorByName(name: string): Nullable<Behavior<T>>;
  85613. }
  85614. }
  85615. declare module BABYLON {
  85616. /**
  85617. * Defines an array and its length.
  85618. * It can be helpfull to group result from both Arrays and smart arrays in one structure.
  85619. */
  85620. export interface ISmartArrayLike<T> {
  85621. /**
  85622. * The data of the array.
  85623. */
  85624. data: Array<T>;
  85625. /**
  85626. * The active length of the array.
  85627. */
  85628. length: number;
  85629. }
  85630. /**
  85631. * Defines an GC Friendly array where the backfield array do not shrink to prevent over allocations.
  85632. */
  85633. export class SmartArray<T> implements ISmartArrayLike<T> {
  85634. /**
  85635. * The full set of data from the array.
  85636. */
  85637. data: Array<T>;
  85638. /**
  85639. * The active length of the array.
  85640. */
  85641. length: number;
  85642. protected _id: number;
  85643. /**
  85644. * Instantiates a Smart Array.
  85645. * @param capacity defines the default capacity of the array.
  85646. */
  85647. constructor(capacity: number);
  85648. /**
  85649. * Pushes a value at the end of the active data.
  85650. * @param value defines the object to push in the array.
  85651. */
  85652. push(value: T): void;
  85653. /**
  85654. * Iterates over the active data and apply the lambda to them.
  85655. * @param func defines the action to apply on each value.
  85656. */
  85657. forEach(func: (content: T) => void): void;
  85658. /**
  85659. * Sorts the full sets of data.
  85660. * @param compareFn defines the comparison function to apply.
  85661. */
  85662. sort(compareFn: (a: T, b: T) => number): void;
  85663. /**
  85664. * Resets the active data to an empty array.
  85665. */
  85666. reset(): void;
  85667. /**
  85668. * Releases all the data from the array as well as the array.
  85669. */
  85670. dispose(): void;
  85671. /**
  85672. * Concats the active data with a given array.
  85673. * @param array defines the data to concatenate with.
  85674. */
  85675. concat(array: any): void;
  85676. /**
  85677. * Returns the position of a value in the active data.
  85678. * @param value defines the value to find the index for
  85679. * @returns the index if found in the active data otherwise -1
  85680. */
  85681. indexOf(value: T): number;
  85682. /**
  85683. * Returns whether an element is part of the active data.
  85684. * @param value defines the value to look for
  85685. * @returns true if found in the active data otherwise false
  85686. */
  85687. contains(value: T): boolean;
  85688. private static _GlobalId;
  85689. }
  85690. /**
  85691. * Defines an GC Friendly array where the backfield array do not shrink to prevent over allocations.
  85692. * The data in this array can only be present once
  85693. */
  85694. export class SmartArrayNoDuplicate<T> extends SmartArray<T> {
  85695. private _duplicateId;
  85696. /**
  85697. * Pushes a value at the end of the active data.
  85698. * THIS DOES NOT PREVENT DUPPLICATE DATA
  85699. * @param value defines the object to push in the array.
  85700. */
  85701. push(value: T): void;
  85702. /**
  85703. * Pushes a value at the end of the active data.
  85704. * If the data is already present, it won t be added again
  85705. * @param value defines the object to push in the array.
  85706. * @returns true if added false if it was already present
  85707. */
  85708. pushNoDuplicate(value: T): boolean;
  85709. /**
  85710. * Resets the active data to an empty array.
  85711. */
  85712. reset(): void;
  85713. /**
  85714. * Concats the active data with a given array.
  85715. * This ensures no dupplicate will be present in the result.
  85716. * @param array defines the data to concatenate with.
  85717. */
  85718. concatWithNoDuplicate(array: any): void;
  85719. }
  85720. }
  85721. declare module BABYLON {
  85722. /**
  85723. * @ignore
  85724. * This is a list of all the different input types that are available in the application.
  85725. * Fo instance: ArcRotateCameraGamepadInput...
  85726. */
  85727. export var CameraInputTypes: {};
  85728. /**
  85729. * This is the contract to implement in order to create a new input class.
  85730. * Inputs are dealing with listening to user actions and moving the camera accordingly.
  85731. */
  85732. export interface ICameraInput<TCamera extends Camera> {
  85733. /**
  85734. * Defines the camera the input is attached to.
  85735. */
  85736. camera: Nullable<TCamera>;
  85737. /**
  85738. * Gets the class name of the current intput.
  85739. * @returns the class name
  85740. */
  85741. getClassName(): string;
  85742. /**
  85743. * Get the friendly name associated with the input class.
  85744. * @returns the input friendly name
  85745. */
  85746. getSimpleName(): string;
  85747. /**
  85748. * Attach the input controls to a specific dom element to get the input from.
  85749. * @param element Defines the element the controls should be listened from
  85750. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  85751. */
  85752. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  85753. /**
  85754. * Detach the current controls from the specified dom element.
  85755. * @param element Defines the element to stop listening the inputs from
  85756. */
  85757. detachControl(element: Nullable<HTMLElement>): void;
  85758. /**
  85759. * Update the current camera state depending on the inputs that have been used this frame.
  85760. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  85761. */
  85762. checkInputs?: () => void;
  85763. }
  85764. /**
  85765. * Represents a map of input types to input instance or input index to input instance.
  85766. */
  85767. export interface CameraInputsMap<TCamera extends Camera> {
  85768. /**
  85769. * Accessor to the input by input type.
  85770. */
  85771. [name: string]: ICameraInput<TCamera>;
  85772. /**
  85773. * Accessor to the input by input index.
  85774. */
  85775. [idx: number]: ICameraInput<TCamera>;
  85776. }
  85777. /**
  85778. * This represents the input manager used within a camera.
  85779. * It helps dealing with all the different kind of input attached to a camera.
  85780. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  85781. */
  85782. export class CameraInputsManager<TCamera extends Camera> {
  85783. /**
  85784. * Defines the list of inputs attahed to the camera.
  85785. */
  85786. attached: CameraInputsMap<TCamera>;
  85787. /**
  85788. * Defines the dom element the camera is collecting inputs from.
  85789. * This is null if the controls have not been attached.
  85790. */
  85791. attachedElement: Nullable<HTMLElement>;
  85792. /**
  85793. * Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  85794. */
  85795. noPreventDefault: boolean;
  85796. /**
  85797. * Defined the camera the input manager belongs to.
  85798. */
  85799. camera: TCamera;
  85800. /**
  85801. * Update the current camera state depending on the inputs that have been used this frame.
  85802. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  85803. */
  85804. checkInputs: () => void;
  85805. /**
  85806. * Instantiate a new Camera Input Manager.
  85807. * @param camera Defines the camera the input manager blongs to
  85808. */
  85809. constructor(camera: TCamera);
  85810. /**
  85811. * Add an input method to a camera
  85812. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  85813. * @param input camera input method
  85814. */
  85815. add(input: ICameraInput<TCamera>): void;
  85816. /**
  85817. * Remove a specific input method from a camera
  85818. * example: camera.inputs.remove(camera.inputs.attached.mouse);
  85819. * @param inputToRemove camera input method
  85820. */
  85821. remove(inputToRemove: ICameraInput<TCamera>): void;
  85822. /**
  85823. * Remove a specific input type from a camera
  85824. * example: camera.inputs.remove("ArcRotateCameraGamepadInput");
  85825. * @param inputType the type of the input to remove
  85826. */
  85827. removeByType(inputType: string): void;
  85828. private _addCheckInputs;
  85829. /**
  85830. * Attach the input controls to the currently attached dom element to listen the events from.
  85831. * @param input Defines the input to attach
  85832. */
  85833. attachInput(input: ICameraInput<TCamera>): void;
  85834. /**
  85835. * Attach the current manager inputs controls to a specific dom element to listen the events from.
  85836. * @param element Defines the dom element to collect the events from
  85837. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  85838. */
  85839. attachElement(element: HTMLElement, noPreventDefault?: boolean): void;
  85840. /**
  85841. * Detach the current manager inputs controls from a specific dom element.
  85842. * @param element Defines the dom element to collect the events from
  85843. * @param disconnect Defines whether the input should be removed from the current list of attached inputs
  85844. */
  85845. detachElement(element: HTMLElement, disconnect?: boolean): void;
  85846. /**
  85847. * Rebuild the dynamic inputCheck function from the current list of
  85848. * defined inputs in the manager.
  85849. */
  85850. rebuildInputCheck(): void;
  85851. /**
  85852. * Remove all attached input methods from a camera
  85853. */
  85854. clear(): void;
  85855. /**
  85856. * Serialize the current input manager attached to a camera.
  85857. * This ensures than once parsed,
  85858. * the input associated to the camera will be identical to the current ones
  85859. * @param serializedCamera Defines the camera serialization JSON the input serialization should write to
  85860. */
  85861. serialize(serializedCamera: any): void;
  85862. /**
  85863. * Parses an input manager serialized JSON to restore the previous list of inputs
  85864. * and states associated to a camera.
  85865. * @param parsedCamera Defines the JSON to parse
  85866. */
  85867. parse(parsedCamera: any): void;
  85868. }
  85869. }
  85870. declare module BABYLON {
  85871. /**
  85872. * Class used to store data that will be store in GPU memory
  85873. */
  85874. export class Buffer {
  85875. private _engine;
  85876. private _buffer;
  85877. /** @hidden */
  85878. _data: Nullable<DataArray>;
  85879. private _updatable;
  85880. private _instanced;
  85881. private _divisor;
  85882. /**
  85883. * Gets the byte stride.
  85884. */
  85885. readonly byteStride: number;
  85886. /**
  85887. * Constructor
  85888. * @param engine the engine
  85889. * @param data the data to use for this buffer
  85890. * @param updatable whether the data is updatable
  85891. * @param stride the stride (optional)
  85892. * @param postponeInternalCreation whether to postpone creating the internal WebGL buffer (optional)
  85893. * @param instanced whether the buffer is instanced (optional)
  85894. * @param useBytes set to true if the stride in in bytes (optional)
  85895. * @param divisor sets an optional divisor for instances (1 by default)
  85896. */
  85897. constructor(engine: any, data: DataArray, updatable: boolean, stride?: number, postponeInternalCreation?: boolean, instanced?: boolean, useBytes?: boolean, divisor?: number);
  85898. /**
  85899. * Create a new VertexBuffer based on the current buffer
  85900. * @param kind defines the vertex buffer kind (position, normal, etc.)
  85901. * @param offset defines offset in the buffer (0 by default)
  85902. * @param size defines the size in floats of attributes (position is 3 for instance)
  85903. * @param stride defines the stride size in floats in the buffer (the offset to apply to reach next value when data is interleaved)
  85904. * @param instanced defines if the vertex buffer contains indexed data
  85905. * @param useBytes defines if the offset and stride are in bytes *
  85906. * @param divisor sets an optional divisor for instances (1 by default)
  85907. * @returns the new vertex buffer
  85908. */
  85909. createVertexBuffer(kind: string, offset: number, size: number, stride?: number, instanced?: boolean, useBytes?: boolean, divisor?: number): VertexBuffer;
  85910. /**
  85911. * Gets a boolean indicating if the Buffer is updatable?
  85912. * @returns true if the buffer is updatable
  85913. */
  85914. isUpdatable(): boolean;
  85915. /**
  85916. * Gets current buffer's data
  85917. * @returns a DataArray or null
  85918. */
  85919. getData(): Nullable<DataArray>;
  85920. /**
  85921. * Gets underlying native buffer
  85922. * @returns underlying native buffer
  85923. */
  85924. getBuffer(): Nullable<DataBuffer>;
  85925. /**
  85926. * Gets the stride in float32 units (i.e. byte stride / 4).
  85927. * May not be an integer if the byte stride is not divisible by 4.
  85928. * @returns the stride in float32 units
  85929. * @deprecated Please use byteStride instead.
  85930. */
  85931. getStrideSize(): number;
  85932. /**
  85933. * Store data into the buffer. If the buffer was already used it will be either recreated or updated depending on isUpdatable property
  85934. * @param data defines the data to store
  85935. */
  85936. create(data?: Nullable<DataArray>): void;
  85937. /** @hidden */
  85938. _rebuild(): void;
  85939. /**
  85940. * Update current buffer data
  85941. * @param data defines the data to store
  85942. */
  85943. update(data: DataArray): void;
  85944. /**
  85945. * Updates the data directly.
  85946. * @param data the new data
  85947. * @param offset the new offset
  85948. * @param vertexCount the vertex count (optional)
  85949. * @param useBytes set to true if the offset is in bytes
  85950. */
  85951. updateDirectly(data: DataArray, offset: number, vertexCount?: number, useBytes?: boolean): void;
  85952. /**
  85953. * Release all resources
  85954. */
  85955. dispose(): void;
  85956. }
  85957. /**
  85958. * Specialized buffer used to store vertex data
  85959. */
  85960. export class VertexBuffer {
  85961. /** @hidden */
  85962. _buffer: Buffer;
  85963. private _kind;
  85964. private _size;
  85965. private _ownsBuffer;
  85966. private _instanced;
  85967. private _instanceDivisor;
  85968. /**
  85969. * The byte type.
  85970. */
  85971. static readonly BYTE: number;
  85972. /**
  85973. * The unsigned byte type.
  85974. */
  85975. static readonly UNSIGNED_BYTE: number;
  85976. /**
  85977. * The short type.
  85978. */
  85979. static readonly SHORT: number;
  85980. /**
  85981. * The unsigned short type.
  85982. */
  85983. static readonly UNSIGNED_SHORT: number;
  85984. /**
  85985. * The integer type.
  85986. */
  85987. static readonly INT: number;
  85988. /**
  85989. * The unsigned integer type.
  85990. */
  85991. static readonly UNSIGNED_INT: number;
  85992. /**
  85993. * The float type.
  85994. */
  85995. static readonly FLOAT: number;
  85996. /**
  85997. * Gets or sets the instance divisor when in instanced mode
  85998. */
  85999. get instanceDivisor(): number;
  86000. set instanceDivisor(value: number);
  86001. /**
  86002. * Gets the byte stride.
  86003. */
  86004. readonly byteStride: number;
  86005. /**
  86006. * Gets the byte offset.
  86007. */
  86008. readonly byteOffset: number;
  86009. /**
  86010. * Gets whether integer data values should be normalized into a certain range when being casted to a float.
  86011. */
  86012. readonly normalized: boolean;
  86013. /**
  86014. * Gets the data type of each component in the array.
  86015. */
  86016. readonly type: number;
  86017. /**
  86018. * Constructor
  86019. * @param engine the engine
  86020. * @param data the data to use for this vertex buffer
  86021. * @param kind the vertex buffer kind
  86022. * @param updatable whether the data is updatable
  86023. * @param postponeInternalCreation whether to postpone creating the internal WebGL buffer (optional)
  86024. * @param stride the stride (optional)
  86025. * @param instanced whether the buffer is instanced (optional)
  86026. * @param offset the offset of the data (optional)
  86027. * @param size the number of components (optional)
  86028. * @param type the type of the component (optional)
  86029. * @param normalized whether the data contains normalized data (optional)
  86030. * @param useBytes set to true if stride and offset are in bytes (optional)
  86031. * @param divisor defines the instance divisor to use (1 by default)
  86032. */
  86033. 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);
  86034. /** @hidden */
  86035. _rebuild(): void;
  86036. /**
  86037. * Returns the kind of the VertexBuffer (string)
  86038. * @returns a string
  86039. */
  86040. getKind(): string;
  86041. /**
  86042. * Gets a boolean indicating if the VertexBuffer is updatable?
  86043. * @returns true if the buffer is updatable
  86044. */
  86045. isUpdatable(): boolean;
  86046. /**
  86047. * Gets current buffer's data
  86048. * @returns a DataArray or null
  86049. */
  86050. getData(): Nullable<DataArray>;
  86051. /**
  86052. * Gets underlying native buffer
  86053. * @returns underlying native buffer
  86054. */
  86055. getBuffer(): Nullable<DataBuffer>;
  86056. /**
  86057. * Gets the stride in float32 units (i.e. byte stride / 4).
  86058. * May not be an integer if the byte stride is not divisible by 4.
  86059. * @returns the stride in float32 units
  86060. * @deprecated Please use byteStride instead.
  86061. */
  86062. getStrideSize(): number;
  86063. /**
  86064. * Returns the offset as a multiple of the type byte length.
  86065. * @returns the offset in bytes
  86066. * @deprecated Please use byteOffset instead.
  86067. */
  86068. getOffset(): number;
  86069. /**
  86070. * Returns the number of components per vertex attribute (integer)
  86071. * @returns the size in float
  86072. */
  86073. getSize(): number;
  86074. /**
  86075. * Gets a boolean indicating is the internal buffer of the VertexBuffer is instanced
  86076. * @returns true if this buffer is instanced
  86077. */
  86078. getIsInstanced(): boolean;
  86079. /**
  86080. * Returns the instancing divisor, zero for non-instanced (integer).
  86081. * @returns a number
  86082. */
  86083. getInstanceDivisor(): number;
  86084. /**
  86085. * Store data into the buffer. If the buffer was already used it will be either recreated or updated depending on isUpdatable property
  86086. * @param data defines the data to store
  86087. */
  86088. create(data?: DataArray): void;
  86089. /**
  86090. * Updates the underlying buffer according to the passed numeric array or Float32Array.
  86091. * This function will create a new buffer if the current one is not updatable
  86092. * @param data defines the data to store
  86093. */
  86094. update(data: DataArray): void;
  86095. /**
  86096. * Updates directly the underlying WebGLBuffer according to the passed numeric array or Float32Array.
  86097. * Returns the directly updated WebGLBuffer.
  86098. * @param data the new data
  86099. * @param offset the new offset
  86100. * @param useBytes set to true if the offset is in bytes
  86101. */
  86102. updateDirectly(data: DataArray, offset: number, useBytes?: boolean): void;
  86103. /**
  86104. * Disposes the VertexBuffer and the underlying WebGLBuffer.
  86105. */
  86106. dispose(): void;
  86107. /**
  86108. * Enumerates each value of this vertex buffer as numbers.
  86109. * @param count the number of values to enumerate
  86110. * @param callback the callback function called for each value
  86111. */
  86112. forEach(count: number, callback: (value: number, index: number) => void): void;
  86113. /**
  86114. * Positions
  86115. */
  86116. static readonly PositionKind: string;
  86117. /**
  86118. * Normals
  86119. */
  86120. static readonly NormalKind: string;
  86121. /**
  86122. * Tangents
  86123. */
  86124. static readonly TangentKind: string;
  86125. /**
  86126. * Texture coordinates
  86127. */
  86128. static readonly UVKind: string;
  86129. /**
  86130. * Texture coordinates 2
  86131. */
  86132. static readonly UV2Kind: string;
  86133. /**
  86134. * Texture coordinates 3
  86135. */
  86136. static readonly UV3Kind: string;
  86137. /**
  86138. * Texture coordinates 4
  86139. */
  86140. static readonly UV4Kind: string;
  86141. /**
  86142. * Texture coordinates 5
  86143. */
  86144. static readonly UV5Kind: string;
  86145. /**
  86146. * Texture coordinates 6
  86147. */
  86148. static readonly UV6Kind: string;
  86149. /**
  86150. * Colors
  86151. */
  86152. static readonly ColorKind: string;
  86153. /**
  86154. * Matrix indices (for bones)
  86155. */
  86156. static readonly MatricesIndicesKind: string;
  86157. /**
  86158. * Matrix weights (for bones)
  86159. */
  86160. static readonly MatricesWeightsKind: string;
  86161. /**
  86162. * Additional matrix indices (for bones)
  86163. */
  86164. static readonly MatricesIndicesExtraKind: string;
  86165. /**
  86166. * Additional matrix weights (for bones)
  86167. */
  86168. static readonly MatricesWeightsExtraKind: string;
  86169. /**
  86170. * Deduces the stride given a kind.
  86171. * @param kind The kind string to deduce
  86172. * @returns The deduced stride
  86173. */
  86174. static DeduceStride(kind: string): number;
  86175. /**
  86176. * Gets the byte length of the given type.
  86177. * @param type the type
  86178. * @returns the number of bytes
  86179. */
  86180. static GetTypeByteLength(type: number): number;
  86181. /**
  86182. * Enumerates each value of the given parameters as numbers.
  86183. * @param data the data to enumerate
  86184. * @param byteOffset the byte offset of the data
  86185. * @param byteStride the byte stride of the data
  86186. * @param componentCount the number of components per element
  86187. * @param componentType the type of the component
  86188. * @param count the number of values to enumerate
  86189. * @param normalized whether the data is normalized
  86190. * @param callback the callback function called for each value
  86191. */
  86192. static ForEach(data: DataArray, byteOffset: number, byteStride: number, componentCount: number, componentType: number, count: number, normalized: boolean, callback: (value: number, index: number) => void): void;
  86193. private static _GetFloatValue;
  86194. }
  86195. }
  86196. declare module BABYLON {
  86197. /**
  86198. * @hidden
  86199. */
  86200. export class IntersectionInfo {
  86201. bu: Nullable<number>;
  86202. bv: Nullable<number>;
  86203. distance: number;
  86204. faceId: number;
  86205. subMeshId: number;
  86206. constructor(bu: Nullable<number>, bv: Nullable<number>, distance: number);
  86207. }
  86208. }
  86209. declare module BABYLON {
  86210. /**
  86211. * Class used to store bounding sphere information
  86212. */
  86213. export class BoundingSphere {
  86214. /**
  86215. * Gets the center of the bounding sphere in local space
  86216. */
  86217. readonly center: Vector3;
  86218. /**
  86219. * Radius of the bounding sphere in local space
  86220. */
  86221. radius: number;
  86222. /**
  86223. * Gets the center of the bounding sphere in world space
  86224. */
  86225. readonly centerWorld: Vector3;
  86226. /**
  86227. * Radius of the bounding sphere in world space
  86228. */
  86229. radiusWorld: number;
  86230. /**
  86231. * Gets the minimum vector in local space
  86232. */
  86233. readonly minimum: Vector3;
  86234. /**
  86235. * Gets the maximum vector in local space
  86236. */
  86237. readonly maximum: Vector3;
  86238. private _worldMatrix;
  86239. private static readonly TmpVector3;
  86240. /**
  86241. * Creates a new bounding sphere
  86242. * @param min defines the minimum vector (in local space)
  86243. * @param max defines the maximum vector (in local space)
  86244. * @param worldMatrix defines the new world matrix
  86245. */
  86246. constructor(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  86247. /**
  86248. * Recreates the entire bounding sphere from scratch as if we call the constructor in place
  86249. * @param min defines the new minimum vector (in local space)
  86250. * @param max defines the new maximum vector (in local space)
  86251. * @param worldMatrix defines the new world matrix
  86252. */
  86253. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  86254. /**
  86255. * Scale the current bounding sphere by applying a scale factor
  86256. * @param factor defines the scale factor to apply
  86257. * @returns the current bounding box
  86258. */
  86259. scale(factor: number): BoundingSphere;
  86260. /**
  86261. * Gets the world matrix of the bounding box
  86262. * @returns a matrix
  86263. */
  86264. getWorldMatrix(): DeepImmutable<Matrix>;
  86265. /** @hidden */
  86266. _update(worldMatrix: DeepImmutable<Matrix>): void;
  86267. /**
  86268. * Tests if the bounding sphere is intersecting the frustum planes
  86269. * @param frustumPlanes defines the frustum planes to test
  86270. * @returns true if there is an intersection
  86271. */
  86272. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  86273. /**
  86274. * Tests if the bounding sphere center is in between the frustum planes.
  86275. * Used for optimistic fast inclusion.
  86276. * @param frustumPlanes defines the frustum planes to test
  86277. * @returns true if the sphere center is in between the frustum planes
  86278. */
  86279. isCenterInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  86280. /**
  86281. * Tests if a point is inside the bounding sphere
  86282. * @param point defines the point to test
  86283. * @returns true if the point is inside the bounding sphere
  86284. */
  86285. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  86286. /**
  86287. * Checks if two sphere intersct
  86288. * @param sphere0 sphere 0
  86289. * @param sphere1 sphere 1
  86290. * @returns true if the speres intersect
  86291. */
  86292. static Intersects(sphere0: DeepImmutable<BoundingSphere>, sphere1: DeepImmutable<BoundingSphere>): boolean;
  86293. }
  86294. }
  86295. declare module BABYLON {
  86296. /**
  86297. * Class used to store bounding box information
  86298. */
  86299. export class BoundingBox implements ICullable {
  86300. /**
  86301. * Gets the 8 vectors representing the bounding box in local space
  86302. */
  86303. readonly vectors: Vector3[];
  86304. /**
  86305. * Gets the center of the bounding box in local space
  86306. */
  86307. readonly center: Vector3;
  86308. /**
  86309. * Gets the center of the bounding box in world space
  86310. */
  86311. readonly centerWorld: Vector3;
  86312. /**
  86313. * Gets the extend size in local space
  86314. */
  86315. readonly extendSize: Vector3;
  86316. /**
  86317. * Gets the extend size in world space
  86318. */
  86319. readonly extendSizeWorld: Vector3;
  86320. /**
  86321. * Gets the OBB (object bounding box) directions
  86322. */
  86323. readonly directions: Vector3[];
  86324. /**
  86325. * Gets the 8 vectors representing the bounding box in world space
  86326. */
  86327. readonly vectorsWorld: Vector3[];
  86328. /**
  86329. * Gets the minimum vector in world space
  86330. */
  86331. readonly minimumWorld: Vector3;
  86332. /**
  86333. * Gets the maximum vector in world space
  86334. */
  86335. readonly maximumWorld: Vector3;
  86336. /**
  86337. * Gets the minimum vector in local space
  86338. */
  86339. readonly minimum: Vector3;
  86340. /**
  86341. * Gets the maximum vector in local space
  86342. */
  86343. readonly maximum: Vector3;
  86344. private _worldMatrix;
  86345. private static readonly TmpVector3;
  86346. /**
  86347. * @hidden
  86348. */
  86349. _tag: number;
  86350. /**
  86351. * Creates a new bounding box
  86352. * @param min defines the minimum vector (in local space)
  86353. * @param max defines the maximum vector (in local space)
  86354. * @param worldMatrix defines the new world matrix
  86355. */
  86356. constructor(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  86357. /**
  86358. * Recreates the entire bounding box from scratch as if we call the constructor in place
  86359. * @param min defines the new minimum vector (in local space)
  86360. * @param max defines the new maximum vector (in local space)
  86361. * @param worldMatrix defines the new world matrix
  86362. */
  86363. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  86364. /**
  86365. * Scale the current bounding box by applying a scale factor
  86366. * @param factor defines the scale factor to apply
  86367. * @returns the current bounding box
  86368. */
  86369. scale(factor: number): BoundingBox;
  86370. /**
  86371. * Gets the world matrix of the bounding box
  86372. * @returns a matrix
  86373. */
  86374. getWorldMatrix(): DeepImmutable<Matrix>;
  86375. /** @hidden */
  86376. _update(world: DeepImmutable<Matrix>): void;
  86377. /**
  86378. * Tests if the bounding box is intersecting the frustum planes
  86379. * @param frustumPlanes defines the frustum planes to test
  86380. * @returns true if there is an intersection
  86381. */
  86382. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  86383. /**
  86384. * Tests if the bounding box is entirely inside the frustum planes
  86385. * @param frustumPlanes defines the frustum planes to test
  86386. * @returns true if there is an inclusion
  86387. */
  86388. isCompletelyInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  86389. /**
  86390. * Tests if a point is inside the bounding box
  86391. * @param point defines the point to test
  86392. * @returns true if the point is inside the bounding box
  86393. */
  86394. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  86395. /**
  86396. * Tests if the bounding box intersects with a bounding sphere
  86397. * @param sphere defines the sphere to test
  86398. * @returns true if there is an intersection
  86399. */
  86400. intersectsSphere(sphere: DeepImmutable<BoundingSphere>): boolean;
  86401. /**
  86402. * Tests if the bounding box intersects with a box defined by a min and max vectors
  86403. * @param min defines the min vector to use
  86404. * @param max defines the max vector to use
  86405. * @returns true if there is an intersection
  86406. */
  86407. intersectsMinMax(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>): boolean;
  86408. /**
  86409. * Tests if two bounding boxes are intersections
  86410. * @param box0 defines the first box to test
  86411. * @param box1 defines the second box to test
  86412. * @returns true if there is an intersection
  86413. */
  86414. static Intersects(box0: DeepImmutable<BoundingBox>, box1: DeepImmutable<BoundingBox>): boolean;
  86415. /**
  86416. * Tests if a bounding box defines by a min/max vectors intersects a sphere
  86417. * @param minPoint defines the minimum vector of the bounding box
  86418. * @param maxPoint defines the maximum vector of the bounding box
  86419. * @param sphereCenter defines the sphere center
  86420. * @param sphereRadius defines the sphere radius
  86421. * @returns true if there is an intersection
  86422. */
  86423. static IntersectsSphere(minPoint: DeepImmutable<Vector3>, maxPoint: DeepImmutable<Vector3>, sphereCenter: DeepImmutable<Vector3>, sphereRadius: number): boolean;
  86424. /**
  86425. * Tests if a bounding box defined with 8 vectors is entirely inside frustum planes
  86426. * @param boundingVectors defines an array of 8 vectors representing a bounding box
  86427. * @param frustumPlanes defines the frustum planes to test
  86428. * @return true if there is an inclusion
  86429. */
  86430. static IsCompletelyInFrustum(boundingVectors: Array<DeepImmutable<Vector3>>, frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  86431. /**
  86432. * Tests if a bounding box defined with 8 vectors intersects frustum planes
  86433. * @param boundingVectors defines an array of 8 vectors representing a bounding box
  86434. * @param frustumPlanes defines the frustum planes to test
  86435. * @return true if there is an intersection
  86436. */
  86437. static IsInFrustum(boundingVectors: Array<DeepImmutable<Vector3>>, frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  86438. }
  86439. }
  86440. declare module BABYLON {
  86441. /** @hidden */
  86442. export class Collider {
  86443. /** Define if a collision was found */
  86444. collisionFound: boolean;
  86445. /**
  86446. * Define last intersection point in local space
  86447. */
  86448. intersectionPoint: Vector3;
  86449. /**
  86450. * Define last collided mesh
  86451. */
  86452. collidedMesh: Nullable<AbstractMesh>;
  86453. private _collisionPoint;
  86454. private _planeIntersectionPoint;
  86455. private _tempVector;
  86456. private _tempVector2;
  86457. private _tempVector3;
  86458. private _tempVector4;
  86459. private _edge;
  86460. private _baseToVertex;
  86461. private _destinationPoint;
  86462. private _slidePlaneNormal;
  86463. private _displacementVector;
  86464. /** @hidden */
  86465. _radius: Vector3;
  86466. /** @hidden */
  86467. _retry: number;
  86468. private _velocity;
  86469. private _basePoint;
  86470. private _epsilon;
  86471. /** @hidden */
  86472. _velocityWorldLength: number;
  86473. /** @hidden */
  86474. _basePointWorld: Vector3;
  86475. private _velocityWorld;
  86476. private _normalizedVelocity;
  86477. /** @hidden */
  86478. _initialVelocity: Vector3;
  86479. /** @hidden */
  86480. _initialPosition: Vector3;
  86481. private _nearestDistance;
  86482. private _collisionMask;
  86483. get collisionMask(): number;
  86484. set collisionMask(mask: number);
  86485. /**
  86486. * Gets the plane normal used to compute the sliding response (in local space)
  86487. */
  86488. get slidePlaneNormal(): Vector3;
  86489. /** @hidden */
  86490. _initialize(source: Vector3, dir: Vector3, e: number): void;
  86491. /** @hidden */
  86492. _checkPointInTriangle(point: Vector3, pa: Vector3, pb: Vector3, pc: Vector3, n: Vector3): boolean;
  86493. /** @hidden */
  86494. _canDoCollision(sphereCenter: Vector3, sphereRadius: number, vecMin: Vector3, vecMax: Vector3): boolean;
  86495. /** @hidden */
  86496. _testTriangle(faceIndex: number, trianglePlaneArray: Array<Plane>, p1: Vector3, p2: Vector3, p3: Vector3, hasMaterial: boolean, hostMesh: AbstractMesh): void;
  86497. /** @hidden */
  86498. _collide(trianglePlaneArray: Array<Plane>, pts: Vector3[], indices: IndicesArray, indexStart: number, indexEnd: number, decal: number, hasMaterial: boolean, hostMesh: AbstractMesh): void;
  86499. /** @hidden */
  86500. _getResponse(pos: Vector3, vel: Vector3): void;
  86501. }
  86502. }
  86503. declare module BABYLON {
  86504. /**
  86505. * Interface for cullable objects
  86506. * @see https://doc.babylonjs.com/babylon101/materials#back-face-culling
  86507. */
  86508. export interface ICullable {
  86509. /**
  86510. * Checks if the object or part of the object is in the frustum
  86511. * @param frustumPlanes Camera near/planes
  86512. * @returns true if the object is in frustum otherwise false
  86513. */
  86514. isInFrustum(frustumPlanes: Plane[]): boolean;
  86515. /**
  86516. * Checks if a cullable object (mesh...) is in the camera frustum
  86517. * Unlike isInFrustum this cheks the full bounding box
  86518. * @param frustumPlanes Camera near/planes
  86519. * @returns true if the object is in frustum otherwise false
  86520. */
  86521. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  86522. }
  86523. /**
  86524. * Info for a bounding data of a mesh
  86525. */
  86526. export class BoundingInfo implements ICullable {
  86527. /**
  86528. * Bounding box for the mesh
  86529. */
  86530. readonly boundingBox: BoundingBox;
  86531. /**
  86532. * Bounding sphere for the mesh
  86533. */
  86534. readonly boundingSphere: BoundingSphere;
  86535. private _isLocked;
  86536. private static readonly TmpVector3;
  86537. /**
  86538. * Constructs bounding info
  86539. * @param minimum min vector of the bounding box/sphere
  86540. * @param maximum max vector of the bounding box/sphere
  86541. * @param worldMatrix defines the new world matrix
  86542. */
  86543. constructor(minimum: DeepImmutable<Vector3>, maximum: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  86544. /**
  86545. * Recreates the entire bounding info from scratch as if we call the constructor in place
  86546. * @param min defines the new minimum vector (in local space)
  86547. * @param max defines the new maximum vector (in local space)
  86548. * @param worldMatrix defines the new world matrix
  86549. */
  86550. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  86551. /**
  86552. * min vector of the bounding box/sphere
  86553. */
  86554. get minimum(): Vector3;
  86555. /**
  86556. * max vector of the bounding box/sphere
  86557. */
  86558. get maximum(): Vector3;
  86559. /**
  86560. * If the info is locked and won't be updated to avoid perf overhead
  86561. */
  86562. get isLocked(): boolean;
  86563. set isLocked(value: boolean);
  86564. /**
  86565. * Updates the bounding sphere and box
  86566. * @param world world matrix to be used to update
  86567. */
  86568. update(world: DeepImmutable<Matrix>): void;
  86569. /**
  86570. * Recreate the bounding info to be centered around a specific point given a specific extend.
  86571. * @param center New center of the bounding info
  86572. * @param extend New extend of the bounding info
  86573. * @returns the current bounding info
  86574. */
  86575. centerOn(center: DeepImmutable<Vector3>, extend: DeepImmutable<Vector3>): BoundingInfo;
  86576. /**
  86577. * Scale the current bounding info by applying a scale factor
  86578. * @param factor defines the scale factor to apply
  86579. * @returns the current bounding info
  86580. */
  86581. scale(factor: number): BoundingInfo;
  86582. /**
  86583. * Returns `true` if the bounding info is within the frustum defined by the passed array of planes.
  86584. * @param frustumPlanes defines the frustum to test
  86585. * @param strategy defines the strategy to use for the culling (default is BABYLON.AbstractMesh.CULLINGSTRATEGY_STANDARD)
  86586. * @returns true if the bounding info is in the frustum planes
  86587. */
  86588. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>, strategy?: number): boolean;
  86589. /**
  86590. * Gets the world distance between the min and max points of the bounding box
  86591. */
  86592. get diagonalLength(): number;
  86593. /**
  86594. * Checks if a cullable object (mesh...) is in the camera frustum
  86595. * Unlike isInFrustum this cheks the full bounding box
  86596. * @param frustumPlanes Camera near/planes
  86597. * @returns true if the object is in frustum otherwise false
  86598. */
  86599. isCompletelyInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  86600. /** @hidden */
  86601. _checkCollision(collider: Collider): boolean;
  86602. /**
  86603. * Checks if a point is inside the bounding box and bounding sphere or the mesh
  86604. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  86605. * @param point the point to check intersection with
  86606. * @returns if the point intersects
  86607. */
  86608. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  86609. /**
  86610. * Checks if another bounding info intersects the bounding box and bounding sphere or the mesh
  86611. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  86612. * @param boundingInfo the bounding info to check intersection with
  86613. * @param precise if the intersection should be done using OBB
  86614. * @returns if the bounding info intersects
  86615. */
  86616. intersects(boundingInfo: DeepImmutable<BoundingInfo>, precise: boolean): boolean;
  86617. }
  86618. }
  86619. declare module BABYLON {
  86620. /**
  86621. * Extracts minimum and maximum values from a list of indexed positions
  86622. * @param positions defines the positions to use
  86623. * @param indices defines the indices to the positions
  86624. * @param indexStart defines the start index
  86625. * @param indexCount defines the end index
  86626. * @param bias defines bias value to add to the result
  86627. * @return minimum and maximum values
  86628. */
  86629. export function extractMinAndMaxIndexed(positions: FloatArray, indices: IndicesArray, indexStart: number, indexCount: number, bias?: Nullable<Vector2>): {
  86630. minimum: Vector3;
  86631. maximum: Vector3;
  86632. };
  86633. /**
  86634. * Extracts minimum and maximum values from a list of positions
  86635. * @param positions defines the positions to use
  86636. * @param start defines the start index in the positions array
  86637. * @param count defines the number of positions to handle
  86638. * @param bias defines bias value to add to the result
  86639. * @param stride defines the stride size to use (distance between two positions in the positions array)
  86640. * @return minimum and maximum values
  86641. */
  86642. export function extractMinAndMax(positions: FloatArray, start: number, count: number, bias?: Nullable<Vector2>, stride?: number): {
  86643. minimum: Vector3;
  86644. maximum: Vector3;
  86645. };
  86646. }
  86647. declare module BABYLON {
  86648. /** @hidden */
  86649. export class WebGLDataBuffer extends DataBuffer {
  86650. private _buffer;
  86651. constructor(resource: WebGLBuffer);
  86652. get underlyingResource(): any;
  86653. }
  86654. }
  86655. declare module BABYLON {
  86656. /** @hidden */
  86657. export class WebGLPipelineContext implements IPipelineContext {
  86658. engine: ThinEngine;
  86659. program: Nullable<WebGLProgram>;
  86660. context?: WebGLRenderingContext;
  86661. vertexShader?: WebGLShader;
  86662. fragmentShader?: WebGLShader;
  86663. isParallelCompiled: boolean;
  86664. onCompiled?: () => void;
  86665. transformFeedback?: WebGLTransformFeedback | null;
  86666. vertexCompilationError: Nullable<string>;
  86667. fragmentCompilationError: Nullable<string>;
  86668. programLinkError: Nullable<string>;
  86669. programValidationError: Nullable<string>;
  86670. get isAsync(): boolean;
  86671. get isReady(): boolean;
  86672. _handlesSpectorRebuildCallback(onCompiled: (program: WebGLProgram) => void): void;
  86673. _getVertexShaderCode(): string | null;
  86674. _getFragmentShaderCode(): string | null;
  86675. }
  86676. }
  86677. declare module BABYLON {
  86678. interface ThinEngine {
  86679. /**
  86680. * Create an uniform buffer
  86681. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  86682. * @param elements defines the content of the uniform buffer
  86683. * @returns the webGL uniform buffer
  86684. */
  86685. createUniformBuffer(elements: FloatArray): DataBuffer;
  86686. /**
  86687. * Create a dynamic uniform buffer
  86688. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  86689. * @param elements defines the content of the uniform buffer
  86690. * @returns the webGL uniform buffer
  86691. */
  86692. createDynamicUniformBuffer(elements: FloatArray): DataBuffer;
  86693. /**
  86694. * Update an existing uniform buffer
  86695. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  86696. * @param uniformBuffer defines the target uniform buffer
  86697. * @param elements defines the content to update
  86698. * @param offset defines the offset in the uniform buffer where update should start
  86699. * @param count defines the size of the data to update
  86700. */
  86701. updateUniformBuffer(uniformBuffer: DataBuffer, elements: FloatArray, offset?: number, count?: number): void;
  86702. /**
  86703. * Bind an uniform buffer to the current webGL context
  86704. * @param buffer defines the buffer to bind
  86705. */
  86706. bindUniformBuffer(buffer: Nullable<DataBuffer>): void;
  86707. /**
  86708. * Bind a buffer to the current webGL context at a given location
  86709. * @param buffer defines the buffer to bind
  86710. * @param location defines the index where to bind the buffer
  86711. */
  86712. bindUniformBufferBase(buffer: DataBuffer, location: number): void;
  86713. /**
  86714. * Bind a specific block at a given index in a specific shader program
  86715. * @param pipelineContext defines the pipeline context to use
  86716. * @param blockName defines the block name
  86717. * @param index defines the index where to bind the block
  86718. */
  86719. bindUniformBlock(pipelineContext: IPipelineContext, blockName: string, index: number): void;
  86720. }
  86721. }
  86722. declare module BABYLON {
  86723. /**
  86724. * Uniform buffer objects.
  86725. *
  86726. * Handles blocks of uniform on the GPU.
  86727. *
  86728. * If WebGL 2 is not available, this class falls back on traditionnal setUniformXXX calls.
  86729. *
  86730. * For more information, please refer to :
  86731. * https://www.khronos.org/opengl/wiki/Uniform_Buffer_Object
  86732. */
  86733. export class UniformBuffer {
  86734. private _engine;
  86735. private _buffer;
  86736. private _data;
  86737. private _bufferData;
  86738. private _dynamic?;
  86739. private _uniformLocations;
  86740. private _uniformSizes;
  86741. private _uniformLocationPointer;
  86742. private _needSync;
  86743. private _noUBO;
  86744. private _currentEffect;
  86745. /** @hidden */
  86746. _alreadyBound: boolean;
  86747. private static _MAX_UNIFORM_SIZE;
  86748. private static _tempBuffer;
  86749. /**
  86750. * Lambda to Update a 3x3 Matrix in a uniform buffer.
  86751. * This is dynamic to allow compat with webgl 1 and 2.
  86752. * You will need to pass the name of the uniform as well as the value.
  86753. */
  86754. updateMatrix3x3: (name: string, matrix: Float32Array) => void;
  86755. /**
  86756. * Lambda to Update a 2x2 Matrix in a uniform buffer.
  86757. * This is dynamic to allow compat with webgl 1 and 2.
  86758. * You will need to pass the name of the uniform as well as the value.
  86759. */
  86760. updateMatrix2x2: (name: string, matrix: Float32Array) => void;
  86761. /**
  86762. * Lambda to Update a single float in a uniform buffer.
  86763. * This is dynamic to allow compat with webgl 1 and 2.
  86764. * You will need to pass the name of the uniform as well as the value.
  86765. */
  86766. updateFloat: (name: string, x: number) => void;
  86767. /**
  86768. * Lambda to Update a vec2 of float in a uniform buffer.
  86769. * This is dynamic to allow compat with webgl 1 and 2.
  86770. * You will need to pass the name of the uniform as well as the value.
  86771. */
  86772. updateFloat2: (name: string, x: number, y: number, suffix?: string) => void;
  86773. /**
  86774. * Lambda to Update a vec3 of float in a uniform buffer.
  86775. * This is dynamic to allow compat with webgl 1 and 2.
  86776. * You will need to pass the name of the uniform as well as the value.
  86777. */
  86778. updateFloat3: (name: string, x: number, y: number, z: number, suffix?: string) => void;
  86779. /**
  86780. * Lambda to Update a vec4 of float in a uniform buffer.
  86781. * This is dynamic to allow compat with webgl 1 and 2.
  86782. * You will need to pass the name of the uniform as well as the value.
  86783. */
  86784. updateFloat4: (name: string, x: number, y: number, z: number, w: number, suffix?: string) => void;
  86785. /**
  86786. * Lambda to Update a 4x4 Matrix in a uniform buffer.
  86787. * This is dynamic to allow compat with webgl 1 and 2.
  86788. * You will need to pass the name of the uniform as well as the value.
  86789. */
  86790. updateMatrix: (name: string, mat: Matrix) => void;
  86791. /**
  86792. * Lambda to Update vec3 of float from a Vector in a uniform buffer.
  86793. * This is dynamic to allow compat with webgl 1 and 2.
  86794. * You will need to pass the name of the uniform as well as the value.
  86795. */
  86796. updateVector3: (name: string, vector: Vector3) => void;
  86797. /**
  86798. * Lambda to Update vec4 of float from a Vector in a uniform buffer.
  86799. * This is dynamic to allow compat with webgl 1 and 2.
  86800. * You will need to pass the name of the uniform as well as the value.
  86801. */
  86802. updateVector4: (name: string, vector: Vector4) => void;
  86803. /**
  86804. * Lambda to Update vec3 of float from a Color in a uniform buffer.
  86805. * This is dynamic to allow compat with webgl 1 and 2.
  86806. * You will need to pass the name of the uniform as well as the value.
  86807. */
  86808. updateColor3: (name: string, color: Color3, suffix?: string) => void;
  86809. /**
  86810. * Lambda to Update vec4 of float from a Color in a uniform buffer.
  86811. * This is dynamic to allow compat with webgl 1 and 2.
  86812. * You will need to pass the name of the uniform as well as the value.
  86813. */
  86814. updateColor4: (name: string, color: Color3, alpha: number, suffix?: string) => void;
  86815. /**
  86816. * Instantiates a new Uniform buffer objects.
  86817. *
  86818. * Handles blocks of uniform on the GPU.
  86819. *
  86820. * If WebGL 2 is not available, this class falls back on traditionnal setUniformXXX calls.
  86821. *
  86822. * For more information, please refer to :
  86823. * @see https://www.khronos.org/opengl/wiki/Uniform_Buffer_Object
  86824. * @param engine Define the engine the buffer is associated with
  86825. * @param data Define the data contained in the buffer
  86826. * @param dynamic Define if the buffer is updatable
  86827. */
  86828. constructor(engine: Engine, data?: number[], dynamic?: boolean);
  86829. /**
  86830. * Indicates if the buffer is using the WebGL2 UBO implementation,
  86831. * or just falling back on setUniformXXX calls.
  86832. */
  86833. get useUbo(): boolean;
  86834. /**
  86835. * Indicates if the WebGL underlying uniform buffer is in sync
  86836. * with the javascript cache data.
  86837. */
  86838. get isSync(): boolean;
  86839. /**
  86840. * Indicates if the WebGL underlying uniform buffer is dynamic.
  86841. * Also, a dynamic UniformBuffer will disable cache verification and always
  86842. * update the underlying WebGL uniform buffer to the GPU.
  86843. * @returns if Dynamic, otherwise false
  86844. */
  86845. isDynamic(): boolean;
  86846. /**
  86847. * The data cache on JS side.
  86848. * @returns the underlying data as a float array
  86849. */
  86850. getData(): Float32Array;
  86851. /**
  86852. * The underlying WebGL Uniform buffer.
  86853. * @returns the webgl buffer
  86854. */
  86855. getBuffer(): Nullable<DataBuffer>;
  86856. /**
  86857. * std140 layout specifies how to align data within an UBO structure.
  86858. * See https://khronos.org/registry/OpenGL/specs/gl/glspec45.core.pdf#page=159
  86859. * for specs.
  86860. */
  86861. private _fillAlignment;
  86862. /**
  86863. * Adds an uniform in the buffer.
  86864. * Warning : the subsequents calls of this function must be in the same order as declared in the shader
  86865. * for the layout to be correct !
  86866. * @param name Name of the uniform, as used in the uniform block in the shader.
  86867. * @param size Data size, or data directly.
  86868. */
  86869. addUniform(name: string, size: number | number[]): void;
  86870. /**
  86871. * Adds a Matrix 4x4 to the uniform buffer.
  86872. * @param name Name of the uniform, as used in the uniform block in the shader.
  86873. * @param mat A 4x4 matrix.
  86874. */
  86875. addMatrix(name: string, mat: Matrix): void;
  86876. /**
  86877. * Adds a vec2 to the uniform buffer.
  86878. * @param name Name of the uniform, as used in the uniform block in the shader.
  86879. * @param x Define the x component value of the vec2
  86880. * @param y Define the y component value of the vec2
  86881. */
  86882. addFloat2(name: string, x: number, y: number): void;
  86883. /**
  86884. * Adds a vec3 to the uniform buffer.
  86885. * @param name Name of the uniform, as used in the uniform block in the shader.
  86886. * @param x Define the x component value of the vec3
  86887. * @param y Define the y component value of the vec3
  86888. * @param z Define the z component value of the vec3
  86889. */
  86890. addFloat3(name: string, x: number, y: number, z: number): void;
  86891. /**
  86892. * Adds a vec3 to the uniform buffer.
  86893. * @param name Name of the uniform, as used in the uniform block in the shader.
  86894. * @param color Define the vec3 from a Color
  86895. */
  86896. addColor3(name: string, color: Color3): void;
  86897. /**
  86898. * Adds a vec4 to the uniform buffer.
  86899. * @param name Name of the uniform, as used in the uniform block in the shader.
  86900. * @param color Define the rgb components from a Color
  86901. * @param alpha Define the a component of the vec4
  86902. */
  86903. addColor4(name: string, color: Color3, alpha: number): void;
  86904. /**
  86905. * Adds a vec3 to the uniform buffer.
  86906. * @param name Name of the uniform, as used in the uniform block in the shader.
  86907. * @param vector Define the vec3 components from a Vector
  86908. */
  86909. addVector3(name: string, vector: Vector3): void;
  86910. /**
  86911. * Adds a Matrix 3x3 to the uniform buffer.
  86912. * @param name Name of the uniform, as used in the uniform block in the shader.
  86913. */
  86914. addMatrix3x3(name: string): void;
  86915. /**
  86916. * Adds a Matrix 2x2 to the uniform buffer.
  86917. * @param name Name of the uniform, as used in the uniform block in the shader.
  86918. */
  86919. addMatrix2x2(name: string): void;
  86920. /**
  86921. * Effectively creates the WebGL Uniform Buffer, once layout is completed with `addUniform`.
  86922. */
  86923. create(): void;
  86924. /** @hidden */
  86925. _rebuild(): void;
  86926. /**
  86927. * Updates the WebGL Uniform Buffer on the GPU.
  86928. * If the `dynamic` flag is set to true, no cache comparison is done.
  86929. * Otherwise, the buffer will be updated only if the cache differs.
  86930. */
  86931. update(): void;
  86932. /**
  86933. * Updates the value of an uniform. The `update` method must be called afterwards to make it effective in the GPU.
  86934. * @param uniformName Define the name of the uniform, as used in the uniform block in the shader.
  86935. * @param data Define the flattened data
  86936. * @param size Define the size of the data.
  86937. */
  86938. updateUniform(uniformName: string, data: FloatArray, size: number): void;
  86939. private _valueCache;
  86940. private _cacheMatrix;
  86941. private _updateMatrix3x3ForUniform;
  86942. private _updateMatrix3x3ForEffect;
  86943. private _updateMatrix2x2ForEffect;
  86944. private _updateMatrix2x2ForUniform;
  86945. private _updateFloatForEffect;
  86946. private _updateFloatForUniform;
  86947. private _updateFloat2ForEffect;
  86948. private _updateFloat2ForUniform;
  86949. private _updateFloat3ForEffect;
  86950. private _updateFloat3ForUniform;
  86951. private _updateFloat4ForEffect;
  86952. private _updateFloat4ForUniform;
  86953. private _updateMatrixForEffect;
  86954. private _updateMatrixForUniform;
  86955. private _updateVector3ForEffect;
  86956. private _updateVector3ForUniform;
  86957. private _updateVector4ForEffect;
  86958. private _updateVector4ForUniform;
  86959. private _updateColor3ForEffect;
  86960. private _updateColor3ForUniform;
  86961. private _updateColor4ForEffect;
  86962. private _updateColor4ForUniform;
  86963. /**
  86964. * Sets a sampler uniform on the effect.
  86965. * @param name Define the name of the sampler.
  86966. * @param texture Define the texture to set in the sampler
  86967. */
  86968. setTexture(name: string, texture: Nullable<BaseTexture>): void;
  86969. /**
  86970. * Directly updates the value of the uniform in the cache AND on the GPU.
  86971. * @param uniformName Define the name of the uniform, as used in the uniform block in the shader.
  86972. * @param data Define the flattened data
  86973. */
  86974. updateUniformDirectly(uniformName: string, data: FloatArray): void;
  86975. /**
  86976. * Binds this uniform buffer to an effect.
  86977. * @param effect Define the effect to bind the buffer to
  86978. * @param name Name of the uniform block in the shader.
  86979. */
  86980. bindToEffect(effect: Effect, name: string): void;
  86981. /**
  86982. * Disposes the uniform buffer.
  86983. */
  86984. dispose(): void;
  86985. }
  86986. }
  86987. declare module BABYLON {
  86988. /**
  86989. * Enum that determines the text-wrapping mode to use.
  86990. */
  86991. export enum InspectableType {
  86992. /**
  86993. * Checkbox for booleans
  86994. */
  86995. Checkbox = 0,
  86996. /**
  86997. * Sliders for numbers
  86998. */
  86999. Slider = 1,
  87000. /**
  87001. * Vector3
  87002. */
  87003. Vector3 = 2,
  87004. /**
  87005. * Quaternions
  87006. */
  87007. Quaternion = 3,
  87008. /**
  87009. * Color3
  87010. */
  87011. Color3 = 4,
  87012. /**
  87013. * String
  87014. */
  87015. String = 5
  87016. }
  87017. /**
  87018. * Interface used to define custom inspectable properties.
  87019. * This interface is used by the inspector to display custom property grids
  87020. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  87021. */
  87022. export interface IInspectable {
  87023. /**
  87024. * Gets the label to display
  87025. */
  87026. label: string;
  87027. /**
  87028. * Gets the name of the property to edit
  87029. */
  87030. propertyName: string;
  87031. /**
  87032. * Gets the type of the editor to use
  87033. */
  87034. type: InspectableType;
  87035. /**
  87036. * Gets the minimum value of the property when using in "slider" mode
  87037. */
  87038. min?: number;
  87039. /**
  87040. * Gets the maximum value of the property when using in "slider" mode
  87041. */
  87042. max?: number;
  87043. /**
  87044. * Gets the setp to use when using in "slider" mode
  87045. */
  87046. step?: number;
  87047. }
  87048. }
  87049. declare module BABYLON {
  87050. /**
  87051. * Class used to provide helper for timing
  87052. */
  87053. export class TimingTools {
  87054. /**
  87055. * Polyfill for setImmediate
  87056. * @param action defines the action to execute after the current execution block
  87057. */
  87058. static SetImmediate(action: () => void): void;
  87059. }
  87060. }
  87061. declare module BABYLON {
  87062. /**
  87063. * Class used to enable instatition of objects by class name
  87064. */
  87065. export class InstantiationTools {
  87066. /**
  87067. * Use this object to register external classes like custom textures or material
  87068. * to allow the laoders to instantiate them
  87069. */
  87070. static RegisteredExternalClasses: {
  87071. [key: string]: Object;
  87072. };
  87073. /**
  87074. * Tries to instantiate a new object from a given class name
  87075. * @param className defines the class name to instantiate
  87076. * @returns the new object or null if the system was not able to do the instantiation
  87077. */
  87078. static Instantiate(className: string): any;
  87079. }
  87080. }
  87081. declare module BABYLON {
  87082. /**
  87083. * Define options used to create a depth texture
  87084. */
  87085. export class DepthTextureCreationOptions {
  87086. /** Specifies whether or not a stencil should be allocated in the texture */
  87087. generateStencil?: boolean;
  87088. /** Specifies whether or not bilinear filtering is enable on the texture */
  87089. bilinearFiltering?: boolean;
  87090. /** Specifies the comparison function to set on the texture. If 0 or undefined, the texture is not in comparison mode */
  87091. comparisonFunction?: number;
  87092. /** Specifies if the created texture is a cube texture */
  87093. isCube?: boolean;
  87094. }
  87095. }
  87096. declare module BABYLON {
  87097. interface ThinEngine {
  87098. /**
  87099. * Creates a depth stencil cube texture.
  87100. * This is only available in WebGL 2.
  87101. * @param size The size of face edge in the cube texture.
  87102. * @param options The options defining the cube texture.
  87103. * @returns The cube texture
  87104. */
  87105. _createDepthStencilCubeTexture(size: number, options: DepthTextureCreationOptions): InternalTexture;
  87106. /**
  87107. * Creates a cube texture
  87108. * @param rootUrl defines the url where the files to load is located
  87109. * @param scene defines the current scene
  87110. * @param files defines the list of files to load (1 per face)
  87111. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  87112. * @param onLoad defines an optional callback raised when the texture is loaded
  87113. * @param onError defines an optional callback raised if there is an issue to load the texture
  87114. * @param format defines the format of the data
  87115. * @param forcedExtension defines the extension to use to pick the right loader
  87116. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  87117. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  87118. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  87119. * @param fallback defines texture to use while falling back when (compressed) texture file not found.
  87120. * @returns the cube texture as an InternalTexture
  87121. */
  87122. 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;
  87123. /**
  87124. * Creates a cube texture
  87125. * @param rootUrl defines the url where the files to load is located
  87126. * @param scene defines the current scene
  87127. * @param files defines the list of files to load (1 per face)
  87128. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  87129. * @param onLoad defines an optional callback raised when the texture is loaded
  87130. * @param onError defines an optional callback raised if there is an issue to load the texture
  87131. * @param format defines the format of the data
  87132. * @param forcedExtension defines the extension to use to pick the right loader
  87133. * @returns the cube texture as an InternalTexture
  87134. */
  87135. 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;
  87136. /**
  87137. * Creates a cube texture
  87138. * @param rootUrl defines the url where the files to load is located
  87139. * @param scene defines the current scene
  87140. * @param files defines the list of files to load (1 per face)
  87141. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  87142. * @param onLoad defines an optional callback raised when the texture is loaded
  87143. * @param onError defines an optional callback raised if there is an issue to load the texture
  87144. * @param format defines the format of the data
  87145. * @param forcedExtension defines the extension to use to pick the right loader
  87146. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  87147. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  87148. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  87149. * @returns the cube texture as an InternalTexture
  87150. */
  87151. 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;
  87152. /** @hidden */
  87153. _partialLoadFile(url: string, index: number, loadedFiles: ArrayBuffer[], onfinish: (files: ArrayBuffer[]) => void, onErrorCallBack: Nullable<(message?: string, exception?: any) => void>): void;
  87154. /** @hidden */
  87155. _cascadeLoadFiles(scene: Nullable<Scene>, onfinish: (images: ArrayBuffer[]) => void, files: string[], onError: Nullable<(message?: string, exception?: any) => void>): void;
  87156. /** @hidden */
  87157. _cascadeLoadImgs(scene: Nullable<Scene>, onfinish: (images: HTMLImageElement[]) => void, files: string[], onError: Nullable<(message?: string, exception?: any) => void>, mimeType?: string): void;
  87158. /** @hidden */
  87159. _partialLoadImg(url: string, index: number, loadedImages: HTMLImageElement[], scene: Nullable<Scene>, onfinish: (images: HTMLImageElement[]) => void, onErrorCallBack: Nullable<(message?: string, exception?: any) => void>, mimeType?: string): void;
  87160. /**
  87161. * @hidden
  87162. */
  87163. _setCubeMapTextureParams(loadMipmap: boolean): void;
  87164. }
  87165. }
  87166. declare module BABYLON {
  87167. /**
  87168. * Class for creating a cube texture
  87169. */
  87170. export class CubeTexture extends BaseTexture {
  87171. private _delayedOnLoad;
  87172. /**
  87173. * Observable triggered once the texture has been loaded.
  87174. */
  87175. onLoadObservable: Observable<CubeTexture>;
  87176. /**
  87177. * The url of the texture
  87178. */
  87179. url: string;
  87180. /**
  87181. * Gets or sets the center of the bounding box associated with the cube texture.
  87182. * It must define where the camera used to render the texture was set
  87183. * @see https://doc.babylonjs.com/how_to/reflect#using-local-cubemap-mode
  87184. */
  87185. boundingBoxPosition: Vector3;
  87186. private _boundingBoxSize;
  87187. /**
  87188. * Gets or sets the size of the bounding box associated with the cube texture
  87189. * When defined, the cubemap will switch to local mode
  87190. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  87191. * @example https://www.babylonjs-playground.com/#RNASML
  87192. */
  87193. set boundingBoxSize(value: Vector3);
  87194. /**
  87195. * Returns the bounding box size
  87196. * @see https://doc.babylonjs.com/how_to/reflect#using-local-cubemap-mode
  87197. */
  87198. get boundingBoxSize(): Vector3;
  87199. protected _rotationY: number;
  87200. /**
  87201. * Sets texture matrix rotation angle around Y axis in radians.
  87202. */
  87203. set rotationY(value: number);
  87204. /**
  87205. * Gets texture matrix rotation angle around Y axis radians.
  87206. */
  87207. get rotationY(): number;
  87208. /**
  87209. * Are mip maps generated for this texture or not.
  87210. */
  87211. get noMipmap(): boolean;
  87212. private _noMipmap;
  87213. private _files;
  87214. protected _forcedExtension: Nullable<string>;
  87215. private _extensions;
  87216. private _textureMatrix;
  87217. private _format;
  87218. private _createPolynomials;
  87219. /**
  87220. * Creates a cube texture from an array of image urls
  87221. * @param files defines an array of image urls
  87222. * @param scene defines the hosting scene
  87223. * @param noMipmap specifies if mip maps are not used
  87224. * @returns a cube texture
  87225. */
  87226. static CreateFromImages(files: string[], scene: Scene, noMipmap?: boolean): CubeTexture;
  87227. /**
  87228. * Creates and return a texture created from prefilterd data by tools like IBL Baker or Lys.
  87229. * @param url defines the url of the prefiltered texture
  87230. * @param scene defines the scene the texture is attached to
  87231. * @param forcedExtension defines the extension of the file if different from the url
  87232. * @param createPolynomials defines whether or not to create polynomial harmonics from the texture data if necessary
  87233. * @return the prefiltered texture
  87234. */
  87235. static CreateFromPrefilteredData(url: string, scene: Scene, forcedExtension?: any, createPolynomials?: boolean): CubeTexture;
  87236. /**
  87237. * Creates a cube texture to use with reflection for instance. It can be based upon dds or six images as well
  87238. * as prefiltered data.
  87239. * @param rootUrl defines the url of the texture or the root name of the six images
  87240. * @param null defines the scene or engine the texture is attached to
  87241. * @param extensions defines the suffixes add to the picture name in case six images are in use like _px.jpg...
  87242. * @param noMipmap defines if mipmaps should be created or not
  87243. * @param files defines the six files to load for the different faces in that order: px, py, pz, nx, ny, nz
  87244. * @param onLoad defines a callback triggered at the end of the file load if no errors occured
  87245. * @param onError defines a callback triggered in case of error during load
  87246. * @param format defines the internal format to use for the texture once loaded
  87247. * @param prefiltered defines whether or not the texture is created from prefiltered data
  87248. * @param forcedExtension defines the extensions to use (force a special type of file to load) in case it is different from the file name
  87249. * @param createPolynomials defines whether or not to create polynomial harmonics from the texture data if necessary
  87250. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  87251. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  87252. * @return the cube texture
  87253. */
  87254. 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);
  87255. /**
  87256. * Get the current class name of the texture useful for serialization or dynamic coding.
  87257. * @returns "CubeTexture"
  87258. */
  87259. getClassName(): string;
  87260. /**
  87261. * Update the url (and optional buffer) of this texture if url was null during construction.
  87262. * @param url the url of the texture
  87263. * @param forcedExtension defines the extension to use
  87264. * @param onLoad callback called when the texture is loaded (defaults to null)
  87265. * @param prefiltered Defines whether the updated texture is prefiltered or not
  87266. */
  87267. updateURL(url: string, forcedExtension?: string, onLoad?: () => void, prefiltered?: boolean): void;
  87268. /**
  87269. * Delays loading of the cube texture
  87270. * @param forcedExtension defines the extension to use
  87271. */
  87272. delayLoad(forcedExtension?: string): void;
  87273. /**
  87274. * Returns the reflection texture matrix
  87275. * @returns the reflection texture matrix
  87276. */
  87277. getReflectionTextureMatrix(): Matrix;
  87278. /**
  87279. * Sets the reflection texture matrix
  87280. * @param value Reflection texture matrix
  87281. */
  87282. setReflectionTextureMatrix(value: Matrix): void;
  87283. /**
  87284. * Parses text to create a cube texture
  87285. * @param parsedTexture define the serialized text to read from
  87286. * @param scene defines the hosting scene
  87287. * @param rootUrl defines the root url of the cube texture
  87288. * @returns a cube texture
  87289. */
  87290. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): CubeTexture;
  87291. /**
  87292. * Makes a clone, or deep copy, of the cube texture
  87293. * @returns a new cube texture
  87294. */
  87295. clone(): CubeTexture;
  87296. }
  87297. }
  87298. declare module BABYLON {
  87299. /**
  87300. * Manages the defines for the Material
  87301. */
  87302. export class MaterialDefines {
  87303. /** @hidden */
  87304. protected _keys: string[];
  87305. private _isDirty;
  87306. /** @hidden */
  87307. _renderId: number;
  87308. /** @hidden */
  87309. _areLightsDirty: boolean;
  87310. /** @hidden */
  87311. _areLightsDisposed: boolean;
  87312. /** @hidden */
  87313. _areAttributesDirty: boolean;
  87314. /** @hidden */
  87315. _areTexturesDirty: boolean;
  87316. /** @hidden */
  87317. _areFresnelDirty: boolean;
  87318. /** @hidden */
  87319. _areMiscDirty: boolean;
  87320. /** @hidden */
  87321. _areImageProcessingDirty: boolean;
  87322. /** @hidden */
  87323. _normals: boolean;
  87324. /** @hidden */
  87325. _uvs: boolean;
  87326. /** @hidden */
  87327. _needNormals: boolean;
  87328. /** @hidden */
  87329. _needUVs: boolean;
  87330. [id: string]: any;
  87331. /**
  87332. * Specifies if the material needs to be re-calculated
  87333. */
  87334. get isDirty(): boolean;
  87335. /**
  87336. * Marks the material to indicate that it has been re-calculated
  87337. */
  87338. markAsProcessed(): void;
  87339. /**
  87340. * Marks the material to indicate that it needs to be re-calculated
  87341. */
  87342. markAsUnprocessed(): void;
  87343. /**
  87344. * Marks the material to indicate all of its defines need to be re-calculated
  87345. */
  87346. markAllAsDirty(): void;
  87347. /**
  87348. * Marks the material to indicate that image processing needs to be re-calculated
  87349. */
  87350. markAsImageProcessingDirty(): void;
  87351. /**
  87352. * Marks the material to indicate the lights need to be re-calculated
  87353. * @param disposed Defines whether the light is dirty due to dispose or not
  87354. */
  87355. markAsLightDirty(disposed?: boolean): void;
  87356. /**
  87357. * Marks the attribute state as changed
  87358. */
  87359. markAsAttributesDirty(): void;
  87360. /**
  87361. * Marks the texture state as changed
  87362. */
  87363. markAsTexturesDirty(): void;
  87364. /**
  87365. * Marks the fresnel state as changed
  87366. */
  87367. markAsFresnelDirty(): void;
  87368. /**
  87369. * Marks the misc state as changed
  87370. */
  87371. markAsMiscDirty(): void;
  87372. /**
  87373. * Rebuilds the material defines
  87374. */
  87375. rebuild(): void;
  87376. /**
  87377. * Specifies if two material defines are equal
  87378. * @param other - A material define instance to compare to
  87379. * @returns - Boolean indicating if the material defines are equal (true) or not (false)
  87380. */
  87381. isEqual(other: MaterialDefines): boolean;
  87382. /**
  87383. * Clones this instance's defines to another instance
  87384. * @param other - material defines to clone values to
  87385. */
  87386. cloneTo(other: MaterialDefines): void;
  87387. /**
  87388. * Resets the material define values
  87389. */
  87390. reset(): void;
  87391. /**
  87392. * Converts the material define values to a string
  87393. * @returns - String of material define information
  87394. */
  87395. toString(): string;
  87396. }
  87397. }
  87398. declare module BABYLON {
  87399. /**
  87400. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  87401. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  87402. * 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;
  87403. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  87404. */
  87405. export class ColorCurves {
  87406. private _dirty;
  87407. private _tempColor;
  87408. private _globalCurve;
  87409. private _highlightsCurve;
  87410. private _midtonesCurve;
  87411. private _shadowsCurve;
  87412. private _positiveCurve;
  87413. private _negativeCurve;
  87414. private _globalHue;
  87415. private _globalDensity;
  87416. private _globalSaturation;
  87417. private _globalExposure;
  87418. /**
  87419. * Gets the global Hue value.
  87420. * 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).
  87421. */
  87422. get globalHue(): number;
  87423. /**
  87424. * Sets the global Hue value.
  87425. * 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).
  87426. */
  87427. set globalHue(value: number);
  87428. /**
  87429. * Gets the global Density value.
  87430. * 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.
  87431. * Values less than zero provide a filter of opposite hue.
  87432. */
  87433. get globalDensity(): number;
  87434. /**
  87435. * Sets the global Density value.
  87436. * 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.
  87437. * Values less than zero provide a filter of opposite hue.
  87438. */
  87439. set globalDensity(value: number);
  87440. /**
  87441. * Gets the global Saturation value.
  87442. * 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.
  87443. */
  87444. get globalSaturation(): number;
  87445. /**
  87446. * Sets the global Saturation value.
  87447. * 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.
  87448. */
  87449. set globalSaturation(value: number);
  87450. /**
  87451. * Gets the global Exposure value.
  87452. * 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.
  87453. */
  87454. get globalExposure(): number;
  87455. /**
  87456. * Sets the global Exposure value.
  87457. * 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.
  87458. */
  87459. set globalExposure(value: number);
  87460. private _highlightsHue;
  87461. private _highlightsDensity;
  87462. private _highlightsSaturation;
  87463. private _highlightsExposure;
  87464. /**
  87465. * Gets the highlights Hue value.
  87466. * 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).
  87467. */
  87468. get highlightsHue(): number;
  87469. /**
  87470. * Sets the highlights Hue value.
  87471. * 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).
  87472. */
  87473. set highlightsHue(value: number);
  87474. /**
  87475. * Gets the highlights Density value.
  87476. * 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.
  87477. * Values less than zero provide a filter of opposite hue.
  87478. */
  87479. get highlightsDensity(): number;
  87480. /**
  87481. * Sets the highlights Density value.
  87482. * 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.
  87483. * Values less than zero provide a filter of opposite hue.
  87484. */
  87485. set highlightsDensity(value: number);
  87486. /**
  87487. * Gets the highlights Saturation value.
  87488. * 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.
  87489. */
  87490. get highlightsSaturation(): number;
  87491. /**
  87492. * Sets the highlights Saturation value.
  87493. * 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.
  87494. */
  87495. set highlightsSaturation(value: number);
  87496. /**
  87497. * Gets the highlights Exposure value.
  87498. * 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.
  87499. */
  87500. get highlightsExposure(): number;
  87501. /**
  87502. * Sets the highlights Exposure value.
  87503. * 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.
  87504. */
  87505. set highlightsExposure(value: number);
  87506. private _midtonesHue;
  87507. private _midtonesDensity;
  87508. private _midtonesSaturation;
  87509. private _midtonesExposure;
  87510. /**
  87511. * Gets the midtones Hue value.
  87512. * 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).
  87513. */
  87514. get midtonesHue(): number;
  87515. /**
  87516. * Sets the midtones Hue value.
  87517. * 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).
  87518. */
  87519. set midtonesHue(value: number);
  87520. /**
  87521. * Gets the midtones Density value.
  87522. * 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.
  87523. * Values less than zero provide a filter of opposite hue.
  87524. */
  87525. get midtonesDensity(): number;
  87526. /**
  87527. * Sets the midtones Density value.
  87528. * 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.
  87529. * Values less than zero provide a filter of opposite hue.
  87530. */
  87531. set midtonesDensity(value: number);
  87532. /**
  87533. * Gets the midtones Saturation value.
  87534. * 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.
  87535. */
  87536. get midtonesSaturation(): number;
  87537. /**
  87538. * Sets the midtones Saturation value.
  87539. * 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.
  87540. */
  87541. set midtonesSaturation(value: number);
  87542. /**
  87543. * Gets the midtones Exposure value.
  87544. * 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.
  87545. */
  87546. get midtonesExposure(): number;
  87547. /**
  87548. * Sets the midtones Exposure value.
  87549. * 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.
  87550. */
  87551. set midtonesExposure(value: number);
  87552. private _shadowsHue;
  87553. private _shadowsDensity;
  87554. private _shadowsSaturation;
  87555. private _shadowsExposure;
  87556. /**
  87557. * Gets the shadows Hue value.
  87558. * 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).
  87559. */
  87560. get shadowsHue(): number;
  87561. /**
  87562. * Sets the shadows Hue value.
  87563. * 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).
  87564. */
  87565. set shadowsHue(value: number);
  87566. /**
  87567. * Gets the shadows Density value.
  87568. * 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.
  87569. * Values less than zero provide a filter of opposite hue.
  87570. */
  87571. get shadowsDensity(): number;
  87572. /**
  87573. * Sets the shadows Density value.
  87574. * 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.
  87575. * Values less than zero provide a filter of opposite hue.
  87576. */
  87577. set shadowsDensity(value: number);
  87578. /**
  87579. * Gets the shadows Saturation value.
  87580. * 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.
  87581. */
  87582. get shadowsSaturation(): number;
  87583. /**
  87584. * Sets the shadows Saturation value.
  87585. * 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.
  87586. */
  87587. set shadowsSaturation(value: number);
  87588. /**
  87589. * Gets the shadows Exposure value.
  87590. * 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.
  87591. */
  87592. get shadowsExposure(): number;
  87593. /**
  87594. * Sets the shadows Exposure value.
  87595. * 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.
  87596. */
  87597. set shadowsExposure(value: number);
  87598. /**
  87599. * Returns the class name
  87600. * @returns The class name
  87601. */
  87602. getClassName(): string;
  87603. /**
  87604. * Binds the color curves to the shader.
  87605. * @param colorCurves The color curve to bind
  87606. * @param effect The effect to bind to
  87607. * @param positiveUniform The positive uniform shader parameter
  87608. * @param neutralUniform The neutral uniform shader parameter
  87609. * @param negativeUniform The negative uniform shader parameter
  87610. */
  87611. static Bind(colorCurves: ColorCurves, effect: Effect, positiveUniform?: string, neutralUniform?: string, negativeUniform?: string): void;
  87612. /**
  87613. * Prepare the list of uniforms associated with the ColorCurves effects.
  87614. * @param uniformsList The list of uniforms used in the effect
  87615. */
  87616. static PrepareUniforms(uniformsList: string[]): void;
  87617. /**
  87618. * Returns color grading data based on a hue, density, saturation and exposure value.
  87619. * @param filterHue The hue of the color filter.
  87620. * @param filterDensity The density of the color filter.
  87621. * @param saturation The saturation.
  87622. * @param exposure The exposure.
  87623. * @param result The result data container.
  87624. */
  87625. private getColorGradingDataToRef;
  87626. /**
  87627. * Takes an input slider value and returns an adjusted value that provides extra control near the centre.
  87628. * @param value The input slider value in range [-100,100].
  87629. * @returns Adjusted value.
  87630. */
  87631. private static applyColorGradingSliderNonlinear;
  87632. /**
  87633. * Returns an RGBA Color4 based on Hue, Saturation and Brightness (also referred to as value, HSV).
  87634. * @param hue The hue (H) input.
  87635. * @param saturation The saturation (S) input.
  87636. * @param brightness The brightness (B) input.
  87637. * @result An RGBA color represented as Vector4.
  87638. */
  87639. private static fromHSBToRef;
  87640. /**
  87641. * Returns a value clamped between min and max
  87642. * @param value The value to clamp
  87643. * @param min The minimum of value
  87644. * @param max The maximum of value
  87645. * @returns The clamped value.
  87646. */
  87647. private static clamp;
  87648. /**
  87649. * Clones the current color curve instance.
  87650. * @return The cloned curves
  87651. */
  87652. clone(): ColorCurves;
  87653. /**
  87654. * Serializes the current color curve instance to a json representation.
  87655. * @return a JSON representation
  87656. */
  87657. serialize(): any;
  87658. /**
  87659. * Parses the color curve from a json representation.
  87660. * @param source the JSON source to parse
  87661. * @return The parsed curves
  87662. */
  87663. static Parse(source: any): ColorCurves;
  87664. }
  87665. }
  87666. declare module BABYLON {
  87667. /**
  87668. * Interface to follow in your material defines to integrate easily the
  87669. * Image proccessing functions.
  87670. * @hidden
  87671. */
  87672. export interface IImageProcessingConfigurationDefines {
  87673. IMAGEPROCESSING: boolean;
  87674. VIGNETTE: boolean;
  87675. VIGNETTEBLENDMODEMULTIPLY: boolean;
  87676. VIGNETTEBLENDMODEOPAQUE: boolean;
  87677. TONEMAPPING: boolean;
  87678. TONEMAPPING_ACES: boolean;
  87679. CONTRAST: boolean;
  87680. EXPOSURE: boolean;
  87681. COLORCURVES: boolean;
  87682. COLORGRADING: boolean;
  87683. COLORGRADING3D: boolean;
  87684. SAMPLER3DGREENDEPTH: boolean;
  87685. SAMPLER3DBGRMAP: boolean;
  87686. IMAGEPROCESSINGPOSTPROCESS: boolean;
  87687. }
  87688. /**
  87689. * @hidden
  87690. */
  87691. export class ImageProcessingConfigurationDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  87692. IMAGEPROCESSING: boolean;
  87693. VIGNETTE: boolean;
  87694. VIGNETTEBLENDMODEMULTIPLY: boolean;
  87695. VIGNETTEBLENDMODEOPAQUE: boolean;
  87696. TONEMAPPING: boolean;
  87697. TONEMAPPING_ACES: boolean;
  87698. CONTRAST: boolean;
  87699. COLORCURVES: boolean;
  87700. COLORGRADING: boolean;
  87701. COLORGRADING3D: boolean;
  87702. SAMPLER3DGREENDEPTH: boolean;
  87703. SAMPLER3DBGRMAP: boolean;
  87704. IMAGEPROCESSINGPOSTPROCESS: boolean;
  87705. EXPOSURE: boolean;
  87706. constructor();
  87707. }
  87708. /**
  87709. * This groups together the common properties used for image processing either in direct forward pass
  87710. * or through post processing effect depending on the use of the image processing pipeline in your scene
  87711. * or not.
  87712. */
  87713. export class ImageProcessingConfiguration {
  87714. /**
  87715. * Default tone mapping applied in BabylonJS.
  87716. */
  87717. static readonly TONEMAPPING_STANDARD: number;
  87718. /**
  87719. * ACES Tone mapping (used by default in unreal and unity). This can help getting closer
  87720. * to other engines rendering to increase portability.
  87721. */
  87722. static readonly TONEMAPPING_ACES: number;
  87723. /**
  87724. * Color curves setup used in the effect if colorCurvesEnabled is set to true
  87725. */
  87726. colorCurves: Nullable<ColorCurves>;
  87727. private _colorCurvesEnabled;
  87728. /**
  87729. * Gets wether the color curves effect is enabled.
  87730. */
  87731. get colorCurvesEnabled(): boolean;
  87732. /**
  87733. * Sets wether the color curves effect is enabled.
  87734. */
  87735. set colorCurvesEnabled(value: boolean);
  87736. private _colorGradingTexture;
  87737. /**
  87738. * Color grading LUT texture used in the effect if colorGradingEnabled is set to true
  87739. */
  87740. get colorGradingTexture(): Nullable<BaseTexture>;
  87741. /**
  87742. * Color grading LUT texture used in the effect if colorGradingEnabled is set to true
  87743. */
  87744. set colorGradingTexture(value: Nullable<BaseTexture>);
  87745. private _colorGradingEnabled;
  87746. /**
  87747. * Gets wether the color grading effect is enabled.
  87748. */
  87749. get colorGradingEnabled(): boolean;
  87750. /**
  87751. * Sets wether the color grading effect is enabled.
  87752. */
  87753. set colorGradingEnabled(value: boolean);
  87754. private _colorGradingWithGreenDepth;
  87755. /**
  87756. * Gets wether the color grading effect is using a green depth for the 3d Texture.
  87757. */
  87758. get colorGradingWithGreenDepth(): boolean;
  87759. /**
  87760. * Sets wether the color grading effect is using a green depth for the 3d Texture.
  87761. */
  87762. set colorGradingWithGreenDepth(value: boolean);
  87763. private _colorGradingBGR;
  87764. /**
  87765. * Gets wether the color grading texture contains BGR values.
  87766. */
  87767. get colorGradingBGR(): boolean;
  87768. /**
  87769. * Sets wether the color grading texture contains BGR values.
  87770. */
  87771. set colorGradingBGR(value: boolean);
  87772. /** @hidden */
  87773. _exposure: number;
  87774. /**
  87775. * Gets the Exposure used in the effect.
  87776. */
  87777. get exposure(): number;
  87778. /**
  87779. * Sets the Exposure used in the effect.
  87780. */
  87781. set exposure(value: number);
  87782. private _toneMappingEnabled;
  87783. /**
  87784. * Gets wether the tone mapping effect is enabled.
  87785. */
  87786. get toneMappingEnabled(): boolean;
  87787. /**
  87788. * Sets wether the tone mapping effect is enabled.
  87789. */
  87790. set toneMappingEnabled(value: boolean);
  87791. private _toneMappingType;
  87792. /**
  87793. * Gets the type of tone mapping effect.
  87794. */
  87795. get toneMappingType(): number;
  87796. /**
  87797. * Sets the type of tone mapping effect used in BabylonJS.
  87798. */
  87799. set toneMappingType(value: number);
  87800. protected _contrast: number;
  87801. /**
  87802. * Gets the contrast used in the effect.
  87803. */
  87804. get contrast(): number;
  87805. /**
  87806. * Sets the contrast used in the effect.
  87807. */
  87808. set contrast(value: number);
  87809. /**
  87810. * Vignette stretch size.
  87811. */
  87812. vignetteStretch: number;
  87813. /**
  87814. * Vignette centre X Offset.
  87815. */
  87816. vignetteCentreX: number;
  87817. /**
  87818. * Vignette centre Y Offset.
  87819. */
  87820. vignetteCentreY: number;
  87821. /**
  87822. * Vignette weight or intensity of the vignette effect.
  87823. */
  87824. vignetteWeight: number;
  87825. /**
  87826. * Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  87827. * if vignetteEnabled is set to true.
  87828. */
  87829. vignetteColor: Color4;
  87830. /**
  87831. * Camera field of view used by the Vignette effect.
  87832. */
  87833. vignetteCameraFov: number;
  87834. private _vignetteBlendMode;
  87835. /**
  87836. * Gets the vignette blend mode allowing different kind of effect.
  87837. */
  87838. get vignetteBlendMode(): number;
  87839. /**
  87840. * Sets the vignette blend mode allowing different kind of effect.
  87841. */
  87842. set vignetteBlendMode(value: number);
  87843. private _vignetteEnabled;
  87844. /**
  87845. * Gets wether the vignette effect is enabled.
  87846. */
  87847. get vignetteEnabled(): boolean;
  87848. /**
  87849. * Sets wether the vignette effect is enabled.
  87850. */
  87851. set vignetteEnabled(value: boolean);
  87852. private _applyByPostProcess;
  87853. /**
  87854. * Gets wether the image processing is applied through a post process or not.
  87855. */
  87856. get applyByPostProcess(): boolean;
  87857. /**
  87858. * Sets wether the image processing is applied through a post process or not.
  87859. */
  87860. set applyByPostProcess(value: boolean);
  87861. private _isEnabled;
  87862. /**
  87863. * Gets wether the image processing is enabled or not.
  87864. */
  87865. get isEnabled(): boolean;
  87866. /**
  87867. * Sets wether the image processing is enabled or not.
  87868. */
  87869. set isEnabled(value: boolean);
  87870. /**
  87871. * An event triggered when the configuration changes and requires Shader to Update some parameters.
  87872. */
  87873. onUpdateParameters: Observable<ImageProcessingConfiguration>;
  87874. /**
  87875. * Method called each time the image processing information changes requires to recompile the effect.
  87876. */
  87877. protected _updateParameters(): void;
  87878. /**
  87879. * Gets the current class name.
  87880. * @return "ImageProcessingConfiguration"
  87881. */
  87882. getClassName(): string;
  87883. /**
  87884. * Prepare the list of uniforms associated with the Image Processing effects.
  87885. * @param uniforms The list of uniforms used in the effect
  87886. * @param defines the list of defines currently in use
  87887. */
  87888. static PrepareUniforms(uniforms: string[], defines: IImageProcessingConfigurationDefines): void;
  87889. /**
  87890. * Prepare the list of samplers associated with the Image Processing effects.
  87891. * @param samplersList The list of uniforms used in the effect
  87892. * @param defines the list of defines currently in use
  87893. */
  87894. static PrepareSamplers(samplersList: string[], defines: IImageProcessingConfigurationDefines): void;
  87895. /**
  87896. * Prepare the list of defines associated to the shader.
  87897. * @param defines the list of defines to complete
  87898. * @param forPostProcess Define if we are currently in post process mode or not
  87899. */
  87900. prepareDefines(defines: IImageProcessingConfigurationDefines, forPostProcess?: boolean): void;
  87901. /**
  87902. * Returns true if all the image processing information are ready.
  87903. * @returns True if ready, otherwise, false
  87904. */
  87905. isReady(): boolean;
  87906. /**
  87907. * Binds the image processing to the shader.
  87908. * @param effect The effect to bind to
  87909. * @param overrideAspectRatio Override the aspect ratio of the effect
  87910. */
  87911. bind(effect: Effect, overrideAspectRatio?: number): void;
  87912. /**
  87913. * Clones the current image processing instance.
  87914. * @return The cloned image processing
  87915. */
  87916. clone(): ImageProcessingConfiguration;
  87917. /**
  87918. * Serializes the current image processing instance to a json representation.
  87919. * @return a JSON representation
  87920. */
  87921. serialize(): any;
  87922. /**
  87923. * Parses the image processing from a json representation.
  87924. * @param source the JSON source to parse
  87925. * @return The parsed image processing
  87926. */
  87927. static Parse(source: any): ImageProcessingConfiguration;
  87928. private static _VIGNETTEMODE_MULTIPLY;
  87929. private static _VIGNETTEMODE_OPAQUE;
  87930. /**
  87931. * Used to apply the vignette as a mix with the pixel color.
  87932. */
  87933. static get VIGNETTEMODE_MULTIPLY(): number;
  87934. /**
  87935. * Used to apply the vignette as a replacement of the pixel color.
  87936. */
  87937. static get VIGNETTEMODE_OPAQUE(): number;
  87938. }
  87939. }
  87940. declare module BABYLON {
  87941. /** @hidden */
  87942. export var postprocessVertexShader: {
  87943. name: string;
  87944. shader: string;
  87945. };
  87946. }
  87947. declare module BABYLON {
  87948. interface ThinEngine {
  87949. /**
  87950. * Creates a new render target texture
  87951. * @param size defines the size of the texture
  87952. * @param options defines the options used to create the texture
  87953. * @returns a new render target texture stored in an InternalTexture
  87954. */
  87955. createRenderTargetTexture(size: number | {
  87956. width: number;
  87957. height: number;
  87958. layers?: number;
  87959. }, options: boolean | RenderTargetCreationOptions): InternalTexture;
  87960. /**
  87961. * Creates a depth stencil texture.
  87962. * This is only available in WebGL 2 or with the depth texture extension available.
  87963. * @param size The size of face edge in the texture.
  87964. * @param options The options defining the texture.
  87965. * @returns The texture
  87966. */
  87967. createDepthStencilTexture(size: number | {
  87968. width: number;
  87969. height: number;
  87970. layers?: number;
  87971. }, options: DepthTextureCreationOptions): InternalTexture;
  87972. /** @hidden */
  87973. _createDepthStencilTexture(size: number | {
  87974. width: number;
  87975. height: number;
  87976. layers?: number;
  87977. }, options: DepthTextureCreationOptions): InternalTexture;
  87978. }
  87979. }
  87980. declare module BABYLON {
  87981. /**
  87982. * Defines the kind of connection point for node based material
  87983. */
  87984. export enum NodeMaterialBlockConnectionPointTypes {
  87985. /** Float */
  87986. Float = 1,
  87987. /** Int */
  87988. Int = 2,
  87989. /** Vector2 */
  87990. Vector2 = 4,
  87991. /** Vector3 */
  87992. Vector3 = 8,
  87993. /** Vector4 */
  87994. Vector4 = 16,
  87995. /** Color3 */
  87996. Color3 = 32,
  87997. /** Color4 */
  87998. Color4 = 64,
  87999. /** Matrix */
  88000. Matrix = 128,
  88001. /** Custom object */
  88002. Object = 256,
  88003. /** Detect type based on connection */
  88004. AutoDetect = 1024,
  88005. /** Output type that will be defined by input type */
  88006. BasedOnInput = 2048
  88007. }
  88008. }
  88009. declare module BABYLON {
  88010. /**
  88011. * Enum used to define the target of a block
  88012. */
  88013. export enum NodeMaterialBlockTargets {
  88014. /** Vertex shader */
  88015. Vertex = 1,
  88016. /** Fragment shader */
  88017. Fragment = 2,
  88018. /** Neutral */
  88019. Neutral = 4,
  88020. /** Vertex and Fragment */
  88021. VertexAndFragment = 3
  88022. }
  88023. }
  88024. declare module BABYLON {
  88025. /**
  88026. * Enum defining the mode of a NodeMaterialBlockConnectionPoint
  88027. */
  88028. export enum NodeMaterialBlockConnectionPointMode {
  88029. /** Value is an uniform */
  88030. Uniform = 0,
  88031. /** Value is a mesh attribute */
  88032. Attribute = 1,
  88033. /** Value is a varying between vertex and fragment shaders */
  88034. Varying = 2,
  88035. /** Mode is undefined */
  88036. Undefined = 3
  88037. }
  88038. }
  88039. declare module BABYLON {
  88040. /**
  88041. * Enum used to define system values e.g. values automatically provided by the system
  88042. */
  88043. export enum NodeMaterialSystemValues {
  88044. /** World */
  88045. World = 1,
  88046. /** View */
  88047. View = 2,
  88048. /** Projection */
  88049. Projection = 3,
  88050. /** ViewProjection */
  88051. ViewProjection = 4,
  88052. /** WorldView */
  88053. WorldView = 5,
  88054. /** WorldViewProjection */
  88055. WorldViewProjection = 6,
  88056. /** CameraPosition */
  88057. CameraPosition = 7,
  88058. /** Fog Color */
  88059. FogColor = 8,
  88060. /** Delta time */
  88061. DeltaTime = 9
  88062. }
  88063. }
  88064. declare module BABYLON {
  88065. /** Defines supported spaces */
  88066. export enum Space {
  88067. /** Local (object) space */
  88068. LOCAL = 0,
  88069. /** World space */
  88070. WORLD = 1,
  88071. /** Bone space */
  88072. BONE = 2
  88073. }
  88074. /** Defines the 3 main axes */
  88075. export class Axis {
  88076. /** X axis */
  88077. static X: Vector3;
  88078. /** Y axis */
  88079. static Y: Vector3;
  88080. /** Z axis */
  88081. static Z: Vector3;
  88082. }
  88083. }
  88084. declare module BABYLON {
  88085. /**
  88086. * Represents a camera frustum
  88087. */
  88088. export class Frustum {
  88089. /**
  88090. * Gets the planes representing the frustum
  88091. * @param transform matrix to be applied to the returned planes
  88092. * @returns a new array of 6 Frustum planes computed by the given transformation matrix.
  88093. */
  88094. static GetPlanes(transform: DeepImmutable<Matrix>): Plane[];
  88095. /**
  88096. * Gets the near frustum plane transformed by the transform matrix
  88097. * @param transform transformation matrix to be applied to the resulting frustum plane
  88098. * @param frustumPlane the resuling frustum plane
  88099. */
  88100. static GetNearPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  88101. /**
  88102. * Gets the far frustum plane transformed by the transform matrix
  88103. * @param transform transformation matrix to be applied to the resulting frustum plane
  88104. * @param frustumPlane the resuling frustum plane
  88105. */
  88106. static GetFarPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  88107. /**
  88108. * Gets the left frustum plane transformed by the transform matrix
  88109. * @param transform transformation matrix to be applied to the resulting frustum plane
  88110. * @param frustumPlane the resuling frustum plane
  88111. */
  88112. static GetLeftPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  88113. /**
  88114. * Gets the right frustum plane transformed by the transform matrix
  88115. * @param transform transformation matrix to be applied to the resulting frustum plane
  88116. * @param frustumPlane the resuling frustum plane
  88117. */
  88118. static GetRightPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  88119. /**
  88120. * Gets the top frustum plane transformed by the transform matrix
  88121. * @param transform transformation matrix to be applied to the resulting frustum plane
  88122. * @param frustumPlane the resuling frustum plane
  88123. */
  88124. static GetTopPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  88125. /**
  88126. * Gets the bottom frustum plane transformed by the transform matrix
  88127. * @param transform transformation matrix to be applied to the resulting frustum plane
  88128. * @param frustumPlane the resuling frustum plane
  88129. */
  88130. static GetBottomPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  88131. /**
  88132. * Sets the given array "frustumPlanes" with the 6 Frustum planes computed by the given transformation matrix.
  88133. * @param transform transformation matrix to be applied to the resulting frustum planes
  88134. * @param frustumPlanes the resuling frustum planes
  88135. */
  88136. static GetPlanesToRef(transform: DeepImmutable<Matrix>, frustumPlanes: Plane[]): void;
  88137. }
  88138. }
  88139. declare module BABYLON {
  88140. /**
  88141. * Interface for the size containing width and height
  88142. */
  88143. export interface ISize {
  88144. /**
  88145. * Width
  88146. */
  88147. width: number;
  88148. /**
  88149. * Heighht
  88150. */
  88151. height: number;
  88152. }
  88153. /**
  88154. * Size containing widht and height
  88155. */
  88156. export class Size implements ISize {
  88157. /**
  88158. * Width
  88159. */
  88160. width: number;
  88161. /**
  88162. * Height
  88163. */
  88164. height: number;
  88165. /**
  88166. * Creates a Size object from the given width and height (floats).
  88167. * @param width width of the new size
  88168. * @param height height of the new size
  88169. */
  88170. constructor(width: number, height: number);
  88171. /**
  88172. * Returns a string with the Size width and height
  88173. * @returns a string with the Size width and height
  88174. */
  88175. toString(): string;
  88176. /**
  88177. * "Size"
  88178. * @returns the string "Size"
  88179. */
  88180. getClassName(): string;
  88181. /**
  88182. * Returns the Size hash code.
  88183. * @returns a hash code for a unique width and height
  88184. */
  88185. getHashCode(): number;
  88186. /**
  88187. * Updates the current size from the given one.
  88188. * @param src the given size
  88189. */
  88190. copyFrom(src: Size): void;
  88191. /**
  88192. * Updates in place the current Size from the given floats.
  88193. * @param width width of the new size
  88194. * @param height height of the new size
  88195. * @returns the updated Size.
  88196. */
  88197. copyFromFloats(width: number, height: number): Size;
  88198. /**
  88199. * Updates in place the current Size from the given floats.
  88200. * @param width width to set
  88201. * @param height height to set
  88202. * @returns the updated Size.
  88203. */
  88204. set(width: number, height: number): Size;
  88205. /**
  88206. * Multiplies the width and height by numbers
  88207. * @param w factor to multiple the width by
  88208. * @param h factor to multiple the height by
  88209. * @returns a new Size set with the multiplication result of the current Size and the given floats.
  88210. */
  88211. multiplyByFloats(w: number, h: number): Size;
  88212. /**
  88213. * Clones the size
  88214. * @returns a new Size copied from the given one.
  88215. */
  88216. clone(): Size;
  88217. /**
  88218. * True if the current Size and the given one width and height are strictly equal.
  88219. * @param other the other size to compare against
  88220. * @returns True if the current Size and the given one width and height are strictly equal.
  88221. */
  88222. equals(other: Size): boolean;
  88223. /**
  88224. * The surface of the Size : width * height (float).
  88225. */
  88226. get surface(): number;
  88227. /**
  88228. * Create a new size of zero
  88229. * @returns a new Size set to (0.0, 0.0)
  88230. */
  88231. static Zero(): Size;
  88232. /**
  88233. * Sums the width and height of two sizes
  88234. * @param otherSize size to add to this size
  88235. * @returns a new Size set as the addition result of the current Size and the given one.
  88236. */
  88237. add(otherSize: Size): Size;
  88238. /**
  88239. * Subtracts the width and height of two
  88240. * @param otherSize size to subtract to this size
  88241. * @returns a new Size set as the subtraction result of the given one from the current Size.
  88242. */
  88243. subtract(otherSize: Size): Size;
  88244. /**
  88245. * Creates a new Size set at the linear interpolation "amount" between "start" and "end"
  88246. * @param start starting size to lerp between
  88247. * @param end end size to lerp between
  88248. * @param amount amount to lerp between the start and end values
  88249. * @returns a new Size set at the linear interpolation "amount" between "start" and "end"
  88250. */
  88251. static Lerp(start: Size, end: Size, amount: number): Size;
  88252. }
  88253. }
  88254. declare module BABYLON {
  88255. /**
  88256. * Contains position and normal vectors for a vertex
  88257. */
  88258. export class PositionNormalVertex {
  88259. /** the position of the vertex (defaut: 0,0,0) */
  88260. position: Vector3;
  88261. /** the normal of the vertex (defaut: 0,1,0) */
  88262. normal: Vector3;
  88263. /**
  88264. * Creates a PositionNormalVertex
  88265. * @param position the position of the vertex (defaut: 0,0,0)
  88266. * @param normal the normal of the vertex (defaut: 0,1,0)
  88267. */
  88268. constructor(
  88269. /** the position of the vertex (defaut: 0,0,0) */
  88270. position?: Vector3,
  88271. /** the normal of the vertex (defaut: 0,1,0) */
  88272. normal?: Vector3);
  88273. /**
  88274. * Clones the PositionNormalVertex
  88275. * @returns the cloned PositionNormalVertex
  88276. */
  88277. clone(): PositionNormalVertex;
  88278. }
  88279. /**
  88280. * Contains position, normal and uv vectors for a vertex
  88281. */
  88282. export class PositionNormalTextureVertex {
  88283. /** the position of the vertex (defaut: 0,0,0) */
  88284. position: Vector3;
  88285. /** the normal of the vertex (defaut: 0,1,0) */
  88286. normal: Vector3;
  88287. /** the uv of the vertex (default: 0,0) */
  88288. uv: Vector2;
  88289. /**
  88290. * Creates a PositionNormalTextureVertex
  88291. * @param position the position of the vertex (defaut: 0,0,0)
  88292. * @param normal the normal of the vertex (defaut: 0,1,0)
  88293. * @param uv the uv of the vertex (default: 0,0)
  88294. */
  88295. constructor(
  88296. /** the position of the vertex (defaut: 0,0,0) */
  88297. position?: Vector3,
  88298. /** the normal of the vertex (defaut: 0,1,0) */
  88299. normal?: Vector3,
  88300. /** the uv of the vertex (default: 0,0) */
  88301. uv?: Vector2);
  88302. /**
  88303. * Clones the PositionNormalTextureVertex
  88304. * @returns the cloned PositionNormalTextureVertex
  88305. */
  88306. clone(): PositionNormalTextureVertex;
  88307. }
  88308. }
  88309. declare module BABYLON {
  88310. /**
  88311. * Enum defining the type of animations supported by InputBlock
  88312. */
  88313. export enum AnimatedInputBlockTypes {
  88314. /** No animation */
  88315. None = 0,
  88316. /** Time based animation. Will only work for floats */
  88317. Time = 1
  88318. }
  88319. }
  88320. declare module BABYLON {
  88321. /**
  88322. * Interface describing all the common properties and methods a shadow light needs to implement.
  88323. * This helps both the shadow generator and materials to genrate the corresponding shadow maps
  88324. * as well as binding the different shadow properties to the effects.
  88325. */
  88326. export interface IShadowLight extends Light {
  88327. /**
  88328. * The light id in the scene (used in scene.findLighById for instance)
  88329. */
  88330. id: string;
  88331. /**
  88332. * The position the shdow will be casted from.
  88333. */
  88334. position: Vector3;
  88335. /**
  88336. * In 2d mode (needCube being false), the direction used to cast the shadow.
  88337. */
  88338. direction: Vector3;
  88339. /**
  88340. * The transformed position. Position of the light in world space taking parenting in account.
  88341. */
  88342. transformedPosition: Vector3;
  88343. /**
  88344. * The transformed direction. Direction of the light in world space taking parenting in account.
  88345. */
  88346. transformedDirection: Vector3;
  88347. /**
  88348. * The friendly name of the light in the scene.
  88349. */
  88350. name: string;
  88351. /**
  88352. * Defines the shadow projection clipping minimum z value.
  88353. */
  88354. shadowMinZ: number;
  88355. /**
  88356. * Defines the shadow projection clipping maximum z value.
  88357. */
  88358. shadowMaxZ: number;
  88359. /**
  88360. * Computes the transformed information (transformedPosition and transformedDirection in World space) of the current light
  88361. * @returns true if the information has been computed, false if it does not need to (no parenting)
  88362. */
  88363. computeTransformedInformation(): boolean;
  88364. /**
  88365. * Gets the scene the light belongs to.
  88366. * @returns The scene
  88367. */
  88368. getScene(): Scene;
  88369. /**
  88370. * Callback defining a custom Projection Matrix Builder.
  88371. * This can be used to override the default projection matrix computation.
  88372. */
  88373. customProjectionMatrixBuilder: (viewMatrix: Matrix, renderList: Array<AbstractMesh>, result: Matrix) => void;
  88374. /**
  88375. * Sets the shadow projection matrix in parameter to the generated projection matrix.
  88376. * @param matrix The materix to updated with the projection information
  88377. * @param viewMatrix The transform matrix of the light
  88378. * @param renderList The list of mesh to render in the map
  88379. * @returns The current light
  88380. */
  88381. setShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): IShadowLight;
  88382. /**
  88383. * Gets the current depth scale used in ESM.
  88384. * @returns The scale
  88385. */
  88386. getDepthScale(): number;
  88387. /**
  88388. * Returns whether or not the shadow generation require a cube texture or a 2d texture.
  88389. * @returns true if a cube texture needs to be use
  88390. */
  88391. needCube(): boolean;
  88392. /**
  88393. * Detects if the projection matrix requires to be recomputed this frame.
  88394. * @returns true if it requires to be recomputed otherwise, false.
  88395. */
  88396. needProjectionMatrixCompute(): boolean;
  88397. /**
  88398. * Forces the shadow generator to recompute the projection matrix even if position and direction did not changed.
  88399. */
  88400. forceProjectionMatrixCompute(): void;
  88401. /**
  88402. * Get the direction to use to render the shadow map. In case of cube texture, the face index can be passed.
  88403. * @param faceIndex The index of the face we are computed the direction to generate shadow
  88404. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  88405. */
  88406. getShadowDirection(faceIndex?: number): Vector3;
  88407. /**
  88408. * Gets the minZ used for shadow according to both the scene and the light.
  88409. * @param activeCamera The camera we are returning the min for
  88410. * @returns the depth min z
  88411. */
  88412. getDepthMinZ(activeCamera: Camera): number;
  88413. /**
  88414. * Gets the maxZ used for shadow according to both the scene and the light.
  88415. * @param activeCamera The camera we are returning the max for
  88416. * @returns the depth max z
  88417. */
  88418. getDepthMaxZ(activeCamera: Camera): number;
  88419. }
  88420. /**
  88421. * Base implementation IShadowLight
  88422. * It groups all the common behaviour in order to reduce dupplication and better follow the DRY pattern.
  88423. */
  88424. export abstract class ShadowLight extends Light implements IShadowLight {
  88425. protected abstract _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  88426. protected _position: Vector3;
  88427. protected _setPosition(value: Vector3): void;
  88428. /**
  88429. * Sets the position the shadow will be casted from. Also use as the light position for both
  88430. * point and spot lights.
  88431. */
  88432. get position(): Vector3;
  88433. /**
  88434. * Sets the position the shadow will be casted from. Also use as the light position for both
  88435. * point and spot lights.
  88436. */
  88437. set position(value: Vector3);
  88438. protected _direction: Vector3;
  88439. protected _setDirection(value: Vector3): void;
  88440. /**
  88441. * In 2d mode (needCube being false), gets the direction used to cast the shadow.
  88442. * Also use as the light direction on spot and directional lights.
  88443. */
  88444. get direction(): Vector3;
  88445. /**
  88446. * In 2d mode (needCube being false), sets the direction used to cast the shadow.
  88447. * Also use as the light direction on spot and directional lights.
  88448. */
  88449. set direction(value: Vector3);
  88450. protected _shadowMinZ: number;
  88451. /**
  88452. * Gets the shadow projection clipping minimum z value.
  88453. */
  88454. get shadowMinZ(): number;
  88455. /**
  88456. * Sets the shadow projection clipping minimum z value.
  88457. */
  88458. set shadowMinZ(value: number);
  88459. protected _shadowMaxZ: number;
  88460. /**
  88461. * Sets the shadow projection clipping maximum z value.
  88462. */
  88463. get shadowMaxZ(): number;
  88464. /**
  88465. * Gets the shadow projection clipping maximum z value.
  88466. */
  88467. set shadowMaxZ(value: number);
  88468. /**
  88469. * Callback defining a custom Projection Matrix Builder.
  88470. * This can be used to override the default projection matrix computation.
  88471. */
  88472. customProjectionMatrixBuilder: (viewMatrix: Matrix, renderList: Array<AbstractMesh>, result: Matrix) => void;
  88473. /**
  88474. * The transformed position. Position of the light in world space taking parenting in account.
  88475. */
  88476. transformedPosition: Vector3;
  88477. /**
  88478. * The transformed direction. Direction of the light in world space taking parenting in account.
  88479. */
  88480. transformedDirection: Vector3;
  88481. private _needProjectionMatrixCompute;
  88482. /**
  88483. * Computes the transformed information (transformedPosition and transformedDirection in World space) of the current light
  88484. * @returns true if the information has been computed, false if it does not need to (no parenting)
  88485. */
  88486. computeTransformedInformation(): boolean;
  88487. /**
  88488. * Return the depth scale used for the shadow map.
  88489. * @returns the depth scale.
  88490. */
  88491. getDepthScale(): number;
  88492. /**
  88493. * Get the direction to use to render the shadow map. In case of cube texture, the face index can be passed.
  88494. * @param faceIndex The index of the face we are computed the direction to generate shadow
  88495. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  88496. */
  88497. getShadowDirection(faceIndex?: number): Vector3;
  88498. /**
  88499. * Returns the ShadowLight absolute position in the World.
  88500. * @returns the position vector in world space
  88501. */
  88502. getAbsolutePosition(): Vector3;
  88503. /**
  88504. * Sets the ShadowLight direction toward the passed target.
  88505. * @param target The point to target in local space
  88506. * @returns the updated ShadowLight direction
  88507. */
  88508. setDirectionToTarget(target: Vector3): Vector3;
  88509. /**
  88510. * Returns the light rotation in euler definition.
  88511. * @returns the x y z rotation in local space.
  88512. */
  88513. getRotation(): Vector3;
  88514. /**
  88515. * Returns whether or not the shadow generation require a cube texture or a 2d texture.
  88516. * @returns true if a cube texture needs to be use
  88517. */
  88518. needCube(): boolean;
  88519. /**
  88520. * Detects if the projection matrix requires to be recomputed this frame.
  88521. * @returns true if it requires to be recomputed otherwise, false.
  88522. */
  88523. needProjectionMatrixCompute(): boolean;
  88524. /**
  88525. * Forces the shadow generator to recompute the projection matrix even if position and direction did not changed.
  88526. */
  88527. forceProjectionMatrixCompute(): void;
  88528. /** @hidden */
  88529. _initCache(): void;
  88530. /** @hidden */
  88531. _isSynchronized(): boolean;
  88532. /**
  88533. * Computes the world matrix of the node
  88534. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  88535. * @returns the world matrix
  88536. */
  88537. computeWorldMatrix(force?: boolean): Matrix;
  88538. /**
  88539. * Gets the minZ used for shadow according to both the scene and the light.
  88540. * @param activeCamera The camera we are returning the min for
  88541. * @returns the depth min z
  88542. */
  88543. getDepthMinZ(activeCamera: Camera): number;
  88544. /**
  88545. * Gets the maxZ used for shadow according to both the scene and the light.
  88546. * @param activeCamera The camera we are returning the max for
  88547. * @returns the depth max z
  88548. */
  88549. getDepthMaxZ(activeCamera: Camera): number;
  88550. /**
  88551. * Sets the shadow projection matrix in parameter to the generated projection matrix.
  88552. * @param matrix The materix to updated with the projection information
  88553. * @param viewMatrix The transform matrix of the light
  88554. * @param renderList The list of mesh to render in the map
  88555. * @returns The current light
  88556. */
  88557. setShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): IShadowLight;
  88558. }
  88559. }
  88560. declare module BABYLON {
  88561. /** @hidden */
  88562. export var packingFunctions: {
  88563. name: string;
  88564. shader: string;
  88565. };
  88566. }
  88567. declare module BABYLON {
  88568. /** @hidden */
  88569. export var bayerDitherFunctions: {
  88570. name: string;
  88571. shader: string;
  88572. };
  88573. }
  88574. declare module BABYLON {
  88575. /** @hidden */
  88576. export var shadowMapFragmentDeclaration: {
  88577. name: string;
  88578. shader: string;
  88579. };
  88580. }
  88581. declare module BABYLON {
  88582. /** @hidden */
  88583. export var clipPlaneFragmentDeclaration: {
  88584. name: string;
  88585. shader: string;
  88586. };
  88587. }
  88588. declare module BABYLON {
  88589. /** @hidden */
  88590. export var clipPlaneFragment: {
  88591. name: string;
  88592. shader: string;
  88593. };
  88594. }
  88595. declare module BABYLON {
  88596. /** @hidden */
  88597. export var shadowMapFragment: {
  88598. name: string;
  88599. shader: string;
  88600. };
  88601. }
  88602. declare module BABYLON {
  88603. /** @hidden */
  88604. export var shadowMapPixelShader: {
  88605. name: string;
  88606. shader: string;
  88607. };
  88608. }
  88609. declare module BABYLON {
  88610. /** @hidden */
  88611. export var bonesDeclaration: {
  88612. name: string;
  88613. shader: string;
  88614. };
  88615. }
  88616. declare module BABYLON {
  88617. /** @hidden */
  88618. export var morphTargetsVertexGlobalDeclaration: {
  88619. name: string;
  88620. shader: string;
  88621. };
  88622. }
  88623. declare module BABYLON {
  88624. /** @hidden */
  88625. export var morphTargetsVertexDeclaration: {
  88626. name: string;
  88627. shader: string;
  88628. };
  88629. }
  88630. declare module BABYLON {
  88631. /** @hidden */
  88632. export var instancesDeclaration: {
  88633. name: string;
  88634. shader: string;
  88635. };
  88636. }
  88637. declare module BABYLON {
  88638. /** @hidden */
  88639. export var helperFunctions: {
  88640. name: string;
  88641. shader: string;
  88642. };
  88643. }
  88644. declare module BABYLON {
  88645. /** @hidden */
  88646. export var shadowMapVertexDeclaration: {
  88647. name: string;
  88648. shader: string;
  88649. };
  88650. }
  88651. declare module BABYLON {
  88652. /** @hidden */
  88653. export var clipPlaneVertexDeclaration: {
  88654. name: string;
  88655. shader: string;
  88656. };
  88657. }
  88658. declare module BABYLON {
  88659. /** @hidden */
  88660. export var morphTargetsVertex: {
  88661. name: string;
  88662. shader: string;
  88663. };
  88664. }
  88665. declare module BABYLON {
  88666. /** @hidden */
  88667. export var instancesVertex: {
  88668. name: string;
  88669. shader: string;
  88670. };
  88671. }
  88672. declare module BABYLON {
  88673. /** @hidden */
  88674. export var bonesVertex: {
  88675. name: string;
  88676. shader: string;
  88677. };
  88678. }
  88679. declare module BABYLON {
  88680. /** @hidden */
  88681. export var shadowMapVertexNormalBias: {
  88682. name: string;
  88683. shader: string;
  88684. };
  88685. }
  88686. declare module BABYLON {
  88687. /** @hidden */
  88688. export var shadowMapVertexMetric: {
  88689. name: string;
  88690. shader: string;
  88691. };
  88692. }
  88693. declare module BABYLON {
  88694. /** @hidden */
  88695. export var clipPlaneVertex: {
  88696. name: string;
  88697. shader: string;
  88698. };
  88699. }
  88700. declare module BABYLON {
  88701. /** @hidden */
  88702. export var shadowMapVertexShader: {
  88703. name: string;
  88704. shader: string;
  88705. };
  88706. }
  88707. declare module BABYLON {
  88708. /** @hidden */
  88709. export var depthBoxBlurPixelShader: {
  88710. name: string;
  88711. shader: string;
  88712. };
  88713. }
  88714. declare module BABYLON {
  88715. /** @hidden */
  88716. export var shadowMapFragmentSoftTransparentShadow: {
  88717. name: string;
  88718. shader: string;
  88719. };
  88720. }
  88721. declare module BABYLON {
  88722. /**
  88723. * EffectFallbacks can be used to add fallbacks (properties to disable) to certain properties when desired to improve performance.
  88724. * (Eg. Start at high quality with reflection and fog, if fps is low, remove reflection, if still low remove fog)
  88725. */
  88726. export class EffectFallbacks implements IEffectFallbacks {
  88727. private _defines;
  88728. private _currentRank;
  88729. private _maxRank;
  88730. private _mesh;
  88731. /**
  88732. * Removes the fallback from the bound mesh.
  88733. */
  88734. unBindMesh(): void;
  88735. /**
  88736. * Adds a fallback on the specified property.
  88737. * @param rank The rank of the fallback (Lower ranks will be fallbacked to first)
  88738. * @param define The name of the define in the shader
  88739. */
  88740. addFallback(rank: number, define: string): void;
  88741. /**
  88742. * Sets the mesh to use CPU skinning when needing to fallback.
  88743. * @param rank The rank of the fallback (Lower ranks will be fallbacked to first)
  88744. * @param mesh The mesh to use the fallbacks.
  88745. */
  88746. addCPUSkinningFallback(rank: number, mesh: AbstractMesh): void;
  88747. /**
  88748. * Checks to see if more fallbacks are still availible.
  88749. */
  88750. get hasMoreFallbacks(): boolean;
  88751. /**
  88752. * Removes the defines that should be removed when falling back.
  88753. * @param currentDefines defines the current define statements for the shader.
  88754. * @param effect defines the current effect we try to compile
  88755. * @returns The resulting defines with defines of the current rank removed.
  88756. */
  88757. reduce(currentDefines: string, effect: Effect): string;
  88758. }
  88759. }
  88760. declare module BABYLON {
  88761. /**
  88762. * Interface used to define Action
  88763. */
  88764. export interface IAction {
  88765. /**
  88766. * Trigger for the action
  88767. */
  88768. trigger: number;
  88769. /** Options of the trigger */
  88770. triggerOptions: any;
  88771. /**
  88772. * Gets the trigger parameters
  88773. * @returns the trigger parameters
  88774. */
  88775. getTriggerParameter(): any;
  88776. /**
  88777. * Internal only - executes current action event
  88778. * @hidden
  88779. */
  88780. _executeCurrent(evt?: ActionEvent): void;
  88781. /**
  88782. * Serialize placeholder for child classes
  88783. * @param parent of child
  88784. * @returns the serialized object
  88785. */
  88786. serialize(parent: any): any;
  88787. /**
  88788. * Internal only
  88789. * @hidden
  88790. */
  88791. _prepare(): void;
  88792. /**
  88793. * Internal only - manager for action
  88794. * @hidden
  88795. */
  88796. _actionManager: AbstractActionManager;
  88797. /**
  88798. * Adds action to chain of actions, may be a DoNothingAction
  88799. * @param action defines the next action to execute
  88800. * @returns The action passed in
  88801. * @see https://www.babylonjs-playground.com/#1T30HR#0
  88802. */
  88803. then(action: IAction): IAction;
  88804. }
  88805. /**
  88806. * The action to be carried out following a trigger
  88807. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#available-actions
  88808. */
  88809. export class Action implements IAction {
  88810. /** the trigger, with or without parameters, for the action */
  88811. triggerOptions: any;
  88812. /**
  88813. * Trigger for the action
  88814. */
  88815. trigger: number;
  88816. /**
  88817. * Internal only - manager for action
  88818. * @hidden
  88819. */
  88820. _actionManager: ActionManager;
  88821. private _nextActiveAction;
  88822. private _child;
  88823. private _condition?;
  88824. private _triggerParameter;
  88825. /**
  88826. * An event triggered prior to action being executed.
  88827. */
  88828. onBeforeExecuteObservable: Observable<Action>;
  88829. /**
  88830. * Creates a new Action
  88831. * @param triggerOptions the trigger, with or without parameters, for the action
  88832. * @param condition an optional determinant of action
  88833. */
  88834. constructor(
  88835. /** the trigger, with or without parameters, for the action */
  88836. triggerOptions: any, condition?: Condition);
  88837. /**
  88838. * Internal only
  88839. * @hidden
  88840. */
  88841. _prepare(): void;
  88842. /**
  88843. * Gets the trigger parameters
  88844. * @returns the trigger parameters
  88845. */
  88846. getTriggerParameter(): any;
  88847. /**
  88848. * Internal only - executes current action event
  88849. * @hidden
  88850. */
  88851. _executeCurrent(evt?: ActionEvent): void;
  88852. /**
  88853. * Execute placeholder for child classes
  88854. * @param evt optional action event
  88855. */
  88856. execute(evt?: ActionEvent): void;
  88857. /**
  88858. * Skips to next active action
  88859. */
  88860. skipToNextActiveAction(): void;
  88861. /**
  88862. * Adds action to chain of actions, may be a DoNothingAction
  88863. * @param action defines the next action to execute
  88864. * @returns The action passed in
  88865. * @see https://www.babylonjs-playground.com/#1T30HR#0
  88866. */
  88867. then(action: Action): Action;
  88868. /**
  88869. * Internal only
  88870. * @hidden
  88871. */
  88872. _getProperty(propertyPath: string): string;
  88873. /**
  88874. * Internal only
  88875. * @hidden
  88876. */
  88877. _getEffectiveTarget(target: any, propertyPath: string): any;
  88878. /**
  88879. * Serialize placeholder for child classes
  88880. * @param parent of child
  88881. * @returns the serialized object
  88882. */
  88883. serialize(parent: any): any;
  88884. /**
  88885. * Internal only called by serialize
  88886. * @hidden
  88887. */
  88888. protected _serialize(serializedAction: any, parent?: any): any;
  88889. /**
  88890. * Internal only
  88891. * @hidden
  88892. */
  88893. static _SerializeValueAsString: (value: any) => string;
  88894. /**
  88895. * Internal only
  88896. * @hidden
  88897. */
  88898. static _GetTargetProperty: (target: Scene | Node) => {
  88899. name: string;
  88900. targetType: string;
  88901. value: string;
  88902. };
  88903. }
  88904. }
  88905. declare module BABYLON {
  88906. /**
  88907. * A Condition applied to an Action
  88908. */
  88909. export class Condition {
  88910. /**
  88911. * Internal only - manager for action
  88912. * @hidden
  88913. */
  88914. _actionManager: ActionManager;
  88915. /**
  88916. * Internal only
  88917. * @hidden
  88918. */
  88919. _evaluationId: number;
  88920. /**
  88921. * Internal only
  88922. * @hidden
  88923. */
  88924. _currentResult: boolean;
  88925. /**
  88926. * Creates a new Condition
  88927. * @param actionManager the manager of the action the condition is applied to
  88928. */
  88929. constructor(actionManager: ActionManager);
  88930. /**
  88931. * Check if the current condition is valid
  88932. * @returns a boolean
  88933. */
  88934. isValid(): boolean;
  88935. /**
  88936. * Internal only
  88937. * @hidden
  88938. */
  88939. _getProperty(propertyPath: string): string;
  88940. /**
  88941. * Internal only
  88942. * @hidden
  88943. */
  88944. _getEffectiveTarget(target: any, propertyPath: string): any;
  88945. /**
  88946. * Serialize placeholder for child classes
  88947. * @returns the serialized object
  88948. */
  88949. serialize(): any;
  88950. /**
  88951. * Internal only
  88952. * @hidden
  88953. */
  88954. protected _serialize(serializedCondition: any): any;
  88955. }
  88956. /**
  88957. * Defines specific conditional operators as extensions of Condition
  88958. */
  88959. export class ValueCondition extends Condition {
  88960. /** path to specify the property of the target the conditional operator uses */
  88961. propertyPath: string;
  88962. /** the value compared by the conditional operator against the current value of the property */
  88963. value: any;
  88964. /** the conditional operator, default ValueCondition.IsEqual */
  88965. operator: number;
  88966. /**
  88967. * Internal only
  88968. * @hidden
  88969. */
  88970. private static _IsEqual;
  88971. /**
  88972. * Internal only
  88973. * @hidden
  88974. */
  88975. private static _IsDifferent;
  88976. /**
  88977. * Internal only
  88978. * @hidden
  88979. */
  88980. private static _IsGreater;
  88981. /**
  88982. * Internal only
  88983. * @hidden
  88984. */
  88985. private static _IsLesser;
  88986. /**
  88987. * returns the number for IsEqual
  88988. */
  88989. static get IsEqual(): number;
  88990. /**
  88991. * Returns the number for IsDifferent
  88992. */
  88993. static get IsDifferent(): number;
  88994. /**
  88995. * Returns the number for IsGreater
  88996. */
  88997. static get IsGreater(): number;
  88998. /**
  88999. * Returns the number for IsLesser
  89000. */
  89001. static get IsLesser(): number;
  89002. /**
  89003. * Internal only The action manager for the condition
  89004. * @hidden
  89005. */
  89006. _actionManager: ActionManager;
  89007. /**
  89008. * Internal only
  89009. * @hidden
  89010. */
  89011. private _target;
  89012. /**
  89013. * Internal only
  89014. * @hidden
  89015. */
  89016. private _effectiveTarget;
  89017. /**
  89018. * Internal only
  89019. * @hidden
  89020. */
  89021. private _property;
  89022. /**
  89023. * Creates a new ValueCondition
  89024. * @param actionManager manager for the action the condition applies to
  89025. * @param target for the action
  89026. * @param propertyPath path to specify the property of the target the conditional operator uses
  89027. * @param value the value compared by the conditional operator against the current value of the property
  89028. * @param operator the conditional operator, default ValueCondition.IsEqual
  89029. */
  89030. constructor(actionManager: ActionManager, target: any,
  89031. /** path to specify the property of the target the conditional operator uses */
  89032. propertyPath: string,
  89033. /** the value compared by the conditional operator against the current value of the property */
  89034. value: any,
  89035. /** the conditional operator, default ValueCondition.IsEqual */
  89036. operator?: number);
  89037. /**
  89038. * Compares the given value with the property value for the specified conditional operator
  89039. * @returns the result of the comparison
  89040. */
  89041. isValid(): boolean;
  89042. /**
  89043. * Serialize the ValueCondition into a JSON compatible object
  89044. * @returns serialization object
  89045. */
  89046. serialize(): any;
  89047. /**
  89048. * Gets the name of the conditional operator for the ValueCondition
  89049. * @param operator the conditional operator
  89050. * @returns the name
  89051. */
  89052. static GetOperatorName(operator: number): string;
  89053. }
  89054. /**
  89055. * Defines a predicate condition as an extension of Condition
  89056. */
  89057. export class PredicateCondition extends Condition {
  89058. /** defines the predicate function used to validate the condition */
  89059. predicate: () => boolean;
  89060. /**
  89061. * Internal only - manager for action
  89062. * @hidden
  89063. */
  89064. _actionManager: ActionManager;
  89065. /**
  89066. * Creates a new PredicateCondition
  89067. * @param actionManager manager for the action the condition applies to
  89068. * @param predicate defines the predicate function used to validate the condition
  89069. */
  89070. constructor(actionManager: ActionManager,
  89071. /** defines the predicate function used to validate the condition */
  89072. predicate: () => boolean);
  89073. /**
  89074. * @returns the validity of the predicate condition
  89075. */
  89076. isValid(): boolean;
  89077. }
  89078. /**
  89079. * Defines a state condition as an extension of Condition
  89080. */
  89081. export class StateCondition extends Condition {
  89082. /** Value to compare with target state */
  89083. value: string;
  89084. /**
  89085. * Internal only - manager for action
  89086. * @hidden
  89087. */
  89088. _actionManager: ActionManager;
  89089. /**
  89090. * Internal only
  89091. * @hidden
  89092. */
  89093. private _target;
  89094. /**
  89095. * Creates a new StateCondition
  89096. * @param actionManager manager for the action the condition applies to
  89097. * @param target of the condition
  89098. * @param value to compare with target state
  89099. */
  89100. constructor(actionManager: ActionManager, target: any,
  89101. /** Value to compare with target state */
  89102. value: string);
  89103. /**
  89104. * Gets a boolean indicating if the current condition is met
  89105. * @returns the validity of the state
  89106. */
  89107. isValid(): boolean;
  89108. /**
  89109. * Serialize the StateCondition into a JSON compatible object
  89110. * @returns serialization object
  89111. */
  89112. serialize(): any;
  89113. }
  89114. }
  89115. declare module BABYLON {
  89116. /**
  89117. * This defines an action responsible to toggle a boolean once triggered.
  89118. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89119. */
  89120. export class SwitchBooleanAction extends Action {
  89121. /**
  89122. * The path to the boolean property in the target object
  89123. */
  89124. propertyPath: string;
  89125. private _target;
  89126. private _effectiveTarget;
  89127. private _property;
  89128. /**
  89129. * Instantiate the action
  89130. * @param triggerOptions defines the trigger options
  89131. * @param target defines the object containing the boolean
  89132. * @param propertyPath defines the path to the boolean property in the target object
  89133. * @param condition defines the trigger related conditions
  89134. */
  89135. constructor(triggerOptions: any, target: any, propertyPath: string, condition?: Condition);
  89136. /** @hidden */
  89137. _prepare(): void;
  89138. /**
  89139. * Execute the action toggle the boolean value.
  89140. */
  89141. execute(): void;
  89142. /**
  89143. * Serializes the actions and its related information.
  89144. * @param parent defines the object to serialize in
  89145. * @returns the serialized object
  89146. */
  89147. serialize(parent: any): any;
  89148. }
  89149. /**
  89150. * This defines an action responsible to set a the state field of the target
  89151. * to a desired value once triggered.
  89152. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89153. */
  89154. export class SetStateAction extends Action {
  89155. /**
  89156. * The value to store in the state field.
  89157. */
  89158. value: string;
  89159. private _target;
  89160. /**
  89161. * Instantiate the action
  89162. * @param triggerOptions defines the trigger options
  89163. * @param target defines the object containing the state property
  89164. * @param value defines the value to store in the state field
  89165. * @param condition defines the trigger related conditions
  89166. */
  89167. constructor(triggerOptions: any, target: any, value: string, condition?: Condition);
  89168. /**
  89169. * Execute the action and store the value on the target state property.
  89170. */
  89171. execute(): void;
  89172. /**
  89173. * Serializes the actions and its related information.
  89174. * @param parent defines the object to serialize in
  89175. * @returns the serialized object
  89176. */
  89177. serialize(parent: any): any;
  89178. }
  89179. /**
  89180. * This defines an action responsible to set a property of the target
  89181. * to a desired value once triggered.
  89182. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89183. */
  89184. export class SetValueAction extends Action {
  89185. /**
  89186. * The path of the property to set in the target.
  89187. */
  89188. propertyPath: string;
  89189. /**
  89190. * The value to set in the property
  89191. */
  89192. value: any;
  89193. private _target;
  89194. private _effectiveTarget;
  89195. private _property;
  89196. /**
  89197. * Instantiate the action
  89198. * @param triggerOptions defines the trigger options
  89199. * @param target defines the object containing the property
  89200. * @param propertyPath defines the path of the property to set in the target
  89201. * @param value defines the value to set in the property
  89202. * @param condition defines the trigger related conditions
  89203. */
  89204. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, condition?: Condition);
  89205. /** @hidden */
  89206. _prepare(): void;
  89207. /**
  89208. * Execute the action and set the targetted property to the desired value.
  89209. */
  89210. execute(): void;
  89211. /**
  89212. * Serializes the actions and its related information.
  89213. * @param parent defines the object to serialize in
  89214. * @returns the serialized object
  89215. */
  89216. serialize(parent: any): any;
  89217. }
  89218. /**
  89219. * This defines an action responsible to increment the target value
  89220. * to a desired value once triggered.
  89221. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89222. */
  89223. export class IncrementValueAction extends Action {
  89224. /**
  89225. * The path of the property to increment in the target.
  89226. */
  89227. propertyPath: string;
  89228. /**
  89229. * The value we should increment the property by.
  89230. */
  89231. value: any;
  89232. private _target;
  89233. private _effectiveTarget;
  89234. private _property;
  89235. /**
  89236. * Instantiate the action
  89237. * @param triggerOptions defines the trigger options
  89238. * @param target defines the object containing the property
  89239. * @param propertyPath defines the path of the property to increment in the target
  89240. * @param value defines the value value we should increment the property by
  89241. * @param condition defines the trigger related conditions
  89242. */
  89243. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, condition?: Condition);
  89244. /** @hidden */
  89245. _prepare(): void;
  89246. /**
  89247. * Execute the action and increment the target of the value amount.
  89248. */
  89249. execute(): void;
  89250. /**
  89251. * Serializes the actions and its related information.
  89252. * @param parent defines the object to serialize in
  89253. * @returns the serialized object
  89254. */
  89255. serialize(parent: any): any;
  89256. }
  89257. /**
  89258. * This defines an action responsible to start an animation once triggered.
  89259. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89260. */
  89261. export class PlayAnimationAction extends Action {
  89262. /**
  89263. * Where the animation should start (animation frame)
  89264. */
  89265. from: number;
  89266. /**
  89267. * Where the animation should stop (animation frame)
  89268. */
  89269. to: number;
  89270. /**
  89271. * Define if the animation should loop or stop after the first play.
  89272. */
  89273. loop?: boolean;
  89274. private _target;
  89275. /**
  89276. * Instantiate the action
  89277. * @param triggerOptions defines the trigger options
  89278. * @param target defines the target animation or animation name
  89279. * @param from defines from where the animation should start (animation frame)
  89280. * @param end defines where the animation should stop (animation frame)
  89281. * @param loop defines if the animation should loop or stop after the first play
  89282. * @param condition defines the trigger related conditions
  89283. */
  89284. constructor(triggerOptions: any, target: any, from: number, to: number, loop?: boolean, condition?: Condition);
  89285. /** @hidden */
  89286. _prepare(): void;
  89287. /**
  89288. * Execute the action and play the animation.
  89289. */
  89290. execute(): void;
  89291. /**
  89292. * Serializes the actions and its related information.
  89293. * @param parent defines the object to serialize in
  89294. * @returns the serialized object
  89295. */
  89296. serialize(parent: any): any;
  89297. }
  89298. /**
  89299. * This defines an action responsible to stop an animation once triggered.
  89300. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89301. */
  89302. export class StopAnimationAction extends Action {
  89303. private _target;
  89304. /**
  89305. * Instantiate the action
  89306. * @param triggerOptions defines the trigger options
  89307. * @param target defines the target animation or animation name
  89308. * @param condition defines the trigger related conditions
  89309. */
  89310. constructor(triggerOptions: any, target: any, condition?: Condition);
  89311. /** @hidden */
  89312. _prepare(): void;
  89313. /**
  89314. * Execute the action and stop the animation.
  89315. */
  89316. execute(): void;
  89317. /**
  89318. * Serializes the actions and its related information.
  89319. * @param parent defines the object to serialize in
  89320. * @returns the serialized object
  89321. */
  89322. serialize(parent: any): any;
  89323. }
  89324. /**
  89325. * This defines an action responsible that does nothing once triggered.
  89326. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89327. */
  89328. export class DoNothingAction extends Action {
  89329. /**
  89330. * Instantiate the action
  89331. * @param triggerOptions defines the trigger options
  89332. * @param condition defines the trigger related conditions
  89333. */
  89334. constructor(triggerOptions?: any, condition?: Condition);
  89335. /**
  89336. * Execute the action and do nothing.
  89337. */
  89338. execute(): void;
  89339. /**
  89340. * Serializes the actions and its related information.
  89341. * @param parent defines the object to serialize in
  89342. * @returns the serialized object
  89343. */
  89344. serialize(parent: any): any;
  89345. }
  89346. /**
  89347. * This defines an action responsible to trigger several actions once triggered.
  89348. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89349. */
  89350. export class CombineAction extends Action {
  89351. /**
  89352. * The list of aggregated animations to run.
  89353. */
  89354. children: Action[];
  89355. /**
  89356. * Instantiate the action
  89357. * @param triggerOptions defines the trigger options
  89358. * @param children defines the list of aggregated animations to run
  89359. * @param condition defines the trigger related conditions
  89360. */
  89361. constructor(triggerOptions: any, children: Action[], condition?: Condition);
  89362. /** @hidden */
  89363. _prepare(): void;
  89364. /**
  89365. * Execute the action and executes all the aggregated actions.
  89366. */
  89367. execute(evt: ActionEvent): void;
  89368. /**
  89369. * Serializes the actions and its related information.
  89370. * @param parent defines the object to serialize in
  89371. * @returns the serialized object
  89372. */
  89373. serialize(parent: any): any;
  89374. }
  89375. /**
  89376. * This defines an action responsible to run code (external event) once triggered.
  89377. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89378. */
  89379. export class ExecuteCodeAction extends Action {
  89380. /**
  89381. * The callback function to run.
  89382. */
  89383. func: (evt: ActionEvent) => void;
  89384. /**
  89385. * Instantiate the action
  89386. * @param triggerOptions defines the trigger options
  89387. * @param func defines the callback function to run
  89388. * @param condition defines the trigger related conditions
  89389. */
  89390. constructor(triggerOptions: any, func: (evt: ActionEvent) => void, condition?: Condition);
  89391. /**
  89392. * Execute the action and run the attached code.
  89393. */
  89394. execute(evt: ActionEvent): void;
  89395. }
  89396. /**
  89397. * This defines an action responsible to set the parent property of the target once triggered.
  89398. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89399. */
  89400. export class SetParentAction extends Action {
  89401. private _parent;
  89402. private _target;
  89403. /**
  89404. * Instantiate the action
  89405. * @param triggerOptions defines the trigger options
  89406. * @param target defines the target containing the parent property
  89407. * @param parent defines from where the animation should start (animation frame)
  89408. * @param condition defines the trigger related conditions
  89409. */
  89410. constructor(triggerOptions: any, target: any, parent: any, condition?: Condition);
  89411. /** @hidden */
  89412. _prepare(): void;
  89413. /**
  89414. * Execute the action and set the parent property.
  89415. */
  89416. execute(): void;
  89417. /**
  89418. * Serializes the actions and its related information.
  89419. * @param parent defines the object to serialize in
  89420. * @returns the serialized object
  89421. */
  89422. serialize(parent: any): any;
  89423. }
  89424. }
  89425. declare module BABYLON {
  89426. /**
  89427. * Action Manager manages all events to be triggered on a given mesh or the global scene.
  89428. * A single scene can have many Action Managers to handle predefined actions on specific meshes.
  89429. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89430. */
  89431. export class ActionManager extends AbstractActionManager {
  89432. /**
  89433. * Nothing
  89434. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89435. */
  89436. static readonly NothingTrigger: number;
  89437. /**
  89438. * On pick
  89439. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89440. */
  89441. static readonly OnPickTrigger: number;
  89442. /**
  89443. * On left pick
  89444. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89445. */
  89446. static readonly OnLeftPickTrigger: number;
  89447. /**
  89448. * On right pick
  89449. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89450. */
  89451. static readonly OnRightPickTrigger: number;
  89452. /**
  89453. * On center pick
  89454. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89455. */
  89456. static readonly OnCenterPickTrigger: number;
  89457. /**
  89458. * On pick down
  89459. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89460. */
  89461. static readonly OnPickDownTrigger: number;
  89462. /**
  89463. * On double pick
  89464. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89465. */
  89466. static readonly OnDoublePickTrigger: number;
  89467. /**
  89468. * On pick up
  89469. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89470. */
  89471. static readonly OnPickUpTrigger: number;
  89472. /**
  89473. * On pick out.
  89474. * This trigger will only be raised if you also declared a OnPickDown
  89475. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89476. */
  89477. static readonly OnPickOutTrigger: number;
  89478. /**
  89479. * On long press
  89480. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89481. */
  89482. static readonly OnLongPressTrigger: number;
  89483. /**
  89484. * On pointer over
  89485. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89486. */
  89487. static readonly OnPointerOverTrigger: number;
  89488. /**
  89489. * On pointer out
  89490. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89491. */
  89492. static readonly OnPointerOutTrigger: number;
  89493. /**
  89494. * On every frame
  89495. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89496. */
  89497. static readonly OnEveryFrameTrigger: number;
  89498. /**
  89499. * On intersection enter
  89500. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89501. */
  89502. static readonly OnIntersectionEnterTrigger: number;
  89503. /**
  89504. * On intersection exit
  89505. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89506. */
  89507. static readonly OnIntersectionExitTrigger: number;
  89508. /**
  89509. * On key down
  89510. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89511. */
  89512. static readonly OnKeyDownTrigger: number;
  89513. /**
  89514. * On key up
  89515. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89516. */
  89517. static readonly OnKeyUpTrigger: number;
  89518. private _scene;
  89519. /**
  89520. * Creates a new action manager
  89521. * @param scene defines the hosting scene
  89522. */
  89523. constructor(scene: Scene);
  89524. /**
  89525. * Releases all associated resources
  89526. */
  89527. dispose(): void;
  89528. /**
  89529. * Gets hosting scene
  89530. * @returns the hosting scene
  89531. */
  89532. getScene(): Scene;
  89533. /**
  89534. * Does this action manager handles actions of any of the given triggers
  89535. * @param triggers defines the triggers to be tested
  89536. * @return a boolean indicating whether one (or more) of the triggers is handled
  89537. */
  89538. hasSpecificTriggers(triggers: number[]): boolean;
  89539. /**
  89540. * Does this action manager handles actions of any of the given triggers. This function takes two arguments for
  89541. * speed.
  89542. * @param triggerA defines the trigger to be tested
  89543. * @param triggerB defines the trigger to be tested
  89544. * @return a boolean indicating whether one (or more) of the triggers is handled
  89545. */
  89546. hasSpecificTriggers2(triggerA: number, triggerB: number): boolean;
  89547. /**
  89548. * Does this action manager handles actions of a given trigger
  89549. * @param trigger defines the trigger to be tested
  89550. * @param parameterPredicate defines an optional predicate to filter triggers by parameter
  89551. * @return whether the trigger is handled
  89552. */
  89553. hasSpecificTrigger(trigger: number, parameterPredicate?: (parameter: any) => boolean): boolean;
  89554. /**
  89555. * Does this action manager has pointer triggers
  89556. */
  89557. get hasPointerTriggers(): boolean;
  89558. /**
  89559. * Does this action manager has pick triggers
  89560. */
  89561. get hasPickTriggers(): boolean;
  89562. /**
  89563. * Registers an action to this action manager
  89564. * @param action defines the action to be registered
  89565. * @return the action amended (prepared) after registration
  89566. */
  89567. registerAction(action: IAction): Nullable<IAction>;
  89568. /**
  89569. * Unregisters an action to this action manager
  89570. * @param action defines the action to be unregistered
  89571. * @return a boolean indicating whether the action has been unregistered
  89572. */
  89573. unregisterAction(action: IAction): Boolean;
  89574. /**
  89575. * Process a specific trigger
  89576. * @param trigger defines the trigger to process
  89577. * @param evt defines the event details to be processed
  89578. */
  89579. processTrigger(trigger: number, evt?: IActionEvent): void;
  89580. /** @hidden */
  89581. _getEffectiveTarget(target: any, propertyPath: string): any;
  89582. /** @hidden */
  89583. _getProperty(propertyPath: string): string;
  89584. /**
  89585. * Serialize this manager to a JSON object
  89586. * @param name defines the property name to store this manager
  89587. * @returns a JSON representation of this manager
  89588. */
  89589. serialize(name: string): any;
  89590. /**
  89591. * Creates a new ActionManager from a JSON data
  89592. * @param parsedActions defines the JSON data to read from
  89593. * @param object defines the hosting mesh
  89594. * @param scene defines the hosting scene
  89595. */
  89596. static Parse(parsedActions: any, object: Nullable<AbstractMesh>, scene: Scene): void;
  89597. /**
  89598. * Get a trigger name by index
  89599. * @param trigger defines the trigger index
  89600. * @returns a trigger name
  89601. */
  89602. static GetTriggerName(trigger: number): string;
  89603. }
  89604. }
  89605. declare module BABYLON {
  89606. /**
  89607. * Class used to represent a sprite
  89608. * @see https://doc.babylonjs.com/babylon101/sprites
  89609. */
  89610. export class Sprite implements IAnimatable {
  89611. /** defines the name */
  89612. name: string;
  89613. /** Gets or sets the current world position */
  89614. position: Vector3;
  89615. /** Gets or sets the main color */
  89616. color: Color4;
  89617. /** Gets or sets the width */
  89618. width: number;
  89619. /** Gets or sets the height */
  89620. height: number;
  89621. /** Gets or sets rotation angle */
  89622. angle: number;
  89623. /** Gets or sets the cell index in the sprite sheet */
  89624. cellIndex: number;
  89625. /** Gets or sets the cell reference in the sprite sheet, uses sprite's filename when added to sprite sheet */
  89626. cellRef: string;
  89627. /** Gets or sets a boolean indicating if UV coordinates should be inverted in U axis */
  89628. invertU: boolean;
  89629. /** Gets or sets a boolean indicating if UV coordinates should be inverted in B axis */
  89630. invertV: boolean;
  89631. /** Gets or sets a boolean indicating that this sprite should be disposed after animation ends */
  89632. disposeWhenFinishedAnimating: boolean;
  89633. /** Gets the list of attached animations */
  89634. animations: Nullable<Array<Animation>>;
  89635. /** Gets or sets a boolean indicating if the sprite can be picked */
  89636. isPickable: boolean;
  89637. /** Gets or sets a boolean indicating that sprite texture alpha will be used for precise picking (false by default) */
  89638. useAlphaForPicking: boolean;
  89639. /** @hidden */
  89640. _xOffset: number;
  89641. /** @hidden */
  89642. _yOffset: number;
  89643. /** @hidden */
  89644. _xSize: number;
  89645. /** @hidden */
  89646. _ySize: number;
  89647. /**
  89648. * Gets or sets the associated action manager
  89649. */
  89650. actionManager: Nullable<ActionManager>;
  89651. /**
  89652. * An event triggered when the control has been disposed
  89653. */
  89654. onDisposeObservable: Observable<Sprite>;
  89655. private _animationStarted;
  89656. private _loopAnimation;
  89657. private _fromIndex;
  89658. private _toIndex;
  89659. private _delay;
  89660. private _direction;
  89661. private _manager;
  89662. private _time;
  89663. private _onAnimationEnd;
  89664. /**
  89665. * Gets or sets a boolean indicating if the sprite is visible (renderable). Default is true
  89666. */
  89667. isVisible: boolean;
  89668. /**
  89669. * Gets or sets the sprite size
  89670. */
  89671. get size(): number;
  89672. set size(value: number);
  89673. /**
  89674. * Returns a boolean indicating if the animation is started
  89675. */
  89676. get animationStarted(): boolean;
  89677. /**
  89678. * Gets or sets the unique id of the sprite
  89679. */
  89680. uniqueId: number;
  89681. /**
  89682. * Gets the manager of this sprite
  89683. */
  89684. get manager(): ISpriteManager;
  89685. /**
  89686. * Creates a new Sprite
  89687. * @param name defines the name
  89688. * @param manager defines the manager
  89689. */
  89690. constructor(
  89691. /** defines the name */
  89692. name: string, manager: ISpriteManager);
  89693. /**
  89694. * Returns the string "Sprite"
  89695. * @returns "Sprite"
  89696. */
  89697. getClassName(): string;
  89698. /** Gets or sets the initial key for the animation (setting it will restart the animation) */
  89699. get fromIndex(): number;
  89700. set fromIndex(value: number);
  89701. /** Gets or sets the end key for the animation (setting it will restart the animation) */
  89702. get toIndex(): number;
  89703. set toIndex(value: number);
  89704. /** Gets or sets a boolean indicating if the animation is looping (setting it will restart the animation) */
  89705. get loopAnimation(): boolean;
  89706. set loopAnimation(value: boolean);
  89707. /** Gets or sets the delay between cell changes (setting it will restart the animation) */
  89708. get delay(): number;
  89709. set delay(value: number);
  89710. /**
  89711. * Starts an animation
  89712. * @param from defines the initial key
  89713. * @param to defines the end key
  89714. * @param loop defines if the animation must loop
  89715. * @param delay defines the start delay (in ms)
  89716. * @param onAnimationEnd defines a callback to call when animation ends
  89717. */
  89718. playAnimation(from: number, to: number, loop: boolean, delay: number, onAnimationEnd?: Nullable<() => void>): void;
  89719. /** Stops current animation (if any) */
  89720. stopAnimation(): void;
  89721. /** @hidden */
  89722. _animate(deltaTime: number): void;
  89723. /** Release associated resources */
  89724. dispose(): void;
  89725. /**
  89726. * Serializes the sprite to a JSON object
  89727. * @returns the JSON object
  89728. */
  89729. serialize(): any;
  89730. /**
  89731. * Parses a JSON object to create a new sprite
  89732. * @param parsedSprite The JSON object to parse
  89733. * @param manager defines the hosting manager
  89734. * @returns the new sprite
  89735. */
  89736. static Parse(parsedSprite: any, manager: SpriteManager): Sprite;
  89737. }
  89738. }
  89739. declare module BABYLON {
  89740. /**
  89741. * Information about the result of picking within a scene
  89742. * @see https://doc.babylonjs.com/babylon101/picking_collisions
  89743. */
  89744. export class PickingInfo {
  89745. /** @hidden */
  89746. _pickingUnavailable: boolean;
  89747. /**
  89748. * If the pick collided with an object
  89749. */
  89750. hit: boolean;
  89751. /**
  89752. * Distance away where the pick collided
  89753. */
  89754. distance: number;
  89755. /**
  89756. * The location of pick collision
  89757. */
  89758. pickedPoint: Nullable<Vector3>;
  89759. /**
  89760. * The mesh corresponding the the pick collision
  89761. */
  89762. pickedMesh: Nullable<AbstractMesh>;
  89763. /** (See getTextureCoordinates) The barycentric U coordinate that is used when calculating the texture coordinates of the collision.*/
  89764. bu: number;
  89765. /** (See getTextureCoordinates) The barycentric V coordinate that is used when calculating the texture coordinates of the collision.*/
  89766. bv: number;
  89767. /** The index of the face on the mesh that was picked, or the index of the Line if the picked Mesh is a LinesMesh */
  89768. faceId: number;
  89769. /** The index of the face on the subMesh that was picked, or the index of the Line if the picked Mesh is a LinesMesh */
  89770. subMeshFaceId: number;
  89771. /** Id of the the submesh that was picked */
  89772. subMeshId: number;
  89773. /** If a sprite was picked, this will be the sprite the pick collided with */
  89774. pickedSprite: Nullable<Sprite>;
  89775. /** If we are pikcing a mesh with thin instance, this will give you the picked thin instance */
  89776. thinInstanceIndex: number;
  89777. /**
  89778. * If a mesh was used to do the picking (eg. 6dof controller) this will be populated.
  89779. */
  89780. originMesh: Nullable<AbstractMesh>;
  89781. /**
  89782. * The ray that was used to perform the picking.
  89783. */
  89784. ray: Nullable<Ray>;
  89785. /**
  89786. * Gets the normal correspodning to the face the pick collided with
  89787. * @param useWorldCoordinates If the resulting normal should be relative to the world (default: false)
  89788. * @param useVerticesNormals If the vertices normals should be used to calculate the normal instead of the normal map
  89789. * @returns The normal correspodning to the face the pick collided with
  89790. */
  89791. getNormal(useWorldCoordinates?: boolean, useVerticesNormals?: boolean): Nullable<Vector3>;
  89792. /**
  89793. * Gets the texture coordinates of where the pick occured
  89794. * @returns the vector containing the coordnates of the texture
  89795. */
  89796. getTextureCoordinates(): Nullable<Vector2>;
  89797. }
  89798. }
  89799. declare module BABYLON {
  89800. /**
  89801. * Class representing a ray with position and direction
  89802. */
  89803. export class Ray {
  89804. /** origin point */
  89805. origin: Vector3;
  89806. /** direction */
  89807. direction: Vector3;
  89808. /** length of the ray */
  89809. length: number;
  89810. private static readonly _TmpVector3;
  89811. private _tmpRay;
  89812. /**
  89813. * Creates a new ray
  89814. * @param origin origin point
  89815. * @param direction direction
  89816. * @param length length of the ray
  89817. */
  89818. constructor(
  89819. /** origin point */
  89820. origin: Vector3,
  89821. /** direction */
  89822. direction: Vector3,
  89823. /** length of the ray */
  89824. length?: number);
  89825. /**
  89826. * Checks if the ray intersects a box
  89827. * This does not account for the ray lenght by design to improve perfs.
  89828. * @param minimum bound of the box
  89829. * @param maximum bound of the box
  89830. * @param intersectionTreshold extra extend to be added to the box in all direction
  89831. * @returns if the box was hit
  89832. */
  89833. intersectsBoxMinMax(minimum: DeepImmutable<Vector3>, maximum: DeepImmutable<Vector3>, intersectionTreshold?: number): boolean;
  89834. /**
  89835. * Checks if the ray intersects a box
  89836. * This does not account for the ray lenght by design to improve perfs.
  89837. * @param box the bounding box to check
  89838. * @param intersectionTreshold extra extend to be added to the BoundingBox in all direction
  89839. * @returns if the box was hit
  89840. */
  89841. intersectsBox(box: DeepImmutable<BoundingBox>, intersectionTreshold?: number): boolean;
  89842. /**
  89843. * If the ray hits a sphere
  89844. * @param sphere the bounding sphere to check
  89845. * @param intersectionTreshold extra extend to be added to the BoundingSphere in all direction
  89846. * @returns true if it hits the sphere
  89847. */
  89848. intersectsSphere(sphere: DeepImmutable<BoundingSphere>, intersectionTreshold?: number): boolean;
  89849. /**
  89850. * If the ray hits a triange
  89851. * @param vertex0 triangle vertex
  89852. * @param vertex1 triangle vertex
  89853. * @param vertex2 triangle vertex
  89854. * @returns intersection information if hit
  89855. */
  89856. intersectsTriangle(vertex0: DeepImmutable<Vector3>, vertex1: DeepImmutable<Vector3>, vertex2: DeepImmutable<Vector3>): Nullable<IntersectionInfo>;
  89857. /**
  89858. * Checks if ray intersects a plane
  89859. * @param plane the plane to check
  89860. * @returns the distance away it was hit
  89861. */
  89862. intersectsPlane(plane: DeepImmutable<Plane>): Nullable<number>;
  89863. /**
  89864. * Calculate the intercept of a ray on a given axis
  89865. * @param axis to check 'x' | 'y' | 'z'
  89866. * @param offset from axis interception (i.e. an offset of 1y is intercepted above ground)
  89867. * @returns a vector containing the coordinates where 'axis' is equal to zero (else offset), or null if there is no intercept.
  89868. */
  89869. intersectsAxis(axis: string, offset?: number): Nullable<Vector3>;
  89870. /**
  89871. * Checks if ray intersects a mesh
  89872. * @param mesh the mesh to check
  89873. * @param fastCheck defines if the first intersection will be used (and not the closest)
  89874. * @returns picking info of the intersecton
  89875. */
  89876. intersectsMesh(mesh: DeepImmutable<AbstractMesh>, fastCheck?: boolean): PickingInfo;
  89877. /**
  89878. * Checks if ray intersects a mesh
  89879. * @param meshes the meshes to check
  89880. * @param fastCheck defines if the first intersection will be used (and not the closest)
  89881. * @param results array to store result in
  89882. * @returns Array of picking infos
  89883. */
  89884. intersectsMeshes(meshes: Array<DeepImmutable<AbstractMesh>>, fastCheck?: boolean, results?: Array<PickingInfo>): Array<PickingInfo>;
  89885. private _comparePickingInfo;
  89886. private static smallnum;
  89887. private static rayl;
  89888. /**
  89889. * Intersection test between the ray and a given segment whithin a given tolerance (threshold)
  89890. * @param sega the first point of the segment to test the intersection against
  89891. * @param segb the second point of the segment to test the intersection against
  89892. * @param threshold the tolerance margin, if the ray doesn't intersect the segment but is close to the given threshold, the intersection is successful
  89893. * @return the distance from the ray origin to the intersection point if there's intersection, or -1 if there's no intersection
  89894. */
  89895. intersectionSegment(sega: DeepImmutable<Vector3>, segb: DeepImmutable<Vector3>, threshold: number): number;
  89896. /**
  89897. * Update the ray from viewport position
  89898. * @param x position
  89899. * @param y y position
  89900. * @param viewportWidth viewport width
  89901. * @param viewportHeight viewport height
  89902. * @param world world matrix
  89903. * @param view view matrix
  89904. * @param projection projection matrix
  89905. * @returns this ray updated
  89906. */
  89907. update(x: number, y: number, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Ray;
  89908. /**
  89909. * Creates a ray with origin and direction of 0,0,0
  89910. * @returns the new ray
  89911. */
  89912. static Zero(): Ray;
  89913. /**
  89914. * Creates a new ray from screen space and viewport
  89915. * @param x position
  89916. * @param y y position
  89917. * @param viewportWidth viewport width
  89918. * @param viewportHeight viewport height
  89919. * @param world world matrix
  89920. * @param view view matrix
  89921. * @param projection projection matrix
  89922. * @returns new ray
  89923. */
  89924. static CreateNew(x: number, y: number, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Ray;
  89925. /**
  89926. * 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
  89927. * transformed to the given world matrix.
  89928. * @param origin The origin point
  89929. * @param end The end point
  89930. * @param world a matrix to transform the ray to. Default is the identity matrix.
  89931. * @returns the new ray
  89932. */
  89933. static CreateNewFromTo(origin: Vector3, end: Vector3, world?: DeepImmutable<Matrix>): Ray;
  89934. /**
  89935. * Transforms a ray by a matrix
  89936. * @param ray ray to transform
  89937. * @param matrix matrix to apply
  89938. * @returns the resulting new ray
  89939. */
  89940. static Transform(ray: DeepImmutable<Ray>, matrix: DeepImmutable<Matrix>): Ray;
  89941. /**
  89942. * Transforms a ray by a matrix
  89943. * @param ray ray to transform
  89944. * @param matrix matrix to apply
  89945. * @param result ray to store result in
  89946. */
  89947. static TransformToRef(ray: DeepImmutable<Ray>, matrix: DeepImmutable<Matrix>, result: Ray): void;
  89948. /**
  89949. * Unproject a ray from screen space to object space
  89950. * @param sourceX defines the screen space x coordinate to use
  89951. * @param sourceY defines the screen space y coordinate to use
  89952. * @param viewportWidth defines the current width of the viewport
  89953. * @param viewportHeight defines the current height of the viewport
  89954. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  89955. * @param view defines the view matrix to use
  89956. * @param projection defines the projection matrix to use
  89957. */
  89958. unprojectRayToRef(sourceX: float, sourceY: float, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): void;
  89959. }
  89960. /**
  89961. * Type used to define predicate used to select faces when a mesh intersection is detected
  89962. */
  89963. export type TrianglePickingPredicate = (p0: Vector3, p1: Vector3, p2: Vector3, ray: Ray) => boolean;
  89964. interface Scene {
  89965. /** @hidden */
  89966. _tempPickingRay: Nullable<Ray>;
  89967. /** @hidden */
  89968. _cachedRayForTransform: Ray;
  89969. /** @hidden */
  89970. _pickWithRayInverseMatrix: Matrix;
  89971. /** @hidden */
  89972. _internalPick(rayFunction: (world: Matrix) => Ray, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, onlyBoundingInfo?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  89973. /** @hidden */
  89974. _internalMultiPick(rayFunction: (world: Matrix) => Ray, predicate?: (mesh: AbstractMesh) => boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  89975. /** @hidden */
  89976. _internalPickForMesh(pickingInfo: Nullable<PickingInfo>, rayFunction: (world: Matrix) => Ray, mesh: AbstractMesh, world: Matrix, fastCheck?: boolean, onlyBoundingInfo?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  89977. }
  89978. }
  89979. declare module BABYLON {
  89980. /**
  89981. * Groups all the scene component constants in one place to ease maintenance.
  89982. * @hidden
  89983. */
  89984. export class SceneComponentConstants {
  89985. static readonly NAME_EFFECTLAYER: string;
  89986. static readonly NAME_LAYER: string;
  89987. static readonly NAME_LENSFLARESYSTEM: string;
  89988. static readonly NAME_BOUNDINGBOXRENDERER: string;
  89989. static readonly NAME_PARTICLESYSTEM: string;
  89990. static readonly NAME_GAMEPAD: string;
  89991. static readonly NAME_SIMPLIFICATIONQUEUE: string;
  89992. static readonly NAME_GEOMETRYBUFFERRENDERER: string;
  89993. static readonly NAME_PREPASSRENDERER: string;
  89994. static readonly NAME_DEPTHRENDERER: string;
  89995. static readonly NAME_POSTPROCESSRENDERPIPELINEMANAGER: string;
  89996. static readonly NAME_SPRITE: string;
  89997. static readonly NAME_OUTLINERENDERER: string;
  89998. static readonly NAME_PROCEDURALTEXTURE: string;
  89999. static readonly NAME_SHADOWGENERATOR: string;
  90000. static readonly NAME_OCTREE: string;
  90001. static readonly NAME_PHYSICSENGINE: string;
  90002. static readonly NAME_AUDIO: string;
  90003. static readonly STEP_ISREADYFORMESH_EFFECTLAYER: number;
  90004. static readonly STEP_BEFOREEVALUATEACTIVEMESH_BOUNDINGBOXRENDERER: number;
  90005. static readonly STEP_EVALUATESUBMESH_BOUNDINGBOXRENDERER: number;
  90006. static readonly STEP_ACTIVEMESH_BOUNDINGBOXRENDERER: number;
  90007. static readonly STEP_CAMERADRAWRENDERTARGET_EFFECTLAYER: number;
  90008. static readonly STEP_BEFORECAMERADRAW_EFFECTLAYER: number;
  90009. static readonly STEP_BEFORECAMERADRAW_LAYER: number;
  90010. static readonly STEP_BEFORECAMERADRAW_PREPASS: number;
  90011. static readonly STEP_BEFORERENDERTARGETDRAW_LAYER: number;
  90012. static readonly STEP_BEFORERENDERINGMESH_OUTLINE: number;
  90013. static readonly STEP_AFTERRENDERINGMESH_OUTLINE: number;
  90014. static readonly STEP_AFTERRENDERINGGROUPDRAW_EFFECTLAYER_DRAW: number;
  90015. static readonly STEP_AFTERRENDERINGGROUPDRAW_BOUNDINGBOXRENDERER: number;
  90016. static readonly STEP_BEFORECAMERAUPDATE_SIMPLIFICATIONQUEUE: number;
  90017. static readonly STEP_BEFORECAMERAUPDATE_GAMEPAD: number;
  90018. static readonly STEP_BEFORECLEAR_PROCEDURALTEXTURE: number;
  90019. static readonly STEP_AFTERRENDERTARGETDRAW_LAYER: number;
  90020. static readonly STEP_AFTERCAMERADRAW_EFFECTLAYER: number;
  90021. static readonly STEP_AFTERCAMERADRAW_LENSFLARESYSTEM: number;
  90022. static readonly STEP_AFTERCAMERADRAW_EFFECTLAYER_DRAW: number;
  90023. static readonly STEP_AFTERCAMERADRAW_LAYER: number;
  90024. static readonly STEP_AFTERCAMERADRAW_PREPASS: number;
  90025. static readonly STEP_AFTERRENDER_AUDIO: number;
  90026. static readonly STEP_GATHERRENDERTARGETS_DEPTHRENDERER: number;
  90027. static readonly STEP_GATHERRENDERTARGETS_GEOMETRYBUFFERRENDERER: number;
  90028. static readonly STEP_GATHERRENDERTARGETS_SHADOWGENERATOR: number;
  90029. static readonly STEP_GATHERRENDERTARGETS_POSTPROCESSRENDERPIPELINEMANAGER: number;
  90030. static readonly STEP_GATHERACTIVECAMERARENDERTARGETS_DEPTHRENDERER: number;
  90031. static readonly STEP_BEFORECLEARSTAGE_PREPASS: number;
  90032. static readonly STEP_POINTERMOVE_SPRITE: number;
  90033. static readonly STEP_POINTERDOWN_SPRITE: number;
  90034. static readonly STEP_POINTERUP_SPRITE: number;
  90035. }
  90036. /**
  90037. * This represents a scene component.
  90038. *
  90039. * This is used to decouple the dependency the scene is having on the different workloads like
  90040. * layers, post processes...
  90041. */
  90042. export interface ISceneComponent {
  90043. /**
  90044. * The name of the component. Each component must have a unique name.
  90045. */
  90046. name: string;
  90047. /**
  90048. * The scene the component belongs to.
  90049. */
  90050. scene: Scene;
  90051. /**
  90052. * Register the component to one instance of a scene.
  90053. */
  90054. register(): void;
  90055. /**
  90056. * Rebuilds the elements related to this component in case of
  90057. * context lost for instance.
  90058. */
  90059. rebuild(): void;
  90060. /**
  90061. * Disposes the component and the associated ressources.
  90062. */
  90063. dispose(): void;
  90064. }
  90065. /**
  90066. * This represents a SERIALIZABLE scene component.
  90067. *
  90068. * This extends Scene Component to add Serialization methods on top.
  90069. */
  90070. export interface ISceneSerializableComponent extends ISceneComponent {
  90071. /**
  90072. * Adds all the elements from the container to the scene
  90073. * @param container the container holding the elements
  90074. */
  90075. addFromContainer(container: AbstractScene): void;
  90076. /**
  90077. * Removes all the elements in the container from the scene
  90078. * @param container contains the elements to remove
  90079. * @param dispose if the removed element should be disposed (default: false)
  90080. */
  90081. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  90082. /**
  90083. * Serializes the component data to the specified json object
  90084. * @param serializationObject The object to serialize to
  90085. */
  90086. serialize(serializationObject: any): void;
  90087. }
  90088. /**
  90089. * Strong typing of a Mesh related stage step action
  90090. */
  90091. export type MeshStageAction = (mesh: AbstractMesh, hardwareInstancedRendering: boolean) => boolean;
  90092. /**
  90093. * Strong typing of a Evaluate Sub Mesh related stage step action
  90094. */
  90095. export type EvaluateSubMeshStageAction = (mesh: AbstractMesh, subMesh: SubMesh) => void;
  90096. /**
  90097. * Strong typing of a Active Mesh related stage step action
  90098. */
  90099. export type ActiveMeshStageAction = (sourceMesh: AbstractMesh, mesh: AbstractMesh) => void;
  90100. /**
  90101. * Strong typing of a Camera related stage step action
  90102. */
  90103. export type CameraStageAction = (camera: Camera) => void;
  90104. /**
  90105. * Strong typing of a Camera Frame buffer related stage step action
  90106. */
  90107. export type CameraStageFrameBufferAction = (camera: Camera) => boolean;
  90108. /**
  90109. * Strong typing of a Render Target related stage step action
  90110. */
  90111. export type RenderTargetStageAction = (renderTarget: RenderTargetTexture) => void;
  90112. /**
  90113. * Strong typing of a RenderingGroup related stage step action
  90114. */
  90115. export type RenderingGroupStageAction = (renderingGroupId: number) => void;
  90116. /**
  90117. * Strong typing of a Mesh Render related stage step action
  90118. */
  90119. export type RenderingMeshStageAction = (mesh: Mesh, subMesh: SubMesh, batch: _InstancesBatch) => void;
  90120. /**
  90121. * Strong typing of a simple stage step action
  90122. */
  90123. export type SimpleStageAction = () => void;
  90124. /**
  90125. * Strong typing of a render target action.
  90126. */
  90127. export type RenderTargetsStageAction = (renderTargets: SmartArrayNoDuplicate<RenderTargetTexture>) => void;
  90128. /**
  90129. * Strong typing of a pointer move action.
  90130. */
  90131. export type PointerMoveStageAction = (unTranslatedPointerX: number, unTranslatedPointerY: number, pickResult: Nullable<PickingInfo>, isMeshPicked: boolean, element: HTMLElement) => Nullable<PickingInfo>;
  90132. /**
  90133. * Strong typing of a pointer up/down action.
  90134. */
  90135. export type PointerUpDownStageAction = (unTranslatedPointerX: number, unTranslatedPointerY: number, pickResult: Nullable<PickingInfo>, evt: PointerEvent) => Nullable<PickingInfo>;
  90136. /**
  90137. * Representation of a stage in the scene (Basically a list of ordered steps)
  90138. * @hidden
  90139. */
  90140. export class Stage<T extends Function> extends Array<{
  90141. index: number;
  90142. component: ISceneComponent;
  90143. action: T;
  90144. }> {
  90145. /**
  90146. * Hide ctor from the rest of the world.
  90147. * @param items The items to add.
  90148. */
  90149. private constructor();
  90150. /**
  90151. * Creates a new Stage.
  90152. * @returns A new instance of a Stage
  90153. */
  90154. static Create<T extends Function>(): Stage<T>;
  90155. /**
  90156. * Registers a step in an ordered way in the targeted stage.
  90157. * @param index Defines the position to register the step in
  90158. * @param component Defines the component attached to the step
  90159. * @param action Defines the action to launch during the step
  90160. */
  90161. registerStep(index: number, component: ISceneComponent, action: T): void;
  90162. /**
  90163. * Clears all the steps from the stage.
  90164. */
  90165. clear(): void;
  90166. }
  90167. }
  90168. declare module BABYLON {
  90169. interface Scene {
  90170. /** @hidden */
  90171. _pointerOverSprite: Nullable<Sprite>;
  90172. /** @hidden */
  90173. _pickedDownSprite: Nullable<Sprite>;
  90174. /** @hidden */
  90175. _tempSpritePickingRay: Nullable<Ray>;
  90176. /**
  90177. * All of the sprite managers added to this scene
  90178. * @see https://doc.babylonjs.com/babylon101/sprites
  90179. */
  90180. spriteManagers: Array<ISpriteManager>;
  90181. /**
  90182. * An event triggered when sprites rendering is about to start
  90183. * Note: This event can be trigger more than once per frame (because sprites can be rendered by render target textures as well)
  90184. */
  90185. onBeforeSpritesRenderingObservable: Observable<Scene>;
  90186. /**
  90187. * An event triggered when sprites rendering is done
  90188. * Note: This event can be trigger more than once per frame (because sprites can be rendered by render target textures as well)
  90189. */
  90190. onAfterSpritesRenderingObservable: Observable<Scene>;
  90191. /** @hidden */
  90192. _internalPickSprites(ray: Ray, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  90193. /** Launch a ray to try to pick a sprite in the scene
  90194. * @param x position on screen
  90195. * @param y position on screen
  90196. * @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
  90197. * @param fastCheck defines if the first intersection will be used (and not the closest)
  90198. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  90199. * @returns a PickingInfo
  90200. */
  90201. pickSprite(x: number, y: number, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  90202. /** Use the given ray to pick a sprite in the scene
  90203. * @param ray The ray (in world space) to use to pick meshes
  90204. * @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
  90205. * @param fastCheck defines if the first intersection will be used (and not the closest)
  90206. * @param camera camera to use. Can be set to null. In this case, the scene.activeCamera will be used
  90207. * @returns a PickingInfo
  90208. */
  90209. pickSpriteWithRay(ray: Ray, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  90210. /** @hidden */
  90211. _internalMultiPickSprites(ray: Ray, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  90212. /** Launch a ray to try to pick sprites in the scene
  90213. * @param x position on screen
  90214. * @param y position on screen
  90215. * @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
  90216. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  90217. * @returns a PickingInfo array
  90218. */
  90219. multiPickSprite(x: number, y: number, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  90220. /** Use the given ray to pick sprites in the scene
  90221. * @param ray The ray (in world space) to use to pick meshes
  90222. * @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
  90223. * @param camera camera to use. Can be set to null. In this case, the scene.activeCamera will be used
  90224. * @returns a PickingInfo array
  90225. */
  90226. multiPickSpriteWithRay(ray: Ray, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  90227. /**
  90228. * Force the sprite under the pointer
  90229. * @param sprite defines the sprite to use
  90230. */
  90231. setPointerOverSprite(sprite: Nullable<Sprite>): void;
  90232. /**
  90233. * Gets the sprite under the pointer
  90234. * @returns a Sprite or null if no sprite is under the pointer
  90235. */
  90236. getPointerOverSprite(): Nullable<Sprite>;
  90237. }
  90238. /**
  90239. * Defines the sprite scene component responsible to manage sprites
  90240. * in a given scene.
  90241. */
  90242. export class SpriteSceneComponent implements ISceneComponent {
  90243. /**
  90244. * The component name helpfull to identify the component in the list of scene components.
  90245. */
  90246. readonly name: string;
  90247. /**
  90248. * The scene the component belongs to.
  90249. */
  90250. scene: Scene;
  90251. /** @hidden */
  90252. private _spritePredicate;
  90253. /**
  90254. * Creates a new instance of the component for the given scene
  90255. * @param scene Defines the scene to register the component in
  90256. */
  90257. constructor(scene: Scene);
  90258. /**
  90259. * Registers the component in a given scene
  90260. */
  90261. register(): void;
  90262. /**
  90263. * Rebuilds the elements related to this component in case of
  90264. * context lost for instance.
  90265. */
  90266. rebuild(): void;
  90267. /**
  90268. * Disposes the component and the associated ressources.
  90269. */
  90270. dispose(): void;
  90271. private _pickSpriteButKeepRay;
  90272. private _pointerMove;
  90273. private _pointerDown;
  90274. private _pointerUp;
  90275. }
  90276. }
  90277. declare module BABYLON {
  90278. /** @hidden */
  90279. export var fogFragmentDeclaration: {
  90280. name: string;
  90281. shader: string;
  90282. };
  90283. }
  90284. declare module BABYLON {
  90285. /** @hidden */
  90286. export var fogFragment: {
  90287. name: string;
  90288. shader: string;
  90289. };
  90290. }
  90291. declare module BABYLON {
  90292. /** @hidden */
  90293. export var spritesPixelShader: {
  90294. name: string;
  90295. shader: string;
  90296. };
  90297. }
  90298. declare module BABYLON {
  90299. /** @hidden */
  90300. export var fogVertexDeclaration: {
  90301. name: string;
  90302. shader: string;
  90303. };
  90304. }
  90305. declare module BABYLON {
  90306. /** @hidden */
  90307. export var spritesVertexShader: {
  90308. name: string;
  90309. shader: string;
  90310. };
  90311. }
  90312. declare module BABYLON {
  90313. /**
  90314. * Defines the minimum interface to fullfil in order to be a sprite manager.
  90315. */
  90316. export interface ISpriteManager extends IDisposable {
  90317. /**
  90318. * Gets manager's name
  90319. */
  90320. name: string;
  90321. /**
  90322. * Restricts the camera to viewing objects with the same layerMask.
  90323. * A camera with a layerMask of 1 will render spriteManager.layerMask & camera.layerMask!== 0
  90324. */
  90325. layerMask: number;
  90326. /**
  90327. * Gets or sets a boolean indicating if the mesh can be picked (by scene.pick for instance or through actions). Default is true
  90328. */
  90329. isPickable: boolean;
  90330. /**
  90331. * Gets the hosting scene
  90332. */
  90333. scene: Scene;
  90334. /**
  90335. * Specifies the rendering group id for this mesh (0 by default)
  90336. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#rendering-groups
  90337. */
  90338. renderingGroupId: number;
  90339. /**
  90340. * Defines the list of sprites managed by the manager.
  90341. */
  90342. sprites: Array<Sprite>;
  90343. /**
  90344. * Gets or sets the spritesheet texture
  90345. */
  90346. texture: Texture;
  90347. /** Defines the default width of a cell in the spritesheet */
  90348. cellWidth: number;
  90349. /** Defines the default height of a cell in the spritesheet */
  90350. cellHeight: number;
  90351. /**
  90352. * Tests the intersection of a sprite with a specific ray.
  90353. * @param ray The ray we are sending to test the collision
  90354. * @param camera The camera space we are sending rays in
  90355. * @param predicate A predicate allowing excluding sprites from the list of object to test
  90356. * @param fastCheck defines if the first intersection will be used (and not the closest)
  90357. * @returns picking info or null.
  90358. */
  90359. intersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean): Nullable<PickingInfo>;
  90360. /**
  90361. * Intersects the sprites with a ray
  90362. * @param ray defines the ray to intersect with
  90363. * @param camera defines the current active camera
  90364. * @param predicate defines a predicate used to select candidate sprites
  90365. * @returns null if no hit or a PickingInfo array
  90366. */
  90367. multiIntersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean): Nullable<PickingInfo[]>;
  90368. /**
  90369. * Renders the list of sprites on screen.
  90370. */
  90371. render(): void;
  90372. }
  90373. /**
  90374. * Class used to manage multiple sprites on the same spritesheet
  90375. * @see https://doc.babylonjs.com/babylon101/sprites
  90376. */
  90377. export class SpriteManager implements ISpriteManager {
  90378. /** defines the manager's name */
  90379. name: string;
  90380. /** Define the Url to load snippets */
  90381. static SnippetUrl: string;
  90382. /** Snippet ID if the manager was created from the snippet server */
  90383. snippetId: string;
  90384. /** Gets the list of sprites */
  90385. sprites: Sprite[];
  90386. /** Gets or sets the rendering group id (0 by default) */
  90387. renderingGroupId: number;
  90388. /** Gets or sets camera layer mask */
  90389. layerMask: number;
  90390. /** Gets or sets a boolean indicating if the manager must consider scene fog when rendering */
  90391. fogEnabled: boolean;
  90392. /** Gets or sets a boolean indicating if the sprites are pickable */
  90393. isPickable: boolean;
  90394. /** Defines the default width of a cell in the spritesheet */
  90395. cellWidth: number;
  90396. /** Defines the default height of a cell in the spritesheet */
  90397. cellHeight: number;
  90398. /** Associative array from JSON sprite data file */
  90399. private _cellData;
  90400. /** Array of sprite names from JSON sprite data file */
  90401. private _spriteMap;
  90402. /** True when packed cell data from JSON file is ready*/
  90403. private _packedAndReady;
  90404. private _textureContent;
  90405. private _useInstancing;
  90406. /**
  90407. * An event triggered when the manager is disposed.
  90408. */
  90409. onDisposeObservable: Observable<SpriteManager>;
  90410. private _onDisposeObserver;
  90411. /**
  90412. * Callback called when the manager is disposed
  90413. */
  90414. set onDispose(callback: () => void);
  90415. private _capacity;
  90416. private _fromPacked;
  90417. private _spriteTexture;
  90418. private _epsilon;
  90419. private _scene;
  90420. private _vertexData;
  90421. private _buffer;
  90422. private _vertexBuffers;
  90423. private _spriteBuffer;
  90424. private _indexBuffer;
  90425. private _effectBase;
  90426. private _effectFog;
  90427. private _vertexBufferSize;
  90428. /**
  90429. * Gets or sets the unique id of the sprite
  90430. */
  90431. uniqueId: number;
  90432. /**
  90433. * Gets the array of sprites
  90434. */
  90435. get children(): Sprite[];
  90436. /**
  90437. * Gets the hosting scene
  90438. */
  90439. get scene(): Scene;
  90440. /**
  90441. * Gets the capacity of the manager
  90442. */
  90443. get capacity(): number;
  90444. /**
  90445. * Gets or sets the spritesheet texture
  90446. */
  90447. get texture(): Texture;
  90448. set texture(value: Texture);
  90449. private _blendMode;
  90450. /**
  90451. * Blend mode use to render the particle, it can be any of
  90452. * the static Constants.ALPHA_x properties provided in this class.
  90453. * Default value is Constants.ALPHA_COMBINE
  90454. */
  90455. get blendMode(): number;
  90456. set blendMode(blendMode: number);
  90457. /** Disables writing to the depth buffer when rendering the sprites.
  90458. * It can be handy to disable depth writing when using textures without alpha channel
  90459. * and setting some specific blend modes.
  90460. */
  90461. disableDepthWrite: boolean;
  90462. /**
  90463. * Creates a new sprite manager
  90464. * @param name defines the manager's name
  90465. * @param imgUrl defines the sprite sheet url
  90466. * @param capacity defines the maximum allowed number of sprites
  90467. * @param cellSize defines the size of a sprite cell
  90468. * @param scene defines the hosting scene
  90469. * @param epsilon defines the epsilon value to align texture (0.01 by default)
  90470. * @param samplingMode defines the smapling mode to use with spritesheet
  90471. * @param fromPacked set to false; do not alter
  90472. * @param spriteJSON null otherwise a JSON object defining sprite sheet data; do not alter
  90473. */
  90474. constructor(
  90475. /** defines the manager's name */
  90476. name: string, imgUrl: string, capacity: number, cellSize: any, scene: Scene, epsilon?: number, samplingMode?: number, fromPacked?: boolean, spriteJSON?: any | null);
  90477. /**
  90478. * Returns the string "SpriteManager"
  90479. * @returns "SpriteManager"
  90480. */
  90481. getClassName(): string;
  90482. private _makePacked;
  90483. private _appendSpriteVertex;
  90484. private _checkTextureAlpha;
  90485. /**
  90486. * Intersects the sprites with a ray
  90487. * @param ray defines the ray to intersect with
  90488. * @param camera defines the current active camera
  90489. * @param predicate defines a predicate used to select candidate sprites
  90490. * @param fastCheck defines if a fast check only must be done (the first potential sprite is will be used and not the closer)
  90491. * @returns null if no hit or a PickingInfo
  90492. */
  90493. intersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean): Nullable<PickingInfo>;
  90494. /**
  90495. * Intersects the sprites with a ray
  90496. * @param ray defines the ray to intersect with
  90497. * @param camera defines the current active camera
  90498. * @param predicate defines a predicate used to select candidate sprites
  90499. * @returns null if no hit or a PickingInfo array
  90500. */
  90501. multiIntersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean): Nullable<PickingInfo[]>;
  90502. /**
  90503. * Render all child sprites
  90504. */
  90505. render(): void;
  90506. /**
  90507. * Release associated resources
  90508. */
  90509. dispose(): void;
  90510. /**
  90511. * Serializes the sprite manager to a JSON object
  90512. * @param serializeTexture defines if the texture must be serialized as well
  90513. * @returns the JSON object
  90514. */
  90515. serialize(serializeTexture?: boolean): any;
  90516. /**
  90517. * Parses a JSON object to create a new sprite manager.
  90518. * @param parsedManager The JSON object to parse
  90519. * @param scene The scene to create the sprite managerin
  90520. * @param rootUrl The root url to use to load external dependencies like texture
  90521. * @returns the new sprite manager
  90522. */
  90523. static Parse(parsedManager: any, scene: Scene, rootUrl: string): SpriteManager;
  90524. /**
  90525. * Creates a sprite manager from a snippet saved in a remote file
  90526. * @param name defines the name of the sprite manager to create (can be null or empty to use the one from the json data)
  90527. * @param url defines the url to load from
  90528. * @param scene defines the hosting scene
  90529. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  90530. * @returns a promise that will resolve to the new sprite manager
  90531. */
  90532. static ParseFromFileAsync(name: Nullable<string>, url: string, scene: Scene, rootUrl?: string): Promise<SpriteManager>;
  90533. /**
  90534. * Creates a sprite manager from a snippet saved by the sprite editor
  90535. * @param snippetId defines the snippet to load (can be set to _BLANK to create a default one)
  90536. * @param scene defines the hosting scene
  90537. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  90538. * @returns a promise that will resolve to the new sprite manager
  90539. */
  90540. static CreateFromSnippetAsync(snippetId: string, scene: Scene, rootUrl?: string): Promise<SpriteManager>;
  90541. }
  90542. }
  90543. declare module BABYLON {
  90544. /** Interface used by value gradients (color, factor, ...) */
  90545. export interface IValueGradient {
  90546. /**
  90547. * Gets or sets the gradient value (between 0 and 1)
  90548. */
  90549. gradient: number;
  90550. }
  90551. /** Class used to store color4 gradient */
  90552. export class ColorGradient implements IValueGradient {
  90553. /**
  90554. * Gets or sets the gradient value (between 0 and 1)
  90555. */
  90556. gradient: number;
  90557. /**
  90558. * Gets or sets first associated color
  90559. */
  90560. color1: Color4;
  90561. /**
  90562. * Gets or sets second associated color
  90563. */
  90564. color2?: Color4 | undefined;
  90565. /**
  90566. * Creates a new color4 gradient
  90567. * @param gradient gets or sets the gradient value (between 0 and 1)
  90568. * @param color1 gets or sets first associated color
  90569. * @param color2 gets or sets first second color
  90570. */
  90571. constructor(
  90572. /**
  90573. * Gets or sets the gradient value (between 0 and 1)
  90574. */
  90575. gradient: number,
  90576. /**
  90577. * Gets or sets first associated color
  90578. */
  90579. color1: Color4,
  90580. /**
  90581. * Gets or sets second associated color
  90582. */
  90583. color2?: Color4 | undefined);
  90584. /**
  90585. * Will get a color picked randomly between color1 and color2.
  90586. * If color2 is undefined then color1 will be used
  90587. * @param result defines the target Color4 to store the result in
  90588. */
  90589. getColorToRef(result: Color4): void;
  90590. }
  90591. /** Class used to store color 3 gradient */
  90592. export class Color3Gradient implements IValueGradient {
  90593. /**
  90594. * Gets or sets the gradient value (between 0 and 1)
  90595. */
  90596. gradient: number;
  90597. /**
  90598. * Gets or sets the associated color
  90599. */
  90600. color: Color3;
  90601. /**
  90602. * Creates a new color3 gradient
  90603. * @param gradient gets or sets the gradient value (between 0 and 1)
  90604. * @param color gets or sets associated color
  90605. */
  90606. constructor(
  90607. /**
  90608. * Gets or sets the gradient value (between 0 and 1)
  90609. */
  90610. gradient: number,
  90611. /**
  90612. * Gets or sets the associated color
  90613. */
  90614. color: Color3);
  90615. }
  90616. /** Class used to store factor gradient */
  90617. export class FactorGradient implements IValueGradient {
  90618. /**
  90619. * Gets or sets the gradient value (between 0 and 1)
  90620. */
  90621. gradient: number;
  90622. /**
  90623. * Gets or sets first associated factor
  90624. */
  90625. factor1: number;
  90626. /**
  90627. * Gets or sets second associated factor
  90628. */
  90629. factor2?: number | undefined;
  90630. /**
  90631. * Creates a new factor gradient
  90632. * @param gradient gets or sets the gradient value (between 0 and 1)
  90633. * @param factor1 gets or sets first associated factor
  90634. * @param factor2 gets or sets second associated factor
  90635. */
  90636. constructor(
  90637. /**
  90638. * Gets or sets the gradient value (between 0 and 1)
  90639. */
  90640. gradient: number,
  90641. /**
  90642. * Gets or sets first associated factor
  90643. */
  90644. factor1: number,
  90645. /**
  90646. * Gets or sets second associated factor
  90647. */
  90648. factor2?: number | undefined);
  90649. /**
  90650. * Will get a number picked randomly between factor1 and factor2.
  90651. * If factor2 is undefined then factor1 will be used
  90652. * @returns the picked number
  90653. */
  90654. getFactor(): number;
  90655. }
  90656. /**
  90657. * Helper used to simplify some generic gradient tasks
  90658. */
  90659. export class GradientHelper {
  90660. /**
  90661. * Gets the current gradient from an array of IValueGradient
  90662. * @param ratio defines the current ratio to get
  90663. * @param gradients defines the array of IValueGradient
  90664. * @param updateFunc defines the callback function used to get the final value from the selected gradients
  90665. */
  90666. static GetCurrentGradient(ratio: number, gradients: IValueGradient[], updateFunc: (current: IValueGradient, next: IValueGradient, scale: number) => void): void;
  90667. }
  90668. }
  90669. declare module BABYLON {
  90670. interface ThinEngine {
  90671. /**
  90672. * Creates a raw texture
  90673. * @param data defines the data to store in the texture
  90674. * @param width defines the width of the texture
  90675. * @param height defines the height of the texture
  90676. * @param format defines the format of the data
  90677. * @param generateMipMaps defines if the engine should generate the mip levels
  90678. * @param invertY defines if data must be stored with Y axis inverted
  90679. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  90680. * @param compression defines the compression used (null by default)
  90681. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  90682. * @returns the raw texture inside an InternalTexture
  90683. */
  90684. createRawTexture(data: Nullable<ArrayBufferView>, width: number, height: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, type: number): InternalTexture;
  90685. /**
  90686. * Update a raw texture
  90687. * @param texture defines the texture to update
  90688. * @param data defines the data to store in the texture
  90689. * @param format defines the format of the data
  90690. * @param invertY defines if data must be stored with Y axis inverted
  90691. */
  90692. updateRawTexture(texture: Nullable<InternalTexture>, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  90693. /**
  90694. * Update a raw texture
  90695. * @param texture defines the texture to update
  90696. * @param data defines the data to store in the texture
  90697. * @param format defines the format of the data
  90698. * @param invertY defines if data must be stored with Y axis inverted
  90699. * @param compression defines the compression used (null by default)
  90700. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  90701. */
  90702. updateRawTexture(texture: Nullable<InternalTexture>, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, type: number): void;
  90703. /**
  90704. * Creates a new raw cube texture
  90705. * @param data defines the array of data to use to create each face
  90706. * @param size defines the size of the textures
  90707. * @param format defines the format of the data
  90708. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  90709. * @param generateMipMaps defines if the engine should generate the mip levels
  90710. * @param invertY defines if data must be stored with Y axis inverted
  90711. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  90712. * @param compression defines the compression used (null by default)
  90713. * @returns the cube texture as an InternalTexture
  90714. */
  90715. createRawCubeTexture(data: Nullable<ArrayBufferView[]>, size: number, format: number, type: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>): InternalTexture;
  90716. /**
  90717. * Update a raw cube texture
  90718. * @param texture defines the texture to udpdate
  90719. * @param data defines the data to store
  90720. * @param format defines the data format
  90721. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  90722. * @param invertY defines if data must be stored with Y axis inverted
  90723. */
  90724. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean): void;
  90725. /**
  90726. * Update a raw cube texture
  90727. * @param texture defines the texture to udpdate
  90728. * @param data defines the data to store
  90729. * @param format defines the data format
  90730. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  90731. * @param invertY defines if data must be stored with Y axis inverted
  90732. * @param compression defines the compression used (null by default)
  90733. */
  90734. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression: Nullable<string>): void;
  90735. /**
  90736. * Update a raw cube texture
  90737. * @param texture defines the texture to udpdate
  90738. * @param data defines the data to store
  90739. * @param format defines the data format
  90740. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  90741. * @param invertY defines if data must be stored with Y axis inverted
  90742. * @param compression defines the compression used (null by default)
  90743. * @param level defines which level of the texture to update
  90744. */
  90745. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression: Nullable<string>, level: number): void;
  90746. /**
  90747. * Creates a new raw cube texture from a specified url
  90748. * @param url defines the url where the data is located
  90749. * @param scene defines the current scene
  90750. * @param size defines the size of the textures
  90751. * @param format defines the format of the data
  90752. * @param type defines the type fo the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  90753. * @param noMipmap defines if the engine should avoid generating the mip levels
  90754. * @param callback defines a callback used to extract texture data from loaded data
  90755. * @param mipmapGenerator defines to provide an optional tool to generate mip levels
  90756. * @param onLoad defines a callback called when texture is loaded
  90757. * @param onError defines a callback called if there is an error
  90758. * @returns the cube texture as an InternalTexture
  90759. */
  90760. 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;
  90761. /**
  90762. * Creates a new raw cube texture from a specified url
  90763. * @param url defines the url where the data is located
  90764. * @param scene defines the current scene
  90765. * @param size defines the size of the textures
  90766. * @param format defines the format of the data
  90767. * @param type defines the type fo the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  90768. * @param noMipmap defines if the engine should avoid generating the mip levels
  90769. * @param callback defines a callback used to extract texture data from loaded data
  90770. * @param mipmapGenerator defines to provide an optional tool to generate mip levels
  90771. * @param onLoad defines a callback called when texture is loaded
  90772. * @param onError defines a callback called if there is an error
  90773. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  90774. * @param invertY defines if data must be stored with Y axis inverted
  90775. * @returns the cube texture as an InternalTexture
  90776. */
  90777. 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;
  90778. /**
  90779. * Creates a new raw 3D texture
  90780. * @param data defines the data used to create the texture
  90781. * @param width defines the width of the texture
  90782. * @param height defines the height of the texture
  90783. * @param depth defines the depth of the texture
  90784. * @param format defines the format of the texture
  90785. * @param generateMipMaps defines if the engine must generate mip levels
  90786. * @param invertY defines if data must be stored with Y axis inverted
  90787. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  90788. * @param compression defines the compressed used (can be null)
  90789. * @param textureType defines the compressed used (can be null)
  90790. * @returns a new raw 3D texture (stored in an InternalTexture)
  90791. */
  90792. createRawTexture3D(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, textureType: number): InternalTexture;
  90793. /**
  90794. * Update a raw 3D texture
  90795. * @param texture defines the texture to update
  90796. * @param data defines the data to store
  90797. * @param format defines the data format
  90798. * @param invertY defines if data must be stored with Y axis inverted
  90799. */
  90800. updateRawTexture3D(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  90801. /**
  90802. * Update a raw 3D texture
  90803. * @param texture defines the texture to update
  90804. * @param data defines the data to store
  90805. * @param format defines the data format
  90806. * @param invertY defines if data must be stored with Y axis inverted
  90807. * @param compression defines the used compression (can be null)
  90808. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  90809. */
  90810. updateRawTexture3D(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, textureType: number): void;
  90811. /**
  90812. * Creates a new raw 2D array texture
  90813. * @param data defines the data used to create the texture
  90814. * @param width defines the width of the texture
  90815. * @param height defines the height of the texture
  90816. * @param depth defines the number of layers of the texture
  90817. * @param format defines the format of the texture
  90818. * @param generateMipMaps defines if the engine must generate mip levels
  90819. * @param invertY defines if data must be stored with Y axis inverted
  90820. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  90821. * @param compression defines the compressed used (can be null)
  90822. * @param textureType defines the compressed used (can be null)
  90823. * @returns a new raw 2D array texture (stored in an InternalTexture)
  90824. */
  90825. createRawTexture2DArray(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, textureType: number): InternalTexture;
  90826. /**
  90827. * Update a raw 2D array texture
  90828. * @param texture defines the texture to update
  90829. * @param data defines the data to store
  90830. * @param format defines the data format
  90831. * @param invertY defines if data must be stored with Y axis inverted
  90832. */
  90833. updateRawTexture2DArray(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  90834. /**
  90835. * Update a raw 2D array texture
  90836. * @param texture defines the texture to update
  90837. * @param data defines the data to store
  90838. * @param format defines the data format
  90839. * @param invertY defines if data must be stored with Y axis inverted
  90840. * @param compression defines the used compression (can be null)
  90841. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  90842. */
  90843. updateRawTexture2DArray(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, textureType: number): void;
  90844. }
  90845. }
  90846. declare module BABYLON {
  90847. /**
  90848. * Raw texture can help creating a texture directly from an array of data.
  90849. * This can be super useful if you either get the data from an uncompressed source or
  90850. * if you wish to create your texture pixel by pixel.
  90851. */
  90852. export class RawTexture extends Texture {
  90853. /**
  90854. * Define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  90855. */
  90856. format: number;
  90857. /**
  90858. * Instantiates a new RawTexture.
  90859. * Raw texture can help creating a texture directly from an array of data.
  90860. * This can be super useful if you either get the data from an uncompressed source or
  90861. * if you wish to create your texture pixel by pixel.
  90862. * @param data define the array of data to use to create the texture
  90863. * @param width define the width of the texture
  90864. * @param height define the height of the texture
  90865. * @param format define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  90866. * @param sceneOrEngine defines the scene or engine the texture will belong to
  90867. * @param generateMipMaps define whether mip maps should be generated or not
  90868. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  90869. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  90870. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  90871. */
  90872. constructor(data: ArrayBufferView, width: number, height: number,
  90873. /**
  90874. * Define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  90875. */
  90876. format: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number);
  90877. /**
  90878. * Updates the texture underlying data.
  90879. * @param data Define the new data of the texture
  90880. */
  90881. update(data: ArrayBufferView): void;
  90882. /**
  90883. * Creates a luminance texture from some data.
  90884. * @param data Define the texture data
  90885. * @param width Define the width of the texture
  90886. * @param height Define the height of the texture
  90887. * @param sceneOrEngine defines the scene or engine the texture will belong to
  90888. * @param generateMipMaps Define whether or not to create mip maps for the texture
  90889. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  90890. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  90891. * @returns the luminance texture
  90892. */
  90893. static CreateLuminanceTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  90894. /**
  90895. * Creates a luminance alpha texture from some data.
  90896. * @param data Define the texture data
  90897. * @param width Define the width of the texture
  90898. * @param height Define the height of the texture
  90899. * @param sceneOrEngine defines the scene or engine the texture will belong to
  90900. * @param generateMipMaps Define whether or not to create mip maps for the texture
  90901. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  90902. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  90903. * @returns the luminance alpha texture
  90904. */
  90905. static CreateLuminanceAlphaTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  90906. /**
  90907. * Creates an alpha texture from some data.
  90908. * @param data Define the texture data
  90909. * @param width Define the width of the texture
  90910. * @param height Define the height of the texture
  90911. * @param sceneOrEngine defines the scene or engine the texture will belong to
  90912. * @param generateMipMaps Define whether or not to create mip maps for the texture
  90913. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  90914. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  90915. * @returns the alpha texture
  90916. */
  90917. static CreateAlphaTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  90918. /**
  90919. * Creates a RGB texture from some data.
  90920. * @param data Define the texture data
  90921. * @param width Define the width of the texture
  90922. * @param height Define the height of the texture
  90923. * @param sceneOrEngine defines the scene or engine the texture will belong to
  90924. * @param generateMipMaps Define whether or not to create mip maps for the texture
  90925. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  90926. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  90927. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  90928. * @returns the RGB alpha texture
  90929. */
  90930. static CreateRGBTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  90931. /**
  90932. * Creates a RGBA texture from some data.
  90933. * @param data Define the texture data
  90934. * @param width Define the width of the texture
  90935. * @param height Define the height of the texture
  90936. * @param sceneOrEngine defines the scene or engine the texture will belong to
  90937. * @param generateMipMaps Define whether or not to create mip maps for the texture
  90938. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  90939. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  90940. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  90941. * @returns the RGBA texture
  90942. */
  90943. static CreateRGBATexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  90944. /**
  90945. * Creates a R texture from some data.
  90946. * @param data Define the texture data
  90947. * @param width Define the width of the texture
  90948. * @param height Define the height of the texture
  90949. * @param sceneOrEngine defines the scene or engine the texture will belong to
  90950. * @param generateMipMaps Define whether or not to create mip maps for the texture
  90951. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  90952. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  90953. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  90954. * @returns the R texture
  90955. */
  90956. static CreateRTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  90957. }
  90958. }
  90959. declare module BABYLON {
  90960. interface ThinEngine {
  90961. /**
  90962. * Update a dynamic index buffer
  90963. * @param indexBuffer defines the target index buffer
  90964. * @param indices defines the data to update
  90965. * @param offset defines the offset in the target index buffer where update should start
  90966. */
  90967. updateDynamicIndexBuffer(indexBuffer: DataBuffer, indices: IndicesArray, offset?: number): void;
  90968. /**
  90969. * Updates a dynamic vertex buffer.
  90970. * @param vertexBuffer the vertex buffer to update
  90971. * @param data the data used to update the vertex buffer
  90972. * @param byteOffset the byte offset of the data
  90973. * @param byteLength the byte length of the data
  90974. */
  90975. updateDynamicVertexBuffer(vertexBuffer: DataBuffer, data: DataArray, byteOffset?: number, byteLength?: number): void;
  90976. }
  90977. }
  90978. declare module BABYLON {
  90979. interface AbstractScene {
  90980. /**
  90981. * The list of procedural textures added to the scene
  90982. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  90983. */
  90984. proceduralTextures: Array<ProceduralTexture>;
  90985. }
  90986. /**
  90987. * Defines the Procedural Texture scene component responsible to manage any Procedural Texture
  90988. * in a given scene.
  90989. */
  90990. export class ProceduralTextureSceneComponent implements ISceneComponent {
  90991. /**
  90992. * The component name helpfull to identify the component in the list of scene components.
  90993. */
  90994. readonly name: string;
  90995. /**
  90996. * The scene the component belongs to.
  90997. */
  90998. scene: Scene;
  90999. /**
  91000. * Creates a new instance of the component for the given scene
  91001. * @param scene Defines the scene to register the component in
  91002. */
  91003. constructor(scene: Scene);
  91004. /**
  91005. * Registers the component in a given scene
  91006. */
  91007. register(): void;
  91008. /**
  91009. * Rebuilds the elements related to this component in case of
  91010. * context lost for instance.
  91011. */
  91012. rebuild(): void;
  91013. /**
  91014. * Disposes the component and the associated ressources.
  91015. */
  91016. dispose(): void;
  91017. private _beforeClear;
  91018. }
  91019. }
  91020. declare module BABYLON {
  91021. interface ThinEngine {
  91022. /**
  91023. * Creates a new render target cube texture
  91024. * @param size defines the size of the texture
  91025. * @param options defines the options used to create the texture
  91026. * @returns a new render target cube texture stored in an InternalTexture
  91027. */
  91028. createRenderTargetCubeTexture(size: number, options?: Partial<RenderTargetCreationOptions>): InternalTexture;
  91029. }
  91030. }
  91031. declare module BABYLON {
  91032. /** @hidden */
  91033. export var proceduralVertexShader: {
  91034. name: string;
  91035. shader: string;
  91036. };
  91037. }
  91038. declare module BABYLON {
  91039. /**
  91040. * 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.
  91041. * This is the base class of any Procedural texture and contains most of the shareable code.
  91042. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  91043. */
  91044. export class ProceduralTexture extends Texture {
  91045. isCube: boolean;
  91046. /**
  91047. * Define if the texture is enabled or not (disabled texture will not render)
  91048. */
  91049. isEnabled: boolean;
  91050. /**
  91051. * Define if the texture must be cleared before rendering (default is true)
  91052. */
  91053. autoClear: boolean;
  91054. /**
  91055. * Callback called when the texture is generated
  91056. */
  91057. onGenerated: () => void;
  91058. /**
  91059. * Event raised when the texture is generated
  91060. */
  91061. onGeneratedObservable: Observable<ProceduralTexture>;
  91062. /** @hidden */
  91063. _generateMipMaps: boolean;
  91064. /** @hidden **/
  91065. _effect: Effect;
  91066. /** @hidden */
  91067. _textures: {
  91068. [key: string]: Texture;
  91069. };
  91070. /** @hidden */
  91071. protected _fallbackTexture: Nullable<Texture>;
  91072. private _size;
  91073. private _currentRefreshId;
  91074. private _frameId;
  91075. private _refreshRate;
  91076. private _vertexBuffers;
  91077. private _indexBuffer;
  91078. private _uniforms;
  91079. private _samplers;
  91080. private _fragment;
  91081. private _floats;
  91082. private _ints;
  91083. private _floatsArrays;
  91084. private _colors3;
  91085. private _colors4;
  91086. private _vectors2;
  91087. private _vectors3;
  91088. private _matrices;
  91089. private _fallbackTextureUsed;
  91090. private _fullEngine;
  91091. private _cachedDefines;
  91092. private _contentUpdateId;
  91093. private _contentData;
  91094. /**
  91095. * Instantiates a new procedural texture.
  91096. * 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.
  91097. * This is the base class of any Procedural texture and contains most of the shareable code.
  91098. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  91099. * @param name Define the name of the texture
  91100. * @param size Define the size of the texture to create
  91101. * @param fragment Define the fragment shader to use to generate the texture or null if it is defined later
  91102. * @param scene Define the scene the texture belongs to
  91103. * @param fallbackTexture Define a fallback texture in case there were issues to create the custom texture
  91104. * @param generateMipMaps Define if the texture should creates mip maps or not
  91105. * @param isCube Define if the texture is a cube texture or not (this will render each faces of the cube)
  91106. */
  91107. constructor(name: string, size: any, fragment: any, scene: Nullable<Scene>, fallbackTexture?: Nullable<Texture>, generateMipMaps?: boolean, isCube?: boolean);
  91108. /**
  91109. * The effect that is created when initializing the post process.
  91110. * @returns The created effect corresponding the the postprocess.
  91111. */
  91112. getEffect(): Effect;
  91113. /**
  91114. * Gets texture content (Use this function wisely as reading from a texture can be slow)
  91115. * @returns an ArrayBufferView (Uint8Array or Float32Array)
  91116. */
  91117. getContent(): Nullable<ArrayBufferView>;
  91118. private _createIndexBuffer;
  91119. /** @hidden */
  91120. _rebuild(): void;
  91121. /**
  91122. * Resets the texture in order to recreate its associated resources.
  91123. * This can be called in case of context loss
  91124. */
  91125. reset(): void;
  91126. protected _getDefines(): string;
  91127. /**
  91128. * Is the texture ready to be used ? (rendered at least once)
  91129. * @returns true if ready, otherwise, false.
  91130. */
  91131. isReady(): boolean;
  91132. /**
  91133. * Resets the refresh counter of the texture and start bak from scratch.
  91134. * Could be useful to regenerate the texture if it is setup to render only once.
  91135. */
  91136. resetRefreshCounter(): void;
  91137. /**
  91138. * Set the fragment shader to use in order to render the texture.
  91139. * @param fragment This can be set to a path (into the shader store) or to a json object containing a fragmentElement property.
  91140. */
  91141. setFragment(fragment: any): void;
  91142. /**
  91143. * Define the refresh rate of the texture or the rendering frequency.
  91144. * Use 0 to render just once, 1 to render on every frame, 2 to render every two frames and so on...
  91145. */
  91146. get refreshRate(): number;
  91147. set refreshRate(value: number);
  91148. /** @hidden */
  91149. _shouldRender(): boolean;
  91150. /**
  91151. * Get the size the texture is rendering at.
  91152. * @returns the size (texture is always squared)
  91153. */
  91154. getRenderSize(): number;
  91155. /**
  91156. * Resize the texture to new value.
  91157. * @param size Define the new size the texture should have
  91158. * @param generateMipMaps Define whether the new texture should create mip maps
  91159. */
  91160. resize(size: number, generateMipMaps: boolean): void;
  91161. private _checkUniform;
  91162. /**
  91163. * Set a texture in the shader program used to render.
  91164. * @param name Define the name of the uniform samplers as defined in the shader
  91165. * @param texture Define the texture to bind to this sampler
  91166. * @return the texture itself allowing "fluent" like uniform updates
  91167. */
  91168. setTexture(name: string, texture: Texture): ProceduralTexture;
  91169. /**
  91170. * Set a float in the shader.
  91171. * @param name Define the name of the uniform as defined in the shader
  91172. * @param value Define the value to give to the uniform
  91173. * @return the texture itself allowing "fluent" like uniform updates
  91174. */
  91175. setFloat(name: string, value: number): ProceduralTexture;
  91176. /**
  91177. * Set a int in the shader.
  91178. * @param name Define the name of the uniform as defined in the shader
  91179. * @param value Define the value to give to the uniform
  91180. * @return the texture itself allowing "fluent" like uniform updates
  91181. */
  91182. setInt(name: string, value: number): ProceduralTexture;
  91183. /**
  91184. * Set an array of floats in the shader.
  91185. * @param name Define the name of the uniform as defined in the shader
  91186. * @param value Define the value to give to the uniform
  91187. * @return the texture itself allowing "fluent" like uniform updates
  91188. */
  91189. setFloats(name: string, value: number[]): ProceduralTexture;
  91190. /**
  91191. * Set a vec3 in the shader from a Color3.
  91192. * @param name Define the name of the uniform as defined in the shader
  91193. * @param value Define the value to give to the uniform
  91194. * @return the texture itself allowing "fluent" like uniform updates
  91195. */
  91196. setColor3(name: string, value: Color3): ProceduralTexture;
  91197. /**
  91198. * Set a vec4 in the shader from a Color4.
  91199. * @param name Define the name of the uniform as defined in the shader
  91200. * @param value Define the value to give to the uniform
  91201. * @return the texture itself allowing "fluent" like uniform updates
  91202. */
  91203. setColor4(name: string, value: Color4): ProceduralTexture;
  91204. /**
  91205. * Set a vec2 in the shader from a Vector2.
  91206. * @param name Define the name of the uniform as defined in the shader
  91207. * @param value Define the value to give to the uniform
  91208. * @return the texture itself allowing "fluent" like uniform updates
  91209. */
  91210. setVector2(name: string, value: Vector2): ProceduralTexture;
  91211. /**
  91212. * Set a vec3 in the shader from a Vector3.
  91213. * @param name Define the name of the uniform as defined in the shader
  91214. * @param value Define the value to give to the uniform
  91215. * @return the texture itself allowing "fluent" like uniform updates
  91216. */
  91217. setVector3(name: string, value: Vector3): ProceduralTexture;
  91218. /**
  91219. * Set a mat4 in the shader from a MAtrix.
  91220. * @param name Define the name of the uniform as defined in the shader
  91221. * @param value Define the value to give to the uniform
  91222. * @return the texture itself allowing "fluent" like uniform updates
  91223. */
  91224. setMatrix(name: string, value: Matrix): ProceduralTexture;
  91225. /**
  91226. * Render the texture to its associated render target.
  91227. * @param useCameraPostProcess Define if camera post process should be applied to the texture
  91228. */
  91229. render(useCameraPostProcess?: boolean): void;
  91230. /**
  91231. * Clone the texture.
  91232. * @returns the cloned texture
  91233. */
  91234. clone(): ProceduralTexture;
  91235. /**
  91236. * Dispose the texture and release its asoociated resources.
  91237. */
  91238. dispose(): void;
  91239. }
  91240. }
  91241. declare module BABYLON {
  91242. /**
  91243. * This represents the base class for particle system in Babylon.
  91244. * 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.
  91245. * Particles can take different shapes while emitted like box, sphere, cone or you can write your custom function.
  91246. * @example https://doc.babylonjs.com/babylon101/particles
  91247. */
  91248. export class BaseParticleSystem {
  91249. /**
  91250. * Source color is added to the destination color without alpha affecting the result
  91251. */
  91252. static BLENDMODE_ONEONE: number;
  91253. /**
  91254. * Blend current color and particle color using particle’s alpha
  91255. */
  91256. static BLENDMODE_STANDARD: number;
  91257. /**
  91258. * Add current color and particle color multiplied by particle’s alpha
  91259. */
  91260. static BLENDMODE_ADD: number;
  91261. /**
  91262. * Multiply current color with particle color
  91263. */
  91264. static BLENDMODE_MULTIPLY: number;
  91265. /**
  91266. * Multiply current color with particle color then add current color and particle color multiplied by particle’s alpha
  91267. */
  91268. static BLENDMODE_MULTIPLYADD: number;
  91269. /**
  91270. * List of animations used by the particle system.
  91271. */
  91272. animations: Animation[];
  91273. /**
  91274. * Gets or sets the unique id of the particle system
  91275. */
  91276. uniqueId: number;
  91277. /**
  91278. * The id of the Particle system.
  91279. */
  91280. id: string;
  91281. /**
  91282. * The friendly name of the Particle system.
  91283. */
  91284. name: string;
  91285. /**
  91286. * Snippet ID if the particle system was created from the snippet server
  91287. */
  91288. snippetId: string;
  91289. /**
  91290. * The rendering group used by the Particle system to chose when to render.
  91291. */
  91292. renderingGroupId: number;
  91293. /**
  91294. * The emitter represents the Mesh or position we are attaching the particle system to.
  91295. */
  91296. emitter: Nullable<AbstractMesh | Vector3>;
  91297. /**
  91298. * The maximum number of particles to emit per frame
  91299. */
  91300. emitRate: number;
  91301. /**
  91302. * If you want to launch only a few particles at once, that can be done, as well.
  91303. */
  91304. manualEmitCount: number;
  91305. /**
  91306. * The overall motion speed (0.01 is default update speed, faster updates = faster animation)
  91307. */
  91308. updateSpeed: number;
  91309. /**
  91310. * The amount of time the particle system is running (depends of the overall update speed).
  91311. */
  91312. targetStopDuration: number;
  91313. /**
  91314. * Specifies whether the particle system will be disposed once it reaches the end of the animation.
  91315. */
  91316. disposeOnStop: boolean;
  91317. /**
  91318. * Minimum power of emitting particles.
  91319. */
  91320. minEmitPower: number;
  91321. /**
  91322. * Maximum power of emitting particles.
  91323. */
  91324. maxEmitPower: number;
  91325. /**
  91326. * Minimum life time of emitting particles.
  91327. */
  91328. minLifeTime: number;
  91329. /**
  91330. * Maximum life time of emitting particles.
  91331. */
  91332. maxLifeTime: number;
  91333. /**
  91334. * Minimum Size of emitting particles.
  91335. */
  91336. minSize: number;
  91337. /**
  91338. * Maximum Size of emitting particles.
  91339. */
  91340. maxSize: number;
  91341. /**
  91342. * Minimum scale of emitting particles on X axis.
  91343. */
  91344. minScaleX: number;
  91345. /**
  91346. * Maximum scale of emitting particles on X axis.
  91347. */
  91348. maxScaleX: number;
  91349. /**
  91350. * Minimum scale of emitting particles on Y axis.
  91351. */
  91352. minScaleY: number;
  91353. /**
  91354. * Maximum scale of emitting particles on Y axis.
  91355. */
  91356. maxScaleY: number;
  91357. /**
  91358. * Gets or sets the minimal initial rotation in radians.
  91359. */
  91360. minInitialRotation: number;
  91361. /**
  91362. * Gets or sets the maximal initial rotation in radians.
  91363. */
  91364. maxInitialRotation: number;
  91365. /**
  91366. * Minimum angular speed of emitting particles (Z-axis rotation for each particle).
  91367. */
  91368. minAngularSpeed: number;
  91369. /**
  91370. * Maximum angular speed of emitting particles (Z-axis rotation for each particle).
  91371. */
  91372. maxAngularSpeed: number;
  91373. /**
  91374. * The texture used to render each particle. (this can be a spritesheet)
  91375. */
  91376. particleTexture: Nullable<BaseTexture>;
  91377. /**
  91378. * The layer mask we are rendering the particles through.
  91379. */
  91380. layerMask: number;
  91381. /**
  91382. * This can help using your own shader to render the particle system.
  91383. * The according effect will be created
  91384. */
  91385. customShader: any;
  91386. /**
  91387. * By default particle system starts as soon as they are created. This prevents the
  91388. * automatic start to happen and let you decide when to start emitting particles.
  91389. */
  91390. preventAutoStart: boolean;
  91391. private _noiseTexture;
  91392. /**
  91393. * Gets or sets a texture used to add random noise to particle positions
  91394. */
  91395. get noiseTexture(): Nullable<ProceduralTexture>;
  91396. set noiseTexture(value: Nullable<ProceduralTexture>);
  91397. /** Gets or sets the strength to apply to the noise value (default is (10, 10, 10)) */
  91398. noiseStrength: Vector3;
  91399. /**
  91400. * Callback triggered when the particle animation is ending.
  91401. */
  91402. onAnimationEnd: Nullable<() => void>;
  91403. /**
  91404. * Blend mode use to render the particle, it can be either ParticleSystem.BLENDMODE_ONEONE or ParticleSystem.BLENDMODE_STANDARD.
  91405. */
  91406. blendMode: number;
  91407. /**
  91408. * Forces the particle to write their depth information to the depth buffer. This can help preventing other draw calls
  91409. * to override the particles.
  91410. */
  91411. forceDepthWrite: boolean;
  91412. /** 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 */
  91413. preWarmCycles: number;
  91414. /** Gets or sets a value indicating the time step multiplier to use in pre-warm mode (default is 1) */
  91415. preWarmStepOffset: number;
  91416. /**
  91417. * 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)
  91418. */
  91419. spriteCellChangeSpeed: number;
  91420. /**
  91421. * If using a spritesheet (isAnimationSheetEnabled) defines the first sprite cell to display
  91422. */
  91423. startSpriteCellID: number;
  91424. /**
  91425. * If using a spritesheet (isAnimationSheetEnabled) defines the last sprite cell to display
  91426. */
  91427. endSpriteCellID: number;
  91428. /**
  91429. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell width to use
  91430. */
  91431. spriteCellWidth: number;
  91432. /**
  91433. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell height to use
  91434. */
  91435. spriteCellHeight: number;
  91436. /**
  91437. * This allows the system to random pick the start cell ID between startSpriteCellID and endSpriteCellID
  91438. */
  91439. spriteRandomStartCell: boolean;
  91440. /** Gets or sets a Vector2 used to move the pivot (by default (0,0)) */
  91441. translationPivot: Vector2;
  91442. /** @hidden */
  91443. protected _isAnimationSheetEnabled: boolean;
  91444. /**
  91445. * Gets or sets a boolean indicating that hosted animations (in the system.animations array) must be started when system.start() is called
  91446. */
  91447. beginAnimationOnStart: boolean;
  91448. /**
  91449. * Gets or sets the frame to start the animation from when beginAnimationOnStart is true
  91450. */
  91451. beginAnimationFrom: number;
  91452. /**
  91453. * Gets or sets the frame to end the animation on when beginAnimationOnStart is true
  91454. */
  91455. beginAnimationTo: number;
  91456. /**
  91457. * Gets or sets a boolean indicating if animations must loop when beginAnimationOnStart is true
  91458. */
  91459. beginAnimationLoop: boolean;
  91460. /**
  91461. * Gets or sets a world offset applied to all particles
  91462. */
  91463. worldOffset: Vector3;
  91464. /**
  91465. * Gets or sets whether an animation sprite sheet is enabled or not on the particle system
  91466. */
  91467. get isAnimationSheetEnabled(): boolean;
  91468. set isAnimationSheetEnabled(value: boolean);
  91469. /**
  91470. * Get hosting scene
  91471. * @returns the scene
  91472. */
  91473. getScene(): Nullable<Scene>;
  91474. /**
  91475. * You can use gravity if you want to give an orientation to your particles.
  91476. */
  91477. gravity: Vector3;
  91478. protected _colorGradients: Nullable<Array<ColorGradient>>;
  91479. protected _sizeGradients: Nullable<Array<FactorGradient>>;
  91480. protected _lifeTimeGradients: Nullable<Array<FactorGradient>>;
  91481. protected _angularSpeedGradients: Nullable<Array<FactorGradient>>;
  91482. protected _velocityGradients: Nullable<Array<FactorGradient>>;
  91483. protected _limitVelocityGradients: Nullable<Array<FactorGradient>>;
  91484. protected _dragGradients: Nullable<Array<FactorGradient>>;
  91485. protected _emitRateGradients: Nullable<Array<FactorGradient>>;
  91486. protected _startSizeGradients: Nullable<Array<FactorGradient>>;
  91487. protected _rampGradients: Nullable<Array<Color3Gradient>>;
  91488. protected _colorRemapGradients: Nullable<Array<FactorGradient>>;
  91489. protected _alphaRemapGradients: Nullable<Array<FactorGradient>>;
  91490. protected _hasTargetStopDurationDependantGradient(): boolean | null;
  91491. /**
  91492. * Defines the delay in milliseconds before starting the system (0 by default)
  91493. */
  91494. startDelay: number;
  91495. /**
  91496. * Gets the current list of drag gradients.
  91497. * You must use addDragGradient and removeDragGradient to udpate this list
  91498. * @returns the list of drag gradients
  91499. */
  91500. getDragGradients(): Nullable<Array<FactorGradient>>;
  91501. /** Gets or sets a value indicating the damping to apply if the limit velocity factor is reached */
  91502. limitVelocityDamping: number;
  91503. /**
  91504. * Gets the current list of limit velocity gradients.
  91505. * You must use addLimitVelocityGradient and removeLimitVelocityGradient to udpate this list
  91506. * @returns the list of limit velocity gradients
  91507. */
  91508. getLimitVelocityGradients(): Nullable<Array<FactorGradient>>;
  91509. /**
  91510. * Gets the current list of color gradients.
  91511. * You must use addColorGradient and removeColorGradient to udpate this list
  91512. * @returns the list of color gradients
  91513. */
  91514. getColorGradients(): Nullable<Array<ColorGradient>>;
  91515. /**
  91516. * Gets the current list of size gradients.
  91517. * You must use addSizeGradient and removeSizeGradient to udpate this list
  91518. * @returns the list of size gradients
  91519. */
  91520. getSizeGradients(): Nullable<Array<FactorGradient>>;
  91521. /**
  91522. * Gets the current list of color remap gradients.
  91523. * You must use addColorRemapGradient and removeColorRemapGradient to udpate this list
  91524. * @returns the list of color remap gradients
  91525. */
  91526. getColorRemapGradients(): Nullable<Array<FactorGradient>>;
  91527. /**
  91528. * Gets the current list of alpha remap gradients.
  91529. * You must use addAlphaRemapGradient and removeAlphaRemapGradient to udpate this list
  91530. * @returns the list of alpha remap gradients
  91531. */
  91532. getAlphaRemapGradients(): Nullable<Array<FactorGradient>>;
  91533. /**
  91534. * Gets the current list of life time gradients.
  91535. * You must use addLifeTimeGradient and removeLifeTimeGradient to udpate this list
  91536. * @returns the list of life time gradients
  91537. */
  91538. getLifeTimeGradients(): Nullable<Array<FactorGradient>>;
  91539. /**
  91540. * Gets the current list of angular speed gradients.
  91541. * You must use addAngularSpeedGradient and removeAngularSpeedGradient to udpate this list
  91542. * @returns the list of angular speed gradients
  91543. */
  91544. getAngularSpeedGradients(): Nullable<Array<FactorGradient>>;
  91545. /**
  91546. * Gets the current list of velocity gradients.
  91547. * You must use addVelocityGradient and removeVelocityGradient to udpate this list
  91548. * @returns the list of velocity gradients
  91549. */
  91550. getVelocityGradients(): Nullable<Array<FactorGradient>>;
  91551. /**
  91552. * Gets the current list of start size gradients.
  91553. * You must use addStartSizeGradient and removeStartSizeGradient to udpate this list
  91554. * @returns the list of start size gradients
  91555. */
  91556. getStartSizeGradients(): Nullable<Array<FactorGradient>>;
  91557. /**
  91558. * Gets the current list of emit rate gradients.
  91559. * You must use addEmitRateGradient and removeEmitRateGradient to udpate this list
  91560. * @returns the list of emit rate gradients
  91561. */
  91562. getEmitRateGradients(): Nullable<Array<FactorGradient>>;
  91563. /**
  91564. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  91565. * This only works when particleEmitterTyps is a BoxParticleEmitter
  91566. */
  91567. get direction1(): Vector3;
  91568. set direction1(value: Vector3);
  91569. /**
  91570. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  91571. * This only works when particleEmitterTyps is a BoxParticleEmitter
  91572. */
  91573. get direction2(): Vector3;
  91574. set direction2(value: Vector3);
  91575. /**
  91576. * 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.
  91577. * This only works when particleEmitterTyps is a BoxParticleEmitter
  91578. */
  91579. get minEmitBox(): Vector3;
  91580. set minEmitBox(value: Vector3);
  91581. /**
  91582. * 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.
  91583. * This only works when particleEmitterTyps is a BoxParticleEmitter
  91584. */
  91585. get maxEmitBox(): Vector3;
  91586. set maxEmitBox(value: Vector3);
  91587. /**
  91588. * Random color of each particle after it has been emitted, between color1 and color2 vectors
  91589. */
  91590. color1: Color4;
  91591. /**
  91592. * Random color of each particle after it has been emitted, between color1 and color2 vectors
  91593. */
  91594. color2: Color4;
  91595. /**
  91596. * Color the particle will have at the end of its lifetime
  91597. */
  91598. colorDead: Color4;
  91599. /**
  91600. * An optional mask to filter some colors out of the texture, or filter a part of the alpha channel
  91601. */
  91602. textureMask: Color4;
  91603. /**
  91604. * The particle emitter type defines the emitter used by the particle system.
  91605. * It can be for example box, sphere, or cone...
  91606. */
  91607. particleEmitterType: IParticleEmitterType;
  91608. /** @hidden */
  91609. _isSubEmitter: boolean;
  91610. /**
  91611. * Gets or sets the billboard mode to use when isBillboardBased = true.
  91612. * Value can be: ParticleSystem.BILLBOARDMODE_ALL, ParticleSystem.BILLBOARDMODE_Y, ParticleSystem.BILLBOARDMODE_STRETCHED
  91613. */
  91614. billboardMode: number;
  91615. protected _isBillboardBased: boolean;
  91616. /**
  91617. * Gets or sets a boolean indicating if the particles must be rendered as billboard or aligned with the direction
  91618. */
  91619. get isBillboardBased(): boolean;
  91620. set isBillboardBased(value: boolean);
  91621. /**
  91622. * The scene the particle system belongs to.
  91623. */
  91624. protected _scene: Nullable<Scene>;
  91625. /**
  91626. * The engine the particle system belongs to.
  91627. */
  91628. protected _engine: ThinEngine;
  91629. /**
  91630. * Local cache of defines for image processing.
  91631. */
  91632. protected _imageProcessingConfigurationDefines: ImageProcessingConfigurationDefines;
  91633. /**
  91634. * Default configuration related to image processing available in the standard Material.
  91635. */
  91636. protected _imageProcessingConfiguration: Nullable<ImageProcessingConfiguration>;
  91637. /**
  91638. * Gets the image processing configuration used either in this material.
  91639. */
  91640. get imageProcessingConfiguration(): Nullable<ImageProcessingConfiguration>;
  91641. /**
  91642. * Sets the Default image processing configuration used either in the this material.
  91643. *
  91644. * If sets to null, the scene one is in use.
  91645. */
  91646. set imageProcessingConfiguration(value: Nullable<ImageProcessingConfiguration>);
  91647. /**
  91648. * Attaches a new image processing configuration to the Standard Material.
  91649. * @param configuration
  91650. */
  91651. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  91652. /** @hidden */
  91653. protected _reset(): void;
  91654. /** @hidden */
  91655. protected _removeGradientAndTexture(gradient: number, gradients: Nullable<IValueGradient[]>, texture: Nullable<RawTexture>): BaseParticleSystem;
  91656. /**
  91657. * Instantiates a particle system.
  91658. * 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.
  91659. * @param name The name of the particle system
  91660. */
  91661. constructor(name: string);
  91662. /**
  91663. * Creates a Point Emitter for the particle system (emits directly from the emitter position)
  91664. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  91665. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  91666. * @returns the emitter
  91667. */
  91668. createPointEmitter(direction1: Vector3, direction2: Vector3): PointParticleEmitter;
  91669. /**
  91670. * Creates a Hemisphere Emitter for the particle system (emits along the hemisphere radius)
  91671. * @param radius The radius of the hemisphere to emit from
  91672. * @param radiusRange The range of the hemisphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  91673. * @returns the emitter
  91674. */
  91675. createHemisphericEmitter(radius?: number, radiusRange?: number): HemisphericParticleEmitter;
  91676. /**
  91677. * Creates a Sphere Emitter for the particle system (emits along the sphere radius)
  91678. * @param radius The radius of the sphere to emit from
  91679. * @param radiusRange The range of the sphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  91680. * @returns the emitter
  91681. */
  91682. createSphereEmitter(radius?: number, radiusRange?: number): SphereParticleEmitter;
  91683. /**
  91684. * Creates a Directed Sphere Emitter for the particle system (emits between direction1 and direction2)
  91685. * @param radius The radius of the sphere to emit from
  91686. * @param direction1 Particles are emitted between the direction1 and direction2 from within the sphere
  91687. * @param direction2 Particles are emitted between the direction1 and direction2 from within the sphere
  91688. * @returns the emitter
  91689. */
  91690. createDirectedSphereEmitter(radius?: number, direction1?: Vector3, direction2?: Vector3): SphereDirectedParticleEmitter;
  91691. /**
  91692. * Creates a Cylinder Emitter for the particle system (emits from the cylinder to the particle position)
  91693. * @param radius The radius of the emission cylinder
  91694. * @param height The height of the emission cylinder
  91695. * @param radiusRange The range of emission [0-1] 0 Surface only, 1 Entire Radius
  91696. * @param directionRandomizer How much to randomize the particle direction [0-1]
  91697. * @returns the emitter
  91698. */
  91699. createCylinderEmitter(radius?: number, height?: number, radiusRange?: number, directionRandomizer?: number): CylinderParticleEmitter;
  91700. /**
  91701. * Creates a Directed Cylinder Emitter for the particle system (emits between direction1 and direction2)
  91702. * @param radius The radius of the cylinder to emit from
  91703. * @param height The height of the emission cylinder
  91704. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  91705. * @param direction1 Particles are emitted between the direction1 and direction2 from within the cylinder
  91706. * @param direction2 Particles are emitted between the direction1 and direction2 from within the cylinder
  91707. * @returns the emitter
  91708. */
  91709. createDirectedCylinderEmitter(radius?: number, height?: number, radiusRange?: number, direction1?: Vector3, direction2?: Vector3): CylinderDirectedParticleEmitter;
  91710. /**
  91711. * Creates a Cone Emitter for the particle system (emits from the cone to the particle position)
  91712. * @param radius The radius of the cone to emit from
  91713. * @param angle The base angle of the cone
  91714. * @returns the emitter
  91715. */
  91716. createConeEmitter(radius?: number, angle?: number): ConeParticleEmitter;
  91717. /**
  91718. * Creates a Box Emitter for the particle system. (emits between direction1 and direction2 from withing the box defined by minEmitBox and maxEmitBox)
  91719. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  91720. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  91721. * @param minEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  91722. * @param maxEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  91723. * @returns the emitter
  91724. */
  91725. createBoxEmitter(direction1: Vector3, direction2: Vector3, minEmitBox: Vector3, maxEmitBox: Vector3): BoxParticleEmitter;
  91726. }
  91727. }
  91728. declare module BABYLON {
  91729. /**
  91730. * Type of sub emitter
  91731. */
  91732. export enum SubEmitterType {
  91733. /**
  91734. * Attached to the particle over it's lifetime
  91735. */
  91736. ATTACHED = 0,
  91737. /**
  91738. * Created when the particle dies
  91739. */
  91740. END = 1
  91741. }
  91742. /**
  91743. * Sub emitter class used to emit particles from an existing particle
  91744. */
  91745. export class SubEmitter {
  91746. /**
  91747. * the particle system to be used by the sub emitter
  91748. */
  91749. particleSystem: ParticleSystem;
  91750. /**
  91751. * Type of the submitter (Default: END)
  91752. */
  91753. type: SubEmitterType;
  91754. /**
  91755. * 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)
  91756. * Note: This only is supported when using an emitter of type Mesh
  91757. */
  91758. inheritDirection: boolean;
  91759. /**
  91760. * How much of the attached particles speed should be added to the sub emitted particle (default: 0)
  91761. */
  91762. inheritedVelocityAmount: number;
  91763. /**
  91764. * Creates a sub emitter
  91765. * @param particleSystem the particle system to be used by the sub emitter
  91766. */
  91767. constructor(
  91768. /**
  91769. * the particle system to be used by the sub emitter
  91770. */
  91771. particleSystem: ParticleSystem);
  91772. /**
  91773. * Clones the sub emitter
  91774. * @returns the cloned sub emitter
  91775. */
  91776. clone(): SubEmitter;
  91777. /**
  91778. * Serialize current object to a JSON object
  91779. * @returns the serialized object
  91780. */
  91781. serialize(): any;
  91782. /** @hidden */
  91783. static _ParseParticleSystem(system: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string): ParticleSystem;
  91784. /**
  91785. * Creates a new SubEmitter from a serialized JSON version
  91786. * @param serializationObject defines the JSON object to read from
  91787. * @param sceneOrEngine defines the hosting scene or the hosting engine
  91788. * @param rootUrl defines the rootUrl for data loading
  91789. * @returns a new SubEmitter
  91790. */
  91791. static Parse(serializationObject: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string): SubEmitter;
  91792. /** Release associated resources */
  91793. dispose(): void;
  91794. }
  91795. }
  91796. declare module BABYLON {
  91797. /** @hidden */
  91798. export var imageProcessingDeclaration: {
  91799. name: string;
  91800. shader: string;
  91801. };
  91802. }
  91803. declare module BABYLON {
  91804. /** @hidden */
  91805. export var imageProcessingFunctions: {
  91806. name: string;
  91807. shader: string;
  91808. };
  91809. }
  91810. declare module BABYLON {
  91811. /** @hidden */
  91812. export var particlesPixelShader: {
  91813. name: string;
  91814. shader: string;
  91815. };
  91816. }
  91817. declare module BABYLON {
  91818. /** @hidden */
  91819. export var particlesVertexShader: {
  91820. name: string;
  91821. shader: string;
  91822. };
  91823. }
  91824. declare module BABYLON {
  91825. /**
  91826. * Interface used to define entities containing multiple clip planes
  91827. */
  91828. export interface IClipPlanesHolder {
  91829. /**
  91830. * Gets or sets the active clipplane 1
  91831. */
  91832. clipPlane: Nullable<Plane>;
  91833. /**
  91834. * Gets or sets the active clipplane 2
  91835. */
  91836. clipPlane2: Nullable<Plane>;
  91837. /**
  91838. * Gets or sets the active clipplane 3
  91839. */
  91840. clipPlane3: Nullable<Plane>;
  91841. /**
  91842. * Gets or sets the active clipplane 4
  91843. */
  91844. clipPlane4: Nullable<Plane>;
  91845. /**
  91846. * Gets or sets the active clipplane 5
  91847. */
  91848. clipPlane5: Nullable<Plane>;
  91849. /**
  91850. * Gets or sets the active clipplane 6
  91851. */
  91852. clipPlane6: Nullable<Plane>;
  91853. }
  91854. }
  91855. declare module BABYLON {
  91856. /**
  91857. * "Static Class" containing a few commonly used helper while dealing with material for rendering purpose.
  91858. *
  91859. * It is complementary with MaterialHelper but provides completely independent functions (for tree shaking sake)
  91860. *
  91861. * This works by convention in BabylonJS but is meant to be use only with shader following the in place naming rules and conventions.
  91862. */
  91863. export class ThinMaterialHelper {
  91864. /**
  91865. * Binds the clip plane information from the holder to the effect.
  91866. * @param effect The effect we are binding the data to
  91867. * @param holder The entity containing the clip plane information
  91868. */
  91869. static BindClipPlane(effect: Effect, holder: IClipPlanesHolder): void;
  91870. }
  91871. }
  91872. declare module BABYLON {
  91873. interface ThinEngine {
  91874. /**
  91875. * Sets alpha constants used by some alpha blending modes
  91876. * @param r defines the red component
  91877. * @param g defines the green component
  91878. * @param b defines the blue component
  91879. * @param a defines the alpha component
  91880. */
  91881. setAlphaConstants(r: number, g: number, b: number, a: number): void;
  91882. /**
  91883. * Sets the current alpha mode
  91884. * @param mode defines the mode to use (one of the Engine.ALPHA_XXX)
  91885. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  91886. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  91887. */
  91888. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  91889. /**
  91890. * Gets the current alpha mode
  91891. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  91892. * @returns the current alpha mode
  91893. */
  91894. getAlphaMode(): number;
  91895. /**
  91896. * Sets the current alpha equation
  91897. * @param equation defines the equation to use (one of the Engine.ALPHA_EQUATION_XXX)
  91898. */
  91899. setAlphaEquation(equation: number): void;
  91900. /**
  91901. * Gets the current alpha equation.
  91902. * @returns the current alpha equation
  91903. */
  91904. getAlphaEquation(): number;
  91905. }
  91906. }
  91907. declare module BABYLON {
  91908. /**
  91909. * This represents a particle system in Babylon.
  91910. * 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.
  91911. * Particles can take different shapes while emitted like box, sphere, cone or you can write your custom function.
  91912. * @example https://doc.babylonjs.com/babylon101/particles
  91913. */
  91914. export class ParticleSystem extends BaseParticleSystem implements IDisposable, IAnimatable, IParticleSystem {
  91915. /**
  91916. * Billboard mode will only apply to Y axis
  91917. */
  91918. static readonly BILLBOARDMODE_Y: number;
  91919. /**
  91920. * Billboard mode will apply to all axes
  91921. */
  91922. static readonly BILLBOARDMODE_ALL: number;
  91923. /**
  91924. * Special billboard mode where the particle will be biilboard to the camera but rotated to align with direction
  91925. */
  91926. static readonly BILLBOARDMODE_STRETCHED: number;
  91927. /**
  91928. * This function can be defined to provide custom update for active particles.
  91929. * This function will be called instead of regular update (age, position, color, etc.).
  91930. * Do not forget that this function will be called on every frame so try to keep it simple and fast :)
  91931. */
  91932. updateFunction: (particles: Particle[]) => void;
  91933. private _emitterWorldMatrix;
  91934. /**
  91935. * This function can be defined to specify initial direction for every new particle.
  91936. * It by default use the emitterType defined function
  91937. */
  91938. startDirectionFunction: (worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean) => void;
  91939. /**
  91940. * This function can be defined to specify initial position for every new particle.
  91941. * It by default use the emitterType defined function
  91942. */
  91943. startPositionFunction: (worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean) => void;
  91944. /**
  91945. * @hidden
  91946. */
  91947. _inheritedVelocityOffset: Vector3;
  91948. /**
  91949. * An event triggered when the system is disposed
  91950. */
  91951. onDisposeObservable: Observable<IParticleSystem>;
  91952. private _onDisposeObserver;
  91953. /**
  91954. * Sets a callback that will be triggered when the system is disposed
  91955. */
  91956. set onDispose(callback: () => void);
  91957. private _particles;
  91958. private _epsilon;
  91959. private _capacity;
  91960. private _stockParticles;
  91961. private _newPartsExcess;
  91962. private _vertexData;
  91963. private _vertexBuffer;
  91964. private _vertexBuffers;
  91965. private _spriteBuffer;
  91966. private _indexBuffer;
  91967. private _effect;
  91968. private _customEffect;
  91969. private _cachedDefines;
  91970. private _scaledColorStep;
  91971. private _colorDiff;
  91972. private _scaledDirection;
  91973. private _scaledGravity;
  91974. private _currentRenderId;
  91975. private _alive;
  91976. private _useInstancing;
  91977. private _started;
  91978. private _stopped;
  91979. private _actualFrame;
  91980. private _scaledUpdateSpeed;
  91981. private _vertexBufferSize;
  91982. /** @hidden */
  91983. _currentEmitRateGradient: Nullable<FactorGradient>;
  91984. /** @hidden */
  91985. _currentEmitRate1: number;
  91986. /** @hidden */
  91987. _currentEmitRate2: number;
  91988. /** @hidden */
  91989. _currentStartSizeGradient: Nullable<FactorGradient>;
  91990. /** @hidden */
  91991. _currentStartSize1: number;
  91992. /** @hidden */
  91993. _currentStartSize2: number;
  91994. private readonly _rawTextureWidth;
  91995. private _rampGradientsTexture;
  91996. private _useRampGradients;
  91997. /** Gets or sets a matrix to use to compute projection */
  91998. defaultProjectionMatrix: Matrix;
  91999. /** Gets or sets a matrix to use to compute view */
  92000. defaultViewMatrix: Matrix;
  92001. /** Gets or sets a boolean indicating that ramp gradients must be used
  92002. * @see https://doc.babylonjs.com/babylon101/particles#ramp-gradients
  92003. */
  92004. get useRampGradients(): boolean;
  92005. set useRampGradients(value: boolean);
  92006. /**
  92007. * 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.
  92008. * 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: [])
  92009. */
  92010. subEmitters: Array<ParticleSystem | SubEmitter | Array<SubEmitter>>;
  92011. private _subEmitters;
  92012. /**
  92013. * @hidden
  92014. * If the particle systems emitter should be disposed when the particle system is disposed
  92015. */
  92016. _disposeEmitterOnDispose: boolean;
  92017. /**
  92018. * The current active Sub-systems, this property is used by the root particle system only.
  92019. */
  92020. activeSubSystems: Array<ParticleSystem>;
  92021. /**
  92022. * Specifies if the particles are updated in emitter local space or world space
  92023. */
  92024. isLocal: boolean;
  92025. private _rootParticleSystem;
  92026. /**
  92027. * Gets the current list of active particles
  92028. */
  92029. get particles(): Particle[];
  92030. /**
  92031. * Gets the number of particles active at the same time.
  92032. * @returns The number of active particles.
  92033. */
  92034. getActiveCount(): number;
  92035. /**
  92036. * Returns the string "ParticleSystem"
  92037. * @returns a string containing the class name
  92038. */
  92039. getClassName(): string;
  92040. /**
  92041. * Gets a boolean indicating that the system is stopping
  92042. * @returns true if the system is currently stopping
  92043. */
  92044. isStopping(): boolean;
  92045. /**
  92046. * Gets the custom effect used to render the particles
  92047. * @param blendMode Blend mode for which the effect should be retrieved
  92048. * @returns The effect
  92049. */
  92050. getCustomEffect(blendMode?: number): Nullable<Effect>;
  92051. /**
  92052. * Sets the custom effect used to render the particles
  92053. * @param effect The effect to set
  92054. * @param blendMode Blend mode for which the effect should be set
  92055. */
  92056. setCustomEffect(effect: Nullable<Effect>, blendMode?: number): void;
  92057. /** @hidden */
  92058. private _onBeforeDrawParticlesObservable;
  92059. /**
  92060. * Observable that will be called just before the particles are drawn
  92061. */
  92062. get onBeforeDrawParticlesObservable(): Observable<Nullable<Effect>>;
  92063. /**
  92064. * Gets the name of the particle vertex shader
  92065. */
  92066. get vertexShaderName(): string;
  92067. /**
  92068. * Instantiates a particle system.
  92069. * 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.
  92070. * @param name The name of the particle system
  92071. * @param capacity The max number of particles alive at the same time
  92072. * @param sceneOrEngine The scene the particle system belongs to or the engine to use if no scene
  92073. * @param customEffect a custom effect used to change the way particles are rendered by default
  92074. * @param isAnimationSheetEnabled Must be true if using a spritesheet to animate the particles texture
  92075. * @param epsilon Offset used to render the particles
  92076. */
  92077. constructor(name: string, capacity: number, sceneOrEngine: Scene | ThinEngine, customEffect?: Nullable<Effect>, isAnimationSheetEnabled?: boolean, epsilon?: number);
  92078. private _addFactorGradient;
  92079. private _removeFactorGradient;
  92080. /**
  92081. * Adds a new life time gradient
  92082. * @param gradient defines the gradient to use (between 0 and 1)
  92083. * @param factor defines the life time factor to affect to the specified gradient
  92084. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92085. * @returns the current particle system
  92086. */
  92087. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92088. /**
  92089. * Remove a specific life time gradient
  92090. * @param gradient defines the gradient to remove
  92091. * @returns the current particle system
  92092. */
  92093. removeLifeTimeGradient(gradient: number): IParticleSystem;
  92094. /**
  92095. * Adds a new size gradient
  92096. * @param gradient defines the gradient to use (between 0 and 1)
  92097. * @param factor defines the size factor to affect to the specified gradient
  92098. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92099. * @returns the current particle system
  92100. */
  92101. addSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92102. /**
  92103. * Remove a specific size gradient
  92104. * @param gradient defines the gradient to remove
  92105. * @returns the current particle system
  92106. */
  92107. removeSizeGradient(gradient: number): IParticleSystem;
  92108. /**
  92109. * Adds a new color remap gradient
  92110. * @param gradient defines the gradient to use (between 0 and 1)
  92111. * @param min defines the color remap minimal range
  92112. * @param max defines the color remap maximal range
  92113. * @returns the current particle system
  92114. */
  92115. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  92116. /**
  92117. * Remove a specific color remap gradient
  92118. * @param gradient defines the gradient to remove
  92119. * @returns the current particle system
  92120. */
  92121. removeColorRemapGradient(gradient: number): IParticleSystem;
  92122. /**
  92123. * Adds a new alpha remap gradient
  92124. * @param gradient defines the gradient to use (between 0 and 1)
  92125. * @param min defines the alpha remap minimal range
  92126. * @param max defines the alpha remap maximal range
  92127. * @returns the current particle system
  92128. */
  92129. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  92130. /**
  92131. * Remove a specific alpha remap gradient
  92132. * @param gradient defines the gradient to remove
  92133. * @returns the current particle system
  92134. */
  92135. removeAlphaRemapGradient(gradient: number): IParticleSystem;
  92136. /**
  92137. * Adds a new angular speed gradient
  92138. * @param gradient defines the gradient to use (between 0 and 1)
  92139. * @param factor defines the angular speed to affect to the specified gradient
  92140. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92141. * @returns the current particle system
  92142. */
  92143. addAngularSpeedGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92144. /**
  92145. * Remove a specific angular speed gradient
  92146. * @param gradient defines the gradient to remove
  92147. * @returns the current particle system
  92148. */
  92149. removeAngularSpeedGradient(gradient: number): IParticleSystem;
  92150. /**
  92151. * Adds a new velocity gradient
  92152. * @param gradient defines the gradient to use (between 0 and 1)
  92153. * @param factor defines the velocity to affect to the specified gradient
  92154. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92155. * @returns the current particle system
  92156. */
  92157. addVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92158. /**
  92159. * Remove a specific velocity gradient
  92160. * @param gradient defines the gradient to remove
  92161. * @returns the current particle system
  92162. */
  92163. removeVelocityGradient(gradient: number): IParticleSystem;
  92164. /**
  92165. * Adds a new limit velocity gradient
  92166. * @param gradient defines the gradient to use (between 0 and 1)
  92167. * @param factor defines the limit velocity value to affect to the specified gradient
  92168. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92169. * @returns the current particle system
  92170. */
  92171. addLimitVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92172. /**
  92173. * Remove a specific limit velocity gradient
  92174. * @param gradient defines the gradient to remove
  92175. * @returns the current particle system
  92176. */
  92177. removeLimitVelocityGradient(gradient: number): IParticleSystem;
  92178. /**
  92179. * Adds a new drag gradient
  92180. * @param gradient defines the gradient to use (between 0 and 1)
  92181. * @param factor defines the drag value to affect to the specified gradient
  92182. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92183. * @returns the current particle system
  92184. */
  92185. addDragGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92186. /**
  92187. * Remove a specific drag gradient
  92188. * @param gradient defines the gradient to remove
  92189. * @returns the current particle system
  92190. */
  92191. removeDragGradient(gradient: number): IParticleSystem;
  92192. /**
  92193. * Adds a new emit rate gradient (please note that this will only work if you set the targetStopDuration property)
  92194. * @param gradient defines the gradient to use (between 0 and 1)
  92195. * @param factor defines the emit rate value to affect to the specified gradient
  92196. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92197. * @returns the current particle system
  92198. */
  92199. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92200. /**
  92201. * Remove a specific emit rate gradient
  92202. * @param gradient defines the gradient to remove
  92203. * @returns the current particle system
  92204. */
  92205. removeEmitRateGradient(gradient: number): IParticleSystem;
  92206. /**
  92207. * Adds a new start size gradient (please note that this will only work if you set the targetStopDuration property)
  92208. * @param gradient defines the gradient to use (between 0 and 1)
  92209. * @param factor defines the start size value to affect to the specified gradient
  92210. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92211. * @returns the current particle system
  92212. */
  92213. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92214. /**
  92215. * Remove a specific start size gradient
  92216. * @param gradient defines the gradient to remove
  92217. * @returns the current particle system
  92218. */
  92219. removeStartSizeGradient(gradient: number): IParticleSystem;
  92220. private _createRampGradientTexture;
  92221. /**
  92222. * Gets the current list of ramp gradients.
  92223. * You must use addRampGradient and removeRampGradient to udpate this list
  92224. * @returns the list of ramp gradients
  92225. */
  92226. getRampGradients(): Nullable<Array<Color3Gradient>>;
  92227. /** Force the system to rebuild all gradients that need to be resync */
  92228. forceRefreshGradients(): void;
  92229. private _syncRampGradientTexture;
  92230. /**
  92231. * Adds a new ramp gradient used to remap particle colors
  92232. * @param gradient defines the gradient to use (between 0 and 1)
  92233. * @param color defines the color to affect to the specified gradient
  92234. * @returns the current particle system
  92235. */
  92236. addRampGradient(gradient: number, color: Color3): ParticleSystem;
  92237. /**
  92238. * Remove a specific ramp gradient
  92239. * @param gradient defines the gradient to remove
  92240. * @returns the current particle system
  92241. */
  92242. removeRampGradient(gradient: number): ParticleSystem;
  92243. /**
  92244. * Adds a new color gradient
  92245. * @param gradient defines the gradient to use (between 0 and 1)
  92246. * @param color1 defines the color to affect to the specified gradient
  92247. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  92248. * @returns this particle system
  92249. */
  92250. addColorGradient(gradient: number, color1: Color4, color2?: Color4): IParticleSystem;
  92251. /**
  92252. * Remove a specific color gradient
  92253. * @param gradient defines the gradient to remove
  92254. * @returns this particle system
  92255. */
  92256. removeColorGradient(gradient: number): IParticleSystem;
  92257. private _fetchR;
  92258. protected _reset(): void;
  92259. private _resetEffect;
  92260. private _createVertexBuffers;
  92261. private _createIndexBuffer;
  92262. /**
  92263. * Gets the maximum number of particles active at the same time.
  92264. * @returns The max number of active particles.
  92265. */
  92266. getCapacity(): number;
  92267. /**
  92268. * Gets whether there are still active particles in the system.
  92269. * @returns True if it is alive, otherwise false.
  92270. */
  92271. isAlive(): boolean;
  92272. /**
  92273. * Gets if the system has been started. (Note: this will still be true after stop is called)
  92274. * @returns True if it has been started, otherwise false.
  92275. */
  92276. isStarted(): boolean;
  92277. private _prepareSubEmitterInternalArray;
  92278. /**
  92279. * Starts the particle system and begins to emit
  92280. * @param delay defines the delay in milliseconds before starting the system (this.startDelay by default)
  92281. */
  92282. start(delay?: number): void;
  92283. /**
  92284. * Stops the particle system.
  92285. * @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.
  92286. */
  92287. stop(stopSubEmitters?: boolean): void;
  92288. /**
  92289. * Remove all active particles
  92290. */
  92291. reset(): void;
  92292. /**
  92293. * @hidden (for internal use only)
  92294. */
  92295. _appendParticleVertex(index: number, particle: Particle, offsetX: number, offsetY: number): void;
  92296. /**
  92297. * "Recycles" one of the particle by copying it back to the "stock" of particles and removing it from the active list.
  92298. * Its lifetime will start back at 0.
  92299. */
  92300. recycleParticle: (particle: Particle) => void;
  92301. private _stopSubEmitters;
  92302. private _createParticle;
  92303. private _removeFromRoot;
  92304. private _emitFromParticle;
  92305. private _update;
  92306. /** @hidden */
  92307. static _GetAttributeNamesOrOptions(isAnimationSheetEnabled?: boolean, isBillboardBased?: boolean, useRampGradients?: boolean): string[];
  92308. /** @hidden */
  92309. static _GetEffectCreationOptions(isAnimationSheetEnabled?: boolean): string[];
  92310. /**
  92311. * Fill the defines array according to the current settings of the particle system
  92312. * @param defines Array to be updated
  92313. * @param blendMode blend mode to take into account when updating the array
  92314. */
  92315. fillDefines(defines: Array<string>, blendMode: number): void;
  92316. /**
  92317. * Fill the uniforms, attributes and samplers arrays according to the current settings of the particle system
  92318. * @param uniforms Uniforms array to fill
  92319. * @param attributes Attributes array to fill
  92320. * @param samplers Samplers array to fill
  92321. */
  92322. fillUniformsAttributesAndSamplerNames(uniforms: Array<string>, attributes: Array<string>, samplers: Array<string>): void;
  92323. /** @hidden */
  92324. private _getEffect;
  92325. /**
  92326. * Animates the particle system for the current frame by emitting new particles and or animating the living ones.
  92327. * @param preWarmOnly will prevent the system from updating the vertex buffer (default is false)
  92328. */
  92329. animate(preWarmOnly?: boolean): void;
  92330. private _appendParticleVertices;
  92331. /**
  92332. * Rebuilds the particle system.
  92333. */
  92334. rebuild(): void;
  92335. /**
  92336. * Is this system ready to be used/rendered
  92337. * @return true if the system is ready
  92338. */
  92339. isReady(): boolean;
  92340. private _render;
  92341. /**
  92342. * Renders the particle system in its current state.
  92343. * @returns the current number of particles
  92344. */
  92345. render(): number;
  92346. /**
  92347. * Disposes the particle system and free the associated resources
  92348. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  92349. */
  92350. dispose(disposeTexture?: boolean): void;
  92351. /**
  92352. * Clones the particle system.
  92353. * @param name The name of the cloned object
  92354. * @param newEmitter The new emitter to use
  92355. * @returns the cloned particle system
  92356. */
  92357. clone(name: string, newEmitter: any): ParticleSystem;
  92358. /**
  92359. * Serializes the particle system to a JSON object
  92360. * @param serializeTexture defines if the texture must be serialized as well
  92361. * @returns the JSON object
  92362. */
  92363. serialize(serializeTexture?: boolean): any;
  92364. /** @hidden */
  92365. static _Serialize(serializationObject: any, particleSystem: IParticleSystem, serializeTexture: boolean): void;
  92366. /** @hidden */
  92367. static _Parse(parsedParticleSystem: any, particleSystem: IParticleSystem, sceneOrEngine: Scene | ThinEngine, rootUrl: string): void;
  92368. /**
  92369. * Parses a JSON object to create a particle system.
  92370. * @param parsedParticleSystem The JSON object to parse
  92371. * @param sceneOrEngine The scene or the engine to create the particle system in
  92372. * @param rootUrl The root url to use to load external dependencies like texture
  92373. * @param doNotStart Ignore the preventAutoStart attribute and does not start
  92374. * @returns the Parsed particle system
  92375. */
  92376. static Parse(parsedParticleSystem: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string, doNotStart?: boolean): ParticleSystem;
  92377. }
  92378. }
  92379. declare module BABYLON {
  92380. /**
  92381. * A particle represents one of the element emitted by a particle system.
  92382. * This is mainly define by its coordinates, direction, velocity and age.
  92383. */
  92384. export class Particle {
  92385. /**
  92386. * The particle system the particle belongs to.
  92387. */
  92388. particleSystem: ParticleSystem;
  92389. private static _Count;
  92390. /**
  92391. * Unique ID of the particle
  92392. */
  92393. id: number;
  92394. /**
  92395. * The world position of the particle in the scene.
  92396. */
  92397. position: Vector3;
  92398. /**
  92399. * The world direction of the particle in the scene.
  92400. */
  92401. direction: Vector3;
  92402. /**
  92403. * The color of the particle.
  92404. */
  92405. color: Color4;
  92406. /**
  92407. * The color change of the particle per step.
  92408. */
  92409. colorStep: Color4;
  92410. /**
  92411. * Defines how long will the life of the particle be.
  92412. */
  92413. lifeTime: number;
  92414. /**
  92415. * The current age of the particle.
  92416. */
  92417. age: number;
  92418. /**
  92419. * The current size of the particle.
  92420. */
  92421. size: number;
  92422. /**
  92423. * The current scale of the particle.
  92424. */
  92425. scale: Vector2;
  92426. /**
  92427. * The current angle of the particle.
  92428. */
  92429. angle: number;
  92430. /**
  92431. * Defines how fast is the angle changing.
  92432. */
  92433. angularSpeed: number;
  92434. /**
  92435. * Defines the cell index used by the particle to be rendered from a sprite.
  92436. */
  92437. cellIndex: number;
  92438. /**
  92439. * The information required to support color remapping
  92440. */
  92441. remapData: Vector4;
  92442. /** @hidden */
  92443. _randomCellOffset?: number;
  92444. /** @hidden */
  92445. _initialDirection: Nullable<Vector3>;
  92446. /** @hidden */
  92447. _attachedSubEmitters: Nullable<Array<SubEmitter>>;
  92448. /** @hidden */
  92449. _initialStartSpriteCellID: number;
  92450. /** @hidden */
  92451. _initialEndSpriteCellID: number;
  92452. /** @hidden */
  92453. _currentColorGradient: Nullable<ColorGradient>;
  92454. /** @hidden */
  92455. _currentColor1: Color4;
  92456. /** @hidden */
  92457. _currentColor2: Color4;
  92458. /** @hidden */
  92459. _currentSizeGradient: Nullable<FactorGradient>;
  92460. /** @hidden */
  92461. _currentSize1: number;
  92462. /** @hidden */
  92463. _currentSize2: number;
  92464. /** @hidden */
  92465. _currentAngularSpeedGradient: Nullable<FactorGradient>;
  92466. /** @hidden */
  92467. _currentAngularSpeed1: number;
  92468. /** @hidden */
  92469. _currentAngularSpeed2: number;
  92470. /** @hidden */
  92471. _currentVelocityGradient: Nullable<FactorGradient>;
  92472. /** @hidden */
  92473. _currentVelocity1: number;
  92474. /** @hidden */
  92475. _currentVelocity2: number;
  92476. /** @hidden */
  92477. _currentLimitVelocityGradient: Nullable<FactorGradient>;
  92478. /** @hidden */
  92479. _currentLimitVelocity1: number;
  92480. /** @hidden */
  92481. _currentLimitVelocity2: number;
  92482. /** @hidden */
  92483. _currentDragGradient: Nullable<FactorGradient>;
  92484. /** @hidden */
  92485. _currentDrag1: number;
  92486. /** @hidden */
  92487. _currentDrag2: number;
  92488. /** @hidden */
  92489. _randomNoiseCoordinates1: Vector3;
  92490. /** @hidden */
  92491. _randomNoiseCoordinates2: Vector3;
  92492. /** @hidden */
  92493. _localPosition?: Vector3;
  92494. /**
  92495. * Creates a new instance Particle
  92496. * @param particleSystem the particle system the particle belongs to
  92497. */
  92498. constructor(
  92499. /**
  92500. * The particle system the particle belongs to.
  92501. */
  92502. particleSystem: ParticleSystem);
  92503. private updateCellInfoFromSystem;
  92504. /**
  92505. * Defines how the sprite cell index is updated for the particle
  92506. */
  92507. updateCellIndex(): void;
  92508. /** @hidden */
  92509. _inheritParticleInfoToSubEmitter(subEmitter: SubEmitter): void;
  92510. /** @hidden */
  92511. _inheritParticleInfoToSubEmitters(): void;
  92512. /** @hidden */
  92513. _reset(): void;
  92514. /**
  92515. * Copy the properties of particle to another one.
  92516. * @param other the particle to copy the information to.
  92517. */
  92518. copyTo(other: Particle): void;
  92519. }
  92520. }
  92521. declare module BABYLON {
  92522. /**
  92523. * Particle emitter represents a volume emitting particles.
  92524. * This is the responsibility of the implementation to define the volume shape like cone/sphere/box.
  92525. */
  92526. export interface IParticleEmitterType {
  92527. /**
  92528. * Called by the particle System when the direction is computed for the created particle.
  92529. * @param worldMatrix is the world matrix of the particle system
  92530. * @param directionToUpdate is the direction vector to update with the result
  92531. * @param particle is the particle we are computed the direction for
  92532. * @param isLocal defines if the direction should be set in local space
  92533. */
  92534. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  92535. /**
  92536. * Called by the particle System when the position is computed for the created particle.
  92537. * @param worldMatrix is the world matrix of the particle system
  92538. * @param positionToUpdate is the position vector to update with the result
  92539. * @param particle is the particle we are computed the position for
  92540. * @param isLocal defines if the position should be set in local space
  92541. */
  92542. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  92543. /**
  92544. * Clones the current emitter and returns a copy of it
  92545. * @returns the new emitter
  92546. */
  92547. clone(): IParticleEmitterType;
  92548. /**
  92549. * Called by the GPUParticleSystem to setup the update shader
  92550. * @param effect defines the update shader
  92551. */
  92552. applyToShader(effect: Effect): void;
  92553. /**
  92554. * Returns a string to use to update the GPU particles update shader
  92555. * @returns the effect defines string
  92556. */
  92557. getEffectDefines(): string;
  92558. /**
  92559. * Returns a string representing the class name
  92560. * @returns a string containing the class name
  92561. */
  92562. getClassName(): string;
  92563. /**
  92564. * Serializes the particle system to a JSON object.
  92565. * @returns the JSON object
  92566. */
  92567. serialize(): any;
  92568. /**
  92569. * Parse properties from a JSON object
  92570. * @param serializationObject defines the JSON object
  92571. * @param scene defines the hosting scene
  92572. */
  92573. parse(serializationObject: any, scene: Nullable<Scene>): void;
  92574. }
  92575. }
  92576. declare module BABYLON {
  92577. /**
  92578. * Particle emitter emitting particles from the inside of a box.
  92579. * It emits the particles randomly between 2 given directions.
  92580. */
  92581. export class BoxParticleEmitter implements IParticleEmitterType {
  92582. /**
  92583. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  92584. */
  92585. direction1: Vector3;
  92586. /**
  92587. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  92588. */
  92589. direction2: Vector3;
  92590. /**
  92591. * 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.
  92592. */
  92593. minEmitBox: Vector3;
  92594. /**
  92595. * 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.
  92596. */
  92597. maxEmitBox: Vector3;
  92598. /**
  92599. * Creates a new instance BoxParticleEmitter
  92600. */
  92601. constructor();
  92602. /**
  92603. * Called by the particle System when the direction is computed for the created particle.
  92604. * @param worldMatrix is the world matrix of the particle system
  92605. * @param directionToUpdate is the direction vector to update with the result
  92606. * @param particle is the particle we are computed the direction for
  92607. * @param isLocal defines if the direction should be set in local space
  92608. */
  92609. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  92610. /**
  92611. * Called by the particle System when the position is computed for the created particle.
  92612. * @param worldMatrix is the world matrix of the particle system
  92613. * @param positionToUpdate is the position vector to update with the result
  92614. * @param particle is the particle we are computed the position for
  92615. * @param isLocal defines if the position should be set in local space
  92616. */
  92617. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  92618. /**
  92619. * Clones the current emitter and returns a copy of it
  92620. * @returns the new emitter
  92621. */
  92622. clone(): BoxParticleEmitter;
  92623. /**
  92624. * Called by the GPUParticleSystem to setup the update shader
  92625. * @param effect defines the update shader
  92626. */
  92627. applyToShader(effect: Effect): void;
  92628. /**
  92629. * Returns a string to use to update the GPU particles update shader
  92630. * @returns a string containng the defines string
  92631. */
  92632. getEffectDefines(): string;
  92633. /**
  92634. * Returns the string "BoxParticleEmitter"
  92635. * @returns a string containing the class name
  92636. */
  92637. getClassName(): string;
  92638. /**
  92639. * Serializes the particle system to a JSON object.
  92640. * @returns the JSON object
  92641. */
  92642. serialize(): any;
  92643. /**
  92644. * Parse properties from a JSON object
  92645. * @param serializationObject defines the JSON object
  92646. */
  92647. parse(serializationObject: any): void;
  92648. }
  92649. }
  92650. declare module BABYLON {
  92651. /**
  92652. * Particle emitter emitting particles from the inside of a cone.
  92653. * It emits the particles alongside the cone volume from the base to the particle.
  92654. * The emission direction might be randomized.
  92655. */
  92656. export class ConeParticleEmitter implements IParticleEmitterType {
  92657. /** defines how much to randomize the particle direction [0-1] (default is 0) */
  92658. directionRandomizer: number;
  92659. private _radius;
  92660. private _angle;
  92661. private _height;
  92662. /**
  92663. * Gets or sets a value indicating where on the radius the start position should be picked (1 = everywhere, 0 = only surface)
  92664. */
  92665. radiusRange: number;
  92666. /**
  92667. * Gets or sets a value indicating where on the height the start position should be picked (1 = everywhere, 0 = only surface)
  92668. */
  92669. heightRange: number;
  92670. /**
  92671. * Gets or sets a value indicating if all the particles should be emitted from the spawn point only (the base of the cone)
  92672. */
  92673. emitFromSpawnPointOnly: boolean;
  92674. /**
  92675. * Gets or sets the radius of the emission cone
  92676. */
  92677. get radius(): number;
  92678. set radius(value: number);
  92679. /**
  92680. * Gets or sets the angle of the emission cone
  92681. */
  92682. get angle(): number;
  92683. set angle(value: number);
  92684. private _buildHeight;
  92685. /**
  92686. * Creates a new instance ConeParticleEmitter
  92687. * @param radius the radius of the emission cone (1 by default)
  92688. * @param angle the cone base angle (PI by default)
  92689. * @param directionRandomizer defines how much to randomize the particle direction [0-1] (default is 0)
  92690. */
  92691. constructor(radius?: number, angle?: number,
  92692. /** defines how much to randomize the particle direction [0-1] (default is 0) */
  92693. directionRandomizer?: number);
  92694. /**
  92695. * Called by the particle System when the direction is computed for the created particle.
  92696. * @param worldMatrix is the world matrix of the particle system
  92697. * @param directionToUpdate is the direction vector to update with the result
  92698. * @param particle is the particle we are computed the direction for
  92699. * @param isLocal defines if the direction should be set in local space
  92700. */
  92701. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  92702. /**
  92703. * Called by the particle System when the position is computed for the created particle.
  92704. * @param worldMatrix is the world matrix of the particle system
  92705. * @param positionToUpdate is the position vector to update with the result
  92706. * @param particle is the particle we are computed the position for
  92707. * @param isLocal defines if the position should be set in local space
  92708. */
  92709. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  92710. /**
  92711. * Clones the current emitter and returns a copy of it
  92712. * @returns the new emitter
  92713. */
  92714. clone(): ConeParticleEmitter;
  92715. /**
  92716. * Called by the GPUParticleSystem to setup the update shader
  92717. * @param effect defines the update shader
  92718. */
  92719. applyToShader(effect: Effect): void;
  92720. /**
  92721. * Returns a string to use to update the GPU particles update shader
  92722. * @returns a string containng the defines string
  92723. */
  92724. getEffectDefines(): string;
  92725. /**
  92726. * Returns the string "ConeParticleEmitter"
  92727. * @returns a string containing the class name
  92728. */
  92729. getClassName(): string;
  92730. /**
  92731. * Serializes the particle system to a JSON object.
  92732. * @returns the JSON object
  92733. */
  92734. serialize(): any;
  92735. /**
  92736. * Parse properties from a JSON object
  92737. * @param serializationObject defines the JSON object
  92738. */
  92739. parse(serializationObject: any): void;
  92740. }
  92741. }
  92742. declare module BABYLON {
  92743. /**
  92744. * Particle emitter emitting particles from the inside of a cylinder.
  92745. * It emits the particles alongside the cylinder radius. The emission direction might be randomized.
  92746. */
  92747. export class CylinderParticleEmitter implements IParticleEmitterType {
  92748. /**
  92749. * The radius of the emission cylinder.
  92750. */
  92751. radius: number;
  92752. /**
  92753. * The height of the emission cylinder.
  92754. */
  92755. height: number;
  92756. /**
  92757. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  92758. */
  92759. radiusRange: number;
  92760. /**
  92761. * How much to randomize the particle direction [0-1].
  92762. */
  92763. directionRandomizer: number;
  92764. /**
  92765. * Creates a new instance CylinderParticleEmitter
  92766. * @param radius the radius of the emission cylinder (1 by default)
  92767. * @param height the height of the emission cylinder (1 by default)
  92768. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  92769. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  92770. */
  92771. constructor(
  92772. /**
  92773. * The radius of the emission cylinder.
  92774. */
  92775. radius?: number,
  92776. /**
  92777. * The height of the emission cylinder.
  92778. */
  92779. height?: number,
  92780. /**
  92781. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  92782. */
  92783. radiusRange?: number,
  92784. /**
  92785. * How much to randomize the particle direction [0-1].
  92786. */
  92787. directionRandomizer?: number);
  92788. /**
  92789. * Called by the particle System when the direction is computed for the created particle.
  92790. * @param worldMatrix is the world matrix of the particle system
  92791. * @param directionToUpdate is the direction vector to update with the result
  92792. * @param particle is the particle we are computed the direction for
  92793. * @param isLocal defines if the direction should be set in local space
  92794. */
  92795. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  92796. /**
  92797. * Called by the particle System when the position is computed for the created particle.
  92798. * @param worldMatrix is the world matrix of the particle system
  92799. * @param positionToUpdate is the position vector to update with the result
  92800. * @param particle is the particle we are computed the position for
  92801. * @param isLocal defines if the position should be set in local space
  92802. */
  92803. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  92804. /**
  92805. * Clones the current emitter and returns a copy of it
  92806. * @returns the new emitter
  92807. */
  92808. clone(): CylinderParticleEmitter;
  92809. /**
  92810. * Called by the GPUParticleSystem to setup the update shader
  92811. * @param effect defines the update shader
  92812. */
  92813. applyToShader(effect: Effect): void;
  92814. /**
  92815. * Returns a string to use to update the GPU particles update shader
  92816. * @returns a string containng the defines string
  92817. */
  92818. getEffectDefines(): string;
  92819. /**
  92820. * Returns the string "CylinderParticleEmitter"
  92821. * @returns a string containing the class name
  92822. */
  92823. getClassName(): string;
  92824. /**
  92825. * Serializes the particle system to a JSON object.
  92826. * @returns the JSON object
  92827. */
  92828. serialize(): any;
  92829. /**
  92830. * Parse properties from a JSON object
  92831. * @param serializationObject defines the JSON object
  92832. */
  92833. parse(serializationObject: any): void;
  92834. }
  92835. /**
  92836. * Particle emitter emitting particles from the inside of a cylinder.
  92837. * It emits the particles randomly between two vectors.
  92838. */
  92839. export class CylinderDirectedParticleEmitter extends CylinderParticleEmitter {
  92840. /**
  92841. * The min limit of the emission direction.
  92842. */
  92843. direction1: Vector3;
  92844. /**
  92845. * The max limit of the emission direction.
  92846. */
  92847. direction2: Vector3;
  92848. /**
  92849. * Creates a new instance CylinderDirectedParticleEmitter
  92850. * @param radius the radius of the emission cylinder (1 by default)
  92851. * @param height the height of the emission cylinder (1 by default)
  92852. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  92853. * @param direction1 the min limit of the emission direction (up vector by default)
  92854. * @param direction2 the max limit of the emission direction (up vector by default)
  92855. */
  92856. constructor(radius?: number, height?: number, radiusRange?: number,
  92857. /**
  92858. * The min limit of the emission direction.
  92859. */
  92860. direction1?: Vector3,
  92861. /**
  92862. * The max limit of the emission direction.
  92863. */
  92864. direction2?: Vector3);
  92865. /**
  92866. * Called by the particle System when the direction is computed for the created particle.
  92867. * @param worldMatrix is the world matrix of the particle system
  92868. * @param directionToUpdate is the direction vector to update with the result
  92869. * @param particle is the particle we are computed the direction for
  92870. */
  92871. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  92872. /**
  92873. * Clones the current emitter and returns a copy of it
  92874. * @returns the new emitter
  92875. */
  92876. clone(): CylinderDirectedParticleEmitter;
  92877. /**
  92878. * Called by the GPUParticleSystem to setup the update shader
  92879. * @param effect defines the update shader
  92880. */
  92881. applyToShader(effect: Effect): void;
  92882. /**
  92883. * Returns a string to use to update the GPU particles update shader
  92884. * @returns a string containng the defines string
  92885. */
  92886. getEffectDefines(): string;
  92887. /**
  92888. * Returns the string "CylinderDirectedParticleEmitter"
  92889. * @returns a string containing the class name
  92890. */
  92891. getClassName(): string;
  92892. /**
  92893. * Serializes the particle system to a JSON object.
  92894. * @returns the JSON object
  92895. */
  92896. serialize(): any;
  92897. /**
  92898. * Parse properties from a JSON object
  92899. * @param serializationObject defines the JSON object
  92900. */
  92901. parse(serializationObject: any): void;
  92902. }
  92903. }
  92904. declare module BABYLON {
  92905. /**
  92906. * Particle emitter emitting particles from the inside of a hemisphere.
  92907. * It emits the particles alongside the hemisphere radius. The emission direction might be randomized.
  92908. */
  92909. export class HemisphericParticleEmitter implements IParticleEmitterType {
  92910. /**
  92911. * The radius of the emission hemisphere.
  92912. */
  92913. radius: number;
  92914. /**
  92915. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  92916. */
  92917. radiusRange: number;
  92918. /**
  92919. * How much to randomize the particle direction [0-1].
  92920. */
  92921. directionRandomizer: number;
  92922. /**
  92923. * Creates a new instance HemisphericParticleEmitter
  92924. * @param radius the radius of the emission hemisphere (1 by default)
  92925. * @param radiusRange the range of the emission hemisphere [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  92926. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  92927. */
  92928. constructor(
  92929. /**
  92930. * The radius of the emission hemisphere.
  92931. */
  92932. radius?: number,
  92933. /**
  92934. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  92935. */
  92936. radiusRange?: number,
  92937. /**
  92938. * How much to randomize the particle direction [0-1].
  92939. */
  92940. directionRandomizer?: number);
  92941. /**
  92942. * Called by the particle System when the direction is computed for the created particle.
  92943. * @param worldMatrix is the world matrix of the particle system
  92944. * @param directionToUpdate is the direction vector to update with the result
  92945. * @param particle is the particle we are computed the direction for
  92946. * @param isLocal defines if the direction should be set in local space
  92947. */
  92948. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  92949. /**
  92950. * Called by the particle System when the position is computed for the created particle.
  92951. * @param worldMatrix is the world matrix of the particle system
  92952. * @param positionToUpdate is the position vector to update with the result
  92953. * @param particle is the particle we are computed the position for
  92954. * @param isLocal defines if the position should be set in local space
  92955. */
  92956. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  92957. /**
  92958. * Clones the current emitter and returns a copy of it
  92959. * @returns the new emitter
  92960. */
  92961. clone(): HemisphericParticleEmitter;
  92962. /**
  92963. * Called by the GPUParticleSystem to setup the update shader
  92964. * @param effect defines the update shader
  92965. */
  92966. applyToShader(effect: Effect): void;
  92967. /**
  92968. * Returns a string to use to update the GPU particles update shader
  92969. * @returns a string containng the defines string
  92970. */
  92971. getEffectDefines(): string;
  92972. /**
  92973. * Returns the string "HemisphericParticleEmitter"
  92974. * @returns a string containing the class name
  92975. */
  92976. getClassName(): string;
  92977. /**
  92978. * Serializes the particle system to a JSON object.
  92979. * @returns the JSON object
  92980. */
  92981. serialize(): any;
  92982. /**
  92983. * Parse properties from a JSON object
  92984. * @param serializationObject defines the JSON object
  92985. */
  92986. parse(serializationObject: any): void;
  92987. }
  92988. }
  92989. declare module BABYLON {
  92990. /**
  92991. * Particle emitter emitting particles from a point.
  92992. * It emits the particles randomly between 2 given directions.
  92993. */
  92994. export class PointParticleEmitter implements IParticleEmitterType {
  92995. /**
  92996. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  92997. */
  92998. direction1: Vector3;
  92999. /**
  93000. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  93001. */
  93002. direction2: Vector3;
  93003. /**
  93004. * Creates a new instance PointParticleEmitter
  93005. */
  93006. constructor();
  93007. /**
  93008. * Called by the particle System when the direction is computed for the created particle.
  93009. * @param worldMatrix is the world matrix of the particle system
  93010. * @param directionToUpdate is the direction vector to update with the result
  93011. * @param particle is the particle we are computed the direction for
  93012. * @param isLocal defines if the direction should be set in local space
  93013. */
  93014. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93015. /**
  93016. * Called by the particle System when the position is computed for the created particle.
  93017. * @param worldMatrix is the world matrix of the particle system
  93018. * @param positionToUpdate is the position vector to update with the result
  93019. * @param particle is the particle we are computed the position for
  93020. * @param isLocal defines if the position should be set in local space
  93021. */
  93022. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93023. /**
  93024. * Clones the current emitter and returns a copy of it
  93025. * @returns the new emitter
  93026. */
  93027. clone(): PointParticleEmitter;
  93028. /**
  93029. * Called by the GPUParticleSystem to setup the update shader
  93030. * @param effect defines the update shader
  93031. */
  93032. applyToShader(effect: Effect): void;
  93033. /**
  93034. * Returns a string to use to update the GPU particles update shader
  93035. * @returns a string containng the defines string
  93036. */
  93037. getEffectDefines(): string;
  93038. /**
  93039. * Returns the string "PointParticleEmitter"
  93040. * @returns a string containing the class name
  93041. */
  93042. getClassName(): string;
  93043. /**
  93044. * Serializes the particle system to a JSON object.
  93045. * @returns the JSON object
  93046. */
  93047. serialize(): any;
  93048. /**
  93049. * Parse properties from a JSON object
  93050. * @param serializationObject defines the JSON object
  93051. */
  93052. parse(serializationObject: any): void;
  93053. }
  93054. }
  93055. declare module BABYLON {
  93056. /**
  93057. * Particle emitter emitting particles from the inside of a sphere.
  93058. * It emits the particles alongside the sphere radius. The emission direction might be randomized.
  93059. */
  93060. export class SphereParticleEmitter implements IParticleEmitterType {
  93061. /**
  93062. * The radius of the emission sphere.
  93063. */
  93064. radius: number;
  93065. /**
  93066. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  93067. */
  93068. radiusRange: number;
  93069. /**
  93070. * How much to randomize the particle direction [0-1].
  93071. */
  93072. directionRandomizer: number;
  93073. /**
  93074. * Creates a new instance SphereParticleEmitter
  93075. * @param radius the radius of the emission sphere (1 by default)
  93076. * @param radiusRange the range of the emission sphere [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  93077. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  93078. */
  93079. constructor(
  93080. /**
  93081. * The radius of the emission sphere.
  93082. */
  93083. radius?: number,
  93084. /**
  93085. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  93086. */
  93087. radiusRange?: number,
  93088. /**
  93089. * How much to randomize the particle direction [0-1].
  93090. */
  93091. directionRandomizer?: number);
  93092. /**
  93093. * Called by the particle System when the direction is computed for the created particle.
  93094. * @param worldMatrix is the world matrix of the particle system
  93095. * @param directionToUpdate is the direction vector to update with the result
  93096. * @param particle is the particle we are computed the direction for
  93097. * @param isLocal defines if the direction should be set in local space
  93098. */
  93099. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93100. /**
  93101. * Called by the particle System when the position is computed for the created particle.
  93102. * @param worldMatrix is the world matrix of the particle system
  93103. * @param positionToUpdate is the position vector to update with the result
  93104. * @param particle is the particle we are computed the position for
  93105. * @param isLocal defines if the position should be set in local space
  93106. */
  93107. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93108. /**
  93109. * Clones the current emitter and returns a copy of it
  93110. * @returns the new emitter
  93111. */
  93112. clone(): SphereParticleEmitter;
  93113. /**
  93114. * Called by the GPUParticleSystem to setup the update shader
  93115. * @param effect defines the update shader
  93116. */
  93117. applyToShader(effect: Effect): void;
  93118. /**
  93119. * Returns a string to use to update the GPU particles update shader
  93120. * @returns a string containng the defines string
  93121. */
  93122. getEffectDefines(): string;
  93123. /**
  93124. * Returns the string "SphereParticleEmitter"
  93125. * @returns a string containing the class name
  93126. */
  93127. getClassName(): string;
  93128. /**
  93129. * Serializes the particle system to a JSON object.
  93130. * @returns the JSON object
  93131. */
  93132. serialize(): any;
  93133. /**
  93134. * Parse properties from a JSON object
  93135. * @param serializationObject defines the JSON object
  93136. */
  93137. parse(serializationObject: any): void;
  93138. }
  93139. /**
  93140. * Particle emitter emitting particles from the inside of a sphere.
  93141. * It emits the particles randomly between two vectors.
  93142. */
  93143. export class SphereDirectedParticleEmitter extends SphereParticleEmitter {
  93144. /**
  93145. * The min limit of the emission direction.
  93146. */
  93147. direction1: Vector3;
  93148. /**
  93149. * The max limit of the emission direction.
  93150. */
  93151. direction2: Vector3;
  93152. /**
  93153. * Creates a new instance SphereDirectedParticleEmitter
  93154. * @param radius the radius of the emission sphere (1 by default)
  93155. * @param direction1 the min limit of the emission direction (up vector by default)
  93156. * @param direction2 the max limit of the emission direction (up vector by default)
  93157. */
  93158. constructor(radius?: number,
  93159. /**
  93160. * The min limit of the emission direction.
  93161. */
  93162. direction1?: Vector3,
  93163. /**
  93164. * The max limit of the emission direction.
  93165. */
  93166. direction2?: Vector3);
  93167. /**
  93168. * Called by the particle System when the direction is computed for the created particle.
  93169. * @param worldMatrix is the world matrix of the particle system
  93170. * @param directionToUpdate is the direction vector to update with the result
  93171. * @param particle is the particle we are computed the direction for
  93172. */
  93173. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  93174. /**
  93175. * Clones the current emitter and returns a copy of it
  93176. * @returns the new emitter
  93177. */
  93178. clone(): SphereDirectedParticleEmitter;
  93179. /**
  93180. * Called by the GPUParticleSystem to setup the update shader
  93181. * @param effect defines the update shader
  93182. */
  93183. applyToShader(effect: Effect): void;
  93184. /**
  93185. * Returns a string to use to update the GPU particles update shader
  93186. * @returns a string containng the defines string
  93187. */
  93188. getEffectDefines(): string;
  93189. /**
  93190. * Returns the string "SphereDirectedParticleEmitter"
  93191. * @returns a string containing the class name
  93192. */
  93193. getClassName(): string;
  93194. /**
  93195. * Serializes the particle system to a JSON object.
  93196. * @returns the JSON object
  93197. */
  93198. serialize(): any;
  93199. /**
  93200. * Parse properties from a JSON object
  93201. * @param serializationObject defines the JSON object
  93202. */
  93203. parse(serializationObject: any): void;
  93204. }
  93205. }
  93206. declare module BABYLON {
  93207. /**
  93208. * Particle emitter emitting particles from a custom list of positions.
  93209. */
  93210. export class CustomParticleEmitter implements IParticleEmitterType {
  93211. /**
  93212. * Gets or sets the position generator that will create the inital position of each particle.
  93213. * Index will be provided when used with GPU particle. Particle will be provided when used with CPU particles
  93214. */
  93215. particlePositionGenerator: (index: number, particle: Nullable<Particle>, outPosition: Vector3) => void;
  93216. /**
  93217. * Gets or sets the destination generator that will create the final destination of each particle.
  93218. * * Index will be provided when used with GPU particle. Particle will be provided when used with CPU particles
  93219. */
  93220. particleDestinationGenerator: (index: number, particle: Nullable<Particle>, outDestination: Vector3) => void;
  93221. /**
  93222. * Creates a new instance CustomParticleEmitter
  93223. */
  93224. constructor();
  93225. /**
  93226. * Called by the particle System when the direction is computed for the created particle.
  93227. * @param worldMatrix is the world matrix of the particle system
  93228. * @param directionToUpdate is the direction vector to update with the result
  93229. * @param particle is the particle we are computed the direction for
  93230. * @param isLocal defines if the direction should be set in local space
  93231. */
  93232. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93233. /**
  93234. * Called by the particle System when the position is computed for the created particle.
  93235. * @param worldMatrix is the world matrix of the particle system
  93236. * @param positionToUpdate is the position vector to update with the result
  93237. * @param particle is the particle we are computed the position for
  93238. * @param isLocal defines if the position should be set in local space
  93239. */
  93240. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93241. /**
  93242. * Clones the current emitter and returns a copy of it
  93243. * @returns the new emitter
  93244. */
  93245. clone(): CustomParticleEmitter;
  93246. /**
  93247. * Called by the GPUParticleSystem to setup the update shader
  93248. * @param effect defines the update shader
  93249. */
  93250. applyToShader(effect: Effect): void;
  93251. /**
  93252. * Returns a string to use to update the GPU particles update shader
  93253. * @returns a string containng the defines string
  93254. */
  93255. getEffectDefines(): string;
  93256. /**
  93257. * Returns the string "PointParticleEmitter"
  93258. * @returns a string containing the class name
  93259. */
  93260. getClassName(): string;
  93261. /**
  93262. * Serializes the particle system to a JSON object.
  93263. * @returns the JSON object
  93264. */
  93265. serialize(): any;
  93266. /**
  93267. * Parse properties from a JSON object
  93268. * @param serializationObject defines the JSON object
  93269. */
  93270. parse(serializationObject: any): void;
  93271. }
  93272. }
  93273. declare module BABYLON {
  93274. /**
  93275. * Particle emitter emitting particles from the inside of a box.
  93276. * It emits the particles randomly between 2 given directions.
  93277. */
  93278. export class MeshParticleEmitter implements IParticleEmitterType {
  93279. private _indices;
  93280. private _positions;
  93281. private _normals;
  93282. private _storedNormal;
  93283. private _mesh;
  93284. /**
  93285. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  93286. */
  93287. direction1: Vector3;
  93288. /**
  93289. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  93290. */
  93291. direction2: Vector3;
  93292. /**
  93293. * Gets or sets a boolean indicating that particle directions must be built from mesh face normals
  93294. */
  93295. useMeshNormalsForDirection: boolean;
  93296. /** Defines the mesh to use as source */
  93297. get mesh(): Nullable<AbstractMesh>;
  93298. set mesh(value: Nullable<AbstractMesh>);
  93299. /**
  93300. * Creates a new instance MeshParticleEmitter
  93301. * @param mesh defines the mesh to use as source
  93302. */
  93303. constructor(mesh?: Nullable<AbstractMesh>);
  93304. /**
  93305. * Called by the particle System when the direction is computed for the created particle.
  93306. * @param worldMatrix is the world matrix of the particle system
  93307. * @param directionToUpdate is the direction vector to update with the result
  93308. * @param particle is the particle we are computed the direction for
  93309. * @param isLocal defines if the direction should be set in local space
  93310. */
  93311. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93312. /**
  93313. * Called by the particle System when the position is computed for the created particle.
  93314. * @param worldMatrix is the world matrix of the particle system
  93315. * @param positionToUpdate is the position vector to update with the result
  93316. * @param particle is the particle we are computed the position for
  93317. * @param isLocal defines if the position should be set in local space
  93318. */
  93319. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93320. /**
  93321. * Clones the current emitter and returns a copy of it
  93322. * @returns the new emitter
  93323. */
  93324. clone(): MeshParticleEmitter;
  93325. /**
  93326. * Called by the GPUParticleSystem to setup the update shader
  93327. * @param effect defines the update shader
  93328. */
  93329. applyToShader(effect: Effect): void;
  93330. /**
  93331. * Returns a string to use to update the GPU particles update shader
  93332. * @returns a string containng the defines string
  93333. */
  93334. getEffectDefines(): string;
  93335. /**
  93336. * Returns the string "BoxParticleEmitter"
  93337. * @returns a string containing the class name
  93338. */
  93339. getClassName(): string;
  93340. /**
  93341. * Serializes the particle system to a JSON object.
  93342. * @returns the JSON object
  93343. */
  93344. serialize(): any;
  93345. /**
  93346. * Parse properties from a JSON object
  93347. * @param serializationObject defines the JSON object
  93348. * @param scene defines the hosting scene
  93349. */
  93350. parse(serializationObject: any, scene: Nullable<Scene>): void;
  93351. }
  93352. }
  93353. declare module BABYLON {
  93354. /**
  93355. * Interface representing a particle system in Babylon.js.
  93356. * This groups the common functionalities that needs to be implemented in order to create a particle system.
  93357. * A particle system represents a way to manage particles from their emission to their animation and rendering.
  93358. */
  93359. export interface IParticleSystem {
  93360. /**
  93361. * List of animations used by the particle system.
  93362. */
  93363. animations: Animation[];
  93364. /**
  93365. * The id of the Particle system.
  93366. */
  93367. id: string;
  93368. /**
  93369. * The name of the Particle system.
  93370. */
  93371. name: string;
  93372. /**
  93373. * The emitter represents the Mesh or position we are attaching the particle system to.
  93374. */
  93375. emitter: Nullable<AbstractMesh | Vector3>;
  93376. /**
  93377. * Gets or sets a boolean indicating if the particles must be rendered as billboard or aligned with the direction
  93378. */
  93379. isBillboardBased: boolean;
  93380. /**
  93381. * The rendering group used by the Particle system to chose when to render.
  93382. */
  93383. renderingGroupId: number;
  93384. /**
  93385. * The layer mask we are rendering the particles through.
  93386. */
  93387. layerMask: number;
  93388. /**
  93389. * The overall motion speed (0.01 is default update speed, faster updates = faster animation)
  93390. */
  93391. updateSpeed: number;
  93392. /**
  93393. * The amount of time the particle system is running (depends of the overall update speed).
  93394. */
  93395. targetStopDuration: number;
  93396. /**
  93397. * The texture used to render each particle. (this can be a spritesheet)
  93398. */
  93399. particleTexture: Nullable<BaseTexture>;
  93400. /**
  93401. * Blend mode use to render the particle, it can be either ParticleSystem.BLENDMODE_ONEONE, ParticleSystem.BLENDMODE_STANDARD or ParticleSystem.BLENDMODE_ADD.
  93402. */
  93403. blendMode: number;
  93404. /**
  93405. * Minimum life time of emitting particles.
  93406. */
  93407. minLifeTime: number;
  93408. /**
  93409. * Maximum life time of emitting particles.
  93410. */
  93411. maxLifeTime: number;
  93412. /**
  93413. * Minimum Size of emitting particles.
  93414. */
  93415. minSize: number;
  93416. /**
  93417. * Maximum Size of emitting particles.
  93418. */
  93419. maxSize: number;
  93420. /**
  93421. * Minimum scale of emitting particles on X axis.
  93422. */
  93423. minScaleX: number;
  93424. /**
  93425. * Maximum scale of emitting particles on X axis.
  93426. */
  93427. maxScaleX: number;
  93428. /**
  93429. * Minimum scale of emitting particles on Y axis.
  93430. */
  93431. minScaleY: number;
  93432. /**
  93433. * Maximum scale of emitting particles on Y axis.
  93434. */
  93435. maxScaleY: number;
  93436. /**
  93437. * Random color of each particle after it has been emitted, between color1 and color2 vectors.
  93438. */
  93439. color1: Color4;
  93440. /**
  93441. * Random color of each particle after it has been emitted, between color1 and color2 vectors.
  93442. */
  93443. color2: Color4;
  93444. /**
  93445. * Color the particle will have at the end of its lifetime.
  93446. */
  93447. colorDead: Color4;
  93448. /**
  93449. * The maximum number of particles to emit per frame until we reach the activeParticleCount value
  93450. */
  93451. emitRate: number;
  93452. /**
  93453. * You can use gravity if you want to give an orientation to your particles.
  93454. */
  93455. gravity: Vector3;
  93456. /**
  93457. * Minimum power of emitting particles.
  93458. */
  93459. minEmitPower: number;
  93460. /**
  93461. * Maximum power of emitting particles.
  93462. */
  93463. maxEmitPower: number;
  93464. /**
  93465. * Minimum angular speed of emitting particles (Z-axis rotation for each particle).
  93466. */
  93467. minAngularSpeed: number;
  93468. /**
  93469. * Maximum angular speed of emitting particles (Z-axis rotation for each particle).
  93470. */
  93471. maxAngularSpeed: number;
  93472. /**
  93473. * Gets or sets the minimal initial rotation in radians.
  93474. */
  93475. minInitialRotation: number;
  93476. /**
  93477. * Gets or sets the maximal initial rotation in radians.
  93478. */
  93479. maxInitialRotation: number;
  93480. /**
  93481. * The particle emitter type defines the emitter used by the particle system.
  93482. * It can be for example box, sphere, or cone...
  93483. */
  93484. particleEmitterType: Nullable<IParticleEmitterType>;
  93485. /**
  93486. * Defines the delay in milliseconds before starting the system (0 by default)
  93487. */
  93488. startDelay: number;
  93489. /**
  93490. * 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
  93491. */
  93492. preWarmCycles: number;
  93493. /**
  93494. * Gets or sets a value indicating the time step multiplier to use in pre-warm mode (default is 1)
  93495. */
  93496. preWarmStepOffset: number;
  93497. /**
  93498. * 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)
  93499. */
  93500. spriteCellChangeSpeed: number;
  93501. /**
  93502. * If using a spritesheet (isAnimationSheetEnabled) defines the first sprite cell to display
  93503. */
  93504. startSpriteCellID: number;
  93505. /**
  93506. * If using a spritesheet (isAnimationSheetEnabled) defines the last sprite cell to display
  93507. */
  93508. endSpriteCellID: number;
  93509. /**
  93510. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell width to use
  93511. */
  93512. spriteCellWidth: number;
  93513. /**
  93514. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell height to use
  93515. */
  93516. spriteCellHeight: number;
  93517. /**
  93518. * This allows the system to random pick the start cell ID between startSpriteCellID and endSpriteCellID
  93519. */
  93520. spriteRandomStartCell: boolean;
  93521. /**
  93522. * Gets or sets a boolean indicating if a spritesheet is used to animate the particles texture
  93523. */
  93524. isAnimationSheetEnabled: boolean;
  93525. /** Gets or sets a Vector2 used to move the pivot (by default (0,0)) */
  93526. translationPivot: Vector2;
  93527. /**
  93528. * Gets or sets a texture used to add random noise to particle positions
  93529. */
  93530. noiseTexture: Nullable<BaseTexture>;
  93531. /** Gets or sets the strength to apply to the noise value (default is (10, 10, 10)) */
  93532. noiseStrength: Vector3;
  93533. /**
  93534. * Gets or sets the billboard mode to use when isBillboardBased = true.
  93535. * Value can be: ParticleSystem.BILLBOARDMODE_ALL, ParticleSystem.BILLBOARDMODE_Y, ParticleSystem.BILLBOARDMODE_STRETCHED
  93536. */
  93537. billboardMode: number;
  93538. /** Gets or sets a value indicating the damping to apply if the limit velocity factor is reached */
  93539. limitVelocityDamping: number;
  93540. /**
  93541. * Gets or sets a boolean indicating that hosted animations (in the system.animations array) must be started when system.start() is called
  93542. */
  93543. beginAnimationOnStart: boolean;
  93544. /**
  93545. * Gets or sets the frame to start the animation from when beginAnimationOnStart is true
  93546. */
  93547. beginAnimationFrom: number;
  93548. /**
  93549. * Gets or sets the frame to end the animation on when beginAnimationOnStart is true
  93550. */
  93551. beginAnimationTo: number;
  93552. /**
  93553. * Gets or sets a boolean indicating if animations must loop when beginAnimationOnStart is true
  93554. */
  93555. beginAnimationLoop: boolean;
  93556. /**
  93557. * Specifies whether the particle system will be disposed once it reaches the end of the animation.
  93558. */
  93559. disposeOnStop: boolean;
  93560. /**
  93561. * Specifies if the particles are updated in emitter local space or world space
  93562. */
  93563. isLocal: boolean;
  93564. /** Snippet ID if the particle system was created from the snippet server */
  93565. snippetId: string;
  93566. /** Gets or sets a matrix to use to compute projection */
  93567. defaultProjectionMatrix: Matrix;
  93568. /**
  93569. * Gets the maximum number of particles active at the same time.
  93570. * @returns The max number of active particles.
  93571. */
  93572. getCapacity(): number;
  93573. /**
  93574. * Gets the number of particles active at the same time.
  93575. * @returns The number of active particles.
  93576. */
  93577. getActiveCount(): number;
  93578. /**
  93579. * Gets if the system has been started. (Note: this will still be true after stop is called)
  93580. * @returns True if it has been started, otherwise false.
  93581. */
  93582. isStarted(): boolean;
  93583. /**
  93584. * Animates the particle system for this frame.
  93585. */
  93586. animate(): void;
  93587. /**
  93588. * Renders the particle system in its current state.
  93589. * @returns the current number of particles
  93590. */
  93591. render(): number;
  93592. /**
  93593. * Dispose the particle system and frees its associated resources.
  93594. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  93595. */
  93596. dispose(disposeTexture?: boolean): void;
  93597. /**
  93598. * An event triggered when the system is disposed
  93599. */
  93600. onDisposeObservable: Observable<IParticleSystem>;
  93601. /**
  93602. * Clones the particle system.
  93603. * @param name The name of the cloned object
  93604. * @param newEmitter The new emitter to use
  93605. * @returns the cloned particle system
  93606. */
  93607. clone(name: string, newEmitter: any): Nullable<IParticleSystem>;
  93608. /**
  93609. * Serializes the particle system to a JSON object
  93610. * @param serializeTexture defines if the texture must be serialized as well
  93611. * @returns the JSON object
  93612. */
  93613. serialize(serializeTexture: boolean): any;
  93614. /**
  93615. * Rebuild the particle system
  93616. */
  93617. rebuild(): void;
  93618. /** Force the system to rebuild all gradients that need to be resync */
  93619. forceRefreshGradients(): void;
  93620. /**
  93621. * Starts the particle system and begins to emit
  93622. * @param delay defines the delay in milliseconds before starting the system (0 by default)
  93623. */
  93624. start(delay?: number): void;
  93625. /**
  93626. * Stops the particle system.
  93627. */
  93628. stop(): void;
  93629. /**
  93630. * Remove all active particles
  93631. */
  93632. reset(): void;
  93633. /**
  93634. * Gets a boolean indicating that the system is stopping
  93635. * @returns true if the system is currently stopping
  93636. */
  93637. isStopping(): boolean;
  93638. /**
  93639. * Is this system ready to be used/rendered
  93640. * @return true if the system is ready
  93641. */
  93642. isReady(): boolean;
  93643. /**
  93644. * Returns the string "ParticleSystem"
  93645. * @returns a string containing the class name
  93646. */
  93647. getClassName(): string;
  93648. /**
  93649. * Gets the custom effect used to render the particles
  93650. * @param blendMode Blend mode for which the effect should be retrieved
  93651. * @returns The effect
  93652. */
  93653. getCustomEffect(blendMode: number): Nullable<Effect>;
  93654. /**
  93655. * Sets the custom effect used to render the particles
  93656. * @param effect The effect to set
  93657. * @param blendMode Blend mode for which the effect should be set
  93658. */
  93659. setCustomEffect(effect: Nullable<Effect>, blendMode: number): void;
  93660. /**
  93661. * Fill the defines array according to the current settings of the particle system
  93662. * @param defines Array to be updated
  93663. * @param blendMode blend mode to take into account when updating the array
  93664. */
  93665. fillDefines(defines: Array<string>, blendMode: number): void;
  93666. /**
  93667. * Fill the uniforms, attributes and samplers arrays according to the current settings of the particle system
  93668. * @param uniforms Uniforms array to fill
  93669. * @param attributes Attributes array to fill
  93670. * @param samplers Samplers array to fill
  93671. */
  93672. fillUniformsAttributesAndSamplerNames(uniforms: Array<string>, attributes: Array<string>, samplers: Array<string>): void;
  93673. /**
  93674. * Observable that will be called just before the particles are drawn
  93675. */
  93676. onBeforeDrawParticlesObservable: Observable<Nullable<Effect>>;
  93677. /**
  93678. * Gets the name of the particle vertex shader
  93679. */
  93680. vertexShaderName: string;
  93681. /**
  93682. * Adds a new color gradient
  93683. * @param gradient defines the gradient to use (between 0 and 1)
  93684. * @param color1 defines the color to affect to the specified gradient
  93685. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  93686. * @returns the current particle system
  93687. */
  93688. addColorGradient(gradient: number, color1: Color4, color2?: Color4): IParticleSystem;
  93689. /**
  93690. * Remove a specific color gradient
  93691. * @param gradient defines the gradient to remove
  93692. * @returns the current particle system
  93693. */
  93694. removeColorGradient(gradient: number): IParticleSystem;
  93695. /**
  93696. * Adds a new size gradient
  93697. * @param gradient defines the gradient to use (between 0 and 1)
  93698. * @param factor defines the size factor to affect to the specified gradient
  93699. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  93700. * @returns the current particle system
  93701. */
  93702. addSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  93703. /**
  93704. * Remove a specific size gradient
  93705. * @param gradient defines the gradient to remove
  93706. * @returns the current particle system
  93707. */
  93708. removeSizeGradient(gradient: number): IParticleSystem;
  93709. /**
  93710. * Gets the current list of color gradients.
  93711. * You must use addColorGradient and removeColorGradient to udpate this list
  93712. * @returns the list of color gradients
  93713. */
  93714. getColorGradients(): Nullable<Array<ColorGradient>>;
  93715. /**
  93716. * Gets the current list of size gradients.
  93717. * You must use addSizeGradient and removeSizeGradient to udpate this list
  93718. * @returns the list of size gradients
  93719. */
  93720. getSizeGradients(): Nullable<Array<FactorGradient>>;
  93721. /**
  93722. * Gets the current list of angular speed gradients.
  93723. * You must use addAngularSpeedGradient and removeAngularSpeedGradient to udpate this list
  93724. * @returns the list of angular speed gradients
  93725. */
  93726. getAngularSpeedGradients(): Nullable<Array<FactorGradient>>;
  93727. /**
  93728. * Adds a new angular speed gradient
  93729. * @param gradient defines the gradient to use (between 0 and 1)
  93730. * @param factor defines the angular speed to affect to the specified gradient
  93731. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  93732. * @returns the current particle system
  93733. */
  93734. addAngularSpeedGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  93735. /**
  93736. * Remove a specific angular speed gradient
  93737. * @param gradient defines the gradient to remove
  93738. * @returns the current particle system
  93739. */
  93740. removeAngularSpeedGradient(gradient: number): IParticleSystem;
  93741. /**
  93742. * Gets the current list of velocity gradients.
  93743. * You must use addVelocityGradient and removeVelocityGradient to udpate this list
  93744. * @returns the list of velocity gradients
  93745. */
  93746. getVelocityGradients(): Nullable<Array<FactorGradient>>;
  93747. /**
  93748. * Adds a new velocity gradient
  93749. * @param gradient defines the gradient to use (between 0 and 1)
  93750. * @param factor defines the velocity to affect to the specified gradient
  93751. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  93752. * @returns the current particle system
  93753. */
  93754. addVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  93755. /**
  93756. * Remove a specific velocity gradient
  93757. * @param gradient defines the gradient to remove
  93758. * @returns the current particle system
  93759. */
  93760. removeVelocityGradient(gradient: number): IParticleSystem;
  93761. /**
  93762. * Gets the current list of limit velocity gradients.
  93763. * You must use addLimitVelocityGradient and removeLimitVelocityGradient to udpate this list
  93764. * @returns the list of limit velocity gradients
  93765. */
  93766. getLimitVelocityGradients(): Nullable<Array<FactorGradient>>;
  93767. /**
  93768. * Adds a new limit velocity gradient
  93769. * @param gradient defines the gradient to use (between 0 and 1)
  93770. * @param factor defines the limit velocity to affect to the specified gradient
  93771. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  93772. * @returns the current particle system
  93773. */
  93774. addLimitVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  93775. /**
  93776. * Remove a specific limit velocity gradient
  93777. * @param gradient defines the gradient to remove
  93778. * @returns the current particle system
  93779. */
  93780. removeLimitVelocityGradient(gradient: number): IParticleSystem;
  93781. /**
  93782. * Adds a new drag gradient
  93783. * @param gradient defines the gradient to use (between 0 and 1)
  93784. * @param factor defines the drag to affect to the specified gradient
  93785. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  93786. * @returns the current particle system
  93787. */
  93788. addDragGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  93789. /**
  93790. * Remove a specific drag gradient
  93791. * @param gradient defines the gradient to remove
  93792. * @returns the current particle system
  93793. */
  93794. removeDragGradient(gradient: number): IParticleSystem;
  93795. /**
  93796. * Gets the current list of drag gradients.
  93797. * You must use addDragGradient and removeDragGradient to udpate this list
  93798. * @returns the list of drag gradients
  93799. */
  93800. getDragGradients(): Nullable<Array<FactorGradient>>;
  93801. /**
  93802. * Adds a new emit rate gradient (please note that this will only work if you set the targetStopDuration property)
  93803. * @param gradient defines the gradient to use (between 0 and 1)
  93804. * @param factor defines the emit rate to affect to the specified gradient
  93805. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  93806. * @returns the current particle system
  93807. */
  93808. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  93809. /**
  93810. * Remove a specific emit rate gradient
  93811. * @param gradient defines the gradient to remove
  93812. * @returns the current particle system
  93813. */
  93814. removeEmitRateGradient(gradient: number): IParticleSystem;
  93815. /**
  93816. * Gets the current list of emit rate gradients.
  93817. * You must use addEmitRateGradient and removeEmitRateGradient to udpate this list
  93818. * @returns the list of emit rate gradients
  93819. */
  93820. getEmitRateGradients(): Nullable<Array<FactorGradient>>;
  93821. /**
  93822. * Adds a new start size gradient (please note that this will only work if you set the targetStopDuration property)
  93823. * @param gradient defines the gradient to use (between 0 and 1)
  93824. * @param factor defines the start size to affect to the specified gradient
  93825. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  93826. * @returns the current particle system
  93827. */
  93828. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  93829. /**
  93830. * Remove a specific start size gradient
  93831. * @param gradient defines the gradient to remove
  93832. * @returns the current particle system
  93833. */
  93834. removeStartSizeGradient(gradient: number): IParticleSystem;
  93835. /**
  93836. * Gets the current list of start size gradients.
  93837. * You must use addStartSizeGradient and removeStartSizeGradient to udpate this list
  93838. * @returns the list of start size gradients
  93839. */
  93840. getStartSizeGradients(): Nullable<Array<FactorGradient>>;
  93841. /**
  93842. * Adds a new life time gradient
  93843. * @param gradient defines the gradient to use (between 0 and 1)
  93844. * @param factor defines the life time factor to affect to the specified gradient
  93845. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  93846. * @returns the current particle system
  93847. */
  93848. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  93849. /**
  93850. * Remove a specific life time gradient
  93851. * @param gradient defines the gradient to remove
  93852. * @returns the current particle system
  93853. */
  93854. removeLifeTimeGradient(gradient: number): IParticleSystem;
  93855. /**
  93856. * Gets the current list of life time gradients.
  93857. * You must use addLifeTimeGradient and removeLifeTimeGradient to udpate this list
  93858. * @returns the list of life time gradients
  93859. */
  93860. getLifeTimeGradients(): Nullable<Array<FactorGradient>>;
  93861. /**
  93862. * Gets the current list of color gradients.
  93863. * You must use addColorGradient and removeColorGradient to udpate this list
  93864. * @returns the list of color gradients
  93865. */
  93866. getColorGradients(): Nullable<Array<ColorGradient>>;
  93867. /**
  93868. * Adds a new ramp gradient used to remap particle colors
  93869. * @param gradient defines the gradient to use (between 0 and 1)
  93870. * @param color defines the color to affect to the specified gradient
  93871. * @returns the current particle system
  93872. */
  93873. addRampGradient(gradient: number, color: Color3): IParticleSystem;
  93874. /**
  93875. * Gets the current list of ramp gradients.
  93876. * You must use addRampGradient and removeRampGradient to udpate this list
  93877. * @returns the list of ramp gradients
  93878. */
  93879. getRampGradients(): Nullable<Array<Color3Gradient>>;
  93880. /** Gets or sets a boolean indicating that ramp gradients must be used
  93881. * @see https://doc.babylonjs.com/babylon101/particles#ramp-gradients
  93882. */
  93883. useRampGradients: boolean;
  93884. /**
  93885. * Adds a new color remap gradient
  93886. * @param gradient defines the gradient to use (between 0 and 1)
  93887. * @param min defines the color remap minimal range
  93888. * @param max defines the color remap maximal range
  93889. * @returns the current particle system
  93890. */
  93891. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  93892. /**
  93893. * Gets the current list of color remap gradients.
  93894. * You must use addColorRemapGradient and removeColorRemapGradient to udpate this list
  93895. * @returns the list of color remap gradients
  93896. */
  93897. getColorRemapGradients(): Nullable<Array<FactorGradient>>;
  93898. /**
  93899. * Adds a new alpha remap gradient
  93900. * @param gradient defines the gradient to use (between 0 and 1)
  93901. * @param min defines the alpha remap minimal range
  93902. * @param max defines the alpha remap maximal range
  93903. * @returns the current particle system
  93904. */
  93905. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  93906. /**
  93907. * Gets the current list of alpha remap gradients.
  93908. * You must use addAlphaRemapGradient and removeAlphaRemapGradient to udpate this list
  93909. * @returns the list of alpha remap gradients
  93910. */
  93911. getAlphaRemapGradients(): Nullable<Array<FactorGradient>>;
  93912. /**
  93913. * Creates a Point Emitter for the particle system (emits directly from the emitter position)
  93914. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  93915. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  93916. * @returns the emitter
  93917. */
  93918. createPointEmitter(direction1: Vector3, direction2: Vector3): PointParticleEmitter;
  93919. /**
  93920. * Creates a Hemisphere Emitter for the particle system (emits along the hemisphere radius)
  93921. * @param radius The radius of the hemisphere to emit from
  93922. * @param radiusRange The range of the hemisphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  93923. * @returns the emitter
  93924. */
  93925. createHemisphericEmitter(radius: number, radiusRange: number): HemisphericParticleEmitter;
  93926. /**
  93927. * Creates a Sphere Emitter for the particle system (emits along the sphere radius)
  93928. * @param radius The radius of the sphere to emit from
  93929. * @param radiusRange The range of the sphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  93930. * @returns the emitter
  93931. */
  93932. createSphereEmitter(radius: number, radiusRange: number): SphereParticleEmitter;
  93933. /**
  93934. * Creates a Directed Sphere Emitter for the particle system (emits between direction1 and direction2)
  93935. * @param radius The radius of the sphere to emit from
  93936. * @param direction1 Particles are emitted between the direction1 and direction2 from within the sphere
  93937. * @param direction2 Particles are emitted between the direction1 and direction2 from within the sphere
  93938. * @returns the emitter
  93939. */
  93940. createDirectedSphereEmitter(radius: number, direction1: Vector3, direction2: Vector3): SphereDirectedParticleEmitter;
  93941. /**
  93942. * Creates a Cylinder Emitter for the particle system (emits from the cylinder to the particle position)
  93943. * @param radius The radius of the emission cylinder
  93944. * @param height The height of the emission cylinder
  93945. * @param radiusRange The range of emission [0-1] 0 Surface only, 1 Entire Radius
  93946. * @param directionRandomizer How much to randomize the particle direction [0-1]
  93947. * @returns the emitter
  93948. */
  93949. createCylinderEmitter(radius: number, height: number, radiusRange: number, directionRandomizer: number): CylinderParticleEmitter;
  93950. /**
  93951. * Creates a Directed Cylinder Emitter for the particle system (emits between direction1 and direction2)
  93952. * @param radius The radius of the cylinder to emit from
  93953. * @param height The height of the emission cylinder
  93954. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  93955. * @param direction1 Particles are emitted between the direction1 and direction2 from within the cylinder
  93956. * @param direction2 Particles are emitted between the direction1 and direction2 from within the cylinder
  93957. * @returns the emitter
  93958. */
  93959. createDirectedCylinderEmitter(radius: number, height: number, radiusRange: number, direction1: Vector3, direction2: Vector3): SphereDirectedParticleEmitter;
  93960. /**
  93961. * Creates a Cone Emitter for the particle system (emits from the cone to the particle position)
  93962. * @param radius The radius of the cone to emit from
  93963. * @param angle The base angle of the cone
  93964. * @returns the emitter
  93965. */
  93966. createConeEmitter(radius: number, angle: number): ConeParticleEmitter;
  93967. /**
  93968. * Creates a Box Emitter for the particle system. (emits between direction1 and direction2 from withing the box defined by minEmitBox and maxEmitBox)
  93969. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  93970. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  93971. * @param minEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  93972. * @param maxEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  93973. * @returns the emitter
  93974. */
  93975. createBoxEmitter(direction1: Vector3, direction2: Vector3, minEmitBox: Vector3, maxEmitBox: Vector3): BoxParticleEmitter;
  93976. /**
  93977. * Get hosting scene
  93978. * @returns the scene
  93979. */
  93980. getScene(): Nullable<Scene>;
  93981. }
  93982. }
  93983. declare module BABYLON {
  93984. /**
  93985. * 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.
  93986. * @see https://doc.babylonjs.com/how_to/transformnode
  93987. */
  93988. export class TransformNode extends Node {
  93989. /**
  93990. * Object will not rotate to face the camera
  93991. */
  93992. static BILLBOARDMODE_NONE: number;
  93993. /**
  93994. * Object will rotate to face the camera but only on the x axis
  93995. */
  93996. static BILLBOARDMODE_X: number;
  93997. /**
  93998. * Object will rotate to face the camera but only on the y axis
  93999. */
  94000. static BILLBOARDMODE_Y: number;
  94001. /**
  94002. * Object will rotate to face the camera but only on the z axis
  94003. */
  94004. static BILLBOARDMODE_Z: number;
  94005. /**
  94006. * Object will rotate to face the camera
  94007. */
  94008. static BILLBOARDMODE_ALL: number;
  94009. /**
  94010. * Object will rotate to face the camera's position instead of orientation
  94011. */
  94012. static BILLBOARDMODE_USE_POSITION: number;
  94013. private static _TmpRotation;
  94014. private static _TmpScaling;
  94015. private static _TmpTranslation;
  94016. private _forward;
  94017. private _forwardInverted;
  94018. private _up;
  94019. private _right;
  94020. private _rightInverted;
  94021. private _position;
  94022. private _rotation;
  94023. private _rotationQuaternion;
  94024. protected _scaling: Vector3;
  94025. protected _isDirty: boolean;
  94026. private _transformToBoneReferal;
  94027. private _isAbsoluteSynced;
  94028. private _billboardMode;
  94029. /**
  94030. * Gets or sets the billboard mode. Default is 0.
  94031. *
  94032. * | Value | Type | Description |
  94033. * | --- | --- | --- |
  94034. * | 0 | BILLBOARDMODE_NONE | |
  94035. * | 1 | BILLBOARDMODE_X | |
  94036. * | 2 | BILLBOARDMODE_Y | |
  94037. * | 4 | BILLBOARDMODE_Z | |
  94038. * | 7 | BILLBOARDMODE_ALL | |
  94039. *
  94040. */
  94041. get billboardMode(): number;
  94042. set billboardMode(value: number);
  94043. private _preserveParentRotationForBillboard;
  94044. /**
  94045. * Gets or sets a boolean indicating that parent rotation should be preserved when using billboards.
  94046. * This could be useful for glTF objects where parent rotation helps converting from right handed to left handed
  94047. */
  94048. get preserveParentRotationForBillboard(): boolean;
  94049. set preserveParentRotationForBillboard(value: boolean);
  94050. /**
  94051. * 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
  94052. */
  94053. scalingDeterminant: number;
  94054. private _infiniteDistance;
  94055. /**
  94056. * Gets or sets the distance of the object to max, often used by skybox
  94057. */
  94058. get infiniteDistance(): boolean;
  94059. set infiniteDistance(value: boolean);
  94060. /**
  94061. * Gets or sets a boolean indicating that non uniform scaling (when at least one component is different from others) should be ignored.
  94062. * By default the system will update normals to compensate
  94063. */
  94064. ignoreNonUniformScaling: boolean;
  94065. /**
  94066. * 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
  94067. */
  94068. reIntegrateRotationIntoRotationQuaternion: boolean;
  94069. /** @hidden */
  94070. _poseMatrix: Nullable<Matrix>;
  94071. /** @hidden */
  94072. _localMatrix: Matrix;
  94073. private _usePivotMatrix;
  94074. private _absolutePosition;
  94075. private _absoluteScaling;
  94076. private _absoluteRotationQuaternion;
  94077. private _pivotMatrix;
  94078. private _pivotMatrixInverse;
  94079. protected _postMultiplyPivotMatrix: boolean;
  94080. protected _isWorldMatrixFrozen: boolean;
  94081. /** @hidden */
  94082. _indexInSceneTransformNodesArray: number;
  94083. /**
  94084. * An event triggered after the world matrix is updated
  94085. */
  94086. onAfterWorldMatrixUpdateObservable: Observable<TransformNode>;
  94087. constructor(name: string, scene?: Nullable<Scene>, isPure?: boolean);
  94088. /**
  94089. * Gets a string identifying the name of the class
  94090. * @returns "TransformNode" string
  94091. */
  94092. getClassName(): string;
  94093. /**
  94094. * Gets or set the node position (default is (0.0, 0.0, 0.0))
  94095. */
  94096. get position(): Vector3;
  94097. set position(newPosition: Vector3);
  94098. /**
  94099. * 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)).
  94100. * If rotation quaternion is set, this Vector3 will be ignored and copy from the quaternion
  94101. */
  94102. get rotation(): Vector3;
  94103. set rotation(newRotation: Vector3);
  94104. /**
  94105. * 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)).
  94106. */
  94107. get scaling(): Vector3;
  94108. set scaling(newScaling: Vector3);
  94109. /**
  94110. * 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).
  94111. * If set, only the rotationQuaternion is then used to compute the node rotation (ie. node.rotation will be ignored)
  94112. */
  94113. get rotationQuaternion(): Nullable<Quaternion>;
  94114. set rotationQuaternion(quaternion: Nullable<Quaternion>);
  94115. /**
  94116. * The forward direction of that transform in world space.
  94117. */
  94118. get forward(): Vector3;
  94119. /**
  94120. * The up direction of that transform in world space.
  94121. */
  94122. get up(): Vector3;
  94123. /**
  94124. * The right direction of that transform in world space.
  94125. */
  94126. get right(): Vector3;
  94127. /**
  94128. * Copies the parameter passed Matrix into the mesh Pose matrix.
  94129. * @param matrix the matrix to copy the pose from
  94130. * @returns this TransformNode.
  94131. */
  94132. updatePoseMatrix(matrix: Matrix): TransformNode;
  94133. /**
  94134. * Returns the mesh Pose matrix.
  94135. * @returns the pose matrix
  94136. */
  94137. getPoseMatrix(): Matrix;
  94138. /** @hidden */
  94139. _isSynchronized(): boolean;
  94140. /** @hidden */
  94141. _initCache(): void;
  94142. /**
  94143. * Flag the transform node as dirty (Forcing it to update everything)
  94144. * @param property if set to "rotation" the objects rotationQuaternion will be set to null
  94145. * @returns this transform node
  94146. */
  94147. markAsDirty(property: string): TransformNode;
  94148. /**
  94149. * Returns the current mesh absolute position.
  94150. * Returns a Vector3.
  94151. */
  94152. get absolutePosition(): Vector3;
  94153. /**
  94154. * Returns the current mesh absolute scaling.
  94155. * Returns a Vector3.
  94156. */
  94157. get absoluteScaling(): Vector3;
  94158. /**
  94159. * Returns the current mesh absolute rotation.
  94160. * Returns a Quaternion.
  94161. */
  94162. get absoluteRotationQuaternion(): Quaternion;
  94163. /**
  94164. * Sets a new matrix to apply before all other transformation
  94165. * @param matrix defines the transform matrix
  94166. * @returns the current TransformNode
  94167. */
  94168. setPreTransformMatrix(matrix: Matrix): TransformNode;
  94169. /**
  94170. * Sets a new pivot matrix to the current node
  94171. * @param matrix defines the new pivot matrix to use
  94172. * @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
  94173. * @returns the current TransformNode
  94174. */
  94175. setPivotMatrix(matrix: DeepImmutable<Matrix>, postMultiplyPivotMatrix?: boolean): TransformNode;
  94176. /**
  94177. * Returns the mesh pivot matrix.
  94178. * Default : Identity.
  94179. * @returns the matrix
  94180. */
  94181. getPivotMatrix(): Matrix;
  94182. /**
  94183. * Instantiate (when possible) or clone that node with its hierarchy
  94184. * @param newParent defines the new parent to use for the instance (or clone)
  94185. * @param options defines options to configure how copy is done
  94186. * @param onNewNodeCreated defines an option callback to call when a clone or an instance is created
  94187. * @returns an instance (or a clone) of the current node with its hiearchy
  94188. */
  94189. instantiateHierarchy(newParent?: Nullable<TransformNode>, options?: {
  94190. doNotInstantiate: boolean;
  94191. }, onNewNodeCreated?: (source: TransformNode, clone: TransformNode) => void): Nullable<TransformNode>;
  94192. /**
  94193. * Prevents the World matrix to be computed any longer
  94194. * @param newWorldMatrix defines an optional matrix to use as world matrix
  94195. * @returns the TransformNode.
  94196. */
  94197. freezeWorldMatrix(newWorldMatrix?: Nullable<Matrix>): TransformNode;
  94198. /**
  94199. * Allows back the World matrix computation.
  94200. * @returns the TransformNode.
  94201. */
  94202. unfreezeWorldMatrix(): this;
  94203. /**
  94204. * True if the World matrix has been frozen.
  94205. */
  94206. get isWorldMatrixFrozen(): boolean;
  94207. /**
  94208. * Retuns the mesh absolute position in the World.
  94209. * @returns a Vector3.
  94210. */
  94211. getAbsolutePosition(): Vector3;
  94212. /**
  94213. * Sets the mesh absolute position in the World from a Vector3 or an Array(3).
  94214. * @param absolutePosition the absolute position to set
  94215. * @returns the TransformNode.
  94216. */
  94217. setAbsolutePosition(absolutePosition: Vector3): TransformNode;
  94218. /**
  94219. * Sets the mesh position in its local space.
  94220. * @param vector3 the position to set in localspace
  94221. * @returns the TransformNode.
  94222. */
  94223. setPositionWithLocalVector(vector3: Vector3): TransformNode;
  94224. /**
  94225. * Returns the mesh position in the local space from the current World matrix values.
  94226. * @returns a new Vector3.
  94227. */
  94228. getPositionExpressedInLocalSpace(): Vector3;
  94229. /**
  94230. * Translates the mesh along the passed Vector3 in its local space.
  94231. * @param vector3 the distance to translate in localspace
  94232. * @returns the TransformNode.
  94233. */
  94234. locallyTranslate(vector3: Vector3): TransformNode;
  94235. private static _lookAtVectorCache;
  94236. /**
  94237. * Orients a mesh towards a target point. Mesh must be drawn facing user.
  94238. * @param targetPoint the position (must be in same space as current mesh) to look at
  94239. * @param yawCor optional yaw (y-axis) correction in radians
  94240. * @param pitchCor optional pitch (x-axis) correction in radians
  94241. * @param rollCor optional roll (z-axis) correction in radians
  94242. * @param space the choosen space of the target
  94243. * @returns the TransformNode.
  94244. */
  94245. lookAt(targetPoint: Vector3, yawCor?: number, pitchCor?: number, rollCor?: number, space?: Space): TransformNode;
  94246. /**
  94247. * Returns a new Vector3 that is the localAxis, expressed in the mesh local space, rotated like the mesh.
  94248. * This Vector3 is expressed in the World space.
  94249. * @param localAxis axis to rotate
  94250. * @returns a new Vector3 that is the localAxis, expressed in the mesh local space, rotated like the mesh.
  94251. */
  94252. getDirection(localAxis: Vector3): Vector3;
  94253. /**
  94254. * Sets the Vector3 "result" as the rotated Vector3 "localAxis" in the same rotation than the mesh.
  94255. * localAxis is expressed in the mesh local space.
  94256. * result is computed in the Wordl space from the mesh World matrix.
  94257. * @param localAxis axis to rotate
  94258. * @param result the resulting transformnode
  94259. * @returns this TransformNode.
  94260. */
  94261. getDirectionToRef(localAxis: Vector3, result: Vector3): TransformNode;
  94262. /**
  94263. * Sets this transform node rotation to the given local axis.
  94264. * @param localAxis the axis in local space
  94265. * @param yawCor optional yaw (y-axis) correction in radians
  94266. * @param pitchCor optional pitch (x-axis) correction in radians
  94267. * @param rollCor optional roll (z-axis) correction in radians
  94268. * @returns this TransformNode
  94269. */
  94270. setDirection(localAxis: Vector3, yawCor?: number, pitchCor?: number, rollCor?: number): TransformNode;
  94271. /**
  94272. * Sets a new pivot point to the current node
  94273. * @param point defines the new pivot point to use
  94274. * @param space defines if the point is in world or local space (local by default)
  94275. * @returns the current TransformNode
  94276. */
  94277. setPivotPoint(point: Vector3, space?: Space): TransformNode;
  94278. /**
  94279. * Returns a new Vector3 set with the mesh pivot point coordinates in the local space.
  94280. * @returns the pivot point
  94281. */
  94282. getPivotPoint(): Vector3;
  94283. /**
  94284. * Sets the passed Vector3 "result" with the coordinates of the mesh pivot point in the local space.
  94285. * @param result the vector3 to store the result
  94286. * @returns this TransformNode.
  94287. */
  94288. getPivotPointToRef(result: Vector3): TransformNode;
  94289. /**
  94290. * Returns a new Vector3 set with the mesh pivot point World coordinates.
  94291. * @returns a new Vector3 set with the mesh pivot point World coordinates.
  94292. */
  94293. getAbsolutePivotPoint(): Vector3;
  94294. /**
  94295. * Sets the Vector3 "result" coordinates with the mesh pivot point World coordinates.
  94296. * @param result vector3 to store the result
  94297. * @returns this TransformNode.
  94298. */
  94299. getAbsolutePivotPointToRef(result: Vector3): TransformNode;
  94300. /**
  94301. * Defines the passed node as the parent of the current node.
  94302. * The node will remain exactly where it is and its position / rotation will be updated accordingly
  94303. * @see https://doc.babylonjs.com/how_to/parenting
  94304. * @param node the node ot set as the parent
  94305. * @returns this TransformNode.
  94306. */
  94307. setParent(node: Nullable<Node>): TransformNode;
  94308. private _nonUniformScaling;
  94309. /**
  94310. * True if the scaling property of this object is non uniform eg. (1,2,1)
  94311. */
  94312. get nonUniformScaling(): boolean;
  94313. /** @hidden */
  94314. _updateNonUniformScalingState(value: boolean): boolean;
  94315. /**
  94316. * Attach the current TransformNode to another TransformNode associated with a bone
  94317. * @param bone Bone affecting the TransformNode
  94318. * @param affectedTransformNode TransformNode associated with the bone
  94319. * @returns this object
  94320. */
  94321. attachToBone(bone: Bone, affectedTransformNode: TransformNode): TransformNode;
  94322. /**
  94323. * Detach the transform node if its associated with a bone
  94324. * @returns this object
  94325. */
  94326. detachFromBone(): TransformNode;
  94327. private static _rotationAxisCache;
  94328. /**
  94329. * Rotates the mesh around the axis vector for the passed angle (amount) expressed in radians, in the given space.
  94330. * space (default LOCAL) can be either Space.LOCAL, either Space.WORLD.
  94331. * Note that the property `rotationQuaternion` is then automatically updated and the property `rotation` is set to (0,0,0) and no longer used.
  94332. * The passed axis is also normalized.
  94333. * @param axis the axis to rotate around
  94334. * @param amount the amount to rotate in radians
  94335. * @param space Space to rotate in (Default: local)
  94336. * @returns the TransformNode.
  94337. */
  94338. rotate(axis: Vector3, amount: number, space?: Space): TransformNode;
  94339. /**
  94340. * Rotates the mesh around the axis vector for the passed angle (amount) expressed in radians, in world space.
  94341. * Note that the property `rotationQuaternion` is then automatically updated and the property `rotation` is set to (0,0,0) and no longer used.
  94342. * The passed axis is also normalized. .
  94343. * Method is based on http://www.euclideanspace.com/maths/geometry/affine/aroundPoint/index.htm
  94344. * @param point the point to rotate around
  94345. * @param axis the axis to rotate around
  94346. * @param amount the amount to rotate in radians
  94347. * @returns the TransformNode
  94348. */
  94349. rotateAround(point: Vector3, axis: Vector3, amount: number): TransformNode;
  94350. /**
  94351. * Translates the mesh along the axis vector for the passed distance in the given space.
  94352. * space (default LOCAL) can be either Space.LOCAL, either Space.WORLD.
  94353. * @param axis the axis to translate in
  94354. * @param distance the distance to translate
  94355. * @param space Space to rotate in (Default: local)
  94356. * @returns the TransformNode.
  94357. */
  94358. translate(axis: Vector3, distance: number, space?: Space): TransformNode;
  94359. /**
  94360. * Adds a rotation step to the mesh current rotation.
  94361. * x, y, z are Euler angles expressed in radians.
  94362. * This methods updates the current mesh rotation, either mesh.rotation, either mesh.rotationQuaternion if it's set.
  94363. * This means this rotation is made in the mesh local space only.
  94364. * It's useful to set a custom rotation order different from the BJS standard one YXZ.
  94365. * Example : this rotates the mesh first around its local X axis, then around its local Z axis, finally around its local Y axis.
  94366. * ```javascript
  94367. * mesh.addRotation(x1, 0, 0).addRotation(0, 0, z2).addRotation(0, 0, y3);
  94368. * ```
  94369. * Note that `addRotation()` accumulates the passed rotation values to the current ones and computes the .rotation or .rotationQuaternion updated values.
  94370. * 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.
  94371. * @param x Rotation to add
  94372. * @param y Rotation to add
  94373. * @param z Rotation to add
  94374. * @returns the TransformNode.
  94375. */
  94376. addRotation(x: number, y: number, z: number): TransformNode;
  94377. /**
  94378. * @hidden
  94379. */
  94380. protected _getEffectiveParent(): Nullable<Node>;
  94381. /**
  94382. * Computes the world matrix of the node
  94383. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  94384. * @returns the world matrix
  94385. */
  94386. computeWorldMatrix(force?: boolean): Matrix;
  94387. /**
  94388. * Resets this nodeTransform's local matrix to Matrix.Identity().
  94389. * @param independentOfChildren indicates if all child nodeTransform's world-space transform should be preserved.
  94390. */
  94391. resetLocalMatrix(independentOfChildren?: boolean): void;
  94392. protected _afterComputeWorldMatrix(): void;
  94393. /**
  94394. * If you'd like to be called back after the mesh position, rotation or scaling has been updated.
  94395. * @param func callback function to add
  94396. *
  94397. * @returns the TransformNode.
  94398. */
  94399. registerAfterWorldMatrixUpdate(func: (mesh: TransformNode) => void): TransformNode;
  94400. /**
  94401. * Removes a registered callback function.
  94402. * @param func callback function to remove
  94403. * @returns the TransformNode.
  94404. */
  94405. unregisterAfterWorldMatrixUpdate(func: (mesh: TransformNode) => void): TransformNode;
  94406. /**
  94407. * Gets the position of the current mesh in camera space
  94408. * @param camera defines the camera to use
  94409. * @returns a position
  94410. */
  94411. getPositionInCameraSpace(camera?: Nullable<Camera>): Vector3;
  94412. /**
  94413. * Returns the distance from the mesh to the active camera
  94414. * @param camera defines the camera to use
  94415. * @returns the distance
  94416. */
  94417. getDistanceToCamera(camera?: Nullable<Camera>): number;
  94418. /**
  94419. * Clone the current transform node
  94420. * @param name Name of the new clone
  94421. * @param newParent New parent for the clone
  94422. * @param doNotCloneChildren Do not clone children hierarchy
  94423. * @returns the new transform node
  94424. */
  94425. clone(name: string, newParent: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<TransformNode>;
  94426. /**
  94427. * Serializes the objects information.
  94428. * @param currentSerializationObject defines the object to serialize in
  94429. * @returns the serialized object
  94430. */
  94431. serialize(currentSerializationObject?: any): any;
  94432. /**
  94433. * Returns a new TransformNode object parsed from the source provided.
  94434. * @param parsedTransformNode is the source.
  94435. * @param scene the scne the object belongs to
  94436. * @param rootUrl is a string, it's the root URL to prefix the `delayLoadingFile` property with
  94437. * @returns a new TransformNode object parsed from the source provided.
  94438. */
  94439. static Parse(parsedTransformNode: any, scene: Scene, rootUrl: string): TransformNode;
  94440. /**
  94441. * Get all child-transformNodes of this node
  94442. * @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
  94443. * @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
  94444. * @returns an array of TransformNode
  94445. */
  94446. getChildTransformNodes(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): TransformNode[];
  94447. /**
  94448. * Releases resources associated with this transform node.
  94449. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  94450. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  94451. */
  94452. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  94453. /**
  94454. * Uniformly scales the mesh to fit inside of a unit cube (1 X 1 X 1 units)
  94455. * @param includeDescendants Use the hierarchy's bounding box instead of the mesh's bounding box. Default is false
  94456. * @param ignoreRotation ignore rotation when computing the scale (ie. object will be axis aligned). Default is false
  94457. * @param predicate predicate that is passed in to getHierarchyBoundingVectors when selecting which object should be included when scaling
  94458. * @returns the current mesh
  94459. */
  94460. normalizeToUnitCube(includeDescendants?: boolean, ignoreRotation?: boolean, predicate?: Nullable<(node: AbstractMesh) => boolean>): TransformNode;
  94461. private _syncAbsoluteScalingAndRotation;
  94462. }
  94463. }
  94464. declare module BABYLON {
  94465. /**
  94466. * Class used to override all child animations of a given target
  94467. */
  94468. export class AnimationPropertiesOverride {
  94469. /**
  94470. * Gets or sets a value indicating if animation blending must be used
  94471. */
  94472. enableBlending: boolean;
  94473. /**
  94474. * Gets or sets the blending speed to use when enableBlending is true
  94475. */
  94476. blendingSpeed: number;
  94477. /**
  94478. * Gets or sets the default loop mode to use
  94479. */
  94480. loopMode: number;
  94481. }
  94482. }
  94483. declare module BABYLON {
  94484. /**
  94485. * Class used to store bone information
  94486. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  94487. */
  94488. export class Bone extends Node {
  94489. /**
  94490. * defines the bone name
  94491. */
  94492. name: string;
  94493. private static _tmpVecs;
  94494. private static _tmpQuat;
  94495. private static _tmpMats;
  94496. /**
  94497. * Gets the list of child bones
  94498. */
  94499. children: Bone[];
  94500. /** Gets the animations associated with this bone */
  94501. animations: Animation[];
  94502. /**
  94503. * Gets or sets bone length
  94504. */
  94505. length: number;
  94506. /**
  94507. * @hidden Internal only
  94508. * Set this value to map this bone to a different index in the transform matrices
  94509. * Set this value to -1 to exclude the bone from the transform matrices
  94510. */
  94511. _index: Nullable<number>;
  94512. private _skeleton;
  94513. private _localMatrix;
  94514. private _restPose;
  94515. private _bindPose;
  94516. private _baseMatrix;
  94517. private _absoluteTransform;
  94518. private _invertedAbsoluteTransform;
  94519. private _parent;
  94520. private _scalingDeterminant;
  94521. private _worldTransform;
  94522. private _localScaling;
  94523. private _localRotation;
  94524. private _localPosition;
  94525. private _needToDecompose;
  94526. private _needToCompose;
  94527. /** @hidden */
  94528. _linkedTransformNode: Nullable<TransformNode>;
  94529. /** @hidden */
  94530. _waitingTransformNodeId: Nullable<string>;
  94531. /** @hidden */
  94532. get _matrix(): Matrix;
  94533. /** @hidden */
  94534. set _matrix(value: Matrix);
  94535. /**
  94536. * Create a new bone
  94537. * @param name defines the bone name
  94538. * @param skeleton defines the parent skeleton
  94539. * @param parentBone defines the parent (can be null if the bone is the root)
  94540. * @param localMatrix defines the local matrix
  94541. * @param restPose defines the rest pose matrix
  94542. * @param baseMatrix defines the base matrix
  94543. * @param index defines index of the bone in the hiearchy
  94544. */
  94545. constructor(
  94546. /**
  94547. * defines the bone name
  94548. */
  94549. name: string, skeleton: Skeleton, parentBone?: Nullable<Bone>, localMatrix?: Nullable<Matrix>, restPose?: Nullable<Matrix>, baseMatrix?: Nullable<Matrix>, index?: Nullable<number>);
  94550. /**
  94551. * Gets the current object class name.
  94552. * @return the class name
  94553. */
  94554. getClassName(): string;
  94555. /**
  94556. * Gets the parent skeleton
  94557. * @returns a skeleton
  94558. */
  94559. getSkeleton(): Skeleton;
  94560. /**
  94561. * Gets parent bone
  94562. * @returns a bone or null if the bone is the root of the bone hierarchy
  94563. */
  94564. getParent(): Nullable<Bone>;
  94565. /**
  94566. * Returns an array containing the root bones
  94567. * @returns an array containing the root bones
  94568. */
  94569. getChildren(): Array<Bone>;
  94570. /**
  94571. * Gets the node index in matrix array generated for rendering
  94572. * @returns the node index
  94573. */
  94574. getIndex(): number;
  94575. /**
  94576. * Sets the parent bone
  94577. * @param parent defines the parent (can be null if the bone is the root)
  94578. * @param updateDifferenceMatrix defines if the difference matrix must be updated
  94579. */
  94580. setParent(parent: Nullable<Bone>, updateDifferenceMatrix?: boolean): void;
  94581. /**
  94582. * Gets the local matrix
  94583. * @returns a matrix
  94584. */
  94585. getLocalMatrix(): Matrix;
  94586. /**
  94587. * Gets the base matrix (initial matrix which remains unchanged)
  94588. * @returns a matrix
  94589. */
  94590. getBaseMatrix(): Matrix;
  94591. /**
  94592. * Gets the rest pose matrix
  94593. * @returns a matrix
  94594. */
  94595. getRestPose(): Matrix;
  94596. /**
  94597. * Sets the rest pose matrix
  94598. * @param matrix the local-space rest pose to set for this bone
  94599. */
  94600. setRestPose(matrix: Matrix): void;
  94601. /**
  94602. * Gets the bind pose matrix
  94603. * @returns the bind pose matrix
  94604. */
  94605. getBindPose(): Matrix;
  94606. /**
  94607. * Sets the bind pose matrix
  94608. * @param matrix the local-space bind pose to set for this bone
  94609. */
  94610. setBindPose(matrix: Matrix): void;
  94611. /**
  94612. * Gets a matrix used to store world matrix (ie. the matrix sent to shaders)
  94613. */
  94614. getWorldMatrix(): Matrix;
  94615. /**
  94616. * Sets the local matrix to rest pose matrix
  94617. */
  94618. returnToRest(): void;
  94619. /**
  94620. * Gets the inverse of the absolute transform matrix.
  94621. * This matrix will be multiplied by local matrix to get the difference matrix (ie. the difference between original state and current state)
  94622. * @returns a matrix
  94623. */
  94624. getInvertedAbsoluteTransform(): Matrix;
  94625. /**
  94626. * Gets the absolute transform matrix (ie base matrix * parent world matrix)
  94627. * @returns a matrix
  94628. */
  94629. getAbsoluteTransform(): Matrix;
  94630. /**
  94631. * Links with the given transform node.
  94632. * The local matrix of this bone is copied from the transform node every frame.
  94633. * @param transformNode defines the transform node to link to
  94634. */
  94635. linkTransformNode(transformNode: Nullable<TransformNode>): void;
  94636. /**
  94637. * Gets the node used to drive the bone's transformation
  94638. * @returns a transform node or null
  94639. */
  94640. getTransformNode(): Nullable<TransformNode>;
  94641. /** Gets or sets current position (in local space) */
  94642. get position(): Vector3;
  94643. set position(newPosition: Vector3);
  94644. /** Gets or sets current rotation (in local space) */
  94645. get rotation(): Vector3;
  94646. set rotation(newRotation: Vector3);
  94647. /** Gets or sets current rotation quaternion (in local space) */
  94648. get rotationQuaternion(): Quaternion;
  94649. set rotationQuaternion(newRotation: Quaternion);
  94650. /** Gets or sets current scaling (in local space) */
  94651. get scaling(): Vector3;
  94652. set scaling(newScaling: Vector3);
  94653. /**
  94654. * Gets the animation properties override
  94655. */
  94656. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  94657. private _decompose;
  94658. private _compose;
  94659. /**
  94660. * Update the base and local matrices
  94661. * @param matrix defines the new base or local matrix
  94662. * @param updateDifferenceMatrix defines if the difference matrix must be updated
  94663. * @param updateLocalMatrix defines if the local matrix should be updated
  94664. */
  94665. updateMatrix(matrix: Matrix, updateDifferenceMatrix?: boolean, updateLocalMatrix?: boolean): void;
  94666. /** @hidden */
  94667. _updateDifferenceMatrix(rootMatrix?: Matrix, updateChildren?: boolean): void;
  94668. /**
  94669. * Flag the bone as dirty (Forcing it to update everything)
  94670. */
  94671. markAsDirty(): void;
  94672. /** @hidden */
  94673. _markAsDirtyAndCompose(): void;
  94674. private _markAsDirtyAndDecompose;
  94675. /**
  94676. * Translate the bone in local or world space
  94677. * @param vec The amount to translate the bone
  94678. * @param space The space that the translation is in
  94679. * @param mesh The mesh that this bone is attached to. This is only used in world space
  94680. */
  94681. translate(vec: Vector3, space?: Space, mesh?: AbstractMesh): void;
  94682. /**
  94683. * Set the postion of the bone in local or world space
  94684. * @param position The position to set the bone
  94685. * @param space The space that the position is in
  94686. * @param mesh The mesh that this bone is attached to. This is only used in world space
  94687. */
  94688. setPosition(position: Vector3, space?: Space, mesh?: AbstractMesh): void;
  94689. /**
  94690. * Set the absolute position of the bone (world space)
  94691. * @param position The position to set the bone
  94692. * @param mesh The mesh that this bone is attached to
  94693. */
  94694. setAbsolutePosition(position: Vector3, mesh?: AbstractMesh): void;
  94695. /**
  94696. * Scale the bone on the x, y and z axes (in local space)
  94697. * @param x The amount to scale the bone on the x axis
  94698. * @param y The amount to scale the bone on the y axis
  94699. * @param z The amount to scale the bone on the z axis
  94700. * @param scaleChildren sets this to true if children of the bone should be scaled as well (false by default)
  94701. */
  94702. scale(x: number, y: number, z: number, scaleChildren?: boolean): void;
  94703. /**
  94704. * Set the bone scaling in local space
  94705. * @param scale defines the scaling vector
  94706. */
  94707. setScale(scale: Vector3): void;
  94708. /**
  94709. * Gets the current scaling in local space
  94710. * @returns the current scaling vector
  94711. */
  94712. getScale(): Vector3;
  94713. /**
  94714. * Gets the current scaling in local space and stores it in a target vector
  94715. * @param result defines the target vector
  94716. */
  94717. getScaleToRef(result: Vector3): void;
  94718. /**
  94719. * Set the yaw, pitch, and roll of the bone in local or world space
  94720. * @param yaw The rotation of the bone on the y axis
  94721. * @param pitch The rotation of the bone on the x axis
  94722. * @param roll The rotation of the bone on the z axis
  94723. * @param space The space that the axes of rotation are in
  94724. * @param mesh The mesh that this bone is attached to. This is only used in world space
  94725. */
  94726. setYawPitchRoll(yaw: number, pitch: number, roll: number, space?: Space, mesh?: AbstractMesh): void;
  94727. /**
  94728. * Add a rotation to the bone on an axis in local or world space
  94729. * @param axis The axis to rotate the bone on
  94730. * @param amount The amount to rotate the bone
  94731. * @param space The space that the axis is in
  94732. * @param mesh The mesh that this bone is attached to. This is only used in world space
  94733. */
  94734. rotate(axis: Vector3, amount: number, space?: Space, mesh?: AbstractMesh): void;
  94735. /**
  94736. * Set the rotation of the bone to a particular axis angle in local or world space
  94737. * @param axis The axis to rotate the bone on
  94738. * @param angle The angle that the bone should be rotated to
  94739. * @param space The space that the axis is in
  94740. * @param mesh The mesh that this bone is attached to. This is only used in world space
  94741. */
  94742. setAxisAngle(axis: Vector3, angle: number, space?: Space, mesh?: AbstractMesh): void;
  94743. /**
  94744. * Set the euler rotation of the bone in local of world space
  94745. * @param rotation The euler rotation that the bone should be set to
  94746. * @param space The space that the rotation is in
  94747. * @param mesh The mesh that this bone is attached to. This is only used in world space
  94748. */
  94749. setRotation(rotation: Vector3, space?: Space, mesh?: AbstractMesh): void;
  94750. /**
  94751. * Set the quaternion rotation of the bone in local of world space
  94752. * @param quat The quaternion rotation that the bone should be set to
  94753. * @param space The space that the rotation is in
  94754. * @param mesh The mesh that this bone is attached to. This is only used in world space
  94755. */
  94756. setRotationQuaternion(quat: Quaternion, space?: Space, mesh?: AbstractMesh): void;
  94757. /**
  94758. * Set the rotation matrix of the bone in local of world space
  94759. * @param rotMat The rotation matrix that the bone should be set to
  94760. * @param space The space that the rotation is in
  94761. * @param mesh The mesh that this bone is attached to. This is only used in world space
  94762. */
  94763. setRotationMatrix(rotMat: Matrix, space?: Space, mesh?: AbstractMesh): void;
  94764. private _rotateWithMatrix;
  94765. private _getNegativeRotationToRef;
  94766. /**
  94767. * Get the position of the bone in local or world space
  94768. * @param space The space that the returned position is in
  94769. * @param mesh The mesh that this bone is attached to. This is only used in world space
  94770. * @returns The position of the bone
  94771. */
  94772. getPosition(space?: Space, mesh?: Nullable<AbstractMesh>): Vector3;
  94773. /**
  94774. * Copy the position of the bone to a vector3 in local or world space
  94775. * @param space The space that the returned position is in
  94776. * @param mesh The mesh that this bone is attached to. This is only used in world space
  94777. * @param result The vector3 to copy the position to
  94778. */
  94779. getPositionToRef(space: Space | undefined, mesh: Nullable<AbstractMesh>, result: Vector3): void;
  94780. /**
  94781. * Get the absolute position of the bone (world space)
  94782. * @param mesh The mesh that this bone is attached to
  94783. * @returns The absolute position of the bone
  94784. */
  94785. getAbsolutePosition(mesh?: Nullable<AbstractMesh>): Vector3;
  94786. /**
  94787. * Copy the absolute position of the bone (world space) to the result param
  94788. * @param mesh The mesh that this bone is attached to
  94789. * @param result The vector3 to copy the absolute position to
  94790. */
  94791. getAbsolutePositionToRef(mesh: AbstractMesh, result: Vector3): void;
  94792. /**
  94793. * Compute the absolute transforms of this bone and its children
  94794. */
  94795. computeAbsoluteTransforms(): void;
  94796. /**
  94797. * Get the world direction from an axis that is in the local space of the bone
  94798. * @param localAxis The local direction that is used to compute the world direction
  94799. * @param mesh The mesh that this bone is attached to
  94800. * @returns The world direction
  94801. */
  94802. getDirection(localAxis: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  94803. /**
  94804. * Copy the world direction to a vector3 from an axis that is in the local space of the bone
  94805. * @param localAxis The local direction that is used to compute the world direction
  94806. * @param mesh The mesh that this bone is attached to
  94807. * @param result The vector3 that the world direction will be copied to
  94808. */
  94809. getDirectionToRef(localAxis: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  94810. /**
  94811. * Get the euler rotation of the bone in local or world space
  94812. * @param space The space that the rotation should be in
  94813. * @param mesh The mesh that this bone is attached to. This is only used in world space
  94814. * @returns The euler rotation
  94815. */
  94816. getRotation(space?: Space, mesh?: Nullable<AbstractMesh>): Vector3;
  94817. /**
  94818. * Copy the euler rotation of the bone to a vector3. The rotation can be in either local or world space
  94819. * @param space The space that the rotation should be in
  94820. * @param mesh The mesh that this bone is attached to. This is only used in world space
  94821. * @param result The vector3 that the rotation should be copied to
  94822. */
  94823. getRotationToRef(space: Space | undefined, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  94824. /**
  94825. * Get the quaternion rotation of the bone in either local or world space
  94826. * @param space The space that the rotation should be in
  94827. * @param mesh The mesh that this bone is attached to. This is only used in world space
  94828. * @returns The quaternion rotation
  94829. */
  94830. getRotationQuaternion(space?: Space, mesh?: Nullable<AbstractMesh>): Quaternion;
  94831. /**
  94832. * Copy the quaternion rotation of the bone to a quaternion. The rotation can be in either local or world space
  94833. * @param space The space that the rotation should be in
  94834. * @param mesh The mesh that this bone is attached to. This is only used in world space
  94835. * @param result The quaternion that the rotation should be copied to
  94836. */
  94837. getRotationQuaternionToRef(space: Space | undefined, mesh: AbstractMesh | null | undefined, result: Quaternion): void;
  94838. /**
  94839. * Get the rotation matrix of the bone in local or world space
  94840. * @param space The space that the rotation should be in
  94841. * @param mesh The mesh that this bone is attached to. This is only used in world space
  94842. * @returns The rotation matrix
  94843. */
  94844. getRotationMatrix(space: Space | undefined, mesh: AbstractMesh): Matrix;
  94845. /**
  94846. * Copy the rotation matrix of the bone to a matrix. The rotation can be in either local or world space
  94847. * @param space The space that the rotation should be in
  94848. * @param mesh The mesh that this bone is attached to. This is only used in world space
  94849. * @param result The quaternion that the rotation should be copied to
  94850. */
  94851. getRotationMatrixToRef(space: Space | undefined, mesh: AbstractMesh, result: Matrix): void;
  94852. /**
  94853. * Get the world position of a point that is in the local space of the bone
  94854. * @param position The local position
  94855. * @param mesh The mesh that this bone is attached to
  94856. * @returns The world position
  94857. */
  94858. getAbsolutePositionFromLocal(position: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  94859. /**
  94860. * Get the world position of a point that is in the local space of the bone and copy it to the result param
  94861. * @param position The local position
  94862. * @param mesh The mesh that this bone is attached to
  94863. * @param result The vector3 that the world position should be copied to
  94864. */
  94865. getAbsolutePositionFromLocalToRef(position: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  94866. /**
  94867. * Get the local position of a point that is in world space
  94868. * @param position The world position
  94869. * @param mesh The mesh that this bone is attached to
  94870. * @returns The local position
  94871. */
  94872. getLocalPositionFromAbsolute(position: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  94873. /**
  94874. * Get the local position of a point that is in world space and copy it to the result param
  94875. * @param position The world position
  94876. * @param mesh The mesh that this bone is attached to
  94877. * @param result The vector3 that the local position should be copied to
  94878. */
  94879. getLocalPositionFromAbsoluteToRef(position: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  94880. }
  94881. }
  94882. declare module BABYLON {
  94883. /**
  94884. * Defines a runtime animation
  94885. */
  94886. export class RuntimeAnimation {
  94887. private _events;
  94888. /**
  94889. * The current frame of the runtime animation
  94890. */
  94891. private _currentFrame;
  94892. /**
  94893. * The animation used by the runtime animation
  94894. */
  94895. private _animation;
  94896. /**
  94897. * The target of the runtime animation
  94898. */
  94899. private _target;
  94900. /**
  94901. * The initiating animatable
  94902. */
  94903. private _host;
  94904. /**
  94905. * The original value of the runtime animation
  94906. */
  94907. private _originalValue;
  94908. /**
  94909. * The original blend value of the runtime animation
  94910. */
  94911. private _originalBlendValue;
  94912. /**
  94913. * The offsets cache of the runtime animation
  94914. */
  94915. private _offsetsCache;
  94916. /**
  94917. * The high limits cache of the runtime animation
  94918. */
  94919. private _highLimitsCache;
  94920. /**
  94921. * Specifies if the runtime animation has been stopped
  94922. */
  94923. private _stopped;
  94924. /**
  94925. * The blending factor of the runtime animation
  94926. */
  94927. private _blendingFactor;
  94928. /**
  94929. * The BabylonJS scene
  94930. */
  94931. private _scene;
  94932. /**
  94933. * The current value of the runtime animation
  94934. */
  94935. private _currentValue;
  94936. /** @hidden */
  94937. _animationState: _IAnimationState;
  94938. /**
  94939. * The active target of the runtime animation
  94940. */
  94941. private _activeTargets;
  94942. private _currentActiveTarget;
  94943. private _directTarget;
  94944. /**
  94945. * The target path of the runtime animation
  94946. */
  94947. private _targetPath;
  94948. /**
  94949. * The weight of the runtime animation
  94950. */
  94951. private _weight;
  94952. /**
  94953. * The ratio offset of the runtime animation
  94954. */
  94955. private _ratioOffset;
  94956. /**
  94957. * The previous delay of the runtime animation
  94958. */
  94959. private _previousDelay;
  94960. /**
  94961. * The previous ratio of the runtime animation
  94962. */
  94963. private _previousRatio;
  94964. private _enableBlending;
  94965. private _keys;
  94966. private _minFrame;
  94967. private _maxFrame;
  94968. private _minValue;
  94969. private _maxValue;
  94970. private _targetIsArray;
  94971. /**
  94972. * Gets the current frame of the runtime animation
  94973. */
  94974. get currentFrame(): number;
  94975. /**
  94976. * Gets the weight of the runtime animation
  94977. */
  94978. get weight(): number;
  94979. /**
  94980. * Gets the current value of the runtime animation
  94981. */
  94982. get currentValue(): any;
  94983. /**
  94984. * Gets the target path of the runtime animation
  94985. */
  94986. get targetPath(): string;
  94987. /**
  94988. * Gets the actual target of the runtime animation
  94989. */
  94990. get target(): any;
  94991. /**
  94992. * Gets the additive state of the runtime animation
  94993. */
  94994. get isAdditive(): boolean;
  94995. /** @hidden */
  94996. _onLoop: () => void;
  94997. /**
  94998. * Create a new RuntimeAnimation object
  94999. * @param target defines the target of the animation
  95000. * @param animation defines the source animation object
  95001. * @param scene defines the hosting scene
  95002. * @param host defines the initiating Animatable
  95003. */
  95004. constructor(target: any, animation: Animation, scene: Scene, host: Animatable);
  95005. private _preparePath;
  95006. /**
  95007. * Gets the animation from the runtime animation
  95008. */
  95009. get animation(): Animation;
  95010. /**
  95011. * Resets the runtime animation to the beginning
  95012. * @param restoreOriginal defines whether to restore the target property to the original value
  95013. */
  95014. reset(restoreOriginal?: boolean): void;
  95015. /**
  95016. * Specifies if the runtime animation is stopped
  95017. * @returns Boolean specifying if the runtime animation is stopped
  95018. */
  95019. isStopped(): boolean;
  95020. /**
  95021. * Disposes of the runtime animation
  95022. */
  95023. dispose(): void;
  95024. /**
  95025. * Apply the interpolated value to the target
  95026. * @param currentValue defines the value computed by the animation
  95027. * @param weight defines the weight to apply to this value (Defaults to 1.0)
  95028. */
  95029. setValue(currentValue: any, weight: number): void;
  95030. private _getOriginalValues;
  95031. private _setValue;
  95032. /**
  95033. * Gets the loop pmode of the runtime animation
  95034. * @returns Loop Mode
  95035. */
  95036. private _getCorrectLoopMode;
  95037. /**
  95038. * Move the current animation to a given frame
  95039. * @param frame defines the frame to move to
  95040. */
  95041. goToFrame(frame: number): void;
  95042. /**
  95043. * @hidden Internal use only
  95044. */
  95045. _prepareForSpeedRatioChange(newSpeedRatio: number): void;
  95046. /**
  95047. * Execute the current animation
  95048. * @param delay defines the delay to add to the current frame
  95049. * @param from defines the lower bound of the animation range
  95050. * @param to defines the upper bound of the animation range
  95051. * @param loop defines if the current animation must loop
  95052. * @param speedRatio defines the current speed ratio
  95053. * @param weight defines the weight of the animation (default is -1 so no weight)
  95054. * @param onLoop optional callback called when animation loops
  95055. * @returns a boolean indicating if the animation is running
  95056. */
  95057. animate(delay: number, from: number, to: number, loop: boolean, speedRatio: number, weight?: number): boolean;
  95058. }
  95059. }
  95060. declare module BABYLON {
  95061. /**
  95062. * Class used to store an actual running animation
  95063. */
  95064. export class Animatable {
  95065. /** defines the target object */
  95066. target: any;
  95067. /** defines the starting frame number (default is 0) */
  95068. fromFrame: number;
  95069. /** defines the ending frame number (default is 100) */
  95070. toFrame: number;
  95071. /** defines if the animation must loop (default is false) */
  95072. loopAnimation: boolean;
  95073. /** defines a callback to call when animation ends if it is not looping */
  95074. onAnimationEnd?: (() => void) | null | undefined;
  95075. /** defines a callback to call when animation loops */
  95076. onAnimationLoop?: (() => void) | null | undefined;
  95077. /** defines whether the animation should be evaluated additively */
  95078. isAdditive: boolean;
  95079. private _localDelayOffset;
  95080. private _pausedDelay;
  95081. private _runtimeAnimations;
  95082. private _paused;
  95083. private _scene;
  95084. private _speedRatio;
  95085. private _weight;
  95086. private _syncRoot;
  95087. /**
  95088. * Gets or sets a boolean indicating if the animatable must be disposed and removed at the end of the animation.
  95089. * This will only apply for non looping animation (default is true)
  95090. */
  95091. disposeOnEnd: boolean;
  95092. /**
  95093. * Gets a boolean indicating if the animation has started
  95094. */
  95095. animationStarted: boolean;
  95096. /**
  95097. * Observer raised when the animation ends
  95098. */
  95099. onAnimationEndObservable: Observable<Animatable>;
  95100. /**
  95101. * Observer raised when the animation loops
  95102. */
  95103. onAnimationLoopObservable: Observable<Animatable>;
  95104. /**
  95105. * Gets the root Animatable used to synchronize and normalize animations
  95106. */
  95107. get syncRoot(): Nullable<Animatable>;
  95108. /**
  95109. * Gets the current frame of the first RuntimeAnimation
  95110. * Used to synchronize Animatables
  95111. */
  95112. get masterFrame(): number;
  95113. /**
  95114. * Gets or sets the animatable weight (-1.0 by default meaning not weighted)
  95115. */
  95116. get weight(): number;
  95117. set weight(value: number);
  95118. /**
  95119. * Gets or sets the speed ratio to apply to the animatable (1.0 by default)
  95120. */
  95121. get speedRatio(): number;
  95122. set speedRatio(value: number);
  95123. /**
  95124. * Creates a new Animatable
  95125. * @param scene defines the hosting scene
  95126. * @param target defines the target object
  95127. * @param fromFrame defines the starting frame number (default is 0)
  95128. * @param toFrame defines the ending frame number (default is 100)
  95129. * @param loopAnimation defines if the animation must loop (default is false)
  95130. * @param speedRatio defines the factor to apply to animation speed (default is 1)
  95131. * @param onAnimationEnd defines a callback to call when animation ends if it is not looping
  95132. * @param animations defines a group of animation to add to the new Animatable
  95133. * @param onAnimationLoop defines a callback to call when animation loops
  95134. * @param isAdditive defines whether the animation should be evaluated additively
  95135. */
  95136. constructor(scene: Scene,
  95137. /** defines the target object */
  95138. target: any,
  95139. /** defines the starting frame number (default is 0) */
  95140. fromFrame?: number,
  95141. /** defines the ending frame number (default is 100) */
  95142. toFrame?: number,
  95143. /** defines if the animation must loop (default is false) */
  95144. loopAnimation?: boolean, speedRatio?: number,
  95145. /** defines a callback to call when animation ends if it is not looping */
  95146. onAnimationEnd?: (() => void) | null | undefined, animations?: Animation[],
  95147. /** defines a callback to call when animation loops */
  95148. onAnimationLoop?: (() => void) | null | undefined,
  95149. /** defines whether the animation should be evaluated additively */
  95150. isAdditive?: boolean);
  95151. /**
  95152. * Synchronize and normalize current Animatable with a source Animatable
  95153. * This is useful when using animation weights and when animations are not of the same length
  95154. * @param root defines the root Animatable to synchronize with
  95155. * @returns the current Animatable
  95156. */
  95157. syncWith(root: Animatable): Animatable;
  95158. /**
  95159. * Gets the list of runtime animations
  95160. * @returns an array of RuntimeAnimation
  95161. */
  95162. getAnimations(): RuntimeAnimation[];
  95163. /**
  95164. * Adds more animations to the current animatable
  95165. * @param target defines the target of the animations
  95166. * @param animations defines the new animations to add
  95167. */
  95168. appendAnimations(target: any, animations: Animation[]): void;
  95169. /**
  95170. * Gets the source animation for a specific property
  95171. * @param property defines the propertyu to look for
  95172. * @returns null or the source animation for the given property
  95173. */
  95174. getAnimationByTargetProperty(property: string): Nullable<Animation>;
  95175. /**
  95176. * Gets the runtime animation for a specific property
  95177. * @param property defines the propertyu to look for
  95178. * @returns null or the runtime animation for the given property
  95179. */
  95180. getRuntimeAnimationByTargetProperty(property: string): Nullable<RuntimeAnimation>;
  95181. /**
  95182. * Resets the animatable to its original state
  95183. */
  95184. reset(): void;
  95185. /**
  95186. * Allows the animatable to blend with current running animations
  95187. * @see https://doc.babylonjs.com/babylon101/animations#animation-blending
  95188. * @param blendingSpeed defines the blending speed to use
  95189. */
  95190. enableBlending(blendingSpeed: number): void;
  95191. /**
  95192. * Disable animation blending
  95193. * @see https://doc.babylonjs.com/babylon101/animations#animation-blending
  95194. */
  95195. disableBlending(): void;
  95196. /**
  95197. * Jump directly to a given frame
  95198. * @param frame defines the frame to jump to
  95199. */
  95200. goToFrame(frame: number): void;
  95201. /**
  95202. * Pause the animation
  95203. */
  95204. pause(): void;
  95205. /**
  95206. * Restart the animation
  95207. */
  95208. restart(): void;
  95209. private _raiseOnAnimationEnd;
  95210. /**
  95211. * Stop and delete the current animation
  95212. * @param animationName defines a string used to only stop some of the runtime animations instead of all
  95213. * @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)
  95214. */
  95215. stop(animationName?: string, targetMask?: (target: any) => boolean): void;
  95216. /**
  95217. * Wait asynchronously for the animation to end
  95218. * @returns a promise which will be fullfilled when the animation ends
  95219. */
  95220. waitAsync(): Promise<Animatable>;
  95221. /** @hidden */
  95222. _animate(delay: number): boolean;
  95223. }
  95224. interface Scene {
  95225. /** @hidden */
  95226. _registerTargetForLateAnimationBinding(runtimeAnimation: RuntimeAnimation, originalValue: any): void;
  95227. /** @hidden */
  95228. _processLateAnimationBindingsForMatrices(holder: {
  95229. totalWeight: number;
  95230. totalAdditiveWeight: number;
  95231. animations: RuntimeAnimation[];
  95232. additiveAnimations: RuntimeAnimation[];
  95233. originalValue: Matrix;
  95234. }): any;
  95235. /** @hidden */
  95236. _processLateAnimationBindingsForQuaternions(holder: {
  95237. totalWeight: number;
  95238. totalAdditiveWeight: number;
  95239. animations: RuntimeAnimation[];
  95240. additiveAnimations: RuntimeAnimation[];
  95241. originalValue: Quaternion;
  95242. }, refQuaternion: Quaternion): Quaternion;
  95243. /** @hidden */
  95244. _processLateAnimationBindings(): void;
  95245. /**
  95246. * Will start the animation sequence of a given target
  95247. * @param target defines the target
  95248. * @param from defines from which frame should animation start
  95249. * @param to defines until which frame should animation run.
  95250. * @param weight defines the weight to apply to the animation (1.0 by default)
  95251. * @param loop defines if the animation loops
  95252. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  95253. * @param onAnimationEnd defines the function to be executed when the animation ends
  95254. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  95255. * @param targetMask defines if the target should be animated if animations are present (this is called recursively on descendant animatables regardless of return value)
  95256. * @param onAnimationLoop defines the callback to call when an animation loops
  95257. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  95258. * @returns the animatable object created for this animation
  95259. */
  95260. 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;
  95261. /**
  95262. * Will start the animation sequence of a given target
  95263. * @param target defines the target
  95264. * @param from defines from which frame should animation start
  95265. * @param to defines until which frame should animation run.
  95266. * @param loop defines if the animation loops
  95267. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  95268. * @param onAnimationEnd defines the function to be executed when the animation ends
  95269. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  95270. * @param stopCurrent defines if the current animations must be stopped first (true by default)
  95271. * @param targetMask defines if the target should be animate if animations are present (this is called recursively on descendant animatables regardless of return value)
  95272. * @param onAnimationLoop defines the callback to call when an animation loops
  95273. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  95274. * @returns the animatable object created for this animation
  95275. */
  95276. 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;
  95277. /**
  95278. * Will start the animation sequence of a given target and its hierarchy
  95279. * @param target defines the target
  95280. * @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.
  95281. * @param from defines from which frame should animation start
  95282. * @param to defines until which frame should animation run.
  95283. * @param loop defines if the animation loops
  95284. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  95285. * @param onAnimationEnd defines the function to be executed when the animation ends
  95286. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  95287. * @param stopCurrent defines if the current animations must be stopped first (true by default)
  95288. * @param targetMask defines if the target should be animated if animations are present (this is called recursively on descendant animatables regardless of return value)
  95289. * @param onAnimationLoop defines the callback to call when an animation loops
  95290. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  95291. * @returns the list of created animatables
  95292. */
  95293. 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[];
  95294. /**
  95295. * Begin a new animation on a given node
  95296. * @param target defines the target where the animation will take place
  95297. * @param animations defines the list of animations to start
  95298. * @param from defines the initial value
  95299. * @param to defines the final value
  95300. * @param loop defines if you want animation to loop (off by default)
  95301. * @param speedRatio defines the speed ratio to apply to all animations
  95302. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  95303. * @param onAnimationLoop defines the callback to call when an animation loops
  95304. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  95305. * @returns the list of created animatables
  95306. */
  95307. beginDirectAnimation(target: any, animations: Animation[], from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, onAnimationLoop?: () => void, isAdditive?: boolean): Animatable;
  95308. /**
  95309. * Begin a new animation on a given node and its hierarchy
  95310. * @param target defines the root node where the animation will take place
  95311. * @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.
  95312. * @param animations defines the list of animations to start
  95313. * @param from defines the initial value
  95314. * @param to defines the final value
  95315. * @param loop defines if you want animation to loop (off by default)
  95316. * @param speedRatio defines the speed ratio to apply to all animations
  95317. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  95318. * @param onAnimationLoop defines the callback to call when an animation loops
  95319. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  95320. * @returns the list of animatables created for all nodes
  95321. */
  95322. beginDirectHierarchyAnimation(target: Node, directDescendantsOnly: boolean, animations: Animation[], from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, onAnimationLoop?: () => void, isAdditive?: boolean): Animatable[];
  95323. /**
  95324. * Gets the animatable associated with a specific target
  95325. * @param target defines the target of the animatable
  95326. * @returns the required animatable if found
  95327. */
  95328. getAnimatableByTarget(target: any): Nullable<Animatable>;
  95329. /**
  95330. * Gets all animatables associated with a given target
  95331. * @param target defines the target to look animatables for
  95332. * @returns an array of Animatables
  95333. */
  95334. getAllAnimatablesByTarget(target: any): Array<Animatable>;
  95335. /**
  95336. * Stops and removes all animations that have been applied to the scene
  95337. */
  95338. stopAllAnimations(): void;
  95339. /**
  95340. * Gets the current delta time used by animation engine
  95341. */
  95342. deltaTime: number;
  95343. }
  95344. interface Bone {
  95345. /**
  95346. * Copy an animation range from another bone
  95347. * @param source defines the source bone
  95348. * @param rangeName defines the range name to copy
  95349. * @param frameOffset defines the frame offset
  95350. * @param rescaleAsRequired defines if rescaling must be applied if required
  95351. * @param skelDimensionsRatio defines the scaling ratio
  95352. * @returns true if operation was successful
  95353. */
  95354. copyAnimationRange(source: Bone, rangeName: string, frameOffset: number, rescaleAsRequired: boolean, skelDimensionsRatio: Nullable<Vector3>): boolean;
  95355. }
  95356. }
  95357. declare module BABYLON {
  95358. /**
  95359. * Class used to handle skinning animations
  95360. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  95361. */
  95362. export class Skeleton implements IAnimatable {
  95363. /** defines the skeleton name */
  95364. name: string;
  95365. /** defines the skeleton Id */
  95366. id: string;
  95367. /**
  95368. * Defines the list of child bones
  95369. */
  95370. bones: Bone[];
  95371. /**
  95372. * Defines an estimate of the dimension of the skeleton at rest
  95373. */
  95374. dimensionsAtRest: Vector3;
  95375. /**
  95376. * Defines a boolean indicating if the root matrix is provided by meshes or by the current skeleton (this is the default value)
  95377. */
  95378. needInitialSkinMatrix: boolean;
  95379. /**
  95380. * Defines a mesh that override the matrix used to get the world matrix (null by default).
  95381. */
  95382. overrideMesh: Nullable<AbstractMesh>;
  95383. /**
  95384. * Gets the list of animations attached to this skeleton
  95385. */
  95386. animations: Array<Animation>;
  95387. private _scene;
  95388. private _isDirty;
  95389. private _transformMatrices;
  95390. private _transformMatrixTexture;
  95391. private _meshesWithPoseMatrix;
  95392. private _animatables;
  95393. private _identity;
  95394. private _synchronizedWithMesh;
  95395. private _ranges;
  95396. private _lastAbsoluteTransformsUpdateId;
  95397. private _canUseTextureForBones;
  95398. private _uniqueId;
  95399. /** @hidden */
  95400. _numBonesWithLinkedTransformNode: number;
  95401. /** @hidden */
  95402. _hasWaitingData: Nullable<boolean>;
  95403. /**
  95404. * Specifies if the skeleton should be serialized
  95405. */
  95406. doNotSerialize: boolean;
  95407. private _useTextureToStoreBoneMatrices;
  95408. /**
  95409. * Gets or sets a boolean indicating that bone matrices should be stored as a texture instead of using shader uniforms (default is true).
  95410. * Please note that this option is not available if the hardware does not support it
  95411. */
  95412. get useTextureToStoreBoneMatrices(): boolean;
  95413. set useTextureToStoreBoneMatrices(value: boolean);
  95414. private _animationPropertiesOverride;
  95415. /**
  95416. * Gets or sets the animation properties override
  95417. */
  95418. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  95419. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  95420. /**
  95421. * List of inspectable custom properties (used by the Inspector)
  95422. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  95423. */
  95424. inspectableCustomProperties: IInspectable[];
  95425. /**
  95426. * An observable triggered before computing the skeleton's matrices
  95427. */
  95428. onBeforeComputeObservable: Observable<Skeleton>;
  95429. /**
  95430. * Gets a boolean indicating that the skeleton effectively stores matrices into a texture
  95431. */
  95432. get isUsingTextureForMatrices(): boolean;
  95433. /**
  95434. * Gets the unique ID of this skeleton
  95435. */
  95436. get uniqueId(): number;
  95437. /**
  95438. * Creates a new skeleton
  95439. * @param name defines the skeleton name
  95440. * @param id defines the skeleton Id
  95441. * @param scene defines the hosting scene
  95442. */
  95443. constructor(
  95444. /** defines the skeleton name */
  95445. name: string,
  95446. /** defines the skeleton Id */
  95447. id: string, scene: Scene);
  95448. /**
  95449. * Gets the current object class name.
  95450. * @return the class name
  95451. */
  95452. getClassName(): string;
  95453. /**
  95454. * Returns an array containing the root bones
  95455. * @returns an array containing the root bones
  95456. */
  95457. getChildren(): Array<Bone>;
  95458. /**
  95459. * Gets the list of transform matrices to send to shaders (one matrix per bone)
  95460. * @param mesh defines the mesh to use to get the root matrix (if needInitialSkinMatrix === true)
  95461. * @returns a Float32Array containing matrices data
  95462. */
  95463. getTransformMatrices(mesh: AbstractMesh): Float32Array;
  95464. /**
  95465. * Gets the list of transform matrices to send to shaders inside a texture (one matrix per bone)
  95466. * @param mesh defines the mesh to use to get the root matrix (if needInitialSkinMatrix === true)
  95467. * @returns a raw texture containing the data
  95468. */
  95469. getTransformMatrixTexture(mesh: AbstractMesh): Nullable<RawTexture>;
  95470. /**
  95471. * Gets the current hosting scene
  95472. * @returns a scene object
  95473. */
  95474. getScene(): Scene;
  95475. /**
  95476. * Gets a string representing the current skeleton data
  95477. * @param fullDetails defines a boolean indicating if we want a verbose version
  95478. * @returns a string representing the current skeleton data
  95479. */
  95480. toString(fullDetails?: boolean): string;
  95481. /**
  95482. * Get bone's index searching by name
  95483. * @param name defines bone's name to search for
  95484. * @return the indice of the bone. Returns -1 if not found
  95485. */
  95486. getBoneIndexByName(name: string): number;
  95487. /**
  95488. * Creater a new animation range
  95489. * @param name defines the name of the range
  95490. * @param from defines the start key
  95491. * @param to defines the end key
  95492. */
  95493. createAnimationRange(name: string, from: number, to: number): void;
  95494. /**
  95495. * Delete a specific animation range
  95496. * @param name defines the name of the range
  95497. * @param deleteFrames defines if frames must be removed as well
  95498. */
  95499. deleteAnimationRange(name: string, deleteFrames?: boolean): void;
  95500. /**
  95501. * Gets a specific animation range
  95502. * @param name defines the name of the range to look for
  95503. * @returns the requested animation range or null if not found
  95504. */
  95505. getAnimationRange(name: string): Nullable<AnimationRange>;
  95506. /**
  95507. * Gets the list of all animation ranges defined on this skeleton
  95508. * @returns an array
  95509. */
  95510. getAnimationRanges(): Nullable<AnimationRange>[];
  95511. /**
  95512. * Copy animation range from a source skeleton.
  95513. * This is not for a complete retargeting, only between very similar skeleton's with only possible bone length differences
  95514. * @param source defines the source skeleton
  95515. * @param name defines the name of the range to copy
  95516. * @param rescaleAsRequired defines if rescaling must be applied if required
  95517. * @returns true if operation was successful
  95518. */
  95519. copyAnimationRange(source: Skeleton, name: string, rescaleAsRequired?: boolean): boolean;
  95520. /**
  95521. * Forces the skeleton to go to rest pose
  95522. */
  95523. returnToRest(): void;
  95524. private _getHighestAnimationFrame;
  95525. /**
  95526. * Begin a specific animation range
  95527. * @param name defines the name of the range to start
  95528. * @param loop defines if looping must be turned on (false by default)
  95529. * @param speedRatio defines the speed ratio to apply (1 by default)
  95530. * @param onAnimationEnd defines a callback which will be called when animation will end
  95531. * @returns a new animatable
  95532. */
  95533. beginAnimation(name: string, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void): Nullable<Animatable>;
  95534. /**
  95535. * Convert the keyframes for a range of animation on a skeleton to be relative to a given reference frame.
  95536. * @param skeleton defines the Skeleton containing the animation range to convert
  95537. * @param referenceFrame defines the frame that keyframes in the range will be relative to
  95538. * @param range defines the name of the AnimationRange belonging to the Skeleton to convert
  95539. * @returns the original skeleton
  95540. */
  95541. static MakeAnimationAdditive(skeleton: Skeleton, referenceFrame: number | undefined, range: string): Nullable<Skeleton>;
  95542. /** @hidden */
  95543. _markAsDirty(): void;
  95544. /** @hidden */
  95545. _registerMeshWithPoseMatrix(mesh: AbstractMesh): void;
  95546. /** @hidden */
  95547. _unregisterMeshWithPoseMatrix(mesh: AbstractMesh): void;
  95548. private _computeTransformMatrices;
  95549. /**
  95550. * Build all resources required to render a skeleton
  95551. */
  95552. prepare(): void;
  95553. /**
  95554. * Gets the list of animatables currently running for this skeleton
  95555. * @returns an array of animatables
  95556. */
  95557. getAnimatables(): IAnimatable[];
  95558. /**
  95559. * Clone the current skeleton
  95560. * @param name defines the name of the new skeleton
  95561. * @param id defines the id of the new skeleton
  95562. * @returns the new skeleton
  95563. */
  95564. clone(name: string, id?: string): Skeleton;
  95565. /**
  95566. * Enable animation blending for this skeleton
  95567. * @param blendingSpeed defines the blending speed to apply
  95568. * @see https://doc.babylonjs.com/babylon101/animations#animation-blending
  95569. */
  95570. enableBlending(blendingSpeed?: number): void;
  95571. /**
  95572. * Releases all resources associated with the current skeleton
  95573. */
  95574. dispose(): void;
  95575. /**
  95576. * Serialize the skeleton in a JSON object
  95577. * @returns a JSON object
  95578. */
  95579. serialize(): any;
  95580. /**
  95581. * Creates a new skeleton from serialized data
  95582. * @param parsedSkeleton defines the serialized data
  95583. * @param scene defines the hosting scene
  95584. * @returns a new skeleton
  95585. */
  95586. static Parse(parsedSkeleton: any, scene: Scene): Skeleton;
  95587. /**
  95588. * Compute all node absolute transforms
  95589. * @param forceUpdate defines if computation must be done even if cache is up to date
  95590. */
  95591. computeAbsoluteTransforms(forceUpdate?: boolean): void;
  95592. /**
  95593. * Gets the root pose matrix
  95594. * @returns a matrix
  95595. */
  95596. getPoseMatrix(): Nullable<Matrix>;
  95597. /**
  95598. * Sorts bones per internal index
  95599. */
  95600. sortBones(): void;
  95601. private _sortBones;
  95602. }
  95603. }
  95604. declare module BABYLON {
  95605. /**
  95606. * Creates an instance based on a source mesh.
  95607. */
  95608. export class InstancedMesh extends AbstractMesh {
  95609. private _sourceMesh;
  95610. private _currentLOD;
  95611. /** @hidden */
  95612. _indexInSourceMeshInstanceArray: number;
  95613. constructor(name: string, source: Mesh);
  95614. /**
  95615. * Returns the string "InstancedMesh".
  95616. */
  95617. getClassName(): string;
  95618. /** Gets the list of lights affecting that mesh */
  95619. get lightSources(): Light[];
  95620. _resyncLightSources(): void;
  95621. _resyncLightSource(light: Light): void;
  95622. _removeLightSource(light: Light, dispose: boolean): void;
  95623. /**
  95624. * If the source mesh receives shadows
  95625. */
  95626. get receiveShadows(): boolean;
  95627. /**
  95628. * The material of the source mesh
  95629. */
  95630. get material(): Nullable<Material>;
  95631. /**
  95632. * Visibility of the source mesh
  95633. */
  95634. get visibility(): number;
  95635. /**
  95636. * Skeleton of the source mesh
  95637. */
  95638. get skeleton(): Nullable<Skeleton>;
  95639. /**
  95640. * Rendering ground id of the source mesh
  95641. */
  95642. get renderingGroupId(): number;
  95643. set renderingGroupId(value: number);
  95644. /**
  95645. * Returns the total number of vertices (integer).
  95646. */
  95647. getTotalVertices(): number;
  95648. /**
  95649. * Returns a positive integer : the total number of indices in this mesh geometry.
  95650. * @returns the numner of indices or zero if the mesh has no geometry.
  95651. */
  95652. getTotalIndices(): number;
  95653. /**
  95654. * The source mesh of the instance
  95655. */
  95656. get sourceMesh(): Mesh;
  95657. /**
  95658. * Creates a new InstancedMesh object from the mesh model.
  95659. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  95660. * @param name defines the name of the new instance
  95661. * @returns a new InstancedMesh
  95662. */
  95663. createInstance(name: string): InstancedMesh;
  95664. /**
  95665. * Is this node ready to be used/rendered
  95666. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  95667. * @return {boolean} is it ready
  95668. */
  95669. isReady(completeCheck?: boolean): boolean;
  95670. /**
  95671. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  95672. * @param kind kind of verticies to retreive (eg. positons, normals, uvs, etc.)
  95673. * @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.
  95674. * @returns a float array or a Float32Array of the requested kind of data : positons, normals, uvs, etc.
  95675. */
  95676. getVerticesData(kind: string, copyWhenShared?: boolean): Nullable<FloatArray>;
  95677. /**
  95678. * Sets the vertex data of the mesh geometry for the requested `kind`.
  95679. * If the mesh has no geometry, a new Geometry object is set to the mesh and then passed this vertex data.
  95680. * The `data` are either a numeric array either a Float32Array.
  95681. * The parameter `updatable` is passed as is to the underlying Geometry object constructor (if initianilly none) or updater.
  95682. * 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).
  95683. * Note that a new underlying VertexBuffer object is created each call.
  95684. * If the `kind` is the `PositionKind`, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  95685. *
  95686. * Possible `kind` values :
  95687. * - VertexBuffer.PositionKind
  95688. * - VertexBuffer.UVKind
  95689. * - VertexBuffer.UV2Kind
  95690. * - VertexBuffer.UV3Kind
  95691. * - VertexBuffer.UV4Kind
  95692. * - VertexBuffer.UV5Kind
  95693. * - VertexBuffer.UV6Kind
  95694. * - VertexBuffer.ColorKind
  95695. * - VertexBuffer.MatricesIndicesKind
  95696. * - VertexBuffer.MatricesIndicesExtraKind
  95697. * - VertexBuffer.MatricesWeightsKind
  95698. * - VertexBuffer.MatricesWeightsExtraKind
  95699. *
  95700. * Returns the Mesh.
  95701. */
  95702. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  95703. /**
  95704. * Updates the existing vertex data of the mesh geometry for the requested `kind`.
  95705. * If the mesh has no geometry, it is simply returned as it is.
  95706. * The `data` are either a numeric array either a Float32Array.
  95707. * No new underlying VertexBuffer object is created.
  95708. * 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.
  95709. * If the parameter `makeItUnique` is true, a new global geometry is created from this positions and is set to the mesh.
  95710. *
  95711. * Possible `kind` values :
  95712. * - VertexBuffer.PositionKind
  95713. * - VertexBuffer.UVKind
  95714. * - VertexBuffer.UV2Kind
  95715. * - VertexBuffer.UV3Kind
  95716. * - VertexBuffer.UV4Kind
  95717. * - VertexBuffer.UV5Kind
  95718. * - VertexBuffer.UV6Kind
  95719. * - VertexBuffer.ColorKind
  95720. * - VertexBuffer.MatricesIndicesKind
  95721. * - VertexBuffer.MatricesIndicesExtraKind
  95722. * - VertexBuffer.MatricesWeightsKind
  95723. * - VertexBuffer.MatricesWeightsExtraKind
  95724. *
  95725. * Returns the Mesh.
  95726. */
  95727. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): Mesh;
  95728. /**
  95729. * Sets the mesh indices.
  95730. * Expects an array populated with integers or a typed array (Int32Array, Uint32Array, Uint16Array).
  95731. * If the mesh has no geometry, a new Geometry object is created and set to the mesh.
  95732. * This method creates a new index buffer each call.
  95733. * Returns the Mesh.
  95734. */
  95735. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>): Mesh;
  95736. /**
  95737. * Boolean : True if the mesh owns the requested kind of data.
  95738. */
  95739. isVerticesDataPresent(kind: string): boolean;
  95740. /**
  95741. * Returns an array of indices (IndicesArray).
  95742. */
  95743. getIndices(): Nullable<IndicesArray>;
  95744. get _positions(): Nullable<Vector3[]>;
  95745. /**
  95746. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  95747. * This means the mesh underlying bounding box and sphere are recomputed.
  95748. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  95749. * @returns the current mesh
  95750. */
  95751. refreshBoundingInfo(applySkeleton?: boolean): InstancedMesh;
  95752. /** @hidden */
  95753. _preActivate(): InstancedMesh;
  95754. /** @hidden */
  95755. _activate(renderId: number, intermediateRendering: boolean): boolean;
  95756. /** @hidden */
  95757. _postActivate(): void;
  95758. getWorldMatrix(): Matrix;
  95759. get isAnInstance(): boolean;
  95760. /**
  95761. * Returns the current associated LOD AbstractMesh.
  95762. */
  95763. getLOD(camera: Camera): AbstractMesh;
  95764. /** @hidden */
  95765. _preActivateForIntermediateRendering(renderId: number): Mesh;
  95766. /** @hidden */
  95767. _syncSubMeshes(): InstancedMesh;
  95768. /** @hidden */
  95769. _generatePointsArray(): boolean;
  95770. /** @hidden */
  95771. _updateBoundingInfo(): AbstractMesh;
  95772. /**
  95773. * Creates a new InstancedMesh from the current mesh.
  95774. * - name (string) : the cloned mesh name
  95775. * - newParent (optional Node) : the optional Node to parent the clone to.
  95776. * - doNotCloneChildren (optional boolean, default `false`) : if `true` the model children aren't cloned.
  95777. *
  95778. * Returns the clone.
  95779. */
  95780. clone(name: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean): InstancedMesh;
  95781. /**
  95782. * Disposes the InstancedMesh.
  95783. * Returns nothing.
  95784. */
  95785. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  95786. }
  95787. interface Mesh {
  95788. /**
  95789. * Register a custom buffer that will be instanced
  95790. * @see https://doc.babylonjs.com/how_to/how_to_use_instances#custom-buffers
  95791. * @param kind defines the buffer kind
  95792. * @param stride defines the stride in floats
  95793. */
  95794. registerInstancedBuffer(kind: string, stride: number): void;
  95795. /**
  95796. * true to use the edge renderer for all instances of this mesh
  95797. */
  95798. edgesShareWithInstances: boolean;
  95799. /** @hidden */
  95800. _userInstancedBuffersStorage: {
  95801. data: {
  95802. [key: string]: Float32Array;
  95803. };
  95804. sizes: {
  95805. [key: string]: number;
  95806. };
  95807. vertexBuffers: {
  95808. [key: string]: Nullable<VertexBuffer>;
  95809. };
  95810. strides: {
  95811. [key: string]: number;
  95812. };
  95813. };
  95814. }
  95815. interface AbstractMesh {
  95816. /**
  95817. * Object used to store instanced buffers defined by user
  95818. * @see https://doc.babylonjs.com/how_to/how_to_use_instances#custom-buffers
  95819. */
  95820. instancedBuffers: {
  95821. [key: string]: any;
  95822. };
  95823. }
  95824. }
  95825. declare module BABYLON {
  95826. /**
  95827. * Defines the options associated with the creation of a shader material.
  95828. */
  95829. export interface IShaderMaterialOptions {
  95830. /**
  95831. * Does the material work in alpha blend mode
  95832. */
  95833. needAlphaBlending: boolean;
  95834. /**
  95835. * Does the material work in alpha test mode
  95836. */
  95837. needAlphaTesting: boolean;
  95838. /**
  95839. * The list of attribute names used in the shader
  95840. */
  95841. attributes: string[];
  95842. /**
  95843. * The list of unifrom names used in the shader
  95844. */
  95845. uniforms: string[];
  95846. /**
  95847. * The list of UBO names used in the shader
  95848. */
  95849. uniformBuffers: string[];
  95850. /**
  95851. * The list of sampler names used in the shader
  95852. */
  95853. samplers: string[];
  95854. /**
  95855. * The list of defines used in the shader
  95856. */
  95857. defines: string[];
  95858. }
  95859. /**
  95860. * 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.
  95861. *
  95862. * This returned material effects how the mesh will look based on the code in the shaders.
  95863. *
  95864. * @see https://doc.babylonjs.com/how_to/shader_material
  95865. */
  95866. export class ShaderMaterial extends Material {
  95867. private _shaderPath;
  95868. private _options;
  95869. private _textures;
  95870. private _textureArrays;
  95871. private _floats;
  95872. private _ints;
  95873. private _floatsArrays;
  95874. private _colors3;
  95875. private _colors3Arrays;
  95876. private _colors4;
  95877. private _colors4Arrays;
  95878. private _vectors2;
  95879. private _vectors3;
  95880. private _vectors4;
  95881. private _matrices;
  95882. private _matrixArrays;
  95883. private _matrices3x3;
  95884. private _matrices2x2;
  95885. private _vectors2Arrays;
  95886. private _vectors3Arrays;
  95887. private _vectors4Arrays;
  95888. private _cachedWorldViewMatrix;
  95889. private _cachedWorldViewProjectionMatrix;
  95890. private _renderId;
  95891. private _multiview;
  95892. private _cachedDefines;
  95893. /** Define the Url to load snippets */
  95894. static SnippetUrl: string;
  95895. /** Snippet ID if the material was created from the snippet server */
  95896. snippetId: string;
  95897. /**
  95898. * Instantiate a new shader material.
  95899. * 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.
  95900. * This returned material effects how the mesh will look based on the code in the shaders.
  95901. * @see https://doc.babylonjs.com/how_to/shader_material
  95902. * @param name Define the name of the material in the scene
  95903. * @param scene Define the scene the material belongs to
  95904. * @param shaderPath Defines the route to the shader code in one of three ways:
  95905. * * object: { vertex: "custom", fragment: "custom" }, used with Effect.ShadersStore["customVertexShader"] and Effect.ShadersStore["customFragmentShader"]
  95906. * * object: { vertexElement: "vertexShaderCode", fragmentElement: "fragmentShaderCode" }, used with shader code in script tags
  95907. * * object: { vertexSource: "vertex shader code string", fragmentSource: "fragment shader code string" } using with strings containing the shaders code
  95908. * * string: "./COMMON_NAME", used with external files COMMON_NAME.vertex.fx and COMMON_NAME.fragment.fx in index.html folder.
  95909. * @param options Define the options used to create the shader
  95910. */
  95911. constructor(name: string, scene: Scene, shaderPath: any, options?: Partial<IShaderMaterialOptions>);
  95912. /**
  95913. * Gets the shader path used to define the shader code
  95914. * It can be modified to trigger a new compilation
  95915. */
  95916. get shaderPath(): any;
  95917. /**
  95918. * Sets the shader path used to define the shader code
  95919. * It can be modified to trigger a new compilation
  95920. */
  95921. set shaderPath(shaderPath: any);
  95922. /**
  95923. * Gets the options used to compile the shader.
  95924. * They can be modified to trigger a new compilation
  95925. */
  95926. get options(): IShaderMaterialOptions;
  95927. /**
  95928. * Gets the current class name of the material e.g. "ShaderMaterial"
  95929. * Mainly use in serialization.
  95930. * @returns the class name
  95931. */
  95932. getClassName(): string;
  95933. /**
  95934. * Specifies if the material will require alpha blending
  95935. * @returns a boolean specifying if alpha blending is needed
  95936. */
  95937. needAlphaBlending(): boolean;
  95938. /**
  95939. * Specifies if this material should be rendered in alpha test mode
  95940. * @returns a boolean specifying if an alpha test is needed.
  95941. */
  95942. needAlphaTesting(): boolean;
  95943. private _checkUniform;
  95944. /**
  95945. * Set a texture in the shader.
  95946. * @param name Define the name of the uniform samplers as defined in the shader
  95947. * @param texture Define the texture to bind to this sampler
  95948. * @return the material itself allowing "fluent" like uniform updates
  95949. */
  95950. setTexture(name: string, texture: BaseTexture): ShaderMaterial;
  95951. /**
  95952. * Set a texture array in the shader.
  95953. * @param name Define the name of the uniform sampler array as defined in the shader
  95954. * @param textures Define the list of textures to bind to this sampler
  95955. * @return the material itself allowing "fluent" like uniform updates
  95956. */
  95957. setTextureArray(name: string, textures: BaseTexture[]): ShaderMaterial;
  95958. /**
  95959. * Set a float in the shader.
  95960. * @param name Define the name of the uniform as defined in the shader
  95961. * @param value Define the value to give to the uniform
  95962. * @return the material itself allowing "fluent" like uniform updates
  95963. */
  95964. setFloat(name: string, value: number): ShaderMaterial;
  95965. /**
  95966. * Set a int in the shader.
  95967. * @param name Define the name of the uniform as defined in the shader
  95968. * @param value Define the value to give to the uniform
  95969. * @return the material itself allowing "fluent" like uniform updates
  95970. */
  95971. setInt(name: string, value: number): ShaderMaterial;
  95972. /**
  95973. * Set an array of floats in the shader.
  95974. * @param name Define the name of the uniform as defined in the shader
  95975. * @param value Define the value to give to the uniform
  95976. * @return the material itself allowing "fluent" like uniform updates
  95977. */
  95978. setFloats(name: string, value: number[]): ShaderMaterial;
  95979. /**
  95980. * Set a vec3 in the shader from a Color3.
  95981. * @param name Define the name of the uniform as defined in the shader
  95982. * @param value Define the value to give to the uniform
  95983. * @return the material itself allowing "fluent" like uniform updates
  95984. */
  95985. setColor3(name: string, value: Color3): ShaderMaterial;
  95986. /**
  95987. * Set a vec3 array in the shader from a Color3 array.
  95988. * @param name Define the name of the uniform as defined in the shader
  95989. * @param value Define the value to give to the uniform
  95990. * @return the material itself allowing "fluent" like uniform updates
  95991. */
  95992. setColor3Array(name: string, value: Color3[]): ShaderMaterial;
  95993. /**
  95994. * Set a vec4 in the shader from a Color4.
  95995. * @param name Define the name of the uniform as defined in the shader
  95996. * @param value Define the value to give to the uniform
  95997. * @return the material itself allowing "fluent" like uniform updates
  95998. */
  95999. setColor4(name: string, value: Color4): ShaderMaterial;
  96000. /**
  96001. * Set a vec4 array in the shader from a Color4 array.
  96002. * @param name Define the name of the uniform as defined in the shader
  96003. * @param value Define the value to give to the uniform
  96004. * @return the material itself allowing "fluent" like uniform updates
  96005. */
  96006. setColor4Array(name: string, value: Color4[]): ShaderMaterial;
  96007. /**
  96008. * Set a vec2 in the shader from a Vector2.
  96009. * @param name Define the name of the uniform as defined in the shader
  96010. * @param value Define the value to give to the uniform
  96011. * @return the material itself allowing "fluent" like uniform updates
  96012. */
  96013. setVector2(name: string, value: Vector2): ShaderMaterial;
  96014. /**
  96015. * Set a vec3 in the shader from a Vector3.
  96016. * @param name Define the name of the uniform as defined in the shader
  96017. * @param value Define the value to give to the uniform
  96018. * @return the material itself allowing "fluent" like uniform updates
  96019. */
  96020. setVector3(name: string, value: Vector3): ShaderMaterial;
  96021. /**
  96022. * Set a vec4 in the shader from a Vector4.
  96023. * @param name Define the name of the uniform as defined in the shader
  96024. * @param value Define the value to give to the uniform
  96025. * @return the material itself allowing "fluent" like uniform updates
  96026. */
  96027. setVector4(name: string, value: Vector4): ShaderMaterial;
  96028. /**
  96029. * Set a mat4 in the shader from a Matrix.
  96030. * @param name Define the name of the uniform as defined in the shader
  96031. * @param value Define the value to give to the uniform
  96032. * @return the material itself allowing "fluent" like uniform updates
  96033. */
  96034. setMatrix(name: string, value: Matrix): ShaderMaterial;
  96035. /**
  96036. * Set a float32Array in the shader from a matrix array.
  96037. * @param name Define the name of the uniform as defined in the shader
  96038. * @param value Define the value to give to the uniform
  96039. * @return the material itself allowing "fluent" like uniform updates
  96040. */
  96041. setMatrices(name: string, value: Matrix[]): ShaderMaterial;
  96042. /**
  96043. * Set a mat3 in the shader from a Float32Array.
  96044. * @param name Define the name of the uniform as defined in the shader
  96045. * @param value Define the value to give to the uniform
  96046. * @return the material itself allowing "fluent" like uniform updates
  96047. */
  96048. setMatrix3x3(name: string, value: Float32Array | Array<number>): ShaderMaterial;
  96049. /**
  96050. * Set a mat2 in the shader from a Float32Array.
  96051. * @param name Define the name of the uniform as defined in the shader
  96052. * @param value Define the value to give to the uniform
  96053. * @return the material itself allowing "fluent" like uniform updates
  96054. */
  96055. setMatrix2x2(name: string, value: Float32Array | Array<number>): ShaderMaterial;
  96056. /**
  96057. * Set a vec2 array in the shader from a number array.
  96058. * @param name Define the name of the uniform as defined in the shader
  96059. * @param value Define the value to give to the uniform
  96060. * @return the material itself allowing "fluent" like uniform updates
  96061. */
  96062. setArray2(name: string, value: number[]): ShaderMaterial;
  96063. /**
  96064. * Set a vec3 array in the shader from a number array.
  96065. * @param name Define the name of the uniform as defined in the shader
  96066. * @param value Define the value to give to the uniform
  96067. * @return the material itself allowing "fluent" like uniform updates
  96068. */
  96069. setArray3(name: string, value: number[]): ShaderMaterial;
  96070. /**
  96071. * Set a vec4 array in the shader from a number array.
  96072. * @param name Define the name of the uniform as defined in the shader
  96073. * @param value Define the value to give to the uniform
  96074. * @return the material itself allowing "fluent" like uniform updates
  96075. */
  96076. setArray4(name: string, value: number[]): ShaderMaterial;
  96077. private _checkCache;
  96078. /**
  96079. * Specifies that the submesh is ready to be used
  96080. * @param mesh defines the mesh to check
  96081. * @param subMesh defines which submesh to check
  96082. * @param useInstances specifies that instances should be used
  96083. * @returns a boolean indicating that the submesh is ready or not
  96084. */
  96085. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  96086. /**
  96087. * Checks if the material is ready to render the requested mesh
  96088. * @param mesh Define the mesh to render
  96089. * @param useInstances Define whether or not the material is used with instances
  96090. * @returns true if ready, otherwise false
  96091. */
  96092. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  96093. /**
  96094. * Binds the world matrix to the material
  96095. * @param world defines the world transformation matrix
  96096. * @param effectOverride - If provided, use this effect instead of internal effect
  96097. */
  96098. bindOnlyWorldMatrix(world: Matrix, effectOverride?: Nullable<Effect>): void;
  96099. /**
  96100. * Binds the submesh to this material by preparing the effect and shader to draw
  96101. * @param world defines the world transformation matrix
  96102. * @param mesh defines the mesh containing the submesh
  96103. * @param subMesh defines the submesh to bind the material to
  96104. */
  96105. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  96106. /**
  96107. * Binds the material to the mesh
  96108. * @param world defines the world transformation matrix
  96109. * @param mesh defines the mesh to bind the material to
  96110. * @param effectOverride - If provided, use this effect instead of internal effect
  96111. */
  96112. bind(world: Matrix, mesh?: Mesh, effectOverride?: Nullable<Effect>): void;
  96113. protected _afterBind(mesh?: Mesh): void;
  96114. /**
  96115. * Gets the active textures from the material
  96116. * @returns an array of textures
  96117. */
  96118. getActiveTextures(): BaseTexture[];
  96119. /**
  96120. * Specifies if the material uses a texture
  96121. * @param texture defines the texture to check against the material
  96122. * @returns a boolean specifying if the material uses the texture
  96123. */
  96124. hasTexture(texture: BaseTexture): boolean;
  96125. /**
  96126. * Makes a duplicate of the material, and gives it a new name
  96127. * @param name defines the new name for the duplicated material
  96128. * @returns the cloned material
  96129. */
  96130. clone(name: string): ShaderMaterial;
  96131. /**
  96132. * Disposes the material
  96133. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  96134. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  96135. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  96136. */
  96137. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  96138. /**
  96139. * Serializes this material in a JSON representation
  96140. * @returns the serialized material object
  96141. */
  96142. serialize(): any;
  96143. /**
  96144. * Creates a shader material from parsed shader material data
  96145. * @param source defines the JSON represnetation of the material
  96146. * @param scene defines the hosting scene
  96147. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  96148. * @returns a new material
  96149. */
  96150. static Parse(source: any, scene: Scene, rootUrl: string): ShaderMaterial;
  96151. /**
  96152. * Creates a new ShaderMaterial from a snippet saved in a remote file
  96153. * @param name defines the name of the ShaderMaterial to create (can be null or empty to use the one from the json data)
  96154. * @param url defines the url to load from
  96155. * @param scene defines the hosting scene
  96156. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  96157. * @returns a promise that will resolve to the new ShaderMaterial
  96158. */
  96159. static ParseFromFileAsync(name: Nullable<string>, url: string, scene: Scene, rootUrl?: string): Promise<ShaderMaterial>;
  96160. /**
  96161. * Creates a ShaderMaterial from a snippet saved by the Inspector
  96162. * @param snippetId defines the snippet to load
  96163. * @param scene defines the hosting scene
  96164. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  96165. * @returns a promise that will resolve to the new ShaderMaterial
  96166. */
  96167. static CreateFromSnippetAsync(snippetId: string, scene: Scene, rootUrl?: string): Promise<ShaderMaterial>;
  96168. }
  96169. }
  96170. declare module BABYLON {
  96171. /** @hidden */
  96172. export var colorPixelShader: {
  96173. name: string;
  96174. shader: string;
  96175. };
  96176. }
  96177. declare module BABYLON {
  96178. /** @hidden */
  96179. export var colorVertexShader: {
  96180. name: string;
  96181. shader: string;
  96182. };
  96183. }
  96184. declare module BABYLON {
  96185. /**
  96186. * Line mesh
  96187. * @see https://doc.babylonjs.com/babylon101/parametric_shapes
  96188. */
  96189. export class LinesMesh extends Mesh {
  96190. /**
  96191. * If vertex color should be applied to the mesh
  96192. */
  96193. readonly useVertexColor?: boolean | undefined;
  96194. /**
  96195. * If vertex alpha should be applied to the mesh
  96196. */
  96197. readonly useVertexAlpha?: boolean | undefined;
  96198. /**
  96199. * Color of the line (Default: White)
  96200. */
  96201. color: Color3;
  96202. /**
  96203. * Alpha of the line (Default: 1)
  96204. */
  96205. alpha: number;
  96206. /**
  96207. * The intersection Threshold is the margin applied when intersection a segment of the LinesMesh with a Ray.
  96208. * This margin is expressed in world space coordinates, so its value may vary.
  96209. * Default value is 0.1
  96210. */
  96211. intersectionThreshold: number;
  96212. private _colorShader;
  96213. private color4;
  96214. /**
  96215. * Creates a new LinesMesh
  96216. * @param name defines the name
  96217. * @param scene defines the hosting scene
  96218. * @param parent defines the parent mesh if any
  96219. * @param source defines the optional source LinesMesh used to clone data from
  96220. * @param doNotCloneChildren When cloning, skip cloning child meshes of source, default False.
  96221. * When false, achieved by calling a clone(), also passing False.
  96222. * This will make creation of children, recursive.
  96223. * @param useVertexColor defines if this LinesMesh supports vertex color
  96224. * @param useVertexAlpha defines if this LinesMesh supports vertex alpha
  96225. */
  96226. constructor(name: string, scene?: Nullable<Scene>, parent?: Nullable<Node>, source?: Nullable<LinesMesh>, doNotCloneChildren?: boolean,
  96227. /**
  96228. * If vertex color should be applied to the mesh
  96229. */
  96230. useVertexColor?: boolean | undefined,
  96231. /**
  96232. * If vertex alpha should be applied to the mesh
  96233. */
  96234. useVertexAlpha?: boolean | undefined);
  96235. private _addClipPlaneDefine;
  96236. private _removeClipPlaneDefine;
  96237. isReady(): boolean;
  96238. /**
  96239. * Returns the string "LineMesh"
  96240. */
  96241. getClassName(): string;
  96242. /**
  96243. * @hidden
  96244. */
  96245. get material(): Material;
  96246. /**
  96247. * @hidden
  96248. */
  96249. set material(value: Material);
  96250. /**
  96251. * @hidden
  96252. */
  96253. get checkCollisions(): boolean;
  96254. /** @hidden */
  96255. _bind(subMesh: SubMesh, effect: Effect, fillMode: number): Mesh;
  96256. /** @hidden */
  96257. _draw(subMesh: SubMesh, fillMode: number, instancesCount?: number): Mesh;
  96258. /**
  96259. * Disposes of the line mesh
  96260. * @param doNotRecurse If children should be disposed
  96261. */
  96262. dispose(doNotRecurse?: boolean): void;
  96263. /**
  96264. * Returns a new LineMesh object cloned from the current one.
  96265. */
  96266. clone(name: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean): LinesMesh;
  96267. /**
  96268. * Creates a new InstancedLinesMesh object from the mesh model.
  96269. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  96270. * @param name defines the name of the new instance
  96271. * @returns a new InstancedLinesMesh
  96272. */
  96273. createInstance(name: string): InstancedLinesMesh;
  96274. }
  96275. /**
  96276. * Creates an instance based on a source LinesMesh
  96277. */
  96278. export class InstancedLinesMesh extends InstancedMesh {
  96279. /**
  96280. * The intersection Threshold is the margin applied when intersection a segment of the LinesMesh with a Ray.
  96281. * This margin is expressed in world space coordinates, so its value may vary.
  96282. * Initilized with the intersectionThreshold value of the source LinesMesh
  96283. */
  96284. intersectionThreshold: number;
  96285. constructor(name: string, source: LinesMesh);
  96286. /**
  96287. * Returns the string "InstancedLinesMesh".
  96288. */
  96289. getClassName(): string;
  96290. }
  96291. }
  96292. declare module BABYLON {
  96293. /** @hidden */
  96294. export var linePixelShader: {
  96295. name: string;
  96296. shader: string;
  96297. };
  96298. }
  96299. declare module BABYLON {
  96300. /** @hidden */
  96301. export var lineVertexShader: {
  96302. name: string;
  96303. shader: string;
  96304. };
  96305. }
  96306. declare module BABYLON {
  96307. interface Scene {
  96308. /** @hidden */
  96309. _edgeRenderLineShader: Nullable<ShaderMaterial>;
  96310. }
  96311. interface AbstractMesh {
  96312. /**
  96313. * Gets the edgesRenderer associated with the mesh
  96314. */
  96315. edgesRenderer: Nullable<EdgesRenderer>;
  96316. }
  96317. interface LinesMesh {
  96318. /**
  96319. * Enables the edge rendering mode on the mesh.
  96320. * This mode makes the mesh edges visible
  96321. * @param epsilon defines the maximal distance between two angles to detect a face
  96322. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  96323. * @returns the currentAbstractMesh
  96324. * @see https://www.babylonjs-playground.com/#19O9TU#0
  96325. */
  96326. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): AbstractMesh;
  96327. }
  96328. interface InstancedLinesMesh {
  96329. /**
  96330. * Enables the edge rendering mode on the mesh.
  96331. * This mode makes the mesh edges visible
  96332. * @param epsilon defines the maximal distance between two angles to detect a face
  96333. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  96334. * @returns the current InstancedLinesMesh
  96335. * @see https://www.babylonjs-playground.com/#19O9TU#0
  96336. */
  96337. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): InstancedLinesMesh;
  96338. }
  96339. /**
  96340. * Defines the minimum contract an Edges renderer should follow.
  96341. */
  96342. export interface IEdgesRenderer extends IDisposable {
  96343. /**
  96344. * Gets or sets a boolean indicating if the edgesRenderer is active
  96345. */
  96346. isEnabled: boolean;
  96347. /**
  96348. * Renders the edges of the attached mesh,
  96349. */
  96350. render(): void;
  96351. /**
  96352. * Checks wether or not the edges renderer is ready to render.
  96353. * @return true if ready, otherwise false.
  96354. */
  96355. isReady(): boolean;
  96356. /**
  96357. * List of instances to render in case the source mesh has instances
  96358. */
  96359. customInstances: SmartArray<Matrix>;
  96360. }
  96361. /**
  96362. * Defines the additional options of the edges renderer
  96363. */
  96364. export interface IEdgesRendererOptions {
  96365. /**
  96366. * Gets or sets a boolean indicating that the alternate edge finder algorithm must be used
  96367. * If not defined, the default value is true
  96368. */
  96369. useAlternateEdgeFinder?: boolean;
  96370. /**
  96371. * Gets or sets a boolean indicating that the vertex merger fast processing must be used.
  96372. * If not defined, the default value is true.
  96373. * 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)
  96374. * This option is used only if useAlternateEdgeFinder = true
  96375. */
  96376. useFastVertexMerger?: boolean;
  96377. /**
  96378. * During edges processing, the vertices are merged if they are close enough: epsilonVertexMerge is the limit whithin which vertices are considered to be equal.
  96379. * The default value is 1e-6
  96380. * This option is used only if useAlternateEdgeFinder = true
  96381. */
  96382. epsilonVertexMerge?: number;
  96383. /**
  96384. * 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
  96385. * 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.
  96386. * This option is used only if useAlternateEdgeFinder = true
  96387. */
  96388. applyTessellation?: boolean;
  96389. /**
  96390. * 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
  96391. * The default value is 1e-6
  96392. * This option is used only if useAlternateEdgeFinder = true
  96393. */
  96394. epsilonVertexAligned?: number;
  96395. }
  96396. /**
  96397. * This class is used to generate edges of the mesh that could then easily be rendered in a scene.
  96398. */
  96399. export class EdgesRenderer implements IEdgesRenderer {
  96400. /**
  96401. * Define the size of the edges with an orthographic camera
  96402. */
  96403. edgesWidthScalerForOrthographic: number;
  96404. /**
  96405. * Define the size of the edges with a perspective camera
  96406. */
  96407. edgesWidthScalerForPerspective: number;
  96408. protected _source: AbstractMesh;
  96409. protected _linesPositions: number[];
  96410. protected _linesNormals: number[];
  96411. protected _linesIndices: number[];
  96412. protected _epsilon: number;
  96413. protected _indicesCount: number;
  96414. protected _lineShader: ShaderMaterial;
  96415. protected _ib: DataBuffer;
  96416. protected _buffers: {
  96417. [key: string]: Nullable<VertexBuffer>;
  96418. };
  96419. protected _buffersForInstances: {
  96420. [key: string]: Nullable<VertexBuffer>;
  96421. };
  96422. protected _checkVerticesInsteadOfIndices: boolean;
  96423. protected _options: Nullable<IEdgesRendererOptions>;
  96424. private _meshRebuildObserver;
  96425. private _meshDisposeObserver;
  96426. /** Gets or sets a boolean indicating if the edgesRenderer is active */
  96427. isEnabled: boolean;
  96428. /**
  96429. * List of instances to render in case the source mesh has instances
  96430. */
  96431. customInstances: SmartArray<Matrix>;
  96432. private static GetShader;
  96433. /**
  96434. * Creates an instance of the EdgesRenderer. It is primarily use to display edges of a mesh.
  96435. * Beware when you use this class with complex objects as the adjacencies computation can be really long
  96436. * @param source Mesh used to create edges
  96437. * @param epsilon sum of angles in adjacency to check for edge
  96438. * @param checkVerticesInsteadOfIndices bases the edges detection on vertices vs indices. Note that this parameter is not used if options.useAlternateEdgeFinder = true
  96439. * @param generateEdgesLines - should generate Lines or only prepare resources.
  96440. * @param options The options to apply when generating the edges
  96441. */
  96442. constructor(source: AbstractMesh, epsilon?: number, checkVerticesInsteadOfIndices?: boolean, generateEdgesLines?: boolean, options?: IEdgesRendererOptions);
  96443. protected _prepareRessources(): void;
  96444. /** @hidden */
  96445. _rebuild(): void;
  96446. /**
  96447. * Releases the required resources for the edges renderer
  96448. */
  96449. dispose(): void;
  96450. protected _processEdgeForAdjacencies(pa: number, pb: number, p0: number, p1: number, p2: number): number;
  96451. protected _processEdgeForAdjacenciesWithVertices(pa: Vector3, pb: Vector3, p0: Vector3, p1: Vector3, p2: Vector3): number;
  96452. /**
  96453. * Checks if the pair of p0 and p1 is en edge
  96454. * @param faceIndex
  96455. * @param edge
  96456. * @param faceNormals
  96457. * @param p0
  96458. * @param p1
  96459. * @private
  96460. */
  96461. protected _checkEdge(faceIndex: number, edge: number, faceNormals: Array<Vector3>, p0: Vector3, p1: Vector3): void;
  96462. /**
  96463. * push line into the position, normal and index buffer
  96464. * @protected
  96465. */
  96466. protected createLine(p0: Vector3, p1: Vector3, offset: number): void;
  96467. /**
  96468. * See https://playground.babylonjs.com/#R3JR6V#1 for a visual display of the algorithm
  96469. */
  96470. private _tessellateTriangle;
  96471. private _generateEdgesLinesAlternate;
  96472. /**
  96473. * Generates lines edges from adjacencjes
  96474. * @private
  96475. */
  96476. _generateEdgesLines(): void;
  96477. /**
  96478. * Checks wether or not the edges renderer is ready to render.
  96479. * @return true if ready, otherwise false.
  96480. */
  96481. isReady(): boolean;
  96482. /**
  96483. * Renders the edges of the attached mesh,
  96484. */
  96485. render(): void;
  96486. }
  96487. /**
  96488. * LineEdgesRenderer for LineMeshes to remove unnecessary triangulation
  96489. */
  96490. export class LineEdgesRenderer extends EdgesRenderer {
  96491. /**
  96492. * This constructor turns off auto generating edges line in Edges Renderer to make it here.
  96493. * @param source LineMesh used to generate edges
  96494. * @param epsilon not important (specified angle for edge detection)
  96495. * @param checkVerticesInsteadOfIndices not important for LineMesh
  96496. */
  96497. constructor(source: AbstractMesh, epsilon?: number, checkVerticesInsteadOfIndices?: boolean);
  96498. /**
  96499. * Generate edges for each line in LinesMesh. Every Line should be rendered as edge.
  96500. */
  96501. _generateEdgesLines(): void;
  96502. }
  96503. }
  96504. declare module BABYLON {
  96505. /**
  96506. * This represents the object necessary to create a rendering group.
  96507. * This is exclusively used and created by the rendering manager.
  96508. * To modify the behavior, you use the available helpers in your scene or meshes.
  96509. * @hidden
  96510. */
  96511. export class RenderingGroup {
  96512. index: number;
  96513. private static _zeroVector;
  96514. private _scene;
  96515. private _opaqueSubMeshes;
  96516. private _transparentSubMeshes;
  96517. private _alphaTestSubMeshes;
  96518. private _depthOnlySubMeshes;
  96519. private _particleSystems;
  96520. private _spriteManagers;
  96521. private _opaqueSortCompareFn;
  96522. private _alphaTestSortCompareFn;
  96523. private _transparentSortCompareFn;
  96524. private _renderOpaque;
  96525. private _renderAlphaTest;
  96526. private _renderTransparent;
  96527. /** @hidden */
  96528. _edgesRenderers: SmartArrayNoDuplicate<IEdgesRenderer>;
  96529. onBeforeTransparentRendering: () => void;
  96530. /**
  96531. * Set the opaque sort comparison function.
  96532. * If null the sub meshes will be render in the order they were created
  96533. */
  96534. set opaqueSortCompareFn(value: Nullable<(a: SubMesh, b: SubMesh) => number>);
  96535. /**
  96536. * Set the alpha test sort comparison function.
  96537. * If null the sub meshes will be render in the order they were created
  96538. */
  96539. set alphaTestSortCompareFn(value: Nullable<(a: SubMesh, b: SubMesh) => number>);
  96540. /**
  96541. * Set the transparent sort comparison function.
  96542. * If null the sub meshes will be render in the order they were created
  96543. */
  96544. set transparentSortCompareFn(value: Nullable<(a: SubMesh, b: SubMesh) => number>);
  96545. /**
  96546. * Creates a new rendering group.
  96547. * @param index The rendering group index
  96548. * @param opaqueSortCompareFn The opaque sort comparison function. If null no order is applied
  96549. * @param alphaTestSortCompareFn The alpha test sort comparison function. If null no order is applied
  96550. * @param transparentSortCompareFn The transparent sort comparison function. If null back to front + alpha index sort is applied
  96551. */
  96552. 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>);
  96553. /**
  96554. * Render all the sub meshes contained in the group.
  96555. * @param customRenderFunction Used to override the default render behaviour of the group.
  96556. * @returns true if rendered some submeshes.
  96557. */
  96558. render(customRenderFunction: Nullable<(opaqueSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>) => void>, renderSprites: boolean, renderParticles: boolean, activeMeshes: Nullable<AbstractMesh[]>): void;
  96559. /**
  96560. * Renders the opaque submeshes in the order from the opaqueSortCompareFn.
  96561. * @param subMeshes The submeshes to render
  96562. */
  96563. private renderOpaqueSorted;
  96564. /**
  96565. * Renders the opaque submeshes in the order from the alphatestSortCompareFn.
  96566. * @param subMeshes The submeshes to render
  96567. */
  96568. private renderAlphaTestSorted;
  96569. /**
  96570. * Renders the opaque submeshes in the order from the transparentSortCompareFn.
  96571. * @param subMeshes The submeshes to render
  96572. */
  96573. private renderTransparentSorted;
  96574. /**
  96575. * Renders the submeshes in a specified order.
  96576. * @param subMeshes The submeshes to sort before render
  96577. * @param sortCompareFn The comparison function use to sort
  96578. * @param cameraPosition The camera position use to preprocess the submeshes to help sorting
  96579. * @param transparent Specifies to activate blending if true
  96580. */
  96581. private static renderSorted;
  96582. /**
  96583. * Renders the submeshes in the order they were dispatched (no sort applied).
  96584. * @param subMeshes The submeshes to render
  96585. */
  96586. private static renderUnsorted;
  96587. /**
  96588. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  96589. * are rendered back to front if in the same alpha index.
  96590. *
  96591. * @param a The first submesh
  96592. * @param b The second submesh
  96593. * @returns The result of the comparison
  96594. */
  96595. static defaultTransparentSortCompare(a: SubMesh, b: SubMesh): number;
  96596. /**
  96597. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  96598. * are rendered back to front.
  96599. *
  96600. * @param a The first submesh
  96601. * @param b The second submesh
  96602. * @returns The result of the comparison
  96603. */
  96604. static backToFrontSortCompare(a: SubMesh, b: SubMesh): number;
  96605. /**
  96606. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  96607. * are rendered front to back (prevent overdraw).
  96608. *
  96609. * @param a The first submesh
  96610. * @param b The second submesh
  96611. * @returns The result of the comparison
  96612. */
  96613. static frontToBackSortCompare(a: SubMesh, b: SubMesh): number;
  96614. /**
  96615. * Resets the different lists of submeshes to prepare a new frame.
  96616. */
  96617. prepare(): void;
  96618. dispose(): void;
  96619. /**
  96620. * Inserts the submesh in its correct queue depending on its material.
  96621. * @param subMesh The submesh to dispatch
  96622. * @param [mesh] Optional reference to the submeshes's mesh. Provide if you have an exiting reference to improve performance.
  96623. * @param [material] Optional reference to the submeshes's material. Provide if you have an exiting reference to improve performance.
  96624. */
  96625. dispatch(subMesh: SubMesh, mesh?: AbstractMesh, material?: Nullable<Material>): void;
  96626. dispatchSprites(spriteManager: ISpriteManager): void;
  96627. dispatchParticles(particleSystem: IParticleSystem): void;
  96628. private _renderParticles;
  96629. private _renderSprites;
  96630. }
  96631. }
  96632. declare module BABYLON {
  96633. /**
  96634. * Interface describing the different options available in the rendering manager
  96635. * regarding Auto Clear between groups.
  96636. */
  96637. export interface IRenderingManagerAutoClearSetup {
  96638. /**
  96639. * Defines whether or not autoclear is enable.
  96640. */
  96641. autoClear: boolean;
  96642. /**
  96643. * Defines whether or not to autoclear the depth buffer.
  96644. */
  96645. depth: boolean;
  96646. /**
  96647. * Defines whether or not to autoclear the stencil buffer.
  96648. */
  96649. stencil: boolean;
  96650. }
  96651. /**
  96652. * This class is used by the onRenderingGroupObservable
  96653. */
  96654. export class RenderingGroupInfo {
  96655. /**
  96656. * The Scene that being rendered
  96657. */
  96658. scene: Scene;
  96659. /**
  96660. * The camera currently used for the rendering pass
  96661. */
  96662. camera: Nullable<Camera>;
  96663. /**
  96664. * The ID of the renderingGroup being processed
  96665. */
  96666. renderingGroupId: number;
  96667. }
  96668. /**
  96669. * This is the manager responsible of all the rendering for meshes sprites and particles.
  96670. * It is enable to manage the different groups as well as the different necessary sort functions.
  96671. * This should not be used directly aside of the few static configurations
  96672. */
  96673. export class RenderingManager {
  96674. /**
  96675. * The max id used for rendering groups (not included)
  96676. */
  96677. static MAX_RENDERINGGROUPS: number;
  96678. /**
  96679. * The min id used for rendering groups (included)
  96680. */
  96681. static MIN_RENDERINGGROUPS: number;
  96682. /**
  96683. * Used to globally prevent autoclearing scenes.
  96684. */
  96685. static AUTOCLEAR: boolean;
  96686. /**
  96687. * @hidden
  96688. */
  96689. _useSceneAutoClearSetup: boolean;
  96690. private _scene;
  96691. private _renderingGroups;
  96692. private _depthStencilBufferAlreadyCleaned;
  96693. private _autoClearDepthStencil;
  96694. private _customOpaqueSortCompareFn;
  96695. private _customAlphaTestSortCompareFn;
  96696. private _customTransparentSortCompareFn;
  96697. private _renderingGroupInfo;
  96698. /**
  96699. * Instantiates a new rendering group for a particular scene
  96700. * @param scene Defines the scene the groups belongs to
  96701. */
  96702. constructor(scene: Scene);
  96703. private _clearDepthStencilBuffer;
  96704. /**
  96705. * Renders the entire managed groups. This is used by the scene or the different rennder targets.
  96706. * @hidden
  96707. */
  96708. render(customRenderFunction: Nullable<(opaqueSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>) => void>, activeMeshes: Nullable<AbstractMesh[]>, renderParticles: boolean, renderSprites: boolean): void;
  96709. /**
  96710. * Resets the different information of the group to prepare a new frame
  96711. * @hidden
  96712. */
  96713. reset(): void;
  96714. /**
  96715. * Dispose and release the group and its associated resources.
  96716. * @hidden
  96717. */
  96718. dispose(): void;
  96719. /**
  96720. * Clear the info related to rendering groups preventing retention points during dispose.
  96721. */
  96722. freeRenderingGroups(): void;
  96723. private _prepareRenderingGroup;
  96724. /**
  96725. * Add a sprite manager to the rendering manager in order to render it this frame.
  96726. * @param spriteManager Define the sprite manager to render
  96727. */
  96728. dispatchSprites(spriteManager: ISpriteManager): void;
  96729. /**
  96730. * Add a particle system to the rendering manager in order to render it this frame.
  96731. * @param particleSystem Define the particle system to render
  96732. */
  96733. dispatchParticles(particleSystem: IParticleSystem): void;
  96734. /**
  96735. * Add a submesh to the manager in order to render it this frame
  96736. * @param subMesh The submesh to dispatch
  96737. * @param mesh Optional reference to the submeshes's mesh. Provide if you have an exiting reference to improve performance.
  96738. * @param material Optional reference to the submeshes's material. Provide if you have an exiting reference to improve performance.
  96739. */
  96740. dispatch(subMesh: SubMesh, mesh?: AbstractMesh, material?: Nullable<Material>): void;
  96741. /**
  96742. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  96743. * This allowed control for front to back rendering or reversly depending of the special needs.
  96744. *
  96745. * @param renderingGroupId The rendering group id corresponding to its index
  96746. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  96747. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  96748. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  96749. */
  96750. 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;
  96751. /**
  96752. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  96753. *
  96754. * @param renderingGroupId The rendering group id corresponding to its index
  96755. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  96756. * @param depth Automatically clears depth between groups if true and autoClear is true.
  96757. * @param stencil Automatically clears stencil between groups if true and autoClear is true.
  96758. */
  96759. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean, depth?: boolean, stencil?: boolean): void;
  96760. /**
  96761. * Gets the current auto clear configuration for one rendering group of the rendering
  96762. * manager.
  96763. * @param index the rendering group index to get the information for
  96764. * @returns The auto clear setup for the requested rendering group
  96765. */
  96766. getAutoClearDepthStencilSetup(index: number): IRenderingManagerAutoClearSetup;
  96767. }
  96768. }
  96769. declare module BABYLON {
  96770. /**
  96771. * Defines the options associated with the creation of a custom shader for a shadow generator.
  96772. */
  96773. export interface ICustomShaderOptions {
  96774. /**
  96775. * Gets or sets the custom shader name to use
  96776. */
  96777. shaderName: string;
  96778. /**
  96779. * The list of attribute names used in the shader
  96780. */
  96781. attributes?: string[];
  96782. /**
  96783. * The list of unifrom names used in the shader
  96784. */
  96785. uniforms?: string[];
  96786. /**
  96787. * The list of sampler names used in the shader
  96788. */
  96789. samplers?: string[];
  96790. /**
  96791. * The list of defines used in the shader
  96792. */
  96793. defines?: string[];
  96794. }
  96795. /**
  96796. * Interface to implement to create a shadow generator compatible with BJS.
  96797. */
  96798. export interface IShadowGenerator {
  96799. /** Gets or set the id of the shadow generator. It will be the one from the light if not defined */
  96800. id: string;
  96801. /**
  96802. * Gets the main RTT containing the shadow map (usually storing depth from the light point of view).
  96803. * @returns The render target texture if present otherwise, null
  96804. */
  96805. getShadowMap(): Nullable<RenderTargetTexture>;
  96806. /**
  96807. * Determine wheter the shadow generator is ready or not (mainly all effects and related post processes needs to be ready).
  96808. * @param subMesh The submesh we want to render in the shadow map
  96809. * @param useInstances Defines wether will draw in the map using instances
  96810. * @param isTransparent Indicates that isReady is called for a transparent subMesh
  96811. * @returns true if ready otherwise, false
  96812. */
  96813. isReady(subMesh: SubMesh, useInstances: boolean, isTransparent: boolean): boolean;
  96814. /**
  96815. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  96816. * @param defines Defines of the material we want to update
  96817. * @param lightIndex Index of the light in the enabled light list of the material
  96818. */
  96819. prepareDefines(defines: MaterialDefines, lightIndex: number): void;
  96820. /**
  96821. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  96822. * defined in the generator but impacting the effect).
  96823. * It implies the unifroms available on the materials are the standard BJS ones.
  96824. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  96825. * @param effect The effect we are binfing the information for
  96826. */
  96827. bindShadowLight(lightIndex: string, effect: Effect): void;
  96828. /**
  96829. * Gets the transformation matrix used to project the meshes into the map from the light point of view.
  96830. * (eq to shadow prjection matrix * light transform matrix)
  96831. * @returns The transform matrix used to create the shadow map
  96832. */
  96833. getTransformMatrix(): Matrix;
  96834. /**
  96835. * Recreates the shadow map dependencies like RTT and post processes. This can be used during the switch between
  96836. * Cube and 2D textures for instance.
  96837. */
  96838. recreateShadowMap(): void;
  96839. /**
  96840. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  96841. * @param onCompiled Callback triggered at the and of the effects compilation
  96842. * @param options Sets of optional options forcing the compilation with different modes
  96843. */
  96844. forceCompilation(onCompiled?: (generator: IShadowGenerator) => void, options?: Partial<{
  96845. useInstances: boolean;
  96846. }>): void;
  96847. /**
  96848. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  96849. * @param options Sets of optional options forcing the compilation with different modes
  96850. * @returns A promise that resolves when the compilation completes
  96851. */
  96852. forceCompilationAsync(options?: Partial<{
  96853. useInstances: boolean;
  96854. }>): Promise<void>;
  96855. /**
  96856. * Serializes the shadow generator setup to a json object.
  96857. * @returns The serialized JSON object
  96858. */
  96859. serialize(): any;
  96860. /**
  96861. * Disposes the Shadow map and related Textures and effects.
  96862. */
  96863. dispose(): void;
  96864. }
  96865. /**
  96866. * Default implementation IShadowGenerator.
  96867. * This is the main object responsible of generating shadows in the framework.
  96868. * Documentation: https://doc.babylonjs.com/babylon101/shadows
  96869. */
  96870. export class ShadowGenerator implements IShadowGenerator {
  96871. /**
  96872. * Name of the shadow generator class
  96873. */
  96874. static CLASSNAME: string;
  96875. /**
  96876. * Shadow generator mode None: no filtering applied.
  96877. */
  96878. static readonly FILTER_NONE: number;
  96879. /**
  96880. * Shadow generator mode ESM: Exponential Shadow Mapping.
  96881. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  96882. */
  96883. static readonly FILTER_EXPONENTIALSHADOWMAP: number;
  96884. /**
  96885. * Shadow generator mode Poisson Sampling: Percentage Closer Filtering.
  96886. * (Multiple Tap around evenly distributed around the pixel are used to evaluate the shadow strength)
  96887. */
  96888. static readonly FILTER_POISSONSAMPLING: number;
  96889. /**
  96890. * Shadow generator mode ESM: Blurred Exponential Shadow Mapping.
  96891. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  96892. */
  96893. static readonly FILTER_BLUREXPONENTIALSHADOWMAP: number;
  96894. /**
  96895. * Shadow generator mode ESM: Exponential Shadow Mapping using the inverse of the exponential preventing
  96896. * edge artifacts on steep falloff.
  96897. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  96898. */
  96899. static readonly FILTER_CLOSEEXPONENTIALSHADOWMAP: number;
  96900. /**
  96901. * Shadow generator mode ESM: Blurred Exponential Shadow Mapping using the inverse of the exponential preventing
  96902. * edge artifacts on steep falloff.
  96903. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  96904. */
  96905. static readonly FILTER_BLURCLOSEEXPONENTIALSHADOWMAP: number;
  96906. /**
  96907. * Shadow generator mode PCF: Percentage Closer Filtering
  96908. * benefits from Webgl 2 shadow samplers. Fallback to Poisson Sampling in Webgl 1
  96909. * (https://developer.nvidia.com/gpugems/GPUGems/gpugems_ch11.html)
  96910. */
  96911. static readonly FILTER_PCF: number;
  96912. /**
  96913. * Shadow generator mode PCSS: Percentage Closering Soft Shadow.
  96914. * benefits from Webgl 2 shadow samplers. Fallback to Poisson Sampling in Webgl 1
  96915. * Contact Hardening
  96916. */
  96917. static readonly FILTER_PCSS: number;
  96918. /**
  96919. * Reserved for PCF and PCSS
  96920. * Highest Quality.
  96921. *
  96922. * Execute PCF on a 5*5 kernel improving a lot the shadow aliasing artifacts.
  96923. *
  96924. * Execute PCSS with 32 taps blocker search and 64 taps PCF.
  96925. */
  96926. static readonly QUALITY_HIGH: number;
  96927. /**
  96928. * Reserved for PCF and PCSS
  96929. * Good tradeoff for quality/perf cross devices
  96930. *
  96931. * Execute PCF on a 3*3 kernel.
  96932. *
  96933. * Execute PCSS with 16 taps blocker search and 32 taps PCF.
  96934. */
  96935. static readonly QUALITY_MEDIUM: number;
  96936. /**
  96937. * Reserved for PCF and PCSS
  96938. * The lowest quality but the fastest.
  96939. *
  96940. * Execute PCF on a 1*1 kernel.
  96941. *
  96942. * Execute PCSS with 16 taps blocker search and 16 taps PCF.
  96943. */
  96944. static readonly QUALITY_LOW: number;
  96945. /** Gets or set the id of the shadow generator. It will be the one from the light if not defined */
  96946. id: string;
  96947. /** Gets or sets the custom shader name to use */
  96948. customShaderOptions: ICustomShaderOptions;
  96949. /**
  96950. * Observable triggered before the shadow is rendered. Can be used to update internal effect state
  96951. */
  96952. onBeforeShadowMapRenderObservable: Observable<Effect>;
  96953. /**
  96954. * Observable triggered after the shadow is rendered. Can be used to restore internal effect state
  96955. */
  96956. onAfterShadowMapRenderObservable: Observable<Effect>;
  96957. /**
  96958. * Observable triggered before a mesh is rendered in the shadow map.
  96959. * Can be used to update internal effect state (that you can get from the onBeforeShadowMapRenderObservable)
  96960. */
  96961. onBeforeShadowMapRenderMeshObservable: Observable<Mesh>;
  96962. /**
  96963. * Observable triggered after a mesh is rendered in the shadow map.
  96964. * Can be used to update internal effect state (that you can get from the onAfterShadowMapRenderObservable)
  96965. */
  96966. onAfterShadowMapRenderMeshObservable: Observable<Mesh>;
  96967. protected _bias: number;
  96968. /**
  96969. * Gets the bias: offset applied on the depth preventing acnea (in light direction).
  96970. */
  96971. get bias(): number;
  96972. /**
  96973. * Sets the bias: offset applied on the depth preventing acnea (in light direction).
  96974. */
  96975. set bias(bias: number);
  96976. protected _normalBias: number;
  96977. /**
  96978. * Gets the normalBias: offset applied on the depth preventing acnea (along side the normal direction and proportinal to the light/normal angle).
  96979. */
  96980. get normalBias(): number;
  96981. /**
  96982. * Sets the normalBias: offset applied on the depth preventing acnea (along side the normal direction and proportinal to the light/normal angle).
  96983. */
  96984. set normalBias(normalBias: number);
  96985. protected _blurBoxOffset: number;
  96986. /**
  96987. * Gets the blur box offset: offset applied during the blur pass.
  96988. * Only useful if useKernelBlur = false
  96989. */
  96990. get blurBoxOffset(): number;
  96991. /**
  96992. * Sets the blur box offset: offset applied during the blur pass.
  96993. * Only useful if useKernelBlur = false
  96994. */
  96995. set blurBoxOffset(value: number);
  96996. protected _blurScale: number;
  96997. /**
  96998. * Gets the blur scale: scale of the blurred texture compared to the main shadow map.
  96999. * 2 means half of the size.
  97000. */
  97001. get blurScale(): number;
  97002. /**
  97003. * Sets the blur scale: scale of the blurred texture compared to the main shadow map.
  97004. * 2 means half of the size.
  97005. */
  97006. set blurScale(value: number);
  97007. protected _blurKernel: number;
  97008. /**
  97009. * Gets the blur kernel: kernel size of the blur pass.
  97010. * Only useful if useKernelBlur = true
  97011. */
  97012. get blurKernel(): number;
  97013. /**
  97014. * Sets the blur kernel: kernel size of the blur pass.
  97015. * Only useful if useKernelBlur = true
  97016. */
  97017. set blurKernel(value: number);
  97018. protected _useKernelBlur: boolean;
  97019. /**
  97020. * Gets whether the blur pass is a kernel blur (if true) or box blur.
  97021. * Only useful in filtered mode (useBlurExponentialShadowMap...)
  97022. */
  97023. get useKernelBlur(): boolean;
  97024. /**
  97025. * Sets whether the blur pass is a kernel blur (if true) or box blur.
  97026. * Only useful in filtered mode (useBlurExponentialShadowMap...)
  97027. */
  97028. set useKernelBlur(value: boolean);
  97029. protected _depthScale: number;
  97030. /**
  97031. * Gets the depth scale used in ESM mode.
  97032. */
  97033. get depthScale(): number;
  97034. /**
  97035. * Sets the depth scale used in ESM mode.
  97036. * This can override the scale stored on the light.
  97037. */
  97038. set depthScale(value: number);
  97039. protected _validateFilter(filter: number): number;
  97040. protected _filter: number;
  97041. /**
  97042. * Gets the current mode of the shadow generator (normal, PCF, ESM...).
  97043. * The returned value is a number equal to one of the available mode defined in ShadowMap.FILTER_x like _FILTER_NONE
  97044. */
  97045. get filter(): number;
  97046. /**
  97047. * Sets the current mode of the shadow generator (normal, PCF, ESM...).
  97048. * The returned value is a number equal to one of the available mode defined in ShadowMap.FILTER_x like _FILTER_NONE
  97049. */
  97050. set filter(value: number);
  97051. /**
  97052. * Gets if the current filter is set to Poisson Sampling.
  97053. */
  97054. get usePoissonSampling(): boolean;
  97055. /**
  97056. * Sets the current filter to Poisson Sampling.
  97057. */
  97058. set usePoissonSampling(value: boolean);
  97059. /**
  97060. * Gets if the current filter is set to ESM.
  97061. */
  97062. get useExponentialShadowMap(): boolean;
  97063. /**
  97064. * Sets the current filter is to ESM.
  97065. */
  97066. set useExponentialShadowMap(value: boolean);
  97067. /**
  97068. * Gets if the current filter is set to filtered ESM.
  97069. */
  97070. get useBlurExponentialShadowMap(): boolean;
  97071. /**
  97072. * Gets if the current filter is set to filtered ESM.
  97073. */
  97074. set useBlurExponentialShadowMap(value: boolean);
  97075. /**
  97076. * Gets if the current filter is set to "close ESM" (using the inverse of the
  97077. * exponential to prevent steep falloff artifacts).
  97078. */
  97079. get useCloseExponentialShadowMap(): boolean;
  97080. /**
  97081. * Sets the current filter to "close ESM" (using the inverse of the
  97082. * exponential to prevent steep falloff artifacts).
  97083. */
  97084. set useCloseExponentialShadowMap(value: boolean);
  97085. /**
  97086. * Gets if the current filter is set to filtered "close ESM" (using the inverse of the
  97087. * exponential to prevent steep falloff artifacts).
  97088. */
  97089. get useBlurCloseExponentialShadowMap(): boolean;
  97090. /**
  97091. * Sets the current filter to filtered "close ESM" (using the inverse of the
  97092. * exponential to prevent steep falloff artifacts).
  97093. */
  97094. set useBlurCloseExponentialShadowMap(value: boolean);
  97095. /**
  97096. * Gets if the current filter is set to "PCF" (percentage closer filtering).
  97097. */
  97098. get usePercentageCloserFiltering(): boolean;
  97099. /**
  97100. * Sets the current filter to "PCF" (percentage closer filtering).
  97101. */
  97102. set usePercentageCloserFiltering(value: boolean);
  97103. protected _filteringQuality: number;
  97104. /**
  97105. * Gets the PCF or PCSS Quality.
  97106. * Only valid if usePercentageCloserFiltering or usePercentageCloserFiltering is true.
  97107. */
  97108. get filteringQuality(): number;
  97109. /**
  97110. * Sets the PCF or PCSS Quality.
  97111. * Only valid if usePercentageCloserFiltering or usePercentageCloserFiltering is true.
  97112. */
  97113. set filteringQuality(filteringQuality: number);
  97114. /**
  97115. * Gets if the current filter is set to "PCSS" (contact hardening).
  97116. */
  97117. get useContactHardeningShadow(): boolean;
  97118. /**
  97119. * Sets the current filter to "PCSS" (contact hardening).
  97120. */
  97121. set useContactHardeningShadow(value: boolean);
  97122. protected _contactHardeningLightSizeUVRatio: number;
  97123. /**
  97124. * Gets the Light Size (in shadow map uv unit) used in PCSS to determine the blocker search area and the penumbra size.
  97125. * Using a ratio helps keeping shape stability independently of the map size.
  97126. *
  97127. * It does not account for the light projection as it was having too much
  97128. * instability during the light setup or during light position changes.
  97129. *
  97130. * Only valid if useContactHardeningShadow is true.
  97131. */
  97132. get contactHardeningLightSizeUVRatio(): number;
  97133. /**
  97134. * Sets the Light Size (in shadow map uv unit) used in PCSS to determine the blocker search area and the penumbra size.
  97135. * Using a ratio helps keeping shape stability independently of the map size.
  97136. *
  97137. * It does not account for the light projection as it was having too much
  97138. * instability during the light setup or during light position changes.
  97139. *
  97140. * Only valid if useContactHardeningShadow is true.
  97141. */
  97142. set contactHardeningLightSizeUVRatio(contactHardeningLightSizeUVRatio: number);
  97143. protected _darkness: number;
  97144. /** Gets or sets the actual darkness of a shadow */
  97145. get darkness(): number;
  97146. set darkness(value: number);
  97147. /**
  97148. * Returns the darkness value (float). This can only decrease the actual darkness of a shadow.
  97149. * 0 means strongest and 1 would means no shadow.
  97150. * @returns the darkness.
  97151. */
  97152. getDarkness(): number;
  97153. /**
  97154. * Sets the darkness value (float). This can only decrease the actual darkness of a shadow.
  97155. * @param darkness The darkness value 0 means strongest and 1 would means no shadow.
  97156. * @returns the shadow generator allowing fluent coding.
  97157. */
  97158. setDarkness(darkness: number): ShadowGenerator;
  97159. protected _transparencyShadow: boolean;
  97160. /** Gets or sets the ability to have transparent shadow */
  97161. get transparencyShadow(): boolean;
  97162. set transparencyShadow(value: boolean);
  97163. /**
  97164. * Sets the ability to have transparent shadow (boolean).
  97165. * @param transparent True if transparent else False
  97166. * @returns the shadow generator allowing fluent coding
  97167. */
  97168. setTransparencyShadow(transparent: boolean): ShadowGenerator;
  97169. /**
  97170. * Enables or disables shadows with varying strength based on the transparency
  97171. * When it is enabled, the strength of the shadow is taken equal to mesh.visibility
  97172. * If you enabled an alpha texture on your material, the alpha value red from the texture is also combined to compute the strength:
  97173. * mesh.visibility * alphaTexture.a
  97174. * Note that by definition transparencyShadow must be set to true for enableSoftTransparentShadow to work!
  97175. */
  97176. enableSoftTransparentShadow: boolean;
  97177. protected _shadowMap: Nullable<RenderTargetTexture>;
  97178. protected _shadowMap2: Nullable<RenderTargetTexture>;
  97179. /**
  97180. * Gets the main RTT containing the shadow map (usually storing depth from the light point of view).
  97181. * @returns The render target texture if present otherwise, null
  97182. */
  97183. getShadowMap(): Nullable<RenderTargetTexture>;
  97184. /**
  97185. * Gets the RTT used during rendering (can be a blurred version of the shadow map or the shadow map itself).
  97186. * @returns The render target texture if the shadow map is present otherwise, null
  97187. */
  97188. getShadowMapForRendering(): Nullable<RenderTargetTexture>;
  97189. /**
  97190. * Gets the class name of that object
  97191. * @returns "ShadowGenerator"
  97192. */
  97193. getClassName(): string;
  97194. /**
  97195. * Helper function to add a mesh and its descendants to the list of shadow casters.
  97196. * @param mesh Mesh to add
  97197. * @param includeDescendants boolean indicating if the descendants should be added. Default to true
  97198. * @returns the Shadow Generator itself
  97199. */
  97200. addShadowCaster(mesh: AbstractMesh, includeDescendants?: boolean): ShadowGenerator;
  97201. /**
  97202. * Helper function to remove a mesh and its descendants from the list of shadow casters
  97203. * @param mesh Mesh to remove
  97204. * @param includeDescendants boolean indicating if the descendants should be removed. Default to true
  97205. * @returns the Shadow Generator itself
  97206. */
  97207. removeShadowCaster(mesh: AbstractMesh, includeDescendants?: boolean): ShadowGenerator;
  97208. /**
  97209. * Controls the extent to which the shadows fade out at the edge of the frustum
  97210. */
  97211. frustumEdgeFalloff: number;
  97212. protected _light: IShadowLight;
  97213. /**
  97214. * Returns the associated light object.
  97215. * @returns the light generating the shadow
  97216. */
  97217. getLight(): IShadowLight;
  97218. /**
  97219. * If true the shadow map is generated by rendering the back face of the mesh instead of the front face.
  97220. * This can help with self-shadowing as the geometry making up the back of objects is slightly offset.
  97221. * It might on the other hand introduce peter panning.
  97222. */
  97223. forceBackFacesOnly: boolean;
  97224. protected _scene: Scene;
  97225. protected _lightDirection: Vector3;
  97226. protected _effect: Effect;
  97227. protected _viewMatrix: Matrix;
  97228. protected _projectionMatrix: Matrix;
  97229. protected _transformMatrix: Matrix;
  97230. protected _cachedPosition: Vector3;
  97231. protected _cachedDirection: Vector3;
  97232. protected _cachedDefines: string;
  97233. protected _currentRenderID: number;
  97234. protected _boxBlurPostprocess: Nullable<PostProcess>;
  97235. protected _kernelBlurXPostprocess: Nullable<PostProcess>;
  97236. protected _kernelBlurYPostprocess: Nullable<PostProcess>;
  97237. protected _blurPostProcesses: PostProcess[];
  97238. protected _mapSize: number;
  97239. protected _currentFaceIndex: number;
  97240. protected _currentFaceIndexCache: number;
  97241. protected _textureType: number;
  97242. protected _defaultTextureMatrix: Matrix;
  97243. protected _storedUniqueId: Nullable<number>;
  97244. /** @hidden */
  97245. static _SceneComponentInitialization: (scene: Scene) => void;
  97246. /**
  97247. * Creates a ShadowGenerator object.
  97248. * A ShadowGenerator is the required tool to use the shadows.
  97249. * Each light casting shadows needs to use its own ShadowGenerator.
  97250. * Documentation : https://doc.babylonjs.com/babylon101/shadows
  97251. * @param mapSize The size of the texture what stores the shadows. Example : 1024.
  97252. * @param light The light object generating the shadows.
  97253. * @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.
  97254. */
  97255. constructor(mapSize: number, light: IShadowLight, usefulFloatFirst?: boolean);
  97256. protected _initializeGenerator(): void;
  97257. protected _createTargetRenderTexture(): void;
  97258. protected _initializeShadowMap(): void;
  97259. protected _initializeBlurRTTAndPostProcesses(): void;
  97260. protected _renderForShadowMap(opaqueSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>): void;
  97261. protected _bindCustomEffectForRenderSubMeshForShadowMap(subMesh: SubMesh, effect: Effect, matriceNames: any, mesh: AbstractMesh): void;
  97262. protected _renderSubMeshForShadowMap(subMesh: SubMesh, isTransparent?: boolean): void;
  97263. protected _applyFilterValues(): void;
  97264. /**
  97265. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  97266. * @param onCompiled Callback triggered at the and of the effects compilation
  97267. * @param options Sets of optional options forcing the compilation with different modes
  97268. */
  97269. forceCompilation(onCompiled?: (generator: IShadowGenerator) => void, options?: Partial<{
  97270. useInstances: boolean;
  97271. }>): void;
  97272. /**
  97273. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  97274. * @param options Sets of optional options forcing the compilation with different modes
  97275. * @returns A promise that resolves when the compilation completes
  97276. */
  97277. forceCompilationAsync(options?: Partial<{
  97278. useInstances: boolean;
  97279. }>): Promise<void>;
  97280. protected _isReadyCustomDefines(defines: any, subMesh: SubMesh, useInstances: boolean): void;
  97281. private _prepareShadowDefines;
  97282. /**
  97283. * Determine wheter the shadow generator is ready or not (mainly all effects and related post processes needs to be ready).
  97284. * @param subMesh The submesh we want to render in the shadow map
  97285. * @param useInstances Defines wether will draw in the map using instances
  97286. * @param isTransparent Indicates that isReady is called for a transparent subMesh
  97287. * @returns true if ready otherwise, false
  97288. */
  97289. isReady(subMesh: SubMesh, useInstances: boolean, isTransparent: boolean): boolean;
  97290. /**
  97291. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  97292. * @param defines Defines of the material we want to update
  97293. * @param lightIndex Index of the light in the enabled light list of the material
  97294. */
  97295. prepareDefines(defines: any, lightIndex: number): void;
  97296. /**
  97297. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  97298. * defined in the generator but impacting the effect).
  97299. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  97300. * @param effect The effect we are binfing the information for
  97301. */
  97302. bindShadowLight(lightIndex: string, effect: Effect): void;
  97303. /**
  97304. * Gets the transformation matrix used to project the meshes into the map from the light point of view.
  97305. * (eq to shadow prjection matrix * light transform matrix)
  97306. * @returns The transform matrix used to create the shadow map
  97307. */
  97308. getTransformMatrix(): Matrix;
  97309. /**
  97310. * Recreates the shadow map dependencies like RTT and post processes. This can be used during the switch between
  97311. * Cube and 2D textures for instance.
  97312. */
  97313. recreateShadowMap(): void;
  97314. protected _disposeBlurPostProcesses(): void;
  97315. protected _disposeRTTandPostProcesses(): void;
  97316. /**
  97317. * Disposes the ShadowGenerator.
  97318. * Returns nothing.
  97319. */
  97320. dispose(): void;
  97321. /**
  97322. * Serializes the shadow generator setup to a json object.
  97323. * @returns The serialized JSON object
  97324. */
  97325. serialize(): any;
  97326. /**
  97327. * Parses a serialized ShadowGenerator and returns a new ShadowGenerator.
  97328. * @param parsedShadowGenerator The JSON object to parse
  97329. * @param scene The scene to create the shadow map for
  97330. * @param constr A function that builds a shadow generator or undefined to create an instance of the default shadow generator
  97331. * @returns The parsed shadow generator
  97332. */
  97333. static Parse(parsedShadowGenerator: any, scene: Scene, constr?: (mapSize: number, light: IShadowLight) => ShadowGenerator): ShadowGenerator;
  97334. }
  97335. }
  97336. declare module BABYLON {
  97337. /**
  97338. * Base class of all the lights in Babylon. It groups all the generic information about lights.
  97339. * Lights are used, as you would expect, to affect how meshes are seen, in terms of both illumination and colour.
  97340. * 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.
  97341. */
  97342. export abstract class Light extends Node {
  97343. /**
  97344. * Falloff Default: light is falling off following the material specification:
  97345. * standard material is using standard falloff whereas pbr material can request special falloff per materials.
  97346. */
  97347. static readonly FALLOFF_DEFAULT: number;
  97348. /**
  97349. * Falloff Physical: light is falling off following the inverse squared distance law.
  97350. */
  97351. static readonly FALLOFF_PHYSICAL: number;
  97352. /**
  97353. * Falloff gltf: light is falling off as described in the gltf moving to PBR document
  97354. * to enhance interoperability with other engines.
  97355. */
  97356. static readonly FALLOFF_GLTF: number;
  97357. /**
  97358. * Falloff Standard: light is falling off like in the standard material
  97359. * to enhance interoperability with other materials.
  97360. */
  97361. static readonly FALLOFF_STANDARD: number;
  97362. /**
  97363. * If every light affecting the material is in this lightmapMode,
  97364. * material.lightmapTexture adds or multiplies
  97365. * (depends on material.useLightmapAsShadowmap)
  97366. * after every other light calculations.
  97367. */
  97368. static readonly LIGHTMAP_DEFAULT: number;
  97369. /**
  97370. * material.lightmapTexture as only diffuse lighting from this light
  97371. * adds only specular lighting from this light
  97372. * adds dynamic shadows
  97373. */
  97374. static readonly LIGHTMAP_SPECULAR: number;
  97375. /**
  97376. * material.lightmapTexture as only lighting
  97377. * no light calculation from this light
  97378. * only adds dynamic shadows from this light
  97379. */
  97380. static readonly LIGHTMAP_SHADOWSONLY: number;
  97381. /**
  97382. * Each light type uses the default quantity according to its type:
  97383. * point/spot lights use luminous intensity
  97384. * directional lights use illuminance
  97385. */
  97386. static readonly INTENSITYMODE_AUTOMATIC: number;
  97387. /**
  97388. * lumen (lm)
  97389. */
  97390. static readonly INTENSITYMODE_LUMINOUSPOWER: number;
  97391. /**
  97392. * candela (lm/sr)
  97393. */
  97394. static readonly INTENSITYMODE_LUMINOUSINTENSITY: number;
  97395. /**
  97396. * lux (lm/m^2)
  97397. */
  97398. static readonly INTENSITYMODE_ILLUMINANCE: number;
  97399. /**
  97400. * nit (cd/m^2)
  97401. */
  97402. static readonly INTENSITYMODE_LUMINANCE: number;
  97403. /**
  97404. * Light type const id of the point light.
  97405. */
  97406. static readonly LIGHTTYPEID_POINTLIGHT: number;
  97407. /**
  97408. * Light type const id of the directional light.
  97409. */
  97410. static readonly LIGHTTYPEID_DIRECTIONALLIGHT: number;
  97411. /**
  97412. * Light type const id of the spot light.
  97413. */
  97414. static readonly LIGHTTYPEID_SPOTLIGHT: number;
  97415. /**
  97416. * Light type const id of the hemispheric light.
  97417. */
  97418. static readonly LIGHTTYPEID_HEMISPHERICLIGHT: number;
  97419. /**
  97420. * Diffuse gives the basic color to an object.
  97421. */
  97422. diffuse: Color3;
  97423. /**
  97424. * Specular produces a highlight color on an object.
  97425. * Note: This is note affecting PBR materials.
  97426. */
  97427. specular: Color3;
  97428. /**
  97429. * Defines the falloff type for this light. This lets overrriding how punctual light are
  97430. * falling off base on range or angle.
  97431. * This can be set to any values in Light.FALLOFF_x.
  97432. *
  97433. * Note: This is only useful for PBR Materials at the moment. This could be extended if required to
  97434. * other types of materials.
  97435. */
  97436. falloffType: number;
  97437. /**
  97438. * Strength of the light.
  97439. * Note: By default it is define in the framework own unit.
  97440. * Note: In PBR materials the intensityMode can be use to chose what unit the intensity is defined in.
  97441. */
  97442. intensity: number;
  97443. private _range;
  97444. protected _inverseSquaredRange: number;
  97445. /**
  97446. * Defines how far from the source the light is impacting in scene units.
  97447. * Note: Unused in PBR material as the distance light falloff is defined following the inverse squared falloff.
  97448. */
  97449. get range(): number;
  97450. /**
  97451. * Defines how far from the source the light is impacting in scene units.
  97452. * Note: Unused in PBR material as the distance light falloff is defined following the inverse squared falloff.
  97453. */
  97454. set range(value: number);
  97455. /**
  97456. * Cached photometric scale default to 1.0 as the automatic intensity mode defaults to 1.0 for every type
  97457. * of light.
  97458. */
  97459. private _photometricScale;
  97460. private _intensityMode;
  97461. /**
  97462. * Gets the photometric scale used to interpret the intensity.
  97463. * This is only relevant with PBR Materials where the light intensity can be defined in a physical way.
  97464. */
  97465. get intensityMode(): number;
  97466. /**
  97467. * Sets the photometric scale used to interpret the intensity.
  97468. * This is only relevant with PBR Materials where the light intensity can be defined in a physical way.
  97469. */
  97470. set intensityMode(value: number);
  97471. private _radius;
  97472. /**
  97473. * Gets the light radius used by PBR Materials to simulate soft area lights.
  97474. */
  97475. get radius(): number;
  97476. /**
  97477. * sets the light radius used by PBR Materials to simulate soft area lights.
  97478. */
  97479. set radius(value: number);
  97480. private _renderPriority;
  97481. /**
  97482. * Defines the rendering priority of the lights. It can help in case of fallback or number of lights
  97483. * exceeding the number allowed of the materials.
  97484. */
  97485. renderPriority: number;
  97486. private _shadowEnabled;
  97487. /**
  97488. * Gets wether or not the shadows are enabled for this light. This can help turning off/on shadow without detaching
  97489. * the current shadow generator.
  97490. */
  97491. get shadowEnabled(): boolean;
  97492. /**
  97493. * Sets wether or not the shadows are enabled for this light. This can help turning off/on shadow without detaching
  97494. * the current shadow generator.
  97495. */
  97496. set shadowEnabled(value: boolean);
  97497. private _includedOnlyMeshes;
  97498. /**
  97499. * Gets the only meshes impacted by this light.
  97500. */
  97501. get includedOnlyMeshes(): AbstractMesh[];
  97502. /**
  97503. * Sets the only meshes impacted by this light.
  97504. */
  97505. set includedOnlyMeshes(value: AbstractMesh[]);
  97506. private _excludedMeshes;
  97507. /**
  97508. * Gets the meshes not impacted by this light.
  97509. */
  97510. get excludedMeshes(): AbstractMesh[];
  97511. /**
  97512. * Sets the meshes not impacted by this light.
  97513. */
  97514. set excludedMeshes(value: AbstractMesh[]);
  97515. private _excludeWithLayerMask;
  97516. /**
  97517. * Gets the layer id use to find what meshes are not impacted by the light.
  97518. * Inactive if 0
  97519. */
  97520. get excludeWithLayerMask(): number;
  97521. /**
  97522. * Sets the layer id use to find what meshes are not impacted by the light.
  97523. * Inactive if 0
  97524. */
  97525. set excludeWithLayerMask(value: number);
  97526. private _includeOnlyWithLayerMask;
  97527. /**
  97528. * Gets the layer id use to find what meshes are impacted by the light.
  97529. * Inactive if 0
  97530. */
  97531. get includeOnlyWithLayerMask(): number;
  97532. /**
  97533. * Sets the layer id use to find what meshes are impacted by the light.
  97534. * Inactive if 0
  97535. */
  97536. set includeOnlyWithLayerMask(value: number);
  97537. private _lightmapMode;
  97538. /**
  97539. * Gets the lightmap mode of this light (should be one of the constants defined by Light.LIGHTMAP_x)
  97540. */
  97541. get lightmapMode(): number;
  97542. /**
  97543. * Sets the lightmap mode of this light (should be one of the constants defined by Light.LIGHTMAP_x)
  97544. */
  97545. set lightmapMode(value: number);
  97546. /**
  97547. * Shadow generator associted to the light.
  97548. * @hidden Internal use only.
  97549. */
  97550. _shadowGenerator: Nullable<IShadowGenerator>;
  97551. /**
  97552. * @hidden Internal use only.
  97553. */
  97554. _excludedMeshesIds: string[];
  97555. /**
  97556. * @hidden Internal use only.
  97557. */
  97558. _includedOnlyMeshesIds: string[];
  97559. /**
  97560. * The current light unifom buffer.
  97561. * @hidden Internal use only.
  97562. */
  97563. _uniformBuffer: UniformBuffer;
  97564. /** @hidden */
  97565. _renderId: number;
  97566. /**
  97567. * Creates a Light object in the scene.
  97568. * Documentation : https://doc.babylonjs.com/babylon101/lights
  97569. * @param name The firendly name of the light
  97570. * @param scene The scene the light belongs too
  97571. */
  97572. constructor(name: string, scene: Scene);
  97573. protected abstract _buildUniformLayout(): void;
  97574. /**
  97575. * Sets the passed Effect "effect" with the Light information.
  97576. * @param effect The effect to update
  97577. * @param lightIndex The index of the light in the effect to update
  97578. * @returns The light
  97579. */
  97580. abstract transferToEffect(effect: Effect, lightIndex: string): Light;
  97581. /**
  97582. * Sets the passed Effect "effect" with the Light textures.
  97583. * @param effect The effect to update
  97584. * @param lightIndex The index of the light in the effect to update
  97585. * @returns The light
  97586. */
  97587. transferTexturesToEffect(effect: Effect, lightIndex: string): Light;
  97588. /**
  97589. * Binds the lights information from the scene to the effect for the given mesh.
  97590. * @param lightIndex Light index
  97591. * @param scene The scene where the light belongs to
  97592. * @param effect The effect we are binding the data to
  97593. * @param useSpecular Defines if specular is supported
  97594. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  97595. */
  97596. _bindLight(lightIndex: number, scene: Scene, effect: Effect, useSpecular: boolean, rebuildInParallel?: boolean): void;
  97597. /**
  97598. * Sets the passed Effect "effect" with the Light information.
  97599. * @param effect The effect to update
  97600. * @param lightDataUniformName The uniform used to store light data (position or direction)
  97601. * @returns The light
  97602. */
  97603. abstract transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): Light;
  97604. /**
  97605. * Returns the string "Light".
  97606. * @returns the class name
  97607. */
  97608. getClassName(): string;
  97609. /** @hidden */
  97610. readonly _isLight: boolean;
  97611. /**
  97612. * Converts the light information to a readable string for debug purpose.
  97613. * @param fullDetails Supports for multiple levels of logging within scene loading
  97614. * @returns the human readable light info
  97615. */
  97616. toString(fullDetails?: boolean): string;
  97617. /** @hidden */
  97618. protected _syncParentEnabledState(): void;
  97619. /**
  97620. * Set the enabled state of this node.
  97621. * @param value - the new enabled state
  97622. */
  97623. setEnabled(value: boolean): void;
  97624. /**
  97625. * Returns the Light associated shadow generator if any.
  97626. * @return the associated shadow generator.
  97627. */
  97628. getShadowGenerator(): Nullable<IShadowGenerator>;
  97629. /**
  97630. * Returns a Vector3, the absolute light position in the World.
  97631. * @returns the world space position of the light
  97632. */
  97633. getAbsolutePosition(): Vector3;
  97634. /**
  97635. * Specifies if the light will affect the passed mesh.
  97636. * @param mesh The mesh to test against the light
  97637. * @return true the mesh is affected otherwise, false.
  97638. */
  97639. canAffectMesh(mesh: AbstractMesh): boolean;
  97640. /**
  97641. * Sort function to order lights for rendering.
  97642. * @param a First Light object to compare to second.
  97643. * @param b Second Light object to compare first.
  97644. * @return -1 to reduce's a's index relative to be, 0 for no change, 1 to increase a's index relative to b.
  97645. */
  97646. static CompareLightsPriority(a: Light, b: Light): number;
  97647. /**
  97648. * Releases resources associated with this node.
  97649. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  97650. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  97651. */
  97652. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  97653. /**
  97654. * Returns the light type ID (integer).
  97655. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  97656. */
  97657. getTypeID(): number;
  97658. /**
  97659. * Returns the intensity scaled by the Photometric Scale according to the light type and intensity mode.
  97660. * @returns the scaled intensity in intensity mode unit
  97661. */
  97662. getScaledIntensity(): number;
  97663. /**
  97664. * Returns a new Light object, named "name", from the current one.
  97665. * @param name The name of the cloned light
  97666. * @param newParent The parent of this light, if it has one
  97667. * @returns the new created light
  97668. */
  97669. clone(name: string, newParent?: Nullable<Node>): Nullable<Light>;
  97670. /**
  97671. * Serializes the current light into a Serialization object.
  97672. * @returns the serialized object.
  97673. */
  97674. serialize(): any;
  97675. /**
  97676. * Creates a new typed light from the passed type (integer) : point light = 0, directional light = 1, spot light = 2, hemispheric light = 3.
  97677. * This new light is named "name" and added to the passed scene.
  97678. * @param type Type according to the types available in Light.LIGHTTYPEID_x
  97679. * @param name The friendly name of the light
  97680. * @param scene The scene the new light will belong to
  97681. * @returns the constructor function
  97682. */
  97683. static GetConstructorFromName(type: number, name: string, scene: Scene): Nullable<() => Light>;
  97684. /**
  97685. * Parses the passed "parsedLight" and returns a new instanced Light from this parsing.
  97686. * @param parsedLight The JSON representation of the light
  97687. * @param scene The scene to create the parsed light in
  97688. * @returns the created light after parsing
  97689. */
  97690. static Parse(parsedLight: any, scene: Scene): Nullable<Light>;
  97691. private _hookArrayForExcluded;
  97692. private _hookArrayForIncludedOnly;
  97693. private _resyncMeshes;
  97694. /**
  97695. * Forces the meshes to update their light related information in their rendering used effects
  97696. * @hidden Internal Use Only
  97697. */
  97698. _markMeshesAsLightDirty(): void;
  97699. /**
  97700. * Recomputes the cached photometric scale if needed.
  97701. */
  97702. private _computePhotometricScale;
  97703. /**
  97704. * Returns the Photometric Scale according to the light type and intensity mode.
  97705. */
  97706. private _getPhotometricScale;
  97707. /**
  97708. * Reorder the light in the scene according to their defined priority.
  97709. * @hidden Internal Use Only
  97710. */
  97711. _reorderLightsInScene(): void;
  97712. /**
  97713. * Prepares the list of defines specific to the light type.
  97714. * @param defines the list of defines
  97715. * @param lightIndex defines the index of the light for the effect
  97716. */
  97717. abstract prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  97718. }
  97719. }
  97720. declare module BABYLON {
  97721. /**
  97722. * A target camera takes a mesh or position as a target and continues to look at it while it moves.
  97723. * This is the base of the follow, arc rotate cameras and Free camera
  97724. * @see https://doc.babylonjs.com/features/cameras
  97725. */
  97726. export class TargetCamera extends Camera {
  97727. private static _RigCamTransformMatrix;
  97728. private static _TargetTransformMatrix;
  97729. private static _TargetFocalPoint;
  97730. private _tmpUpVector;
  97731. private _tmpTargetVector;
  97732. /**
  97733. * Define the current direction the camera is moving to
  97734. */
  97735. cameraDirection: Vector3;
  97736. /**
  97737. * Define the current rotation the camera is rotating to
  97738. */
  97739. cameraRotation: Vector2;
  97740. /** Gets or sets a boolean indicating that the scaling of the parent hierarchy will not be taken in account by the camera */
  97741. ignoreParentScaling: boolean;
  97742. /**
  97743. * When set, the up vector of the camera will be updated by the rotation of the camera
  97744. */
  97745. updateUpVectorFromRotation: boolean;
  97746. private _tmpQuaternion;
  97747. /**
  97748. * Define the current rotation of the camera
  97749. */
  97750. rotation: Vector3;
  97751. /**
  97752. * Define the current rotation of the camera as a quaternion to prevent Gimbal lock
  97753. */
  97754. rotationQuaternion: Quaternion;
  97755. /**
  97756. * Define the current speed of the camera
  97757. */
  97758. speed: number;
  97759. /**
  97760. * Add constraint to the camera to prevent it to move freely in all directions and
  97761. * around all axis.
  97762. */
  97763. noRotationConstraint: boolean;
  97764. /**
  97765. * Reverses mouselook direction to 'natural' panning as opposed to traditional direct
  97766. * panning
  97767. */
  97768. invertRotation: boolean;
  97769. /**
  97770. * Speed multiplier for inverse camera panning
  97771. */
  97772. inverseRotationSpeed: number;
  97773. /**
  97774. * Define the current target of the camera as an object or a position.
  97775. */
  97776. lockedTarget: any;
  97777. /** @hidden */
  97778. _currentTarget: Vector3;
  97779. /** @hidden */
  97780. _initialFocalDistance: number;
  97781. /** @hidden */
  97782. _viewMatrix: Matrix;
  97783. /** @hidden */
  97784. _camMatrix: Matrix;
  97785. /** @hidden */
  97786. _cameraTransformMatrix: Matrix;
  97787. /** @hidden */
  97788. _cameraRotationMatrix: Matrix;
  97789. /** @hidden */
  97790. _referencePoint: Vector3;
  97791. /** @hidden */
  97792. _transformedReferencePoint: Vector3;
  97793. /** @hidden */
  97794. _reset: () => void;
  97795. private _defaultUp;
  97796. /**
  97797. * Instantiates a target camera that takes a mesh or position as a target and continues to look at it while it moves.
  97798. * This is the base of the follow, arc rotate cameras and Free camera
  97799. * @see https://doc.babylonjs.com/features/cameras
  97800. * @param name Defines the name of the camera in the scene
  97801. * @param position Defines the start position of the camera in the scene
  97802. * @param scene Defines the scene the camera belongs to
  97803. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  97804. */
  97805. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  97806. /**
  97807. * Gets the position in front of the camera at a given distance.
  97808. * @param distance The distance from the camera we want the position to be
  97809. * @returns the position
  97810. */
  97811. getFrontPosition(distance: number): Vector3;
  97812. /** @hidden */
  97813. _getLockedTargetPosition(): Nullable<Vector3>;
  97814. private _storedPosition;
  97815. private _storedRotation;
  97816. private _storedRotationQuaternion;
  97817. /**
  97818. * Store current camera state of the camera (fov, position, rotation, etc..)
  97819. * @returns the camera
  97820. */
  97821. storeState(): Camera;
  97822. /**
  97823. * Restored camera state. You must call storeState() first
  97824. * @returns whether it was successful or not
  97825. * @hidden
  97826. */
  97827. _restoreStateValues(): boolean;
  97828. /** @hidden */
  97829. _initCache(): void;
  97830. /** @hidden */
  97831. _updateCache(ignoreParentClass?: boolean): void;
  97832. /** @hidden */
  97833. _isSynchronizedViewMatrix(): boolean;
  97834. /** @hidden */
  97835. _computeLocalCameraSpeed(): number;
  97836. /**
  97837. * Defines the target the camera should look at.
  97838. * @param target Defines the new target as a Vector or a mesh
  97839. */
  97840. setTarget(target: Vector3): void;
  97841. /**
  97842. * Defines the target point of the camera.
  97843. * The camera looks towards it form the radius distance.
  97844. */
  97845. get target(): Vector3;
  97846. set target(value: Vector3);
  97847. /**
  97848. * Return the current target position of the camera. This value is expressed in local space.
  97849. * @returns the target position
  97850. */
  97851. getTarget(): Vector3;
  97852. /** @hidden */
  97853. _decideIfNeedsToMove(): boolean;
  97854. /** @hidden */
  97855. _updatePosition(): void;
  97856. /** @hidden */
  97857. _checkInputs(): void;
  97858. protected _updateCameraRotationMatrix(): void;
  97859. /**
  97860. * 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)
  97861. * @returns the current camera
  97862. */
  97863. private _rotateUpVectorWithCameraRotationMatrix;
  97864. private _cachedRotationZ;
  97865. private _cachedQuaternionRotationZ;
  97866. /** @hidden */
  97867. _getViewMatrix(): Matrix;
  97868. protected _computeViewMatrix(position: Vector3, target: Vector3, up: Vector3): void;
  97869. /**
  97870. * @hidden
  97871. */
  97872. createRigCamera(name: string, cameraIndex: number): Nullable<Camera>;
  97873. /**
  97874. * @hidden
  97875. */
  97876. _updateRigCameras(): void;
  97877. private _getRigCamPositionAndTarget;
  97878. /**
  97879. * Gets the current object class name.
  97880. * @return the class name
  97881. */
  97882. getClassName(): string;
  97883. }
  97884. }
  97885. declare module BABYLON {
  97886. /**
  97887. * Gather the list of keyboard event types as constants.
  97888. */
  97889. export class KeyboardEventTypes {
  97890. /**
  97891. * The keydown event is fired when a key becomes active (pressed).
  97892. */
  97893. static readonly KEYDOWN: number;
  97894. /**
  97895. * The keyup event is fired when a key has been released.
  97896. */
  97897. static readonly KEYUP: number;
  97898. }
  97899. /**
  97900. * This class is used to store keyboard related info for the onKeyboardObservable event.
  97901. */
  97902. export class KeyboardInfo {
  97903. /**
  97904. * Defines the type of event (KeyboardEventTypes)
  97905. */
  97906. type: number;
  97907. /**
  97908. * Defines the related dom event
  97909. */
  97910. event: KeyboardEvent;
  97911. /**
  97912. * Instantiates a new keyboard info.
  97913. * This class is used to store keyboard related info for the onKeyboardObservable event.
  97914. * @param type Defines the type of event (KeyboardEventTypes)
  97915. * @param event Defines the related dom event
  97916. */
  97917. constructor(
  97918. /**
  97919. * Defines the type of event (KeyboardEventTypes)
  97920. */
  97921. type: number,
  97922. /**
  97923. * Defines the related dom event
  97924. */
  97925. event: KeyboardEvent);
  97926. }
  97927. /**
  97928. * This class is used to store keyboard related info for the onPreKeyboardObservable event.
  97929. * Set the skipOnKeyboardObservable property to true if you want the engine to stop any process after this event is triggered, even not calling onKeyboardObservable
  97930. */
  97931. export class KeyboardInfoPre extends KeyboardInfo {
  97932. /**
  97933. * Defines the type of event (KeyboardEventTypes)
  97934. */
  97935. type: number;
  97936. /**
  97937. * Defines the related dom event
  97938. */
  97939. event: KeyboardEvent;
  97940. /**
  97941. * Defines whether the engine should skip the next onKeyboardObservable associated to this pre.
  97942. */
  97943. skipOnPointerObservable: boolean;
  97944. /**
  97945. * Instantiates a new keyboard pre info.
  97946. * This class is used to store keyboard related info for the onPreKeyboardObservable event.
  97947. * @param type Defines the type of event (KeyboardEventTypes)
  97948. * @param event Defines the related dom event
  97949. */
  97950. constructor(
  97951. /**
  97952. * Defines the type of event (KeyboardEventTypes)
  97953. */
  97954. type: number,
  97955. /**
  97956. * Defines the related dom event
  97957. */
  97958. event: KeyboardEvent);
  97959. }
  97960. }
  97961. declare module BABYLON {
  97962. /**
  97963. * Manage the keyboard inputs to control the movement of a free camera.
  97964. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  97965. */
  97966. export class FreeCameraKeyboardMoveInput implements ICameraInput<FreeCamera> {
  97967. /**
  97968. * Defines the camera the input is attached to.
  97969. */
  97970. camera: FreeCamera;
  97971. /**
  97972. * Gets or Set the list of keyboard keys used to control the forward move of the camera.
  97973. */
  97974. keysUp: number[];
  97975. /**
  97976. * Gets or Set the list of keyboard keys used to control the upward move of the camera.
  97977. */
  97978. keysUpward: number[];
  97979. /**
  97980. * Gets or Set the list of keyboard keys used to control the backward move of the camera.
  97981. */
  97982. keysDown: number[];
  97983. /**
  97984. * Gets or Set the list of keyboard keys used to control the downward move of the camera.
  97985. */
  97986. keysDownward: number[];
  97987. /**
  97988. * Gets or Set the list of keyboard keys used to control the left strafe move of the camera.
  97989. */
  97990. keysLeft: number[];
  97991. /**
  97992. * Gets or Set the list of keyboard keys used to control the right strafe move of the camera.
  97993. */
  97994. keysRight: number[];
  97995. private _keys;
  97996. private _onCanvasBlurObserver;
  97997. private _onKeyboardObserver;
  97998. private _engine;
  97999. private _scene;
  98000. /**
  98001. * Attach the input controls to a specific dom element to get the input from.
  98002. * @param element Defines the element the controls should be listened from
  98003. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  98004. */
  98005. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  98006. /**
  98007. * Detach the current controls from the specified dom element.
  98008. * @param element Defines the element to stop listening the inputs from
  98009. */
  98010. detachControl(element: Nullable<HTMLElement>): void;
  98011. /**
  98012. * Update the current camera state depending on the inputs that have been used this frame.
  98013. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  98014. */
  98015. checkInputs(): void;
  98016. /**
  98017. * Gets the class name of the current intput.
  98018. * @returns the class name
  98019. */
  98020. getClassName(): string;
  98021. /** @hidden */
  98022. _onLostFocus(): void;
  98023. /**
  98024. * Get the friendly name associated with the input class.
  98025. * @returns the input friendly name
  98026. */
  98027. getSimpleName(): string;
  98028. }
  98029. }
  98030. declare module BABYLON {
  98031. /**
  98032. * Gather the list of pointer event types as constants.
  98033. */
  98034. export class PointerEventTypes {
  98035. /**
  98036. * 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.
  98037. */
  98038. static readonly POINTERDOWN: number;
  98039. /**
  98040. * The pointerup event is fired when a pointer is no longer active.
  98041. */
  98042. static readonly POINTERUP: number;
  98043. /**
  98044. * The pointermove event is fired when a pointer changes coordinates.
  98045. */
  98046. static readonly POINTERMOVE: number;
  98047. /**
  98048. * The pointerwheel event is fired when a mouse wheel has been rotated.
  98049. */
  98050. static readonly POINTERWHEEL: number;
  98051. /**
  98052. * The pointerpick event is fired when a mesh or sprite has been picked by the pointer.
  98053. */
  98054. static readonly POINTERPICK: number;
  98055. /**
  98056. * The pointertap event is fired when a the object has been touched and released without drag.
  98057. */
  98058. static readonly POINTERTAP: number;
  98059. /**
  98060. * The pointerdoubletap event is fired when a the object has been touched and released twice without drag.
  98061. */
  98062. static readonly POINTERDOUBLETAP: number;
  98063. }
  98064. /**
  98065. * Base class of pointer info types.
  98066. */
  98067. export class PointerInfoBase {
  98068. /**
  98069. * Defines the type of event (PointerEventTypes)
  98070. */
  98071. type: number;
  98072. /**
  98073. * Defines the related dom event
  98074. */
  98075. event: PointerEvent | MouseWheelEvent;
  98076. /**
  98077. * Instantiates the base class of pointers info.
  98078. * @param type Defines the type of event (PointerEventTypes)
  98079. * @param event Defines the related dom event
  98080. */
  98081. constructor(
  98082. /**
  98083. * Defines the type of event (PointerEventTypes)
  98084. */
  98085. type: number,
  98086. /**
  98087. * Defines the related dom event
  98088. */
  98089. event: PointerEvent | MouseWheelEvent);
  98090. }
  98091. /**
  98092. * This class is used to store pointer related info for the onPrePointerObservable event.
  98093. * Set the skipOnPointerObservable property to true if you want the engine to stop any process after this event is triggered, even not calling onPointerObservable
  98094. */
  98095. export class PointerInfoPre extends PointerInfoBase {
  98096. /**
  98097. * Ray from a pointer if availible (eg. 6dof controller)
  98098. */
  98099. ray: Nullable<Ray>;
  98100. /**
  98101. * Defines the local position of the pointer on the canvas.
  98102. */
  98103. localPosition: Vector2;
  98104. /**
  98105. * Defines whether the engine should skip the next OnPointerObservable associated to this pre.
  98106. */
  98107. skipOnPointerObservable: boolean;
  98108. /**
  98109. * Instantiates a PointerInfoPre to store pointer related info to the onPrePointerObservable event.
  98110. * @param type Defines the type of event (PointerEventTypes)
  98111. * @param event Defines the related dom event
  98112. * @param localX Defines the local x coordinates of the pointer when the event occured
  98113. * @param localY Defines the local y coordinates of the pointer when the event occured
  98114. */
  98115. constructor(type: number, event: PointerEvent | MouseWheelEvent, localX: number, localY: number);
  98116. }
  98117. /**
  98118. * This type contains all the data related to a pointer event in Babylon.js.
  98119. * 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.
  98120. */
  98121. export class PointerInfo extends PointerInfoBase {
  98122. /**
  98123. * Defines the picking info associated to the info (if any)\
  98124. */
  98125. pickInfo: Nullable<PickingInfo>;
  98126. /**
  98127. * Instantiates a PointerInfo to store pointer related info to the onPointerObservable event.
  98128. * @param type Defines the type of event (PointerEventTypes)
  98129. * @param event Defines the related dom event
  98130. * @param pickInfo Defines the picking info associated to the info (if any)\
  98131. */
  98132. constructor(type: number, event: PointerEvent | MouseWheelEvent,
  98133. /**
  98134. * Defines the picking info associated to the info (if any)\
  98135. */
  98136. pickInfo: Nullable<PickingInfo>);
  98137. }
  98138. /**
  98139. * Data relating to a touch event on the screen.
  98140. */
  98141. export interface PointerTouch {
  98142. /**
  98143. * X coordinate of touch.
  98144. */
  98145. x: number;
  98146. /**
  98147. * Y coordinate of touch.
  98148. */
  98149. y: number;
  98150. /**
  98151. * Id of touch. Unique for each finger.
  98152. */
  98153. pointerId: number;
  98154. /**
  98155. * Event type passed from DOM.
  98156. */
  98157. type: any;
  98158. }
  98159. }
  98160. declare module BABYLON {
  98161. /**
  98162. * Manage the mouse inputs to control the movement of a free camera.
  98163. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  98164. */
  98165. export class FreeCameraMouseInput implements ICameraInput<FreeCamera> {
  98166. /**
  98167. * Define if touch is enabled in the mouse input
  98168. */
  98169. touchEnabled: boolean;
  98170. /**
  98171. * Defines the camera the input is attached to.
  98172. */
  98173. camera: FreeCamera;
  98174. /**
  98175. * Defines the buttons associated with the input to handle camera move.
  98176. */
  98177. buttons: number[];
  98178. /**
  98179. * Defines the pointer angular sensibility along the X and Y axis or how fast is the camera rotating.
  98180. */
  98181. angularSensibility: number;
  98182. private _pointerInput;
  98183. private _onMouseMove;
  98184. private _observer;
  98185. private previousPosition;
  98186. /**
  98187. * Observable for when a pointer move event occurs containing the move offset
  98188. */
  98189. onPointerMovedObservable: Observable<{
  98190. offsetX: number;
  98191. offsetY: number;
  98192. }>;
  98193. /**
  98194. * @hidden
  98195. * If the camera should be rotated automatically based on pointer movement
  98196. */
  98197. _allowCameraRotation: boolean;
  98198. /**
  98199. * Manage the mouse inputs to control the movement of a free camera.
  98200. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  98201. * @param touchEnabled Defines if touch is enabled or not
  98202. */
  98203. constructor(
  98204. /**
  98205. * Define if touch is enabled in the mouse input
  98206. */
  98207. touchEnabled?: boolean);
  98208. /**
  98209. * Attach the input controls to a specific dom element to get the input from.
  98210. * @param element Defines the element the controls should be listened from
  98211. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  98212. */
  98213. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  98214. /**
  98215. * Called on JS contextmenu event.
  98216. * Override this method to provide functionality.
  98217. */
  98218. protected onContextMenu(evt: PointerEvent): void;
  98219. /**
  98220. * Detach the current controls from the specified dom element.
  98221. * @param element Defines the element to stop listening the inputs from
  98222. */
  98223. detachControl(element: Nullable<HTMLElement>): void;
  98224. /**
  98225. * Gets the class name of the current intput.
  98226. * @returns the class name
  98227. */
  98228. getClassName(): string;
  98229. /**
  98230. * Get the friendly name associated with the input class.
  98231. * @returns the input friendly name
  98232. */
  98233. getSimpleName(): string;
  98234. }
  98235. }
  98236. declare module BABYLON {
  98237. /**
  98238. * Manage the touch inputs to control the movement of a free camera.
  98239. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  98240. */
  98241. export class FreeCameraTouchInput implements ICameraInput<FreeCamera> {
  98242. /**
  98243. * Define if mouse events can be treated as touch events
  98244. */
  98245. allowMouse: boolean;
  98246. /**
  98247. * Defines the camera the input is attached to.
  98248. */
  98249. camera: FreeCamera;
  98250. /**
  98251. * Defines the touch sensibility for rotation.
  98252. * The higher the faster.
  98253. */
  98254. touchAngularSensibility: number;
  98255. /**
  98256. * Defines the touch sensibility for move.
  98257. * The higher the faster.
  98258. */
  98259. touchMoveSensibility: number;
  98260. private _offsetX;
  98261. private _offsetY;
  98262. private _pointerPressed;
  98263. private _pointerInput;
  98264. private _observer;
  98265. private _onLostFocus;
  98266. /**
  98267. * Manage the touch inputs to control the movement of a free camera.
  98268. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  98269. * @param allowMouse Defines if mouse events can be treated as touch events
  98270. */
  98271. constructor(
  98272. /**
  98273. * Define if mouse events can be treated as touch events
  98274. */
  98275. allowMouse?: boolean);
  98276. /**
  98277. * Attach the input controls to a specific dom element to get the input from.
  98278. * @param element Defines the element the controls should be listened from
  98279. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  98280. */
  98281. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  98282. /**
  98283. * Detach the current controls from the specified dom element.
  98284. * @param element Defines the element to stop listening the inputs from
  98285. */
  98286. detachControl(element: Nullable<HTMLElement>): void;
  98287. /**
  98288. * Update the current camera state depending on the inputs that have been used this frame.
  98289. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  98290. */
  98291. checkInputs(): void;
  98292. /**
  98293. * Gets the class name of the current intput.
  98294. * @returns the class name
  98295. */
  98296. getClassName(): string;
  98297. /**
  98298. * Get the friendly name associated with the input class.
  98299. * @returns the input friendly name
  98300. */
  98301. getSimpleName(): string;
  98302. }
  98303. }
  98304. declare module BABYLON {
  98305. /**
  98306. * Default Inputs manager for the FreeCamera.
  98307. * It groups all the default supported inputs for ease of use.
  98308. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  98309. */
  98310. export class FreeCameraInputsManager extends CameraInputsManager<FreeCamera> {
  98311. /**
  98312. * @hidden
  98313. */
  98314. _mouseInput: Nullable<FreeCameraMouseInput>;
  98315. /**
  98316. * Instantiates a new FreeCameraInputsManager.
  98317. * @param camera Defines the camera the inputs belong to
  98318. */
  98319. constructor(camera: FreeCamera);
  98320. /**
  98321. * Add keyboard input support to the input manager.
  98322. * @returns the current input manager
  98323. */
  98324. addKeyboard(): FreeCameraInputsManager;
  98325. /**
  98326. * Add mouse input support to the input manager.
  98327. * @param touchEnabled if the FreeCameraMouseInput should support touch (default: true)
  98328. * @returns the current input manager
  98329. */
  98330. addMouse(touchEnabled?: boolean): FreeCameraInputsManager;
  98331. /**
  98332. * Removes the mouse input support from the manager
  98333. * @returns the current input manager
  98334. */
  98335. removeMouse(): FreeCameraInputsManager;
  98336. /**
  98337. * Add touch input support to the input manager.
  98338. * @returns the current input manager
  98339. */
  98340. addTouch(): FreeCameraInputsManager;
  98341. /**
  98342. * Remove all attached input methods from a camera
  98343. */
  98344. clear(): void;
  98345. }
  98346. }
  98347. declare module BABYLON {
  98348. /**
  98349. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  98350. * Please consider using the new UniversalCamera instead as it adds more functionality like the gamepad.
  98351. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  98352. */
  98353. export class FreeCamera extends TargetCamera {
  98354. /**
  98355. * Define the collision ellipsoid of the camera.
  98356. * This is helpful to simulate a camera body like the player body around the camera
  98357. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  98358. */
  98359. ellipsoid: Vector3;
  98360. /**
  98361. * Define an offset for the position of the ellipsoid around the camera.
  98362. * This can be helpful to determine the center of the body near the gravity center of the body
  98363. * instead of its head.
  98364. */
  98365. ellipsoidOffset: Vector3;
  98366. /**
  98367. * Enable or disable collisions of the camera with the rest of the scene objects.
  98368. */
  98369. checkCollisions: boolean;
  98370. /**
  98371. * Enable or disable gravity on the camera.
  98372. */
  98373. applyGravity: boolean;
  98374. /**
  98375. * Define the input manager associated to the camera.
  98376. */
  98377. inputs: FreeCameraInputsManager;
  98378. /**
  98379. * Gets the input sensibility for a mouse input. (default is 2000.0)
  98380. * Higher values reduce sensitivity.
  98381. */
  98382. get angularSensibility(): number;
  98383. /**
  98384. * Sets the input sensibility for a mouse input. (default is 2000.0)
  98385. * Higher values reduce sensitivity.
  98386. */
  98387. set angularSensibility(value: number);
  98388. /**
  98389. * Gets or Set the list of keyboard keys used to control the forward move of the camera.
  98390. */
  98391. get keysUp(): number[];
  98392. set keysUp(value: number[]);
  98393. /**
  98394. * Gets or Set the list of keyboard keys used to control the upward move of the camera.
  98395. */
  98396. get keysUpward(): number[];
  98397. set keysUpward(value: number[]);
  98398. /**
  98399. * Gets or Set the list of keyboard keys used to control the backward move of the camera.
  98400. */
  98401. get keysDown(): number[];
  98402. set keysDown(value: number[]);
  98403. /**
  98404. * Gets or Set the list of keyboard keys used to control the downward move of the camera.
  98405. */
  98406. get keysDownward(): number[];
  98407. set keysDownward(value: number[]);
  98408. /**
  98409. * Gets or Set the list of keyboard keys used to control the left strafe move of the camera.
  98410. */
  98411. get keysLeft(): number[];
  98412. set keysLeft(value: number[]);
  98413. /**
  98414. * Gets or Set the list of keyboard keys used to control the right strafe move of the camera.
  98415. */
  98416. get keysRight(): number[];
  98417. set keysRight(value: number[]);
  98418. /**
  98419. * Event raised when the camera collide with a mesh in the scene.
  98420. */
  98421. onCollide: (collidedMesh: AbstractMesh) => void;
  98422. private _collider;
  98423. private _needMoveForGravity;
  98424. private _oldPosition;
  98425. private _diffPosition;
  98426. private _newPosition;
  98427. /** @hidden */
  98428. _localDirection: Vector3;
  98429. /** @hidden */
  98430. _transformedDirection: Vector3;
  98431. /**
  98432. * Instantiates a Free Camera.
  98433. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  98434. * Please consider using the new UniversalCamera instead as it adds more functionality like touch to this camera.
  98435. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  98436. * @param name Define the name of the camera in the scene
  98437. * @param position Define the start position of the camera in the scene
  98438. * @param scene Define the scene the camera belongs to
  98439. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  98440. */
  98441. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  98442. /**
  98443. * Attached controls to the current camera.
  98444. * @param element Defines the element the controls should be listened from
  98445. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  98446. */
  98447. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  98448. /**
  98449. * Detach the current controls from the camera.
  98450. * The camera will stop reacting to inputs.
  98451. * @param element Defines the element to stop listening the inputs from
  98452. */
  98453. detachControl(element: HTMLElement): void;
  98454. private _collisionMask;
  98455. /**
  98456. * Define a collision mask to limit the list of object the camera can collide with
  98457. */
  98458. get collisionMask(): number;
  98459. set collisionMask(mask: number);
  98460. /** @hidden */
  98461. _collideWithWorld(displacement: Vector3): void;
  98462. private _onCollisionPositionChange;
  98463. /** @hidden */
  98464. _checkInputs(): void;
  98465. /** @hidden */
  98466. _decideIfNeedsToMove(): boolean;
  98467. /** @hidden */
  98468. _updatePosition(): void;
  98469. /**
  98470. * Destroy the camera and release the current resources hold by it.
  98471. */
  98472. dispose(): void;
  98473. /**
  98474. * Gets the current object class name.
  98475. * @return the class name
  98476. */
  98477. getClassName(): string;
  98478. }
  98479. }
  98480. declare module BABYLON {
  98481. /**
  98482. * Represents a gamepad control stick position
  98483. */
  98484. export class StickValues {
  98485. /**
  98486. * The x component of the control stick
  98487. */
  98488. x: number;
  98489. /**
  98490. * The y component of the control stick
  98491. */
  98492. y: number;
  98493. /**
  98494. * Initializes the gamepad x and y control stick values
  98495. * @param x The x component of the gamepad control stick value
  98496. * @param y The y component of the gamepad control stick value
  98497. */
  98498. constructor(
  98499. /**
  98500. * The x component of the control stick
  98501. */
  98502. x: number,
  98503. /**
  98504. * The y component of the control stick
  98505. */
  98506. y: number);
  98507. }
  98508. /**
  98509. * An interface which manages callbacks for gamepad button changes
  98510. */
  98511. export interface GamepadButtonChanges {
  98512. /**
  98513. * Called when a gamepad has been changed
  98514. */
  98515. changed: boolean;
  98516. /**
  98517. * Called when a gamepad press event has been triggered
  98518. */
  98519. pressChanged: boolean;
  98520. /**
  98521. * Called when a touch event has been triggered
  98522. */
  98523. touchChanged: boolean;
  98524. /**
  98525. * Called when a value has changed
  98526. */
  98527. valueChanged: boolean;
  98528. }
  98529. /**
  98530. * Represents a gamepad
  98531. */
  98532. export class Gamepad {
  98533. /**
  98534. * The id of the gamepad
  98535. */
  98536. id: string;
  98537. /**
  98538. * The index of the gamepad
  98539. */
  98540. index: number;
  98541. /**
  98542. * The browser gamepad
  98543. */
  98544. browserGamepad: any;
  98545. /**
  98546. * Specifies what type of gamepad this represents
  98547. */
  98548. type: number;
  98549. private _leftStick;
  98550. private _rightStick;
  98551. /** @hidden */
  98552. _isConnected: boolean;
  98553. private _leftStickAxisX;
  98554. private _leftStickAxisY;
  98555. private _rightStickAxisX;
  98556. private _rightStickAxisY;
  98557. /**
  98558. * Triggered when the left control stick has been changed
  98559. */
  98560. private _onleftstickchanged;
  98561. /**
  98562. * Triggered when the right control stick has been changed
  98563. */
  98564. private _onrightstickchanged;
  98565. /**
  98566. * Represents a gamepad controller
  98567. */
  98568. static GAMEPAD: number;
  98569. /**
  98570. * Represents a generic controller
  98571. */
  98572. static GENERIC: number;
  98573. /**
  98574. * Represents an XBox controller
  98575. */
  98576. static XBOX: number;
  98577. /**
  98578. * Represents a pose-enabled controller
  98579. */
  98580. static POSE_ENABLED: number;
  98581. /**
  98582. * Represents an Dual Shock controller
  98583. */
  98584. static DUALSHOCK: number;
  98585. /**
  98586. * Specifies whether the left control stick should be Y-inverted
  98587. */
  98588. protected _invertLeftStickY: boolean;
  98589. /**
  98590. * Specifies if the gamepad has been connected
  98591. */
  98592. get isConnected(): boolean;
  98593. /**
  98594. * Initializes the gamepad
  98595. * @param id The id of the gamepad
  98596. * @param index The index of the gamepad
  98597. * @param browserGamepad The browser gamepad
  98598. * @param leftStickX The x component of the left joystick
  98599. * @param leftStickY The y component of the left joystick
  98600. * @param rightStickX The x component of the right joystick
  98601. * @param rightStickY The y component of the right joystick
  98602. */
  98603. constructor(
  98604. /**
  98605. * The id of the gamepad
  98606. */
  98607. id: string,
  98608. /**
  98609. * The index of the gamepad
  98610. */
  98611. index: number,
  98612. /**
  98613. * The browser gamepad
  98614. */
  98615. browserGamepad: any, leftStickX?: number, leftStickY?: number, rightStickX?: number, rightStickY?: number);
  98616. /**
  98617. * Callback triggered when the left joystick has changed
  98618. * @param callback
  98619. */
  98620. onleftstickchanged(callback: (values: StickValues) => void): void;
  98621. /**
  98622. * Callback triggered when the right joystick has changed
  98623. * @param callback
  98624. */
  98625. onrightstickchanged(callback: (values: StickValues) => void): void;
  98626. /**
  98627. * Gets the left joystick
  98628. */
  98629. get leftStick(): StickValues;
  98630. /**
  98631. * Sets the left joystick values
  98632. */
  98633. set leftStick(newValues: StickValues);
  98634. /**
  98635. * Gets the right joystick
  98636. */
  98637. get rightStick(): StickValues;
  98638. /**
  98639. * Sets the right joystick value
  98640. */
  98641. set rightStick(newValues: StickValues);
  98642. /**
  98643. * Updates the gamepad joystick positions
  98644. */
  98645. update(): void;
  98646. /**
  98647. * Disposes the gamepad
  98648. */
  98649. dispose(): void;
  98650. }
  98651. /**
  98652. * Represents a generic gamepad
  98653. */
  98654. export class GenericPad extends Gamepad {
  98655. private _buttons;
  98656. private _onbuttondown;
  98657. private _onbuttonup;
  98658. /**
  98659. * Observable triggered when a button has been pressed
  98660. */
  98661. onButtonDownObservable: Observable<number>;
  98662. /**
  98663. * Observable triggered when a button has been released
  98664. */
  98665. onButtonUpObservable: Observable<number>;
  98666. /**
  98667. * Callback triggered when a button has been pressed
  98668. * @param callback Called when a button has been pressed
  98669. */
  98670. onbuttondown(callback: (buttonPressed: number) => void): void;
  98671. /**
  98672. * Callback triggered when a button has been released
  98673. * @param callback Called when a button has been released
  98674. */
  98675. onbuttonup(callback: (buttonReleased: number) => void): void;
  98676. /**
  98677. * Initializes the generic gamepad
  98678. * @param id The id of the generic gamepad
  98679. * @param index The index of the generic gamepad
  98680. * @param browserGamepad The browser gamepad
  98681. */
  98682. constructor(id: string, index: number, browserGamepad: any);
  98683. private _setButtonValue;
  98684. /**
  98685. * Updates the generic gamepad
  98686. */
  98687. update(): void;
  98688. /**
  98689. * Disposes the generic gamepad
  98690. */
  98691. dispose(): void;
  98692. }
  98693. }
  98694. declare module BABYLON {
  98695. /**
  98696. * Defines the types of pose enabled controllers that are supported
  98697. */
  98698. export enum PoseEnabledControllerType {
  98699. /**
  98700. * HTC Vive
  98701. */
  98702. VIVE = 0,
  98703. /**
  98704. * Oculus Rift
  98705. */
  98706. OCULUS = 1,
  98707. /**
  98708. * Windows mixed reality
  98709. */
  98710. WINDOWS = 2,
  98711. /**
  98712. * Samsung gear VR
  98713. */
  98714. GEAR_VR = 3,
  98715. /**
  98716. * Google Daydream
  98717. */
  98718. DAYDREAM = 4,
  98719. /**
  98720. * Generic
  98721. */
  98722. GENERIC = 5
  98723. }
  98724. /**
  98725. * Defines the MutableGamepadButton interface for the state of a gamepad button
  98726. */
  98727. export interface MutableGamepadButton {
  98728. /**
  98729. * Value of the button/trigger
  98730. */
  98731. value: number;
  98732. /**
  98733. * If the button/trigger is currently touched
  98734. */
  98735. touched: boolean;
  98736. /**
  98737. * If the button/trigger is currently pressed
  98738. */
  98739. pressed: boolean;
  98740. }
  98741. /**
  98742. * Defines the ExtendedGamepadButton interface for a gamepad button which includes state provided by a pose controller
  98743. * @hidden
  98744. */
  98745. export interface ExtendedGamepadButton extends GamepadButton {
  98746. /**
  98747. * If the button/trigger is currently pressed
  98748. */
  98749. readonly pressed: boolean;
  98750. /**
  98751. * If the button/trigger is currently touched
  98752. */
  98753. readonly touched: boolean;
  98754. /**
  98755. * Value of the button/trigger
  98756. */
  98757. readonly value: number;
  98758. }
  98759. /** @hidden */
  98760. export interface _GamePadFactory {
  98761. /**
  98762. * Returns whether or not the current gamepad can be created for this type of controller.
  98763. * @param gamepadInfo Defines the gamepad info as received from the controller APIs.
  98764. * @returns true if it can be created, otherwise false
  98765. */
  98766. canCreate(gamepadInfo: any): boolean;
  98767. /**
  98768. * Creates a new instance of the Gamepad.
  98769. * @param gamepadInfo Defines the gamepad info as received from the controller APIs.
  98770. * @returns the new gamepad instance
  98771. */
  98772. create(gamepadInfo: any): Gamepad;
  98773. }
  98774. /**
  98775. * Defines the PoseEnabledControllerHelper object that is used initialize a gamepad as the controller type it is specified as (eg. windows mixed reality controller)
  98776. */
  98777. export class PoseEnabledControllerHelper {
  98778. /** @hidden */
  98779. static _ControllerFactories: _GamePadFactory[];
  98780. /** @hidden */
  98781. static _DefaultControllerFactory: Nullable<(gamepadInfo: any) => Gamepad>;
  98782. /**
  98783. * Initializes a gamepad as the controller type it is specified as (eg. windows mixed reality controller)
  98784. * @param vrGamepad the gamepad to initialized
  98785. * @returns a vr controller of the type the gamepad identified as
  98786. */
  98787. static InitiateController(vrGamepad: any): Gamepad;
  98788. }
  98789. /**
  98790. * Defines the PoseEnabledController object that contains state of a vr capable controller
  98791. */
  98792. export class PoseEnabledController extends Gamepad implements PoseControlled {
  98793. /**
  98794. * If the controller is used in a webXR session
  98795. */
  98796. isXR: boolean;
  98797. private _deviceRoomPosition;
  98798. private _deviceRoomRotationQuaternion;
  98799. /**
  98800. * The device position in babylon space
  98801. */
  98802. devicePosition: Vector3;
  98803. /**
  98804. * The device rotation in babylon space
  98805. */
  98806. deviceRotationQuaternion: Quaternion;
  98807. /**
  98808. * The scale factor of the device in babylon space
  98809. */
  98810. deviceScaleFactor: number;
  98811. /**
  98812. * (Likely devicePosition should be used instead) The device position in its room space
  98813. */
  98814. position: Vector3;
  98815. /**
  98816. * (Likely deviceRotationQuaternion should be used instead) The device rotation in its room space
  98817. */
  98818. rotationQuaternion: Quaternion;
  98819. /**
  98820. * The type of controller (Eg. Windows mixed reality)
  98821. */
  98822. controllerType: PoseEnabledControllerType;
  98823. protected _calculatedPosition: Vector3;
  98824. private _calculatedRotation;
  98825. /**
  98826. * The raw pose from the device
  98827. */
  98828. rawPose: DevicePose;
  98829. private _trackPosition;
  98830. private _maxRotationDistFromHeadset;
  98831. private _draggedRoomRotation;
  98832. /**
  98833. * @hidden
  98834. */
  98835. _disableTrackPosition(fixedPosition: Vector3): void;
  98836. /**
  98837. * Internal, the mesh attached to the controller
  98838. * @hidden
  98839. */
  98840. _mesh: Nullable<AbstractMesh>;
  98841. private _poseControlledCamera;
  98842. private _leftHandSystemQuaternion;
  98843. /**
  98844. * Internal, matrix used to convert room space to babylon space
  98845. * @hidden
  98846. */
  98847. _deviceToWorld: Matrix;
  98848. /**
  98849. * Node to be used when casting a ray from the controller
  98850. * @hidden
  98851. */
  98852. _pointingPoseNode: Nullable<TransformNode>;
  98853. /**
  98854. * Name of the child mesh that can be used to cast a ray from the controller
  98855. */
  98856. static readonly POINTING_POSE: string;
  98857. /**
  98858. * Creates a new PoseEnabledController from a gamepad
  98859. * @param browserGamepad the gamepad that the PoseEnabledController should be created from
  98860. */
  98861. constructor(browserGamepad: any);
  98862. private _workingMatrix;
  98863. /**
  98864. * Updates the state of the pose enbaled controller and mesh based on the current position and rotation of the controller
  98865. */
  98866. update(): void;
  98867. /**
  98868. * Updates only the pose device and mesh without doing any button event checking
  98869. */
  98870. protected _updatePoseAndMesh(): void;
  98871. /**
  98872. * Updates the state of the pose enbaled controller based on the raw pose data from the device
  98873. * @param poseData raw pose fromthe device
  98874. */
  98875. updateFromDevice(poseData: DevicePose): void;
  98876. /**
  98877. * @hidden
  98878. */
  98879. _meshAttachedObservable: Observable<AbstractMesh>;
  98880. /**
  98881. * Attaches a mesh to the controller
  98882. * @param mesh the mesh to be attached
  98883. */
  98884. attachToMesh(mesh: AbstractMesh): void;
  98885. /**
  98886. * Attaches the controllers mesh to a camera
  98887. * @param camera the camera the mesh should be attached to
  98888. */
  98889. attachToPoseControlledCamera(camera: TargetCamera): void;
  98890. /**
  98891. * Disposes of the controller
  98892. */
  98893. dispose(): void;
  98894. /**
  98895. * The mesh that is attached to the controller
  98896. */
  98897. get mesh(): Nullable<AbstractMesh>;
  98898. /**
  98899. * Gets the ray of the controller in the direction the controller is pointing
  98900. * @param length the length the resulting ray should be
  98901. * @returns a ray in the direction the controller is pointing
  98902. */
  98903. getForwardRay(length?: number): Ray;
  98904. }
  98905. }
  98906. declare module BABYLON {
  98907. /**
  98908. * Defines the WebVRController object that represents controllers tracked in 3D space
  98909. */
  98910. export abstract class WebVRController extends PoseEnabledController {
  98911. /**
  98912. * Internal, the default controller model for the controller
  98913. */
  98914. protected _defaultModel: Nullable<AbstractMesh>;
  98915. /**
  98916. * Fired when the trigger state has changed
  98917. */
  98918. onTriggerStateChangedObservable: Observable<ExtendedGamepadButton>;
  98919. /**
  98920. * Fired when the main button state has changed
  98921. */
  98922. onMainButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  98923. /**
  98924. * Fired when the secondary button state has changed
  98925. */
  98926. onSecondaryButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  98927. /**
  98928. * Fired when the pad state has changed
  98929. */
  98930. onPadStateChangedObservable: Observable<ExtendedGamepadButton>;
  98931. /**
  98932. * Fired when controllers stick values have changed
  98933. */
  98934. onPadValuesChangedObservable: Observable<StickValues>;
  98935. /**
  98936. * Array of button availible on the controller
  98937. */
  98938. protected _buttons: Array<MutableGamepadButton>;
  98939. private _onButtonStateChange;
  98940. /**
  98941. * Fired when a controller button's state has changed
  98942. * @param callback the callback containing the button that was modified
  98943. */
  98944. onButtonStateChange(callback: (controlledIndex: number, buttonIndex: number, state: ExtendedGamepadButton) => void): void;
  98945. /**
  98946. * X and Y axis corresponding to the controllers joystick
  98947. */
  98948. pad: StickValues;
  98949. /**
  98950. * 'left' or 'right', see https://w3c.github.io/gamepad/extensions.html#gamepadhand-enum
  98951. */
  98952. hand: string;
  98953. /**
  98954. * The default controller model for the controller
  98955. */
  98956. get defaultModel(): Nullable<AbstractMesh>;
  98957. /**
  98958. * Creates a new WebVRController from a gamepad
  98959. * @param vrGamepad the gamepad that the WebVRController should be created from
  98960. */
  98961. constructor(vrGamepad: any);
  98962. /**
  98963. * Updates the state of the controller and mesh based on the current position and rotation of the controller
  98964. */
  98965. update(): void;
  98966. /**
  98967. * Function to be called when a button is modified
  98968. */
  98969. protected abstract _handleButtonChange(buttonIdx: number, value: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  98970. /**
  98971. * Loads a mesh and attaches it to the controller
  98972. * @param scene the scene the mesh should be added to
  98973. * @param meshLoaded callback for when the mesh has been loaded
  98974. */
  98975. abstract initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  98976. private _setButtonValue;
  98977. private _changes;
  98978. private _checkChanges;
  98979. /**
  98980. * Disposes of th webVRCOntroller
  98981. */
  98982. dispose(): void;
  98983. }
  98984. }
  98985. declare module BABYLON {
  98986. /**
  98987. * The HemisphericLight simulates the ambient environment light,
  98988. * so the passed direction is the light reflection direction, not the incoming direction.
  98989. */
  98990. export class HemisphericLight extends Light {
  98991. /**
  98992. * The groundColor is the light in the opposite direction to the one specified during creation.
  98993. * 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.
  98994. */
  98995. groundColor: Color3;
  98996. /**
  98997. * The light reflection direction, not the incoming direction.
  98998. */
  98999. direction: Vector3;
  99000. /**
  99001. * Creates a HemisphericLight object in the scene according to the passed direction (Vector3).
  99002. * The HemisphericLight simulates the ambient environment light, so the passed direction is the light reflection direction, not the incoming direction.
  99003. * The HemisphericLight can't cast shadows.
  99004. * Documentation : https://doc.babylonjs.com/babylon101/lights
  99005. * @param name The friendly name of the light
  99006. * @param direction The direction of the light reflection
  99007. * @param scene The scene the light belongs to
  99008. */
  99009. constructor(name: string, direction: Vector3, scene: Scene);
  99010. protected _buildUniformLayout(): void;
  99011. /**
  99012. * Returns the string "HemisphericLight".
  99013. * @return The class name
  99014. */
  99015. getClassName(): string;
  99016. /**
  99017. * Sets the HemisphericLight direction towards the passed target (Vector3).
  99018. * Returns the updated direction.
  99019. * @param target The target the direction should point to
  99020. * @return The computed direction
  99021. */
  99022. setDirectionToTarget(target: Vector3): Vector3;
  99023. /**
  99024. * Returns the shadow generator associated to the light.
  99025. * @returns Always null for hemispheric lights because it does not support shadows.
  99026. */
  99027. getShadowGenerator(): Nullable<IShadowGenerator>;
  99028. /**
  99029. * Sets the passed Effect object with the HemisphericLight normalized direction and color and the passed name (string).
  99030. * @param effect The effect to update
  99031. * @param lightIndex The index of the light in the effect to update
  99032. * @returns The hemispheric light
  99033. */
  99034. transferToEffect(effect: Effect, lightIndex: string): HemisphericLight;
  99035. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  99036. /**
  99037. * Computes the world matrix of the node
  99038. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  99039. * @param useWasUpdatedFlag defines a reserved property
  99040. * @returns the world matrix
  99041. */
  99042. computeWorldMatrix(): Matrix;
  99043. /**
  99044. * Returns the integer 3.
  99045. * @return The light Type id as a constant defines in Light.LIGHTTYPEID_x
  99046. */
  99047. getTypeID(): number;
  99048. /**
  99049. * Prepares the list of defines specific to the light type.
  99050. * @param defines the list of defines
  99051. * @param lightIndex defines the index of the light for the effect
  99052. */
  99053. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  99054. }
  99055. }
  99056. declare module BABYLON {
  99057. /** @hidden */
  99058. export var vrMultiviewToSingleviewPixelShader: {
  99059. name: string;
  99060. shader: string;
  99061. };
  99062. }
  99063. declare module BABYLON {
  99064. /**
  99065. * Renders to multiple views with a single draw call
  99066. * @see https://www.khronos.org/registry/webgl/extensions/WEBGL_multiview/
  99067. */
  99068. export class MultiviewRenderTarget extends RenderTargetTexture {
  99069. /**
  99070. * Creates a multiview render target
  99071. * @param scene scene used with the render target
  99072. * @param size the size of the render target (used for each view)
  99073. */
  99074. constructor(scene: Scene, size?: number | {
  99075. width: number;
  99076. height: number;
  99077. } | {
  99078. ratio: number;
  99079. });
  99080. /**
  99081. * @hidden
  99082. * @param faceIndex the face index, if its a cube texture
  99083. */
  99084. _bindFrameBuffer(faceIndex?: number): void;
  99085. /**
  99086. * Gets the number of views the corresponding to the texture (eg. a MultiviewRenderTarget will have > 1)
  99087. * @returns the view count
  99088. */
  99089. getViewCount(): number;
  99090. }
  99091. }
  99092. declare module BABYLON {
  99093. interface Engine {
  99094. /**
  99095. * Creates a new multiview render target
  99096. * @param width defines the width of the texture
  99097. * @param height defines the height of the texture
  99098. * @returns the created multiview texture
  99099. */
  99100. createMultiviewRenderTargetTexture(width: number, height: number): InternalTexture;
  99101. /**
  99102. * Binds a multiview framebuffer to be drawn to
  99103. * @param multiviewTexture texture to bind
  99104. */
  99105. bindMultiviewFramebuffer(multiviewTexture: InternalTexture): void;
  99106. }
  99107. interface Camera {
  99108. /**
  99109. * @hidden
  99110. * 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)
  99111. */
  99112. _useMultiviewToSingleView: boolean;
  99113. /**
  99114. * @hidden
  99115. * 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)
  99116. */
  99117. _multiviewTexture: Nullable<RenderTargetTexture>;
  99118. /**
  99119. * @hidden
  99120. * ensures the multiview texture of the camera exists and has the specified width/height
  99121. * @param width height to set on the multiview texture
  99122. * @param height width to set on the multiview texture
  99123. */
  99124. _resizeOrCreateMultiviewTexture(width: number, height: number): void;
  99125. }
  99126. interface Scene {
  99127. /** @hidden */
  99128. _transformMatrixR: Matrix;
  99129. /** @hidden */
  99130. _multiviewSceneUbo: Nullable<UniformBuffer>;
  99131. /** @hidden */
  99132. _createMultiviewUbo(): void;
  99133. /** @hidden */
  99134. _updateMultiviewUbo(viewR?: Matrix, projectionR?: Matrix): void;
  99135. /** @hidden */
  99136. _renderMultiviewToSingleView(camera: Camera): void;
  99137. }
  99138. }
  99139. declare module BABYLON {
  99140. /**
  99141. * VRMultiviewToSingleview used to convert multiview texture arrays to standard textures for scenarios such as webVR
  99142. * This will not be used for webXR as it supports displaying texture arrays directly
  99143. */
  99144. export class VRMultiviewToSingleviewPostProcess extends PostProcess {
  99145. /**
  99146. * Gets a string identifying the name of the class
  99147. * @returns "VRMultiviewToSingleviewPostProcess" string
  99148. */
  99149. getClassName(): string;
  99150. /**
  99151. * Initializes a VRMultiviewToSingleview
  99152. * @param name name of the post process
  99153. * @param camera camera to be applied to
  99154. * @param scaleFactor scaling factor to the size of the output texture
  99155. */
  99156. constructor(name: string, camera: Camera, scaleFactor: number);
  99157. }
  99158. }
  99159. declare module BABYLON {
  99160. /**
  99161. * Interface used to define additional presentation attributes
  99162. */
  99163. export interface IVRPresentationAttributes {
  99164. /**
  99165. * Defines a boolean indicating that we want to get 72hz mode on Oculus Browser (default is off eg. 60hz)
  99166. */
  99167. highRefreshRate: boolean;
  99168. /**
  99169. * Enables foveation in VR to improve perf. 0 none, 1 low, 2 medium, 3 high (Default is 1)
  99170. */
  99171. foveationLevel: number;
  99172. }
  99173. interface Engine {
  99174. /** @hidden */
  99175. _vrDisplay: any;
  99176. /** @hidden */
  99177. _vrSupported: boolean;
  99178. /** @hidden */
  99179. _oldSize: Size;
  99180. /** @hidden */
  99181. _oldHardwareScaleFactor: number;
  99182. /** @hidden */
  99183. _vrExclusivePointerMode: boolean;
  99184. /** @hidden */
  99185. _webVRInitPromise: Promise<IDisplayChangedEventArgs>;
  99186. /** @hidden */
  99187. _onVRDisplayPointerRestricted: () => void;
  99188. /** @hidden */
  99189. _onVRDisplayPointerUnrestricted: () => void;
  99190. /** @hidden */
  99191. _onVrDisplayConnect: Nullable<(display: any) => void>;
  99192. /** @hidden */
  99193. _onVrDisplayDisconnect: Nullable<() => void>;
  99194. /** @hidden */
  99195. _onVrDisplayPresentChange: Nullable<() => void>;
  99196. /**
  99197. * Observable signaled when VR display mode changes
  99198. */
  99199. onVRDisplayChangedObservable: Observable<IDisplayChangedEventArgs>;
  99200. /**
  99201. * Observable signaled when VR request present is complete
  99202. */
  99203. onVRRequestPresentComplete: Observable<boolean>;
  99204. /**
  99205. * Observable signaled when VR request present starts
  99206. */
  99207. onVRRequestPresentStart: Observable<Engine>;
  99208. /**
  99209. * Gets a boolean indicating that the engine is currently in VR exclusive mode for the pointers
  99210. * @see https://docs.microsoft.com/en-us/microsoft-edge/webvr/essentials#mouse-input
  99211. */
  99212. isInVRExclusivePointerMode: boolean;
  99213. /**
  99214. * Gets a boolean indicating if a webVR device was detected
  99215. * @returns true if a webVR device was detected
  99216. */
  99217. isVRDevicePresent(): boolean;
  99218. /**
  99219. * Gets the current webVR device
  99220. * @returns the current webVR device (or null)
  99221. */
  99222. getVRDevice(): any;
  99223. /**
  99224. * Initializes a webVR display and starts listening to display change events
  99225. * The onVRDisplayChangedObservable will be notified upon these changes
  99226. * @returns A promise containing a VRDisplay and if vr is supported
  99227. */
  99228. initWebVRAsync(): Promise<IDisplayChangedEventArgs>;
  99229. /** @hidden */
  99230. _getVRDisplaysAsync(): Promise<IDisplayChangedEventArgs>;
  99231. /**
  99232. * Gets or sets the presentation attributes used to configure VR rendering
  99233. */
  99234. vrPresentationAttributes?: IVRPresentationAttributes;
  99235. /**
  99236. * Call this function to switch to webVR mode
  99237. * Will do nothing if webVR is not supported or if there is no webVR device
  99238. * @param options the webvr options provided to the camera. mainly used for multiview
  99239. * @see https://doc.babylonjs.com/how_to/webvr_camera
  99240. */
  99241. enableVR(options: WebVROptions): void;
  99242. /** @hidden */
  99243. _onVRFullScreenTriggered(): void;
  99244. }
  99245. }
  99246. declare module BABYLON {
  99247. /**
  99248. * This is a copy of VRPose. See https://developer.mozilla.org/en-US/docs/Web/API/VRPose
  99249. * IMPORTANT!! The data is right-hand data.
  99250. * @export
  99251. * @interface DevicePose
  99252. */
  99253. export interface DevicePose {
  99254. /**
  99255. * The position of the device, values in array are [x,y,z].
  99256. */
  99257. readonly position: Nullable<Float32Array>;
  99258. /**
  99259. * The linearVelocity of the device, values in array are [x,y,z].
  99260. */
  99261. readonly linearVelocity: Nullable<Float32Array>;
  99262. /**
  99263. * The linearAcceleration of the device, values in array are [x,y,z].
  99264. */
  99265. readonly linearAcceleration: Nullable<Float32Array>;
  99266. /**
  99267. * The orientation of the device in a quaternion array, values in array are [x,y,z,w].
  99268. */
  99269. readonly orientation: Nullable<Float32Array>;
  99270. /**
  99271. * The angularVelocity of the device, values in array are [x,y,z].
  99272. */
  99273. readonly angularVelocity: Nullable<Float32Array>;
  99274. /**
  99275. * The angularAcceleration of the device, values in array are [x,y,z].
  99276. */
  99277. readonly angularAcceleration: Nullable<Float32Array>;
  99278. }
  99279. /**
  99280. * Interface representing a pose controlled object in Babylon.
  99281. * A pose controlled object has both regular pose values as well as pose values
  99282. * from an external device such as a VR head mounted display
  99283. */
  99284. export interface PoseControlled {
  99285. /**
  99286. * The position of the object in babylon space.
  99287. */
  99288. position: Vector3;
  99289. /**
  99290. * The rotation quaternion of the object in babylon space.
  99291. */
  99292. rotationQuaternion: Quaternion;
  99293. /**
  99294. * The position of the device in babylon space.
  99295. */
  99296. devicePosition?: Vector3;
  99297. /**
  99298. * The rotation quaternion of the device in babylon space.
  99299. */
  99300. deviceRotationQuaternion: Quaternion;
  99301. /**
  99302. * The raw pose coming from the device.
  99303. */
  99304. rawPose: Nullable<DevicePose>;
  99305. /**
  99306. * The scale of the device to be used when translating from device space to babylon space.
  99307. */
  99308. deviceScaleFactor: number;
  99309. /**
  99310. * Updates the poseControlled values based on the input device pose.
  99311. * @param poseData the pose data to update the object with
  99312. */
  99313. updateFromDevice(poseData: DevicePose): void;
  99314. }
  99315. /**
  99316. * Set of options to customize the webVRCamera
  99317. */
  99318. export interface WebVROptions {
  99319. /**
  99320. * Sets if the webVR camera should be tracked to the vrDevice. (default: true)
  99321. */
  99322. trackPosition?: boolean;
  99323. /**
  99324. * Sets the scale of the vrDevice in babylon space. (default: 1)
  99325. */
  99326. positionScale?: number;
  99327. /**
  99328. * If there are more than one VRDisplays, this will choose the display matching this name. (default: pick first vrDisplay)
  99329. */
  99330. displayName?: string;
  99331. /**
  99332. * Should the native controller meshes be initialized. (default: true)
  99333. */
  99334. controllerMeshes?: boolean;
  99335. /**
  99336. * Creating a default HemiLight only on controllers. (default: true)
  99337. */
  99338. defaultLightingOnControllers?: boolean;
  99339. /**
  99340. * If you don't want to use the default VR button of the helper. (default: false)
  99341. */
  99342. useCustomVRButton?: boolean;
  99343. /**
  99344. * If you'd like to provide your own button to the VRHelper. (default: standard babylon vr button)
  99345. */
  99346. customVRButton?: HTMLButtonElement;
  99347. /**
  99348. * To change the length of the ray for gaze/controllers. Will be scaled by positionScale. (default: 100)
  99349. */
  99350. rayLength?: number;
  99351. /**
  99352. * To change the default offset from the ground to account for user's height in meters. Will be scaled by positionScale. (default: 1.7)
  99353. */
  99354. defaultHeight?: number;
  99355. /**
  99356. * If multiview should be used if availible (default: false)
  99357. */
  99358. useMultiview?: boolean;
  99359. }
  99360. /**
  99361. * This represents a WebVR camera.
  99362. * The WebVR camera is Babylon's simple interface to interaction with Windows Mixed Reality, HTC Vive and Oculus Rift.
  99363. * @example https://doc.babylonjs.com/how_to/webvr_camera
  99364. */
  99365. export class WebVRFreeCamera extends FreeCamera implements PoseControlled {
  99366. private webVROptions;
  99367. /**
  99368. * @hidden
  99369. * The vrDisplay tied to the camera. See https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay
  99370. */
  99371. _vrDevice: any;
  99372. /**
  99373. * The rawPose of the vrDevice.
  99374. */
  99375. rawPose: Nullable<DevicePose>;
  99376. private _onVREnabled;
  99377. private _specsVersion;
  99378. private _attached;
  99379. private _frameData;
  99380. protected _descendants: Array<Node>;
  99381. private _deviceRoomPosition;
  99382. /** @hidden */
  99383. _deviceRoomRotationQuaternion: Quaternion;
  99384. private _standingMatrix;
  99385. /**
  99386. * Represents device position in babylon space.
  99387. */
  99388. devicePosition: Vector3;
  99389. /**
  99390. * Represents device rotation in babylon space.
  99391. */
  99392. deviceRotationQuaternion: Quaternion;
  99393. /**
  99394. * The scale of the device to be used when translating from device space to babylon space.
  99395. */
  99396. deviceScaleFactor: number;
  99397. private _deviceToWorld;
  99398. private _worldToDevice;
  99399. /**
  99400. * References to the webVR controllers for the vrDevice.
  99401. */
  99402. controllers: Array<WebVRController>;
  99403. /**
  99404. * Emits an event when a controller is attached.
  99405. */
  99406. onControllersAttachedObservable: Observable<WebVRController[]>;
  99407. /**
  99408. * Emits an event when a controller's mesh has been loaded;
  99409. */
  99410. onControllerMeshLoadedObservable: Observable<WebVRController>;
  99411. /**
  99412. * Emits an event when the HMD's pose has been updated.
  99413. */
  99414. onPoseUpdatedFromDeviceObservable: Observable<any>;
  99415. private _poseSet;
  99416. /**
  99417. * If the rig cameras be used as parent instead of this camera.
  99418. */
  99419. rigParenting: boolean;
  99420. private _lightOnControllers;
  99421. private _defaultHeight?;
  99422. /**
  99423. * Instantiates a WebVRFreeCamera.
  99424. * @param name The name of the WebVRFreeCamera
  99425. * @param position The starting anchor position for the camera
  99426. * @param scene The scene the camera belongs to
  99427. * @param webVROptions a set of customizable options for the webVRCamera
  99428. */
  99429. constructor(name: string, position: Vector3, scene: Scene, webVROptions?: WebVROptions);
  99430. /**
  99431. * Gets the device distance from the ground in meters.
  99432. * @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.
  99433. */
  99434. deviceDistanceToRoomGround(): number;
  99435. /**
  99436. * Enables the standing matrix when supported. This can be used to position the user's view the correct height from the ground.
  99437. * @param callback will be called when the standing matrix is set. Callback parameter is if the standing matrix is supported.
  99438. */
  99439. useStandingMatrix(callback?: (bool: boolean) => void): void;
  99440. /**
  99441. * Enables the standing matrix when supported. This can be used to position the user's view the correct height from the ground.
  99442. * @returns A promise with a boolean set to if the standing matrix is supported.
  99443. */
  99444. useStandingMatrixAsync(): Promise<boolean>;
  99445. /**
  99446. * Disposes the camera
  99447. */
  99448. dispose(): void;
  99449. /**
  99450. * Gets a vrController by name.
  99451. * @param name The name of the controller to retreive
  99452. * @returns the controller matching the name specified or null if not found
  99453. */
  99454. getControllerByName(name: string): Nullable<WebVRController>;
  99455. private _leftController;
  99456. /**
  99457. * The controller corresponding to the users left hand.
  99458. */
  99459. get leftController(): Nullable<WebVRController>;
  99460. private _rightController;
  99461. /**
  99462. * The controller corresponding to the users right hand.
  99463. */
  99464. get rightController(): Nullable<WebVRController>;
  99465. /**
  99466. * Casts a ray forward from the vrCamera's gaze.
  99467. * @param length Length of the ray (default: 100)
  99468. * @returns the ray corresponding to the gaze
  99469. */
  99470. getForwardRay(length?: number): Ray;
  99471. /**
  99472. * @hidden
  99473. * Updates the camera based on device's frame data
  99474. */
  99475. _checkInputs(): void;
  99476. /**
  99477. * Updates the poseControlled values based on the input device pose.
  99478. * @param poseData Pose coming from the device
  99479. */
  99480. updateFromDevice(poseData: DevicePose): void;
  99481. private _htmlElementAttached;
  99482. private _detachIfAttached;
  99483. /**
  99484. * WebVR's attach control will start broadcasting frames to the device.
  99485. * Note that in certain browsers (chrome for example) this function must be called
  99486. * within a user-interaction callback. Example:
  99487. * <pre> scene.onPointerDown = function() { camera.attachControl(canvas); }</pre>
  99488. *
  99489. * @param element html element to attach the vrDevice to
  99490. * @param noPreventDefault prevent the default html element operation when attaching the vrDevice
  99491. */
  99492. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  99493. /**
  99494. * Detaches the camera from the html element and disables VR
  99495. *
  99496. * @param element html element to detach from
  99497. */
  99498. detachControl(element: HTMLElement): void;
  99499. /**
  99500. * @returns the name of this class
  99501. */
  99502. getClassName(): string;
  99503. /**
  99504. * Calls resetPose on the vrDisplay
  99505. * See: https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay/resetPose
  99506. */
  99507. resetToCurrentRotation(): void;
  99508. /**
  99509. * @hidden
  99510. * Updates the rig cameras (left and right eye)
  99511. */
  99512. _updateRigCameras(): void;
  99513. private _workingVector;
  99514. private _oneVector;
  99515. private _workingMatrix;
  99516. private updateCacheCalled;
  99517. private _correctPositionIfNotTrackPosition;
  99518. /**
  99519. * @hidden
  99520. * Updates the cached values of the camera
  99521. * @param ignoreParentClass ignores updating the parent class's cache (default: false)
  99522. */
  99523. _updateCache(ignoreParentClass?: boolean): void;
  99524. /**
  99525. * @hidden
  99526. * Get current device position in babylon world
  99527. */
  99528. _computeDevicePosition(): void;
  99529. /**
  99530. * Updates the current device position and rotation in the babylon world
  99531. */
  99532. update(): void;
  99533. /**
  99534. * @hidden
  99535. * Gets the view matrix of this camera (Always set to identity as left and right eye cameras contain the actual view matrix)
  99536. * @returns an identity matrix
  99537. */
  99538. _getViewMatrix(): Matrix;
  99539. private _tmpMatrix;
  99540. /**
  99541. * This function is called by the two RIG cameras.
  99542. * 'this' is the left or right camera (and NOT (!!!) the WebVRFreeCamera instance)
  99543. * @hidden
  99544. */
  99545. _getWebVRViewMatrix(): Matrix;
  99546. /** @hidden */
  99547. _getWebVRProjectionMatrix(): Matrix;
  99548. private _onGamepadConnectedObserver;
  99549. private _onGamepadDisconnectedObserver;
  99550. private _updateCacheWhenTrackingDisabledObserver;
  99551. /**
  99552. * Initializes the controllers and their meshes
  99553. */
  99554. initControllers(): void;
  99555. }
  99556. }
  99557. declare module BABYLON {
  99558. /**
  99559. * "Static Class" containing the most commonly used helper while dealing with material for rendering purpose.
  99560. *
  99561. * It contains the basic tools to help defining defines, binding uniform for the common part of the materials.
  99562. *
  99563. * This works by convention in BabylonJS but is meant to be use only with shader following the in place naming rules and conventions.
  99564. */
  99565. export class MaterialHelper {
  99566. /**
  99567. * Bind the current view position to an effect.
  99568. * @param effect The effect to be bound
  99569. * @param scene The scene the eyes position is used from
  99570. * @param variableName name of the shader variable that will hold the eye position
  99571. */
  99572. static BindEyePosition(effect: Effect, scene: Scene, variableName?: string): void;
  99573. /**
  99574. * Helps preparing the defines values about the UVs in used in the effect.
  99575. * UVs are shared as much as we can accross channels in the shaders.
  99576. * @param texture The texture we are preparing the UVs for
  99577. * @param defines The defines to update
  99578. * @param key The channel key "diffuse", "specular"... used in the shader
  99579. */
  99580. static PrepareDefinesForMergedUV(texture: BaseTexture, defines: any, key: string): void;
  99581. /**
  99582. * Binds a texture matrix value to its corrsponding uniform
  99583. * @param texture The texture to bind the matrix for
  99584. * @param uniformBuffer The uniform buffer receivin the data
  99585. * @param key The channel key "diffuse", "specular"... used in the shader
  99586. */
  99587. static BindTextureMatrix(texture: BaseTexture, uniformBuffer: UniformBuffer, key: string): void;
  99588. /**
  99589. * Gets the current status of the fog (should it be enabled?)
  99590. * @param mesh defines the mesh to evaluate for fog support
  99591. * @param scene defines the hosting scene
  99592. * @returns true if fog must be enabled
  99593. */
  99594. static GetFogState(mesh: AbstractMesh, scene: Scene): boolean;
  99595. /**
  99596. * Helper used to prepare the list of defines associated with misc. values for shader compilation
  99597. * @param mesh defines the current mesh
  99598. * @param scene defines the current scene
  99599. * @param useLogarithmicDepth defines if logarithmic depth has to be turned on
  99600. * @param pointsCloud defines if point cloud rendering has to be turned on
  99601. * @param fogEnabled defines if fog has to be turned on
  99602. * @param alphaTest defines if alpha testing has to be turned on
  99603. * @param defines defines the current list of defines
  99604. */
  99605. static PrepareDefinesForMisc(mesh: AbstractMesh, scene: Scene, useLogarithmicDepth: boolean, pointsCloud: boolean, fogEnabled: boolean, alphaTest: boolean, defines: any): void;
  99606. /**
  99607. * Helper used to prepare the list of defines associated with frame values for shader compilation
  99608. * @param scene defines the current scene
  99609. * @param engine defines the current engine
  99610. * @param defines specifies the list of active defines
  99611. * @param useInstances defines if instances have to be turned on
  99612. * @param useClipPlane defines if clip plane have to be turned on
  99613. * @param useInstances defines if instances have to be turned on
  99614. * @param useThinInstances defines if thin instances have to be turned on
  99615. */
  99616. static PrepareDefinesForFrameBoundValues(scene: Scene, engine: Engine, defines: any, useInstances: boolean, useClipPlane?: Nullable<boolean>, useThinInstances?: boolean): void;
  99617. /**
  99618. * Prepares the defines for bones
  99619. * @param mesh The mesh containing the geometry data we will draw
  99620. * @param defines The defines to update
  99621. */
  99622. static PrepareDefinesForBones(mesh: AbstractMesh, defines: any): void;
  99623. /**
  99624. * Prepares the defines for morph targets
  99625. * @param mesh The mesh containing the geometry data we will draw
  99626. * @param defines The defines to update
  99627. */
  99628. static PrepareDefinesForMorphTargets(mesh: AbstractMesh, defines: any): void;
  99629. /**
  99630. * Prepares the defines used in the shader depending on the attributes data available in the mesh
  99631. * @param mesh The mesh containing the geometry data we will draw
  99632. * @param defines The defines to update
  99633. * @param useVertexColor Precise whether vertex colors should be used or not (override mesh info)
  99634. * @param useBones Precise whether bones should be used or not (override mesh info)
  99635. * @param useMorphTargets Precise whether morph targets should be used or not (override mesh info)
  99636. * @param useVertexAlpha Precise whether vertex alpha should be used or not (override mesh info)
  99637. * @returns false if defines are considered not dirty and have not been checked
  99638. */
  99639. static PrepareDefinesForAttributes(mesh: AbstractMesh, defines: any, useVertexColor: boolean, useBones: boolean, useMorphTargets?: boolean, useVertexAlpha?: boolean): boolean;
  99640. /**
  99641. * Prepares the defines related to multiview
  99642. * @param scene The scene we are intending to draw
  99643. * @param defines The defines to update
  99644. */
  99645. static PrepareDefinesForMultiview(scene: Scene, defines: any): void;
  99646. /**
  99647. * Prepares the defines related to the prepass
  99648. * @param scene The scene we are intending to draw
  99649. * @param defines The defines to update
  99650. * @param canRenderToMRT Indicates if this material renders to several textures in the prepass
  99651. */
  99652. static PrepareDefinesForPrePass(scene: Scene, defines: any, canRenderToMRT: boolean): void;
  99653. /**
  99654. * Prepares the defines related to the light information passed in parameter
  99655. * @param scene The scene we are intending to draw
  99656. * @param mesh The mesh the effect is compiling for
  99657. * @param light The light the effect is compiling for
  99658. * @param lightIndex The index of the light
  99659. * @param defines The defines to update
  99660. * @param specularSupported Specifies whether specular is supported or not (override lights data)
  99661. * @param state Defines the current state regarding what is needed (normals, etc...)
  99662. */
  99663. static PrepareDefinesForLight(scene: Scene, mesh: AbstractMesh, light: Light, lightIndex: number, defines: any, specularSupported: boolean, state: {
  99664. needNormals: boolean;
  99665. needRebuild: boolean;
  99666. shadowEnabled: boolean;
  99667. specularEnabled: boolean;
  99668. lightmapMode: boolean;
  99669. }): void;
  99670. /**
  99671. * Prepares the defines related to the light information passed in parameter
  99672. * @param scene The scene we are intending to draw
  99673. * @param mesh The mesh the effect is compiling for
  99674. * @param defines The defines to update
  99675. * @param specularSupported Specifies whether specular is supported or not (override lights data)
  99676. * @param maxSimultaneousLights Specfies how manuy lights can be added to the effect at max
  99677. * @param disableLighting Specifies whether the lighting is disabled (override scene and light)
  99678. * @returns true if normals will be required for the rest of the effect
  99679. */
  99680. static PrepareDefinesForLights(scene: Scene, mesh: AbstractMesh, defines: any, specularSupported: boolean, maxSimultaneousLights?: number, disableLighting?: boolean): boolean;
  99681. /**
  99682. * Prepares the uniforms and samplers list to be used in the effect (for a specific light)
  99683. * @param lightIndex defines the light index
  99684. * @param uniformsList The uniform list
  99685. * @param samplersList The sampler list
  99686. * @param projectedLightTexture defines if projected texture must be used
  99687. * @param uniformBuffersList defines an optional list of uniform buffers
  99688. */
  99689. static PrepareUniformsAndSamplersForLight(lightIndex: number, uniformsList: string[], samplersList: string[], projectedLightTexture?: any, uniformBuffersList?: Nullable<string[]>): void;
  99690. /**
  99691. * Prepares the uniforms and samplers list to be used in the effect
  99692. * @param uniformsListOrOptions The uniform names to prepare or an EffectCreationOptions containing the liist and extra information
  99693. * @param samplersList The sampler list
  99694. * @param defines The defines helping in the list generation
  99695. * @param maxSimultaneousLights The maximum number of simultanous light allowed in the effect
  99696. */
  99697. static PrepareUniformsAndSamplersList(uniformsListOrOptions: string[] | IEffectCreationOptions, samplersList?: string[], defines?: any, maxSimultaneousLights?: number): void;
  99698. /**
  99699. * This helps decreasing rank by rank the shadow quality (0 being the highest rank and quality)
  99700. * @param defines The defines to update while falling back
  99701. * @param fallbacks The authorized effect fallbacks
  99702. * @param maxSimultaneousLights The maximum number of lights allowed
  99703. * @param rank the current rank of the Effect
  99704. * @returns The newly affected rank
  99705. */
  99706. static HandleFallbacksForShadows(defines: any, fallbacks: EffectFallbacks, maxSimultaneousLights?: number, rank?: number): number;
  99707. private static _TmpMorphInfluencers;
  99708. /**
  99709. * Prepares the list of attributes required for morph targets according to the effect defines.
  99710. * @param attribs The current list of supported attribs
  99711. * @param mesh The mesh to prepare the morph targets attributes for
  99712. * @param influencers The number of influencers
  99713. */
  99714. static PrepareAttributesForMorphTargetsInfluencers(attribs: string[], mesh: AbstractMesh, influencers: number): void;
  99715. /**
  99716. * Prepares the list of attributes required for morph targets according to the effect defines.
  99717. * @param attribs The current list of supported attribs
  99718. * @param mesh The mesh to prepare the morph targets attributes for
  99719. * @param defines The current Defines of the effect
  99720. */
  99721. static PrepareAttributesForMorphTargets(attribs: string[], mesh: AbstractMesh, defines: any): void;
  99722. /**
  99723. * Prepares the list of attributes required for bones according to the effect defines.
  99724. * @param attribs The current list of supported attribs
  99725. * @param mesh The mesh to prepare the bones attributes for
  99726. * @param defines The current Defines of the effect
  99727. * @param fallbacks The current efffect fallback strategy
  99728. */
  99729. static PrepareAttributesForBones(attribs: string[], mesh: AbstractMesh, defines: any, fallbacks: EffectFallbacks): void;
  99730. /**
  99731. * Check and prepare the list of attributes required for instances according to the effect defines.
  99732. * @param attribs The current list of supported attribs
  99733. * @param defines The current MaterialDefines of the effect
  99734. */
  99735. static PrepareAttributesForInstances(attribs: string[], defines: MaterialDefines): void;
  99736. /**
  99737. * Add the list of attributes required for instances to the attribs array.
  99738. * @param attribs The current list of supported attribs
  99739. */
  99740. static PushAttributesForInstances(attribs: string[]): void;
  99741. /**
  99742. * Binds the light information to the effect.
  99743. * @param light The light containing the generator
  99744. * @param effect The effect we are binding the data to
  99745. * @param lightIndex The light index in the effect used to render
  99746. */
  99747. static BindLightProperties(light: Light, effect: Effect, lightIndex: number): void;
  99748. /**
  99749. * Binds the lights information from the scene to the effect for the given mesh.
  99750. * @param light Light to bind
  99751. * @param lightIndex Light index
  99752. * @param scene The scene where the light belongs to
  99753. * @param effect The effect we are binding the data to
  99754. * @param useSpecular Defines if specular is supported
  99755. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  99756. */
  99757. static BindLight(light: Light, lightIndex: number, scene: Scene, effect: Effect, useSpecular: boolean, rebuildInParallel?: boolean): void;
  99758. /**
  99759. * Binds the lights information from the scene to the effect for the given mesh.
  99760. * @param scene The scene the lights belongs to
  99761. * @param mesh The mesh we are binding the information to render
  99762. * @param effect The effect we are binding the data to
  99763. * @param defines The generated defines for the effect
  99764. * @param maxSimultaneousLights The maximum number of light that can be bound to the effect
  99765. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  99766. */
  99767. static BindLights(scene: Scene, mesh: AbstractMesh, effect: Effect, defines: any, maxSimultaneousLights?: number, rebuildInParallel?: boolean): void;
  99768. private static _tempFogColor;
  99769. /**
  99770. * Binds the fog information from the scene to the effect for the given mesh.
  99771. * @param scene The scene the lights belongs to
  99772. * @param mesh The mesh we are binding the information to render
  99773. * @param effect The effect we are binding the data to
  99774. * @param linearSpace Defines if the fog effect is applied in linear space
  99775. */
  99776. static BindFogParameters(scene: Scene, mesh: AbstractMesh, effect: Effect, linearSpace?: boolean): void;
  99777. /**
  99778. * Binds the bones information from the mesh to the effect.
  99779. * @param mesh The mesh we are binding the information to render
  99780. * @param effect The effect we are binding the data to
  99781. */
  99782. static BindBonesParameters(mesh?: AbstractMesh, effect?: Effect): void;
  99783. /**
  99784. * Binds the morph targets information from the mesh to the effect.
  99785. * @param abstractMesh The mesh we are binding the information to render
  99786. * @param effect The effect we are binding the data to
  99787. */
  99788. static BindMorphTargetParameters(abstractMesh: AbstractMesh, effect: Effect): void;
  99789. /**
  99790. * Binds the logarithmic depth information from the scene to the effect for the given defines.
  99791. * @param defines The generated defines used in the effect
  99792. * @param effect The effect we are binding the data to
  99793. * @param scene The scene we are willing to render with logarithmic scale for
  99794. */
  99795. static BindLogDepth(defines: any, effect: Effect, scene: Scene): void;
  99796. /**
  99797. * Binds the clip plane information from the scene to the effect.
  99798. * @param scene The scene the clip plane information are extracted from
  99799. * @param effect The effect we are binding the data to
  99800. */
  99801. static BindClipPlane(effect: Effect, scene: Scene): void;
  99802. }
  99803. }
  99804. declare module BABYLON {
  99805. /**
  99806. * Block used to expose an input value
  99807. */
  99808. export class InputBlock extends NodeMaterialBlock {
  99809. private _mode;
  99810. private _associatedVariableName;
  99811. private _storedValue;
  99812. private _valueCallback;
  99813. private _type;
  99814. private _animationType;
  99815. /** Gets or set a value used to limit the range of float values */
  99816. min: number;
  99817. /** Gets or set a value used to limit the range of float values */
  99818. max: number;
  99819. /** Gets or set a value indicating that this input can only get 0 and 1 values */
  99820. isBoolean: boolean;
  99821. /** Gets or sets a value used by the Node Material editor to determine how to configure the current value if it is a matrix */
  99822. matrixMode: number;
  99823. /** @hidden */
  99824. _systemValue: Nullable<NodeMaterialSystemValues>;
  99825. /** Gets or sets a boolean indicating that this input can be edited in the Inspector (false by default) */
  99826. visibleInInspector: boolean;
  99827. /** Gets or sets a boolean indicating that the value of this input will not change after a build */
  99828. isConstant: boolean;
  99829. /** Gets or sets the group to use to display this block in the Inspector */
  99830. groupInInspector: string;
  99831. /** Gets an observable raised when the value is changed */
  99832. onValueChangedObservable: Observable<InputBlock>;
  99833. /**
  99834. * Gets or sets the connection point type (default is float)
  99835. */
  99836. get type(): NodeMaterialBlockConnectionPointTypes;
  99837. /**
  99838. * Creates a new InputBlock
  99839. * @param name defines the block name
  99840. * @param target defines the target of that block (Vertex by default)
  99841. * @param type defines the type of the input (can be set to NodeMaterialBlockConnectionPointTypes.AutoDetect)
  99842. */
  99843. constructor(name: string, target?: NodeMaterialBlockTargets, type?: NodeMaterialBlockConnectionPointTypes);
  99844. /**
  99845. * Validates if a name is a reserve word.
  99846. * @param newName the new name to be given to the node.
  99847. * @returns false if the name is a reserve word, else true.
  99848. */
  99849. validateBlockName(newName: string): boolean;
  99850. /**
  99851. * Gets the output component
  99852. */
  99853. get output(): NodeMaterialConnectionPoint;
  99854. /**
  99855. * Set the source of this connection point to a vertex attribute
  99856. * @param attributeName defines the attribute name (position, uv, normal, etc...). If not specified it will take the connection point name
  99857. * @returns the current connection point
  99858. */
  99859. setAsAttribute(attributeName?: string): InputBlock;
  99860. /**
  99861. * Set the source of this connection point to a system value
  99862. * @param value define the system value to use (world, view, etc...) or null to switch to manual value
  99863. * @returns the current connection point
  99864. */
  99865. setAsSystemValue(value: Nullable<NodeMaterialSystemValues>): InputBlock;
  99866. /**
  99867. * Gets or sets the value of that point.
  99868. * Please note that this value will be ignored if valueCallback is defined
  99869. */
  99870. get value(): any;
  99871. set value(value: any);
  99872. /**
  99873. * Gets or sets a callback used to get the value of that point.
  99874. * Please note that setting this value will force the connection point to ignore the value property
  99875. */
  99876. get valueCallback(): () => any;
  99877. set valueCallback(value: () => any);
  99878. /**
  99879. * Gets or sets the associated variable name in the shader
  99880. */
  99881. get associatedVariableName(): string;
  99882. set associatedVariableName(value: string);
  99883. /** Gets or sets the type of animation applied to the input */
  99884. get animationType(): AnimatedInputBlockTypes;
  99885. set animationType(value: AnimatedInputBlockTypes);
  99886. /**
  99887. * Gets a boolean indicating that this connection point not defined yet
  99888. */
  99889. get isUndefined(): boolean;
  99890. /**
  99891. * Gets or sets a boolean indicating that this connection point is coming from an uniform.
  99892. * In this case the connection point name must be the name of the uniform to use.
  99893. * Can only be set on inputs
  99894. */
  99895. get isUniform(): boolean;
  99896. set isUniform(value: boolean);
  99897. /**
  99898. * Gets or sets a boolean indicating that this connection point is coming from an attribute.
  99899. * In this case the connection point name must be the name of the attribute to use
  99900. * Can only be set on inputs
  99901. */
  99902. get isAttribute(): boolean;
  99903. set isAttribute(value: boolean);
  99904. /**
  99905. * Gets or sets a boolean indicating that this connection point is generating a varying variable.
  99906. * Can only be set on exit points
  99907. */
  99908. get isVarying(): boolean;
  99909. set isVarying(value: boolean);
  99910. /**
  99911. * Gets a boolean indicating that the current connection point is a system value
  99912. */
  99913. get isSystemValue(): boolean;
  99914. /**
  99915. * Gets or sets the current well known value or null if not defined as a system value
  99916. */
  99917. get systemValue(): Nullable<NodeMaterialSystemValues>;
  99918. set systemValue(value: Nullable<NodeMaterialSystemValues>);
  99919. /**
  99920. * Gets the current class name
  99921. * @returns the class name
  99922. */
  99923. getClassName(): string;
  99924. /**
  99925. * Animate the input if animationType !== None
  99926. * @param scene defines the rendering scene
  99927. */
  99928. animate(scene: Scene): void;
  99929. private _emitDefine;
  99930. initialize(state: NodeMaterialBuildState): void;
  99931. /**
  99932. * Set the input block to its default value (based on its type)
  99933. */
  99934. setDefaultValue(): void;
  99935. private _emitConstant;
  99936. /** @hidden */
  99937. get _noContextSwitch(): boolean;
  99938. private _emit;
  99939. /** @hidden */
  99940. _transmitWorld(effect: Effect, world: Matrix, worldView: Matrix, worldViewProjection: Matrix): void;
  99941. /** @hidden */
  99942. _transmit(effect: Effect, scene: Scene): void;
  99943. protected _buildBlock(state: NodeMaterialBuildState): void;
  99944. protected _dumpPropertiesCode(): string;
  99945. dispose(): void;
  99946. serialize(): any;
  99947. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  99948. }
  99949. }
  99950. declare module BABYLON {
  99951. /**
  99952. * Enum used to define the compatibility state between two connection points
  99953. */
  99954. export enum NodeMaterialConnectionPointCompatibilityStates {
  99955. /** Points are compatibles */
  99956. Compatible = 0,
  99957. /** Points are incompatible because of their types */
  99958. TypeIncompatible = 1,
  99959. /** Points are incompatible because of their targets (vertex vs fragment) */
  99960. TargetIncompatible = 2
  99961. }
  99962. /**
  99963. * Defines the direction of a connection point
  99964. */
  99965. export enum NodeMaterialConnectionPointDirection {
  99966. /** Input */
  99967. Input = 0,
  99968. /** Output */
  99969. Output = 1
  99970. }
  99971. /**
  99972. * Defines a connection point for a block
  99973. */
  99974. export class NodeMaterialConnectionPoint {
  99975. /** @hidden */
  99976. _ownerBlock: NodeMaterialBlock;
  99977. /** @hidden */
  99978. _connectedPoint: Nullable<NodeMaterialConnectionPoint>;
  99979. private _endpoints;
  99980. private _associatedVariableName;
  99981. private _direction;
  99982. /** @hidden */
  99983. _typeConnectionSource: Nullable<NodeMaterialConnectionPoint>;
  99984. /** @hidden */
  99985. _linkedConnectionSource: Nullable<NodeMaterialConnectionPoint>;
  99986. private _type;
  99987. /** @hidden */
  99988. _enforceAssociatedVariableName: boolean;
  99989. /** Gets the direction of the point */
  99990. get direction(): NodeMaterialConnectionPointDirection;
  99991. /** Indicates that this connection point needs dual validation before being connected to another point */
  99992. needDualDirectionValidation: boolean;
  99993. /**
  99994. * Gets or sets the additional types supported by this connection point
  99995. */
  99996. acceptedConnectionPointTypes: NodeMaterialBlockConnectionPointTypes[];
  99997. /**
  99998. * Gets or sets the additional types excluded by this connection point
  99999. */
  100000. excludedConnectionPointTypes: NodeMaterialBlockConnectionPointTypes[];
  100001. /**
  100002. * Observable triggered when this point is connected
  100003. */
  100004. onConnectionObservable: Observable<NodeMaterialConnectionPoint>;
  100005. /**
  100006. * Gets or sets the associated variable name in the shader
  100007. */
  100008. get associatedVariableName(): string;
  100009. set associatedVariableName(value: string);
  100010. /** Get the inner type (ie AutoDetect for instance instead of the inferred one) */
  100011. get innerType(): NodeMaterialBlockConnectionPointTypes;
  100012. /**
  100013. * Gets or sets the connection point type (default is float)
  100014. */
  100015. get type(): NodeMaterialBlockConnectionPointTypes;
  100016. set type(value: NodeMaterialBlockConnectionPointTypes);
  100017. /**
  100018. * Gets or sets the connection point name
  100019. */
  100020. name: string;
  100021. /**
  100022. * Gets or sets the connection point name
  100023. */
  100024. displayName: string;
  100025. /**
  100026. * Gets or sets a boolean indicating that this connection point can be omitted
  100027. */
  100028. isOptional: boolean;
  100029. /**
  100030. * Gets or sets a boolean indicating that this connection point is exposed on a frame
  100031. */
  100032. isExposedOnFrame: boolean;
  100033. /**
  100034. * Gets or sets a string indicating that this uniform must be defined under a #ifdef
  100035. */
  100036. define: string;
  100037. /** @hidden */
  100038. _prioritizeVertex: boolean;
  100039. private _target;
  100040. /** Gets or sets the target of that connection point */
  100041. get target(): NodeMaterialBlockTargets;
  100042. set target(value: NodeMaterialBlockTargets);
  100043. /**
  100044. * Gets a boolean indicating that the current point is connected to another NodeMaterialBlock
  100045. */
  100046. get isConnected(): boolean;
  100047. /**
  100048. * Gets a boolean indicating that the current point is connected to an input block
  100049. */
  100050. get isConnectedToInputBlock(): boolean;
  100051. /**
  100052. * Gets a the connected input block (if any)
  100053. */
  100054. get connectInputBlock(): Nullable<InputBlock>;
  100055. /** Get the other side of the connection (if any) */
  100056. get connectedPoint(): Nullable<NodeMaterialConnectionPoint>;
  100057. /** Get the block that owns this connection point */
  100058. get ownerBlock(): NodeMaterialBlock;
  100059. /** Get the block connected on the other side of this connection (if any) */
  100060. get sourceBlock(): Nullable<NodeMaterialBlock>;
  100061. /** Get the block connected on the endpoints of this connection (if any) */
  100062. get connectedBlocks(): Array<NodeMaterialBlock>;
  100063. /** Gets the list of connected endpoints */
  100064. get endpoints(): NodeMaterialConnectionPoint[];
  100065. /** Gets a boolean indicating if that output point is connected to at least one input */
  100066. get hasEndpoints(): boolean;
  100067. /** Gets a boolean indicating that this connection will be used in the vertex shader */
  100068. get isConnectedInVertexShader(): boolean;
  100069. /** Gets a boolean indicating that this connection will be used in the fragment shader */
  100070. get isConnectedInFragmentShader(): boolean;
  100071. /**
  100072. * Creates a block suitable to be used as an input for this input point.
  100073. * If null is returned, a block based on the point type will be created.
  100074. * @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
  100075. */
  100076. createCustomInputBlock(): Nullable<[NodeMaterialBlock, string]>;
  100077. /**
  100078. * Creates a new connection point
  100079. * @param name defines the connection point name
  100080. * @param ownerBlock defines the block hosting this connection point
  100081. * @param direction defines the direction of the connection point
  100082. */
  100083. constructor(name: string, ownerBlock: NodeMaterialBlock, direction: NodeMaterialConnectionPointDirection);
  100084. /**
  100085. * Gets the current class name e.g. "NodeMaterialConnectionPoint"
  100086. * @returns the class name
  100087. */
  100088. getClassName(): string;
  100089. /**
  100090. * Gets a boolean indicating if the current point can be connected to another point
  100091. * @param connectionPoint defines the other connection point
  100092. * @returns a boolean
  100093. */
  100094. canConnectTo(connectionPoint: NodeMaterialConnectionPoint): boolean;
  100095. /**
  100096. * Gets a number indicating if the current point can be connected to another point
  100097. * @param connectionPoint defines the other connection point
  100098. * @returns a number defining the compatibility state
  100099. */
  100100. checkCompatibilityState(connectionPoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPointCompatibilityStates;
  100101. /**
  100102. * Connect this point to another connection point
  100103. * @param connectionPoint defines the other connection point
  100104. * @param ignoreConstraints defines if the system will ignore connection type constraints (default is false)
  100105. * @returns the current connection point
  100106. */
  100107. connectTo(connectionPoint: NodeMaterialConnectionPoint, ignoreConstraints?: boolean): NodeMaterialConnectionPoint;
  100108. /**
  100109. * Disconnect this point from one of his endpoint
  100110. * @param endpoint defines the other connection point
  100111. * @returns the current connection point
  100112. */
  100113. disconnectFrom(endpoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPoint;
  100114. /**
  100115. * Serializes this point in a JSON representation
  100116. * @param isInput defines if the connection point is an input (default is true)
  100117. * @returns the serialized point object
  100118. */
  100119. serialize(isInput?: boolean): any;
  100120. /**
  100121. * Release resources
  100122. */
  100123. dispose(): void;
  100124. }
  100125. }
  100126. declare module BABYLON {
  100127. /**
  100128. * Enum used to define the material modes
  100129. */
  100130. export enum NodeMaterialModes {
  100131. /** Regular material */
  100132. Material = 0,
  100133. /** For post process */
  100134. PostProcess = 1,
  100135. /** For particle system */
  100136. Particle = 2
  100137. }
  100138. }
  100139. declare module BABYLON {
  100140. /**
  100141. * Block used to read a texture from a sampler
  100142. */
  100143. export class TextureBlock extends NodeMaterialBlock {
  100144. private _defineName;
  100145. private _linearDefineName;
  100146. private _gammaDefineName;
  100147. private _tempTextureRead;
  100148. private _samplerName;
  100149. private _transformedUVName;
  100150. private _textureTransformName;
  100151. private _textureInfoName;
  100152. private _mainUVName;
  100153. private _mainUVDefineName;
  100154. private _fragmentOnly;
  100155. /**
  100156. * Gets or sets the texture associated with the node
  100157. */
  100158. texture: Nullable<Texture>;
  100159. /**
  100160. * Gets or sets a boolean indicating if content needs to be converted to gamma space
  100161. */
  100162. convertToGammaSpace: boolean;
  100163. /**
  100164. * Gets or sets a boolean indicating if content needs to be converted to linear space
  100165. */
  100166. convertToLinearSpace: boolean;
  100167. /**
  100168. * Create a new TextureBlock
  100169. * @param name defines the block name
  100170. */
  100171. constructor(name: string, fragmentOnly?: boolean);
  100172. /**
  100173. * Gets the current class name
  100174. * @returns the class name
  100175. */
  100176. getClassName(): string;
  100177. /**
  100178. * Gets the uv input component
  100179. */
  100180. get uv(): NodeMaterialConnectionPoint;
  100181. /**
  100182. * Gets the rgba output component
  100183. */
  100184. get rgba(): NodeMaterialConnectionPoint;
  100185. /**
  100186. * Gets the rgb output component
  100187. */
  100188. get rgb(): NodeMaterialConnectionPoint;
  100189. /**
  100190. * Gets the r output component
  100191. */
  100192. get r(): NodeMaterialConnectionPoint;
  100193. /**
  100194. * Gets the g output component
  100195. */
  100196. get g(): NodeMaterialConnectionPoint;
  100197. /**
  100198. * Gets the b output component
  100199. */
  100200. get b(): NodeMaterialConnectionPoint;
  100201. /**
  100202. * Gets the a output component
  100203. */
  100204. get a(): NodeMaterialConnectionPoint;
  100205. get target(): NodeMaterialBlockTargets;
  100206. autoConfigure(material: NodeMaterial): void;
  100207. initializeDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  100208. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  100209. isReady(): boolean;
  100210. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  100211. private get _isMixed();
  100212. private _injectVertexCode;
  100213. private _writeTextureRead;
  100214. private _writeOutput;
  100215. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  100216. protected _dumpPropertiesCode(): string;
  100217. serialize(): any;
  100218. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  100219. }
  100220. }
  100221. declare module BABYLON {
  100222. /** @hidden */
  100223. export var reflectionFunction: {
  100224. name: string;
  100225. shader: string;
  100226. };
  100227. }
  100228. declare module BABYLON {
  100229. /**
  100230. * Base block used to read a reflection texture from a sampler
  100231. */
  100232. export abstract class ReflectionTextureBaseBlock extends NodeMaterialBlock {
  100233. /** @hidden */
  100234. _define3DName: string;
  100235. /** @hidden */
  100236. _defineCubicName: string;
  100237. /** @hidden */
  100238. _defineExplicitName: string;
  100239. /** @hidden */
  100240. _defineProjectionName: string;
  100241. /** @hidden */
  100242. _defineLocalCubicName: string;
  100243. /** @hidden */
  100244. _defineSphericalName: string;
  100245. /** @hidden */
  100246. _definePlanarName: string;
  100247. /** @hidden */
  100248. _defineEquirectangularName: string;
  100249. /** @hidden */
  100250. _defineMirroredEquirectangularFixedName: string;
  100251. /** @hidden */
  100252. _defineEquirectangularFixedName: string;
  100253. /** @hidden */
  100254. _defineSkyboxName: string;
  100255. /** @hidden */
  100256. _defineOppositeZ: string;
  100257. /** @hidden */
  100258. _cubeSamplerName: string;
  100259. /** @hidden */
  100260. _2DSamplerName: string;
  100261. protected _positionUVWName: string;
  100262. protected _directionWName: string;
  100263. protected _reflectionVectorName: string;
  100264. /** @hidden */
  100265. _reflectionCoordsName: string;
  100266. /** @hidden */
  100267. _reflectionMatrixName: string;
  100268. protected _reflectionColorName: string;
  100269. /**
  100270. * Gets or sets the texture associated with the node
  100271. */
  100272. texture: Nullable<BaseTexture>;
  100273. /**
  100274. * Create a new ReflectionTextureBaseBlock
  100275. * @param name defines the block name
  100276. */
  100277. constructor(name: string);
  100278. /**
  100279. * Gets the current class name
  100280. * @returns the class name
  100281. */
  100282. getClassName(): string;
  100283. /**
  100284. * Gets the world position input component
  100285. */
  100286. abstract get position(): NodeMaterialConnectionPoint;
  100287. /**
  100288. * Gets the world position input component
  100289. */
  100290. abstract get worldPosition(): NodeMaterialConnectionPoint;
  100291. /**
  100292. * Gets the world normal input component
  100293. */
  100294. abstract get worldNormal(): NodeMaterialConnectionPoint;
  100295. /**
  100296. * Gets the world input component
  100297. */
  100298. abstract get world(): NodeMaterialConnectionPoint;
  100299. /**
  100300. * Gets the camera (or eye) position component
  100301. */
  100302. abstract get cameraPosition(): NodeMaterialConnectionPoint;
  100303. /**
  100304. * Gets the view input component
  100305. */
  100306. abstract get view(): NodeMaterialConnectionPoint;
  100307. protected _getTexture(): Nullable<BaseTexture>;
  100308. autoConfigure(material: NodeMaterial): void;
  100309. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  100310. isReady(): boolean;
  100311. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  100312. /**
  100313. * Gets the code to inject in the vertex shader
  100314. * @param state current state of the node material building
  100315. * @returns the shader code
  100316. */
  100317. handleVertexSide(state: NodeMaterialBuildState): string;
  100318. /**
  100319. * Handles the inits for the fragment code path
  100320. * @param state node material build state
  100321. */
  100322. handleFragmentSideInits(state: NodeMaterialBuildState): void;
  100323. /**
  100324. * Generates the reflection coords code for the fragment code path
  100325. * @param worldNormalVarName name of the world normal variable
  100326. * @param worldPos name of the world position variable. If not provided, will use the world position connected to this block
  100327. * @param onlyReflectionVector if true, generates code only for the reflection vector computation, not for the reflection coordinates
  100328. * @returns the shader code
  100329. */
  100330. handleFragmentSideCodeReflectionCoords(worldNormalVarName: string, worldPos?: string, onlyReflectionVector?: boolean): string;
  100331. /**
  100332. * Generates the reflection color code for the fragment code path
  100333. * @param lodVarName name of the lod variable
  100334. * @param swizzleLookupTexture swizzle to use for the final color variable
  100335. * @returns the shader code
  100336. */
  100337. handleFragmentSideCodeReflectionColor(lodVarName?: string, swizzleLookupTexture?: string): string;
  100338. /**
  100339. * Generates the code corresponding to the connected output points
  100340. * @param state node material build state
  100341. * @param varName name of the variable to output
  100342. * @returns the shader code
  100343. */
  100344. writeOutputs(state: NodeMaterialBuildState, varName: string): string;
  100345. protected _buildBlock(state: NodeMaterialBuildState): this;
  100346. protected _dumpPropertiesCode(): string;
  100347. serialize(): any;
  100348. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  100349. }
  100350. }
  100351. declare module BABYLON {
  100352. /**
  100353. * Defines a connection point to be used for points with a custom object type
  100354. */
  100355. export class NodeMaterialConnectionPointCustomObject<T extends NodeMaterialBlock> extends NodeMaterialConnectionPoint {
  100356. private _blockType;
  100357. private _blockName;
  100358. private _nameForCheking?;
  100359. /**
  100360. * Creates a new connection point
  100361. * @param name defines the connection point name
  100362. * @param ownerBlock defines the block hosting this connection point
  100363. * @param direction defines the direction of the connection point
  100364. */
  100365. constructor(name: string, ownerBlock: NodeMaterialBlock, direction: NodeMaterialConnectionPointDirection, _blockType: new (...args: any[]) => T, _blockName: string, _nameForCheking?: string | undefined);
  100366. /**
  100367. * Gets a number indicating if the current point can be connected to another point
  100368. * @param connectionPoint defines the other connection point
  100369. * @returns a number defining the compatibility state
  100370. */
  100371. checkCompatibilityState(connectionPoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPointCompatibilityStates;
  100372. /**
  100373. * Creates a block suitable to be used as an input for this input point.
  100374. * If null is returned, a block based on the point type will be created.
  100375. * @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
  100376. */
  100377. createCustomInputBlock(): Nullable<[NodeMaterialBlock, string]>;
  100378. }
  100379. }
  100380. declare module BABYLON {
  100381. /**
  100382. * Enum defining the type of properties that can be edited in the property pages in the NME
  100383. */
  100384. export enum PropertyTypeForEdition {
  100385. /** property is a boolean */
  100386. Boolean = 0,
  100387. /** property is a float */
  100388. Float = 1,
  100389. /** property is a Vector2 */
  100390. Vector2 = 2,
  100391. /** property is a list of values */
  100392. List = 3
  100393. }
  100394. /**
  100395. * Interface that defines an option in a variable of type list
  100396. */
  100397. export interface IEditablePropertyListOption {
  100398. /** label of the option */
  100399. "label": string;
  100400. /** value of the option */
  100401. "value": number;
  100402. }
  100403. /**
  100404. * Interface that defines the options available for an editable property
  100405. */
  100406. export interface IEditablePropertyOption {
  100407. /** min value */
  100408. "min"?: number;
  100409. /** max value */
  100410. "max"?: number;
  100411. /** notifiers: indicates which actions to take when the property is changed */
  100412. "notifiers"?: {
  100413. /** the material should be rebuilt */
  100414. "rebuild"?: boolean;
  100415. /** the preview should be updated */
  100416. "update"?: boolean;
  100417. };
  100418. /** list of the options for a variable of type list */
  100419. "options"?: IEditablePropertyListOption[];
  100420. }
  100421. /**
  100422. * Interface that describes an editable property
  100423. */
  100424. export interface IPropertyDescriptionForEdition {
  100425. /** name of the property */
  100426. "propertyName": string;
  100427. /** display name of the property */
  100428. "displayName": string;
  100429. /** type of the property */
  100430. "type": PropertyTypeForEdition;
  100431. /** group of the property - all properties with the same group value will be displayed in a specific section */
  100432. "groupName": string;
  100433. /** options for the property */
  100434. "options": IEditablePropertyOption;
  100435. }
  100436. /**
  100437. * Decorator that flags a property in a node material block as being editable
  100438. */
  100439. export function editableInPropertyPage(displayName: string, propertyType?: PropertyTypeForEdition, groupName?: string, options?: IEditablePropertyOption): (target: any, propertyKey: string) => void;
  100440. }
  100441. declare module BABYLON {
  100442. /**
  100443. * Block used to implement the refraction part of the sub surface module of the PBR material
  100444. */
  100445. export class RefractionBlock extends NodeMaterialBlock {
  100446. /** @hidden */
  100447. _define3DName: string;
  100448. /** @hidden */
  100449. _refractionMatrixName: string;
  100450. /** @hidden */
  100451. _defineLODRefractionAlpha: string;
  100452. /** @hidden */
  100453. _defineLinearSpecularRefraction: string;
  100454. /** @hidden */
  100455. _defineOppositeZ: string;
  100456. /** @hidden */
  100457. _cubeSamplerName: string;
  100458. /** @hidden */
  100459. _2DSamplerName: string;
  100460. /** @hidden */
  100461. _vRefractionMicrosurfaceInfosName: string;
  100462. /** @hidden */
  100463. _vRefractionInfosName: string;
  100464. private _scene;
  100465. /**
  100466. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  100467. * Materials half opaque for instance using refraction could benefit from this control.
  100468. */
  100469. linkRefractionWithTransparency: boolean;
  100470. /**
  100471. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  100472. */
  100473. invertRefractionY: boolean;
  100474. /**
  100475. * Gets or sets the texture associated with the node
  100476. */
  100477. texture: Nullable<BaseTexture>;
  100478. /**
  100479. * Create a new RefractionBlock
  100480. * @param name defines the block name
  100481. */
  100482. constructor(name: string);
  100483. /**
  100484. * Gets the current class name
  100485. * @returns the class name
  100486. */
  100487. getClassName(): string;
  100488. /**
  100489. * Gets the intensity input component
  100490. */
  100491. get intensity(): NodeMaterialConnectionPoint;
  100492. /**
  100493. * Gets the index of refraction input component
  100494. */
  100495. get indexOfRefraction(): NodeMaterialConnectionPoint;
  100496. /**
  100497. * Gets the tint at distance input component
  100498. */
  100499. get tintAtDistance(): NodeMaterialConnectionPoint;
  100500. /**
  100501. * Gets the view input component
  100502. */
  100503. get view(): NodeMaterialConnectionPoint;
  100504. /**
  100505. * Gets the refraction object output component
  100506. */
  100507. get refraction(): NodeMaterialConnectionPoint;
  100508. /**
  100509. * Returns true if the block has a texture
  100510. */
  100511. get hasTexture(): boolean;
  100512. protected _getTexture(): Nullable<BaseTexture>;
  100513. autoConfigure(material: NodeMaterial): void;
  100514. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  100515. isReady(): boolean;
  100516. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  100517. /**
  100518. * Gets the main code of the block (fragment side)
  100519. * @param state current state of the node material building
  100520. * @returns the shader code
  100521. */
  100522. getCode(state: NodeMaterialBuildState): string;
  100523. protected _buildBlock(state: NodeMaterialBuildState): this;
  100524. protected _dumpPropertiesCode(): string;
  100525. serialize(): any;
  100526. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  100527. }
  100528. }
  100529. declare module BABYLON {
  100530. /**
  100531. * Base block used as input for post process
  100532. */
  100533. export class CurrentScreenBlock extends NodeMaterialBlock {
  100534. private _samplerName;
  100535. private _linearDefineName;
  100536. private _gammaDefineName;
  100537. private _mainUVName;
  100538. private _tempTextureRead;
  100539. /**
  100540. * Gets or sets the texture associated with the node
  100541. */
  100542. texture: Nullable<BaseTexture>;
  100543. /**
  100544. * Gets or sets a boolean indicating if content needs to be converted to gamma space
  100545. */
  100546. convertToGammaSpace: boolean;
  100547. /**
  100548. * Gets or sets a boolean indicating if content needs to be converted to linear space
  100549. */
  100550. convertToLinearSpace: boolean;
  100551. /**
  100552. * Create a new CurrentScreenBlock
  100553. * @param name defines the block name
  100554. */
  100555. constructor(name: string);
  100556. /**
  100557. * Gets the current class name
  100558. * @returns the class name
  100559. */
  100560. getClassName(): string;
  100561. /**
  100562. * Gets the uv input component
  100563. */
  100564. get uv(): NodeMaterialConnectionPoint;
  100565. /**
  100566. * Gets the rgba output component
  100567. */
  100568. get rgba(): NodeMaterialConnectionPoint;
  100569. /**
  100570. * Gets the rgb output component
  100571. */
  100572. get rgb(): NodeMaterialConnectionPoint;
  100573. /**
  100574. * Gets the r output component
  100575. */
  100576. get r(): NodeMaterialConnectionPoint;
  100577. /**
  100578. * Gets the g output component
  100579. */
  100580. get g(): NodeMaterialConnectionPoint;
  100581. /**
  100582. * Gets the b output component
  100583. */
  100584. get b(): NodeMaterialConnectionPoint;
  100585. /**
  100586. * Gets the a output component
  100587. */
  100588. get a(): NodeMaterialConnectionPoint;
  100589. /**
  100590. * Initialize the block and prepare the context for build
  100591. * @param state defines the state that will be used for the build
  100592. */
  100593. initialize(state: NodeMaterialBuildState): void;
  100594. get target(): NodeMaterialBlockTargets;
  100595. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  100596. isReady(): boolean;
  100597. private _injectVertexCode;
  100598. private _writeTextureRead;
  100599. private _writeOutput;
  100600. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  100601. serialize(): any;
  100602. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  100603. }
  100604. }
  100605. declare module BABYLON {
  100606. /**
  100607. * Base block used for the particle texture
  100608. */
  100609. export class ParticleTextureBlock extends NodeMaterialBlock {
  100610. private _samplerName;
  100611. private _linearDefineName;
  100612. private _gammaDefineName;
  100613. private _tempTextureRead;
  100614. /**
  100615. * Gets or sets the texture associated with the node
  100616. */
  100617. texture: Nullable<BaseTexture>;
  100618. /**
  100619. * Gets or sets a boolean indicating if content needs to be converted to gamma space
  100620. */
  100621. convertToGammaSpace: boolean;
  100622. /**
  100623. * Gets or sets a boolean indicating if content needs to be converted to linear space
  100624. */
  100625. convertToLinearSpace: boolean;
  100626. /**
  100627. * Create a new ParticleTextureBlock
  100628. * @param name defines the block name
  100629. */
  100630. constructor(name: string);
  100631. /**
  100632. * Gets the current class name
  100633. * @returns the class name
  100634. */
  100635. getClassName(): string;
  100636. /**
  100637. * Gets the uv input component
  100638. */
  100639. get uv(): NodeMaterialConnectionPoint;
  100640. /**
  100641. * Gets the rgba output component
  100642. */
  100643. get rgba(): NodeMaterialConnectionPoint;
  100644. /**
  100645. * Gets the rgb output component
  100646. */
  100647. get rgb(): NodeMaterialConnectionPoint;
  100648. /**
  100649. * Gets the r output component
  100650. */
  100651. get r(): NodeMaterialConnectionPoint;
  100652. /**
  100653. * Gets the g output component
  100654. */
  100655. get g(): NodeMaterialConnectionPoint;
  100656. /**
  100657. * Gets the b output component
  100658. */
  100659. get b(): NodeMaterialConnectionPoint;
  100660. /**
  100661. * Gets the a output component
  100662. */
  100663. get a(): NodeMaterialConnectionPoint;
  100664. /**
  100665. * Initialize the block and prepare the context for build
  100666. * @param state defines the state that will be used for the build
  100667. */
  100668. initialize(state: NodeMaterialBuildState): void;
  100669. autoConfigure(material: NodeMaterial): void;
  100670. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  100671. isReady(): boolean;
  100672. private _writeOutput;
  100673. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  100674. serialize(): any;
  100675. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  100676. }
  100677. }
  100678. declare module BABYLON {
  100679. /**
  100680. * Class used to store shared data between 2 NodeMaterialBuildState
  100681. */
  100682. export class NodeMaterialBuildStateSharedData {
  100683. /**
  100684. * Gets the list of emitted varyings
  100685. */
  100686. temps: string[];
  100687. /**
  100688. * Gets the list of emitted varyings
  100689. */
  100690. varyings: string[];
  100691. /**
  100692. * Gets the varying declaration string
  100693. */
  100694. varyingDeclaration: string;
  100695. /**
  100696. * Input blocks
  100697. */
  100698. inputBlocks: InputBlock[];
  100699. /**
  100700. * Input blocks
  100701. */
  100702. textureBlocks: (TextureBlock | ReflectionTextureBaseBlock | RefractionBlock | CurrentScreenBlock | ParticleTextureBlock)[];
  100703. /**
  100704. * Bindable blocks (Blocks that need to set data to the effect)
  100705. */
  100706. bindableBlocks: NodeMaterialBlock[];
  100707. /**
  100708. * List of blocks that can provide a compilation fallback
  100709. */
  100710. blocksWithFallbacks: NodeMaterialBlock[];
  100711. /**
  100712. * List of blocks that can provide a define update
  100713. */
  100714. blocksWithDefines: NodeMaterialBlock[];
  100715. /**
  100716. * List of blocks that can provide a repeatable content
  100717. */
  100718. repeatableContentBlocks: NodeMaterialBlock[];
  100719. /**
  100720. * List of blocks that can provide a dynamic list of uniforms
  100721. */
  100722. dynamicUniformBlocks: NodeMaterialBlock[];
  100723. /**
  100724. * List of blocks that can block the isReady function for the material
  100725. */
  100726. blockingBlocks: NodeMaterialBlock[];
  100727. /**
  100728. * Gets the list of animated inputs
  100729. */
  100730. animatedInputs: InputBlock[];
  100731. /**
  100732. * Build Id used to avoid multiple recompilations
  100733. */
  100734. buildId: number;
  100735. /** List of emitted variables */
  100736. variableNames: {
  100737. [key: string]: number;
  100738. };
  100739. /** List of emitted defines */
  100740. defineNames: {
  100741. [key: string]: number;
  100742. };
  100743. /** Should emit comments? */
  100744. emitComments: boolean;
  100745. /** Emit build activity */
  100746. verbose: boolean;
  100747. /** Gets or sets the hosting scene */
  100748. scene: Scene;
  100749. /**
  100750. * Gets the compilation hints emitted at compilation time
  100751. */
  100752. hints: {
  100753. needWorldViewMatrix: boolean;
  100754. needWorldViewProjectionMatrix: boolean;
  100755. needAlphaBlending: boolean;
  100756. needAlphaTesting: boolean;
  100757. };
  100758. /**
  100759. * List of compilation checks
  100760. */
  100761. checks: {
  100762. emitVertex: boolean;
  100763. emitFragment: boolean;
  100764. notConnectedNonOptionalInputs: NodeMaterialConnectionPoint[];
  100765. };
  100766. /**
  100767. * Is vertex program allowed to be empty?
  100768. */
  100769. allowEmptyVertexProgram: boolean;
  100770. /** Creates a new shared data */
  100771. constructor();
  100772. /**
  100773. * Emits console errors and exceptions if there is a failing check
  100774. */
  100775. emitErrors(): void;
  100776. }
  100777. }
  100778. declare module BABYLON {
  100779. /**
  100780. * Class used to store node based material build state
  100781. */
  100782. export class NodeMaterialBuildState {
  100783. /** Gets or sets a boolean indicating if the current state can emit uniform buffers */
  100784. supportUniformBuffers: boolean;
  100785. /**
  100786. * Gets the list of emitted attributes
  100787. */
  100788. attributes: string[];
  100789. /**
  100790. * Gets the list of emitted uniforms
  100791. */
  100792. uniforms: string[];
  100793. /**
  100794. * Gets the list of emitted constants
  100795. */
  100796. constants: string[];
  100797. /**
  100798. * Gets the list of emitted samplers
  100799. */
  100800. samplers: string[];
  100801. /**
  100802. * Gets the list of emitted functions
  100803. */
  100804. functions: {
  100805. [key: string]: string;
  100806. };
  100807. /**
  100808. * Gets the list of emitted extensions
  100809. */
  100810. extensions: {
  100811. [key: string]: string;
  100812. };
  100813. /**
  100814. * Gets the target of the compilation state
  100815. */
  100816. target: NodeMaterialBlockTargets;
  100817. /**
  100818. * Gets the list of emitted counters
  100819. */
  100820. counters: {
  100821. [key: string]: number;
  100822. };
  100823. /**
  100824. * Shared data between multiple NodeMaterialBuildState instances
  100825. */
  100826. sharedData: NodeMaterialBuildStateSharedData;
  100827. /** @hidden */
  100828. _vertexState: NodeMaterialBuildState;
  100829. /** @hidden */
  100830. _attributeDeclaration: string;
  100831. /** @hidden */
  100832. _uniformDeclaration: string;
  100833. /** @hidden */
  100834. _constantDeclaration: string;
  100835. /** @hidden */
  100836. _samplerDeclaration: string;
  100837. /** @hidden */
  100838. _varyingTransfer: string;
  100839. /** @hidden */
  100840. _injectAtEnd: string;
  100841. private _repeatableContentAnchorIndex;
  100842. /** @hidden */
  100843. _builtCompilationString: string;
  100844. /**
  100845. * Gets the emitted compilation strings
  100846. */
  100847. compilationString: string;
  100848. /**
  100849. * Finalize the compilation strings
  100850. * @param state defines the current compilation state
  100851. */
  100852. finalize(state: NodeMaterialBuildState): void;
  100853. /** @hidden */
  100854. get _repeatableContentAnchor(): string;
  100855. /** @hidden */
  100856. _getFreeVariableName(prefix: string): string;
  100857. /** @hidden */
  100858. _getFreeDefineName(prefix: string): string;
  100859. /** @hidden */
  100860. _excludeVariableName(name: string): void;
  100861. /** @hidden */
  100862. _emit2DSampler(name: string): void;
  100863. /** @hidden */
  100864. _getGLType(type: NodeMaterialBlockConnectionPointTypes): string;
  100865. /** @hidden */
  100866. _emitExtension(name: string, extension: string, define?: string): void;
  100867. /** @hidden */
  100868. _emitFunction(name: string, code: string, comments: string): void;
  100869. /** @hidden */
  100870. _emitCodeFromInclude(includeName: string, comments: string, options?: {
  100871. replaceStrings?: {
  100872. search: RegExp;
  100873. replace: string;
  100874. }[];
  100875. repeatKey?: string;
  100876. }): string;
  100877. /** @hidden */
  100878. _emitFunctionFromInclude(includeName: string, comments: string, options?: {
  100879. repeatKey?: string;
  100880. removeAttributes?: boolean;
  100881. removeUniforms?: boolean;
  100882. removeVaryings?: boolean;
  100883. removeIfDef?: boolean;
  100884. replaceStrings?: {
  100885. search: RegExp;
  100886. replace: string;
  100887. }[];
  100888. }, storeKey?: string): void;
  100889. /** @hidden */
  100890. _registerTempVariable(name: string): boolean;
  100891. /** @hidden */
  100892. _emitVaryingFromString(name: string, type: string, define?: string, notDefine?: boolean): boolean;
  100893. /** @hidden */
  100894. _emitUniformFromString(name: string, type: string, define?: string, notDefine?: boolean): void;
  100895. /** @hidden */
  100896. _emitFloat(value: number): string;
  100897. }
  100898. }
  100899. declare module BABYLON {
  100900. /**
  100901. * Helper class used to generate session unique ID
  100902. */
  100903. export class UniqueIdGenerator {
  100904. private static _UniqueIdCounter;
  100905. /**
  100906. * Gets an unique (relatively to the current scene) Id
  100907. */
  100908. static get UniqueId(): number;
  100909. }
  100910. }
  100911. declare module BABYLON {
  100912. /**
  100913. * Defines a block that can be used inside a node based material
  100914. */
  100915. export class NodeMaterialBlock {
  100916. private _buildId;
  100917. private _buildTarget;
  100918. private _target;
  100919. private _isFinalMerger;
  100920. private _isInput;
  100921. private _name;
  100922. protected _isUnique: boolean;
  100923. /** Gets or sets a boolean indicating that only one input can be connected at a time */
  100924. inputsAreExclusive: boolean;
  100925. /** @hidden */
  100926. _codeVariableName: string;
  100927. /** @hidden */
  100928. _inputs: NodeMaterialConnectionPoint[];
  100929. /** @hidden */
  100930. _outputs: NodeMaterialConnectionPoint[];
  100931. /** @hidden */
  100932. _preparationId: number;
  100933. /**
  100934. * Gets the name of the block
  100935. */
  100936. get name(): string;
  100937. /**
  100938. * Sets the name of the block. Will check if the name is valid.
  100939. */
  100940. set name(newName: string);
  100941. /**
  100942. * Gets or sets the unique id of the node
  100943. */
  100944. uniqueId: number;
  100945. /**
  100946. * Gets or sets the comments associated with this block
  100947. */
  100948. comments: string;
  100949. /**
  100950. * Gets a boolean indicating that this block can only be used once per NodeMaterial
  100951. */
  100952. get isUnique(): boolean;
  100953. /**
  100954. * Gets a boolean indicating that this block is an end block (e.g. it is generating a system value)
  100955. */
  100956. get isFinalMerger(): boolean;
  100957. /**
  100958. * Gets a boolean indicating that this block is an input (e.g. it sends data to the shader)
  100959. */
  100960. get isInput(): boolean;
  100961. /**
  100962. * Gets or sets the build Id
  100963. */
  100964. get buildId(): number;
  100965. set buildId(value: number);
  100966. /**
  100967. * Gets or sets the target of the block
  100968. */
  100969. get target(): NodeMaterialBlockTargets;
  100970. set target(value: NodeMaterialBlockTargets);
  100971. /**
  100972. * Gets the list of input points
  100973. */
  100974. get inputs(): NodeMaterialConnectionPoint[];
  100975. /** Gets the list of output points */
  100976. get outputs(): NodeMaterialConnectionPoint[];
  100977. /**
  100978. * Find an input by its name
  100979. * @param name defines the name of the input to look for
  100980. * @returns the input or null if not found
  100981. */
  100982. getInputByName(name: string): Nullable<NodeMaterialConnectionPoint>;
  100983. /**
  100984. * Find an output by its name
  100985. * @param name defines the name of the outputto look for
  100986. * @returns the output or null if not found
  100987. */
  100988. getOutputByName(name: string): Nullable<NodeMaterialConnectionPoint>;
  100989. /**
  100990. * Creates a new NodeMaterialBlock
  100991. * @param name defines the block name
  100992. * @param target defines the target of that block (Vertex by default)
  100993. * @param isFinalMerger defines a boolean indicating that this block is an end block (e.g. it is generating a system value). Default is false
  100994. * @param isInput defines a boolean indicating that this block is an input (e.g. it sends data to the shader). Default is false
  100995. */
  100996. constructor(name: string, target?: NodeMaterialBlockTargets, isFinalMerger?: boolean, isInput?: boolean);
  100997. /**
  100998. * Initialize the block and prepare the context for build
  100999. * @param state defines the state that will be used for the build
  101000. */
  101001. initialize(state: NodeMaterialBuildState): void;
  101002. /**
  101003. * Bind data to effect. Will only be called for blocks with isBindable === true
  101004. * @param effect defines the effect to bind data to
  101005. * @param nodeMaterial defines the hosting NodeMaterial
  101006. * @param mesh defines the mesh that will be rendered
  101007. * @param subMesh defines the submesh that will be rendered
  101008. */
  101009. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  101010. protected _declareOutput(output: NodeMaterialConnectionPoint, state: NodeMaterialBuildState): string;
  101011. protected _writeVariable(currentPoint: NodeMaterialConnectionPoint): string;
  101012. protected _writeFloat(value: number): string;
  101013. /**
  101014. * Gets the current class name e.g. "NodeMaterialBlock"
  101015. * @returns the class name
  101016. */
  101017. getClassName(): string;
  101018. /**
  101019. * Register a new input. Must be called inside a block constructor
  101020. * @param name defines the connection point name
  101021. * @param type defines the connection point type
  101022. * @param isOptional defines a boolean indicating that this input can be omitted
  101023. * @param target defines the target to use to limit the connection point (will be VertexAndFragment by default)
  101024. * @param point an already created connection point. If not provided, create a new one
  101025. * @returns the current block
  101026. */
  101027. registerInput(name: string, type: NodeMaterialBlockConnectionPointTypes, isOptional?: boolean, target?: NodeMaterialBlockTargets, point?: NodeMaterialConnectionPoint): this;
  101028. /**
  101029. * Register a new output. Must be called inside a block constructor
  101030. * @param name defines the connection point name
  101031. * @param type defines the connection point type
  101032. * @param target defines the target to use to limit the connection point (will be VertexAndFragment by default)
  101033. * @param point an already created connection point. If not provided, create a new one
  101034. * @returns the current block
  101035. */
  101036. registerOutput(name: string, type: NodeMaterialBlockConnectionPointTypes, target?: NodeMaterialBlockTargets, point?: NodeMaterialConnectionPoint): this;
  101037. /**
  101038. * Will return the first available input e.g. the first one which is not an uniform or an attribute
  101039. * @param forOutput defines an optional connection point to check compatibility with
  101040. * @returns the first available input or null
  101041. */
  101042. getFirstAvailableInput(forOutput?: Nullable<NodeMaterialConnectionPoint>): Nullable<NodeMaterialConnectionPoint>;
  101043. /**
  101044. * Will return the first available output e.g. the first one which is not yet connected and not a varying
  101045. * @param forBlock defines an optional block to check compatibility with
  101046. * @returns the first available input or null
  101047. */
  101048. getFirstAvailableOutput(forBlock?: Nullable<NodeMaterialBlock>): Nullable<NodeMaterialConnectionPoint>;
  101049. /**
  101050. * Gets the sibling of the given output
  101051. * @param current defines the current output
  101052. * @returns the next output in the list or null
  101053. */
  101054. getSiblingOutput(current: NodeMaterialConnectionPoint): Nullable<NodeMaterialConnectionPoint>;
  101055. /**
  101056. * Connect current block with another block
  101057. * @param other defines the block to connect with
  101058. * @param options define the various options to help pick the right connections
  101059. * @returns the current block
  101060. */
  101061. connectTo(other: NodeMaterialBlock, options?: {
  101062. input?: string;
  101063. output?: string;
  101064. outputSwizzle?: string;
  101065. }): this | undefined;
  101066. protected _buildBlock(state: NodeMaterialBuildState): void;
  101067. /**
  101068. * Add uniforms, samplers and uniform buffers at compilation time
  101069. * @param state defines the state to update
  101070. * @param nodeMaterial defines the node material requesting the update
  101071. * @param defines defines the material defines to update
  101072. * @param uniformBuffers defines the list of uniform buffer names
  101073. */
  101074. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  101075. /**
  101076. * Add potential fallbacks if shader compilation fails
  101077. * @param mesh defines the mesh to be rendered
  101078. * @param fallbacks defines the current prioritized list of fallbacks
  101079. */
  101080. provideFallbacks(mesh: AbstractMesh, fallbacks: EffectFallbacks): void;
  101081. /**
  101082. * Initialize defines for shader compilation
  101083. * @param mesh defines the mesh to be rendered
  101084. * @param nodeMaterial defines the node material requesting the update
  101085. * @param defines defines the material defines to update
  101086. * @param useInstances specifies that instances should be used
  101087. */
  101088. initializeDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  101089. /**
  101090. * Update defines for shader compilation
  101091. * @param mesh defines the mesh to be rendered
  101092. * @param nodeMaterial defines the node material requesting the update
  101093. * @param defines defines the material defines to update
  101094. * @param useInstances specifies that instances should be used
  101095. * @param subMesh defines which submesh to render
  101096. */
  101097. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  101098. /**
  101099. * Lets the block try to connect some inputs automatically
  101100. * @param material defines the hosting NodeMaterial
  101101. */
  101102. autoConfigure(material: NodeMaterial): void;
  101103. /**
  101104. * Function called when a block is declared as repeatable content generator
  101105. * @param vertexShaderState defines the current compilation state for the vertex shader
  101106. * @param fragmentShaderState defines the current compilation state for the fragment shader
  101107. * @param mesh defines the mesh to be rendered
  101108. * @param defines defines the material defines to update
  101109. */
  101110. replaceRepeatableContent(vertexShaderState: NodeMaterialBuildState, fragmentShaderState: NodeMaterialBuildState, mesh: AbstractMesh, defines: NodeMaterialDefines): void;
  101111. /**
  101112. * Checks if the block is ready
  101113. * @param mesh defines the mesh to be rendered
  101114. * @param nodeMaterial defines the node material requesting the update
  101115. * @param defines defines the material defines to update
  101116. * @param useInstances specifies that instances should be used
  101117. * @returns true if the block is ready
  101118. */
  101119. isReady(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): boolean;
  101120. protected _linkConnectionTypes(inputIndex0: number, inputIndex1: number): void;
  101121. private _processBuild;
  101122. /**
  101123. * Validates the new name for the block node.
  101124. * @param newName the new name to be given to the node.
  101125. * @returns false if the name is a reserve word, else true.
  101126. */
  101127. validateBlockName(newName: string): boolean;
  101128. /**
  101129. * Compile the current node and generate the shader code
  101130. * @param state defines the current compilation state (uniforms, samplers, current string)
  101131. * @param activeBlocks defines the list of active blocks (i.e. blocks to compile)
  101132. * @returns true if already built
  101133. */
  101134. build(state: NodeMaterialBuildState, activeBlocks: NodeMaterialBlock[]): boolean;
  101135. protected _inputRename(name: string): string;
  101136. protected _outputRename(name: string): string;
  101137. protected _dumpPropertiesCode(): string;
  101138. /** @hidden */
  101139. _dumpCode(uniqueNames: string[], alreadyDumped: NodeMaterialBlock[]): string;
  101140. /** @hidden */
  101141. _dumpCodeForOutputConnections(alreadyDumped: NodeMaterialBlock[]): string;
  101142. /**
  101143. * Clone the current block to a new identical block
  101144. * @param scene defines the hosting scene
  101145. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  101146. * @returns a copy of the current block
  101147. */
  101148. clone(scene: Scene, rootUrl?: string): Nullable<NodeMaterialBlock>;
  101149. /**
  101150. * Serializes this block in a JSON representation
  101151. * @returns the serialized block object
  101152. */
  101153. serialize(): any;
  101154. /** @hidden */
  101155. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  101156. private _deserializePortDisplayNamesAndExposedOnFrame;
  101157. /**
  101158. * Release resources
  101159. */
  101160. dispose(): void;
  101161. }
  101162. }
  101163. declare module BABYLON {
  101164. /**
  101165. * Base class of materials working in push mode in babylon JS
  101166. * @hidden
  101167. */
  101168. export class PushMaterial extends Material {
  101169. protected _activeEffect: Effect;
  101170. protected _normalMatrix: Matrix;
  101171. constructor(name: string, scene: Scene);
  101172. getEffect(): Effect;
  101173. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  101174. protected _isReadyForSubMesh(subMesh: SubMesh): boolean;
  101175. /**
  101176. * Binds the given world matrix to the active effect
  101177. *
  101178. * @param world the matrix to bind
  101179. */
  101180. bindOnlyWorldMatrix(world: Matrix): void;
  101181. /**
  101182. * Binds the given normal matrix to the active effect
  101183. *
  101184. * @param normalMatrix the matrix to bind
  101185. */
  101186. bindOnlyNormalMatrix(normalMatrix: Matrix): void;
  101187. bind(world: Matrix, mesh?: Mesh): void;
  101188. protected _afterBind(mesh: Mesh, effect?: Nullable<Effect>): void;
  101189. protected _mustRebind(scene: Scene, effect: Effect, visibility?: number): boolean;
  101190. }
  101191. }
  101192. declare module BABYLON {
  101193. /**
  101194. * Root class for all node material optimizers
  101195. */
  101196. export class NodeMaterialOptimizer {
  101197. /**
  101198. * Function used to optimize a NodeMaterial graph
  101199. * @param vertexOutputNodes defines the list of output nodes for the vertex shader
  101200. * @param fragmentOutputNodes defines the list of output nodes for the fragment shader
  101201. */
  101202. optimize(vertexOutputNodes: NodeMaterialBlock[], fragmentOutputNodes: NodeMaterialBlock[]): void;
  101203. }
  101204. }
  101205. declare module BABYLON {
  101206. /**
  101207. * Block used to transform a vector (2, 3 or 4) with a matrix. It will generate a Vector4
  101208. */
  101209. export class TransformBlock extends NodeMaterialBlock {
  101210. /**
  101211. * Defines the value to use to complement W value to transform it to a Vector4
  101212. */
  101213. complementW: number;
  101214. /**
  101215. * Defines the value to use to complement z value to transform it to a Vector4
  101216. */
  101217. complementZ: number;
  101218. /**
  101219. * Creates a new TransformBlock
  101220. * @param name defines the block name
  101221. */
  101222. constructor(name: string);
  101223. /**
  101224. * Gets the current class name
  101225. * @returns the class name
  101226. */
  101227. getClassName(): string;
  101228. /**
  101229. * Gets the vector input
  101230. */
  101231. get vector(): NodeMaterialConnectionPoint;
  101232. /**
  101233. * Gets the output component
  101234. */
  101235. get output(): NodeMaterialConnectionPoint;
  101236. /**
  101237. * Gets the xyz output component
  101238. */
  101239. get xyz(): NodeMaterialConnectionPoint;
  101240. /**
  101241. * Gets the matrix transform input
  101242. */
  101243. get transform(): NodeMaterialConnectionPoint;
  101244. protected _buildBlock(state: NodeMaterialBuildState): this;
  101245. /**
  101246. * Update defines for shader compilation
  101247. * @param mesh defines the mesh to be rendered
  101248. * @param nodeMaterial defines the node material requesting the update
  101249. * @param defines defines the material defines to update
  101250. * @param useInstances specifies that instances should be used
  101251. * @param subMesh defines which submesh to render
  101252. */
  101253. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  101254. serialize(): any;
  101255. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  101256. protected _dumpPropertiesCode(): string;
  101257. }
  101258. }
  101259. declare module BABYLON {
  101260. /**
  101261. * Block used to output the vertex position
  101262. */
  101263. export class VertexOutputBlock extends NodeMaterialBlock {
  101264. /**
  101265. * Creates a new VertexOutputBlock
  101266. * @param name defines the block name
  101267. */
  101268. constructor(name: string);
  101269. /**
  101270. * Gets the current class name
  101271. * @returns the class name
  101272. */
  101273. getClassName(): string;
  101274. /**
  101275. * Gets the vector input component
  101276. */
  101277. get vector(): NodeMaterialConnectionPoint;
  101278. protected _buildBlock(state: NodeMaterialBuildState): this;
  101279. }
  101280. }
  101281. declare module BABYLON {
  101282. /**
  101283. * Block used to output the final color
  101284. */
  101285. export class FragmentOutputBlock extends NodeMaterialBlock {
  101286. /**
  101287. * Create a new FragmentOutputBlock
  101288. * @param name defines the block name
  101289. */
  101290. constructor(name: string);
  101291. /**
  101292. * Gets the current class name
  101293. * @returns the class name
  101294. */
  101295. getClassName(): string;
  101296. /**
  101297. * Gets the rgba input component
  101298. */
  101299. get rgba(): NodeMaterialConnectionPoint;
  101300. /**
  101301. * Gets the rgb input component
  101302. */
  101303. get rgb(): NodeMaterialConnectionPoint;
  101304. /**
  101305. * Gets the a input component
  101306. */
  101307. get a(): NodeMaterialConnectionPoint;
  101308. protected _buildBlock(state: NodeMaterialBuildState): this;
  101309. }
  101310. }
  101311. declare module BABYLON {
  101312. /**
  101313. * Block used for the particle ramp gradient section
  101314. */
  101315. export class ParticleRampGradientBlock extends NodeMaterialBlock {
  101316. /**
  101317. * Create a new ParticleRampGradientBlock
  101318. * @param name defines the block name
  101319. */
  101320. constructor(name: string);
  101321. /**
  101322. * Gets the current class name
  101323. * @returns the class name
  101324. */
  101325. getClassName(): string;
  101326. /**
  101327. * Gets the color input component
  101328. */
  101329. get color(): NodeMaterialConnectionPoint;
  101330. /**
  101331. * Gets the rampColor output component
  101332. */
  101333. get rampColor(): NodeMaterialConnectionPoint;
  101334. /**
  101335. * Initialize the block and prepare the context for build
  101336. * @param state defines the state that will be used for the build
  101337. */
  101338. initialize(state: NodeMaterialBuildState): void;
  101339. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  101340. }
  101341. }
  101342. declare module BABYLON {
  101343. /**
  101344. * Block used for the particle blend multiply section
  101345. */
  101346. export class ParticleBlendMultiplyBlock extends NodeMaterialBlock {
  101347. /**
  101348. * Create a new ParticleBlendMultiplyBlock
  101349. * @param name defines the block name
  101350. */
  101351. constructor(name: string);
  101352. /**
  101353. * Gets the current class name
  101354. * @returns the class name
  101355. */
  101356. getClassName(): string;
  101357. /**
  101358. * Gets the color input component
  101359. */
  101360. get color(): NodeMaterialConnectionPoint;
  101361. /**
  101362. * Gets the alphaTexture input component
  101363. */
  101364. get alphaTexture(): NodeMaterialConnectionPoint;
  101365. /**
  101366. * Gets the alphaColor input component
  101367. */
  101368. get alphaColor(): NodeMaterialConnectionPoint;
  101369. /**
  101370. * Gets the blendColor output component
  101371. */
  101372. get blendColor(): NodeMaterialConnectionPoint;
  101373. /**
  101374. * Initialize the block and prepare the context for build
  101375. * @param state defines the state that will be used for the build
  101376. */
  101377. initialize(state: NodeMaterialBuildState): void;
  101378. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  101379. }
  101380. }
  101381. declare module BABYLON {
  101382. /**
  101383. * Block used to create a Vector2/3/4 out of individual inputs (one for each component)
  101384. */
  101385. export class VectorMergerBlock extends NodeMaterialBlock {
  101386. /**
  101387. * Create a new VectorMergerBlock
  101388. * @param name defines the block name
  101389. */
  101390. constructor(name: string);
  101391. /**
  101392. * Gets the current class name
  101393. * @returns the class name
  101394. */
  101395. getClassName(): string;
  101396. /**
  101397. * Gets the xyz component (input)
  101398. */
  101399. get xyzIn(): NodeMaterialConnectionPoint;
  101400. /**
  101401. * Gets the xy component (input)
  101402. */
  101403. get xyIn(): NodeMaterialConnectionPoint;
  101404. /**
  101405. * Gets the x component (input)
  101406. */
  101407. get x(): NodeMaterialConnectionPoint;
  101408. /**
  101409. * Gets the y component (input)
  101410. */
  101411. get y(): NodeMaterialConnectionPoint;
  101412. /**
  101413. * Gets the z component (input)
  101414. */
  101415. get z(): NodeMaterialConnectionPoint;
  101416. /**
  101417. * Gets the w component (input)
  101418. */
  101419. get w(): NodeMaterialConnectionPoint;
  101420. /**
  101421. * Gets the xyzw component (output)
  101422. */
  101423. get xyzw(): NodeMaterialConnectionPoint;
  101424. /**
  101425. * Gets the xyz component (output)
  101426. */
  101427. get xyzOut(): NodeMaterialConnectionPoint;
  101428. /**
  101429. * Gets the xy component (output)
  101430. */
  101431. get xyOut(): NodeMaterialConnectionPoint;
  101432. /**
  101433. * Gets the xy component (output)
  101434. * @deprecated Please use xyOut instead.
  101435. */
  101436. get xy(): NodeMaterialConnectionPoint;
  101437. /**
  101438. * Gets the xyz component (output)
  101439. * @deprecated Please use xyzOut instead.
  101440. */
  101441. get xyz(): NodeMaterialConnectionPoint;
  101442. protected _buildBlock(state: NodeMaterialBuildState): this;
  101443. }
  101444. }
  101445. declare module BABYLON {
  101446. /**
  101447. * Block used to remap a float from a range to a new one
  101448. */
  101449. export class RemapBlock extends NodeMaterialBlock {
  101450. /**
  101451. * Gets or sets the source range
  101452. */
  101453. sourceRange: Vector2;
  101454. /**
  101455. * Gets or sets the target range
  101456. */
  101457. targetRange: Vector2;
  101458. /**
  101459. * Creates a new RemapBlock
  101460. * @param name defines the block name
  101461. */
  101462. constructor(name: string);
  101463. /**
  101464. * Gets the current class name
  101465. * @returns the class name
  101466. */
  101467. getClassName(): string;
  101468. /**
  101469. * Gets the input component
  101470. */
  101471. get input(): NodeMaterialConnectionPoint;
  101472. /**
  101473. * Gets the source min input component
  101474. */
  101475. get sourceMin(): NodeMaterialConnectionPoint;
  101476. /**
  101477. * Gets the source max input component
  101478. */
  101479. get sourceMax(): NodeMaterialConnectionPoint;
  101480. /**
  101481. * Gets the target min input component
  101482. */
  101483. get targetMin(): NodeMaterialConnectionPoint;
  101484. /**
  101485. * Gets the target max input component
  101486. */
  101487. get targetMax(): NodeMaterialConnectionPoint;
  101488. /**
  101489. * Gets the output component
  101490. */
  101491. get output(): NodeMaterialConnectionPoint;
  101492. protected _buildBlock(state: NodeMaterialBuildState): this;
  101493. protected _dumpPropertiesCode(): string;
  101494. serialize(): any;
  101495. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  101496. }
  101497. }
  101498. declare module BABYLON {
  101499. /**
  101500. * Block used to multiply 2 values
  101501. */
  101502. export class MultiplyBlock extends NodeMaterialBlock {
  101503. /**
  101504. * Creates a new MultiplyBlock
  101505. * @param name defines the block name
  101506. */
  101507. constructor(name: string);
  101508. /**
  101509. * Gets the current class name
  101510. * @returns the class name
  101511. */
  101512. getClassName(): string;
  101513. /**
  101514. * Gets the left operand input component
  101515. */
  101516. get left(): NodeMaterialConnectionPoint;
  101517. /**
  101518. * Gets the right operand input component
  101519. */
  101520. get right(): NodeMaterialConnectionPoint;
  101521. /**
  101522. * Gets the output component
  101523. */
  101524. get output(): NodeMaterialConnectionPoint;
  101525. protected _buildBlock(state: NodeMaterialBuildState): this;
  101526. }
  101527. }
  101528. declare module BABYLON {
  101529. /**
  101530. * Block used to expand a Color3/4 into 4 outputs (one for each component)
  101531. */
  101532. export class ColorSplitterBlock extends NodeMaterialBlock {
  101533. /**
  101534. * Create a new ColorSplitterBlock
  101535. * @param name defines the block name
  101536. */
  101537. constructor(name: string);
  101538. /**
  101539. * Gets the current class name
  101540. * @returns the class name
  101541. */
  101542. getClassName(): string;
  101543. /**
  101544. * Gets the rgba component (input)
  101545. */
  101546. get rgba(): NodeMaterialConnectionPoint;
  101547. /**
  101548. * Gets the rgb component (input)
  101549. */
  101550. get rgbIn(): NodeMaterialConnectionPoint;
  101551. /**
  101552. * Gets the rgb component (output)
  101553. */
  101554. get rgbOut(): NodeMaterialConnectionPoint;
  101555. /**
  101556. * Gets the r component (output)
  101557. */
  101558. get r(): NodeMaterialConnectionPoint;
  101559. /**
  101560. * Gets the g component (output)
  101561. */
  101562. get g(): NodeMaterialConnectionPoint;
  101563. /**
  101564. * Gets the b component (output)
  101565. */
  101566. get b(): NodeMaterialConnectionPoint;
  101567. /**
  101568. * Gets the a component (output)
  101569. */
  101570. get a(): NodeMaterialConnectionPoint;
  101571. protected _inputRename(name: string): string;
  101572. protected _outputRename(name: string): string;
  101573. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  101574. }
  101575. }
  101576. declare module BABYLON {
  101577. /**
  101578. * Interface used to configure the node material editor
  101579. */
  101580. export interface INodeMaterialEditorOptions {
  101581. /** Define the URl to load node editor script */
  101582. editorURL?: string;
  101583. }
  101584. /** @hidden */
  101585. export class NodeMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  101586. NORMAL: boolean;
  101587. TANGENT: boolean;
  101588. UV1: boolean;
  101589. /** BONES */
  101590. NUM_BONE_INFLUENCERS: number;
  101591. BonesPerMesh: number;
  101592. BONETEXTURE: boolean;
  101593. /** MORPH TARGETS */
  101594. MORPHTARGETS: boolean;
  101595. MORPHTARGETS_NORMAL: boolean;
  101596. MORPHTARGETS_TANGENT: boolean;
  101597. MORPHTARGETS_UV: boolean;
  101598. NUM_MORPH_INFLUENCERS: number;
  101599. /** IMAGE PROCESSING */
  101600. IMAGEPROCESSING: boolean;
  101601. VIGNETTE: boolean;
  101602. VIGNETTEBLENDMODEMULTIPLY: boolean;
  101603. VIGNETTEBLENDMODEOPAQUE: boolean;
  101604. TONEMAPPING: boolean;
  101605. TONEMAPPING_ACES: boolean;
  101606. CONTRAST: boolean;
  101607. EXPOSURE: boolean;
  101608. COLORCURVES: boolean;
  101609. COLORGRADING: boolean;
  101610. COLORGRADING3D: boolean;
  101611. SAMPLER3DGREENDEPTH: boolean;
  101612. SAMPLER3DBGRMAP: boolean;
  101613. IMAGEPROCESSINGPOSTPROCESS: boolean;
  101614. /** MISC. */
  101615. BUMPDIRECTUV: number;
  101616. constructor();
  101617. setValue(name: string, value: any, markAsUnprocessedIfDirty?: boolean): void;
  101618. }
  101619. /**
  101620. * Class used to configure NodeMaterial
  101621. */
  101622. export interface INodeMaterialOptions {
  101623. /**
  101624. * Defines if blocks should emit comments
  101625. */
  101626. emitComments: boolean;
  101627. }
  101628. /**
  101629. * Class used to create a node based material built by assembling shader blocks
  101630. */
  101631. export class NodeMaterial extends PushMaterial {
  101632. private static _BuildIdGenerator;
  101633. private _options;
  101634. private _vertexCompilationState;
  101635. private _fragmentCompilationState;
  101636. private _sharedData;
  101637. private _buildId;
  101638. private _buildWasSuccessful;
  101639. private _cachedWorldViewMatrix;
  101640. private _cachedWorldViewProjectionMatrix;
  101641. private _optimizers;
  101642. private _animationFrame;
  101643. /** Define the Url to load node editor script */
  101644. static EditorURL: string;
  101645. /** Define the Url to load snippets */
  101646. static SnippetUrl: string;
  101647. /** Gets or sets a boolean indicating that node materials should not deserialize textures from json / snippet content */
  101648. static IgnoreTexturesAtLoadTime: boolean;
  101649. private BJSNODEMATERIALEDITOR;
  101650. /** Get the inspector from bundle or global */
  101651. private _getGlobalNodeMaterialEditor;
  101652. /**
  101653. * Snippet ID if the material was created from the snippet server
  101654. */
  101655. snippetId: string;
  101656. /**
  101657. * Gets or sets data used by visual editor
  101658. * @see https://nme.babylonjs.com
  101659. */
  101660. editorData: any;
  101661. /**
  101662. * 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)
  101663. */
  101664. ignoreAlpha: boolean;
  101665. /**
  101666. * Defines the maximum number of lights that can be used in the material
  101667. */
  101668. maxSimultaneousLights: number;
  101669. /**
  101670. * Observable raised when the material is built
  101671. */
  101672. onBuildObservable: Observable<NodeMaterial>;
  101673. /**
  101674. * Gets or sets the root nodes of the material vertex shader
  101675. */
  101676. _vertexOutputNodes: NodeMaterialBlock[];
  101677. /**
  101678. * Gets or sets the root nodes of the material fragment (pixel) shader
  101679. */
  101680. _fragmentOutputNodes: NodeMaterialBlock[];
  101681. /** Gets or sets options to control the node material overall behavior */
  101682. get options(): INodeMaterialOptions;
  101683. set options(options: INodeMaterialOptions);
  101684. /**
  101685. * Default configuration related to image processing available in the standard Material.
  101686. */
  101687. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  101688. /**
  101689. * Gets the image processing configuration used either in this material.
  101690. */
  101691. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  101692. /**
  101693. * Sets the Default image processing configuration used either in the this material.
  101694. *
  101695. * If sets to null, the scene one is in use.
  101696. */
  101697. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  101698. /**
  101699. * Gets an array of blocks that needs to be serialized even if they are not yet connected
  101700. */
  101701. attachedBlocks: NodeMaterialBlock[];
  101702. /**
  101703. * Specifies the mode of the node material
  101704. * @hidden
  101705. */
  101706. _mode: NodeMaterialModes;
  101707. /**
  101708. * Gets the mode property
  101709. */
  101710. get mode(): NodeMaterialModes;
  101711. /**
  101712. * Create a new node based material
  101713. * @param name defines the material name
  101714. * @param scene defines the hosting scene
  101715. * @param options defines creation option
  101716. */
  101717. constructor(name: string, scene?: Scene, options?: Partial<INodeMaterialOptions>);
  101718. /**
  101719. * Gets the current class name of the material e.g. "NodeMaterial"
  101720. * @returns the class name
  101721. */
  101722. getClassName(): string;
  101723. /**
  101724. * Keep track of the image processing observer to allow dispose and replace.
  101725. */
  101726. private _imageProcessingObserver;
  101727. /**
  101728. * Attaches a new image processing configuration to the Standard Material.
  101729. * @param configuration
  101730. */
  101731. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  101732. /**
  101733. * Get a block by its name
  101734. * @param name defines the name of the block to retrieve
  101735. * @returns the required block or null if not found
  101736. */
  101737. getBlockByName(name: string): Nullable<NodeMaterialBlock>;
  101738. /**
  101739. * Get a block by its name
  101740. * @param predicate defines the predicate used to find the good candidate
  101741. * @returns the required block or null if not found
  101742. */
  101743. getBlockByPredicate(predicate: (block: NodeMaterialBlock) => boolean): Nullable<NodeMaterialBlock>;
  101744. /**
  101745. * Get an input block by its name
  101746. * @param predicate defines the predicate used to find the good candidate
  101747. * @returns the required input block or null if not found
  101748. */
  101749. getInputBlockByPredicate(predicate: (block: InputBlock) => boolean): Nullable<InputBlock>;
  101750. /**
  101751. * Gets the list of input blocks attached to this material
  101752. * @returns an array of InputBlocks
  101753. */
  101754. getInputBlocks(): InputBlock[];
  101755. /**
  101756. * Adds a new optimizer to the list of optimizers
  101757. * @param optimizer defines the optimizers to add
  101758. * @returns the current material
  101759. */
  101760. registerOptimizer(optimizer: NodeMaterialOptimizer): this | undefined;
  101761. /**
  101762. * Remove an optimizer from the list of optimizers
  101763. * @param optimizer defines the optimizers to remove
  101764. * @returns the current material
  101765. */
  101766. unregisterOptimizer(optimizer: NodeMaterialOptimizer): this | undefined;
  101767. /**
  101768. * Add a new block to the list of output nodes
  101769. * @param node defines the node to add
  101770. * @returns the current material
  101771. */
  101772. addOutputNode(node: NodeMaterialBlock): this;
  101773. /**
  101774. * Remove a block from the list of root nodes
  101775. * @param node defines the node to remove
  101776. * @returns the current material
  101777. */
  101778. removeOutputNode(node: NodeMaterialBlock): this;
  101779. private _addVertexOutputNode;
  101780. private _removeVertexOutputNode;
  101781. private _addFragmentOutputNode;
  101782. private _removeFragmentOutputNode;
  101783. /**
  101784. * Specifies if the material will require alpha blending
  101785. * @returns a boolean specifying if alpha blending is needed
  101786. */
  101787. needAlphaBlending(): boolean;
  101788. /**
  101789. * Specifies if this material should be rendered in alpha test mode
  101790. * @returns a boolean specifying if an alpha test is needed.
  101791. */
  101792. needAlphaTesting(): boolean;
  101793. private _initializeBlock;
  101794. private _resetDualBlocks;
  101795. /**
  101796. * Remove a block from the current node material
  101797. * @param block defines the block to remove
  101798. */
  101799. removeBlock(block: NodeMaterialBlock): void;
  101800. /**
  101801. * Build the material and generates the inner effect
  101802. * @param verbose defines if the build should log activity
  101803. */
  101804. build(verbose?: boolean): void;
  101805. /**
  101806. * Runs an otpimization phase to try to improve the shader code
  101807. */
  101808. optimize(): void;
  101809. private _prepareDefinesForAttributes;
  101810. /**
  101811. * Create a post process from the material
  101812. * @param camera The camera to apply the render pass to.
  101813. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  101814. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  101815. * @param engine The engine which the post process will be applied. (default: current engine)
  101816. * @param reusable If the post process can be reused on the same frame. (default: false)
  101817. * @param textureType Type of textures used when performing the post process. (default: 0)
  101818. * @param textureFormat Format of textures used when performing the post process. (default: TEXTUREFORMAT_RGBA)
  101819. * @returns the post process created
  101820. */
  101821. createPostProcess(camera: Nullable<Camera>, options?: number | PostProcessOptions, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, textureFormat?: number): PostProcess;
  101822. /**
  101823. * Create the post process effect from the material
  101824. * @param postProcess The post process to create the effect for
  101825. */
  101826. createEffectForPostProcess(postProcess: PostProcess): void;
  101827. private _createEffectOrPostProcess;
  101828. private _createEffectForParticles;
  101829. /**
  101830. * Create the effect to be used as the custom effect for a particle system
  101831. * @param particleSystem Particle system to create the effect for
  101832. * @param onCompiled defines a function to call when the effect creation is successful
  101833. * @param onError defines a function to call when the effect creation has failed
  101834. */
  101835. createEffectForParticles(particleSystem: IParticleSystem, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  101836. private _processDefines;
  101837. /**
  101838. * Get if the submesh is ready to be used and all its information available.
  101839. * Child classes can use it to update shaders
  101840. * @param mesh defines the mesh to check
  101841. * @param subMesh defines which submesh to check
  101842. * @param useInstances specifies that instances should be used
  101843. * @returns a boolean indicating that the submesh is ready or not
  101844. */
  101845. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  101846. /**
  101847. * Get a string representing the shaders built by the current node graph
  101848. */
  101849. get compiledShaders(): string;
  101850. /**
  101851. * Binds the world matrix to the material
  101852. * @param world defines the world transformation matrix
  101853. */
  101854. bindOnlyWorldMatrix(world: Matrix): void;
  101855. /**
  101856. * Binds the submesh to this material by preparing the effect and shader to draw
  101857. * @param world defines the world transformation matrix
  101858. * @param mesh defines the mesh containing the submesh
  101859. * @param subMesh defines the submesh to bind the material to
  101860. */
  101861. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  101862. /**
  101863. * Gets the active textures from the material
  101864. * @returns an array of textures
  101865. */
  101866. getActiveTextures(): BaseTexture[];
  101867. /**
  101868. * Gets the list of texture blocks
  101869. * @returns an array of texture blocks
  101870. */
  101871. getTextureBlocks(): (TextureBlock | ReflectionTextureBaseBlock | RefractionBlock | CurrentScreenBlock | ParticleTextureBlock)[];
  101872. /**
  101873. * Specifies if the material uses a texture
  101874. * @param texture defines the texture to check against the material
  101875. * @returns a boolean specifying if the material uses the texture
  101876. */
  101877. hasTexture(texture: BaseTexture): boolean;
  101878. /**
  101879. * Disposes the material
  101880. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  101881. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  101882. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  101883. */
  101884. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  101885. /** Creates the node editor window. */
  101886. private _createNodeEditor;
  101887. /**
  101888. * Launch the node material editor
  101889. * @param config Define the configuration of the editor
  101890. * @return a promise fulfilled when the node editor is visible
  101891. */
  101892. edit(config?: INodeMaterialEditorOptions): Promise<void>;
  101893. /**
  101894. * Clear the current material
  101895. */
  101896. clear(): void;
  101897. /**
  101898. * Clear the current material and set it to a default state
  101899. */
  101900. setToDefault(): void;
  101901. /**
  101902. * Clear the current material and set it to a default state for post process
  101903. */
  101904. setToDefaultPostProcess(): void;
  101905. /**
  101906. * Clear the current material and set it to a default state for particle
  101907. */
  101908. setToDefaultParticle(): void;
  101909. /**
  101910. * Loads the current Node Material from a url pointing to a file save by the Node Material Editor
  101911. * @param url defines the url to load from
  101912. * @returns a promise that will fullfil when the material is fully loaded
  101913. */
  101914. loadAsync(url: string): Promise<void>;
  101915. private _gatherBlocks;
  101916. /**
  101917. * Generate a string containing the code declaration required to create an equivalent of this material
  101918. * @returns a string
  101919. */
  101920. generateCode(): string;
  101921. /**
  101922. * Serializes this material in a JSON representation
  101923. * @returns the serialized material object
  101924. */
  101925. serialize(selectedBlocks?: NodeMaterialBlock[]): any;
  101926. private _restoreConnections;
  101927. /**
  101928. * Clear the current graph and load a new one from a serialization object
  101929. * @param source defines the JSON representation of the material
  101930. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  101931. * @param merge defines whether or not the source must be merged or replace the current content
  101932. */
  101933. loadFromSerialization(source: any, rootUrl?: string, merge?: boolean): void;
  101934. /**
  101935. * Makes a duplicate of the current material.
  101936. * @param name - name to use for the new material.
  101937. */
  101938. clone(name: string): NodeMaterial;
  101939. /**
  101940. * Creates a node material from parsed material data
  101941. * @param source defines the JSON representation of the material
  101942. * @param scene defines the hosting scene
  101943. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  101944. * @returns a new node material
  101945. */
  101946. static Parse(source: any, scene: Scene, rootUrl?: string): NodeMaterial;
  101947. /**
  101948. * Creates a node material from a snippet saved in a remote file
  101949. * @param name defines the name of the material to create
  101950. * @param url defines the url to load from
  101951. * @param scene defines the hosting scene
  101952. * @returns a promise that will resolve to the new node material
  101953. */
  101954. static ParseFromFileAsync(name: string, url: string, scene: Scene): Promise<NodeMaterial>;
  101955. /**
  101956. * Creates a node material from a snippet saved by the node material editor
  101957. * @param snippetId defines the snippet to load
  101958. * @param scene defines the hosting scene
  101959. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  101960. * @param nodeMaterial defines a node material to update (instead of creating a new one)
  101961. * @returns a promise that will resolve to the new node material
  101962. */
  101963. static ParseFromSnippetAsync(snippetId: string, scene: Scene, rootUrl?: string, nodeMaterial?: NodeMaterial): Promise<NodeMaterial>;
  101964. /**
  101965. * Creates a new node material set to default basic configuration
  101966. * @param name defines the name of the material
  101967. * @param scene defines the hosting scene
  101968. * @returns a new NodeMaterial
  101969. */
  101970. static CreateDefault(name: string, scene?: Scene): NodeMaterial;
  101971. }
  101972. }
  101973. declare module BABYLON {
  101974. /**
  101975. * Size options for a post process
  101976. */
  101977. export type PostProcessOptions = {
  101978. width: number;
  101979. height: number;
  101980. };
  101981. /**
  101982. * PostProcess can be used to apply a shader to a texture after it has been rendered
  101983. * See https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  101984. */
  101985. export class PostProcess {
  101986. /**
  101987. * Gets or sets the unique id of the post process
  101988. */
  101989. uniqueId: number;
  101990. /** Name of the PostProcess. */
  101991. name: string;
  101992. /**
  101993. * Width of the texture to apply the post process on
  101994. */
  101995. width: number;
  101996. /**
  101997. * Height of the texture to apply the post process on
  101998. */
  101999. height: number;
  102000. /**
  102001. * Gets the node material used to create this postprocess (null if the postprocess was manually created)
  102002. */
  102003. nodeMaterialSource: Nullable<NodeMaterial>;
  102004. /**
  102005. * Internal, reference to the location where this postprocess was output to. (Typically the texture on the next postprocess in the chain)
  102006. * @hidden
  102007. */
  102008. _outputTexture: Nullable<InternalTexture>;
  102009. /**
  102010. * Sampling mode used by the shader
  102011. * See https://doc.babylonjs.com/classes/3.1/texture
  102012. */
  102013. renderTargetSamplingMode: number;
  102014. /**
  102015. * Clear color to use when screen clearing
  102016. */
  102017. clearColor: Color4;
  102018. /**
  102019. * If the buffer needs to be cleared before applying the post process. (default: true)
  102020. * Should be set to false if shader will overwrite all previous pixels.
  102021. */
  102022. autoClear: boolean;
  102023. /**
  102024. * Type of alpha mode to use when performing the post process (default: Engine.ALPHA_DISABLE)
  102025. */
  102026. alphaMode: number;
  102027. /**
  102028. * Sets the setAlphaBlendConstants of the babylon engine
  102029. */
  102030. alphaConstants: Color4;
  102031. /**
  102032. * Animations to be used for the post processing
  102033. */
  102034. animations: Animation[];
  102035. /**
  102036. * Enable Pixel Perfect mode where texture is not scaled to be power of 2.
  102037. * Can only be used on a single postprocess or on the last one of a chain. (default: false)
  102038. */
  102039. enablePixelPerfectMode: boolean;
  102040. /**
  102041. * Force the postprocess to be applied without taking in account viewport
  102042. */
  102043. forceFullscreenViewport: boolean;
  102044. /**
  102045. * List of inspectable custom properties (used by the Inspector)
  102046. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  102047. */
  102048. inspectableCustomProperties: IInspectable[];
  102049. /**
  102050. * Scale mode for the post process (default: Engine.SCALEMODE_FLOOR)
  102051. *
  102052. * | Value | Type | Description |
  102053. * | ----- | ----------------------------------- | ----------- |
  102054. * | 1 | SCALEMODE_FLOOR | [engine.scalemode_floor](https://doc.babylonjs.com/api/classes/babylon.engine#scalemode_floor) |
  102055. * | 2 | SCALEMODE_NEAREST | [engine.scalemode_nearest](https://doc.babylonjs.com/api/classes/babylon.engine#scalemode_nearest) |
  102056. * | 3 | SCALEMODE_CEILING | [engine.scalemode_ceiling](https://doc.babylonjs.com/api/classes/babylon.engine#scalemode_ceiling) |
  102057. *
  102058. */
  102059. scaleMode: number;
  102060. /**
  102061. * Force textures to be a power of two (default: false)
  102062. */
  102063. alwaysForcePOT: boolean;
  102064. private _samples;
  102065. /**
  102066. * Number of sample textures (default: 1)
  102067. */
  102068. get samples(): number;
  102069. set samples(n: number);
  102070. /**
  102071. * Modify the scale of the post process to be the same as the viewport (default: false)
  102072. */
  102073. adaptScaleToCurrentViewport: boolean;
  102074. private _camera;
  102075. protected _scene: Scene;
  102076. private _engine;
  102077. private _options;
  102078. private _reusable;
  102079. private _textureType;
  102080. private _textureFormat;
  102081. /**
  102082. * Smart array of input and output textures for the post process.
  102083. * @hidden
  102084. */
  102085. _textures: SmartArray<InternalTexture>;
  102086. /**
  102087. * The index in _textures that corresponds to the output texture.
  102088. * @hidden
  102089. */
  102090. _currentRenderTextureInd: number;
  102091. private _effect;
  102092. private _samplers;
  102093. private _fragmentUrl;
  102094. private _vertexUrl;
  102095. private _parameters;
  102096. private _scaleRatio;
  102097. protected _indexParameters: any;
  102098. private _shareOutputWithPostProcess;
  102099. private _texelSize;
  102100. private _forcedOutputTexture;
  102101. /**
  102102. * Returns the fragment url or shader name used in the post process.
  102103. * @returns the fragment url or name in the shader store.
  102104. */
  102105. getEffectName(): string;
  102106. /**
  102107. * An event triggered when the postprocess is activated.
  102108. */
  102109. onActivateObservable: Observable<Camera>;
  102110. private _onActivateObserver;
  102111. /**
  102112. * A function that is added to the onActivateObservable
  102113. */
  102114. set onActivate(callback: Nullable<(camera: Camera) => void>);
  102115. /**
  102116. * An event triggered when the postprocess changes its size.
  102117. */
  102118. onSizeChangedObservable: Observable<PostProcess>;
  102119. private _onSizeChangedObserver;
  102120. /**
  102121. * A function that is added to the onSizeChangedObservable
  102122. */
  102123. set onSizeChanged(callback: (postProcess: PostProcess) => void);
  102124. /**
  102125. * An event triggered when the postprocess applies its effect.
  102126. */
  102127. onApplyObservable: Observable<Effect>;
  102128. private _onApplyObserver;
  102129. /**
  102130. * A function that is added to the onApplyObservable
  102131. */
  102132. set onApply(callback: (effect: Effect) => void);
  102133. /**
  102134. * An event triggered before rendering the postprocess
  102135. */
  102136. onBeforeRenderObservable: Observable<Effect>;
  102137. private _onBeforeRenderObserver;
  102138. /**
  102139. * A function that is added to the onBeforeRenderObservable
  102140. */
  102141. set onBeforeRender(callback: (effect: Effect) => void);
  102142. /**
  102143. * An event triggered after rendering the postprocess
  102144. */
  102145. onAfterRenderObservable: Observable<Effect>;
  102146. private _onAfterRenderObserver;
  102147. /**
  102148. * A function that is added to the onAfterRenderObservable
  102149. */
  102150. set onAfterRender(callback: (efect: Effect) => void);
  102151. /**
  102152. * 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
  102153. * render it's output into this texture and this texture will be used as textureSampler in the fragment shader of this post process.
  102154. */
  102155. get inputTexture(): InternalTexture;
  102156. set inputTexture(value: InternalTexture);
  102157. /**
  102158. * Since inputTexture should always be defined, if we previously manually set `inputTexture`,
  102159. * the only way to unset it is to use this function to restore its internal state
  102160. */
  102161. restoreDefaultInputTexture(): void;
  102162. /**
  102163. * Gets the camera which post process is applied to.
  102164. * @returns The camera the post process is applied to.
  102165. */
  102166. getCamera(): Camera;
  102167. /**
  102168. * Gets the texel size of the postprocess.
  102169. * See https://en.wikipedia.org/wiki/Texel_(graphics)
  102170. */
  102171. get texelSize(): Vector2;
  102172. /**
  102173. * Creates a new instance PostProcess
  102174. * @param name The name of the PostProcess.
  102175. * @param fragmentUrl The url of the fragment shader to be used.
  102176. * @param parameters Array of the names of uniform non-sampler2D variables that will be passed to the shader.
  102177. * @param samplers Array of the names of uniform sampler2D variables that will be passed to the shader.
  102178. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  102179. * @param camera The camera to apply the render pass to.
  102180. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  102181. * @param engine The engine which the post process will be applied. (default: current engine)
  102182. * @param reusable If the post process can be reused on the same frame. (default: false)
  102183. * @param defines String of defines that will be set when running the fragment shader. (default: null)
  102184. * @param textureType Type of textures used when performing the post process. (default: 0)
  102185. * @param vertexUrl The url of the vertex shader to be used. (default: "postprocess")
  102186. * @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
  102187. * @param blockCompilation If the shader should not be compiled imediatly. (default: false)
  102188. * @param textureFormat Format of textures used when performing the post process. (default: TEXTUREFORMAT_RGBA)
  102189. */
  102190. 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);
  102191. /**
  102192. * Gets a string identifying the name of the class
  102193. * @returns "PostProcess" string
  102194. */
  102195. getClassName(): string;
  102196. /**
  102197. * Gets the engine which this post process belongs to.
  102198. * @returns The engine the post process was enabled with.
  102199. */
  102200. getEngine(): Engine;
  102201. /**
  102202. * The effect that is created when initializing the post process.
  102203. * @returns The created effect corresponding the the postprocess.
  102204. */
  102205. getEffect(): Effect;
  102206. /**
  102207. * To avoid multiple redundant textures for multiple post process, the output the output texture for this post process can be shared with another.
  102208. * @param postProcess The post process to share the output with.
  102209. * @returns This post process.
  102210. */
  102211. shareOutputWith(postProcess: PostProcess): PostProcess;
  102212. /**
  102213. * Reverses the effect of calling shareOutputWith and returns the post process back to its original state.
  102214. * This should be called if the post process that shares output with this post process is disabled/disposed.
  102215. */
  102216. useOwnOutput(): void;
  102217. /**
  102218. * Updates the effect with the current post process compile time values and recompiles the shader.
  102219. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  102220. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  102221. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  102222. * @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
  102223. * @param onCompiled Called when the shader has been compiled.
  102224. * @param onError Called if there is an error when compiling a shader.
  102225. * @param vertexUrl The url of the vertex shader to be used (default: the one given at construction time)
  102226. * @param fragmentUrl The url of the fragment shader to be used (default: the one given at construction time)
  102227. */
  102228. 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;
  102229. /**
  102230. * The post process is reusable if it can be used multiple times within one frame.
  102231. * @returns If the post process is reusable
  102232. */
  102233. isReusable(): boolean;
  102234. /** invalidate frameBuffer to hint the postprocess to create a depth buffer */
  102235. markTextureDirty(): void;
  102236. /**
  102237. * Activates the post process by intializing the textures to be used when executed. Notifies onActivateObservable.
  102238. * 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.
  102239. * @param camera The camera that will be used in the post process. This camera will be used when calling onActivateObservable.
  102240. * @param sourceTexture The source texture to be inspected to get the width and height if not specified in the post process constructor. (default: null)
  102241. * @param forceDepthStencil If true, a depth and stencil buffer will be generated. (default: false)
  102242. * @returns The target texture that was bound to be written to.
  102243. */
  102244. activate(camera: Nullable<Camera>, sourceTexture?: Nullable<InternalTexture>, forceDepthStencil?: boolean): InternalTexture;
  102245. /**
  102246. * If the post process is supported.
  102247. */
  102248. get isSupported(): boolean;
  102249. /**
  102250. * The aspect ratio of the output texture.
  102251. */
  102252. get aspectRatio(): number;
  102253. /**
  102254. * Get a value indicating if the post-process is ready to be used
  102255. * @returns true if the post-process is ready (shader is compiled)
  102256. */
  102257. isReady(): boolean;
  102258. /**
  102259. * Binds all textures and uniforms to the shader, this will be run on every pass.
  102260. * @returns the effect corresponding to this post process. Null if not compiled or not ready.
  102261. */
  102262. apply(): Nullable<Effect>;
  102263. private _disposeTextures;
  102264. /**
  102265. * Disposes the post process.
  102266. * @param camera The camera to dispose the post process on.
  102267. */
  102268. dispose(camera?: Camera): void;
  102269. /**
  102270. * Serializes the particle system to a JSON object
  102271. * @returns the JSON object
  102272. */
  102273. serialize(): any;
  102274. /**
  102275. * Creates a material from parsed material data
  102276. * @param parsedPostProcess defines parsed post process data
  102277. * @param scene defines the hosting scene
  102278. * @param rootUrl defines the root URL to use to load textures
  102279. * @returns a new post process
  102280. */
  102281. static Parse(parsedPostProcess: any, scene: Scene, rootUrl: string): Nullable<PostProcess>;
  102282. }
  102283. }
  102284. declare module BABYLON {
  102285. /** @hidden */
  102286. export var kernelBlurVaryingDeclaration: {
  102287. name: string;
  102288. shader: string;
  102289. };
  102290. }
  102291. declare module BABYLON {
  102292. /** @hidden */
  102293. export var kernelBlurFragment: {
  102294. name: string;
  102295. shader: string;
  102296. };
  102297. }
  102298. declare module BABYLON {
  102299. /** @hidden */
  102300. export var kernelBlurFragment2: {
  102301. name: string;
  102302. shader: string;
  102303. };
  102304. }
  102305. declare module BABYLON {
  102306. /** @hidden */
  102307. export var kernelBlurPixelShader: {
  102308. name: string;
  102309. shader: string;
  102310. };
  102311. }
  102312. declare module BABYLON {
  102313. /** @hidden */
  102314. export var kernelBlurVertex: {
  102315. name: string;
  102316. shader: string;
  102317. };
  102318. }
  102319. declare module BABYLON {
  102320. /** @hidden */
  102321. export var kernelBlurVertexShader: {
  102322. name: string;
  102323. shader: string;
  102324. };
  102325. }
  102326. declare module BABYLON {
  102327. /**
  102328. * The Blur Post Process which blurs an image based on a kernel and direction.
  102329. * Can be used twice in x and y directions to perform a guassian blur in two passes.
  102330. */
  102331. export class BlurPostProcess extends PostProcess {
  102332. private blockCompilation;
  102333. protected _kernel: number;
  102334. protected _idealKernel: number;
  102335. protected _packedFloat: boolean;
  102336. private _staticDefines;
  102337. /** The direction in which to blur the image. */
  102338. direction: Vector2;
  102339. /**
  102340. * Sets the length in pixels of the blur sample region
  102341. */
  102342. set kernel(v: number);
  102343. /**
  102344. * Gets the length in pixels of the blur sample region
  102345. */
  102346. get kernel(): number;
  102347. /**
  102348. * Sets wether or not the blur needs to unpack/repack floats
  102349. */
  102350. set packedFloat(v: boolean);
  102351. /**
  102352. * Gets wether or not the blur is unpacking/repacking floats
  102353. */
  102354. get packedFloat(): boolean;
  102355. /**
  102356. * Gets a string identifying the name of the class
  102357. * @returns "BlurPostProcess" string
  102358. */
  102359. getClassName(): string;
  102360. /**
  102361. * Creates a new instance BlurPostProcess
  102362. * @param name The name of the effect.
  102363. * @param direction The direction in which to blur the image.
  102364. * @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.
  102365. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  102366. * @param camera The camera to apply the render pass to.
  102367. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  102368. * @param engine The engine which the post process will be applied. (default: current engine)
  102369. * @param reusable If the post process can be reused on the same frame. (default: false)
  102370. * @param textureType Type of textures used when performing the post process. (default: 0)
  102371. * @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)
  102372. */
  102373. 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);
  102374. /**
  102375. * Updates the effect with the current post process compile time values and recompiles the shader.
  102376. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  102377. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  102378. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  102379. * @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
  102380. * @param onCompiled Called when the shader has been compiled.
  102381. * @param onError Called if there is an error when compiling a shader.
  102382. */
  102383. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  102384. protected _updateParameters(onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  102385. /**
  102386. * Best kernels are odd numbers that when divided by 2, their integer part is even, so 5, 9 or 13.
  102387. * Other odd kernels optimize correctly but require proportionally more samples, even kernels are
  102388. * possible but will produce minor visual artifacts. Since each new kernel requires a new shader we
  102389. * want to minimize kernel changes, having gaps between physical kernels is helpful in that regard.
  102390. * The gaps between physical kernels are compensated for in the weighting of the samples
  102391. * @param idealKernel Ideal blur kernel.
  102392. * @return Nearest best kernel.
  102393. */
  102394. protected _nearestBestKernel(idealKernel: number): number;
  102395. /**
  102396. * Calculates the value of a Gaussian distribution with sigma 3 at a given point.
  102397. * @param x The point on the Gaussian distribution to sample.
  102398. * @return the value of the Gaussian function at x.
  102399. */
  102400. protected _gaussianWeight(x: number): number;
  102401. /**
  102402. * Generates a string that can be used as a floating point number in GLSL.
  102403. * @param x Value to print.
  102404. * @param decimalFigures Number of decimal places to print the number to (excluding trailing 0s).
  102405. * @return GLSL float string.
  102406. */
  102407. protected _glslFloat(x: number, decimalFigures?: number): string;
  102408. /** @hidden */
  102409. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<BlurPostProcess>;
  102410. }
  102411. }
  102412. declare module BABYLON {
  102413. /**
  102414. * Mirror texture can be used to simulate the view from a mirror in a scene.
  102415. * It will dynamically be rendered every frame to adapt to the camera point of view.
  102416. * You can then easily use it as a reflectionTexture on a flat surface.
  102417. * In case the surface is not a plane, please consider relying on reflection probes.
  102418. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  102419. */
  102420. export class MirrorTexture extends RenderTargetTexture {
  102421. private scene;
  102422. /**
  102423. * Define the reflection plane we want to use. The mirrorPlane is usually set to the constructed reflector.
  102424. * 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.
  102425. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  102426. */
  102427. mirrorPlane: Plane;
  102428. /**
  102429. * Define the blur ratio used to blur the reflection if needed.
  102430. */
  102431. set blurRatio(value: number);
  102432. get blurRatio(): number;
  102433. /**
  102434. * Define the adaptive blur kernel used to blur the reflection if needed.
  102435. * This will autocompute the closest best match for the `blurKernel`
  102436. */
  102437. set adaptiveBlurKernel(value: number);
  102438. /**
  102439. * Define the blur kernel used to blur the reflection if needed.
  102440. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  102441. */
  102442. set blurKernel(value: number);
  102443. /**
  102444. * Define the blur kernel on the X Axis used to blur the reflection if needed.
  102445. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  102446. */
  102447. set blurKernelX(value: number);
  102448. get blurKernelX(): number;
  102449. /**
  102450. * Define the blur kernel on the Y Axis used to blur the reflection if needed.
  102451. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  102452. */
  102453. set blurKernelY(value: number);
  102454. get blurKernelY(): number;
  102455. private _autoComputeBlurKernel;
  102456. protected _onRatioRescale(): void;
  102457. private _updateGammaSpace;
  102458. private _imageProcessingConfigChangeObserver;
  102459. private _transformMatrix;
  102460. private _mirrorMatrix;
  102461. private _savedViewMatrix;
  102462. private _blurX;
  102463. private _blurY;
  102464. private _adaptiveBlurKernel;
  102465. private _blurKernelX;
  102466. private _blurKernelY;
  102467. private _blurRatio;
  102468. /**
  102469. * Instantiates a Mirror Texture.
  102470. * Mirror texture can be used to simulate the view from a mirror in a scene.
  102471. * It will dynamically be rendered every frame to adapt to the camera point of view.
  102472. * You can then easily use it as a reflectionTexture on a flat surface.
  102473. * In case the surface is not a plane, please consider relying on reflection probes.
  102474. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  102475. * @param name
  102476. * @param size
  102477. * @param scene
  102478. * @param generateMipMaps
  102479. * @param type
  102480. * @param samplingMode
  102481. * @param generateDepthBuffer
  102482. */
  102483. constructor(name: string, size: number | {
  102484. width: number;
  102485. height: number;
  102486. } | {
  102487. ratio: number;
  102488. }, scene: Scene, generateMipMaps?: boolean, type?: number, samplingMode?: number, generateDepthBuffer?: boolean);
  102489. private _preparePostProcesses;
  102490. /**
  102491. * Clone the mirror texture.
  102492. * @returns the cloned texture
  102493. */
  102494. clone(): MirrorTexture;
  102495. /**
  102496. * Serialize the texture to a JSON representation you could use in Parse later on
  102497. * @returns the serialized JSON representation
  102498. */
  102499. serialize(): any;
  102500. /**
  102501. * Dispose the texture and release its associated resources.
  102502. */
  102503. dispose(): void;
  102504. }
  102505. }
  102506. declare module BABYLON {
  102507. /**
  102508. * This represents a texture in babylon. It can be easily loaded from a network, base64 or html input.
  102509. * @see https://doc.babylonjs.com/babylon101/materials#texture
  102510. */
  102511. export class Texture extends BaseTexture {
  102512. /**
  102513. * Gets or sets a general boolean used to indicate that textures containing direct data (buffers) must be saved as part of the serialization process
  102514. */
  102515. static SerializeBuffers: boolean;
  102516. /** @hidden */
  102517. static _CubeTextureParser: (jsonTexture: any, scene: Scene, rootUrl: string) => CubeTexture;
  102518. /** @hidden */
  102519. static _CreateMirror: (name: string, renderTargetSize: number, scene: Scene, generateMipMaps: boolean) => MirrorTexture;
  102520. /** @hidden */
  102521. static _CreateRenderTargetTexture: (name: string, renderTargetSize: number, scene: Scene, generateMipMaps: boolean) => RenderTargetTexture;
  102522. /** nearest is mag = nearest and min = nearest and mip = linear */
  102523. static readonly NEAREST_SAMPLINGMODE: number;
  102524. /** nearest is mag = nearest and min = nearest and mip = linear */
  102525. static readonly NEAREST_NEAREST_MIPLINEAR: number;
  102526. /** Bilinear is mag = linear and min = linear and mip = nearest */
  102527. static readonly BILINEAR_SAMPLINGMODE: number;
  102528. /** Bilinear is mag = linear and min = linear and mip = nearest */
  102529. static readonly LINEAR_LINEAR_MIPNEAREST: number;
  102530. /** Trilinear is mag = linear and min = linear and mip = linear */
  102531. static readonly TRILINEAR_SAMPLINGMODE: number;
  102532. /** Trilinear is mag = linear and min = linear and mip = linear */
  102533. static readonly LINEAR_LINEAR_MIPLINEAR: number;
  102534. /** mag = nearest and min = nearest and mip = nearest */
  102535. static readonly NEAREST_NEAREST_MIPNEAREST: number;
  102536. /** mag = nearest and min = linear and mip = nearest */
  102537. static readonly NEAREST_LINEAR_MIPNEAREST: number;
  102538. /** mag = nearest and min = linear and mip = linear */
  102539. static readonly NEAREST_LINEAR_MIPLINEAR: number;
  102540. /** mag = nearest and min = linear and mip = none */
  102541. static readonly NEAREST_LINEAR: number;
  102542. /** mag = nearest and min = nearest and mip = none */
  102543. static readonly NEAREST_NEAREST: number;
  102544. /** mag = linear and min = nearest and mip = nearest */
  102545. static readonly LINEAR_NEAREST_MIPNEAREST: number;
  102546. /** mag = linear and min = nearest and mip = linear */
  102547. static readonly LINEAR_NEAREST_MIPLINEAR: number;
  102548. /** mag = linear and min = linear and mip = none */
  102549. static readonly LINEAR_LINEAR: number;
  102550. /** mag = linear and min = nearest and mip = none */
  102551. static readonly LINEAR_NEAREST: number;
  102552. /** Explicit coordinates mode */
  102553. static readonly EXPLICIT_MODE: number;
  102554. /** Spherical coordinates mode */
  102555. static readonly SPHERICAL_MODE: number;
  102556. /** Planar coordinates mode */
  102557. static readonly PLANAR_MODE: number;
  102558. /** Cubic coordinates mode */
  102559. static readonly CUBIC_MODE: number;
  102560. /** Projection coordinates mode */
  102561. static readonly PROJECTION_MODE: number;
  102562. /** Inverse Cubic coordinates mode */
  102563. static readonly SKYBOX_MODE: number;
  102564. /** Inverse Cubic coordinates mode */
  102565. static readonly INVCUBIC_MODE: number;
  102566. /** Equirectangular coordinates mode */
  102567. static readonly EQUIRECTANGULAR_MODE: number;
  102568. /** Equirectangular Fixed coordinates mode */
  102569. static readonly FIXED_EQUIRECTANGULAR_MODE: number;
  102570. /** Equirectangular Fixed Mirrored coordinates mode */
  102571. static readonly FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  102572. /** Texture is not repeating outside of 0..1 UVs */
  102573. static readonly CLAMP_ADDRESSMODE: number;
  102574. /** Texture is repeating outside of 0..1 UVs */
  102575. static readonly WRAP_ADDRESSMODE: number;
  102576. /** Texture is repeating and mirrored */
  102577. static readonly MIRROR_ADDRESSMODE: number;
  102578. /**
  102579. * 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
  102580. */
  102581. static UseSerializedUrlIfAny: boolean;
  102582. /**
  102583. * Define the url of the texture.
  102584. */
  102585. url: Nullable<string>;
  102586. /**
  102587. * Define an offset on the texture to offset the u coordinates of the UVs
  102588. * @see https://doc.babylonjs.com/how_to/more_materials#offsetting
  102589. */
  102590. uOffset: number;
  102591. /**
  102592. * Define an offset on the texture to offset the v coordinates of the UVs
  102593. * @see https://doc.babylonjs.com/how_to/more_materials#offsetting
  102594. */
  102595. vOffset: number;
  102596. /**
  102597. * Define an offset on the texture to scale the u coordinates of the UVs
  102598. * @see https://doc.babylonjs.com/how_to/more_materials#tiling
  102599. */
  102600. uScale: number;
  102601. /**
  102602. * Define an offset on the texture to scale the v coordinates of the UVs
  102603. * @see https://doc.babylonjs.com/how_to/more_materials#tiling
  102604. */
  102605. vScale: number;
  102606. /**
  102607. * Define an offset on the texture to rotate around the u coordinates of the UVs
  102608. * @see https://doc.babylonjs.com/how_to/more_materials
  102609. */
  102610. uAng: number;
  102611. /**
  102612. * Define an offset on the texture to rotate around the v coordinates of the UVs
  102613. * @see https://doc.babylonjs.com/how_to/more_materials
  102614. */
  102615. vAng: number;
  102616. /**
  102617. * Define an offset on the texture to rotate around the w coordinates of the UVs (in case of 3d texture)
  102618. * @see https://doc.babylonjs.com/how_to/more_materials
  102619. */
  102620. wAng: number;
  102621. /**
  102622. * Defines the center of rotation (U)
  102623. */
  102624. uRotationCenter: number;
  102625. /**
  102626. * Defines the center of rotation (V)
  102627. */
  102628. vRotationCenter: number;
  102629. /**
  102630. * Defines the center of rotation (W)
  102631. */
  102632. wRotationCenter: number;
  102633. /**
  102634. * Are mip maps generated for this texture or not.
  102635. */
  102636. get noMipmap(): boolean;
  102637. /**
  102638. * List of inspectable custom properties (used by the Inspector)
  102639. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  102640. */
  102641. inspectableCustomProperties: Nullable<IInspectable[]>;
  102642. private _noMipmap;
  102643. /** @hidden */
  102644. _invertY: boolean;
  102645. private _rowGenerationMatrix;
  102646. private _cachedTextureMatrix;
  102647. private _projectionModeMatrix;
  102648. private _t0;
  102649. private _t1;
  102650. private _t2;
  102651. private _cachedUOffset;
  102652. private _cachedVOffset;
  102653. private _cachedUScale;
  102654. private _cachedVScale;
  102655. private _cachedUAng;
  102656. private _cachedVAng;
  102657. private _cachedWAng;
  102658. private _cachedProjectionMatrixId;
  102659. private _cachedCoordinatesMode;
  102660. /** @hidden */
  102661. protected _initialSamplingMode: number;
  102662. /** @hidden */
  102663. _buffer: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>;
  102664. private _deleteBuffer;
  102665. protected _format: Nullable<number>;
  102666. private _delayedOnLoad;
  102667. private _delayedOnError;
  102668. private _mimeType?;
  102669. /**
  102670. * Observable triggered once the texture has been loaded.
  102671. */
  102672. onLoadObservable: Observable<Texture>;
  102673. protected _isBlocking: boolean;
  102674. /**
  102675. * Is the texture preventing material to render while loading.
  102676. * If false, a default texture will be used instead of the loading one during the preparation step.
  102677. */
  102678. set isBlocking(value: boolean);
  102679. get isBlocking(): boolean;
  102680. /**
  102681. * Get the current sampling mode associated with the texture.
  102682. */
  102683. get samplingMode(): number;
  102684. /**
  102685. * Gets a boolean indicating if the texture needs to be inverted on the y axis during loading
  102686. */
  102687. get invertY(): boolean;
  102688. /**
  102689. * Instantiates a new texture.
  102690. * This represents a texture in babylon. It can be easily loaded from a network, base64 or html input.
  102691. * @see https://doc.babylonjs.com/babylon101/materials#texture
  102692. * @param url defines the url of the picture to load as a texture
  102693. * @param sceneOrEngine defines the scene or engine the texture will belong to
  102694. * @param noMipmap defines if the texture will require mip maps or not
  102695. * @param invertY defines if the texture needs to be inverted on the y axis during loading
  102696. * @param samplingMode defines the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  102697. * @param onLoad defines a callback triggered when the texture has been loaded
  102698. * @param onError defines a callback triggered when an error occurred during the loading session
  102699. * @param buffer defines the buffer to load the texture from in case the texture is loaded from a buffer representation
  102700. * @param deleteBuffer defines if the buffer we are loading the texture from should be deleted after load
  102701. * @param format defines the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  102702. * @param mimeType defines an optional mime type information
  102703. */
  102704. 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);
  102705. /**
  102706. * Update the url (and optional buffer) of this texture if url was null during construction.
  102707. * @param url the url of the texture
  102708. * @param buffer the buffer of the texture (defaults to null)
  102709. * @param onLoad callback called when the texture is loaded (defaults to null)
  102710. */
  102711. updateURL(url: string, buffer?: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob>, onLoad?: () => void): void;
  102712. /**
  102713. * Finish the loading sequence of a texture flagged as delayed load.
  102714. * @hidden
  102715. */
  102716. delayLoad(): void;
  102717. private _prepareRowForTextureGeneration;
  102718. /**
  102719. * Get the current texture matrix which includes the requested offsetting, tiling and rotation components.
  102720. * @returns the transform matrix of the texture.
  102721. */
  102722. getTextureMatrix(uBase?: number): Matrix;
  102723. /**
  102724. * Get the current matrix used to apply reflection. This is useful to rotate an environment texture for instance.
  102725. * @returns The reflection texture transform
  102726. */
  102727. getReflectionTextureMatrix(): Matrix;
  102728. /**
  102729. * Clones the texture.
  102730. * @returns the cloned texture
  102731. */
  102732. clone(): Texture;
  102733. /**
  102734. * Serialize the texture to a JSON representation we can easily use in the resepective Parse function.
  102735. * @returns The JSON representation of the texture
  102736. */
  102737. serialize(): any;
  102738. /**
  102739. * Get the current class name of the texture useful for serialization or dynamic coding.
  102740. * @returns "Texture"
  102741. */
  102742. getClassName(): string;
  102743. /**
  102744. * Dispose the texture and release its associated resources.
  102745. */
  102746. dispose(): void;
  102747. /**
  102748. * Parse the JSON representation of a texture in order to recreate the texture in the given scene.
  102749. * @param parsedTexture Define the JSON representation of the texture
  102750. * @param scene Define the scene the parsed texture should be instantiated in
  102751. * @param rootUrl Define the root url of the parsing sequence in the case of relative dependencies
  102752. * @returns The parsed texture if successful
  102753. */
  102754. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): Nullable<BaseTexture>;
  102755. /**
  102756. * Creates a texture from its base 64 representation.
  102757. * @param data Define the base64 payload without the data: prefix
  102758. * @param name Define the name of the texture in the scene useful fo caching purpose for instance
  102759. * @param scene Define the scene the texture should belong to
  102760. * @param noMipmap Forces the texture to not create mip map information if true
  102761. * @param invertY define if the texture needs to be inverted on the y axis during loading
  102762. * @param samplingMode define the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  102763. * @param onLoad define a callback triggered when the texture has been loaded
  102764. * @param onError define a callback triggered when an error occurred during the loading session
  102765. * @param format define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  102766. * @returns the created texture
  102767. */
  102768. static CreateFromBase64String(data: string, name: string, scene: Scene, noMipmap?: boolean, invertY?: boolean, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<() => void>, format?: number): Texture;
  102769. /**
  102770. * Creates a texture from its data: representation. (data: will be added in case only the payload has been passed in)
  102771. * @param data Define the base64 payload without the data: prefix
  102772. * @param name Define the name of the texture in the scene useful fo caching purpose for instance
  102773. * @param buffer define the buffer to load the texture from in case the texture is loaded from a buffer representation
  102774. * @param scene Define the scene the texture should belong to
  102775. * @param deleteBuffer define if the buffer we are loading the texture from should be deleted after load
  102776. * @param noMipmap Forces the texture to not create mip map information if true
  102777. * @param invertY define if the texture needs to be inverted on the y axis during loading
  102778. * @param samplingMode define the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  102779. * @param onLoad define a callback triggered when the texture has been loaded
  102780. * @param onError define a callback triggered when an error occurred during the loading session
  102781. * @param format define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  102782. * @returns the created texture
  102783. */
  102784. 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;
  102785. }
  102786. }
  102787. declare module BABYLON {
  102788. /**
  102789. * PostProcessManager is used to manage one or more post processes or post process pipelines
  102790. * See https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  102791. */
  102792. export class PostProcessManager {
  102793. private _scene;
  102794. private _indexBuffer;
  102795. private _vertexBuffers;
  102796. /**
  102797. * Creates a new instance PostProcess
  102798. * @param scene The scene that the post process is associated with.
  102799. */
  102800. constructor(scene: Scene);
  102801. private _prepareBuffers;
  102802. private _buildIndexBuffer;
  102803. /**
  102804. * Rebuilds the vertex buffers of the manager.
  102805. * @hidden
  102806. */
  102807. _rebuild(): void;
  102808. /**
  102809. * Prepares a frame to be run through a post process.
  102810. * @param sourceTexture The input texture to the post procesess. (default: null)
  102811. * @param postProcesses An array of post processes to be run. (default: null)
  102812. * @returns True if the post processes were able to be run.
  102813. * @hidden
  102814. */
  102815. _prepareFrame(sourceTexture?: Nullable<InternalTexture>, postProcesses?: Nullable<PostProcess[]>): boolean;
  102816. /**
  102817. * Manually render a set of post processes to a texture.
  102818. * Please note, the frame buffer won't be unbound after the call in case you have more render to do.
  102819. * @param postProcesses An array of post processes to be run.
  102820. * @param targetTexture The target texture to render to.
  102821. * @param forceFullscreenViewport force gl.viewport to be full screen eg. 0,0,textureWidth,textureHeight
  102822. * @param faceIndex defines the face to render to if a cubemap is defined as the target
  102823. * @param lodLevel defines which lod of the texture to render to
  102824. * @param doNotBindFrambuffer If set to true, assumes that the framebuffer has been bound previously
  102825. */
  102826. directRender(postProcesses: PostProcess[], targetTexture?: Nullable<InternalTexture>, forceFullscreenViewport?: boolean, faceIndex?: number, lodLevel?: number, doNotBindFrambuffer?: boolean): void;
  102827. /**
  102828. * Finalize the result of the output of the postprocesses.
  102829. * @param doNotPresent If true the result will not be displayed to the screen.
  102830. * @param targetTexture The target texture to render to.
  102831. * @param faceIndex The index of the face to bind the target texture to.
  102832. * @param postProcesses The array of post processes to render.
  102833. * @param forceFullscreenViewport force gl.viewport to be full screen eg. 0,0,textureWidth,textureHeight (default: false)
  102834. * @hidden
  102835. */
  102836. _finalizeFrame(doNotPresent?: boolean, targetTexture?: InternalTexture, faceIndex?: number, postProcesses?: Array<PostProcess>, forceFullscreenViewport?: boolean): void;
  102837. /**
  102838. * Disposes of the post process manager.
  102839. */
  102840. dispose(): void;
  102841. }
  102842. }
  102843. declare module BABYLON {
  102844. /**
  102845. * This Helps creating a texture that will be created from a camera in your scene.
  102846. * It is basically a dynamic texture that could be used to create special effects for instance.
  102847. * Actually, It is the base of lot of effects in the framework like post process, shadows, effect layers and rendering pipelines...
  102848. */
  102849. export class RenderTargetTexture extends Texture {
  102850. isCube: boolean;
  102851. /**
  102852. * The texture will only be rendered once which can be useful to improve performance if everything in your render is static for instance.
  102853. */
  102854. static readonly REFRESHRATE_RENDER_ONCE: number;
  102855. /**
  102856. * The texture will only be rendered rendered every frame and is recomended for dynamic contents.
  102857. */
  102858. static readonly REFRESHRATE_RENDER_ONEVERYFRAME: number;
  102859. /**
  102860. * The texture will be rendered every 2 frames which could be enough if your dynamic objects are not
  102861. * the central point of your effect and can save a lot of performances.
  102862. */
  102863. static readonly REFRESHRATE_RENDER_ONEVERYTWOFRAMES: number;
  102864. /**
  102865. * Use this predicate to dynamically define the list of mesh you want to render.
  102866. * If set, the renderList property will be overwritten.
  102867. */
  102868. renderListPredicate: (AbstractMesh: AbstractMesh) => boolean;
  102869. private _renderList;
  102870. /**
  102871. * Use this list to define the list of mesh you want to render.
  102872. */
  102873. get renderList(): Nullable<Array<AbstractMesh>>;
  102874. set renderList(value: Nullable<Array<AbstractMesh>>);
  102875. /**
  102876. * Use this function to overload the renderList array at rendering time.
  102877. * Return null to render with the curent renderList, else return the list of meshes to use for rendering.
  102878. * For 2DArray RTT, layerOrFace is the index of the layer that is going to be rendered, else it is the faceIndex of
  102879. * the cube (if the RTT is a cube, else layerOrFace=0).
  102880. * The renderList passed to the function is the current render list (the one that will be used if the function returns null).
  102881. * The length of this list is passed through renderListLength: don't use renderList.length directly because the array can
  102882. * hold dummy elements!
  102883. */
  102884. getCustomRenderList: (layerOrFace: number, renderList: Nullable<Immutable<Array<AbstractMesh>>>, renderListLength: number) => Nullable<Array<AbstractMesh>>;
  102885. private _hookArray;
  102886. /**
  102887. * Define if particles should be rendered in your texture.
  102888. */
  102889. renderParticles: boolean;
  102890. /**
  102891. * Define if sprites should be rendered in your texture.
  102892. */
  102893. renderSprites: boolean;
  102894. /**
  102895. * Override the default coordinates mode to projection for RTT as it is the most common case for rendered textures.
  102896. */
  102897. coordinatesMode: number;
  102898. /**
  102899. * Define the camera used to render the texture.
  102900. */
  102901. activeCamera: Nullable<Camera>;
  102902. /**
  102903. * Override the mesh isReady function with your own one.
  102904. */
  102905. customIsReadyFunction: (mesh: AbstractMesh, refreshRate: number) => boolean;
  102906. /**
  102907. * Override the render function of the texture with your own one.
  102908. */
  102909. customRenderFunction: (opaqueSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>, beforeTransparents?: () => void) => void;
  102910. /**
  102911. * Define if camera post processes should be use while rendering the texture.
  102912. */
  102913. useCameraPostProcesses: boolean;
  102914. /**
  102915. * Define if the camera viewport should be respected while rendering the texture or if the render should be done to the entire texture.
  102916. */
  102917. ignoreCameraViewport: boolean;
  102918. private _postProcessManager;
  102919. private _postProcesses;
  102920. private _resizeObserver;
  102921. /**
  102922. * An event triggered when the texture is unbind.
  102923. */
  102924. onBeforeBindObservable: Observable<RenderTargetTexture>;
  102925. /**
  102926. * An event triggered when the texture is unbind.
  102927. */
  102928. onAfterUnbindObservable: Observable<RenderTargetTexture>;
  102929. private _onAfterUnbindObserver;
  102930. /**
  102931. * Set a after unbind callback in the texture.
  102932. * This has been kept for backward compatibility and use of onAfterUnbindObservable is recommended.
  102933. */
  102934. set onAfterUnbind(callback: () => void);
  102935. /**
  102936. * An event triggered before rendering the texture
  102937. */
  102938. onBeforeRenderObservable: Observable<number>;
  102939. private _onBeforeRenderObserver;
  102940. /**
  102941. * Set a before render callback in the texture.
  102942. * This has been kept for backward compatibility and use of onBeforeRenderObservable is recommended.
  102943. */
  102944. set onBeforeRender(callback: (faceIndex: number) => void);
  102945. /**
  102946. * An event triggered after rendering the texture
  102947. */
  102948. onAfterRenderObservable: Observable<number>;
  102949. private _onAfterRenderObserver;
  102950. /**
  102951. * Set a after render callback in the texture.
  102952. * This has been kept for backward compatibility and use of onAfterRenderObservable is recommended.
  102953. */
  102954. set onAfterRender(callback: (faceIndex: number) => void);
  102955. /**
  102956. * An event triggered after the texture clear
  102957. */
  102958. onClearObservable: Observable<Engine>;
  102959. private _onClearObserver;
  102960. /**
  102961. * Set a clear callback in the texture.
  102962. * This has been kept for backward compatibility and use of onClearObservable is recommended.
  102963. */
  102964. set onClear(callback: (Engine: Engine) => void);
  102965. /**
  102966. * An event triggered when the texture is resized.
  102967. */
  102968. onResizeObservable: Observable<RenderTargetTexture>;
  102969. /**
  102970. * Define the clear color of the Render Target if it should be different from the scene.
  102971. */
  102972. clearColor: Color4;
  102973. protected _size: number | {
  102974. width: number;
  102975. height: number;
  102976. layers?: number;
  102977. };
  102978. protected _initialSizeParameter: number | {
  102979. width: number;
  102980. height: number;
  102981. } | {
  102982. ratio: number;
  102983. };
  102984. protected _sizeRatio: Nullable<number>;
  102985. /** @hidden */
  102986. _generateMipMaps: boolean;
  102987. protected _renderingManager: RenderingManager;
  102988. /** @hidden */
  102989. _waitingRenderList: string[];
  102990. protected _doNotChangeAspectRatio: boolean;
  102991. protected _currentRefreshId: number;
  102992. protected _refreshRate: number;
  102993. protected _textureMatrix: Matrix;
  102994. protected _samples: number;
  102995. protected _renderTargetOptions: RenderTargetCreationOptions;
  102996. /**
  102997. * Gets render target creation options that were used.
  102998. */
  102999. get renderTargetOptions(): RenderTargetCreationOptions;
  103000. protected _onRatioRescale(): void;
  103001. /**
  103002. * Gets or sets the center of the bounding box associated with the texture (when in cube mode)
  103003. * It must define where the camera used to render the texture is set
  103004. */
  103005. boundingBoxPosition: Vector3;
  103006. private _boundingBoxSize;
  103007. /**
  103008. * Gets or sets the size of the bounding box associated with the texture (when in cube mode)
  103009. * When defined, the cubemap will switch to local mode
  103010. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  103011. * @example https://www.babylonjs-playground.com/#RNASML
  103012. */
  103013. set boundingBoxSize(value: Vector3);
  103014. get boundingBoxSize(): Vector3;
  103015. /**
  103016. * In case the RTT has been created with a depth texture, get the associated
  103017. * depth texture.
  103018. * Otherwise, return null.
  103019. */
  103020. get depthStencilTexture(): Nullable<InternalTexture>;
  103021. /**
  103022. * Instantiate a render target texture. This is mainly used to render of screen the scene to for instance apply post processse
  103023. * or used a shadow, depth texture...
  103024. * @param name The friendly name of the texture
  103025. * @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)
  103026. * @param scene The scene the RTT belongs to. The latest created scene will be used if not precised.
  103027. * @param generateMipMaps True if mip maps need to be generated after render.
  103028. * @param doNotChangeAspectRatio True to not change the aspect ratio of the scene in the RTT
  103029. * @param type The type of the buffer in the RTT (int, half float, float...)
  103030. * @param isCube True if a cube texture needs to be created
  103031. * @param samplingMode The sampling mode to be usedwith the render target (Linear, Nearest...)
  103032. * @param generateDepthBuffer True to generate a depth buffer
  103033. * @param generateStencilBuffer True to generate a stencil buffer
  103034. * @param isMulti True if multiple textures need to be created (Draw Buffers)
  103035. * @param format The internal format of the buffer in the RTT (RED, RG, RGB, RGBA, ALPHA...)
  103036. * @param delayAllocation if the texture allocation should be delayed (default: false)
  103037. */
  103038. constructor(name: string, size: number | {
  103039. width: number;
  103040. height: number;
  103041. layers?: number;
  103042. } | {
  103043. ratio: number;
  103044. }, scene: Nullable<Scene>, generateMipMaps?: boolean, doNotChangeAspectRatio?: boolean, type?: number, isCube?: boolean, samplingMode?: number, generateDepthBuffer?: boolean, generateStencilBuffer?: boolean, isMulti?: boolean, format?: number, delayAllocation?: boolean);
  103045. /**
  103046. * Creates a depth stencil texture.
  103047. * This is only available in WebGL 2 or with the depth texture extension available.
  103048. * @param comparisonFunction Specifies the comparison function to set on the texture. If 0 or undefined, the texture is not in comparison mode
  103049. * @param bilinearFiltering Specifies whether or not bilinear filtering is enable on the texture
  103050. * @param generateStencil Specifies whether or not a stencil should be allocated in the texture
  103051. */
  103052. createDepthStencilTexture(comparisonFunction?: number, bilinearFiltering?: boolean, generateStencil?: boolean): void;
  103053. private _processSizeParameter;
  103054. /**
  103055. * Define the number of samples to use in case of MSAA.
  103056. * It defaults to one meaning no MSAA has been enabled.
  103057. */
  103058. get samples(): number;
  103059. set samples(value: number);
  103060. /**
  103061. * Resets the refresh counter of the texture and start bak from scratch.
  103062. * Could be useful to regenerate the texture if it is setup to render only once.
  103063. */
  103064. resetRefreshCounter(): void;
  103065. /**
  103066. * Define the refresh rate of the texture or the rendering frequency.
  103067. * Use 0 to render just once, 1 to render on every frame, 2 to render every two frames and so on...
  103068. */
  103069. get refreshRate(): number;
  103070. set refreshRate(value: number);
  103071. /**
  103072. * Adds a post process to the render target rendering passes.
  103073. * @param postProcess define the post process to add
  103074. */
  103075. addPostProcess(postProcess: PostProcess): void;
  103076. /**
  103077. * Clear all the post processes attached to the render target
  103078. * @param dispose define if the cleared post processesshould also be disposed (false by default)
  103079. */
  103080. clearPostProcesses(dispose?: boolean): void;
  103081. /**
  103082. * Remove one of the post process from the list of attached post processes to the texture
  103083. * @param postProcess define the post process to remove from the list
  103084. */
  103085. removePostProcess(postProcess: PostProcess): void;
  103086. /** @hidden */
  103087. _shouldRender(): boolean;
  103088. /**
  103089. * Gets the actual render size of the texture.
  103090. * @returns the width of the render size
  103091. */
  103092. getRenderSize(): number;
  103093. /**
  103094. * Gets the actual render width of the texture.
  103095. * @returns the width of the render size
  103096. */
  103097. getRenderWidth(): number;
  103098. /**
  103099. * Gets the actual render height of the texture.
  103100. * @returns the height of the render size
  103101. */
  103102. getRenderHeight(): number;
  103103. /**
  103104. * Gets the actual number of layers of the texture.
  103105. * @returns the number of layers
  103106. */
  103107. getRenderLayers(): number;
  103108. /**
  103109. * Get if the texture can be rescaled or not.
  103110. */
  103111. get canRescale(): boolean;
  103112. /**
  103113. * Resize the texture using a ratio.
  103114. * @param ratio the ratio to apply to the texture size in order to compute the new target size
  103115. */
  103116. scale(ratio: number): void;
  103117. /**
  103118. * Get the texture reflection matrix used to rotate/transform the reflection.
  103119. * @returns the reflection matrix
  103120. */
  103121. getReflectionTextureMatrix(): Matrix;
  103122. /**
  103123. * Resize the texture to a new desired size.
  103124. * Be carrefull as it will recreate all the data in the new texture.
  103125. * @param size Define the new size. It can be:
  103126. * - a number for squared texture,
  103127. * - an object containing { width: number, height: number }
  103128. * - or an object containing a ratio { ratio: number }
  103129. */
  103130. resize(size: number | {
  103131. width: number;
  103132. height: number;
  103133. } | {
  103134. ratio: number;
  103135. }): void;
  103136. private _defaultRenderListPrepared;
  103137. /**
  103138. * Renders all the objects from the render list into the texture.
  103139. * @param useCameraPostProcess Define if camera post processes should be used during the rendering
  103140. * @param dumpForDebug Define if the rendering result should be dumped (copied) for debugging purpose
  103141. */
  103142. render(useCameraPostProcess?: boolean, dumpForDebug?: boolean): void;
  103143. private _bestReflectionRenderTargetDimension;
  103144. private _prepareRenderingManager;
  103145. /**
  103146. * @hidden
  103147. * @param faceIndex face index to bind to if this is a cubetexture
  103148. * @param layer defines the index of the texture to bind in the array
  103149. */
  103150. _bindFrameBuffer(faceIndex?: number, layer?: number): void;
  103151. protected unbindFrameBuffer(engine: Engine, faceIndex: number): void;
  103152. private renderToTarget;
  103153. /**
  103154. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  103155. * This allowed control for front to back rendering or reversly depending of the special needs.
  103156. *
  103157. * @param renderingGroupId The rendering group id corresponding to its index
  103158. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  103159. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  103160. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  103161. */
  103162. 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;
  103163. /**
  103164. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  103165. *
  103166. * @param renderingGroupId The rendering group id corresponding to its index
  103167. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  103168. */
  103169. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean): void;
  103170. /**
  103171. * Clones the texture.
  103172. * @returns the cloned texture
  103173. */
  103174. clone(): RenderTargetTexture;
  103175. /**
  103176. * Serialize the texture to a JSON representation we can easily use in the resepective Parse function.
  103177. * @returns The JSON representation of the texture
  103178. */
  103179. serialize(): any;
  103180. /**
  103181. * This will remove the attached framebuffer objects. The texture will not be able to be used as render target anymore
  103182. */
  103183. disposeFramebufferObjects(): void;
  103184. /**
  103185. * Dispose the texture and release its associated resources.
  103186. */
  103187. dispose(): void;
  103188. /** @hidden */
  103189. _rebuild(): void;
  103190. /**
  103191. * Clear the info related to rendering groups preventing retention point in material dispose.
  103192. */
  103193. freeRenderingGroups(): void;
  103194. /**
  103195. * Gets the number of views the corresponding to the texture (eg. a MultiviewRenderTarget will have > 1)
  103196. * @returns the view count
  103197. */
  103198. getViewCount(): number;
  103199. }
  103200. }
  103201. declare module BABYLON {
  103202. /**
  103203. * Class used to manipulate GUIDs
  103204. */
  103205. export class GUID {
  103206. /**
  103207. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  103208. * Be aware Math.random() could cause collisions, but:
  103209. * "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"
  103210. * @returns a pseudo random id
  103211. */
  103212. static RandomId(): string;
  103213. }
  103214. }
  103215. declare module BABYLON {
  103216. /**
  103217. * Options to be used when creating a shadow depth material
  103218. */
  103219. export interface IIOptionShadowDepthMaterial {
  103220. /** Variables in the vertex shader code that need to have their names remapped.
  103221. * The format is: ["var_name", "var_remapped_name", "var_name", "var_remapped_name", ...]
  103222. * "var_name" should be either: worldPos or vNormalW
  103223. * So, if the variable holding the world position in your vertex shader is not named worldPos, you must tell the system
  103224. * the name to use instead by using: ["worldPos", "myWorldPosVar"] assuming the variable is named myWorldPosVar in your code.
  103225. * If the normal must also be remapped: ["worldPos", "myWorldPosVar", "vNormalW", "myWorldNormal"]
  103226. */
  103227. remappedVariables?: string[];
  103228. /** Set standalone to true if the base material wrapped by ShadowDepthMaterial is not used for a regular object but for depth shadow generation only */
  103229. standalone?: boolean;
  103230. }
  103231. /**
  103232. * Class that can be used to wrap a base material to generate accurate shadows when using custom vertex/fragment code in the base material
  103233. */
  103234. export class ShadowDepthWrapper {
  103235. private _scene;
  103236. private _options?;
  103237. private _baseMaterial;
  103238. private _onEffectCreatedObserver;
  103239. private _subMeshToEffect;
  103240. private _subMeshToDepthEffect;
  103241. private _meshes;
  103242. /** @hidden */
  103243. _matriceNames: any;
  103244. /** Gets the standalone status of the wrapper */
  103245. get standalone(): boolean;
  103246. /** Gets the base material the wrapper is built upon */
  103247. get baseMaterial(): Material;
  103248. /**
  103249. * Instantiate a new shadow depth wrapper.
  103250. * It works by injecting some specific code in the vertex/fragment shaders of the base material and is used by a shadow generator to
  103251. * generate the shadow depth map. For more information, please refer to the documentation:
  103252. * https://doc.babylonjs.com/babylon101/shadows
  103253. * @param baseMaterial Material to wrap
  103254. * @param scene Define the scene the material belongs to
  103255. * @param options Options used to create the wrapper
  103256. */
  103257. constructor(baseMaterial: Material, scene: Scene, options?: IIOptionShadowDepthMaterial);
  103258. /**
  103259. * Gets the effect to use to generate the depth map
  103260. * @param subMesh subMesh to get the effect for
  103261. * @param shadowGenerator shadow generator to get the effect for
  103262. * @returns the effect to use to generate the depth map for the subMesh + shadow generator specified
  103263. */
  103264. getEffect(subMesh: Nullable<SubMesh>, shadowGenerator: ShadowGenerator): Nullable<Effect>;
  103265. /**
  103266. * Specifies that the submesh is ready to be used for depth rendering
  103267. * @param subMesh submesh to check
  103268. * @param defines the list of defines to take into account when checking the effect
  103269. * @param shadowGenerator combined with subMesh, it defines the effect to check
  103270. * @param useInstances specifies that instances should be used
  103271. * @returns a boolean indicating that the submesh is ready or not
  103272. */
  103273. isReadyForSubMesh(subMesh: SubMesh, defines: string[], shadowGenerator: ShadowGenerator, useInstances: boolean): boolean;
  103274. /**
  103275. * Disposes the resources
  103276. */
  103277. dispose(): void;
  103278. private _makeEffect;
  103279. }
  103280. }
  103281. declare module BABYLON {
  103282. interface ThinEngine {
  103283. /**
  103284. * Unbind a list of render target textures from the webGL context
  103285. * This is used only when drawBuffer extension or webGL2 are active
  103286. * @param textures defines the render target textures to unbind
  103287. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  103288. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  103289. */
  103290. unBindMultiColorAttachmentFramebuffer(textures: InternalTexture[], disableGenerateMipMaps: boolean, onBeforeUnbind?: () => void): void;
  103291. /**
  103292. * Create a multi render target texture
  103293. * @see https://doc.babylonjs.com/features/webgl2#multiple-render-target
  103294. * @param size defines the size of the texture
  103295. * @param options defines the creation options
  103296. * @returns the cube texture as an InternalTexture
  103297. */
  103298. createMultipleRenderTarget(size: any, options: IMultiRenderTargetOptions): InternalTexture[];
  103299. /**
  103300. * Update the sample count for a given multiple render target texture
  103301. * @see https://doc.babylonjs.com/features/webgl2#multisample-render-targets
  103302. * @param textures defines the textures to update
  103303. * @param samples defines the sample count to set
  103304. * @returns the effective sample count (could be 0 if multisample render targets are not supported)
  103305. */
  103306. updateMultipleRenderTargetTextureSampleCount(textures: Nullable<InternalTexture[]>, samples: number): number;
  103307. /**
  103308. * Select a subsets of attachments to draw to.
  103309. * @param attachments gl attachments
  103310. */
  103311. bindAttachments(attachments: number[]): void;
  103312. }
  103313. }
  103314. declare module BABYLON {
  103315. /**
  103316. * Creation options of the multi render target texture.
  103317. */
  103318. export interface IMultiRenderTargetOptions {
  103319. /**
  103320. * Define if the texture needs to create mip maps after render.
  103321. */
  103322. generateMipMaps?: boolean;
  103323. /**
  103324. * Define the types of all the draw buffers we want to create
  103325. */
  103326. types?: number[];
  103327. /**
  103328. * Define the sampling modes of all the draw buffers we want to create
  103329. */
  103330. samplingModes?: number[];
  103331. /**
  103332. * Define if a depth buffer is required
  103333. */
  103334. generateDepthBuffer?: boolean;
  103335. /**
  103336. * Define if a stencil buffer is required
  103337. */
  103338. generateStencilBuffer?: boolean;
  103339. /**
  103340. * Define if a depth texture is required instead of a depth buffer
  103341. */
  103342. generateDepthTexture?: boolean;
  103343. /**
  103344. * Define the number of desired draw buffers
  103345. */
  103346. textureCount?: number;
  103347. /**
  103348. * Define if aspect ratio should be adapted to the texture or stay the scene one
  103349. */
  103350. doNotChangeAspectRatio?: boolean;
  103351. /**
  103352. * Define the default type of the buffers we are creating
  103353. */
  103354. defaultType?: number;
  103355. }
  103356. /**
  103357. * A multi render target, like a render target provides the ability to render to a texture.
  103358. * Unlike the render target, it can render to several draw buffers in one draw.
  103359. * This is specially interesting in deferred rendering or for any effects requiring more than
  103360. * just one color from a single pass.
  103361. */
  103362. export class MultiRenderTarget extends RenderTargetTexture {
  103363. private _internalTextures;
  103364. private _textures;
  103365. private _multiRenderTargetOptions;
  103366. private _count;
  103367. /**
  103368. * Get if draw buffers are currently supported by the used hardware and browser.
  103369. */
  103370. get isSupported(): boolean;
  103371. /**
  103372. * Get the list of textures generated by the multi render target.
  103373. */
  103374. get textures(): Texture[];
  103375. /**
  103376. * Gets the number of textures in this MRT. This number can be different from `_textures.length` in case a depth texture is generated.
  103377. */
  103378. get count(): number;
  103379. /**
  103380. * Get the depth texture generated by the multi render target if options.generateDepthTexture has been set
  103381. */
  103382. get depthTexture(): Texture;
  103383. /**
  103384. * Set the wrapping mode on U of all the textures we are rendering to.
  103385. * Can be any of the Texture. (CLAMP_ADDRESSMODE, MIRROR_ADDRESSMODE or WRAP_ADDRESSMODE)
  103386. */
  103387. set wrapU(wrap: number);
  103388. /**
  103389. * Set the wrapping mode on V of all the textures we are rendering to.
  103390. * Can be any of the Texture. (CLAMP_ADDRESSMODE, MIRROR_ADDRESSMODE or WRAP_ADDRESSMODE)
  103391. */
  103392. set wrapV(wrap: number);
  103393. /**
  103394. * Instantiate a new multi render target texture.
  103395. * A multi render target, like a render target provides the ability to render to a texture.
  103396. * Unlike the render target, it can render to several draw buffers in one draw.
  103397. * This is specially interesting in deferred rendering or for any effects requiring more than
  103398. * just one color from a single pass.
  103399. * @param name Define the name of the texture
  103400. * @param size Define the size of the buffers to render to
  103401. * @param count Define the number of target we are rendering into
  103402. * @param scene Define the scene the texture belongs to
  103403. * @param options Define the options used to create the multi render target
  103404. */
  103405. constructor(name: string, size: any, count: number, scene: Scene, options?: IMultiRenderTargetOptions);
  103406. /** @hidden */
  103407. _rebuild(): void;
  103408. private _createInternalTextures;
  103409. private _createTextures;
  103410. /**
  103411. * Define the number of samples used if MSAA is enabled.
  103412. */
  103413. get samples(): number;
  103414. set samples(value: number);
  103415. /**
  103416. * Resize all the textures in the multi render target.
  103417. * Be carrefull as it will recreate all the data in the new texture.
  103418. * @param size Define the new size
  103419. */
  103420. resize(size: any): void;
  103421. protected unbindFrameBuffer(engine: Engine, faceIndex: number): void;
  103422. /**
  103423. * Dispose the render targets and their associated resources
  103424. */
  103425. dispose(): void;
  103426. /**
  103427. * Release all the underlying texture used as draw buffers.
  103428. */
  103429. releaseInternalTextures(): void;
  103430. }
  103431. }
  103432. declare module BABYLON {
  103433. /** @hidden */
  103434. export var imageProcessingPixelShader: {
  103435. name: string;
  103436. shader: string;
  103437. };
  103438. }
  103439. declare module BABYLON {
  103440. /**
  103441. * ImageProcessingPostProcess
  103442. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#imageprocessing
  103443. */
  103444. export class ImageProcessingPostProcess extends PostProcess {
  103445. /**
  103446. * Default configuration related to image processing available in the PBR Material.
  103447. */
  103448. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  103449. /**
  103450. * Gets the image processing configuration used either in this material.
  103451. */
  103452. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  103453. /**
  103454. * Sets the Default image processing configuration used either in the this material.
  103455. *
  103456. * If sets to null, the scene one is in use.
  103457. */
  103458. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  103459. /**
  103460. * Keep track of the image processing observer to allow dispose and replace.
  103461. */
  103462. private _imageProcessingObserver;
  103463. /**
  103464. * Attaches a new image processing configuration to the PBR Material.
  103465. * @param configuration
  103466. */
  103467. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>, doNotBuild?: boolean): void;
  103468. /**
  103469. * If the post process is supported.
  103470. */
  103471. get isSupported(): boolean;
  103472. /**
  103473. * Gets Color curves setup used in the effect if colorCurvesEnabled is set to true .
  103474. */
  103475. get colorCurves(): Nullable<ColorCurves>;
  103476. /**
  103477. * Sets Color curves setup used in the effect if colorCurvesEnabled is set to true .
  103478. */
  103479. set colorCurves(value: Nullable<ColorCurves>);
  103480. /**
  103481. * Gets wether the color curves effect is enabled.
  103482. */
  103483. get colorCurvesEnabled(): boolean;
  103484. /**
  103485. * Sets wether the color curves effect is enabled.
  103486. */
  103487. set colorCurvesEnabled(value: boolean);
  103488. /**
  103489. * Gets Color grading LUT texture used in the effect if colorGradingEnabled is set to true.
  103490. */
  103491. get colorGradingTexture(): Nullable<BaseTexture>;
  103492. /**
  103493. * Sets Color grading LUT texture used in the effect if colorGradingEnabled is set to true.
  103494. */
  103495. set colorGradingTexture(value: Nullable<BaseTexture>);
  103496. /**
  103497. * Gets wether the color grading effect is enabled.
  103498. */
  103499. get colorGradingEnabled(): boolean;
  103500. /**
  103501. * Gets wether the color grading effect is enabled.
  103502. */
  103503. set colorGradingEnabled(value: boolean);
  103504. /**
  103505. * Gets exposure used in the effect.
  103506. */
  103507. get exposure(): number;
  103508. /**
  103509. * Sets exposure used in the effect.
  103510. */
  103511. set exposure(value: number);
  103512. /**
  103513. * Gets wether tonemapping is enabled or not.
  103514. */
  103515. get toneMappingEnabled(): boolean;
  103516. /**
  103517. * Sets wether tonemapping is enabled or not
  103518. */
  103519. set toneMappingEnabled(value: boolean);
  103520. /**
  103521. * Gets the type of tone mapping effect.
  103522. */
  103523. get toneMappingType(): number;
  103524. /**
  103525. * Sets the type of tone mapping effect.
  103526. */
  103527. set toneMappingType(value: number);
  103528. /**
  103529. * Gets contrast used in the effect.
  103530. */
  103531. get contrast(): number;
  103532. /**
  103533. * Sets contrast used in the effect.
  103534. */
  103535. set contrast(value: number);
  103536. /**
  103537. * Gets Vignette stretch size.
  103538. */
  103539. get vignetteStretch(): number;
  103540. /**
  103541. * Sets Vignette stretch size.
  103542. */
  103543. set vignetteStretch(value: number);
  103544. /**
  103545. * Gets Vignette centre X Offset.
  103546. */
  103547. get vignetteCentreX(): number;
  103548. /**
  103549. * Sets Vignette centre X Offset.
  103550. */
  103551. set vignetteCentreX(value: number);
  103552. /**
  103553. * Gets Vignette centre Y Offset.
  103554. */
  103555. get vignetteCentreY(): number;
  103556. /**
  103557. * Sets Vignette centre Y Offset.
  103558. */
  103559. set vignetteCentreY(value: number);
  103560. /**
  103561. * Gets Vignette weight or intensity of the vignette effect.
  103562. */
  103563. get vignetteWeight(): number;
  103564. /**
  103565. * Sets Vignette weight or intensity of the vignette effect.
  103566. */
  103567. set vignetteWeight(value: number);
  103568. /**
  103569. * Gets Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  103570. * if vignetteEnabled is set to true.
  103571. */
  103572. get vignetteColor(): Color4;
  103573. /**
  103574. * Sets Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  103575. * if vignetteEnabled is set to true.
  103576. */
  103577. set vignetteColor(value: Color4);
  103578. /**
  103579. * Gets Camera field of view used by the Vignette effect.
  103580. */
  103581. get vignetteCameraFov(): number;
  103582. /**
  103583. * Sets Camera field of view used by the Vignette effect.
  103584. */
  103585. set vignetteCameraFov(value: number);
  103586. /**
  103587. * Gets the vignette blend mode allowing different kind of effect.
  103588. */
  103589. get vignetteBlendMode(): number;
  103590. /**
  103591. * Sets the vignette blend mode allowing different kind of effect.
  103592. */
  103593. set vignetteBlendMode(value: number);
  103594. /**
  103595. * Gets wether the vignette effect is enabled.
  103596. */
  103597. get vignetteEnabled(): boolean;
  103598. /**
  103599. * Sets wether the vignette effect is enabled.
  103600. */
  103601. set vignetteEnabled(value: boolean);
  103602. private _fromLinearSpace;
  103603. /**
  103604. * Gets wether the input of the processing is in Gamma or Linear Space.
  103605. */
  103606. get fromLinearSpace(): boolean;
  103607. /**
  103608. * Sets wether the input of the processing is in Gamma or Linear Space.
  103609. */
  103610. set fromLinearSpace(value: boolean);
  103611. /**
  103612. * Defines cache preventing GC.
  103613. */
  103614. private _defines;
  103615. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, imageProcessingConfiguration?: ImageProcessingConfiguration);
  103616. /**
  103617. * "ImageProcessingPostProcess"
  103618. * @returns "ImageProcessingPostProcess"
  103619. */
  103620. getClassName(): string;
  103621. /**
  103622. * @hidden
  103623. */
  103624. _updateParameters(): void;
  103625. dispose(camera?: Camera): void;
  103626. }
  103627. }
  103628. declare module BABYLON {
  103629. /** @hidden */
  103630. export var fibonacci: {
  103631. name: string;
  103632. shader: string;
  103633. };
  103634. }
  103635. declare module BABYLON {
  103636. /** @hidden */
  103637. export var subSurfaceScatteringFunctions: {
  103638. name: string;
  103639. shader: string;
  103640. };
  103641. }
  103642. declare module BABYLON {
  103643. /** @hidden */
  103644. export var diffusionProfile: {
  103645. name: string;
  103646. shader: string;
  103647. };
  103648. }
  103649. declare module BABYLON {
  103650. /** @hidden */
  103651. export var subSurfaceScatteringPixelShader: {
  103652. name: string;
  103653. shader: string;
  103654. };
  103655. }
  103656. declare module BABYLON {
  103657. /**
  103658. * Sub surface scattering post process
  103659. */
  103660. export class SubSurfaceScatteringPostProcess extends PostProcess {
  103661. /**
  103662. * Gets a string identifying the name of the class
  103663. * @returns "SubSurfaceScatteringPostProcess" string
  103664. */
  103665. getClassName(): string;
  103666. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  103667. }
  103668. }
  103669. declare module BABYLON {
  103670. /**
  103671. * Interface for defining prepass effects in the prepass post-process pipeline
  103672. */
  103673. export interface PrePassEffectConfiguration {
  103674. /**
  103675. * Post process to attach for this effect
  103676. */
  103677. postProcess: PostProcess;
  103678. /**
  103679. * Is the effect enabled
  103680. */
  103681. enabled: boolean;
  103682. /**
  103683. * Disposes the effect configuration
  103684. */
  103685. dispose(): void;
  103686. /**
  103687. * Disposes the effect configuration
  103688. */
  103689. createPostProcess: () => PostProcess;
  103690. }
  103691. }
  103692. declare module BABYLON {
  103693. /**
  103694. * Contains all parameters needed for the prepass to perform
  103695. * screen space subsurface scattering
  103696. */
  103697. export class SubSurfaceConfiguration implements PrePassEffectConfiguration {
  103698. private _ssDiffusionS;
  103699. private _ssFilterRadii;
  103700. private _ssDiffusionD;
  103701. /**
  103702. * Post process to attach for screen space subsurface scattering
  103703. */
  103704. postProcess: SubSurfaceScatteringPostProcess;
  103705. /**
  103706. * Diffusion profile color for subsurface scattering
  103707. */
  103708. get ssDiffusionS(): number[];
  103709. /**
  103710. * Diffusion profile max color channel value for subsurface scattering
  103711. */
  103712. get ssDiffusionD(): number[];
  103713. /**
  103714. * Diffusion profile filter radius for subsurface scattering
  103715. */
  103716. get ssFilterRadii(): number[];
  103717. /**
  103718. * Is subsurface enabled
  103719. */
  103720. enabled: boolean;
  103721. /**
  103722. * Diffusion profile colors for subsurface scattering
  103723. * You can add one diffusion color using `addDiffusionProfile` on `scene.prePassRenderer`
  103724. * See ...
  103725. * Note that you can only store up to 5 of them
  103726. */
  103727. ssDiffusionProfileColors: Color3[];
  103728. /**
  103729. * Defines the ratio real world => scene units.
  103730. * Used for subsurface scattering
  103731. */
  103732. metersPerUnit: number;
  103733. private _scene;
  103734. /**
  103735. * Builds a subsurface configuration object
  103736. * @param scene The scene
  103737. */
  103738. constructor(scene: Scene);
  103739. /**
  103740. * Adds a new diffusion profile.
  103741. * Useful for more realistic subsurface scattering on diverse materials.
  103742. * @param color The color of the diffusion profile. Should be the average color of the material.
  103743. * @return The index of the diffusion profile for the material subsurface configuration
  103744. */
  103745. addDiffusionProfile(color: Color3): number;
  103746. /**
  103747. * Creates the sss post process
  103748. * @return The created post process
  103749. */
  103750. createPostProcess(): SubSurfaceScatteringPostProcess;
  103751. /**
  103752. * Deletes all diffusion profiles.
  103753. * Note that in order to render subsurface scattering, you should have at least 1 diffusion profile.
  103754. */
  103755. clearAllDiffusionProfiles(): void;
  103756. /**
  103757. * Disposes this object
  103758. */
  103759. dispose(): void;
  103760. /**
  103761. * @hidden
  103762. * https://zero-radiance.github.io/post/sampling-diffusion/
  103763. *
  103764. * Importance sample the normalized diffuse reflectance profile for the computed value of 's'.
  103765. * ------------------------------------------------------------------------------------
  103766. * R[r, phi, s] = s * (Exp[-r * s] + Exp[-r * s / 3]) / (8 * Pi * r)
  103767. * PDF[r, phi, s] = r * R[r, phi, s]
  103768. * CDF[r, s] = 1 - 1/4 * Exp[-r * s] - 3/4 * Exp[-r * s / 3]
  103769. * ------------------------------------------------------------------------------------
  103770. * We importance sample the color channel with the widest scattering distance.
  103771. */
  103772. getDiffusionProfileParameters(color: Color3): number;
  103773. /**
  103774. * Performs sampling of a Normalized Burley diffusion profile in polar coordinates.
  103775. * 'u' is the random number (the value of the CDF): [0, 1).
  103776. * rcp(s) = 1 / ShapeParam = ScatteringDistance.
  103777. * Returns the sampled radial distance, s.t. (u = 0 -> r = 0) and (u = 1 -> r = Inf).
  103778. */
  103779. private _sampleBurleyDiffusionProfile;
  103780. }
  103781. }
  103782. declare module BABYLON {
  103783. /**
  103784. * Renders a pre pass of the scene
  103785. * This means every mesh in the scene will be rendered to a render target texture
  103786. * And then this texture will be composited to the rendering canvas with post processes
  103787. * It is necessary for effects like subsurface scattering or deferred shading
  103788. */
  103789. export class PrePassRenderer {
  103790. /** @hidden */
  103791. static _SceneComponentInitialization: (scene: Scene) => void;
  103792. private _scene;
  103793. private _engine;
  103794. private _isDirty;
  103795. /**
  103796. * Number of textures in the multi render target texture where the scene is directly rendered
  103797. */
  103798. readonly mrtCount: number;
  103799. /**
  103800. * The render target where the scene is directly rendered
  103801. */
  103802. prePassRT: MultiRenderTarget;
  103803. private _mrtTypes;
  103804. private _multiRenderAttachments;
  103805. private _defaultAttachments;
  103806. private _clearAttachments;
  103807. private _postProcesses;
  103808. private readonly _clearColor;
  103809. /**
  103810. * Image processing post process for composition
  103811. */
  103812. imageProcessingPostProcess: ImageProcessingPostProcess;
  103813. /**
  103814. * Configuration for sub surface scattering post process
  103815. */
  103816. subSurfaceConfiguration: SubSurfaceConfiguration;
  103817. /**
  103818. * Should materials render their geometry on the MRT
  103819. */
  103820. materialsShouldRenderGeometry: boolean;
  103821. /**
  103822. * Should materials render the irradiance information on the MRT
  103823. */
  103824. materialsShouldRenderIrradiance: boolean;
  103825. private _enabled;
  103826. /**
  103827. * Indicates if the prepass is enabled
  103828. */
  103829. get enabled(): boolean;
  103830. /**
  103831. * How many samples are used for MSAA of the scene render target
  103832. */
  103833. get samples(): number;
  103834. set samples(n: number);
  103835. /**
  103836. * Instanciates a prepass renderer
  103837. * @param scene The scene
  103838. */
  103839. constructor(scene: Scene);
  103840. private _initializeAttachments;
  103841. private _createCompositionEffect;
  103842. /**
  103843. * Indicates if rendering a prepass is supported
  103844. */
  103845. get isSupported(): boolean;
  103846. /**
  103847. * Sets the proper output textures to draw in the engine.
  103848. * @param effect The effect that is drawn. It can be or not be compatible with drawing to several output textures.
  103849. */
  103850. bindAttachmentsForEffect(effect: Effect): void;
  103851. /**
  103852. * @hidden
  103853. */
  103854. _beforeCameraDraw(): void;
  103855. /**
  103856. * @hidden
  103857. */
  103858. _afterCameraDraw(): void;
  103859. private _checkRTSize;
  103860. private _bindFrameBuffer;
  103861. /**
  103862. * Clears the scene render target (in the sense of settings pixels to the scene clear color value)
  103863. */
  103864. clear(): void;
  103865. private _setState;
  103866. private _enable;
  103867. private _disable;
  103868. private _resetPostProcessChain;
  103869. private _bindPostProcessChain;
  103870. /**
  103871. * Marks the prepass renderer as dirty, triggering a check if the prepass is necessary for the next rendering.
  103872. */
  103873. markAsDirty(): void;
  103874. private _update;
  103875. /**
  103876. * Disposes the prepass renderer.
  103877. */
  103878. dispose(): void;
  103879. }
  103880. }
  103881. declare module BABYLON {
  103882. /**
  103883. * Options for compiling materials.
  103884. */
  103885. export interface IMaterialCompilationOptions {
  103886. /**
  103887. * Defines whether clip planes are enabled.
  103888. */
  103889. clipPlane: boolean;
  103890. /**
  103891. * Defines whether instances are enabled.
  103892. */
  103893. useInstances: boolean;
  103894. }
  103895. /**
  103896. * Options passed when calling customShaderNameResolve
  103897. */
  103898. export interface ICustomShaderNameResolveOptions {
  103899. /**
  103900. * 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
  103901. */
  103902. processFinalCode?: Nullable<(shaderType: string, code: string) => string>;
  103903. }
  103904. /**
  103905. * Base class for the main features of a material in Babylon.js
  103906. */
  103907. export class Material implements IAnimatable {
  103908. /**
  103909. * Returns the triangle fill mode
  103910. */
  103911. static readonly TriangleFillMode: number;
  103912. /**
  103913. * Returns the wireframe mode
  103914. */
  103915. static readonly WireFrameFillMode: number;
  103916. /**
  103917. * Returns the point fill mode
  103918. */
  103919. static readonly PointFillMode: number;
  103920. /**
  103921. * Returns the point list draw mode
  103922. */
  103923. static readonly PointListDrawMode: number;
  103924. /**
  103925. * Returns the line list draw mode
  103926. */
  103927. static readonly LineListDrawMode: number;
  103928. /**
  103929. * Returns the line loop draw mode
  103930. */
  103931. static readonly LineLoopDrawMode: number;
  103932. /**
  103933. * Returns the line strip draw mode
  103934. */
  103935. static readonly LineStripDrawMode: number;
  103936. /**
  103937. * Returns the triangle strip draw mode
  103938. */
  103939. static readonly TriangleStripDrawMode: number;
  103940. /**
  103941. * Returns the triangle fan draw mode
  103942. */
  103943. static readonly TriangleFanDrawMode: number;
  103944. /**
  103945. * Stores the clock-wise side orientation
  103946. */
  103947. static readonly ClockWiseSideOrientation: number;
  103948. /**
  103949. * Stores the counter clock-wise side orientation
  103950. */
  103951. static readonly CounterClockWiseSideOrientation: number;
  103952. /**
  103953. * The dirty texture flag value
  103954. */
  103955. static readonly TextureDirtyFlag: number;
  103956. /**
  103957. * The dirty light flag value
  103958. */
  103959. static readonly LightDirtyFlag: number;
  103960. /**
  103961. * The dirty fresnel flag value
  103962. */
  103963. static readonly FresnelDirtyFlag: number;
  103964. /**
  103965. * The dirty attribute flag value
  103966. */
  103967. static readonly AttributesDirtyFlag: number;
  103968. /**
  103969. * The dirty misc flag value
  103970. */
  103971. static readonly MiscDirtyFlag: number;
  103972. /**
  103973. * The all dirty flag value
  103974. */
  103975. static readonly AllDirtyFlag: number;
  103976. /**
  103977. * MaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  103978. */
  103979. static readonly MATERIAL_OPAQUE: number;
  103980. /**
  103981. * MaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  103982. */
  103983. static readonly MATERIAL_ALPHATEST: number;
  103984. /**
  103985. * MaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  103986. */
  103987. static readonly MATERIAL_ALPHABLEND: number;
  103988. /**
  103989. * MaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  103990. * They are also discarded below the alpha cutoff threshold to improve performances.
  103991. */
  103992. static readonly MATERIAL_ALPHATESTANDBLEND: number;
  103993. /**
  103994. * The Whiteout method is used to blend normals.
  103995. * Details of the algorithm can be found here: https://blog.selfshadow.com/publications/blending-in-detail/
  103996. */
  103997. static readonly MATERIAL_NORMALBLENDMETHOD_WHITEOUT: number;
  103998. /**
  103999. * The Reoriented Normal Mapping method is used to blend normals.
  104000. * Details of the algorithm can be found here: https://blog.selfshadow.com/publications/blending-in-detail/
  104001. */
  104002. static readonly MATERIAL_NORMALBLENDMETHOD_RNM: number;
  104003. /**
  104004. * Custom callback helping to override the default shader used in the material.
  104005. */
  104006. customShaderNameResolve: (shaderName: string, uniforms: string[], uniformBuffers: string[], samplers: string[], defines: MaterialDefines | string[], attributes?: string[], options?: ICustomShaderNameResolveOptions) => string;
  104007. /**
  104008. * Custom shadow depth material to use for shadow rendering instead of the in-built one
  104009. */
  104010. shadowDepthWrapper: Nullable<ShadowDepthWrapper>;
  104011. /**
  104012. * Gets or sets a boolean indicating that the material is allowed (if supported) to do shader hot swapping.
  104013. * This means that the material can keep using a previous shader while a new one is being compiled.
  104014. * This is mostly used when shader parallel compilation is supported (true by default)
  104015. */
  104016. allowShaderHotSwapping: boolean;
  104017. /**
  104018. * The ID of the material
  104019. */
  104020. id: string;
  104021. /**
  104022. * Gets or sets the unique id of the material
  104023. */
  104024. uniqueId: number;
  104025. /**
  104026. * The name of the material
  104027. */
  104028. name: string;
  104029. /**
  104030. * Gets or sets user defined metadata
  104031. */
  104032. metadata: any;
  104033. /**
  104034. * For internal use only. Please do not use.
  104035. */
  104036. reservedDataStore: any;
  104037. /**
  104038. * Specifies if the ready state should be checked on each call
  104039. */
  104040. checkReadyOnEveryCall: boolean;
  104041. /**
  104042. * Specifies if the ready state should be checked once
  104043. */
  104044. checkReadyOnlyOnce: boolean;
  104045. /**
  104046. * The state of the material
  104047. */
  104048. state: string;
  104049. /**
  104050. * If the material can be rendered to several textures with MRT extension
  104051. */
  104052. get canRenderToMRT(): boolean;
  104053. /**
  104054. * The alpha value of the material
  104055. */
  104056. protected _alpha: number;
  104057. /**
  104058. * List of inspectable custom properties (used by the Inspector)
  104059. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  104060. */
  104061. inspectableCustomProperties: IInspectable[];
  104062. /**
  104063. * Sets the alpha value of the material
  104064. */
  104065. set alpha(value: number);
  104066. /**
  104067. * Gets the alpha value of the material
  104068. */
  104069. get alpha(): number;
  104070. /**
  104071. * Specifies if back face culling is enabled
  104072. */
  104073. protected _backFaceCulling: boolean;
  104074. /**
  104075. * Sets the back-face culling state
  104076. */
  104077. set backFaceCulling(value: boolean);
  104078. /**
  104079. * Gets the back-face culling state
  104080. */
  104081. get backFaceCulling(): boolean;
  104082. /**
  104083. * Stores the value for side orientation
  104084. */
  104085. sideOrientation: number;
  104086. /**
  104087. * Callback triggered when the material is compiled
  104088. */
  104089. onCompiled: Nullable<(effect: Effect) => void>;
  104090. /**
  104091. * Callback triggered when an error occurs
  104092. */
  104093. onError: Nullable<(effect: Effect, errors: string) => void>;
  104094. /**
  104095. * Callback triggered to get the render target textures
  104096. */
  104097. getRenderTargetTextures: Nullable<() => SmartArray<RenderTargetTexture>>;
  104098. /**
  104099. * Gets a boolean indicating that current material needs to register RTT
  104100. */
  104101. get hasRenderTargetTextures(): boolean;
  104102. /**
  104103. * Specifies if the material should be serialized
  104104. */
  104105. doNotSerialize: boolean;
  104106. /**
  104107. * @hidden
  104108. */
  104109. _storeEffectOnSubMeshes: boolean;
  104110. /**
  104111. * Stores the animations for the material
  104112. */
  104113. animations: Nullable<Array<Animation>>;
  104114. /**
  104115. * An event triggered when the material is disposed
  104116. */
  104117. onDisposeObservable: Observable<Material>;
  104118. /**
  104119. * An observer which watches for dispose events
  104120. */
  104121. private _onDisposeObserver;
  104122. private _onUnBindObservable;
  104123. /**
  104124. * Called during a dispose event
  104125. */
  104126. set onDispose(callback: () => void);
  104127. private _onBindObservable;
  104128. /**
  104129. * An event triggered when the material is bound
  104130. */
  104131. get onBindObservable(): Observable<AbstractMesh>;
  104132. /**
  104133. * An observer which watches for bind events
  104134. */
  104135. private _onBindObserver;
  104136. /**
  104137. * Called during a bind event
  104138. */
  104139. set onBind(callback: (Mesh: AbstractMesh) => void);
  104140. /**
  104141. * An event triggered when the material is unbound
  104142. */
  104143. get onUnBindObservable(): Observable<Material>;
  104144. protected _onEffectCreatedObservable: Nullable<Observable<{
  104145. effect: Effect;
  104146. subMesh: Nullable<SubMesh>;
  104147. }>>;
  104148. /**
  104149. * An event triggered when the effect is (re)created
  104150. */
  104151. get onEffectCreatedObservable(): Observable<{
  104152. effect: Effect;
  104153. subMesh: Nullable<SubMesh>;
  104154. }>;
  104155. /**
  104156. * Stores the value of the alpha mode
  104157. */
  104158. private _alphaMode;
  104159. /**
  104160. * Sets the value of the alpha mode.
  104161. *
  104162. * | Value | Type | Description |
  104163. * | --- | --- | --- |
  104164. * | 0 | ALPHA_DISABLE | |
  104165. * | 1 | ALPHA_ADD | |
  104166. * | 2 | ALPHA_COMBINE | |
  104167. * | 3 | ALPHA_SUBTRACT | |
  104168. * | 4 | ALPHA_MULTIPLY | |
  104169. * | 5 | ALPHA_MAXIMIZED | |
  104170. * | 6 | ALPHA_ONEONE | |
  104171. * | 7 | ALPHA_PREMULTIPLIED | |
  104172. * | 8 | ALPHA_PREMULTIPLIED_PORTERDUFF | |
  104173. * | 9 | ALPHA_INTERPOLATE | |
  104174. * | 10 | ALPHA_SCREENMODE | |
  104175. *
  104176. */
  104177. set alphaMode(value: number);
  104178. /**
  104179. * Gets the value of the alpha mode
  104180. */
  104181. get alphaMode(): number;
  104182. /**
  104183. * Stores the state of the need depth pre-pass value
  104184. */
  104185. private _needDepthPrePass;
  104186. /**
  104187. * Sets the need depth pre-pass value
  104188. */
  104189. set needDepthPrePass(value: boolean);
  104190. /**
  104191. * Gets the depth pre-pass value
  104192. */
  104193. get needDepthPrePass(): boolean;
  104194. /**
  104195. * Specifies if depth writing should be disabled
  104196. */
  104197. disableDepthWrite: boolean;
  104198. /**
  104199. * Specifies if color writing should be disabled
  104200. */
  104201. disableColorWrite: boolean;
  104202. /**
  104203. * Specifies if depth writing should be forced
  104204. */
  104205. forceDepthWrite: boolean;
  104206. /**
  104207. * Specifies the depth function that should be used. 0 means the default engine function
  104208. */
  104209. depthFunction: number;
  104210. /**
  104211. * Specifies if there should be a separate pass for culling
  104212. */
  104213. separateCullingPass: boolean;
  104214. /**
  104215. * Stores the state specifing if fog should be enabled
  104216. */
  104217. private _fogEnabled;
  104218. /**
  104219. * Sets the state for enabling fog
  104220. */
  104221. set fogEnabled(value: boolean);
  104222. /**
  104223. * Gets the value of the fog enabled state
  104224. */
  104225. get fogEnabled(): boolean;
  104226. /**
  104227. * Stores the size of points
  104228. */
  104229. pointSize: number;
  104230. /**
  104231. * Stores the z offset value
  104232. */
  104233. zOffset: number;
  104234. get wireframe(): boolean;
  104235. /**
  104236. * Sets the state of wireframe mode
  104237. */
  104238. set wireframe(value: boolean);
  104239. /**
  104240. * Gets the value specifying if point clouds are enabled
  104241. */
  104242. get pointsCloud(): boolean;
  104243. /**
  104244. * Sets the state of point cloud mode
  104245. */
  104246. set pointsCloud(value: boolean);
  104247. /**
  104248. * Gets the material fill mode
  104249. */
  104250. get fillMode(): number;
  104251. /**
  104252. * Sets the material fill mode
  104253. */
  104254. set fillMode(value: number);
  104255. /**
  104256. * @hidden
  104257. * Stores the effects for the material
  104258. */
  104259. _effect: Nullable<Effect>;
  104260. /**
  104261. * Specifies if uniform buffers should be used
  104262. */
  104263. private _useUBO;
  104264. /**
  104265. * Stores a reference to the scene
  104266. */
  104267. private _scene;
  104268. /**
  104269. * Stores the fill mode state
  104270. */
  104271. private _fillMode;
  104272. /**
  104273. * Specifies if the depth write state should be cached
  104274. */
  104275. private _cachedDepthWriteState;
  104276. /**
  104277. * Specifies if the color write state should be cached
  104278. */
  104279. private _cachedColorWriteState;
  104280. /**
  104281. * Specifies if the depth function state should be cached
  104282. */
  104283. private _cachedDepthFunctionState;
  104284. /**
  104285. * Stores the uniform buffer
  104286. */
  104287. protected _uniformBuffer: UniformBuffer;
  104288. /** @hidden */
  104289. _indexInSceneMaterialArray: number;
  104290. /** @hidden */
  104291. meshMap: Nullable<{
  104292. [id: string]: AbstractMesh | undefined;
  104293. }>;
  104294. /**
  104295. * Creates a material instance
  104296. * @param name defines the name of the material
  104297. * @param scene defines the scene to reference
  104298. * @param doNotAdd specifies if the material should be added to the scene
  104299. */
  104300. constructor(name: string, scene: Scene, doNotAdd?: boolean);
  104301. /**
  104302. * Returns a string representation of the current material
  104303. * @param fullDetails defines a boolean indicating which levels of logging is desired
  104304. * @returns a string with material information
  104305. */
  104306. toString(fullDetails?: boolean): string;
  104307. /**
  104308. * Gets the class name of the material
  104309. * @returns a string with the class name of the material
  104310. */
  104311. getClassName(): string;
  104312. /**
  104313. * Specifies if updates for the material been locked
  104314. */
  104315. get isFrozen(): boolean;
  104316. /**
  104317. * Locks updates for the material
  104318. */
  104319. freeze(): void;
  104320. /**
  104321. * Unlocks updates for the material
  104322. */
  104323. unfreeze(): void;
  104324. /**
  104325. * Specifies if the material is ready to be used
  104326. * @param mesh defines the mesh to check
  104327. * @param useInstances specifies if instances should be used
  104328. * @returns a boolean indicating if the material is ready to be used
  104329. */
  104330. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  104331. /**
  104332. * Specifies that the submesh is ready to be used
  104333. * @param mesh defines the mesh to check
  104334. * @param subMesh defines which submesh to check
  104335. * @param useInstances specifies that instances should be used
  104336. * @returns a boolean indicating that the submesh is ready or not
  104337. */
  104338. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  104339. /**
  104340. * Returns the material effect
  104341. * @returns the effect associated with the material
  104342. */
  104343. getEffect(): Nullable<Effect>;
  104344. /**
  104345. * Returns the current scene
  104346. * @returns a Scene
  104347. */
  104348. getScene(): Scene;
  104349. /**
  104350. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  104351. */
  104352. protected _forceAlphaTest: boolean;
  104353. /**
  104354. * The transparency mode of the material.
  104355. */
  104356. protected _transparencyMode: Nullable<number>;
  104357. /**
  104358. * Gets the current transparency mode.
  104359. */
  104360. get transparencyMode(): Nullable<number>;
  104361. /**
  104362. * Sets the transparency mode of the material.
  104363. *
  104364. * | Value | Type | Description |
  104365. * | ----- | ----------------------------------- | ----------- |
  104366. * | 0 | OPAQUE | |
  104367. * | 1 | ALPHATEST | |
  104368. * | 2 | ALPHABLEND | |
  104369. * | 3 | ALPHATESTANDBLEND | |
  104370. *
  104371. */
  104372. set transparencyMode(value: Nullable<number>);
  104373. /**
  104374. * Returns true if alpha blending should be disabled.
  104375. */
  104376. protected get _disableAlphaBlending(): boolean;
  104377. /**
  104378. * Specifies whether or not this material should be rendered in alpha blend mode.
  104379. * @returns a boolean specifying if alpha blending is needed
  104380. */
  104381. needAlphaBlending(): boolean;
  104382. /**
  104383. * Specifies if the mesh will require alpha blending
  104384. * @param mesh defines the mesh to check
  104385. * @returns a boolean specifying if alpha blending is needed for the mesh
  104386. */
  104387. needAlphaBlendingForMesh(mesh: AbstractMesh): boolean;
  104388. /**
  104389. * Specifies whether or not this material should be rendered in alpha test mode.
  104390. * @returns a boolean specifying if an alpha test is needed.
  104391. */
  104392. needAlphaTesting(): boolean;
  104393. /**
  104394. * Specifies if material alpha testing should be turned on for the mesh
  104395. * @param mesh defines the mesh to check
  104396. */
  104397. protected _shouldTurnAlphaTestOn(mesh: AbstractMesh): boolean;
  104398. /**
  104399. * Gets the texture used for the alpha test
  104400. * @returns the texture to use for alpha testing
  104401. */
  104402. getAlphaTestTexture(): Nullable<BaseTexture>;
  104403. /**
  104404. * Marks the material to indicate that it needs to be re-calculated
  104405. */
  104406. markDirty(): void;
  104407. /** @hidden */
  104408. _preBind(effect?: Effect, overrideOrientation?: Nullable<number>): boolean;
  104409. /**
  104410. * Binds the material to the mesh
  104411. * @param world defines the world transformation matrix
  104412. * @param mesh defines the mesh to bind the material to
  104413. */
  104414. bind(world: Matrix, mesh?: Mesh): void;
  104415. /**
  104416. * Binds the submesh to the material
  104417. * @param world defines the world transformation matrix
  104418. * @param mesh defines the mesh containing the submesh
  104419. * @param subMesh defines the submesh to bind the material to
  104420. */
  104421. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  104422. /**
  104423. * Binds the world matrix to the material
  104424. * @param world defines the world transformation matrix
  104425. */
  104426. bindOnlyWorldMatrix(world: Matrix): void;
  104427. /**
  104428. * Binds the scene's uniform buffer to the effect.
  104429. * @param effect defines the effect to bind to the scene uniform buffer
  104430. * @param sceneUbo defines the uniform buffer storing scene data
  104431. */
  104432. bindSceneUniformBuffer(effect: Effect, sceneUbo: UniformBuffer): void;
  104433. /**
  104434. * Binds the view matrix to the effect
  104435. * @param effect defines the effect to bind the view matrix to
  104436. */
  104437. bindView(effect: Effect): void;
  104438. /**
  104439. * Binds the view projection matrix to the effect
  104440. * @param effect defines the effect to bind the view projection matrix to
  104441. */
  104442. bindViewProjection(effect: Effect): void;
  104443. /**
  104444. * Processes to execute after binding the material to a mesh
  104445. * @param mesh defines the rendered mesh
  104446. */
  104447. protected _afterBind(mesh?: Mesh): void;
  104448. /**
  104449. * Unbinds the material from the mesh
  104450. */
  104451. unbind(): void;
  104452. /**
  104453. * Gets the active textures from the material
  104454. * @returns an array of textures
  104455. */
  104456. getActiveTextures(): BaseTexture[];
  104457. /**
  104458. * Specifies if the material uses a texture
  104459. * @param texture defines the texture to check against the material
  104460. * @returns a boolean specifying if the material uses the texture
  104461. */
  104462. hasTexture(texture: BaseTexture): boolean;
  104463. /**
  104464. * Makes a duplicate of the material, and gives it a new name
  104465. * @param name defines the new name for the duplicated material
  104466. * @returns the cloned material
  104467. */
  104468. clone(name: string): Nullable<Material>;
  104469. /**
  104470. * Gets the meshes bound to the material
  104471. * @returns an array of meshes bound to the material
  104472. */
  104473. getBindedMeshes(): AbstractMesh[];
  104474. /**
  104475. * Force shader compilation
  104476. * @param mesh defines the mesh associated with this material
  104477. * @param onCompiled defines a function to execute once the material is compiled
  104478. * @param options defines the options to configure the compilation
  104479. * @param onError defines a function to execute if the material fails compiling
  104480. */
  104481. forceCompilation(mesh: AbstractMesh, onCompiled?: (material: Material) => void, options?: Partial<IMaterialCompilationOptions>, onError?: (reason: string) => void): void;
  104482. /**
  104483. * Force shader compilation
  104484. * @param mesh defines the mesh that will use this material
  104485. * @param options defines additional options for compiling the shaders
  104486. * @returns a promise that resolves when the compilation completes
  104487. */
  104488. forceCompilationAsync(mesh: AbstractMesh, options?: Partial<IMaterialCompilationOptions>): Promise<void>;
  104489. private static readonly _AllDirtyCallBack;
  104490. private static readonly _ImageProcessingDirtyCallBack;
  104491. private static readonly _TextureDirtyCallBack;
  104492. private static readonly _FresnelDirtyCallBack;
  104493. private static readonly _MiscDirtyCallBack;
  104494. private static readonly _LightsDirtyCallBack;
  104495. private static readonly _AttributeDirtyCallBack;
  104496. private static _FresnelAndMiscDirtyCallBack;
  104497. private static _TextureAndMiscDirtyCallBack;
  104498. private static readonly _DirtyCallbackArray;
  104499. private static readonly _RunDirtyCallBacks;
  104500. /**
  104501. * Marks a define in the material to indicate that it needs to be re-computed
  104502. * @param flag defines a flag used to determine which parts of the material have to be marked as dirty
  104503. */
  104504. markAsDirty(flag: number): void;
  104505. /**
  104506. * Marks all submeshes of a material to indicate that their material defines need to be re-calculated
  104507. * @param func defines a function which checks material defines against the submeshes
  104508. */
  104509. protected _markAllSubMeshesAsDirty(func: (defines: MaterialDefines) => void): void;
  104510. /**
  104511. * Indicates that the scene should check if the rendering now needs a prepass
  104512. */
  104513. protected _markScenePrePassDirty(): void;
  104514. /**
  104515. * Indicates that we need to re-calculated for all submeshes
  104516. */
  104517. protected _markAllSubMeshesAsAllDirty(): void;
  104518. /**
  104519. * Indicates that image processing needs to be re-calculated for all submeshes
  104520. */
  104521. protected _markAllSubMeshesAsImageProcessingDirty(): void;
  104522. /**
  104523. * Indicates that textures need to be re-calculated for all submeshes
  104524. */
  104525. protected _markAllSubMeshesAsTexturesDirty(): void;
  104526. /**
  104527. * Indicates that fresnel needs to be re-calculated for all submeshes
  104528. */
  104529. protected _markAllSubMeshesAsFresnelDirty(): void;
  104530. /**
  104531. * Indicates that fresnel and misc need to be re-calculated for all submeshes
  104532. */
  104533. protected _markAllSubMeshesAsFresnelAndMiscDirty(): void;
  104534. /**
  104535. * Indicates that lights need to be re-calculated for all submeshes
  104536. */
  104537. protected _markAllSubMeshesAsLightsDirty(): void;
  104538. /**
  104539. * Indicates that attributes need to be re-calculated for all submeshes
  104540. */
  104541. protected _markAllSubMeshesAsAttributesDirty(): void;
  104542. /**
  104543. * Indicates that misc needs to be re-calculated for all submeshes
  104544. */
  104545. protected _markAllSubMeshesAsMiscDirty(): void;
  104546. /**
  104547. * Indicates that textures and misc need to be re-calculated for all submeshes
  104548. */
  104549. protected _markAllSubMeshesAsTexturesAndMiscDirty(): void;
  104550. /**
  104551. * Sets the required values to the prepass renderer.
  104552. * @param prePassRenderer defines the prepass renderer to setup.
  104553. * @returns true if the pre pass is needed.
  104554. */
  104555. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  104556. /**
  104557. * Disposes the material
  104558. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  104559. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  104560. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  104561. */
  104562. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  104563. /** @hidden */
  104564. private releaseVertexArrayObject;
  104565. /**
  104566. * Serializes this material
  104567. * @returns the serialized material object
  104568. */
  104569. serialize(): any;
  104570. /**
  104571. * Creates a material from parsed material data
  104572. * @param parsedMaterial defines parsed material data
  104573. * @param scene defines the hosting scene
  104574. * @param rootUrl defines the root URL to use to load textures
  104575. * @returns a new material
  104576. */
  104577. static Parse(parsedMaterial: any, scene: Scene, rootUrl: string): Nullable<Material>;
  104578. }
  104579. }
  104580. declare module BABYLON {
  104581. /**
  104582. * A multi-material is used to apply different materials to different parts of the same object without the need of
  104583. * separate meshes. This can be use to improve performances.
  104584. * @see https://doc.babylonjs.com/how_to/multi_materials
  104585. */
  104586. export class MultiMaterial extends Material {
  104587. private _subMaterials;
  104588. /**
  104589. * Gets or Sets the list of Materials used within the multi material.
  104590. * They need to be ordered according to the submeshes order in the associated mesh
  104591. */
  104592. get subMaterials(): Nullable<Material>[];
  104593. set subMaterials(value: Nullable<Material>[]);
  104594. /**
  104595. * Function used to align with Node.getChildren()
  104596. * @returns the list of Materials used within the multi material
  104597. */
  104598. getChildren(): Nullable<Material>[];
  104599. /**
  104600. * Instantiates a new Multi Material
  104601. * A multi-material is used to apply different materials to different parts of the same object without the need of
  104602. * separate meshes. This can be use to improve performances.
  104603. * @see https://doc.babylonjs.com/how_to/multi_materials
  104604. * @param name Define the name in the scene
  104605. * @param scene Define the scene the material belongs to
  104606. */
  104607. constructor(name: string, scene: Scene);
  104608. private _hookArray;
  104609. /**
  104610. * Get one of the submaterial by its index in the submaterials array
  104611. * @param index The index to look the sub material at
  104612. * @returns The Material if the index has been defined
  104613. */
  104614. getSubMaterial(index: number): Nullable<Material>;
  104615. /**
  104616. * Get the list of active textures for the whole sub materials list.
  104617. * @returns All the textures that will be used during the rendering
  104618. */
  104619. getActiveTextures(): BaseTexture[];
  104620. /**
  104621. * Gets the current class name of the material e.g. "MultiMaterial"
  104622. * Mainly use in serialization.
  104623. * @returns the class name
  104624. */
  104625. getClassName(): string;
  104626. /**
  104627. * Checks if the material is ready to render the requested sub mesh
  104628. * @param mesh Define the mesh the submesh belongs to
  104629. * @param subMesh Define the sub mesh to look readyness for
  104630. * @param useInstances Define whether or not the material is used with instances
  104631. * @returns true if ready, otherwise false
  104632. */
  104633. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  104634. /**
  104635. * Clones the current material and its related sub materials
  104636. * @param name Define the name of the newly cloned material
  104637. * @param cloneChildren Define if submaterial will be cloned or shared with the parent instance
  104638. * @returns the cloned material
  104639. */
  104640. clone(name: string, cloneChildren?: boolean): MultiMaterial;
  104641. /**
  104642. * Serializes the materials into a JSON representation.
  104643. * @returns the JSON representation
  104644. */
  104645. serialize(): any;
  104646. /**
  104647. * Dispose the material and release its associated resources
  104648. * @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)
  104649. * @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)
  104650. * @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)
  104651. */
  104652. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, forceDisposeChildren?: boolean): void;
  104653. /**
  104654. * Creates a MultiMaterial from parsed MultiMaterial data.
  104655. * @param parsedMultiMaterial defines parsed MultiMaterial data.
  104656. * @param scene defines the hosting scene
  104657. * @returns a new MultiMaterial
  104658. */
  104659. static ParseMultiMaterial(parsedMultiMaterial: any, scene: Scene): MultiMaterial;
  104660. }
  104661. }
  104662. declare module BABYLON {
  104663. /**
  104664. * Defines a subdivision inside a mesh
  104665. */
  104666. export class SubMesh implements ICullable {
  104667. /** the material index to use */
  104668. materialIndex: number;
  104669. /** vertex index start */
  104670. verticesStart: number;
  104671. /** vertices count */
  104672. verticesCount: number;
  104673. /** index start */
  104674. indexStart: number;
  104675. /** indices count */
  104676. indexCount: number;
  104677. /** @hidden */
  104678. _materialDefines: Nullable<MaterialDefines>;
  104679. /** @hidden */
  104680. _materialEffect: Nullable<Effect>;
  104681. /** @hidden */
  104682. _effectOverride: Nullable<Effect>;
  104683. /**
  104684. * Gets material defines used by the effect associated to the sub mesh
  104685. */
  104686. get materialDefines(): Nullable<MaterialDefines>;
  104687. /**
  104688. * Sets material defines used by the effect associated to the sub mesh
  104689. */
  104690. set materialDefines(defines: Nullable<MaterialDefines>);
  104691. /**
  104692. * Gets associated effect
  104693. */
  104694. get effect(): Nullable<Effect>;
  104695. /**
  104696. * Sets associated effect (effect used to render this submesh)
  104697. * @param effect defines the effect to associate with
  104698. * @param defines defines the set of defines used to compile this effect
  104699. */
  104700. setEffect(effect: Nullable<Effect>, defines?: Nullable<MaterialDefines>): void;
  104701. /** @hidden */
  104702. _linesIndexCount: number;
  104703. private _mesh;
  104704. private _renderingMesh;
  104705. private _boundingInfo;
  104706. private _linesIndexBuffer;
  104707. /** @hidden */
  104708. _lastColliderWorldVertices: Nullable<Vector3[]>;
  104709. /** @hidden */
  104710. _trianglePlanes: Plane[];
  104711. /** @hidden */
  104712. _lastColliderTransformMatrix: Nullable<Matrix>;
  104713. /** @hidden */
  104714. _renderId: number;
  104715. /** @hidden */
  104716. _alphaIndex: number;
  104717. /** @hidden */
  104718. _distanceToCamera: number;
  104719. /** @hidden */
  104720. _id: number;
  104721. private _currentMaterial;
  104722. /**
  104723. * Add a new submesh to a mesh
  104724. * @param materialIndex defines the material index to use
  104725. * @param verticesStart defines vertex index start
  104726. * @param verticesCount defines vertices count
  104727. * @param indexStart defines index start
  104728. * @param indexCount defines indices count
  104729. * @param mesh defines the parent mesh
  104730. * @param renderingMesh defines an optional rendering mesh
  104731. * @param createBoundingBox defines if bounding box should be created for this submesh
  104732. * @returns the new submesh
  104733. */
  104734. static AddToMesh(materialIndex: number, verticesStart: number, verticesCount: number, indexStart: number, indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh, createBoundingBox?: boolean): SubMesh;
  104735. /**
  104736. * Creates a new submesh
  104737. * @param materialIndex defines the material index to use
  104738. * @param verticesStart defines vertex index start
  104739. * @param verticesCount defines vertices count
  104740. * @param indexStart defines index start
  104741. * @param indexCount defines indices count
  104742. * @param mesh defines the parent mesh
  104743. * @param renderingMesh defines an optional rendering mesh
  104744. * @param createBoundingBox defines if bounding box should be created for this submesh
  104745. * @param addToMesh defines a boolean indicating that the submesh must be added to the mesh.subMeshes array (true by default)
  104746. */
  104747. constructor(
  104748. /** the material index to use */
  104749. materialIndex: number,
  104750. /** vertex index start */
  104751. verticesStart: number,
  104752. /** vertices count */
  104753. verticesCount: number,
  104754. /** index start */
  104755. indexStart: number,
  104756. /** indices count */
  104757. indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh, createBoundingBox?: boolean, addToMesh?: boolean);
  104758. /**
  104759. * Returns true if this submesh covers the entire parent mesh
  104760. * @ignorenaming
  104761. */
  104762. get IsGlobal(): boolean;
  104763. /**
  104764. * Returns the submesh BoudingInfo object
  104765. * @returns current bounding info (or mesh's one if the submesh is global)
  104766. */
  104767. getBoundingInfo(): BoundingInfo;
  104768. /**
  104769. * Sets the submesh BoundingInfo
  104770. * @param boundingInfo defines the new bounding info to use
  104771. * @returns the SubMesh
  104772. */
  104773. setBoundingInfo(boundingInfo: BoundingInfo): SubMesh;
  104774. /**
  104775. * Returns the mesh of the current submesh
  104776. * @return the parent mesh
  104777. */
  104778. getMesh(): AbstractMesh;
  104779. /**
  104780. * Returns the rendering mesh of the submesh
  104781. * @returns the rendering mesh (could be different from parent mesh)
  104782. */
  104783. getRenderingMesh(): Mesh;
  104784. /**
  104785. * Returns the replacement mesh of the submesh
  104786. * @returns the replacement mesh (could be different from parent mesh)
  104787. */
  104788. getReplacementMesh(): Nullable<AbstractMesh>;
  104789. /**
  104790. * Returns the effective mesh of the submesh
  104791. * @returns the effective mesh (could be different from parent mesh)
  104792. */
  104793. getEffectiveMesh(): AbstractMesh;
  104794. /**
  104795. * Returns the submesh material
  104796. * @returns null or the current material
  104797. */
  104798. getMaterial(): Nullable<Material>;
  104799. private _IsMultiMaterial;
  104800. /**
  104801. * Sets a new updated BoundingInfo object to the submesh
  104802. * @param data defines an optional position array to use to determine the bounding info
  104803. * @returns the SubMesh
  104804. */
  104805. refreshBoundingInfo(data?: Nullable<FloatArray>): SubMesh;
  104806. /** @hidden */
  104807. _checkCollision(collider: Collider): boolean;
  104808. /**
  104809. * Updates the submesh BoundingInfo
  104810. * @param world defines the world matrix to use to update the bounding info
  104811. * @returns the submesh
  104812. */
  104813. updateBoundingInfo(world: DeepImmutable<Matrix>): SubMesh;
  104814. /**
  104815. * True is the submesh bounding box intersects the frustum defined by the passed array of planes.
  104816. * @param frustumPlanes defines the frustum planes
  104817. * @returns true if the submesh is intersecting with the frustum
  104818. */
  104819. isInFrustum(frustumPlanes: Plane[]): boolean;
  104820. /**
  104821. * True is the submesh bounding box is completely inside the frustum defined by the passed array of planes
  104822. * @param frustumPlanes defines the frustum planes
  104823. * @returns true if the submesh is inside the frustum
  104824. */
  104825. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  104826. /**
  104827. * Renders the submesh
  104828. * @param enableAlphaMode defines if alpha needs to be used
  104829. * @returns the submesh
  104830. */
  104831. render(enableAlphaMode: boolean): SubMesh;
  104832. /**
  104833. * @hidden
  104834. */
  104835. _getLinesIndexBuffer(indices: IndicesArray, engine: Engine): DataBuffer;
  104836. /**
  104837. * Checks if the submesh intersects with a ray
  104838. * @param ray defines the ray to test
  104839. * @returns true is the passed ray intersects the submesh bounding box
  104840. */
  104841. canIntersects(ray: Ray): boolean;
  104842. /**
  104843. * Intersects current submesh with a ray
  104844. * @param ray defines the ray to test
  104845. * @param positions defines mesh's positions array
  104846. * @param indices defines mesh's indices array
  104847. * @param fastCheck defines if the first intersection will be used (and not the closest)
  104848. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  104849. * @returns intersection info or null if no intersection
  104850. */
  104851. intersects(ray: Ray, positions: Vector3[], indices: IndicesArray, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<IntersectionInfo>;
  104852. /** @hidden */
  104853. private _intersectLines;
  104854. /** @hidden */
  104855. private _intersectUnIndexedLines;
  104856. /** @hidden */
  104857. private _intersectTriangles;
  104858. /** @hidden */
  104859. private _intersectUnIndexedTriangles;
  104860. /** @hidden */
  104861. _rebuild(): void;
  104862. /**
  104863. * Creates a new submesh from the passed mesh
  104864. * @param newMesh defines the new hosting mesh
  104865. * @param newRenderingMesh defines an optional rendering mesh
  104866. * @returns the new submesh
  104867. */
  104868. clone(newMesh: AbstractMesh, newRenderingMesh?: Mesh): SubMesh;
  104869. /**
  104870. * Release associated resources
  104871. */
  104872. dispose(): void;
  104873. /**
  104874. * Gets the class name
  104875. * @returns the string "SubMesh".
  104876. */
  104877. getClassName(): string;
  104878. /**
  104879. * Creates a new submesh from indices data
  104880. * @param materialIndex the index of the main mesh material
  104881. * @param startIndex the index where to start the copy in the mesh indices array
  104882. * @param indexCount the number of indices to copy then from the startIndex
  104883. * @param mesh the main mesh to create the submesh from
  104884. * @param renderingMesh the optional rendering mesh
  104885. * @returns a new submesh
  104886. */
  104887. static CreateFromIndices(materialIndex: number, startIndex: number, indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh): SubMesh;
  104888. }
  104889. }
  104890. declare module BABYLON {
  104891. /**
  104892. * Class used to represent data loading progression
  104893. */
  104894. export class SceneLoaderFlags {
  104895. private static _ForceFullSceneLoadingForIncremental;
  104896. private static _ShowLoadingScreen;
  104897. private static _CleanBoneMatrixWeights;
  104898. private static _loggingLevel;
  104899. /**
  104900. * Gets or sets a boolean indicating if entire scene must be loaded even if scene contains incremental data
  104901. */
  104902. static get ForceFullSceneLoadingForIncremental(): boolean;
  104903. static set ForceFullSceneLoadingForIncremental(value: boolean);
  104904. /**
  104905. * Gets or sets a boolean indicating if loading screen must be displayed while loading a scene
  104906. */
  104907. static get ShowLoadingScreen(): boolean;
  104908. static set ShowLoadingScreen(value: boolean);
  104909. /**
  104910. * Defines the current logging level (while loading the scene)
  104911. * @ignorenaming
  104912. */
  104913. static get loggingLevel(): number;
  104914. static set loggingLevel(value: number);
  104915. /**
  104916. * Gets or set a boolean indicating if matrix weights must be cleaned upon loading
  104917. */
  104918. static get CleanBoneMatrixWeights(): boolean;
  104919. static set CleanBoneMatrixWeights(value: boolean);
  104920. }
  104921. }
  104922. declare module BABYLON {
  104923. /**
  104924. * Class used to store geometry data (vertex buffers + index buffer)
  104925. */
  104926. export class Geometry implements IGetSetVerticesData {
  104927. /**
  104928. * Gets or sets the ID of the geometry
  104929. */
  104930. id: string;
  104931. /**
  104932. * Gets or sets the unique ID of the geometry
  104933. */
  104934. uniqueId: number;
  104935. /**
  104936. * Gets the delay loading state of the geometry (none by default which means not delayed)
  104937. */
  104938. delayLoadState: number;
  104939. /**
  104940. * Gets the file containing the data to load when running in delay load state
  104941. */
  104942. delayLoadingFile: Nullable<string>;
  104943. /**
  104944. * Callback called when the geometry is updated
  104945. */
  104946. onGeometryUpdated: (geometry: Geometry, kind?: string) => void;
  104947. private _scene;
  104948. private _engine;
  104949. private _meshes;
  104950. private _totalVertices;
  104951. /** @hidden */
  104952. _indices: IndicesArray;
  104953. /** @hidden */
  104954. _vertexBuffers: {
  104955. [key: string]: VertexBuffer;
  104956. };
  104957. private _isDisposed;
  104958. private _extend;
  104959. private _boundingBias;
  104960. /** @hidden */
  104961. _delayInfo: Array<string>;
  104962. private _indexBuffer;
  104963. private _indexBufferIsUpdatable;
  104964. /** @hidden */
  104965. _boundingInfo: Nullable<BoundingInfo>;
  104966. /** @hidden */
  104967. _delayLoadingFunction: Nullable<(any: any, geometry: Geometry) => void>;
  104968. /** @hidden */
  104969. _softwareSkinningFrameId: number;
  104970. private _vertexArrayObjects;
  104971. private _updatable;
  104972. /** @hidden */
  104973. _positions: Nullable<Vector3[]>;
  104974. /**
  104975. * 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
  104976. */
  104977. get boundingBias(): Vector2;
  104978. /**
  104979. * 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
  104980. */
  104981. set boundingBias(value: Vector2);
  104982. /**
  104983. * Static function used to attach a new empty geometry to a mesh
  104984. * @param mesh defines the mesh to attach the geometry to
  104985. * @returns the new Geometry
  104986. */
  104987. static CreateGeometryForMesh(mesh: Mesh): Geometry;
  104988. /** Get the list of meshes using this geometry */
  104989. get meshes(): Mesh[];
  104990. /**
  104991. * 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
  104992. * and won't be computed based on the vertex positions (which is what we get when useBoundingInfoFromGeometry = false)
  104993. */
  104994. useBoundingInfoFromGeometry: boolean;
  104995. /**
  104996. * Creates a new geometry
  104997. * @param id defines the unique ID
  104998. * @param scene defines the hosting scene
  104999. * @param vertexData defines the VertexData used to get geometry data
  105000. * @param updatable defines if geometry must be updatable (false by default)
  105001. * @param mesh defines the mesh that will be associated with the geometry
  105002. */
  105003. constructor(id: string, scene: Scene, vertexData?: VertexData, updatable?: boolean, mesh?: Nullable<Mesh>);
  105004. /**
  105005. * Gets the current extend of the geometry
  105006. */
  105007. get extend(): {
  105008. minimum: Vector3;
  105009. maximum: Vector3;
  105010. };
  105011. /**
  105012. * Gets the hosting scene
  105013. * @returns the hosting Scene
  105014. */
  105015. getScene(): Scene;
  105016. /**
  105017. * Gets the hosting engine
  105018. * @returns the hosting Engine
  105019. */
  105020. getEngine(): Engine;
  105021. /**
  105022. * Defines if the geometry is ready to use
  105023. * @returns true if the geometry is ready to be used
  105024. */
  105025. isReady(): boolean;
  105026. /**
  105027. * Gets a value indicating that the geometry should not be serialized
  105028. */
  105029. get doNotSerialize(): boolean;
  105030. /** @hidden */
  105031. _rebuild(): void;
  105032. /**
  105033. * Affects all geometry data in one call
  105034. * @param vertexData defines the geometry data
  105035. * @param updatable defines if the geometry must be flagged as updatable (false as default)
  105036. */
  105037. setAllVerticesData(vertexData: VertexData, updatable?: boolean): void;
  105038. /**
  105039. * Set specific vertex data
  105040. * @param kind defines the data kind (Position, normal, etc...)
  105041. * @param data defines the vertex data to use
  105042. * @param updatable defines if the vertex must be flagged as updatable (false as default)
  105043. * @param stride defines the stride to use (0 by default). This value is deduced from the kind value if not specified
  105044. */
  105045. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): void;
  105046. /**
  105047. * Removes a specific vertex data
  105048. * @param kind defines the data kind (Position, normal, etc...)
  105049. */
  105050. removeVerticesData(kind: string): void;
  105051. /**
  105052. * Affect a vertex buffer to the geometry. the vertexBuffer.getKind() function is used to determine where to store the data
  105053. * @param buffer defines the vertex buffer to use
  105054. * @param totalVertices defines the total number of vertices for position kind (could be null)
  105055. */
  105056. setVerticesBuffer(buffer: VertexBuffer, totalVertices?: Nullable<number>): void;
  105057. /**
  105058. * Update a specific vertex buffer
  105059. * This function will directly update the underlying DataBuffer according to the passed numeric array or Float32Array
  105060. * It will do nothing if the buffer is not updatable
  105061. * @param kind defines the data kind (Position, normal, etc...)
  105062. * @param data defines the data to use
  105063. * @param offset defines the offset in the target buffer where to store the data
  105064. * @param useBytes set to true if the offset is in bytes
  105065. */
  105066. updateVerticesDataDirectly(kind: string, data: DataArray, offset: number, useBytes?: boolean): void;
  105067. /**
  105068. * Update a specific vertex buffer
  105069. * This function will create a new buffer if the current one is not updatable
  105070. * @param kind defines the data kind (Position, normal, etc...)
  105071. * @param data defines the data to use
  105072. * @param updateExtends defines if the geometry extends must be recomputed (false by default)
  105073. */
  105074. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean): void;
  105075. private _updateBoundingInfo;
  105076. /** @hidden */
  105077. _bind(effect: Nullable<Effect>, indexToBind?: Nullable<DataBuffer>): void;
  105078. /**
  105079. * Gets total number of vertices
  105080. * @returns the total number of vertices
  105081. */
  105082. getTotalVertices(): number;
  105083. /**
  105084. * Gets a specific vertex data attached to this geometry. Float data is constructed if the vertex buffer data cannot be returned directly.
  105085. * @param kind defines the data kind (Position, normal, etc...)
  105086. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  105087. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  105088. * @returns a float array containing vertex data
  105089. */
  105090. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  105091. /**
  105092. * Returns a boolean defining if the vertex data for the requested `kind` is updatable
  105093. * @param kind defines the data kind (Position, normal, etc...)
  105094. * @returns true if the vertex buffer with the specified kind is updatable
  105095. */
  105096. isVertexBufferUpdatable(kind: string): boolean;
  105097. /**
  105098. * Gets a specific vertex buffer
  105099. * @param kind defines the data kind (Position, normal, etc...)
  105100. * @returns a VertexBuffer
  105101. */
  105102. getVertexBuffer(kind: string): Nullable<VertexBuffer>;
  105103. /**
  105104. * Returns all vertex buffers
  105105. * @return an object holding all vertex buffers indexed by kind
  105106. */
  105107. getVertexBuffers(): Nullable<{
  105108. [key: string]: VertexBuffer;
  105109. }>;
  105110. /**
  105111. * Gets a boolean indicating if specific vertex buffer is present
  105112. * @param kind defines the data kind (Position, normal, etc...)
  105113. * @returns true if data is present
  105114. */
  105115. isVerticesDataPresent(kind: string): boolean;
  105116. /**
  105117. * Gets a list of all attached data kinds (Position, normal, etc...)
  105118. * @returns a list of string containing all kinds
  105119. */
  105120. getVerticesDataKinds(): string[];
  105121. /**
  105122. * Update index buffer
  105123. * @param indices defines the indices to store in the index buffer
  105124. * @param offset defines the offset in the target buffer where to store the data
  105125. * @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)
  105126. */
  105127. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): void;
  105128. /**
  105129. * Creates a new index buffer
  105130. * @param indices defines the indices to store in the index buffer
  105131. * @param totalVertices defines the total number of vertices (could be null)
  105132. * @param updatable defines if the index buffer must be flagged as updatable (false by default)
  105133. */
  105134. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>, updatable?: boolean): void;
  105135. /**
  105136. * Return the total number of indices
  105137. * @returns the total number of indices
  105138. */
  105139. getTotalIndices(): number;
  105140. /**
  105141. * Gets the index buffer array
  105142. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  105143. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  105144. * @returns the index buffer array
  105145. */
  105146. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  105147. /**
  105148. * Gets the index buffer
  105149. * @return the index buffer
  105150. */
  105151. getIndexBuffer(): Nullable<DataBuffer>;
  105152. /** @hidden */
  105153. _releaseVertexArrayObject(effect?: Nullable<Effect>): void;
  105154. /**
  105155. * Release the associated resources for a specific mesh
  105156. * @param mesh defines the source mesh
  105157. * @param shouldDispose defines if the geometry must be disposed if there is no more mesh pointing to it
  105158. */
  105159. releaseForMesh(mesh: Mesh, shouldDispose?: boolean): void;
  105160. /**
  105161. * Apply current geometry to a given mesh
  105162. * @param mesh defines the mesh to apply geometry to
  105163. */
  105164. applyToMesh(mesh: Mesh): void;
  105165. private _updateExtend;
  105166. private _applyToMesh;
  105167. private notifyUpdate;
  105168. /**
  105169. * Load the geometry if it was flagged as delay loaded
  105170. * @param scene defines the hosting scene
  105171. * @param onLoaded defines a callback called when the geometry is loaded
  105172. */
  105173. load(scene: Scene, onLoaded?: () => void): void;
  105174. private _queueLoad;
  105175. /**
  105176. * Invert the geometry to move from a right handed system to a left handed one.
  105177. */
  105178. toLeftHanded(): void;
  105179. /** @hidden */
  105180. _resetPointsArrayCache(): void;
  105181. /** @hidden */
  105182. _generatePointsArray(): boolean;
  105183. /**
  105184. * Gets a value indicating if the geometry is disposed
  105185. * @returns true if the geometry was disposed
  105186. */
  105187. isDisposed(): boolean;
  105188. private _disposeVertexArrayObjects;
  105189. /**
  105190. * Free all associated resources
  105191. */
  105192. dispose(): void;
  105193. /**
  105194. * Clone the current geometry into a new geometry
  105195. * @param id defines the unique ID of the new geometry
  105196. * @returns a new geometry object
  105197. */
  105198. copy(id: string): Geometry;
  105199. /**
  105200. * Serialize the current geometry info (and not the vertices data) into a JSON object
  105201. * @return a JSON representation of the current geometry data (without the vertices data)
  105202. */
  105203. serialize(): any;
  105204. private toNumberArray;
  105205. /**
  105206. * Serialize all vertices data into a JSON oject
  105207. * @returns a JSON representation of the current geometry data
  105208. */
  105209. serializeVerticeData(): any;
  105210. /**
  105211. * Extracts a clone of a mesh geometry
  105212. * @param mesh defines the source mesh
  105213. * @param id defines the unique ID of the new geometry object
  105214. * @returns the new geometry object
  105215. */
  105216. static ExtractFromMesh(mesh: Mesh, id: string): Nullable<Geometry>;
  105217. /**
  105218. * You should now use Tools.RandomId(), this method is still here for legacy reasons.
  105219. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  105220. * Be aware Math.random() could cause collisions, but:
  105221. * "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"
  105222. * @returns a string containing a new GUID
  105223. */
  105224. static RandomId(): string;
  105225. /** @hidden */
  105226. static _ImportGeometry(parsedGeometry: any, mesh: Mesh): void;
  105227. private static _CleanMatricesWeights;
  105228. /**
  105229. * Create a new geometry from persisted data (Using .babylon file format)
  105230. * @param parsedVertexData defines the persisted data
  105231. * @param scene defines the hosting scene
  105232. * @param rootUrl defines the root url to use to load assets (like delayed data)
  105233. * @returns the new geometry object
  105234. */
  105235. static Parse(parsedVertexData: any, scene: Scene, rootUrl: string): Nullable<Geometry>;
  105236. }
  105237. }
  105238. declare module BABYLON {
  105239. /**
  105240. * Define an interface for all classes that will get and set the data on vertices
  105241. */
  105242. export interface IGetSetVerticesData {
  105243. /**
  105244. * Gets a boolean indicating if specific vertex data is present
  105245. * @param kind defines the vertex data kind to use
  105246. * @returns true is data kind is present
  105247. */
  105248. isVerticesDataPresent(kind: string): boolean;
  105249. /**
  105250. * Gets a specific vertex data attached to this geometry. Float data is constructed if the vertex buffer data cannot be returned directly.
  105251. * @param kind defines the data kind (Position, normal, etc...)
  105252. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  105253. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  105254. * @returns a float array containing vertex data
  105255. */
  105256. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  105257. /**
  105258. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  105259. * @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.
  105260. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  105261. * @returns the indices array or an empty array if the mesh has no geometry
  105262. */
  105263. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  105264. /**
  105265. * Set specific vertex data
  105266. * @param kind defines the data kind (Position, normal, etc...)
  105267. * @param data defines the vertex data to use
  105268. * @param updatable defines if the vertex must be flagged as updatable (false as default)
  105269. * @param stride defines the stride to use (0 by default). This value is deduced from the kind value if not specified
  105270. */
  105271. setVerticesData(kind: string, data: FloatArray, updatable: boolean): void;
  105272. /**
  105273. * Update a specific associated vertex buffer
  105274. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  105275. * - VertexBuffer.PositionKind
  105276. * - VertexBuffer.UVKind
  105277. * - VertexBuffer.UV2Kind
  105278. * - VertexBuffer.UV3Kind
  105279. * - VertexBuffer.UV4Kind
  105280. * - VertexBuffer.UV5Kind
  105281. * - VertexBuffer.UV6Kind
  105282. * - VertexBuffer.ColorKind
  105283. * - VertexBuffer.MatricesIndicesKind
  105284. * - VertexBuffer.MatricesIndicesExtraKind
  105285. * - VertexBuffer.MatricesWeightsKind
  105286. * - VertexBuffer.MatricesWeightsExtraKind
  105287. * @param data defines the data source
  105288. * @param updateExtends defines if extends info of the mesh must be updated (can be null). This is mostly useful for "position" kind
  105289. * @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)
  105290. */
  105291. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): void;
  105292. /**
  105293. * Creates a new index buffer
  105294. * @param indices defines the indices to store in the index buffer
  105295. * @param totalVertices defines the total number of vertices (could be null)
  105296. * @param updatable defines if the index buffer must be flagged as updatable (false by default)
  105297. */
  105298. setIndices(indices: IndicesArray, totalVertices: Nullable<number>, updatable?: boolean): void;
  105299. }
  105300. /**
  105301. * This class contains the various kinds of data on every vertex of a mesh used in determining its shape and appearance
  105302. */
  105303. export class VertexData {
  105304. /**
  105305. * Mesh side orientation : usually the external or front surface
  105306. */
  105307. static readonly FRONTSIDE: number;
  105308. /**
  105309. * Mesh side orientation : usually the internal or back surface
  105310. */
  105311. static readonly BACKSIDE: number;
  105312. /**
  105313. * Mesh side orientation : both internal and external or front and back surfaces
  105314. */
  105315. static readonly DOUBLESIDE: number;
  105316. /**
  105317. * Mesh side orientation : by default, `FRONTSIDE`
  105318. */
  105319. static readonly DEFAULTSIDE: number;
  105320. /**
  105321. * An array of the x, y, z position of each vertex [...., x, y, z, .....]
  105322. */
  105323. positions: Nullable<FloatArray>;
  105324. /**
  105325. * An array of the x, y, z normal vector of each vertex [...., x, y, z, .....]
  105326. */
  105327. normals: Nullable<FloatArray>;
  105328. /**
  105329. * An array of the x, y, z tangent vector of each vertex [...., x, y, z, .....]
  105330. */
  105331. tangents: Nullable<FloatArray>;
  105332. /**
  105333. * An array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  105334. */
  105335. uvs: Nullable<FloatArray>;
  105336. /**
  105337. * A second array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  105338. */
  105339. uvs2: Nullable<FloatArray>;
  105340. /**
  105341. * A third array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  105342. */
  105343. uvs3: Nullable<FloatArray>;
  105344. /**
  105345. * A fourth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  105346. */
  105347. uvs4: Nullable<FloatArray>;
  105348. /**
  105349. * A fifth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  105350. */
  105351. uvs5: Nullable<FloatArray>;
  105352. /**
  105353. * A sixth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  105354. */
  105355. uvs6: Nullable<FloatArray>;
  105356. /**
  105357. * An array of the r, g, b, a, color of each vertex [...., r, g, b, a, .....]
  105358. */
  105359. colors: Nullable<FloatArray>;
  105360. /**
  105361. * 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).
  105362. */
  105363. matricesIndices: Nullable<FloatArray>;
  105364. /**
  105365. * An array containing the list of weights defining the weight of each indexed matrix in the final computation
  105366. */
  105367. matricesWeights: Nullable<FloatArray>;
  105368. /**
  105369. * An array extending the number of possible indices
  105370. */
  105371. matricesIndicesExtra: Nullable<FloatArray>;
  105372. /**
  105373. * An array extending the number of possible weights when the number of indices is extended
  105374. */
  105375. matricesWeightsExtra: Nullable<FloatArray>;
  105376. /**
  105377. * An array of i, j, k the three vertex indices required for each triangular facet [...., i, j, k .....]
  105378. */
  105379. indices: Nullable<IndicesArray>;
  105380. /**
  105381. * Uses the passed data array to set the set the values for the specified kind of data
  105382. * @param data a linear array of floating numbers
  105383. * @param kind the type of data that is being set, eg positions, colors etc
  105384. */
  105385. set(data: FloatArray, kind: string): void;
  105386. /**
  105387. * Associates the vertexData to the passed Mesh.
  105388. * Sets it as updatable or not (default `false`)
  105389. * @param mesh the mesh the vertexData is applied to
  105390. * @param updatable when used and having the value true allows new data to update the vertexData
  105391. * @returns the VertexData
  105392. */
  105393. applyToMesh(mesh: Mesh, updatable?: boolean): VertexData;
  105394. /**
  105395. * Associates the vertexData to the passed Geometry.
  105396. * Sets it as updatable or not (default `false`)
  105397. * @param geometry the geometry the vertexData is applied to
  105398. * @param updatable when used and having the value true allows new data to update the vertexData
  105399. * @returns VertexData
  105400. */
  105401. applyToGeometry(geometry: Geometry, updatable?: boolean): VertexData;
  105402. /**
  105403. * Updates the associated mesh
  105404. * @param mesh the mesh to be updated
  105405. * @param updateExtends when true the mesh BoundingInfo will be renewed when and if position kind is updated, optional with default false
  105406. * @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
  105407. * @returns VertexData
  105408. */
  105409. updateMesh(mesh: Mesh): VertexData;
  105410. /**
  105411. * Updates the associated geometry
  105412. * @param geometry the geometry to be updated
  105413. * @param updateExtends when true BoundingInfo will be renewed when and if position kind is updated, optional with default false
  105414. * @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
  105415. * @returns VertexData.
  105416. */
  105417. updateGeometry(geometry: Geometry): VertexData;
  105418. private _applyTo;
  105419. private _update;
  105420. /**
  105421. * Transforms each position and each normal of the vertexData according to the passed Matrix
  105422. * @param matrix the transforming matrix
  105423. * @returns the VertexData
  105424. */
  105425. transform(matrix: Matrix): VertexData;
  105426. /**
  105427. * Merges the passed VertexData into the current one
  105428. * @param other the VertexData to be merged into the current one
  105429. * @param use32BitsIndices defines a boolean indicating if indices must be store in a 32 bits array
  105430. * @returns the modified VertexData
  105431. */
  105432. merge(other: VertexData, use32BitsIndices?: boolean): VertexData;
  105433. private _mergeElement;
  105434. private _validate;
  105435. /**
  105436. * Serializes the VertexData
  105437. * @returns a serialized object
  105438. */
  105439. serialize(): any;
  105440. /**
  105441. * Extracts the vertexData from a mesh
  105442. * @param mesh the mesh from which to extract the VertexData
  105443. * @param copyWhenShared defines if the VertexData must be cloned when shared between multiple meshes, optional, default false
  105444. * @param forceCopy indicating that the VertexData must be cloned, optional, default false
  105445. * @returns the object VertexData associated to the passed mesh
  105446. */
  105447. static ExtractFromMesh(mesh: Mesh, copyWhenShared?: boolean, forceCopy?: boolean): VertexData;
  105448. /**
  105449. * Extracts the vertexData from the geometry
  105450. * @param geometry the geometry from which to extract the VertexData
  105451. * @param copyWhenShared defines if the VertexData must be cloned when the geometrty is shared between multiple meshes, optional, default false
  105452. * @param forceCopy indicating that the VertexData must be cloned, optional, default false
  105453. * @returns the object VertexData associated to the passed mesh
  105454. */
  105455. static ExtractFromGeometry(geometry: Geometry, copyWhenShared?: boolean, forceCopy?: boolean): VertexData;
  105456. private static _ExtractFrom;
  105457. /**
  105458. * Creates the VertexData for a Ribbon
  105459. * @param options an object used to set the following optional parameters for the ribbon, required but can be empty
  105460. * * pathArray array of paths, each of which an array of successive Vector3
  105461. * * closeArray creates a seam between the first and the last paths of the pathArray, optional, default false
  105462. * * closePath creates a seam between the first and the last points of each path of the path array, optional, default false
  105463. * * 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
  105464. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  105465. * * 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)
  105466. * * 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)
  105467. * * invertUV swaps in the U and V coordinates when applying a texture, optional, default false
  105468. * * uvs a linear array, of length 2 * number of vertices, of custom UV values, optional
  105469. * * colors a linear array, of length 4 * number of vertices, of custom color values, optional
  105470. * @returns the VertexData of the ribbon
  105471. */
  105472. static CreateRibbon(options: {
  105473. pathArray: Vector3[][];
  105474. closeArray?: boolean;
  105475. closePath?: boolean;
  105476. offset?: number;
  105477. sideOrientation?: number;
  105478. frontUVs?: Vector4;
  105479. backUVs?: Vector4;
  105480. invertUV?: boolean;
  105481. uvs?: Vector2[];
  105482. colors?: Color4[];
  105483. }): VertexData;
  105484. /**
  105485. * Creates the VertexData for a box
  105486. * @param options an object used to set the following optional parameters for the box, required but can be empty
  105487. * * size sets the width, height and depth of the box to the value of size, optional default 1
  105488. * * width sets the width (x direction) of the box, overwrites the width set by size, optional, default size
  105489. * * height sets the height (y direction) of the box, overwrites the height set by size, optional, default size
  105490. * * depth sets the depth (z direction) of the box, overwrites the depth set by size, optional, default size
  105491. * * faceUV an array of 6 Vector4 elements used to set different images to each box side
  105492. * * faceColors an array of 6 Color3 elements used to set different colors to each box side
  105493. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  105494. * * 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)
  105495. * * 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)
  105496. * @returns the VertexData of the box
  105497. */
  105498. static CreateBox(options: {
  105499. size?: number;
  105500. width?: number;
  105501. height?: number;
  105502. depth?: number;
  105503. faceUV?: Vector4[];
  105504. faceColors?: Color4[];
  105505. sideOrientation?: number;
  105506. frontUVs?: Vector4;
  105507. backUVs?: Vector4;
  105508. }): VertexData;
  105509. /**
  105510. * Creates the VertexData for a tiled box
  105511. * @param options an object used to set the following optional parameters for the box, required but can be empty
  105512. * * faceTiles sets the pattern, tile size and number of tiles for a face
  105513. * * faceUV an array of 6 Vector4 elements used to set different images to each box side
  105514. * * faceColors an array of 6 Color3 elements used to set different colors to each box side
  105515. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  105516. * @returns the VertexData of the box
  105517. */
  105518. static CreateTiledBox(options: {
  105519. pattern?: number;
  105520. width?: number;
  105521. height?: number;
  105522. depth?: number;
  105523. tileSize?: number;
  105524. tileWidth?: number;
  105525. tileHeight?: number;
  105526. alignHorizontal?: number;
  105527. alignVertical?: number;
  105528. faceUV?: Vector4[];
  105529. faceColors?: Color4[];
  105530. sideOrientation?: number;
  105531. }): VertexData;
  105532. /**
  105533. * Creates the VertexData for a tiled plane
  105534. * @param options an object used to set the following optional parameters for the box, required but can be empty
  105535. * * pattern a limited pattern arrangement depending on the number
  105536. * * tileSize sets the width, height and depth of the tile to the value of size, optional default 1
  105537. * * tileWidth sets the width (x direction) of the tile, overwrites the width set by size, optional, default size
  105538. * * tileHeight sets the height (y direction) of the tile, overwrites the height set by size, optional, default size
  105539. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  105540. * * 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)
  105541. * * 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)
  105542. * @returns the VertexData of the tiled plane
  105543. */
  105544. static CreateTiledPlane(options: {
  105545. pattern?: number;
  105546. tileSize?: number;
  105547. tileWidth?: number;
  105548. tileHeight?: number;
  105549. size?: number;
  105550. width?: number;
  105551. height?: number;
  105552. alignHorizontal?: number;
  105553. alignVertical?: number;
  105554. sideOrientation?: number;
  105555. frontUVs?: Vector4;
  105556. backUVs?: Vector4;
  105557. }): VertexData;
  105558. /**
  105559. * Creates the VertexData for an ellipsoid, defaults to a sphere
  105560. * @param options an object used to set the following optional parameters for the box, required but can be empty
  105561. * * segments sets the number of horizontal strips optional, default 32
  105562. * * diameter sets the axes dimensions, diameterX, diameterY and diameterZ to the value of diameter, optional default 1
  105563. * * diameterX sets the diameterX (x direction) of the ellipsoid, overwrites the diameterX set by diameter, optional, default diameter
  105564. * * diameterY sets the diameterY (y direction) of the ellipsoid, overwrites the diameterY set by diameter, optional, default diameter
  105565. * * diameterZ sets the diameterZ (z direction) of the ellipsoid, overwrites the diameterZ set by diameter, optional, default diameter
  105566. * * 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
  105567. * * 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
  105568. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  105569. * * 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)
  105570. * * 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)
  105571. * @returns the VertexData of the ellipsoid
  105572. */
  105573. static CreateSphere(options: {
  105574. segments?: number;
  105575. diameter?: number;
  105576. diameterX?: number;
  105577. diameterY?: number;
  105578. diameterZ?: number;
  105579. arc?: number;
  105580. slice?: number;
  105581. sideOrientation?: number;
  105582. frontUVs?: Vector4;
  105583. backUVs?: Vector4;
  105584. }): VertexData;
  105585. /**
  105586. * Creates the VertexData for a cylinder, cone or prism
  105587. * @param options an object used to set the following optional parameters for the box, required but can be empty
  105588. * * height sets the height (y direction) of the cylinder, optional, default 2
  105589. * * diameterTop sets the diameter of the top of the cone, overwrites diameter, optional, default diameter
  105590. * * diameterBottom sets the diameter of the bottom of the cone, overwrites diameter, optional, default diameter
  105591. * * diameter sets the diameter of the top and bottom of the cone, optional default 1
  105592. * * tessellation the number of prism sides, 3 for a triangular prism, optional, default 24
  105593. * * subdivisions` the number of rings along the cylinder height, optional, default 1
  105594. * * 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
  105595. * * faceColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  105596. * * faceUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  105597. * * hasRings when true makes each subdivision independantly treated as a face for faceUV and faceColors, optional, default false
  105598. * * enclose when true closes an open cylinder by adding extra flat faces between the height axis and vertical edges, think cut cake
  105599. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  105600. * * 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)
  105601. * * 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)
  105602. * @returns the VertexData of the cylinder, cone or prism
  105603. */
  105604. static CreateCylinder(options: {
  105605. height?: number;
  105606. diameterTop?: number;
  105607. diameterBottom?: number;
  105608. diameter?: number;
  105609. tessellation?: number;
  105610. subdivisions?: number;
  105611. arc?: number;
  105612. faceColors?: Color4[];
  105613. faceUV?: Vector4[];
  105614. hasRings?: boolean;
  105615. enclose?: boolean;
  105616. sideOrientation?: number;
  105617. frontUVs?: Vector4;
  105618. backUVs?: Vector4;
  105619. }): VertexData;
  105620. /**
  105621. * Creates the VertexData for a torus
  105622. * @param options an object used to set the following optional parameters for the box, required but can be empty
  105623. * * diameter the diameter of the torus, optional default 1
  105624. * * thickness the diameter of the tube forming the torus, optional default 0.5
  105625. * * tessellation the number of prism sides, 3 for a triangular prism, optional, default 24
  105626. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  105627. * * 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)
  105628. * * 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)
  105629. * @returns the VertexData of the torus
  105630. */
  105631. static CreateTorus(options: {
  105632. diameter?: number;
  105633. thickness?: number;
  105634. tessellation?: number;
  105635. sideOrientation?: number;
  105636. frontUVs?: Vector4;
  105637. backUVs?: Vector4;
  105638. }): VertexData;
  105639. /**
  105640. * Creates the VertexData of the LineSystem
  105641. * @param options an object used to set the following optional parameters for the LineSystem, required but can be empty
  105642. * - lines an array of lines, each line being an array of successive Vector3
  105643. * - colors an array of line colors, each of the line colors being an array of successive Color4, one per line point
  105644. * @returns the VertexData of the LineSystem
  105645. */
  105646. static CreateLineSystem(options: {
  105647. lines: Vector3[][];
  105648. colors?: Nullable<Color4[][]>;
  105649. }): VertexData;
  105650. /**
  105651. * Create the VertexData for a DashedLines
  105652. * @param options an object used to set the following optional parameters for the DashedLines, required but can be empty
  105653. * - points an array successive Vector3
  105654. * - dashSize the size of the dashes relative to the dash number, optional, default 3
  105655. * - gapSize the size of the gap between two successive dashes relative to the dash number, optional, default 1
  105656. * - dashNb the intended total number of dashes, optional, default 200
  105657. * @returns the VertexData for the DashedLines
  105658. */
  105659. static CreateDashedLines(options: {
  105660. points: Vector3[];
  105661. dashSize?: number;
  105662. gapSize?: number;
  105663. dashNb?: number;
  105664. }): VertexData;
  105665. /**
  105666. * Creates the VertexData for a Ground
  105667. * @param options an object used to set the following optional parameters for the Ground, required but can be empty
  105668. * - width the width (x direction) of the ground, optional, default 1
  105669. * - height the height (z direction) of the ground, optional, default 1
  105670. * - subdivisions the number of subdivisions per side, optional, default 1
  105671. * @returns the VertexData of the Ground
  105672. */
  105673. static CreateGround(options: {
  105674. width?: number;
  105675. height?: number;
  105676. subdivisions?: number;
  105677. subdivisionsX?: number;
  105678. subdivisionsY?: number;
  105679. }): VertexData;
  105680. /**
  105681. * Creates the VertexData for a TiledGround by subdividing the ground into tiles
  105682. * @param options an object used to set the following optional parameters for the Ground, required but can be empty
  105683. * * xmin the ground minimum X coordinate, optional, default -1
  105684. * * zmin the ground minimum Z coordinate, optional, default -1
  105685. * * xmax the ground maximum X coordinate, optional, default 1
  105686. * * zmax the ground maximum Z coordinate, optional, default 1
  105687. * * 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}
  105688. * * 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}
  105689. * @returns the VertexData of the TiledGround
  105690. */
  105691. static CreateTiledGround(options: {
  105692. xmin: number;
  105693. zmin: number;
  105694. xmax: number;
  105695. zmax: number;
  105696. subdivisions?: {
  105697. w: number;
  105698. h: number;
  105699. };
  105700. precision?: {
  105701. w: number;
  105702. h: number;
  105703. };
  105704. }): VertexData;
  105705. /**
  105706. * Creates the VertexData of the Ground designed from a heightmap
  105707. * @param options an object used to set the following parameters for the Ground, required and provided by MeshBuilder.CreateGroundFromHeightMap
  105708. * * width the width (x direction) of the ground
  105709. * * height the height (z direction) of the ground
  105710. * * subdivisions the number of subdivisions per side
  105711. * * minHeight the minimum altitude on the ground, optional, default 0
  105712. * * maxHeight the maximum altitude on the ground, optional default 1
  105713. * * colorFilter the filter to apply to the image pixel colors to compute the height, optional Color3, default (0.3, 0.59, 0.11)
  105714. * * buffer the array holding the image color data
  105715. * * bufferWidth the width of image
  105716. * * bufferHeight the height of image
  105717. * * alphaFilter Remove any data where the alpha channel is below this value, defaults 0 (all data visible)
  105718. * @returns the VertexData of the Ground designed from a heightmap
  105719. */
  105720. static CreateGroundFromHeightMap(options: {
  105721. width: number;
  105722. height: number;
  105723. subdivisions: number;
  105724. minHeight: number;
  105725. maxHeight: number;
  105726. colorFilter: Color3;
  105727. buffer: Uint8Array;
  105728. bufferWidth: number;
  105729. bufferHeight: number;
  105730. alphaFilter: number;
  105731. }): VertexData;
  105732. /**
  105733. * Creates the VertexData for a Plane
  105734. * @param options an object used to set the following optional parameters for the plane, required but can be empty
  105735. * * size sets the width and height of the plane to the value of size, optional default 1
  105736. * * width sets the width (x direction) of the plane, overwrites the width set by size, optional, default size
  105737. * * height sets the height (y direction) of the plane, overwrites the height set by size, optional, default size
  105738. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  105739. * * 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)
  105740. * * 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)
  105741. * @returns the VertexData of the box
  105742. */
  105743. static CreatePlane(options: {
  105744. size?: number;
  105745. width?: number;
  105746. height?: number;
  105747. sideOrientation?: number;
  105748. frontUVs?: Vector4;
  105749. backUVs?: Vector4;
  105750. }): VertexData;
  105751. /**
  105752. * Creates the VertexData of the Disc or regular Polygon
  105753. * @param options an object used to set the following optional parameters for the disc, required but can be empty
  105754. * * radius the radius of the disc, optional default 0.5
  105755. * * tessellation the number of polygon sides, optional, default 64
  105756. * * 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
  105757. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  105758. * * 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)
  105759. * * 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)
  105760. * @returns the VertexData of the box
  105761. */
  105762. static CreateDisc(options: {
  105763. radius?: number;
  105764. tessellation?: number;
  105765. arc?: number;
  105766. sideOrientation?: number;
  105767. frontUVs?: Vector4;
  105768. backUVs?: Vector4;
  105769. }): VertexData;
  105770. /**
  105771. * Creates the VertexData for an irregular Polygon in the XoZ plane using a mesh built by polygonTriangulation.build()
  105772. * All parameters are provided by MeshBuilder.CreatePolygon as needed
  105773. * @param polygon a mesh built from polygonTriangulation.build()
  105774. * @param sideOrientation takes the values Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  105775. * @param fUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  105776. * @param fColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  105777. * @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)
  105778. * @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)
  105779. * @param wrap a boolean, default false, when true and fUVs used texture is wrapped around all sides, when false texture is applied side
  105780. * @returns the VertexData of the Polygon
  105781. */
  105782. static CreatePolygon(polygon: Mesh, sideOrientation: number, fUV?: Vector4[], fColors?: Color4[], frontUVs?: Vector4, backUVs?: Vector4, wrap?: boolean): VertexData;
  105783. /**
  105784. * Creates the VertexData of the IcoSphere
  105785. * @param options an object used to set the following optional parameters for the IcoSphere, required but can be empty
  105786. * * radius the radius of the IcoSphere, optional default 1
  105787. * * radiusX allows stretching in the x direction, optional, default radius
  105788. * * radiusY allows stretching in the y direction, optional, default radius
  105789. * * radiusZ allows stretching in the z direction, optional, default radius
  105790. * * flat when true creates a flat shaded mesh, optional, default true
  105791. * * subdivisions increasing the subdivisions increases the number of faces, optional, default 4
  105792. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  105793. * * 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)
  105794. * * 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)
  105795. * @returns the VertexData of the IcoSphere
  105796. */
  105797. static CreateIcoSphere(options: {
  105798. radius?: number;
  105799. radiusX?: number;
  105800. radiusY?: number;
  105801. radiusZ?: number;
  105802. flat?: boolean;
  105803. subdivisions?: number;
  105804. sideOrientation?: number;
  105805. frontUVs?: Vector4;
  105806. backUVs?: Vector4;
  105807. }): VertexData;
  105808. /**
  105809. * Creates the VertexData for a Polyhedron
  105810. * @param options an object used to set the following optional parameters for the polyhedron, required but can be empty
  105811. * * type provided types are:
  105812. * * 0 : Tetrahedron, 1 : Octahedron, 2 : Dodecahedron, 3 : Icosahedron, 4 : Rhombicuboctahedron, 5 : Triangular Prism, 6 : Pentagonal Prism, 7 : Hexagonal Prism, 8 : Square Pyramid (J1)
  105813. * * 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)
  105814. * * size the size of the IcoSphere, optional default 1
  105815. * * sizeX allows stretching in the x direction, optional, default size
  105816. * * sizeY allows stretching in the y direction, optional, default size
  105817. * * sizeZ allows stretching in the z direction, optional, default size
  105818. * * 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
  105819. * * faceUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  105820. * * faceColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  105821. * * flat when true creates a flat shaded mesh, optional, default true
  105822. * * subdivisions increasing the subdivisions increases the number of faces, optional, default 4
  105823. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  105824. * * 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)
  105825. * * 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)
  105826. * @returns the VertexData of the Polyhedron
  105827. */
  105828. static CreatePolyhedron(options: {
  105829. type?: number;
  105830. size?: number;
  105831. sizeX?: number;
  105832. sizeY?: number;
  105833. sizeZ?: number;
  105834. custom?: any;
  105835. faceUV?: Vector4[];
  105836. faceColors?: Color4[];
  105837. flat?: boolean;
  105838. sideOrientation?: number;
  105839. frontUVs?: Vector4;
  105840. backUVs?: Vector4;
  105841. }): VertexData;
  105842. /**
  105843. * Creates the VertexData for a TorusKnot
  105844. * @param options an object used to set the following optional parameters for the TorusKnot, required but can be empty
  105845. * * radius the radius of the torus knot, optional, default 2
  105846. * * tube the thickness of the tube, optional, default 0.5
  105847. * * radialSegments the number of sides on each tube segments, optional, default 32
  105848. * * tubularSegments the number of tubes to decompose the knot into, optional, default 32
  105849. * * p the number of windings around the z axis, optional, default 2
  105850. * * q the number of windings around the x axis, optional, default 3
  105851. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  105852. * * 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)
  105853. * * 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)
  105854. * @returns the VertexData of the Torus Knot
  105855. */
  105856. static CreateTorusKnot(options: {
  105857. radius?: number;
  105858. tube?: number;
  105859. radialSegments?: number;
  105860. tubularSegments?: number;
  105861. p?: number;
  105862. q?: number;
  105863. sideOrientation?: number;
  105864. frontUVs?: Vector4;
  105865. backUVs?: Vector4;
  105866. }): VertexData;
  105867. /**
  105868. * Compute normals for given positions and indices
  105869. * @param positions an array of vertex positions, [...., x, y, z, ......]
  105870. * @param indices an array of indices in groups of three for each triangular facet, [...., i, j, k, ......]
  105871. * @param normals an array of vertex normals, [...., x, y, z, ......]
  105872. * @param options an object used to set the following optional parameters for the TorusKnot, optional
  105873. * * facetNormals : optional array of facet normals (vector3)
  105874. * * facetPositions : optional array of facet positions (vector3)
  105875. * * facetPartitioning : optional partitioning array. facetPositions is required for facetPartitioning computation
  105876. * * ratio : optional partitioning ratio / bounding box, required for facetPartitioning computation
  105877. * * bInfo : optional bounding info, required for facetPartitioning computation
  105878. * * bbSize : optional bounding box size data, required for facetPartitioning computation
  105879. * * subDiv : optional partitioning data about subdivsions on each axis (int), required for facetPartitioning computation
  105880. * * useRightHandedSystem: optional boolean to for right handed system computation
  105881. * * depthSort : optional boolean to enable the facet depth sort computation
  105882. * * distanceTo : optional Vector3 to compute the facet depth from this location
  105883. * * depthSortedFacets : optional array of depthSortedFacets to store the facet distances from the reference location
  105884. */
  105885. static ComputeNormals(positions: any, indices: any, normals: any, options?: {
  105886. facetNormals?: any;
  105887. facetPositions?: any;
  105888. facetPartitioning?: any;
  105889. ratio?: number;
  105890. bInfo?: any;
  105891. bbSize?: Vector3;
  105892. subDiv?: any;
  105893. useRightHandedSystem?: boolean;
  105894. depthSort?: boolean;
  105895. distanceTo?: Vector3;
  105896. depthSortedFacets?: any;
  105897. }): void;
  105898. /** @hidden */
  105899. static _ComputeSides(sideOrientation: number, positions: FloatArray, indices: FloatArray, normals: FloatArray, uvs: FloatArray, frontUVs?: Vector4, backUVs?: Vector4): void;
  105900. /**
  105901. * Applies VertexData created from the imported parameters to the geometry
  105902. * @param parsedVertexData the parsed data from an imported file
  105903. * @param geometry the geometry to apply the VertexData to
  105904. */
  105905. static ImportVertexData(parsedVertexData: any, geometry: Geometry): void;
  105906. }
  105907. }
  105908. declare module BABYLON {
  105909. /**
  105910. * Defines a target to use with MorphTargetManager
  105911. * @see https://doc.babylonjs.com/how_to/how_to_use_morphtargets
  105912. */
  105913. export class MorphTarget implements IAnimatable {
  105914. /** defines the name of the target */
  105915. name: string;
  105916. /**
  105917. * Gets or sets the list of animations
  105918. */
  105919. animations: Animation[];
  105920. private _scene;
  105921. private _positions;
  105922. private _normals;
  105923. private _tangents;
  105924. private _uvs;
  105925. private _influence;
  105926. private _uniqueId;
  105927. /**
  105928. * Observable raised when the influence changes
  105929. */
  105930. onInfluenceChanged: Observable<boolean>;
  105931. /** @hidden */
  105932. _onDataLayoutChanged: Observable<void>;
  105933. /**
  105934. * Gets or sets the influence of this target (ie. its weight in the overall morphing)
  105935. */
  105936. get influence(): number;
  105937. set influence(influence: number);
  105938. /**
  105939. * Gets or sets the id of the morph Target
  105940. */
  105941. id: string;
  105942. private _animationPropertiesOverride;
  105943. /**
  105944. * Gets or sets the animation properties override
  105945. */
  105946. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  105947. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  105948. /**
  105949. * Creates a new MorphTarget
  105950. * @param name defines the name of the target
  105951. * @param influence defines the influence to use
  105952. * @param scene defines the scene the morphtarget belongs to
  105953. */
  105954. constructor(
  105955. /** defines the name of the target */
  105956. name: string, influence?: number, scene?: Nullable<Scene>);
  105957. /**
  105958. * Gets the unique ID of this manager
  105959. */
  105960. get uniqueId(): number;
  105961. /**
  105962. * Gets a boolean defining if the target contains position data
  105963. */
  105964. get hasPositions(): boolean;
  105965. /**
  105966. * Gets a boolean defining if the target contains normal data
  105967. */
  105968. get hasNormals(): boolean;
  105969. /**
  105970. * Gets a boolean defining if the target contains tangent data
  105971. */
  105972. get hasTangents(): boolean;
  105973. /**
  105974. * Gets a boolean defining if the target contains texture coordinates data
  105975. */
  105976. get hasUVs(): boolean;
  105977. /**
  105978. * Affects position data to this target
  105979. * @param data defines the position data to use
  105980. */
  105981. setPositions(data: Nullable<FloatArray>): void;
  105982. /**
  105983. * Gets the position data stored in this target
  105984. * @returns a FloatArray containing the position data (or null if not present)
  105985. */
  105986. getPositions(): Nullable<FloatArray>;
  105987. /**
  105988. * Affects normal data to this target
  105989. * @param data defines the normal data to use
  105990. */
  105991. setNormals(data: Nullable<FloatArray>): void;
  105992. /**
  105993. * Gets the normal data stored in this target
  105994. * @returns a FloatArray containing the normal data (or null if not present)
  105995. */
  105996. getNormals(): Nullable<FloatArray>;
  105997. /**
  105998. * Affects tangent data to this target
  105999. * @param data defines the tangent data to use
  106000. */
  106001. setTangents(data: Nullable<FloatArray>): void;
  106002. /**
  106003. * Gets the tangent data stored in this target
  106004. * @returns a FloatArray containing the tangent data (or null if not present)
  106005. */
  106006. getTangents(): Nullable<FloatArray>;
  106007. /**
  106008. * Affects texture coordinates data to this target
  106009. * @param data defines the texture coordinates data to use
  106010. */
  106011. setUVs(data: Nullable<FloatArray>): void;
  106012. /**
  106013. * Gets the texture coordinates data stored in this target
  106014. * @returns a FloatArray containing the texture coordinates data (or null if not present)
  106015. */
  106016. getUVs(): Nullable<FloatArray>;
  106017. /**
  106018. * Clone the current target
  106019. * @returns a new MorphTarget
  106020. */
  106021. clone(): MorphTarget;
  106022. /**
  106023. * Serializes the current target into a Serialization object
  106024. * @returns the serialized object
  106025. */
  106026. serialize(): any;
  106027. /**
  106028. * Returns the string "MorphTarget"
  106029. * @returns "MorphTarget"
  106030. */
  106031. getClassName(): string;
  106032. /**
  106033. * Creates a new target from serialized data
  106034. * @param serializationObject defines the serialized data to use
  106035. * @returns a new MorphTarget
  106036. */
  106037. static Parse(serializationObject: any): MorphTarget;
  106038. /**
  106039. * Creates a MorphTarget from mesh data
  106040. * @param mesh defines the source mesh
  106041. * @param name defines the name to use for the new target
  106042. * @param influence defines the influence to attach to the target
  106043. * @returns a new MorphTarget
  106044. */
  106045. static FromMesh(mesh: AbstractMesh, name?: string, influence?: number): MorphTarget;
  106046. }
  106047. }
  106048. declare module BABYLON {
  106049. /**
  106050. * This class is used to deform meshes using morphing between different targets
  106051. * @see https://doc.babylonjs.com/how_to/how_to_use_morphtargets
  106052. */
  106053. export class MorphTargetManager {
  106054. private _targets;
  106055. private _targetInfluenceChangedObservers;
  106056. private _targetDataLayoutChangedObservers;
  106057. private _activeTargets;
  106058. private _scene;
  106059. private _influences;
  106060. private _supportsNormals;
  106061. private _supportsTangents;
  106062. private _supportsUVs;
  106063. private _vertexCount;
  106064. private _uniqueId;
  106065. private _tempInfluences;
  106066. /**
  106067. * Gets or sets a boolean indicating if normals must be morphed
  106068. */
  106069. enableNormalMorphing: boolean;
  106070. /**
  106071. * Gets or sets a boolean indicating if tangents must be morphed
  106072. */
  106073. enableTangentMorphing: boolean;
  106074. /**
  106075. * Gets or sets a boolean indicating if UV must be morphed
  106076. */
  106077. enableUVMorphing: boolean;
  106078. /**
  106079. * Creates a new MorphTargetManager
  106080. * @param scene defines the current scene
  106081. */
  106082. constructor(scene?: Nullable<Scene>);
  106083. /**
  106084. * Gets the unique ID of this manager
  106085. */
  106086. get uniqueId(): number;
  106087. /**
  106088. * Gets the number of vertices handled by this manager
  106089. */
  106090. get vertexCount(): number;
  106091. /**
  106092. * Gets a boolean indicating if this manager supports morphing of normals
  106093. */
  106094. get supportsNormals(): boolean;
  106095. /**
  106096. * Gets a boolean indicating if this manager supports morphing of tangents
  106097. */
  106098. get supportsTangents(): boolean;
  106099. /**
  106100. * Gets a boolean indicating if this manager supports morphing of texture coordinates
  106101. */
  106102. get supportsUVs(): boolean;
  106103. /**
  106104. * Gets the number of targets stored in this manager
  106105. */
  106106. get numTargets(): number;
  106107. /**
  106108. * Gets the number of influencers (ie. the number of targets with influences > 0)
  106109. */
  106110. get numInfluencers(): number;
  106111. /**
  106112. * Gets the list of influences (one per target)
  106113. */
  106114. get influences(): Float32Array;
  106115. /**
  106116. * Gets the active target at specified index. An active target is a target with an influence > 0
  106117. * @param index defines the index to check
  106118. * @returns the requested target
  106119. */
  106120. getActiveTarget(index: number): MorphTarget;
  106121. /**
  106122. * Gets the target at specified index
  106123. * @param index defines the index to check
  106124. * @returns the requested target
  106125. */
  106126. getTarget(index: number): MorphTarget;
  106127. /**
  106128. * Add a new target to this manager
  106129. * @param target defines the target to add
  106130. */
  106131. addTarget(target: MorphTarget): void;
  106132. /**
  106133. * Removes a target from the manager
  106134. * @param target defines the target to remove
  106135. */
  106136. removeTarget(target: MorphTarget): void;
  106137. /**
  106138. * Clone the current manager
  106139. * @returns a new MorphTargetManager
  106140. */
  106141. clone(): MorphTargetManager;
  106142. /**
  106143. * Serializes the current manager into a Serialization object
  106144. * @returns the serialized object
  106145. */
  106146. serialize(): any;
  106147. private _syncActiveTargets;
  106148. /**
  106149. * Syncrhonize the targets with all the meshes using this morph target manager
  106150. */
  106151. synchronize(): void;
  106152. /**
  106153. * Creates a new MorphTargetManager from serialized data
  106154. * @param serializationObject defines the serialized data
  106155. * @param scene defines the hosting scene
  106156. * @returns the new MorphTargetManager
  106157. */
  106158. static Parse(serializationObject: any, scene: Scene): MorphTargetManager;
  106159. }
  106160. }
  106161. declare module BABYLON {
  106162. /**
  106163. * Class used to represent a specific level of detail of a mesh
  106164. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  106165. */
  106166. export class MeshLODLevel {
  106167. /** Defines the distance where this level should start being displayed */
  106168. distance: number;
  106169. /** Defines the mesh to use to render this level */
  106170. mesh: Nullable<Mesh>;
  106171. /**
  106172. * Creates a new LOD level
  106173. * @param distance defines the distance where this level should star being displayed
  106174. * @param mesh defines the mesh to use to render this level
  106175. */
  106176. constructor(
  106177. /** Defines the distance where this level should start being displayed */
  106178. distance: number,
  106179. /** Defines the mesh to use to render this level */
  106180. mesh: Nullable<Mesh>);
  106181. }
  106182. }
  106183. declare module BABYLON {
  106184. /**
  106185. * Helper class used to generate a canvas to manipulate images
  106186. */
  106187. export class CanvasGenerator {
  106188. /**
  106189. * Create a new canvas (or offscreen canvas depending on the context)
  106190. * @param width defines the expected width
  106191. * @param height defines the expected height
  106192. * @return a new canvas or offscreen canvas
  106193. */
  106194. static CreateCanvas(width: number, height: number): HTMLCanvasElement | OffscreenCanvas;
  106195. }
  106196. }
  106197. declare module BABYLON {
  106198. /**
  106199. * Mesh representing the gorund
  106200. */
  106201. export class GroundMesh extends Mesh {
  106202. /** If octree should be generated */
  106203. generateOctree: boolean;
  106204. private _heightQuads;
  106205. /** @hidden */
  106206. _subdivisionsX: number;
  106207. /** @hidden */
  106208. _subdivisionsY: number;
  106209. /** @hidden */
  106210. _width: number;
  106211. /** @hidden */
  106212. _height: number;
  106213. /** @hidden */
  106214. _minX: number;
  106215. /** @hidden */
  106216. _maxX: number;
  106217. /** @hidden */
  106218. _minZ: number;
  106219. /** @hidden */
  106220. _maxZ: number;
  106221. constructor(name: string, scene: Scene);
  106222. /**
  106223. * "GroundMesh"
  106224. * @returns "GroundMesh"
  106225. */
  106226. getClassName(): string;
  106227. /**
  106228. * The minimum of x and y subdivisions
  106229. */
  106230. get subdivisions(): number;
  106231. /**
  106232. * X subdivisions
  106233. */
  106234. get subdivisionsX(): number;
  106235. /**
  106236. * Y subdivisions
  106237. */
  106238. get subdivisionsY(): number;
  106239. /**
  106240. * This function will update an octree to help to select the right submeshes for rendering, picking and collision computations.
  106241. * Please note that you must have a decent number of submeshes to get performance improvements when using an octree
  106242. * @param chunksCount the number of subdivisions for x and y
  106243. * @param octreeBlocksSize (Default: 32)
  106244. */
  106245. optimize(chunksCount: number, octreeBlocksSize?: number): void;
  106246. /**
  106247. * Returns a height (y) value in the Worl system :
  106248. * the ground altitude at the coordinates (x, z) expressed in the World system.
  106249. * @param x x coordinate
  106250. * @param z z coordinate
  106251. * @returns the ground y position if (x, z) are outside the ground surface.
  106252. */
  106253. getHeightAtCoordinates(x: number, z: number): number;
  106254. /**
  106255. * Returns a normalized vector (Vector3) orthogonal to the ground
  106256. * at the ground coordinates (x, z) expressed in the World system.
  106257. * @param x x coordinate
  106258. * @param z z coordinate
  106259. * @returns Vector3(0.0, 1.0, 0.0) if (x, z) are outside the ground surface.
  106260. */
  106261. getNormalAtCoordinates(x: number, z: number): Vector3;
  106262. /**
  106263. * Updates the Vector3 passed a reference with a normalized vector orthogonal to the ground
  106264. * at the ground coordinates (x, z) expressed in the World system.
  106265. * Doesn't uptade the reference Vector3 if (x, z) are outside the ground surface.
  106266. * @param x x coordinate
  106267. * @param z z coordinate
  106268. * @param ref vector to store the result
  106269. * @returns the GroundMesh.
  106270. */
  106271. getNormalAtCoordinatesToRef(x: number, z: number, ref: Vector3): GroundMesh;
  106272. /**
  106273. * Force the heights to be recomputed for getHeightAtCoordinates() or getNormalAtCoordinates()
  106274. * if the ground has been updated.
  106275. * This can be used in the render loop.
  106276. * @returns the GroundMesh.
  106277. */
  106278. updateCoordinateHeights(): GroundMesh;
  106279. private _getFacetAt;
  106280. private _initHeightQuads;
  106281. private _computeHeightQuads;
  106282. /**
  106283. * Serializes this ground mesh
  106284. * @param serializationObject object to write serialization to
  106285. */
  106286. serialize(serializationObject: any): void;
  106287. /**
  106288. * Parses a serialized ground mesh
  106289. * @param parsedMesh the serialized mesh
  106290. * @param scene the scene to create the ground mesh in
  106291. * @returns the created ground mesh
  106292. */
  106293. static Parse(parsedMesh: any, scene: Scene): GroundMesh;
  106294. }
  106295. }
  106296. declare module BABYLON {
  106297. /**
  106298. * Interface for Physics-Joint data
  106299. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106300. */
  106301. export interface PhysicsJointData {
  106302. /**
  106303. * The main pivot of the joint
  106304. */
  106305. mainPivot?: Vector3;
  106306. /**
  106307. * The connected pivot of the joint
  106308. */
  106309. connectedPivot?: Vector3;
  106310. /**
  106311. * The main axis of the joint
  106312. */
  106313. mainAxis?: Vector3;
  106314. /**
  106315. * The connected axis of the joint
  106316. */
  106317. connectedAxis?: Vector3;
  106318. /**
  106319. * The collision of the joint
  106320. */
  106321. collision?: boolean;
  106322. /**
  106323. * Native Oimo/Cannon/Energy data
  106324. */
  106325. nativeParams?: any;
  106326. }
  106327. /**
  106328. * This is a holder class for the physics joint created by the physics plugin
  106329. * It holds a set of functions to control the underlying joint
  106330. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106331. */
  106332. export class PhysicsJoint {
  106333. /**
  106334. * The type of the physics joint
  106335. */
  106336. type: number;
  106337. /**
  106338. * The data for the physics joint
  106339. */
  106340. jointData: PhysicsJointData;
  106341. private _physicsJoint;
  106342. protected _physicsPlugin: IPhysicsEnginePlugin;
  106343. /**
  106344. * Initializes the physics joint
  106345. * @param type The type of the physics joint
  106346. * @param jointData The data for the physics joint
  106347. */
  106348. constructor(
  106349. /**
  106350. * The type of the physics joint
  106351. */
  106352. type: number,
  106353. /**
  106354. * The data for the physics joint
  106355. */
  106356. jointData: PhysicsJointData);
  106357. /**
  106358. * Gets the physics joint
  106359. */
  106360. get physicsJoint(): any;
  106361. /**
  106362. * Sets the physics joint
  106363. */
  106364. set physicsJoint(newJoint: any);
  106365. /**
  106366. * Sets the physics plugin
  106367. */
  106368. set physicsPlugin(physicsPlugin: IPhysicsEnginePlugin);
  106369. /**
  106370. * Execute a function that is physics-plugin specific.
  106371. * @param {Function} func the function that will be executed.
  106372. * It accepts two parameters: the physics world and the physics joint
  106373. */
  106374. executeNativeFunction(func: (world: any, physicsJoint: any) => void): void;
  106375. /**
  106376. * Distance-Joint type
  106377. */
  106378. static DistanceJoint: number;
  106379. /**
  106380. * Hinge-Joint type
  106381. */
  106382. static HingeJoint: number;
  106383. /**
  106384. * Ball-and-Socket joint type
  106385. */
  106386. static BallAndSocketJoint: number;
  106387. /**
  106388. * Wheel-Joint type
  106389. */
  106390. static WheelJoint: number;
  106391. /**
  106392. * Slider-Joint type
  106393. */
  106394. static SliderJoint: number;
  106395. /**
  106396. * Prismatic-Joint type
  106397. */
  106398. static PrismaticJoint: number;
  106399. /**
  106400. * Universal-Joint type
  106401. * ENERGY FTW! (compare with this - @see http://ode-wiki.org/wiki/index.php?title=Manual:_Joint_Types_and_Functions)
  106402. */
  106403. static UniversalJoint: number;
  106404. /**
  106405. * Hinge-Joint 2 type
  106406. */
  106407. static Hinge2Joint: number;
  106408. /**
  106409. * Point to Point Joint type. Similar to a Ball-Joint. Different in parameters
  106410. */
  106411. static PointToPointJoint: number;
  106412. /**
  106413. * Spring-Joint type
  106414. */
  106415. static SpringJoint: number;
  106416. /**
  106417. * Lock-Joint type
  106418. */
  106419. static LockJoint: number;
  106420. }
  106421. /**
  106422. * A class representing a physics distance joint
  106423. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106424. */
  106425. export class DistanceJoint extends PhysicsJoint {
  106426. /**
  106427. *
  106428. * @param jointData The data for the Distance-Joint
  106429. */
  106430. constructor(jointData: DistanceJointData);
  106431. /**
  106432. * Update the predefined distance.
  106433. * @param maxDistance The maximum preferred distance
  106434. * @param minDistance The minimum preferred distance
  106435. */
  106436. updateDistance(maxDistance: number, minDistance?: number): void;
  106437. }
  106438. /**
  106439. * Represents a Motor-Enabled Joint
  106440. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106441. */
  106442. export class MotorEnabledJoint extends PhysicsJoint implements IMotorEnabledJoint {
  106443. /**
  106444. * Initializes the Motor-Enabled Joint
  106445. * @param type The type of the joint
  106446. * @param jointData The physica joint data for the joint
  106447. */
  106448. constructor(type: number, jointData: PhysicsJointData);
  106449. /**
  106450. * Set the motor values.
  106451. * Attention, this function is plugin specific. Engines won't react 100% the same.
  106452. * @param force the force to apply
  106453. * @param maxForce max force for this motor.
  106454. */
  106455. setMotor(force?: number, maxForce?: number): void;
  106456. /**
  106457. * Set the motor's limits.
  106458. * Attention, this function is plugin specific. Engines won't react 100% the same.
  106459. * @param upperLimit The upper limit of the motor
  106460. * @param lowerLimit The lower limit of the motor
  106461. */
  106462. setLimit(upperLimit: number, lowerLimit?: number): void;
  106463. }
  106464. /**
  106465. * This class represents a single physics Hinge-Joint
  106466. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106467. */
  106468. export class HingeJoint extends MotorEnabledJoint {
  106469. /**
  106470. * Initializes the Hinge-Joint
  106471. * @param jointData The joint data for the Hinge-Joint
  106472. */
  106473. constructor(jointData: PhysicsJointData);
  106474. /**
  106475. * Set the motor values.
  106476. * Attention, this function is plugin specific. Engines won't react 100% the same.
  106477. * @param {number} force the force to apply
  106478. * @param {number} maxForce max force for this motor.
  106479. */
  106480. setMotor(force?: number, maxForce?: number): void;
  106481. /**
  106482. * Set the motor's limits.
  106483. * Attention, this function is plugin specific. Engines won't react 100% the same.
  106484. * @param upperLimit The upper limit of the motor
  106485. * @param lowerLimit The lower limit of the motor
  106486. */
  106487. setLimit(upperLimit: number, lowerLimit?: number): void;
  106488. }
  106489. /**
  106490. * This class represents a dual hinge physics joint (same as wheel joint)
  106491. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106492. */
  106493. export class Hinge2Joint extends MotorEnabledJoint {
  106494. /**
  106495. * Initializes the Hinge2-Joint
  106496. * @param jointData The joint data for the Hinge2-Joint
  106497. */
  106498. constructor(jointData: PhysicsJointData);
  106499. /**
  106500. * Set the motor values.
  106501. * Attention, this function is plugin specific. Engines won't react 100% the same.
  106502. * @param {number} targetSpeed the speed the motor is to reach
  106503. * @param {number} maxForce max force for this motor.
  106504. * @param {motorIndex} the motor's index, 0 or 1.
  106505. */
  106506. setMotor(targetSpeed?: number, maxForce?: number, motorIndex?: number): void;
  106507. /**
  106508. * Set the motor limits.
  106509. * Attention, this function is plugin specific. Engines won't react 100% the same.
  106510. * @param {number} upperLimit the upper limit
  106511. * @param {number} lowerLimit lower limit
  106512. * @param {motorIndex} the motor's index, 0 or 1.
  106513. */
  106514. setLimit(upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  106515. }
  106516. /**
  106517. * Interface for a motor enabled joint
  106518. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106519. */
  106520. export interface IMotorEnabledJoint {
  106521. /**
  106522. * Physics joint
  106523. */
  106524. physicsJoint: any;
  106525. /**
  106526. * Sets the motor of the motor-enabled joint
  106527. * @param force The force of the motor
  106528. * @param maxForce The maximum force of the motor
  106529. * @param motorIndex The index of the motor
  106530. */
  106531. setMotor(force?: number, maxForce?: number, motorIndex?: number): void;
  106532. /**
  106533. * Sets the limit of the motor
  106534. * @param upperLimit The upper limit of the motor
  106535. * @param lowerLimit The lower limit of the motor
  106536. * @param motorIndex The index of the motor
  106537. */
  106538. setLimit(upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  106539. }
  106540. /**
  106541. * Joint data for a Distance-Joint
  106542. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106543. */
  106544. export interface DistanceJointData extends PhysicsJointData {
  106545. /**
  106546. * Max distance the 2 joint objects can be apart
  106547. */
  106548. maxDistance: number;
  106549. }
  106550. /**
  106551. * Joint data from a spring joint
  106552. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106553. */
  106554. export interface SpringJointData extends PhysicsJointData {
  106555. /**
  106556. * Length of the spring
  106557. */
  106558. length: number;
  106559. /**
  106560. * Stiffness of the spring
  106561. */
  106562. stiffness: number;
  106563. /**
  106564. * Damping of the spring
  106565. */
  106566. damping: number;
  106567. /** this callback will be called when applying the force to the impostors. */
  106568. forceApplicationCallback: () => void;
  106569. }
  106570. }
  106571. declare module BABYLON {
  106572. /**
  106573. * Holds the data for the raycast result
  106574. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106575. */
  106576. export class PhysicsRaycastResult {
  106577. private _hasHit;
  106578. private _hitDistance;
  106579. private _hitNormalWorld;
  106580. private _hitPointWorld;
  106581. private _rayFromWorld;
  106582. private _rayToWorld;
  106583. /**
  106584. * Gets if there was a hit
  106585. */
  106586. get hasHit(): boolean;
  106587. /**
  106588. * Gets the distance from the hit
  106589. */
  106590. get hitDistance(): number;
  106591. /**
  106592. * Gets the hit normal/direction in the world
  106593. */
  106594. get hitNormalWorld(): Vector3;
  106595. /**
  106596. * Gets the hit point in the world
  106597. */
  106598. get hitPointWorld(): Vector3;
  106599. /**
  106600. * Gets the ray "start point" of the ray in the world
  106601. */
  106602. get rayFromWorld(): Vector3;
  106603. /**
  106604. * Gets the ray "end point" of the ray in the world
  106605. */
  106606. get rayToWorld(): Vector3;
  106607. /**
  106608. * Sets the hit data (normal & point in world space)
  106609. * @param hitNormalWorld defines the normal in world space
  106610. * @param hitPointWorld defines the point in world space
  106611. */
  106612. setHitData(hitNormalWorld: IXYZ, hitPointWorld: IXYZ): void;
  106613. /**
  106614. * Sets the distance from the start point to the hit point
  106615. * @param distance
  106616. */
  106617. setHitDistance(distance: number): void;
  106618. /**
  106619. * Calculates the distance manually
  106620. */
  106621. calculateHitDistance(): void;
  106622. /**
  106623. * Resets all the values to default
  106624. * @param from The from point on world space
  106625. * @param to The to point on world space
  106626. */
  106627. reset(from?: Vector3, to?: Vector3): void;
  106628. }
  106629. /**
  106630. * Interface for the size containing width and height
  106631. */
  106632. interface IXYZ {
  106633. /**
  106634. * X
  106635. */
  106636. x: number;
  106637. /**
  106638. * Y
  106639. */
  106640. y: number;
  106641. /**
  106642. * Z
  106643. */
  106644. z: number;
  106645. }
  106646. }
  106647. declare module BABYLON {
  106648. /**
  106649. * Interface used to describe a physics joint
  106650. */
  106651. export interface PhysicsImpostorJoint {
  106652. /** Defines the main impostor to which the joint is linked */
  106653. mainImpostor: PhysicsImpostor;
  106654. /** Defines the impostor that is connected to the main impostor using this joint */
  106655. connectedImpostor: PhysicsImpostor;
  106656. /** Defines the joint itself */
  106657. joint: PhysicsJoint;
  106658. }
  106659. /** @hidden */
  106660. export interface IPhysicsEnginePlugin {
  106661. world: any;
  106662. name: string;
  106663. setGravity(gravity: Vector3): void;
  106664. setTimeStep(timeStep: number): void;
  106665. getTimeStep(): number;
  106666. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  106667. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  106668. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  106669. generatePhysicsBody(impostor: PhysicsImpostor): void;
  106670. removePhysicsBody(impostor: PhysicsImpostor): void;
  106671. generateJoint(joint: PhysicsImpostorJoint): void;
  106672. removeJoint(joint: PhysicsImpostorJoint): void;
  106673. isSupported(): boolean;
  106674. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  106675. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  106676. setLinearVelocity(impostor: PhysicsImpostor, velocity: Nullable<Vector3>): void;
  106677. setAngularVelocity(impostor: PhysicsImpostor, velocity: Nullable<Vector3>): void;
  106678. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  106679. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  106680. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  106681. getBodyMass(impostor: PhysicsImpostor): number;
  106682. getBodyFriction(impostor: PhysicsImpostor): number;
  106683. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  106684. getBodyRestitution(impostor: PhysicsImpostor): number;
  106685. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  106686. getBodyPressure?(impostor: PhysicsImpostor): number;
  106687. setBodyPressure?(impostor: PhysicsImpostor, pressure: number): void;
  106688. getBodyStiffness?(impostor: PhysicsImpostor): number;
  106689. setBodyStiffness?(impostor: PhysicsImpostor, stiffness: number): void;
  106690. getBodyVelocityIterations?(impostor: PhysicsImpostor): number;
  106691. setBodyVelocityIterations?(impostor: PhysicsImpostor, velocityIterations: number): void;
  106692. getBodyPositionIterations?(impostor: PhysicsImpostor): number;
  106693. setBodyPositionIterations?(impostor: PhysicsImpostor, positionIterations: number): void;
  106694. appendAnchor?(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, width: number, height: number, influence: number, noCollisionBetweenLinkedBodies: boolean): void;
  106695. appendHook?(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, length: number, influence: number, noCollisionBetweenLinkedBodies: boolean): void;
  106696. sleepBody(impostor: PhysicsImpostor): void;
  106697. wakeUpBody(impostor: PhysicsImpostor): void;
  106698. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  106699. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  106700. setMotor(joint: IMotorEnabledJoint, speed: number, maxForce?: number, motorIndex?: number): void;
  106701. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  106702. getRadius(impostor: PhysicsImpostor): number;
  106703. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  106704. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  106705. dispose(): void;
  106706. }
  106707. /**
  106708. * Interface used to define a physics engine
  106709. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106710. */
  106711. export interface IPhysicsEngine {
  106712. /**
  106713. * Gets the gravity vector used by the simulation
  106714. */
  106715. gravity: Vector3;
  106716. /**
  106717. * Sets the gravity vector used by the simulation
  106718. * @param gravity defines the gravity vector to use
  106719. */
  106720. setGravity(gravity: Vector3): void;
  106721. /**
  106722. * Set the time step of the physics engine.
  106723. * Default is 1/60.
  106724. * To slow it down, enter 1/600 for example.
  106725. * To speed it up, 1/30
  106726. * @param newTimeStep the new timestep to apply to this world.
  106727. */
  106728. setTimeStep(newTimeStep: number): void;
  106729. /**
  106730. * Get the time step of the physics engine.
  106731. * @returns the current time step
  106732. */
  106733. getTimeStep(): number;
  106734. /**
  106735. * Set the sub time step of the physics engine.
  106736. * Default is 0 meaning there is no sub steps
  106737. * To increase physics resolution precision, set a small value (like 1 ms)
  106738. * @param subTimeStep defines the new sub timestep used for physics resolution.
  106739. */
  106740. setSubTimeStep(subTimeStep: number): void;
  106741. /**
  106742. * Get the sub time step of the physics engine.
  106743. * @returns the current sub time step
  106744. */
  106745. getSubTimeStep(): number;
  106746. /**
  106747. * Release all resources
  106748. */
  106749. dispose(): void;
  106750. /**
  106751. * Gets the name of the current physics plugin
  106752. * @returns the name of the plugin
  106753. */
  106754. getPhysicsPluginName(): string;
  106755. /**
  106756. * Adding a new impostor for the impostor tracking.
  106757. * This will be done by the impostor itself.
  106758. * @param impostor the impostor to add
  106759. */
  106760. addImpostor(impostor: PhysicsImpostor): void;
  106761. /**
  106762. * Remove an impostor from the engine.
  106763. * This impostor and its mesh will not longer be updated by the physics engine.
  106764. * @param impostor the impostor to remove
  106765. */
  106766. removeImpostor(impostor: PhysicsImpostor): void;
  106767. /**
  106768. * Add a joint to the physics engine
  106769. * @param mainImpostor defines the main impostor to which the joint is added.
  106770. * @param connectedImpostor defines the impostor that is connected to the main impostor using this joint
  106771. * @param joint defines the joint that will connect both impostors.
  106772. */
  106773. addJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  106774. /**
  106775. * Removes a joint from the simulation
  106776. * @param mainImpostor defines the impostor used with the joint
  106777. * @param connectedImpostor defines the other impostor connected to the main one by the joint
  106778. * @param joint defines the joint to remove
  106779. */
  106780. removeJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  106781. /**
  106782. * Gets the current plugin used to run the simulation
  106783. * @returns current plugin
  106784. */
  106785. getPhysicsPlugin(): IPhysicsEnginePlugin;
  106786. /**
  106787. * Gets the list of physic impostors
  106788. * @returns an array of PhysicsImpostor
  106789. */
  106790. getImpostors(): Array<PhysicsImpostor>;
  106791. /**
  106792. * Gets the impostor for a physics enabled object
  106793. * @param object defines the object impersonated by the impostor
  106794. * @returns the PhysicsImpostor or null if not found
  106795. */
  106796. getImpostorForPhysicsObject(object: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  106797. /**
  106798. * Gets the impostor for a physics body object
  106799. * @param body defines physics body used by the impostor
  106800. * @returns the PhysicsImpostor or null if not found
  106801. */
  106802. getImpostorWithPhysicsBody(body: any): Nullable<PhysicsImpostor>;
  106803. /**
  106804. * Does a raycast in the physics world
  106805. * @param from when should the ray start?
  106806. * @param to when should the ray end?
  106807. * @returns PhysicsRaycastResult
  106808. */
  106809. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  106810. /**
  106811. * Called by the scene. No need to call it.
  106812. * @param delta defines the timespam between frames
  106813. */
  106814. _step(delta: number): void;
  106815. }
  106816. }
  106817. declare module BABYLON {
  106818. /**
  106819. * The interface for the physics imposter parameters
  106820. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106821. */
  106822. export interface PhysicsImpostorParameters {
  106823. /**
  106824. * The mass of the physics imposter
  106825. */
  106826. mass: number;
  106827. /**
  106828. * The friction of the physics imposter
  106829. */
  106830. friction?: number;
  106831. /**
  106832. * The coefficient of restitution of the physics imposter
  106833. */
  106834. restitution?: number;
  106835. /**
  106836. * The native options of the physics imposter
  106837. */
  106838. nativeOptions?: any;
  106839. /**
  106840. * Specifies if the parent should be ignored
  106841. */
  106842. ignoreParent?: boolean;
  106843. /**
  106844. * Specifies if bi-directional transformations should be disabled
  106845. */
  106846. disableBidirectionalTransformation?: boolean;
  106847. /**
  106848. * The pressure inside the physics imposter, soft object only
  106849. */
  106850. pressure?: number;
  106851. /**
  106852. * The stiffness the physics imposter, soft object only
  106853. */
  106854. stiffness?: number;
  106855. /**
  106856. * The number of iterations used in maintaining consistent vertex velocities, soft object only
  106857. */
  106858. velocityIterations?: number;
  106859. /**
  106860. * The number of iterations used in maintaining consistent vertex positions, soft object only
  106861. */
  106862. positionIterations?: number;
  106863. /**
  106864. * The number used to fix points on a cloth (0, 1, 2, 4, 8) or rope (0, 1, 2) only
  106865. * 0 None, 1, back left or top, 2, back right or bottom, 4, front left, 8, front right
  106866. * Add to fix multiple points
  106867. */
  106868. fixedPoints?: number;
  106869. /**
  106870. * The collision margin around a soft object
  106871. */
  106872. margin?: number;
  106873. /**
  106874. * The collision margin around a soft object
  106875. */
  106876. damping?: number;
  106877. /**
  106878. * The path for a rope based on an extrusion
  106879. */
  106880. path?: any;
  106881. /**
  106882. * The shape of an extrusion used for a rope based on an extrusion
  106883. */
  106884. shape?: any;
  106885. }
  106886. /**
  106887. * Interface for a physics-enabled object
  106888. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106889. */
  106890. export interface IPhysicsEnabledObject {
  106891. /**
  106892. * The position of the physics-enabled object
  106893. */
  106894. position: Vector3;
  106895. /**
  106896. * The rotation of the physics-enabled object
  106897. */
  106898. rotationQuaternion: Nullable<Quaternion>;
  106899. /**
  106900. * The scale of the physics-enabled object
  106901. */
  106902. scaling: Vector3;
  106903. /**
  106904. * The rotation of the physics-enabled object
  106905. */
  106906. rotation?: Vector3;
  106907. /**
  106908. * The parent of the physics-enabled object
  106909. */
  106910. parent?: any;
  106911. /**
  106912. * The bounding info of the physics-enabled object
  106913. * @returns The bounding info of the physics-enabled object
  106914. */
  106915. getBoundingInfo(): BoundingInfo;
  106916. /**
  106917. * Computes the world matrix
  106918. * @param force Specifies if the world matrix should be computed by force
  106919. * @returns A world matrix
  106920. */
  106921. computeWorldMatrix(force: boolean): Matrix;
  106922. /**
  106923. * Gets the world matrix
  106924. * @returns A world matrix
  106925. */
  106926. getWorldMatrix?(): Matrix;
  106927. /**
  106928. * Gets the child meshes
  106929. * @param directDescendantsOnly Specifies if only direct-descendants should be obtained
  106930. * @returns An array of abstract meshes
  106931. */
  106932. getChildMeshes?(directDescendantsOnly?: boolean): Array<AbstractMesh>;
  106933. /**
  106934. * Gets the vertex data
  106935. * @param kind The type of vertex data
  106936. * @returns A nullable array of numbers, or a float32 array
  106937. */
  106938. getVerticesData(kind: string): Nullable<Array<number> | Float32Array>;
  106939. /**
  106940. * Gets the indices from the mesh
  106941. * @returns A nullable array of index arrays
  106942. */
  106943. getIndices?(): Nullable<IndicesArray>;
  106944. /**
  106945. * Gets the scene from the mesh
  106946. * @returns the indices array or null
  106947. */
  106948. getScene?(): Scene;
  106949. /**
  106950. * Gets the absolute position from the mesh
  106951. * @returns the absolute position
  106952. */
  106953. getAbsolutePosition(): Vector3;
  106954. /**
  106955. * Gets the absolute pivot point from the mesh
  106956. * @returns the absolute pivot point
  106957. */
  106958. getAbsolutePivotPoint(): Vector3;
  106959. /**
  106960. * Rotates the mesh
  106961. * @param axis The axis of rotation
  106962. * @param amount The amount of rotation
  106963. * @param space The space of the rotation
  106964. * @returns The rotation transform node
  106965. */
  106966. rotate(axis: Vector3, amount: number, space?: Space): TransformNode;
  106967. /**
  106968. * Translates the mesh
  106969. * @param axis The axis of translation
  106970. * @param distance The distance of translation
  106971. * @param space The space of the translation
  106972. * @returns The transform node
  106973. */
  106974. translate(axis: Vector3, distance: number, space?: Space): TransformNode;
  106975. /**
  106976. * Sets the absolute position of the mesh
  106977. * @param absolutePosition The absolute position of the mesh
  106978. * @returns The transform node
  106979. */
  106980. setAbsolutePosition(absolutePosition: Vector3): TransformNode;
  106981. /**
  106982. * Gets the class name of the mesh
  106983. * @returns The class name
  106984. */
  106985. getClassName(): string;
  106986. }
  106987. /**
  106988. * Represents a physics imposter
  106989. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106990. */
  106991. export class PhysicsImpostor {
  106992. /**
  106993. * The physics-enabled object used as the physics imposter
  106994. */
  106995. object: IPhysicsEnabledObject;
  106996. /**
  106997. * The type of the physics imposter
  106998. */
  106999. type: number;
  107000. private _options;
  107001. private _scene?;
  107002. /**
  107003. * The default object size of the imposter
  107004. */
  107005. static DEFAULT_OBJECT_SIZE: Vector3;
  107006. /**
  107007. * The identity quaternion of the imposter
  107008. */
  107009. static IDENTITY_QUATERNION: Quaternion;
  107010. /** @hidden */
  107011. _pluginData: any;
  107012. private _physicsEngine;
  107013. private _physicsBody;
  107014. private _bodyUpdateRequired;
  107015. private _onBeforePhysicsStepCallbacks;
  107016. private _onAfterPhysicsStepCallbacks;
  107017. /** @hidden */
  107018. _onPhysicsCollideCallbacks: Array<{
  107019. callback: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor) => void;
  107020. otherImpostors: Array<PhysicsImpostor>;
  107021. }>;
  107022. private _deltaPosition;
  107023. private _deltaRotation;
  107024. private _deltaRotationConjugated;
  107025. /** @hidden */
  107026. _isFromLine: boolean;
  107027. private _parent;
  107028. private _isDisposed;
  107029. private static _tmpVecs;
  107030. private static _tmpQuat;
  107031. /**
  107032. * Specifies if the physics imposter is disposed
  107033. */
  107034. get isDisposed(): boolean;
  107035. /**
  107036. * Gets the mass of the physics imposter
  107037. */
  107038. get mass(): number;
  107039. set mass(value: number);
  107040. /**
  107041. * Gets the coefficient of friction
  107042. */
  107043. get friction(): number;
  107044. /**
  107045. * Sets the coefficient of friction
  107046. */
  107047. set friction(value: number);
  107048. /**
  107049. * Gets the coefficient of restitution
  107050. */
  107051. get restitution(): number;
  107052. /**
  107053. * Sets the coefficient of restitution
  107054. */
  107055. set restitution(value: number);
  107056. /**
  107057. * Gets the pressure of a soft body; only supported by the AmmoJSPlugin
  107058. */
  107059. get pressure(): number;
  107060. /**
  107061. * Sets the pressure of a soft body; only supported by the AmmoJSPlugin
  107062. */
  107063. set pressure(value: number);
  107064. /**
  107065. * Gets the stiffness of a soft body; only supported by the AmmoJSPlugin
  107066. */
  107067. get stiffness(): number;
  107068. /**
  107069. * Sets the stiffness of a soft body; only supported by the AmmoJSPlugin
  107070. */
  107071. set stiffness(value: number);
  107072. /**
  107073. * Gets the velocityIterations of a soft body; only supported by the AmmoJSPlugin
  107074. */
  107075. get velocityIterations(): number;
  107076. /**
  107077. * Sets the velocityIterations of a soft body; only supported by the AmmoJSPlugin
  107078. */
  107079. set velocityIterations(value: number);
  107080. /**
  107081. * Gets the positionIterations of a soft body; only supported by the AmmoJSPlugin
  107082. */
  107083. get positionIterations(): number;
  107084. /**
  107085. * Sets the positionIterations of a soft body; only supported by the AmmoJSPlugin
  107086. */
  107087. set positionIterations(value: number);
  107088. /**
  107089. * The unique id of the physics imposter
  107090. * set by the physics engine when adding this impostor to the array
  107091. */
  107092. uniqueId: number;
  107093. /**
  107094. * @hidden
  107095. */
  107096. soft: boolean;
  107097. /**
  107098. * @hidden
  107099. */
  107100. segments: number;
  107101. private _joints;
  107102. /**
  107103. * Initializes the physics imposter
  107104. * @param object The physics-enabled object used as the physics imposter
  107105. * @param type The type of the physics imposter
  107106. * @param _options The options for the physics imposter
  107107. * @param _scene The Babylon scene
  107108. */
  107109. constructor(
  107110. /**
  107111. * The physics-enabled object used as the physics imposter
  107112. */
  107113. object: IPhysicsEnabledObject,
  107114. /**
  107115. * The type of the physics imposter
  107116. */
  107117. type: number, _options?: PhysicsImpostorParameters, _scene?: Scene | undefined);
  107118. /**
  107119. * This function will completly initialize this impostor.
  107120. * It will create a new body - but only if this mesh has no parent.
  107121. * If it has, this impostor will not be used other than to define the impostor
  107122. * of the child mesh.
  107123. * @hidden
  107124. */
  107125. _init(): void;
  107126. private _getPhysicsParent;
  107127. /**
  107128. * Should a new body be generated.
  107129. * @returns boolean specifying if body initialization is required
  107130. */
  107131. isBodyInitRequired(): boolean;
  107132. /**
  107133. * Sets the updated scaling
  107134. * @param updated Specifies if the scaling is updated
  107135. */
  107136. setScalingUpdated(): void;
  107137. /**
  107138. * Force a regeneration of this or the parent's impostor's body.
  107139. * Use under cautious - This will remove all joints already implemented.
  107140. */
  107141. forceUpdate(): void;
  107142. /**
  107143. * Gets the body that holds this impostor. Either its own, or its parent.
  107144. */
  107145. get physicsBody(): any;
  107146. /**
  107147. * Get the parent of the physics imposter
  107148. * @returns Physics imposter or null
  107149. */
  107150. get parent(): Nullable<PhysicsImpostor>;
  107151. /**
  107152. * Sets the parent of the physics imposter
  107153. */
  107154. set parent(value: Nullable<PhysicsImpostor>);
  107155. /**
  107156. * Set the physics body. Used mainly by the physics engine/plugin
  107157. */
  107158. set physicsBody(physicsBody: any);
  107159. /**
  107160. * Resets the update flags
  107161. */
  107162. resetUpdateFlags(): void;
  107163. /**
  107164. * Gets the object extend size
  107165. * @returns the object extend size
  107166. */
  107167. getObjectExtendSize(): Vector3;
  107168. /**
  107169. * Gets the object center
  107170. * @returns The object center
  107171. */
  107172. getObjectCenter(): Vector3;
  107173. /**
  107174. * Get a specific parameter from the options parameters
  107175. * @param paramName The object parameter name
  107176. * @returns The object parameter
  107177. */
  107178. getParam(paramName: string): any;
  107179. /**
  107180. * Sets a specific parameter in the options given to the physics plugin
  107181. * @param paramName The parameter name
  107182. * @param value The value of the parameter
  107183. */
  107184. setParam(paramName: string, value: number): void;
  107185. /**
  107186. * Specifically change the body's mass option. Won't recreate the physics body object
  107187. * @param mass The mass of the physics imposter
  107188. */
  107189. setMass(mass: number): void;
  107190. /**
  107191. * Gets the linear velocity
  107192. * @returns linear velocity or null
  107193. */
  107194. getLinearVelocity(): Nullable<Vector3>;
  107195. /**
  107196. * Sets the linear velocity
  107197. * @param velocity linear velocity or null
  107198. */
  107199. setLinearVelocity(velocity: Nullable<Vector3>): void;
  107200. /**
  107201. * Gets the angular velocity
  107202. * @returns angular velocity or null
  107203. */
  107204. getAngularVelocity(): Nullable<Vector3>;
  107205. /**
  107206. * Sets the angular velocity
  107207. * @param velocity The velocity or null
  107208. */
  107209. setAngularVelocity(velocity: Nullable<Vector3>): void;
  107210. /**
  107211. * Execute a function with the physics plugin native code
  107212. * Provide a function the will have two variables - the world object and the physics body object
  107213. * @param func The function to execute with the physics plugin native code
  107214. */
  107215. executeNativeFunction(func: (world: any, physicsBody: any) => void): void;
  107216. /**
  107217. * Register a function that will be executed before the physics world is stepping forward
  107218. * @param func The function to execute before the physics world is stepped forward
  107219. */
  107220. registerBeforePhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  107221. /**
  107222. * Unregister a function that will be executed before the physics world is stepping forward
  107223. * @param func The function to execute before the physics world is stepped forward
  107224. */
  107225. unregisterBeforePhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  107226. /**
  107227. * Register a function that will be executed after the physics step
  107228. * @param func The function to execute after physics step
  107229. */
  107230. registerAfterPhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  107231. /**
  107232. * Unregisters a function that will be executed after the physics step
  107233. * @param func The function to execute after physics step
  107234. */
  107235. unregisterAfterPhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  107236. /**
  107237. * register a function that will be executed when this impostor collides against a different body
  107238. * @param collideAgainst Physics imposter, or array of physics imposters to collide against
  107239. * @param func Callback that is executed on collision
  107240. */
  107241. registerOnPhysicsCollide(collideAgainst: PhysicsImpostor | Array<PhysicsImpostor>, func: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor) => void): void;
  107242. /**
  107243. * Unregisters the physics imposter on contact
  107244. * @param collideAgainst The physics object to collide against
  107245. * @param func Callback to execute on collision
  107246. */
  107247. unregisterOnPhysicsCollide(collideAgainst: PhysicsImpostor | Array<PhysicsImpostor>, func: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor | Array<PhysicsImpostor>) => void): void;
  107248. private _tmpQuat;
  107249. private _tmpQuat2;
  107250. /**
  107251. * Get the parent rotation
  107252. * @returns The parent rotation
  107253. */
  107254. getParentsRotation(): Quaternion;
  107255. /**
  107256. * this function is executed by the physics engine.
  107257. */
  107258. beforeStep: () => void;
  107259. /**
  107260. * this function is executed by the physics engine
  107261. */
  107262. afterStep: () => void;
  107263. /**
  107264. * Legacy collision detection event support
  107265. */
  107266. onCollideEvent: Nullable<(collider: PhysicsImpostor, collidedWith: PhysicsImpostor) => void>;
  107267. /**
  107268. * event and body object due to cannon's event-based architecture.
  107269. */
  107270. onCollide: (e: {
  107271. body: any;
  107272. }) => void;
  107273. /**
  107274. * Apply a force
  107275. * @param force The force to apply
  107276. * @param contactPoint The contact point for the force
  107277. * @returns The physics imposter
  107278. */
  107279. applyForce(force: Vector3, contactPoint: Vector3): PhysicsImpostor;
  107280. /**
  107281. * Apply an impulse
  107282. * @param force The impulse force
  107283. * @param contactPoint The contact point for the impulse force
  107284. * @returns The physics imposter
  107285. */
  107286. applyImpulse(force: Vector3, contactPoint: Vector3): PhysicsImpostor;
  107287. /**
  107288. * A help function to create a joint
  107289. * @param otherImpostor A physics imposter used to create a joint
  107290. * @param jointType The type of joint
  107291. * @param jointData The data for the joint
  107292. * @returns The physics imposter
  107293. */
  107294. createJoint(otherImpostor: PhysicsImpostor, jointType: number, jointData: PhysicsJointData): PhysicsImpostor;
  107295. /**
  107296. * Add a joint to this impostor with a different impostor
  107297. * @param otherImpostor A physics imposter used to add a joint
  107298. * @param joint The joint to add
  107299. * @returns The physics imposter
  107300. */
  107301. addJoint(otherImpostor: PhysicsImpostor, joint: PhysicsJoint): PhysicsImpostor;
  107302. /**
  107303. * Add an anchor to a cloth impostor
  107304. * @param otherImpostor rigid impostor to anchor to
  107305. * @param width ratio across width from 0 to 1
  107306. * @param height ratio up height from 0 to 1
  107307. * @param influence the elasticity between cloth impostor and anchor from 0, very stretchy to 1, little strech
  107308. * @param noCollisionBetweenLinkedBodies when true collisions between cloth impostor and anchor are ignored; default false
  107309. * @returns impostor the soft imposter
  107310. */
  107311. addAnchor(otherImpostor: PhysicsImpostor, width: number, height: number, influence: number, noCollisionBetweenLinkedBodies: boolean): PhysicsImpostor;
  107312. /**
  107313. * Add a hook to a rope impostor
  107314. * @param otherImpostor rigid impostor to anchor to
  107315. * @param length ratio across rope from 0 to 1
  107316. * @param influence the elasticity between rope impostor and anchor from 0, very stretchy to 1, little strech
  107317. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  107318. * @returns impostor the rope imposter
  107319. */
  107320. addHook(otherImpostor: PhysicsImpostor, length: number, influence: number, noCollisionBetweenLinkedBodies: boolean): PhysicsImpostor;
  107321. /**
  107322. * Will keep this body still, in a sleep mode.
  107323. * @returns the physics imposter
  107324. */
  107325. sleep(): PhysicsImpostor;
  107326. /**
  107327. * Wake the body up.
  107328. * @returns The physics imposter
  107329. */
  107330. wakeUp(): PhysicsImpostor;
  107331. /**
  107332. * Clones the physics imposter
  107333. * @param newObject The physics imposter clones to this physics-enabled object
  107334. * @returns A nullable physics imposter
  107335. */
  107336. clone(newObject: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  107337. /**
  107338. * Disposes the physics imposter
  107339. */
  107340. dispose(): void;
  107341. /**
  107342. * Sets the delta position
  107343. * @param position The delta position amount
  107344. */
  107345. setDeltaPosition(position: Vector3): void;
  107346. /**
  107347. * Sets the delta rotation
  107348. * @param rotation The delta rotation amount
  107349. */
  107350. setDeltaRotation(rotation: Quaternion): void;
  107351. /**
  107352. * Gets the box size of the physics imposter and stores the result in the input parameter
  107353. * @param result Stores the box size
  107354. * @returns The physics imposter
  107355. */
  107356. getBoxSizeToRef(result: Vector3): PhysicsImpostor;
  107357. /**
  107358. * Gets the radius of the physics imposter
  107359. * @returns Radius of the physics imposter
  107360. */
  107361. getRadius(): number;
  107362. /**
  107363. * Sync a bone with this impostor
  107364. * @param bone The bone to sync to the impostor.
  107365. * @param boneMesh The mesh that the bone is influencing.
  107366. * @param jointPivot The pivot of the joint / bone in local space.
  107367. * @param distToJoint Optional distance from the impostor to the joint.
  107368. * @param adjustRotation Optional quaternion for adjusting the local rotation of the bone.
  107369. */
  107370. syncBoneWithImpostor(bone: Bone, boneMesh: AbstractMesh, jointPivot: Vector3, distToJoint?: number, adjustRotation?: Quaternion): void;
  107371. /**
  107372. * Sync impostor to a bone
  107373. * @param bone The bone that the impostor will be synced to.
  107374. * @param boneMesh The mesh that the bone is influencing.
  107375. * @param jointPivot The pivot of the joint / bone in local space.
  107376. * @param distToJoint Optional distance from the impostor to the joint.
  107377. * @param adjustRotation Optional quaternion for adjusting the local rotation of the bone.
  107378. * @param boneAxis Optional vector3 axis the bone is aligned with
  107379. */
  107380. syncImpostorWithBone(bone: Bone, boneMesh: AbstractMesh, jointPivot: Vector3, distToJoint?: number, adjustRotation?: Quaternion, boneAxis?: Vector3): void;
  107381. /**
  107382. * No-Imposter type
  107383. */
  107384. static NoImpostor: number;
  107385. /**
  107386. * Sphere-Imposter type
  107387. */
  107388. static SphereImpostor: number;
  107389. /**
  107390. * Box-Imposter type
  107391. */
  107392. static BoxImpostor: number;
  107393. /**
  107394. * Plane-Imposter type
  107395. */
  107396. static PlaneImpostor: number;
  107397. /**
  107398. * Mesh-imposter type
  107399. */
  107400. static MeshImpostor: number;
  107401. /**
  107402. * Capsule-Impostor type (Ammo.js plugin only)
  107403. */
  107404. static CapsuleImpostor: number;
  107405. /**
  107406. * Cylinder-Imposter type
  107407. */
  107408. static CylinderImpostor: number;
  107409. /**
  107410. * Particle-Imposter type
  107411. */
  107412. static ParticleImpostor: number;
  107413. /**
  107414. * Heightmap-Imposter type
  107415. */
  107416. static HeightmapImpostor: number;
  107417. /**
  107418. * ConvexHull-Impostor type (Ammo.js plugin only)
  107419. */
  107420. static ConvexHullImpostor: number;
  107421. /**
  107422. * Custom-Imposter type (Ammo.js plugin only)
  107423. */
  107424. static CustomImpostor: number;
  107425. /**
  107426. * Rope-Imposter type
  107427. */
  107428. static RopeImpostor: number;
  107429. /**
  107430. * Cloth-Imposter type
  107431. */
  107432. static ClothImpostor: number;
  107433. /**
  107434. * Softbody-Imposter type
  107435. */
  107436. static SoftbodyImpostor: number;
  107437. }
  107438. }
  107439. declare module BABYLON {
  107440. /**
  107441. * @hidden
  107442. **/
  107443. export class _CreationDataStorage {
  107444. closePath?: boolean;
  107445. closeArray?: boolean;
  107446. idx: number[];
  107447. dashSize: number;
  107448. gapSize: number;
  107449. path3D: Path3D;
  107450. pathArray: Vector3[][];
  107451. arc: number;
  107452. radius: number;
  107453. cap: number;
  107454. tessellation: number;
  107455. }
  107456. /**
  107457. * @hidden
  107458. **/
  107459. class _InstanceDataStorage {
  107460. visibleInstances: any;
  107461. batchCache: _InstancesBatch;
  107462. instancesBufferSize: number;
  107463. instancesBuffer: Nullable<Buffer>;
  107464. instancesData: Float32Array;
  107465. overridenInstanceCount: number;
  107466. isFrozen: boolean;
  107467. previousBatch: Nullable<_InstancesBatch>;
  107468. hardwareInstancedRendering: boolean;
  107469. sideOrientation: number;
  107470. manualUpdate: boolean;
  107471. }
  107472. /**
  107473. * @hidden
  107474. **/
  107475. export class _InstancesBatch {
  107476. mustReturn: boolean;
  107477. visibleInstances: Nullable<InstancedMesh[]>[];
  107478. renderSelf: boolean[];
  107479. hardwareInstancedRendering: boolean[];
  107480. }
  107481. /**
  107482. * @hidden
  107483. **/
  107484. class _ThinInstanceDataStorage {
  107485. instancesCount: number;
  107486. matrixBuffer: Nullable<Buffer>;
  107487. matrixBufferSize: number;
  107488. matrixData: Nullable<Float32Array>;
  107489. boundingVectors: Array<Vector3>;
  107490. worldMatrices: Nullable<Matrix[]>;
  107491. }
  107492. /**
  107493. * Class used to represent renderable models
  107494. */
  107495. export class Mesh extends AbstractMesh implements IGetSetVerticesData {
  107496. /**
  107497. * Mesh side orientation : usually the external or front surface
  107498. */
  107499. static readonly FRONTSIDE: number;
  107500. /**
  107501. * Mesh side orientation : usually the internal or back surface
  107502. */
  107503. static readonly BACKSIDE: number;
  107504. /**
  107505. * Mesh side orientation : both internal and external or front and back surfaces
  107506. */
  107507. static readonly DOUBLESIDE: number;
  107508. /**
  107509. * Mesh side orientation : by default, `FRONTSIDE`
  107510. */
  107511. static readonly DEFAULTSIDE: number;
  107512. /**
  107513. * Mesh cap setting : no cap
  107514. */
  107515. static readonly NO_CAP: number;
  107516. /**
  107517. * Mesh cap setting : one cap at the beginning of the mesh
  107518. */
  107519. static readonly CAP_START: number;
  107520. /**
  107521. * Mesh cap setting : one cap at the end of the mesh
  107522. */
  107523. static readonly CAP_END: number;
  107524. /**
  107525. * Mesh cap setting : two caps, one at the beginning and one at the end of the mesh
  107526. */
  107527. static readonly CAP_ALL: number;
  107528. /**
  107529. * Mesh pattern setting : no flip or rotate
  107530. */
  107531. static readonly NO_FLIP: number;
  107532. /**
  107533. * Mesh pattern setting : flip (reflect in y axis) alternate tiles on each row or column
  107534. */
  107535. static readonly FLIP_TILE: number;
  107536. /**
  107537. * Mesh pattern setting : rotate (180degs) alternate tiles on each row or column
  107538. */
  107539. static readonly ROTATE_TILE: number;
  107540. /**
  107541. * Mesh pattern setting : flip (reflect in y axis) all tiles on alternate rows
  107542. */
  107543. static readonly FLIP_ROW: number;
  107544. /**
  107545. * Mesh pattern setting : rotate (180degs) all tiles on alternate rows
  107546. */
  107547. static readonly ROTATE_ROW: number;
  107548. /**
  107549. * Mesh pattern setting : flip and rotate alternate tiles on each row or column
  107550. */
  107551. static readonly FLIP_N_ROTATE_TILE: number;
  107552. /**
  107553. * Mesh pattern setting : rotate pattern and rotate
  107554. */
  107555. static readonly FLIP_N_ROTATE_ROW: number;
  107556. /**
  107557. * Mesh tile positioning : part tiles same on left/right or top/bottom
  107558. */
  107559. static readonly CENTER: number;
  107560. /**
  107561. * Mesh tile positioning : part tiles on left
  107562. */
  107563. static readonly LEFT: number;
  107564. /**
  107565. * Mesh tile positioning : part tiles on right
  107566. */
  107567. static readonly RIGHT: number;
  107568. /**
  107569. * Mesh tile positioning : part tiles on top
  107570. */
  107571. static readonly TOP: number;
  107572. /**
  107573. * Mesh tile positioning : part tiles on bottom
  107574. */
  107575. static readonly BOTTOM: number;
  107576. /**
  107577. * Gets the default side orientation.
  107578. * @param orientation the orientation to value to attempt to get
  107579. * @returns the default orientation
  107580. * @hidden
  107581. */
  107582. static _GetDefaultSideOrientation(orientation?: number): number;
  107583. private _internalMeshDataInfo;
  107584. get computeBonesUsingShaders(): boolean;
  107585. set computeBonesUsingShaders(value: boolean);
  107586. /**
  107587. * An event triggered before rendering the mesh
  107588. */
  107589. get onBeforeRenderObservable(): Observable<Mesh>;
  107590. /**
  107591. * An event triggered before binding the mesh
  107592. */
  107593. get onBeforeBindObservable(): Observable<Mesh>;
  107594. /**
  107595. * An event triggered after rendering the mesh
  107596. */
  107597. get onAfterRenderObservable(): Observable<Mesh>;
  107598. /**
  107599. * An event triggered before drawing the mesh
  107600. */
  107601. get onBeforeDrawObservable(): Observable<Mesh>;
  107602. private _onBeforeDrawObserver;
  107603. /**
  107604. * Sets a callback to call before drawing the mesh. It is recommended to use onBeforeDrawObservable instead
  107605. */
  107606. set onBeforeDraw(callback: () => void);
  107607. get hasInstances(): boolean;
  107608. get hasThinInstances(): boolean;
  107609. /**
  107610. * Gets the delay loading state of the mesh (when delay loading is turned on)
  107611. * @see https://doc.babylonjs.com/how_to/using_the_incremental_loading_system
  107612. */
  107613. delayLoadState: number;
  107614. /**
  107615. * Gets the list of instances created from this mesh
  107616. * it is not supposed to be modified manually.
  107617. * Note also that the order of the InstancedMesh wihin the array is not significant and might change.
  107618. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  107619. */
  107620. instances: InstancedMesh[];
  107621. /**
  107622. * Gets the file containing delay loading data for this mesh
  107623. */
  107624. delayLoadingFile: string;
  107625. /** @hidden */
  107626. _binaryInfo: any;
  107627. /**
  107628. * User defined function used to change how LOD level selection is done
  107629. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  107630. */
  107631. onLODLevelSelection: (distance: number, mesh: Mesh, selectedLevel: Nullable<Mesh>) => void;
  107632. /**
  107633. * Gets or sets the morph target manager
  107634. * @see https://doc.babylonjs.com/how_to/how_to_use_morphtargets
  107635. */
  107636. get morphTargetManager(): Nullable<MorphTargetManager>;
  107637. set morphTargetManager(value: Nullable<MorphTargetManager>);
  107638. /** @hidden */
  107639. _creationDataStorage: Nullable<_CreationDataStorage>;
  107640. /** @hidden */
  107641. _geometry: Nullable<Geometry>;
  107642. /** @hidden */
  107643. _delayInfo: Array<string>;
  107644. /** @hidden */
  107645. _delayLoadingFunction: (any: any, mesh: Mesh) => void;
  107646. /** @hidden */
  107647. _instanceDataStorage: _InstanceDataStorage;
  107648. /** @hidden */
  107649. _thinInstanceDataStorage: _ThinInstanceDataStorage;
  107650. private _effectiveMaterial;
  107651. /** @hidden */
  107652. _shouldGenerateFlatShading: boolean;
  107653. /** @hidden */
  107654. _originalBuilderSideOrientation: number;
  107655. /**
  107656. * Use this property to change the original side orientation defined at construction time
  107657. */
  107658. overrideMaterialSideOrientation: Nullable<number>;
  107659. /**
  107660. * Gets the source mesh (the one used to clone this one from)
  107661. */
  107662. get source(): Nullable<Mesh>;
  107663. /**
  107664. * Gets or sets a boolean indicating that this mesh does not use index buffer
  107665. */
  107666. get isUnIndexed(): boolean;
  107667. set isUnIndexed(value: boolean);
  107668. /** Gets the array buffer used to store the instanced buffer used for instances' world matrices */
  107669. get worldMatrixInstancedBuffer(): Float32Array;
  107670. /** Gets or sets a boolean indicating that the update of the instance buffer of the world matrices is manual */
  107671. get manualUpdateOfWorldMatrixInstancedBuffer(): boolean;
  107672. set manualUpdateOfWorldMatrixInstancedBuffer(value: boolean);
  107673. /**
  107674. * @constructor
  107675. * @param name The value used by scene.getMeshByName() to do a lookup.
  107676. * @param scene The scene to add this mesh to.
  107677. * @param parent The parent of this mesh, if it has one
  107678. * @param source An optional Mesh from which geometry is shared, cloned.
  107679. * @param doNotCloneChildren When cloning, skip cloning child meshes of source, default False.
  107680. * When false, achieved by calling a clone(), also passing False.
  107681. * This will make creation of children, recursive.
  107682. * @param clonePhysicsImpostor When cloning, include cloning mesh physics impostor, default True.
  107683. */
  107684. constructor(name: string, scene?: Nullable<Scene>, parent?: Nullable<Node>, source?: Nullable<Mesh>, doNotCloneChildren?: boolean, clonePhysicsImpostor?: boolean);
  107685. instantiateHierarchy(newParent?: Nullable<TransformNode>, options?: {
  107686. doNotInstantiate: boolean;
  107687. }, onNewNodeCreated?: (source: TransformNode, clone: TransformNode) => void): Nullable<TransformNode>;
  107688. /**
  107689. * Gets the class name
  107690. * @returns the string "Mesh".
  107691. */
  107692. getClassName(): string;
  107693. /** @hidden */
  107694. get _isMesh(): boolean;
  107695. /**
  107696. * Returns a description of this mesh
  107697. * @param fullDetails define if full details about this mesh must be used
  107698. * @returns a descriptive string representing this mesh
  107699. */
  107700. toString(fullDetails?: boolean): string;
  107701. /** @hidden */
  107702. _unBindEffect(): void;
  107703. /**
  107704. * Gets a boolean indicating if this mesh has LOD
  107705. */
  107706. get hasLODLevels(): boolean;
  107707. /**
  107708. * Gets the list of MeshLODLevel associated with the current mesh
  107709. * @returns an array of MeshLODLevel
  107710. */
  107711. getLODLevels(): MeshLODLevel[];
  107712. private _sortLODLevels;
  107713. /**
  107714. * Add a mesh as LOD level triggered at the given distance.
  107715. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  107716. * @param distance The distance from the center of the object to show this level
  107717. * @param mesh The mesh to be added as LOD level (can be null)
  107718. * @return This mesh (for chaining)
  107719. */
  107720. addLODLevel(distance: number, mesh: Nullable<Mesh>): Mesh;
  107721. /**
  107722. * Returns the LOD level mesh at the passed distance or null if not found.
  107723. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  107724. * @param distance The distance from the center of the object to show this level
  107725. * @returns a Mesh or `null`
  107726. */
  107727. getLODLevelAtDistance(distance: number): Nullable<Mesh>;
  107728. /**
  107729. * Remove a mesh from the LOD array
  107730. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  107731. * @param mesh defines the mesh to be removed
  107732. * @return This mesh (for chaining)
  107733. */
  107734. removeLODLevel(mesh: Mesh): Mesh;
  107735. /**
  107736. * Returns the registered LOD mesh distant from the parameter `camera` position if any, else returns the current mesh.
  107737. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  107738. * @param camera defines the camera to use to compute distance
  107739. * @param boundingSphere defines a custom bounding sphere to use instead of the one from this mesh
  107740. * @return This mesh (for chaining)
  107741. */
  107742. getLOD(camera: Camera, boundingSphere?: BoundingSphere): Nullable<AbstractMesh>;
  107743. /**
  107744. * Gets the mesh internal Geometry object
  107745. */
  107746. get geometry(): Nullable<Geometry>;
  107747. /**
  107748. * Returns the total number of vertices within the mesh geometry or zero if the mesh has no geometry.
  107749. * @returns the total number of vertices
  107750. */
  107751. getTotalVertices(): number;
  107752. /**
  107753. * Returns the content of an associated vertex buffer
  107754. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  107755. * - VertexBuffer.PositionKind
  107756. * - VertexBuffer.UVKind
  107757. * - VertexBuffer.UV2Kind
  107758. * - VertexBuffer.UV3Kind
  107759. * - VertexBuffer.UV4Kind
  107760. * - VertexBuffer.UV5Kind
  107761. * - VertexBuffer.UV6Kind
  107762. * - VertexBuffer.ColorKind
  107763. * - VertexBuffer.MatricesIndicesKind
  107764. * - VertexBuffer.MatricesIndicesExtraKind
  107765. * - VertexBuffer.MatricesWeightsKind
  107766. * - VertexBuffer.MatricesWeightsExtraKind
  107767. * @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
  107768. * @param forceCopy defines a boolean forcing the copy of the buffer no matter what the value of copyWhenShared is
  107769. * @returns a FloatArray or null if the mesh has no geometry or no vertex buffer for this kind.
  107770. */
  107771. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  107772. /**
  107773. * Returns the mesh VertexBuffer object from the requested `kind`
  107774. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  107775. * - VertexBuffer.PositionKind
  107776. * - VertexBuffer.NormalKind
  107777. * - VertexBuffer.UVKind
  107778. * - VertexBuffer.UV2Kind
  107779. * - VertexBuffer.UV3Kind
  107780. * - VertexBuffer.UV4Kind
  107781. * - VertexBuffer.UV5Kind
  107782. * - VertexBuffer.UV6Kind
  107783. * - VertexBuffer.ColorKind
  107784. * - VertexBuffer.MatricesIndicesKind
  107785. * - VertexBuffer.MatricesIndicesExtraKind
  107786. * - VertexBuffer.MatricesWeightsKind
  107787. * - VertexBuffer.MatricesWeightsExtraKind
  107788. * @returns a FloatArray or null if the mesh has no vertex buffer for this kind.
  107789. */
  107790. getVertexBuffer(kind: string): Nullable<VertexBuffer>;
  107791. /**
  107792. * Tests if a specific vertex buffer is associated with this mesh
  107793. * @param kind defines which buffer to check (positions, indices, normals, etc). Possible `kind` values :
  107794. * - VertexBuffer.PositionKind
  107795. * - VertexBuffer.NormalKind
  107796. * - VertexBuffer.UVKind
  107797. * - VertexBuffer.UV2Kind
  107798. * - VertexBuffer.UV3Kind
  107799. * - VertexBuffer.UV4Kind
  107800. * - VertexBuffer.UV5Kind
  107801. * - VertexBuffer.UV6Kind
  107802. * - VertexBuffer.ColorKind
  107803. * - VertexBuffer.MatricesIndicesKind
  107804. * - VertexBuffer.MatricesIndicesExtraKind
  107805. * - VertexBuffer.MatricesWeightsKind
  107806. * - VertexBuffer.MatricesWeightsExtraKind
  107807. * @returns a boolean
  107808. */
  107809. isVerticesDataPresent(kind: string): boolean;
  107810. /**
  107811. * Returns a boolean defining if the vertex data for the requested `kind` is updatable.
  107812. * @param kind defines which buffer to check (positions, indices, normals, etc). Possible `kind` values :
  107813. * - VertexBuffer.PositionKind
  107814. * - VertexBuffer.UVKind
  107815. * - VertexBuffer.UV2Kind
  107816. * - VertexBuffer.UV3Kind
  107817. * - VertexBuffer.UV4Kind
  107818. * - VertexBuffer.UV5Kind
  107819. * - VertexBuffer.UV6Kind
  107820. * - VertexBuffer.ColorKind
  107821. * - VertexBuffer.MatricesIndicesKind
  107822. * - VertexBuffer.MatricesIndicesExtraKind
  107823. * - VertexBuffer.MatricesWeightsKind
  107824. * - VertexBuffer.MatricesWeightsExtraKind
  107825. * @returns a boolean
  107826. */
  107827. isVertexBufferUpdatable(kind: string): boolean;
  107828. /**
  107829. * Returns a string which contains the list of existing `kinds` of Vertex Data associated with this mesh.
  107830. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  107831. * - VertexBuffer.PositionKind
  107832. * - VertexBuffer.NormalKind
  107833. * - VertexBuffer.UVKind
  107834. * - VertexBuffer.UV2Kind
  107835. * - VertexBuffer.UV3Kind
  107836. * - VertexBuffer.UV4Kind
  107837. * - VertexBuffer.UV5Kind
  107838. * - VertexBuffer.UV6Kind
  107839. * - VertexBuffer.ColorKind
  107840. * - VertexBuffer.MatricesIndicesKind
  107841. * - VertexBuffer.MatricesIndicesExtraKind
  107842. * - VertexBuffer.MatricesWeightsKind
  107843. * - VertexBuffer.MatricesWeightsExtraKind
  107844. * @returns an array of strings
  107845. */
  107846. getVerticesDataKinds(): string[];
  107847. /**
  107848. * Returns a positive integer : the total number of indices in this mesh geometry.
  107849. * @returns the numner of indices or zero if the mesh has no geometry.
  107850. */
  107851. getTotalIndices(): number;
  107852. /**
  107853. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  107854. * @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.
  107855. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  107856. * @returns the indices array or an empty array if the mesh has no geometry
  107857. */
  107858. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  107859. get isBlocked(): boolean;
  107860. /**
  107861. * Determine if the current mesh is ready to be rendered
  107862. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  107863. * @param forceInstanceSupport will check if the mesh will be ready when used with instances (false by default)
  107864. * @returns true if all associated assets are ready (material, textures, shaders)
  107865. */
  107866. isReady(completeCheck?: boolean, forceInstanceSupport?: boolean): boolean;
  107867. /**
  107868. * 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.
  107869. */
  107870. get areNormalsFrozen(): boolean;
  107871. /**
  107872. * 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.
  107873. * @returns the current mesh
  107874. */
  107875. freezeNormals(): Mesh;
  107876. /**
  107877. * 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
  107878. * @returns the current mesh
  107879. */
  107880. unfreezeNormals(): Mesh;
  107881. /**
  107882. * Sets a value overriding the instance count. Only applicable when custom instanced InterleavedVertexBuffer are used rather than InstancedMeshs
  107883. */
  107884. set overridenInstanceCount(count: number);
  107885. /** @hidden */
  107886. _preActivate(): Mesh;
  107887. /** @hidden */
  107888. _preActivateForIntermediateRendering(renderId: number): Mesh;
  107889. /** @hidden */
  107890. _registerInstanceForRenderId(instance: InstancedMesh, renderId: number): Mesh;
  107891. protected _afterComputeWorldMatrix(): void;
  107892. /** @hidden */
  107893. _postActivate(): void;
  107894. /**
  107895. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  107896. * This means the mesh underlying bounding box and sphere are recomputed.
  107897. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  107898. * @returns the current mesh
  107899. */
  107900. refreshBoundingInfo(applySkeleton?: boolean): Mesh;
  107901. /** @hidden */
  107902. _createGlobalSubMesh(force: boolean): Nullable<SubMesh>;
  107903. /**
  107904. * This function will subdivide the mesh into multiple submeshes
  107905. * @param count defines the expected number of submeshes
  107906. */
  107907. subdivide(count: number): void;
  107908. /**
  107909. * Copy a FloatArray into a specific associated vertex buffer
  107910. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  107911. * - VertexBuffer.PositionKind
  107912. * - VertexBuffer.UVKind
  107913. * - VertexBuffer.UV2Kind
  107914. * - VertexBuffer.UV3Kind
  107915. * - VertexBuffer.UV4Kind
  107916. * - VertexBuffer.UV5Kind
  107917. * - VertexBuffer.UV6Kind
  107918. * - VertexBuffer.ColorKind
  107919. * - VertexBuffer.MatricesIndicesKind
  107920. * - VertexBuffer.MatricesIndicesExtraKind
  107921. * - VertexBuffer.MatricesWeightsKind
  107922. * - VertexBuffer.MatricesWeightsExtraKind
  107923. * @param data defines the data source
  107924. * @param updatable defines if the updated vertex buffer must be flagged as updatable
  107925. * @param stride defines the data stride size (can be null)
  107926. * @returns the current mesh
  107927. */
  107928. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  107929. /**
  107930. * Delete a vertex buffer associated with this mesh
  107931. * @param kind defines which buffer to delete (positions, indices, normals, etc). Possible `kind` values :
  107932. * - VertexBuffer.PositionKind
  107933. * - VertexBuffer.UVKind
  107934. * - VertexBuffer.UV2Kind
  107935. * - VertexBuffer.UV3Kind
  107936. * - VertexBuffer.UV4Kind
  107937. * - VertexBuffer.UV5Kind
  107938. * - VertexBuffer.UV6Kind
  107939. * - VertexBuffer.ColorKind
  107940. * - VertexBuffer.MatricesIndicesKind
  107941. * - VertexBuffer.MatricesIndicesExtraKind
  107942. * - VertexBuffer.MatricesWeightsKind
  107943. * - VertexBuffer.MatricesWeightsExtraKind
  107944. */
  107945. removeVerticesData(kind: string): void;
  107946. /**
  107947. * Flags an associated vertex buffer as updatable
  107948. * @param kind defines which buffer to use (positions, indices, normals, etc). Possible `kind` values :
  107949. * - VertexBuffer.PositionKind
  107950. * - VertexBuffer.UVKind
  107951. * - VertexBuffer.UV2Kind
  107952. * - VertexBuffer.UV3Kind
  107953. * - VertexBuffer.UV4Kind
  107954. * - VertexBuffer.UV5Kind
  107955. * - VertexBuffer.UV6Kind
  107956. * - VertexBuffer.ColorKind
  107957. * - VertexBuffer.MatricesIndicesKind
  107958. * - VertexBuffer.MatricesIndicesExtraKind
  107959. * - VertexBuffer.MatricesWeightsKind
  107960. * - VertexBuffer.MatricesWeightsExtraKind
  107961. * @param updatable defines if the updated vertex buffer must be flagged as updatable
  107962. */
  107963. markVerticesDataAsUpdatable(kind: string, updatable?: boolean): void;
  107964. /**
  107965. * Sets the mesh global Vertex Buffer
  107966. * @param buffer defines the buffer to use
  107967. * @returns the current mesh
  107968. */
  107969. setVerticesBuffer(buffer: VertexBuffer): Mesh;
  107970. /**
  107971. * Update a specific associated vertex buffer
  107972. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  107973. * - VertexBuffer.PositionKind
  107974. * - VertexBuffer.UVKind
  107975. * - VertexBuffer.UV2Kind
  107976. * - VertexBuffer.UV3Kind
  107977. * - VertexBuffer.UV4Kind
  107978. * - VertexBuffer.UV5Kind
  107979. * - VertexBuffer.UV6Kind
  107980. * - VertexBuffer.ColorKind
  107981. * - VertexBuffer.MatricesIndicesKind
  107982. * - VertexBuffer.MatricesIndicesExtraKind
  107983. * - VertexBuffer.MatricesWeightsKind
  107984. * - VertexBuffer.MatricesWeightsExtraKind
  107985. * @param data defines the data source
  107986. * @param updateExtends defines if extends info of the mesh must be updated (can be null). This is mostly useful for "position" kind
  107987. * @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)
  107988. * @returns the current mesh
  107989. */
  107990. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): AbstractMesh;
  107991. /**
  107992. * This method updates the vertex positions of an updatable mesh according to the `positionFunction` returned values.
  107993. * @see https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh#other-shapes-updatemeshpositions
  107994. * @param positionFunction is a simple JS function what is passed the mesh `positions` array. It doesn't need to return anything
  107995. * @param computeNormals is a boolean (default true) to enable/disable the mesh normal recomputation after the vertex position update
  107996. * @returns the current mesh
  107997. */
  107998. updateMeshPositions(positionFunction: (data: FloatArray) => void, computeNormals?: boolean): Mesh;
  107999. /**
  108000. * Creates a un-shared specific occurence of the geometry for the mesh.
  108001. * @returns the current mesh
  108002. */
  108003. makeGeometryUnique(): Mesh;
  108004. /**
  108005. * Set the index buffer of this mesh
  108006. * @param indices defines the source data
  108007. * @param totalVertices defines the total number of vertices referenced by this index data (can be null)
  108008. * @param updatable defines if the updated index buffer must be flagged as updatable (default is false)
  108009. * @returns the current mesh
  108010. */
  108011. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>, updatable?: boolean): AbstractMesh;
  108012. /**
  108013. * Update the current index buffer
  108014. * @param indices defines the source data
  108015. * @param offset defines the offset in the index buffer where to store the new data (can be null)
  108016. * @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)
  108017. * @returns the current mesh
  108018. */
  108019. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): AbstractMesh;
  108020. /**
  108021. * Invert the geometry to move from a right handed system to a left handed one.
  108022. * @returns the current mesh
  108023. */
  108024. toLeftHanded(): Mesh;
  108025. /** @hidden */
  108026. _bind(subMesh: SubMesh, effect: Effect, fillMode: number): Mesh;
  108027. /** @hidden */
  108028. _draw(subMesh: SubMesh, fillMode: number, instancesCount?: number): Mesh;
  108029. /**
  108030. * Registers for this mesh a javascript function called just before the rendering process
  108031. * @param func defines the function to call before rendering this mesh
  108032. * @returns the current mesh
  108033. */
  108034. registerBeforeRender(func: (mesh: AbstractMesh) => void): Mesh;
  108035. /**
  108036. * Disposes a previously registered javascript function called before the rendering
  108037. * @param func defines the function to remove
  108038. * @returns the current mesh
  108039. */
  108040. unregisterBeforeRender(func: (mesh: AbstractMesh) => void): Mesh;
  108041. /**
  108042. * Registers for this mesh a javascript function called just after the rendering is complete
  108043. * @param func defines the function to call after rendering this mesh
  108044. * @returns the current mesh
  108045. */
  108046. registerAfterRender(func: (mesh: AbstractMesh) => void): Mesh;
  108047. /**
  108048. * Disposes a previously registered javascript function called after the rendering.
  108049. * @param func defines the function to remove
  108050. * @returns the current mesh
  108051. */
  108052. unregisterAfterRender(func: (mesh: AbstractMesh) => void): Mesh;
  108053. /** @hidden */
  108054. _getInstancesRenderList(subMeshId: number, isReplacementMode?: boolean): _InstancesBatch;
  108055. /** @hidden */
  108056. _renderWithInstances(subMesh: SubMesh, fillMode: number, batch: _InstancesBatch, effect: Effect, engine: Engine): Mesh;
  108057. /** @hidden */
  108058. _renderWithThinInstances(subMesh: SubMesh, fillMode: number, effect: Effect, engine: Engine): void;
  108059. /** @hidden */
  108060. _processInstancedBuffers(visibleInstances: InstancedMesh[], renderSelf: boolean): void;
  108061. /** @hidden */
  108062. _processRendering(renderingMesh: AbstractMesh, subMesh: SubMesh, effect: Effect, fillMode: number, batch: _InstancesBatch, hardwareInstancedRendering: boolean, onBeforeDraw: (isInstance: boolean, world: Matrix, effectiveMaterial?: Material) => void, effectiveMaterial?: Material): Mesh;
  108063. /** @hidden */
  108064. _rebuild(): void;
  108065. /** @hidden */
  108066. _freeze(): void;
  108067. /** @hidden */
  108068. _unFreeze(): void;
  108069. /**
  108070. * 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
  108071. * @param subMesh defines the subMesh to render
  108072. * @param enableAlphaMode defines if alpha mode can be changed
  108073. * @param effectiveMeshReplacement defines an optional mesh used to provide info for the rendering
  108074. * @returns the current mesh
  108075. */
  108076. render(subMesh: SubMesh, enableAlphaMode: boolean, effectiveMeshReplacement?: AbstractMesh): Mesh;
  108077. private _onBeforeDraw;
  108078. /**
  108079. * Renormalize the mesh and patch it up if there are no weights
  108080. * Similar to normalization by adding the weights compute the reciprocal and multiply all elements, this wil ensure that everything adds to 1.
  108081. * However in the case of zero weights then we set just a single influence to 1.
  108082. * We check in the function for extra's present and if so we use the normalizeSkinWeightsWithExtras rather than the FourWeights version.
  108083. */
  108084. cleanMatrixWeights(): void;
  108085. private normalizeSkinFourWeights;
  108086. private normalizeSkinWeightsAndExtra;
  108087. /**
  108088. * ValidateSkinning is used to determine that a mesh has valid skinning data along with skin metrics, if missing weights,
  108089. * or not normalized it is returned as invalid mesh the string can be used for console logs, or on screen messages to let
  108090. * the user know there was an issue with importing the mesh
  108091. * @returns a validation object with skinned, valid and report string
  108092. */
  108093. validateSkinning(): {
  108094. skinned: boolean;
  108095. valid: boolean;
  108096. report: string;
  108097. };
  108098. /** @hidden */
  108099. _checkDelayState(): Mesh;
  108100. private _queueLoad;
  108101. /**
  108102. * Returns `true` if the mesh is within the frustum defined by the passed array of planes.
  108103. * A mesh is in the frustum if its bounding box intersects the frustum
  108104. * @param frustumPlanes defines the frustum to test
  108105. * @returns true if the mesh is in the frustum planes
  108106. */
  108107. isInFrustum(frustumPlanes: Plane[]): boolean;
  108108. /**
  108109. * Sets the mesh material by the material or multiMaterial `id` property
  108110. * @param id is a string identifying the material or the multiMaterial
  108111. * @returns the current mesh
  108112. */
  108113. setMaterialByID(id: string): Mesh;
  108114. /**
  108115. * Returns as a new array populated with the mesh material and/or skeleton, if any.
  108116. * @returns an array of IAnimatable
  108117. */
  108118. getAnimatables(): IAnimatable[];
  108119. /**
  108120. * Modifies the mesh geometry according to the passed transformation matrix.
  108121. * This method returns nothing but it really modifies the mesh even if it's originally not set as updatable.
  108122. * The mesh normals are modified using the same transformation.
  108123. * Note that, under the hood, this method sets a new VertexBuffer each call.
  108124. * @param transform defines the transform matrix to use
  108125. * @see https://doc.babylonjs.com/resources/baking_transformations
  108126. * @returns the current mesh
  108127. */
  108128. bakeTransformIntoVertices(transform: Matrix): Mesh;
  108129. /**
  108130. * Modifies the mesh geometry according to its own current World Matrix.
  108131. * The mesh World Matrix is then reset.
  108132. * This method returns nothing but really modifies the mesh even if it's originally not set as updatable.
  108133. * Note that, under the hood, this method sets a new VertexBuffer each call.
  108134. * @see https://doc.babylonjs.com/resources/baking_transformations
  108135. * @param bakeIndependenlyOfChildren indicates whether to preserve all child nodes' World Matrix during baking
  108136. * @returns the current mesh
  108137. */
  108138. bakeCurrentTransformIntoVertices(bakeIndependenlyOfChildren?: boolean): Mesh;
  108139. /** @hidden */
  108140. get _positions(): Nullable<Vector3[]>;
  108141. /** @hidden */
  108142. _resetPointsArrayCache(): Mesh;
  108143. /** @hidden */
  108144. _generatePointsArray(): boolean;
  108145. /**
  108146. * Returns a new Mesh object generated from the current mesh properties.
  108147. * This method must not get confused with createInstance()
  108148. * @param name is a string, the name given to the new mesh
  108149. * @param newParent can be any Node object (default `null`)
  108150. * @param doNotCloneChildren allows/denies the recursive cloning of the original mesh children if any (default `false`)
  108151. * @param clonePhysicsImpostor allows/denies the cloning in the same time of the original mesh `body` used by the physics engine, if any (default `true`)
  108152. * @returns a new mesh
  108153. */
  108154. clone(name?: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean, clonePhysicsImpostor?: boolean): Mesh;
  108155. /**
  108156. * Releases resources associated with this mesh.
  108157. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  108158. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  108159. */
  108160. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  108161. /** @hidden */
  108162. _disposeInstanceSpecificData(): void;
  108163. /** @hidden */
  108164. _disposeThinInstanceSpecificData(): void;
  108165. /**
  108166. * Modifies the mesh geometry according to a displacement map.
  108167. * 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.
  108168. * The mesh must be set as updatable. Its internal geometry is directly modified, no new buffer are allocated.
  108169. * @param url is a string, the URL from the image file is to be downloaded.
  108170. * @param minHeight is the lower limit of the displacement.
  108171. * @param maxHeight is the upper limit of the displacement.
  108172. * @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.
  108173. * @param uvOffset is an optional vector2 used to offset UV.
  108174. * @param uvScale is an optional vector2 used to scale UV.
  108175. * @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.
  108176. * @returns the Mesh.
  108177. */
  108178. applyDisplacementMap(url: string, minHeight: number, maxHeight: number, onSuccess?: (mesh: Mesh) => void, uvOffset?: Vector2, uvScale?: Vector2, forceUpdate?: boolean): Mesh;
  108179. /**
  108180. * Modifies the mesh geometry according to a displacementMap buffer.
  108181. * 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.
  108182. * The mesh must be set as updatable. Its internal geometry is directly modified, no new buffer are allocated.
  108183. * @param buffer is a `Uint8Array` buffer containing series of `Uint8` lower than 255, the red, green, blue and alpha values of each successive pixel.
  108184. * @param heightMapWidth is the width of the buffer image.
  108185. * @param heightMapHeight is the height of the buffer image.
  108186. * @param minHeight is the lower limit of the displacement.
  108187. * @param maxHeight is the upper limit of the displacement.
  108188. * @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.
  108189. * @param uvOffset is an optional vector2 used to offset UV.
  108190. * @param uvScale is an optional vector2 used to scale UV.
  108191. * @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.
  108192. * @returns the Mesh.
  108193. */
  108194. applyDisplacementMapFromBuffer(buffer: Uint8Array, heightMapWidth: number, heightMapHeight: number, minHeight: number, maxHeight: number, uvOffset?: Vector2, uvScale?: Vector2, forceUpdate?: boolean): Mesh;
  108195. /**
  108196. * Modify the mesh to get a flat shading rendering.
  108197. * This means each mesh facet will then have its own normals. Usually new vertices are added in the mesh geometry to get this result.
  108198. * Warning : the mesh is really modified even if not set originally as updatable and, under the hood, a new VertexBuffer is allocated.
  108199. * @returns current mesh
  108200. */
  108201. convertToFlatShadedMesh(): Mesh;
  108202. /**
  108203. * This method removes all the mesh indices and add new vertices (duplication) in order to unfold facets into buffers.
  108204. * In other words, more vertices, no more indices and a single bigger VBO.
  108205. * The mesh is really modified even if not set originally as updatable. Under the hood, a new VertexBuffer is allocated.
  108206. * @returns current mesh
  108207. */
  108208. convertToUnIndexedMesh(): Mesh;
  108209. /**
  108210. * Inverses facet orientations.
  108211. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  108212. * @param flipNormals will also inverts the normals
  108213. * @returns current mesh
  108214. */
  108215. flipFaces(flipNormals?: boolean): Mesh;
  108216. /**
  108217. * Increase the number of facets and hence vertices in a mesh
  108218. * Vertex normals are interpolated from existing vertex normals
  108219. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  108220. * @param numberPerEdge the number of new vertices to add to each edge of a facet, optional default 1
  108221. */
  108222. increaseVertices(numberPerEdge: number): void;
  108223. /**
  108224. * Force adjacent facets to share vertices and remove any facets that have all vertices in a line
  108225. * This will undo any application of covertToFlatShadedMesh
  108226. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  108227. */
  108228. forceSharedVertices(): void;
  108229. /** @hidden */
  108230. static _instancedMeshFactory(name: string, mesh: Mesh): InstancedMesh;
  108231. /** @hidden */
  108232. static _PhysicsImpostorParser(scene: Scene, physicObject: IPhysicsEnabledObject, jsonObject: any): PhysicsImpostor;
  108233. /**
  108234. * Creates a new InstancedMesh object from the mesh model.
  108235. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  108236. * @param name defines the name of the new instance
  108237. * @returns a new InstancedMesh
  108238. */
  108239. createInstance(name: string): InstancedMesh;
  108240. /**
  108241. * Synchronises all the mesh instance submeshes to the current mesh submeshes, if any.
  108242. * After this call, all the mesh instances have the same submeshes than the current mesh.
  108243. * @returns the current mesh
  108244. */
  108245. synchronizeInstances(): Mesh;
  108246. /**
  108247. * Optimization of the mesh's indices, in case a mesh has duplicated vertices.
  108248. * The function will only reorder the indices and will not remove unused vertices to avoid problems with submeshes.
  108249. * This should be used together with the simplification to avoid disappearing triangles.
  108250. * @param successCallback an optional success callback to be called after the optimization finished.
  108251. * @returns the current mesh
  108252. */
  108253. optimizeIndices(successCallback?: (mesh?: Mesh) => void): Mesh;
  108254. /**
  108255. * Serialize current mesh
  108256. * @param serializationObject defines the object which will receive the serialization data
  108257. */
  108258. serialize(serializationObject: any): void;
  108259. /** @hidden */
  108260. _syncGeometryWithMorphTargetManager(): void;
  108261. /** @hidden */
  108262. static _GroundMeshParser: (parsedMesh: any, scene: Scene) => Mesh;
  108263. /**
  108264. * Returns a new Mesh object parsed from the source provided.
  108265. * @param parsedMesh is the source
  108266. * @param scene defines the hosting scene
  108267. * @param rootUrl is the root URL to prefix the `delayLoadingFile` property with
  108268. * @returns a new Mesh
  108269. */
  108270. static Parse(parsedMesh: any, scene: Scene, rootUrl: string): Mesh;
  108271. /**
  108272. * Creates a ribbon mesh. Please consider using the same method from the MeshBuilder class instead
  108273. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  108274. * @param name defines the name of the mesh to create
  108275. * @param pathArray is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry.
  108276. * @param closeArray creates a seam between the first and the last paths of the path array (default is false)
  108277. * @param closePath creates a seam between the first and the last points of each path of the path array
  108278. * @param offset is taken in account only if the `pathArray` is containing a single path
  108279. * @param scene defines the hosting scene
  108280. * @param updatable defines if the mesh must be flagged as updatable
  108281. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108282. * @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)
  108283. * @returns a new Mesh
  108284. */
  108285. static CreateRibbon(name: string, pathArray: Vector3[][], closeArray: boolean, closePath: boolean, offset: number, scene?: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  108286. /**
  108287. * Creates a plane polygonal mesh. By default, this is a disc. Please consider using the same method from the MeshBuilder class instead
  108288. * @param name defines the name of the mesh to create
  108289. * @param radius sets the radius size (float) of the polygon (default 0.5)
  108290. * @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
  108291. * @param scene defines the hosting scene
  108292. * @param updatable defines if the mesh must be flagged as updatable
  108293. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108294. * @returns a new Mesh
  108295. */
  108296. static CreateDisc(name: string, radius: number, tessellation: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number): Mesh;
  108297. /**
  108298. * Creates a box mesh. Please consider using the same method from the MeshBuilder class instead
  108299. * @param name defines the name of the mesh to create
  108300. * @param size sets the size (float) of each box side (default 1)
  108301. * @param scene defines the hosting scene
  108302. * @param updatable defines if the mesh must be flagged as updatable
  108303. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108304. * @returns a new Mesh
  108305. */
  108306. static CreateBox(name: string, size: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number): Mesh;
  108307. /**
  108308. * Creates a sphere mesh. Please consider using the same method from the MeshBuilder class instead
  108309. * @param name defines the name of the mesh to create
  108310. * @param segments sets the sphere number of horizontal stripes (positive integer, default 32)
  108311. * @param diameter sets the diameter size (float) of the sphere (default 1)
  108312. * @param scene defines the hosting scene
  108313. * @param updatable defines if the mesh must be flagged as updatable
  108314. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108315. * @returns a new Mesh
  108316. */
  108317. static CreateSphere(name: string, segments: number, diameter: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  108318. /**
  108319. * Creates a hemisphere mesh. Please consider using the same method from the MeshBuilder class instead
  108320. * @param name defines the name of the mesh to create
  108321. * @param segments sets the sphere number of horizontal stripes (positive integer, default 32)
  108322. * @param diameter sets the diameter size (float) of the sphere (default 1)
  108323. * @param scene defines the hosting scene
  108324. * @returns a new Mesh
  108325. */
  108326. static CreateHemisphere(name: string, segments: number, diameter: number, scene?: Scene): Mesh;
  108327. /**
  108328. * Creates a cylinder or a cone mesh. Please consider using the same method from the MeshBuilder class instead
  108329. * @param name defines the name of the mesh to create
  108330. * @param height sets the height size (float) of the cylinder/cone (float, default 2)
  108331. * @param diameterTop set the top cap diameter (floats, default 1)
  108332. * @param diameterBottom set the bottom cap diameter (floats, default 1). This value can't be zero
  108333. * @param tessellation sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance
  108334. * @param subdivisions sets the number of rings along the cylinder height (positive integer, default 1)
  108335. * @param scene defines the hosting scene
  108336. * @param updatable defines if the mesh must be flagged as updatable
  108337. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108338. * @returns a new Mesh
  108339. */
  108340. static CreateCylinder(name: string, height: number, diameterTop: number, diameterBottom: number, tessellation: number, subdivisions: any, scene?: Scene, updatable?: any, sideOrientation?: number): Mesh;
  108341. /**
  108342. * Creates a torus mesh. Please consider using the same method from the MeshBuilder class instead
  108343. * @param name defines the name of the mesh to create
  108344. * @param diameter sets the diameter size (float) of the torus (default 1)
  108345. * @param thickness sets the diameter size of the tube of the torus (float, default 0.5)
  108346. * @param tessellation sets the number of torus sides (postive integer, default 16)
  108347. * @param scene defines the hosting scene
  108348. * @param updatable defines if the mesh must be flagged as updatable
  108349. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108350. * @returns a new Mesh
  108351. */
  108352. static CreateTorus(name: string, diameter: number, thickness: number, tessellation: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  108353. /**
  108354. * Creates a torus knot mesh. Please consider using the same method from the MeshBuilder class instead
  108355. * @param name defines the name of the mesh to create
  108356. * @param radius sets the global radius size (float) of the torus knot (default 2)
  108357. * @param tube sets the diameter size of the tube of the torus (float, default 0.5)
  108358. * @param radialSegments sets the number of sides on each tube segments (positive integer, default 32)
  108359. * @param tubularSegments sets the number of tubes to decompose the knot into (positive integer, default 32)
  108360. * @param p the number of windings on X axis (positive integers, default 2)
  108361. * @param q the number of windings on Y axis (positive integers, default 3)
  108362. * @param scene defines the hosting scene
  108363. * @param updatable defines if the mesh must be flagged as updatable
  108364. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108365. * @returns a new Mesh
  108366. */
  108367. static CreateTorusKnot(name: string, radius: number, tube: number, radialSegments: number, tubularSegments: number, p: number, q: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  108368. /**
  108369. * Creates a line mesh. Please consider using the same method from the MeshBuilder class instead.
  108370. * @param name defines the name of the mesh to create
  108371. * @param points is an array successive Vector3
  108372. * @param scene defines the hosting scene
  108373. * @param updatable defines if the mesh must be flagged as updatable
  108374. * @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).
  108375. * @returns a new Mesh
  108376. */
  108377. static CreateLines(name: string, points: Vector3[], scene?: Nullable<Scene>, updatable?: boolean, instance?: Nullable<LinesMesh>): LinesMesh;
  108378. /**
  108379. * Creates a dashed line mesh. Please consider using the same method from the MeshBuilder class instead
  108380. * @param name defines the name of the mesh to create
  108381. * @param points is an array successive Vector3
  108382. * @param dashSize is the size of the dashes relatively the dash number (positive float, default 3)
  108383. * @param gapSize is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  108384. * @param dashNb is the intended total number of dashes (positive integer, default 200)
  108385. * @param scene defines the hosting scene
  108386. * @param updatable defines if the mesh must be flagged as updatable
  108387. * @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)
  108388. * @returns a new Mesh
  108389. */
  108390. static CreateDashedLines(name: string, points: Vector3[], dashSize: number, gapSize: number, dashNb: number, scene?: Nullable<Scene>, updatable?: boolean, instance?: LinesMesh): LinesMesh;
  108391. /**
  108392. * Creates a polygon mesh.Please consider using the same method from the MeshBuilder class instead
  108393. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh.
  108394. * 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.
  108395. * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  108396. * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  108397. * Remember you can only change the shape positions, not their number when updating a polygon.
  108398. * @see https://doc.babylonjs.com/how_to/parametric_shapes#non-regular-polygon
  108399. * @param name defines the name of the mesh to create
  108400. * @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
  108401. * @param scene defines the hosting scene
  108402. * @param holes is a required array of arrays of successive Vector3 used to defines holes in the polygon
  108403. * @param updatable defines if the mesh must be flagged as updatable
  108404. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108405. * @param earcutInjection can be used to inject your own earcut reference
  108406. * @returns a new Mesh
  108407. */
  108408. static CreatePolygon(name: string, shape: Vector3[], scene: Scene, holes?: Vector3[][], updatable?: boolean, sideOrientation?: number, earcutInjection?: any): Mesh;
  108409. /**
  108410. * Creates an extruded polygon mesh, with depth in the Y direction. Please consider using the same method from the MeshBuilder class instead.
  108411. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-non-regular-polygon
  108412. * @param name defines the name of the mesh to create
  108413. * @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
  108414. * @param depth defines the height of extrusion
  108415. * @param scene defines the hosting scene
  108416. * @param holes is a required array of arrays of successive Vector3 used to defines holes in the polygon
  108417. * @param updatable defines if the mesh must be flagged as updatable
  108418. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108419. * @param earcutInjection can be used to inject your own earcut reference
  108420. * @returns a new Mesh
  108421. */
  108422. static ExtrudePolygon(name: string, shape: Vector3[], depth: number, scene: Scene, holes?: Vector3[][], updatable?: boolean, sideOrientation?: number, earcutInjection?: any): Mesh;
  108423. /**
  108424. * Creates an extruded shape mesh.
  108425. * 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
  108426. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  108427. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  108428. * @param name defines the name of the mesh to create
  108429. * @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
  108430. * @param path is a required array of successive Vector3. This is the axis curve the shape is extruded along
  108431. * @param scale is the value to scale the shape
  108432. * @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
  108433. * @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
  108434. * @param scene defines the hosting scene
  108435. * @param updatable defines if the mesh must be flagged as updatable
  108436. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108437. * @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)
  108438. * @returns a new Mesh
  108439. */
  108440. static ExtrudeShape(name: string, shape: Vector3[], path: Vector3[], scale: number, rotation: number, cap: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  108441. /**
  108442. * Creates an custom extruded shape mesh.
  108443. * The custom extrusion is a parametric shape.
  108444. * It has no predefined shape. Its final shape will depend on the input parameters.
  108445. * Please consider using the same method from the MeshBuilder class instead
  108446. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  108447. * @param name defines the name of the mesh to create
  108448. * @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
  108449. * @param path is a required array of successive Vector3. This is the axis curve the shape is extruded along
  108450. * @param scaleFunction is a custom Javascript function called on each path point
  108451. * @param rotationFunction is a custom Javascript function called on each path point
  108452. * @param ribbonCloseArray forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  108453. * @param ribbonClosePath forces the extrusion underlying ribbon to close its `pathArray`
  108454. * @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
  108455. * @param scene defines the hosting scene
  108456. * @param updatable defines if the mesh must be flagged as updatable
  108457. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108458. * @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)
  108459. * @returns a new Mesh
  108460. */
  108461. 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;
  108462. /**
  108463. * Creates lathe mesh.
  108464. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe.
  108465. * Please consider using the same method from the MeshBuilder class instead
  108466. * @param name defines the name of the mesh to create
  108467. * @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
  108468. * @param radius is the radius value of the lathe
  108469. * @param tessellation is the side number of the lathe.
  108470. * @param scene defines the hosting scene
  108471. * @param updatable defines if the mesh must be flagged as updatable
  108472. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108473. * @returns a new Mesh
  108474. */
  108475. static CreateLathe(name: string, shape: Vector3[], radius: number, tessellation: number, scene: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  108476. /**
  108477. * Creates a plane mesh. Please consider using the same method from the MeshBuilder class instead
  108478. * @param name defines the name of the mesh to create
  108479. * @param size sets the size (float) of both sides of the plane at once (default 1)
  108480. * @param scene defines the hosting scene
  108481. * @param updatable defines if the mesh must be flagged as updatable
  108482. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108483. * @returns a new Mesh
  108484. */
  108485. static CreatePlane(name: string, size: number, scene: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  108486. /**
  108487. * Creates a ground mesh.
  108488. * Please consider using the same method from the MeshBuilder class instead
  108489. * @param name defines the name of the mesh to create
  108490. * @param width set the width of the ground
  108491. * @param height set the height of the ground
  108492. * @param subdivisions sets the number of subdivisions per side
  108493. * @param scene defines the hosting scene
  108494. * @param updatable defines if the mesh must be flagged as updatable
  108495. * @returns a new Mesh
  108496. */
  108497. static CreateGround(name: string, width: number, height: number, subdivisions: number, scene?: Scene, updatable?: boolean): Mesh;
  108498. /**
  108499. * Creates a tiled ground mesh.
  108500. * Please consider using the same method from the MeshBuilder class instead
  108501. * @param name defines the name of the mesh to create
  108502. * @param xmin set the ground minimum X coordinate
  108503. * @param zmin set the ground minimum Y coordinate
  108504. * @param xmax set the ground maximum X coordinate
  108505. * @param zmax set the ground maximum Z coordinate
  108506. * @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
  108507. * @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
  108508. * @param scene defines the hosting scene
  108509. * @param updatable defines if the mesh must be flagged as updatable
  108510. * @returns a new Mesh
  108511. */
  108512. static CreateTiledGround(name: string, xmin: number, zmin: number, xmax: number, zmax: number, subdivisions: {
  108513. w: number;
  108514. h: number;
  108515. }, precision: {
  108516. w: number;
  108517. h: number;
  108518. }, scene: Scene, updatable?: boolean): Mesh;
  108519. /**
  108520. * Creates a ground mesh from a height map.
  108521. * Please consider using the same method from the MeshBuilder class instead
  108522. * @see https://doc.babylonjs.com/babylon101/height_map
  108523. * @param name defines the name of the mesh to create
  108524. * @param url sets the URL of the height map image resource
  108525. * @param width set the ground width size
  108526. * @param height set the ground height size
  108527. * @param subdivisions sets the number of subdivision per side
  108528. * @param minHeight is the minimum altitude on the ground
  108529. * @param maxHeight is the maximum altitude on the ground
  108530. * @param scene defines the hosting scene
  108531. * @param updatable defines if the mesh must be flagged as updatable
  108532. * @param onReady is a callback function that will be called once the mesh is built (the height map download can last some time)
  108533. * @param alphaFilter will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  108534. * @returns a new Mesh
  108535. */
  108536. 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;
  108537. /**
  108538. * Creates a tube mesh.
  108539. * The tube is a parametric shape.
  108540. * It has no predefined shape. Its final shape will depend on the input parameters.
  108541. * Please consider using the same method from the MeshBuilder class instead
  108542. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  108543. * @param name defines the name of the mesh to create
  108544. * @param path is a required array of successive Vector3. It is the curve used as the axis of the tube
  108545. * @param radius sets the tube radius size
  108546. * @param tessellation is the number of sides on the tubular surface
  108547. * @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
  108548. * @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
  108549. * @param scene defines the hosting scene
  108550. * @param updatable defines if the mesh must be flagged as updatable
  108551. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108552. * @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)
  108553. * @returns a new Mesh
  108554. */
  108555. static CreateTube(name: string, path: Vector3[], radius: number, tessellation: number, radiusFunction: {
  108556. (i: number, distance: number): number;
  108557. }, cap: number, scene: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  108558. /**
  108559. * Creates a polyhedron mesh.
  108560. * Please consider using the same method from the MeshBuilder class instead.
  108561. * * 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
  108562. * * The parameter `size` (positive float, default 1) sets the polygon size
  108563. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  108564. * * 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`
  108565. * * 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
  108566. * * 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)`)
  108567. * * 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
  108568. * * 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
  108569. * * You can also set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  108570. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  108571. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  108572. * @param name defines the name of the mesh to create
  108573. * @param options defines the options used to create the mesh
  108574. * @param scene defines the hosting scene
  108575. * @returns a new Mesh
  108576. */
  108577. static CreatePolyhedron(name: string, options: {
  108578. type?: number;
  108579. size?: number;
  108580. sizeX?: number;
  108581. sizeY?: number;
  108582. sizeZ?: number;
  108583. custom?: any;
  108584. faceUV?: Vector4[];
  108585. faceColors?: Color4[];
  108586. updatable?: boolean;
  108587. sideOrientation?: number;
  108588. }, scene: Scene): Mesh;
  108589. /**
  108590. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  108591. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  108592. * * 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`)
  108593. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  108594. * * 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
  108595. * * You can also set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  108596. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  108597. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  108598. * @param name defines the name of the mesh
  108599. * @param options defines the options used to create the mesh
  108600. * @param scene defines the hosting scene
  108601. * @returns a new Mesh
  108602. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  108603. */
  108604. static CreateIcoSphere(name: string, options: {
  108605. radius?: number;
  108606. flat?: boolean;
  108607. subdivisions?: number;
  108608. sideOrientation?: number;
  108609. updatable?: boolean;
  108610. }, scene: Scene): Mesh;
  108611. /**
  108612. * Creates a decal mesh.
  108613. * Please consider using the same method from the MeshBuilder class instead.
  108614. * A decal is a mesh usually applied as a model onto the surface of another mesh
  108615. * @param name defines the name of the mesh
  108616. * @param sourceMesh defines the mesh receiving the decal
  108617. * @param position sets the position of the decal in world coordinates
  108618. * @param normal sets the normal of the mesh where the decal is applied onto in world coordinates
  108619. * @param size sets the decal scaling
  108620. * @param angle sets the angle to rotate the decal
  108621. * @returns a new Mesh
  108622. */
  108623. static CreateDecal(name: string, sourceMesh: AbstractMesh, position: Vector3, normal: Vector3, size: Vector3, angle: number): Mesh;
  108624. /**
  108625. * Prepare internal position array for software CPU skinning
  108626. * @returns original positions used for CPU skinning. Useful for integrating Morphing with skeletons in same mesh
  108627. */
  108628. setPositionsForCPUSkinning(): Float32Array;
  108629. /**
  108630. * Prepare internal normal array for software CPU skinning
  108631. * @returns original normals used for CPU skinning. Useful for integrating Morphing with skeletons in same mesh.
  108632. */
  108633. setNormalsForCPUSkinning(): Float32Array;
  108634. /**
  108635. * Updates the vertex buffer by applying transformation from the bones
  108636. * @param skeleton defines the skeleton to apply to current mesh
  108637. * @returns the current mesh
  108638. */
  108639. applySkeleton(skeleton: Skeleton): Mesh;
  108640. /**
  108641. * 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
  108642. * @param meshes defines the list of meshes to scan
  108643. * @returns an object `{min:` Vector3`, max:` Vector3`}`
  108644. */
  108645. static MinMax(meshes: AbstractMesh[]): {
  108646. min: Vector3;
  108647. max: Vector3;
  108648. };
  108649. /**
  108650. * Returns the center of the `{min:` Vector3`, max:` Vector3`}` or the center of MinMax vector3 computed from a mesh array
  108651. * @param meshesOrMinMaxVector could be an array of meshes or a `{min:` Vector3`, max:` Vector3`}` object
  108652. * @returns a vector3
  108653. */
  108654. static Center(meshesOrMinMaxVector: {
  108655. min: Vector3;
  108656. max: Vector3;
  108657. } | AbstractMesh[]): Vector3;
  108658. /**
  108659. * Merge the array of meshes into a single mesh for performance reasons.
  108660. * @param meshes defines he vertices source. They should all be of the same material. Entries can empty
  108661. * @param disposeSource when true (default), dispose of the vertices from the source meshes
  108662. * @param allow32BitsIndices when the sum of the vertices > 64k, this must be set to true
  108663. * @param meshSubclass when set, vertices inserted into this Mesh. Meshes can then be merged into a Mesh sub-class.
  108664. * @param subdivideWithSubMeshes when true (false default), subdivide mesh to his subMesh array with meshes source.
  108665. * @param multiMultiMaterials when true (false default), subdivide mesh and accept multiple multi materials, ignores subdivideWithSubMeshes.
  108666. * @returns a new mesh
  108667. */
  108668. static MergeMeshes(meshes: Array<Mesh>, disposeSource?: boolean, allow32BitsIndices?: boolean, meshSubclass?: Mesh, subdivideWithSubMeshes?: boolean, multiMultiMaterials?: boolean): Nullable<Mesh>;
  108669. /** @hidden */
  108670. addInstance(instance: InstancedMesh): void;
  108671. /** @hidden */
  108672. removeInstance(instance: InstancedMesh): void;
  108673. }
  108674. }
  108675. declare module BABYLON {
  108676. /**
  108677. * This is the base class of all the camera used in the application.
  108678. * @see https://doc.babylonjs.com/features/cameras
  108679. */
  108680. export class Camera extends Node {
  108681. /** @hidden */
  108682. static _createDefaultParsedCamera: (name: string, scene: Scene) => Camera;
  108683. /**
  108684. * This is the default projection mode used by the cameras.
  108685. * It helps recreating a feeling of perspective and better appreciate depth.
  108686. * This is the best way to simulate real life cameras.
  108687. */
  108688. static readonly PERSPECTIVE_CAMERA: number;
  108689. /**
  108690. * This helps creating camera with an orthographic mode.
  108691. * 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.
  108692. */
  108693. static readonly ORTHOGRAPHIC_CAMERA: number;
  108694. /**
  108695. * This is the default FOV mode for perspective cameras.
  108696. * This setting aligns the upper and lower bounds of the viewport to the upper and lower bounds of the camera frustum.
  108697. */
  108698. static readonly FOVMODE_VERTICAL_FIXED: number;
  108699. /**
  108700. * This setting aligns the left and right bounds of the viewport to the left and right bounds of the camera frustum.
  108701. */
  108702. static readonly FOVMODE_HORIZONTAL_FIXED: number;
  108703. /**
  108704. * This specifies ther is no need for a camera rig.
  108705. * Basically only one eye is rendered corresponding to the camera.
  108706. */
  108707. static readonly RIG_MODE_NONE: number;
  108708. /**
  108709. * Simulates a camera Rig with one blue eye and one red eye.
  108710. * This can be use with 3d blue and red glasses.
  108711. */
  108712. static readonly RIG_MODE_STEREOSCOPIC_ANAGLYPH: number;
  108713. /**
  108714. * Defines that both eyes of the camera will be rendered side by side with a parallel target.
  108715. */
  108716. static readonly RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_PARALLEL: number;
  108717. /**
  108718. * Defines that both eyes of the camera will be rendered side by side with a none parallel target.
  108719. */
  108720. static readonly RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_CROSSEYED: number;
  108721. /**
  108722. * Defines that both eyes of the camera will be rendered over under each other.
  108723. */
  108724. static readonly RIG_MODE_STEREOSCOPIC_OVERUNDER: number;
  108725. /**
  108726. * Defines that both eyes of the camera will be rendered on successive lines interlaced for passive 3d monitors.
  108727. */
  108728. static readonly RIG_MODE_STEREOSCOPIC_INTERLACED: number;
  108729. /**
  108730. * Defines that both eyes of the camera should be renderered in a VR mode (carbox).
  108731. */
  108732. static readonly RIG_MODE_VR: number;
  108733. /**
  108734. * Defines that both eyes of the camera should be renderered in a VR mode (webVR).
  108735. */
  108736. static readonly RIG_MODE_WEBVR: number;
  108737. /**
  108738. * Custom rig mode allowing rig cameras to be populated manually with any number of cameras
  108739. */
  108740. static readonly RIG_MODE_CUSTOM: number;
  108741. /**
  108742. * Defines if by default attaching controls should prevent the default javascript event to continue.
  108743. */
  108744. static ForceAttachControlToAlwaysPreventDefault: boolean;
  108745. /**
  108746. * Define the input manager associated with the camera.
  108747. */
  108748. inputs: CameraInputsManager<Camera>;
  108749. /** @hidden */
  108750. _position: Vector3;
  108751. /**
  108752. * Define the current local position of the camera in the scene
  108753. */
  108754. get position(): Vector3;
  108755. set position(newPosition: Vector3);
  108756. /**
  108757. * The vector the camera should consider as up.
  108758. * (default is Vector3(0, 1, 0) aka Vector3.Up())
  108759. */
  108760. upVector: Vector3;
  108761. /**
  108762. * Define the current limit on the left side for an orthographic camera
  108763. * In scene unit
  108764. */
  108765. orthoLeft: Nullable<number>;
  108766. /**
  108767. * Define the current limit on the right side for an orthographic camera
  108768. * In scene unit
  108769. */
  108770. orthoRight: Nullable<number>;
  108771. /**
  108772. * Define the current limit on the bottom side for an orthographic camera
  108773. * In scene unit
  108774. */
  108775. orthoBottom: Nullable<number>;
  108776. /**
  108777. * Define the current limit on the top side for an orthographic camera
  108778. * In scene unit
  108779. */
  108780. orthoTop: Nullable<number>;
  108781. /**
  108782. * Field Of View is set in Radians. (default is 0.8)
  108783. */
  108784. fov: number;
  108785. /**
  108786. * Define the minimum distance the camera can see from.
  108787. * This is important to note that the depth buffer are not infinite and the closer it starts
  108788. * the more your scene might encounter depth fighting issue.
  108789. */
  108790. minZ: number;
  108791. /**
  108792. * Define the maximum distance the camera can see to.
  108793. * This is important to note that the depth buffer are not infinite and the further it end
  108794. * the more your scene might encounter depth fighting issue.
  108795. */
  108796. maxZ: number;
  108797. /**
  108798. * Define the default inertia of the camera.
  108799. * This helps giving a smooth feeling to the camera movement.
  108800. */
  108801. inertia: number;
  108802. /**
  108803. * Define the mode of the camera (Camera.PERSPECTIVE_CAMERA or Camera.ORTHOGRAPHIC_CAMERA)
  108804. */
  108805. mode: number;
  108806. /**
  108807. * Define whether the camera is intermediate.
  108808. * This is useful to not present the output directly to the screen in case of rig without post process for instance
  108809. */
  108810. isIntermediate: boolean;
  108811. /**
  108812. * Define the viewport of the camera.
  108813. * This correspond to the portion of the screen the camera will render to in normalized 0 to 1 unit.
  108814. */
  108815. viewport: Viewport;
  108816. /**
  108817. * Restricts the camera to viewing objects with the same layerMask.
  108818. * A camera with a layerMask of 1 will render mesh.layerMask & camera.layerMask!== 0
  108819. */
  108820. layerMask: number;
  108821. /**
  108822. * fovMode sets the camera frustum bounds to the viewport bounds. (default is FOVMODE_VERTICAL_FIXED)
  108823. */
  108824. fovMode: number;
  108825. /**
  108826. * Rig mode of the camera.
  108827. * This is useful to create the camera with two "eyes" instead of one to create VR or stereoscopic scenes.
  108828. * This is normally controlled byt the camera themselves as internal use.
  108829. */
  108830. cameraRigMode: number;
  108831. /**
  108832. * Defines the distance between both "eyes" in case of a RIG
  108833. */
  108834. interaxialDistance: number;
  108835. /**
  108836. * Defines if stereoscopic rendering is done side by side or over under.
  108837. */
  108838. isStereoscopicSideBySide: boolean;
  108839. /**
  108840. * 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
  108841. * This is pretty helpfull if you wish to make a camera render to a texture you could reuse somewhere
  108842. * else in the scene. (Eg. security camera)
  108843. *
  108844. * 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)
  108845. */
  108846. customRenderTargets: RenderTargetTexture[];
  108847. /**
  108848. * When set, the camera will render to this render target instead of the default canvas
  108849. *
  108850. * If the desire is to use the output of a camera as a texture in the scene consider using camera.customRenderTargets instead
  108851. */
  108852. outputRenderTarget: Nullable<RenderTargetTexture>;
  108853. /**
  108854. * Observable triggered when the camera view matrix has changed.
  108855. */
  108856. onViewMatrixChangedObservable: Observable<Camera>;
  108857. /**
  108858. * Observable triggered when the camera Projection matrix has changed.
  108859. */
  108860. onProjectionMatrixChangedObservable: Observable<Camera>;
  108861. /**
  108862. * Observable triggered when the inputs have been processed.
  108863. */
  108864. onAfterCheckInputsObservable: Observable<Camera>;
  108865. /**
  108866. * Observable triggered when reset has been called and applied to the camera.
  108867. */
  108868. onRestoreStateObservable: Observable<Camera>;
  108869. /**
  108870. * Is this camera a part of a rig system?
  108871. */
  108872. isRigCamera: boolean;
  108873. /**
  108874. * If isRigCamera set to true this will be set with the parent camera.
  108875. * The parent camera is not (!) necessarily the .parent of this camera (like in the case of XR)
  108876. */
  108877. rigParent?: Camera;
  108878. /** @hidden */
  108879. _cameraRigParams: any;
  108880. /** @hidden */
  108881. _rigCameras: Camera[];
  108882. /** @hidden */
  108883. _rigPostProcess: Nullable<PostProcess>;
  108884. protected _webvrViewMatrix: Matrix;
  108885. /** @hidden */
  108886. _skipRendering: boolean;
  108887. /** @hidden */
  108888. _projectionMatrix: Matrix;
  108889. /** @hidden */
  108890. _postProcesses: Nullable<PostProcess>[];
  108891. /** @hidden */
  108892. _activeMeshes: SmartArray<AbstractMesh>;
  108893. protected _globalPosition: Vector3;
  108894. /** @hidden */
  108895. _computedViewMatrix: Matrix;
  108896. private _doNotComputeProjectionMatrix;
  108897. private _transformMatrix;
  108898. private _frustumPlanes;
  108899. private _refreshFrustumPlanes;
  108900. private _storedFov;
  108901. private _stateStored;
  108902. /**
  108903. * Instantiates a new camera object.
  108904. * This should not be used directly but through the inherited cameras: ArcRotate, Free...
  108905. * @see https://doc.babylonjs.com/features/cameras
  108906. * @param name Defines the name of the camera in the scene
  108907. * @param position Defines the position of the camera
  108908. * @param scene Defines the scene the camera belongs too
  108909. * @param setActiveOnSceneIfNoneActive Defines if the camera should be set as active after creation if no other camera have been defined in the scene
  108910. */
  108911. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  108912. /**
  108913. * Store current camera state (fov, position, etc..)
  108914. * @returns the camera
  108915. */
  108916. storeState(): Camera;
  108917. /**
  108918. * Restores the camera state values if it has been stored. You must call storeState() first
  108919. */
  108920. protected _restoreStateValues(): boolean;
  108921. /**
  108922. * Restored camera state. You must call storeState() first.
  108923. * @returns true if restored and false otherwise
  108924. */
  108925. restoreState(): boolean;
  108926. /**
  108927. * Gets the class name of the camera.
  108928. * @returns the class name
  108929. */
  108930. getClassName(): string;
  108931. /** @hidden */
  108932. readonly _isCamera: boolean;
  108933. /**
  108934. * Gets a string representation of the camera useful for debug purpose.
  108935. * @param fullDetails Defines that a more verboe level of logging is required
  108936. * @returns the string representation
  108937. */
  108938. toString(fullDetails?: boolean): string;
  108939. /**
  108940. * Gets the current world space position of the camera.
  108941. */
  108942. get globalPosition(): Vector3;
  108943. /**
  108944. * Gets the list of active meshes this frame (meshes no culled or excluded by lod s in the frame)
  108945. * @returns the active meshe list
  108946. */
  108947. getActiveMeshes(): SmartArray<AbstractMesh>;
  108948. /**
  108949. * Check whether a mesh is part of the current active mesh list of the camera
  108950. * @param mesh Defines the mesh to check
  108951. * @returns true if active, false otherwise
  108952. */
  108953. isActiveMesh(mesh: Mesh): boolean;
  108954. /**
  108955. * Is this camera ready to be used/rendered
  108956. * @param completeCheck defines if a complete check (including post processes) has to be done (false by default)
  108957. * @return true if the camera is ready
  108958. */
  108959. isReady(completeCheck?: boolean): boolean;
  108960. /** @hidden */
  108961. _initCache(): void;
  108962. /** @hidden */
  108963. _updateCache(ignoreParentClass?: boolean): void;
  108964. /** @hidden */
  108965. _isSynchronized(): boolean;
  108966. /** @hidden */
  108967. _isSynchronizedViewMatrix(): boolean;
  108968. /** @hidden */
  108969. _isSynchronizedProjectionMatrix(): boolean;
  108970. /**
  108971. * Attach the input controls to a specific dom element to get the input from.
  108972. * @param element Defines the element the controls should be listened from
  108973. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  108974. */
  108975. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  108976. /**
  108977. * Detach the current controls from the specified dom element.
  108978. * @param element Defines the element to stop listening the inputs from
  108979. */
  108980. detachControl(element: HTMLElement): void;
  108981. /**
  108982. * Update the camera state according to the different inputs gathered during the frame.
  108983. */
  108984. update(): void;
  108985. /** @hidden */
  108986. _checkInputs(): void;
  108987. /** @hidden */
  108988. get rigCameras(): Camera[];
  108989. /**
  108990. * Gets the post process used by the rig cameras
  108991. */
  108992. get rigPostProcess(): Nullable<PostProcess>;
  108993. /**
  108994. * Internal, gets the first post proces.
  108995. * @returns the first post process to be run on this camera.
  108996. */
  108997. _getFirstPostProcess(): Nullable<PostProcess>;
  108998. private _cascadePostProcessesToRigCams;
  108999. /**
  109000. * Attach a post process to the camera.
  109001. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#attach-postprocess
  109002. * @param postProcess The post process to attach to the camera
  109003. * @param insertAt The position of the post process in case several of them are in use in the scene
  109004. * @returns the position the post process has been inserted at
  109005. */
  109006. attachPostProcess(postProcess: PostProcess, insertAt?: Nullable<number>): number;
  109007. /**
  109008. * Detach a post process to the camera.
  109009. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#attach-postprocess
  109010. * @param postProcess The post process to detach from the camera
  109011. */
  109012. detachPostProcess(postProcess: PostProcess): void;
  109013. /**
  109014. * Gets the current world matrix of the camera
  109015. */
  109016. getWorldMatrix(): Matrix;
  109017. /** @hidden */
  109018. _getViewMatrix(): Matrix;
  109019. /**
  109020. * Gets the current view matrix of the camera.
  109021. * @param force forces the camera to recompute the matrix without looking at the cached state
  109022. * @returns the view matrix
  109023. */
  109024. getViewMatrix(force?: boolean): Matrix;
  109025. /**
  109026. * Freeze the projection matrix.
  109027. * It will prevent the cache check of the camera projection compute and can speed up perf
  109028. * if no parameter of the camera are meant to change
  109029. * @param projection Defines manually a projection if necessary
  109030. */
  109031. freezeProjectionMatrix(projection?: Matrix): void;
  109032. /**
  109033. * Unfreeze the projection matrix if it has previously been freezed by freezeProjectionMatrix.
  109034. */
  109035. unfreezeProjectionMatrix(): void;
  109036. /**
  109037. * Gets the current projection matrix of the camera.
  109038. * @param force forces the camera to recompute the matrix without looking at the cached state
  109039. * @returns the projection matrix
  109040. */
  109041. getProjectionMatrix(force?: boolean): Matrix;
  109042. /**
  109043. * Gets the transformation matrix (ie. the multiplication of view by projection matrices)
  109044. * @returns a Matrix
  109045. */
  109046. getTransformationMatrix(): Matrix;
  109047. private _updateFrustumPlanes;
  109048. /**
  109049. * Checks if a cullable object (mesh...) is in the camera frustum
  109050. * This checks the bounding box center. See isCompletelyInFrustum for a full bounding check
  109051. * @param target The object to check
  109052. * @param checkRigCameras If the rig cameras should be checked (eg. with webVR camera both eyes should be checked) (Default: false)
  109053. * @returns true if the object is in frustum otherwise false
  109054. */
  109055. isInFrustum(target: ICullable, checkRigCameras?: boolean): boolean;
  109056. /**
  109057. * Checks if a cullable object (mesh...) is in the camera frustum
  109058. * Unlike isInFrustum this cheks the full bounding box
  109059. * @param target The object to check
  109060. * @returns true if the object is in frustum otherwise false
  109061. */
  109062. isCompletelyInFrustum(target: ICullable): boolean;
  109063. /**
  109064. * Gets a ray in the forward direction from the camera.
  109065. * @param length Defines the length of the ray to create
  109066. * @param transform Defines the transform to apply to the ray, by default the world matrx is used to create a workd space ray
  109067. * @param origin Defines the start point of the ray which defaults to the camera position
  109068. * @returns the forward ray
  109069. */
  109070. getForwardRay(length?: number, transform?: Matrix, origin?: Vector3): Ray;
  109071. /**
  109072. * Gets a ray in the forward direction from the camera.
  109073. * @param refRay the ray to (re)use when setting the values
  109074. * @param length Defines the length of the ray to create
  109075. * @param transform Defines the transform to apply to the ray, by default the world matrx is used to create a workd space ray
  109076. * @param origin Defines the start point of the ray which defaults to the camera position
  109077. * @returns the forward ray
  109078. */
  109079. getForwardRayToRef(refRay: Ray, length?: number, transform?: Matrix, origin?: Vector3): Ray;
  109080. /**
  109081. * Releases resources associated with this node.
  109082. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  109083. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  109084. */
  109085. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  109086. /** @hidden */
  109087. _isLeftCamera: boolean;
  109088. /**
  109089. * Gets the left camera of a rig setup in case of Rigged Camera
  109090. */
  109091. get isLeftCamera(): boolean;
  109092. /** @hidden */
  109093. _isRightCamera: boolean;
  109094. /**
  109095. * Gets the right camera of a rig setup in case of Rigged Camera
  109096. */
  109097. get isRightCamera(): boolean;
  109098. /**
  109099. * Gets the left camera of a rig setup in case of Rigged Camera
  109100. */
  109101. get leftCamera(): Nullable<FreeCamera>;
  109102. /**
  109103. * Gets the right camera of a rig setup in case of Rigged Camera
  109104. */
  109105. get rightCamera(): Nullable<FreeCamera>;
  109106. /**
  109107. * Gets the left camera target of a rig setup in case of Rigged Camera
  109108. * @returns the target position
  109109. */
  109110. getLeftTarget(): Nullable<Vector3>;
  109111. /**
  109112. * Gets the right camera target of a rig setup in case of Rigged Camera
  109113. * @returns the target position
  109114. */
  109115. getRightTarget(): Nullable<Vector3>;
  109116. /**
  109117. * @hidden
  109118. */
  109119. setCameraRigMode(mode: number, rigParams: any): void;
  109120. /** @hidden */
  109121. static _setStereoscopicRigMode(camera: Camera): void;
  109122. /** @hidden */
  109123. static _setStereoscopicAnaglyphRigMode(camera: Camera): void;
  109124. /** @hidden */
  109125. static _setVRRigMode(camera: Camera, rigParams: any): void;
  109126. /** @hidden */
  109127. static _setWebVRRigMode(camera: Camera, rigParams: any): void;
  109128. /** @hidden */
  109129. _getVRProjectionMatrix(): Matrix;
  109130. protected _updateCameraRotationMatrix(): void;
  109131. protected _updateWebVRCameraRotationMatrix(): void;
  109132. /**
  109133. * This function MUST be overwritten by the different WebVR cameras available.
  109134. * The context in which it is running is the RIG camera. So 'this' is the TargetCamera, left or right.
  109135. * @hidden
  109136. */
  109137. _getWebVRProjectionMatrix(): Matrix;
  109138. /**
  109139. * This function MUST be overwritten by the different WebVR cameras available.
  109140. * The context in which it is running is the RIG camera. So 'this' is the TargetCamera, left or right.
  109141. * @hidden
  109142. */
  109143. _getWebVRViewMatrix(): Matrix;
  109144. /** @hidden */
  109145. setCameraRigParameter(name: string, value: any): void;
  109146. /**
  109147. * needs to be overridden by children so sub has required properties to be copied
  109148. * @hidden
  109149. */
  109150. createRigCamera(name: string, cameraIndex: number): Nullable<Camera>;
  109151. /**
  109152. * May need to be overridden by children
  109153. * @hidden
  109154. */
  109155. _updateRigCameras(): void;
  109156. /** @hidden */
  109157. _setupInputs(): void;
  109158. /**
  109159. * Serialiaze the camera setup to a json represention
  109160. * @returns the JSON representation
  109161. */
  109162. serialize(): any;
  109163. /**
  109164. * Clones the current camera.
  109165. * @param name The cloned camera name
  109166. * @returns the cloned camera
  109167. */
  109168. clone(name: string): Camera;
  109169. /**
  109170. * Gets the direction of the camera relative to a given local axis.
  109171. * @param localAxis Defines the reference axis to provide a relative direction.
  109172. * @return the direction
  109173. */
  109174. getDirection(localAxis: Vector3): Vector3;
  109175. /**
  109176. * Returns the current camera absolute rotation
  109177. */
  109178. get absoluteRotation(): Quaternion;
  109179. /**
  109180. * Gets the direction of the camera relative to a given local axis into a passed vector.
  109181. * @param localAxis Defines the reference axis to provide a relative direction.
  109182. * @param result Defines the vector to store the result in
  109183. */
  109184. getDirectionToRef(localAxis: Vector3, result: Vector3): void;
  109185. /**
  109186. * Gets a camera constructor for a given camera type
  109187. * @param type The type of the camera to construct (should be equal to one of the camera class name)
  109188. * @param name The name of the camera the result will be able to instantiate
  109189. * @param scene The scene the result will construct the camera in
  109190. * @param interaxial_distance In case of stereoscopic setup, the distance between both eyes
  109191. * @param isStereoscopicSideBySide In case of stereoscopic setup, should the sereo be side b side
  109192. * @returns a factory method to construc the camera
  109193. */
  109194. static GetConstructorFromName(type: string, name: string, scene: Scene, interaxial_distance?: number, isStereoscopicSideBySide?: boolean): () => Camera;
  109195. /**
  109196. * Compute the world matrix of the camera.
  109197. * @returns the camera world matrix
  109198. */
  109199. computeWorldMatrix(): Matrix;
  109200. /**
  109201. * Parse a JSON and creates the camera from the parsed information
  109202. * @param parsedCamera The JSON to parse
  109203. * @param scene The scene to instantiate the camera in
  109204. * @returns the newly constructed camera
  109205. */
  109206. static Parse(parsedCamera: any, scene: Scene): Camera;
  109207. }
  109208. }
  109209. declare module BABYLON {
  109210. /**
  109211. * Class containing static functions to help procedurally build meshes
  109212. */
  109213. export class DiscBuilder {
  109214. /**
  109215. * Creates a plane polygonal mesh. By default, this is a disc
  109216. * * The parameter `radius` sets the radius size (float) of the polygon (default 0.5)
  109217. * * 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
  109218. * * 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
  109219. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  109220. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  109221. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  109222. * @param name defines the name of the mesh
  109223. * @param options defines the options used to create the mesh
  109224. * @param scene defines the hosting scene
  109225. * @returns the plane polygonal mesh
  109226. * @see https://doc.babylonjs.com/how_to/set_shapes#disc-or-regular-polygon
  109227. */
  109228. static CreateDisc(name: string, options: {
  109229. radius?: number;
  109230. tessellation?: number;
  109231. arc?: number;
  109232. updatable?: boolean;
  109233. sideOrientation?: number;
  109234. frontUVs?: Vector4;
  109235. backUVs?: Vector4;
  109236. }, scene?: Nullable<Scene>): Mesh;
  109237. }
  109238. }
  109239. declare module BABYLON {
  109240. /**
  109241. * Options to be used when creating a FresnelParameters.
  109242. */
  109243. export type IFresnelParametersCreationOptions = {
  109244. /**
  109245. * Define the color used on edges (grazing angle)
  109246. */
  109247. leftColor?: Color3;
  109248. /**
  109249. * Define the color used on center
  109250. */
  109251. rightColor?: Color3;
  109252. /**
  109253. * Define bias applied to computed fresnel term
  109254. */
  109255. bias?: number;
  109256. /**
  109257. * Defined the power exponent applied to fresnel term
  109258. */
  109259. power?: number;
  109260. /**
  109261. * Define if the fresnel effect is enable or not.
  109262. */
  109263. isEnabled?: boolean;
  109264. };
  109265. /**
  109266. * Serialized format for FresnelParameters.
  109267. */
  109268. export type IFresnelParametersSerialized = {
  109269. /**
  109270. * Define the color used on edges (grazing angle) [as an array]
  109271. */
  109272. leftColor: number[];
  109273. /**
  109274. * Define the color used on center [as an array]
  109275. */
  109276. rightColor: number[];
  109277. /**
  109278. * Define bias applied to computed fresnel term
  109279. */
  109280. bias: number;
  109281. /**
  109282. * Defined the power exponent applied to fresnel term
  109283. */
  109284. power?: number;
  109285. /**
  109286. * Define if the fresnel effect is enable or not.
  109287. */
  109288. isEnabled: boolean;
  109289. };
  109290. /**
  109291. * This represents all the required information to add a fresnel effect on a material:
  109292. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  109293. */
  109294. export class FresnelParameters {
  109295. private _isEnabled;
  109296. /**
  109297. * Define if the fresnel effect is enable or not.
  109298. */
  109299. get isEnabled(): boolean;
  109300. set isEnabled(value: boolean);
  109301. /**
  109302. * Define the color used on edges (grazing angle)
  109303. */
  109304. leftColor: Color3;
  109305. /**
  109306. * Define the color used on center
  109307. */
  109308. rightColor: Color3;
  109309. /**
  109310. * Define bias applied to computed fresnel term
  109311. */
  109312. bias: number;
  109313. /**
  109314. * Defined the power exponent applied to fresnel term
  109315. */
  109316. power: number;
  109317. /**
  109318. * Creates a new FresnelParameters object.
  109319. *
  109320. * @param options provide your own settings to optionally to override defaults
  109321. */
  109322. constructor(options?: IFresnelParametersCreationOptions);
  109323. /**
  109324. * Clones the current fresnel and its valuues
  109325. * @returns a clone fresnel configuration
  109326. */
  109327. clone(): FresnelParameters;
  109328. /**
  109329. * Determines equality between FresnelParameters objects
  109330. * @param otherFresnelParameters defines the second operand
  109331. * @returns true if the power, bias, leftColor, rightColor and isEnabled values are equal to the given ones
  109332. */
  109333. equals(otherFresnelParameters: DeepImmutable<FresnelParameters>): boolean;
  109334. /**
  109335. * Serializes the current fresnel parameters to a JSON representation.
  109336. * @return the JSON serialization
  109337. */
  109338. serialize(): IFresnelParametersSerialized;
  109339. /**
  109340. * Parse a JSON object and deserialize it to a new Fresnel parameter object.
  109341. * @param parsedFresnelParameters Define the JSON representation
  109342. * @returns the parsed parameters
  109343. */
  109344. static Parse(parsedFresnelParameters: IFresnelParametersSerialized): FresnelParameters;
  109345. }
  109346. }
  109347. declare module BABYLON {
  109348. /**
  109349. * This groups all the flags used to control the materials channel.
  109350. */
  109351. export class MaterialFlags {
  109352. private static _DiffuseTextureEnabled;
  109353. /**
  109354. * Are diffuse textures enabled in the application.
  109355. */
  109356. static get DiffuseTextureEnabled(): boolean;
  109357. static set DiffuseTextureEnabled(value: boolean);
  109358. private static _DetailTextureEnabled;
  109359. /**
  109360. * Are detail textures enabled in the application.
  109361. */
  109362. static get DetailTextureEnabled(): boolean;
  109363. static set DetailTextureEnabled(value: boolean);
  109364. private static _AmbientTextureEnabled;
  109365. /**
  109366. * Are ambient textures enabled in the application.
  109367. */
  109368. static get AmbientTextureEnabled(): boolean;
  109369. static set AmbientTextureEnabled(value: boolean);
  109370. private static _OpacityTextureEnabled;
  109371. /**
  109372. * Are opacity textures enabled in the application.
  109373. */
  109374. static get OpacityTextureEnabled(): boolean;
  109375. static set OpacityTextureEnabled(value: boolean);
  109376. private static _ReflectionTextureEnabled;
  109377. /**
  109378. * Are reflection textures enabled in the application.
  109379. */
  109380. static get ReflectionTextureEnabled(): boolean;
  109381. static set ReflectionTextureEnabled(value: boolean);
  109382. private static _EmissiveTextureEnabled;
  109383. /**
  109384. * Are emissive textures enabled in the application.
  109385. */
  109386. static get EmissiveTextureEnabled(): boolean;
  109387. static set EmissiveTextureEnabled(value: boolean);
  109388. private static _SpecularTextureEnabled;
  109389. /**
  109390. * Are specular textures enabled in the application.
  109391. */
  109392. static get SpecularTextureEnabled(): boolean;
  109393. static set SpecularTextureEnabled(value: boolean);
  109394. private static _BumpTextureEnabled;
  109395. /**
  109396. * Are bump textures enabled in the application.
  109397. */
  109398. static get BumpTextureEnabled(): boolean;
  109399. static set BumpTextureEnabled(value: boolean);
  109400. private static _LightmapTextureEnabled;
  109401. /**
  109402. * Are lightmap textures enabled in the application.
  109403. */
  109404. static get LightmapTextureEnabled(): boolean;
  109405. static set LightmapTextureEnabled(value: boolean);
  109406. private static _RefractionTextureEnabled;
  109407. /**
  109408. * Are refraction textures enabled in the application.
  109409. */
  109410. static get RefractionTextureEnabled(): boolean;
  109411. static set RefractionTextureEnabled(value: boolean);
  109412. private static _ColorGradingTextureEnabled;
  109413. /**
  109414. * Are color grading textures enabled in the application.
  109415. */
  109416. static get ColorGradingTextureEnabled(): boolean;
  109417. static set ColorGradingTextureEnabled(value: boolean);
  109418. private static _FresnelEnabled;
  109419. /**
  109420. * Are fresnels enabled in the application.
  109421. */
  109422. static get FresnelEnabled(): boolean;
  109423. static set FresnelEnabled(value: boolean);
  109424. private static _ClearCoatTextureEnabled;
  109425. /**
  109426. * Are clear coat textures enabled in the application.
  109427. */
  109428. static get ClearCoatTextureEnabled(): boolean;
  109429. static set ClearCoatTextureEnabled(value: boolean);
  109430. private static _ClearCoatBumpTextureEnabled;
  109431. /**
  109432. * Are clear coat bump textures enabled in the application.
  109433. */
  109434. static get ClearCoatBumpTextureEnabled(): boolean;
  109435. static set ClearCoatBumpTextureEnabled(value: boolean);
  109436. private static _ClearCoatTintTextureEnabled;
  109437. /**
  109438. * Are clear coat tint textures enabled in the application.
  109439. */
  109440. static get ClearCoatTintTextureEnabled(): boolean;
  109441. static set ClearCoatTintTextureEnabled(value: boolean);
  109442. private static _SheenTextureEnabled;
  109443. /**
  109444. * Are sheen textures enabled in the application.
  109445. */
  109446. static get SheenTextureEnabled(): boolean;
  109447. static set SheenTextureEnabled(value: boolean);
  109448. private static _AnisotropicTextureEnabled;
  109449. /**
  109450. * Are anisotropic textures enabled in the application.
  109451. */
  109452. static get AnisotropicTextureEnabled(): boolean;
  109453. static set AnisotropicTextureEnabled(value: boolean);
  109454. private static _ThicknessTextureEnabled;
  109455. /**
  109456. * Are thickness textures enabled in the application.
  109457. */
  109458. static get ThicknessTextureEnabled(): boolean;
  109459. static set ThicknessTextureEnabled(value: boolean);
  109460. }
  109461. }
  109462. declare module BABYLON {
  109463. /** @hidden */
  109464. export var defaultFragmentDeclaration: {
  109465. name: string;
  109466. shader: string;
  109467. };
  109468. }
  109469. declare module BABYLON {
  109470. /** @hidden */
  109471. export var defaultUboDeclaration: {
  109472. name: string;
  109473. shader: string;
  109474. };
  109475. }
  109476. declare module BABYLON {
  109477. /** @hidden */
  109478. export var prePassDeclaration: {
  109479. name: string;
  109480. shader: string;
  109481. };
  109482. }
  109483. declare module BABYLON {
  109484. /** @hidden */
  109485. export var lightFragmentDeclaration: {
  109486. name: string;
  109487. shader: string;
  109488. };
  109489. }
  109490. declare module BABYLON {
  109491. /** @hidden */
  109492. export var lightUboDeclaration: {
  109493. name: string;
  109494. shader: string;
  109495. };
  109496. }
  109497. declare module BABYLON {
  109498. /** @hidden */
  109499. export var lightsFragmentFunctions: {
  109500. name: string;
  109501. shader: string;
  109502. };
  109503. }
  109504. declare module BABYLON {
  109505. /** @hidden */
  109506. export var shadowsFragmentFunctions: {
  109507. name: string;
  109508. shader: string;
  109509. };
  109510. }
  109511. declare module BABYLON {
  109512. /** @hidden */
  109513. export var fresnelFunction: {
  109514. name: string;
  109515. shader: string;
  109516. };
  109517. }
  109518. declare module BABYLON {
  109519. /** @hidden */
  109520. export var bumpFragmentMainFunctions: {
  109521. name: string;
  109522. shader: string;
  109523. };
  109524. }
  109525. declare module BABYLON {
  109526. /** @hidden */
  109527. export var bumpFragmentFunctions: {
  109528. name: string;
  109529. shader: string;
  109530. };
  109531. }
  109532. declare module BABYLON {
  109533. /** @hidden */
  109534. export var logDepthDeclaration: {
  109535. name: string;
  109536. shader: string;
  109537. };
  109538. }
  109539. declare module BABYLON {
  109540. /** @hidden */
  109541. export var bumpFragment: {
  109542. name: string;
  109543. shader: string;
  109544. };
  109545. }
  109546. declare module BABYLON {
  109547. /** @hidden */
  109548. export var depthPrePass: {
  109549. name: string;
  109550. shader: string;
  109551. };
  109552. }
  109553. declare module BABYLON {
  109554. /** @hidden */
  109555. export var lightFragment: {
  109556. name: string;
  109557. shader: string;
  109558. };
  109559. }
  109560. declare module BABYLON {
  109561. /** @hidden */
  109562. export var logDepthFragment: {
  109563. name: string;
  109564. shader: string;
  109565. };
  109566. }
  109567. declare module BABYLON {
  109568. /** @hidden */
  109569. export var defaultPixelShader: {
  109570. name: string;
  109571. shader: string;
  109572. };
  109573. }
  109574. declare module BABYLON {
  109575. /** @hidden */
  109576. export var defaultVertexDeclaration: {
  109577. name: string;
  109578. shader: string;
  109579. };
  109580. }
  109581. declare module BABYLON {
  109582. /** @hidden */
  109583. export var bumpVertexDeclaration: {
  109584. name: string;
  109585. shader: string;
  109586. };
  109587. }
  109588. declare module BABYLON {
  109589. /** @hidden */
  109590. export var bumpVertex: {
  109591. name: string;
  109592. shader: string;
  109593. };
  109594. }
  109595. declare module BABYLON {
  109596. /** @hidden */
  109597. export var fogVertex: {
  109598. name: string;
  109599. shader: string;
  109600. };
  109601. }
  109602. declare module BABYLON {
  109603. /** @hidden */
  109604. export var shadowsVertex: {
  109605. name: string;
  109606. shader: string;
  109607. };
  109608. }
  109609. declare module BABYLON {
  109610. /** @hidden */
  109611. export var pointCloudVertex: {
  109612. name: string;
  109613. shader: string;
  109614. };
  109615. }
  109616. declare module BABYLON {
  109617. /** @hidden */
  109618. export var logDepthVertex: {
  109619. name: string;
  109620. shader: string;
  109621. };
  109622. }
  109623. declare module BABYLON {
  109624. /** @hidden */
  109625. export var defaultVertexShader: {
  109626. name: string;
  109627. shader: string;
  109628. };
  109629. }
  109630. declare module BABYLON {
  109631. /**
  109632. * @hidden
  109633. */
  109634. export interface IMaterialDetailMapDefines {
  109635. DETAIL: boolean;
  109636. DETAILDIRECTUV: number;
  109637. DETAIL_NORMALBLENDMETHOD: number;
  109638. /** @hidden */
  109639. _areTexturesDirty: boolean;
  109640. }
  109641. /**
  109642. * Define the code related to the detail map parameters of a material
  109643. *
  109644. * Inspired from:
  109645. * 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
  109646. * Unreal: https://docs.unrealengine.com/en-US/Engine/Rendering/Materials/HowTo/DetailTexturing/index.html
  109647. * Cryengine: https://docs.cryengine.com/display/SDKDOC2/Detail+Maps
  109648. */
  109649. export class DetailMapConfiguration {
  109650. private _texture;
  109651. /**
  109652. * The detail texture of the material.
  109653. */
  109654. texture: Nullable<BaseTexture>;
  109655. /**
  109656. * Defines how strongly the detail diffuse/albedo channel is blended with the regular diffuse/albedo texture
  109657. * Bigger values mean stronger blending
  109658. */
  109659. diffuseBlendLevel: number;
  109660. /**
  109661. * Defines how strongly the detail roughness channel is blended with the regular roughness value
  109662. * Bigger values mean stronger blending. Only used with PBR materials
  109663. */
  109664. roughnessBlendLevel: number;
  109665. /**
  109666. * Defines how strong the bump effect from the detail map is
  109667. * Bigger values mean stronger effect
  109668. */
  109669. bumpLevel: number;
  109670. private _normalBlendMethod;
  109671. /**
  109672. * The method used to blend the bump and detail normals together
  109673. */
  109674. normalBlendMethod: number;
  109675. private _isEnabled;
  109676. /**
  109677. * Enable or disable the detail map on this material
  109678. */
  109679. isEnabled: boolean;
  109680. /** @hidden */
  109681. private _internalMarkAllSubMeshesAsTexturesDirty;
  109682. /** @hidden */
  109683. _markAllSubMeshesAsTexturesDirty(): void;
  109684. /**
  109685. * Instantiate a new detail map
  109686. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  109687. */
  109688. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  109689. /**
  109690. * Gets whether the submesh is ready to be used or not.
  109691. * @param defines the list of "defines" to update.
  109692. * @param scene defines the scene the material belongs to.
  109693. * @returns - boolean indicating that the submesh is ready or not.
  109694. */
  109695. isReadyForSubMesh(defines: IMaterialDetailMapDefines, scene: Scene): boolean;
  109696. /**
  109697. * Update the defines for detail map usage
  109698. * @param defines the list of "defines" to update.
  109699. * @param scene defines the scene the material belongs to.
  109700. */
  109701. prepareDefines(defines: IMaterialDetailMapDefines, scene: Scene): void;
  109702. /**
  109703. * Binds the material data.
  109704. * @param uniformBuffer defines the Uniform buffer to fill in.
  109705. * @param scene defines the scene the material belongs to.
  109706. * @param isFrozen defines whether the material is frozen or not.
  109707. */
  109708. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  109709. /**
  109710. * Checks to see if a texture is used in the material.
  109711. * @param texture - Base texture to use.
  109712. * @returns - Boolean specifying if a texture is used in the material.
  109713. */
  109714. hasTexture(texture: BaseTexture): boolean;
  109715. /**
  109716. * Returns an array of the actively used textures.
  109717. * @param activeTextures Array of BaseTextures
  109718. */
  109719. getActiveTextures(activeTextures: BaseTexture[]): void;
  109720. /**
  109721. * Returns the animatable textures.
  109722. * @param animatables Array of animatable textures.
  109723. */
  109724. getAnimatables(animatables: IAnimatable[]): void;
  109725. /**
  109726. * Disposes the resources of the material.
  109727. * @param forceDisposeTextures - Forces the disposal of all textures.
  109728. */
  109729. dispose(forceDisposeTextures?: boolean): void;
  109730. /**
  109731. * Get the current class name useful for serialization or dynamic coding.
  109732. * @returns "DetailMap"
  109733. */
  109734. getClassName(): string;
  109735. /**
  109736. * Add the required uniforms to the current list.
  109737. * @param uniforms defines the current uniform list.
  109738. */
  109739. static AddUniforms(uniforms: string[]): void;
  109740. /**
  109741. * Add the required samplers to the current list.
  109742. * @param samplers defines the current sampler list.
  109743. */
  109744. static AddSamplers(samplers: string[]): void;
  109745. /**
  109746. * Add the required uniforms to the current buffer.
  109747. * @param uniformBuffer defines the current uniform buffer.
  109748. */
  109749. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  109750. /**
  109751. * Makes a duplicate of the current instance into another one.
  109752. * @param detailMap define the instance where to copy the info
  109753. */
  109754. copyTo(detailMap: DetailMapConfiguration): void;
  109755. /**
  109756. * Serializes this detail map instance
  109757. * @returns - An object with the serialized instance.
  109758. */
  109759. serialize(): any;
  109760. /**
  109761. * Parses a detail map setting from a serialized object.
  109762. * @param source - Serialized object.
  109763. * @param scene Defines the scene we are parsing for
  109764. * @param rootUrl Defines the rootUrl to load from
  109765. */
  109766. parse(source: any, scene: Scene, rootUrl: string): void;
  109767. }
  109768. }
  109769. declare module BABYLON {
  109770. /** @hidden */
  109771. export class StandardMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines, IMaterialDetailMapDefines {
  109772. MAINUV1: boolean;
  109773. MAINUV2: boolean;
  109774. DIFFUSE: boolean;
  109775. DIFFUSEDIRECTUV: number;
  109776. DETAIL: boolean;
  109777. DETAILDIRECTUV: number;
  109778. DETAIL_NORMALBLENDMETHOD: number;
  109779. AMBIENT: boolean;
  109780. AMBIENTDIRECTUV: number;
  109781. OPACITY: boolean;
  109782. OPACITYDIRECTUV: number;
  109783. OPACITYRGB: boolean;
  109784. REFLECTION: boolean;
  109785. EMISSIVE: boolean;
  109786. EMISSIVEDIRECTUV: number;
  109787. SPECULAR: boolean;
  109788. SPECULARDIRECTUV: number;
  109789. BUMP: boolean;
  109790. BUMPDIRECTUV: number;
  109791. PARALLAX: boolean;
  109792. PARALLAXOCCLUSION: boolean;
  109793. SPECULAROVERALPHA: boolean;
  109794. CLIPPLANE: boolean;
  109795. CLIPPLANE2: boolean;
  109796. CLIPPLANE3: boolean;
  109797. CLIPPLANE4: boolean;
  109798. CLIPPLANE5: boolean;
  109799. CLIPPLANE6: boolean;
  109800. ALPHATEST: boolean;
  109801. DEPTHPREPASS: boolean;
  109802. ALPHAFROMDIFFUSE: boolean;
  109803. POINTSIZE: boolean;
  109804. FOG: boolean;
  109805. SPECULARTERM: boolean;
  109806. DIFFUSEFRESNEL: boolean;
  109807. OPACITYFRESNEL: boolean;
  109808. REFLECTIONFRESNEL: boolean;
  109809. REFRACTIONFRESNEL: boolean;
  109810. EMISSIVEFRESNEL: boolean;
  109811. FRESNEL: boolean;
  109812. NORMAL: boolean;
  109813. UV1: boolean;
  109814. UV2: boolean;
  109815. VERTEXCOLOR: boolean;
  109816. VERTEXALPHA: boolean;
  109817. NUM_BONE_INFLUENCERS: number;
  109818. BonesPerMesh: number;
  109819. BONETEXTURE: boolean;
  109820. INSTANCES: boolean;
  109821. THIN_INSTANCES: boolean;
  109822. GLOSSINESS: boolean;
  109823. ROUGHNESS: boolean;
  109824. EMISSIVEASILLUMINATION: boolean;
  109825. LINKEMISSIVEWITHDIFFUSE: boolean;
  109826. REFLECTIONFRESNELFROMSPECULAR: boolean;
  109827. LIGHTMAP: boolean;
  109828. LIGHTMAPDIRECTUV: number;
  109829. OBJECTSPACE_NORMALMAP: boolean;
  109830. USELIGHTMAPASSHADOWMAP: boolean;
  109831. REFLECTIONMAP_3D: boolean;
  109832. REFLECTIONMAP_SPHERICAL: boolean;
  109833. REFLECTIONMAP_PLANAR: boolean;
  109834. REFLECTIONMAP_CUBIC: boolean;
  109835. USE_LOCAL_REFLECTIONMAP_CUBIC: boolean;
  109836. REFLECTIONMAP_PROJECTION: boolean;
  109837. REFLECTIONMAP_SKYBOX: boolean;
  109838. REFLECTIONMAP_EXPLICIT: boolean;
  109839. REFLECTIONMAP_EQUIRECTANGULAR: boolean;
  109840. REFLECTIONMAP_EQUIRECTANGULAR_FIXED: boolean;
  109841. REFLECTIONMAP_MIRROREDEQUIRECTANGULAR_FIXED: boolean;
  109842. INVERTCUBICMAP: boolean;
  109843. LOGARITHMICDEPTH: boolean;
  109844. REFRACTION: boolean;
  109845. REFRACTIONMAP_3D: boolean;
  109846. REFLECTIONOVERALPHA: boolean;
  109847. TWOSIDEDLIGHTING: boolean;
  109848. SHADOWFLOAT: boolean;
  109849. MORPHTARGETS: boolean;
  109850. MORPHTARGETS_NORMAL: boolean;
  109851. MORPHTARGETS_TANGENT: boolean;
  109852. MORPHTARGETS_UV: boolean;
  109853. NUM_MORPH_INFLUENCERS: number;
  109854. NONUNIFORMSCALING: boolean;
  109855. PREMULTIPLYALPHA: boolean;
  109856. ALPHATEST_AFTERALLALPHACOMPUTATIONS: boolean;
  109857. ALPHABLEND: boolean;
  109858. PREPASS: boolean;
  109859. SCENE_MRT_COUNT: number;
  109860. RGBDLIGHTMAP: boolean;
  109861. RGBDREFLECTION: boolean;
  109862. RGBDREFRACTION: boolean;
  109863. IMAGEPROCESSING: boolean;
  109864. VIGNETTE: boolean;
  109865. VIGNETTEBLENDMODEMULTIPLY: boolean;
  109866. VIGNETTEBLENDMODEOPAQUE: boolean;
  109867. TONEMAPPING: boolean;
  109868. TONEMAPPING_ACES: boolean;
  109869. CONTRAST: boolean;
  109870. COLORCURVES: boolean;
  109871. COLORGRADING: boolean;
  109872. COLORGRADING3D: boolean;
  109873. SAMPLER3DGREENDEPTH: boolean;
  109874. SAMPLER3DBGRMAP: boolean;
  109875. IMAGEPROCESSINGPOSTPROCESS: boolean;
  109876. MULTIVIEW: boolean;
  109877. /**
  109878. * If the reflection texture on this material is in linear color space
  109879. * @hidden
  109880. */
  109881. IS_REFLECTION_LINEAR: boolean;
  109882. /**
  109883. * If the refraction texture on this material is in linear color space
  109884. * @hidden
  109885. */
  109886. IS_REFRACTION_LINEAR: boolean;
  109887. EXPOSURE: boolean;
  109888. constructor();
  109889. setReflectionMode(modeToEnable: string): void;
  109890. }
  109891. /**
  109892. * This is the default material used in Babylon. It is the best trade off between quality
  109893. * and performances.
  109894. * @see https://doc.babylonjs.com/babylon101/materials
  109895. */
  109896. export class StandardMaterial extends PushMaterial {
  109897. private _diffuseTexture;
  109898. /**
  109899. * The basic texture of the material as viewed under a light.
  109900. */
  109901. diffuseTexture: Nullable<BaseTexture>;
  109902. private _ambientTexture;
  109903. /**
  109904. * AKA Occlusion Texture in other nomenclature, it helps adding baked shadows into your material.
  109905. */
  109906. ambientTexture: Nullable<BaseTexture>;
  109907. private _opacityTexture;
  109908. /**
  109909. * Define the transparency of the material from a texture.
  109910. * The final alpha value can be read either from the red channel (if texture.getAlphaFromRGB is false)
  109911. * or from the luminance or the current texel (if texture.getAlphaFromRGB is true)
  109912. */
  109913. opacityTexture: Nullable<BaseTexture>;
  109914. private _reflectionTexture;
  109915. /**
  109916. * Define the texture used to display the reflection.
  109917. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  109918. */
  109919. reflectionTexture: Nullable<BaseTexture>;
  109920. private _emissiveTexture;
  109921. /**
  109922. * Define texture of the material as if self lit.
  109923. * This will be mixed in the final result even in the absence of light.
  109924. */
  109925. emissiveTexture: Nullable<BaseTexture>;
  109926. private _specularTexture;
  109927. /**
  109928. * Define how the color and intensity of the highlight given by the light in the material.
  109929. */
  109930. specularTexture: Nullable<BaseTexture>;
  109931. private _bumpTexture;
  109932. /**
  109933. * Bump mapping is a technique to simulate bump and dents on a rendered surface.
  109934. * 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.
  109935. * @see https://doc.babylonjs.com/how_to/more_materials#bump-map
  109936. */
  109937. bumpTexture: Nullable<BaseTexture>;
  109938. private _lightmapTexture;
  109939. /**
  109940. * Complex lighting can be computationally expensive to compute at runtime.
  109941. * To save on computation, lightmaps may be used to store calculated lighting in a texture which will be applied to a given mesh.
  109942. * @see https://doc.babylonjs.com/babylon101/lights#lightmaps
  109943. */
  109944. lightmapTexture: Nullable<BaseTexture>;
  109945. private _refractionTexture;
  109946. /**
  109947. * Define the texture used to display the refraction.
  109948. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  109949. */
  109950. refractionTexture: Nullable<BaseTexture>;
  109951. /**
  109952. * The color of the material lit by the environmental background lighting.
  109953. * @see https://doc.babylonjs.com/babylon101/materials#ambient-color-example
  109954. */
  109955. ambientColor: Color3;
  109956. /**
  109957. * The basic color of the material as viewed under a light.
  109958. */
  109959. diffuseColor: Color3;
  109960. /**
  109961. * Define how the color and intensity of the highlight given by the light in the material.
  109962. */
  109963. specularColor: Color3;
  109964. /**
  109965. * Define the color of the material as if self lit.
  109966. * This will be mixed in the final result even in the absence of light.
  109967. */
  109968. emissiveColor: Color3;
  109969. /**
  109970. * Defines how sharp are the highlights in the material.
  109971. * The bigger the value the sharper giving a more glossy feeling to the result.
  109972. * Reversely, the smaller the value the blurrier giving a more rough feeling to the result.
  109973. */
  109974. specularPower: number;
  109975. private _useAlphaFromDiffuseTexture;
  109976. /**
  109977. * Does the transparency come from the diffuse texture alpha channel.
  109978. */
  109979. useAlphaFromDiffuseTexture: boolean;
  109980. private _useEmissiveAsIllumination;
  109981. /**
  109982. * If true, the emissive value is added into the end result, otherwise it is multiplied in.
  109983. */
  109984. useEmissiveAsIllumination: boolean;
  109985. private _linkEmissiveWithDiffuse;
  109986. /**
  109987. * If true, some kind of energy conservation will prevent the end result to be more than 1 by reducing
  109988. * the emissive level when the final color is close to one.
  109989. */
  109990. linkEmissiveWithDiffuse: boolean;
  109991. private _useSpecularOverAlpha;
  109992. /**
  109993. * Specifies that the material will keep the specular highlights over a transparent surface (only the most limunous ones).
  109994. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  109995. */
  109996. useSpecularOverAlpha: boolean;
  109997. private _useReflectionOverAlpha;
  109998. /**
  109999. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  110000. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  110001. */
  110002. useReflectionOverAlpha: boolean;
  110003. private _disableLighting;
  110004. /**
  110005. * Does lights from the scene impacts this material.
  110006. * It can be a nice trick for performance to disable lighting on a fully emissive material.
  110007. */
  110008. disableLighting: boolean;
  110009. private _useObjectSpaceNormalMap;
  110010. /**
  110011. * Allows using an object space normal map (instead of tangent space).
  110012. */
  110013. useObjectSpaceNormalMap: boolean;
  110014. private _useParallax;
  110015. /**
  110016. * Is parallax enabled or not.
  110017. * @see https://doc.babylonjs.com/how_to/using_parallax_mapping
  110018. */
  110019. useParallax: boolean;
  110020. private _useParallaxOcclusion;
  110021. /**
  110022. * Is parallax occlusion enabled or not.
  110023. * If true, the outcome is way more realistic than traditional Parallax but you can expect a performance hit that worthes consideration.
  110024. * @see https://doc.babylonjs.com/how_to/using_parallax_mapping
  110025. */
  110026. useParallaxOcclusion: boolean;
  110027. /**
  110028. * 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.
  110029. */
  110030. parallaxScaleBias: number;
  110031. private _roughness;
  110032. /**
  110033. * Helps to define how blurry the reflections should appears in the material.
  110034. */
  110035. roughness: number;
  110036. /**
  110037. * In case of refraction, define the value of the index of refraction.
  110038. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  110039. */
  110040. indexOfRefraction: number;
  110041. /**
  110042. * Invert the refraction texture alongside the y axis.
  110043. * It can be useful with procedural textures or probe for instance.
  110044. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  110045. */
  110046. invertRefractionY: boolean;
  110047. /**
  110048. * Defines the alpha limits in alpha test mode.
  110049. */
  110050. alphaCutOff: number;
  110051. private _useLightmapAsShadowmap;
  110052. /**
  110053. * In case of light mapping, define whether the map contains light or shadow informations.
  110054. */
  110055. useLightmapAsShadowmap: boolean;
  110056. private _diffuseFresnelParameters;
  110057. /**
  110058. * Define the diffuse fresnel parameters of the material.
  110059. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  110060. */
  110061. diffuseFresnelParameters: FresnelParameters;
  110062. private _opacityFresnelParameters;
  110063. /**
  110064. * Define the opacity fresnel parameters of the material.
  110065. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  110066. */
  110067. opacityFresnelParameters: FresnelParameters;
  110068. private _reflectionFresnelParameters;
  110069. /**
  110070. * Define the reflection fresnel parameters of the material.
  110071. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  110072. */
  110073. reflectionFresnelParameters: FresnelParameters;
  110074. private _refractionFresnelParameters;
  110075. /**
  110076. * Define the refraction fresnel parameters of the material.
  110077. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  110078. */
  110079. refractionFresnelParameters: FresnelParameters;
  110080. private _emissiveFresnelParameters;
  110081. /**
  110082. * Define the emissive fresnel parameters of the material.
  110083. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  110084. */
  110085. emissiveFresnelParameters: FresnelParameters;
  110086. private _useReflectionFresnelFromSpecular;
  110087. /**
  110088. * If true automatically deducts the fresnels values from the material specularity.
  110089. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  110090. */
  110091. useReflectionFresnelFromSpecular: boolean;
  110092. private _useGlossinessFromSpecularMapAlpha;
  110093. /**
  110094. * Defines if the glossiness/roughness of the material should be read from the specular map alpha channel
  110095. */
  110096. useGlossinessFromSpecularMapAlpha: boolean;
  110097. private _maxSimultaneousLights;
  110098. /**
  110099. * Defines the maximum number of lights that can be used in the material
  110100. */
  110101. maxSimultaneousLights: number;
  110102. private _invertNormalMapX;
  110103. /**
  110104. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  110105. */
  110106. invertNormalMapX: boolean;
  110107. private _invertNormalMapY;
  110108. /**
  110109. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  110110. */
  110111. invertNormalMapY: boolean;
  110112. private _twoSidedLighting;
  110113. /**
  110114. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  110115. */
  110116. twoSidedLighting: boolean;
  110117. /**
  110118. * Default configuration related to image processing available in the standard Material.
  110119. */
  110120. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  110121. /**
  110122. * Gets the image processing configuration used either in this material.
  110123. */
  110124. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  110125. /**
  110126. * Sets the Default image processing configuration used either in the this material.
  110127. *
  110128. * If sets to null, the scene one is in use.
  110129. */
  110130. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  110131. /**
  110132. * Keep track of the image processing observer to allow dispose and replace.
  110133. */
  110134. private _imageProcessingObserver;
  110135. /**
  110136. * Attaches a new image processing configuration to the Standard Material.
  110137. * @param configuration
  110138. */
  110139. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  110140. /**
  110141. * Gets wether the color curves effect is enabled.
  110142. */
  110143. get cameraColorCurvesEnabled(): boolean;
  110144. /**
  110145. * Sets wether the color curves effect is enabled.
  110146. */
  110147. set cameraColorCurvesEnabled(value: boolean);
  110148. /**
  110149. * Gets wether the color grading effect is enabled.
  110150. */
  110151. get cameraColorGradingEnabled(): boolean;
  110152. /**
  110153. * Gets wether the color grading effect is enabled.
  110154. */
  110155. set cameraColorGradingEnabled(value: boolean);
  110156. /**
  110157. * Gets wether tonemapping is enabled or not.
  110158. */
  110159. get cameraToneMappingEnabled(): boolean;
  110160. /**
  110161. * Sets wether tonemapping is enabled or not
  110162. */
  110163. set cameraToneMappingEnabled(value: boolean);
  110164. /**
  110165. * The camera exposure used on this material.
  110166. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  110167. * This corresponds to a photographic exposure.
  110168. */
  110169. get cameraExposure(): number;
  110170. /**
  110171. * The camera exposure used on this material.
  110172. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  110173. * This corresponds to a photographic exposure.
  110174. */
  110175. set cameraExposure(value: number);
  110176. /**
  110177. * Gets The camera contrast used on this material.
  110178. */
  110179. get cameraContrast(): number;
  110180. /**
  110181. * Sets The camera contrast used on this material.
  110182. */
  110183. set cameraContrast(value: number);
  110184. /**
  110185. * Gets the Color Grading 2D Lookup Texture.
  110186. */
  110187. get cameraColorGradingTexture(): Nullable<BaseTexture>;
  110188. /**
  110189. * Sets the Color Grading 2D Lookup Texture.
  110190. */
  110191. set cameraColorGradingTexture(value: Nullable<BaseTexture>);
  110192. /**
  110193. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  110194. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  110195. * 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;
  110196. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  110197. */
  110198. get cameraColorCurves(): Nullable<ColorCurves>;
  110199. /**
  110200. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  110201. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  110202. * 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;
  110203. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  110204. */
  110205. set cameraColorCurves(value: Nullable<ColorCurves>);
  110206. /**
  110207. * Can this material render to several textures at once
  110208. */
  110209. get canRenderToMRT(): boolean;
  110210. /**
  110211. * Defines the detail map parameters for the material.
  110212. */
  110213. readonly detailMap: DetailMapConfiguration;
  110214. protected _renderTargets: SmartArray<RenderTargetTexture>;
  110215. protected _worldViewProjectionMatrix: Matrix;
  110216. protected _globalAmbientColor: Color3;
  110217. protected _useLogarithmicDepth: boolean;
  110218. protected _rebuildInParallel: boolean;
  110219. /**
  110220. * Instantiates a new standard material.
  110221. * This is the default material used in Babylon. It is the best trade off between quality
  110222. * and performances.
  110223. * @see https://doc.babylonjs.com/babylon101/materials
  110224. * @param name Define the name of the material in the scene
  110225. * @param scene Define the scene the material belong to
  110226. */
  110227. constructor(name: string, scene: Scene);
  110228. /**
  110229. * Gets a boolean indicating that current material needs to register RTT
  110230. */
  110231. get hasRenderTargetTextures(): boolean;
  110232. /**
  110233. * Gets the current class name of the material e.g. "StandardMaterial"
  110234. * Mainly use in serialization.
  110235. * @returns the class name
  110236. */
  110237. getClassName(): string;
  110238. /**
  110239. * In case the depth buffer does not allow enough depth precision for your scene (might be the case in large scenes)
  110240. * You can try switching to logarithmic depth.
  110241. * @see https://doc.babylonjs.com/how_to/using_logarithmic_depth_buffer
  110242. */
  110243. get useLogarithmicDepth(): boolean;
  110244. set useLogarithmicDepth(value: boolean);
  110245. /**
  110246. * Specifies if the material will require alpha blending
  110247. * @returns a boolean specifying if alpha blending is needed
  110248. */
  110249. needAlphaBlending(): boolean;
  110250. /**
  110251. * Specifies if this material should be rendered in alpha test mode
  110252. * @returns a boolean specifying if an alpha test is needed.
  110253. */
  110254. needAlphaTesting(): boolean;
  110255. protected _shouldUseAlphaFromDiffuseTexture(): boolean;
  110256. /**
  110257. * Get the texture used for alpha test purpose.
  110258. * @returns the diffuse texture in case of the standard material.
  110259. */
  110260. getAlphaTestTexture(): Nullable<BaseTexture>;
  110261. /**
  110262. * Get if the submesh is ready to be used and all its information available.
  110263. * Child classes can use it to update shaders
  110264. * @param mesh defines the mesh to check
  110265. * @param subMesh defines which submesh to check
  110266. * @param useInstances specifies that instances should be used
  110267. * @returns a boolean indicating that the submesh is ready or not
  110268. */
  110269. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  110270. /**
  110271. * Builds the material UBO layouts.
  110272. * Used internally during the effect preparation.
  110273. */
  110274. buildUniformLayout(): void;
  110275. /**
  110276. * Unbinds the material from the mesh
  110277. */
  110278. unbind(): void;
  110279. /**
  110280. * Binds the submesh to this material by preparing the effect and shader to draw
  110281. * @param world defines the world transformation matrix
  110282. * @param mesh defines the mesh containing the submesh
  110283. * @param subMesh defines the submesh to bind the material to
  110284. */
  110285. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  110286. /**
  110287. * Get the list of animatables in the material.
  110288. * @returns the list of animatables object used in the material
  110289. */
  110290. getAnimatables(): IAnimatable[];
  110291. /**
  110292. * Gets the active textures from the material
  110293. * @returns an array of textures
  110294. */
  110295. getActiveTextures(): BaseTexture[];
  110296. /**
  110297. * Specifies if the material uses a texture
  110298. * @param texture defines the texture to check against the material
  110299. * @returns a boolean specifying if the material uses the texture
  110300. */
  110301. hasTexture(texture: BaseTexture): boolean;
  110302. /**
  110303. * Disposes the material
  110304. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  110305. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  110306. */
  110307. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  110308. /**
  110309. * Makes a duplicate of the material, and gives it a new name
  110310. * @param name defines the new name for the duplicated material
  110311. * @returns the cloned material
  110312. */
  110313. clone(name: string): StandardMaterial;
  110314. /**
  110315. * Serializes this material in a JSON representation
  110316. * @returns the serialized material object
  110317. */
  110318. serialize(): any;
  110319. /**
  110320. * Creates a standard material from parsed material data
  110321. * @param source defines the JSON representation of the material
  110322. * @param scene defines the hosting scene
  110323. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  110324. * @returns a new standard material
  110325. */
  110326. static Parse(source: any, scene: Scene, rootUrl: string): StandardMaterial;
  110327. /**
  110328. * Are diffuse textures enabled in the application.
  110329. */
  110330. static get DiffuseTextureEnabled(): boolean;
  110331. static set DiffuseTextureEnabled(value: boolean);
  110332. /**
  110333. * Are detail textures enabled in the application.
  110334. */
  110335. static get DetailTextureEnabled(): boolean;
  110336. static set DetailTextureEnabled(value: boolean);
  110337. /**
  110338. * Are ambient textures enabled in the application.
  110339. */
  110340. static get AmbientTextureEnabled(): boolean;
  110341. static set AmbientTextureEnabled(value: boolean);
  110342. /**
  110343. * Are opacity textures enabled in the application.
  110344. */
  110345. static get OpacityTextureEnabled(): boolean;
  110346. static set OpacityTextureEnabled(value: boolean);
  110347. /**
  110348. * Are reflection textures enabled in the application.
  110349. */
  110350. static get ReflectionTextureEnabled(): boolean;
  110351. static set ReflectionTextureEnabled(value: boolean);
  110352. /**
  110353. * Are emissive textures enabled in the application.
  110354. */
  110355. static get EmissiveTextureEnabled(): boolean;
  110356. static set EmissiveTextureEnabled(value: boolean);
  110357. /**
  110358. * Are specular textures enabled in the application.
  110359. */
  110360. static get SpecularTextureEnabled(): boolean;
  110361. static set SpecularTextureEnabled(value: boolean);
  110362. /**
  110363. * Are bump textures enabled in the application.
  110364. */
  110365. static get BumpTextureEnabled(): boolean;
  110366. static set BumpTextureEnabled(value: boolean);
  110367. /**
  110368. * Are lightmap textures enabled in the application.
  110369. */
  110370. static get LightmapTextureEnabled(): boolean;
  110371. static set LightmapTextureEnabled(value: boolean);
  110372. /**
  110373. * Are refraction textures enabled in the application.
  110374. */
  110375. static get RefractionTextureEnabled(): boolean;
  110376. static set RefractionTextureEnabled(value: boolean);
  110377. /**
  110378. * Are color grading textures enabled in the application.
  110379. */
  110380. static get ColorGradingTextureEnabled(): boolean;
  110381. static set ColorGradingTextureEnabled(value: boolean);
  110382. /**
  110383. * Are fresnels enabled in the application.
  110384. */
  110385. static get FresnelEnabled(): boolean;
  110386. static set FresnelEnabled(value: boolean);
  110387. }
  110388. }
  110389. declare module BABYLON {
  110390. /**
  110391. * The SPS is a single updatable mesh. The solid particles are simply separate parts or faces fo this big mesh.
  110392. *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.
  110393. * The SPS is also a particle system. It provides some methods to manage the particles.
  110394. * However it is behavior agnostic. This means it has no emitter, no particle physics, no particle recycler. You have to implement your own behavior.
  110395. *
  110396. * Full documentation here : https://doc.babylonjs.com/how_to/Solid_Particle_System
  110397. */
  110398. export class SolidParticleSystem implements IDisposable {
  110399. /**
  110400. * The SPS array of Solid Particle objects. Just access each particle as with any classic array.
  110401. * Example : var p = SPS.particles[i];
  110402. */
  110403. particles: SolidParticle[];
  110404. /**
  110405. * The SPS total number of particles. Read only. Use SPS.counter instead if you need to set your own value.
  110406. */
  110407. nbParticles: number;
  110408. /**
  110409. * If the particles must ever face the camera (default false). Useful for planar particles.
  110410. */
  110411. billboard: boolean;
  110412. /**
  110413. * Recompute normals when adding a shape
  110414. */
  110415. recomputeNormals: boolean;
  110416. /**
  110417. * This a counter ofr your own usage. It's not set by any SPS functions.
  110418. */
  110419. counter: number;
  110420. /**
  110421. * The SPS name. This name is also given to the underlying mesh.
  110422. */
  110423. name: string;
  110424. /**
  110425. * The SPS mesh. It's a standard BJS Mesh, so all the methods from the Mesh class are avalaible.
  110426. */
  110427. mesh: Mesh;
  110428. /**
  110429. * This empty object is intended to store some SPS specific or temporary values in order to lower the Garbage Collector activity.
  110430. * Please read : https://doc.babylonjs.com/how_to/Solid_Particle_System#garbage-collector-concerns
  110431. */
  110432. vars: any;
  110433. /**
  110434. * This array is populated when the SPS is set as 'pickable'.
  110435. * Each key of this array is a `faceId` value that you can get from a pickResult object.
  110436. * Each element of this array is an object `{idx: int, faceId: int}`.
  110437. * `idx` is the picked particle index in the `SPS.particles` array
  110438. * `faceId` is the picked face index counted within this particle.
  110439. * This array is the first element of the pickedBySubMesh array : sps.pickBySubMesh[0].
  110440. * It's not pertinent to use it when using a SPS with the support for MultiMaterial enabled.
  110441. * Use the method SPS.pickedParticle(pickingInfo) instead.
  110442. * Please read : https://doc.babylonjs.com/how_to/Solid_Particle_System#pickable-particles
  110443. */
  110444. pickedParticles: {
  110445. idx: number;
  110446. faceId: number;
  110447. }[];
  110448. /**
  110449. * This array is populated when the SPS is set as 'pickable'
  110450. * Each key of this array is a submesh index.
  110451. * Each element of this array is a second array defined like this :
  110452. * Each key of this second array is a `faceId` value that you can get from a pickResult object.
  110453. * Each element of this second array is an object `{idx: int, faceId: int}`.
  110454. * `idx` is the picked particle index in the `SPS.particles` array
  110455. * `faceId` is the picked face index counted within this particle.
  110456. * It's better to use the method SPS.pickedParticle(pickingInfo) rather than using directly this array.
  110457. * Please read : https://doc.babylonjs.com/how_to/Solid_Particle_System#pickable-particles
  110458. */
  110459. pickedBySubMesh: {
  110460. idx: number;
  110461. faceId: number;
  110462. }[][];
  110463. /**
  110464. * This array is populated when `enableDepthSort` is set to true.
  110465. * Each element of this array is an instance of the class DepthSortedParticle.
  110466. */
  110467. depthSortedParticles: DepthSortedParticle[];
  110468. /**
  110469. * If the particle intersection must be computed only with the bounding sphere (no bounding box computation, so faster). (Internal use only)
  110470. * @hidden
  110471. */
  110472. _bSphereOnly: boolean;
  110473. /**
  110474. * A number to multiply the boundind sphere radius by in order to reduce it for instance. (Internal use only)
  110475. * @hidden
  110476. */
  110477. _bSphereRadiusFactor: number;
  110478. private _scene;
  110479. private _positions;
  110480. private _indices;
  110481. private _normals;
  110482. private _colors;
  110483. private _uvs;
  110484. private _indices32;
  110485. private _positions32;
  110486. private _normals32;
  110487. private _fixedNormal32;
  110488. private _colors32;
  110489. private _uvs32;
  110490. private _index;
  110491. private _updatable;
  110492. private _pickable;
  110493. private _isVisibilityBoxLocked;
  110494. private _alwaysVisible;
  110495. private _depthSort;
  110496. private _expandable;
  110497. private _shapeCounter;
  110498. private _copy;
  110499. private _color;
  110500. private _computeParticleColor;
  110501. private _computeParticleTexture;
  110502. private _computeParticleRotation;
  110503. private _computeParticleVertex;
  110504. private _computeBoundingBox;
  110505. private _depthSortParticles;
  110506. private _camera;
  110507. private _mustUnrotateFixedNormals;
  110508. private _particlesIntersect;
  110509. private _needs32Bits;
  110510. private _isNotBuilt;
  110511. private _lastParticleId;
  110512. private _idxOfId;
  110513. private _multimaterialEnabled;
  110514. private _useModelMaterial;
  110515. private _indicesByMaterial;
  110516. private _materialIndexes;
  110517. private _depthSortFunction;
  110518. private _materialSortFunction;
  110519. private _materials;
  110520. private _multimaterial;
  110521. private _materialIndexesById;
  110522. private _defaultMaterial;
  110523. private _autoUpdateSubMeshes;
  110524. private _tmpVertex;
  110525. /**
  110526. * Creates a SPS (Solid Particle System) object.
  110527. * @param name (String) is the SPS name, this will be the underlying mesh name.
  110528. * @param scene (Scene) is the scene in which the SPS is added.
  110529. * @param options defines the options of the sps e.g.
  110530. * * updatable (optional boolean, default true) : if the SPS must be updatable or immutable.
  110531. * * isPickable (optional boolean, default false) : if the solid particles must be pickable.
  110532. * * enableDepthSort (optional boolean, default false) : if the solid particles must be sorted in the geometry according to their distance to the camera.
  110533. * * 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.
  110534. * * enableMultiMaterial (optional boolean, default false) : if the solid particles can be given different materials.
  110535. * * expandable (optional boolean, default false) : if particles can still be added after the initial SPS mesh creation.
  110536. * * particleIntersection (optional boolean, default false) : if the solid particle intersections must be computed.
  110537. * * boundingSphereOnly (optional boolean, default false) : if the particle intersection must be computed only with the bounding sphere (no bounding box computation, so faster).
  110538. * * bSphereRadiusFactor (optional float, default 1.0) : a number to multiply the boundind sphere radius by in order to reduce it for instance.
  110539. * @example bSphereRadiusFactor = 1.0 / Math.sqrt(3.0) => the bounding sphere exactly matches a spherical mesh.
  110540. */
  110541. constructor(name: string, scene: Scene, options?: {
  110542. updatable?: boolean;
  110543. isPickable?: boolean;
  110544. enableDepthSort?: boolean;
  110545. particleIntersection?: boolean;
  110546. boundingSphereOnly?: boolean;
  110547. bSphereRadiusFactor?: number;
  110548. expandable?: boolean;
  110549. useModelMaterial?: boolean;
  110550. enableMultiMaterial?: boolean;
  110551. });
  110552. /**
  110553. * Builds the SPS underlying mesh. Returns a standard Mesh.
  110554. * If no model shape was added to the SPS, the returned mesh is just a single triangular plane.
  110555. * @returns the created mesh
  110556. */
  110557. buildMesh(): Mesh;
  110558. /**
  110559. * Digests the mesh and generates as many solid particles in the system as wanted. Returns the SPS.
  110560. * These particles will have the same geometry than the mesh parts and will be positioned at the same localisation than the mesh original places.
  110561. * Thus the particles generated from `digest()` have their property `position` set yet.
  110562. * @param mesh ( Mesh ) is the mesh to be digested
  110563. * @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
  110564. * {delta} (optional integer, default 0) is the random extra number of facets per particle , each particle will have between `facetNb` and `facetNb + delta` facets
  110565. * {number} (optional positive integer) is the wanted number of particles : each particle is built with `mesh_total_facets / number` facets
  110566. * {storage} (optional existing array) is an array where the particles will be stored for a further use instead of being inserted in the SPS.
  110567. * @returns the current SPS
  110568. */
  110569. digest(mesh: Mesh, options?: {
  110570. facetNb?: number;
  110571. number?: number;
  110572. delta?: number;
  110573. storage?: [];
  110574. }): SolidParticleSystem;
  110575. /**
  110576. * Unrotate the fixed normals in case the mesh was built with pre-rotated particles, ex : use of positionFunction in addShape()
  110577. * @hidden
  110578. */
  110579. private _unrotateFixedNormals;
  110580. /**
  110581. * Resets the temporary working copy particle
  110582. * @hidden
  110583. */
  110584. private _resetCopy;
  110585. /**
  110586. * Inserts the shape model geometry in the global SPS mesh by updating the positions, indices, normals, colors, uvs arrays
  110587. * @param p the current index in the positions array to be updated
  110588. * @param ind the current index in the indices array
  110589. * @param shape a Vector3 array, the shape geometry
  110590. * @param positions the positions array to be updated
  110591. * @param meshInd the shape indices array
  110592. * @param indices the indices array to be updated
  110593. * @param meshUV the shape uv array
  110594. * @param uvs the uv array to be updated
  110595. * @param meshCol the shape color array
  110596. * @param colors the color array to be updated
  110597. * @param meshNor the shape normals array
  110598. * @param normals the normals array to be updated
  110599. * @param idx the particle index
  110600. * @param idxInShape the particle index in its shape
  110601. * @param options the addShape() method passed options
  110602. * @model the particle model
  110603. * @hidden
  110604. */
  110605. private _meshBuilder;
  110606. /**
  110607. * Returns a shape Vector3 array from positions float array
  110608. * @param positions float array
  110609. * @returns a vector3 array
  110610. * @hidden
  110611. */
  110612. private _posToShape;
  110613. /**
  110614. * Returns a shapeUV array from a float uvs (array deep copy)
  110615. * @param uvs as a float array
  110616. * @returns a shapeUV array
  110617. * @hidden
  110618. */
  110619. private _uvsToShapeUV;
  110620. /**
  110621. * Adds a new particle object in the particles array
  110622. * @param idx particle index in particles array
  110623. * @param id particle id
  110624. * @param idxpos positionIndex : the starting index of the particle vertices in the SPS "positions" array
  110625. * @param idxind indiceIndex : he starting index of the particle indices in the SPS "indices" array
  110626. * @param model particle ModelShape object
  110627. * @param shapeId model shape identifier
  110628. * @param idxInShape index of the particle in the current model
  110629. * @param bInfo model bounding info object
  110630. * @param storage target storage array, if any
  110631. * @hidden
  110632. */
  110633. private _addParticle;
  110634. /**
  110635. * Adds some particles to the SPS from the model shape. Returns the shape id.
  110636. * Please read the doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#create-an-immutable-sps
  110637. * @param mesh is any Mesh object that will be used as a model for the solid particles.
  110638. * @param nb (positive integer) the number of particles to be created from this model
  110639. * @param options {positionFunction} is an optional javascript function to called for each particle on SPS creation.
  110640. * {vertexFunction} is an optional javascript function to called for each vertex of each particle on SPS creation
  110641. * {storage} (optional existing array) is an array where the particles will be stored for a further use instead of being inserted in the SPS.
  110642. * @returns the number of shapes in the system
  110643. */
  110644. addShape(mesh: Mesh, nb: number, options?: {
  110645. positionFunction?: any;
  110646. vertexFunction?: any;
  110647. storage?: [];
  110648. }): number;
  110649. /**
  110650. * Rebuilds a particle back to its just built status : if needed, recomputes the custom positions and vertices
  110651. * @hidden
  110652. */
  110653. private _rebuildParticle;
  110654. /**
  110655. * Rebuilds the whole mesh and updates the VBO : custom positions and vertices are recomputed if needed.
  110656. * @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.
  110657. * @returns the SPS.
  110658. */
  110659. rebuildMesh(reset?: boolean): SolidParticleSystem;
  110660. /** Removes the particles from the start-th to the end-th included from an expandable SPS (required).
  110661. * Returns an array with the removed particles.
  110662. * 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.
  110663. * The SPS can't be empty so at least one particle needs to remain in place.
  110664. * Under the hood, the VertexData array, so the VBO buffer, is recreated each call.
  110665. * @param start index of the first particle to remove
  110666. * @param end index of the last particle to remove (included)
  110667. * @returns an array populated with the removed particles
  110668. */
  110669. removeParticles(start: number, end: number): SolidParticle[];
  110670. /**
  110671. * Inserts some pre-created particles in the solid particle system so that they can be managed by setParticles().
  110672. * @param solidParticleArray an array populated with Solid Particles objects
  110673. * @returns the SPS
  110674. */
  110675. insertParticlesFromArray(solidParticleArray: SolidParticle[]): SolidParticleSystem;
  110676. /**
  110677. * Creates a new particle and modifies the SPS mesh geometry :
  110678. * - calls _meshBuilder() to increase the SPS mesh geometry step by step
  110679. * - calls _addParticle() to populate the particle array
  110680. * factorized code from addShape() and insertParticlesFromArray()
  110681. * @param idx particle index in the particles array
  110682. * @param i particle index in its shape
  110683. * @param modelShape particle ModelShape object
  110684. * @param shape shape vertex array
  110685. * @param meshInd shape indices array
  110686. * @param meshUV shape uv array
  110687. * @param meshCol shape color array
  110688. * @param meshNor shape normals array
  110689. * @param bbInfo shape bounding info
  110690. * @param storage target particle storage
  110691. * @options addShape() passed options
  110692. * @hidden
  110693. */
  110694. private _insertNewParticle;
  110695. /**
  110696. * Sets all the particles : this method actually really updates the mesh according to the particle positions, rotations, colors, textures, etc.
  110697. * This method calls `updateParticle()` for each particle of the SPS.
  110698. * For an animated SPS, it is usually called within the render loop.
  110699. * 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.
  110700. * @param start The particle index in the particle array where to start to compute the particle property values _(default 0)_
  110701. * @param end The particle index in the particle array where to stop to compute the particle property values _(default nbParticle - 1)_
  110702. * @param update If the mesh must be finally updated on this call after all the particle computations _(default true)_
  110703. * @returns the SPS.
  110704. */
  110705. setParticles(start?: number, end?: number, update?: boolean): SolidParticleSystem;
  110706. /**
  110707. * Disposes the SPS.
  110708. */
  110709. dispose(): void;
  110710. /** Returns an object {idx: numbern faceId: number} for the picked particle from the passed pickingInfo object.
  110711. * idx is the particle index in the SPS
  110712. * faceId is the picked face index counted within this particle.
  110713. * Returns null if the pickInfo can't identify a picked particle.
  110714. * @param pickingInfo (PickingInfo object)
  110715. * @returns {idx: number, faceId: number} or null
  110716. */
  110717. pickedParticle(pickingInfo: PickingInfo): Nullable<{
  110718. idx: number;
  110719. faceId: number;
  110720. }>;
  110721. /**
  110722. * Returns a SolidParticle object from its identifier : particle.id
  110723. * @param id (integer) the particle Id
  110724. * @returns the searched particle or null if not found in the SPS.
  110725. */
  110726. getParticleById(id: number): Nullable<SolidParticle>;
  110727. /**
  110728. * Returns a new array populated with the particles having the passed shapeId.
  110729. * @param shapeId (integer) the shape identifier
  110730. * @returns a new solid particle array
  110731. */
  110732. getParticlesByShapeId(shapeId: number): SolidParticle[];
  110733. /**
  110734. * Populates the passed array "ref" with the particles having the passed shapeId.
  110735. * @param shapeId the shape identifier
  110736. * @returns the SPS
  110737. * @param ref
  110738. */
  110739. getParticlesByShapeIdToRef(shapeId: number, ref: SolidParticle[]): SolidParticleSystem;
  110740. /**
  110741. * Computes the required SubMeshes according the materials assigned to the particles.
  110742. * @returns the solid particle system.
  110743. * Does nothing if called before the SPS mesh is built.
  110744. */
  110745. computeSubMeshes(): SolidParticleSystem;
  110746. /**
  110747. * Sorts the solid particles by material when MultiMaterial is enabled.
  110748. * Updates the indices32 array.
  110749. * Updates the indicesByMaterial array.
  110750. * Updates the mesh indices array.
  110751. * @returns the SPS
  110752. * @hidden
  110753. */
  110754. private _sortParticlesByMaterial;
  110755. /**
  110756. * Sets the material indexes by id materialIndexesById[id] = materialIndex
  110757. * @hidden
  110758. */
  110759. private _setMaterialIndexesById;
  110760. /**
  110761. * Returns an array with unique values of Materials from the passed array
  110762. * @param array the material array to be checked and filtered
  110763. * @hidden
  110764. */
  110765. private _filterUniqueMaterialId;
  110766. /**
  110767. * Sets a new Standard Material as _defaultMaterial if not already set.
  110768. * @hidden
  110769. */
  110770. private _setDefaultMaterial;
  110771. /**
  110772. * Visibilty helper : Recomputes the visible size according to the mesh bounding box
  110773. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  110774. * @returns the SPS.
  110775. */
  110776. refreshVisibleSize(): SolidParticleSystem;
  110777. /**
  110778. * Visibility helper : Sets the size of a visibility box, this sets the underlying mesh bounding box.
  110779. * @param size the size (float) of the visibility box
  110780. * note : this doesn't lock the SPS mesh bounding box.
  110781. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  110782. */
  110783. setVisibilityBox(size: number): void;
  110784. /**
  110785. * Gets whether the SPS as always visible or not
  110786. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  110787. */
  110788. get isAlwaysVisible(): boolean;
  110789. /**
  110790. * Sets the SPS as always visible or not
  110791. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  110792. */
  110793. set isAlwaysVisible(val: boolean);
  110794. /**
  110795. * Sets the SPS visibility box as locked or not. This enables/disables the underlying mesh bounding box updates.
  110796. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  110797. */
  110798. set isVisibilityBoxLocked(val: boolean);
  110799. /**
  110800. * Gets if the SPS visibility box as locked or not. This enables/disables the underlying mesh bounding box updates.
  110801. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  110802. */
  110803. get isVisibilityBoxLocked(): boolean;
  110804. /**
  110805. * Tells to `setParticles()` to compute the particle rotations or not.
  110806. * Default value : true. The SPS is faster when it's set to false.
  110807. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate.
  110808. */
  110809. set computeParticleRotation(val: boolean);
  110810. /**
  110811. * Tells to `setParticles()` to compute the particle colors or not.
  110812. * Default value : true. The SPS is faster when it's set to false.
  110813. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  110814. */
  110815. set computeParticleColor(val: boolean);
  110816. set computeParticleTexture(val: boolean);
  110817. /**
  110818. * Tells to `setParticles()` to call the vertex function for each vertex of each particle, or not.
  110819. * Default value : false. The SPS is faster when it's set to false.
  110820. * Note : the particle custom vertex positions aren't stored values.
  110821. */
  110822. set computeParticleVertex(val: boolean);
  110823. /**
  110824. * Tells to `setParticles()` to compute or not the mesh bounding box when computing the particle positions.
  110825. */
  110826. set computeBoundingBox(val: boolean);
  110827. /**
  110828. * Tells to `setParticles()` to sort or not the distance between each particle and the camera.
  110829. * Skipped when `enableDepthSort` is set to `false` (default) at construction time.
  110830. * Default : `true`
  110831. */
  110832. set depthSortParticles(val: boolean);
  110833. /**
  110834. * Gets if `setParticles()` computes the particle rotations or not.
  110835. * Default value : true. The SPS is faster when it's set to false.
  110836. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate.
  110837. */
  110838. get computeParticleRotation(): boolean;
  110839. /**
  110840. * Gets if `setParticles()` computes the particle colors or not.
  110841. * Default value : true. The SPS is faster when it's set to false.
  110842. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  110843. */
  110844. get computeParticleColor(): boolean;
  110845. /**
  110846. * Gets if `setParticles()` computes the particle textures or not.
  110847. * Default value : true. The SPS is faster when it's set to false.
  110848. * Note : the particle textures are stored values, so setting `computeParticleTexture` to false will keep yet the last colors set.
  110849. */
  110850. get computeParticleTexture(): boolean;
  110851. /**
  110852. * Gets if `setParticles()` calls the vertex function for each vertex of each particle, or not.
  110853. * Default value : false. The SPS is faster when it's set to false.
  110854. * Note : the particle custom vertex positions aren't stored values.
  110855. */
  110856. get computeParticleVertex(): boolean;
  110857. /**
  110858. * Gets if `setParticles()` computes or not the mesh bounding box when computing the particle positions.
  110859. */
  110860. get computeBoundingBox(): boolean;
  110861. /**
  110862. * Gets if `setParticles()` sorts or not the distance between each particle and the camera.
  110863. * Skipped when `enableDepthSort` is set to `false` (default) at construction time.
  110864. * Default : `true`
  110865. */
  110866. get depthSortParticles(): boolean;
  110867. /**
  110868. * Gets if the SPS is created as expandable at construction time.
  110869. * Default : `false`
  110870. */
  110871. get expandable(): boolean;
  110872. /**
  110873. * Gets if the SPS supports the Multi Materials
  110874. */
  110875. get multimaterialEnabled(): boolean;
  110876. /**
  110877. * Gets if the SPS uses the model materials for its own multimaterial.
  110878. */
  110879. get useModelMaterial(): boolean;
  110880. /**
  110881. * The SPS used material array.
  110882. */
  110883. get materials(): Material[];
  110884. /**
  110885. * Sets the SPS MultiMaterial from the passed materials.
  110886. * Note : the passed array is internally copied and not used then by reference.
  110887. * @param materials an array of material objects. This array indexes are the materialIndex values of the particles.
  110888. */
  110889. setMultiMaterial(materials: Material[]): void;
  110890. /**
  110891. * The SPS computed multimaterial object
  110892. */
  110893. get multimaterial(): MultiMaterial;
  110894. set multimaterial(mm: MultiMaterial);
  110895. /**
  110896. * If the subMeshes must be updated on the next call to setParticles()
  110897. */
  110898. get autoUpdateSubMeshes(): boolean;
  110899. set autoUpdateSubMeshes(val: boolean);
  110900. /**
  110901. * This function does nothing. It may be overwritten to set all the particle first values.
  110902. * The SPS doesn't call this function, you may have to call it by your own.
  110903. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  110904. */
  110905. initParticles(): void;
  110906. /**
  110907. * This function does nothing. It may be overwritten to recycle a particle.
  110908. * The SPS doesn't call this function, you may have to call it by your own.
  110909. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  110910. * @param particle The particle to recycle
  110911. * @returns the recycled particle
  110912. */
  110913. recycleParticle(particle: SolidParticle): SolidParticle;
  110914. /**
  110915. * Updates a particle : this function should be overwritten by the user.
  110916. * It is called on each particle by `setParticles()`. This is the place to code each particle behavior.
  110917. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  110918. * @example : just set a particle position or velocity and recycle conditions
  110919. * @param particle The particle to update
  110920. * @returns the updated particle
  110921. */
  110922. updateParticle(particle: SolidParticle): SolidParticle;
  110923. /**
  110924. * Updates a vertex of a particle : it can be overwritten by the user.
  110925. * This will be called on each vertex particle by `setParticles()` if `computeParticleVertex` is set to true only.
  110926. * @param particle the current particle
  110927. * @param vertex the current vertex of the current particle : a SolidParticleVertex object
  110928. * @param pt the index of the current vertex in the particle shape
  110929. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#update-each-particle-shape
  110930. * @example : just set a vertex particle position or color
  110931. * @returns the sps
  110932. */
  110933. updateParticleVertex(particle: SolidParticle, vertex: SolidParticleVertex, pt: number): SolidParticleSystem;
  110934. /**
  110935. * This will be called before any other treatment by `setParticles()` and will be passed three parameters.
  110936. * This does nothing and may be overwritten by the user.
  110937. * @param start the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  110938. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  110939. * @param update the boolean update value actually passed to setParticles()
  110940. */
  110941. beforeUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  110942. /**
  110943. * This will be called by `setParticles()` after all the other treatments and just before the actual mesh update.
  110944. * This will be passed three parameters.
  110945. * This does nothing and may be overwritten by the user.
  110946. * @param start the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  110947. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  110948. * @param update the boolean update value actually passed to setParticles()
  110949. */
  110950. afterUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  110951. }
  110952. }
  110953. declare module BABYLON {
  110954. /**
  110955. * Represents one particle of a solid particle system.
  110956. */
  110957. export class SolidParticle {
  110958. /**
  110959. * particle global index
  110960. */
  110961. idx: number;
  110962. /**
  110963. * particle identifier
  110964. */
  110965. id: number;
  110966. /**
  110967. * The color of the particle
  110968. */
  110969. color: Nullable<Color4>;
  110970. /**
  110971. * The world space position of the particle.
  110972. */
  110973. position: Vector3;
  110974. /**
  110975. * The world space rotation of the particle. (Not use if rotationQuaternion is set)
  110976. */
  110977. rotation: Vector3;
  110978. /**
  110979. * The world space rotation quaternion of the particle.
  110980. */
  110981. rotationQuaternion: Nullable<Quaternion>;
  110982. /**
  110983. * The scaling of the particle.
  110984. */
  110985. scaling: Vector3;
  110986. /**
  110987. * The uvs of the particle.
  110988. */
  110989. uvs: Vector4;
  110990. /**
  110991. * The current speed of the particle.
  110992. */
  110993. velocity: Vector3;
  110994. /**
  110995. * The pivot point in the particle local space.
  110996. */
  110997. pivot: Vector3;
  110998. /**
  110999. * Must the particle be translated from its pivot point in its local space ?
  111000. * In this case, the pivot point is set at the origin of the particle local space and the particle is translated.
  111001. * Default : false
  111002. */
  111003. translateFromPivot: boolean;
  111004. /**
  111005. * Is the particle active or not ?
  111006. */
  111007. alive: boolean;
  111008. /**
  111009. * Is the particle visible or not ?
  111010. */
  111011. isVisible: boolean;
  111012. /**
  111013. * Index of this particle in the global "positions" array (Internal use)
  111014. * @hidden
  111015. */
  111016. _pos: number;
  111017. /**
  111018. * @hidden Index of this particle in the global "indices" array (Internal use)
  111019. */
  111020. _ind: number;
  111021. /**
  111022. * @hidden ModelShape of this particle (Internal use)
  111023. */
  111024. _model: ModelShape;
  111025. /**
  111026. * ModelShape id of this particle
  111027. */
  111028. shapeId: number;
  111029. /**
  111030. * Index of the particle in its shape id
  111031. */
  111032. idxInShape: number;
  111033. /**
  111034. * @hidden Reference to the shape model BoundingInfo object (Internal use)
  111035. */
  111036. _modelBoundingInfo: BoundingInfo;
  111037. /**
  111038. * @hidden Particle BoundingInfo object (Internal use)
  111039. */
  111040. _boundingInfo: BoundingInfo;
  111041. /**
  111042. * @hidden Reference to the SPS what the particle belongs to (Internal use)
  111043. */
  111044. _sps: SolidParticleSystem;
  111045. /**
  111046. * @hidden Still set as invisible in order to skip useless computations (Internal use)
  111047. */
  111048. _stillInvisible: boolean;
  111049. /**
  111050. * @hidden Last computed particle rotation matrix
  111051. */
  111052. _rotationMatrix: number[];
  111053. /**
  111054. * Parent particle Id, if any.
  111055. * Default null.
  111056. */
  111057. parentId: Nullable<number>;
  111058. /**
  111059. * The particle material identifier (integer) when MultiMaterials are enabled in the SPS.
  111060. */
  111061. materialIndex: Nullable<number>;
  111062. /**
  111063. * Custom object or properties.
  111064. */
  111065. props: Nullable<any>;
  111066. /**
  111067. * The culling strategy to use to check whether the solid particle must be culled or not when using isInFrustum().
  111068. * The possible values are :
  111069. * - AbstractMesh.CULLINGSTRATEGY_STANDARD
  111070. * - AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  111071. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION
  111072. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY
  111073. * The default value for solid particles is AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  111074. * Please read each static variable documentation in the class AbstractMesh to get details about the culling process.
  111075. * */
  111076. cullingStrategy: number;
  111077. /**
  111078. * @hidden Internal global position in the SPS.
  111079. */
  111080. _globalPosition: Vector3;
  111081. /**
  111082. * Creates a Solid Particle object.
  111083. * Don't create particles manually, use instead the Solid Particle System internal tools like _addParticle()
  111084. * @param particleIndex (integer) is the particle index in the Solid Particle System pool.
  111085. * @param particleId (integer) is the particle identifier. Unless some particles are removed from the SPS, it's the same value than the particle idx.
  111086. * @param positionIndex (integer) is the starting index of the particle vertices in the SPS "positions" array.
  111087. * @param indiceIndex (integer) is the starting index of the particle indices in the SPS "indices" array.
  111088. * @param model (ModelShape) is a reference to the model shape on what the particle is designed.
  111089. * @param shapeId (integer) is the model shape identifier in the SPS.
  111090. * @param idxInShape (integer) is the index of the particle in the current model (ex: the 10th box of addShape(box, 30))
  111091. * @param sps defines the sps it is associated to
  111092. * @param modelBoundingInfo is the reference to the model BoundingInfo used for intersection computations.
  111093. * @param materialIndex is the particle material identifier (integer) when the MultiMaterials are enabled in the SPS.
  111094. */
  111095. constructor(particleIndex: number, particleId: number, positionIndex: number, indiceIndex: number, model: Nullable<ModelShape>, shapeId: number, idxInShape: number, sps: SolidParticleSystem, modelBoundingInfo?: Nullable<BoundingInfo>, materialIndex?: Nullable<number>);
  111096. /**
  111097. * Copies the particle property values into the existing target : position, rotation, scaling, uvs, colors, pivot, parent, visibility, alive
  111098. * @param target the particle target
  111099. * @returns the current particle
  111100. */
  111101. copyToRef(target: SolidParticle): SolidParticle;
  111102. /**
  111103. * Legacy support, changed scale to scaling
  111104. */
  111105. get scale(): Vector3;
  111106. /**
  111107. * Legacy support, changed scale to scaling
  111108. */
  111109. set scale(scale: Vector3);
  111110. /**
  111111. * Legacy support, changed quaternion to rotationQuaternion
  111112. */
  111113. get quaternion(): Nullable<Quaternion>;
  111114. /**
  111115. * Legacy support, changed quaternion to rotationQuaternion
  111116. */
  111117. set quaternion(q: Nullable<Quaternion>);
  111118. /**
  111119. * Returns a boolean. True if the particle intersects another particle or another mesh, else false.
  111120. * The intersection is computed on the particle bounding sphere and Axis Aligned Bounding Box (AABB)
  111121. * @param target is the object (solid particle or mesh) what the intersection is computed against.
  111122. * @returns true if it intersects
  111123. */
  111124. intersectsMesh(target: Mesh | SolidParticle): boolean;
  111125. /**
  111126. * Returns `true` if the solid particle is within the frustum defined by the passed array of planes.
  111127. * A particle is in the frustum if its bounding box intersects the frustum
  111128. * @param frustumPlanes defines the frustum to test
  111129. * @returns true if the particle is in the frustum planes
  111130. */
  111131. isInFrustum(frustumPlanes: Plane[]): boolean;
  111132. /**
  111133. * get the rotation matrix of the particle
  111134. * @hidden
  111135. */
  111136. getRotationMatrix(m: Matrix): void;
  111137. }
  111138. /**
  111139. * Represents the shape of the model used by one particle of a solid particle system.
  111140. * SPS internal tool, don't use it manually.
  111141. */
  111142. export class ModelShape {
  111143. /**
  111144. * The shape id
  111145. * @hidden
  111146. */
  111147. shapeID: number;
  111148. /**
  111149. * flat array of model positions (internal use)
  111150. * @hidden
  111151. */
  111152. _shape: Vector3[];
  111153. /**
  111154. * flat array of model UVs (internal use)
  111155. * @hidden
  111156. */
  111157. _shapeUV: number[];
  111158. /**
  111159. * color array of the model
  111160. * @hidden
  111161. */
  111162. _shapeColors: number[];
  111163. /**
  111164. * indices array of the model
  111165. * @hidden
  111166. */
  111167. _indices: number[];
  111168. /**
  111169. * normals array of the model
  111170. * @hidden
  111171. */
  111172. _normals: number[];
  111173. /**
  111174. * length of the shape in the model indices array (internal use)
  111175. * @hidden
  111176. */
  111177. _indicesLength: number;
  111178. /**
  111179. * Custom position function (internal use)
  111180. * @hidden
  111181. */
  111182. _positionFunction: Nullable<(particle: SolidParticle, i: number, s: number) => void>;
  111183. /**
  111184. * Custom vertex function (internal use)
  111185. * @hidden
  111186. */
  111187. _vertexFunction: Nullable<(particle: SolidParticle, vertex: Vector3, i: number) => void>;
  111188. /**
  111189. * Model material (internal use)
  111190. * @hidden
  111191. */
  111192. _material: Nullable<Material>;
  111193. /**
  111194. * 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.
  111195. * SPS internal tool, don't use it manually.
  111196. * @hidden
  111197. */
  111198. 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>);
  111199. }
  111200. /**
  111201. * Represents a Depth Sorted Particle in the solid particle system.
  111202. * @hidden
  111203. */
  111204. export class DepthSortedParticle {
  111205. /**
  111206. * Particle index
  111207. */
  111208. idx: number;
  111209. /**
  111210. * Index of the particle in the "indices" array
  111211. */
  111212. ind: number;
  111213. /**
  111214. * Length of the particle shape in the "indices" array
  111215. */
  111216. indicesLength: number;
  111217. /**
  111218. * Squared distance from the particle to the camera
  111219. */
  111220. sqDistance: number;
  111221. /**
  111222. * Material index when used with MultiMaterials
  111223. */
  111224. materialIndex: number;
  111225. /**
  111226. * Creates a new sorted particle
  111227. * @param materialIndex
  111228. */
  111229. constructor(idx: number, ind: number, indLength: number, materialIndex: number);
  111230. }
  111231. /**
  111232. * Represents a solid particle vertex
  111233. */
  111234. export class SolidParticleVertex {
  111235. /**
  111236. * Vertex position
  111237. */
  111238. position: Vector3;
  111239. /**
  111240. * Vertex color
  111241. */
  111242. color: Color4;
  111243. /**
  111244. * Vertex UV
  111245. */
  111246. uv: Vector2;
  111247. /**
  111248. * Creates a new solid particle vertex
  111249. */
  111250. constructor();
  111251. /** Vertex x coordinate */
  111252. get x(): number;
  111253. set x(val: number);
  111254. /** Vertex y coordinate */
  111255. get y(): number;
  111256. set y(val: number);
  111257. /** Vertex z coordinate */
  111258. get z(): number;
  111259. set z(val: number);
  111260. }
  111261. }
  111262. declare module BABYLON {
  111263. /**
  111264. * @hidden
  111265. */
  111266. export class _MeshCollisionData {
  111267. _checkCollisions: boolean;
  111268. _collisionMask: number;
  111269. _collisionGroup: number;
  111270. _surroundingMeshes: Nullable<AbstractMesh[]>;
  111271. _collider: Nullable<Collider>;
  111272. _oldPositionForCollisions: Vector3;
  111273. _diffPositionForCollisions: Vector3;
  111274. _onCollideObserver: Nullable<Observer<AbstractMesh>>;
  111275. _onCollisionPositionChangeObserver: Nullable<Observer<Vector3>>;
  111276. }
  111277. }
  111278. declare module BABYLON {
  111279. /** @hidden */
  111280. class _FacetDataStorage {
  111281. facetPositions: Vector3[];
  111282. facetNormals: Vector3[];
  111283. facetPartitioning: number[][];
  111284. facetNb: number;
  111285. partitioningSubdivisions: number;
  111286. partitioningBBoxRatio: number;
  111287. facetDataEnabled: boolean;
  111288. facetParameters: any;
  111289. bbSize: Vector3;
  111290. subDiv: {
  111291. max: number;
  111292. X: number;
  111293. Y: number;
  111294. Z: number;
  111295. };
  111296. facetDepthSort: boolean;
  111297. facetDepthSortEnabled: boolean;
  111298. depthSortedIndices: IndicesArray;
  111299. depthSortedFacets: {
  111300. ind: number;
  111301. sqDistance: number;
  111302. }[];
  111303. facetDepthSortFunction: (f1: {
  111304. ind: number;
  111305. sqDistance: number;
  111306. }, f2: {
  111307. ind: number;
  111308. sqDistance: number;
  111309. }) => number;
  111310. facetDepthSortFrom: Vector3;
  111311. facetDepthSortOrigin: Vector3;
  111312. invertedMatrix: Matrix;
  111313. }
  111314. /**
  111315. * @hidden
  111316. **/
  111317. class _InternalAbstractMeshDataInfo {
  111318. _hasVertexAlpha: boolean;
  111319. _useVertexColors: boolean;
  111320. _numBoneInfluencers: number;
  111321. _applyFog: boolean;
  111322. _receiveShadows: boolean;
  111323. _facetData: _FacetDataStorage;
  111324. _visibility: number;
  111325. _skeleton: Nullable<Skeleton>;
  111326. _layerMask: number;
  111327. _computeBonesUsingShaders: boolean;
  111328. _isActive: boolean;
  111329. _onlyForInstances: boolean;
  111330. _isActiveIntermediate: boolean;
  111331. _onlyForInstancesIntermediate: boolean;
  111332. _actAsRegularMesh: boolean;
  111333. }
  111334. /**
  111335. * Class used to store all common mesh properties
  111336. */
  111337. export class AbstractMesh extends TransformNode implements IDisposable, ICullable, IGetSetVerticesData {
  111338. /** No occlusion */
  111339. static OCCLUSION_TYPE_NONE: number;
  111340. /** Occlusion set to optimisitic */
  111341. static OCCLUSION_TYPE_OPTIMISTIC: number;
  111342. /** Occlusion set to strict */
  111343. static OCCLUSION_TYPE_STRICT: number;
  111344. /** Use an accurante occlusion algorithm */
  111345. static OCCLUSION_ALGORITHM_TYPE_ACCURATE: number;
  111346. /** Use a conservative occlusion algorithm */
  111347. static OCCLUSION_ALGORITHM_TYPE_CONSERVATIVE: number;
  111348. /** Default culling strategy : this is an exclusion test and it's the more accurate.
  111349. * Test order :
  111350. * Is the bounding sphere outside the frustum ?
  111351. * If not, are the bounding box vertices outside the frustum ?
  111352. * It not, then the cullable object is in the frustum.
  111353. */
  111354. static readonly CULLINGSTRATEGY_STANDARD: number;
  111355. /** Culling strategy : Bounding Sphere Only.
  111356. * This is an exclusion test. It's faster than the standard strategy because the bounding box is not tested.
  111357. * It's also less accurate than the standard because some not visible objects can still be selected.
  111358. * Test : is the bounding sphere outside the frustum ?
  111359. * If not, then the cullable object is in the frustum.
  111360. */
  111361. static readonly CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY: number;
  111362. /** Culling strategy : Optimistic Inclusion.
  111363. * This in an inclusion test first, then the standard exclusion test.
  111364. * This can be faster when a cullable object is expected to be almost always in the camera frustum.
  111365. * 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.
  111366. * Anyway, it's as accurate as the standard strategy.
  111367. * Test :
  111368. * Is the cullable object bounding sphere center in the frustum ?
  111369. * If not, apply the default culling strategy.
  111370. */
  111371. static readonly CULLINGSTRATEGY_OPTIMISTIC_INCLUSION: number;
  111372. /** Culling strategy : Optimistic Inclusion then Bounding Sphere Only.
  111373. * This in an inclusion test first, then the bounding sphere only exclusion test.
  111374. * This can be the fastest test when a cullable object is expected to be almost always in the camera frustum.
  111375. * 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.
  111376. * It's less accurate than the standard strategy and as accurate as the BoundingSphereOnly strategy.
  111377. * Test :
  111378. * Is the cullable object bounding sphere center in the frustum ?
  111379. * If not, apply the Bounding Sphere Only strategy. No Bounding Box is tested here.
  111380. */
  111381. static readonly CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY: number;
  111382. /**
  111383. * No billboard
  111384. */
  111385. static get BILLBOARDMODE_NONE(): number;
  111386. /** Billboard on X axis */
  111387. static get BILLBOARDMODE_X(): number;
  111388. /** Billboard on Y axis */
  111389. static get BILLBOARDMODE_Y(): number;
  111390. /** Billboard on Z axis */
  111391. static get BILLBOARDMODE_Z(): number;
  111392. /** Billboard on all axes */
  111393. static get BILLBOARDMODE_ALL(): number;
  111394. /** Billboard on using position instead of orientation */
  111395. static get BILLBOARDMODE_USE_POSITION(): number;
  111396. /** @hidden */
  111397. _internalAbstractMeshDataInfo: _InternalAbstractMeshDataInfo;
  111398. /**
  111399. * The culling strategy to use to check whether the mesh must be rendered or not.
  111400. * This value can be changed at any time and will be used on the next render mesh selection.
  111401. * The possible values are :
  111402. * - AbstractMesh.CULLINGSTRATEGY_STANDARD
  111403. * - AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  111404. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION
  111405. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY
  111406. * Please read each static variable documentation to get details about the culling process.
  111407. * */
  111408. cullingStrategy: number;
  111409. /**
  111410. * Gets the number of facets in the mesh
  111411. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#what-is-a-mesh-facet
  111412. */
  111413. get facetNb(): number;
  111414. /**
  111415. * Gets or set the number (integer) of subdivisions per axis in the partioning space
  111416. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#tweaking-the-partitioning
  111417. */
  111418. get partitioningSubdivisions(): number;
  111419. set partitioningSubdivisions(nb: number);
  111420. /**
  111421. * The ratio (float) to apply to the bouding box size to set to the partioning space.
  111422. * Ex : 1.01 (default) the partioning space is 1% bigger than the bounding box
  111423. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#tweaking-the-partitioning
  111424. */
  111425. get partitioningBBoxRatio(): number;
  111426. set partitioningBBoxRatio(ratio: number);
  111427. /**
  111428. * Gets or sets a boolean indicating that the facets must be depth sorted on next call to `updateFacetData()`.
  111429. * Works only for updatable meshes.
  111430. * Doesn't work with multi-materials
  111431. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#facet-depth-sort
  111432. */
  111433. get mustDepthSortFacets(): boolean;
  111434. set mustDepthSortFacets(sort: boolean);
  111435. /**
  111436. * The location (Vector3) where the facet depth sort must be computed from.
  111437. * By default, the active camera position.
  111438. * Used only when facet depth sort is enabled
  111439. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#facet-depth-sort
  111440. */
  111441. get facetDepthSortFrom(): Vector3;
  111442. set facetDepthSortFrom(location: Vector3);
  111443. /**
  111444. * gets a boolean indicating if facetData is enabled
  111445. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#what-is-a-mesh-facet
  111446. */
  111447. get isFacetDataEnabled(): boolean;
  111448. /** @hidden */
  111449. _updateNonUniformScalingState(value: boolean): boolean;
  111450. /**
  111451. * An event triggered when this mesh collides with another one
  111452. */
  111453. onCollideObservable: Observable<AbstractMesh>;
  111454. /** Set a function to call when this mesh collides with another one */
  111455. set onCollide(callback: () => void);
  111456. /**
  111457. * An event triggered when the collision's position changes
  111458. */
  111459. onCollisionPositionChangeObservable: Observable<Vector3>;
  111460. /** Set a function to call when the collision's position changes */
  111461. set onCollisionPositionChange(callback: () => void);
  111462. /**
  111463. * An event triggered when material is changed
  111464. */
  111465. onMaterialChangedObservable: Observable<AbstractMesh>;
  111466. /**
  111467. * Gets or sets the orientation for POV movement & rotation
  111468. */
  111469. definedFacingForward: boolean;
  111470. /** @hidden */
  111471. _occlusionQuery: Nullable<WebGLQuery>;
  111472. /** @hidden */
  111473. _renderingGroup: Nullable<RenderingGroup>;
  111474. /**
  111475. * Gets or sets mesh visibility between 0 and 1 (default is 1)
  111476. */
  111477. get visibility(): number;
  111478. /**
  111479. * Gets or sets mesh visibility between 0 and 1 (default is 1)
  111480. */
  111481. set visibility(value: number);
  111482. /** Gets or sets the alpha index used to sort transparent meshes
  111483. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#alpha-index
  111484. */
  111485. alphaIndex: number;
  111486. /**
  111487. * Gets or sets a boolean indicating if the mesh is visible (renderable). Default is true
  111488. */
  111489. isVisible: boolean;
  111490. /**
  111491. * Gets or sets a boolean indicating if the mesh can be picked (by scene.pick for instance or through actions). Default is true
  111492. */
  111493. isPickable: boolean;
  111494. /** Gets or sets a boolean indicating that bounding boxes of subMeshes must be rendered as well (false by default) */
  111495. showSubMeshesBoundingBox: boolean;
  111496. /** Gets or sets a boolean indicating if the mesh must be considered as a ray blocker for lens flares (false by default)
  111497. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  111498. */
  111499. isBlocker: boolean;
  111500. /**
  111501. * Gets or sets a boolean indicating that pointer move events must be supported on this mesh (false by default)
  111502. */
  111503. enablePointerMoveEvents: boolean;
  111504. /**
  111505. * Specifies the rendering group id for this mesh (0 by default)
  111506. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#rendering-groups
  111507. */
  111508. renderingGroupId: number;
  111509. private _material;
  111510. /** Gets or sets current material */
  111511. get material(): Nullable<Material>;
  111512. set material(value: Nullable<Material>);
  111513. /**
  111514. * Gets or sets a boolean indicating that this mesh can receive realtime shadows
  111515. * @see https://doc.babylonjs.com/babylon101/shadows
  111516. */
  111517. get receiveShadows(): boolean;
  111518. set receiveShadows(value: boolean);
  111519. /** Defines color to use when rendering outline */
  111520. outlineColor: Color3;
  111521. /** Define width to use when rendering outline */
  111522. outlineWidth: number;
  111523. /** Defines color to use when rendering overlay */
  111524. overlayColor: Color3;
  111525. /** Defines alpha to use when rendering overlay */
  111526. overlayAlpha: number;
  111527. /** Gets or sets a boolean indicating that this mesh contains vertex color data with alpha values */
  111528. get hasVertexAlpha(): boolean;
  111529. set hasVertexAlpha(value: boolean);
  111530. /** 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) */
  111531. get useVertexColors(): boolean;
  111532. set useVertexColors(value: boolean);
  111533. /**
  111534. * Gets or sets a boolean indicating that bone animations must be computed by the CPU (false by default)
  111535. */
  111536. get computeBonesUsingShaders(): boolean;
  111537. set computeBonesUsingShaders(value: boolean);
  111538. /** Gets or sets the number of allowed bone influences per vertex (4 by default) */
  111539. get numBoneInfluencers(): number;
  111540. set numBoneInfluencers(value: number);
  111541. /** Gets or sets a boolean indicating that this mesh will allow fog to be rendered on it (true by default) */
  111542. get applyFog(): boolean;
  111543. set applyFog(value: boolean);
  111544. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes selection (true by default) */
  111545. useOctreeForRenderingSelection: boolean;
  111546. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes picking (true by default) */
  111547. useOctreeForPicking: boolean;
  111548. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes collision (true by default) */
  111549. useOctreeForCollisions: boolean;
  111550. /**
  111551. * Gets or sets the current layer mask (default is 0x0FFFFFFF)
  111552. * @see https://doc.babylonjs.com/how_to/layermasks_and_multi-cam_textures
  111553. */
  111554. get layerMask(): number;
  111555. set layerMask(value: number);
  111556. /**
  111557. * True if the mesh must be rendered in any case (this will shortcut the frustum clipping phase)
  111558. */
  111559. alwaysSelectAsActiveMesh: boolean;
  111560. /**
  111561. * Gets or sets a boolean indicating that the bounding info does not need to be kept in sync (for performance reason)
  111562. */
  111563. doNotSyncBoundingInfo: boolean;
  111564. /**
  111565. * Gets or sets the current action manager
  111566. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  111567. */
  111568. actionManager: Nullable<AbstractActionManager>;
  111569. private _meshCollisionData;
  111570. /**
  111571. * Gets or sets the ellipsoid used to impersonate this mesh when using collision engine (default is (0.5, 1, 0.5))
  111572. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  111573. */
  111574. ellipsoid: Vector3;
  111575. /**
  111576. * Gets or sets the ellipsoid offset used to impersonate this mesh when using collision engine (default is (0, 0, 0))
  111577. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  111578. */
  111579. ellipsoidOffset: Vector3;
  111580. /**
  111581. * Gets or sets a collision mask used to mask collisions (default is -1).
  111582. * A collision between A and B will happen if A.collisionGroup & b.collisionMask !== 0
  111583. */
  111584. get collisionMask(): number;
  111585. set collisionMask(mask: number);
  111586. /**
  111587. * Gets or sets the current collision group mask (-1 by default).
  111588. * A collision between A and B will happen if A.collisionGroup & b.collisionMask !== 0
  111589. */
  111590. get collisionGroup(): number;
  111591. set collisionGroup(mask: number);
  111592. /**
  111593. * Gets or sets current surrounding meshes (null by default).
  111594. *
  111595. * By default collision detection is tested against every mesh in the scene.
  111596. * It is possible to set surroundingMeshes to a defined list of meshes and then only these specified
  111597. * meshes will be tested for the collision.
  111598. *
  111599. * Note: if set to an empty array no collision will happen when this mesh is moved.
  111600. */
  111601. get surroundingMeshes(): Nullable<AbstractMesh[]>;
  111602. set surroundingMeshes(meshes: Nullable<AbstractMesh[]>);
  111603. /**
  111604. * Defines edge width used when edgesRenderer is enabled
  111605. * @see https://www.babylonjs-playground.com/#10OJSG#13
  111606. */
  111607. edgesWidth: number;
  111608. /**
  111609. * Defines edge color used when edgesRenderer is enabled
  111610. * @see https://www.babylonjs-playground.com/#10OJSG#13
  111611. */
  111612. edgesColor: Color4;
  111613. /** @hidden */
  111614. _edgesRenderer: Nullable<IEdgesRenderer>;
  111615. /** @hidden */
  111616. _masterMesh: Nullable<AbstractMesh>;
  111617. /** @hidden */
  111618. _boundingInfo: Nullable<BoundingInfo>;
  111619. /** @hidden */
  111620. _renderId: number;
  111621. /**
  111622. * Gets or sets the list of subMeshes
  111623. * @see https://doc.babylonjs.com/how_to/multi_materials
  111624. */
  111625. subMeshes: SubMesh[];
  111626. /** @hidden */
  111627. _intersectionsInProgress: AbstractMesh[];
  111628. /** @hidden */
  111629. _unIndexed: boolean;
  111630. /** @hidden */
  111631. _lightSources: Light[];
  111632. /** Gets the list of lights affecting that mesh */
  111633. get lightSources(): Light[];
  111634. /** @hidden */
  111635. get _positions(): Nullable<Vector3[]>;
  111636. /** @hidden */
  111637. _waitingData: {
  111638. lods: Nullable<any>;
  111639. actions: Nullable<any>;
  111640. freezeWorldMatrix: Nullable<boolean>;
  111641. };
  111642. /** @hidden */
  111643. _bonesTransformMatrices: Nullable<Float32Array>;
  111644. /** @hidden */
  111645. _transformMatrixTexture: Nullable<RawTexture>;
  111646. /**
  111647. * Gets or sets a skeleton to apply skining transformations
  111648. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  111649. */
  111650. set skeleton(value: Nullable<Skeleton>);
  111651. get skeleton(): Nullable<Skeleton>;
  111652. /**
  111653. * An event triggered when the mesh is rebuilt.
  111654. */
  111655. onRebuildObservable: Observable<AbstractMesh>;
  111656. /**
  111657. * Creates a new AbstractMesh
  111658. * @param name defines the name of the mesh
  111659. * @param scene defines the hosting scene
  111660. */
  111661. constructor(name: string, scene?: Nullable<Scene>);
  111662. /**
  111663. * Returns the string "AbstractMesh"
  111664. * @returns "AbstractMesh"
  111665. */
  111666. getClassName(): string;
  111667. /**
  111668. * Gets a string representation of the current mesh
  111669. * @param fullDetails defines a boolean indicating if full details must be included
  111670. * @returns a string representation of the current mesh
  111671. */
  111672. toString(fullDetails?: boolean): string;
  111673. /**
  111674. * @hidden
  111675. */
  111676. protected _getEffectiveParent(): Nullable<Node>;
  111677. /** @hidden */
  111678. _getActionManagerForTrigger(trigger?: number, initialCall?: boolean): Nullable<AbstractActionManager>;
  111679. /** @hidden */
  111680. _rebuild(): void;
  111681. /** @hidden */
  111682. _resyncLightSources(): void;
  111683. /** @hidden */
  111684. _resyncLightSource(light: Light): void;
  111685. /** @hidden */
  111686. _unBindEffect(): void;
  111687. /** @hidden */
  111688. _removeLightSource(light: Light, dispose: boolean): void;
  111689. private _markSubMeshesAsDirty;
  111690. /** @hidden */
  111691. _markSubMeshesAsLightDirty(dispose?: boolean): void;
  111692. /** @hidden */
  111693. _markSubMeshesAsAttributesDirty(): void;
  111694. /** @hidden */
  111695. _markSubMeshesAsMiscDirty(): void;
  111696. /**
  111697. * Gets or sets a Vector3 depicting the mesh scaling along each local axis X, Y, Z. Default is (1.0, 1.0, 1.0)
  111698. */
  111699. get scaling(): Vector3;
  111700. set scaling(newScaling: Vector3);
  111701. /**
  111702. * Returns true if the mesh is blocked. Implemented by child classes
  111703. */
  111704. get isBlocked(): boolean;
  111705. /**
  111706. * Returns the mesh itself by default. Implemented by child classes
  111707. * @param camera defines the camera to use to pick the right LOD level
  111708. * @returns the currentAbstractMesh
  111709. */
  111710. getLOD(camera: Camera): Nullable<AbstractMesh>;
  111711. /**
  111712. * Returns 0 by default. Implemented by child classes
  111713. * @returns an integer
  111714. */
  111715. getTotalVertices(): number;
  111716. /**
  111717. * Returns a positive integer : the total number of indices in this mesh geometry.
  111718. * @returns the numner of indices or zero if the mesh has no geometry.
  111719. */
  111720. getTotalIndices(): number;
  111721. /**
  111722. * Returns null by default. Implemented by child classes
  111723. * @returns null
  111724. */
  111725. getIndices(): Nullable<IndicesArray>;
  111726. /**
  111727. * Returns the array of the requested vertex data kind. Implemented by child classes
  111728. * @param kind defines the vertex data kind to use
  111729. * @returns null
  111730. */
  111731. getVerticesData(kind: string): Nullable<FloatArray>;
  111732. /**
  111733. * Sets the vertex data of the mesh geometry for the requested `kind`.
  111734. * If the mesh has no geometry, a new Geometry object is set to the mesh and then passed this vertex data.
  111735. * Note that a new underlying VertexBuffer object is created each call.
  111736. * If the `kind` is the `PositionKind`, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  111737. * @param kind defines vertex data kind:
  111738. * * VertexBuffer.PositionKind
  111739. * * VertexBuffer.UVKind
  111740. * * VertexBuffer.UV2Kind
  111741. * * VertexBuffer.UV3Kind
  111742. * * VertexBuffer.UV4Kind
  111743. * * VertexBuffer.UV5Kind
  111744. * * VertexBuffer.UV6Kind
  111745. * * VertexBuffer.ColorKind
  111746. * * VertexBuffer.MatricesIndicesKind
  111747. * * VertexBuffer.MatricesIndicesExtraKind
  111748. * * VertexBuffer.MatricesWeightsKind
  111749. * * VertexBuffer.MatricesWeightsExtraKind
  111750. * @param data defines the data source
  111751. * @param updatable defines if the data must be flagged as updatable (or static)
  111752. * @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
  111753. * @returns the current mesh
  111754. */
  111755. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  111756. /**
  111757. * Updates the existing vertex data of the mesh geometry for the requested `kind`.
  111758. * If the mesh has no geometry, it is simply returned as it is.
  111759. * @param kind defines vertex data kind:
  111760. * * VertexBuffer.PositionKind
  111761. * * VertexBuffer.UVKind
  111762. * * VertexBuffer.UV2Kind
  111763. * * VertexBuffer.UV3Kind
  111764. * * VertexBuffer.UV4Kind
  111765. * * VertexBuffer.UV5Kind
  111766. * * VertexBuffer.UV6Kind
  111767. * * VertexBuffer.ColorKind
  111768. * * VertexBuffer.MatricesIndicesKind
  111769. * * VertexBuffer.MatricesIndicesExtraKind
  111770. * * VertexBuffer.MatricesWeightsKind
  111771. * * VertexBuffer.MatricesWeightsExtraKind
  111772. * @param data defines the data source
  111773. * @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
  111774. * @param makeItUnique If true, a new global geometry is created from this data and is set to the mesh
  111775. * @returns the current mesh
  111776. */
  111777. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): AbstractMesh;
  111778. /**
  111779. * Sets the mesh indices,
  111780. * If the mesh has no geometry, a new Geometry object is created and set to the mesh.
  111781. * @param indices Expects an array populated with integers or a typed array (Int32Array, Uint32Array, Uint16Array)
  111782. * @param totalVertices Defines the total number of vertices
  111783. * @returns the current mesh
  111784. */
  111785. setIndices(indices: IndicesArray, totalVertices: Nullable<number>): AbstractMesh;
  111786. /**
  111787. * Gets a boolean indicating if specific vertex data is present
  111788. * @param kind defines the vertex data kind to use
  111789. * @returns true is data kind is present
  111790. */
  111791. isVerticesDataPresent(kind: string): boolean;
  111792. /**
  111793. * Returns the mesh BoundingInfo object or creates a new one and returns if it was undefined.
  111794. * Note that it returns a shallow bounding of the mesh (i.e. it does not include children).
  111795. * To get the full bounding of all children, call `getHierarchyBoundingVectors` instead.
  111796. * @returns a BoundingInfo
  111797. */
  111798. getBoundingInfo(): BoundingInfo;
  111799. /**
  111800. * Uniformly scales the mesh to fit inside of a unit cube (1 X 1 X 1 units)
  111801. * @param includeDescendants Use the hierarchy's bounding box instead of the mesh's bounding box. Default is false
  111802. * @param ignoreRotation ignore rotation when computing the scale (ie. object will be axis aligned). Default is false
  111803. * @param predicate predicate that is passed in to getHierarchyBoundingVectors when selecting which object should be included when scaling
  111804. * @returns the current mesh
  111805. */
  111806. normalizeToUnitCube(includeDescendants?: boolean, ignoreRotation?: boolean, predicate?: Nullable<(node: AbstractMesh) => boolean>): AbstractMesh;
  111807. /**
  111808. * Overwrite the current bounding info
  111809. * @param boundingInfo defines the new bounding info
  111810. * @returns the current mesh
  111811. */
  111812. setBoundingInfo(boundingInfo: BoundingInfo): AbstractMesh;
  111813. /** Gets a boolean indicating if this mesh has skinning data and an attached skeleton */
  111814. get useBones(): boolean;
  111815. /** @hidden */
  111816. _preActivate(): void;
  111817. /** @hidden */
  111818. _preActivateForIntermediateRendering(renderId: number): void;
  111819. /** @hidden */
  111820. _activate(renderId: number, intermediateRendering: boolean): boolean;
  111821. /** @hidden */
  111822. _postActivate(): void;
  111823. /** @hidden */
  111824. _freeze(): void;
  111825. /** @hidden */
  111826. _unFreeze(): void;
  111827. /**
  111828. * Gets the current world matrix
  111829. * @returns a Matrix
  111830. */
  111831. getWorldMatrix(): Matrix;
  111832. /** @hidden */
  111833. _getWorldMatrixDeterminant(): number;
  111834. /**
  111835. * Gets a boolean indicating if this mesh is an instance or a regular mesh
  111836. */
  111837. get isAnInstance(): boolean;
  111838. /**
  111839. * Gets a boolean indicating if this mesh has instances
  111840. */
  111841. get hasInstances(): boolean;
  111842. /**
  111843. * Gets a boolean indicating if this mesh has thin instances
  111844. */
  111845. get hasThinInstances(): boolean;
  111846. /**
  111847. * Perform relative position change from the point of view of behind the front of the mesh.
  111848. * This is performed taking into account the meshes current rotation, so you do not have to care.
  111849. * Supports definition of mesh facing forward or backward
  111850. * @param amountRight defines the distance on the right axis
  111851. * @param amountUp defines the distance on the up axis
  111852. * @param amountForward defines the distance on the forward axis
  111853. * @returns the current mesh
  111854. */
  111855. movePOV(amountRight: number, amountUp: number, amountForward: number): AbstractMesh;
  111856. /**
  111857. * Calculate relative position change from the point of view of behind the front of the mesh.
  111858. * This is performed taking into account the meshes current rotation, so you do not have to care.
  111859. * Supports definition of mesh facing forward or backward
  111860. * @param amountRight defines the distance on the right axis
  111861. * @param amountUp defines the distance on the up axis
  111862. * @param amountForward defines the distance on the forward axis
  111863. * @returns the new displacement vector
  111864. */
  111865. calcMovePOV(amountRight: number, amountUp: number, amountForward: number): Vector3;
  111866. /**
  111867. * Perform relative rotation change from the point of view of behind the front of the mesh.
  111868. * Supports definition of mesh facing forward or backward
  111869. * @param flipBack defines the flip
  111870. * @param twirlClockwise defines the twirl
  111871. * @param tiltRight defines the tilt
  111872. * @returns the current mesh
  111873. */
  111874. rotatePOV(flipBack: number, twirlClockwise: number, tiltRight: number): AbstractMesh;
  111875. /**
  111876. * Calculate relative rotation change from the point of view of behind the front of the mesh.
  111877. * Supports definition of mesh facing forward or backward.
  111878. * @param flipBack defines the flip
  111879. * @param twirlClockwise defines the twirl
  111880. * @param tiltRight defines the tilt
  111881. * @returns the new rotation vector
  111882. */
  111883. calcRotatePOV(flipBack: number, twirlClockwise: number, tiltRight: number): Vector3;
  111884. /**
  111885. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  111886. * This means the mesh underlying bounding box and sphere are recomputed.
  111887. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  111888. * @returns the current mesh
  111889. */
  111890. refreshBoundingInfo(applySkeleton?: boolean): AbstractMesh;
  111891. /** @hidden */
  111892. _refreshBoundingInfo(data: Nullable<FloatArray>, bias: Nullable<Vector2>): void;
  111893. /** @hidden */
  111894. _getPositionData(applySkeleton: boolean): Nullable<FloatArray>;
  111895. /** @hidden */
  111896. _updateBoundingInfo(): AbstractMesh;
  111897. /** @hidden */
  111898. _updateSubMeshesBoundingInfo(matrix: DeepImmutable<Matrix>): AbstractMesh;
  111899. /** @hidden */
  111900. protected _afterComputeWorldMatrix(): void;
  111901. /** @hidden */
  111902. get _effectiveMesh(): AbstractMesh;
  111903. /**
  111904. * Returns `true` if the mesh is within the frustum defined by the passed array of planes.
  111905. * A mesh is in the frustum if its bounding box intersects the frustum
  111906. * @param frustumPlanes defines the frustum to test
  111907. * @returns true if the mesh is in the frustum planes
  111908. */
  111909. isInFrustum(frustumPlanes: Plane[]): boolean;
  111910. /**
  111911. * Returns `true` if the mesh is completely in the frustum defined be the passed array of planes.
  111912. * A mesh is completely in the frustum if its bounding box it completely inside the frustum.
  111913. * @param frustumPlanes defines the frustum to test
  111914. * @returns true if the mesh is completely in the frustum planes
  111915. */
  111916. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  111917. /**
  111918. * True if the mesh intersects another mesh or a SolidParticle object
  111919. * @param mesh defines a target mesh or SolidParticle to test
  111920. * @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)
  111921. * @param includeDescendants Can be set to true to test if the mesh defined in parameters intersects with the current mesh or any child meshes
  111922. * @returns true if there is an intersection
  111923. */
  111924. intersectsMesh(mesh: AbstractMesh | SolidParticle, precise?: boolean, includeDescendants?: boolean): boolean;
  111925. /**
  111926. * Returns true if the passed point (Vector3) is inside the mesh bounding box
  111927. * @param point defines the point to test
  111928. * @returns true if there is an intersection
  111929. */
  111930. intersectsPoint(point: Vector3): boolean;
  111931. /**
  111932. * Gets or sets a boolean indicating that this mesh can be used in the collision engine
  111933. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  111934. */
  111935. get checkCollisions(): boolean;
  111936. set checkCollisions(collisionEnabled: boolean);
  111937. /**
  111938. * Gets Collider object used to compute collisions (not physics)
  111939. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  111940. */
  111941. get collider(): Nullable<Collider>;
  111942. /**
  111943. * Move the mesh using collision engine
  111944. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  111945. * @param displacement defines the requested displacement vector
  111946. * @returns the current mesh
  111947. */
  111948. moveWithCollisions(displacement: Vector3): AbstractMesh;
  111949. private _onCollisionPositionChange;
  111950. /** @hidden */
  111951. _collideForSubMesh(subMesh: SubMesh, transformMatrix: Matrix, collider: Collider): AbstractMesh;
  111952. /** @hidden */
  111953. _processCollisionsForSubMeshes(collider: Collider, transformMatrix: Matrix): AbstractMesh;
  111954. /** @hidden */
  111955. _checkCollision(collider: Collider): AbstractMesh;
  111956. /** @hidden */
  111957. _generatePointsArray(): boolean;
  111958. /**
  111959. * Checks if the passed Ray intersects with the mesh
  111960. * @param ray defines the ray to use
  111961. * @param fastCheck defines if fast mode (but less precise) must be used (false by default)
  111962. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  111963. * @param onlyBoundingInfo defines a boolean indicating if picking should only happen using bounding info (false by default)
  111964. * @param worldToUse defines the world matrix to use to get the world coordinate of the intersection point
  111965. * @returns the picking info
  111966. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  111967. */
  111968. intersects(ray: Ray, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate, onlyBoundingInfo?: boolean, worldToUse?: Matrix): PickingInfo;
  111969. /**
  111970. * Clones the current mesh
  111971. * @param name defines the mesh name
  111972. * @param newParent defines the new mesh parent
  111973. * @param doNotCloneChildren defines a boolean indicating that children must not be cloned (false by default)
  111974. * @returns the new mesh
  111975. */
  111976. clone(name: string, newParent: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<AbstractMesh>;
  111977. /**
  111978. * Disposes all the submeshes of the current meshnp
  111979. * @returns the current mesh
  111980. */
  111981. releaseSubMeshes(): AbstractMesh;
  111982. /**
  111983. * Releases resources associated with this abstract mesh.
  111984. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  111985. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  111986. */
  111987. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  111988. /**
  111989. * Adds the passed mesh as a child to the current mesh
  111990. * @param mesh defines the child mesh
  111991. * @returns the current mesh
  111992. */
  111993. addChild(mesh: AbstractMesh): AbstractMesh;
  111994. /**
  111995. * Removes the passed mesh from the current mesh children list
  111996. * @param mesh defines the child mesh
  111997. * @returns the current mesh
  111998. */
  111999. removeChild(mesh: AbstractMesh): AbstractMesh;
  112000. /** @hidden */
  112001. private _initFacetData;
  112002. /**
  112003. * Updates the mesh facetData arrays and the internal partitioning when the mesh is morphed or updated.
  112004. * This method can be called within the render loop.
  112005. * 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
  112006. * @returns the current mesh
  112007. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112008. */
  112009. updateFacetData(): AbstractMesh;
  112010. /**
  112011. * Returns the facetLocalNormals array.
  112012. * The normals are expressed in the mesh local spac
  112013. * @returns an array of Vector3
  112014. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112015. */
  112016. getFacetLocalNormals(): Vector3[];
  112017. /**
  112018. * Returns the facetLocalPositions array.
  112019. * The facet positions are expressed in the mesh local space
  112020. * @returns an array of Vector3
  112021. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112022. */
  112023. getFacetLocalPositions(): Vector3[];
  112024. /**
  112025. * Returns the facetLocalPartioning array
  112026. * @returns an array of array of numbers
  112027. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112028. */
  112029. getFacetLocalPartitioning(): number[][];
  112030. /**
  112031. * Returns the i-th facet position in the world system.
  112032. * This method allocates a new Vector3 per call
  112033. * @param i defines the facet index
  112034. * @returns a new Vector3
  112035. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112036. */
  112037. getFacetPosition(i: number): Vector3;
  112038. /**
  112039. * Sets the reference Vector3 with the i-th facet position in the world system
  112040. * @param i defines the facet index
  112041. * @param ref defines the target vector
  112042. * @returns the current mesh
  112043. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112044. */
  112045. getFacetPositionToRef(i: number, ref: Vector3): AbstractMesh;
  112046. /**
  112047. * Returns the i-th facet normal in the world system.
  112048. * This method allocates a new Vector3 per call
  112049. * @param i defines the facet index
  112050. * @returns a new Vector3
  112051. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112052. */
  112053. getFacetNormal(i: number): Vector3;
  112054. /**
  112055. * Sets the reference Vector3 with the i-th facet normal in the world system
  112056. * @param i defines the facet index
  112057. * @param ref defines the target vector
  112058. * @returns the current mesh
  112059. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112060. */
  112061. getFacetNormalToRef(i: number, ref: Vector3): this;
  112062. /**
  112063. * 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)
  112064. * @param x defines x coordinate
  112065. * @param y defines y coordinate
  112066. * @param z defines z coordinate
  112067. * @returns the array of facet indexes
  112068. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112069. */
  112070. getFacetsAtLocalCoordinates(x: number, y: number, z: number): Nullable<number[]>;
  112071. /**
  112072. * Returns the closest mesh facet index at (x,y,z) World coordinates, null if not found
  112073. * @param projected sets as the (x,y,z) world projection on the facet
  112074. * @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
  112075. * @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
  112076. * @param x defines x coordinate
  112077. * @param y defines y coordinate
  112078. * @param z defines z coordinate
  112079. * @returns the face index if found (or null instead)
  112080. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112081. */
  112082. getClosestFacetAtCoordinates(x: number, y: number, z: number, projected?: Vector3, checkFace?: boolean, facing?: boolean): Nullable<number>;
  112083. /**
  112084. * Returns the closest mesh facet index at (x,y,z) local coordinates, null if not found
  112085. * @param projected sets as the (x,y,z) local projection on the facet
  112086. * @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
  112087. * @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
  112088. * @param x defines x coordinate
  112089. * @param y defines y coordinate
  112090. * @param z defines z coordinate
  112091. * @returns the face index if found (or null instead)
  112092. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112093. */
  112094. getClosestFacetAtLocalCoordinates(x: number, y: number, z: number, projected?: Vector3, checkFace?: boolean, facing?: boolean): Nullable<number>;
  112095. /**
  112096. * Returns the object "parameter" set with all the expected parameters for facetData computation by ComputeNormals()
  112097. * @returns the parameters
  112098. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112099. */
  112100. getFacetDataParameters(): any;
  112101. /**
  112102. * Disables the feature FacetData and frees the related memory
  112103. * @returns the current mesh
  112104. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112105. */
  112106. disableFacetData(): AbstractMesh;
  112107. /**
  112108. * Updates the AbstractMesh indices array
  112109. * @param indices defines the data source
  112110. * @param offset defines the offset in the index buffer where to store the new data (can be null)
  112111. * @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)
  112112. * @returns the current mesh
  112113. */
  112114. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): AbstractMesh;
  112115. /**
  112116. * Creates new normals data for the mesh
  112117. * @param updatable defines if the normal vertex buffer must be flagged as updatable
  112118. * @returns the current mesh
  112119. */
  112120. createNormals(updatable: boolean): AbstractMesh;
  112121. /**
  112122. * Align the mesh with a normal
  112123. * @param normal defines the normal to use
  112124. * @param upDirection can be used to redefined the up vector to use (will use the (0, 1, 0) by default)
  112125. * @returns the current mesh
  112126. */
  112127. alignWithNormal(normal: Vector3, upDirection?: Vector3): AbstractMesh;
  112128. /** @hidden */
  112129. _checkOcclusionQuery(): boolean;
  112130. /**
  112131. * Disables the mesh edge rendering mode
  112132. * @returns the currentAbstractMesh
  112133. */
  112134. disableEdgesRendering(): AbstractMesh;
  112135. /**
  112136. * Enables the edge rendering mode on the mesh.
  112137. * This mode makes the mesh edges visible
  112138. * @param epsilon defines the maximal distance between two angles to detect a face
  112139. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  112140. * @returns the currentAbstractMesh
  112141. * @see https://www.babylonjs-playground.com/#19O9TU#0
  112142. */
  112143. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): AbstractMesh;
  112144. /**
  112145. * This function returns all of the particle systems in the scene that use the mesh as an emitter.
  112146. * @returns an array of particle systems in the scene that use the mesh as an emitter
  112147. */
  112148. getConnectedParticleSystems(): IParticleSystem[];
  112149. }
  112150. }
  112151. declare module BABYLON {
  112152. /**
  112153. * Interface used to define ActionEvent
  112154. */
  112155. export interface IActionEvent {
  112156. /** The mesh or sprite that triggered the action */
  112157. source: any;
  112158. /** The X mouse cursor position at the time of the event */
  112159. pointerX: number;
  112160. /** The Y mouse cursor position at the time of the event */
  112161. pointerY: number;
  112162. /** The mesh that is currently pointed at (can be null) */
  112163. meshUnderPointer: Nullable<AbstractMesh>;
  112164. /** the original (browser) event that triggered the ActionEvent */
  112165. sourceEvent?: any;
  112166. /** additional data for the event */
  112167. additionalData?: any;
  112168. }
  112169. /**
  112170. * ActionEvent is the event being sent when an action is triggered.
  112171. */
  112172. export class ActionEvent implements IActionEvent {
  112173. /** The mesh or sprite that triggered the action */
  112174. source: any;
  112175. /** The X mouse cursor position at the time of the event */
  112176. pointerX: number;
  112177. /** The Y mouse cursor position at the time of the event */
  112178. pointerY: number;
  112179. /** The mesh that is currently pointed at (can be null) */
  112180. meshUnderPointer: Nullable<AbstractMesh>;
  112181. /** the original (browser) event that triggered the ActionEvent */
  112182. sourceEvent?: any;
  112183. /** additional data for the event */
  112184. additionalData?: any;
  112185. /**
  112186. * Creates a new ActionEvent
  112187. * @param source The mesh or sprite that triggered the action
  112188. * @param pointerX The X mouse cursor position at the time of the event
  112189. * @param pointerY The Y mouse cursor position at the time of the event
  112190. * @param meshUnderPointer The mesh that is currently pointed at (can be null)
  112191. * @param sourceEvent the original (browser) event that triggered the ActionEvent
  112192. * @param additionalData additional data for the event
  112193. */
  112194. constructor(
  112195. /** The mesh or sprite that triggered the action */
  112196. source: any,
  112197. /** The X mouse cursor position at the time of the event */
  112198. pointerX: number,
  112199. /** The Y mouse cursor position at the time of the event */
  112200. pointerY: number,
  112201. /** The mesh that is currently pointed at (can be null) */
  112202. meshUnderPointer: Nullable<AbstractMesh>,
  112203. /** the original (browser) event that triggered the ActionEvent */
  112204. sourceEvent?: any,
  112205. /** additional data for the event */
  112206. additionalData?: any);
  112207. /**
  112208. * Helper function to auto-create an ActionEvent from a source mesh.
  112209. * @param source The source mesh that triggered the event
  112210. * @param evt The original (browser) event
  112211. * @param additionalData additional data for the event
  112212. * @returns the new ActionEvent
  112213. */
  112214. static CreateNew(source: AbstractMesh, evt?: Event, additionalData?: any): ActionEvent;
  112215. /**
  112216. * Helper function to auto-create an ActionEvent from a source sprite
  112217. * @param source The source sprite that triggered the event
  112218. * @param scene Scene associated with the sprite
  112219. * @param evt The original (browser) event
  112220. * @param additionalData additional data for the event
  112221. * @returns the new ActionEvent
  112222. */
  112223. static CreateNewFromSprite(source: Sprite, scene: Scene, evt?: Event, additionalData?: any): ActionEvent;
  112224. /**
  112225. * Helper function to auto-create an ActionEvent from a scene. If triggered by a mesh use ActionEvent.CreateNew
  112226. * @param scene the scene where the event occurred
  112227. * @param evt The original (browser) event
  112228. * @returns the new ActionEvent
  112229. */
  112230. static CreateNewFromScene(scene: Scene, evt: Event): ActionEvent;
  112231. /**
  112232. * Helper function to auto-create an ActionEvent from a primitive
  112233. * @param prim defines the target primitive
  112234. * @param pointerPos defines the pointer position
  112235. * @param evt The original (browser) event
  112236. * @param additionalData additional data for the event
  112237. * @returns the new ActionEvent
  112238. */
  112239. static CreateNewFromPrimitive(prim: any, pointerPos: Vector2, evt?: Event, additionalData?: any): ActionEvent;
  112240. }
  112241. }
  112242. declare module BABYLON {
  112243. /**
  112244. * Abstract class used to decouple action Manager from scene and meshes.
  112245. * Do not instantiate.
  112246. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  112247. */
  112248. export abstract class AbstractActionManager implements IDisposable {
  112249. /** Gets the list of active triggers */
  112250. static Triggers: {
  112251. [key: string]: number;
  112252. };
  112253. /** Gets the cursor to use when hovering items */
  112254. hoverCursor: string;
  112255. /** Gets the list of actions */
  112256. actions: IAction[];
  112257. /**
  112258. * Gets or sets a boolean indicating that the manager is recursive meaning that it can trigger action from children
  112259. */
  112260. isRecursive: boolean;
  112261. /**
  112262. * Releases all associated resources
  112263. */
  112264. abstract dispose(): void;
  112265. /**
  112266. * Does this action manager has pointer triggers
  112267. */
  112268. abstract get hasPointerTriggers(): boolean;
  112269. /**
  112270. * Does this action manager has pick triggers
  112271. */
  112272. abstract get hasPickTriggers(): boolean;
  112273. /**
  112274. * Process a specific trigger
  112275. * @param trigger defines the trigger to process
  112276. * @param evt defines the event details to be processed
  112277. */
  112278. abstract processTrigger(trigger: number, evt?: IActionEvent): void;
  112279. /**
  112280. * Does this action manager handles actions of any of the given triggers
  112281. * @param triggers defines the triggers to be tested
  112282. * @return a boolean indicating whether one (or more) of the triggers is handled
  112283. */
  112284. abstract hasSpecificTriggers(triggers: number[]): boolean;
  112285. /**
  112286. * Does this action manager handles actions of any of the given triggers. This function takes two arguments for
  112287. * speed.
  112288. * @param triggerA defines the trigger to be tested
  112289. * @param triggerB defines the trigger to be tested
  112290. * @return a boolean indicating whether one (or more) of the triggers is handled
  112291. */
  112292. abstract hasSpecificTriggers2(triggerA: number, triggerB: number): boolean;
  112293. /**
  112294. * Does this action manager handles actions of a given trigger
  112295. * @param trigger defines the trigger to be tested
  112296. * @param parameterPredicate defines an optional predicate to filter triggers by parameter
  112297. * @return whether the trigger is handled
  112298. */
  112299. abstract hasSpecificTrigger(trigger: number, parameterPredicate?: (parameter: any) => boolean): boolean;
  112300. /**
  112301. * Serialize this manager to a JSON object
  112302. * @param name defines the property name to store this manager
  112303. * @returns a JSON representation of this manager
  112304. */
  112305. abstract serialize(name: string): any;
  112306. /**
  112307. * Registers an action to this action manager
  112308. * @param action defines the action to be registered
  112309. * @return the action amended (prepared) after registration
  112310. */
  112311. abstract registerAction(action: IAction): Nullable<IAction>;
  112312. /**
  112313. * Unregisters an action to this action manager
  112314. * @param action defines the action to be unregistered
  112315. * @return a boolean indicating whether the action has been unregistered
  112316. */
  112317. abstract unregisterAction(action: IAction): Boolean;
  112318. /**
  112319. * Does exist one action manager with at least one trigger
  112320. **/
  112321. static get HasTriggers(): boolean;
  112322. /**
  112323. * Does exist one action manager with at least one pick trigger
  112324. **/
  112325. static get HasPickTriggers(): boolean;
  112326. /**
  112327. * Does exist one action manager that handles actions of a given trigger
  112328. * @param trigger defines the trigger to be tested
  112329. * @return a boolean indicating whether the trigger is handeled by at least one action manager
  112330. **/
  112331. static HasSpecificTrigger(trigger: number): boolean;
  112332. }
  112333. }
  112334. declare module BABYLON {
  112335. /**
  112336. * Defines how a node can be built from a string name.
  112337. */
  112338. export type NodeConstructor = (name: string, scene: Scene, options?: any) => () => Node;
  112339. /**
  112340. * Node is the basic class for all scene objects (Mesh, Light, Camera.)
  112341. */
  112342. export class Node implements IBehaviorAware<Node> {
  112343. /** @hidden */
  112344. static _AnimationRangeFactory: (name: string, from: number, to: number) => AnimationRange;
  112345. private static _NodeConstructors;
  112346. /**
  112347. * Add a new node constructor
  112348. * @param type defines the type name of the node to construct
  112349. * @param constructorFunc defines the constructor function
  112350. */
  112351. static AddNodeConstructor(type: string, constructorFunc: NodeConstructor): void;
  112352. /**
  112353. * Returns a node constructor based on type name
  112354. * @param type defines the type name
  112355. * @param name defines the new node name
  112356. * @param scene defines the hosting scene
  112357. * @param options defines optional options to transmit to constructors
  112358. * @returns the new constructor or null
  112359. */
  112360. static Construct(type: string, name: string, scene: Scene, options?: any): Nullable<() => Node>;
  112361. /**
  112362. * Gets or sets the name of the node
  112363. */
  112364. name: string;
  112365. /**
  112366. * Gets or sets the id of the node
  112367. */
  112368. id: string;
  112369. /**
  112370. * Gets or sets the unique id of the node
  112371. */
  112372. uniqueId: number;
  112373. /**
  112374. * Gets or sets a string used to store user defined state for the node
  112375. */
  112376. state: string;
  112377. /**
  112378. * Gets or sets an object used to store user defined information for the node
  112379. */
  112380. metadata: any;
  112381. /**
  112382. * For internal use only. Please do not use.
  112383. */
  112384. reservedDataStore: any;
  112385. /**
  112386. * List of inspectable custom properties (used by the Inspector)
  112387. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  112388. */
  112389. inspectableCustomProperties: IInspectable[];
  112390. private _doNotSerialize;
  112391. /**
  112392. * Gets or sets a boolean used to define if the node must be serialized
  112393. */
  112394. get doNotSerialize(): boolean;
  112395. set doNotSerialize(value: boolean);
  112396. /** @hidden */
  112397. _isDisposed: boolean;
  112398. /**
  112399. * Gets a list of Animations associated with the node
  112400. */
  112401. animations: Animation[];
  112402. protected _ranges: {
  112403. [name: string]: Nullable<AnimationRange>;
  112404. };
  112405. /**
  112406. * Callback raised when the node is ready to be used
  112407. */
  112408. onReady: Nullable<(node: Node) => void>;
  112409. private _isEnabled;
  112410. private _isParentEnabled;
  112411. private _isReady;
  112412. /** @hidden */
  112413. _currentRenderId: number;
  112414. private _parentUpdateId;
  112415. /** @hidden */
  112416. _childUpdateId: number;
  112417. /** @hidden */
  112418. _waitingParentId: Nullable<string>;
  112419. /** @hidden */
  112420. _scene: Scene;
  112421. /** @hidden */
  112422. _cache: any;
  112423. private _parentNode;
  112424. private _children;
  112425. /** @hidden */
  112426. _worldMatrix: Matrix;
  112427. /** @hidden */
  112428. _worldMatrixDeterminant: number;
  112429. /** @hidden */
  112430. _worldMatrixDeterminantIsDirty: boolean;
  112431. /** @hidden */
  112432. private _sceneRootNodesIndex;
  112433. /**
  112434. * Gets a boolean indicating if the node has been disposed
  112435. * @returns true if the node was disposed
  112436. */
  112437. isDisposed(): boolean;
  112438. /**
  112439. * Gets or sets the parent of the node (without keeping the current position in the scene)
  112440. * @see https://doc.babylonjs.com/how_to/parenting
  112441. */
  112442. set parent(parent: Nullable<Node>);
  112443. get parent(): Nullable<Node>;
  112444. /** @hidden */
  112445. _addToSceneRootNodes(): void;
  112446. /** @hidden */
  112447. _removeFromSceneRootNodes(): void;
  112448. private _animationPropertiesOverride;
  112449. /**
  112450. * Gets or sets the animation properties override
  112451. */
  112452. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  112453. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  112454. /**
  112455. * Gets a string identifying the name of the class
  112456. * @returns "Node" string
  112457. */
  112458. getClassName(): string;
  112459. /** @hidden */
  112460. readonly _isNode: boolean;
  112461. /**
  112462. * An event triggered when the mesh is disposed
  112463. */
  112464. onDisposeObservable: Observable<Node>;
  112465. private _onDisposeObserver;
  112466. /**
  112467. * Sets a callback that will be raised when the node will be disposed
  112468. */
  112469. set onDispose(callback: () => void);
  112470. /**
  112471. * Creates a new Node
  112472. * @param name the name and id to be given to this node
  112473. * @param scene the scene this node will be added to
  112474. */
  112475. constructor(name: string, scene?: Nullable<Scene>);
  112476. /**
  112477. * Gets the scene of the node
  112478. * @returns a scene
  112479. */
  112480. getScene(): Scene;
  112481. /**
  112482. * Gets the engine of the node
  112483. * @returns a Engine
  112484. */
  112485. getEngine(): Engine;
  112486. private _behaviors;
  112487. /**
  112488. * Attach a behavior to the node
  112489. * @see https://doc.babylonjs.com/features/behaviour
  112490. * @param behavior defines the behavior to attach
  112491. * @param attachImmediately defines that the behavior must be attached even if the scene is still loading
  112492. * @returns the current Node
  112493. */
  112494. addBehavior(behavior: Behavior<Node>, attachImmediately?: boolean): Node;
  112495. /**
  112496. * Remove an attached behavior
  112497. * @see https://doc.babylonjs.com/features/behaviour
  112498. * @param behavior defines the behavior to attach
  112499. * @returns the current Node
  112500. */
  112501. removeBehavior(behavior: Behavior<Node>): Node;
  112502. /**
  112503. * Gets the list of attached behaviors
  112504. * @see https://doc.babylonjs.com/features/behaviour
  112505. */
  112506. get behaviors(): Behavior<Node>[];
  112507. /**
  112508. * Gets an attached behavior by name
  112509. * @param name defines the name of the behavior to look for
  112510. * @see https://doc.babylonjs.com/features/behaviour
  112511. * @returns null if behavior was not found else the requested behavior
  112512. */
  112513. getBehaviorByName(name: string): Nullable<Behavior<Node>>;
  112514. /**
  112515. * Returns the latest update of the World matrix
  112516. * @returns a Matrix
  112517. */
  112518. getWorldMatrix(): Matrix;
  112519. /** @hidden */
  112520. _getWorldMatrixDeterminant(): number;
  112521. /**
  112522. * Returns directly the latest state of the mesh World matrix.
  112523. * A Matrix is returned.
  112524. */
  112525. get worldMatrixFromCache(): Matrix;
  112526. /** @hidden */
  112527. _initCache(): void;
  112528. /** @hidden */
  112529. updateCache(force?: boolean): void;
  112530. /** @hidden */
  112531. _getActionManagerForTrigger(trigger?: number, initialCall?: boolean): Nullable<AbstractActionManager>;
  112532. /** @hidden */
  112533. _updateCache(ignoreParentClass?: boolean): void;
  112534. /** @hidden */
  112535. _isSynchronized(): boolean;
  112536. /** @hidden */
  112537. _markSyncedWithParent(): void;
  112538. /** @hidden */
  112539. isSynchronizedWithParent(): boolean;
  112540. /** @hidden */
  112541. isSynchronized(): boolean;
  112542. /**
  112543. * Is this node ready to be used/rendered
  112544. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  112545. * @return true if the node is ready
  112546. */
  112547. isReady(completeCheck?: boolean): boolean;
  112548. /**
  112549. * Is this node enabled?
  112550. * 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
  112551. * @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
  112552. * @return whether this node (and its parent) is enabled
  112553. */
  112554. isEnabled(checkAncestors?: boolean): boolean;
  112555. /** @hidden */
  112556. protected _syncParentEnabledState(): void;
  112557. /**
  112558. * Set the enabled state of this node
  112559. * @param value defines the new enabled state
  112560. */
  112561. setEnabled(value: boolean): void;
  112562. /**
  112563. * Is this node a descendant of the given node?
  112564. * The function will iterate up the hierarchy until the ancestor was found or no more parents defined
  112565. * @param ancestor defines the parent node to inspect
  112566. * @returns a boolean indicating if this node is a descendant of the given node
  112567. */
  112568. isDescendantOf(ancestor: Node): boolean;
  112569. /** @hidden */
  112570. _getDescendants(results: Node[], directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): void;
  112571. /**
  112572. * Will return all nodes that have this node as ascendant
  112573. * @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
  112574. * @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
  112575. * @return all children nodes of all types
  112576. */
  112577. getDescendants(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): Node[];
  112578. /**
  112579. * Get all child-meshes of this node
  112580. * @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)
  112581. * @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
  112582. * @returns an array of AbstractMesh
  112583. */
  112584. getChildMeshes(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): AbstractMesh[];
  112585. /**
  112586. * Get all direct children of this node
  112587. * @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
  112588. * @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)
  112589. * @returns an array of Node
  112590. */
  112591. getChildren(predicate?: (node: Node) => boolean, directDescendantsOnly?: boolean): Node[];
  112592. /** @hidden */
  112593. _setReady(state: boolean): void;
  112594. /**
  112595. * Get an animation by name
  112596. * @param name defines the name of the animation to look for
  112597. * @returns null if not found else the requested animation
  112598. */
  112599. getAnimationByName(name: string): Nullable<Animation>;
  112600. /**
  112601. * Creates an animation range for this node
  112602. * @param name defines the name of the range
  112603. * @param from defines the starting key
  112604. * @param to defines the end key
  112605. */
  112606. createAnimationRange(name: string, from: number, to: number): void;
  112607. /**
  112608. * Delete a specific animation range
  112609. * @param name defines the name of the range to delete
  112610. * @param deleteFrames defines if animation frames from the range must be deleted as well
  112611. */
  112612. deleteAnimationRange(name: string, deleteFrames?: boolean): void;
  112613. /**
  112614. * Get an animation range by name
  112615. * @param name defines the name of the animation range to look for
  112616. * @returns null if not found else the requested animation range
  112617. */
  112618. getAnimationRange(name: string): Nullable<AnimationRange>;
  112619. /**
  112620. * Gets the list of all animation ranges defined on this node
  112621. * @returns an array
  112622. */
  112623. getAnimationRanges(): Nullable<AnimationRange>[];
  112624. /**
  112625. * Will start the animation sequence
  112626. * @param name defines the range frames for animation sequence
  112627. * @param loop defines if the animation should loop (false by default)
  112628. * @param speedRatio defines the speed factor in which to run the animation (1 by default)
  112629. * @param onAnimationEnd defines a function to be executed when the animation ended (undefined by default)
  112630. * @returns the object created for this animation. If range does not exist, it will return null
  112631. */
  112632. beginAnimation(name: string, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void): Nullable<Animatable>;
  112633. /**
  112634. * Serialize animation ranges into a JSON compatible object
  112635. * @returns serialization object
  112636. */
  112637. serializeAnimationRanges(): any;
  112638. /**
  112639. * Computes the world matrix of the node
  112640. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  112641. * @returns the world matrix
  112642. */
  112643. computeWorldMatrix(force?: boolean): Matrix;
  112644. /**
  112645. * Releases resources associated with this node.
  112646. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  112647. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  112648. */
  112649. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  112650. /**
  112651. * Parse animation range data from a serialization object and store them into a given node
  112652. * @param node defines where to store the animation ranges
  112653. * @param parsedNode defines the serialization object to read data from
  112654. * @param scene defines the hosting scene
  112655. */
  112656. static ParseAnimationRanges(node: Node, parsedNode: any, scene: Scene): void;
  112657. /**
  112658. * Return the minimum and maximum world vectors of the entire hierarchy under current node
  112659. * @param includeDescendants Include bounding info from descendants as well (true by default)
  112660. * @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
  112661. * @returns the new bounding vectors
  112662. */
  112663. getHierarchyBoundingVectors(includeDescendants?: boolean, predicate?: Nullable<(abstractMesh: AbstractMesh) => boolean>): {
  112664. min: Vector3;
  112665. max: Vector3;
  112666. };
  112667. }
  112668. }
  112669. declare module BABYLON {
  112670. /**
  112671. * @hidden
  112672. */
  112673. export class _IAnimationState {
  112674. key: number;
  112675. repeatCount: number;
  112676. workValue?: any;
  112677. loopMode?: number;
  112678. offsetValue?: any;
  112679. highLimitValue?: any;
  112680. }
  112681. /**
  112682. * Class used to store any kind of animation
  112683. */
  112684. export class Animation {
  112685. /**Name of the animation */
  112686. name: string;
  112687. /**Property to animate */
  112688. targetProperty: string;
  112689. /**The frames per second of the animation */
  112690. framePerSecond: number;
  112691. /**The data type of the animation */
  112692. dataType: number;
  112693. /**The loop mode of the animation */
  112694. loopMode?: number | undefined;
  112695. /**Specifies if blending should be enabled */
  112696. enableBlending?: boolean | undefined;
  112697. /**
  112698. * Use matrix interpolation instead of using direct key value when animating matrices
  112699. */
  112700. static AllowMatricesInterpolation: boolean;
  112701. /**
  112702. * When matrix interpolation is enabled, this boolean forces the system to use Matrix.DecomposeLerp instead of Matrix.Lerp. Interpolation is more precise but slower
  112703. */
  112704. static AllowMatrixDecomposeForInterpolation: boolean;
  112705. /** Define the Url to load snippets */
  112706. static SnippetUrl: string;
  112707. /** Snippet ID if the animation was created from the snippet server */
  112708. snippetId: string;
  112709. /**
  112710. * Stores the key frames of the animation
  112711. */
  112712. private _keys;
  112713. /**
  112714. * Stores the easing function of the animation
  112715. */
  112716. private _easingFunction;
  112717. /**
  112718. * @hidden Internal use only
  112719. */
  112720. _runtimeAnimations: RuntimeAnimation[];
  112721. /**
  112722. * The set of event that will be linked to this animation
  112723. */
  112724. private _events;
  112725. /**
  112726. * Stores an array of target property paths
  112727. */
  112728. targetPropertyPath: string[];
  112729. /**
  112730. * Stores the blending speed of the animation
  112731. */
  112732. blendingSpeed: number;
  112733. /**
  112734. * Stores the animation ranges for the animation
  112735. */
  112736. private _ranges;
  112737. /**
  112738. * @hidden Internal use
  112739. */
  112740. static _PrepareAnimation(name: string, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction): Nullable<Animation>;
  112741. /**
  112742. * Sets up an animation
  112743. * @param property The property to animate
  112744. * @param animationType The animation type to apply
  112745. * @param framePerSecond The frames per second of the animation
  112746. * @param easingFunction The easing function used in the animation
  112747. * @returns The created animation
  112748. */
  112749. static CreateAnimation(property: string, animationType: number, framePerSecond: number, easingFunction: EasingFunction): Animation;
  112750. /**
  112751. * Create and start an animation on a node
  112752. * @param name defines the name of the global animation that will be run on all nodes
  112753. * @param node defines the root node where the animation will take place
  112754. * @param targetProperty defines property to animate
  112755. * @param framePerSecond defines the number of frame per second yo use
  112756. * @param totalFrame defines the number of frames in total
  112757. * @param from defines the initial value
  112758. * @param to defines the final value
  112759. * @param loopMode defines which loop mode you want to use (off by default)
  112760. * @param easingFunction defines the easing function to use (linear by default)
  112761. * @param onAnimationEnd defines the callback to call when animation end
  112762. * @returns the animatable created for this animation
  112763. */
  112764. static CreateAndStartAnimation(name: string, node: Node, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable>;
  112765. /**
  112766. * Create and start an animation on a node and its descendants
  112767. * @param name defines the name of the global animation that will be run on all nodes
  112768. * @param node defines the root node where the animation will take place
  112769. * @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
  112770. * @param targetProperty defines property to animate
  112771. * @param framePerSecond defines the number of frame per second to use
  112772. * @param totalFrame defines the number of frames in total
  112773. * @param from defines the initial value
  112774. * @param to defines the final value
  112775. * @param loopMode defines which loop mode you want to use (off by default)
  112776. * @param easingFunction defines the easing function to use (linear by default)
  112777. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  112778. * @returns the list of animatables created for all nodes
  112779. * @example https://www.babylonjs-playground.com/#MH0VLI
  112780. */
  112781. 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[]>;
  112782. /**
  112783. * Creates a new animation, merges it with the existing animations and starts it
  112784. * @param name Name of the animation
  112785. * @param node Node which contains the scene that begins the animations
  112786. * @param targetProperty Specifies which property to animate
  112787. * @param framePerSecond The frames per second of the animation
  112788. * @param totalFrame The total number of frames
  112789. * @param from The frame at the beginning of the animation
  112790. * @param to The frame at the end of the animation
  112791. * @param loopMode Specifies the loop mode of the animation
  112792. * @param easingFunction (Optional) The easing function of the animation, which allow custom mathematical formulas for animations
  112793. * @param onAnimationEnd Callback to run once the animation is complete
  112794. * @returns Nullable animation
  112795. */
  112796. static CreateMergeAndStartAnimation(name: string, node: Node, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable>;
  112797. /**
  112798. * Convert the keyframes for all animations belonging to the group to be relative to a given reference frame.
  112799. * @param sourceAnimation defines the Animation containing keyframes to convert
  112800. * @param referenceFrame defines the frame that keyframes in the range will be relative to
  112801. * @param range defines the name of the AnimationRange belonging to the Animation to convert
  112802. * @param cloneOriginal defines whether or not to clone the animation and convert the clone or convert the original animation (default is false)
  112803. * @param clonedName defines the name of the resulting cloned Animation if cloneOriginal is true
  112804. * @returns a new Animation if cloneOriginal is true or the original Animation if cloneOriginal is false
  112805. */
  112806. static MakeAnimationAdditive(sourceAnimation: Animation, referenceFrame?: number, range?: string, cloneOriginal?: boolean, clonedName?: string): Animation;
  112807. /**
  112808. * Transition property of an host to the target Value
  112809. * @param property The property to transition
  112810. * @param targetValue The target Value of the property
  112811. * @param host The object where the property to animate belongs
  112812. * @param scene Scene used to run the animation
  112813. * @param frameRate Framerate (in frame/s) to use
  112814. * @param transition The transition type we want to use
  112815. * @param duration The duration of the animation, in milliseconds
  112816. * @param onAnimationEnd Callback trigger at the end of the animation
  112817. * @returns Nullable animation
  112818. */
  112819. static TransitionTo(property: string, targetValue: any, host: any, scene: Scene, frameRate: number, transition: Animation, duration: number, onAnimationEnd?: Nullable<() => void>): Nullable<Animatable>;
  112820. /**
  112821. * Return the array of runtime animations currently using this animation
  112822. */
  112823. get runtimeAnimations(): RuntimeAnimation[];
  112824. /**
  112825. * Specifies if any of the runtime animations are currently running
  112826. */
  112827. get hasRunningRuntimeAnimations(): boolean;
  112828. /**
  112829. * Initializes the animation
  112830. * @param name Name of the animation
  112831. * @param targetProperty Property to animate
  112832. * @param framePerSecond The frames per second of the animation
  112833. * @param dataType The data type of the animation
  112834. * @param loopMode The loop mode of the animation
  112835. * @param enableBlending Specifies if blending should be enabled
  112836. */
  112837. constructor(
  112838. /**Name of the animation */
  112839. name: string,
  112840. /**Property to animate */
  112841. targetProperty: string,
  112842. /**The frames per second of the animation */
  112843. framePerSecond: number,
  112844. /**The data type of the animation */
  112845. dataType: number,
  112846. /**The loop mode of the animation */
  112847. loopMode?: number | undefined,
  112848. /**Specifies if blending should be enabled */
  112849. enableBlending?: boolean | undefined);
  112850. /**
  112851. * Converts the animation to a string
  112852. * @param fullDetails support for multiple levels of logging within scene loading
  112853. * @returns String form of the animation
  112854. */
  112855. toString(fullDetails?: boolean): string;
  112856. /**
  112857. * Add an event to this animation
  112858. * @param event Event to add
  112859. */
  112860. addEvent(event: AnimationEvent): void;
  112861. /**
  112862. * Remove all events found at the given frame
  112863. * @param frame The frame to remove events from
  112864. */
  112865. removeEvents(frame: number): void;
  112866. /**
  112867. * Retrieves all the events from the animation
  112868. * @returns Events from the animation
  112869. */
  112870. getEvents(): AnimationEvent[];
  112871. /**
  112872. * Creates an animation range
  112873. * @param name Name of the animation range
  112874. * @param from Starting frame of the animation range
  112875. * @param to Ending frame of the animation
  112876. */
  112877. createRange(name: string, from: number, to: number): void;
  112878. /**
  112879. * Deletes an animation range by name
  112880. * @param name Name of the animation range to delete
  112881. * @param deleteFrames Specifies if the key frames for the range should also be deleted (true) or not (false)
  112882. */
  112883. deleteRange(name: string, deleteFrames?: boolean): void;
  112884. /**
  112885. * Gets the animation range by name, or null if not defined
  112886. * @param name Name of the animation range
  112887. * @returns Nullable animation range
  112888. */
  112889. getRange(name: string): Nullable<AnimationRange>;
  112890. /**
  112891. * Gets the key frames from the animation
  112892. * @returns The key frames of the animation
  112893. */
  112894. getKeys(): Array<IAnimationKey>;
  112895. /**
  112896. * Gets the highest frame rate of the animation
  112897. * @returns Highest frame rate of the animation
  112898. */
  112899. getHighestFrame(): number;
  112900. /**
  112901. * Gets the easing function of the animation
  112902. * @returns Easing function of the animation
  112903. */
  112904. getEasingFunction(): IEasingFunction;
  112905. /**
  112906. * Sets the easing function of the animation
  112907. * @param easingFunction A custom mathematical formula for animation
  112908. */
  112909. setEasingFunction(easingFunction: EasingFunction): void;
  112910. /**
  112911. * Interpolates a scalar linearly
  112912. * @param startValue Start value of the animation curve
  112913. * @param endValue End value of the animation curve
  112914. * @param gradient Scalar amount to interpolate
  112915. * @returns Interpolated scalar value
  112916. */
  112917. floatInterpolateFunction(startValue: number, endValue: number, gradient: number): number;
  112918. /**
  112919. * Interpolates a scalar cubically
  112920. * @param startValue Start value of the animation curve
  112921. * @param outTangent End tangent of the animation
  112922. * @param endValue End value of the animation curve
  112923. * @param inTangent Start tangent of the animation curve
  112924. * @param gradient Scalar amount to interpolate
  112925. * @returns Interpolated scalar value
  112926. */
  112927. floatInterpolateFunctionWithTangents(startValue: number, outTangent: number, endValue: number, inTangent: number, gradient: number): number;
  112928. /**
  112929. * Interpolates a quaternion using a spherical linear interpolation
  112930. * @param startValue Start value of the animation curve
  112931. * @param endValue End value of the animation curve
  112932. * @param gradient Scalar amount to interpolate
  112933. * @returns Interpolated quaternion value
  112934. */
  112935. quaternionInterpolateFunction(startValue: Quaternion, endValue: Quaternion, gradient: number): Quaternion;
  112936. /**
  112937. * Interpolates a quaternion cubically
  112938. * @param startValue Start value of the animation curve
  112939. * @param outTangent End tangent of the animation curve
  112940. * @param endValue End value of the animation curve
  112941. * @param inTangent Start tangent of the animation curve
  112942. * @param gradient Scalar amount to interpolate
  112943. * @returns Interpolated quaternion value
  112944. */
  112945. quaternionInterpolateFunctionWithTangents(startValue: Quaternion, outTangent: Quaternion, endValue: Quaternion, inTangent: Quaternion, gradient: number): Quaternion;
  112946. /**
  112947. * Interpolates a Vector3 linearl
  112948. * @param startValue Start value of the animation curve
  112949. * @param endValue End value of the animation curve
  112950. * @param gradient Scalar amount to interpolate
  112951. * @returns Interpolated scalar value
  112952. */
  112953. vector3InterpolateFunction(startValue: Vector3, endValue: Vector3, gradient: number): Vector3;
  112954. /**
  112955. * Interpolates a Vector3 cubically
  112956. * @param startValue Start value of the animation curve
  112957. * @param outTangent End tangent of the animation
  112958. * @param endValue End value of the animation curve
  112959. * @param inTangent Start tangent of the animation curve
  112960. * @param gradient Scalar amount to interpolate
  112961. * @returns InterpolatedVector3 value
  112962. */
  112963. vector3InterpolateFunctionWithTangents(startValue: Vector3, outTangent: Vector3, endValue: Vector3, inTangent: Vector3, gradient: number): Vector3;
  112964. /**
  112965. * Interpolates a Vector2 linearly
  112966. * @param startValue Start value of the animation curve
  112967. * @param endValue End value of the animation curve
  112968. * @param gradient Scalar amount to interpolate
  112969. * @returns Interpolated Vector2 value
  112970. */
  112971. vector2InterpolateFunction(startValue: Vector2, endValue: Vector2, gradient: number): Vector2;
  112972. /**
  112973. * Interpolates a Vector2 cubically
  112974. * @param startValue Start value of the animation curve
  112975. * @param outTangent End tangent of the animation
  112976. * @param endValue End value of the animation curve
  112977. * @param inTangent Start tangent of the animation curve
  112978. * @param gradient Scalar amount to interpolate
  112979. * @returns Interpolated Vector2 value
  112980. */
  112981. vector2InterpolateFunctionWithTangents(startValue: Vector2, outTangent: Vector2, endValue: Vector2, inTangent: Vector2, gradient: number): Vector2;
  112982. /**
  112983. * Interpolates a size linearly
  112984. * @param startValue Start value of the animation curve
  112985. * @param endValue End value of the animation curve
  112986. * @param gradient Scalar amount to interpolate
  112987. * @returns Interpolated Size value
  112988. */
  112989. sizeInterpolateFunction(startValue: Size, endValue: Size, gradient: number): Size;
  112990. /**
  112991. * Interpolates a Color3 linearly
  112992. * @param startValue Start value of the animation curve
  112993. * @param endValue End value of the animation curve
  112994. * @param gradient Scalar amount to interpolate
  112995. * @returns Interpolated Color3 value
  112996. */
  112997. color3InterpolateFunction(startValue: Color3, endValue: Color3, gradient: number): Color3;
  112998. /**
  112999. * Interpolates a Color4 linearly
  113000. * @param startValue Start value of the animation curve
  113001. * @param endValue End value of the animation curve
  113002. * @param gradient Scalar amount to interpolate
  113003. * @returns Interpolated Color3 value
  113004. */
  113005. color4InterpolateFunction(startValue: Color4, endValue: Color4, gradient: number): Color4;
  113006. /**
  113007. * @hidden Internal use only
  113008. */
  113009. _getKeyValue(value: any): any;
  113010. /**
  113011. * @hidden Internal use only
  113012. */
  113013. _interpolate(currentFrame: number, state: _IAnimationState): any;
  113014. /**
  113015. * Defines the function to use to interpolate matrices
  113016. * @param startValue defines the start matrix
  113017. * @param endValue defines the end matrix
  113018. * @param gradient defines the gradient between both matrices
  113019. * @param result defines an optional target matrix where to store the interpolation
  113020. * @returns the interpolated matrix
  113021. */
  113022. matrixInterpolateFunction(startValue: Matrix, endValue: Matrix, gradient: number, result?: Matrix): Matrix;
  113023. /**
  113024. * Makes a copy of the animation
  113025. * @returns Cloned animation
  113026. */
  113027. clone(): Animation;
  113028. /**
  113029. * Sets the key frames of the animation
  113030. * @param values The animation key frames to set
  113031. */
  113032. setKeys(values: Array<IAnimationKey>): void;
  113033. /**
  113034. * Serializes the animation to an object
  113035. * @returns Serialized object
  113036. */
  113037. serialize(): any;
  113038. /**
  113039. * Float animation type
  113040. */
  113041. static readonly ANIMATIONTYPE_FLOAT: number;
  113042. /**
  113043. * Vector3 animation type
  113044. */
  113045. static readonly ANIMATIONTYPE_VECTOR3: number;
  113046. /**
  113047. * Quaternion animation type
  113048. */
  113049. static readonly ANIMATIONTYPE_QUATERNION: number;
  113050. /**
  113051. * Matrix animation type
  113052. */
  113053. static readonly ANIMATIONTYPE_MATRIX: number;
  113054. /**
  113055. * Color3 animation type
  113056. */
  113057. static readonly ANIMATIONTYPE_COLOR3: number;
  113058. /**
  113059. * Color3 animation type
  113060. */
  113061. static readonly ANIMATIONTYPE_COLOR4: number;
  113062. /**
  113063. * Vector2 animation type
  113064. */
  113065. static readonly ANIMATIONTYPE_VECTOR2: number;
  113066. /**
  113067. * Size animation type
  113068. */
  113069. static readonly ANIMATIONTYPE_SIZE: number;
  113070. /**
  113071. * Relative Loop Mode
  113072. */
  113073. static readonly ANIMATIONLOOPMODE_RELATIVE: number;
  113074. /**
  113075. * Cycle Loop Mode
  113076. */
  113077. static readonly ANIMATIONLOOPMODE_CYCLE: number;
  113078. /**
  113079. * Constant Loop Mode
  113080. */
  113081. static readonly ANIMATIONLOOPMODE_CONSTANT: number;
  113082. /** @hidden */
  113083. static _UniversalLerp(left: any, right: any, amount: number): any;
  113084. /**
  113085. * Parses an animation object and creates an animation
  113086. * @param parsedAnimation Parsed animation object
  113087. * @returns Animation object
  113088. */
  113089. static Parse(parsedAnimation: any): Animation;
  113090. /**
  113091. * Appends the serialized animations from the source animations
  113092. * @param source Source containing the animations
  113093. * @param destination Target to store the animations
  113094. */
  113095. static AppendSerializedAnimations(source: IAnimatable, destination: any): void;
  113096. /**
  113097. * Creates a new animation or an array of animations from a snippet saved in a remote file
  113098. * @param name defines the name of the animation to create (can be null or empty to use the one from the json data)
  113099. * @param url defines the url to load from
  113100. * @returns a promise that will resolve to the new animation or an array of animations
  113101. */
  113102. static ParseFromFileAsync(name: Nullable<string>, url: string): Promise<Animation | Array<Animation>>;
  113103. /**
  113104. * Creates an animation or an array of animations from a snippet saved by the Inspector
  113105. * @param snippetId defines the snippet to load
  113106. * @returns a promise that will resolve to the new animation or a new array of animations
  113107. */
  113108. static CreateFromSnippetAsync(snippetId: string): Promise<Animation | Array<Animation>>;
  113109. }
  113110. }
  113111. declare module BABYLON {
  113112. /**
  113113. * Interface containing an array of animations
  113114. */
  113115. export interface IAnimatable {
  113116. /**
  113117. * Array of animations
  113118. */
  113119. animations: Nullable<Array<Animation>>;
  113120. }
  113121. }
  113122. declare module BABYLON {
  113123. export function expandToProperty(callback: string, targetKey?: Nullable<string>): (target: any, propertyKey: string) => void;
  113124. export function serialize(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113125. export function serializeAsTexture(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113126. export function serializeAsColor3(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113127. export function serializeAsFresnelParameters(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113128. export function serializeAsVector2(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113129. export function serializeAsVector3(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113130. export function serializeAsMeshReference(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113131. export function serializeAsColorCurves(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113132. export function serializeAsColor4(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113133. export function serializeAsImageProcessingConfiguration(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113134. export function serializeAsQuaternion(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113135. export function serializeAsMatrix(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113136. /**
  113137. * Decorator used to define property that can be serialized as reference to a camera
  113138. * @param sourceName defines the name of the property to decorate
  113139. */
  113140. export function serializeAsCameraReference(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113141. /**
  113142. * Class used to help serialization objects
  113143. */
  113144. export class SerializationHelper {
  113145. /** @hidden */
  113146. static _ImageProcessingConfigurationParser: (sourceProperty: any) => ImageProcessingConfiguration;
  113147. /** @hidden */
  113148. static _FresnelParametersParser: (sourceProperty: any) => FresnelParameters;
  113149. /** @hidden */
  113150. static _ColorCurvesParser: (sourceProperty: any) => ColorCurves;
  113151. /** @hidden */
  113152. static _TextureParser: (sourceProperty: any, scene: Scene, rootUrl: string) => Nullable<BaseTexture>;
  113153. /**
  113154. * Appends the serialized animations from the source animations
  113155. * @param source Source containing the animations
  113156. * @param destination Target to store the animations
  113157. */
  113158. static AppendSerializedAnimations(source: IAnimatable, destination: any): void;
  113159. /**
  113160. * Static function used to serialized a specific entity
  113161. * @param entity defines the entity to serialize
  113162. * @param serializationObject defines the optional target obecjt where serialization data will be stored
  113163. * @returns a JSON compatible object representing the serialization of the entity
  113164. */
  113165. static Serialize<T>(entity: T, serializationObject?: any): any;
  113166. /**
  113167. * Creates a new entity from a serialization data object
  113168. * @param creationFunction defines a function used to instanciated the new entity
  113169. * @param source defines the source serialization data
  113170. * @param scene defines the hosting scene
  113171. * @param rootUrl defines the root url for resources
  113172. * @returns a new entity
  113173. */
  113174. static Parse<T>(creationFunction: () => T, source: any, scene: Nullable<Scene>, rootUrl?: Nullable<string>): T;
  113175. /**
  113176. * Clones an object
  113177. * @param creationFunction defines the function used to instanciate the new object
  113178. * @param source defines the source object
  113179. * @returns the cloned object
  113180. */
  113181. static Clone<T>(creationFunction: () => T, source: T): T;
  113182. /**
  113183. * Instanciates a new object based on a source one (some data will be shared between both object)
  113184. * @param creationFunction defines the function used to instanciate the new object
  113185. * @param source defines the source object
  113186. * @returns the new object
  113187. */
  113188. static Instanciate<T>(creationFunction: () => T, source: T): T;
  113189. }
  113190. }
  113191. declare module BABYLON {
  113192. /**
  113193. * Base class of all the textures in babylon.
  113194. * It groups all the common properties the materials, post process, lights... might need
  113195. * in order to make a correct use of the texture.
  113196. */
  113197. export class BaseTexture implements IAnimatable {
  113198. /**
  113199. * Default anisotropic filtering level for the application.
  113200. * It is set to 4 as a good tradeoff between perf and quality.
  113201. */
  113202. static DEFAULT_ANISOTROPIC_FILTERING_LEVEL: number;
  113203. /**
  113204. * Gets or sets the unique id of the texture
  113205. */
  113206. uniqueId: number;
  113207. /**
  113208. * Define the name of the texture.
  113209. */
  113210. name: string;
  113211. /**
  113212. * Gets or sets an object used to store user defined information.
  113213. */
  113214. metadata: any;
  113215. /**
  113216. * For internal use only. Please do not use.
  113217. */
  113218. reservedDataStore: any;
  113219. private _hasAlpha;
  113220. /**
  113221. * Define if the texture is having a usable alpha value (can be use for transparency or glossiness for instance).
  113222. */
  113223. set hasAlpha(value: boolean);
  113224. get hasAlpha(): boolean;
  113225. /**
  113226. * Defines if the alpha value should be determined via the rgb values.
  113227. * If true the luminance of the pixel might be used to find the corresponding alpha value.
  113228. */
  113229. getAlphaFromRGB: boolean;
  113230. /**
  113231. * Intensity or strength of the texture.
  113232. * It is commonly used by materials to fine tune the intensity of the texture
  113233. */
  113234. level: number;
  113235. /**
  113236. * Define the UV chanel to use starting from 0 and defaulting to 0.
  113237. * This is part of the texture as textures usually maps to one uv set.
  113238. */
  113239. coordinatesIndex: number;
  113240. private _coordinatesMode;
  113241. /**
  113242. * How a texture is mapped.
  113243. *
  113244. * | Value | Type | Description |
  113245. * | ----- | ----------------------------------- | ----------- |
  113246. * | 0 | EXPLICIT_MODE | |
  113247. * | 1 | SPHERICAL_MODE | |
  113248. * | 2 | PLANAR_MODE | |
  113249. * | 3 | CUBIC_MODE | |
  113250. * | 4 | PROJECTION_MODE | |
  113251. * | 5 | SKYBOX_MODE | |
  113252. * | 6 | INVCUBIC_MODE | |
  113253. * | 7 | EQUIRECTANGULAR_MODE | |
  113254. * | 8 | FIXED_EQUIRECTANGULAR_MODE | |
  113255. * | 9 | FIXED_EQUIRECTANGULAR_MIRRORED_MODE | |
  113256. */
  113257. set coordinatesMode(value: number);
  113258. get coordinatesMode(): number;
  113259. /**
  113260. * | Value | Type | Description |
  113261. * | ----- | ------------------ | ----------- |
  113262. * | 0 | CLAMP_ADDRESSMODE | |
  113263. * | 1 | WRAP_ADDRESSMODE | |
  113264. * | 2 | MIRROR_ADDRESSMODE | |
  113265. */
  113266. wrapU: number;
  113267. /**
  113268. * | Value | Type | Description |
  113269. * | ----- | ------------------ | ----------- |
  113270. * | 0 | CLAMP_ADDRESSMODE | |
  113271. * | 1 | WRAP_ADDRESSMODE | |
  113272. * | 2 | MIRROR_ADDRESSMODE | |
  113273. */
  113274. wrapV: number;
  113275. /**
  113276. * | Value | Type | Description |
  113277. * | ----- | ------------------ | ----------- |
  113278. * | 0 | CLAMP_ADDRESSMODE | |
  113279. * | 1 | WRAP_ADDRESSMODE | |
  113280. * | 2 | MIRROR_ADDRESSMODE | |
  113281. */
  113282. wrapR: number;
  113283. /**
  113284. * With compliant hardware and browser (supporting anisotropic filtering)
  113285. * this defines the level of anisotropic filtering in the texture.
  113286. * The higher the better but the slower. This defaults to 4 as it seems to be the best tradeoff.
  113287. */
  113288. anisotropicFilteringLevel: number;
  113289. /**
  113290. * Define if the texture is a cube texture or if false a 2d texture.
  113291. */
  113292. get isCube(): boolean;
  113293. set isCube(value: boolean);
  113294. /**
  113295. * Define if the texture is a 3d texture (webgl 2) or if false a 2d texture.
  113296. */
  113297. get is3D(): boolean;
  113298. set is3D(value: boolean);
  113299. /**
  113300. * Define if the texture is a 2d array texture (webgl 2) or if false a 2d texture.
  113301. */
  113302. get is2DArray(): boolean;
  113303. set is2DArray(value: boolean);
  113304. /**
  113305. * Define if the texture contains data in gamma space (most of the png/jpg aside bump).
  113306. * HDR texture are usually stored in linear space.
  113307. * This only impacts the PBR and Background materials
  113308. */
  113309. gammaSpace: boolean;
  113310. /**
  113311. * Gets or sets whether or not the texture contains RGBD data.
  113312. */
  113313. get isRGBD(): boolean;
  113314. set isRGBD(value: boolean);
  113315. /**
  113316. * Is Z inverted in the texture (useful in a cube texture).
  113317. */
  113318. invertZ: boolean;
  113319. /**
  113320. * Are mip maps generated for this texture or not.
  113321. */
  113322. get noMipmap(): boolean;
  113323. /**
  113324. * @hidden
  113325. */
  113326. lodLevelInAlpha: boolean;
  113327. /**
  113328. * With prefiltered texture, defined the offset used during the prefiltering steps.
  113329. */
  113330. get lodGenerationOffset(): number;
  113331. set lodGenerationOffset(value: number);
  113332. /**
  113333. * With prefiltered texture, defined the scale used during the prefiltering steps.
  113334. */
  113335. get lodGenerationScale(): number;
  113336. set lodGenerationScale(value: number);
  113337. /**
  113338. * With prefiltered texture, defined if the specular generation is based on a linear ramp.
  113339. * By default we are using a log2 of the linear roughness helping to keep a better resolution for
  113340. * average roughness values.
  113341. */
  113342. get linearSpecularLOD(): boolean;
  113343. set linearSpecularLOD(value: boolean);
  113344. /**
  113345. * In case a better definition than spherical harmonics is required for the diffuse part of the environment.
  113346. * You can set the irradiance texture to rely on a texture instead of the spherical approach.
  113347. * This texture need to have the same characteristics than its parent (Cube vs 2d, coordinates mode, Gamma/Linear, RGBD).
  113348. */
  113349. get irradianceTexture(): Nullable<BaseTexture>;
  113350. set irradianceTexture(value: Nullable<BaseTexture>);
  113351. /**
  113352. * Define if the texture is a render target.
  113353. */
  113354. isRenderTarget: boolean;
  113355. /**
  113356. * Define the unique id of the texture in the scene.
  113357. */
  113358. get uid(): string;
  113359. /** @hidden */
  113360. _prefiltered: boolean;
  113361. /**
  113362. * Return a string representation of the texture.
  113363. * @returns the texture as a string
  113364. */
  113365. toString(): string;
  113366. /**
  113367. * Get the class name of the texture.
  113368. * @returns "BaseTexture"
  113369. */
  113370. getClassName(): string;
  113371. /**
  113372. * Define the list of animation attached to the texture.
  113373. */
  113374. animations: Animation[];
  113375. /**
  113376. * An event triggered when the texture is disposed.
  113377. */
  113378. onDisposeObservable: Observable<BaseTexture>;
  113379. private _onDisposeObserver;
  113380. /**
  113381. * Callback triggered when the texture has been disposed.
  113382. * Kept for back compatibility, you can use the onDisposeObservable instead.
  113383. */
  113384. set onDispose(callback: () => void);
  113385. /**
  113386. * Define the current state of the loading sequence when in delayed load mode.
  113387. */
  113388. delayLoadState: number;
  113389. protected _scene: Nullable<Scene>;
  113390. protected _engine: Nullable<ThinEngine>;
  113391. /** @hidden */
  113392. _texture: Nullable<InternalTexture>;
  113393. private _uid;
  113394. /**
  113395. * Define if the texture is preventinga material to render or not.
  113396. * If not and the texture is not ready, the engine will use a default black texture instead.
  113397. */
  113398. get isBlocking(): boolean;
  113399. /**
  113400. * Instantiates a new BaseTexture.
  113401. * Base class of all the textures in babylon.
  113402. * It groups all the common properties the materials, post process, lights... might need
  113403. * in order to make a correct use of the texture.
  113404. * @param sceneOrEngine Define the scene or engine the texture blongs to
  113405. */
  113406. constructor(sceneOrEngine: Nullable<Scene | ThinEngine>);
  113407. /**
  113408. * Get the scene the texture belongs to.
  113409. * @returns the scene or null if undefined
  113410. */
  113411. getScene(): Nullable<Scene>;
  113412. /** @hidden */
  113413. protected _getEngine(): Nullable<ThinEngine>;
  113414. /**
  113415. * Get the texture transform matrix used to offset tile the texture for istance.
  113416. * @returns the transformation matrix
  113417. */
  113418. getTextureMatrix(): Matrix;
  113419. /**
  113420. * Get the texture reflection matrix used to rotate/transform the reflection.
  113421. * @returns the reflection matrix
  113422. */
  113423. getReflectionTextureMatrix(): Matrix;
  113424. /**
  113425. * Get the underlying lower level texture from Babylon.
  113426. * @returns the insternal texture
  113427. */
  113428. getInternalTexture(): Nullable<InternalTexture>;
  113429. /**
  113430. * Get if the texture is ready to be consumed (either it is ready or it is not blocking)
  113431. * @returns true if ready or not blocking
  113432. */
  113433. isReadyOrNotBlocking(): boolean;
  113434. /**
  113435. * Get if the texture is ready to be used (downloaded, converted, mip mapped...).
  113436. * @returns true if fully ready
  113437. */
  113438. isReady(): boolean;
  113439. private _cachedSize;
  113440. /**
  113441. * Get the size of the texture.
  113442. * @returns the texture size.
  113443. */
  113444. getSize(): ISize;
  113445. /**
  113446. * Get the base size of the texture.
  113447. * It can be different from the size if the texture has been resized for POT for instance
  113448. * @returns the base size
  113449. */
  113450. getBaseSize(): ISize;
  113451. /**
  113452. * Update the sampling mode of the texture.
  113453. * Default is Trilinear mode.
  113454. *
  113455. * | Value | Type | Description |
  113456. * | ----- | ------------------ | ----------- |
  113457. * | 1 | NEAREST_SAMPLINGMODE or NEAREST_NEAREST_MIPLINEAR | Nearest is: mag = nearest, min = nearest, mip = linear |
  113458. * | 2 | BILINEAR_SAMPLINGMODE or LINEAR_LINEAR_MIPNEAREST | Bilinear is: mag = linear, min = linear, mip = nearest |
  113459. * | 3 | TRILINEAR_SAMPLINGMODE or LINEAR_LINEAR_MIPLINEAR | Trilinear is: mag = linear, min = linear, mip = linear |
  113460. * | 4 | NEAREST_NEAREST_MIPNEAREST | |
  113461. * | 5 | NEAREST_LINEAR_MIPNEAREST | |
  113462. * | 6 | NEAREST_LINEAR_MIPLINEAR | |
  113463. * | 7 | NEAREST_LINEAR | |
  113464. * | 8 | NEAREST_NEAREST | |
  113465. * | 9 | LINEAR_NEAREST_MIPNEAREST | |
  113466. * | 10 | LINEAR_NEAREST_MIPLINEAR | |
  113467. * | 11 | LINEAR_LINEAR | |
  113468. * | 12 | LINEAR_NEAREST | |
  113469. *
  113470. * > _mag_: magnification filter (close to the viewer)
  113471. * > _min_: minification filter (far from the viewer)
  113472. * > _mip_: filter used between mip map levels
  113473. *@param samplingMode Define the new sampling mode of the texture
  113474. */
  113475. updateSamplingMode(samplingMode: number): void;
  113476. /**
  113477. * Scales the texture if is `canRescale()`
  113478. * @param ratio the resize factor we want to use to rescale
  113479. */
  113480. scale(ratio: number): void;
  113481. /**
  113482. * Get if the texture can rescale.
  113483. */
  113484. get canRescale(): boolean;
  113485. /** @hidden */
  113486. _getFromCache(url: Nullable<string>, noMipmap: boolean, sampling?: number, invertY?: boolean): Nullable<InternalTexture>;
  113487. /** @hidden */
  113488. _rebuild(): void;
  113489. /**
  113490. * Triggers the load sequence in delayed load mode.
  113491. */
  113492. delayLoad(): void;
  113493. /**
  113494. * Clones the texture.
  113495. * @returns the cloned texture
  113496. */
  113497. clone(): Nullable<BaseTexture>;
  113498. /**
  113499. * Get the texture underlying type (INT, FLOAT...)
  113500. */
  113501. get textureType(): number;
  113502. /**
  113503. * Get the texture underlying format (RGB, RGBA...)
  113504. */
  113505. get textureFormat(): number;
  113506. /**
  113507. * Indicates that textures need to be re-calculated for all materials
  113508. */
  113509. protected _markAllSubMeshesAsTexturesDirty(): void;
  113510. /**
  113511. * Reads the pixels stored in the webgl texture and returns them as an ArrayBuffer.
  113512. * This will returns an RGBA array buffer containing either in values (0-255) or
  113513. * float values (0-1) depending of the underlying buffer type.
  113514. * @param faceIndex defines the face of the texture to read (in case of cube texture)
  113515. * @param level defines the LOD level of the texture to read (in case of Mip Maps)
  113516. * @param buffer defines a user defined buffer to fill with data (can be null)
  113517. * @returns The Array buffer containing the pixels data.
  113518. */
  113519. readPixels(faceIndex?: number, level?: number, buffer?: Nullable<ArrayBufferView>): Nullable<ArrayBufferView>;
  113520. /**
  113521. * Release and destroy the underlying lower level texture aka internalTexture.
  113522. */
  113523. releaseInternalTexture(): void;
  113524. /** @hidden */
  113525. get _lodTextureHigh(): Nullable<BaseTexture>;
  113526. /** @hidden */
  113527. get _lodTextureMid(): Nullable<BaseTexture>;
  113528. /** @hidden */
  113529. get _lodTextureLow(): Nullable<BaseTexture>;
  113530. /**
  113531. * Dispose the texture and release its associated resources.
  113532. */
  113533. dispose(): void;
  113534. /**
  113535. * Serialize the texture into a JSON representation that can be parsed later on.
  113536. * @returns the JSON representation of the texture
  113537. */
  113538. serialize(): any;
  113539. /**
  113540. * Helper function to be called back once a list of texture contains only ready textures.
  113541. * @param textures Define the list of textures to wait for
  113542. * @param callback Define the callback triggered once the entire list will be ready
  113543. */
  113544. static WhenAllReady(textures: BaseTexture[], callback: () => void): void;
  113545. private static _isScene;
  113546. }
  113547. }
  113548. declare module BABYLON {
  113549. /**
  113550. * Options to be used when creating an effect.
  113551. */
  113552. export interface IEffectCreationOptions {
  113553. /**
  113554. * Atrributes that will be used in the shader.
  113555. */
  113556. attributes: string[];
  113557. /**
  113558. * Uniform varible names that will be set in the shader.
  113559. */
  113560. uniformsNames: string[];
  113561. /**
  113562. * Uniform buffer variable names that will be set in the shader.
  113563. */
  113564. uniformBuffersNames: string[];
  113565. /**
  113566. * Sampler texture variable names that will be set in the shader.
  113567. */
  113568. samplers: string[];
  113569. /**
  113570. * Define statements that will be set in the shader.
  113571. */
  113572. defines: any;
  113573. /**
  113574. * Possible fallbacks for this effect to improve performance when needed.
  113575. */
  113576. fallbacks: Nullable<IEffectFallbacks>;
  113577. /**
  113578. * Callback that will be called when the shader is compiled.
  113579. */
  113580. onCompiled: Nullable<(effect: Effect) => void>;
  113581. /**
  113582. * Callback that will be called if an error occurs during shader compilation.
  113583. */
  113584. onError: Nullable<(effect: Effect, errors: string) => void>;
  113585. /**
  113586. * Parameters to be used with Babylons include syntax to iterate over an array (eg. {lights: 10})
  113587. */
  113588. indexParameters?: any;
  113589. /**
  113590. * Max number of lights that can be used in the shader.
  113591. */
  113592. maxSimultaneousLights?: number;
  113593. /**
  113594. * See https://developer.mozilla.org/en-US/docs/Web/API/WebGL2RenderingContext/transformFeedbackVaryings
  113595. */
  113596. transformFeedbackVaryings?: Nullable<string[]>;
  113597. /**
  113598. * 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
  113599. */
  113600. processFinalCode?: Nullable<(shaderType: string, code: string) => string>;
  113601. /**
  113602. * Is this effect rendering to several color attachments ?
  113603. */
  113604. multiTarget?: boolean;
  113605. }
  113606. /**
  113607. * Effect containing vertex and fragment shader that can be executed on an object.
  113608. */
  113609. export class Effect implements IDisposable {
  113610. /**
  113611. * Gets or sets the relative url used to load shaders if using the engine in non-minified mode
  113612. */
  113613. static ShadersRepository: string;
  113614. /**
  113615. * Enable logging of the shader code when a compilation error occurs
  113616. */
  113617. static LogShaderCodeOnCompilationError: boolean;
  113618. /**
  113619. * Name of the effect.
  113620. */
  113621. name: any;
  113622. /**
  113623. * String container all the define statements that should be set on the shader.
  113624. */
  113625. defines: string;
  113626. /**
  113627. * Callback that will be called when the shader is compiled.
  113628. */
  113629. onCompiled: Nullable<(effect: Effect) => void>;
  113630. /**
  113631. * Callback that will be called if an error occurs during shader compilation.
  113632. */
  113633. onError: Nullable<(effect: Effect, errors: string) => void>;
  113634. /**
  113635. * Callback that will be called when effect is bound.
  113636. */
  113637. onBind: Nullable<(effect: Effect) => void>;
  113638. /**
  113639. * Unique ID of the effect.
  113640. */
  113641. uniqueId: number;
  113642. /**
  113643. * Observable that will be called when the shader is compiled.
  113644. * It is recommended to use executeWhenCompile() or to make sure that scene.isReady() is called to get this observable raised.
  113645. */
  113646. onCompileObservable: Observable<Effect>;
  113647. /**
  113648. * Observable that will be called if an error occurs during shader compilation.
  113649. */
  113650. onErrorObservable: Observable<Effect>;
  113651. /** @hidden */
  113652. _onBindObservable: Nullable<Observable<Effect>>;
  113653. /**
  113654. * @hidden
  113655. * Specifies if the effect was previously ready
  113656. */
  113657. _wasPreviouslyReady: boolean;
  113658. /**
  113659. * Observable that will be called when effect is bound.
  113660. */
  113661. get onBindObservable(): Observable<Effect>;
  113662. /** @hidden */
  113663. _bonesComputationForcedToCPU: boolean;
  113664. /** @hidden */
  113665. _multiTarget: boolean;
  113666. private static _uniqueIdSeed;
  113667. private _engine;
  113668. private _uniformBuffersNames;
  113669. private _uniformBuffersNamesList;
  113670. private _uniformsNames;
  113671. private _samplerList;
  113672. private _samplers;
  113673. private _isReady;
  113674. private _compilationError;
  113675. private _allFallbacksProcessed;
  113676. private _attributesNames;
  113677. private _attributes;
  113678. private _attributeLocationByName;
  113679. private _uniforms;
  113680. /**
  113681. * Key for the effect.
  113682. * @hidden
  113683. */
  113684. _key: string;
  113685. private _indexParameters;
  113686. private _fallbacks;
  113687. private _vertexSourceCode;
  113688. private _fragmentSourceCode;
  113689. private _vertexSourceCodeOverride;
  113690. private _fragmentSourceCodeOverride;
  113691. private _transformFeedbackVaryings;
  113692. /**
  113693. * Compiled shader to webGL program.
  113694. * @hidden
  113695. */
  113696. _pipelineContext: Nullable<IPipelineContext>;
  113697. private _valueCache;
  113698. private static _baseCache;
  113699. /**
  113700. * Instantiates an effect.
  113701. * An effect can be used to create/manage/execute vertex and fragment shaders.
  113702. * @param baseName Name of the effect.
  113703. * @param attributesNamesOrOptions List of attribute names that will be passed to the shader or set of all options to create the effect.
  113704. * @param uniformsNamesOrEngine List of uniform variable names that will be passed to the shader or the engine that will be used to render effect.
  113705. * @param samplers List of sampler variables that will be passed to the shader.
  113706. * @param engine Engine to be used to render the effect
  113707. * @param defines Define statements to be added to the shader.
  113708. * @param fallbacks Possible fallbacks for this effect to improve performance when needed.
  113709. * @param onCompiled Callback that will be called when the shader is compiled.
  113710. * @param onError Callback that will be called if an error occurs during shader compilation.
  113711. * @param indexParameters Parameters to be used with Babylons include syntax to iterate over an array (eg. {lights: 10})
  113712. */
  113713. 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);
  113714. private _useFinalCode;
  113715. /**
  113716. * Unique key for this effect
  113717. */
  113718. get key(): string;
  113719. /**
  113720. * If the effect has been compiled and prepared.
  113721. * @returns if the effect is compiled and prepared.
  113722. */
  113723. isReady(): boolean;
  113724. private _isReadyInternal;
  113725. /**
  113726. * The engine the effect was initialized with.
  113727. * @returns the engine.
  113728. */
  113729. getEngine(): Engine;
  113730. /**
  113731. * The pipeline context for this effect
  113732. * @returns the associated pipeline context
  113733. */
  113734. getPipelineContext(): Nullable<IPipelineContext>;
  113735. /**
  113736. * The set of names of attribute variables for the shader.
  113737. * @returns An array of attribute names.
  113738. */
  113739. getAttributesNames(): string[];
  113740. /**
  113741. * Returns the attribute at the given index.
  113742. * @param index The index of the attribute.
  113743. * @returns The location of the attribute.
  113744. */
  113745. getAttributeLocation(index: number): number;
  113746. /**
  113747. * Returns the attribute based on the name of the variable.
  113748. * @param name of the attribute to look up.
  113749. * @returns the attribute location.
  113750. */
  113751. getAttributeLocationByName(name: string): number;
  113752. /**
  113753. * The number of attributes.
  113754. * @returns the numnber of attributes.
  113755. */
  113756. getAttributesCount(): number;
  113757. /**
  113758. * Gets the index of a uniform variable.
  113759. * @param uniformName of the uniform to look up.
  113760. * @returns the index.
  113761. */
  113762. getUniformIndex(uniformName: string): number;
  113763. /**
  113764. * Returns the attribute based on the name of the variable.
  113765. * @param uniformName of the uniform to look up.
  113766. * @returns the location of the uniform.
  113767. */
  113768. getUniform(uniformName: string): Nullable<WebGLUniformLocation>;
  113769. /**
  113770. * Returns an array of sampler variable names
  113771. * @returns The array of sampler variable names.
  113772. */
  113773. getSamplers(): string[];
  113774. /**
  113775. * Returns an array of uniform variable names
  113776. * @returns The array of uniform variable names.
  113777. */
  113778. getUniformNames(): string[];
  113779. /**
  113780. * Returns an array of uniform buffer variable names
  113781. * @returns The array of uniform buffer variable names.
  113782. */
  113783. getUniformBuffersNames(): string[];
  113784. /**
  113785. * Returns the index parameters used to create the effect
  113786. * @returns The index parameters object
  113787. */
  113788. getIndexParameters(): any;
  113789. /**
  113790. * The error from the last compilation.
  113791. * @returns the error string.
  113792. */
  113793. getCompilationError(): string;
  113794. /**
  113795. * Gets a boolean indicating that all fallbacks were used during compilation
  113796. * @returns true if all fallbacks were used
  113797. */
  113798. allFallbacksProcessed(): boolean;
  113799. /**
  113800. * Adds a callback to the onCompiled observable and call the callback imediatly if already ready.
  113801. * @param func The callback to be used.
  113802. */
  113803. executeWhenCompiled(func: (effect: Effect) => void): void;
  113804. private _checkIsReady;
  113805. private _loadShader;
  113806. /**
  113807. * Gets the vertex shader source code of this effect
  113808. */
  113809. get vertexSourceCode(): string;
  113810. /**
  113811. * Gets the fragment shader source code of this effect
  113812. */
  113813. get fragmentSourceCode(): string;
  113814. /**
  113815. * Recompiles the webGL program
  113816. * @param vertexSourceCode The source code for the vertex shader.
  113817. * @param fragmentSourceCode The source code for the fragment shader.
  113818. * @param onCompiled Callback called when completed.
  113819. * @param onError Callback called on error.
  113820. * @hidden
  113821. */
  113822. _rebuildProgram(vertexSourceCode: string, fragmentSourceCode: string, onCompiled: (pipelineContext: IPipelineContext) => void, onError: (message: string) => void): void;
  113823. /**
  113824. * Prepares the effect
  113825. * @hidden
  113826. */
  113827. _prepareEffect(): void;
  113828. private _getShaderCodeAndErrorLine;
  113829. private _processCompilationErrors;
  113830. /**
  113831. * Checks if the effect is supported. (Must be called after compilation)
  113832. */
  113833. get isSupported(): boolean;
  113834. /**
  113835. * Binds a texture to the engine to be used as output of the shader.
  113836. * @param channel Name of the output variable.
  113837. * @param texture Texture to bind.
  113838. * @hidden
  113839. */
  113840. _bindTexture(channel: string, texture: Nullable<InternalTexture>): void;
  113841. /**
  113842. * Sets a texture on the engine to be used in the shader.
  113843. * @param channel Name of the sampler variable.
  113844. * @param texture Texture to set.
  113845. */
  113846. setTexture(channel: string, texture: Nullable<BaseTexture>): void;
  113847. /**
  113848. * Sets a depth stencil texture from a render target on the engine to be used in the shader.
  113849. * @param channel Name of the sampler variable.
  113850. * @param texture Texture to set.
  113851. */
  113852. setDepthStencilTexture(channel: string, texture: Nullable<RenderTargetTexture>): void;
  113853. /**
  113854. * Sets an array of textures on the engine to be used in the shader.
  113855. * @param channel Name of the variable.
  113856. * @param textures Textures to set.
  113857. */
  113858. setTextureArray(channel: string, textures: BaseTexture[]): void;
  113859. /**
  113860. * 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)
  113861. * @param channel Name of the sampler variable.
  113862. * @param postProcess Post process to get the input texture from.
  113863. */
  113864. setTextureFromPostProcess(channel: string, postProcess: Nullable<PostProcess>): void;
  113865. /**
  113866. * (Warning! setTextureFromPostProcessOutput may be desired instead)
  113867. * 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)
  113868. * @param channel Name of the sampler variable.
  113869. * @param postProcess Post process to get the output texture from.
  113870. */
  113871. setTextureFromPostProcessOutput(channel: string, postProcess: Nullable<PostProcess>): void;
  113872. /** @hidden */
  113873. _cacheMatrix(uniformName: string, matrix: IMatrixLike): boolean;
  113874. /** @hidden */
  113875. _cacheFloat2(uniformName: string, x: number, y: number): boolean;
  113876. /** @hidden */
  113877. _cacheFloat3(uniformName: string, x: number, y: number, z: number): boolean;
  113878. /** @hidden */
  113879. _cacheFloat4(uniformName: string, x: number, y: number, z: number, w: number): boolean;
  113880. /**
  113881. * Binds a buffer to a uniform.
  113882. * @param buffer Buffer to bind.
  113883. * @param name Name of the uniform variable to bind to.
  113884. */
  113885. bindUniformBuffer(buffer: DataBuffer, name: string): void;
  113886. /**
  113887. * Binds block to a uniform.
  113888. * @param blockName Name of the block to bind.
  113889. * @param index Index to bind.
  113890. */
  113891. bindUniformBlock(blockName: string, index: number): void;
  113892. /**
  113893. * Sets an interger value on a uniform variable.
  113894. * @param uniformName Name of the variable.
  113895. * @param value Value to be set.
  113896. * @returns this effect.
  113897. */
  113898. setInt(uniformName: string, value: number): Effect;
  113899. /**
  113900. * Sets an int array on a uniform variable.
  113901. * @param uniformName Name of the variable.
  113902. * @param array array to be set.
  113903. * @returns this effect.
  113904. */
  113905. setIntArray(uniformName: string, array: Int32Array): Effect;
  113906. /**
  113907. * 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)
  113908. * @param uniformName Name of the variable.
  113909. * @param array array to be set.
  113910. * @returns this effect.
  113911. */
  113912. setIntArray2(uniformName: string, array: Int32Array): Effect;
  113913. /**
  113914. * 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)
  113915. * @param uniformName Name of the variable.
  113916. * @param array array to be set.
  113917. * @returns this effect.
  113918. */
  113919. setIntArray3(uniformName: string, array: Int32Array): Effect;
  113920. /**
  113921. * 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)
  113922. * @param uniformName Name of the variable.
  113923. * @param array array to be set.
  113924. * @returns this effect.
  113925. */
  113926. setIntArray4(uniformName: string, array: Int32Array): Effect;
  113927. /**
  113928. * Sets an float array on a uniform variable.
  113929. * @param uniformName Name of the variable.
  113930. * @param array array to be set.
  113931. * @returns this effect.
  113932. */
  113933. setFloatArray(uniformName: string, array: Float32Array): Effect;
  113934. /**
  113935. * 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)
  113936. * @param uniformName Name of the variable.
  113937. * @param array array to be set.
  113938. * @returns this effect.
  113939. */
  113940. setFloatArray2(uniformName: string, array: Float32Array): Effect;
  113941. /**
  113942. * 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)
  113943. * @param uniformName Name of the variable.
  113944. * @param array array to be set.
  113945. * @returns this effect.
  113946. */
  113947. setFloatArray3(uniformName: string, array: Float32Array): Effect;
  113948. /**
  113949. * 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)
  113950. * @param uniformName Name of the variable.
  113951. * @param array array to be set.
  113952. * @returns this effect.
  113953. */
  113954. setFloatArray4(uniformName: string, array: Float32Array): Effect;
  113955. /**
  113956. * Sets an array on a uniform variable.
  113957. * @param uniformName Name of the variable.
  113958. * @param array array to be set.
  113959. * @returns this effect.
  113960. */
  113961. setArray(uniformName: string, array: number[]): Effect;
  113962. /**
  113963. * 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)
  113964. * @param uniformName Name of the variable.
  113965. * @param array array to be set.
  113966. * @returns this effect.
  113967. */
  113968. setArray2(uniformName: string, array: number[]): Effect;
  113969. /**
  113970. * 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)
  113971. * @param uniformName Name of the variable.
  113972. * @param array array to be set.
  113973. * @returns this effect.
  113974. */
  113975. setArray3(uniformName: string, array: number[]): Effect;
  113976. /**
  113977. * 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)
  113978. * @param uniformName Name of the variable.
  113979. * @param array array to be set.
  113980. * @returns this effect.
  113981. */
  113982. setArray4(uniformName: string, array: number[]): Effect;
  113983. /**
  113984. * Sets matrices on a uniform variable.
  113985. * @param uniformName Name of the variable.
  113986. * @param matrices matrices to be set.
  113987. * @returns this effect.
  113988. */
  113989. setMatrices(uniformName: string, matrices: Float32Array | Array<number>): Effect;
  113990. /**
  113991. * Sets matrix on a uniform variable.
  113992. * @param uniformName Name of the variable.
  113993. * @param matrix matrix to be set.
  113994. * @returns this effect.
  113995. */
  113996. setMatrix(uniformName: string, matrix: IMatrixLike): Effect;
  113997. /**
  113998. * 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)
  113999. * @param uniformName Name of the variable.
  114000. * @param matrix matrix to be set.
  114001. * @returns this effect.
  114002. */
  114003. setMatrix3x3(uniformName: string, matrix: Float32Array | Array<number>): Effect;
  114004. /**
  114005. * Sets a 2x2 matrix on a uniform variable. (Speicified as [1,2,3,4] will result in [1,2][3,4] matrix)
  114006. * @param uniformName Name of the variable.
  114007. * @param matrix matrix to be set.
  114008. * @returns this effect.
  114009. */
  114010. setMatrix2x2(uniformName: string, matrix: Float32Array | Array<number>): Effect;
  114011. /**
  114012. * Sets a float on a uniform variable.
  114013. * @param uniformName Name of the variable.
  114014. * @param value value to be set.
  114015. * @returns this effect.
  114016. */
  114017. setFloat(uniformName: string, value: number): Effect;
  114018. /**
  114019. * Sets a boolean on a uniform variable.
  114020. * @param uniformName Name of the variable.
  114021. * @param bool value to be set.
  114022. * @returns this effect.
  114023. */
  114024. setBool(uniformName: string, bool: boolean): Effect;
  114025. /**
  114026. * Sets a Vector2 on a uniform variable.
  114027. * @param uniformName Name of the variable.
  114028. * @param vector2 vector2 to be set.
  114029. * @returns this effect.
  114030. */
  114031. setVector2(uniformName: string, vector2: IVector2Like): Effect;
  114032. /**
  114033. * Sets a float2 on a uniform variable.
  114034. * @param uniformName Name of the variable.
  114035. * @param x First float in float2.
  114036. * @param y Second float in float2.
  114037. * @returns this effect.
  114038. */
  114039. setFloat2(uniformName: string, x: number, y: number): Effect;
  114040. /**
  114041. * Sets a Vector3 on a uniform variable.
  114042. * @param uniformName Name of the variable.
  114043. * @param vector3 Value to be set.
  114044. * @returns this effect.
  114045. */
  114046. setVector3(uniformName: string, vector3: IVector3Like): Effect;
  114047. /**
  114048. * Sets a float3 on a uniform variable.
  114049. * @param uniformName Name of the variable.
  114050. * @param x First float in float3.
  114051. * @param y Second float in float3.
  114052. * @param z Third float in float3.
  114053. * @returns this effect.
  114054. */
  114055. setFloat3(uniformName: string, x: number, y: number, z: number): Effect;
  114056. /**
  114057. * Sets a Vector4 on a uniform variable.
  114058. * @param uniformName Name of the variable.
  114059. * @param vector4 Value to be set.
  114060. * @returns this effect.
  114061. */
  114062. setVector4(uniformName: string, vector4: IVector4Like): Effect;
  114063. /**
  114064. * Sets a float4 on a uniform variable.
  114065. * @param uniformName Name of the variable.
  114066. * @param x First float in float4.
  114067. * @param y Second float in float4.
  114068. * @param z Third float in float4.
  114069. * @param w Fourth float in float4.
  114070. * @returns this effect.
  114071. */
  114072. setFloat4(uniformName: string, x: number, y: number, z: number, w: number): Effect;
  114073. /**
  114074. * Sets a Color3 on a uniform variable.
  114075. * @param uniformName Name of the variable.
  114076. * @param color3 Value to be set.
  114077. * @returns this effect.
  114078. */
  114079. setColor3(uniformName: string, color3: IColor3Like): Effect;
  114080. /**
  114081. * Sets a Color4 on a uniform variable.
  114082. * @param uniformName Name of the variable.
  114083. * @param color3 Value to be set.
  114084. * @param alpha Alpha value to be set.
  114085. * @returns this effect.
  114086. */
  114087. setColor4(uniformName: string, color3: IColor3Like, alpha: number): Effect;
  114088. /**
  114089. * Sets a Color4 on a uniform variable
  114090. * @param uniformName defines the name of the variable
  114091. * @param color4 defines the value to be set
  114092. * @returns this effect.
  114093. */
  114094. setDirectColor4(uniformName: string, color4: IColor4Like): Effect;
  114095. /** Release all associated resources */
  114096. dispose(): void;
  114097. /**
  114098. * This function will add a new shader to the shader store
  114099. * @param name the name of the shader
  114100. * @param pixelShader optional pixel shader content
  114101. * @param vertexShader optional vertex shader content
  114102. */
  114103. static RegisterShader(name: string, pixelShader?: string, vertexShader?: string): void;
  114104. /**
  114105. * Store of each shader (The can be looked up using effect.key)
  114106. */
  114107. static ShadersStore: {
  114108. [key: string]: string;
  114109. };
  114110. /**
  114111. * Store of each included file for a shader (The can be looked up using effect.key)
  114112. */
  114113. static IncludesShadersStore: {
  114114. [key: string]: string;
  114115. };
  114116. /**
  114117. * Resets the cache of effects.
  114118. */
  114119. static ResetCache(): void;
  114120. }
  114121. }
  114122. declare module BABYLON {
  114123. /**
  114124. * Interface used to describe the capabilities of the engine relatively to the current browser
  114125. */
  114126. export interface EngineCapabilities {
  114127. /** Maximum textures units per fragment shader */
  114128. maxTexturesImageUnits: number;
  114129. /** Maximum texture units per vertex shader */
  114130. maxVertexTextureImageUnits: number;
  114131. /** Maximum textures units in the entire pipeline */
  114132. maxCombinedTexturesImageUnits: number;
  114133. /** Maximum texture size */
  114134. maxTextureSize: number;
  114135. /** Maximum texture samples */
  114136. maxSamples?: number;
  114137. /** Maximum cube texture size */
  114138. maxCubemapTextureSize: number;
  114139. /** Maximum render texture size */
  114140. maxRenderTextureSize: number;
  114141. /** Maximum number of vertex attributes */
  114142. maxVertexAttribs: number;
  114143. /** Maximum number of varyings */
  114144. maxVaryingVectors: number;
  114145. /** Maximum number of uniforms per vertex shader */
  114146. maxVertexUniformVectors: number;
  114147. /** Maximum number of uniforms per fragment shader */
  114148. maxFragmentUniformVectors: number;
  114149. /** Defines if standard derivates (dx/dy) are supported */
  114150. standardDerivatives: boolean;
  114151. /** Defines if s3tc texture compression is supported */
  114152. s3tc?: WEBGL_compressed_texture_s3tc;
  114153. /** Defines if pvrtc texture compression is supported */
  114154. pvrtc: any;
  114155. /** Defines if etc1 texture compression is supported */
  114156. etc1: any;
  114157. /** Defines if etc2 texture compression is supported */
  114158. etc2: any;
  114159. /** Defines if astc texture compression is supported */
  114160. astc: any;
  114161. /** Defines if float textures are supported */
  114162. textureFloat: boolean;
  114163. /** Defines if vertex array objects are supported */
  114164. vertexArrayObject: boolean;
  114165. /** Gets the webgl extension for anisotropic filtering (null if not supported) */
  114166. textureAnisotropicFilterExtension?: EXT_texture_filter_anisotropic;
  114167. /** Gets the maximum level of anisotropy supported */
  114168. maxAnisotropy: number;
  114169. /** Defines if instancing is supported */
  114170. instancedArrays: boolean;
  114171. /** Defines if 32 bits indices are supported */
  114172. uintIndices: boolean;
  114173. /** Defines if high precision shaders are supported */
  114174. highPrecisionShaderSupported: boolean;
  114175. /** Defines if depth reading in the fragment shader is supported */
  114176. fragmentDepthSupported: boolean;
  114177. /** Defines if float texture linear filtering is supported*/
  114178. textureFloatLinearFiltering: boolean;
  114179. /** Defines if rendering to float textures is supported */
  114180. textureFloatRender: boolean;
  114181. /** Defines if half float textures are supported*/
  114182. textureHalfFloat: boolean;
  114183. /** Defines if half float texture linear filtering is supported*/
  114184. textureHalfFloatLinearFiltering: boolean;
  114185. /** Defines if rendering to half float textures is supported */
  114186. textureHalfFloatRender: boolean;
  114187. /** Defines if textureLOD shader command is supported */
  114188. textureLOD: boolean;
  114189. /** Defines if draw buffers extension is supported */
  114190. drawBuffersExtension: boolean;
  114191. /** Defines if depth textures are supported */
  114192. depthTextureExtension: boolean;
  114193. /** Defines if float color buffer are supported */
  114194. colorBufferFloat: boolean;
  114195. /** Gets disjoint timer query extension (null if not supported) */
  114196. timerQuery?: EXT_disjoint_timer_query;
  114197. /** Defines if timestamp can be used with timer query */
  114198. canUseTimestampForTimerQuery: boolean;
  114199. /** Defines if multiview is supported (https://www.khronos.org/registry/webgl/extensions/WEBGL_multiview/) */
  114200. multiview?: any;
  114201. /** Defines if oculus multiview is supported (https://developer.oculus.com/documentation/oculus-browser/latest/concepts/browser-multiview/) */
  114202. oculusMultiview?: any;
  114203. /** Function used to let the system compiles shaders in background */
  114204. parallelShaderCompile?: {
  114205. COMPLETION_STATUS_KHR: number;
  114206. };
  114207. /** Max number of texture samples for MSAA */
  114208. maxMSAASamples: number;
  114209. /** Defines if the blend min max extension is supported */
  114210. blendMinMax: boolean;
  114211. }
  114212. }
  114213. declare module BABYLON {
  114214. /**
  114215. * @hidden
  114216. **/
  114217. export class DepthCullingState {
  114218. private _isDepthTestDirty;
  114219. private _isDepthMaskDirty;
  114220. private _isDepthFuncDirty;
  114221. private _isCullFaceDirty;
  114222. private _isCullDirty;
  114223. private _isZOffsetDirty;
  114224. private _isFrontFaceDirty;
  114225. private _depthTest;
  114226. private _depthMask;
  114227. private _depthFunc;
  114228. private _cull;
  114229. private _cullFace;
  114230. private _zOffset;
  114231. private _frontFace;
  114232. /**
  114233. * Initializes the state.
  114234. */
  114235. constructor();
  114236. get isDirty(): boolean;
  114237. get zOffset(): number;
  114238. set zOffset(value: number);
  114239. get cullFace(): Nullable<number>;
  114240. set cullFace(value: Nullable<number>);
  114241. get cull(): Nullable<boolean>;
  114242. set cull(value: Nullable<boolean>);
  114243. get depthFunc(): Nullable<number>;
  114244. set depthFunc(value: Nullable<number>);
  114245. get depthMask(): boolean;
  114246. set depthMask(value: boolean);
  114247. get depthTest(): boolean;
  114248. set depthTest(value: boolean);
  114249. get frontFace(): Nullable<number>;
  114250. set frontFace(value: Nullable<number>);
  114251. reset(): void;
  114252. apply(gl: WebGLRenderingContext): void;
  114253. }
  114254. }
  114255. declare module BABYLON {
  114256. /**
  114257. * @hidden
  114258. **/
  114259. export class StencilState {
  114260. /** 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 */
  114261. static readonly ALWAYS: number;
  114262. /** Passed to stencilOperation to specify that stencil value must be kept */
  114263. static readonly KEEP: number;
  114264. /** Passed to stencilOperation to specify that stencil value must be replaced */
  114265. static readonly REPLACE: number;
  114266. private _isStencilTestDirty;
  114267. private _isStencilMaskDirty;
  114268. private _isStencilFuncDirty;
  114269. private _isStencilOpDirty;
  114270. private _stencilTest;
  114271. private _stencilMask;
  114272. private _stencilFunc;
  114273. private _stencilFuncRef;
  114274. private _stencilFuncMask;
  114275. private _stencilOpStencilFail;
  114276. private _stencilOpDepthFail;
  114277. private _stencilOpStencilDepthPass;
  114278. get isDirty(): boolean;
  114279. get stencilFunc(): number;
  114280. set stencilFunc(value: number);
  114281. get stencilFuncRef(): number;
  114282. set stencilFuncRef(value: number);
  114283. get stencilFuncMask(): number;
  114284. set stencilFuncMask(value: number);
  114285. get stencilOpStencilFail(): number;
  114286. set stencilOpStencilFail(value: number);
  114287. get stencilOpDepthFail(): number;
  114288. set stencilOpDepthFail(value: number);
  114289. get stencilOpStencilDepthPass(): number;
  114290. set stencilOpStencilDepthPass(value: number);
  114291. get stencilMask(): number;
  114292. set stencilMask(value: number);
  114293. get stencilTest(): boolean;
  114294. set stencilTest(value: boolean);
  114295. constructor();
  114296. reset(): void;
  114297. apply(gl: WebGLRenderingContext): void;
  114298. }
  114299. }
  114300. declare module BABYLON {
  114301. /**
  114302. * @hidden
  114303. **/
  114304. export class AlphaState {
  114305. private _isAlphaBlendDirty;
  114306. private _isBlendFunctionParametersDirty;
  114307. private _isBlendEquationParametersDirty;
  114308. private _isBlendConstantsDirty;
  114309. private _alphaBlend;
  114310. private _blendFunctionParameters;
  114311. private _blendEquationParameters;
  114312. private _blendConstants;
  114313. /**
  114314. * Initializes the state.
  114315. */
  114316. constructor();
  114317. get isDirty(): boolean;
  114318. get alphaBlend(): boolean;
  114319. set alphaBlend(value: boolean);
  114320. setAlphaBlendConstants(r: number, g: number, b: number, a: number): void;
  114321. setAlphaBlendFunctionParameters(value0: number, value1: number, value2: number, value3: number): void;
  114322. setAlphaEquationParameters(rgb: number, alpha: number): void;
  114323. reset(): void;
  114324. apply(gl: WebGLRenderingContext): void;
  114325. }
  114326. }
  114327. declare module BABYLON {
  114328. /** @hidden */
  114329. export class WebGL2ShaderProcessor implements IShaderProcessor {
  114330. attributeProcessor(attribute: string): string;
  114331. varyingProcessor(varying: string, isFragment: boolean): string;
  114332. postProcessor(code: string, defines: string[], isFragment: boolean): string;
  114333. }
  114334. }
  114335. declare module BABYLON {
  114336. /**
  114337. * Interface for attribute information associated with buffer instanciation
  114338. */
  114339. export interface InstancingAttributeInfo {
  114340. /**
  114341. * Name of the GLSL attribute
  114342. * if attribute index is not specified, this is used to retrieve the index from the effect
  114343. */
  114344. attributeName: string;
  114345. /**
  114346. * Index/offset of the attribute in the vertex shader
  114347. * if not specified, this will be computes from the name.
  114348. */
  114349. index?: number;
  114350. /**
  114351. * size of the attribute, 1, 2, 3 or 4
  114352. */
  114353. attributeSize: number;
  114354. /**
  114355. * Offset of the data in the Vertex Buffer acting as the instancing buffer
  114356. */
  114357. offset: number;
  114358. /**
  114359. * Modifies the rate at which generic vertex attributes advance when rendering multiple instances
  114360. * default to 1
  114361. */
  114362. divisor?: number;
  114363. /**
  114364. * type of the attribute, gl.BYTE, gl.UNSIGNED_BYTE, gl.SHORT, gl.UNSIGNED_SHORT, gl.FIXED, gl.FLOAT.
  114365. * default is FLOAT
  114366. */
  114367. attributeType?: number;
  114368. /**
  114369. * normalization of fixed-point data. behavior unclear, use FALSE, default is FALSE
  114370. */
  114371. normalized?: boolean;
  114372. }
  114373. }
  114374. declare module BABYLON {
  114375. interface ThinEngine {
  114376. /**
  114377. * Update a video texture
  114378. * @param texture defines the texture to update
  114379. * @param video defines the video element to use
  114380. * @param invertY defines if data must be stored with Y axis inverted
  114381. */
  114382. updateVideoTexture(texture: Nullable<InternalTexture>, video: HTMLVideoElement, invertY: boolean): void;
  114383. }
  114384. }
  114385. declare module BABYLON {
  114386. interface ThinEngine {
  114387. /**
  114388. * Creates a dynamic texture
  114389. * @param width defines the width of the texture
  114390. * @param height defines the height of the texture
  114391. * @param generateMipMaps defines if the engine should generate the mip levels
  114392. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  114393. * @returns the dynamic texture inside an InternalTexture
  114394. */
  114395. createDynamicTexture(width: number, height: number, generateMipMaps: boolean, samplingMode: number): InternalTexture;
  114396. /**
  114397. * Update the content of a dynamic texture
  114398. * @param texture defines the texture to update
  114399. * @param canvas defines the canvas containing the source
  114400. * @param invertY defines if data must be stored with Y axis inverted
  114401. * @param premulAlpha defines if alpha is stored as premultiplied
  114402. * @param format defines the format of the data
  114403. * @param forceBindTexture if the texture should be forced to be bound eg. after a graphics context loss (Default: false)
  114404. */
  114405. updateDynamicTexture(texture: Nullable<InternalTexture>, canvas: HTMLCanvasElement | OffscreenCanvas, invertY: boolean, premulAlpha?: boolean, format?: number, forceBindTexture?: boolean): void;
  114406. }
  114407. }
  114408. declare module BABYLON {
  114409. /**
  114410. * Settings for finer control over video usage
  114411. */
  114412. export interface VideoTextureSettings {
  114413. /**
  114414. * Applies `autoplay` to video, if specified
  114415. */
  114416. autoPlay?: boolean;
  114417. /**
  114418. * Applies `loop` to video, if specified
  114419. */
  114420. loop?: boolean;
  114421. /**
  114422. * Automatically updates internal texture from video at every frame in the render loop
  114423. */
  114424. autoUpdateTexture: boolean;
  114425. /**
  114426. * Image src displayed during the video loading or until the user interacts with the video.
  114427. */
  114428. poster?: string;
  114429. }
  114430. /**
  114431. * If you want to display a video in your scene, this is the special texture for that.
  114432. * This special texture works similar to other textures, with the exception of a few parameters.
  114433. * @see https://doc.babylonjs.com/how_to/video_texture
  114434. */
  114435. export class VideoTexture extends Texture {
  114436. /**
  114437. * Tells whether textures will be updated automatically or user is required to call `updateTexture` manually
  114438. */
  114439. readonly autoUpdateTexture: boolean;
  114440. /**
  114441. * The video instance used by the texture internally
  114442. */
  114443. readonly video: HTMLVideoElement;
  114444. private _onUserActionRequestedObservable;
  114445. /**
  114446. * Event triggerd when a dom action is required by the user to play the video.
  114447. * This happens due to recent changes in browser policies preventing video to auto start.
  114448. */
  114449. get onUserActionRequestedObservable(): Observable<Texture>;
  114450. private _generateMipMaps;
  114451. private _stillImageCaptured;
  114452. private _displayingPosterTexture;
  114453. private _settings;
  114454. private _createInternalTextureOnEvent;
  114455. private _frameId;
  114456. private _currentSrc;
  114457. /**
  114458. * Creates a video texture.
  114459. * If you want to display a video in your scene, this is the special texture for that.
  114460. * This special texture works similar to other textures, with the exception of a few parameters.
  114461. * @see https://doc.babylonjs.com/how_to/video_texture
  114462. * @param name optional name, will detect from video source, if not defined
  114463. * @param src can be used to provide an url, array of urls or an already setup HTML video element.
  114464. * @param scene is obviously the current scene.
  114465. * @param generateMipMaps can be used to turn on mipmaps (Can be expensive for videoTextures because they are often updated).
  114466. * @param invertY is false by default but can be used to invert video on Y axis
  114467. * @param samplingMode controls the sampling method and is set to TRILINEAR_SAMPLINGMODE by default
  114468. * @param settings allows finer control over video usage
  114469. */
  114470. constructor(name: Nullable<string>, src: string | string[] | HTMLVideoElement, scene: Nullable<Scene>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, settings?: VideoTextureSettings);
  114471. private _getName;
  114472. private _getVideo;
  114473. private _createInternalTexture;
  114474. private reset;
  114475. /**
  114476. * @hidden Internal method to initiate `update`.
  114477. */
  114478. _rebuild(): void;
  114479. /**
  114480. * Update Texture in the `auto` mode. Does not do anything if `settings.autoUpdateTexture` is false.
  114481. */
  114482. update(): void;
  114483. /**
  114484. * Update Texture in `manual` mode. Does not do anything if not visible or paused.
  114485. * @param isVisible Visibility state, detected by user using `scene.getActiveMeshes()` or othervise.
  114486. */
  114487. updateTexture(isVisible: boolean): void;
  114488. protected _updateInternalTexture: () => void;
  114489. /**
  114490. * Change video content. Changing video instance or setting multiple urls (as in constructor) is not supported.
  114491. * @param url New url.
  114492. */
  114493. updateURL(url: string): void;
  114494. /**
  114495. * Clones the texture.
  114496. * @returns the cloned texture
  114497. */
  114498. clone(): VideoTexture;
  114499. /**
  114500. * Dispose the texture and release its associated resources.
  114501. */
  114502. dispose(): void;
  114503. /**
  114504. * Creates a video texture straight from a stream.
  114505. * @param scene Define the scene the texture should be created in
  114506. * @param stream Define the stream the texture should be created from
  114507. * @returns The created video texture as a promise
  114508. */
  114509. static CreateFromStreamAsync(scene: Scene, stream: MediaStream): Promise<VideoTexture>;
  114510. /**
  114511. * Creates a video texture straight from your WebCam video feed.
  114512. * @param scene Define the scene the texture should be created in
  114513. * @param constraints Define the constraints to use to create the web cam feed from WebRTC
  114514. * @param audioConstaints Define the audio constraints to use to create the web cam feed from WebRTC
  114515. * @returns The created video texture as a promise
  114516. */
  114517. static CreateFromWebCamAsync(scene: Scene, constraints: {
  114518. minWidth: number;
  114519. maxWidth: number;
  114520. minHeight: number;
  114521. maxHeight: number;
  114522. deviceId: string;
  114523. } & MediaTrackConstraints, audioConstaints?: boolean | MediaTrackConstraints): Promise<VideoTexture>;
  114524. /**
  114525. * Creates a video texture straight from your WebCam video feed.
  114526. * @param scene Define the scene the texture should be created in
  114527. * @param onReady Define a callback to triggered once the texture will be ready
  114528. * @param constraints Define the constraints to use to create the web cam feed from WebRTC
  114529. * @param audioConstaints Define the audio constraints to use to create the web cam feed from WebRTC
  114530. */
  114531. static CreateFromWebCam(scene: Scene, onReady: (videoTexture: VideoTexture) => void, constraints: {
  114532. minWidth: number;
  114533. maxWidth: number;
  114534. minHeight: number;
  114535. maxHeight: number;
  114536. deviceId: string;
  114537. } & MediaTrackConstraints, audioConstaints?: boolean | MediaTrackConstraints): void;
  114538. }
  114539. }
  114540. declare module BABYLON {
  114541. /**
  114542. * Defines the interface used by objects working like Scene
  114543. * @hidden
  114544. */
  114545. export interface ISceneLike {
  114546. _addPendingData(data: any): void;
  114547. _removePendingData(data: any): void;
  114548. offlineProvider: IOfflineProvider;
  114549. }
  114550. /**
  114551. * Information about the current host
  114552. */
  114553. export interface HostInformation {
  114554. /**
  114555. * Defines if the current host is a mobile
  114556. */
  114557. isMobile: boolean;
  114558. }
  114559. /** Interface defining initialization parameters for Engine class */
  114560. export interface EngineOptions extends WebGLContextAttributes {
  114561. /**
  114562. * Defines if the engine should no exceed a specified device ratio
  114563. * @see https://developer.mozilla.org/en-US/docs/Web/API/Window/devicePixelRatio
  114564. */
  114565. limitDeviceRatio?: number;
  114566. /**
  114567. * Defines if webvr should be enabled automatically
  114568. * @see https://doc.babylonjs.com/how_to/webvr_camera
  114569. */
  114570. autoEnableWebVR?: boolean;
  114571. /**
  114572. * Defines if webgl2 should be turned off even if supported
  114573. * @see https://doc.babylonjs.com/features/webgl2
  114574. */
  114575. disableWebGL2Support?: boolean;
  114576. /**
  114577. * Defines if webaudio should be initialized as well
  114578. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  114579. */
  114580. audioEngine?: boolean;
  114581. /**
  114582. * Defines if animations should run using a deterministic lock step
  114583. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  114584. */
  114585. deterministicLockstep?: boolean;
  114586. /** Defines the maximum steps to use with deterministic lock step mode */
  114587. lockstepMaxSteps?: number;
  114588. /** Defines the seconds between each deterministic lock step */
  114589. timeStep?: number;
  114590. /**
  114591. * Defines that engine should ignore context lost events
  114592. * If this event happens when this parameter is true, you will have to reload the page to restore rendering
  114593. */
  114594. doNotHandleContextLost?: boolean;
  114595. /**
  114596. * Defines that engine should ignore modifying touch action attribute and style
  114597. * If not handle, you might need to set it up on your side for expected touch devices behavior.
  114598. */
  114599. doNotHandleTouchAction?: boolean;
  114600. /**
  114601. * Defines that engine should compile shaders with high precision floats (if supported). True by default
  114602. */
  114603. useHighPrecisionFloats?: boolean;
  114604. /**
  114605. * Make the canvas XR Compatible for XR sessions
  114606. */
  114607. xrCompatible?: boolean;
  114608. /**
  114609. * Make the matrix computations to be performed in 64 bits instead of 32 bits. False by default
  114610. */
  114611. useHighPrecisionMatrix?: boolean;
  114612. }
  114613. /**
  114614. * The base engine class (root of all engines)
  114615. */
  114616. export class ThinEngine {
  114617. /** Use this array to turn off some WebGL2 features on known buggy browsers version */
  114618. static ExceptionList: ({
  114619. key: string;
  114620. capture: string;
  114621. captureConstraint: number;
  114622. targets: string[];
  114623. } | {
  114624. key: string;
  114625. capture: null;
  114626. captureConstraint: null;
  114627. targets: string[];
  114628. })[];
  114629. /** @hidden */
  114630. static _TextureLoaders: IInternalTextureLoader[];
  114631. /**
  114632. * Returns the current npm package of the sdk
  114633. */
  114634. static get NpmPackage(): string;
  114635. /**
  114636. * Returns the current version of the framework
  114637. */
  114638. static get Version(): string;
  114639. /**
  114640. * Returns a string describing the current engine
  114641. */
  114642. get description(): string;
  114643. /**
  114644. * Gets or sets the epsilon value used by collision engine
  114645. */
  114646. static CollisionsEpsilon: number;
  114647. /**
  114648. * Gets or sets the relative url used to load shaders if using the engine in non-minified mode
  114649. */
  114650. static get ShadersRepository(): string;
  114651. static set ShadersRepository(value: string);
  114652. /** @hidden */
  114653. _shaderProcessor: IShaderProcessor;
  114654. /**
  114655. * Gets or sets a boolean that indicates if textures must be forced to power of 2 size even if not required
  114656. */
  114657. forcePOTTextures: boolean;
  114658. /**
  114659. * Gets a boolean indicating if the engine is currently rendering in fullscreen mode
  114660. */
  114661. isFullscreen: boolean;
  114662. /**
  114663. * Gets or sets a boolean indicating if back faces must be culled (true by default)
  114664. */
  114665. cullBackFaces: boolean;
  114666. /**
  114667. * Gets or sets a boolean indicating if the engine must keep rendering even if the window is not in foregroun
  114668. */
  114669. renderEvenInBackground: boolean;
  114670. /**
  114671. * Gets or sets a boolean indicating that cache can be kept between frames
  114672. */
  114673. preventCacheWipeBetweenFrames: boolean;
  114674. /** Gets or sets a boolean indicating if the engine should validate programs after compilation */
  114675. validateShaderPrograms: boolean;
  114676. /**
  114677. * Gets or sets a boolean indicating if depth buffer should be reverse, going from far to near.
  114678. * This can provide greater z depth for distant objects.
  114679. */
  114680. useReverseDepthBuffer: boolean;
  114681. /**
  114682. * Gets or sets a boolean indicating that uniform buffers must be disabled even if they are supported
  114683. */
  114684. disableUniformBuffers: boolean;
  114685. /** @hidden */
  114686. _uniformBuffers: UniformBuffer[];
  114687. /**
  114688. * Gets a boolean indicating that the engine supports uniform buffers
  114689. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  114690. */
  114691. get supportsUniformBuffers(): boolean;
  114692. /** @hidden */
  114693. _gl: WebGLRenderingContext;
  114694. /** @hidden */
  114695. _webGLVersion: number;
  114696. protected _renderingCanvas: Nullable<HTMLCanvasElement>;
  114697. protected _windowIsBackground: boolean;
  114698. protected _creationOptions: EngineOptions;
  114699. protected _highPrecisionShadersAllowed: boolean;
  114700. /** @hidden */
  114701. get _shouldUseHighPrecisionShader(): boolean;
  114702. /**
  114703. * Gets a boolean indicating that only power of 2 textures are supported
  114704. * Please note that you can still use non power of 2 textures but in this case the engine will forcefully convert them
  114705. */
  114706. get needPOTTextures(): boolean;
  114707. /** @hidden */
  114708. _badOS: boolean;
  114709. /** @hidden */
  114710. _badDesktopOS: boolean;
  114711. private _hardwareScalingLevel;
  114712. /** @hidden */
  114713. _caps: EngineCapabilities;
  114714. private _isStencilEnable;
  114715. private _glVersion;
  114716. private _glRenderer;
  114717. private _glVendor;
  114718. /** @hidden */
  114719. _videoTextureSupported: boolean;
  114720. protected _renderingQueueLaunched: boolean;
  114721. protected _activeRenderLoops: (() => void)[];
  114722. /**
  114723. * Observable signaled when a context lost event is raised
  114724. */
  114725. onContextLostObservable: Observable<ThinEngine>;
  114726. /**
  114727. * Observable signaled when a context restored event is raised
  114728. */
  114729. onContextRestoredObservable: Observable<ThinEngine>;
  114730. private _onContextLost;
  114731. private _onContextRestored;
  114732. protected _contextWasLost: boolean;
  114733. /** @hidden */
  114734. _doNotHandleContextLost: boolean;
  114735. /**
  114736. * Gets or sets a boolean indicating if resources should be retained to be able to handle context lost events
  114737. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#handling-webgl-context-lost
  114738. */
  114739. get doNotHandleContextLost(): boolean;
  114740. set doNotHandleContextLost(value: boolean);
  114741. /**
  114742. * Gets or sets a boolean indicating that vertex array object must be disabled even if they are supported
  114743. */
  114744. disableVertexArrayObjects: boolean;
  114745. /** @hidden */
  114746. protected _colorWrite: boolean;
  114747. /** @hidden */
  114748. protected _colorWriteChanged: boolean;
  114749. /** @hidden */
  114750. protected _depthCullingState: DepthCullingState;
  114751. /** @hidden */
  114752. protected _stencilState: StencilState;
  114753. /** @hidden */
  114754. _alphaState: AlphaState;
  114755. /** @hidden */
  114756. _alphaMode: number;
  114757. /** @hidden */
  114758. _alphaEquation: number;
  114759. /** @hidden */
  114760. _internalTexturesCache: InternalTexture[];
  114761. /** @hidden */
  114762. protected _activeChannel: number;
  114763. private _currentTextureChannel;
  114764. /** @hidden */
  114765. protected _boundTexturesCache: {
  114766. [key: string]: Nullable<InternalTexture>;
  114767. };
  114768. /** @hidden */
  114769. protected _currentEffect: Nullable<Effect>;
  114770. /** @hidden */
  114771. protected _currentProgram: Nullable<WebGLProgram>;
  114772. private _compiledEffects;
  114773. private _vertexAttribArraysEnabled;
  114774. /** @hidden */
  114775. protected _cachedViewport: Nullable<IViewportLike>;
  114776. private _cachedVertexArrayObject;
  114777. /** @hidden */
  114778. protected _cachedVertexBuffers: any;
  114779. /** @hidden */
  114780. protected _cachedIndexBuffer: Nullable<DataBuffer>;
  114781. /** @hidden */
  114782. protected _cachedEffectForVertexBuffers: Nullable<Effect>;
  114783. /** @hidden */
  114784. _currentRenderTarget: Nullable<InternalTexture>;
  114785. private _uintIndicesCurrentlySet;
  114786. protected _currentBoundBuffer: Nullable<WebGLBuffer>[];
  114787. /** @hidden */
  114788. _currentFramebuffer: Nullable<WebGLFramebuffer>;
  114789. /** @hidden */
  114790. _dummyFramebuffer: Nullable<WebGLFramebuffer>;
  114791. private _currentBufferPointers;
  114792. private _currentInstanceLocations;
  114793. private _currentInstanceBuffers;
  114794. private _textureUnits;
  114795. /** @hidden */
  114796. _workingCanvas: Nullable<HTMLCanvasElement | OffscreenCanvas>;
  114797. /** @hidden */
  114798. _workingContext: Nullable<CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D>;
  114799. /** @hidden */
  114800. _boundRenderFunction: any;
  114801. private _vaoRecordInProgress;
  114802. private _mustWipeVertexAttributes;
  114803. private _emptyTexture;
  114804. private _emptyCubeTexture;
  114805. private _emptyTexture3D;
  114806. private _emptyTexture2DArray;
  114807. /** @hidden */
  114808. _frameHandler: number;
  114809. private _nextFreeTextureSlots;
  114810. private _maxSimultaneousTextures;
  114811. private _activeRequests;
  114812. /** @hidden */
  114813. _transformTextureUrl: Nullable<(url: string) => string>;
  114814. /**
  114815. * Gets information about the current host
  114816. */
  114817. hostInformation: HostInformation;
  114818. protected get _supportsHardwareTextureRescaling(): boolean;
  114819. private _framebufferDimensionsObject;
  114820. /**
  114821. * sets the object from which width and height will be taken from when getting render width and height
  114822. * Will fallback to the gl object
  114823. * @param dimensions the framebuffer width and height that will be used.
  114824. */
  114825. set framebufferDimensionsObject(dimensions: Nullable<{
  114826. framebufferWidth: number;
  114827. framebufferHeight: number;
  114828. }>);
  114829. /**
  114830. * Gets the current viewport
  114831. */
  114832. get currentViewport(): Nullable<IViewportLike>;
  114833. /**
  114834. * Gets the default empty texture
  114835. */
  114836. get emptyTexture(): InternalTexture;
  114837. /**
  114838. * Gets the default empty 3D texture
  114839. */
  114840. get emptyTexture3D(): InternalTexture;
  114841. /**
  114842. * Gets the default empty 2D array texture
  114843. */
  114844. get emptyTexture2DArray(): InternalTexture;
  114845. /**
  114846. * Gets the default empty cube texture
  114847. */
  114848. get emptyCubeTexture(): InternalTexture;
  114849. /**
  114850. * Defines whether the engine has been created with the premultipliedAlpha option on or not.
  114851. */
  114852. readonly premultipliedAlpha: boolean;
  114853. /**
  114854. * Observable event triggered before each texture is initialized
  114855. */
  114856. onBeforeTextureInitObservable: Observable<Texture>;
  114857. /**
  114858. * Creates a new engine
  114859. * @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
  114860. * @param antialias defines enable antialiasing (default: false)
  114861. * @param options defines further options to be sent to the getContext() function
  114862. * @param adaptToDeviceRatio defines whether to adapt to the device's viewport characteristics (default: false)
  114863. */
  114864. constructor(canvasOrContext: Nullable<HTMLCanvasElement | WebGLRenderingContext | WebGL2RenderingContext>, antialias?: boolean, options?: EngineOptions, adaptToDeviceRatio?: boolean);
  114865. private _rebuildInternalTextures;
  114866. private _rebuildEffects;
  114867. /**
  114868. * Gets a boolean indicating if all created effects are ready
  114869. * @returns true if all effects are ready
  114870. */
  114871. areAllEffectsReady(): boolean;
  114872. protected _rebuildBuffers(): void;
  114873. protected _initGLContext(): void;
  114874. /**
  114875. * Gets version of the current webGL context
  114876. */
  114877. get webGLVersion(): number;
  114878. /**
  114879. * Gets a string identifying the name of the class
  114880. * @returns "Engine" string
  114881. */
  114882. getClassName(): string;
  114883. /**
  114884. * Returns true if the stencil buffer has been enabled through the creation option of the context.
  114885. */
  114886. get isStencilEnable(): boolean;
  114887. /** @hidden */
  114888. _prepareWorkingCanvas(): void;
  114889. /**
  114890. * Reset the texture cache to empty state
  114891. */
  114892. resetTextureCache(): void;
  114893. /**
  114894. * Gets an object containing information about the current webGL context
  114895. * @returns an object containing the vender, the renderer and the version of the current webGL context
  114896. */
  114897. getGlInfo(): {
  114898. vendor: string;
  114899. renderer: string;
  114900. version: string;
  114901. };
  114902. /**
  114903. * Defines the hardware scaling level.
  114904. * By default the hardware scaling level is computed from the window device ratio.
  114905. * 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.
  114906. * @param level defines the level to use
  114907. */
  114908. setHardwareScalingLevel(level: number): void;
  114909. /**
  114910. * Gets the current hardware scaling level.
  114911. * By default the hardware scaling level is computed from the window device ratio.
  114912. * 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.
  114913. * @returns a number indicating the current hardware scaling level
  114914. */
  114915. getHardwareScalingLevel(): number;
  114916. /**
  114917. * Gets the list of loaded textures
  114918. * @returns an array containing all loaded textures
  114919. */
  114920. getLoadedTexturesCache(): InternalTexture[];
  114921. /**
  114922. * Gets the object containing all engine capabilities
  114923. * @returns the EngineCapabilities object
  114924. */
  114925. getCaps(): EngineCapabilities;
  114926. /**
  114927. * stop executing a render loop function and remove it from the execution array
  114928. * @param renderFunction defines the function to be removed. If not provided all functions will be removed.
  114929. */
  114930. stopRenderLoop(renderFunction?: () => void): void;
  114931. /** @hidden */
  114932. _renderLoop(): void;
  114933. /**
  114934. * Gets the HTML canvas attached with the current webGL context
  114935. * @returns a HTML canvas
  114936. */
  114937. getRenderingCanvas(): Nullable<HTMLCanvasElement>;
  114938. /**
  114939. * Gets host window
  114940. * @returns the host window object
  114941. */
  114942. getHostWindow(): Nullable<Window>;
  114943. /**
  114944. * Gets the current render width
  114945. * @param useScreen defines if screen size must be used (or the current render target if any)
  114946. * @returns a number defining the current render width
  114947. */
  114948. getRenderWidth(useScreen?: boolean): number;
  114949. /**
  114950. * Gets the current render height
  114951. * @param useScreen defines if screen size must be used (or the current render target if any)
  114952. * @returns a number defining the current render height
  114953. */
  114954. getRenderHeight(useScreen?: boolean): number;
  114955. /**
  114956. * Can be used to override the current requestAnimationFrame requester.
  114957. * @hidden
  114958. */
  114959. protected _queueNewFrame(bindedRenderFunction: any, requester?: any): number;
  114960. /**
  114961. * Register and execute a render loop. The engine can have more than one render function
  114962. * @param renderFunction defines the function to continuously execute
  114963. */
  114964. runRenderLoop(renderFunction: () => void): void;
  114965. /**
  114966. * Clear the current render buffer or the current render target (if any is set up)
  114967. * @param color defines the color to use
  114968. * @param backBuffer defines if the back buffer must be cleared
  114969. * @param depth defines if the depth buffer must be cleared
  114970. * @param stencil defines if the stencil buffer must be cleared
  114971. */
  114972. clear(color: Nullable<IColor4Like>, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  114973. private _viewportCached;
  114974. /** @hidden */
  114975. _viewport(x: number, y: number, width: number, height: number): void;
  114976. /**
  114977. * Set the WebGL's viewport
  114978. * @param viewport defines the viewport element to be used
  114979. * @param requiredWidth defines the width required for rendering. If not provided the rendering canvas' width is used
  114980. * @param requiredHeight defines the height required for rendering. If not provided the rendering canvas' height is used
  114981. */
  114982. setViewport(viewport: IViewportLike, requiredWidth?: number, requiredHeight?: number): void;
  114983. /**
  114984. * Begin a new frame
  114985. */
  114986. beginFrame(): void;
  114987. /**
  114988. * Enf the current frame
  114989. */
  114990. endFrame(): void;
  114991. /**
  114992. * Resize the view according to the canvas' size
  114993. */
  114994. resize(): void;
  114995. /**
  114996. * Force a specific size of the canvas
  114997. * @param width defines the new canvas' width
  114998. * @param height defines the new canvas' height
  114999. * @returns true if the size was changed
  115000. */
  115001. setSize(width: number, height: number): boolean;
  115002. /**
  115003. * Binds the frame buffer to the specified texture.
  115004. * @param texture The texture to render to or null for the default canvas
  115005. * @param faceIndex The face of the texture to render to in case of cube texture
  115006. * @param requiredWidth The width of the target to render to
  115007. * @param requiredHeight The height of the target to render to
  115008. * @param forceFullscreenViewport Forces the viewport to be the entire texture/screen if true
  115009. * @param lodLevel defines the lod level to bind to the frame buffer
  115010. * @param layer defines the 2d array index to bind to frame buffer to
  115011. */
  115012. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean, lodLevel?: number, layer?: number): void;
  115013. /** @hidden */
  115014. _bindUnboundFramebuffer(framebuffer: Nullable<WebGLFramebuffer>): void;
  115015. /**
  115016. * Unbind the current render target texture from the webGL context
  115017. * @param texture defines the render target texture to unbind
  115018. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  115019. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  115020. */
  115021. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  115022. /**
  115023. * Force a webGL flush (ie. a flush of all waiting webGL commands)
  115024. */
  115025. flushFramebuffer(): void;
  115026. /**
  115027. * Unbind the current render target and bind the default framebuffer
  115028. */
  115029. restoreDefaultFramebuffer(): void;
  115030. /** @hidden */
  115031. protected _resetVertexBufferBinding(): void;
  115032. /**
  115033. * Creates a vertex buffer
  115034. * @param data the data for the vertex buffer
  115035. * @returns the new WebGL static buffer
  115036. */
  115037. createVertexBuffer(data: DataArray): DataBuffer;
  115038. private _createVertexBuffer;
  115039. /**
  115040. * Creates a dynamic vertex buffer
  115041. * @param data the data for the dynamic vertex buffer
  115042. * @returns the new WebGL dynamic buffer
  115043. */
  115044. createDynamicVertexBuffer(data: DataArray): DataBuffer;
  115045. protected _resetIndexBufferBinding(): void;
  115046. /**
  115047. * Creates a new index buffer
  115048. * @param indices defines the content of the index buffer
  115049. * @param updatable defines if the index buffer must be updatable
  115050. * @returns a new webGL buffer
  115051. */
  115052. createIndexBuffer(indices: IndicesArray, updatable?: boolean): DataBuffer;
  115053. protected _normalizeIndexData(indices: IndicesArray): Uint16Array | Uint32Array;
  115054. /**
  115055. * Bind a webGL buffer to the webGL context
  115056. * @param buffer defines the buffer to bind
  115057. */
  115058. bindArrayBuffer(buffer: Nullable<DataBuffer>): void;
  115059. protected bindIndexBuffer(buffer: Nullable<DataBuffer>): void;
  115060. private bindBuffer;
  115061. /**
  115062. * update the bound buffer with the given data
  115063. * @param data defines the data to update
  115064. */
  115065. updateArrayBuffer(data: Float32Array): void;
  115066. private _vertexAttribPointer;
  115067. /** @hidden */
  115068. _bindIndexBufferWithCache(indexBuffer: Nullable<DataBuffer>): void;
  115069. private _bindVertexBuffersAttributes;
  115070. /**
  115071. * Records a vertex array object
  115072. * @see https://doc.babylonjs.com/features/webgl2#vertex-array-objects
  115073. * @param vertexBuffers defines the list of vertex buffers to store
  115074. * @param indexBuffer defines the index buffer to store
  115075. * @param effect defines the effect to store
  115076. * @returns the new vertex array object
  115077. */
  115078. recordVertexArrayObject(vertexBuffers: {
  115079. [key: string]: VertexBuffer;
  115080. }, indexBuffer: Nullable<DataBuffer>, effect: Effect): WebGLVertexArrayObject;
  115081. /**
  115082. * Bind a specific vertex array object
  115083. * @see https://doc.babylonjs.com/features/webgl2#vertex-array-objects
  115084. * @param vertexArrayObject defines the vertex array object to bind
  115085. * @param indexBuffer defines the index buffer to bind
  115086. */
  115087. bindVertexArrayObject(vertexArrayObject: WebGLVertexArrayObject, indexBuffer: Nullable<DataBuffer>): void;
  115088. /**
  115089. * Bind webGl buffers directly to the webGL context
  115090. * @param vertexBuffer defines the vertex buffer to bind
  115091. * @param indexBuffer defines the index buffer to bind
  115092. * @param vertexDeclaration defines the vertex declaration to use with the vertex buffer
  115093. * @param vertexStrideSize defines the vertex stride of the vertex buffer
  115094. * @param effect defines the effect associated with the vertex buffer
  115095. */
  115096. bindBuffersDirectly(vertexBuffer: DataBuffer, indexBuffer: DataBuffer, vertexDeclaration: number[], vertexStrideSize: number, effect: Effect): void;
  115097. private _unbindVertexArrayObject;
  115098. /**
  115099. * Bind a list of vertex buffers to the webGL context
  115100. * @param vertexBuffers defines the list of vertex buffers to bind
  115101. * @param indexBuffer defines the index buffer to bind
  115102. * @param effect defines the effect associated with the vertex buffers
  115103. */
  115104. bindBuffers(vertexBuffers: {
  115105. [key: string]: Nullable<VertexBuffer>;
  115106. }, indexBuffer: Nullable<DataBuffer>, effect: Effect): void;
  115107. /**
  115108. * Unbind all instance attributes
  115109. */
  115110. unbindInstanceAttributes(): void;
  115111. /**
  115112. * Release and free the memory of a vertex array object
  115113. * @param vao defines the vertex array object to delete
  115114. */
  115115. releaseVertexArrayObject(vao: WebGLVertexArrayObject): void;
  115116. /** @hidden */
  115117. _releaseBuffer(buffer: DataBuffer): boolean;
  115118. protected _deleteBuffer(buffer: DataBuffer): void;
  115119. /**
  115120. * Update the content of a webGL buffer used with instanciation and bind it to the webGL context
  115121. * @param instancesBuffer defines the webGL buffer to update and bind
  115122. * @param data defines the data to store in the buffer
  115123. * @param offsetLocations defines the offsets or attributes information used to determine where data must be stored in the buffer
  115124. */
  115125. updateAndBindInstancesBuffer(instancesBuffer: DataBuffer, data: Float32Array, offsetLocations: number[] | InstancingAttributeInfo[]): void;
  115126. /**
  115127. * Bind the content of a webGL buffer used with instantiation
  115128. * @param instancesBuffer defines the webGL buffer to bind
  115129. * @param attributesInfo defines the offsets or attributes information used to determine where data must be stored in the buffer
  115130. * @param computeStride defines Whether to compute the strides from the info or use the default 0
  115131. */
  115132. bindInstancesBuffer(instancesBuffer: DataBuffer, attributesInfo: InstancingAttributeInfo[], computeStride?: boolean): void;
  115133. /**
  115134. * Disable the instance attribute corresponding to the name in parameter
  115135. * @param name defines the name of the attribute to disable
  115136. */
  115137. disableInstanceAttributeByName(name: string): void;
  115138. /**
  115139. * Disable the instance attribute corresponding to the location in parameter
  115140. * @param attributeLocation defines the attribute location of the attribute to disable
  115141. */
  115142. disableInstanceAttribute(attributeLocation: number): void;
  115143. /**
  115144. * Disable the attribute corresponding to the location in parameter
  115145. * @param attributeLocation defines the attribute location of the attribute to disable
  115146. */
  115147. disableAttributeByIndex(attributeLocation: number): void;
  115148. /**
  115149. * Send a draw order
  115150. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  115151. * @param indexStart defines the starting index
  115152. * @param indexCount defines the number of index to draw
  115153. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  115154. */
  115155. draw(useTriangles: boolean, indexStart: number, indexCount: number, instancesCount?: number): void;
  115156. /**
  115157. * Draw a list of points
  115158. * @param verticesStart defines the index of first vertex to draw
  115159. * @param verticesCount defines the count of vertices to draw
  115160. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  115161. */
  115162. drawPointClouds(verticesStart: number, verticesCount: number, instancesCount?: number): void;
  115163. /**
  115164. * Draw a list of unindexed primitives
  115165. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  115166. * @param verticesStart defines the index of first vertex to draw
  115167. * @param verticesCount defines the count of vertices to draw
  115168. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  115169. */
  115170. drawUnIndexed(useTriangles: boolean, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  115171. /**
  115172. * Draw a list of indexed primitives
  115173. * @param fillMode defines the primitive to use
  115174. * @param indexStart defines the starting index
  115175. * @param indexCount defines the number of index to draw
  115176. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  115177. */
  115178. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  115179. /**
  115180. * Draw a list of unindexed primitives
  115181. * @param fillMode defines the primitive to use
  115182. * @param verticesStart defines the index of first vertex to draw
  115183. * @param verticesCount defines the count of vertices to draw
  115184. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  115185. */
  115186. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  115187. private _drawMode;
  115188. /** @hidden */
  115189. protected _reportDrawCall(): void;
  115190. /** @hidden */
  115191. _releaseEffect(effect: Effect): void;
  115192. /** @hidden */
  115193. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  115194. /**
  115195. * Create a new effect (used to store vertex/fragment shaders)
  115196. * @param baseName defines the base name of the effect (The name of file without .fragment.fx or .vertex.fx)
  115197. * @param attributesNamesOrOptions defines either a list of attribute names or an IEffectCreationOptions object
  115198. * @param uniformsNamesOrEngine defines either a list of uniform names or the engine to use
  115199. * @param samplers defines an array of string used to represent textures
  115200. * @param defines defines the string containing the defines to use to compile the shaders
  115201. * @param fallbacks defines the list of potential fallbacks to use if shader conmpilation fails
  115202. * @param onCompiled defines a function to call when the effect creation is successful
  115203. * @param onError defines a function to call when the effect creation has failed
  115204. * @param indexParameters defines an object containing the index values to use to compile shaders (like the maximum number of simultaneous lights)
  115205. * @returns the new Effect
  115206. */
  115207. 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;
  115208. protected static _ConcatenateShader(source: string, defines: Nullable<string>, shaderVersion?: string): string;
  115209. private _compileShader;
  115210. private _compileRawShader;
  115211. /** @hidden */
  115212. _getShaderSource(shader: WebGLShader): Nullable<string>;
  115213. /**
  115214. * Directly creates a webGL program
  115215. * @param pipelineContext defines the pipeline context to attach to
  115216. * @param vertexCode defines the vertex shader code to use
  115217. * @param fragmentCode defines the fragment shader code to use
  115218. * @param context defines the webGL context to use (if not set, the current one will be used)
  115219. * @param transformFeedbackVaryings defines the list of transform feedback varyings to use
  115220. * @returns the new webGL program
  115221. */
  115222. createRawShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  115223. /**
  115224. * Creates a webGL program
  115225. * @param pipelineContext defines the pipeline context to attach to
  115226. * @param vertexCode defines the vertex shader code to use
  115227. * @param fragmentCode defines the fragment shader code to use
  115228. * @param defines defines the string containing the defines to use to compile the shaders
  115229. * @param context defines the webGL context to use (if not set, the current one will be used)
  115230. * @param transformFeedbackVaryings defines the list of transform feedback varyings to use
  115231. * @returns the new webGL program
  115232. */
  115233. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  115234. /**
  115235. * Creates a new pipeline context
  115236. * @returns the new pipeline
  115237. */
  115238. createPipelineContext(): IPipelineContext;
  115239. protected _createShaderProgram(pipelineContext: WebGLPipelineContext, vertexShader: WebGLShader, fragmentShader: WebGLShader, context: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  115240. protected _finalizePipelineContext(pipelineContext: WebGLPipelineContext): void;
  115241. /** @hidden */
  115242. _preparePipelineContext(pipelineContext: IPipelineContext, vertexSourceCode: string, fragmentSourceCode: string, createAsRaw: boolean, rebuildRebind: any, defines: Nullable<string>, transformFeedbackVaryings: Nullable<string[]>): void;
  115243. /** @hidden */
  115244. _isRenderingStateCompiled(pipelineContext: IPipelineContext): boolean;
  115245. /** @hidden */
  115246. _executeWhenRenderingStateIsCompiled(pipelineContext: IPipelineContext, action: () => void): void;
  115247. /**
  115248. * Gets the list of webGL uniform locations associated with a specific program based on a list of uniform names
  115249. * @param pipelineContext defines the pipeline context to use
  115250. * @param uniformsNames defines the list of uniform names
  115251. * @returns an array of webGL uniform locations
  115252. */
  115253. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): Nullable<WebGLUniformLocation>[];
  115254. /**
  115255. * Gets the lsit of active attributes for a given webGL program
  115256. * @param pipelineContext defines the pipeline context to use
  115257. * @param attributesNames defines the list of attribute names to get
  115258. * @returns an array of indices indicating the offset of each attribute
  115259. */
  115260. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  115261. /**
  115262. * Activates an effect, mkaing it the current one (ie. the one used for rendering)
  115263. * @param effect defines the effect to activate
  115264. */
  115265. enableEffect(effect: Nullable<Effect>): void;
  115266. /**
  115267. * Set the value of an uniform to a number (int)
  115268. * @param uniform defines the webGL uniform location where to store the value
  115269. * @param value defines the int number to store
  115270. */
  115271. setInt(uniform: Nullable<WebGLUniformLocation>, value: number): void;
  115272. /**
  115273. * Set the value of an uniform to an array of int32
  115274. * @param uniform defines the webGL uniform location where to store the value
  115275. * @param array defines the array of int32 to store
  115276. */
  115277. setIntArray(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  115278. /**
  115279. * Set the value of an uniform to an array of int32 (stored as vec2)
  115280. * @param uniform defines the webGL uniform location where to store the value
  115281. * @param array defines the array of int32 to store
  115282. */
  115283. setIntArray2(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  115284. /**
  115285. * Set the value of an uniform to an array of int32 (stored as vec3)
  115286. * @param uniform defines the webGL uniform location where to store the value
  115287. * @param array defines the array of int32 to store
  115288. */
  115289. setIntArray3(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  115290. /**
  115291. * Set the value of an uniform to an array of int32 (stored as vec4)
  115292. * @param uniform defines the webGL uniform location where to store the value
  115293. * @param array defines the array of int32 to store
  115294. */
  115295. setIntArray4(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  115296. /**
  115297. * Set the value of an uniform to an array of number
  115298. * @param uniform defines the webGL uniform location where to store the value
  115299. * @param array defines the array of number to store
  115300. */
  115301. setArray(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  115302. /**
  115303. * Set the value of an uniform to an array of number (stored as vec2)
  115304. * @param uniform defines the webGL uniform location where to store the value
  115305. * @param array defines the array of number to store
  115306. */
  115307. setArray2(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  115308. /**
  115309. * Set the value of an uniform to an array of number (stored as vec3)
  115310. * @param uniform defines the webGL uniform location where to store the value
  115311. * @param array defines the array of number to store
  115312. */
  115313. setArray3(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  115314. /**
  115315. * Set the value of an uniform to an array of number (stored as vec4)
  115316. * @param uniform defines the webGL uniform location where to store the value
  115317. * @param array defines the array of number to store
  115318. */
  115319. setArray4(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  115320. /**
  115321. * Set the value of an uniform to an array of float32 (stored as matrices)
  115322. * @param uniform defines the webGL uniform location where to store the value
  115323. * @param matrices defines the array of float32 to store
  115324. */
  115325. setMatrices(uniform: Nullable<WebGLUniformLocation>, matrices: Float32Array): void;
  115326. /**
  115327. * Set the value of an uniform to a matrix (3x3)
  115328. * @param uniform defines the webGL uniform location where to store the value
  115329. * @param matrix defines the Float32Array representing the 3x3 matrix to store
  115330. */
  115331. setMatrix3x3(uniform: Nullable<WebGLUniformLocation>, matrix: Float32Array): void;
  115332. /**
  115333. * Set the value of an uniform to a matrix (2x2)
  115334. * @param uniform defines the webGL uniform location where to store the value
  115335. * @param matrix defines the Float32Array representing the 2x2 matrix to store
  115336. */
  115337. setMatrix2x2(uniform: Nullable<WebGLUniformLocation>, matrix: Float32Array): void;
  115338. /**
  115339. * Set the value of an uniform to a number (float)
  115340. * @param uniform defines the webGL uniform location where to store the value
  115341. * @param value defines the float number to store
  115342. */
  115343. setFloat(uniform: Nullable<WebGLUniformLocation>, value: number): void;
  115344. /**
  115345. * Set the value of an uniform to a vec2
  115346. * @param uniform defines the webGL uniform location where to store the value
  115347. * @param x defines the 1st component of the value
  115348. * @param y defines the 2nd component of the value
  115349. */
  115350. setFloat2(uniform: Nullable<WebGLUniformLocation>, x: number, y: number): void;
  115351. /**
  115352. * Set the value of an uniform to a vec3
  115353. * @param uniform defines the webGL uniform location where to store the value
  115354. * @param x defines the 1st component of the value
  115355. * @param y defines the 2nd component of the value
  115356. * @param z defines the 3rd component of the value
  115357. */
  115358. setFloat3(uniform: Nullable<WebGLUniformLocation>, x: number, y: number, z: number): void;
  115359. /**
  115360. * Set the value of an uniform to a vec4
  115361. * @param uniform defines the webGL uniform location where to store the value
  115362. * @param x defines the 1st component of the value
  115363. * @param y defines the 2nd component of the value
  115364. * @param z defines the 3rd component of the value
  115365. * @param w defines the 4th component of the value
  115366. */
  115367. setFloat4(uniform: Nullable<WebGLUniformLocation>, x: number, y: number, z: number, w: number): void;
  115368. /**
  115369. * Apply all cached states (depth, culling, stencil and alpha)
  115370. */
  115371. applyStates(): void;
  115372. /**
  115373. * Enable or disable color writing
  115374. * @param enable defines the state to set
  115375. */
  115376. setColorWrite(enable: boolean): void;
  115377. /**
  115378. * Gets a boolean indicating if color writing is enabled
  115379. * @returns the current color writing state
  115380. */
  115381. getColorWrite(): boolean;
  115382. /**
  115383. * Gets the depth culling state manager
  115384. */
  115385. get depthCullingState(): DepthCullingState;
  115386. /**
  115387. * Gets the alpha state manager
  115388. */
  115389. get alphaState(): AlphaState;
  115390. /**
  115391. * Gets the stencil state manager
  115392. */
  115393. get stencilState(): StencilState;
  115394. /**
  115395. * Clears the list of texture accessible through engine.
  115396. * This can help preventing texture load conflict due to name collision.
  115397. */
  115398. clearInternalTexturesCache(): void;
  115399. /**
  115400. * Force the entire cache to be cleared
  115401. * You should not have to use this function unless your engine needs to share the webGL context with another engine
  115402. * @param bruteForce defines a boolean to force clearing ALL caches (including stencil, detoh and alpha states)
  115403. */
  115404. wipeCaches(bruteForce?: boolean): void;
  115405. /** @hidden */
  115406. _getSamplingParameters(samplingMode: number, generateMipMaps: boolean): {
  115407. min: number;
  115408. mag: number;
  115409. };
  115410. /** @hidden */
  115411. _createTexture(): WebGLTexture;
  115412. /**
  115413. * Usually called from Texture.ts.
  115414. * Passed information to create a WebGLTexture
  115415. * @param url defines a value which contains one of the following:
  115416. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  115417. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  115418. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  115419. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  115420. * @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)
  115421. * @param scene needed for loading to the correct scene
  115422. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  115423. * @param onLoad optional callback to be called upon successful completion
  115424. * @param onError optional callback to be called upon failure
  115425. * @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
  115426. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  115427. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  115428. * @param forcedExtension defines the extension to use to pick the right loader
  115429. * @param mimeType defines an optional mime type
  115430. * @returns a InternalTexture for assignment back into BABYLON.Texture
  115431. */
  115432. 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;
  115433. /**
  115434. * Loads an image as an HTMLImageElement.
  115435. * @param input url string, ArrayBuffer, or Blob to load
  115436. * @param onLoad callback called when the image successfully loads
  115437. * @param onError callback called when the image fails to load
  115438. * @param offlineProvider offline provider for caching
  115439. * @param mimeType optional mime type
  115440. * @returns the HTMLImageElement of the loaded image
  115441. * @hidden
  115442. */
  115443. 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>;
  115444. /**
  115445. * @hidden
  115446. */
  115447. _rescaleTexture(source: InternalTexture, destination: InternalTexture, scene: Nullable<any>, internalFormat: number, onComplete: () => void): void;
  115448. private _unpackFlipYCached;
  115449. /**
  115450. * In case you are sharing the context with other applications, it might
  115451. * be interested to not cache the unpack flip y state to ensure a consistent
  115452. * value would be set.
  115453. */
  115454. enableUnpackFlipYCached: boolean;
  115455. /** @hidden */
  115456. _unpackFlipY(value: boolean): void;
  115457. /** @hidden */
  115458. _getUnpackAlignement(): number;
  115459. private _getTextureTarget;
  115460. /**
  115461. * Update the sampling mode of a given texture
  115462. * @param samplingMode defines the required sampling mode
  115463. * @param texture defines the texture to update
  115464. * @param generateMipMaps defines whether to generate mipmaps for the texture
  115465. */
  115466. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture, generateMipMaps?: boolean): void;
  115467. /**
  115468. * Update the sampling mode of a given texture
  115469. * @param texture defines the texture to update
  115470. * @param wrapU defines the texture wrap mode of the u coordinates
  115471. * @param wrapV defines the texture wrap mode of the v coordinates
  115472. * @param wrapR defines the texture wrap mode of the r coordinates
  115473. */
  115474. updateTextureWrappingMode(texture: InternalTexture, wrapU: Nullable<number>, wrapV?: Nullable<number>, wrapR?: Nullable<number>): void;
  115475. /** @hidden */
  115476. _setupDepthStencilTexture(internalTexture: InternalTexture, size: number | {
  115477. width: number;
  115478. height: number;
  115479. layers?: number;
  115480. }, generateStencil: boolean, bilinearFiltering: boolean, comparisonFunction: number): void;
  115481. /** @hidden */
  115482. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  115483. /** @hidden */
  115484. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number, babylonInternalFormat?: number, useTextureWidthAndHeight?: boolean): void;
  115485. /**
  115486. * Update a portion of an internal texture
  115487. * @param texture defines the texture to update
  115488. * @param imageData defines the data to store into the texture
  115489. * @param xOffset defines the x coordinates of the update rectangle
  115490. * @param yOffset defines the y coordinates of the update rectangle
  115491. * @param width defines the width of the update rectangle
  115492. * @param height defines the height of the update rectangle
  115493. * @param faceIndex defines the face index if texture is a cube (0 by default)
  115494. * @param lod defines the lod level to update (0 by default)
  115495. */
  115496. updateTextureData(texture: InternalTexture, imageData: ArrayBufferView, xOffset: number, yOffset: number, width: number, height: number, faceIndex?: number, lod?: number): void;
  115497. /** @hidden */
  115498. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  115499. protected _prepareWebGLTextureContinuation(texture: InternalTexture, scene: Nullable<ISceneLike>, noMipmap: boolean, isCompressed: boolean, samplingMode: number): void;
  115500. private _prepareWebGLTexture;
  115501. /** @hidden */
  115502. _setupFramebufferDepthAttachments(generateStencilBuffer: boolean, generateDepthBuffer: boolean, width: number, height: number, samples?: number): Nullable<WebGLRenderbuffer>;
  115503. private _getDepthStencilBuffer;
  115504. /** @hidden */
  115505. _releaseFramebufferObjects(texture: InternalTexture): void;
  115506. /** @hidden */
  115507. _releaseTexture(texture: InternalTexture): void;
  115508. protected _deleteTexture(texture: Nullable<WebGLTexture>): void;
  115509. protected _setProgram(program: WebGLProgram): void;
  115510. protected _boundUniforms: {
  115511. [key: number]: WebGLUniformLocation;
  115512. };
  115513. /**
  115514. * Binds an effect to the webGL context
  115515. * @param effect defines the effect to bind
  115516. */
  115517. bindSamplers(effect: Effect): void;
  115518. private _activateCurrentTexture;
  115519. /** @hidden */
  115520. _bindTextureDirectly(target: number, texture: Nullable<InternalTexture>, forTextureDataUpdate?: boolean, force?: boolean): boolean;
  115521. /** @hidden */
  115522. _bindTexture(channel: number, texture: Nullable<InternalTexture>): void;
  115523. /**
  115524. * Unbind all textures from the webGL context
  115525. */
  115526. unbindAllTextures(): void;
  115527. /**
  115528. * Sets a texture to the according uniform.
  115529. * @param channel The texture channel
  115530. * @param uniform The uniform to set
  115531. * @param texture The texture to apply
  115532. */
  115533. setTexture(channel: number, uniform: Nullable<WebGLUniformLocation>, texture: Nullable<BaseTexture>): void;
  115534. private _bindSamplerUniformToChannel;
  115535. private _getTextureWrapMode;
  115536. protected _setTexture(channel: number, texture: Nullable<BaseTexture>, isPartOfTextureArray?: boolean, depthStencilTexture?: boolean): boolean;
  115537. /**
  115538. * Sets an array of texture to the webGL context
  115539. * @param channel defines the channel where the texture array must be set
  115540. * @param uniform defines the associated uniform location
  115541. * @param textures defines the array of textures to bind
  115542. */
  115543. setTextureArray(channel: number, uniform: Nullable<WebGLUniformLocation>, textures: BaseTexture[]): void;
  115544. /** @hidden */
  115545. _setAnisotropicLevel(target: number, internalTexture: InternalTexture, anisotropicFilteringLevel: number): void;
  115546. private _setTextureParameterFloat;
  115547. private _setTextureParameterInteger;
  115548. /**
  115549. * Unbind all vertex attributes from the webGL context
  115550. */
  115551. unbindAllAttributes(): void;
  115552. /**
  115553. * 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
  115554. */
  115555. releaseEffects(): void;
  115556. /**
  115557. * Dispose and release all associated resources
  115558. */
  115559. dispose(): void;
  115560. /**
  115561. * Attach a new callback raised when context lost event is fired
  115562. * @param callback defines the callback to call
  115563. */
  115564. attachContextLostEvent(callback: ((event: WebGLContextEvent) => void)): void;
  115565. /**
  115566. * Attach a new callback raised when context restored event is fired
  115567. * @param callback defines the callback to call
  115568. */
  115569. attachContextRestoredEvent(callback: ((event: WebGLContextEvent) => void)): void;
  115570. /**
  115571. * Get the current error code of the webGL context
  115572. * @returns the error code
  115573. * @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getError
  115574. */
  115575. getError(): number;
  115576. private _canRenderToFloatFramebuffer;
  115577. private _canRenderToHalfFloatFramebuffer;
  115578. private _canRenderToFramebuffer;
  115579. /** @hidden */
  115580. _getWebGLTextureType(type: number): number;
  115581. /** @hidden */
  115582. _getInternalFormat(format: number): number;
  115583. /** @hidden */
  115584. _getRGBABufferInternalSizedFormat(type: number, format?: number): number;
  115585. /** @hidden */
  115586. _getRGBAMultiSampleBufferFormat(type: number): number;
  115587. /** @hidden */
  115588. _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;
  115589. /**
  115590. * Loads a file from a url
  115591. * @param url url to load
  115592. * @param onSuccess callback called when the file successfully loads
  115593. * @param onProgress callback called while file is loading (if the server supports this mode)
  115594. * @param offlineProvider defines the offline provider for caching
  115595. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  115596. * @param onError callback called when the file fails to load
  115597. * @returns a file request object
  115598. * @hidden
  115599. */
  115600. 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;
  115601. /**
  115602. * Reads pixels from the current frame buffer. Please note that this function can be slow
  115603. * @param x defines the x coordinate of the rectangle where pixels must be read
  115604. * @param y defines the y coordinate of the rectangle where pixels must be read
  115605. * @param width defines the width of the rectangle where pixels must be read
  115606. * @param height defines the height of the rectangle where pixels must be read
  115607. * @param hasAlpha defines whether the output should have alpha or not (defaults to true)
  115608. * @returns a Uint8Array containing RGBA colors
  115609. */
  115610. readPixels(x: number, y: number, width: number, height: number, hasAlpha?: boolean): Uint8Array;
  115611. private static _isSupported;
  115612. /**
  115613. * Gets a boolean indicating if the engine can be instanciated (ie. if a webGL context can be found)
  115614. * @returns true if the engine can be created
  115615. * @ignorenaming
  115616. */
  115617. static isSupported(): boolean;
  115618. /**
  115619. * Find the next highest power of two.
  115620. * @param x Number to start search from.
  115621. * @return Next highest power of two.
  115622. */
  115623. static CeilingPOT(x: number): number;
  115624. /**
  115625. * Find the next lowest power of two.
  115626. * @param x Number to start search from.
  115627. * @return Next lowest power of two.
  115628. */
  115629. static FloorPOT(x: number): number;
  115630. /**
  115631. * Find the nearest power of two.
  115632. * @param x Number to start search from.
  115633. * @return Next nearest power of two.
  115634. */
  115635. static NearestPOT(x: number): number;
  115636. /**
  115637. * Get the closest exponent of two
  115638. * @param value defines the value to approximate
  115639. * @param max defines the maximum value to return
  115640. * @param mode defines how to define the closest value
  115641. * @returns closest exponent of two of the given value
  115642. */
  115643. static GetExponentOfTwo(value: number, max: number, mode?: number): number;
  115644. /**
  115645. * Queue a new function into the requested animation frame pool (ie. this function will be executed byt the browser for the next frame)
  115646. * @param func - the function to be called
  115647. * @param requester - the object that will request the next frame. Falls back to window.
  115648. * @returns frame number
  115649. */
  115650. static QueueNewFrame(func: () => void, requester?: any): number;
  115651. /**
  115652. * Gets host document
  115653. * @returns the host document object
  115654. */
  115655. getHostDocument(): Nullable<Document>;
  115656. }
  115657. }
  115658. declare module BABYLON {
  115659. /**
  115660. * Class representing spherical harmonics coefficients to the 3rd degree
  115661. */
  115662. export class SphericalHarmonics {
  115663. /**
  115664. * Defines whether or not the harmonics have been prescaled for rendering.
  115665. */
  115666. preScaled: boolean;
  115667. /**
  115668. * The l0,0 coefficients of the spherical harmonics
  115669. */
  115670. l00: Vector3;
  115671. /**
  115672. * The l1,-1 coefficients of the spherical harmonics
  115673. */
  115674. l1_1: Vector3;
  115675. /**
  115676. * The l1,0 coefficients of the spherical harmonics
  115677. */
  115678. l10: Vector3;
  115679. /**
  115680. * The l1,1 coefficients of the spherical harmonics
  115681. */
  115682. l11: Vector3;
  115683. /**
  115684. * The l2,-2 coefficients of the spherical harmonics
  115685. */
  115686. l2_2: Vector3;
  115687. /**
  115688. * The l2,-1 coefficients of the spherical harmonics
  115689. */
  115690. l2_1: Vector3;
  115691. /**
  115692. * The l2,0 coefficients of the spherical harmonics
  115693. */
  115694. l20: Vector3;
  115695. /**
  115696. * The l2,1 coefficients of the spherical harmonics
  115697. */
  115698. l21: Vector3;
  115699. /**
  115700. * The l2,2 coefficients of the spherical harmonics
  115701. */
  115702. l22: Vector3;
  115703. /**
  115704. * Adds a light to the spherical harmonics
  115705. * @param direction the direction of the light
  115706. * @param color the color of the light
  115707. * @param deltaSolidAngle the delta solid angle of the light
  115708. */
  115709. addLight(direction: Vector3, color: Color3, deltaSolidAngle: number): void;
  115710. /**
  115711. * Scales the spherical harmonics by the given amount
  115712. * @param scale the amount to scale
  115713. */
  115714. scaleInPlace(scale: number): void;
  115715. /**
  115716. * Convert from incident radiance (Li) to irradiance (E) by applying convolution with the cosine-weighted hemisphere.
  115717. *
  115718. * ```
  115719. * E_lm = A_l * L_lm
  115720. * ```
  115721. *
  115722. * In spherical harmonics this convolution amounts to scaling factors for each frequency band.
  115723. * This corresponds to equation 5 in "An Efficient Representation for Irradiance Environment Maps", where
  115724. * the scaling factors are given in equation 9.
  115725. */
  115726. convertIncidentRadianceToIrradiance(): void;
  115727. /**
  115728. * Convert from irradiance to outgoing radiance for Lambertian BDRF, suitable for efficient shader evaluation.
  115729. *
  115730. * ```
  115731. * L = (1/pi) * E * rho
  115732. * ```
  115733. *
  115734. * This is done by an additional scale by 1/pi, so is a fairly trivial operation but important conceptually.
  115735. */
  115736. convertIrradianceToLambertianRadiance(): void;
  115737. /**
  115738. * Integrates the reconstruction coefficients directly in to the SH preventing further
  115739. * required operations at run time.
  115740. *
  115741. * This is simply done by scaling back the SH with Ylm constants parameter.
  115742. * The trigonometric part being applied by the shader at run time.
  115743. */
  115744. preScaleForRendering(): void;
  115745. /**
  115746. * Constructs a spherical harmonics from an array.
  115747. * @param data defines the 9x3 coefficients (l00, l1-1, l10, l11, l2-2, l2-1, l20, l21, l22)
  115748. * @returns the spherical harmonics
  115749. */
  115750. static FromArray(data: ArrayLike<ArrayLike<number>>): SphericalHarmonics;
  115751. /**
  115752. * Gets the spherical harmonics from polynomial
  115753. * @param polynomial the spherical polynomial
  115754. * @returns the spherical harmonics
  115755. */
  115756. static FromPolynomial(polynomial: SphericalPolynomial): SphericalHarmonics;
  115757. }
  115758. /**
  115759. * Class representing spherical polynomial coefficients to the 3rd degree
  115760. */
  115761. export class SphericalPolynomial {
  115762. private _harmonics;
  115763. /**
  115764. * The spherical harmonics used to create the polynomials.
  115765. */
  115766. get preScaledHarmonics(): SphericalHarmonics;
  115767. /**
  115768. * The x coefficients of the spherical polynomial
  115769. */
  115770. x: Vector3;
  115771. /**
  115772. * The y coefficients of the spherical polynomial
  115773. */
  115774. y: Vector3;
  115775. /**
  115776. * The z coefficients of the spherical polynomial
  115777. */
  115778. z: Vector3;
  115779. /**
  115780. * The xx coefficients of the spherical polynomial
  115781. */
  115782. xx: Vector3;
  115783. /**
  115784. * The yy coefficients of the spherical polynomial
  115785. */
  115786. yy: Vector3;
  115787. /**
  115788. * The zz coefficients of the spherical polynomial
  115789. */
  115790. zz: Vector3;
  115791. /**
  115792. * The xy coefficients of the spherical polynomial
  115793. */
  115794. xy: Vector3;
  115795. /**
  115796. * The yz coefficients of the spherical polynomial
  115797. */
  115798. yz: Vector3;
  115799. /**
  115800. * The zx coefficients of the spherical polynomial
  115801. */
  115802. zx: Vector3;
  115803. /**
  115804. * Adds an ambient color to the spherical polynomial
  115805. * @param color the color to add
  115806. */
  115807. addAmbient(color: Color3): void;
  115808. /**
  115809. * Scales the spherical polynomial by the given amount
  115810. * @param scale the amount to scale
  115811. */
  115812. scaleInPlace(scale: number): void;
  115813. /**
  115814. * Gets the spherical polynomial from harmonics
  115815. * @param harmonics the spherical harmonics
  115816. * @returns the spherical polynomial
  115817. */
  115818. static FromHarmonics(harmonics: SphericalHarmonics): SphericalPolynomial;
  115819. /**
  115820. * Constructs a spherical polynomial from an array.
  115821. * @param data defines the 9x3 coefficients (x, y, z, xx, yy, zz, yz, zx, xy)
  115822. * @returns the spherical polynomial
  115823. */
  115824. static FromArray(data: ArrayLike<ArrayLike<number>>): SphericalPolynomial;
  115825. }
  115826. }
  115827. declare module BABYLON {
  115828. /**
  115829. * Defines the source of the internal texture
  115830. */
  115831. export enum InternalTextureSource {
  115832. /**
  115833. * The source of the texture data is unknown
  115834. */
  115835. Unknown = 0,
  115836. /**
  115837. * Texture data comes from an URL
  115838. */
  115839. Url = 1,
  115840. /**
  115841. * Texture data is only used for temporary storage
  115842. */
  115843. Temp = 2,
  115844. /**
  115845. * Texture data comes from raw data (ArrayBuffer)
  115846. */
  115847. Raw = 3,
  115848. /**
  115849. * Texture content is dynamic (video or dynamic texture)
  115850. */
  115851. Dynamic = 4,
  115852. /**
  115853. * Texture content is generated by rendering to it
  115854. */
  115855. RenderTarget = 5,
  115856. /**
  115857. * Texture content is part of a multi render target process
  115858. */
  115859. MultiRenderTarget = 6,
  115860. /**
  115861. * Texture data comes from a cube data file
  115862. */
  115863. Cube = 7,
  115864. /**
  115865. * Texture data comes from a raw cube data
  115866. */
  115867. CubeRaw = 8,
  115868. /**
  115869. * Texture data come from a prefiltered cube data file
  115870. */
  115871. CubePrefiltered = 9,
  115872. /**
  115873. * Texture content is raw 3D data
  115874. */
  115875. Raw3D = 10,
  115876. /**
  115877. * Texture content is raw 2D array data
  115878. */
  115879. Raw2DArray = 11,
  115880. /**
  115881. * Texture content is a depth texture
  115882. */
  115883. Depth = 12,
  115884. /**
  115885. * Texture data comes from a raw cube data encoded with RGBD
  115886. */
  115887. CubeRawRGBD = 13
  115888. }
  115889. /**
  115890. * Class used to store data associated with WebGL texture data for the engine
  115891. * This class should not be used directly
  115892. */
  115893. export class InternalTexture {
  115894. /** @hidden */
  115895. static _UpdateRGBDAsync: (internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number) => Promise<void>;
  115896. /**
  115897. * Defines if the texture is ready
  115898. */
  115899. isReady: boolean;
  115900. /**
  115901. * Defines if the texture is a cube texture
  115902. */
  115903. isCube: boolean;
  115904. /**
  115905. * Defines if the texture contains 3D data
  115906. */
  115907. is3D: boolean;
  115908. /**
  115909. * Defines if the texture contains 2D array data
  115910. */
  115911. is2DArray: boolean;
  115912. /**
  115913. * Defines if the texture contains multiview data
  115914. */
  115915. isMultiview: boolean;
  115916. /**
  115917. * Gets the URL used to load this texture
  115918. */
  115919. url: string;
  115920. /**
  115921. * Gets the sampling mode of the texture
  115922. */
  115923. samplingMode: number;
  115924. /**
  115925. * Gets a boolean indicating if the texture needs mipmaps generation
  115926. */
  115927. generateMipMaps: boolean;
  115928. /**
  115929. * Gets the number of samples used by the texture (WebGL2+ only)
  115930. */
  115931. samples: number;
  115932. /**
  115933. * Gets the type of the texture (int, float...)
  115934. */
  115935. type: number;
  115936. /**
  115937. * Gets the format of the texture (RGB, RGBA...)
  115938. */
  115939. format: number;
  115940. /**
  115941. * Observable called when the texture is loaded
  115942. */
  115943. onLoadedObservable: Observable<InternalTexture>;
  115944. /**
  115945. * Gets the width of the texture
  115946. */
  115947. width: number;
  115948. /**
  115949. * Gets the height of the texture
  115950. */
  115951. height: number;
  115952. /**
  115953. * Gets the depth of the texture
  115954. */
  115955. depth: number;
  115956. /**
  115957. * Gets the initial width of the texture (It could be rescaled if the current system does not support non power of two textures)
  115958. */
  115959. baseWidth: number;
  115960. /**
  115961. * Gets the initial height of the texture (It could be rescaled if the current system does not support non power of two textures)
  115962. */
  115963. baseHeight: number;
  115964. /**
  115965. * Gets the initial depth of the texture (It could be rescaled if the current system does not support non power of two textures)
  115966. */
  115967. baseDepth: number;
  115968. /**
  115969. * Gets a boolean indicating if the texture is inverted on Y axis
  115970. */
  115971. invertY: boolean;
  115972. /** @hidden */
  115973. _invertVScale: boolean;
  115974. /** @hidden */
  115975. _associatedChannel: number;
  115976. /** @hidden */
  115977. _source: InternalTextureSource;
  115978. /** @hidden */
  115979. _buffer: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>;
  115980. /** @hidden */
  115981. _bufferView: Nullable<ArrayBufferView>;
  115982. /** @hidden */
  115983. _bufferViewArray: Nullable<ArrayBufferView[]>;
  115984. /** @hidden */
  115985. _bufferViewArrayArray: Nullable<ArrayBufferView[][]>;
  115986. /** @hidden */
  115987. _size: number;
  115988. /** @hidden */
  115989. _extension: string;
  115990. /** @hidden */
  115991. _files: Nullable<string[]>;
  115992. /** @hidden */
  115993. _workingCanvas: Nullable<HTMLCanvasElement | OffscreenCanvas>;
  115994. /** @hidden */
  115995. _workingContext: Nullable<CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D>;
  115996. /** @hidden */
  115997. _framebuffer: Nullable<WebGLFramebuffer>;
  115998. /** @hidden */
  115999. _depthStencilBuffer: Nullable<WebGLRenderbuffer>;
  116000. /** @hidden */
  116001. _MSAAFramebuffer: Nullable<WebGLFramebuffer>;
  116002. /** @hidden */
  116003. _MSAARenderBuffer: Nullable<WebGLRenderbuffer>;
  116004. /** @hidden */
  116005. _attachments: Nullable<number[]>;
  116006. /** @hidden */
  116007. _textureArray: Nullable<InternalTexture[]>;
  116008. /** @hidden */
  116009. _cachedCoordinatesMode: Nullable<number>;
  116010. /** @hidden */
  116011. _cachedWrapU: Nullable<number>;
  116012. /** @hidden */
  116013. _cachedWrapV: Nullable<number>;
  116014. /** @hidden */
  116015. _cachedWrapR: Nullable<number>;
  116016. /** @hidden */
  116017. _cachedAnisotropicFilteringLevel: Nullable<number>;
  116018. /** @hidden */
  116019. _isDisabled: boolean;
  116020. /** @hidden */
  116021. _compression: Nullable<string>;
  116022. /** @hidden */
  116023. _generateStencilBuffer: boolean;
  116024. /** @hidden */
  116025. _generateDepthBuffer: boolean;
  116026. /** @hidden */
  116027. _comparisonFunction: number;
  116028. /** @hidden */
  116029. _sphericalPolynomial: Nullable<SphericalPolynomial>;
  116030. /** @hidden */
  116031. _lodGenerationScale: number;
  116032. /** @hidden */
  116033. _lodGenerationOffset: number;
  116034. /** @hidden */
  116035. _depthStencilTexture: Nullable<InternalTexture>;
  116036. /** @hidden */
  116037. _colorTextureArray: Nullable<WebGLTexture>;
  116038. /** @hidden */
  116039. _depthStencilTextureArray: Nullable<WebGLTexture>;
  116040. /** @hidden */
  116041. _lodTextureHigh: Nullable<BaseTexture>;
  116042. /** @hidden */
  116043. _lodTextureMid: Nullable<BaseTexture>;
  116044. /** @hidden */
  116045. _lodTextureLow: Nullable<BaseTexture>;
  116046. /** @hidden */
  116047. _isRGBD: boolean;
  116048. /** @hidden */
  116049. _linearSpecularLOD: boolean;
  116050. /** @hidden */
  116051. _irradianceTexture: Nullable<BaseTexture>;
  116052. /** @hidden */
  116053. _webGLTexture: Nullable<WebGLTexture>;
  116054. /** @hidden */
  116055. _references: number;
  116056. private _engine;
  116057. /**
  116058. * Gets the Engine the texture belongs to.
  116059. * @returns The babylon engine
  116060. */
  116061. getEngine(): ThinEngine;
  116062. /**
  116063. * Gets the data source type of the texture
  116064. */
  116065. get source(): InternalTextureSource;
  116066. /**
  116067. * Creates a new InternalTexture
  116068. * @param engine defines the engine to use
  116069. * @param source defines the type of data that will be used
  116070. * @param delayAllocation if the texture allocation should be delayed (default: false)
  116071. */
  116072. constructor(engine: ThinEngine, source: InternalTextureSource, delayAllocation?: boolean);
  116073. /**
  116074. * Increments the number of references (ie. the number of Texture that point to it)
  116075. */
  116076. incrementReferences(): void;
  116077. /**
  116078. * Change the size of the texture (not the size of the content)
  116079. * @param width defines the new width
  116080. * @param height defines the new height
  116081. * @param depth defines the new depth (1 by default)
  116082. */
  116083. updateSize(width: int, height: int, depth?: int): void;
  116084. /** @hidden */
  116085. _rebuild(): void;
  116086. /** @hidden */
  116087. _swapAndDie(target: InternalTexture): void;
  116088. /**
  116089. * Dispose the current allocated resources
  116090. */
  116091. dispose(): void;
  116092. }
  116093. }
  116094. declare module BABYLON {
  116095. /**
  116096. * Class used to work with sound analyzer using fast fourier transform (FFT)
  116097. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  116098. */
  116099. export class Analyser {
  116100. /**
  116101. * Gets or sets the smoothing
  116102. * @ignorenaming
  116103. */
  116104. SMOOTHING: number;
  116105. /**
  116106. * Gets or sets the FFT table size
  116107. * @ignorenaming
  116108. */
  116109. FFT_SIZE: number;
  116110. /**
  116111. * Gets or sets the bar graph amplitude
  116112. * @ignorenaming
  116113. */
  116114. BARGRAPHAMPLITUDE: number;
  116115. /**
  116116. * Gets or sets the position of the debug canvas
  116117. * @ignorenaming
  116118. */
  116119. DEBUGCANVASPOS: {
  116120. x: number;
  116121. y: number;
  116122. };
  116123. /**
  116124. * Gets or sets the debug canvas size
  116125. * @ignorenaming
  116126. */
  116127. DEBUGCANVASSIZE: {
  116128. width: number;
  116129. height: number;
  116130. };
  116131. private _byteFreqs;
  116132. private _byteTime;
  116133. private _floatFreqs;
  116134. private _webAudioAnalyser;
  116135. private _debugCanvas;
  116136. private _debugCanvasContext;
  116137. private _scene;
  116138. private _registerFunc;
  116139. private _audioEngine;
  116140. /**
  116141. * Creates a new analyser
  116142. * @param scene defines hosting scene
  116143. */
  116144. constructor(scene: Scene);
  116145. /**
  116146. * Get the number of data values you will have to play with for the visualization
  116147. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/frequencyBinCount
  116148. * @returns a number
  116149. */
  116150. getFrequencyBinCount(): number;
  116151. /**
  116152. * Gets the current frequency data as a byte array
  116153. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData
  116154. * @returns a Uint8Array
  116155. */
  116156. getByteFrequencyData(): Uint8Array;
  116157. /**
  116158. * Gets the current waveform as a byte array
  116159. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteTimeDomainData
  116160. * @returns a Uint8Array
  116161. */
  116162. getByteTimeDomainData(): Uint8Array;
  116163. /**
  116164. * Gets the current frequency data as a float array
  116165. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData
  116166. * @returns a Float32Array
  116167. */
  116168. getFloatFrequencyData(): Float32Array;
  116169. /**
  116170. * Renders the debug canvas
  116171. */
  116172. drawDebugCanvas(): void;
  116173. /**
  116174. * Stops rendering the debug canvas and removes it
  116175. */
  116176. stopDebugCanvas(): void;
  116177. /**
  116178. * Connects two audio nodes
  116179. * @param inputAudioNode defines first node to connect
  116180. * @param outputAudioNode defines second node to connect
  116181. */
  116182. connectAudioNodes(inputAudioNode: AudioNode, outputAudioNode: AudioNode): void;
  116183. /**
  116184. * Releases all associated resources
  116185. */
  116186. dispose(): void;
  116187. }
  116188. }
  116189. declare module BABYLON {
  116190. /**
  116191. * This represents an audio engine and it is responsible
  116192. * to play, synchronize and analyse sounds throughout the application.
  116193. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  116194. */
  116195. export interface IAudioEngine extends IDisposable {
  116196. /**
  116197. * Gets whether the current host supports Web Audio and thus could create AudioContexts.
  116198. */
  116199. readonly canUseWebAudio: boolean;
  116200. /**
  116201. * Gets the current AudioContext if available.
  116202. */
  116203. readonly audioContext: Nullable<AudioContext>;
  116204. /**
  116205. * The master gain node defines the global audio volume of your audio engine.
  116206. */
  116207. readonly masterGain: GainNode;
  116208. /**
  116209. * Gets whether or not mp3 are supported by your browser.
  116210. */
  116211. readonly isMP3supported: boolean;
  116212. /**
  116213. * Gets whether or not ogg are supported by your browser.
  116214. */
  116215. readonly isOGGsupported: boolean;
  116216. /**
  116217. * Defines if Babylon should emit a warning if WebAudio is not supported.
  116218. * @ignoreNaming
  116219. */
  116220. WarnedWebAudioUnsupported: boolean;
  116221. /**
  116222. * Defines if the audio engine relies on a custom unlocked button.
  116223. * In this case, the embedded button will not be displayed.
  116224. */
  116225. useCustomUnlockedButton: boolean;
  116226. /**
  116227. * Gets whether or not the audio engine is unlocked (require first a user gesture on some browser).
  116228. */
  116229. readonly unlocked: boolean;
  116230. /**
  116231. * Event raised when audio has been unlocked on the browser.
  116232. */
  116233. onAudioUnlockedObservable: Observable<AudioEngine>;
  116234. /**
  116235. * Event raised when audio has been locked on the browser.
  116236. */
  116237. onAudioLockedObservable: Observable<AudioEngine>;
  116238. /**
  116239. * Flags the audio engine in Locked state.
  116240. * This happens due to new browser policies preventing audio to autoplay.
  116241. */
  116242. lock(): void;
  116243. /**
  116244. * Unlocks the audio engine once a user action has been done on the dom.
  116245. * This is helpful to resume play once browser policies have been satisfied.
  116246. */
  116247. unlock(): void;
  116248. /**
  116249. * Gets the global volume sets on the master gain.
  116250. * @returns the global volume if set or -1 otherwise
  116251. */
  116252. getGlobalVolume(): number;
  116253. /**
  116254. * Sets the global volume of your experience (sets on the master gain).
  116255. * @param newVolume Defines the new global volume of the application
  116256. */
  116257. setGlobalVolume(newVolume: number): void;
  116258. /**
  116259. * Connect the audio engine to an audio analyser allowing some amazing
  116260. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  116261. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  116262. * @param analyser The analyser to connect to the engine
  116263. */
  116264. connectToAnalyser(analyser: Analyser): void;
  116265. }
  116266. /**
  116267. * This represents the default audio engine used in babylon.
  116268. * It is responsible to play, synchronize and analyse sounds throughout the application.
  116269. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  116270. */
  116271. export class AudioEngine implements IAudioEngine {
  116272. private _audioContext;
  116273. private _audioContextInitialized;
  116274. private _muteButton;
  116275. private _hostElement;
  116276. /**
  116277. * Gets whether the current host supports Web Audio and thus could create AudioContexts.
  116278. */
  116279. canUseWebAudio: boolean;
  116280. /**
  116281. * The master gain node defines the global audio volume of your audio engine.
  116282. */
  116283. masterGain: GainNode;
  116284. /**
  116285. * Defines if Babylon should emit a warning if WebAudio is not supported.
  116286. * @ignoreNaming
  116287. */
  116288. WarnedWebAudioUnsupported: boolean;
  116289. /**
  116290. * Gets whether or not mp3 are supported by your browser.
  116291. */
  116292. isMP3supported: boolean;
  116293. /**
  116294. * Gets whether or not ogg are supported by your browser.
  116295. */
  116296. isOGGsupported: boolean;
  116297. /**
  116298. * Gets whether audio has been unlocked on the device.
  116299. * Some Browsers have strong restrictions about Audio and won t autoplay unless
  116300. * a user interaction has happened.
  116301. */
  116302. unlocked: boolean;
  116303. /**
  116304. * Defines if the audio engine relies on a custom unlocked button.
  116305. * In this case, the embedded button will not be displayed.
  116306. */
  116307. useCustomUnlockedButton: boolean;
  116308. /**
  116309. * Event raised when audio has been unlocked on the browser.
  116310. */
  116311. onAudioUnlockedObservable: Observable<AudioEngine>;
  116312. /**
  116313. * Event raised when audio has been locked on the browser.
  116314. */
  116315. onAudioLockedObservable: Observable<AudioEngine>;
  116316. /**
  116317. * Gets the current AudioContext if available.
  116318. */
  116319. get audioContext(): Nullable<AudioContext>;
  116320. private _connectedAnalyser;
  116321. /**
  116322. * Instantiates a new audio engine.
  116323. *
  116324. * There should be only one per page as some browsers restrict the number
  116325. * of audio contexts you can create.
  116326. * @param hostElement defines the host element where to display the mute icon if necessary
  116327. */
  116328. constructor(hostElement?: Nullable<HTMLElement>);
  116329. /**
  116330. * Flags the audio engine in Locked state.
  116331. * This happens due to new browser policies preventing audio to autoplay.
  116332. */
  116333. lock(): void;
  116334. /**
  116335. * Unlocks the audio engine once a user action has been done on the dom.
  116336. * This is helpful to resume play once browser policies have been satisfied.
  116337. */
  116338. unlock(): void;
  116339. private _resumeAudioContext;
  116340. private _initializeAudioContext;
  116341. private _tryToRun;
  116342. private _triggerRunningState;
  116343. private _triggerSuspendedState;
  116344. private _displayMuteButton;
  116345. private _moveButtonToTopLeft;
  116346. private _onResize;
  116347. private _hideMuteButton;
  116348. /**
  116349. * Destroy and release the resources associated with the audio ccontext.
  116350. */
  116351. dispose(): void;
  116352. /**
  116353. * Gets the global volume sets on the master gain.
  116354. * @returns the global volume if set or -1 otherwise
  116355. */
  116356. getGlobalVolume(): number;
  116357. /**
  116358. * Sets the global volume of your experience (sets on the master gain).
  116359. * @param newVolume Defines the new global volume of the application
  116360. */
  116361. setGlobalVolume(newVolume: number): void;
  116362. /**
  116363. * Connect the audio engine to an audio analyser allowing some amazing
  116364. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  116365. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  116366. * @param analyser The analyser to connect to the engine
  116367. */
  116368. connectToAnalyser(analyser: Analyser): void;
  116369. }
  116370. }
  116371. declare module BABYLON {
  116372. /**
  116373. * Interface used to present a loading screen while loading a scene
  116374. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  116375. */
  116376. export interface ILoadingScreen {
  116377. /**
  116378. * Function called to display the loading screen
  116379. */
  116380. displayLoadingUI: () => void;
  116381. /**
  116382. * Function called to hide the loading screen
  116383. */
  116384. hideLoadingUI: () => void;
  116385. /**
  116386. * Gets or sets the color to use for the background
  116387. */
  116388. loadingUIBackgroundColor: string;
  116389. /**
  116390. * Gets or sets the text to display while loading
  116391. */
  116392. loadingUIText: string;
  116393. }
  116394. /**
  116395. * Class used for the default loading screen
  116396. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  116397. */
  116398. export class DefaultLoadingScreen implements ILoadingScreen {
  116399. private _renderingCanvas;
  116400. private _loadingText;
  116401. private _loadingDivBackgroundColor;
  116402. private _loadingDiv;
  116403. private _loadingTextDiv;
  116404. /** Gets or sets the logo url to use for the default loading screen */
  116405. static DefaultLogoUrl: string;
  116406. /** Gets or sets the spinner url to use for the default loading screen */
  116407. static DefaultSpinnerUrl: string;
  116408. /**
  116409. * Creates a new default loading screen
  116410. * @param _renderingCanvas defines the canvas used to render the scene
  116411. * @param _loadingText defines the default text to display
  116412. * @param _loadingDivBackgroundColor defines the default background color
  116413. */
  116414. constructor(_renderingCanvas: HTMLCanvasElement, _loadingText?: string, _loadingDivBackgroundColor?: string);
  116415. /**
  116416. * Function called to display the loading screen
  116417. */
  116418. displayLoadingUI(): void;
  116419. /**
  116420. * Function called to hide the loading screen
  116421. */
  116422. hideLoadingUI(): void;
  116423. /**
  116424. * Gets or sets the text to display while loading
  116425. */
  116426. set loadingUIText(text: string);
  116427. get loadingUIText(): string;
  116428. /**
  116429. * Gets or sets the color to use for the background
  116430. */
  116431. get loadingUIBackgroundColor(): string;
  116432. set loadingUIBackgroundColor(color: string);
  116433. private _resizeLoadingUI;
  116434. }
  116435. }
  116436. declare module BABYLON {
  116437. /**
  116438. * Interface for any object that can request an animation frame
  116439. */
  116440. export interface ICustomAnimationFrameRequester {
  116441. /**
  116442. * This function will be called when the render loop is ready. If this is not populated, the engine's renderloop function will be called
  116443. */
  116444. renderFunction?: Function;
  116445. /**
  116446. * Called to request the next frame to render to
  116447. * @see https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame
  116448. */
  116449. requestAnimationFrame: Function;
  116450. /**
  116451. * You can pass this value to cancelAnimationFrame() to cancel the refresh callback request
  116452. * @see https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame#Return_value
  116453. */
  116454. requestID?: number;
  116455. }
  116456. }
  116457. declare module BABYLON {
  116458. /**
  116459. * Performance monitor tracks rolling average frame-time and frame-time variance over a user defined sliding-window
  116460. */
  116461. export class PerformanceMonitor {
  116462. private _enabled;
  116463. private _rollingFrameTime;
  116464. private _lastFrameTimeMs;
  116465. /**
  116466. * constructor
  116467. * @param frameSampleSize The number of samples required to saturate the sliding window
  116468. */
  116469. constructor(frameSampleSize?: number);
  116470. /**
  116471. * Samples current frame
  116472. * @param timeMs A timestamp in milliseconds of the current frame to compare with other frames
  116473. */
  116474. sampleFrame(timeMs?: number): void;
  116475. /**
  116476. * Returns the average frame time in milliseconds over the sliding window (or the subset of frames sampled so far)
  116477. */
  116478. get averageFrameTime(): number;
  116479. /**
  116480. * Returns the variance frame time in milliseconds over the sliding window (or the subset of frames sampled so far)
  116481. */
  116482. get averageFrameTimeVariance(): number;
  116483. /**
  116484. * Returns the frame time of the most recent frame
  116485. */
  116486. get instantaneousFrameTime(): number;
  116487. /**
  116488. * Returns the average framerate in frames per second over the sliding window (or the subset of frames sampled so far)
  116489. */
  116490. get averageFPS(): number;
  116491. /**
  116492. * Returns the average framerate in frames per second using the most recent frame time
  116493. */
  116494. get instantaneousFPS(): number;
  116495. /**
  116496. * Returns true if enough samples have been taken to completely fill the sliding window
  116497. */
  116498. get isSaturated(): boolean;
  116499. /**
  116500. * Enables contributions to the sliding window sample set
  116501. */
  116502. enable(): void;
  116503. /**
  116504. * Disables contributions to the sliding window sample set
  116505. * Samples will not be interpolated over the disabled period
  116506. */
  116507. disable(): void;
  116508. /**
  116509. * Returns true if sampling is enabled
  116510. */
  116511. get isEnabled(): boolean;
  116512. /**
  116513. * Resets performance monitor
  116514. */
  116515. reset(): void;
  116516. }
  116517. /**
  116518. * RollingAverage
  116519. *
  116520. * Utility to efficiently compute the rolling average and variance over a sliding window of samples
  116521. */
  116522. export class RollingAverage {
  116523. /**
  116524. * Current average
  116525. */
  116526. average: number;
  116527. /**
  116528. * Current variance
  116529. */
  116530. variance: number;
  116531. protected _samples: Array<number>;
  116532. protected _sampleCount: number;
  116533. protected _pos: number;
  116534. protected _m2: number;
  116535. /**
  116536. * constructor
  116537. * @param length The number of samples required to saturate the sliding window
  116538. */
  116539. constructor(length: number);
  116540. /**
  116541. * Adds a sample to the sample set
  116542. * @param v The sample value
  116543. */
  116544. add(v: number): void;
  116545. /**
  116546. * Returns previously added values or null if outside of history or outside the sliding window domain
  116547. * @param i Index in history. For example, pass 0 for the most recent value and 1 for the value before that
  116548. * @return Value previously recorded with add() or null if outside of range
  116549. */
  116550. history(i: number): number;
  116551. /**
  116552. * Returns true if enough samples have been taken to completely fill the sliding window
  116553. * @return true if sample-set saturated
  116554. */
  116555. isSaturated(): boolean;
  116556. /**
  116557. * Resets the rolling average (equivalent to 0 samples taken so far)
  116558. */
  116559. reset(): void;
  116560. /**
  116561. * Wraps a value around the sample range boundaries
  116562. * @param i Position in sample range, for example if the sample length is 5, and i is -3, then 2 will be returned.
  116563. * @return Wrapped position in sample range
  116564. */
  116565. protected _wrapPosition(i: number): number;
  116566. }
  116567. }
  116568. declare module BABYLON {
  116569. /**
  116570. * This class is used to track a performance counter which is number based.
  116571. * The user has access to many properties which give statistics of different nature.
  116572. *
  116573. * The implementer can track two kinds of Performance Counter: time and count.
  116574. * 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.
  116575. * 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.
  116576. */
  116577. export class PerfCounter {
  116578. /**
  116579. * Gets or sets a global boolean to turn on and off all the counters
  116580. */
  116581. static Enabled: boolean;
  116582. /**
  116583. * Returns the smallest value ever
  116584. */
  116585. get min(): number;
  116586. /**
  116587. * Returns the biggest value ever
  116588. */
  116589. get max(): number;
  116590. /**
  116591. * Returns the average value since the performance counter is running
  116592. */
  116593. get average(): number;
  116594. /**
  116595. * Returns the average value of the last second the counter was monitored
  116596. */
  116597. get lastSecAverage(): number;
  116598. /**
  116599. * Returns the current value
  116600. */
  116601. get current(): number;
  116602. /**
  116603. * Gets the accumulated total
  116604. */
  116605. get total(): number;
  116606. /**
  116607. * Gets the total value count
  116608. */
  116609. get count(): number;
  116610. /**
  116611. * Creates a new counter
  116612. */
  116613. constructor();
  116614. /**
  116615. * Call this method to start monitoring a new frame.
  116616. * 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.
  116617. */
  116618. fetchNewFrame(): void;
  116619. /**
  116620. * Call this method to monitor a count of something (e.g. mesh drawn in viewport count)
  116621. * @param newCount the count value to add to the monitored count
  116622. * @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.
  116623. */
  116624. addCount(newCount: number, fetchResult: boolean): void;
  116625. /**
  116626. * Start monitoring this performance counter
  116627. */
  116628. beginMonitoring(): void;
  116629. /**
  116630. * Compute the time lapsed since the previous beginMonitoring() call.
  116631. * @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
  116632. */
  116633. endMonitoring(newFrame?: boolean): void;
  116634. private _fetchResult;
  116635. private _startMonitoringTime;
  116636. private _min;
  116637. private _max;
  116638. private _average;
  116639. private _current;
  116640. private _totalValueCount;
  116641. private _totalAccumulated;
  116642. private _lastSecAverage;
  116643. private _lastSecAccumulated;
  116644. private _lastSecTime;
  116645. private _lastSecValueCount;
  116646. }
  116647. }
  116648. declare module BABYLON {
  116649. interface ThinEngine {
  116650. /** @hidden */
  116651. _readTexturePixels(texture: InternalTexture, width: number, height: number, faceIndex?: number, level?: number, buffer?: Nullable<ArrayBufferView>): ArrayBufferView;
  116652. }
  116653. }
  116654. declare module BABYLON {
  116655. /**
  116656. * Defines the interface used by display changed events
  116657. */
  116658. export interface IDisplayChangedEventArgs {
  116659. /** Gets the vrDisplay object (if any) */
  116660. vrDisplay: Nullable<any>;
  116661. /** Gets a boolean indicating if webVR is supported */
  116662. vrSupported: boolean;
  116663. }
  116664. /**
  116665. * Defines the interface used by objects containing a viewport (like a camera)
  116666. */
  116667. interface IViewportOwnerLike {
  116668. /**
  116669. * Gets or sets the viewport
  116670. */
  116671. viewport: IViewportLike;
  116672. }
  116673. /**
  116674. * The engine class is responsible for interfacing with all lower-level APIs such as WebGL and Audio
  116675. */
  116676. export class Engine extends ThinEngine {
  116677. /** Defines that alpha blending is disabled */
  116678. static readonly ALPHA_DISABLE: number;
  116679. /** Defines that alpha blending to SRC ALPHA * SRC + DEST */
  116680. static readonly ALPHA_ADD: number;
  116681. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC ALPHA) * DEST */
  116682. static readonly ALPHA_COMBINE: number;
  116683. /** Defines that alpha blending to DEST - SRC * DEST */
  116684. static readonly ALPHA_SUBTRACT: number;
  116685. /** Defines that alpha blending to SRC * DEST */
  116686. static readonly ALPHA_MULTIPLY: number;
  116687. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC) * DEST */
  116688. static readonly ALPHA_MAXIMIZED: number;
  116689. /** Defines that alpha blending to SRC + DEST */
  116690. static readonly ALPHA_ONEONE: number;
  116691. /** Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST */
  116692. static readonly ALPHA_PREMULTIPLIED: number;
  116693. /**
  116694. * Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST
  116695. * Alpha will be set to (1 - SRC ALPHA) * DEST ALPHA
  116696. */
  116697. static readonly ALPHA_PREMULTIPLIED_PORTERDUFF: number;
  116698. /** Defines that alpha blending to CST * SRC + (1 - CST) * DEST */
  116699. static readonly ALPHA_INTERPOLATE: number;
  116700. /**
  116701. * Defines that alpha blending to SRC + (1 - SRC) * DEST
  116702. * Alpha will be set to SRC ALPHA + (1 - SRC ALPHA) * DEST ALPHA
  116703. */
  116704. static readonly ALPHA_SCREENMODE: number;
  116705. /** Defines that the ressource is not delayed*/
  116706. static readonly DELAYLOADSTATE_NONE: number;
  116707. /** Defines that the ressource was successfully delay loaded */
  116708. static readonly DELAYLOADSTATE_LOADED: number;
  116709. /** Defines that the ressource is currently delay loading */
  116710. static readonly DELAYLOADSTATE_LOADING: number;
  116711. /** Defines that the ressource is delayed and has not started loading */
  116712. static readonly DELAYLOADSTATE_NOTLOADED: number;
  116713. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will never pass. i.e. Nothing will be drawn */
  116714. static readonly NEVER: number;
  116715. /** 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 */
  116716. static readonly ALWAYS: number;
  116717. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than the stored value */
  116718. static readonly LESS: number;
  116719. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is equals to the stored value */
  116720. static readonly EQUAL: number;
  116721. /** 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 */
  116722. static readonly LEQUAL: number;
  116723. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than the stored value */
  116724. static readonly GREATER: number;
  116725. /** 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 */
  116726. static readonly GEQUAL: number;
  116727. /** 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 */
  116728. static readonly NOTEQUAL: number;
  116729. /** Passed to stencilOperation to specify that stencil value must be kept */
  116730. static readonly KEEP: number;
  116731. /** Passed to stencilOperation to specify that stencil value must be replaced */
  116732. static readonly REPLACE: number;
  116733. /** Passed to stencilOperation to specify that stencil value must be incremented */
  116734. static readonly INCR: number;
  116735. /** Passed to stencilOperation to specify that stencil value must be decremented */
  116736. static readonly DECR: number;
  116737. /** Passed to stencilOperation to specify that stencil value must be inverted */
  116738. static readonly INVERT: number;
  116739. /** Passed to stencilOperation to specify that stencil value must be incremented with wrapping */
  116740. static readonly INCR_WRAP: number;
  116741. /** Passed to stencilOperation to specify that stencil value must be decremented with wrapping */
  116742. static readonly DECR_WRAP: number;
  116743. /** Texture is not repeating outside of 0..1 UVs */
  116744. static readonly TEXTURE_CLAMP_ADDRESSMODE: number;
  116745. /** Texture is repeating outside of 0..1 UVs */
  116746. static readonly TEXTURE_WRAP_ADDRESSMODE: number;
  116747. /** Texture is repeating and mirrored */
  116748. static readonly TEXTURE_MIRROR_ADDRESSMODE: number;
  116749. /** ALPHA */
  116750. static readonly TEXTUREFORMAT_ALPHA: number;
  116751. /** LUMINANCE */
  116752. static readonly TEXTUREFORMAT_LUMINANCE: number;
  116753. /** LUMINANCE_ALPHA */
  116754. static readonly TEXTUREFORMAT_LUMINANCE_ALPHA: number;
  116755. /** RGB */
  116756. static readonly TEXTUREFORMAT_RGB: number;
  116757. /** RGBA */
  116758. static readonly TEXTUREFORMAT_RGBA: number;
  116759. /** RED */
  116760. static readonly TEXTUREFORMAT_RED: number;
  116761. /** RED (2nd reference) */
  116762. static readonly TEXTUREFORMAT_R: number;
  116763. /** RG */
  116764. static readonly TEXTUREFORMAT_RG: number;
  116765. /** RED_INTEGER */
  116766. static readonly TEXTUREFORMAT_RED_INTEGER: number;
  116767. /** RED_INTEGER (2nd reference) */
  116768. static readonly TEXTUREFORMAT_R_INTEGER: number;
  116769. /** RG_INTEGER */
  116770. static readonly TEXTUREFORMAT_RG_INTEGER: number;
  116771. /** RGB_INTEGER */
  116772. static readonly TEXTUREFORMAT_RGB_INTEGER: number;
  116773. /** RGBA_INTEGER */
  116774. static readonly TEXTUREFORMAT_RGBA_INTEGER: number;
  116775. /** UNSIGNED_BYTE */
  116776. static readonly TEXTURETYPE_UNSIGNED_BYTE: number;
  116777. /** UNSIGNED_BYTE (2nd reference) */
  116778. static readonly TEXTURETYPE_UNSIGNED_INT: number;
  116779. /** FLOAT */
  116780. static readonly TEXTURETYPE_FLOAT: number;
  116781. /** HALF_FLOAT */
  116782. static readonly TEXTURETYPE_HALF_FLOAT: number;
  116783. /** BYTE */
  116784. static readonly TEXTURETYPE_BYTE: number;
  116785. /** SHORT */
  116786. static readonly TEXTURETYPE_SHORT: number;
  116787. /** UNSIGNED_SHORT */
  116788. static readonly TEXTURETYPE_UNSIGNED_SHORT: number;
  116789. /** INT */
  116790. static readonly TEXTURETYPE_INT: number;
  116791. /** UNSIGNED_INT */
  116792. static readonly TEXTURETYPE_UNSIGNED_INTEGER: number;
  116793. /** UNSIGNED_SHORT_4_4_4_4 */
  116794. static readonly TEXTURETYPE_UNSIGNED_SHORT_4_4_4_4: number;
  116795. /** UNSIGNED_SHORT_5_5_5_1 */
  116796. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_5_5_1: number;
  116797. /** UNSIGNED_SHORT_5_6_5 */
  116798. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_6_5: number;
  116799. /** UNSIGNED_INT_2_10_10_10_REV */
  116800. static readonly TEXTURETYPE_UNSIGNED_INT_2_10_10_10_REV: number;
  116801. /** UNSIGNED_INT_24_8 */
  116802. static readonly TEXTURETYPE_UNSIGNED_INT_24_8: number;
  116803. /** UNSIGNED_INT_10F_11F_11F_REV */
  116804. static readonly TEXTURETYPE_UNSIGNED_INT_10F_11F_11F_REV: number;
  116805. /** UNSIGNED_INT_5_9_9_9_REV */
  116806. static readonly TEXTURETYPE_UNSIGNED_INT_5_9_9_9_REV: number;
  116807. /** FLOAT_32_UNSIGNED_INT_24_8_REV */
  116808. static readonly TEXTURETYPE_FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  116809. /** nearest is mag = nearest and min = nearest and mip = linear */
  116810. static readonly TEXTURE_NEAREST_SAMPLINGMODE: number;
  116811. /** Bilinear is mag = linear and min = linear and mip = nearest */
  116812. static readonly TEXTURE_BILINEAR_SAMPLINGMODE: number;
  116813. /** Trilinear is mag = linear and min = linear and mip = linear */
  116814. static readonly TEXTURE_TRILINEAR_SAMPLINGMODE: number;
  116815. /** nearest is mag = nearest and min = nearest and mip = linear */
  116816. static readonly TEXTURE_NEAREST_NEAREST_MIPLINEAR: number;
  116817. /** Bilinear is mag = linear and min = linear and mip = nearest */
  116818. static readonly TEXTURE_LINEAR_LINEAR_MIPNEAREST: number;
  116819. /** Trilinear is mag = linear and min = linear and mip = linear */
  116820. static readonly TEXTURE_LINEAR_LINEAR_MIPLINEAR: number;
  116821. /** mag = nearest and min = nearest and mip = nearest */
  116822. static readonly TEXTURE_NEAREST_NEAREST_MIPNEAREST: number;
  116823. /** mag = nearest and min = linear and mip = nearest */
  116824. static readonly TEXTURE_NEAREST_LINEAR_MIPNEAREST: number;
  116825. /** mag = nearest and min = linear and mip = linear */
  116826. static readonly TEXTURE_NEAREST_LINEAR_MIPLINEAR: number;
  116827. /** mag = nearest and min = linear and mip = none */
  116828. static readonly TEXTURE_NEAREST_LINEAR: number;
  116829. /** mag = nearest and min = nearest and mip = none */
  116830. static readonly TEXTURE_NEAREST_NEAREST: number;
  116831. /** mag = linear and min = nearest and mip = nearest */
  116832. static readonly TEXTURE_LINEAR_NEAREST_MIPNEAREST: number;
  116833. /** mag = linear and min = nearest and mip = linear */
  116834. static readonly TEXTURE_LINEAR_NEAREST_MIPLINEAR: number;
  116835. /** mag = linear and min = linear and mip = none */
  116836. static readonly TEXTURE_LINEAR_LINEAR: number;
  116837. /** mag = linear and min = nearest and mip = none */
  116838. static readonly TEXTURE_LINEAR_NEAREST: number;
  116839. /** Explicit coordinates mode */
  116840. static readonly TEXTURE_EXPLICIT_MODE: number;
  116841. /** Spherical coordinates mode */
  116842. static readonly TEXTURE_SPHERICAL_MODE: number;
  116843. /** Planar coordinates mode */
  116844. static readonly TEXTURE_PLANAR_MODE: number;
  116845. /** Cubic coordinates mode */
  116846. static readonly TEXTURE_CUBIC_MODE: number;
  116847. /** Projection coordinates mode */
  116848. static readonly TEXTURE_PROJECTION_MODE: number;
  116849. /** Skybox coordinates mode */
  116850. static readonly TEXTURE_SKYBOX_MODE: number;
  116851. /** Inverse Cubic coordinates mode */
  116852. static readonly TEXTURE_INVCUBIC_MODE: number;
  116853. /** Equirectangular coordinates mode */
  116854. static readonly TEXTURE_EQUIRECTANGULAR_MODE: number;
  116855. /** Equirectangular Fixed coordinates mode */
  116856. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MODE: number;
  116857. /** Equirectangular Fixed Mirrored coordinates mode */
  116858. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  116859. /** Defines that texture rescaling will use a floor to find the closer power of 2 size */
  116860. static readonly SCALEMODE_FLOOR: number;
  116861. /** Defines that texture rescaling will look for the nearest power of 2 size */
  116862. static readonly SCALEMODE_NEAREST: number;
  116863. /** Defines that texture rescaling will use a ceil to find the closer power of 2 size */
  116864. static readonly SCALEMODE_CEILING: number;
  116865. /**
  116866. * Returns the current npm package of the sdk
  116867. */
  116868. static get NpmPackage(): string;
  116869. /**
  116870. * Returns the current version of the framework
  116871. */
  116872. static get Version(): string;
  116873. /** Gets the list of created engines */
  116874. static get Instances(): Engine[];
  116875. /**
  116876. * Gets the latest created engine
  116877. */
  116878. static get LastCreatedEngine(): Nullable<Engine>;
  116879. /**
  116880. * Gets the latest created scene
  116881. */
  116882. static get LastCreatedScene(): Nullable<Scene>;
  116883. /**
  116884. * Will flag all materials in all scenes in all engines as dirty to trigger new shader compilation
  116885. * @param flag defines which part of the materials must be marked as dirty
  116886. * @param predicate defines a predicate used to filter which materials should be affected
  116887. */
  116888. static MarkAllMaterialsAsDirty(flag: number, predicate?: (mat: Material) => boolean): void;
  116889. /**
  116890. * Method called to create the default loading screen.
  116891. * This can be overriden in your own app.
  116892. * @param canvas The rendering canvas element
  116893. * @returns The loading screen
  116894. */
  116895. static DefaultLoadingScreenFactory(canvas: HTMLCanvasElement): ILoadingScreen;
  116896. /**
  116897. * Method called to create the default rescale post process on each engine.
  116898. */
  116899. static _RescalePostProcessFactory: Nullable<(engine: Engine) => PostProcess>;
  116900. /**
  116901. * Gets or sets a boolean to enable/disable IndexedDB support and avoid XHR on .manifest
  116902. **/
  116903. enableOfflineSupport: boolean;
  116904. /**
  116905. * 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)
  116906. **/
  116907. disableManifestCheck: boolean;
  116908. /**
  116909. * Gets the list of created scenes
  116910. */
  116911. scenes: Scene[];
  116912. /**
  116913. * Event raised when a new scene is created
  116914. */
  116915. onNewSceneAddedObservable: Observable<Scene>;
  116916. /**
  116917. * Gets the list of created postprocesses
  116918. */
  116919. postProcesses: PostProcess[];
  116920. /**
  116921. * Gets a boolean indicating if the pointer is currently locked
  116922. */
  116923. isPointerLock: boolean;
  116924. /**
  116925. * Observable event triggered each time the rendering canvas is resized
  116926. */
  116927. onResizeObservable: Observable<Engine>;
  116928. /**
  116929. * Observable event triggered each time the canvas loses focus
  116930. */
  116931. onCanvasBlurObservable: Observable<Engine>;
  116932. /**
  116933. * Observable event triggered each time the canvas gains focus
  116934. */
  116935. onCanvasFocusObservable: Observable<Engine>;
  116936. /**
  116937. * Observable event triggered each time the canvas receives pointerout event
  116938. */
  116939. onCanvasPointerOutObservable: Observable<PointerEvent>;
  116940. /**
  116941. * Observable raised when the engine begins a new frame
  116942. */
  116943. onBeginFrameObservable: Observable<Engine>;
  116944. /**
  116945. * If set, will be used to request the next animation frame for the render loop
  116946. */
  116947. customAnimationFrameRequester: Nullable<ICustomAnimationFrameRequester>;
  116948. /**
  116949. * Observable raised when the engine ends the current frame
  116950. */
  116951. onEndFrameObservable: Observable<Engine>;
  116952. /**
  116953. * Observable raised when the engine is about to compile a shader
  116954. */
  116955. onBeforeShaderCompilationObservable: Observable<Engine>;
  116956. /**
  116957. * Observable raised when the engine has jsut compiled a shader
  116958. */
  116959. onAfterShaderCompilationObservable: Observable<Engine>;
  116960. /**
  116961. * Gets the audio engine
  116962. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  116963. * @ignorenaming
  116964. */
  116965. static audioEngine: IAudioEngine;
  116966. /**
  116967. * Default AudioEngine factory responsible of creating the Audio Engine.
  116968. * By default, this will create a BabylonJS Audio Engine if the workload has been embedded.
  116969. */
  116970. static AudioEngineFactory: (hostElement: Nullable<HTMLElement>) => IAudioEngine;
  116971. /**
  116972. * Default offline support factory responsible of creating a tool used to store data locally.
  116973. * By default, this will create a Database object if the workload has been embedded.
  116974. */
  116975. static OfflineProviderFactory: (urlToScene: string, callbackManifestChecked: (checked: boolean) => any, disableManifestCheck: boolean) => IOfflineProvider;
  116976. private _loadingScreen;
  116977. private _pointerLockRequested;
  116978. private _rescalePostProcess;
  116979. private _deterministicLockstep;
  116980. private _lockstepMaxSteps;
  116981. private _timeStep;
  116982. protected get _supportsHardwareTextureRescaling(): boolean;
  116983. private _fps;
  116984. private _deltaTime;
  116985. /** @hidden */
  116986. _drawCalls: PerfCounter;
  116987. /** 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 */
  116988. canvasTabIndex: number;
  116989. /**
  116990. * Turn this value on if you want to pause FPS computation when in background
  116991. */
  116992. disablePerformanceMonitorInBackground: boolean;
  116993. private _performanceMonitor;
  116994. /**
  116995. * Gets the performance monitor attached to this engine
  116996. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  116997. */
  116998. get performanceMonitor(): PerformanceMonitor;
  116999. private _onFocus;
  117000. private _onBlur;
  117001. private _onCanvasPointerOut;
  117002. private _onCanvasBlur;
  117003. private _onCanvasFocus;
  117004. private _onFullscreenChange;
  117005. private _onPointerLockChange;
  117006. /**
  117007. * Gets the HTML element used to attach event listeners
  117008. * @returns a HTML element
  117009. */
  117010. getInputElement(): Nullable<HTMLElement>;
  117011. /**
  117012. * Creates a new engine
  117013. * @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
  117014. * @param antialias defines enable antialiasing (default: false)
  117015. * @param options defines further options to be sent to the getContext() function
  117016. * @param adaptToDeviceRatio defines whether to adapt to the device's viewport characteristics (default: false)
  117017. */
  117018. constructor(canvasOrContext: Nullable<HTMLCanvasElement | WebGLRenderingContext>, antialias?: boolean, options?: EngineOptions, adaptToDeviceRatio?: boolean);
  117019. /**
  117020. * Gets current aspect ratio
  117021. * @param viewportOwner defines the camera to use to get the aspect ratio
  117022. * @param useScreen defines if screen size must be used (or the current render target if any)
  117023. * @returns a number defining the aspect ratio
  117024. */
  117025. getAspectRatio(viewportOwner: IViewportOwnerLike, useScreen?: boolean): number;
  117026. /**
  117027. * Gets current screen aspect ratio
  117028. * @returns a number defining the aspect ratio
  117029. */
  117030. getScreenAspectRatio(): number;
  117031. /**
  117032. * Gets the client rect of the HTML canvas attached with the current webGL context
  117033. * @returns a client rectanglee
  117034. */
  117035. getRenderingCanvasClientRect(): Nullable<ClientRect>;
  117036. /**
  117037. * Gets the client rect of the HTML element used for events
  117038. * @returns a client rectanglee
  117039. */
  117040. getInputElementClientRect(): Nullable<ClientRect>;
  117041. /**
  117042. * Gets a boolean indicating that the engine is running in deterministic lock step mode
  117043. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  117044. * @returns true if engine is in deterministic lock step mode
  117045. */
  117046. isDeterministicLockStep(): boolean;
  117047. /**
  117048. * Gets the max steps when engine is running in deterministic lock step
  117049. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  117050. * @returns the max steps
  117051. */
  117052. getLockstepMaxSteps(): number;
  117053. /**
  117054. * Returns the time in ms between steps when using deterministic lock step.
  117055. * @returns time step in (ms)
  117056. */
  117057. getTimeStep(): number;
  117058. /**
  117059. * Force the mipmap generation for the given render target texture
  117060. * @param texture defines the render target texture to use
  117061. * @param unbind defines whether or not to unbind the texture after generation. Defaults to true.
  117062. */
  117063. generateMipMapsForCubemap(texture: InternalTexture, unbind?: boolean): void;
  117064. /** States */
  117065. /**
  117066. * Set various states to the webGL context
  117067. * @param culling defines backface culling state
  117068. * @param zOffset defines the value to apply to zOffset (0 by default)
  117069. * @param force defines if states must be applied even if cache is up to date
  117070. * @param reverseSide defines if culling must be reversed (CCW instead of CW and CW instead of CCW)
  117071. */
  117072. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  117073. /**
  117074. * Set the z offset to apply to current rendering
  117075. * @param value defines the offset to apply
  117076. */
  117077. setZOffset(value: number): void;
  117078. /**
  117079. * Gets the current value of the zOffset
  117080. * @returns the current zOffset state
  117081. */
  117082. getZOffset(): number;
  117083. /**
  117084. * Enable or disable depth buffering
  117085. * @param enable defines the state to set
  117086. */
  117087. setDepthBuffer(enable: boolean): void;
  117088. /**
  117089. * Gets a boolean indicating if depth writing is enabled
  117090. * @returns the current depth writing state
  117091. */
  117092. getDepthWrite(): boolean;
  117093. /**
  117094. * Enable or disable depth writing
  117095. * @param enable defines the state to set
  117096. */
  117097. setDepthWrite(enable: boolean): void;
  117098. /**
  117099. * Gets a boolean indicating if stencil buffer is enabled
  117100. * @returns the current stencil buffer state
  117101. */
  117102. getStencilBuffer(): boolean;
  117103. /**
  117104. * Enable or disable the stencil buffer
  117105. * @param enable defines if the stencil buffer must be enabled or disabled
  117106. */
  117107. setStencilBuffer(enable: boolean): void;
  117108. /**
  117109. * Gets the current stencil mask
  117110. * @returns a number defining the new stencil mask to use
  117111. */
  117112. getStencilMask(): number;
  117113. /**
  117114. * Sets the current stencil mask
  117115. * @param mask defines the new stencil mask to use
  117116. */
  117117. setStencilMask(mask: number): void;
  117118. /**
  117119. * Gets the current stencil function
  117120. * @returns a number defining the stencil function to use
  117121. */
  117122. getStencilFunction(): number;
  117123. /**
  117124. * Gets the current stencil reference value
  117125. * @returns a number defining the stencil reference value to use
  117126. */
  117127. getStencilFunctionReference(): number;
  117128. /**
  117129. * Gets the current stencil mask
  117130. * @returns a number defining the stencil mask to use
  117131. */
  117132. getStencilFunctionMask(): number;
  117133. /**
  117134. * Sets the current stencil function
  117135. * @param stencilFunc defines the new stencil function to use
  117136. */
  117137. setStencilFunction(stencilFunc: number): void;
  117138. /**
  117139. * Sets the current stencil reference
  117140. * @param reference defines the new stencil reference to use
  117141. */
  117142. setStencilFunctionReference(reference: number): void;
  117143. /**
  117144. * Sets the current stencil mask
  117145. * @param mask defines the new stencil mask to use
  117146. */
  117147. setStencilFunctionMask(mask: number): void;
  117148. /**
  117149. * Gets the current stencil operation when stencil fails
  117150. * @returns a number defining stencil operation to use when stencil fails
  117151. */
  117152. getStencilOperationFail(): number;
  117153. /**
  117154. * Gets the current stencil operation when depth fails
  117155. * @returns a number defining stencil operation to use when depth fails
  117156. */
  117157. getStencilOperationDepthFail(): number;
  117158. /**
  117159. * Gets the current stencil operation when stencil passes
  117160. * @returns a number defining stencil operation to use when stencil passes
  117161. */
  117162. getStencilOperationPass(): number;
  117163. /**
  117164. * Sets the stencil operation to use when stencil fails
  117165. * @param operation defines the stencil operation to use when stencil fails
  117166. */
  117167. setStencilOperationFail(operation: number): void;
  117168. /**
  117169. * Sets the stencil operation to use when depth fails
  117170. * @param operation defines the stencil operation to use when depth fails
  117171. */
  117172. setStencilOperationDepthFail(operation: number): void;
  117173. /**
  117174. * Sets the stencil operation to use when stencil passes
  117175. * @param operation defines the stencil operation to use when stencil passes
  117176. */
  117177. setStencilOperationPass(operation: number): void;
  117178. /**
  117179. * Sets a boolean indicating if the dithering state is enabled or disabled
  117180. * @param value defines the dithering state
  117181. */
  117182. setDitheringState(value: boolean): void;
  117183. /**
  117184. * Sets a boolean indicating if the rasterizer state is enabled or disabled
  117185. * @param value defines the rasterizer state
  117186. */
  117187. setRasterizerState(value: boolean): void;
  117188. /**
  117189. * Gets the current depth function
  117190. * @returns a number defining the depth function
  117191. */
  117192. getDepthFunction(): Nullable<number>;
  117193. /**
  117194. * Sets the current depth function
  117195. * @param depthFunc defines the function to use
  117196. */
  117197. setDepthFunction(depthFunc: number): void;
  117198. /**
  117199. * Sets the current depth function to GREATER
  117200. */
  117201. setDepthFunctionToGreater(): void;
  117202. /**
  117203. * Sets the current depth function to GEQUAL
  117204. */
  117205. setDepthFunctionToGreaterOrEqual(): void;
  117206. /**
  117207. * Sets the current depth function to LESS
  117208. */
  117209. setDepthFunctionToLess(): void;
  117210. /**
  117211. * Sets the current depth function to LEQUAL
  117212. */
  117213. setDepthFunctionToLessOrEqual(): void;
  117214. private _cachedStencilBuffer;
  117215. private _cachedStencilFunction;
  117216. private _cachedStencilMask;
  117217. private _cachedStencilOperationPass;
  117218. private _cachedStencilOperationFail;
  117219. private _cachedStencilOperationDepthFail;
  117220. private _cachedStencilReference;
  117221. /**
  117222. * Caches the the state of the stencil buffer
  117223. */
  117224. cacheStencilState(): void;
  117225. /**
  117226. * Restores the state of the stencil buffer
  117227. */
  117228. restoreStencilState(): void;
  117229. /**
  117230. * Directly set the WebGL Viewport
  117231. * @param x defines the x coordinate of the viewport (in screen space)
  117232. * @param y defines the y coordinate of the viewport (in screen space)
  117233. * @param width defines the width of the viewport (in screen space)
  117234. * @param height defines the height of the viewport (in screen space)
  117235. * @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
  117236. */
  117237. setDirectViewport(x: number, y: number, width: number, height: number): Nullable<IViewportLike>;
  117238. /**
  117239. * Executes a scissor clear (ie. a clear on a specific portion of the screen)
  117240. * @param x defines the x-coordinate of the top left corner of the clear rectangle
  117241. * @param y defines the y-coordinate of the corner of the clear rectangle
  117242. * @param width defines the width of the clear rectangle
  117243. * @param height defines the height of the clear rectangle
  117244. * @param clearColor defines the clear color
  117245. */
  117246. scissorClear(x: number, y: number, width: number, height: number, clearColor: IColor4Like): void;
  117247. /**
  117248. * Enable scissor test on a specific rectangle (ie. render will only be executed on a specific portion of the screen)
  117249. * @param x defines the x-coordinate of the top left corner of the clear rectangle
  117250. * @param y defines the y-coordinate of the corner of the clear rectangle
  117251. * @param width defines the width of the clear rectangle
  117252. * @param height defines the height of the clear rectangle
  117253. */
  117254. enableScissor(x: number, y: number, width: number, height: number): void;
  117255. /**
  117256. * Disable previously set scissor test rectangle
  117257. */
  117258. disableScissor(): void;
  117259. protected _reportDrawCall(): void;
  117260. /**
  117261. * Initializes a webVR display and starts listening to display change events
  117262. * The onVRDisplayChangedObservable will be notified upon these changes
  117263. * @returns The onVRDisplayChangedObservable
  117264. */
  117265. initWebVR(): Observable<IDisplayChangedEventArgs>;
  117266. /** @hidden */
  117267. _prepareVRComponent(): void;
  117268. /** @hidden */
  117269. _connectVREvents(canvas?: HTMLCanvasElement, document?: any): void;
  117270. /** @hidden */
  117271. _submitVRFrame(): void;
  117272. /**
  117273. * Call this function to leave webVR mode
  117274. * Will do nothing if webVR is not supported or if there is no webVR device
  117275. * @see https://doc.babylonjs.com/how_to/webvr_camera
  117276. */
  117277. disableVR(): void;
  117278. /**
  117279. * Gets a boolean indicating that the system is in VR mode and is presenting
  117280. * @returns true if VR mode is engaged
  117281. */
  117282. isVRPresenting(): boolean;
  117283. /** @hidden */
  117284. _requestVRFrame(): void;
  117285. /** @hidden */
  117286. _loadFileAsync(url: string, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  117287. /**
  117288. * Gets the source code of the vertex shader associated with a specific webGL program
  117289. * @param program defines the program to use
  117290. * @returns a string containing the source code of the vertex shader associated with the program
  117291. */
  117292. getVertexShaderSource(program: WebGLProgram): Nullable<string>;
  117293. /**
  117294. * Gets the source code of the fragment shader associated with a specific webGL program
  117295. * @param program defines the program to use
  117296. * @returns a string containing the source code of the fragment shader associated with the program
  117297. */
  117298. getFragmentShaderSource(program: WebGLProgram): Nullable<string>;
  117299. /**
  117300. * Sets a depth stencil texture from a render target to the according uniform.
  117301. * @param channel The texture channel
  117302. * @param uniform The uniform to set
  117303. * @param texture The render target texture containing the depth stencil texture to apply
  117304. */
  117305. setDepthStencilTexture(channel: number, uniform: Nullable<WebGLUniformLocation>, texture: Nullable<RenderTargetTexture>): void;
  117306. /**
  117307. * Sets a texture to the webGL context from a postprocess
  117308. * @param channel defines the channel to use
  117309. * @param postProcess defines the source postprocess
  117310. */
  117311. setTextureFromPostProcess(channel: number, postProcess: Nullable<PostProcess>): void;
  117312. /**
  117313. * Binds the output of the passed in post process to the texture channel specified
  117314. * @param channel The channel the texture should be bound to
  117315. * @param postProcess The post process which's output should be bound
  117316. */
  117317. setTextureFromPostProcessOutput(channel: number, postProcess: Nullable<PostProcess>): void;
  117318. protected _rebuildBuffers(): void;
  117319. /** @hidden */
  117320. _renderFrame(): void;
  117321. _renderLoop(): void;
  117322. /** @hidden */
  117323. _renderViews(): boolean;
  117324. /**
  117325. * Toggle full screen mode
  117326. * @param requestPointerLock defines if a pointer lock should be requested from the user
  117327. */
  117328. switchFullscreen(requestPointerLock: boolean): void;
  117329. /**
  117330. * Enters full screen mode
  117331. * @param requestPointerLock defines if a pointer lock should be requested from the user
  117332. */
  117333. enterFullscreen(requestPointerLock: boolean): void;
  117334. /**
  117335. * Exits full screen mode
  117336. */
  117337. exitFullscreen(): void;
  117338. /**
  117339. * Enters Pointerlock mode
  117340. */
  117341. enterPointerlock(): void;
  117342. /**
  117343. * Exits Pointerlock mode
  117344. */
  117345. exitPointerlock(): void;
  117346. /**
  117347. * Begin a new frame
  117348. */
  117349. beginFrame(): void;
  117350. /**
  117351. * Enf the current frame
  117352. */
  117353. endFrame(): void;
  117354. resize(): void;
  117355. /**
  117356. * Force a specific size of the canvas
  117357. * @param width defines the new canvas' width
  117358. * @param height defines the new canvas' height
  117359. * @returns true if the size was changed
  117360. */
  117361. setSize(width: number, height: number): boolean;
  117362. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  117363. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  117364. protected _createShaderProgram(pipelineContext: WebGLPipelineContext, vertexShader: WebGLShader, fragmentShader: WebGLShader, context: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  117365. _releaseTexture(texture: InternalTexture): void;
  117366. /**
  117367. * @hidden
  117368. * Rescales a texture
  117369. * @param source input texutre
  117370. * @param destination destination texture
  117371. * @param scene scene to use to render the resize
  117372. * @param internalFormat format to use when resizing
  117373. * @param onComplete callback to be called when resize has completed
  117374. */
  117375. _rescaleTexture(source: InternalTexture, destination: InternalTexture, scene: Nullable<any>, internalFormat: number, onComplete: () => void): void;
  117376. /**
  117377. * Gets the current framerate
  117378. * @returns a number representing the framerate
  117379. */
  117380. getFps(): number;
  117381. /**
  117382. * Gets the time spent between current and previous frame
  117383. * @returns a number representing the delta time in ms
  117384. */
  117385. getDeltaTime(): number;
  117386. private _measureFps;
  117387. /** @hidden */
  117388. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement | ImageBitmap, faceIndex?: number, lod?: number): void;
  117389. /**
  117390. * Updates the sample count of a render target texture
  117391. * @see https://doc.babylonjs.com/features/webgl2#multisample-render-targets
  117392. * @param texture defines the texture to update
  117393. * @param samples defines the sample count to set
  117394. * @returns the effective sample count (could be 0 if multisample render targets are not supported)
  117395. */
  117396. updateRenderTargetTextureSampleCount(texture: Nullable<InternalTexture>, samples: number): number;
  117397. /**
  117398. * Updates a depth texture Comparison Mode and Function.
  117399. * If the comparison Function is equal to 0, the mode will be set to none.
  117400. * Otherwise, this only works in webgl 2 and requires a shadow sampler in the shader.
  117401. * @param texture The texture to set the comparison function for
  117402. * @param comparisonFunction The comparison function to set, 0 if no comparison required
  117403. */
  117404. updateTextureComparisonFunction(texture: InternalTexture, comparisonFunction: number): void;
  117405. /**
  117406. * Creates a webGL buffer to use with instanciation
  117407. * @param capacity defines the size of the buffer
  117408. * @returns the webGL buffer
  117409. */
  117410. createInstancesBuffer(capacity: number): DataBuffer;
  117411. /**
  117412. * Delete a webGL buffer used with instanciation
  117413. * @param buffer defines the webGL buffer to delete
  117414. */
  117415. deleteInstancesBuffer(buffer: WebGLBuffer): void;
  117416. private _clientWaitAsync;
  117417. /** @hidden */
  117418. _readPixelsAsync(x: number, y: number, w: number, h: number, format: number, type: number, outputBuffer: ArrayBufferView): Promise<ArrayBufferView> | null;
  117419. dispose(): void;
  117420. private _disableTouchAction;
  117421. /**
  117422. * Display the loading screen
  117423. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  117424. */
  117425. displayLoadingUI(): void;
  117426. /**
  117427. * Hide the loading screen
  117428. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  117429. */
  117430. hideLoadingUI(): void;
  117431. /**
  117432. * Gets the current loading screen object
  117433. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  117434. */
  117435. get loadingScreen(): ILoadingScreen;
  117436. /**
  117437. * Sets the current loading screen object
  117438. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  117439. */
  117440. set loadingScreen(loadingScreen: ILoadingScreen);
  117441. /**
  117442. * Sets the current loading screen text
  117443. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  117444. */
  117445. set loadingUIText(text: string);
  117446. /**
  117447. * Sets the current loading screen background color
  117448. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  117449. */
  117450. set loadingUIBackgroundColor(color: string);
  117451. /** Pointerlock and fullscreen */
  117452. /**
  117453. * Ask the browser to promote the current element to pointerlock mode
  117454. * @param element defines the DOM element to promote
  117455. */
  117456. static _RequestPointerlock(element: HTMLElement): void;
  117457. /**
  117458. * Asks the browser to exit pointerlock mode
  117459. */
  117460. static _ExitPointerlock(): void;
  117461. /**
  117462. * Ask the browser to promote the current element to fullscreen rendering mode
  117463. * @param element defines the DOM element to promote
  117464. */
  117465. static _RequestFullscreen(element: HTMLElement): void;
  117466. /**
  117467. * Asks the browser to exit fullscreen mode
  117468. */
  117469. static _ExitFullscreen(): void;
  117470. }
  117471. }
  117472. declare module BABYLON {
  117473. /**
  117474. * The engine store class is responsible to hold all the instances of Engine and Scene created
  117475. * during the life time of the application.
  117476. */
  117477. export class EngineStore {
  117478. /** Gets the list of created engines */
  117479. static Instances: Engine[];
  117480. /** @hidden */
  117481. static _LastCreatedScene: Nullable<Scene>;
  117482. /**
  117483. * Gets the latest created engine
  117484. */
  117485. static get LastCreatedEngine(): Nullable<Engine>;
  117486. /**
  117487. * Gets the latest created scene
  117488. */
  117489. static get LastCreatedScene(): Nullable<Scene>;
  117490. /**
  117491. * Gets or sets a global variable indicating if fallback texture must be used when a texture cannot be loaded
  117492. * @ignorenaming
  117493. */
  117494. static UseFallbackTexture: boolean;
  117495. /**
  117496. * Texture content used if a texture cannot loaded
  117497. * @ignorenaming
  117498. */
  117499. static FallbackTexture: string;
  117500. }
  117501. }
  117502. declare module BABYLON {
  117503. /**
  117504. * Helper class that provides a small promise polyfill
  117505. */
  117506. export class PromisePolyfill {
  117507. /**
  117508. * Static function used to check if the polyfill is required
  117509. * If this is the case then the function will inject the polyfill to window.Promise
  117510. * @param force defines a boolean used to force the injection (mostly for testing purposes)
  117511. */
  117512. static Apply(force?: boolean): void;
  117513. }
  117514. }
  117515. declare module BABYLON {
  117516. /**
  117517. * Interface for screenshot methods with describe argument called `size` as object with options
  117518. * @link https://doc.babylonjs.com/api/classes/babylon.screenshottools
  117519. */
  117520. export interface IScreenshotSize {
  117521. /**
  117522. * number in pixels for canvas height
  117523. */
  117524. height?: number;
  117525. /**
  117526. * multiplier allowing render at a higher or lower resolution
  117527. * If value is defined then height and width will be ignored and taken from camera
  117528. */
  117529. precision?: number;
  117530. /**
  117531. * number in pixels for canvas width
  117532. */
  117533. width?: number;
  117534. }
  117535. }
  117536. declare module BABYLON {
  117537. interface IColor4Like {
  117538. r: float;
  117539. g: float;
  117540. b: float;
  117541. a: float;
  117542. }
  117543. /**
  117544. * Class containing a set of static utilities functions
  117545. */
  117546. export class Tools {
  117547. /**
  117548. * Gets or sets the base URL to use to load assets
  117549. */
  117550. static get BaseUrl(): string;
  117551. static set BaseUrl(value: string);
  117552. /**
  117553. * Enable/Disable Custom HTTP Request Headers globally.
  117554. * default = false
  117555. * @see CustomRequestHeaders
  117556. */
  117557. static UseCustomRequestHeaders: boolean;
  117558. /**
  117559. * Custom HTTP Request Headers to be sent with XMLHttpRequests
  117560. * i.e. when loading files, where the server/service expects an Authorization header
  117561. */
  117562. static CustomRequestHeaders: {
  117563. [key: string]: string;
  117564. };
  117565. /**
  117566. * Gets or sets the retry strategy to apply when an error happens while loading an asset
  117567. */
  117568. static get DefaultRetryStrategy(): (url: string, request: WebRequest, retryIndex: number) => number;
  117569. static set DefaultRetryStrategy(strategy: (url: string, request: WebRequest, retryIndex: number) => number);
  117570. /**
  117571. * Default behaviour for cors in the application.
  117572. * It can be a string if the expected behavior is identical in the entire app.
  117573. * Or a callback to be able to set it per url or on a group of them (in case of Video source for instance)
  117574. */
  117575. static get CorsBehavior(): string | ((url: string | string[]) => string);
  117576. static set CorsBehavior(value: string | ((url: string | string[]) => string));
  117577. /**
  117578. * Gets or sets a global variable indicating if fallback texture must be used when a texture cannot be loaded
  117579. * @ignorenaming
  117580. */
  117581. static get UseFallbackTexture(): boolean;
  117582. static set UseFallbackTexture(value: boolean);
  117583. /**
  117584. * Use this object to register external classes like custom textures or material
  117585. * to allow the laoders to instantiate them
  117586. */
  117587. static get RegisteredExternalClasses(): {
  117588. [key: string]: Object;
  117589. };
  117590. static set RegisteredExternalClasses(classes: {
  117591. [key: string]: Object;
  117592. });
  117593. /**
  117594. * Texture content used if a texture cannot loaded
  117595. * @ignorenaming
  117596. */
  117597. static get fallbackTexture(): string;
  117598. static set fallbackTexture(value: string);
  117599. /**
  117600. * Read the content of a byte array at a specified coordinates (taking in account wrapping)
  117601. * @param u defines the coordinate on X axis
  117602. * @param v defines the coordinate on Y axis
  117603. * @param width defines the width of the source data
  117604. * @param height defines the height of the source data
  117605. * @param pixels defines the source byte array
  117606. * @param color defines the output color
  117607. */
  117608. static FetchToRef(u: number, v: number, width: number, height: number, pixels: Uint8Array, color: IColor4Like): void;
  117609. /**
  117610. * Interpolates between a and b via alpha
  117611. * @param a The lower value (returned when alpha = 0)
  117612. * @param b The upper value (returned when alpha = 1)
  117613. * @param alpha The interpolation-factor
  117614. * @return The mixed value
  117615. */
  117616. static Mix(a: number, b: number, alpha: number): number;
  117617. /**
  117618. * Tries to instantiate a new object from a given class name
  117619. * @param className defines the class name to instantiate
  117620. * @returns the new object or null if the system was not able to do the instantiation
  117621. */
  117622. static Instantiate(className: string): any;
  117623. /**
  117624. * Provides a slice function that will work even on IE
  117625. * @param data defines the array to slice
  117626. * @param start defines the start of the data (optional)
  117627. * @param end defines the end of the data (optional)
  117628. * @returns the new sliced array
  117629. */
  117630. static Slice<T>(data: T, start?: number, end?: number): T;
  117631. /**
  117632. * Polyfill for setImmediate
  117633. * @param action defines the action to execute after the current execution block
  117634. */
  117635. static SetImmediate(action: () => void): void;
  117636. /**
  117637. * Function indicating if a number is an exponent of 2
  117638. * @param value defines the value to test
  117639. * @returns true if the value is an exponent of 2
  117640. */
  117641. static IsExponentOfTwo(value: number): boolean;
  117642. private static _tmpFloatArray;
  117643. /**
  117644. * Returns the nearest 32-bit single precision float representation of a Number
  117645. * @param value A Number. If the parameter is of a different type, it will get converted
  117646. * to a number or to NaN if it cannot be converted
  117647. * @returns number
  117648. */
  117649. static FloatRound(value: number): number;
  117650. /**
  117651. * Extracts the filename from a path
  117652. * @param path defines the path to use
  117653. * @returns the filename
  117654. */
  117655. static GetFilename(path: string): string;
  117656. /**
  117657. * Extracts the "folder" part of a path (everything before the filename).
  117658. * @param uri The URI to extract the info from
  117659. * @param returnUnchangedIfNoSlash Do not touch the URI if no slashes are present
  117660. * @returns The "folder" part of the path
  117661. */
  117662. static GetFolderPath(uri: string, returnUnchangedIfNoSlash?: boolean): string;
  117663. /**
  117664. * Extracts text content from a DOM element hierarchy
  117665. * Back Compat only, please use DomManagement.GetDOMTextContent instead.
  117666. */
  117667. static GetDOMTextContent: typeof DomManagement.GetDOMTextContent;
  117668. /**
  117669. * Convert an angle in radians to degrees
  117670. * @param angle defines the angle to convert
  117671. * @returns the angle in degrees
  117672. */
  117673. static ToDegrees(angle: number): number;
  117674. /**
  117675. * Convert an angle in degrees to radians
  117676. * @param angle defines the angle to convert
  117677. * @returns the angle in radians
  117678. */
  117679. static ToRadians(angle: number): number;
  117680. /**
  117681. * Returns an array if obj is not an array
  117682. * @param obj defines the object to evaluate as an array
  117683. * @param allowsNullUndefined defines a boolean indicating if obj is allowed to be null or undefined
  117684. * @returns either obj directly if obj is an array or a new array containing obj
  117685. */
  117686. static MakeArray(obj: any, allowsNullUndefined?: boolean): Nullable<Array<any>>;
  117687. /**
  117688. * Gets the pointer prefix to use
  117689. * @param engine defines the engine we are finding the prefix for
  117690. * @returns "pointer" if touch is enabled. Else returns "mouse"
  117691. */
  117692. static GetPointerPrefix(engine: Engine): string;
  117693. /**
  117694. * Sets the cors behavior on a dom element. This will add the required Tools.CorsBehavior to the element.
  117695. * @param url define the url we are trying
  117696. * @param element define the dom element where to configure the cors policy
  117697. */
  117698. static SetCorsBehavior(url: string | string[], element: {
  117699. crossOrigin: string | null;
  117700. }): void;
  117701. /**
  117702. * Removes unwanted characters from an url
  117703. * @param url defines the url to clean
  117704. * @returns the cleaned url
  117705. */
  117706. static CleanUrl(url: string): string;
  117707. /**
  117708. * Gets or sets a function used to pre-process url before using them to load assets
  117709. */
  117710. static get PreprocessUrl(): (url: string) => string;
  117711. static set PreprocessUrl(processor: (url: string) => string);
  117712. /**
  117713. * Loads an image as an HTMLImageElement.
  117714. * @param input url string, ArrayBuffer, or Blob to load
  117715. * @param onLoad callback called when the image successfully loads
  117716. * @param onError callback called when the image fails to load
  117717. * @param offlineProvider offline provider for caching
  117718. * @param mimeType optional mime type
  117719. * @returns the HTMLImageElement of the loaded image
  117720. */
  117721. static LoadImage(input: string | ArrayBuffer | Blob, onLoad: (img: HTMLImageElement | ImageBitmap) => void, onError: (message?: string, exception?: any) => void, offlineProvider: Nullable<IOfflineProvider>, mimeType?: string): Nullable<HTMLImageElement>;
  117722. /**
  117723. * Loads a file from a url
  117724. * @param url url string, ArrayBuffer, or Blob to load
  117725. * @param onSuccess callback called when the file successfully loads
  117726. * @param onProgress callback called while file is loading (if the server supports this mode)
  117727. * @param offlineProvider defines the offline provider for caching
  117728. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  117729. * @param onError callback called when the file fails to load
  117730. * @returns a file request object
  117731. */
  117732. 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;
  117733. /**
  117734. * Loads a file from a url
  117735. * @param url the file url to load
  117736. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  117737. * @returns a promise containing an ArrayBuffer corresponding to the loaded file
  117738. */
  117739. static LoadFileAsync(url: string, useArrayBuffer?: boolean): Promise<ArrayBuffer | string>;
  117740. /**
  117741. * Load a script (identified by an url). When the url returns, the
  117742. * content of this file is added into a new script element, attached to the DOM (body element)
  117743. * @param scriptUrl defines the url of the script to laod
  117744. * @param onSuccess defines the callback called when the script is loaded
  117745. * @param onError defines the callback to call if an error occurs
  117746. * @param scriptId defines the id of the script element
  117747. */
  117748. static LoadScript(scriptUrl: string, onSuccess: () => void, onError?: (message?: string, exception?: any) => void, scriptId?: string): void;
  117749. /**
  117750. * Load an asynchronous script (identified by an url). When the url returns, the
  117751. * content of this file is added into a new script element, attached to the DOM (body element)
  117752. * @param scriptUrl defines the url of the script to laod
  117753. * @param scriptId defines the id of the script element
  117754. * @returns a promise request object
  117755. */
  117756. static LoadScriptAsync(scriptUrl: string, scriptId?: string): Promise<void>;
  117757. /**
  117758. * Loads a file from a blob
  117759. * @param fileToLoad defines the blob to use
  117760. * @param callback defines the callback to call when data is loaded
  117761. * @param progressCallback defines the callback to call during loading process
  117762. * @returns a file request object
  117763. */
  117764. static ReadFileAsDataURL(fileToLoad: Blob, callback: (data: any) => void, progressCallback: (ev: ProgressEvent) => any): IFileRequest;
  117765. /**
  117766. * Reads a file from a File object
  117767. * @param file defines the file to load
  117768. * @param onSuccess defines the callback to call when data is loaded
  117769. * @param onProgress defines the callback to call during loading process
  117770. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  117771. * @param onError defines the callback to call when an error occurs
  117772. * @returns a file request object
  117773. */
  117774. static ReadFile(file: File, onSuccess: (data: any) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  117775. /**
  117776. * Creates a data url from a given string content
  117777. * @param content defines the content to convert
  117778. * @returns the new data url link
  117779. */
  117780. static FileAsURL(content: string): string;
  117781. /**
  117782. * Format the given number to a specific decimal format
  117783. * @param value defines the number to format
  117784. * @param decimals defines the number of decimals to use
  117785. * @returns the formatted string
  117786. */
  117787. static Format(value: number, decimals?: number): string;
  117788. /**
  117789. * Tries to copy an object by duplicating every property
  117790. * @param source defines the source object
  117791. * @param destination defines the target object
  117792. * @param doNotCopyList defines a list of properties to avoid
  117793. * @param mustCopyList defines a list of properties to copy (even if they start with _)
  117794. */
  117795. static DeepCopy(source: any, destination: any, doNotCopyList?: string[], mustCopyList?: string[]): void;
  117796. /**
  117797. * Gets a boolean indicating if the given object has no own property
  117798. * @param obj defines the object to test
  117799. * @returns true if object has no own property
  117800. */
  117801. static IsEmpty(obj: any): boolean;
  117802. /**
  117803. * Function used to register events at window level
  117804. * @param windowElement defines the Window object to use
  117805. * @param events defines the events to register
  117806. */
  117807. static RegisterTopRootEvents(windowElement: Window, events: {
  117808. name: string;
  117809. handler: Nullable<(e: FocusEvent) => any>;
  117810. }[]): void;
  117811. /**
  117812. * Function used to unregister events from window level
  117813. * @param windowElement defines the Window object to use
  117814. * @param events defines the events to unregister
  117815. */
  117816. static UnregisterTopRootEvents(windowElement: Window, events: {
  117817. name: string;
  117818. handler: Nullable<(e: FocusEvent) => any>;
  117819. }[]): void;
  117820. /**
  117821. * @ignore
  117822. */
  117823. static _ScreenshotCanvas: HTMLCanvasElement;
  117824. /**
  117825. * Dumps the current bound framebuffer
  117826. * @param width defines the rendering width
  117827. * @param height defines the rendering height
  117828. * @param engine defines the hosting engine
  117829. * @param successCallback defines the callback triggered once the data are available
  117830. * @param mimeType defines the mime type of the result
  117831. * @param fileName defines the filename to download. If present, the result will automatically be downloaded
  117832. */
  117833. static DumpFramebuffer(width: number, height: number, engine: Engine, successCallback?: (data: string) => void, mimeType?: string, fileName?: string): void;
  117834. /**
  117835. * Converts the canvas data to blob.
  117836. * This acts as a polyfill for browsers not supporting the to blob function.
  117837. * @param canvas Defines the canvas to extract the data from
  117838. * @param successCallback Defines the callback triggered once the data are available
  117839. * @param mimeType Defines the mime type of the result
  117840. */
  117841. static ToBlob(canvas: HTMLCanvasElement, successCallback: (blob: Nullable<Blob>) => void, mimeType?: string): void;
  117842. /**
  117843. * Encodes the canvas data to base 64 or automatically download the result if filename is defined
  117844. * @param successCallback defines the callback triggered once the data are available
  117845. * @param mimeType defines the mime type of the result
  117846. * @param fileName defines he filename to download. If present, the result will automatically be downloaded
  117847. */
  117848. static EncodeScreenshotCanvasData(successCallback?: (data: string) => void, mimeType?: string, fileName?: string): void;
  117849. /**
  117850. * Downloads a blob in the browser
  117851. * @param blob defines the blob to download
  117852. * @param fileName defines the name of the downloaded file
  117853. */
  117854. static Download(blob: Blob, fileName: string): void;
  117855. /**
  117856. * Captures a screenshot of the current rendering
  117857. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  117858. * @param engine defines the rendering engine
  117859. * @param camera defines the source camera
  117860. * @param size This parameter can be set to a single number or to an object with the
  117861. * following (optional) properties: precision, width, height. If a single number is passed,
  117862. * it will be used for both width and height. If an object is passed, the screenshot size
  117863. * will be derived from the parameters. The precision property is a multiplier allowing
  117864. * rendering at a higher or lower resolution
  117865. * @param successCallback defines the callback receives a single parameter which contains the
  117866. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  117867. * src parameter of an <img> to display it
  117868. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  117869. * Check your browser for supported MIME types
  117870. */
  117871. static CreateScreenshot(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string): void;
  117872. /**
  117873. * Captures a screenshot of the current rendering
  117874. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  117875. * @param engine defines the rendering engine
  117876. * @param camera defines the source camera
  117877. * @param size This parameter can be set to a single number or to an object with the
  117878. * following (optional) properties: precision, width, height. If a single number is passed,
  117879. * it will be used for both width and height. If an object is passed, the screenshot size
  117880. * will be derived from the parameters. The precision property is a multiplier allowing
  117881. * rendering at a higher or lower resolution
  117882. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  117883. * Check your browser for supported MIME types
  117884. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  117885. * to the src parameter of an <img> to display it
  117886. */
  117887. static CreateScreenshotAsync(engine: Engine, camera: Camera, size: IScreenshotSize | number, mimeType?: string): Promise<string>;
  117888. /**
  117889. * Generates an image screenshot from the specified camera.
  117890. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  117891. * @param engine The engine to use for rendering
  117892. * @param camera The camera to use for rendering
  117893. * @param size This parameter can be set to a single number or to an object with the
  117894. * following (optional) properties: precision, width, height. If a single number is passed,
  117895. * it will be used for both width and height. If an object is passed, the screenshot size
  117896. * will be derived from the parameters. The precision property is a multiplier allowing
  117897. * rendering at a higher or lower resolution
  117898. * @param successCallback The callback receives a single parameter which contains the
  117899. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  117900. * src parameter of an <img> to display it
  117901. * @param mimeType The MIME type of the screenshot image (default: image/png).
  117902. * Check your browser for supported MIME types
  117903. * @param samples Texture samples (default: 1)
  117904. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  117905. * @param fileName A name for for the downloaded file.
  117906. */
  117907. static CreateScreenshotUsingRenderTarget(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): void;
  117908. /**
  117909. * Generates an image screenshot from the specified camera.
  117910. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  117911. * @param engine The engine to use for rendering
  117912. * @param camera The camera to use for rendering
  117913. * @param size This parameter can be set to a single number or to an object with the
  117914. * following (optional) properties: precision, width, height. If a single number is passed,
  117915. * it will be used for both width and height. If an object is passed, the screenshot size
  117916. * will be derived from the parameters. The precision property is a multiplier allowing
  117917. * rendering at a higher or lower resolution
  117918. * @param mimeType The MIME type of the screenshot image (default: image/png).
  117919. * Check your browser for supported MIME types
  117920. * @param samples Texture samples (default: 1)
  117921. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  117922. * @param fileName A name for for the downloaded file.
  117923. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  117924. * to the src parameter of an <img> to display it
  117925. */
  117926. static CreateScreenshotUsingRenderTargetAsync(engine: Engine, camera: Camera, size: IScreenshotSize | number, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): Promise<string>;
  117927. /**
  117928. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  117929. * Be aware Math.random() could cause collisions, but:
  117930. * "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"
  117931. * @returns a pseudo random id
  117932. */
  117933. static RandomId(): string;
  117934. /**
  117935. * Test if the given uri is a base64 string
  117936. * @param uri The uri to test
  117937. * @return True if the uri is a base64 string or false otherwise
  117938. */
  117939. static IsBase64(uri: string): boolean;
  117940. /**
  117941. * Decode the given base64 uri.
  117942. * @param uri The uri to decode
  117943. * @return The decoded base64 data.
  117944. */
  117945. static DecodeBase64(uri: string): ArrayBuffer;
  117946. /**
  117947. * Gets the absolute url.
  117948. * @param url the input url
  117949. * @return the absolute url
  117950. */
  117951. static GetAbsoluteUrl(url: string): string;
  117952. /**
  117953. * No log
  117954. */
  117955. static readonly NoneLogLevel: number;
  117956. /**
  117957. * Only message logs
  117958. */
  117959. static readonly MessageLogLevel: number;
  117960. /**
  117961. * Only warning logs
  117962. */
  117963. static readonly WarningLogLevel: number;
  117964. /**
  117965. * Only error logs
  117966. */
  117967. static readonly ErrorLogLevel: number;
  117968. /**
  117969. * All logs
  117970. */
  117971. static readonly AllLogLevel: number;
  117972. /**
  117973. * Gets a value indicating the number of loading errors
  117974. * @ignorenaming
  117975. */
  117976. static get errorsCount(): number;
  117977. /**
  117978. * Callback called when a new log is added
  117979. */
  117980. static OnNewCacheEntry: (entry: string) => void;
  117981. /**
  117982. * Log a message to the console
  117983. * @param message defines the message to log
  117984. */
  117985. static Log(message: string): void;
  117986. /**
  117987. * Write a warning message to the console
  117988. * @param message defines the message to log
  117989. */
  117990. static Warn(message: string): void;
  117991. /**
  117992. * Write an error message to the console
  117993. * @param message defines the message to log
  117994. */
  117995. static Error(message: string): void;
  117996. /**
  117997. * Gets current log cache (list of logs)
  117998. */
  117999. static get LogCache(): string;
  118000. /**
  118001. * Clears the log cache
  118002. */
  118003. static ClearLogCache(): void;
  118004. /**
  118005. * Sets the current log level (MessageLogLevel / WarningLogLevel / ErrorLogLevel)
  118006. */
  118007. static set LogLevels(level: number);
  118008. /**
  118009. * Checks if the window object exists
  118010. * Back Compat only, please use DomManagement.IsWindowObjectExist instead.
  118011. */
  118012. static IsWindowObjectExist: typeof DomManagement.IsWindowObjectExist;
  118013. /**
  118014. * No performance log
  118015. */
  118016. static readonly PerformanceNoneLogLevel: number;
  118017. /**
  118018. * Use user marks to log performance
  118019. */
  118020. static readonly PerformanceUserMarkLogLevel: number;
  118021. /**
  118022. * Log performance to the console
  118023. */
  118024. static readonly PerformanceConsoleLogLevel: number;
  118025. private static _performance;
  118026. /**
  118027. * Sets the current performance log level
  118028. */
  118029. static set PerformanceLogLevel(level: number);
  118030. private static _StartPerformanceCounterDisabled;
  118031. private static _EndPerformanceCounterDisabled;
  118032. private static _StartUserMark;
  118033. private static _EndUserMark;
  118034. private static _StartPerformanceConsole;
  118035. private static _EndPerformanceConsole;
  118036. /**
  118037. * Starts a performance counter
  118038. */
  118039. static StartPerformanceCounter: (counterName: string, condition?: boolean) => void;
  118040. /**
  118041. * Ends a specific performance coutner
  118042. */
  118043. static EndPerformanceCounter: (counterName: string, condition?: boolean) => void;
  118044. /**
  118045. * Gets either window.performance.now() if supported or Date.now() else
  118046. */
  118047. static get Now(): number;
  118048. /**
  118049. * This method will return the name of the class used to create the instance of the given object.
  118050. * It will works only on Javascript basic data types (number, string, ...) and instance of class declared with the @className decorator.
  118051. * @param object the object to get the class name from
  118052. * @param isType defines if the object is actually a type
  118053. * @returns the name of the class, will be "object" for a custom data type not using the @className decorator
  118054. */
  118055. static GetClassName(object: any, isType?: boolean): string;
  118056. /**
  118057. * Gets the first element of an array satisfying a given predicate
  118058. * @param array defines the array to browse
  118059. * @param predicate defines the predicate to use
  118060. * @returns null if not found or the element
  118061. */
  118062. static First<T>(array: Array<T>, predicate: (item: T) => boolean): Nullable<T>;
  118063. /**
  118064. * This method will return the name of the full name of the class, including its owning module (if any).
  118065. * 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).
  118066. * @param object the object to get the class name from
  118067. * @param isType defines if the object is actually a type
  118068. * @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.
  118069. * @ignorenaming
  118070. */
  118071. static getFullClassName(object: any, isType?: boolean): Nullable<string>;
  118072. /**
  118073. * Returns a promise that resolves after the given amount of time.
  118074. * @param delay Number of milliseconds to delay
  118075. * @returns Promise that resolves after the given amount of time
  118076. */
  118077. static DelayAsync(delay: number): Promise<void>;
  118078. /**
  118079. * Utility function to detect if the current user agent is Safari
  118080. * @returns whether or not the current user agent is safari
  118081. */
  118082. static IsSafari(): boolean;
  118083. }
  118084. /**
  118085. * Use this className as a decorator on a given class definition to add it a name and optionally its module.
  118086. * You can then use the Tools.getClassName(obj) on an instance to retrieve its class name.
  118087. * This method is the only way to get it done in all cases, even if the .js file declaring the class is minified
  118088. * @param name The name of the class, case should be preserved
  118089. * @param module The name of the Module hosting the class, optional, but strongly recommended to specify if possible. Case should be preserved.
  118090. */
  118091. export function className(name: string, module?: string): (target: Object) => void;
  118092. /**
  118093. * An implementation of a loop for asynchronous functions.
  118094. */
  118095. export class AsyncLoop {
  118096. /**
  118097. * Defines the number of iterations for the loop
  118098. */
  118099. iterations: number;
  118100. /**
  118101. * Defines the current index of the loop.
  118102. */
  118103. index: number;
  118104. private _done;
  118105. private _fn;
  118106. private _successCallback;
  118107. /**
  118108. * Constructor.
  118109. * @param iterations the number of iterations.
  118110. * @param func the function to run each iteration
  118111. * @param successCallback the callback that will be called upon succesful execution
  118112. * @param offset starting offset.
  118113. */
  118114. constructor(
  118115. /**
  118116. * Defines the number of iterations for the loop
  118117. */
  118118. iterations: number, func: (asyncLoop: AsyncLoop) => void, successCallback: () => void, offset?: number);
  118119. /**
  118120. * Execute the next iteration. Must be called after the last iteration was finished.
  118121. */
  118122. executeNext(): void;
  118123. /**
  118124. * Break the loop and run the success callback.
  118125. */
  118126. breakLoop(): void;
  118127. /**
  118128. * Create and run an async loop.
  118129. * @param iterations the number of iterations.
  118130. * @param fn the function to run each iteration
  118131. * @param successCallback the callback that will be called upon succesful execution
  118132. * @param offset starting offset.
  118133. * @returns the created async loop object
  118134. */
  118135. static Run(iterations: number, fn: (asyncLoop: AsyncLoop) => void, successCallback: () => void, offset?: number): AsyncLoop;
  118136. /**
  118137. * A for-loop that will run a given number of iterations synchronous and the rest async.
  118138. * @param iterations total number of iterations
  118139. * @param syncedIterations number of synchronous iterations in each async iteration.
  118140. * @param fn the function to call each iteration.
  118141. * @param callback a success call back that will be called when iterating stops.
  118142. * @param breakFunction a break condition (optional)
  118143. * @param timeout timeout settings for the setTimeout function. default - 0.
  118144. * @returns the created async loop object
  118145. */
  118146. static SyncAsyncForLoop(iterations: number, syncedIterations: number, fn: (iteration: number) => void, callback: () => void, breakFunction?: () => boolean, timeout?: number): AsyncLoop;
  118147. }
  118148. }
  118149. declare module BABYLON {
  118150. /**
  118151. * This class implement a typical dictionary using a string as key and the generic type T as value.
  118152. * The underlying implementation relies on an associative array to ensure the best performances.
  118153. * The value can be anything including 'null' but except 'undefined'
  118154. */
  118155. export class StringDictionary<T> {
  118156. /**
  118157. * This will clear this dictionary and copy the content from the 'source' one.
  118158. * If the T value is a custom object, it won't be copied/cloned, the same object will be used
  118159. * @param source the dictionary to take the content from and copy to this dictionary
  118160. */
  118161. copyFrom(source: StringDictionary<T>): void;
  118162. /**
  118163. * Get a value based from its key
  118164. * @param key the given key to get the matching value from
  118165. * @return the value if found, otherwise undefined is returned
  118166. */
  118167. get(key: string): T | undefined;
  118168. /**
  118169. * Get a value from its key or add it if it doesn't exist.
  118170. * This method will ensure you that a given key/data will be present in the dictionary.
  118171. * @param key the given key to get the matching value from
  118172. * @param factory the factory that will create the value if the key is not present in the dictionary.
  118173. * The factory will only be invoked if there's no data for the given key.
  118174. * @return the value corresponding to the key.
  118175. */
  118176. getOrAddWithFactory(key: string, factory: (key: string) => T): T;
  118177. /**
  118178. * Get a value from its key if present in the dictionary otherwise add it
  118179. * @param key the key to get the value from
  118180. * @param val if there's no such key/value pair in the dictionary add it with this value
  118181. * @return the value corresponding to the key
  118182. */
  118183. getOrAdd(key: string, val: T): T;
  118184. /**
  118185. * Check if there's a given key in the dictionary
  118186. * @param key the key to check for
  118187. * @return true if the key is present, false otherwise
  118188. */
  118189. contains(key: string): boolean;
  118190. /**
  118191. * Add a new key and its corresponding value
  118192. * @param key the key to add
  118193. * @param value the value corresponding to the key
  118194. * @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
  118195. */
  118196. add(key: string, value: T): boolean;
  118197. /**
  118198. * Update a specific value associated to a key
  118199. * @param key defines the key to use
  118200. * @param value defines the value to store
  118201. * @returns true if the value was updated (or false if the key was not found)
  118202. */
  118203. set(key: string, value: T): boolean;
  118204. /**
  118205. * Get the element of the given key and remove it from the dictionary
  118206. * @param key defines the key to search
  118207. * @returns the value associated with the key or null if not found
  118208. */
  118209. getAndRemove(key: string): Nullable<T>;
  118210. /**
  118211. * Remove a key/value from the dictionary.
  118212. * @param key the key to remove
  118213. * @return true if the item was successfully deleted, false if no item with such key exist in the dictionary
  118214. */
  118215. remove(key: string): boolean;
  118216. /**
  118217. * Clear the whole content of the dictionary
  118218. */
  118219. clear(): void;
  118220. /**
  118221. * Gets the current count
  118222. */
  118223. get count(): number;
  118224. /**
  118225. * Execute a callback on each key/val of the dictionary.
  118226. * Note that you can remove any element in this dictionary in the callback implementation
  118227. * @param callback the callback to execute on a given key/value pair
  118228. */
  118229. forEach(callback: (key: string, val: T) => void): void;
  118230. /**
  118231. * Execute a callback on every occurrence of the dictionary until it returns a valid TRes object.
  118232. * If the callback returns null or undefined the method will iterate to the next key/value pair
  118233. * Note that you can remove any element in this dictionary in the callback implementation
  118234. * @param callback the callback to execute, if it return a valid T instanced object the enumeration will stop and the object will be returned
  118235. * @returns the first item
  118236. */
  118237. first<TRes>(callback: (key: string, val: T) => TRes): TRes | null;
  118238. private _count;
  118239. private _data;
  118240. }
  118241. }
  118242. declare module BABYLON {
  118243. /** @hidden */
  118244. export interface ICollisionCoordinator {
  118245. createCollider(): Collider;
  118246. getNewPosition(position: Vector3, displacement: Vector3, collider: Collider, maximumRetry: number, excludedMesh: Nullable<AbstractMesh>, onNewPosition: (collisionIndex: number, newPosition: Vector3, collidedMesh: Nullable<AbstractMesh>) => void, collisionIndex: number): void;
  118247. init(scene: Scene): void;
  118248. }
  118249. /** @hidden */
  118250. export class DefaultCollisionCoordinator implements ICollisionCoordinator {
  118251. private _scene;
  118252. private _scaledPosition;
  118253. private _scaledVelocity;
  118254. private _finalPosition;
  118255. getNewPosition(position: Vector3, displacement: Vector3, collider: Collider, maximumRetry: number, excludedMesh: AbstractMesh, onNewPosition: (collisionIndex: number, newPosition: Vector3, collidedMesh: Nullable<AbstractMesh>) => void, collisionIndex: number): void;
  118256. createCollider(): Collider;
  118257. init(scene: Scene): void;
  118258. private _collideWithWorld;
  118259. }
  118260. }
  118261. declare module BABYLON {
  118262. /**
  118263. * Class used to manage all inputs for the scene.
  118264. */
  118265. export class InputManager {
  118266. /** The distance in pixel that you have to move to prevent some events */
  118267. static DragMovementThreshold: number;
  118268. /** Time in milliseconds to wait to raise long press events if button is still pressed */
  118269. static LongPressDelay: number;
  118270. /** Time in milliseconds with two consecutive clicks will be considered as a double click */
  118271. static DoubleClickDelay: number;
  118272. /** If you need to check double click without raising a single click at first click, enable this flag */
  118273. static ExclusiveDoubleClickMode: boolean;
  118274. /** 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. */
  118275. private _alreadyAttached;
  118276. private _wheelEventName;
  118277. private _onPointerMove;
  118278. private _onPointerDown;
  118279. private _onPointerUp;
  118280. private _initClickEvent;
  118281. private _initActionManager;
  118282. private _delayedSimpleClick;
  118283. private _delayedSimpleClickTimeout;
  118284. private _previousDelayedSimpleClickTimeout;
  118285. private _meshPickProceed;
  118286. private _previousButtonPressed;
  118287. private _currentPickResult;
  118288. private _previousPickResult;
  118289. private _totalPointersPressed;
  118290. private _doubleClickOccured;
  118291. private _pointerOverMesh;
  118292. private _pickedDownMesh;
  118293. private _pickedUpMesh;
  118294. private _pointerX;
  118295. private _pointerY;
  118296. private _unTranslatedPointerX;
  118297. private _unTranslatedPointerY;
  118298. private _startingPointerPosition;
  118299. private _previousStartingPointerPosition;
  118300. private _startingPointerTime;
  118301. private _previousStartingPointerTime;
  118302. private _pointerCaptures;
  118303. private _onKeyDown;
  118304. private _onKeyUp;
  118305. private _onCanvasFocusObserver;
  118306. private _onCanvasBlurObserver;
  118307. private _scene;
  118308. /**
  118309. * Creates a new InputManager
  118310. * @param scene defines the hosting scene
  118311. */
  118312. constructor(scene: Scene);
  118313. /**
  118314. * Gets the mesh that is currently under the pointer
  118315. */
  118316. get meshUnderPointer(): Nullable<AbstractMesh>;
  118317. /**
  118318. * Gets the pointer coordinates in 2D without any translation (ie. straight out of the pointer event)
  118319. */
  118320. get unTranslatedPointer(): Vector2;
  118321. /**
  118322. * Gets or sets the current on-screen X position of the pointer
  118323. */
  118324. get pointerX(): number;
  118325. set pointerX(value: number);
  118326. /**
  118327. * Gets or sets the current on-screen Y position of the pointer
  118328. */
  118329. get pointerY(): number;
  118330. set pointerY(value: number);
  118331. private _updatePointerPosition;
  118332. private _processPointerMove;
  118333. private _setRayOnPointerInfo;
  118334. private _checkPrePointerObservable;
  118335. /**
  118336. * Use this method to simulate a pointer move on a mesh
  118337. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  118338. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  118339. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  118340. */
  118341. simulatePointerMove(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): void;
  118342. /**
  118343. * Use this method to simulate a pointer down on a mesh
  118344. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  118345. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  118346. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  118347. */
  118348. simulatePointerDown(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): void;
  118349. private _processPointerDown;
  118350. /** @hidden */
  118351. _isPointerSwiping(): boolean;
  118352. /**
  118353. * Use this method to simulate a pointer up on a mesh
  118354. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  118355. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  118356. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  118357. * @param doubleTap indicates that the pointer up event should be considered as part of a double click (false by default)
  118358. */
  118359. simulatePointerUp(pickResult: PickingInfo, pointerEventInit?: PointerEventInit, doubleTap?: boolean): void;
  118360. private _processPointerUp;
  118361. /**
  118362. * Gets a boolean indicating if the current pointer event is captured (meaning that the scene has already handled the pointer down)
  118363. * @param pointerId defines the pointer id to use in a multi-touch scenario (0 by default)
  118364. * @returns true if the pointer was captured
  118365. */
  118366. isPointerCaptured(pointerId?: number): boolean;
  118367. /**
  118368. * Attach events to the canvas (To handle actionManagers triggers and raise onPointerMove, onPointerDown and onPointerUp
  118369. * @param attachUp defines if you want to attach events to pointerup
  118370. * @param attachDown defines if you want to attach events to pointerdown
  118371. * @param attachMove defines if you want to attach events to pointermove
  118372. * @param elementToAttachTo defines the target DOM element to attach to (will use the canvas by default)
  118373. */
  118374. attachControl(attachUp?: boolean, attachDown?: boolean, attachMove?: boolean, elementToAttachTo?: Nullable<HTMLElement>): void;
  118375. /**
  118376. * Detaches all event handlers
  118377. */
  118378. detachControl(): void;
  118379. /**
  118380. * Force the value of meshUnderPointer
  118381. * @param mesh defines the mesh to use
  118382. */
  118383. setPointerOverMesh(mesh: Nullable<AbstractMesh>): void;
  118384. /**
  118385. * Gets the mesh under the pointer
  118386. * @returns a Mesh or null if no mesh is under the pointer
  118387. */
  118388. getPointerOverMesh(): Nullable<AbstractMesh>;
  118389. }
  118390. }
  118391. declare module BABYLON {
  118392. /**
  118393. * This class defines the direct association between an animation and a target
  118394. */
  118395. export class TargetedAnimation {
  118396. /**
  118397. * Animation to perform
  118398. */
  118399. animation: Animation;
  118400. /**
  118401. * Target to animate
  118402. */
  118403. target: any;
  118404. /**
  118405. * Returns the string "TargetedAnimation"
  118406. * @returns "TargetedAnimation"
  118407. */
  118408. getClassName(): string;
  118409. /**
  118410. * Serialize the object
  118411. * @returns the JSON object representing the current entity
  118412. */
  118413. serialize(): any;
  118414. }
  118415. /**
  118416. * Use this class to create coordinated animations on multiple targets
  118417. */
  118418. export class AnimationGroup implements IDisposable {
  118419. /** The name of the animation group */
  118420. name: string;
  118421. private _scene;
  118422. private _targetedAnimations;
  118423. private _animatables;
  118424. private _from;
  118425. private _to;
  118426. private _isStarted;
  118427. private _isPaused;
  118428. private _speedRatio;
  118429. private _loopAnimation;
  118430. private _isAdditive;
  118431. /**
  118432. * Gets or sets the unique id of the node
  118433. */
  118434. uniqueId: number;
  118435. /**
  118436. * This observable will notify when one animation have ended
  118437. */
  118438. onAnimationEndObservable: Observable<TargetedAnimation>;
  118439. /**
  118440. * Observer raised when one animation loops
  118441. */
  118442. onAnimationLoopObservable: Observable<TargetedAnimation>;
  118443. /**
  118444. * Observer raised when all animations have looped
  118445. */
  118446. onAnimationGroupLoopObservable: Observable<AnimationGroup>;
  118447. /**
  118448. * This observable will notify when all animations have ended.
  118449. */
  118450. onAnimationGroupEndObservable: Observable<AnimationGroup>;
  118451. /**
  118452. * This observable will notify when all animations have paused.
  118453. */
  118454. onAnimationGroupPauseObservable: Observable<AnimationGroup>;
  118455. /**
  118456. * This observable will notify when all animations are playing.
  118457. */
  118458. onAnimationGroupPlayObservable: Observable<AnimationGroup>;
  118459. /**
  118460. * Gets the first frame
  118461. */
  118462. get from(): number;
  118463. /**
  118464. * Gets the last frame
  118465. */
  118466. get to(): number;
  118467. /**
  118468. * Define if the animations are started
  118469. */
  118470. get isStarted(): boolean;
  118471. /**
  118472. * Gets a value indicating that the current group is playing
  118473. */
  118474. get isPlaying(): boolean;
  118475. /**
  118476. * Gets or sets the speed ratio to use for all animations
  118477. */
  118478. get speedRatio(): number;
  118479. /**
  118480. * Gets or sets the speed ratio to use for all animations
  118481. */
  118482. set speedRatio(value: number);
  118483. /**
  118484. * Gets or sets if all animations should loop or not
  118485. */
  118486. get loopAnimation(): boolean;
  118487. set loopAnimation(value: boolean);
  118488. /**
  118489. * Gets or sets if all animations should be evaluated additively
  118490. */
  118491. get isAdditive(): boolean;
  118492. set isAdditive(value: boolean);
  118493. /**
  118494. * Gets the targeted animations for this animation group
  118495. */
  118496. get targetedAnimations(): Array<TargetedAnimation>;
  118497. /**
  118498. * returning the list of animatables controlled by this animation group.
  118499. */
  118500. get animatables(): Array<Animatable>;
  118501. /**
  118502. * Gets the list of target animations
  118503. */
  118504. get children(): TargetedAnimation[];
  118505. /**
  118506. * Instantiates a new Animation Group.
  118507. * This helps managing several animations at once.
  118508. * @see https://doc.babylonjs.com/how_to/group
  118509. * @param name Defines the name of the group
  118510. * @param scene Defines the scene the group belongs to
  118511. */
  118512. constructor(
  118513. /** The name of the animation group */
  118514. name: string, scene?: Nullable<Scene>);
  118515. /**
  118516. * Add an animation (with its target) in the group
  118517. * @param animation defines the animation we want to add
  118518. * @param target defines the target of the animation
  118519. * @returns the TargetedAnimation object
  118520. */
  118521. addTargetedAnimation(animation: Animation, target: any): TargetedAnimation;
  118522. /**
  118523. * This function will normalize every animation in the group to make sure they all go from beginFrame to endFrame
  118524. * It can add constant keys at begin or end
  118525. * @param beginFrame defines the new begin frame for all animations or the smallest begin frame of all animations if null (defaults to null)
  118526. * @param endFrame defines the new end frame for all animations or the largest end frame of all animations if null (defaults to null)
  118527. * @returns the animation group
  118528. */
  118529. normalize(beginFrame?: Nullable<number>, endFrame?: Nullable<number>): AnimationGroup;
  118530. private _animationLoopCount;
  118531. private _animationLoopFlags;
  118532. private _processLoop;
  118533. /**
  118534. * Start all animations on given targets
  118535. * @param loop defines if animations must loop
  118536. * @param speedRatio defines the ratio to apply to animation speed (1 by default)
  118537. * @param from defines the from key (optional)
  118538. * @param to defines the to key (optional)
  118539. * @param isAdditive defines the additive state for the resulting animatables (optional)
  118540. * @returns the current animation group
  118541. */
  118542. start(loop?: boolean, speedRatio?: number, from?: number, to?: number, isAdditive?: boolean): AnimationGroup;
  118543. /**
  118544. * Pause all animations
  118545. * @returns the animation group
  118546. */
  118547. pause(): AnimationGroup;
  118548. /**
  118549. * Play all animations to initial state
  118550. * This function will start() the animations if they were not started or will restart() them if they were paused
  118551. * @param loop defines if animations must loop
  118552. * @returns the animation group
  118553. */
  118554. play(loop?: boolean): AnimationGroup;
  118555. /**
  118556. * Reset all animations to initial state
  118557. * @returns the animation group
  118558. */
  118559. reset(): AnimationGroup;
  118560. /**
  118561. * Restart animations from key 0
  118562. * @returns the animation group
  118563. */
  118564. restart(): AnimationGroup;
  118565. /**
  118566. * Stop all animations
  118567. * @returns the animation group
  118568. */
  118569. stop(): AnimationGroup;
  118570. /**
  118571. * Set animation weight for all animatables
  118572. * @param weight defines the weight to use
  118573. * @return the animationGroup
  118574. * @see https://doc.babylonjs.com/babylon101/animations#animation-weights
  118575. */
  118576. setWeightForAllAnimatables(weight: number): AnimationGroup;
  118577. /**
  118578. * Synchronize and normalize all animatables with a source animatable
  118579. * @param root defines the root animatable to synchronize with
  118580. * @return the animationGroup
  118581. * @see https://doc.babylonjs.com/babylon101/animations#animation-weights
  118582. */
  118583. syncAllAnimationsWith(root: Animatable): AnimationGroup;
  118584. /**
  118585. * Goes to a specific frame in this animation group
  118586. * @param frame the frame number to go to
  118587. * @return the animationGroup
  118588. */
  118589. goToFrame(frame: number): AnimationGroup;
  118590. /**
  118591. * Dispose all associated resources
  118592. */
  118593. dispose(): void;
  118594. private _checkAnimationGroupEnded;
  118595. /**
  118596. * Clone the current animation group and returns a copy
  118597. * @param newName defines the name of the new group
  118598. * @param targetConverter defines an optional function used to convert current animation targets to new ones
  118599. * @returns the new aniamtion group
  118600. */
  118601. clone(newName: string, targetConverter?: (oldTarget: any) => any): AnimationGroup;
  118602. /**
  118603. * Serializes the animationGroup to an object
  118604. * @returns Serialized object
  118605. */
  118606. serialize(): any;
  118607. /**
  118608. * Returns a new AnimationGroup object parsed from the source provided.
  118609. * @param parsedAnimationGroup defines the source
  118610. * @param scene defines the scene that will receive the animationGroup
  118611. * @returns a new AnimationGroup
  118612. */
  118613. static Parse(parsedAnimationGroup: any, scene: Scene): AnimationGroup;
  118614. /**
  118615. * Convert the keyframes for all animations belonging to the group to be relative to a given reference frame.
  118616. * @param sourceAnimationGroup defines the AnimationGroup containing animations to convert
  118617. * @param referenceFrame defines the frame that keyframes in the range will be relative to
  118618. * @param range defines the name of the AnimationRange belonging to the animations in the group to convert
  118619. * @param cloneOriginal defines whether or not to clone the group and convert the clone or convert the original group (default is false)
  118620. * @param clonedName defines the name of the resulting cloned AnimationGroup if cloneOriginal is true
  118621. * @returns a new AnimationGroup if cloneOriginal is true or the original AnimationGroup if cloneOriginal is false
  118622. */
  118623. static MakeAnimationAdditive(sourceAnimationGroup: AnimationGroup, referenceFrame?: number, range?: string, cloneOriginal?: boolean, clonedName?: string): AnimationGroup;
  118624. /**
  118625. * Returns the string "AnimationGroup"
  118626. * @returns "AnimationGroup"
  118627. */
  118628. getClassName(): string;
  118629. /**
  118630. * Creates a detailled string about the object
  118631. * @param fullDetails defines if the output string will support multiple levels of logging within scene loading
  118632. * @returns a string representing the object
  118633. */
  118634. toString(fullDetails?: boolean): string;
  118635. }
  118636. }
  118637. declare module BABYLON {
  118638. /**
  118639. * Define an interface for all classes that will hold resources
  118640. */
  118641. export interface IDisposable {
  118642. /**
  118643. * Releases all held resources
  118644. */
  118645. dispose(): void;
  118646. }
  118647. /** Interface defining initialization parameters for Scene class */
  118648. export interface SceneOptions {
  118649. /**
  118650. * Defines that scene should keep up-to-date a map of geometry to enable fast look-up by uniqueId
  118651. * It will improve performance when the number of geometries becomes important.
  118652. */
  118653. useGeometryUniqueIdsMap?: boolean;
  118654. /**
  118655. * Defines that each material of the scene should keep up-to-date a map of referencing meshes for fast diposing
  118656. * It will improve performance when the number of mesh becomes important, but might consume a bit more memory
  118657. */
  118658. useMaterialMeshMap?: boolean;
  118659. /**
  118660. * Defines that each mesh of the scene should keep up-to-date a map of referencing cloned meshes for fast diposing
  118661. * It will improve performance when the number of mesh becomes important, but might consume a bit more memory
  118662. */
  118663. useClonedMeshMap?: boolean;
  118664. /** Defines if the creation of the scene should impact the engine (Eg. UtilityLayer's scene) */
  118665. virtual?: boolean;
  118666. }
  118667. /**
  118668. * Represents a scene to be rendered by the engine.
  118669. * @see https://doc.babylonjs.com/features/scene
  118670. */
  118671. export class Scene extends AbstractScene implements IAnimatable, IClipPlanesHolder {
  118672. /** The fog is deactivated */
  118673. static readonly FOGMODE_NONE: number;
  118674. /** The fog density is following an exponential function */
  118675. static readonly FOGMODE_EXP: number;
  118676. /** The fog density is following an exponential function faster than FOGMODE_EXP */
  118677. static readonly FOGMODE_EXP2: number;
  118678. /** The fog density is following a linear function. */
  118679. static readonly FOGMODE_LINEAR: number;
  118680. /**
  118681. * Gets or sets the minimum deltatime when deterministic lock step is enabled
  118682. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  118683. */
  118684. static MinDeltaTime: number;
  118685. /**
  118686. * Gets or sets the maximum deltatime when deterministic lock step is enabled
  118687. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  118688. */
  118689. static MaxDeltaTime: number;
  118690. /**
  118691. * Factory used to create the default material.
  118692. * @param name The name of the material to create
  118693. * @param scene The scene to create the material for
  118694. * @returns The default material
  118695. */
  118696. static DefaultMaterialFactory(scene: Scene): Material;
  118697. /**
  118698. * Factory used to create the a collision coordinator.
  118699. * @returns The collision coordinator
  118700. */
  118701. static CollisionCoordinatorFactory(): ICollisionCoordinator;
  118702. /** @hidden */
  118703. _inputManager: InputManager;
  118704. /** Define this parameter if you are using multiple cameras and you want to specify which one should be used for pointer position */
  118705. cameraToUseForPointers: Nullable<Camera>;
  118706. /** @hidden */
  118707. readonly _isScene: boolean;
  118708. /** @hidden */
  118709. _blockEntityCollection: boolean;
  118710. /**
  118711. * Gets or sets a boolean that indicates if the scene must clear the render buffer before rendering a frame
  118712. */
  118713. autoClear: boolean;
  118714. /**
  118715. * Gets or sets a boolean that indicates if the scene must clear the depth and stencil buffers before rendering a frame
  118716. */
  118717. autoClearDepthAndStencil: boolean;
  118718. /**
  118719. * Defines the color used to clear the render buffer (Default is (0.2, 0.2, 0.3, 1.0))
  118720. */
  118721. clearColor: Color4;
  118722. /**
  118723. * Defines the color used to simulate the ambient color (Default is (0, 0, 0))
  118724. */
  118725. ambientColor: Color3;
  118726. /**
  118727. * This is use to store the default BRDF lookup for PBR materials in your scene.
  118728. * It should only be one of the following (if not the default embedded one):
  118729. * * For uncorrelated BRDF (pbr.brdf.useEnergyConservation = false and pbr.brdf.useSmithVisibilityHeightCorrelated = false) : https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds
  118730. * * For correlated BRDF (pbr.brdf.useEnergyConservation = false and pbr.brdf.useSmithVisibilityHeightCorrelated = true) : https://assets.babylonjs.com/environments/correlatedBRDF.dds
  118731. * * For correlated multi scattering BRDF (pbr.brdf.useEnergyConservation = true and pbr.brdf.useSmithVisibilityHeightCorrelated = true) : https://assets.babylonjs.com/environments/correlatedMSBRDF.dds
  118732. * The material properties need to be setup according to the type of texture in use.
  118733. */
  118734. environmentBRDFTexture: BaseTexture;
  118735. /** @hidden */
  118736. protected _environmentTexture: Nullable<BaseTexture>;
  118737. /**
  118738. * Texture used in all pbr material as the reflection texture.
  118739. * As in the majority of the scene they are the same (exception for multi room and so on),
  118740. * this is easier to reference from here than from all the materials.
  118741. */
  118742. get environmentTexture(): Nullable<BaseTexture>;
  118743. /**
  118744. * Texture used in all pbr material as the reflection texture.
  118745. * As in the majority of the scene they are the same (exception for multi room and so on),
  118746. * this is easier to set here than in all the materials.
  118747. */
  118748. set environmentTexture(value: Nullable<BaseTexture>);
  118749. /** @hidden */
  118750. protected _environmentIntensity: number;
  118751. /**
  118752. * Intensity of the environment in all pbr material.
  118753. * This dims or reinforces the IBL lighting overall (reflection and diffuse).
  118754. * As in the majority of the scene they are the same (exception for multi room and so on),
  118755. * this is easier to reference from here than from all the materials.
  118756. */
  118757. get environmentIntensity(): number;
  118758. /**
  118759. * Intensity of the environment in all pbr material.
  118760. * This dims or reinforces the IBL lighting overall (reflection and diffuse).
  118761. * As in the majority of the scene they are the same (exception for multi room and so on),
  118762. * this is easier to set here than in all the materials.
  118763. */
  118764. set environmentIntensity(value: number);
  118765. /** @hidden */
  118766. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  118767. /**
  118768. * Default image processing configuration used either in the rendering
  118769. * Forward main pass or through the imageProcessingPostProcess if present.
  118770. * As in the majority of the scene they are the same (exception for multi camera),
  118771. * this is easier to reference from here than from all the materials and post process.
  118772. *
  118773. * No setter as we it is a shared configuration, you can set the values instead.
  118774. */
  118775. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  118776. private _forceWireframe;
  118777. /**
  118778. * Gets or sets a boolean indicating if all rendering must be done in wireframe
  118779. */
  118780. set forceWireframe(value: boolean);
  118781. get forceWireframe(): boolean;
  118782. private _skipFrustumClipping;
  118783. /**
  118784. * Gets or sets a boolean indicating if we should skip the frustum clipping part of the active meshes selection
  118785. */
  118786. set skipFrustumClipping(value: boolean);
  118787. get skipFrustumClipping(): boolean;
  118788. private _forcePointsCloud;
  118789. /**
  118790. * Gets or sets a boolean indicating if all rendering must be done in point cloud
  118791. */
  118792. set forcePointsCloud(value: boolean);
  118793. get forcePointsCloud(): boolean;
  118794. /**
  118795. * Gets or sets the active clipplane 1
  118796. */
  118797. clipPlane: Nullable<Plane>;
  118798. /**
  118799. * Gets or sets the active clipplane 2
  118800. */
  118801. clipPlane2: Nullable<Plane>;
  118802. /**
  118803. * Gets or sets the active clipplane 3
  118804. */
  118805. clipPlane3: Nullable<Plane>;
  118806. /**
  118807. * Gets or sets the active clipplane 4
  118808. */
  118809. clipPlane4: Nullable<Plane>;
  118810. /**
  118811. * Gets or sets the active clipplane 5
  118812. */
  118813. clipPlane5: Nullable<Plane>;
  118814. /**
  118815. * Gets or sets the active clipplane 6
  118816. */
  118817. clipPlane6: Nullable<Plane>;
  118818. /**
  118819. * Gets or sets a boolean indicating if animations are enabled
  118820. */
  118821. animationsEnabled: boolean;
  118822. private _animationPropertiesOverride;
  118823. /**
  118824. * Gets or sets the animation properties override
  118825. */
  118826. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  118827. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  118828. /**
  118829. * Gets or sets a boolean indicating if a constant deltatime has to be used
  118830. * This is mostly useful for testing purposes when you do not want the animations to scale with the framerate
  118831. */
  118832. useConstantAnimationDeltaTime: boolean;
  118833. /**
  118834. * Gets or sets a boolean indicating if the scene must keep the meshUnderPointer property updated
  118835. * Please note that it requires to run a ray cast through the scene on every frame
  118836. */
  118837. constantlyUpdateMeshUnderPointer: boolean;
  118838. /**
  118839. * Defines the HTML cursor to use when hovering over interactive elements
  118840. */
  118841. hoverCursor: string;
  118842. /**
  118843. * Defines the HTML default cursor to use (empty by default)
  118844. */
  118845. defaultCursor: string;
  118846. /**
  118847. * Defines whether cursors are handled by the scene.
  118848. */
  118849. doNotHandleCursors: boolean;
  118850. /**
  118851. * This is used to call preventDefault() on pointer down
  118852. * in order to block unwanted artifacts like system double clicks
  118853. */
  118854. preventDefaultOnPointerDown: boolean;
  118855. /**
  118856. * This is used to call preventDefault() on pointer up
  118857. * in order to block unwanted artifacts like system double clicks
  118858. */
  118859. preventDefaultOnPointerUp: boolean;
  118860. /**
  118861. * Gets or sets user defined metadata
  118862. */
  118863. metadata: any;
  118864. /**
  118865. * For internal use only. Please do not use.
  118866. */
  118867. reservedDataStore: any;
  118868. /**
  118869. * Gets the name of the plugin used to load this scene (null by default)
  118870. */
  118871. loadingPluginName: string;
  118872. /**
  118873. * Use this array to add regular expressions used to disable offline support for specific urls
  118874. */
  118875. disableOfflineSupportExceptionRules: RegExp[];
  118876. /**
  118877. * An event triggered when the scene is disposed.
  118878. */
  118879. onDisposeObservable: Observable<Scene>;
  118880. private _onDisposeObserver;
  118881. /** Sets a function to be executed when this scene is disposed. */
  118882. set onDispose(callback: () => void);
  118883. /**
  118884. * An event triggered before rendering the scene (right after animations and physics)
  118885. */
  118886. onBeforeRenderObservable: Observable<Scene>;
  118887. private _onBeforeRenderObserver;
  118888. /** Sets a function to be executed before rendering this scene */
  118889. set beforeRender(callback: Nullable<() => void>);
  118890. /**
  118891. * An event triggered after rendering the scene
  118892. */
  118893. onAfterRenderObservable: Observable<Scene>;
  118894. /**
  118895. * An event triggered after rendering the scene for an active camera (When scene.render is called this will be called after each camera)
  118896. */
  118897. onAfterRenderCameraObservable: Observable<Camera>;
  118898. private _onAfterRenderObserver;
  118899. /** Sets a function to be executed after rendering this scene */
  118900. set afterRender(callback: Nullable<() => void>);
  118901. /**
  118902. * An event triggered before animating the scene
  118903. */
  118904. onBeforeAnimationsObservable: Observable<Scene>;
  118905. /**
  118906. * An event triggered after animations processing
  118907. */
  118908. onAfterAnimationsObservable: Observable<Scene>;
  118909. /**
  118910. * An event triggered before draw calls are ready to be sent
  118911. */
  118912. onBeforeDrawPhaseObservable: Observable<Scene>;
  118913. /**
  118914. * An event triggered after draw calls have been sent
  118915. */
  118916. onAfterDrawPhaseObservable: Observable<Scene>;
  118917. /**
  118918. * An event triggered when the scene is ready
  118919. */
  118920. onReadyObservable: Observable<Scene>;
  118921. /**
  118922. * An event triggered before rendering a camera
  118923. */
  118924. onBeforeCameraRenderObservable: Observable<Camera>;
  118925. private _onBeforeCameraRenderObserver;
  118926. /** Sets a function to be executed before rendering a camera*/
  118927. set beforeCameraRender(callback: () => void);
  118928. /**
  118929. * An event triggered after rendering a camera
  118930. */
  118931. onAfterCameraRenderObservable: Observable<Camera>;
  118932. private _onAfterCameraRenderObserver;
  118933. /** Sets a function to be executed after rendering a camera*/
  118934. set afterCameraRender(callback: () => void);
  118935. /**
  118936. * An event triggered when active meshes evaluation is about to start
  118937. */
  118938. onBeforeActiveMeshesEvaluationObservable: Observable<Scene>;
  118939. /**
  118940. * An event triggered when active meshes evaluation is done
  118941. */
  118942. onAfterActiveMeshesEvaluationObservable: Observable<Scene>;
  118943. /**
  118944. * An event triggered when particles rendering is about to start
  118945. * Note: This event can be trigger more than once per frame (because particles can be rendered by render target textures as well)
  118946. */
  118947. onBeforeParticlesRenderingObservable: Observable<Scene>;
  118948. /**
  118949. * An event triggered when particles rendering is done
  118950. * Note: This event can be trigger more than once per frame (because particles can be rendered by render target textures as well)
  118951. */
  118952. onAfterParticlesRenderingObservable: Observable<Scene>;
  118953. /**
  118954. * An event triggered when SceneLoader.Append or SceneLoader.Load or SceneLoader.ImportMesh were successfully executed
  118955. */
  118956. onDataLoadedObservable: Observable<Scene>;
  118957. /**
  118958. * An event triggered when a camera is created
  118959. */
  118960. onNewCameraAddedObservable: Observable<Camera>;
  118961. /**
  118962. * An event triggered when a camera is removed
  118963. */
  118964. onCameraRemovedObservable: Observable<Camera>;
  118965. /**
  118966. * An event triggered when a light is created
  118967. */
  118968. onNewLightAddedObservable: Observable<Light>;
  118969. /**
  118970. * An event triggered when a light is removed
  118971. */
  118972. onLightRemovedObservable: Observable<Light>;
  118973. /**
  118974. * An event triggered when a geometry is created
  118975. */
  118976. onNewGeometryAddedObservable: Observable<Geometry>;
  118977. /**
  118978. * An event triggered when a geometry is removed
  118979. */
  118980. onGeometryRemovedObservable: Observable<Geometry>;
  118981. /**
  118982. * An event triggered when a transform node is created
  118983. */
  118984. onNewTransformNodeAddedObservable: Observable<TransformNode>;
  118985. /**
  118986. * An event triggered when a transform node is removed
  118987. */
  118988. onTransformNodeRemovedObservable: Observable<TransformNode>;
  118989. /**
  118990. * An event triggered when a mesh is created
  118991. */
  118992. onNewMeshAddedObservable: Observable<AbstractMesh>;
  118993. /**
  118994. * An event triggered when a mesh is removed
  118995. */
  118996. onMeshRemovedObservable: Observable<AbstractMesh>;
  118997. /**
  118998. * An event triggered when a skeleton is created
  118999. */
  119000. onNewSkeletonAddedObservable: Observable<Skeleton>;
  119001. /**
  119002. * An event triggered when a skeleton is removed
  119003. */
  119004. onSkeletonRemovedObservable: Observable<Skeleton>;
  119005. /**
  119006. * An event triggered when a material is created
  119007. */
  119008. onNewMaterialAddedObservable: Observable<Material>;
  119009. /**
  119010. * An event triggered when a material is removed
  119011. */
  119012. onMaterialRemovedObservable: Observable<Material>;
  119013. /**
  119014. * An event triggered when a texture is created
  119015. */
  119016. onNewTextureAddedObservable: Observable<BaseTexture>;
  119017. /**
  119018. * An event triggered when a texture is removed
  119019. */
  119020. onTextureRemovedObservable: Observable<BaseTexture>;
  119021. /**
  119022. * An event triggered when render targets are about to be rendered
  119023. * Can happen multiple times per frame.
  119024. */
  119025. onBeforeRenderTargetsRenderObservable: Observable<Scene>;
  119026. /**
  119027. * An event triggered when render targets were rendered.
  119028. * Can happen multiple times per frame.
  119029. */
  119030. onAfterRenderTargetsRenderObservable: Observable<Scene>;
  119031. /**
  119032. * An event triggered before calculating deterministic simulation step
  119033. */
  119034. onBeforeStepObservable: Observable<Scene>;
  119035. /**
  119036. * An event triggered after calculating deterministic simulation step
  119037. */
  119038. onAfterStepObservable: Observable<Scene>;
  119039. /**
  119040. * An event triggered when the activeCamera property is updated
  119041. */
  119042. onActiveCameraChanged: Observable<Scene>;
  119043. /**
  119044. * This Observable will be triggered before rendering each renderingGroup of each rendered camera.
  119045. * The RenderinGroupInfo class contains all the information about the context in which the observable is called
  119046. * 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)
  119047. */
  119048. onBeforeRenderingGroupObservable: Observable<RenderingGroupInfo>;
  119049. /**
  119050. * This Observable will be triggered after rendering each renderingGroup of each rendered camera.
  119051. * The RenderinGroupInfo class contains all the information about the context in which the observable is called
  119052. * 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)
  119053. */
  119054. onAfterRenderingGroupObservable: Observable<RenderingGroupInfo>;
  119055. /**
  119056. * This Observable will when a mesh has been imported into the scene.
  119057. */
  119058. onMeshImportedObservable: Observable<AbstractMesh>;
  119059. /**
  119060. * This Observable will when an animation file has been imported into the scene.
  119061. */
  119062. onAnimationFileImportedObservable: Observable<Scene>;
  119063. /**
  119064. * Gets or sets a user defined funtion to select LOD from a mesh and a camera.
  119065. * By default this function is undefined and Babylon.js will select LOD based on distance to camera
  119066. */
  119067. customLODSelector: (mesh: AbstractMesh, camera: Camera) => Nullable<AbstractMesh>;
  119068. /** @hidden */
  119069. _registeredForLateAnimationBindings: SmartArrayNoDuplicate<any>;
  119070. /**
  119071. * Gets or sets a predicate used to select candidate meshes for a pointer down event
  119072. */
  119073. pointerDownPredicate: (Mesh: AbstractMesh) => boolean;
  119074. /**
  119075. * Gets or sets a predicate used to select candidate meshes for a pointer up event
  119076. */
  119077. pointerUpPredicate: (Mesh: AbstractMesh) => boolean;
  119078. /**
  119079. * Gets or sets a predicate used to select candidate meshes for a pointer move event
  119080. */
  119081. pointerMovePredicate: (Mesh: AbstractMesh) => boolean;
  119082. /** Callback called when a pointer move is detected */
  119083. onPointerMove: (evt: PointerEvent, pickInfo: PickingInfo, type: PointerEventTypes) => void;
  119084. /** Callback called when a pointer down is detected */
  119085. onPointerDown: (evt: PointerEvent, pickInfo: PickingInfo, type: PointerEventTypes) => void;
  119086. /** Callback called when a pointer up is detected */
  119087. onPointerUp: (evt: PointerEvent, pickInfo: Nullable<PickingInfo>, type: PointerEventTypes) => void;
  119088. /** Callback called when a pointer pick is detected */
  119089. onPointerPick: (evt: PointerEvent, pickInfo: PickingInfo) => void;
  119090. /**
  119091. * 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).
  119092. * You have the possibility to skip the process and the call to onPointerObservable by setting PointerInfoPre.skipOnPointerObservable to true
  119093. */
  119094. onPrePointerObservable: Observable<PointerInfoPre>;
  119095. /**
  119096. * Observable event triggered each time an input event is received from the rendering canvas
  119097. */
  119098. onPointerObservable: Observable<PointerInfo>;
  119099. /**
  119100. * Gets the pointer coordinates without any translation (ie. straight out of the pointer event)
  119101. */
  119102. get unTranslatedPointer(): Vector2;
  119103. /**
  119104. * Gets or sets the distance in pixel that you have to move to prevent some events. Default is 10 pixels
  119105. */
  119106. static get DragMovementThreshold(): number;
  119107. static set DragMovementThreshold(value: number);
  119108. /**
  119109. * Time in milliseconds to wait to raise long press events if button is still pressed. Default is 500 ms
  119110. */
  119111. static get LongPressDelay(): number;
  119112. static set LongPressDelay(value: number);
  119113. /**
  119114. * Time in milliseconds to wait to raise long press events if button is still pressed. Default is 300 ms
  119115. */
  119116. static get DoubleClickDelay(): number;
  119117. static set DoubleClickDelay(value: number);
  119118. /** If you need to check double click without raising a single click at first click, enable this flag */
  119119. static get ExclusiveDoubleClickMode(): boolean;
  119120. static set ExclusiveDoubleClickMode(value: boolean);
  119121. /** @hidden */
  119122. _mirroredCameraPosition: Nullable<Vector3>;
  119123. /**
  119124. * This observable event is triggered when any keyboard event si raised and registered during Scene.attachControl()
  119125. * You have the possibility to skip the process and the call to onKeyboardObservable by setting KeyboardInfoPre.skipOnPointerObservable to true
  119126. */
  119127. onPreKeyboardObservable: Observable<KeyboardInfoPre>;
  119128. /**
  119129. * Observable event triggered each time an keyboard event is received from the hosting window
  119130. */
  119131. onKeyboardObservable: Observable<KeyboardInfo>;
  119132. private _useRightHandedSystem;
  119133. /**
  119134. * Gets or sets a boolean indicating if the scene must use right-handed coordinates system
  119135. */
  119136. set useRightHandedSystem(value: boolean);
  119137. get useRightHandedSystem(): boolean;
  119138. private _timeAccumulator;
  119139. private _currentStepId;
  119140. private _currentInternalStep;
  119141. /**
  119142. * Sets the step Id used by deterministic lock step
  119143. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  119144. * @param newStepId defines the step Id
  119145. */
  119146. setStepId(newStepId: number): void;
  119147. /**
  119148. * Gets the step Id used by deterministic lock step
  119149. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  119150. * @returns the step Id
  119151. */
  119152. getStepId(): number;
  119153. /**
  119154. * Gets the internal step used by deterministic lock step
  119155. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  119156. * @returns the internal step
  119157. */
  119158. getInternalStep(): number;
  119159. private _fogEnabled;
  119160. /**
  119161. * Gets or sets a boolean indicating if fog is enabled on this scene
  119162. * @see https://doc.babylonjs.com/babylon101/environment#fog
  119163. * (Default is true)
  119164. */
  119165. set fogEnabled(value: boolean);
  119166. get fogEnabled(): boolean;
  119167. private _fogMode;
  119168. /**
  119169. * Gets or sets the fog mode to use
  119170. * @see https://doc.babylonjs.com/babylon101/environment#fog
  119171. * | mode | value |
  119172. * | --- | --- |
  119173. * | FOGMODE_NONE | 0 |
  119174. * | FOGMODE_EXP | 1 |
  119175. * | FOGMODE_EXP2 | 2 |
  119176. * | FOGMODE_LINEAR | 3 |
  119177. */
  119178. set fogMode(value: number);
  119179. get fogMode(): number;
  119180. /**
  119181. * Gets or sets the fog color to use
  119182. * @see https://doc.babylonjs.com/babylon101/environment#fog
  119183. * (Default is Color3(0.2, 0.2, 0.3))
  119184. */
  119185. fogColor: Color3;
  119186. /**
  119187. * Gets or sets the fog density to use
  119188. * @see https://doc.babylonjs.com/babylon101/environment#fog
  119189. * (Default is 0.1)
  119190. */
  119191. fogDensity: number;
  119192. /**
  119193. * Gets or sets the fog start distance to use
  119194. * @see https://doc.babylonjs.com/babylon101/environment#fog
  119195. * (Default is 0)
  119196. */
  119197. fogStart: number;
  119198. /**
  119199. * Gets or sets the fog end distance to use
  119200. * @see https://doc.babylonjs.com/babylon101/environment#fog
  119201. * (Default is 1000)
  119202. */
  119203. fogEnd: number;
  119204. /**
  119205. * Flag indicating that the frame buffer binding is handled by another component
  119206. */
  119207. prePass: boolean;
  119208. private _shadowsEnabled;
  119209. /**
  119210. * Gets or sets a boolean indicating if shadows are enabled on this scene
  119211. */
  119212. set shadowsEnabled(value: boolean);
  119213. get shadowsEnabled(): boolean;
  119214. private _lightsEnabled;
  119215. /**
  119216. * Gets or sets a boolean indicating if lights are enabled on this scene
  119217. */
  119218. set lightsEnabled(value: boolean);
  119219. get lightsEnabled(): boolean;
  119220. /** All of the active cameras added to this scene. */
  119221. activeCameras: Camera[];
  119222. /** @hidden */
  119223. _activeCamera: Nullable<Camera>;
  119224. /** Gets or sets the current active camera */
  119225. get activeCamera(): Nullable<Camera>;
  119226. set activeCamera(value: Nullable<Camera>);
  119227. private _defaultMaterial;
  119228. /** The default material used on meshes when no material is affected */
  119229. get defaultMaterial(): Material;
  119230. /** The default material used on meshes when no material is affected */
  119231. set defaultMaterial(value: Material);
  119232. private _texturesEnabled;
  119233. /**
  119234. * Gets or sets a boolean indicating if textures are enabled on this scene
  119235. */
  119236. set texturesEnabled(value: boolean);
  119237. get texturesEnabled(): boolean;
  119238. /**
  119239. * Gets or sets a boolean indicating if physic engines are enabled on this scene
  119240. */
  119241. physicsEnabled: boolean;
  119242. /**
  119243. * Gets or sets a boolean indicating if particles are enabled on this scene
  119244. */
  119245. particlesEnabled: boolean;
  119246. /**
  119247. * Gets or sets a boolean indicating if sprites are enabled on this scene
  119248. */
  119249. spritesEnabled: boolean;
  119250. private _skeletonsEnabled;
  119251. /**
  119252. * Gets or sets a boolean indicating if skeletons are enabled on this scene
  119253. */
  119254. set skeletonsEnabled(value: boolean);
  119255. get skeletonsEnabled(): boolean;
  119256. /**
  119257. * Gets or sets a boolean indicating if lens flares are enabled on this scene
  119258. */
  119259. lensFlaresEnabled: boolean;
  119260. /**
  119261. * Gets or sets a boolean indicating if collisions are enabled on this scene
  119262. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  119263. */
  119264. collisionsEnabled: boolean;
  119265. private _collisionCoordinator;
  119266. /** @hidden */
  119267. get collisionCoordinator(): ICollisionCoordinator;
  119268. /**
  119269. * Defines the gravity applied to this scene (used only for collisions)
  119270. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  119271. */
  119272. gravity: Vector3;
  119273. /**
  119274. * Gets or sets a boolean indicating if postprocesses are enabled on this scene
  119275. */
  119276. postProcessesEnabled: boolean;
  119277. /**
  119278. * Gets the current postprocess manager
  119279. */
  119280. postProcessManager: PostProcessManager;
  119281. /**
  119282. * Gets or sets a boolean indicating if render targets are enabled on this scene
  119283. */
  119284. renderTargetsEnabled: boolean;
  119285. /**
  119286. * Gets or sets a boolean indicating if next render targets must be dumped as image for debugging purposes
  119287. * We recommend not using it and instead rely on Spector.js: http://spector.babylonjs.com
  119288. */
  119289. dumpNextRenderTargets: boolean;
  119290. /**
  119291. * The list of user defined render targets added to the scene
  119292. */
  119293. customRenderTargets: RenderTargetTexture[];
  119294. /**
  119295. * Defines if texture loading must be delayed
  119296. * If true, textures will only be loaded when they need to be rendered
  119297. */
  119298. useDelayedTextureLoading: boolean;
  119299. /**
  119300. * Gets the list of meshes imported to the scene through SceneLoader
  119301. */
  119302. importedMeshesFiles: String[];
  119303. /**
  119304. * Gets or sets a boolean indicating if probes are enabled on this scene
  119305. */
  119306. probesEnabled: boolean;
  119307. /**
  119308. * Gets or sets the current offline provider to use to store scene data
  119309. * @see https://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  119310. */
  119311. offlineProvider: IOfflineProvider;
  119312. /**
  119313. * Gets or sets the action manager associated with the scene
  119314. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  119315. */
  119316. actionManager: AbstractActionManager;
  119317. private _meshesForIntersections;
  119318. /**
  119319. * Gets or sets a boolean indicating if procedural textures are enabled on this scene
  119320. */
  119321. proceduralTexturesEnabled: boolean;
  119322. private _engine;
  119323. private _totalVertices;
  119324. /** @hidden */
  119325. _activeIndices: PerfCounter;
  119326. /** @hidden */
  119327. _activeParticles: PerfCounter;
  119328. /** @hidden */
  119329. _activeBones: PerfCounter;
  119330. private _animationRatio;
  119331. /** @hidden */
  119332. _animationTimeLast: number;
  119333. /** @hidden */
  119334. _animationTime: number;
  119335. /**
  119336. * Gets or sets a general scale for animation speed
  119337. * @see https://www.babylonjs-playground.com/#IBU2W7#3
  119338. */
  119339. animationTimeScale: number;
  119340. /** @hidden */
  119341. _cachedMaterial: Nullable<Material>;
  119342. /** @hidden */
  119343. _cachedEffect: Nullable<Effect>;
  119344. /** @hidden */
  119345. _cachedVisibility: Nullable<number>;
  119346. private _renderId;
  119347. private _frameId;
  119348. private _executeWhenReadyTimeoutId;
  119349. private _intermediateRendering;
  119350. private _viewUpdateFlag;
  119351. private _projectionUpdateFlag;
  119352. /** @hidden */
  119353. _toBeDisposed: Nullable<IDisposable>[];
  119354. private _activeRequests;
  119355. /** @hidden */
  119356. _pendingData: any[];
  119357. private _isDisposed;
  119358. /**
  119359. * Gets or sets a boolean indicating that all submeshes of active meshes must be rendered
  119360. * Use this boolean to avoid computing frustum clipping on submeshes (This could help when you are CPU bound)
  119361. */
  119362. dispatchAllSubMeshesOfActiveMeshes: boolean;
  119363. private _activeMeshes;
  119364. private _processedMaterials;
  119365. private _renderTargets;
  119366. /** @hidden */
  119367. _activeParticleSystems: SmartArray<IParticleSystem>;
  119368. private _activeSkeletons;
  119369. private _softwareSkinnedMeshes;
  119370. private _renderingManager;
  119371. /** @hidden */
  119372. _activeAnimatables: Animatable[];
  119373. private _transformMatrix;
  119374. private _sceneUbo;
  119375. /** @hidden */
  119376. _viewMatrix: Matrix;
  119377. private _projectionMatrix;
  119378. /** @hidden */
  119379. _forcedViewPosition: Nullable<Vector3>;
  119380. /** @hidden */
  119381. _frustumPlanes: Plane[];
  119382. /**
  119383. * Gets the list of frustum planes (built from the active camera)
  119384. */
  119385. get frustumPlanes(): Plane[];
  119386. /**
  119387. * Gets or sets a boolean indicating if lights must be sorted by priority (off by default)
  119388. * This is useful if there are more lights that the maximum simulteanous authorized
  119389. */
  119390. requireLightSorting: boolean;
  119391. /** @hidden */
  119392. readonly useMaterialMeshMap: boolean;
  119393. /** @hidden */
  119394. readonly useClonedMeshMap: boolean;
  119395. private _externalData;
  119396. private _uid;
  119397. /**
  119398. * @hidden
  119399. * Backing store of defined scene components.
  119400. */
  119401. _components: ISceneComponent[];
  119402. /**
  119403. * @hidden
  119404. * Backing store of defined scene components.
  119405. */
  119406. _serializableComponents: ISceneSerializableComponent[];
  119407. /**
  119408. * List of components to register on the next registration step.
  119409. */
  119410. private _transientComponents;
  119411. /**
  119412. * Registers the transient components if needed.
  119413. */
  119414. private _registerTransientComponents;
  119415. /**
  119416. * @hidden
  119417. * Add a component to the scene.
  119418. * Note that the ccomponent could be registered on th next frame if this is called after
  119419. * the register component stage.
  119420. * @param component Defines the component to add to the scene
  119421. */
  119422. _addComponent(component: ISceneComponent): void;
  119423. /**
  119424. * @hidden
  119425. * Gets a component from the scene.
  119426. * @param name defines the name of the component to retrieve
  119427. * @returns the component or null if not present
  119428. */
  119429. _getComponent(name: string): Nullable<ISceneComponent>;
  119430. /**
  119431. * @hidden
  119432. * Defines the actions happening before camera updates.
  119433. */
  119434. _beforeCameraUpdateStage: Stage<SimpleStageAction>;
  119435. /**
  119436. * @hidden
  119437. * Defines the actions happening before clear the canvas.
  119438. */
  119439. _beforeClearStage: Stage<SimpleStageAction>;
  119440. /**
  119441. * @hidden
  119442. * Defines the actions when collecting render targets for the frame.
  119443. */
  119444. _gatherRenderTargetsStage: Stage<RenderTargetsStageAction>;
  119445. /**
  119446. * @hidden
  119447. * Defines the actions happening for one camera in the frame.
  119448. */
  119449. _gatherActiveCameraRenderTargetsStage: Stage<RenderTargetsStageAction>;
  119450. /**
  119451. * @hidden
  119452. * Defines the actions happening during the per mesh ready checks.
  119453. */
  119454. _isReadyForMeshStage: Stage<MeshStageAction>;
  119455. /**
  119456. * @hidden
  119457. * Defines the actions happening before evaluate active mesh checks.
  119458. */
  119459. _beforeEvaluateActiveMeshStage: Stage<SimpleStageAction>;
  119460. /**
  119461. * @hidden
  119462. * Defines the actions happening during the evaluate sub mesh checks.
  119463. */
  119464. _evaluateSubMeshStage: Stage<EvaluateSubMeshStageAction>;
  119465. /**
  119466. * @hidden
  119467. * Defines the actions happening during the active mesh stage.
  119468. */
  119469. _activeMeshStage: Stage<ActiveMeshStageAction>;
  119470. /**
  119471. * @hidden
  119472. * Defines the actions happening during the per camera render target step.
  119473. */
  119474. _cameraDrawRenderTargetStage: Stage<CameraStageFrameBufferAction>;
  119475. /**
  119476. * @hidden
  119477. * Defines the actions happening just before the active camera is drawing.
  119478. */
  119479. _beforeCameraDrawStage: Stage<CameraStageAction>;
  119480. /**
  119481. * @hidden
  119482. * Defines the actions happening just before a render target is drawing.
  119483. */
  119484. _beforeRenderTargetDrawStage: Stage<RenderTargetStageAction>;
  119485. /**
  119486. * @hidden
  119487. * Defines the actions happening just before a rendering group is drawing.
  119488. */
  119489. _beforeRenderingGroupDrawStage: Stage<RenderingGroupStageAction>;
  119490. /**
  119491. * @hidden
  119492. * Defines the actions happening just before a mesh is drawing.
  119493. */
  119494. _beforeRenderingMeshStage: Stage<RenderingMeshStageAction>;
  119495. /**
  119496. * @hidden
  119497. * Defines the actions happening just after a mesh has been drawn.
  119498. */
  119499. _afterRenderingMeshStage: Stage<RenderingMeshStageAction>;
  119500. /**
  119501. * @hidden
  119502. * Defines the actions happening just after a rendering group has been drawn.
  119503. */
  119504. _afterRenderingGroupDrawStage: Stage<RenderingGroupStageAction>;
  119505. /**
  119506. * @hidden
  119507. * Defines the actions happening just after the active camera has been drawn.
  119508. */
  119509. _afterCameraDrawStage: Stage<CameraStageAction>;
  119510. /**
  119511. * @hidden
  119512. * Defines the actions happening just after a render target has been drawn.
  119513. */
  119514. _afterRenderTargetDrawStage: Stage<RenderTargetStageAction>;
  119515. /**
  119516. * @hidden
  119517. * Defines the actions happening just after rendering all cameras and computing intersections.
  119518. */
  119519. _afterRenderStage: Stage<SimpleStageAction>;
  119520. /**
  119521. * @hidden
  119522. * Defines the actions happening when a pointer move event happens.
  119523. */
  119524. _pointerMoveStage: Stage<PointerMoveStageAction>;
  119525. /**
  119526. * @hidden
  119527. * Defines the actions happening when a pointer down event happens.
  119528. */
  119529. _pointerDownStage: Stage<PointerUpDownStageAction>;
  119530. /**
  119531. * @hidden
  119532. * Defines the actions happening when a pointer up event happens.
  119533. */
  119534. _pointerUpStage: Stage<PointerUpDownStageAction>;
  119535. /**
  119536. * an optional map from Geometry Id to Geometry index in the 'geometries' array
  119537. */
  119538. private geometriesByUniqueId;
  119539. /**
  119540. * Creates a new Scene
  119541. * @param engine defines the engine to use to render this scene
  119542. * @param options defines the scene options
  119543. */
  119544. constructor(engine: Engine, options?: SceneOptions);
  119545. /**
  119546. * Gets a string identifying the name of the class
  119547. * @returns "Scene" string
  119548. */
  119549. getClassName(): string;
  119550. private _defaultMeshCandidates;
  119551. /**
  119552. * @hidden
  119553. */
  119554. _getDefaultMeshCandidates(): ISmartArrayLike<AbstractMesh>;
  119555. private _defaultSubMeshCandidates;
  119556. /**
  119557. * @hidden
  119558. */
  119559. _getDefaultSubMeshCandidates(mesh: AbstractMesh): ISmartArrayLike<SubMesh>;
  119560. /**
  119561. * Sets the default candidate providers for the scene.
  119562. * This sets the getActiveMeshCandidates, getActiveSubMeshCandidates, getIntersectingSubMeshCandidates
  119563. * and getCollidingSubMeshCandidates to their default function
  119564. */
  119565. setDefaultCandidateProviders(): void;
  119566. /**
  119567. * Gets the mesh that is currently under the pointer
  119568. */
  119569. get meshUnderPointer(): Nullable<AbstractMesh>;
  119570. /**
  119571. * Gets or sets the current on-screen X position of the pointer
  119572. */
  119573. get pointerX(): number;
  119574. set pointerX(value: number);
  119575. /**
  119576. * Gets or sets the current on-screen Y position of the pointer
  119577. */
  119578. get pointerY(): number;
  119579. set pointerY(value: number);
  119580. /**
  119581. * Gets the cached material (ie. the latest rendered one)
  119582. * @returns the cached material
  119583. */
  119584. getCachedMaterial(): Nullable<Material>;
  119585. /**
  119586. * Gets the cached effect (ie. the latest rendered one)
  119587. * @returns the cached effect
  119588. */
  119589. getCachedEffect(): Nullable<Effect>;
  119590. /**
  119591. * Gets the cached visibility state (ie. the latest rendered one)
  119592. * @returns the cached visibility state
  119593. */
  119594. getCachedVisibility(): Nullable<number>;
  119595. /**
  119596. * Gets a boolean indicating if the current material / effect / visibility must be bind again
  119597. * @param material defines the current material
  119598. * @param effect defines the current effect
  119599. * @param visibility defines the current visibility state
  119600. * @returns true if one parameter is not cached
  119601. */
  119602. isCachedMaterialInvalid(material: Material, effect: Effect, visibility?: number): boolean;
  119603. /**
  119604. * Gets the engine associated with the scene
  119605. * @returns an Engine
  119606. */
  119607. getEngine(): Engine;
  119608. /**
  119609. * Gets the total number of vertices rendered per frame
  119610. * @returns the total number of vertices rendered per frame
  119611. */
  119612. getTotalVertices(): number;
  119613. /**
  119614. * Gets the performance counter for total vertices
  119615. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  119616. */
  119617. get totalVerticesPerfCounter(): PerfCounter;
  119618. /**
  119619. * Gets the total number of active indices rendered per frame (You can deduce the number of rendered triangles by dividing this number by 3)
  119620. * @returns the total number of active indices rendered per frame
  119621. */
  119622. getActiveIndices(): number;
  119623. /**
  119624. * Gets the performance counter for active indices
  119625. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  119626. */
  119627. get totalActiveIndicesPerfCounter(): PerfCounter;
  119628. /**
  119629. * Gets the total number of active particles rendered per frame
  119630. * @returns the total number of active particles rendered per frame
  119631. */
  119632. getActiveParticles(): number;
  119633. /**
  119634. * Gets the performance counter for active particles
  119635. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  119636. */
  119637. get activeParticlesPerfCounter(): PerfCounter;
  119638. /**
  119639. * Gets the total number of active bones rendered per frame
  119640. * @returns the total number of active bones rendered per frame
  119641. */
  119642. getActiveBones(): number;
  119643. /**
  119644. * Gets the performance counter for active bones
  119645. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  119646. */
  119647. get activeBonesPerfCounter(): PerfCounter;
  119648. /**
  119649. * Gets the array of active meshes
  119650. * @returns an array of AbstractMesh
  119651. */
  119652. getActiveMeshes(): SmartArray<AbstractMesh>;
  119653. /**
  119654. * Gets the animation ratio (which is 1.0 is the scene renders at 60fps and 2 if the scene renders at 30fps, etc.)
  119655. * @returns a number
  119656. */
  119657. getAnimationRatio(): number;
  119658. /**
  119659. * Gets an unique Id for the current render phase
  119660. * @returns a number
  119661. */
  119662. getRenderId(): number;
  119663. /**
  119664. * Gets an unique Id for the current frame
  119665. * @returns a number
  119666. */
  119667. getFrameId(): number;
  119668. /** Call this function if you want to manually increment the render Id*/
  119669. incrementRenderId(): void;
  119670. private _createUbo;
  119671. /**
  119672. * Use this method to simulate a pointer move on a mesh
  119673. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  119674. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  119675. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  119676. * @returns the current scene
  119677. */
  119678. simulatePointerMove(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): Scene;
  119679. /**
  119680. * Use this method to simulate a pointer down on a mesh
  119681. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  119682. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  119683. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  119684. * @returns the current scene
  119685. */
  119686. simulatePointerDown(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): Scene;
  119687. /**
  119688. * Use this method to simulate a pointer up on a mesh
  119689. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  119690. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  119691. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  119692. * @param doubleTap indicates that the pointer up event should be considered as part of a double click (false by default)
  119693. * @returns the current scene
  119694. */
  119695. simulatePointerUp(pickResult: PickingInfo, pointerEventInit?: PointerEventInit, doubleTap?: boolean): Scene;
  119696. /**
  119697. * Gets a boolean indicating if the current pointer event is captured (meaning that the scene has already handled the pointer down)
  119698. * @param pointerId defines the pointer id to use in a multi-touch scenario (0 by default)
  119699. * @returns true if the pointer was captured
  119700. */
  119701. isPointerCaptured(pointerId?: number): boolean;
  119702. /**
  119703. * Attach events to the canvas (To handle actionManagers triggers and raise onPointerMove, onPointerDown and onPointerUp
  119704. * @param attachUp defines if you want to attach events to pointerup
  119705. * @param attachDown defines if you want to attach events to pointerdown
  119706. * @param attachMove defines if you want to attach events to pointermove
  119707. */
  119708. attachControl(attachUp?: boolean, attachDown?: boolean, attachMove?: boolean): void;
  119709. /** Detaches all event handlers*/
  119710. detachControl(): void;
  119711. /**
  119712. * This function will check if the scene can be rendered (textures are loaded, shaders are compiled)
  119713. * Delay loaded resources are not taking in account
  119714. * @return true if all required resources are ready
  119715. */
  119716. isReady(): boolean;
  119717. /** Resets all cached information relative to material (including effect and visibility) */
  119718. resetCachedMaterial(): void;
  119719. /**
  119720. * Registers a function to be called before every frame render
  119721. * @param func defines the function to register
  119722. */
  119723. registerBeforeRender(func: () => void): void;
  119724. /**
  119725. * Unregisters a function called before every frame render
  119726. * @param func defines the function to unregister
  119727. */
  119728. unregisterBeforeRender(func: () => void): void;
  119729. /**
  119730. * Registers a function to be called after every frame render
  119731. * @param func defines the function to register
  119732. */
  119733. registerAfterRender(func: () => void): void;
  119734. /**
  119735. * Unregisters a function called after every frame render
  119736. * @param func defines the function to unregister
  119737. */
  119738. unregisterAfterRender(func: () => void): void;
  119739. private _executeOnceBeforeRender;
  119740. /**
  119741. * The provided function will run before render once and will be disposed afterwards.
  119742. * A timeout delay can be provided so that the function will be executed in N ms.
  119743. * The timeout is using the browser's native setTimeout so time percision cannot be guaranteed.
  119744. * @param func The function to be executed.
  119745. * @param timeout optional delay in ms
  119746. */
  119747. executeOnceBeforeRender(func: () => void, timeout?: number): void;
  119748. /** @hidden */
  119749. _addPendingData(data: any): void;
  119750. /** @hidden */
  119751. _removePendingData(data: any): void;
  119752. /**
  119753. * Returns the number of items waiting to be loaded
  119754. * @returns the number of items waiting to be loaded
  119755. */
  119756. getWaitingItemsCount(): number;
  119757. /**
  119758. * Returns a boolean indicating if the scene is still loading data
  119759. */
  119760. get isLoading(): boolean;
  119761. /**
  119762. * Registers a function to be executed when the scene is ready
  119763. * @param {Function} func - the function to be executed
  119764. */
  119765. executeWhenReady(func: () => void): void;
  119766. /**
  119767. * Returns a promise that resolves when the scene is ready
  119768. * @returns A promise that resolves when the scene is ready
  119769. */
  119770. whenReadyAsync(): Promise<void>;
  119771. /** @hidden */
  119772. _checkIsReady(): void;
  119773. /**
  119774. * Gets all animatable attached to the scene
  119775. */
  119776. get animatables(): Animatable[];
  119777. /**
  119778. * Resets the last animation time frame.
  119779. * Useful to override when animations start running when loading a scene for the first time.
  119780. */
  119781. resetLastAnimationTimeFrame(): void;
  119782. /**
  119783. * Gets the current view matrix
  119784. * @returns a Matrix
  119785. */
  119786. getViewMatrix(): Matrix;
  119787. /**
  119788. * Gets the current projection matrix
  119789. * @returns a Matrix
  119790. */
  119791. getProjectionMatrix(): Matrix;
  119792. /**
  119793. * Gets the current transform matrix
  119794. * @returns a Matrix made of View * Projection
  119795. */
  119796. getTransformMatrix(): Matrix;
  119797. /**
  119798. * Sets the current transform matrix
  119799. * @param viewL defines the View matrix to use
  119800. * @param projectionL defines the Projection matrix to use
  119801. * @param viewR defines the right View matrix to use (if provided)
  119802. * @param projectionR defines the right Projection matrix to use (if provided)
  119803. */
  119804. setTransformMatrix(viewL: Matrix, projectionL: Matrix, viewR?: Matrix, projectionR?: Matrix): void;
  119805. /**
  119806. * Gets the uniform buffer used to store scene data
  119807. * @returns a UniformBuffer
  119808. */
  119809. getSceneUniformBuffer(): UniformBuffer;
  119810. /**
  119811. * Gets an unique (relatively to the current scene) Id
  119812. * @returns an unique number for the scene
  119813. */
  119814. getUniqueId(): number;
  119815. /**
  119816. * Add a mesh to the list of scene's meshes
  119817. * @param newMesh defines the mesh to add
  119818. * @param recursive if all child meshes should also be added to the scene
  119819. */
  119820. addMesh(newMesh: AbstractMesh, recursive?: boolean): void;
  119821. /**
  119822. * Remove a mesh for the list of scene's meshes
  119823. * @param toRemove defines the mesh to remove
  119824. * @param recursive if all child meshes should also be removed from the scene
  119825. * @returns the index where the mesh was in the mesh list
  119826. */
  119827. removeMesh(toRemove: AbstractMesh, recursive?: boolean): number;
  119828. /**
  119829. * Add a transform node to the list of scene's transform nodes
  119830. * @param newTransformNode defines the transform node to add
  119831. */
  119832. addTransformNode(newTransformNode: TransformNode): void;
  119833. /**
  119834. * Remove a transform node for the list of scene's transform nodes
  119835. * @param toRemove defines the transform node to remove
  119836. * @returns the index where the transform node was in the transform node list
  119837. */
  119838. removeTransformNode(toRemove: TransformNode): number;
  119839. /**
  119840. * Remove a skeleton for the list of scene's skeletons
  119841. * @param toRemove defines the skeleton to remove
  119842. * @returns the index where the skeleton was in the skeleton list
  119843. */
  119844. removeSkeleton(toRemove: Skeleton): number;
  119845. /**
  119846. * Remove a morph target for the list of scene's morph targets
  119847. * @param toRemove defines the morph target to remove
  119848. * @returns the index where the morph target was in the morph target list
  119849. */
  119850. removeMorphTargetManager(toRemove: MorphTargetManager): number;
  119851. /**
  119852. * Remove a light for the list of scene's lights
  119853. * @param toRemove defines the light to remove
  119854. * @returns the index where the light was in the light list
  119855. */
  119856. removeLight(toRemove: Light): number;
  119857. /**
  119858. * Remove a camera for the list of scene's cameras
  119859. * @param toRemove defines the camera to remove
  119860. * @returns the index where the camera was in the camera list
  119861. */
  119862. removeCamera(toRemove: Camera): number;
  119863. /**
  119864. * Remove a particle system for the list of scene's particle systems
  119865. * @param toRemove defines the particle system to remove
  119866. * @returns the index where the particle system was in the particle system list
  119867. */
  119868. removeParticleSystem(toRemove: IParticleSystem): number;
  119869. /**
  119870. * Remove a animation for the list of scene's animations
  119871. * @param toRemove defines the animation to remove
  119872. * @returns the index where the animation was in the animation list
  119873. */
  119874. removeAnimation(toRemove: Animation): number;
  119875. /**
  119876. * Will stop the animation of the given target
  119877. * @param target - the target
  119878. * @param animationName - the name of the animation to stop (all animations will be stopped if both this and targetMask are empty)
  119879. * @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)
  119880. */
  119881. stopAnimation(target: any, animationName?: string, targetMask?: (target: any) => boolean): void;
  119882. /**
  119883. * Removes the given animation group from this scene.
  119884. * @param toRemove The animation group to remove
  119885. * @returns The index of the removed animation group
  119886. */
  119887. removeAnimationGroup(toRemove: AnimationGroup): number;
  119888. /**
  119889. * Removes the given multi-material from this scene.
  119890. * @param toRemove The multi-material to remove
  119891. * @returns The index of the removed multi-material
  119892. */
  119893. removeMultiMaterial(toRemove: MultiMaterial): number;
  119894. /**
  119895. * Removes the given material from this scene.
  119896. * @param toRemove The material to remove
  119897. * @returns The index of the removed material
  119898. */
  119899. removeMaterial(toRemove: Material): number;
  119900. /**
  119901. * Removes the given action manager from this scene.
  119902. * @param toRemove The action manager to remove
  119903. * @returns The index of the removed action manager
  119904. */
  119905. removeActionManager(toRemove: AbstractActionManager): number;
  119906. /**
  119907. * Removes the given texture from this scene.
  119908. * @param toRemove The texture to remove
  119909. * @returns The index of the removed texture
  119910. */
  119911. removeTexture(toRemove: BaseTexture): number;
  119912. /**
  119913. * Adds the given light to this scene
  119914. * @param newLight The light to add
  119915. */
  119916. addLight(newLight: Light): void;
  119917. /**
  119918. * Sorts the list list based on light priorities
  119919. */
  119920. sortLightsByPriority(): void;
  119921. /**
  119922. * Adds the given camera to this scene
  119923. * @param newCamera The camera to add
  119924. */
  119925. addCamera(newCamera: Camera): void;
  119926. /**
  119927. * Adds the given skeleton to this scene
  119928. * @param newSkeleton The skeleton to add
  119929. */
  119930. addSkeleton(newSkeleton: Skeleton): void;
  119931. /**
  119932. * Adds the given particle system to this scene
  119933. * @param newParticleSystem The particle system to add
  119934. */
  119935. addParticleSystem(newParticleSystem: IParticleSystem): void;
  119936. /**
  119937. * Adds the given animation to this scene
  119938. * @param newAnimation The animation to add
  119939. */
  119940. addAnimation(newAnimation: Animation): void;
  119941. /**
  119942. * Adds the given animation group to this scene.
  119943. * @param newAnimationGroup The animation group to add
  119944. */
  119945. addAnimationGroup(newAnimationGroup: AnimationGroup): void;
  119946. /**
  119947. * Adds the given multi-material to this scene
  119948. * @param newMultiMaterial The multi-material to add
  119949. */
  119950. addMultiMaterial(newMultiMaterial: MultiMaterial): void;
  119951. /**
  119952. * Adds the given material to this scene
  119953. * @param newMaterial The material to add
  119954. */
  119955. addMaterial(newMaterial: Material): void;
  119956. /**
  119957. * Adds the given morph target to this scene
  119958. * @param newMorphTargetManager The morph target to add
  119959. */
  119960. addMorphTargetManager(newMorphTargetManager: MorphTargetManager): void;
  119961. /**
  119962. * Adds the given geometry to this scene
  119963. * @param newGeometry The geometry to add
  119964. */
  119965. addGeometry(newGeometry: Geometry): void;
  119966. /**
  119967. * Adds the given action manager to this scene
  119968. * @param newActionManager The action manager to add
  119969. */
  119970. addActionManager(newActionManager: AbstractActionManager): void;
  119971. /**
  119972. * Adds the given texture to this scene.
  119973. * @param newTexture The texture to add
  119974. */
  119975. addTexture(newTexture: BaseTexture): void;
  119976. /**
  119977. * Switch active camera
  119978. * @param newCamera defines the new active camera
  119979. * @param attachControl defines if attachControl must be called for the new active camera (default: true)
  119980. */
  119981. switchActiveCamera(newCamera: Camera, attachControl?: boolean): void;
  119982. /**
  119983. * sets the active camera of the scene using its ID
  119984. * @param id defines the camera's ID
  119985. * @return the new active camera or null if none found.
  119986. */
  119987. setActiveCameraByID(id: string): Nullable<Camera>;
  119988. /**
  119989. * sets the active camera of the scene using its name
  119990. * @param name defines the camera's name
  119991. * @returns the new active camera or null if none found.
  119992. */
  119993. setActiveCameraByName(name: string): Nullable<Camera>;
  119994. /**
  119995. * get an animation group using its name
  119996. * @param name defines the material's name
  119997. * @return the animation group or null if none found.
  119998. */
  119999. getAnimationGroupByName(name: string): Nullable<AnimationGroup>;
  120000. /**
  120001. * Get a material using its unique id
  120002. * @param uniqueId defines the material's unique id
  120003. * @return the material or null if none found.
  120004. */
  120005. getMaterialByUniqueID(uniqueId: number): Nullable<Material>;
  120006. /**
  120007. * get a material using its id
  120008. * @param id defines the material's ID
  120009. * @return the material or null if none found.
  120010. */
  120011. getMaterialByID(id: string): Nullable<Material>;
  120012. /**
  120013. * Gets a the last added material using a given id
  120014. * @param id defines the material's ID
  120015. * @return the last material with the given id or null if none found.
  120016. */
  120017. getLastMaterialByID(id: string): Nullable<Material>;
  120018. /**
  120019. * Gets a material using its name
  120020. * @param name defines the material's name
  120021. * @return the material or null if none found.
  120022. */
  120023. getMaterialByName(name: string): Nullable<Material>;
  120024. /**
  120025. * Get a texture using its unique id
  120026. * @param uniqueId defines the texture's unique id
  120027. * @return the texture or null if none found.
  120028. */
  120029. getTextureByUniqueID(uniqueId: number): Nullable<BaseTexture>;
  120030. /**
  120031. * Gets a camera using its id
  120032. * @param id defines the id to look for
  120033. * @returns the camera or null if not found
  120034. */
  120035. getCameraByID(id: string): Nullable<Camera>;
  120036. /**
  120037. * Gets a camera using its unique id
  120038. * @param uniqueId defines the unique id to look for
  120039. * @returns the camera or null if not found
  120040. */
  120041. getCameraByUniqueID(uniqueId: number): Nullable<Camera>;
  120042. /**
  120043. * Gets a camera using its name
  120044. * @param name defines the camera's name
  120045. * @return the camera or null if none found.
  120046. */
  120047. getCameraByName(name: string): Nullable<Camera>;
  120048. /**
  120049. * Gets a bone using its id
  120050. * @param id defines the bone's id
  120051. * @return the bone or null if not found
  120052. */
  120053. getBoneByID(id: string): Nullable<Bone>;
  120054. /**
  120055. * Gets a bone using its id
  120056. * @param name defines the bone's name
  120057. * @return the bone or null if not found
  120058. */
  120059. getBoneByName(name: string): Nullable<Bone>;
  120060. /**
  120061. * Gets a light node using its name
  120062. * @param name defines the the light's name
  120063. * @return the light or null if none found.
  120064. */
  120065. getLightByName(name: string): Nullable<Light>;
  120066. /**
  120067. * Gets a light node using its id
  120068. * @param id defines the light's id
  120069. * @return the light or null if none found.
  120070. */
  120071. getLightByID(id: string): Nullable<Light>;
  120072. /**
  120073. * Gets a light node using its scene-generated unique ID
  120074. * @param uniqueId defines the light's unique id
  120075. * @return the light or null if none found.
  120076. */
  120077. getLightByUniqueID(uniqueId: number): Nullable<Light>;
  120078. /**
  120079. * Gets a particle system by id
  120080. * @param id defines the particle system id
  120081. * @return the corresponding system or null if none found
  120082. */
  120083. getParticleSystemByID(id: string): Nullable<IParticleSystem>;
  120084. /**
  120085. * Gets a geometry using its ID
  120086. * @param id defines the geometry's id
  120087. * @return the geometry or null if none found.
  120088. */
  120089. getGeometryByID(id: string): Nullable<Geometry>;
  120090. private _getGeometryByUniqueID;
  120091. /**
  120092. * Add a new geometry to this scene
  120093. * @param geometry defines the geometry to be added to the scene.
  120094. * @param force defines if the geometry must be pushed even if a geometry with this id already exists
  120095. * @return a boolean defining if the geometry was added or not
  120096. */
  120097. pushGeometry(geometry: Geometry, force?: boolean): boolean;
  120098. /**
  120099. * Removes an existing geometry
  120100. * @param geometry defines the geometry to be removed from the scene
  120101. * @return a boolean defining if the geometry was removed or not
  120102. */
  120103. removeGeometry(geometry: Geometry): boolean;
  120104. /**
  120105. * Gets the list of geometries attached to the scene
  120106. * @returns an array of Geometry
  120107. */
  120108. getGeometries(): Geometry[];
  120109. /**
  120110. * Gets the first added mesh found of a given ID
  120111. * @param id defines the id to search for
  120112. * @return the mesh found or null if not found at all
  120113. */
  120114. getMeshByID(id: string): Nullable<AbstractMesh>;
  120115. /**
  120116. * Gets a list of meshes using their id
  120117. * @param id defines the id to search for
  120118. * @returns a list of meshes
  120119. */
  120120. getMeshesByID(id: string): Array<AbstractMesh>;
  120121. /**
  120122. * Gets the first added transform node found of a given ID
  120123. * @param id defines the id to search for
  120124. * @return the found transform node or null if not found at all.
  120125. */
  120126. getTransformNodeByID(id: string): Nullable<TransformNode>;
  120127. /**
  120128. * Gets a transform node with its auto-generated unique id
  120129. * @param uniqueId efines the unique id to search for
  120130. * @return the found transform node or null if not found at all.
  120131. */
  120132. getTransformNodeByUniqueID(uniqueId: number): Nullable<TransformNode>;
  120133. /**
  120134. * Gets a list of transform nodes using their id
  120135. * @param id defines the id to search for
  120136. * @returns a list of transform nodes
  120137. */
  120138. getTransformNodesByID(id: string): Array<TransformNode>;
  120139. /**
  120140. * Gets a mesh with its auto-generated unique id
  120141. * @param uniqueId defines the unique id to search for
  120142. * @return the found mesh or null if not found at all.
  120143. */
  120144. getMeshByUniqueID(uniqueId: number): Nullable<AbstractMesh>;
  120145. /**
  120146. * Gets a the last added mesh using a given id
  120147. * @param id defines the id to search for
  120148. * @return the found mesh or null if not found at all.
  120149. */
  120150. getLastMeshByID(id: string): Nullable<AbstractMesh>;
  120151. /**
  120152. * Gets a the last added node (Mesh, Camera, Light) using a given id
  120153. * @param id defines the id to search for
  120154. * @return the found node or null if not found at all
  120155. */
  120156. getLastEntryByID(id: string): Nullable<Node>;
  120157. /**
  120158. * Gets a node (Mesh, Camera, Light) using a given id
  120159. * @param id defines the id to search for
  120160. * @return the found node or null if not found at all
  120161. */
  120162. getNodeByID(id: string): Nullable<Node>;
  120163. /**
  120164. * Gets a node (Mesh, Camera, Light) using a given name
  120165. * @param name defines the name to search for
  120166. * @return the found node or null if not found at all.
  120167. */
  120168. getNodeByName(name: string): Nullable<Node>;
  120169. /**
  120170. * Gets a mesh using a given name
  120171. * @param name defines the name to search for
  120172. * @return the found mesh or null if not found at all.
  120173. */
  120174. getMeshByName(name: string): Nullable<AbstractMesh>;
  120175. /**
  120176. * Gets a transform node using a given name
  120177. * @param name defines the name to search for
  120178. * @return the found transform node or null if not found at all.
  120179. */
  120180. getTransformNodeByName(name: string): Nullable<TransformNode>;
  120181. /**
  120182. * Gets a skeleton using a given id (if many are found, this function will pick the last one)
  120183. * @param id defines the id to search for
  120184. * @return the found skeleton or null if not found at all.
  120185. */
  120186. getLastSkeletonByID(id: string): Nullable<Skeleton>;
  120187. /**
  120188. * Gets a skeleton using a given auto generated unique id
  120189. * @param uniqueId defines the unique id to search for
  120190. * @return the found skeleton or null if not found at all.
  120191. */
  120192. getSkeletonByUniqueId(uniqueId: number): Nullable<Skeleton>;
  120193. /**
  120194. * Gets a skeleton using a given id (if many are found, this function will pick the first one)
  120195. * @param id defines the id to search for
  120196. * @return the found skeleton or null if not found at all.
  120197. */
  120198. getSkeletonById(id: string): Nullable<Skeleton>;
  120199. /**
  120200. * Gets a skeleton using a given name
  120201. * @param name defines the name to search for
  120202. * @return the found skeleton or null if not found at all.
  120203. */
  120204. getSkeletonByName(name: string): Nullable<Skeleton>;
  120205. /**
  120206. * Gets a morph target manager using a given id (if many are found, this function will pick the last one)
  120207. * @param id defines the id to search for
  120208. * @return the found morph target manager or null if not found at all.
  120209. */
  120210. getMorphTargetManagerById(id: number): Nullable<MorphTargetManager>;
  120211. /**
  120212. * Gets a morph target using a given id (if many are found, this function will pick the first one)
  120213. * @param id defines the id to search for
  120214. * @return the found morph target or null if not found at all.
  120215. */
  120216. getMorphTargetById(id: string): Nullable<MorphTarget>;
  120217. /**
  120218. * Gets a morph target using a given name (if many are found, this function will pick the first one)
  120219. * @param name defines the name to search for
  120220. * @return the found morph target or null if not found at all.
  120221. */
  120222. getMorphTargetByName(name: string): Nullable<MorphTarget>;
  120223. /**
  120224. * Gets a post process using a given name (if many are found, this function will pick the first one)
  120225. * @param name defines the name to search for
  120226. * @return the found post process or null if not found at all.
  120227. */
  120228. getPostProcessByName(name: string): Nullable<PostProcess>;
  120229. /**
  120230. * Gets a boolean indicating if the given mesh is active
  120231. * @param mesh defines the mesh to look for
  120232. * @returns true if the mesh is in the active list
  120233. */
  120234. isActiveMesh(mesh: AbstractMesh): boolean;
  120235. /**
  120236. * Return a unique id as a string which can serve as an identifier for the scene
  120237. */
  120238. get uid(): string;
  120239. /**
  120240. * Add an externaly attached data from its key.
  120241. * This method call will fail and return false, if such key already exists.
  120242. * If you don't care and just want to get the data no matter what, use the more convenient getOrAddExternalDataWithFactory() method.
  120243. * @param key the unique key that identifies the data
  120244. * @param data the data object to associate to the key for this Engine instance
  120245. * @return true if no such key were already present and the data was added successfully, false otherwise
  120246. */
  120247. addExternalData<T>(key: string, data: T): boolean;
  120248. /**
  120249. * Get an externaly attached data from its key
  120250. * @param key the unique key that identifies the data
  120251. * @return the associated data, if present (can be null), or undefined if not present
  120252. */
  120253. getExternalData<T>(key: string): Nullable<T>;
  120254. /**
  120255. * Get an externaly attached data from its key, create it using a factory if it's not already present
  120256. * @param key the unique key that identifies the data
  120257. * @param factory the factory that will be called to create the instance if and only if it doesn't exists
  120258. * @return the associated data, can be null if the factory returned null.
  120259. */
  120260. getOrAddExternalDataWithFactory<T>(key: string, factory: (k: string) => T): T;
  120261. /**
  120262. * Remove an externaly attached data from the Engine instance
  120263. * @param key the unique key that identifies the data
  120264. * @return true if the data was successfully removed, false if it doesn't exist
  120265. */
  120266. removeExternalData(key: string): boolean;
  120267. private _evaluateSubMesh;
  120268. /**
  120269. * Clear the processed materials smart array preventing retention point in material dispose.
  120270. */
  120271. freeProcessedMaterials(): void;
  120272. private _preventFreeActiveMeshesAndRenderingGroups;
  120273. /** Gets or sets a boolean blocking all the calls to freeActiveMeshes and freeRenderingGroups
  120274. * It can be used in order to prevent going through methods freeRenderingGroups and freeActiveMeshes several times to improve performance
  120275. * when disposing several meshes in a row or a hierarchy of meshes.
  120276. * When used, it is the responsability of the user to blockfreeActiveMeshesAndRenderingGroups back to false.
  120277. */
  120278. get blockfreeActiveMeshesAndRenderingGroups(): boolean;
  120279. set blockfreeActiveMeshesAndRenderingGroups(value: boolean);
  120280. /**
  120281. * Clear the active meshes smart array preventing retention point in mesh dispose.
  120282. */
  120283. freeActiveMeshes(): void;
  120284. /**
  120285. * Clear the info related to rendering groups preventing retention points during dispose.
  120286. */
  120287. freeRenderingGroups(): void;
  120288. /** @hidden */
  120289. _isInIntermediateRendering(): boolean;
  120290. /**
  120291. * Lambda returning the list of potentially active meshes.
  120292. */
  120293. getActiveMeshCandidates: () => ISmartArrayLike<AbstractMesh>;
  120294. /**
  120295. * Lambda returning the list of potentially active sub meshes.
  120296. */
  120297. getActiveSubMeshCandidates: (mesh: AbstractMesh) => ISmartArrayLike<SubMesh>;
  120298. /**
  120299. * Lambda returning the list of potentially intersecting sub meshes.
  120300. */
  120301. getIntersectingSubMeshCandidates: (mesh: AbstractMesh, localRay: Ray) => ISmartArrayLike<SubMesh>;
  120302. /**
  120303. * Lambda returning the list of potentially colliding sub meshes.
  120304. */
  120305. getCollidingSubMeshCandidates: (mesh: AbstractMesh, collider: Collider) => ISmartArrayLike<SubMesh>;
  120306. private _activeMeshesFrozen;
  120307. private _skipEvaluateActiveMeshesCompletely;
  120308. /**
  120309. * Use this function to stop evaluating active meshes. The current list will be keep alive between frames
  120310. * @param skipEvaluateActiveMeshes defines an optional boolean indicating that the evaluate active meshes step must be completely skipped
  120311. * @returns the current scene
  120312. */
  120313. freezeActiveMeshes(skipEvaluateActiveMeshes?: boolean): Scene;
  120314. /**
  120315. * Use this function to restart evaluating active meshes on every frame
  120316. * @returns the current scene
  120317. */
  120318. unfreezeActiveMeshes(): Scene;
  120319. private _evaluateActiveMeshes;
  120320. private _activeMesh;
  120321. /**
  120322. * Update the transform matrix to update from the current active camera
  120323. * @param force defines a boolean used to force the update even if cache is up to date
  120324. */
  120325. updateTransformMatrix(force?: boolean): void;
  120326. private _bindFrameBuffer;
  120327. /** @hidden */
  120328. _allowPostProcessClearColor: boolean;
  120329. /** @hidden */
  120330. _renderForCamera(camera: Camera, rigParent?: Camera): void;
  120331. private _processSubCameras;
  120332. private _checkIntersections;
  120333. /** @hidden */
  120334. _advancePhysicsEngineStep(step: number): void;
  120335. /**
  120336. * User updatable function that will return a deterministic frame time when engine is in deterministic lock step mode
  120337. */
  120338. getDeterministicFrameTime: () => number;
  120339. /** @hidden */
  120340. _animate(): void;
  120341. /** Execute all animations (for a frame) */
  120342. animate(): void;
  120343. /**
  120344. * Render the scene
  120345. * @param updateCameras defines a boolean indicating if cameras must update according to their inputs (true by default)
  120346. * @param ignoreAnimations defines a boolean indicating if animations should not be executed (false by default)
  120347. */
  120348. render(updateCameras?: boolean, ignoreAnimations?: boolean): void;
  120349. /**
  120350. * Freeze all materials
  120351. * A frozen material will not be updatable but should be faster to render
  120352. */
  120353. freezeMaterials(): void;
  120354. /**
  120355. * Unfreeze all materials
  120356. * A frozen material will not be updatable but should be faster to render
  120357. */
  120358. unfreezeMaterials(): void;
  120359. /**
  120360. * Releases all held ressources
  120361. */
  120362. dispose(): void;
  120363. /**
  120364. * Gets if the scene is already disposed
  120365. */
  120366. get isDisposed(): boolean;
  120367. /**
  120368. * Call this function to reduce memory footprint of the scene.
  120369. * Vertex buffers will not store CPU data anymore (this will prevent picking, collisions or physics to work correctly)
  120370. */
  120371. clearCachedVertexData(): void;
  120372. /**
  120373. * This function will remove the local cached buffer data from texture.
  120374. * It will save memory but will prevent the texture from being rebuilt
  120375. */
  120376. cleanCachedTextureBuffer(): void;
  120377. /**
  120378. * Get the world extend vectors with an optional filter
  120379. *
  120380. * @param filterPredicate the predicate - which meshes should be included when calculating the world size
  120381. * @returns {{ min: Vector3; max: Vector3 }} min and max vectors
  120382. */
  120383. getWorldExtends(filterPredicate?: (mesh: AbstractMesh) => boolean): {
  120384. min: Vector3;
  120385. max: Vector3;
  120386. };
  120387. /**
  120388. * Creates a ray that can be used to pick in the scene
  120389. * @param x defines the x coordinate of the origin (on-screen)
  120390. * @param y defines the y coordinate of the origin (on-screen)
  120391. * @param world defines the world matrix to use if you want to pick in object space (instead of world space)
  120392. * @param camera defines the camera to use for the picking
  120393. * @param cameraViewSpace defines if picking will be done in view space (false by default)
  120394. * @returns a Ray
  120395. */
  120396. createPickingRay(x: number, y: number, world: Matrix, camera: Nullable<Camera>, cameraViewSpace?: boolean): Ray;
  120397. /**
  120398. * Creates a ray that can be used to pick in the scene
  120399. * @param x defines the x coordinate of the origin (on-screen)
  120400. * @param y defines the y coordinate of the origin (on-screen)
  120401. * @param world defines the world matrix to use if you want to pick in object space (instead of world space)
  120402. * @param result defines the ray where to store the picking ray
  120403. * @param camera defines the camera to use for the picking
  120404. * @param cameraViewSpace defines if picking will be done in view space (false by default)
  120405. * @returns the current scene
  120406. */
  120407. createPickingRayToRef(x: number, y: number, world: Matrix, result: Ray, camera: Nullable<Camera>, cameraViewSpace?: boolean): Scene;
  120408. /**
  120409. * Creates a ray that can be used to pick in the scene
  120410. * @param x defines the x coordinate of the origin (on-screen)
  120411. * @param y defines the y coordinate of the origin (on-screen)
  120412. * @param camera defines the camera to use for the picking
  120413. * @returns a Ray
  120414. */
  120415. createPickingRayInCameraSpace(x: number, y: number, camera?: Camera): Ray;
  120416. /**
  120417. * Creates a ray that can be used to pick in the scene
  120418. * @param x defines the x coordinate of the origin (on-screen)
  120419. * @param y defines the y coordinate of the origin (on-screen)
  120420. * @param result defines the ray where to store the picking ray
  120421. * @param camera defines the camera to use for the picking
  120422. * @returns the current scene
  120423. */
  120424. createPickingRayInCameraSpaceToRef(x: number, y: number, result: Ray, camera?: Camera): Scene;
  120425. /** Launch a ray to try to pick a mesh in the scene
  120426. * @param x position on screen
  120427. * @param y position on screen
  120428. * @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
  120429. * @param fastCheck defines if the first intersection will be used (and not the closest)
  120430. * @param camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  120431. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  120432. * @returns a PickingInfo
  120433. */
  120434. pick(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, camera?: Nullable<Camera>, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  120435. /** Launch a ray to try to pick a mesh in the scene using only bounding information of the main mesh (not using submeshes)
  120436. * @param x position on screen
  120437. * @param y position on screen
  120438. * @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
  120439. * @param fastCheck defines if the first intersection will be used (and not the closest)
  120440. * @param camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  120441. * @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)
  120442. */
  120443. pickWithBoundingInfo(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, camera?: Nullable<Camera>): Nullable<PickingInfo>;
  120444. /** Use the given ray to pick a mesh in the scene
  120445. * @param ray The ray to use to pick meshes
  120446. * @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
  120447. * @param fastCheck defines if the first intersection will be used (and not the closest)
  120448. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  120449. * @returns a PickingInfo
  120450. */
  120451. pickWithRay(ray: Ray, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  120452. /**
  120453. * Launch a ray to try to pick a mesh in the scene
  120454. * @param x X position on screen
  120455. * @param y Y position on screen
  120456. * @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
  120457. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  120458. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  120459. * @returns an array of PickingInfo
  120460. */
  120461. multiPick(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, camera?: Camera, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  120462. /**
  120463. * Launch a ray to try to pick a mesh in the scene
  120464. * @param ray Ray to use
  120465. * @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
  120466. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  120467. * @returns an array of PickingInfo
  120468. */
  120469. multiPickWithRay(ray: Ray, predicate: (mesh: AbstractMesh) => boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  120470. /**
  120471. * Force the value of meshUnderPointer
  120472. * @param mesh defines the mesh to use
  120473. */
  120474. setPointerOverMesh(mesh: Nullable<AbstractMesh>): void;
  120475. /**
  120476. * Gets the mesh under the pointer
  120477. * @returns a Mesh or null if no mesh is under the pointer
  120478. */
  120479. getPointerOverMesh(): Nullable<AbstractMesh>;
  120480. /** @hidden */
  120481. _rebuildGeometries(): void;
  120482. /** @hidden */
  120483. _rebuildTextures(): void;
  120484. private _getByTags;
  120485. /**
  120486. * Get a list of meshes by tags
  120487. * @param tagsQuery defines the tags query to use
  120488. * @param forEach defines a predicate used to filter results
  120489. * @returns an array of Mesh
  120490. */
  120491. getMeshesByTags(tagsQuery: string, forEach?: (mesh: AbstractMesh) => void): Mesh[];
  120492. /**
  120493. * Get a list of cameras by tags
  120494. * @param tagsQuery defines the tags query to use
  120495. * @param forEach defines a predicate used to filter results
  120496. * @returns an array of Camera
  120497. */
  120498. getCamerasByTags(tagsQuery: string, forEach?: (camera: Camera) => void): Camera[];
  120499. /**
  120500. * Get a list of lights by tags
  120501. * @param tagsQuery defines the tags query to use
  120502. * @param forEach defines a predicate used to filter results
  120503. * @returns an array of Light
  120504. */
  120505. getLightsByTags(tagsQuery: string, forEach?: (light: Light) => void): Light[];
  120506. /**
  120507. * Get a list of materials by tags
  120508. * @param tagsQuery defines the tags query to use
  120509. * @param forEach defines a predicate used to filter results
  120510. * @returns an array of Material
  120511. */
  120512. getMaterialByTags(tagsQuery: string, forEach?: (material: Material) => void): Material[];
  120513. /**
  120514. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  120515. * This allowed control for front to back rendering or reversly depending of the special needs.
  120516. *
  120517. * @param renderingGroupId The rendering group id corresponding to its index
  120518. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  120519. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  120520. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  120521. */
  120522. 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;
  120523. /**
  120524. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  120525. *
  120526. * @param renderingGroupId The rendering group id corresponding to its index
  120527. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  120528. * @param depth Automatically clears depth between groups if true and autoClear is true.
  120529. * @param stencil Automatically clears stencil between groups if true and autoClear is true.
  120530. */
  120531. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean, depth?: boolean, stencil?: boolean): void;
  120532. /**
  120533. * Gets the current auto clear configuration for one rendering group of the rendering
  120534. * manager.
  120535. * @param index the rendering group index to get the information for
  120536. * @returns The auto clear setup for the requested rendering group
  120537. */
  120538. getAutoClearDepthStencilSetup(index: number): IRenderingManagerAutoClearSetup;
  120539. private _blockMaterialDirtyMechanism;
  120540. /** Gets or sets a boolean blocking all the calls to markAllMaterialsAsDirty (ie. the materials won't be updated if they are out of sync) */
  120541. get blockMaterialDirtyMechanism(): boolean;
  120542. set blockMaterialDirtyMechanism(value: boolean);
  120543. /**
  120544. * Will flag all materials as dirty to trigger new shader compilation
  120545. * @param flag defines the flag used to specify which material part must be marked as dirty
  120546. * @param predicate If not null, it will be used to specifiy if a material has to be marked as dirty
  120547. */
  120548. markAllMaterialsAsDirty(flag: number, predicate?: (mat: Material) => boolean): void;
  120549. /** @hidden */
  120550. _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;
  120551. /** @hidden */
  120552. _loadFileAsync(url: string, onProgress?: (data: any) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  120553. /** @hidden */
  120554. _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;
  120555. /** @hidden */
  120556. _requestFileAsync(url: string, onProgress?: (ev: ProgressEvent) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean, onOpened?: (request: WebRequest) => void): Promise<string | ArrayBuffer>;
  120557. /** @hidden */
  120558. _readFile(file: File, onSuccess: (data: string | ArrayBuffer) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  120559. /** @hidden */
  120560. _readFileAsync(file: File, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  120561. }
  120562. }
  120563. declare module BABYLON {
  120564. /**
  120565. * Set of assets to keep when moving a scene into an asset container.
  120566. */
  120567. export class KeepAssets extends AbstractScene {
  120568. }
  120569. /**
  120570. * Class used to store the output of the AssetContainer.instantiateAllMeshesToScene function
  120571. */
  120572. export class InstantiatedEntries {
  120573. /**
  120574. * List of new root nodes (eg. nodes with no parent)
  120575. */
  120576. rootNodes: TransformNode[];
  120577. /**
  120578. * List of new skeletons
  120579. */
  120580. skeletons: Skeleton[];
  120581. /**
  120582. * List of new animation groups
  120583. */
  120584. animationGroups: AnimationGroup[];
  120585. }
  120586. /**
  120587. * Container with a set of assets that can be added or removed from a scene.
  120588. */
  120589. export class AssetContainer extends AbstractScene {
  120590. private _wasAddedToScene;
  120591. /**
  120592. * The scene the AssetContainer belongs to.
  120593. */
  120594. scene: Scene;
  120595. /**
  120596. * Instantiates an AssetContainer.
  120597. * @param scene The scene the AssetContainer belongs to.
  120598. */
  120599. constructor(scene: Scene);
  120600. /**
  120601. * Instantiate or clone all meshes and add the new ones to the scene.
  120602. * Skeletons and animation groups will all be cloned
  120603. * @param nameFunction defines an optional function used to get new names for clones
  120604. * @param cloneMaterials defines an optional boolean that defines if materials must be cloned as well (false by default)
  120605. * @returns a list of rootNodes, skeletons and aniamtion groups that were duplicated
  120606. */
  120607. instantiateModelsToScene(nameFunction?: (sourceName: string) => string, cloneMaterials?: boolean): InstantiatedEntries;
  120608. /**
  120609. * Adds all the assets from the container to the scene.
  120610. */
  120611. addAllToScene(): void;
  120612. /**
  120613. * Removes all the assets in the container from the scene
  120614. */
  120615. removeAllFromScene(): void;
  120616. /**
  120617. * Disposes all the assets in the container
  120618. */
  120619. dispose(): void;
  120620. private _moveAssets;
  120621. /**
  120622. * Removes all the assets contained in the scene and adds them to the container.
  120623. * @param keepAssets Set of assets to keep in the scene. (default: empty)
  120624. */
  120625. moveAllFromScene(keepAssets?: KeepAssets): void;
  120626. /**
  120627. * 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.
  120628. * @returns the root mesh
  120629. */
  120630. createRootMesh(): Mesh;
  120631. /**
  120632. * Merge animations (direct and animation groups) from this asset container into a scene
  120633. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  120634. * @param animatables set of animatables to retarget to a node from the scene
  120635. * @param targetConverter defines a function used to convert animation targets from the asset container to the scene (default: search node by name)
  120636. * @returns an array of the new AnimationGroup added to the scene (empty array if none)
  120637. */
  120638. mergeAnimationsTo(scene: Scene | null | undefined, animatables: Animatable[], targetConverter?: Nullable<(target: any) => Nullable<Node>>): AnimationGroup[];
  120639. }
  120640. }
  120641. declare module BABYLON {
  120642. /**
  120643. * Defines how the parser contract is defined.
  120644. * These parsers are used to parse a list of specific assets (like particle systems, etc..)
  120645. */
  120646. export type BabylonFileParser = (parsedData: any, scene: Scene, container: AssetContainer, rootUrl: string) => void;
  120647. /**
  120648. * Defines how the individual parser contract is defined.
  120649. * These parser can parse an individual asset
  120650. */
  120651. export type IndividualBabylonFileParser = (parsedData: any, scene: Scene, rootUrl: string) => any;
  120652. /**
  120653. * Base class of the scene acting as a container for the different elements composing a scene.
  120654. * This class is dynamically extended by the different components of the scene increasing
  120655. * flexibility and reducing coupling
  120656. */
  120657. export abstract class AbstractScene {
  120658. /**
  120659. * Stores the list of available parsers in the application.
  120660. */
  120661. private static _BabylonFileParsers;
  120662. /**
  120663. * Stores the list of available individual parsers in the application.
  120664. */
  120665. private static _IndividualBabylonFileParsers;
  120666. /**
  120667. * Adds a parser in the list of available ones
  120668. * @param name Defines the name of the parser
  120669. * @param parser Defines the parser to add
  120670. */
  120671. static AddParser(name: string, parser: BabylonFileParser): void;
  120672. /**
  120673. * Gets a general parser from the list of avaialble ones
  120674. * @param name Defines the name of the parser
  120675. * @returns the requested parser or null
  120676. */
  120677. static GetParser(name: string): Nullable<BabylonFileParser>;
  120678. /**
  120679. * Adds n individual parser in the list of available ones
  120680. * @param name Defines the name of the parser
  120681. * @param parser Defines the parser to add
  120682. */
  120683. static AddIndividualParser(name: string, parser: IndividualBabylonFileParser): void;
  120684. /**
  120685. * Gets an individual parser from the list of avaialble ones
  120686. * @param name Defines the name of the parser
  120687. * @returns the requested parser or null
  120688. */
  120689. static GetIndividualParser(name: string): Nullable<IndividualBabylonFileParser>;
  120690. /**
  120691. * Parser json data and populate both a scene and its associated container object
  120692. * @param jsonData Defines the data to parse
  120693. * @param scene Defines the scene to parse the data for
  120694. * @param container Defines the container attached to the parsing sequence
  120695. * @param rootUrl Defines the root url of the data
  120696. */
  120697. static Parse(jsonData: any, scene: Scene, container: AssetContainer, rootUrl: string): void;
  120698. /**
  120699. * Gets the list of root nodes (ie. nodes with no parent)
  120700. */
  120701. rootNodes: Node[];
  120702. /** All of the cameras added to this scene
  120703. * @see https://doc.babylonjs.com/babylon101/cameras
  120704. */
  120705. cameras: Camera[];
  120706. /**
  120707. * All of the lights added to this scene
  120708. * @see https://doc.babylonjs.com/babylon101/lights
  120709. */
  120710. lights: Light[];
  120711. /**
  120712. * All of the (abstract) meshes added to this scene
  120713. */
  120714. meshes: AbstractMesh[];
  120715. /**
  120716. * The list of skeletons added to the scene
  120717. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  120718. */
  120719. skeletons: Skeleton[];
  120720. /**
  120721. * All of the particle systems added to this scene
  120722. * @see https://doc.babylonjs.com/babylon101/particles
  120723. */
  120724. particleSystems: IParticleSystem[];
  120725. /**
  120726. * Gets a list of Animations associated with the scene
  120727. */
  120728. animations: Animation[];
  120729. /**
  120730. * All of the animation groups added to this scene
  120731. * @see https://doc.babylonjs.com/how_to/group
  120732. */
  120733. animationGroups: AnimationGroup[];
  120734. /**
  120735. * All of the multi-materials added to this scene
  120736. * @see https://doc.babylonjs.com/how_to/multi_materials
  120737. */
  120738. multiMaterials: MultiMaterial[];
  120739. /**
  120740. * All of the materials added to this scene
  120741. * In the context of a Scene, it is not supposed to be modified manually.
  120742. * Any addition or removal should be done using the addMaterial and removeMaterial Scene methods.
  120743. * Note also that the order of the Material within the array is not significant and might change.
  120744. * @see https://doc.babylonjs.com/babylon101/materials
  120745. */
  120746. materials: Material[];
  120747. /**
  120748. * The list of morph target managers added to the scene
  120749. * @see https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh
  120750. */
  120751. morphTargetManagers: MorphTargetManager[];
  120752. /**
  120753. * The list of geometries used in the scene.
  120754. */
  120755. geometries: Geometry[];
  120756. /**
  120757. * All of the tranform nodes added to this scene
  120758. * In the context of a Scene, it is not supposed to be modified manually.
  120759. * Any addition or removal should be done using the addTransformNode and removeTransformNode Scene methods.
  120760. * Note also that the order of the TransformNode wihin the array is not significant and might change.
  120761. * @see https://doc.babylonjs.com/how_to/transformnode
  120762. */
  120763. transformNodes: TransformNode[];
  120764. /**
  120765. * ActionManagers available on the scene.
  120766. */
  120767. actionManagers: AbstractActionManager[];
  120768. /**
  120769. * Textures to keep.
  120770. */
  120771. textures: BaseTexture[];
  120772. /**
  120773. * Environment texture for the scene
  120774. */
  120775. environmentTexture: Nullable<BaseTexture>;
  120776. /**
  120777. * The list of postprocesses added to the scene
  120778. */
  120779. postProcesses: PostProcess[];
  120780. /**
  120781. * @returns all meshes, lights, cameras, transformNodes and bones
  120782. */
  120783. getNodes(): Array<Node>;
  120784. }
  120785. }
  120786. declare module BABYLON {
  120787. /**
  120788. * Interface used to define options for Sound class
  120789. */
  120790. export interface ISoundOptions {
  120791. /**
  120792. * Does the sound autoplay once loaded.
  120793. */
  120794. autoplay?: boolean;
  120795. /**
  120796. * Does the sound loop after it finishes playing once.
  120797. */
  120798. loop?: boolean;
  120799. /**
  120800. * Sound's volume
  120801. */
  120802. volume?: number;
  120803. /**
  120804. * Is it a spatial sound?
  120805. */
  120806. spatialSound?: boolean;
  120807. /**
  120808. * Maximum distance to hear that sound
  120809. */
  120810. maxDistance?: number;
  120811. /**
  120812. * Uses user defined attenuation function
  120813. */
  120814. useCustomAttenuation?: boolean;
  120815. /**
  120816. * Define the roll off factor of spatial sounds.
  120817. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  120818. */
  120819. rolloffFactor?: number;
  120820. /**
  120821. * Define the reference distance the sound should be heard perfectly.
  120822. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  120823. */
  120824. refDistance?: number;
  120825. /**
  120826. * Define the distance attenuation model the sound will follow.
  120827. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  120828. */
  120829. distanceModel?: string;
  120830. /**
  120831. * Defines the playback speed (1 by default)
  120832. */
  120833. playbackRate?: number;
  120834. /**
  120835. * Defines if the sound is from a streaming source
  120836. */
  120837. streaming?: boolean;
  120838. /**
  120839. * Defines an optional length (in seconds) inside the sound file
  120840. */
  120841. length?: number;
  120842. /**
  120843. * Defines an optional offset (in seconds) inside the sound file
  120844. */
  120845. offset?: number;
  120846. /**
  120847. * If true, URLs will not be required to state the audio file codec to use.
  120848. */
  120849. skipCodecCheck?: boolean;
  120850. }
  120851. /**
  120852. * Defines a sound that can be played in the application.
  120853. * The sound can either be an ambient track or a simple sound played in reaction to a user action.
  120854. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  120855. */
  120856. export class Sound {
  120857. /**
  120858. * The name of the sound in the scene.
  120859. */
  120860. name: string;
  120861. /**
  120862. * Does the sound autoplay once loaded.
  120863. */
  120864. autoplay: boolean;
  120865. /**
  120866. * Does the sound loop after it finishes playing once.
  120867. */
  120868. loop: boolean;
  120869. /**
  120870. * Does the sound use a custom attenuation curve to simulate the falloff
  120871. * happening when the source gets further away from the camera.
  120872. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-your-own-custom-attenuation-function
  120873. */
  120874. useCustomAttenuation: boolean;
  120875. /**
  120876. * The sound track id this sound belongs to.
  120877. */
  120878. soundTrackId: number;
  120879. /**
  120880. * Is this sound currently played.
  120881. */
  120882. isPlaying: boolean;
  120883. /**
  120884. * Is this sound currently paused.
  120885. */
  120886. isPaused: boolean;
  120887. /**
  120888. * Does this sound enables spatial sound.
  120889. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  120890. */
  120891. spatialSound: boolean;
  120892. /**
  120893. * Define the reference distance the sound should be heard perfectly.
  120894. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  120895. */
  120896. refDistance: number;
  120897. /**
  120898. * Define the roll off factor of spatial sounds.
  120899. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  120900. */
  120901. rolloffFactor: number;
  120902. /**
  120903. * Define the max distance the sound should be heard (intensity just became 0 at this point).
  120904. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  120905. */
  120906. maxDistance: number;
  120907. /**
  120908. * Define the distance attenuation model the sound will follow.
  120909. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  120910. */
  120911. distanceModel: string;
  120912. /**
  120913. * @hidden
  120914. * Back Compat
  120915. **/
  120916. onended: () => any;
  120917. /**
  120918. * Gets or sets an object used to store user defined information for the sound.
  120919. */
  120920. metadata: any;
  120921. /**
  120922. * Observable event when the current playing sound finishes.
  120923. */
  120924. onEndedObservable: Observable<Sound>;
  120925. private _panningModel;
  120926. private _playbackRate;
  120927. private _streaming;
  120928. private _startTime;
  120929. private _startOffset;
  120930. private _position;
  120931. /** @hidden */
  120932. _positionInEmitterSpace: boolean;
  120933. private _localDirection;
  120934. private _volume;
  120935. private _isReadyToPlay;
  120936. private _isDirectional;
  120937. private _readyToPlayCallback;
  120938. private _audioBuffer;
  120939. private _soundSource;
  120940. private _streamingSource;
  120941. private _soundPanner;
  120942. private _soundGain;
  120943. private _inputAudioNode;
  120944. private _outputAudioNode;
  120945. private _coneInnerAngle;
  120946. private _coneOuterAngle;
  120947. private _coneOuterGain;
  120948. private _scene;
  120949. private _connectedTransformNode;
  120950. private _customAttenuationFunction;
  120951. private _registerFunc;
  120952. private _isOutputConnected;
  120953. private _htmlAudioElement;
  120954. private _urlType;
  120955. private _length?;
  120956. private _offset?;
  120957. /** @hidden */
  120958. static _SceneComponentInitialization: (scene: Scene) => void;
  120959. /**
  120960. * Create a sound and attach it to a scene
  120961. * @param name Name of your sound
  120962. * @param urlOrArrayBuffer Url to the sound to load async or ArrayBuffer, it also works with MediaStreams
  120963. * @param scene defines the scene the sound belongs to
  120964. * @param readyToPlayCallback Provide a callback function if you'd like to load your code once the sound is ready to be played
  120965. * @param options Objects to provide with the current available options: autoplay, loop, volume, spatialSound, maxDistance, rolloffFactor, refDistance, distanceModel, panningModel, streaming
  120966. */
  120967. constructor(name: string, urlOrArrayBuffer: any, scene: Scene, readyToPlayCallback?: Nullable<() => void>, options?: ISoundOptions);
  120968. /**
  120969. * Release the sound and its associated resources
  120970. */
  120971. dispose(): void;
  120972. /**
  120973. * Gets if the sounds is ready to be played or not.
  120974. * @returns true if ready, otherwise false
  120975. */
  120976. isReady(): boolean;
  120977. private _soundLoaded;
  120978. /**
  120979. * Sets the data of the sound from an audiobuffer
  120980. * @param audioBuffer The audioBuffer containing the data
  120981. */
  120982. setAudioBuffer(audioBuffer: AudioBuffer): void;
  120983. /**
  120984. * Updates the current sounds options such as maxdistance, loop...
  120985. * @param options A JSON object containing values named as the object properties
  120986. */
  120987. updateOptions(options: ISoundOptions): void;
  120988. private _createSpatialParameters;
  120989. private _updateSpatialParameters;
  120990. /**
  120991. * Switch the panning model to HRTF:
  120992. * Renders a stereo output of higher quality than equalpower — it uses a convolution with measured impulse responses from human subjects.
  120993. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  120994. */
  120995. switchPanningModelToHRTF(): void;
  120996. /**
  120997. * Switch the panning model to Equal Power:
  120998. * Represents the equal-power panning algorithm, generally regarded as simple and efficient. equalpower is the default value.
  120999. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121000. */
  121001. switchPanningModelToEqualPower(): void;
  121002. private _switchPanningModel;
  121003. /**
  121004. * Connect this sound to a sound track audio node like gain...
  121005. * @param soundTrackAudioNode the sound track audio node to connect to
  121006. */
  121007. connectToSoundTrackAudioNode(soundTrackAudioNode: AudioNode): void;
  121008. /**
  121009. * Transform this sound into a directional source
  121010. * @param coneInnerAngle Size of the inner cone in degree
  121011. * @param coneOuterAngle Size of the outer cone in degree
  121012. * @param coneOuterGain Volume of the sound outside the outer cone (between 0.0 and 1.0)
  121013. */
  121014. setDirectionalCone(coneInnerAngle: number, coneOuterAngle: number, coneOuterGain: number): void;
  121015. /**
  121016. * Gets or sets the inner angle for the directional cone.
  121017. */
  121018. get directionalConeInnerAngle(): number;
  121019. /**
  121020. * Gets or sets the inner angle for the directional cone.
  121021. */
  121022. set directionalConeInnerAngle(value: number);
  121023. /**
  121024. * Gets or sets the outer angle for the directional cone.
  121025. */
  121026. get directionalConeOuterAngle(): number;
  121027. /**
  121028. * Gets or sets the outer angle for the directional cone.
  121029. */
  121030. set directionalConeOuterAngle(value: number);
  121031. /**
  121032. * Sets the position of the emitter if spatial sound is enabled
  121033. * @param newPosition Defines the new posisiton
  121034. */
  121035. setPosition(newPosition: Vector3): void;
  121036. /**
  121037. * Sets the local direction of the emitter if spatial sound is enabled
  121038. * @param newLocalDirection Defines the new local direction
  121039. */
  121040. setLocalDirectionToMesh(newLocalDirection: Vector3): void;
  121041. private _updateDirection;
  121042. /** @hidden */
  121043. updateDistanceFromListener(): void;
  121044. /**
  121045. * Sets a new custom attenuation function for the sound.
  121046. * @param callback Defines the function used for the attenuation
  121047. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-your-own-custom-attenuation-function
  121048. */
  121049. setAttenuationFunction(callback: (currentVolume: number, currentDistance: number, maxDistance: number, refDistance: number, rolloffFactor: number) => number): void;
  121050. /**
  121051. * Play the sound
  121052. * @param time (optional) Start the sound after X seconds. Start immediately (0) by default.
  121053. * @param offset (optional) Start the sound at a specific time in seconds
  121054. * @param length (optional) Sound duration (in seconds)
  121055. */
  121056. play(time?: number, offset?: number, length?: number): void;
  121057. private _onended;
  121058. /**
  121059. * Stop the sound
  121060. * @param time (optional) Stop the sound after X seconds. Stop immediately (0) by default.
  121061. */
  121062. stop(time?: number): void;
  121063. /**
  121064. * Put the sound in pause
  121065. */
  121066. pause(): void;
  121067. /**
  121068. * Sets a dedicated volume for this sounds
  121069. * @param newVolume Define the new volume of the sound
  121070. * @param time Define time for gradual change to new volume
  121071. */
  121072. setVolume(newVolume: number, time?: number): void;
  121073. /**
  121074. * Set the sound play back rate
  121075. * @param newPlaybackRate Define the playback rate the sound should be played at
  121076. */
  121077. setPlaybackRate(newPlaybackRate: number): void;
  121078. /**
  121079. * Gets the volume of the sound.
  121080. * @returns the volume of the sound
  121081. */
  121082. getVolume(): number;
  121083. /**
  121084. * Attach the sound to a dedicated mesh
  121085. * @param transformNode The transform node to connect the sound with
  121086. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#attaching-a-sound-to-a-mesh
  121087. */
  121088. attachToMesh(transformNode: TransformNode): void;
  121089. /**
  121090. * Detach the sound from the previously attached mesh
  121091. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#attaching-a-sound-to-a-mesh
  121092. */
  121093. detachFromMesh(): void;
  121094. private _onRegisterAfterWorldMatrixUpdate;
  121095. /**
  121096. * Clone the current sound in the scene.
  121097. * @returns the new sound clone
  121098. */
  121099. clone(): Nullable<Sound>;
  121100. /**
  121101. * Gets the current underlying audio buffer containing the data
  121102. * @returns the audio buffer
  121103. */
  121104. getAudioBuffer(): Nullable<AudioBuffer>;
  121105. /**
  121106. * Gets the WebAudio AudioBufferSourceNode, lets you keep track of and stop instances of this Sound.
  121107. * @returns the source node
  121108. */
  121109. getSoundSource(): Nullable<AudioBufferSourceNode>;
  121110. /**
  121111. * Gets the WebAudio GainNode, gives you precise control over the gain of instances of this Sound.
  121112. * @returns the gain node
  121113. */
  121114. getSoundGain(): Nullable<GainNode>;
  121115. /**
  121116. * Serializes the Sound in a JSON representation
  121117. * @returns the JSON representation of the sound
  121118. */
  121119. serialize(): any;
  121120. /**
  121121. * Parse a JSON representation of a sound to innstantiate in a given scene
  121122. * @param parsedSound Define the JSON representation of the sound (usually coming from the serialize method)
  121123. * @param scene Define the scene the new parsed sound should be created in
  121124. * @param rootUrl Define the rooturl of the load in case we need to fetch relative dependencies
  121125. * @param sourceSound Define a cound place holder if do not need to instantiate a new one
  121126. * @returns the newly parsed sound
  121127. */
  121128. static Parse(parsedSound: any, scene: Scene, rootUrl: string, sourceSound?: Sound): Sound;
  121129. }
  121130. }
  121131. declare module BABYLON {
  121132. /**
  121133. * This defines an action helpful to play a defined sound on a triggered action.
  121134. */
  121135. export class PlaySoundAction extends Action {
  121136. private _sound;
  121137. /**
  121138. * Instantiate the action
  121139. * @param triggerOptions defines the trigger options
  121140. * @param sound defines the sound to play
  121141. * @param condition defines the trigger related conditions
  121142. */
  121143. constructor(triggerOptions: any, sound: Sound, condition?: Condition);
  121144. /** @hidden */
  121145. _prepare(): void;
  121146. /**
  121147. * Execute the action and play the sound.
  121148. */
  121149. execute(): void;
  121150. /**
  121151. * Serializes the actions and its related information.
  121152. * @param parent defines the object to serialize in
  121153. * @returns the serialized object
  121154. */
  121155. serialize(parent: any): any;
  121156. }
  121157. /**
  121158. * This defines an action helpful to stop a defined sound on a triggered action.
  121159. */
  121160. export class StopSoundAction extends Action {
  121161. private _sound;
  121162. /**
  121163. * Instantiate the action
  121164. * @param triggerOptions defines the trigger options
  121165. * @param sound defines the sound to stop
  121166. * @param condition defines the trigger related conditions
  121167. */
  121168. constructor(triggerOptions: any, sound: Sound, condition?: Condition);
  121169. /** @hidden */
  121170. _prepare(): void;
  121171. /**
  121172. * Execute the action and stop the sound.
  121173. */
  121174. execute(): void;
  121175. /**
  121176. * Serializes the actions and its related information.
  121177. * @param parent defines the object to serialize in
  121178. * @returns the serialized object
  121179. */
  121180. serialize(parent: any): any;
  121181. }
  121182. }
  121183. declare module BABYLON {
  121184. /**
  121185. * This defines an action responsible to change the value of a property
  121186. * by interpolating between its current value and the newly set one once triggered.
  121187. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  121188. */
  121189. export class InterpolateValueAction extends Action {
  121190. /**
  121191. * Defines the path of the property where the value should be interpolated
  121192. */
  121193. propertyPath: string;
  121194. /**
  121195. * Defines the target value at the end of the interpolation.
  121196. */
  121197. value: any;
  121198. /**
  121199. * Defines the time it will take for the property to interpolate to the value.
  121200. */
  121201. duration: number;
  121202. /**
  121203. * Defines if the other scene animations should be stopped when the action has been triggered
  121204. */
  121205. stopOtherAnimations?: boolean;
  121206. /**
  121207. * Defines a callback raised once the interpolation animation has been done.
  121208. */
  121209. onInterpolationDone?: () => void;
  121210. /**
  121211. * Observable triggered once the interpolation animation has been done.
  121212. */
  121213. onInterpolationDoneObservable: Observable<InterpolateValueAction>;
  121214. private _target;
  121215. private _effectiveTarget;
  121216. private _property;
  121217. /**
  121218. * Instantiate the action
  121219. * @param triggerOptions defines the trigger options
  121220. * @param target defines the object containing the value to interpolate
  121221. * @param propertyPath defines the path to the property in the target object
  121222. * @param value defines the target value at the end of the interpolation
  121223. * @param duration deines the time it will take for the property to interpolate to the value.
  121224. * @param condition defines the trigger related conditions
  121225. * @param stopOtherAnimations defines if the other scene animations should be stopped when the action has been triggered
  121226. * @param onInterpolationDone defines a callback raised once the interpolation animation has been done
  121227. */
  121228. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, duration?: number, condition?: Condition, stopOtherAnimations?: boolean, onInterpolationDone?: () => void);
  121229. /** @hidden */
  121230. _prepare(): void;
  121231. /**
  121232. * Execute the action starts the value interpolation.
  121233. */
  121234. execute(): void;
  121235. /**
  121236. * Serializes the actions and its related information.
  121237. * @param parent defines the object to serialize in
  121238. * @returns the serialized object
  121239. */
  121240. serialize(parent: any): any;
  121241. }
  121242. }
  121243. declare module BABYLON {
  121244. /**
  121245. * Options allowed during the creation of a sound track.
  121246. */
  121247. export interface ISoundTrackOptions {
  121248. /**
  121249. * The volume the sound track should take during creation
  121250. */
  121251. volume?: number;
  121252. /**
  121253. * Define if the sound track is the main sound track of the scene
  121254. */
  121255. mainTrack?: boolean;
  121256. }
  121257. /**
  121258. * It could be useful to isolate your music & sounds on several tracks to better manage volume on a grouped instance of sounds.
  121259. * It will be also used in a future release to apply effects on a specific track.
  121260. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-sound-tracks
  121261. */
  121262. export class SoundTrack {
  121263. /**
  121264. * The unique identifier of the sound track in the scene.
  121265. */
  121266. id: number;
  121267. /**
  121268. * The list of sounds included in the sound track.
  121269. */
  121270. soundCollection: Array<Sound>;
  121271. private _outputAudioNode;
  121272. private _scene;
  121273. private _connectedAnalyser;
  121274. private _options;
  121275. private _isInitialized;
  121276. /**
  121277. * Creates a new sound track.
  121278. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-sound-tracks
  121279. * @param scene Define the scene the sound track belongs to
  121280. * @param options
  121281. */
  121282. constructor(scene: Scene, options?: ISoundTrackOptions);
  121283. private _initializeSoundTrackAudioGraph;
  121284. /**
  121285. * Release the sound track and its associated resources
  121286. */
  121287. dispose(): void;
  121288. /**
  121289. * Adds a sound to this sound track
  121290. * @param sound define the cound to add
  121291. * @ignoreNaming
  121292. */
  121293. AddSound(sound: Sound): void;
  121294. /**
  121295. * Removes a sound to this sound track
  121296. * @param sound define the cound to remove
  121297. * @ignoreNaming
  121298. */
  121299. RemoveSound(sound: Sound): void;
  121300. /**
  121301. * Set a global volume for the full sound track.
  121302. * @param newVolume Define the new volume of the sound track
  121303. */
  121304. setVolume(newVolume: number): void;
  121305. /**
  121306. * Switch the panning model to HRTF:
  121307. * Renders a stereo output of higher quality than equalpower — it uses a convolution with measured impulse responses from human subjects.
  121308. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121309. */
  121310. switchPanningModelToHRTF(): void;
  121311. /**
  121312. * Switch the panning model to Equal Power:
  121313. * Represents the equal-power panning algorithm, generally regarded as simple and efficient. equalpower is the default value.
  121314. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121315. */
  121316. switchPanningModelToEqualPower(): void;
  121317. /**
  121318. * Connect the sound track to an audio analyser allowing some amazing
  121319. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  121320. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  121321. * @param analyser The analyser to connect to the engine
  121322. */
  121323. connectToAnalyser(analyser: Analyser): void;
  121324. }
  121325. }
  121326. declare module BABYLON {
  121327. interface AbstractScene {
  121328. /**
  121329. * The list of sounds used in the scene.
  121330. */
  121331. sounds: Nullable<Array<Sound>>;
  121332. }
  121333. interface Scene {
  121334. /**
  121335. * @hidden
  121336. * Backing field
  121337. */
  121338. _mainSoundTrack: SoundTrack;
  121339. /**
  121340. * The main sound track played by the scene.
  121341. * It cotains your primary collection of sounds.
  121342. */
  121343. mainSoundTrack: SoundTrack;
  121344. /**
  121345. * The list of sound tracks added to the scene
  121346. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  121347. */
  121348. soundTracks: Nullable<Array<SoundTrack>>;
  121349. /**
  121350. * Gets a sound using a given name
  121351. * @param name defines the name to search for
  121352. * @return the found sound or null if not found at all.
  121353. */
  121354. getSoundByName(name: string): Nullable<Sound>;
  121355. /**
  121356. * Gets or sets if audio support is enabled
  121357. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  121358. */
  121359. audioEnabled: boolean;
  121360. /**
  121361. * Gets or sets if audio will be output to headphones
  121362. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  121363. */
  121364. headphone: boolean;
  121365. /**
  121366. * Gets or sets custom audio listener position provider
  121367. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  121368. */
  121369. audioListenerPositionProvider: Nullable<() => Vector3>;
  121370. /**
  121371. * Gets or sets a refresh rate when using 3D audio positioning
  121372. */
  121373. audioPositioningRefreshRate: number;
  121374. }
  121375. /**
  121376. * Defines the sound scene component responsible to manage any sounds
  121377. * in a given scene.
  121378. */
  121379. export class AudioSceneComponent implements ISceneSerializableComponent {
  121380. /**
  121381. * The component name helpfull to identify the component in the list of scene components.
  121382. */
  121383. readonly name: string;
  121384. /**
  121385. * The scene the component belongs to.
  121386. */
  121387. scene: Scene;
  121388. private _audioEnabled;
  121389. /**
  121390. * Gets whether audio is enabled or not.
  121391. * Please use related enable/disable method to switch state.
  121392. */
  121393. get audioEnabled(): boolean;
  121394. private _headphone;
  121395. /**
  121396. * Gets whether audio is outputing to headphone or not.
  121397. * Please use the according Switch methods to change output.
  121398. */
  121399. get headphone(): boolean;
  121400. /**
  121401. * Gets or sets a refresh rate when using 3D audio positioning
  121402. */
  121403. audioPositioningRefreshRate: number;
  121404. private _audioListenerPositionProvider;
  121405. /**
  121406. * Gets the current audio listener position provider
  121407. */
  121408. get audioListenerPositionProvider(): Nullable<() => Vector3>;
  121409. /**
  121410. * Sets a custom listener position for all sounds in the scene
  121411. * By default, this is the position of the first active camera
  121412. */
  121413. set audioListenerPositionProvider(value: Nullable<() => Vector3>);
  121414. /**
  121415. * Creates a new instance of the component for the given scene
  121416. * @param scene Defines the scene to register the component in
  121417. */
  121418. constructor(scene: Scene);
  121419. /**
  121420. * Registers the component in a given scene
  121421. */
  121422. register(): void;
  121423. /**
  121424. * Rebuilds the elements related to this component in case of
  121425. * context lost for instance.
  121426. */
  121427. rebuild(): void;
  121428. /**
  121429. * Serializes the component data to the specified json object
  121430. * @param serializationObject The object to serialize to
  121431. */
  121432. serialize(serializationObject: any): void;
  121433. /**
  121434. * Adds all the elements from the container to the scene
  121435. * @param container the container holding the elements
  121436. */
  121437. addFromContainer(container: AbstractScene): void;
  121438. /**
  121439. * Removes all the elements in the container from the scene
  121440. * @param container contains the elements to remove
  121441. * @param dispose if the removed element should be disposed (default: false)
  121442. */
  121443. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  121444. /**
  121445. * Disposes the component and the associated ressources.
  121446. */
  121447. dispose(): void;
  121448. /**
  121449. * Disables audio in the associated scene.
  121450. */
  121451. disableAudio(): void;
  121452. /**
  121453. * Enables audio in the associated scene.
  121454. */
  121455. enableAudio(): void;
  121456. /**
  121457. * Switch audio to headphone output.
  121458. */
  121459. switchAudioModeForHeadphones(): void;
  121460. /**
  121461. * Switch audio to normal speakers.
  121462. */
  121463. switchAudioModeForNormalSpeakers(): void;
  121464. private _cachedCameraDirection;
  121465. private _cachedCameraPosition;
  121466. private _lastCheck;
  121467. private _afterRender;
  121468. }
  121469. }
  121470. declare module BABYLON {
  121471. /**
  121472. * Wraps one or more Sound objects and selects one with random weight for playback.
  121473. */
  121474. export class WeightedSound {
  121475. /** When true a Sound will be selected and played when the current playing Sound completes. */
  121476. loop: boolean;
  121477. private _coneInnerAngle;
  121478. private _coneOuterAngle;
  121479. private _volume;
  121480. /** A Sound is currently playing. */
  121481. isPlaying: boolean;
  121482. /** A Sound is currently paused. */
  121483. isPaused: boolean;
  121484. private _sounds;
  121485. private _weights;
  121486. private _currentIndex?;
  121487. /**
  121488. * Creates a new WeightedSound from the list of sounds given.
  121489. * @param loop When true a Sound will be selected and played when the current playing Sound completes.
  121490. * @param sounds Array of Sounds that will be selected from.
  121491. * @param weights Array of number values for selection weights; length must equal sounds, values will be normalized to 1
  121492. */
  121493. constructor(loop: boolean, sounds: Sound[], weights: number[]);
  121494. /**
  121495. * The size of cone in degrees for a directional sound in which there will be no attenuation.
  121496. */
  121497. get directionalConeInnerAngle(): number;
  121498. /**
  121499. * The size of cone in degress for a directional sound in which there will be no attenuation.
  121500. */
  121501. set directionalConeInnerAngle(value: number);
  121502. /**
  121503. * Size of cone in degrees for a directional sound outside of which there will be no sound.
  121504. * Listener angles between innerAngle and outerAngle will falloff linearly.
  121505. */
  121506. get directionalConeOuterAngle(): number;
  121507. /**
  121508. * Size of cone in degrees for a directional sound outside of which there will be no sound.
  121509. * Listener angles between innerAngle and outerAngle will falloff linearly.
  121510. */
  121511. set directionalConeOuterAngle(value: number);
  121512. /**
  121513. * Playback volume.
  121514. */
  121515. get volume(): number;
  121516. /**
  121517. * Playback volume.
  121518. */
  121519. set volume(value: number);
  121520. private _onended;
  121521. /**
  121522. * Suspend playback
  121523. */
  121524. pause(): void;
  121525. /**
  121526. * Stop playback
  121527. */
  121528. stop(): void;
  121529. /**
  121530. * Start playback.
  121531. * @param startOffset Position the clip head at a specific time in seconds.
  121532. */
  121533. play(startOffset?: number): void;
  121534. }
  121535. }
  121536. declare module BABYLON {
  121537. /**
  121538. * Add a bouncing effect to an ArcRotateCamera when reaching a specified minimum and maximum radius
  121539. * @see https://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  121540. */
  121541. export class BouncingBehavior implements Behavior<ArcRotateCamera> {
  121542. /**
  121543. * Gets the name of the behavior.
  121544. */
  121545. get name(): string;
  121546. /**
  121547. * The easing function used by animations
  121548. */
  121549. static EasingFunction: BackEase;
  121550. /**
  121551. * The easing mode used by animations
  121552. */
  121553. static EasingMode: number;
  121554. /**
  121555. * The duration of the animation, in milliseconds
  121556. */
  121557. transitionDuration: number;
  121558. /**
  121559. * Length of the distance animated by the transition when lower radius is reached
  121560. */
  121561. lowerRadiusTransitionRange: number;
  121562. /**
  121563. * Length of the distance animated by the transition when upper radius is reached
  121564. */
  121565. upperRadiusTransitionRange: number;
  121566. private _autoTransitionRange;
  121567. /**
  121568. * Gets a value indicating if the lowerRadiusTransitionRange and upperRadiusTransitionRange are defined automatically
  121569. */
  121570. get autoTransitionRange(): boolean;
  121571. /**
  121572. * Sets a value indicating if the lowerRadiusTransitionRange and upperRadiusTransitionRange are defined automatically
  121573. * Transition ranges will be set to 5% of the bounding box diagonal in world space
  121574. */
  121575. set autoTransitionRange(value: boolean);
  121576. private _attachedCamera;
  121577. private _onAfterCheckInputsObserver;
  121578. private _onMeshTargetChangedObserver;
  121579. /**
  121580. * Initializes the behavior.
  121581. */
  121582. init(): void;
  121583. /**
  121584. * Attaches the behavior to its arc rotate camera.
  121585. * @param camera Defines the camera to attach the behavior to
  121586. */
  121587. attach(camera: ArcRotateCamera): void;
  121588. /**
  121589. * Detaches the behavior from its current arc rotate camera.
  121590. */
  121591. detach(): void;
  121592. private _radiusIsAnimating;
  121593. private _radiusBounceTransition;
  121594. private _animatables;
  121595. private _cachedWheelPrecision;
  121596. /**
  121597. * Checks if the camera radius is at the specified limit. Takes into account animation locks.
  121598. * @param radiusLimit The limit to check against.
  121599. * @return Bool to indicate if at limit.
  121600. */
  121601. private _isRadiusAtLimit;
  121602. /**
  121603. * Applies an animation to the radius of the camera, extending by the radiusDelta.
  121604. * @param radiusDelta The delta by which to animate to. Can be negative.
  121605. */
  121606. private _applyBoundRadiusAnimation;
  121607. /**
  121608. * Removes all animation locks. Allows new animations to be added to any of the camera properties.
  121609. */
  121610. protected _clearAnimationLocks(): void;
  121611. /**
  121612. * Stops and removes all animations that have been applied to the camera
  121613. */
  121614. stopAllAnimations(): void;
  121615. }
  121616. }
  121617. declare module BABYLON {
  121618. /**
  121619. * 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.
  121620. * @see https://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  121621. */
  121622. export class FramingBehavior implements Behavior<ArcRotateCamera> {
  121623. /**
  121624. * Gets the name of the behavior.
  121625. */
  121626. get name(): string;
  121627. private _mode;
  121628. private _radiusScale;
  121629. private _positionScale;
  121630. private _defaultElevation;
  121631. private _elevationReturnTime;
  121632. private _elevationReturnWaitTime;
  121633. private _zoomStopsAnimation;
  121634. private _framingTime;
  121635. /**
  121636. * The easing function used by animations
  121637. */
  121638. static EasingFunction: ExponentialEase;
  121639. /**
  121640. * The easing mode used by animations
  121641. */
  121642. static EasingMode: number;
  121643. /**
  121644. * Sets the current mode used by the behavior
  121645. */
  121646. set mode(mode: number);
  121647. /**
  121648. * Gets current mode used by the behavior.
  121649. */
  121650. get mode(): number;
  121651. /**
  121652. * Sets the scale applied to the radius (1 by default)
  121653. */
  121654. set radiusScale(radius: number);
  121655. /**
  121656. * Gets the scale applied to the radius
  121657. */
  121658. get radiusScale(): number;
  121659. /**
  121660. * Sets the scale to apply on Y axis to position camera focus. 0.5 by default which means the center of the bounding box.
  121661. */
  121662. set positionScale(scale: number);
  121663. /**
  121664. * Gets the scale to apply on Y axis to position camera focus. 0.5 by default which means the center of the bounding box.
  121665. */
  121666. get positionScale(): number;
  121667. /**
  121668. * Sets the angle above/below the horizontal plane to return to when the return to default elevation idle
  121669. * behaviour is triggered, in radians.
  121670. */
  121671. set defaultElevation(elevation: number);
  121672. /**
  121673. * Gets the angle above/below the horizontal plane to return to when the return to default elevation idle
  121674. * behaviour is triggered, in radians.
  121675. */
  121676. get defaultElevation(): number;
  121677. /**
  121678. * Sets the time (in milliseconds) taken to return to the default beta position.
  121679. * Negative value indicates camera should not return to default.
  121680. */
  121681. set elevationReturnTime(speed: number);
  121682. /**
  121683. * Gets the time (in milliseconds) taken to return to the default beta position.
  121684. * Negative value indicates camera should not return to default.
  121685. */
  121686. get elevationReturnTime(): number;
  121687. /**
  121688. * Sets the delay (in milliseconds) taken before the camera returns to the default beta position.
  121689. */
  121690. set elevationReturnWaitTime(time: number);
  121691. /**
  121692. * Gets the delay (in milliseconds) taken before the camera returns to the default beta position.
  121693. */
  121694. get elevationReturnWaitTime(): number;
  121695. /**
  121696. * Sets the flag that indicates if user zooming should stop animation.
  121697. */
  121698. set zoomStopsAnimation(flag: boolean);
  121699. /**
  121700. * Gets the flag that indicates if user zooming should stop animation.
  121701. */
  121702. get zoomStopsAnimation(): boolean;
  121703. /**
  121704. * Sets the transition time when framing the mesh, in milliseconds
  121705. */
  121706. set framingTime(time: number);
  121707. /**
  121708. * Gets the transition time when framing the mesh, in milliseconds
  121709. */
  121710. get framingTime(): number;
  121711. /**
  121712. * Define if the behavior should automatically change the configured
  121713. * camera limits and sensibilities.
  121714. */
  121715. autoCorrectCameraLimitsAndSensibility: boolean;
  121716. private _onPrePointerObservableObserver;
  121717. private _onAfterCheckInputsObserver;
  121718. private _onMeshTargetChangedObserver;
  121719. private _attachedCamera;
  121720. private _isPointerDown;
  121721. private _lastInteractionTime;
  121722. /**
  121723. * Initializes the behavior.
  121724. */
  121725. init(): void;
  121726. /**
  121727. * Attaches the behavior to its arc rotate camera.
  121728. * @param camera Defines the camera to attach the behavior to
  121729. */
  121730. attach(camera: ArcRotateCamera): void;
  121731. /**
  121732. * Detaches the behavior from its current arc rotate camera.
  121733. */
  121734. detach(): void;
  121735. private _animatables;
  121736. private _betaIsAnimating;
  121737. private _betaTransition;
  121738. private _radiusTransition;
  121739. private _vectorTransition;
  121740. /**
  121741. * Targets the given mesh and updates zoom level accordingly.
  121742. * @param mesh The mesh to target.
  121743. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  121744. * @param onAnimationEnd Callback triggered at the end of the framing animation
  121745. */
  121746. zoomOnMesh(mesh: AbstractMesh, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  121747. /**
  121748. * Targets the given mesh with its children and updates zoom level accordingly.
  121749. * @param mesh The mesh to target.
  121750. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  121751. * @param onAnimationEnd Callback triggered at the end of the framing animation
  121752. */
  121753. zoomOnMeshHierarchy(mesh: AbstractMesh, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  121754. /**
  121755. * Targets the given meshes with their children and updates zoom level accordingly.
  121756. * @param meshes The mesh to target.
  121757. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  121758. * @param onAnimationEnd Callback triggered at the end of the framing animation
  121759. */
  121760. zoomOnMeshesHierarchy(meshes: AbstractMesh[], focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  121761. /**
  121762. * Targets the bounding box info defined by its extends and updates zoom level accordingly.
  121763. * @param minimumWorld Determines the smaller position of the bounding box extend
  121764. * @param maximumWorld Determines the bigger position of the bounding box extend
  121765. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  121766. * @param onAnimationEnd Callback triggered at the end of the framing animation
  121767. */
  121768. zoomOnBoundingInfo(minimumWorld: Vector3, maximumWorld: Vector3, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  121769. /**
  121770. * Calculates the lowest radius for the camera based on the bounding box of the mesh.
  121771. * @param mesh The mesh on which to base the calculation. mesh boundingInfo used to estimate necessary
  121772. * frustum width.
  121773. * @return The minimum distance from the primary mesh's center point at which the camera must be kept in order
  121774. * to fully enclose the mesh in the viewing frustum.
  121775. */
  121776. protected _calculateLowerRadiusFromModelBoundingSphere(minimumWorld: Vector3, maximumWorld: Vector3): number;
  121777. /**
  121778. * Keeps the camera above the ground plane. If the user pulls the camera below the ground plane, the camera
  121779. * is automatically returned to its default position (expected to be above ground plane).
  121780. */
  121781. private _maintainCameraAboveGround;
  121782. /**
  121783. * Returns the frustum slope based on the canvas ratio and camera FOV
  121784. * @returns The frustum slope represented as a Vector2 with X and Y slopes
  121785. */
  121786. private _getFrustumSlope;
  121787. /**
  121788. * Removes all animation locks. Allows new animations to be added to any of the arcCamera properties.
  121789. */
  121790. private _clearAnimationLocks;
  121791. /**
  121792. * Applies any current user interaction to the camera. Takes into account maximum alpha rotation.
  121793. */
  121794. private _applyUserInteraction;
  121795. /**
  121796. * Stops and removes all animations that have been applied to the camera
  121797. */
  121798. stopAllAnimations(): void;
  121799. /**
  121800. * Gets a value indicating if the user is moving the camera
  121801. */
  121802. get isUserIsMoving(): boolean;
  121803. /**
  121804. * The camera can move all the way towards the mesh.
  121805. */
  121806. static IgnoreBoundsSizeMode: number;
  121807. /**
  121808. * The camera is not allowed to zoom closer to the mesh than the point at which the adjusted bounding sphere touches the frustum sides
  121809. */
  121810. static FitFrustumSidesMode: number;
  121811. }
  121812. }
  121813. declare module BABYLON {
  121814. /**
  121815. * Base class for Camera Pointer Inputs.
  121816. * See FollowCameraPointersInput in src/Cameras/Inputs/followCameraPointersInput.ts
  121817. * for example usage.
  121818. */
  121819. export abstract class BaseCameraPointersInput implements ICameraInput<Camera> {
  121820. /**
  121821. * Defines the camera the input is attached to.
  121822. */
  121823. abstract camera: Camera;
  121824. /**
  121825. * Whether keyboard modifier keys are pressed at time of last mouse event.
  121826. */
  121827. protected _altKey: boolean;
  121828. protected _ctrlKey: boolean;
  121829. protected _metaKey: boolean;
  121830. protected _shiftKey: boolean;
  121831. /**
  121832. * Which mouse buttons were pressed at time of last mouse event.
  121833. * https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/buttons
  121834. */
  121835. protected _buttonsPressed: number;
  121836. /**
  121837. * Defines the buttons associated with the input to handle camera move.
  121838. */
  121839. buttons: number[];
  121840. /**
  121841. * Attach the input controls to a specific dom element to get the input from.
  121842. * @param element Defines the element the controls should be listened from
  121843. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  121844. */
  121845. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  121846. /**
  121847. * Detach the current controls from the specified dom element.
  121848. * @param element Defines the element to stop listening the inputs from
  121849. */
  121850. detachControl(element: Nullable<HTMLElement>): void;
  121851. /**
  121852. * Gets the class name of the current input.
  121853. * @returns the class name
  121854. */
  121855. getClassName(): string;
  121856. /**
  121857. * Get the friendly name associated with the input class.
  121858. * @returns the input friendly name
  121859. */
  121860. getSimpleName(): string;
  121861. /**
  121862. * Called on pointer POINTERDOUBLETAP event.
  121863. * Override this method to provide functionality on POINTERDOUBLETAP event.
  121864. */
  121865. protected onDoubleTap(type: string): void;
  121866. /**
  121867. * Called on pointer POINTERMOVE event if only a single touch is active.
  121868. * Override this method to provide functionality.
  121869. */
  121870. protected onTouch(point: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  121871. /**
  121872. * Called on pointer POINTERMOVE event if multiple touches are active.
  121873. * Override this method to provide functionality.
  121874. */
  121875. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  121876. /**
  121877. * Called on JS contextmenu event.
  121878. * Override this method to provide functionality.
  121879. */
  121880. protected onContextMenu(evt: PointerEvent): void;
  121881. /**
  121882. * Called each time a new POINTERDOWN event occurs. Ie, for each button
  121883. * press.
  121884. * Override this method to provide functionality.
  121885. */
  121886. protected onButtonDown(evt: PointerEvent): void;
  121887. /**
  121888. * Called each time a new POINTERUP event occurs. Ie, for each button
  121889. * release.
  121890. * Override this method to provide functionality.
  121891. */
  121892. protected onButtonUp(evt: PointerEvent): void;
  121893. /**
  121894. * Called when window becomes inactive.
  121895. * Override this method to provide functionality.
  121896. */
  121897. protected onLostFocus(): void;
  121898. private _pointerInput;
  121899. private _observer;
  121900. private _onLostFocus;
  121901. private pointA;
  121902. private pointB;
  121903. }
  121904. }
  121905. declare module BABYLON {
  121906. /**
  121907. * Manage the pointers inputs to control an arc rotate camera.
  121908. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  121909. */
  121910. export class ArcRotateCameraPointersInput extends BaseCameraPointersInput {
  121911. /**
  121912. * Defines the camera the input is attached to.
  121913. */
  121914. camera: ArcRotateCamera;
  121915. /**
  121916. * Gets the class name of the current input.
  121917. * @returns the class name
  121918. */
  121919. getClassName(): string;
  121920. /**
  121921. * Defines the buttons associated with the input to handle camera move.
  121922. */
  121923. buttons: number[];
  121924. /**
  121925. * Defines the pointer angular sensibility along the X axis or how fast is
  121926. * the camera rotating.
  121927. */
  121928. angularSensibilityX: number;
  121929. /**
  121930. * Defines the pointer angular sensibility along the Y axis or how fast is
  121931. * the camera rotating.
  121932. */
  121933. angularSensibilityY: number;
  121934. /**
  121935. * Defines the pointer pinch precision or how fast is the camera zooming.
  121936. */
  121937. pinchPrecision: number;
  121938. /**
  121939. * pinchDeltaPercentage will be used instead of pinchPrecision if different
  121940. * from 0.
  121941. * It defines the percentage of current camera.radius to use as delta when
  121942. * pinch zoom is used.
  121943. */
  121944. pinchDeltaPercentage: number;
  121945. /**
  121946. * When useNaturalPinchZoom is true, multi touch zoom will zoom in such
  121947. * that any object in the plane at the camera's target point will scale
  121948. * perfectly with finger motion.
  121949. * Overrides pinchDeltaPercentage and pinchPrecision.
  121950. */
  121951. useNaturalPinchZoom: boolean;
  121952. /**
  121953. * Defines the pointer panning sensibility or how fast is the camera moving.
  121954. */
  121955. panningSensibility: number;
  121956. /**
  121957. * Defines whether panning (2 fingers swipe) is enabled through multitouch.
  121958. */
  121959. multiTouchPanning: boolean;
  121960. /**
  121961. * Defines whether panning is enabled for both pan (2 fingers swipe) and
  121962. * zoom (pinch) through multitouch.
  121963. */
  121964. multiTouchPanAndZoom: boolean;
  121965. /**
  121966. * Revers pinch action direction.
  121967. */
  121968. pinchInwards: boolean;
  121969. private _isPanClick;
  121970. private _twoFingerActivityCount;
  121971. private _isPinching;
  121972. /**
  121973. * Called on pointer POINTERMOVE event if only a single touch is active.
  121974. */
  121975. protected onTouch(point: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  121976. /**
  121977. * Called on pointer POINTERDOUBLETAP event.
  121978. */
  121979. protected onDoubleTap(type: string): void;
  121980. /**
  121981. * Called on pointer POINTERMOVE event if multiple touches are active.
  121982. */
  121983. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  121984. /**
  121985. * Called each time a new POINTERDOWN event occurs. Ie, for each button
  121986. * press.
  121987. */
  121988. protected onButtonDown(evt: PointerEvent): void;
  121989. /**
  121990. * Called each time a new POINTERUP event occurs. Ie, for each button
  121991. * release.
  121992. */
  121993. protected onButtonUp(evt: PointerEvent): void;
  121994. /**
  121995. * Called when window becomes inactive.
  121996. */
  121997. protected onLostFocus(): void;
  121998. }
  121999. }
  122000. declare module BABYLON {
  122001. /**
  122002. * Manage the keyboard inputs to control the movement of an arc rotate camera.
  122003. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  122004. */
  122005. export class ArcRotateCameraKeyboardMoveInput implements ICameraInput<ArcRotateCamera> {
  122006. /**
  122007. * Defines the camera the input is attached to.
  122008. */
  122009. camera: ArcRotateCamera;
  122010. /**
  122011. * Defines the list of key codes associated with the up action (increase alpha)
  122012. */
  122013. keysUp: number[];
  122014. /**
  122015. * Defines the list of key codes associated with the down action (decrease alpha)
  122016. */
  122017. keysDown: number[];
  122018. /**
  122019. * Defines the list of key codes associated with the left action (increase beta)
  122020. */
  122021. keysLeft: number[];
  122022. /**
  122023. * Defines the list of key codes associated with the right action (decrease beta)
  122024. */
  122025. keysRight: number[];
  122026. /**
  122027. * Defines the list of key codes associated with the reset action.
  122028. * Those keys reset the camera to its last stored state (with the method camera.storeState())
  122029. */
  122030. keysReset: number[];
  122031. /**
  122032. * Defines the panning sensibility of the inputs.
  122033. * (How fast is the camera panning)
  122034. */
  122035. panningSensibility: number;
  122036. /**
  122037. * Defines the zooming sensibility of the inputs.
  122038. * (How fast is the camera zooming)
  122039. */
  122040. zoomingSensibility: number;
  122041. /**
  122042. * Defines whether maintaining the alt key down switch the movement mode from
  122043. * orientation to zoom.
  122044. */
  122045. useAltToZoom: boolean;
  122046. /**
  122047. * Rotation speed of the camera
  122048. */
  122049. angularSpeed: number;
  122050. private _keys;
  122051. private _ctrlPressed;
  122052. private _altPressed;
  122053. private _onCanvasBlurObserver;
  122054. private _onKeyboardObserver;
  122055. private _engine;
  122056. private _scene;
  122057. /**
  122058. * Attach the input controls to a specific dom element to get the input from.
  122059. * @param element Defines the element the controls should be listened from
  122060. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  122061. */
  122062. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  122063. /**
  122064. * Detach the current controls from the specified dom element.
  122065. * @param element Defines the element to stop listening the inputs from
  122066. */
  122067. detachControl(element: Nullable<HTMLElement>): void;
  122068. /**
  122069. * Update the current camera state depending on the inputs that have been used this frame.
  122070. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  122071. */
  122072. checkInputs(): void;
  122073. /**
  122074. * Gets the class name of the current intput.
  122075. * @returns the class name
  122076. */
  122077. getClassName(): string;
  122078. /**
  122079. * Get the friendly name associated with the input class.
  122080. * @returns the input friendly name
  122081. */
  122082. getSimpleName(): string;
  122083. }
  122084. }
  122085. declare module BABYLON {
  122086. /**
  122087. * Manage the mouse wheel inputs to control an arc rotate camera.
  122088. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  122089. */
  122090. export class ArcRotateCameraMouseWheelInput implements ICameraInput<ArcRotateCamera> {
  122091. /**
  122092. * Defines the camera the input is attached to.
  122093. */
  122094. camera: ArcRotateCamera;
  122095. /**
  122096. * Gets or Set the mouse wheel precision or how fast is the camera zooming.
  122097. */
  122098. wheelPrecision: number;
  122099. /**
  122100. * wheelDeltaPercentage will be used instead of wheelPrecision if different from 0.
  122101. * It defines the percentage of current camera.radius to use as delta when wheel is used.
  122102. */
  122103. wheelDeltaPercentage: number;
  122104. private _wheel;
  122105. private _observer;
  122106. private computeDeltaFromMouseWheelLegacyEvent;
  122107. /**
  122108. * Attach the input controls to a specific dom element to get the input from.
  122109. * @param element Defines the element the controls should be listened from
  122110. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  122111. */
  122112. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  122113. /**
  122114. * Detach the current controls from the specified dom element.
  122115. * @param element Defines the element to stop listening the inputs from
  122116. */
  122117. detachControl(element: Nullable<HTMLElement>): void;
  122118. /**
  122119. * Gets the class name of the current intput.
  122120. * @returns the class name
  122121. */
  122122. getClassName(): string;
  122123. /**
  122124. * Get the friendly name associated with the input class.
  122125. * @returns the input friendly name
  122126. */
  122127. getSimpleName(): string;
  122128. }
  122129. }
  122130. declare module BABYLON {
  122131. /**
  122132. * Default Inputs manager for the ArcRotateCamera.
  122133. * It groups all the default supported inputs for ease of use.
  122134. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  122135. */
  122136. export class ArcRotateCameraInputsManager extends CameraInputsManager<ArcRotateCamera> {
  122137. /**
  122138. * Instantiates a new ArcRotateCameraInputsManager.
  122139. * @param camera Defines the camera the inputs belong to
  122140. */
  122141. constructor(camera: ArcRotateCamera);
  122142. /**
  122143. * Add mouse wheel input support to the input manager.
  122144. * @returns the current input manager
  122145. */
  122146. addMouseWheel(): ArcRotateCameraInputsManager;
  122147. /**
  122148. * Add pointers input support to the input manager.
  122149. * @returns the current input manager
  122150. */
  122151. addPointers(): ArcRotateCameraInputsManager;
  122152. /**
  122153. * Add keyboard input support to the input manager.
  122154. * @returns the current input manager
  122155. */
  122156. addKeyboard(): ArcRotateCameraInputsManager;
  122157. }
  122158. }
  122159. declare module BABYLON {
  122160. /**
  122161. * This represents an orbital type of camera.
  122162. *
  122163. * 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.
  122164. * 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.
  122165. * @see https://doc.babylonjs.com/babylon101/cameras#arc-rotate-camera
  122166. */
  122167. export class ArcRotateCamera extends TargetCamera {
  122168. /**
  122169. * Defines the rotation angle of the camera along the longitudinal axis.
  122170. */
  122171. alpha: number;
  122172. /**
  122173. * Defines the rotation angle of the camera along the latitudinal axis.
  122174. */
  122175. beta: number;
  122176. /**
  122177. * Defines the radius of the camera from it s target point.
  122178. */
  122179. radius: number;
  122180. protected _target: Vector3;
  122181. protected _targetHost: Nullable<AbstractMesh>;
  122182. /**
  122183. * Defines the target point of the camera.
  122184. * The camera looks towards it form the radius distance.
  122185. * Please note that you can set the target to a mesh and thus the target will be copied from mesh.position
  122186. */
  122187. get target(): Vector3;
  122188. set target(value: Vector3);
  122189. /**
  122190. * Define the current local position of the camera in the scene
  122191. */
  122192. get position(): Vector3;
  122193. set position(newPosition: Vector3);
  122194. protected _upVector: Vector3;
  122195. protected _upToYMatrix: Matrix;
  122196. protected _YToUpMatrix: Matrix;
  122197. /**
  122198. * The vector the camera should consider as up. (default is Vector3(0, 1, 0) as returned by Vector3.Up())
  122199. * Setting this will copy the given vector to the camera's upVector, and set rotation matrices to and from Y up.
  122200. * DO NOT set the up vector using copyFrom or copyFromFloats, as this bypasses setting the above matrices.
  122201. */
  122202. set upVector(vec: Vector3);
  122203. get upVector(): Vector3;
  122204. /**
  122205. * Sets the Y-up to camera up-vector rotation matrix, and the up-vector to Y-up rotation matrix.
  122206. */
  122207. setMatUp(): void;
  122208. /**
  122209. * Current inertia value on the longitudinal axis.
  122210. * The bigger this number the longer it will take for the camera to stop.
  122211. */
  122212. inertialAlphaOffset: number;
  122213. /**
  122214. * Current inertia value on the latitudinal axis.
  122215. * The bigger this number the longer it will take for the camera to stop.
  122216. */
  122217. inertialBetaOffset: number;
  122218. /**
  122219. * Current inertia value on the radius axis.
  122220. * The bigger this number the longer it will take for the camera to stop.
  122221. */
  122222. inertialRadiusOffset: number;
  122223. /**
  122224. * Minimum allowed angle on the longitudinal axis.
  122225. * This can help limiting how the Camera is able to move in the scene.
  122226. */
  122227. lowerAlphaLimit: Nullable<number>;
  122228. /**
  122229. * Maximum allowed angle on the longitudinal axis.
  122230. * This can help limiting how the Camera is able to move in the scene.
  122231. */
  122232. upperAlphaLimit: Nullable<number>;
  122233. /**
  122234. * Minimum allowed angle on the latitudinal axis.
  122235. * This can help limiting how the Camera is able to move in the scene.
  122236. */
  122237. lowerBetaLimit: number;
  122238. /**
  122239. * Maximum allowed angle on the latitudinal axis.
  122240. * This can help limiting how the Camera is able to move in the scene.
  122241. */
  122242. upperBetaLimit: number;
  122243. /**
  122244. * Minimum allowed distance of the camera to the target (The camera can not get closer).
  122245. * This can help limiting how the Camera is able to move in the scene.
  122246. */
  122247. lowerRadiusLimit: Nullable<number>;
  122248. /**
  122249. * Maximum allowed distance of the camera to the target (The camera can not get further).
  122250. * This can help limiting how the Camera is able to move in the scene.
  122251. */
  122252. upperRadiusLimit: Nullable<number>;
  122253. /**
  122254. * Defines the current inertia value used during panning of the camera along the X axis.
  122255. */
  122256. inertialPanningX: number;
  122257. /**
  122258. * Defines the current inertia value used during panning of the camera along the Y axis.
  122259. */
  122260. inertialPanningY: number;
  122261. /**
  122262. * Defines the distance used to consider the camera in pan mode vs pinch/zoom.
  122263. * Basically if your fingers moves away from more than this distance you will be considered
  122264. * in pinch mode.
  122265. */
  122266. pinchToPanMaxDistance: number;
  122267. /**
  122268. * Defines the maximum distance the camera can pan.
  122269. * This could help keeping the cammera always in your scene.
  122270. */
  122271. panningDistanceLimit: Nullable<number>;
  122272. /**
  122273. * Defines the target of the camera before paning.
  122274. */
  122275. panningOriginTarget: Vector3;
  122276. /**
  122277. * Defines the value of the inertia used during panning.
  122278. * 0 would mean stop inertia and one would mean no decelleration at all.
  122279. */
  122280. panningInertia: number;
  122281. /**
  122282. * Gets or Set the pointer angular sensibility along the X axis or how fast is the camera rotating.
  122283. */
  122284. get angularSensibilityX(): number;
  122285. set angularSensibilityX(value: number);
  122286. /**
  122287. * Gets or Set the pointer angular sensibility along the Y axis or how fast is the camera rotating.
  122288. */
  122289. get angularSensibilityY(): number;
  122290. set angularSensibilityY(value: number);
  122291. /**
  122292. * Gets or Set the pointer pinch precision or how fast is the camera zooming.
  122293. */
  122294. get pinchPrecision(): number;
  122295. set pinchPrecision(value: number);
  122296. /**
  122297. * Gets or Set the pointer pinch delta percentage or how fast is the camera zooming.
  122298. * It will be used instead of pinchDeltaPrecision if different from 0.
  122299. * It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
  122300. */
  122301. get pinchDeltaPercentage(): number;
  122302. set pinchDeltaPercentage(value: number);
  122303. /**
  122304. * Gets or Set the pointer use natural pinch zoom to override the pinch precision
  122305. * and pinch delta percentage.
  122306. * When useNaturalPinchZoom is true, multi touch zoom will zoom in such
  122307. * that any object in the plane at the camera's target point will scale
  122308. * perfectly with finger motion.
  122309. */
  122310. get useNaturalPinchZoom(): boolean;
  122311. set useNaturalPinchZoom(value: boolean);
  122312. /**
  122313. * Gets or Set the pointer panning sensibility or how fast is the camera moving.
  122314. */
  122315. get panningSensibility(): number;
  122316. set panningSensibility(value: number);
  122317. /**
  122318. * Gets or Set the list of keyboard keys used to control beta angle in a positive direction.
  122319. */
  122320. get keysUp(): number[];
  122321. set keysUp(value: number[]);
  122322. /**
  122323. * Gets or Set the list of keyboard keys used to control beta angle in a negative direction.
  122324. */
  122325. get keysDown(): number[];
  122326. set keysDown(value: number[]);
  122327. /**
  122328. * Gets or Set the list of keyboard keys used to control alpha angle in a negative direction.
  122329. */
  122330. get keysLeft(): number[];
  122331. set keysLeft(value: number[]);
  122332. /**
  122333. * Gets or Set the list of keyboard keys used to control alpha angle in a positive direction.
  122334. */
  122335. get keysRight(): number[];
  122336. set keysRight(value: number[]);
  122337. /**
  122338. * Gets or Set the mouse wheel precision or how fast is the camera zooming.
  122339. */
  122340. get wheelPrecision(): number;
  122341. set wheelPrecision(value: number);
  122342. /**
  122343. * Gets or Set the mouse wheel delta percentage or how fast is the camera zooming.
  122344. * It will be used instead of pinchDeltaPrecision if different from 0.
  122345. * It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
  122346. */
  122347. get wheelDeltaPercentage(): number;
  122348. set wheelDeltaPercentage(value: number);
  122349. /**
  122350. * Defines how much the radius should be scaled while zomming on a particular mesh (through the zoomOn function)
  122351. */
  122352. zoomOnFactor: number;
  122353. /**
  122354. * Defines a screen offset for the camera position.
  122355. */
  122356. targetScreenOffset: Vector2;
  122357. /**
  122358. * Allows the camera to be completely reversed.
  122359. * If false the camera can not arrive upside down.
  122360. */
  122361. allowUpsideDown: boolean;
  122362. /**
  122363. * Define if double tap/click is used to restore the previously saved state of the camera.
  122364. */
  122365. useInputToRestoreState: boolean;
  122366. /** @hidden */
  122367. _viewMatrix: Matrix;
  122368. /** @hidden */
  122369. _useCtrlForPanning: boolean;
  122370. /** @hidden */
  122371. _panningMouseButton: number;
  122372. /**
  122373. * Defines the input associated to the camera.
  122374. */
  122375. inputs: ArcRotateCameraInputsManager;
  122376. /** @hidden */
  122377. _reset: () => void;
  122378. /**
  122379. * Defines the allowed panning axis.
  122380. */
  122381. panningAxis: Vector3;
  122382. protected _localDirection: Vector3;
  122383. protected _transformedDirection: Vector3;
  122384. private _bouncingBehavior;
  122385. /**
  122386. * Gets the bouncing behavior of the camera if it has been enabled.
  122387. * @see https://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  122388. */
  122389. get bouncingBehavior(): Nullable<BouncingBehavior>;
  122390. /**
  122391. * Defines if the bouncing behavior of the camera is enabled on the camera.
  122392. * @see https://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  122393. */
  122394. get useBouncingBehavior(): boolean;
  122395. set useBouncingBehavior(value: boolean);
  122396. private _framingBehavior;
  122397. /**
  122398. * Gets the framing behavior of the camera if it has been enabled.
  122399. * @see https://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  122400. */
  122401. get framingBehavior(): Nullable<FramingBehavior>;
  122402. /**
  122403. * Defines if the framing behavior of the camera is enabled on the camera.
  122404. * @see https://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  122405. */
  122406. get useFramingBehavior(): boolean;
  122407. set useFramingBehavior(value: boolean);
  122408. private _autoRotationBehavior;
  122409. /**
  122410. * Gets the auto rotation behavior of the camera if it has been enabled.
  122411. * @see https://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  122412. */
  122413. get autoRotationBehavior(): Nullable<AutoRotationBehavior>;
  122414. /**
  122415. * Defines if the auto rotation behavior of the camera is enabled on the camera.
  122416. * @see https://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  122417. */
  122418. get useAutoRotationBehavior(): boolean;
  122419. set useAutoRotationBehavior(value: boolean);
  122420. /**
  122421. * Observable triggered when the mesh target has been changed on the camera.
  122422. */
  122423. onMeshTargetChangedObservable: Observable<Nullable<AbstractMesh>>;
  122424. /**
  122425. * Event raised when the camera is colliding with a mesh.
  122426. */
  122427. onCollide: (collidedMesh: AbstractMesh) => void;
  122428. /**
  122429. * Defines whether the camera should check collision with the objects oh the scene.
  122430. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#how-can-i-do-this
  122431. */
  122432. checkCollisions: boolean;
  122433. /**
  122434. * Defines the collision radius of the camera.
  122435. * This simulates a sphere around the camera.
  122436. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  122437. */
  122438. collisionRadius: Vector3;
  122439. protected _collider: Collider;
  122440. protected _previousPosition: Vector3;
  122441. protected _collisionVelocity: Vector3;
  122442. protected _newPosition: Vector3;
  122443. protected _previousAlpha: number;
  122444. protected _previousBeta: number;
  122445. protected _previousRadius: number;
  122446. protected _collisionTriggered: boolean;
  122447. protected _targetBoundingCenter: Nullable<Vector3>;
  122448. private _computationVector;
  122449. /**
  122450. * Instantiates a new ArcRotateCamera in a given scene
  122451. * @param name Defines the name of the camera
  122452. * @param alpha Defines the camera rotation along the logitudinal axis
  122453. * @param beta Defines the camera rotation along the latitudinal axis
  122454. * @param radius Defines the camera distance from its target
  122455. * @param target Defines the camera target
  122456. * @param scene Defines the scene the camera belongs to
  122457. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  122458. */
  122459. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  122460. /** @hidden */
  122461. _initCache(): void;
  122462. /** @hidden */
  122463. _updateCache(ignoreParentClass?: boolean): void;
  122464. protected _getTargetPosition(): Vector3;
  122465. private _storedAlpha;
  122466. private _storedBeta;
  122467. private _storedRadius;
  122468. private _storedTarget;
  122469. private _storedTargetScreenOffset;
  122470. /**
  122471. * Stores the current state of the camera (alpha, beta, radius and target)
  122472. * @returns the camera itself
  122473. */
  122474. storeState(): Camera;
  122475. /**
  122476. * @hidden
  122477. * Restored camera state. You must call storeState() first
  122478. */
  122479. _restoreStateValues(): boolean;
  122480. /** @hidden */
  122481. _isSynchronizedViewMatrix(): boolean;
  122482. /**
  122483. * Attached controls to the current camera.
  122484. * @param element Defines the element the controls should be listened from
  122485. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  122486. * @param useCtrlForPanning Defines whether ctrl is used for paning within the controls
  122487. * @param panningMouseButton Defines whether panning is allowed through mouse click button
  122488. */
  122489. attachControl(element: HTMLElement, noPreventDefault?: boolean, useCtrlForPanning?: boolean, panningMouseButton?: number): void;
  122490. /**
  122491. * Detach the current controls from the camera.
  122492. * The camera will stop reacting to inputs.
  122493. * @param element Defines the element to stop listening the inputs from
  122494. */
  122495. detachControl(element: HTMLElement): void;
  122496. /** @hidden */
  122497. _checkInputs(): void;
  122498. protected _checkLimits(): void;
  122499. /**
  122500. * Rebuilds angles (alpha, beta) and radius from the give position and target
  122501. */
  122502. rebuildAnglesAndRadius(): void;
  122503. /**
  122504. * Use a position to define the current camera related information like alpha, beta and radius
  122505. * @param position Defines the position to set the camera at
  122506. */
  122507. setPosition(position: Vector3): void;
  122508. /**
  122509. * Defines the target the camera should look at.
  122510. * This will automatically adapt alpha beta and radius to fit within the new target.
  122511. * @param target Defines the new target as a Vector or a mesh
  122512. * @param toBoundingCenter In case of a mesh target, defines whether to target the mesh position or its bounding information center
  122513. * @param allowSamePosition If false, prevents reapplying the new computed position if it is identical to the current one (optim)
  122514. */
  122515. setTarget(target: AbstractMesh | Vector3, toBoundingCenter?: boolean, allowSamePosition?: boolean): void;
  122516. /** @hidden */
  122517. _getViewMatrix(): Matrix;
  122518. protected _onCollisionPositionChange: (collisionId: number, newPosition: Vector3, collidedMesh?: Nullable<AbstractMesh>) => void;
  122519. /**
  122520. * Zooms on a mesh to be at the min distance where we could see it fully in the current viewport.
  122521. * @param meshes Defines the mesh to zoom on
  122522. * @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)
  122523. */
  122524. zoomOn(meshes?: AbstractMesh[], doNotUpdateMaxZ?: boolean): void;
  122525. /**
  122526. * Focus on a mesh or a bounding box. This adapts the target and maxRadius if necessary but does not update the current radius.
  122527. * The target will be changed but the radius
  122528. * @param meshesOrMinMaxVectorAndDistance Defines the mesh or bounding info to focus on
  122529. * @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)
  122530. */
  122531. focusOn(meshesOrMinMaxVectorAndDistance: AbstractMesh[] | {
  122532. min: Vector3;
  122533. max: Vector3;
  122534. distance: number;
  122535. }, doNotUpdateMaxZ?: boolean): void;
  122536. /**
  122537. * @override
  122538. * Override Camera.createRigCamera
  122539. */
  122540. createRigCamera(name: string, cameraIndex: number): Camera;
  122541. /**
  122542. * @hidden
  122543. * @override
  122544. * Override Camera._updateRigCameras
  122545. */
  122546. _updateRigCameras(): void;
  122547. /**
  122548. * Destroy the camera and release the current resources hold by it.
  122549. */
  122550. dispose(): void;
  122551. /**
  122552. * Gets the current object class name.
  122553. * @return the class name
  122554. */
  122555. getClassName(): string;
  122556. }
  122557. }
  122558. declare module BABYLON {
  122559. /**
  122560. * The autoRotation behavior (AutoRotationBehavior) is designed to create a smooth rotation of an ArcRotateCamera when there is no user interaction.
  122561. * @see https://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  122562. */
  122563. export class AutoRotationBehavior implements Behavior<ArcRotateCamera> {
  122564. /**
  122565. * Gets the name of the behavior.
  122566. */
  122567. get name(): string;
  122568. private _zoomStopsAnimation;
  122569. private _idleRotationSpeed;
  122570. private _idleRotationWaitTime;
  122571. private _idleRotationSpinupTime;
  122572. /**
  122573. * Sets the flag that indicates if user zooming should stop animation.
  122574. */
  122575. set zoomStopsAnimation(flag: boolean);
  122576. /**
  122577. * Gets the flag that indicates if user zooming should stop animation.
  122578. */
  122579. get zoomStopsAnimation(): boolean;
  122580. /**
  122581. * Sets the default speed at which the camera rotates around the model.
  122582. */
  122583. set idleRotationSpeed(speed: number);
  122584. /**
  122585. * Gets the default speed at which the camera rotates around the model.
  122586. */
  122587. get idleRotationSpeed(): number;
  122588. /**
  122589. * Sets the time (in milliseconds) to wait after user interaction before the camera starts rotating.
  122590. */
  122591. set idleRotationWaitTime(time: number);
  122592. /**
  122593. * Gets the time (milliseconds) to wait after user interaction before the camera starts rotating.
  122594. */
  122595. get idleRotationWaitTime(): number;
  122596. /**
  122597. * Sets the time (milliseconds) to take to spin up to the full idle rotation speed.
  122598. */
  122599. set idleRotationSpinupTime(time: number);
  122600. /**
  122601. * Gets the time (milliseconds) to take to spin up to the full idle rotation speed.
  122602. */
  122603. get idleRotationSpinupTime(): number;
  122604. /**
  122605. * Gets a value indicating if the camera is currently rotating because of this behavior
  122606. */
  122607. get rotationInProgress(): boolean;
  122608. private _onPrePointerObservableObserver;
  122609. private _onAfterCheckInputsObserver;
  122610. private _attachedCamera;
  122611. private _isPointerDown;
  122612. private _lastFrameTime;
  122613. private _lastInteractionTime;
  122614. private _cameraRotationSpeed;
  122615. /**
  122616. * Initializes the behavior.
  122617. */
  122618. init(): void;
  122619. /**
  122620. * Attaches the behavior to its arc rotate camera.
  122621. * @param camera Defines the camera to attach the behavior to
  122622. */
  122623. attach(camera: ArcRotateCamera): void;
  122624. /**
  122625. * Detaches the behavior from its current arc rotate camera.
  122626. */
  122627. detach(): void;
  122628. /**
  122629. * Returns true if user is scrolling.
  122630. * @return true if user is scrolling.
  122631. */
  122632. private _userIsZooming;
  122633. private _lastFrameRadius;
  122634. private _shouldAnimationStopForInteraction;
  122635. /**
  122636. * Applies any current user interaction to the camera. Takes into account maximum alpha rotation.
  122637. */
  122638. private _applyUserInteraction;
  122639. private _userIsMoving;
  122640. }
  122641. }
  122642. declare module BABYLON {
  122643. /**
  122644. * A behavior that when attached to a mesh will will place a specified node on the meshes face pointing towards the camera
  122645. */
  122646. export class AttachToBoxBehavior implements Behavior<Mesh> {
  122647. private ui;
  122648. /**
  122649. * The name of the behavior
  122650. */
  122651. name: string;
  122652. /**
  122653. * The distance away from the face of the mesh that the UI should be attached to (default: 0.15)
  122654. */
  122655. distanceAwayFromFace: number;
  122656. /**
  122657. * The distance from the bottom of the face that the UI should be attached to (default: 0.15)
  122658. */
  122659. distanceAwayFromBottomOfFace: number;
  122660. private _faceVectors;
  122661. private _target;
  122662. private _scene;
  122663. private _onRenderObserver;
  122664. private _tmpMatrix;
  122665. private _tmpVector;
  122666. /**
  122667. * Creates the AttachToBoxBehavior, used to attach UI to the closest face of the box to a camera
  122668. * @param ui The transform node that should be attched to the mesh
  122669. */
  122670. constructor(ui: TransformNode);
  122671. /**
  122672. * Initializes the behavior
  122673. */
  122674. init(): void;
  122675. private _closestFace;
  122676. private _zeroVector;
  122677. private _lookAtTmpMatrix;
  122678. private _lookAtToRef;
  122679. /**
  122680. * Attaches the AttachToBoxBehavior to the passed in mesh
  122681. * @param target The mesh that the specified node will be attached to
  122682. */
  122683. attach(target: Mesh): void;
  122684. /**
  122685. * Detaches the behavior from the mesh
  122686. */
  122687. detach(): void;
  122688. }
  122689. }
  122690. declare module BABYLON {
  122691. /**
  122692. * A behavior that when attached to a mesh will allow the mesh to fade in and out
  122693. */
  122694. export class FadeInOutBehavior implements Behavior<Mesh> {
  122695. /**
  122696. * Time in milliseconds to delay before fading in (Default: 0)
  122697. */
  122698. delay: number;
  122699. /**
  122700. * Time in milliseconds for the mesh to fade in (Default: 300)
  122701. */
  122702. fadeInTime: number;
  122703. private _millisecondsPerFrame;
  122704. private _hovered;
  122705. private _hoverValue;
  122706. private _ownerNode;
  122707. /**
  122708. * Instatiates the FadeInOutBehavior
  122709. */
  122710. constructor();
  122711. /**
  122712. * The name of the behavior
  122713. */
  122714. get name(): string;
  122715. /**
  122716. * Initializes the behavior
  122717. */
  122718. init(): void;
  122719. /**
  122720. * Attaches the fade behavior on the passed in mesh
  122721. * @param ownerNode The mesh that will be faded in/out once attached
  122722. */
  122723. attach(ownerNode: Mesh): void;
  122724. /**
  122725. * Detaches the behavior from the mesh
  122726. */
  122727. detach(): void;
  122728. /**
  122729. * Triggers the mesh to begin fading in or out
  122730. * @param value if the object should fade in or out (true to fade in)
  122731. */
  122732. fadeIn(value: boolean): void;
  122733. private _update;
  122734. private _setAllVisibility;
  122735. }
  122736. }
  122737. declare module BABYLON {
  122738. /**
  122739. * Class containing a set of static utilities functions for managing Pivots
  122740. * @hidden
  122741. */
  122742. export class PivotTools {
  122743. private static _PivotCached;
  122744. private static _OldPivotPoint;
  122745. private static _PivotTranslation;
  122746. private static _PivotTmpVector;
  122747. /** @hidden */
  122748. static _RemoveAndStorePivotPoint(mesh: AbstractMesh): void;
  122749. /** @hidden */
  122750. static _RestorePivotPoint(mesh: AbstractMesh): void;
  122751. }
  122752. }
  122753. declare module BABYLON {
  122754. /**
  122755. * Class containing static functions to help procedurally build meshes
  122756. */
  122757. export class PlaneBuilder {
  122758. /**
  122759. * Creates a plane mesh
  122760. * * The parameter `size` sets the size (float) of both sides of the plane at once (default 1)
  122761. * * You can set some different plane dimensions by using the parameters `width` and `height` (both by default have the same value of `size`)
  122762. * * The parameter `sourcePlane` is a Plane instance. It builds a mesh plane from a Math plane
  122763. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  122764. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  122765. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  122766. * @param name defines the name of the mesh
  122767. * @param options defines the options used to create the mesh
  122768. * @param scene defines the hosting scene
  122769. * @returns the plane mesh
  122770. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  122771. */
  122772. static CreatePlane(name: string, options: {
  122773. size?: number;
  122774. width?: number;
  122775. height?: number;
  122776. sideOrientation?: number;
  122777. frontUVs?: Vector4;
  122778. backUVs?: Vector4;
  122779. updatable?: boolean;
  122780. sourcePlane?: Plane;
  122781. }, scene?: Nullable<Scene>): Mesh;
  122782. }
  122783. }
  122784. declare module BABYLON {
  122785. /**
  122786. * A behavior that when attached to a mesh will allow the mesh to be dragged around the screen based on pointer events
  122787. */
  122788. export class PointerDragBehavior implements Behavior<AbstractMesh> {
  122789. private static _AnyMouseID;
  122790. /**
  122791. * Abstract mesh the behavior is set on
  122792. */
  122793. attachedNode: AbstractMesh;
  122794. private _dragPlane;
  122795. private _scene;
  122796. private _pointerObserver;
  122797. private _beforeRenderObserver;
  122798. private static _planeScene;
  122799. private _useAlternatePickedPointAboveMaxDragAngleDragSpeed;
  122800. /**
  122801. * 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)
  122802. */
  122803. maxDragAngle: number;
  122804. /**
  122805. * @hidden
  122806. */
  122807. _useAlternatePickedPointAboveMaxDragAngle: boolean;
  122808. /**
  122809. * The id of the pointer that is currently interacting with the behavior (-1 when no pointer is active)
  122810. */
  122811. currentDraggingPointerID: number;
  122812. /**
  122813. * The last position where the pointer hit the drag plane in world space
  122814. */
  122815. lastDragPosition: Vector3;
  122816. /**
  122817. * If the behavior is currently in a dragging state
  122818. */
  122819. dragging: boolean;
  122820. /**
  122821. * 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)
  122822. */
  122823. dragDeltaRatio: number;
  122824. /**
  122825. * If the drag plane orientation should be updated during the dragging (Default: true)
  122826. */
  122827. updateDragPlane: boolean;
  122828. private _debugMode;
  122829. private _moving;
  122830. /**
  122831. * Fires each time the attached mesh is dragged with the pointer
  122832. * * delta between last drag position and current drag position in world space
  122833. * * dragDistance along the drag axis
  122834. * * dragPlaneNormal normal of the current drag plane used during the drag
  122835. * * dragPlanePoint in world space where the drag intersects the drag plane
  122836. */
  122837. onDragObservable: Observable<{
  122838. delta: Vector3;
  122839. dragPlanePoint: Vector3;
  122840. dragPlaneNormal: Vector3;
  122841. dragDistance: number;
  122842. pointerId: number;
  122843. }>;
  122844. /**
  122845. * Fires each time a drag begins (eg. mouse down on mesh)
  122846. */
  122847. onDragStartObservable: Observable<{
  122848. dragPlanePoint: Vector3;
  122849. pointerId: number;
  122850. }>;
  122851. /**
  122852. * Fires each time a drag ends (eg. mouse release after drag)
  122853. */
  122854. onDragEndObservable: Observable<{
  122855. dragPlanePoint: Vector3;
  122856. pointerId: number;
  122857. }>;
  122858. /**
  122859. * If the attached mesh should be moved when dragged
  122860. */
  122861. moveAttached: boolean;
  122862. /**
  122863. * If the drag behavior will react to drag events (Default: true)
  122864. */
  122865. enabled: boolean;
  122866. /**
  122867. * If pointer events should start and release the drag (Default: true)
  122868. */
  122869. startAndReleaseDragOnPointerEvents: boolean;
  122870. /**
  122871. * If camera controls should be detached during the drag
  122872. */
  122873. detachCameraControls: boolean;
  122874. /**
  122875. * If set, the drag plane/axis will be rotated based on the attached mesh's world rotation (Default: true)
  122876. */
  122877. useObjectOrientationForDragging: boolean;
  122878. private _options;
  122879. /**
  122880. * Gets the options used by the behavior
  122881. */
  122882. get options(): {
  122883. dragAxis?: Vector3;
  122884. dragPlaneNormal?: Vector3;
  122885. };
  122886. /**
  122887. * Sets the options used by the behavior
  122888. */
  122889. set options(options: {
  122890. dragAxis?: Vector3;
  122891. dragPlaneNormal?: Vector3;
  122892. });
  122893. /**
  122894. * Creates a pointer drag behavior that can be attached to a mesh
  122895. * @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)
  122896. */
  122897. constructor(options?: {
  122898. dragAxis?: Vector3;
  122899. dragPlaneNormal?: Vector3;
  122900. });
  122901. /**
  122902. * Predicate to determine if it is valid to move the object to a new position when it is moved
  122903. */
  122904. validateDrag: (targetPosition: Vector3) => boolean;
  122905. /**
  122906. * The name of the behavior
  122907. */
  122908. get name(): string;
  122909. /**
  122910. * Initializes the behavior
  122911. */
  122912. init(): void;
  122913. private _tmpVector;
  122914. private _alternatePickedPoint;
  122915. private _worldDragAxis;
  122916. private _targetPosition;
  122917. private _attachedElement;
  122918. /**
  122919. * Attaches the drag behavior the passed in mesh
  122920. * @param ownerNode The mesh that will be dragged around once attached
  122921. * @param predicate Predicate to use for pick filtering
  122922. */
  122923. attach(ownerNode: AbstractMesh, predicate?: (m: AbstractMesh) => boolean): void;
  122924. /**
  122925. * Force relase the drag action by code.
  122926. */
  122927. releaseDrag(): void;
  122928. private _startDragRay;
  122929. private _lastPointerRay;
  122930. /**
  122931. * Simulates the start of a pointer drag event on the behavior
  122932. * @param pointerId pointerID of the pointer that should be simulated (Default: Any mouse pointer ID)
  122933. * @param fromRay initial ray of the pointer to be simulated (Default: Ray from camera to attached mesh)
  122934. * @param startPickedPoint picked point of the pointer to be simulated (Default: attached mesh position)
  122935. */
  122936. startDrag(pointerId?: number, fromRay?: Ray, startPickedPoint?: Vector3): void;
  122937. private _startDrag;
  122938. private _dragDelta;
  122939. private _moveDrag;
  122940. private _pickWithRayOnDragPlane;
  122941. private _pointA;
  122942. private _pointC;
  122943. private _localAxis;
  122944. private _lookAt;
  122945. private _updateDragPlanePosition;
  122946. /**
  122947. * Detaches the behavior from the mesh
  122948. */
  122949. detach(): void;
  122950. }
  122951. }
  122952. declare module BABYLON {
  122953. /**
  122954. * A behavior that when attached to a mesh will allow the mesh to be scaled
  122955. */
  122956. export class MultiPointerScaleBehavior implements Behavior<Mesh> {
  122957. private _dragBehaviorA;
  122958. private _dragBehaviorB;
  122959. private _startDistance;
  122960. private _initialScale;
  122961. private _targetScale;
  122962. private _ownerNode;
  122963. private _sceneRenderObserver;
  122964. /**
  122965. * Instantiate a new behavior that when attached to a mesh will allow the mesh to be scaled
  122966. */
  122967. constructor();
  122968. /**
  122969. * The name of the behavior
  122970. */
  122971. get name(): string;
  122972. /**
  122973. * Initializes the behavior
  122974. */
  122975. init(): void;
  122976. private _getCurrentDistance;
  122977. /**
  122978. * Attaches the scale behavior the passed in mesh
  122979. * @param ownerNode The mesh that will be scaled around once attached
  122980. */
  122981. attach(ownerNode: Mesh): void;
  122982. /**
  122983. * Detaches the behavior from the mesh
  122984. */
  122985. detach(): void;
  122986. }
  122987. }
  122988. declare module BABYLON {
  122989. /**
  122990. * 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
  122991. */
  122992. export class SixDofDragBehavior implements Behavior<Mesh> {
  122993. private static _virtualScene;
  122994. private _ownerNode;
  122995. private _sceneRenderObserver;
  122996. private _scene;
  122997. private _targetPosition;
  122998. private _virtualOriginMesh;
  122999. private _virtualDragMesh;
  123000. private _pointerObserver;
  123001. private _moving;
  123002. private _startingOrientation;
  123003. private _attachedElement;
  123004. /**
  123005. * 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)
  123006. */
  123007. private zDragFactor;
  123008. /**
  123009. * If the object should rotate to face the drag origin
  123010. */
  123011. rotateDraggedObject: boolean;
  123012. /**
  123013. * If the behavior is currently in a dragging state
  123014. */
  123015. dragging: boolean;
  123016. /**
  123017. * 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)
  123018. */
  123019. dragDeltaRatio: number;
  123020. /**
  123021. * The id of the pointer that is currently interacting with the behavior (-1 when no pointer is active)
  123022. */
  123023. currentDraggingPointerID: number;
  123024. /**
  123025. * If camera controls should be detached during the drag
  123026. */
  123027. detachCameraControls: boolean;
  123028. /**
  123029. * Fires each time a drag starts
  123030. */
  123031. onDragStartObservable: Observable<{}>;
  123032. /**
  123033. * Fires each time a drag ends (eg. mouse release after drag)
  123034. */
  123035. onDragEndObservable: Observable<{}>;
  123036. /**
  123037. * 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
  123038. */
  123039. constructor();
  123040. /**
  123041. * The name of the behavior
  123042. */
  123043. get name(): string;
  123044. /**
  123045. * Initializes the behavior
  123046. */
  123047. init(): void;
  123048. /**
  123049. * In the case of multiplea active cameras, the cameraToUseForPointers should be used if set instead of active camera
  123050. */
  123051. private get _pointerCamera();
  123052. /**
  123053. * Attaches the scale behavior the passed in mesh
  123054. * @param ownerNode The mesh that will be scaled around once attached
  123055. */
  123056. attach(ownerNode: Mesh): void;
  123057. /**
  123058. * Detaches the behavior from the mesh
  123059. */
  123060. detach(): void;
  123061. }
  123062. }
  123063. declare module BABYLON {
  123064. /**
  123065. * Class used to apply inverse kinematics to bones
  123066. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons#boneikcontroller
  123067. */
  123068. export class BoneIKController {
  123069. private static _tmpVecs;
  123070. private static _tmpQuat;
  123071. private static _tmpMats;
  123072. /**
  123073. * Gets or sets the target mesh
  123074. */
  123075. targetMesh: AbstractMesh;
  123076. /** Gets or sets the mesh used as pole */
  123077. poleTargetMesh: AbstractMesh;
  123078. /**
  123079. * Gets or sets the bone used as pole
  123080. */
  123081. poleTargetBone: Nullable<Bone>;
  123082. /**
  123083. * Gets or sets the target position
  123084. */
  123085. targetPosition: Vector3;
  123086. /**
  123087. * Gets or sets the pole target position
  123088. */
  123089. poleTargetPosition: Vector3;
  123090. /**
  123091. * Gets or sets the pole target local offset
  123092. */
  123093. poleTargetLocalOffset: Vector3;
  123094. /**
  123095. * Gets or sets the pole angle
  123096. */
  123097. poleAngle: number;
  123098. /**
  123099. * Gets or sets the mesh associated with the controller
  123100. */
  123101. mesh: AbstractMesh;
  123102. /**
  123103. * 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)
  123104. */
  123105. slerpAmount: number;
  123106. private _bone1Quat;
  123107. private _bone1Mat;
  123108. private _bone2Ang;
  123109. private _bone1;
  123110. private _bone2;
  123111. private _bone1Length;
  123112. private _bone2Length;
  123113. private _maxAngle;
  123114. private _maxReach;
  123115. private _rightHandedSystem;
  123116. private _bendAxis;
  123117. private _slerping;
  123118. private _adjustRoll;
  123119. /**
  123120. * Gets or sets maximum allowed angle
  123121. */
  123122. get maxAngle(): number;
  123123. set maxAngle(value: number);
  123124. /**
  123125. * Creates a new BoneIKController
  123126. * @param mesh defines the mesh to control
  123127. * @param bone defines the bone to control
  123128. * @param options defines options to set up the controller
  123129. */
  123130. constructor(mesh: AbstractMesh, bone: Bone, options?: {
  123131. targetMesh?: AbstractMesh;
  123132. poleTargetMesh?: AbstractMesh;
  123133. poleTargetBone?: Bone;
  123134. poleTargetLocalOffset?: Vector3;
  123135. poleAngle?: number;
  123136. bendAxis?: Vector3;
  123137. maxAngle?: number;
  123138. slerpAmount?: number;
  123139. });
  123140. private _setMaxAngle;
  123141. /**
  123142. * Force the controller to update the bones
  123143. */
  123144. update(): void;
  123145. }
  123146. }
  123147. declare module BABYLON {
  123148. /**
  123149. * Class used to make a bone look toward a point in space
  123150. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons#bonelookcontroller
  123151. */
  123152. export class BoneLookController {
  123153. private static _tmpVecs;
  123154. private static _tmpQuat;
  123155. private static _tmpMats;
  123156. /**
  123157. * The target Vector3 that the bone will look at
  123158. */
  123159. target: Vector3;
  123160. /**
  123161. * The mesh that the bone is attached to
  123162. */
  123163. mesh: AbstractMesh;
  123164. /**
  123165. * The bone that will be looking to the target
  123166. */
  123167. bone: Bone;
  123168. /**
  123169. * The up axis of the coordinate system that is used when the bone is rotated
  123170. */
  123171. upAxis: Vector3;
  123172. /**
  123173. * The space that the up axis is in - Space.BONE, Space.LOCAL (default), or Space.WORLD
  123174. */
  123175. upAxisSpace: Space;
  123176. /**
  123177. * Used to make an adjustment to the yaw of the bone
  123178. */
  123179. adjustYaw: number;
  123180. /**
  123181. * Used to make an adjustment to the pitch of the bone
  123182. */
  123183. adjustPitch: number;
  123184. /**
  123185. * Used to make an adjustment to the roll of the bone
  123186. */
  123187. adjustRoll: number;
  123188. /**
  123189. * 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)
  123190. */
  123191. slerpAmount: number;
  123192. private _minYaw;
  123193. private _maxYaw;
  123194. private _minPitch;
  123195. private _maxPitch;
  123196. private _minYawSin;
  123197. private _minYawCos;
  123198. private _maxYawSin;
  123199. private _maxYawCos;
  123200. private _midYawConstraint;
  123201. private _minPitchTan;
  123202. private _maxPitchTan;
  123203. private _boneQuat;
  123204. private _slerping;
  123205. private _transformYawPitch;
  123206. private _transformYawPitchInv;
  123207. private _firstFrameSkipped;
  123208. private _yawRange;
  123209. private _fowardAxis;
  123210. /**
  123211. * Gets or sets the minimum yaw angle that the bone can look to
  123212. */
  123213. get minYaw(): number;
  123214. set minYaw(value: number);
  123215. /**
  123216. * Gets or sets the maximum yaw angle that the bone can look to
  123217. */
  123218. get maxYaw(): number;
  123219. set maxYaw(value: number);
  123220. /**
  123221. * Gets or sets the minimum pitch angle that the bone can look to
  123222. */
  123223. get minPitch(): number;
  123224. set minPitch(value: number);
  123225. /**
  123226. * Gets or sets the maximum pitch angle that the bone can look to
  123227. */
  123228. get maxPitch(): number;
  123229. set maxPitch(value: number);
  123230. /**
  123231. * Create a BoneLookController
  123232. * @param mesh the mesh that the bone belongs to
  123233. * @param bone the bone that will be looking to the target
  123234. * @param target the target Vector3 to look at
  123235. * @param options optional settings:
  123236. * * maxYaw: the maximum angle the bone will yaw to
  123237. * * minYaw: the minimum angle the bone will yaw to
  123238. * * maxPitch: the maximum angle the bone will pitch to
  123239. * * minPitch: the minimum angle the bone will yaw to
  123240. * * slerpAmount: set the between 0 and 1 to make the bone slerp to the target.
  123241. * * upAxis: the up axis of the coordinate system
  123242. * * upAxisSpace: the space that the up axis is in - Space.BONE, Space.LOCAL (default), or Space.WORLD.
  123243. * * yawAxis: set yawAxis if the bone does not yaw on the y axis
  123244. * * pitchAxis: set pitchAxis if the bone does not pitch on the x axis
  123245. * * adjustYaw: used to make an adjustment to the yaw of the bone
  123246. * * adjustPitch: used to make an adjustment to the pitch of the bone
  123247. * * adjustRoll: used to make an adjustment to the roll of the bone
  123248. **/
  123249. constructor(mesh: AbstractMesh, bone: Bone, target: Vector3, options?: {
  123250. maxYaw?: number;
  123251. minYaw?: number;
  123252. maxPitch?: number;
  123253. minPitch?: number;
  123254. slerpAmount?: number;
  123255. upAxis?: Vector3;
  123256. upAxisSpace?: Space;
  123257. yawAxis?: Vector3;
  123258. pitchAxis?: Vector3;
  123259. adjustYaw?: number;
  123260. adjustPitch?: number;
  123261. adjustRoll?: number;
  123262. });
  123263. /**
  123264. * Update the bone to look at the target. This should be called before the scene is rendered (use scene.registerBeforeRender())
  123265. */
  123266. update(): void;
  123267. private _getAngleDiff;
  123268. private _getAngleBetween;
  123269. private _isAngleBetween;
  123270. }
  123271. }
  123272. declare module BABYLON {
  123273. /**
  123274. * Manage the gamepad inputs to control an arc rotate camera.
  123275. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  123276. */
  123277. export class ArcRotateCameraGamepadInput implements ICameraInput<ArcRotateCamera> {
  123278. /**
  123279. * Defines the camera the input is attached to.
  123280. */
  123281. camera: ArcRotateCamera;
  123282. /**
  123283. * Defines the gamepad the input is gathering event from.
  123284. */
  123285. gamepad: Nullable<Gamepad>;
  123286. /**
  123287. * Defines the gamepad rotation sensiblity.
  123288. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  123289. */
  123290. gamepadRotationSensibility: number;
  123291. /**
  123292. * Defines the gamepad move sensiblity.
  123293. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  123294. */
  123295. gamepadMoveSensibility: number;
  123296. private _yAxisScale;
  123297. /**
  123298. * Gets or sets a boolean indicating that Yaxis (for right stick) should be inverted
  123299. */
  123300. get invertYAxis(): boolean;
  123301. set invertYAxis(value: boolean);
  123302. private _onGamepadConnectedObserver;
  123303. private _onGamepadDisconnectedObserver;
  123304. /**
  123305. * Attach the input controls to a specific dom element to get the input from.
  123306. * @param element Defines the element the controls should be listened from
  123307. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  123308. */
  123309. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  123310. /**
  123311. * Detach the current controls from the specified dom element.
  123312. * @param element Defines the element to stop listening the inputs from
  123313. */
  123314. detachControl(element: Nullable<HTMLElement>): void;
  123315. /**
  123316. * Update the current camera state depending on the inputs that have been used this frame.
  123317. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  123318. */
  123319. checkInputs(): void;
  123320. /**
  123321. * Gets the class name of the current intput.
  123322. * @returns the class name
  123323. */
  123324. getClassName(): string;
  123325. /**
  123326. * Get the friendly name associated with the input class.
  123327. * @returns the input friendly name
  123328. */
  123329. getSimpleName(): string;
  123330. }
  123331. }
  123332. declare module BABYLON {
  123333. interface ArcRotateCameraInputsManager {
  123334. /**
  123335. * Add orientation input support to the input manager.
  123336. * @returns the current input manager
  123337. */
  123338. addVRDeviceOrientation(): ArcRotateCameraInputsManager;
  123339. }
  123340. /**
  123341. * Manage the device orientation inputs (gyroscope) to control an arc rotate camera.
  123342. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  123343. */
  123344. export class ArcRotateCameraVRDeviceOrientationInput implements ICameraInput<ArcRotateCamera> {
  123345. /**
  123346. * Defines the camera the input is attached to.
  123347. */
  123348. camera: ArcRotateCamera;
  123349. /**
  123350. * Defines a correction factor applied on the alpha value retrieved from the orientation events.
  123351. */
  123352. alphaCorrection: number;
  123353. /**
  123354. * Defines a correction factor applied on the gamma value retrieved from the orientation events.
  123355. */
  123356. gammaCorrection: number;
  123357. private _alpha;
  123358. private _gamma;
  123359. private _dirty;
  123360. private _deviceOrientationHandler;
  123361. /**
  123362. * Instantiate a new ArcRotateCameraVRDeviceOrientationInput.
  123363. */
  123364. constructor();
  123365. /**
  123366. * Attach the input controls to a specific dom element to get the input from.
  123367. * @param element Defines the element the controls should be listened from
  123368. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  123369. */
  123370. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  123371. /** @hidden */
  123372. _onOrientationEvent(evt: DeviceOrientationEvent): void;
  123373. /**
  123374. * Update the current camera state depending on the inputs that have been used this frame.
  123375. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  123376. */
  123377. checkInputs(): void;
  123378. /**
  123379. * Detach the current controls from the specified dom element.
  123380. * @param element Defines the element to stop listening the inputs from
  123381. */
  123382. detachControl(element: Nullable<HTMLElement>): void;
  123383. /**
  123384. * Gets the class name of the current intput.
  123385. * @returns the class name
  123386. */
  123387. getClassName(): string;
  123388. /**
  123389. * Get the friendly name associated with the input class.
  123390. * @returns the input friendly name
  123391. */
  123392. getSimpleName(): string;
  123393. }
  123394. }
  123395. declare module BABYLON {
  123396. /**
  123397. * Listen to mouse events to control the camera.
  123398. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  123399. */
  123400. export class FlyCameraMouseInput implements ICameraInput<FlyCamera> {
  123401. /**
  123402. * Defines the camera the input is attached to.
  123403. */
  123404. camera: FlyCamera;
  123405. /**
  123406. * Defines if touch is enabled. (Default is true.)
  123407. */
  123408. touchEnabled: boolean;
  123409. /**
  123410. * Defines the buttons associated with the input to handle camera rotation.
  123411. */
  123412. buttons: number[];
  123413. /**
  123414. * Assign buttons for Yaw control.
  123415. */
  123416. buttonsYaw: number[];
  123417. /**
  123418. * Assign buttons for Pitch control.
  123419. */
  123420. buttonsPitch: number[];
  123421. /**
  123422. * Assign buttons for Roll control.
  123423. */
  123424. buttonsRoll: number[];
  123425. /**
  123426. * Detect if any button is being pressed while mouse is moved.
  123427. * -1 = Mouse locked.
  123428. * 0 = Left button.
  123429. * 1 = Middle Button.
  123430. * 2 = Right Button.
  123431. */
  123432. activeButton: number;
  123433. /**
  123434. * Defines the pointer's angular sensibility, to control the camera rotation speed.
  123435. * Higher values reduce its sensitivity.
  123436. */
  123437. angularSensibility: number;
  123438. private _mousemoveCallback;
  123439. private _observer;
  123440. private _rollObserver;
  123441. private previousPosition;
  123442. private noPreventDefault;
  123443. private element;
  123444. /**
  123445. * Listen to mouse events to control the camera.
  123446. * @param touchEnabled Define if touch is enabled. (Default is true.)
  123447. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  123448. */
  123449. constructor(touchEnabled?: boolean);
  123450. /**
  123451. * Attach the mouse control to the HTML DOM element.
  123452. * @param element Defines the element that listens to the input events.
  123453. * @param noPreventDefault Defines whether events caught by the controls should call preventdefault().
  123454. */
  123455. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  123456. /**
  123457. * Detach the current controls from the specified dom element.
  123458. * @param element Defines the element to stop listening the inputs from
  123459. */
  123460. detachControl(element: Nullable<HTMLElement>): void;
  123461. /**
  123462. * Gets the class name of the current input.
  123463. * @returns the class name.
  123464. */
  123465. getClassName(): string;
  123466. /**
  123467. * Get the friendly name associated with the input class.
  123468. * @returns the input's friendly name.
  123469. */
  123470. getSimpleName(): string;
  123471. private _pointerInput;
  123472. private _onMouseMove;
  123473. /**
  123474. * Rotate camera by mouse offset.
  123475. */
  123476. private rotateCamera;
  123477. }
  123478. }
  123479. declare module BABYLON {
  123480. /**
  123481. * Default Inputs manager for the FlyCamera.
  123482. * It groups all the default supported inputs for ease of use.
  123483. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  123484. */
  123485. export class FlyCameraInputsManager extends CameraInputsManager<FlyCamera> {
  123486. /**
  123487. * Instantiates a new FlyCameraInputsManager.
  123488. * @param camera Defines the camera the inputs belong to.
  123489. */
  123490. constructor(camera: FlyCamera);
  123491. /**
  123492. * Add keyboard input support to the input manager.
  123493. * @returns the new FlyCameraKeyboardMoveInput().
  123494. */
  123495. addKeyboard(): FlyCameraInputsManager;
  123496. /**
  123497. * Add mouse input support to the input manager.
  123498. * @param touchEnabled Enable touch screen support.
  123499. * @returns the new FlyCameraMouseInput().
  123500. */
  123501. addMouse(touchEnabled?: boolean): FlyCameraInputsManager;
  123502. }
  123503. }
  123504. declare module BABYLON {
  123505. /**
  123506. * This is a flying camera, designed for 3D movement and rotation in all directions,
  123507. * such as in a 3D Space Shooter or a Flight Simulator.
  123508. */
  123509. export class FlyCamera extends TargetCamera {
  123510. /**
  123511. * Define the collision ellipsoid of the camera.
  123512. * This is helpful for simulating a camera body, like a player's body.
  123513. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  123514. */
  123515. ellipsoid: Vector3;
  123516. /**
  123517. * Define an offset for the position of the ellipsoid around the camera.
  123518. * This can be helpful if the camera is attached away from the player's body center,
  123519. * such as at its head.
  123520. */
  123521. ellipsoidOffset: Vector3;
  123522. /**
  123523. * Enable or disable collisions of the camera with the rest of the scene objects.
  123524. */
  123525. checkCollisions: boolean;
  123526. /**
  123527. * Enable or disable gravity on the camera.
  123528. */
  123529. applyGravity: boolean;
  123530. /**
  123531. * Define the current direction the camera is moving to.
  123532. */
  123533. cameraDirection: Vector3;
  123534. /**
  123535. * Define the current local rotation of the camera as a quaternion to prevent Gimbal lock.
  123536. * This overrides and empties cameraRotation.
  123537. */
  123538. rotationQuaternion: Quaternion;
  123539. /**
  123540. * Track Roll to maintain the wanted Rolling when looking around.
  123541. */
  123542. _trackRoll: number;
  123543. /**
  123544. * Slowly correct the Roll to its original value after a Pitch+Yaw rotation.
  123545. */
  123546. rollCorrect: number;
  123547. /**
  123548. * Mimic a banked turn, Rolling the camera when Yawing.
  123549. * It's recommended to use rollCorrect = 10 for faster banking correction.
  123550. */
  123551. bankedTurn: boolean;
  123552. /**
  123553. * Limit in radians for how much Roll banking will add. (Default: 90°)
  123554. */
  123555. bankedTurnLimit: number;
  123556. /**
  123557. * Value of 0 disables the banked Roll.
  123558. * Value of 1 is equal to the Yaw angle in radians.
  123559. */
  123560. bankedTurnMultiplier: number;
  123561. /**
  123562. * The inputs manager loads all the input sources, such as keyboard and mouse.
  123563. */
  123564. inputs: FlyCameraInputsManager;
  123565. /**
  123566. * Gets the input sensibility for mouse input.
  123567. * Higher values reduce sensitivity.
  123568. */
  123569. get angularSensibility(): number;
  123570. /**
  123571. * Sets the input sensibility for a mouse input.
  123572. * Higher values reduce sensitivity.
  123573. */
  123574. set angularSensibility(value: number);
  123575. /**
  123576. * Get the keys for camera movement forward.
  123577. */
  123578. get keysForward(): number[];
  123579. /**
  123580. * Set the keys for camera movement forward.
  123581. */
  123582. set keysForward(value: number[]);
  123583. /**
  123584. * Get the keys for camera movement backward.
  123585. */
  123586. get keysBackward(): number[];
  123587. set keysBackward(value: number[]);
  123588. /**
  123589. * Get the keys for camera movement up.
  123590. */
  123591. get keysUp(): number[];
  123592. /**
  123593. * Set the keys for camera movement up.
  123594. */
  123595. set keysUp(value: number[]);
  123596. /**
  123597. * Get the keys for camera movement down.
  123598. */
  123599. get keysDown(): number[];
  123600. /**
  123601. * Set the keys for camera movement down.
  123602. */
  123603. set keysDown(value: number[]);
  123604. /**
  123605. * Get the keys for camera movement left.
  123606. */
  123607. get keysLeft(): number[];
  123608. /**
  123609. * Set the keys for camera movement left.
  123610. */
  123611. set keysLeft(value: number[]);
  123612. /**
  123613. * Set the keys for camera movement right.
  123614. */
  123615. get keysRight(): number[];
  123616. /**
  123617. * Set the keys for camera movement right.
  123618. */
  123619. set keysRight(value: number[]);
  123620. /**
  123621. * Event raised when the camera collides with a mesh in the scene.
  123622. */
  123623. onCollide: (collidedMesh: AbstractMesh) => void;
  123624. private _collider;
  123625. private _needMoveForGravity;
  123626. private _oldPosition;
  123627. private _diffPosition;
  123628. private _newPosition;
  123629. /** @hidden */
  123630. _localDirection: Vector3;
  123631. /** @hidden */
  123632. _transformedDirection: Vector3;
  123633. /**
  123634. * Instantiates a FlyCamera.
  123635. * This is a flying camera, designed for 3D movement and rotation in all directions,
  123636. * such as in a 3D Space Shooter or a Flight Simulator.
  123637. * @param name Define the name of the camera in the scene.
  123638. * @param position Define the starting position of the camera in the scene.
  123639. * @param scene Define the scene the camera belongs to.
  123640. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active, if no other camera has been defined as active.
  123641. */
  123642. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  123643. /**
  123644. * Attach a control to the HTML DOM element.
  123645. * @param element Defines the element that listens to the input events.
  123646. * @param noPreventDefault Defines whether events caught by the controls should call preventdefault(). https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault
  123647. */
  123648. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  123649. /**
  123650. * Detach a control from the HTML DOM element.
  123651. * The camera will stop reacting to that input.
  123652. * @param element Defines the element that listens to the input events.
  123653. */
  123654. detachControl(element: HTMLElement): void;
  123655. private _collisionMask;
  123656. /**
  123657. * Get the mask that the camera ignores in collision events.
  123658. */
  123659. get collisionMask(): number;
  123660. /**
  123661. * Set the mask that the camera ignores in collision events.
  123662. */
  123663. set collisionMask(mask: number);
  123664. /** @hidden */
  123665. _collideWithWorld(displacement: Vector3): void;
  123666. /** @hidden */
  123667. private _onCollisionPositionChange;
  123668. /** @hidden */
  123669. _checkInputs(): void;
  123670. /** @hidden */
  123671. _decideIfNeedsToMove(): boolean;
  123672. /** @hidden */
  123673. _updatePosition(): void;
  123674. /**
  123675. * Restore the Roll to its target value at the rate specified.
  123676. * @param rate - Higher means slower restoring.
  123677. * @hidden
  123678. */
  123679. restoreRoll(rate: number): void;
  123680. /**
  123681. * Destroy the camera and release the current resources held by it.
  123682. */
  123683. dispose(): void;
  123684. /**
  123685. * Get the current object class name.
  123686. * @returns the class name.
  123687. */
  123688. getClassName(): string;
  123689. }
  123690. }
  123691. declare module BABYLON {
  123692. /**
  123693. * Listen to keyboard events to control the camera.
  123694. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  123695. */
  123696. export class FlyCameraKeyboardInput implements ICameraInput<FlyCamera> {
  123697. /**
  123698. * Defines the camera the input is attached to.
  123699. */
  123700. camera: FlyCamera;
  123701. /**
  123702. * The list of keyboard keys used to control the forward move of the camera.
  123703. */
  123704. keysForward: number[];
  123705. /**
  123706. * The list of keyboard keys used to control the backward move of the camera.
  123707. */
  123708. keysBackward: number[];
  123709. /**
  123710. * The list of keyboard keys used to control the forward move of the camera.
  123711. */
  123712. keysUp: number[];
  123713. /**
  123714. * The list of keyboard keys used to control the backward move of the camera.
  123715. */
  123716. keysDown: number[];
  123717. /**
  123718. * The list of keyboard keys used to control the right strafe move of the camera.
  123719. */
  123720. keysRight: number[];
  123721. /**
  123722. * The list of keyboard keys used to control the left strafe move of the camera.
  123723. */
  123724. keysLeft: number[];
  123725. private _keys;
  123726. private _onCanvasBlurObserver;
  123727. private _onKeyboardObserver;
  123728. private _engine;
  123729. private _scene;
  123730. /**
  123731. * Attach the input controls to a specific dom element to get the input from.
  123732. * @param element Defines the element the controls should be listened from
  123733. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  123734. */
  123735. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  123736. /**
  123737. * Detach the current controls from the specified dom element.
  123738. * @param element Defines the element to stop listening the inputs from
  123739. */
  123740. detachControl(element: Nullable<HTMLElement>): void;
  123741. /**
  123742. * Gets the class name of the current intput.
  123743. * @returns the class name
  123744. */
  123745. getClassName(): string;
  123746. /** @hidden */
  123747. _onLostFocus(e: FocusEvent): void;
  123748. /**
  123749. * Get the friendly name associated with the input class.
  123750. * @returns the input friendly name
  123751. */
  123752. getSimpleName(): string;
  123753. /**
  123754. * Update the current camera state depending on the inputs that have been used this frame.
  123755. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  123756. */
  123757. checkInputs(): void;
  123758. }
  123759. }
  123760. declare module BABYLON {
  123761. /**
  123762. * Manage the mouse wheel inputs to control a follow camera.
  123763. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  123764. */
  123765. export class FollowCameraMouseWheelInput implements ICameraInput<FollowCamera> {
  123766. /**
  123767. * Defines the camera the input is attached to.
  123768. */
  123769. camera: FollowCamera;
  123770. /**
  123771. * Moue wheel controls zoom. (Mouse wheel modifies camera.radius value.)
  123772. */
  123773. axisControlRadius: boolean;
  123774. /**
  123775. * Moue wheel controls height. (Mouse wheel modifies camera.heightOffset value.)
  123776. */
  123777. axisControlHeight: boolean;
  123778. /**
  123779. * Moue wheel controls angle. (Mouse wheel modifies camera.rotationOffset value.)
  123780. */
  123781. axisControlRotation: boolean;
  123782. /**
  123783. * Gets or Set the mouse wheel precision or how fast is the camera moves in
  123784. * relation to mouseWheel events.
  123785. */
  123786. wheelPrecision: number;
  123787. /**
  123788. * wheelDeltaPercentage will be used instead of wheelPrecision if different from 0.
  123789. * It defines the percentage of current camera.radius to use as delta when wheel is used.
  123790. */
  123791. wheelDeltaPercentage: number;
  123792. private _wheel;
  123793. private _observer;
  123794. /**
  123795. * Attach the input controls to a specific dom element to get the input from.
  123796. * @param element Defines the element the controls should be listened from
  123797. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  123798. */
  123799. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  123800. /**
  123801. * Detach the current controls from the specified dom element.
  123802. * @param element Defines the element to stop listening the inputs from
  123803. */
  123804. detachControl(element: Nullable<HTMLElement>): void;
  123805. /**
  123806. * Gets the class name of the current intput.
  123807. * @returns the class name
  123808. */
  123809. getClassName(): string;
  123810. /**
  123811. * Get the friendly name associated with the input class.
  123812. * @returns the input friendly name
  123813. */
  123814. getSimpleName(): string;
  123815. }
  123816. }
  123817. declare module BABYLON {
  123818. /**
  123819. * Manage the pointers inputs to control an follow camera.
  123820. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  123821. */
  123822. export class FollowCameraPointersInput extends BaseCameraPointersInput {
  123823. /**
  123824. * Defines the camera the input is attached to.
  123825. */
  123826. camera: FollowCamera;
  123827. /**
  123828. * Gets the class name of the current input.
  123829. * @returns the class name
  123830. */
  123831. getClassName(): string;
  123832. /**
  123833. * Defines the pointer angular sensibility along the X axis or how fast is
  123834. * the camera rotating.
  123835. * A negative number will reverse the axis direction.
  123836. */
  123837. angularSensibilityX: number;
  123838. /**
  123839. * Defines the pointer angular sensibility along the Y axis or how fast is
  123840. * the camera rotating.
  123841. * A negative number will reverse the axis direction.
  123842. */
  123843. angularSensibilityY: number;
  123844. /**
  123845. * Defines the pointer pinch precision or how fast is the camera zooming.
  123846. * A negative number will reverse the axis direction.
  123847. */
  123848. pinchPrecision: number;
  123849. /**
  123850. * pinchDeltaPercentage will be used instead of pinchPrecision if different
  123851. * from 0.
  123852. * It defines the percentage of current camera.radius to use as delta when
  123853. * pinch zoom is used.
  123854. */
  123855. pinchDeltaPercentage: number;
  123856. /**
  123857. * Pointer X axis controls zoom. (X axis modifies camera.radius value.)
  123858. */
  123859. axisXControlRadius: boolean;
  123860. /**
  123861. * Pointer X axis controls height. (X axis modifies camera.heightOffset value.)
  123862. */
  123863. axisXControlHeight: boolean;
  123864. /**
  123865. * Pointer X axis controls angle. (X axis modifies camera.rotationOffset value.)
  123866. */
  123867. axisXControlRotation: boolean;
  123868. /**
  123869. * Pointer Y axis controls zoom. (Y axis modifies camera.radius value.)
  123870. */
  123871. axisYControlRadius: boolean;
  123872. /**
  123873. * Pointer Y axis controls height. (Y axis modifies camera.heightOffset value.)
  123874. */
  123875. axisYControlHeight: boolean;
  123876. /**
  123877. * Pointer Y axis controls angle. (Y axis modifies camera.rotationOffset value.)
  123878. */
  123879. axisYControlRotation: boolean;
  123880. /**
  123881. * Pinch controls zoom. (Pinch modifies camera.radius value.)
  123882. */
  123883. axisPinchControlRadius: boolean;
  123884. /**
  123885. * Pinch controls height. (Pinch modifies camera.heightOffset value.)
  123886. */
  123887. axisPinchControlHeight: boolean;
  123888. /**
  123889. * Pinch controls angle. (Pinch modifies camera.rotationOffset value.)
  123890. */
  123891. axisPinchControlRotation: boolean;
  123892. /**
  123893. * Log error messages if basic misconfiguration has occurred.
  123894. */
  123895. warningEnable: boolean;
  123896. protected onTouch(pointA: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  123897. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  123898. private _warningCounter;
  123899. private _warning;
  123900. }
  123901. }
  123902. declare module BABYLON {
  123903. /**
  123904. * Default Inputs manager for the FollowCamera.
  123905. * It groups all the default supported inputs for ease of use.
  123906. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  123907. */
  123908. export class FollowCameraInputsManager extends CameraInputsManager<FollowCamera> {
  123909. /**
  123910. * Instantiates a new FollowCameraInputsManager.
  123911. * @param camera Defines the camera the inputs belong to
  123912. */
  123913. constructor(camera: FollowCamera);
  123914. /**
  123915. * Add keyboard input support to the input manager.
  123916. * @returns the current input manager
  123917. */
  123918. addKeyboard(): FollowCameraInputsManager;
  123919. /**
  123920. * Add mouse wheel input support to the input manager.
  123921. * @returns the current input manager
  123922. */
  123923. addMouseWheel(): FollowCameraInputsManager;
  123924. /**
  123925. * Add pointers input support to the input manager.
  123926. * @returns the current input manager
  123927. */
  123928. addPointers(): FollowCameraInputsManager;
  123929. /**
  123930. * Add orientation input support to the input manager.
  123931. * @returns the current input manager
  123932. */
  123933. addVRDeviceOrientation(): FollowCameraInputsManager;
  123934. }
  123935. }
  123936. declare module BABYLON {
  123937. /**
  123938. * A follow camera takes a mesh as a target and follows it as it moves. Both a free camera version followCamera and
  123939. * an arc rotate version arcFollowCamera are available.
  123940. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  123941. */
  123942. export class FollowCamera extends TargetCamera {
  123943. /**
  123944. * Distance the follow camera should follow an object at
  123945. */
  123946. radius: number;
  123947. /**
  123948. * Minimum allowed distance of the camera to the axis of rotation
  123949. * (The camera can not get closer).
  123950. * This can help limiting how the Camera is able to move in the scene.
  123951. */
  123952. lowerRadiusLimit: Nullable<number>;
  123953. /**
  123954. * Maximum allowed distance of the camera to the axis of rotation
  123955. * (The camera can not get further).
  123956. * This can help limiting how the Camera is able to move in the scene.
  123957. */
  123958. upperRadiusLimit: Nullable<number>;
  123959. /**
  123960. * Define a rotation offset between the camera and the object it follows
  123961. */
  123962. rotationOffset: number;
  123963. /**
  123964. * Minimum allowed angle to camera position relative to target object.
  123965. * This can help limiting how the Camera is able to move in the scene.
  123966. */
  123967. lowerRotationOffsetLimit: Nullable<number>;
  123968. /**
  123969. * Maximum allowed angle to camera position relative to target object.
  123970. * This can help limiting how the Camera is able to move in the scene.
  123971. */
  123972. upperRotationOffsetLimit: Nullable<number>;
  123973. /**
  123974. * Define a height offset between the camera and the object it follows.
  123975. * It can help following an object from the top (like a car chaing a plane)
  123976. */
  123977. heightOffset: number;
  123978. /**
  123979. * Minimum allowed height of camera position relative to target object.
  123980. * This can help limiting how the Camera is able to move in the scene.
  123981. */
  123982. lowerHeightOffsetLimit: Nullable<number>;
  123983. /**
  123984. * Maximum allowed height of camera position relative to target object.
  123985. * This can help limiting how the Camera is able to move in the scene.
  123986. */
  123987. upperHeightOffsetLimit: Nullable<number>;
  123988. /**
  123989. * Define how fast the camera can accelerate to follow it s target.
  123990. */
  123991. cameraAcceleration: number;
  123992. /**
  123993. * Define the speed limit of the camera following an object.
  123994. */
  123995. maxCameraSpeed: number;
  123996. /**
  123997. * Define the target of the camera.
  123998. */
  123999. lockedTarget: Nullable<AbstractMesh>;
  124000. /**
  124001. * Defines the input associated with the camera.
  124002. */
  124003. inputs: FollowCameraInputsManager;
  124004. /**
  124005. * Instantiates the follow camera.
  124006. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  124007. * @param name Define the name of the camera in the scene
  124008. * @param position Define the position of the camera
  124009. * @param scene Define the scene the camera belong to
  124010. * @param lockedTarget Define the target of the camera
  124011. */
  124012. constructor(name: string, position: Vector3, scene: Scene, lockedTarget?: Nullable<AbstractMesh>);
  124013. private _follow;
  124014. /**
  124015. * Attached controls to the current camera.
  124016. * @param element Defines the element the controls should be listened from
  124017. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  124018. */
  124019. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  124020. /**
  124021. * Detach the current controls from the camera.
  124022. * The camera will stop reacting to inputs.
  124023. * @param element Defines the element to stop listening the inputs from
  124024. */
  124025. detachControl(element: HTMLElement): void;
  124026. /** @hidden */
  124027. _checkInputs(): void;
  124028. private _checkLimits;
  124029. /**
  124030. * Gets the camera class name.
  124031. * @returns the class name
  124032. */
  124033. getClassName(): string;
  124034. }
  124035. /**
  124036. * Arc Rotate version of the follow camera.
  124037. * It still follows a Defined mesh but in an Arc Rotate Camera fashion.
  124038. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  124039. */
  124040. export class ArcFollowCamera extends TargetCamera {
  124041. /** The longitudinal angle of the camera */
  124042. alpha: number;
  124043. /** The latitudinal angle of the camera */
  124044. beta: number;
  124045. /** The radius of the camera from its target */
  124046. radius: number;
  124047. private _cartesianCoordinates;
  124048. /** Define the camera target (the mesh it should follow) */
  124049. private _meshTarget;
  124050. /**
  124051. * Instantiates a new ArcFollowCamera
  124052. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  124053. * @param name Define the name of the camera
  124054. * @param alpha Define the rotation angle of the camera around the logitudinal axis
  124055. * @param beta Define the rotation angle of the camera around the elevation axis
  124056. * @param radius Define the radius of the camera from its target point
  124057. * @param target Define the target of the camera
  124058. * @param scene Define the scene the camera belongs to
  124059. */
  124060. constructor(name: string,
  124061. /** The longitudinal angle of the camera */
  124062. alpha: number,
  124063. /** The latitudinal angle of the camera */
  124064. beta: number,
  124065. /** The radius of the camera from its target */
  124066. radius: number,
  124067. /** Define the camera target (the mesh it should follow) */
  124068. target: Nullable<AbstractMesh>, scene: Scene);
  124069. private _follow;
  124070. /** @hidden */
  124071. _checkInputs(): void;
  124072. /**
  124073. * Returns the class name of the object.
  124074. * It is mostly used internally for serialization purposes.
  124075. */
  124076. getClassName(): string;
  124077. }
  124078. }
  124079. declare module BABYLON {
  124080. /**
  124081. * Manage the keyboard inputs to control the movement of a follow camera.
  124082. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  124083. */
  124084. export class FollowCameraKeyboardMoveInput implements ICameraInput<FollowCamera> {
  124085. /**
  124086. * Defines the camera the input is attached to.
  124087. */
  124088. camera: FollowCamera;
  124089. /**
  124090. * Defines the list of key codes associated with the up action (increase heightOffset)
  124091. */
  124092. keysHeightOffsetIncr: number[];
  124093. /**
  124094. * Defines the list of key codes associated with the down action (decrease heightOffset)
  124095. */
  124096. keysHeightOffsetDecr: number[];
  124097. /**
  124098. * Defines whether the Alt modifier key is required to move up/down (alter heightOffset)
  124099. */
  124100. keysHeightOffsetModifierAlt: boolean;
  124101. /**
  124102. * Defines whether the Ctrl modifier key is required to move up/down (alter heightOffset)
  124103. */
  124104. keysHeightOffsetModifierCtrl: boolean;
  124105. /**
  124106. * Defines whether the Shift modifier key is required to move up/down (alter heightOffset)
  124107. */
  124108. keysHeightOffsetModifierShift: boolean;
  124109. /**
  124110. * Defines the list of key codes associated with the left action (increase rotationOffset)
  124111. */
  124112. keysRotationOffsetIncr: number[];
  124113. /**
  124114. * Defines the list of key codes associated with the right action (decrease rotationOffset)
  124115. */
  124116. keysRotationOffsetDecr: number[];
  124117. /**
  124118. * Defines whether the Alt modifier key is required to move left/right (alter rotationOffset)
  124119. */
  124120. keysRotationOffsetModifierAlt: boolean;
  124121. /**
  124122. * Defines whether the Ctrl modifier key is required to move left/right (alter rotationOffset)
  124123. */
  124124. keysRotationOffsetModifierCtrl: boolean;
  124125. /**
  124126. * Defines whether the Shift modifier key is required to move left/right (alter rotationOffset)
  124127. */
  124128. keysRotationOffsetModifierShift: boolean;
  124129. /**
  124130. * Defines the list of key codes associated with the zoom-in action (decrease radius)
  124131. */
  124132. keysRadiusIncr: number[];
  124133. /**
  124134. * Defines the list of key codes associated with the zoom-out action (increase radius)
  124135. */
  124136. keysRadiusDecr: number[];
  124137. /**
  124138. * Defines whether the Alt modifier key is required to zoom in/out (alter radius value)
  124139. */
  124140. keysRadiusModifierAlt: boolean;
  124141. /**
  124142. * Defines whether the Ctrl modifier key is required to zoom in/out (alter radius value)
  124143. */
  124144. keysRadiusModifierCtrl: boolean;
  124145. /**
  124146. * Defines whether the Shift modifier key is required to zoom in/out (alter radius value)
  124147. */
  124148. keysRadiusModifierShift: boolean;
  124149. /**
  124150. * Defines the rate of change of heightOffset.
  124151. */
  124152. heightSensibility: number;
  124153. /**
  124154. * Defines the rate of change of rotationOffset.
  124155. */
  124156. rotationSensibility: number;
  124157. /**
  124158. * Defines the rate of change of radius.
  124159. */
  124160. radiusSensibility: number;
  124161. private _keys;
  124162. private _ctrlPressed;
  124163. private _altPressed;
  124164. private _shiftPressed;
  124165. private _onCanvasBlurObserver;
  124166. private _onKeyboardObserver;
  124167. private _engine;
  124168. private _scene;
  124169. /**
  124170. * Attach the input controls to a specific dom element to get the input from.
  124171. * @param element Defines the element the controls should be listened from
  124172. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  124173. */
  124174. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  124175. /**
  124176. * Detach the current controls from the specified dom element.
  124177. * @param element Defines the element to stop listening the inputs from
  124178. */
  124179. detachControl(element: Nullable<HTMLElement>): void;
  124180. /**
  124181. * Update the current camera state depending on the inputs that have been used this frame.
  124182. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  124183. */
  124184. checkInputs(): void;
  124185. /**
  124186. * Gets the class name of the current input.
  124187. * @returns the class name
  124188. */
  124189. getClassName(): string;
  124190. /**
  124191. * Get the friendly name associated with the input class.
  124192. * @returns the input friendly name
  124193. */
  124194. getSimpleName(): string;
  124195. /**
  124196. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  124197. * allow modification of the heightOffset value.
  124198. */
  124199. private _modifierHeightOffset;
  124200. /**
  124201. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  124202. * allow modification of the rotationOffset value.
  124203. */
  124204. private _modifierRotationOffset;
  124205. /**
  124206. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  124207. * allow modification of the radius value.
  124208. */
  124209. private _modifierRadius;
  124210. }
  124211. }
  124212. declare module BABYLON {
  124213. interface FreeCameraInputsManager {
  124214. /**
  124215. * @hidden
  124216. */
  124217. _deviceOrientationInput: Nullable<FreeCameraDeviceOrientationInput>;
  124218. /**
  124219. * Add orientation input support to the input manager.
  124220. * @returns the current input manager
  124221. */
  124222. addDeviceOrientation(): FreeCameraInputsManager;
  124223. }
  124224. /**
  124225. * Takes information about the orientation of the device as reported by the deviceorientation event to orient the camera.
  124226. * Screen rotation is taken into account.
  124227. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  124228. */
  124229. export class FreeCameraDeviceOrientationInput implements ICameraInput<FreeCamera> {
  124230. private _camera;
  124231. private _screenOrientationAngle;
  124232. private _constantTranform;
  124233. private _screenQuaternion;
  124234. private _alpha;
  124235. private _beta;
  124236. private _gamma;
  124237. /**
  124238. * Can be used to detect if a device orientation sensor is available on a device
  124239. * @param timeout amount of time in milliseconds to wait for a response from the sensor (default: infinite)
  124240. * @returns a promise that will resolve on orientation change
  124241. */
  124242. static WaitForOrientationChangeAsync(timeout?: number): Promise<unknown>;
  124243. /**
  124244. * @hidden
  124245. */
  124246. _onDeviceOrientationChangedObservable: Observable<void>;
  124247. /**
  124248. * Instantiates a new input
  124249. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  124250. */
  124251. constructor();
  124252. /**
  124253. * Define the camera controlled by the input.
  124254. */
  124255. get camera(): FreeCamera;
  124256. set camera(camera: FreeCamera);
  124257. /**
  124258. * Attach the input controls to a specific dom element to get the input from.
  124259. * @param element Defines the element the controls should be listened from
  124260. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  124261. */
  124262. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  124263. private _orientationChanged;
  124264. private _deviceOrientation;
  124265. /**
  124266. * Detach the current controls from the specified dom element.
  124267. * @param element Defines the element to stop listening the inputs from
  124268. */
  124269. detachControl(element: Nullable<HTMLElement>): void;
  124270. /**
  124271. * Update the current camera state depending on the inputs that have been used this frame.
  124272. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  124273. */
  124274. checkInputs(): void;
  124275. /**
  124276. * Gets the class name of the current intput.
  124277. * @returns the class name
  124278. */
  124279. getClassName(): string;
  124280. /**
  124281. * Get the friendly name associated with the input class.
  124282. * @returns the input friendly name
  124283. */
  124284. getSimpleName(): string;
  124285. }
  124286. }
  124287. declare module BABYLON {
  124288. /**
  124289. * Manage the gamepad inputs to control a free camera.
  124290. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  124291. */
  124292. export class FreeCameraGamepadInput implements ICameraInput<FreeCamera> {
  124293. /**
  124294. * Define the camera the input is attached to.
  124295. */
  124296. camera: FreeCamera;
  124297. /**
  124298. * Define the Gamepad controlling the input
  124299. */
  124300. gamepad: Nullable<Gamepad>;
  124301. /**
  124302. * Defines the gamepad rotation sensiblity.
  124303. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  124304. */
  124305. gamepadAngularSensibility: number;
  124306. /**
  124307. * Defines the gamepad move sensiblity.
  124308. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  124309. */
  124310. gamepadMoveSensibility: number;
  124311. private _yAxisScale;
  124312. /**
  124313. * Gets or sets a boolean indicating that Yaxis (for right stick) should be inverted
  124314. */
  124315. get invertYAxis(): boolean;
  124316. set invertYAxis(value: boolean);
  124317. private _onGamepadConnectedObserver;
  124318. private _onGamepadDisconnectedObserver;
  124319. private _cameraTransform;
  124320. private _deltaTransform;
  124321. private _vector3;
  124322. private _vector2;
  124323. /**
  124324. * Attach the input controls to a specific dom element to get the input from.
  124325. * @param element Defines the element the controls should be listened from
  124326. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  124327. */
  124328. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  124329. /**
  124330. * Detach the current controls from the specified dom element.
  124331. * @param element Defines the element to stop listening the inputs from
  124332. */
  124333. detachControl(element: Nullable<HTMLElement>): void;
  124334. /**
  124335. * Update the current camera state depending on the inputs that have been used this frame.
  124336. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  124337. */
  124338. checkInputs(): void;
  124339. /**
  124340. * Gets the class name of the current intput.
  124341. * @returns the class name
  124342. */
  124343. getClassName(): string;
  124344. /**
  124345. * Get the friendly name associated with the input class.
  124346. * @returns the input friendly name
  124347. */
  124348. getSimpleName(): string;
  124349. }
  124350. }
  124351. declare module BABYLON {
  124352. /**
  124353. * Defines the potential axis of a Joystick
  124354. */
  124355. export enum JoystickAxis {
  124356. /** X axis */
  124357. X = 0,
  124358. /** Y axis */
  124359. Y = 1,
  124360. /** Z axis */
  124361. Z = 2
  124362. }
  124363. /**
  124364. * Represents the different customization options available
  124365. * for VirtualJoystick
  124366. */
  124367. interface VirtualJoystickCustomizations {
  124368. /**
  124369. * Size of the joystick's puck
  124370. */
  124371. puckSize: number;
  124372. /**
  124373. * Size of the joystick's container
  124374. */
  124375. containerSize: number;
  124376. /**
  124377. * Color of the joystick && puck
  124378. */
  124379. color: string;
  124380. /**
  124381. * Image URL for the joystick's puck
  124382. */
  124383. puckImage?: string;
  124384. /**
  124385. * Image URL for the joystick's container
  124386. */
  124387. containerImage?: string;
  124388. /**
  124389. * Defines the unmoving position of the joystick container
  124390. */
  124391. position?: {
  124392. x: number;
  124393. y: number;
  124394. };
  124395. /**
  124396. * Defines whether or not the joystick container is always visible
  124397. */
  124398. alwaysVisible: boolean;
  124399. /**
  124400. * Defines whether or not to limit the movement of the puck to the joystick's container
  124401. */
  124402. limitToContainer: boolean;
  124403. }
  124404. /**
  124405. * Class used to define virtual joystick (used in touch mode)
  124406. */
  124407. export class VirtualJoystick {
  124408. /**
  124409. * Gets or sets a boolean indicating that left and right values must be inverted
  124410. */
  124411. reverseLeftRight: boolean;
  124412. /**
  124413. * Gets or sets a boolean indicating that up and down values must be inverted
  124414. */
  124415. reverseUpDown: boolean;
  124416. /**
  124417. * Gets the offset value for the position (ie. the change of the position value)
  124418. */
  124419. deltaPosition: Vector3;
  124420. /**
  124421. * Gets a boolean indicating if the virtual joystick was pressed
  124422. */
  124423. pressed: boolean;
  124424. /**
  124425. * Canvas the virtual joystick will render onto, default z-index of this is 5
  124426. */
  124427. static Canvas: Nullable<HTMLCanvasElement>;
  124428. /**
  124429. * boolean indicating whether or not the joystick's puck's movement should be limited to the joystick's container area
  124430. */
  124431. limitToContainer: boolean;
  124432. private static _globalJoystickIndex;
  124433. private static _alwaysVisibleSticks;
  124434. private static vjCanvasContext;
  124435. private static vjCanvasWidth;
  124436. private static vjCanvasHeight;
  124437. private static halfWidth;
  124438. private static _GetDefaultOptions;
  124439. private _action;
  124440. private _axisTargetedByLeftAndRight;
  124441. private _axisTargetedByUpAndDown;
  124442. private _joystickSensibility;
  124443. private _inversedSensibility;
  124444. private _joystickPointerID;
  124445. private _joystickColor;
  124446. private _joystickPointerPos;
  124447. private _joystickPreviousPointerPos;
  124448. private _joystickPointerStartPos;
  124449. private _deltaJoystickVector;
  124450. private _leftJoystick;
  124451. private _touches;
  124452. private _joystickPosition;
  124453. private _alwaysVisible;
  124454. private _puckImage;
  124455. private _containerImage;
  124456. private _joystickPuckSize;
  124457. private _joystickContainerSize;
  124458. private _clearPuckSize;
  124459. private _clearContainerSize;
  124460. private _clearPuckSizeOffset;
  124461. private _clearContainerSizeOffset;
  124462. private _onPointerDownHandlerRef;
  124463. private _onPointerMoveHandlerRef;
  124464. private _onPointerUpHandlerRef;
  124465. private _onResize;
  124466. /**
  124467. * Creates a new virtual joystick
  124468. * @param leftJoystick defines that the joystick is for left hand (false by default)
  124469. * @param customizations Defines the options we want to customize the VirtualJoystick
  124470. */
  124471. constructor(leftJoystick?: boolean, customizations?: Partial<VirtualJoystickCustomizations>);
  124472. /**
  124473. * Defines joystick sensibility (ie. the ratio beteen a physical move and virtual joystick position change)
  124474. * @param newJoystickSensibility defines the new sensibility
  124475. */
  124476. setJoystickSensibility(newJoystickSensibility: number): void;
  124477. private _onPointerDown;
  124478. private _onPointerMove;
  124479. private _onPointerUp;
  124480. /**
  124481. * Change the color of the virtual joystick
  124482. * @param newColor a string that must be a CSS color value (like "red") or the hexa value (like "#FF0000")
  124483. */
  124484. setJoystickColor(newColor: string): void;
  124485. /**
  124486. * Size of the joystick's container
  124487. */
  124488. set containerSize(newSize: number);
  124489. get containerSize(): number;
  124490. /**
  124491. * Size of the joystick's puck
  124492. */
  124493. set puckSize(newSize: number);
  124494. get puckSize(): number;
  124495. /**
  124496. * Clears the set position of the joystick
  124497. */
  124498. clearPosition(): void;
  124499. /**
  124500. * Defines whether or not the joystick container is always visible
  124501. */
  124502. set alwaysVisible(value: boolean);
  124503. get alwaysVisible(): boolean;
  124504. /**
  124505. * Sets the constant position of the Joystick container
  124506. * @param x X axis coordinate
  124507. * @param y Y axis coordinate
  124508. */
  124509. setPosition(x: number, y: number): void;
  124510. /**
  124511. * Defines a callback to call when the joystick is touched
  124512. * @param action defines the callback
  124513. */
  124514. setActionOnTouch(action: () => any): void;
  124515. /**
  124516. * Defines which axis you'd like to control for left & right
  124517. * @param axis defines the axis to use
  124518. */
  124519. setAxisForLeftRight(axis: JoystickAxis): void;
  124520. /**
  124521. * Defines which axis you'd like to control for up & down
  124522. * @param axis defines the axis to use
  124523. */
  124524. setAxisForUpDown(axis: JoystickAxis): void;
  124525. /**
  124526. * Clears the canvas from the previous puck / container draw
  124527. */
  124528. private _clearPreviousDraw;
  124529. /**
  124530. * Loads `urlPath` to be used for the container's image
  124531. * @param urlPath defines the urlPath of an image to use
  124532. */
  124533. setContainerImage(urlPath: string): void;
  124534. /**
  124535. * Loads `urlPath` to be used for the puck's image
  124536. * @param urlPath defines the urlPath of an image to use
  124537. */
  124538. setPuckImage(urlPath: string): void;
  124539. /**
  124540. * Draws the Virtual Joystick's container
  124541. */
  124542. private _drawContainer;
  124543. /**
  124544. * Draws the Virtual Joystick's puck
  124545. */
  124546. private _drawPuck;
  124547. private _drawVirtualJoystick;
  124548. /**
  124549. * Release internal HTML canvas
  124550. */
  124551. releaseCanvas(): void;
  124552. }
  124553. }
  124554. declare module BABYLON {
  124555. interface FreeCameraInputsManager {
  124556. /**
  124557. * Add virtual joystick input support to the input manager.
  124558. * @returns the current input manager
  124559. */
  124560. addVirtualJoystick(): FreeCameraInputsManager;
  124561. }
  124562. /**
  124563. * Manage the Virtual Joystick inputs to control the movement of a free camera.
  124564. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  124565. */
  124566. export class FreeCameraVirtualJoystickInput implements ICameraInput<FreeCamera> {
  124567. /**
  124568. * Defines the camera the input is attached to.
  124569. */
  124570. camera: FreeCamera;
  124571. private _leftjoystick;
  124572. private _rightjoystick;
  124573. /**
  124574. * Gets the left stick of the virtual joystick.
  124575. * @returns The virtual Joystick
  124576. */
  124577. getLeftJoystick(): VirtualJoystick;
  124578. /**
  124579. * Gets the right stick of the virtual joystick.
  124580. * @returns The virtual Joystick
  124581. */
  124582. getRightJoystick(): VirtualJoystick;
  124583. /**
  124584. * Update the current camera state depending on the inputs that have been used this frame.
  124585. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  124586. */
  124587. checkInputs(): void;
  124588. /**
  124589. * Attach the input controls to a specific dom element to get the input from.
  124590. * @param element Defines the element the controls should be listened from
  124591. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  124592. */
  124593. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  124594. /**
  124595. * Detach the current controls from the specified dom element.
  124596. * @param element Defines the element to stop listening the inputs from
  124597. */
  124598. detachControl(element: Nullable<HTMLElement>): void;
  124599. /**
  124600. * Gets the class name of the current intput.
  124601. * @returns the class name
  124602. */
  124603. getClassName(): string;
  124604. /**
  124605. * Get the friendly name associated with the input class.
  124606. * @returns the input friendly name
  124607. */
  124608. getSimpleName(): string;
  124609. }
  124610. }
  124611. declare module BABYLON {
  124612. /**
  124613. * This represents a FPS type of camera controlled by touch.
  124614. * This is like a universal camera minus the Gamepad controls.
  124615. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  124616. */
  124617. export class TouchCamera extends FreeCamera {
  124618. /**
  124619. * Defines the touch sensibility for rotation.
  124620. * The higher the faster.
  124621. */
  124622. get touchAngularSensibility(): number;
  124623. set touchAngularSensibility(value: number);
  124624. /**
  124625. * Defines the touch sensibility for move.
  124626. * The higher the faster.
  124627. */
  124628. get touchMoveSensibility(): number;
  124629. set touchMoveSensibility(value: number);
  124630. /**
  124631. * Instantiates a new touch camera.
  124632. * This represents a FPS type of camera controlled by touch.
  124633. * This is like a universal camera minus the Gamepad controls.
  124634. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  124635. * @param name Define the name of the camera in the scene
  124636. * @param position Define the start position of the camera in the scene
  124637. * @param scene Define the scene the camera belongs to
  124638. */
  124639. constructor(name: string, position: Vector3, scene: Scene);
  124640. /**
  124641. * Gets the current object class name.
  124642. * @return the class name
  124643. */
  124644. getClassName(): string;
  124645. /** @hidden */
  124646. _setupInputs(): void;
  124647. }
  124648. }
  124649. declare module BABYLON {
  124650. /**
  124651. * This is a camera specifically designed to react to device orientation events such as a modern mobile device
  124652. * being tilted forward or back and left or right.
  124653. */
  124654. export class DeviceOrientationCamera extends FreeCamera {
  124655. private _initialQuaternion;
  124656. private _quaternionCache;
  124657. private _tmpDragQuaternion;
  124658. private _disablePointerInputWhenUsingDeviceOrientation;
  124659. /**
  124660. * Creates a new device orientation camera
  124661. * @param name The name of the camera
  124662. * @param position The start position camera
  124663. * @param scene The scene the camera belongs to
  124664. */
  124665. constructor(name: string, position: Vector3, scene: Scene);
  124666. /**
  124667. * Gets or sets a boolean indicating that pointer input must be disabled on first orientation sensor update (Default: true)
  124668. */
  124669. get disablePointerInputWhenUsingDeviceOrientation(): boolean;
  124670. set disablePointerInputWhenUsingDeviceOrientation(value: boolean);
  124671. private _dragFactor;
  124672. /**
  124673. * Enabled turning on the y axis when the orientation sensor is active
  124674. * @param dragFactor the factor that controls the turn speed (default: 1/300)
  124675. */
  124676. enableHorizontalDragging(dragFactor?: number): void;
  124677. /**
  124678. * Gets the current instance class name ("DeviceOrientationCamera").
  124679. * This helps avoiding instanceof at run time.
  124680. * @returns the class name
  124681. */
  124682. getClassName(): string;
  124683. /**
  124684. * @hidden
  124685. * Checks and applies the current values of the inputs to the camera. (Internal use only)
  124686. */
  124687. _checkInputs(): void;
  124688. /**
  124689. * Reset the camera to its default orientation on the specified axis only.
  124690. * @param axis The axis to reset
  124691. */
  124692. resetToCurrentRotation(axis?: Axis): void;
  124693. }
  124694. }
  124695. declare module BABYLON {
  124696. /**
  124697. * Defines supported buttons for XBox360 compatible gamepads
  124698. */
  124699. export enum Xbox360Button {
  124700. /** A */
  124701. A = 0,
  124702. /** B */
  124703. B = 1,
  124704. /** X */
  124705. X = 2,
  124706. /** Y */
  124707. Y = 3,
  124708. /** Left button */
  124709. LB = 4,
  124710. /** Right button */
  124711. RB = 5,
  124712. /** Back */
  124713. Back = 8,
  124714. /** Start */
  124715. Start = 9,
  124716. /** Left stick */
  124717. LeftStick = 10,
  124718. /** Right stick */
  124719. RightStick = 11
  124720. }
  124721. /** Defines values for XBox360 DPad */
  124722. export enum Xbox360Dpad {
  124723. /** Up */
  124724. Up = 12,
  124725. /** Down */
  124726. Down = 13,
  124727. /** Left */
  124728. Left = 14,
  124729. /** Right */
  124730. Right = 15
  124731. }
  124732. /**
  124733. * Defines a XBox360 gamepad
  124734. */
  124735. export class Xbox360Pad extends Gamepad {
  124736. private _leftTrigger;
  124737. private _rightTrigger;
  124738. private _onlefttriggerchanged;
  124739. private _onrighttriggerchanged;
  124740. private _onbuttondown;
  124741. private _onbuttonup;
  124742. private _ondpaddown;
  124743. private _ondpadup;
  124744. /** Observable raised when a button is pressed */
  124745. onButtonDownObservable: Observable<Xbox360Button>;
  124746. /** Observable raised when a button is released */
  124747. onButtonUpObservable: Observable<Xbox360Button>;
  124748. /** Observable raised when a pad is pressed */
  124749. onPadDownObservable: Observable<Xbox360Dpad>;
  124750. /** Observable raised when a pad is released */
  124751. onPadUpObservable: Observable<Xbox360Dpad>;
  124752. private _buttonA;
  124753. private _buttonB;
  124754. private _buttonX;
  124755. private _buttonY;
  124756. private _buttonBack;
  124757. private _buttonStart;
  124758. private _buttonLB;
  124759. private _buttonRB;
  124760. private _buttonLeftStick;
  124761. private _buttonRightStick;
  124762. private _dPadUp;
  124763. private _dPadDown;
  124764. private _dPadLeft;
  124765. private _dPadRight;
  124766. private _isXboxOnePad;
  124767. /**
  124768. * Creates a new XBox360 gamepad object
  124769. * @param id defines the id of this gamepad
  124770. * @param index defines its index
  124771. * @param gamepad defines the internal HTML gamepad object
  124772. * @param xboxOne defines if it is a XBox One gamepad
  124773. */
  124774. constructor(id: string, index: number, gamepad: any, xboxOne?: boolean);
  124775. /**
  124776. * Defines the callback to call when left trigger is pressed
  124777. * @param callback defines the callback to use
  124778. */
  124779. onlefttriggerchanged(callback: (value: number) => void): void;
  124780. /**
  124781. * Defines the callback to call when right trigger is pressed
  124782. * @param callback defines the callback to use
  124783. */
  124784. onrighttriggerchanged(callback: (value: number) => void): void;
  124785. /**
  124786. * Gets the left trigger value
  124787. */
  124788. get leftTrigger(): number;
  124789. /**
  124790. * Sets the left trigger value
  124791. */
  124792. set leftTrigger(newValue: number);
  124793. /**
  124794. * Gets the right trigger value
  124795. */
  124796. get rightTrigger(): number;
  124797. /**
  124798. * Sets the right trigger value
  124799. */
  124800. set rightTrigger(newValue: number);
  124801. /**
  124802. * Defines the callback to call when a button is pressed
  124803. * @param callback defines the callback to use
  124804. */
  124805. onbuttondown(callback: (buttonPressed: Xbox360Button) => void): void;
  124806. /**
  124807. * Defines the callback to call when a button is released
  124808. * @param callback defines the callback to use
  124809. */
  124810. onbuttonup(callback: (buttonReleased: Xbox360Button) => void): void;
  124811. /**
  124812. * Defines the callback to call when a pad is pressed
  124813. * @param callback defines the callback to use
  124814. */
  124815. ondpaddown(callback: (dPadPressed: Xbox360Dpad) => void): void;
  124816. /**
  124817. * Defines the callback to call when a pad is released
  124818. * @param callback defines the callback to use
  124819. */
  124820. ondpadup(callback: (dPadReleased: Xbox360Dpad) => void): void;
  124821. private _setButtonValue;
  124822. private _setDPadValue;
  124823. /**
  124824. * Gets the value of the `A` button
  124825. */
  124826. get buttonA(): number;
  124827. /**
  124828. * Sets the value of the `A` button
  124829. */
  124830. set buttonA(value: number);
  124831. /**
  124832. * Gets the value of the `B` button
  124833. */
  124834. get buttonB(): number;
  124835. /**
  124836. * Sets the value of the `B` button
  124837. */
  124838. set buttonB(value: number);
  124839. /**
  124840. * Gets the value of the `X` button
  124841. */
  124842. get buttonX(): number;
  124843. /**
  124844. * Sets the value of the `X` button
  124845. */
  124846. set buttonX(value: number);
  124847. /**
  124848. * Gets the value of the `Y` button
  124849. */
  124850. get buttonY(): number;
  124851. /**
  124852. * Sets the value of the `Y` button
  124853. */
  124854. set buttonY(value: number);
  124855. /**
  124856. * Gets the value of the `Start` button
  124857. */
  124858. get buttonStart(): number;
  124859. /**
  124860. * Sets the value of the `Start` button
  124861. */
  124862. set buttonStart(value: number);
  124863. /**
  124864. * Gets the value of the `Back` button
  124865. */
  124866. get buttonBack(): number;
  124867. /**
  124868. * Sets the value of the `Back` button
  124869. */
  124870. set buttonBack(value: number);
  124871. /**
  124872. * Gets the value of the `Left` button
  124873. */
  124874. get buttonLB(): number;
  124875. /**
  124876. * Sets the value of the `Left` button
  124877. */
  124878. set buttonLB(value: number);
  124879. /**
  124880. * Gets the value of the `Right` button
  124881. */
  124882. get buttonRB(): number;
  124883. /**
  124884. * Sets the value of the `Right` button
  124885. */
  124886. set buttonRB(value: number);
  124887. /**
  124888. * Gets the value of the Left joystick
  124889. */
  124890. get buttonLeftStick(): number;
  124891. /**
  124892. * Sets the value of the Left joystick
  124893. */
  124894. set buttonLeftStick(value: number);
  124895. /**
  124896. * Gets the value of the Right joystick
  124897. */
  124898. get buttonRightStick(): number;
  124899. /**
  124900. * Sets the value of the Right joystick
  124901. */
  124902. set buttonRightStick(value: number);
  124903. /**
  124904. * Gets the value of D-pad up
  124905. */
  124906. get dPadUp(): number;
  124907. /**
  124908. * Sets the value of D-pad up
  124909. */
  124910. set dPadUp(value: number);
  124911. /**
  124912. * Gets the value of D-pad down
  124913. */
  124914. get dPadDown(): number;
  124915. /**
  124916. * Sets the value of D-pad down
  124917. */
  124918. set dPadDown(value: number);
  124919. /**
  124920. * Gets the value of D-pad left
  124921. */
  124922. get dPadLeft(): number;
  124923. /**
  124924. * Sets the value of D-pad left
  124925. */
  124926. set dPadLeft(value: number);
  124927. /**
  124928. * Gets the value of D-pad right
  124929. */
  124930. get dPadRight(): number;
  124931. /**
  124932. * Sets the value of D-pad right
  124933. */
  124934. set dPadRight(value: number);
  124935. /**
  124936. * Force the gamepad to synchronize with device values
  124937. */
  124938. update(): void;
  124939. /**
  124940. * Disposes the gamepad
  124941. */
  124942. dispose(): void;
  124943. }
  124944. }
  124945. declare module BABYLON {
  124946. /**
  124947. * Defines supported buttons for DualShock compatible gamepads
  124948. */
  124949. export enum DualShockButton {
  124950. /** Cross */
  124951. Cross = 0,
  124952. /** Circle */
  124953. Circle = 1,
  124954. /** Square */
  124955. Square = 2,
  124956. /** Triangle */
  124957. Triangle = 3,
  124958. /** L1 */
  124959. L1 = 4,
  124960. /** R1 */
  124961. R1 = 5,
  124962. /** Share */
  124963. Share = 8,
  124964. /** Options */
  124965. Options = 9,
  124966. /** Left stick */
  124967. LeftStick = 10,
  124968. /** Right stick */
  124969. RightStick = 11
  124970. }
  124971. /** Defines values for DualShock DPad */
  124972. export enum DualShockDpad {
  124973. /** Up */
  124974. Up = 12,
  124975. /** Down */
  124976. Down = 13,
  124977. /** Left */
  124978. Left = 14,
  124979. /** Right */
  124980. Right = 15
  124981. }
  124982. /**
  124983. * Defines a DualShock gamepad
  124984. */
  124985. export class DualShockPad extends Gamepad {
  124986. private _leftTrigger;
  124987. private _rightTrigger;
  124988. private _onlefttriggerchanged;
  124989. private _onrighttriggerchanged;
  124990. private _onbuttondown;
  124991. private _onbuttonup;
  124992. private _ondpaddown;
  124993. private _ondpadup;
  124994. /** Observable raised when a button is pressed */
  124995. onButtonDownObservable: Observable<DualShockButton>;
  124996. /** Observable raised when a button is released */
  124997. onButtonUpObservable: Observable<DualShockButton>;
  124998. /** Observable raised when a pad is pressed */
  124999. onPadDownObservable: Observable<DualShockDpad>;
  125000. /** Observable raised when a pad is released */
  125001. onPadUpObservable: Observable<DualShockDpad>;
  125002. private _buttonCross;
  125003. private _buttonCircle;
  125004. private _buttonSquare;
  125005. private _buttonTriangle;
  125006. private _buttonShare;
  125007. private _buttonOptions;
  125008. private _buttonL1;
  125009. private _buttonR1;
  125010. private _buttonLeftStick;
  125011. private _buttonRightStick;
  125012. private _dPadUp;
  125013. private _dPadDown;
  125014. private _dPadLeft;
  125015. private _dPadRight;
  125016. /**
  125017. * Creates a new DualShock gamepad object
  125018. * @param id defines the id of this gamepad
  125019. * @param index defines its index
  125020. * @param gamepad defines the internal HTML gamepad object
  125021. */
  125022. constructor(id: string, index: number, gamepad: any);
  125023. /**
  125024. * Defines the callback to call when left trigger is pressed
  125025. * @param callback defines the callback to use
  125026. */
  125027. onlefttriggerchanged(callback: (value: number) => void): void;
  125028. /**
  125029. * Defines the callback to call when right trigger is pressed
  125030. * @param callback defines the callback to use
  125031. */
  125032. onrighttriggerchanged(callback: (value: number) => void): void;
  125033. /**
  125034. * Gets the left trigger value
  125035. */
  125036. get leftTrigger(): number;
  125037. /**
  125038. * Sets the left trigger value
  125039. */
  125040. set leftTrigger(newValue: number);
  125041. /**
  125042. * Gets the right trigger value
  125043. */
  125044. get rightTrigger(): number;
  125045. /**
  125046. * Sets the right trigger value
  125047. */
  125048. set rightTrigger(newValue: number);
  125049. /**
  125050. * Defines the callback to call when a button is pressed
  125051. * @param callback defines the callback to use
  125052. */
  125053. onbuttondown(callback: (buttonPressed: DualShockButton) => void): void;
  125054. /**
  125055. * Defines the callback to call when a button is released
  125056. * @param callback defines the callback to use
  125057. */
  125058. onbuttonup(callback: (buttonReleased: DualShockButton) => void): void;
  125059. /**
  125060. * Defines the callback to call when a pad is pressed
  125061. * @param callback defines the callback to use
  125062. */
  125063. ondpaddown(callback: (dPadPressed: DualShockDpad) => void): void;
  125064. /**
  125065. * Defines the callback to call when a pad is released
  125066. * @param callback defines the callback to use
  125067. */
  125068. ondpadup(callback: (dPadReleased: DualShockDpad) => void): void;
  125069. private _setButtonValue;
  125070. private _setDPadValue;
  125071. /**
  125072. * Gets the value of the `Cross` button
  125073. */
  125074. get buttonCross(): number;
  125075. /**
  125076. * Sets the value of the `Cross` button
  125077. */
  125078. set buttonCross(value: number);
  125079. /**
  125080. * Gets the value of the `Circle` button
  125081. */
  125082. get buttonCircle(): number;
  125083. /**
  125084. * Sets the value of the `Circle` button
  125085. */
  125086. set buttonCircle(value: number);
  125087. /**
  125088. * Gets the value of the `Square` button
  125089. */
  125090. get buttonSquare(): number;
  125091. /**
  125092. * Sets the value of the `Square` button
  125093. */
  125094. set buttonSquare(value: number);
  125095. /**
  125096. * Gets the value of the `Triangle` button
  125097. */
  125098. get buttonTriangle(): number;
  125099. /**
  125100. * Sets the value of the `Triangle` button
  125101. */
  125102. set buttonTriangle(value: number);
  125103. /**
  125104. * Gets the value of the `Options` button
  125105. */
  125106. get buttonOptions(): number;
  125107. /**
  125108. * Sets the value of the `Options` button
  125109. */
  125110. set buttonOptions(value: number);
  125111. /**
  125112. * Gets the value of the `Share` button
  125113. */
  125114. get buttonShare(): number;
  125115. /**
  125116. * Sets the value of the `Share` button
  125117. */
  125118. set buttonShare(value: number);
  125119. /**
  125120. * Gets the value of the `L1` button
  125121. */
  125122. get buttonL1(): number;
  125123. /**
  125124. * Sets the value of the `L1` button
  125125. */
  125126. set buttonL1(value: number);
  125127. /**
  125128. * Gets the value of the `R1` button
  125129. */
  125130. get buttonR1(): number;
  125131. /**
  125132. * Sets the value of the `R1` button
  125133. */
  125134. set buttonR1(value: number);
  125135. /**
  125136. * Gets the value of the Left joystick
  125137. */
  125138. get buttonLeftStick(): number;
  125139. /**
  125140. * Sets the value of the Left joystick
  125141. */
  125142. set buttonLeftStick(value: number);
  125143. /**
  125144. * Gets the value of the Right joystick
  125145. */
  125146. get buttonRightStick(): number;
  125147. /**
  125148. * Sets the value of the Right joystick
  125149. */
  125150. set buttonRightStick(value: number);
  125151. /**
  125152. * Gets the value of D-pad up
  125153. */
  125154. get dPadUp(): number;
  125155. /**
  125156. * Sets the value of D-pad up
  125157. */
  125158. set dPadUp(value: number);
  125159. /**
  125160. * Gets the value of D-pad down
  125161. */
  125162. get dPadDown(): number;
  125163. /**
  125164. * Sets the value of D-pad down
  125165. */
  125166. set dPadDown(value: number);
  125167. /**
  125168. * Gets the value of D-pad left
  125169. */
  125170. get dPadLeft(): number;
  125171. /**
  125172. * Sets the value of D-pad left
  125173. */
  125174. set dPadLeft(value: number);
  125175. /**
  125176. * Gets the value of D-pad right
  125177. */
  125178. get dPadRight(): number;
  125179. /**
  125180. * Sets the value of D-pad right
  125181. */
  125182. set dPadRight(value: number);
  125183. /**
  125184. * Force the gamepad to synchronize with device values
  125185. */
  125186. update(): void;
  125187. /**
  125188. * Disposes the gamepad
  125189. */
  125190. dispose(): void;
  125191. }
  125192. }
  125193. declare module BABYLON {
  125194. /**
  125195. * Manager for handling gamepads
  125196. */
  125197. export class GamepadManager {
  125198. private _scene?;
  125199. private _babylonGamepads;
  125200. private _oneGamepadConnected;
  125201. /** @hidden */
  125202. _isMonitoring: boolean;
  125203. private _gamepadEventSupported;
  125204. private _gamepadSupport?;
  125205. /**
  125206. * observable to be triggered when the gamepad controller has been connected
  125207. */
  125208. onGamepadConnectedObservable: Observable<Gamepad>;
  125209. /**
  125210. * observable to be triggered when the gamepad controller has been disconnected
  125211. */
  125212. onGamepadDisconnectedObservable: Observable<Gamepad>;
  125213. private _onGamepadConnectedEvent;
  125214. private _onGamepadDisconnectedEvent;
  125215. /**
  125216. * Initializes the gamepad manager
  125217. * @param _scene BabylonJS scene
  125218. */
  125219. constructor(_scene?: Scene | undefined);
  125220. /**
  125221. * The gamepads in the game pad manager
  125222. */
  125223. get gamepads(): Gamepad[];
  125224. /**
  125225. * Get the gamepad controllers based on type
  125226. * @param type The type of gamepad controller
  125227. * @returns Nullable gamepad
  125228. */
  125229. getGamepadByType(type?: number): Nullable<Gamepad>;
  125230. /**
  125231. * Disposes the gamepad manager
  125232. */
  125233. dispose(): void;
  125234. private _addNewGamepad;
  125235. private _startMonitoringGamepads;
  125236. private _stopMonitoringGamepads;
  125237. /** @hidden */
  125238. _checkGamepadsStatus(): void;
  125239. private _updateGamepadObjects;
  125240. }
  125241. }
  125242. declare module BABYLON {
  125243. interface Scene {
  125244. /** @hidden */
  125245. _gamepadManager: Nullable<GamepadManager>;
  125246. /**
  125247. * Gets the gamepad manager associated with the scene
  125248. * @see https://doc.babylonjs.com/how_to/how_to_use_gamepads
  125249. */
  125250. gamepadManager: GamepadManager;
  125251. }
  125252. /**
  125253. * Interface representing a free camera inputs manager
  125254. */
  125255. interface FreeCameraInputsManager {
  125256. /**
  125257. * Adds gamepad input support to the FreeCameraInputsManager.
  125258. * @returns the FreeCameraInputsManager
  125259. */
  125260. addGamepad(): FreeCameraInputsManager;
  125261. }
  125262. /**
  125263. * Interface representing an arc rotate camera inputs manager
  125264. */
  125265. interface ArcRotateCameraInputsManager {
  125266. /**
  125267. * Adds gamepad input support to the ArcRotateCamera InputManager.
  125268. * @returns the camera inputs manager
  125269. */
  125270. addGamepad(): ArcRotateCameraInputsManager;
  125271. }
  125272. /**
  125273. * Defines the gamepad scene component responsible to manage gamepads in a given scene
  125274. */
  125275. export class GamepadSystemSceneComponent implements ISceneComponent {
  125276. /**
  125277. * The component name helpfull to identify the component in the list of scene components.
  125278. */
  125279. readonly name: string;
  125280. /**
  125281. * The scene the component belongs to.
  125282. */
  125283. scene: Scene;
  125284. /**
  125285. * Creates a new instance of the component for the given scene
  125286. * @param scene Defines the scene to register the component in
  125287. */
  125288. constructor(scene: Scene);
  125289. /**
  125290. * Registers the component in a given scene
  125291. */
  125292. register(): void;
  125293. /**
  125294. * Rebuilds the elements related to this component in case of
  125295. * context lost for instance.
  125296. */
  125297. rebuild(): void;
  125298. /**
  125299. * Disposes the component and the associated ressources
  125300. */
  125301. dispose(): void;
  125302. private _beforeCameraUpdate;
  125303. }
  125304. }
  125305. declare module BABYLON {
  125306. /**
  125307. * 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,
  125308. * which still works and will still be found in many Playgrounds.
  125309. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  125310. */
  125311. export class UniversalCamera extends TouchCamera {
  125312. /**
  125313. * Defines the gamepad rotation sensiblity.
  125314. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  125315. */
  125316. get gamepadAngularSensibility(): number;
  125317. set gamepadAngularSensibility(value: number);
  125318. /**
  125319. * Defines the gamepad move sensiblity.
  125320. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  125321. */
  125322. get gamepadMoveSensibility(): number;
  125323. set gamepadMoveSensibility(value: number);
  125324. /**
  125325. * 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,
  125326. * which still works and will still be found in many Playgrounds.
  125327. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  125328. * @param name Define the name of the camera in the scene
  125329. * @param position Define the start position of the camera in the scene
  125330. * @param scene Define the scene the camera belongs to
  125331. */
  125332. constructor(name: string, position: Vector3, scene: Scene);
  125333. /**
  125334. * Gets the current object class name.
  125335. * @return the class name
  125336. */
  125337. getClassName(): string;
  125338. }
  125339. }
  125340. declare module BABYLON {
  125341. /**
  125342. * This represents a FPS type of camera. This is only here for back compat purpose.
  125343. * Please use the UniversalCamera instead as both are identical.
  125344. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  125345. */
  125346. export class GamepadCamera extends UniversalCamera {
  125347. /**
  125348. * Instantiates a new Gamepad Camera
  125349. * This represents a FPS type of camera. This is only here for back compat purpose.
  125350. * Please use the UniversalCamera instead as both are identical.
  125351. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  125352. * @param name Define the name of the camera in the scene
  125353. * @param position Define the start position of the camera in the scene
  125354. * @param scene Define the scene the camera belongs to
  125355. */
  125356. constructor(name: string, position: Vector3, scene: Scene);
  125357. /**
  125358. * Gets the current object class name.
  125359. * @return the class name
  125360. */
  125361. getClassName(): string;
  125362. }
  125363. }
  125364. declare module BABYLON {
  125365. /** @hidden */
  125366. export var passPixelShader: {
  125367. name: string;
  125368. shader: string;
  125369. };
  125370. }
  125371. declare module BABYLON {
  125372. /** @hidden */
  125373. export var passCubePixelShader: {
  125374. name: string;
  125375. shader: string;
  125376. };
  125377. }
  125378. declare module BABYLON {
  125379. /**
  125380. * PassPostProcess which produces an output the same as it's input
  125381. */
  125382. export class PassPostProcess extends PostProcess {
  125383. /**
  125384. * Gets a string identifying the name of the class
  125385. * @returns "PassPostProcess" string
  125386. */
  125387. getClassName(): string;
  125388. /**
  125389. * Creates the PassPostProcess
  125390. * @param name The name of the effect.
  125391. * @param options The required width/height ratio to downsize to before computing the render pass.
  125392. * @param camera The camera to apply the render pass to.
  125393. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  125394. * @param engine The engine which the post process will be applied. (default: current engine)
  125395. * @param reusable If the post process can be reused on the same frame. (default: false)
  125396. * @param textureType The type of texture to be used when performing the post processing.
  125397. * @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)
  125398. */
  125399. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  125400. /** @hidden */
  125401. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): PassPostProcess;
  125402. }
  125403. /**
  125404. * PassCubePostProcess which produces an output the same as it's input (which must be a cube texture)
  125405. */
  125406. export class PassCubePostProcess extends PostProcess {
  125407. private _face;
  125408. /**
  125409. * Gets or sets the cube face to display.
  125410. * * 0 is +X
  125411. * * 1 is -X
  125412. * * 2 is +Y
  125413. * * 3 is -Y
  125414. * * 4 is +Z
  125415. * * 5 is -Z
  125416. */
  125417. get face(): number;
  125418. set face(value: number);
  125419. /**
  125420. * Gets a string identifying the name of the class
  125421. * @returns "PassCubePostProcess" string
  125422. */
  125423. getClassName(): string;
  125424. /**
  125425. * Creates the PassCubePostProcess
  125426. * @param name The name of the effect.
  125427. * @param options The required width/height ratio to downsize to before computing the render pass.
  125428. * @param camera The camera to apply the render pass to.
  125429. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  125430. * @param engine The engine which the post process will be applied. (default: current engine)
  125431. * @param reusable If the post process can be reused on the same frame. (default: false)
  125432. * @param textureType The type of texture to be used when performing the post processing.
  125433. * @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)
  125434. */
  125435. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  125436. /** @hidden */
  125437. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): PassCubePostProcess;
  125438. }
  125439. }
  125440. declare module BABYLON {
  125441. /** @hidden */
  125442. export var anaglyphPixelShader: {
  125443. name: string;
  125444. shader: string;
  125445. };
  125446. }
  125447. declare module BABYLON {
  125448. /**
  125449. * Postprocess used to generate anaglyphic rendering
  125450. */
  125451. export class AnaglyphPostProcess extends PostProcess {
  125452. private _passedProcess;
  125453. /**
  125454. * Gets a string identifying the name of the class
  125455. * @returns "AnaglyphPostProcess" string
  125456. */
  125457. getClassName(): string;
  125458. /**
  125459. * Creates a new AnaglyphPostProcess
  125460. * @param name defines postprocess name
  125461. * @param options defines creation options or target ratio scale
  125462. * @param rigCameras defines cameras using this postprocess
  125463. * @param samplingMode defines required sampling mode (BABYLON.Texture.NEAREST_SAMPLINGMODE by default)
  125464. * @param engine defines hosting engine
  125465. * @param reusable defines if the postprocess will be reused multiple times per frame
  125466. */
  125467. constructor(name: string, options: number | PostProcessOptions, rigCameras: Camera[], samplingMode?: number, engine?: Engine, reusable?: boolean);
  125468. }
  125469. }
  125470. declare module BABYLON {
  125471. /**
  125472. * Camera used to simulate anaglyphic rendering (based on ArcRotateCamera)
  125473. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  125474. */
  125475. export class AnaglyphArcRotateCamera extends ArcRotateCamera {
  125476. /**
  125477. * Creates a new AnaglyphArcRotateCamera
  125478. * @param name defines camera name
  125479. * @param alpha defines alpha angle (in radians)
  125480. * @param beta defines beta angle (in radians)
  125481. * @param radius defines radius
  125482. * @param target defines camera target
  125483. * @param interaxialDistance defines distance between each color axis
  125484. * @param scene defines the hosting scene
  125485. */
  125486. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, interaxialDistance: number, scene: Scene);
  125487. /**
  125488. * Gets camera class name
  125489. * @returns AnaglyphArcRotateCamera
  125490. */
  125491. getClassName(): string;
  125492. }
  125493. }
  125494. declare module BABYLON {
  125495. /**
  125496. * Camera used to simulate anaglyphic rendering (based on FreeCamera)
  125497. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  125498. */
  125499. export class AnaglyphFreeCamera extends FreeCamera {
  125500. /**
  125501. * Creates a new AnaglyphFreeCamera
  125502. * @param name defines camera name
  125503. * @param position defines initial position
  125504. * @param interaxialDistance defines distance between each color axis
  125505. * @param scene defines the hosting scene
  125506. */
  125507. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  125508. /**
  125509. * Gets camera class name
  125510. * @returns AnaglyphFreeCamera
  125511. */
  125512. getClassName(): string;
  125513. }
  125514. }
  125515. declare module BABYLON {
  125516. /**
  125517. * Camera used to simulate anaglyphic rendering (based on GamepadCamera)
  125518. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  125519. */
  125520. export class AnaglyphGamepadCamera extends GamepadCamera {
  125521. /**
  125522. * Creates a new AnaglyphGamepadCamera
  125523. * @param name defines camera name
  125524. * @param position defines initial position
  125525. * @param interaxialDistance defines distance between each color axis
  125526. * @param scene defines the hosting scene
  125527. */
  125528. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  125529. /**
  125530. * Gets camera class name
  125531. * @returns AnaglyphGamepadCamera
  125532. */
  125533. getClassName(): string;
  125534. }
  125535. }
  125536. declare module BABYLON {
  125537. /**
  125538. * Camera used to simulate anaglyphic rendering (based on UniversalCamera)
  125539. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  125540. */
  125541. export class AnaglyphUniversalCamera extends UniversalCamera {
  125542. /**
  125543. * Creates a new AnaglyphUniversalCamera
  125544. * @param name defines camera name
  125545. * @param position defines initial position
  125546. * @param interaxialDistance defines distance between each color axis
  125547. * @param scene defines the hosting scene
  125548. */
  125549. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  125550. /**
  125551. * Gets camera class name
  125552. * @returns AnaglyphUniversalCamera
  125553. */
  125554. getClassName(): string;
  125555. }
  125556. }
  125557. declare module BABYLON {
  125558. /**
  125559. * Camera used to simulate stereoscopic rendering (based on ArcRotateCamera)
  125560. * @see https://doc.babylonjs.com/features/cameras
  125561. */
  125562. export class StereoscopicArcRotateCamera extends ArcRotateCamera {
  125563. /**
  125564. * Creates a new StereoscopicArcRotateCamera
  125565. * @param name defines camera name
  125566. * @param alpha defines alpha angle (in radians)
  125567. * @param beta defines beta angle (in radians)
  125568. * @param radius defines radius
  125569. * @param target defines camera target
  125570. * @param interaxialDistance defines distance between each color axis
  125571. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  125572. * @param scene defines the hosting scene
  125573. */
  125574. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  125575. /**
  125576. * Gets camera class name
  125577. * @returns StereoscopicArcRotateCamera
  125578. */
  125579. getClassName(): string;
  125580. }
  125581. }
  125582. declare module BABYLON {
  125583. /**
  125584. * Camera used to simulate stereoscopic rendering (based on FreeCamera)
  125585. * @see https://doc.babylonjs.com/features/cameras
  125586. */
  125587. export class StereoscopicFreeCamera extends FreeCamera {
  125588. /**
  125589. * Creates a new StereoscopicFreeCamera
  125590. * @param name defines camera name
  125591. * @param position defines initial position
  125592. * @param interaxialDistance defines distance between each color axis
  125593. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  125594. * @param scene defines the hosting scene
  125595. */
  125596. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  125597. /**
  125598. * Gets camera class name
  125599. * @returns StereoscopicFreeCamera
  125600. */
  125601. getClassName(): string;
  125602. }
  125603. }
  125604. declare module BABYLON {
  125605. /**
  125606. * Camera used to simulate stereoscopic rendering (based on GamepadCamera)
  125607. * @see https://doc.babylonjs.com/features/cameras
  125608. */
  125609. export class StereoscopicGamepadCamera extends GamepadCamera {
  125610. /**
  125611. * Creates a new StereoscopicGamepadCamera
  125612. * @param name defines camera name
  125613. * @param position defines initial position
  125614. * @param interaxialDistance defines distance between each color axis
  125615. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  125616. * @param scene defines the hosting scene
  125617. */
  125618. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  125619. /**
  125620. * Gets camera class name
  125621. * @returns StereoscopicGamepadCamera
  125622. */
  125623. getClassName(): string;
  125624. }
  125625. }
  125626. declare module BABYLON {
  125627. /**
  125628. * Camera used to simulate stereoscopic rendering (based on UniversalCamera)
  125629. * @see https://doc.babylonjs.com/features/cameras
  125630. */
  125631. export class StereoscopicUniversalCamera extends UniversalCamera {
  125632. /**
  125633. * Creates a new StereoscopicUniversalCamera
  125634. * @param name defines camera name
  125635. * @param position defines initial position
  125636. * @param interaxialDistance defines distance between each color axis
  125637. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  125638. * @param scene defines the hosting scene
  125639. */
  125640. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  125641. /**
  125642. * Gets camera class name
  125643. * @returns StereoscopicUniversalCamera
  125644. */
  125645. getClassName(): string;
  125646. }
  125647. }
  125648. declare module BABYLON {
  125649. /**
  125650. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  125651. * It is identical to the Free Camera and simply adds by default a virtual joystick.
  125652. * Virtual Joysticks are on-screen 2D graphics that are used to control the camera or other scene items.
  125653. * @see https://doc.babylonjs.com/features/cameras#virtual-joysticks-camera
  125654. */
  125655. export class VirtualJoysticksCamera extends FreeCamera {
  125656. /**
  125657. * Intantiates a VirtualJoysticksCamera. It can be useful in First Person Shooter game for instance.
  125658. * It is identical to the Free Camera and simply adds by default a virtual joystick.
  125659. * Virtual Joysticks are on-screen 2D graphics that are used to control the camera or other scene items.
  125660. * @see https://doc.babylonjs.com/features/cameras#virtual-joysticks-camera
  125661. * @param name Define the name of the camera in the scene
  125662. * @param position Define the start position of the camera in the scene
  125663. * @param scene Define the scene the camera belongs to
  125664. */
  125665. constructor(name: string, position: Vector3, scene: Scene);
  125666. /**
  125667. * Gets the current object class name.
  125668. * @return the class name
  125669. */
  125670. getClassName(): string;
  125671. }
  125672. }
  125673. declare module BABYLON {
  125674. /**
  125675. * This represents all the required metrics to create a VR camera.
  125676. * @see https://doc.babylonjs.com/babylon101/cameras#device-orientation-camera
  125677. */
  125678. export class VRCameraMetrics {
  125679. /**
  125680. * Define the horizontal resolution off the screen.
  125681. */
  125682. hResolution: number;
  125683. /**
  125684. * Define the vertical resolution off the screen.
  125685. */
  125686. vResolution: number;
  125687. /**
  125688. * Define the horizontal screen size.
  125689. */
  125690. hScreenSize: number;
  125691. /**
  125692. * Define the vertical screen size.
  125693. */
  125694. vScreenSize: number;
  125695. /**
  125696. * Define the vertical screen center position.
  125697. */
  125698. vScreenCenter: number;
  125699. /**
  125700. * Define the distance of the eyes to the screen.
  125701. */
  125702. eyeToScreenDistance: number;
  125703. /**
  125704. * Define the distance between both lenses
  125705. */
  125706. lensSeparationDistance: number;
  125707. /**
  125708. * Define the distance between both viewer's eyes.
  125709. */
  125710. interpupillaryDistance: number;
  125711. /**
  125712. * Define the distortion factor of the VR postprocess.
  125713. * Please, touch with care.
  125714. */
  125715. distortionK: number[];
  125716. /**
  125717. * Define the chromatic aberration correction factors for the VR post process.
  125718. */
  125719. chromaAbCorrection: number[];
  125720. /**
  125721. * Define the scale factor of the post process.
  125722. * The smaller the better but the slower.
  125723. */
  125724. postProcessScaleFactor: number;
  125725. /**
  125726. * Define an offset for the lens center.
  125727. */
  125728. lensCenterOffset: number;
  125729. /**
  125730. * Define if the current vr camera should compensate the distortion of the lense or not.
  125731. */
  125732. compensateDistortion: boolean;
  125733. /**
  125734. * Defines if multiview should be enabled when rendering (Default: false)
  125735. */
  125736. multiviewEnabled: boolean;
  125737. /**
  125738. * Gets the rendering aspect ratio based on the provided resolutions.
  125739. */
  125740. get aspectRatio(): number;
  125741. /**
  125742. * Gets the aspect ratio based on the FOV, scale factors, and real screen sizes.
  125743. */
  125744. get aspectRatioFov(): number;
  125745. /**
  125746. * @hidden
  125747. */
  125748. get leftHMatrix(): Matrix;
  125749. /**
  125750. * @hidden
  125751. */
  125752. get rightHMatrix(): Matrix;
  125753. /**
  125754. * @hidden
  125755. */
  125756. get leftPreViewMatrix(): Matrix;
  125757. /**
  125758. * @hidden
  125759. */
  125760. get rightPreViewMatrix(): Matrix;
  125761. /**
  125762. * Get the default VRMetrics based on the most generic setup.
  125763. * @returns the default vr metrics
  125764. */
  125765. static GetDefault(): VRCameraMetrics;
  125766. }
  125767. }
  125768. declare module BABYLON {
  125769. /** @hidden */
  125770. export var vrDistortionCorrectionPixelShader: {
  125771. name: string;
  125772. shader: string;
  125773. };
  125774. }
  125775. declare module BABYLON {
  125776. /**
  125777. * VRDistortionCorrectionPostProcess used for mobile VR
  125778. */
  125779. export class VRDistortionCorrectionPostProcess extends PostProcess {
  125780. private _isRightEye;
  125781. private _distortionFactors;
  125782. private _postProcessScaleFactor;
  125783. private _lensCenterOffset;
  125784. private _scaleIn;
  125785. private _scaleFactor;
  125786. private _lensCenter;
  125787. /**
  125788. * Gets a string identifying the name of the class
  125789. * @returns "VRDistortionCorrectionPostProcess" string
  125790. */
  125791. getClassName(): string;
  125792. /**
  125793. * Initializes the VRDistortionCorrectionPostProcess
  125794. * @param name The name of the effect.
  125795. * @param camera The camera to apply the render pass to.
  125796. * @param isRightEye If this is for the right eye distortion
  125797. * @param vrMetrics All the required metrics for the VR camera
  125798. */
  125799. constructor(name: string, camera: Camera, isRightEye: boolean, vrMetrics: VRCameraMetrics);
  125800. }
  125801. }
  125802. declare module BABYLON {
  125803. /**
  125804. * Camera used to simulate VR rendering (based on ArcRotateCamera)
  125805. * @see https://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  125806. */
  125807. export class VRDeviceOrientationArcRotateCamera extends ArcRotateCamera {
  125808. /**
  125809. * Creates a new VRDeviceOrientationArcRotateCamera
  125810. * @param name defines camera name
  125811. * @param alpha defines the camera rotation along the logitudinal axis
  125812. * @param beta defines the camera rotation along the latitudinal axis
  125813. * @param radius defines the camera distance from its target
  125814. * @param target defines the camera target
  125815. * @param scene defines the scene the camera belongs to
  125816. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  125817. * @param vrCameraMetrics defines the vr metrics associated to the camera
  125818. */
  125819. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  125820. /**
  125821. * Gets camera class name
  125822. * @returns VRDeviceOrientationArcRotateCamera
  125823. */
  125824. getClassName(): string;
  125825. }
  125826. }
  125827. declare module BABYLON {
  125828. /**
  125829. * Camera used to simulate VR rendering (based on FreeCamera)
  125830. * @see https://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  125831. */
  125832. export class VRDeviceOrientationFreeCamera extends DeviceOrientationCamera {
  125833. /**
  125834. * Creates a new VRDeviceOrientationFreeCamera
  125835. * @param name defines camera name
  125836. * @param position defines the start position of the camera
  125837. * @param scene defines the scene the camera belongs to
  125838. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  125839. * @param vrCameraMetrics defines the vr metrics associated to the camera
  125840. */
  125841. constructor(name: string, position: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  125842. /**
  125843. * Gets camera class name
  125844. * @returns VRDeviceOrientationFreeCamera
  125845. */
  125846. getClassName(): string;
  125847. }
  125848. }
  125849. declare module BABYLON {
  125850. /**
  125851. * Camera used to simulate VR rendering (based on VRDeviceOrientationFreeCamera)
  125852. * @see https://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  125853. */
  125854. export class VRDeviceOrientationGamepadCamera extends VRDeviceOrientationFreeCamera {
  125855. /**
  125856. * Creates a new VRDeviceOrientationGamepadCamera
  125857. * @param name defines camera name
  125858. * @param position defines the start position of the camera
  125859. * @param scene defines the scene the camera belongs to
  125860. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  125861. * @param vrCameraMetrics defines the vr metrics associated to the camera
  125862. */
  125863. constructor(name: string, position: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  125864. /**
  125865. * Gets camera class name
  125866. * @returns VRDeviceOrientationGamepadCamera
  125867. */
  125868. getClassName(): string;
  125869. }
  125870. }
  125871. declare module BABYLON {
  125872. /**
  125873. * A class extending Texture allowing drawing on a texture
  125874. * @see https://doc.babylonjs.com/how_to/dynamictexture
  125875. */
  125876. export class DynamicTexture extends Texture {
  125877. private _generateMipMaps;
  125878. private _canvas;
  125879. private _context;
  125880. /**
  125881. * Creates a DynamicTexture
  125882. * @param name defines the name of the texture
  125883. * @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
  125884. * @param scene defines the scene where you want the texture
  125885. * @param generateMipMaps defines the use of MinMaps or not (default is false)
  125886. * @param samplingMode defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  125887. * @param format defines the texture format to use (default is Engine.TEXTUREFORMAT_RGBA)
  125888. */
  125889. constructor(name: string, options: any, scene: Scene | null | undefined, generateMipMaps: boolean, samplingMode?: number, format?: number);
  125890. /**
  125891. * Get the current class name of the texture useful for serialization or dynamic coding.
  125892. * @returns "DynamicTexture"
  125893. */
  125894. getClassName(): string;
  125895. /**
  125896. * Gets the current state of canRescale
  125897. */
  125898. get canRescale(): boolean;
  125899. private _recreate;
  125900. /**
  125901. * Scales the texture
  125902. * @param ratio the scale factor to apply to both width and height
  125903. */
  125904. scale(ratio: number): void;
  125905. /**
  125906. * Resizes the texture
  125907. * @param width the new width
  125908. * @param height the new height
  125909. */
  125910. scaleTo(width: number, height: number): void;
  125911. /**
  125912. * Gets the context of the canvas used by the texture
  125913. * @returns the canvas context of the dynamic texture
  125914. */
  125915. getContext(): CanvasRenderingContext2D;
  125916. /**
  125917. * Clears the texture
  125918. */
  125919. clear(): void;
  125920. /**
  125921. * Updates the texture
  125922. * @param invertY defines the direction for the Y axis (default is true - y increases downwards)
  125923. * @param premulAlpha defines if alpha is stored as premultiplied (default is false)
  125924. */
  125925. update(invertY?: boolean, premulAlpha?: boolean): void;
  125926. /**
  125927. * Draws text onto the texture
  125928. * @param text defines the text to be drawn
  125929. * @param x defines the placement of the text from the left
  125930. * @param y defines the placement of the text from the top when invertY is true and from the bottom when false
  125931. * @param font defines the font to be used with font-style, font-size, font-name
  125932. * @param color defines the color used for the text
  125933. * @param clearColor defines the color for the canvas, use null to not overwrite canvas
  125934. * @param invertY defines the direction for the Y axis (default is true - y increases downwards)
  125935. * @param update defines whether texture is immediately update (default is true)
  125936. */
  125937. drawText(text: string, x: number | null | undefined, y: number | null | undefined, font: string, color: string | null, clearColor: string, invertY?: boolean, update?: boolean): void;
  125938. /**
  125939. * Clones the texture
  125940. * @returns the clone of the texture.
  125941. */
  125942. clone(): DynamicTexture;
  125943. /**
  125944. * Serializes the dynamic texture. The scene should be ready before the dynamic texture is serialized
  125945. * @returns a serialized dynamic texture object
  125946. */
  125947. serialize(): any;
  125948. private _IsCanvasElement;
  125949. /** @hidden */
  125950. _rebuild(): void;
  125951. }
  125952. }
  125953. declare module BABYLON {
  125954. /**
  125955. * Class containing static functions to help procedurally build meshes
  125956. */
  125957. export class GroundBuilder {
  125958. /**
  125959. * Creates a ground mesh
  125960. * * The parameters `width` and `height` (floats, default 1) set the width and height sizes of the ground
  125961. * * The parameter `subdivisions` (positive integer) sets the number of subdivisions per side
  125962. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  125963. * @param name defines the name of the mesh
  125964. * @param options defines the options used to create the mesh
  125965. * @param scene defines the hosting scene
  125966. * @returns the ground mesh
  125967. * @see https://doc.babylonjs.com/how_to/set_shapes#ground
  125968. */
  125969. static CreateGround(name: string, options: {
  125970. width?: number;
  125971. height?: number;
  125972. subdivisions?: number;
  125973. subdivisionsX?: number;
  125974. subdivisionsY?: number;
  125975. updatable?: boolean;
  125976. }, scene: any): Mesh;
  125977. /**
  125978. * Creates a tiled ground mesh
  125979. * * The parameters `xmin` and `xmax` (floats, default -1 and 1) set the ground minimum and maximum X coordinates
  125980. * * The parameters `zmin` and `zmax` (floats, default -1 and 1) set the ground minimum and maximum Z coordinates
  125981. * * 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
  125982. * * 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
  125983. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  125984. * @param name defines the name of the mesh
  125985. * @param options defines the options used to create the mesh
  125986. * @param scene defines the hosting scene
  125987. * @returns the tiled ground mesh
  125988. * @see https://doc.babylonjs.com/how_to/set_shapes#tiled-ground
  125989. */
  125990. static CreateTiledGround(name: string, options: {
  125991. xmin: number;
  125992. zmin: number;
  125993. xmax: number;
  125994. zmax: number;
  125995. subdivisions?: {
  125996. w: number;
  125997. h: number;
  125998. };
  125999. precision?: {
  126000. w: number;
  126001. h: number;
  126002. };
  126003. updatable?: boolean;
  126004. }, scene?: Nullable<Scene>): Mesh;
  126005. /**
  126006. * Creates a ground mesh from a height map
  126007. * * The parameter `url` sets the URL of the height map image resource.
  126008. * * The parameters `width` and `height` (positive floats, default 10) set the ground width and height sizes.
  126009. * * The parameter `subdivisions` (positive integer, default 1) sets the number of subdivision per side.
  126010. * * The parameter `minHeight` (float, default 0) is the minimum altitude on the ground.
  126011. * * The parameter `maxHeight` (float, default 1) is the maximum altitude on the ground.
  126012. * * 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.
  126013. * * 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).
  126014. * * The parameter `alphaFilter` will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  126015. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  126016. * @param name defines the name of the mesh
  126017. * @param url defines the url to the height map
  126018. * @param options defines the options used to create the mesh
  126019. * @param scene defines the hosting scene
  126020. * @returns the ground mesh
  126021. * @see https://doc.babylonjs.com/babylon101/height_map
  126022. * @see https://doc.babylonjs.com/how_to/set_shapes#ground-from-a-height-map
  126023. */
  126024. static CreateGroundFromHeightMap(name: string, url: string, options: {
  126025. width?: number;
  126026. height?: number;
  126027. subdivisions?: number;
  126028. minHeight?: number;
  126029. maxHeight?: number;
  126030. colorFilter?: Color3;
  126031. alphaFilter?: number;
  126032. updatable?: boolean;
  126033. onReady?: (mesh: GroundMesh) => void;
  126034. }, scene?: Nullable<Scene>): GroundMesh;
  126035. }
  126036. }
  126037. declare module BABYLON {
  126038. /**
  126039. * Class containing static functions to help procedurally build meshes
  126040. */
  126041. export class TorusBuilder {
  126042. /**
  126043. * Creates a torus mesh
  126044. * * The parameter `diameter` sets the diameter size (float) of the torus (default 1)
  126045. * * The parameter `thickness` sets the diameter size of the tube of the torus (float, default 0.5)
  126046. * * The parameter `tessellation` sets the number of torus sides (postive integer, default 16)
  126047. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  126048. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  126049. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  126050. * @param name defines the name of the mesh
  126051. * @param options defines the options used to create the mesh
  126052. * @param scene defines the hosting scene
  126053. * @returns the torus mesh
  126054. * @see https://doc.babylonjs.com/how_to/set_shapes#torus
  126055. */
  126056. static CreateTorus(name: string, options: {
  126057. diameter?: number;
  126058. thickness?: number;
  126059. tessellation?: number;
  126060. updatable?: boolean;
  126061. sideOrientation?: number;
  126062. frontUVs?: Vector4;
  126063. backUVs?: Vector4;
  126064. }, scene: any): Mesh;
  126065. }
  126066. }
  126067. declare module BABYLON {
  126068. /**
  126069. * Class containing static functions to help procedurally build meshes
  126070. */
  126071. export class CylinderBuilder {
  126072. /**
  126073. * Creates a cylinder or a cone mesh
  126074. * * The parameter `height` sets the height size (float) of the cylinder/cone (float, default 2).
  126075. * * The parameter `diameter` sets the diameter of the top and bottom cap at once (float, default 1).
  126076. * * 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.
  126077. * * The parameter `tessellation` sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance.
  126078. * * The parameter `subdivisions` sets the number of rings along the cylinder height (positive integer, default 1).
  126079. * * The parameter `hasRings` (boolean, default false) makes the subdivisions independent from each other, so they become different faces.
  126080. * * The parameter `enclose` (boolean, default false) adds two extra faces per subdivision to a sliced cylinder to close it around its height axis.
  126081. * * 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).
  126082. * * The parameter `arc` (float, default 1) is the ratio (max 1) to apply to the circumference to slice the cylinder.
  126083. * * 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).
  126084. * * 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
  126085. * * Now, if the cylinder has 5 independent subdivisions (hasRings = true), n equals : top face + 5 stripe surfaces + bottom face = 2 + 5 = 7
  126086. * * 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
  126087. * * 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.
  126088. * * If `enclose` is false, a ring surface is one element.
  126089. * * If `enclose` is true, a ring surface is 3 successive elements in the array : the tubular surface, then the two closing faces.
  126090. * * 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
  126091. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  126092. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  126093. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  126094. * @param name defines the name of the mesh
  126095. * @param options defines the options used to create the mesh
  126096. * @param scene defines the hosting scene
  126097. * @returns the cylinder mesh
  126098. * @see https://doc.babylonjs.com/how_to/set_shapes#cylinder-or-cone
  126099. */
  126100. static CreateCylinder(name: string, options: {
  126101. height?: number;
  126102. diameterTop?: number;
  126103. diameterBottom?: number;
  126104. diameter?: number;
  126105. tessellation?: number;
  126106. subdivisions?: number;
  126107. arc?: number;
  126108. faceColors?: Color4[];
  126109. faceUV?: Vector4[];
  126110. updatable?: boolean;
  126111. hasRings?: boolean;
  126112. enclose?: boolean;
  126113. cap?: number;
  126114. sideOrientation?: number;
  126115. frontUVs?: Vector4;
  126116. backUVs?: Vector4;
  126117. }, scene: any): Mesh;
  126118. }
  126119. }
  126120. declare module BABYLON {
  126121. /**
  126122. * States of the webXR experience
  126123. */
  126124. export enum WebXRState {
  126125. /**
  126126. * Transitioning to being in XR mode
  126127. */
  126128. ENTERING_XR = 0,
  126129. /**
  126130. * Transitioning to non XR mode
  126131. */
  126132. EXITING_XR = 1,
  126133. /**
  126134. * In XR mode and presenting
  126135. */
  126136. IN_XR = 2,
  126137. /**
  126138. * Not entered XR mode
  126139. */
  126140. NOT_IN_XR = 3
  126141. }
  126142. /**
  126143. * Abstraction of the XR render target
  126144. */
  126145. export interface WebXRRenderTarget extends IDisposable {
  126146. /**
  126147. * xrpresent context of the canvas which can be used to display/mirror xr content
  126148. */
  126149. canvasContext: WebGLRenderingContext;
  126150. /**
  126151. * xr layer for the canvas
  126152. */
  126153. xrLayer: Nullable<XRWebGLLayer>;
  126154. /**
  126155. * Initializes the xr layer for the session
  126156. * @param xrSession xr session
  126157. * @returns a promise that will resolve once the XR Layer has been created
  126158. */
  126159. initializeXRLayerAsync(xrSession: XRSession): Promise<XRWebGLLayer>;
  126160. }
  126161. }
  126162. declare module BABYLON {
  126163. /**
  126164. * COnfiguration object for WebXR output canvas
  126165. */
  126166. export class WebXRManagedOutputCanvasOptions {
  126167. /**
  126168. * An optional canvas in case you wish to create it yourself and provide it here.
  126169. * If not provided, a new canvas will be created
  126170. */
  126171. canvasElement?: HTMLCanvasElement;
  126172. /**
  126173. * Options for this XR Layer output
  126174. */
  126175. canvasOptions?: XRWebGLLayerOptions;
  126176. /**
  126177. * CSS styling for a newly created canvas (if not provided)
  126178. */
  126179. newCanvasCssStyle?: string;
  126180. /**
  126181. * Get the default values of the configuration object
  126182. * @returns default values of this configuration object
  126183. */
  126184. static GetDefaults(): WebXRManagedOutputCanvasOptions;
  126185. }
  126186. /**
  126187. * Creates a canvas that is added/removed from the webpage when entering/exiting XR
  126188. */
  126189. export class WebXRManagedOutputCanvas implements WebXRRenderTarget {
  126190. private _options;
  126191. private _canvas;
  126192. private _engine;
  126193. private _originalCanvasSize;
  126194. /**
  126195. * Rendering context of the canvas which can be used to display/mirror xr content
  126196. */
  126197. canvasContext: WebGLRenderingContext;
  126198. /**
  126199. * xr layer for the canvas
  126200. */
  126201. xrLayer: Nullable<XRWebGLLayer>;
  126202. /**
  126203. * Obseervers registered here will be triggered when the xr layer was initialized
  126204. */
  126205. onXRLayerInitObservable: Observable<XRWebGLLayer>;
  126206. /**
  126207. * Initializes the canvas to be added/removed upon entering/exiting xr
  126208. * @param _xrSessionManager The XR Session manager
  126209. * @param _options optional configuration for this canvas output. defaults will be used if not provided
  126210. */
  126211. constructor(_xrSessionManager: WebXRSessionManager, _options?: WebXRManagedOutputCanvasOptions);
  126212. /**
  126213. * Disposes of the object
  126214. */
  126215. dispose(): void;
  126216. /**
  126217. * Initializes the xr layer for the session
  126218. * @param xrSession xr session
  126219. * @returns a promise that will resolve once the XR Layer has been created
  126220. */
  126221. initializeXRLayerAsync(xrSession: XRSession): Promise<XRWebGLLayer>;
  126222. private _addCanvas;
  126223. private _removeCanvas;
  126224. private _setCanvasSize;
  126225. private _setManagedOutputCanvas;
  126226. }
  126227. }
  126228. declare module BABYLON {
  126229. /**
  126230. * Manages an XRSession to work with Babylon's engine
  126231. * @see https://doc.babylonjs.com/how_to/webxr_session_manager
  126232. */
  126233. export class WebXRSessionManager implements IDisposable {
  126234. /** The scene which the session should be created for */
  126235. scene: Scene;
  126236. private _referenceSpace;
  126237. private _rttProvider;
  126238. private _sessionEnded;
  126239. private _xrNavigator;
  126240. private baseLayer;
  126241. /**
  126242. * The base reference space from which the session started. good if you want to reset your
  126243. * reference space
  126244. */
  126245. baseReferenceSpace: XRReferenceSpace;
  126246. /**
  126247. * Current XR frame
  126248. */
  126249. currentFrame: Nullable<XRFrame>;
  126250. /** WebXR timestamp updated every frame */
  126251. currentTimestamp: number;
  126252. /**
  126253. * Used just in case of a failure to initialize an immersive session.
  126254. * The viewer reference space is compensated using this height, creating a kind of "viewer-floor" reference space
  126255. */
  126256. defaultHeightCompensation: number;
  126257. /**
  126258. * Fires every time a new xrFrame arrives which can be used to update the camera
  126259. */
  126260. onXRFrameObservable: Observable<XRFrame>;
  126261. /**
  126262. * Fires when the reference space changed
  126263. */
  126264. onXRReferenceSpaceChanged: Observable<XRReferenceSpace>;
  126265. /**
  126266. * Fires when the xr session is ended either by the device or manually done
  126267. */
  126268. onXRSessionEnded: Observable<any>;
  126269. /**
  126270. * Fires when the xr session is ended either by the device or manually done
  126271. */
  126272. onXRSessionInit: Observable<XRSession>;
  126273. /**
  126274. * Underlying xr session
  126275. */
  126276. session: XRSession;
  126277. /**
  126278. * The viewer (head position) reference space. This can be used to get the XR world coordinates
  126279. * or get the offset the player is currently at.
  126280. */
  126281. viewerReferenceSpace: XRReferenceSpace;
  126282. /**
  126283. * Constructs a WebXRSessionManager, this must be initialized within a user action before usage
  126284. * @param scene The scene which the session should be created for
  126285. */
  126286. constructor(
  126287. /** The scene which the session should be created for */
  126288. scene: Scene);
  126289. /**
  126290. * The current reference space used in this session. This reference space can constantly change!
  126291. * It is mainly used to offset the camera's position.
  126292. */
  126293. get referenceSpace(): XRReferenceSpace;
  126294. /**
  126295. * Set a new reference space and triggers the observable
  126296. */
  126297. set referenceSpace(newReferenceSpace: XRReferenceSpace);
  126298. /**
  126299. * Disposes of the session manager
  126300. */
  126301. dispose(): void;
  126302. /**
  126303. * Stops the xrSession and restores the render loop
  126304. * @returns Promise which resolves after it exits XR
  126305. */
  126306. exitXRAsync(): Promise<void>;
  126307. /**
  126308. * Gets the correct render target texture to be rendered this frame for this eye
  126309. * @param eye the eye for which to get the render target
  126310. * @returns the render target for the specified eye
  126311. */
  126312. getRenderTargetTextureForEye(eye: XREye): RenderTargetTexture;
  126313. /**
  126314. * Creates a WebXRRenderTarget object for the XR session
  126315. * @param onStateChangedObservable optional, mechanism for enabling/disabling XR rendering canvas, used only on Web
  126316. * @param options optional options to provide when creating a new render target
  126317. * @returns a WebXR render target to which the session can render
  126318. */
  126319. getWebXRRenderTarget(options?: WebXRManagedOutputCanvasOptions): WebXRRenderTarget;
  126320. /**
  126321. * Initializes the manager
  126322. * After initialization enterXR can be called to start an XR session
  126323. * @returns Promise which resolves after it is initialized
  126324. */
  126325. initializeAsync(): Promise<void>;
  126326. /**
  126327. * Initializes an xr session
  126328. * @param xrSessionMode mode to initialize
  126329. * @param xrSessionInit defines optional and required values to pass to the session builder
  126330. * @returns a promise which will resolve once the session has been initialized
  126331. */
  126332. initializeSessionAsync(xrSessionMode?: XRSessionMode, xrSessionInit?: XRSessionInit): Promise<XRSession>;
  126333. /**
  126334. * Checks if a session would be supported for the creation options specified
  126335. * @param sessionMode session mode to check if supported eg. immersive-vr
  126336. * @returns A Promise that resolves to true if supported and false if not
  126337. */
  126338. isSessionSupportedAsync(sessionMode: XRSessionMode): Promise<boolean>;
  126339. /**
  126340. * Resets the reference space to the one started the session
  126341. */
  126342. resetReferenceSpace(): void;
  126343. /**
  126344. * Starts rendering to the xr layer
  126345. */
  126346. runXRRenderLoop(): void;
  126347. /**
  126348. * Sets the reference space on the xr session
  126349. * @param referenceSpaceType space to set
  126350. * @returns a promise that will resolve once the reference space has been set
  126351. */
  126352. setReferenceSpaceTypeAsync(referenceSpaceType?: XRReferenceSpaceType): Promise<XRReferenceSpace>;
  126353. /**
  126354. * Updates the render state of the session
  126355. * @param state state to set
  126356. * @returns a promise that resolves once the render state has been updated
  126357. */
  126358. updateRenderStateAsync(state: XRRenderState): Promise<void>;
  126359. /**
  126360. * Returns a promise that resolves with a boolean indicating if the provided session mode is supported by this browser
  126361. * @param sessionMode defines the session to test
  126362. * @returns a promise with boolean as final value
  126363. */
  126364. static IsSessionSupportedAsync(sessionMode: XRSessionMode): Promise<boolean>;
  126365. private _createRenderTargetTexture;
  126366. }
  126367. }
  126368. declare module BABYLON {
  126369. /**
  126370. * WebXR Camera which holds the views for the xrSession
  126371. * @see https://doc.babylonjs.com/how_to/webxr_camera
  126372. */
  126373. export class WebXRCamera extends FreeCamera {
  126374. private _xrSessionManager;
  126375. private _firstFrame;
  126376. private _referenceQuaternion;
  126377. private _referencedPosition;
  126378. private _xrInvPositionCache;
  126379. private _xrInvQuaternionCache;
  126380. /**
  126381. * Observable raised before camera teleportation
  126382. */
  126383. onBeforeCameraTeleport: Observable<Vector3>;
  126384. /**
  126385. * Observable raised after camera teleportation
  126386. */
  126387. onAfterCameraTeleport: Observable<Vector3>;
  126388. /**
  126389. * Should position compensation execute on first frame.
  126390. * This is used when copying the position from a native (non XR) camera
  126391. */
  126392. compensateOnFirstFrame: boolean;
  126393. /**
  126394. * Creates a new webXRCamera, this should only be set at the camera after it has been updated by the xrSessionManager
  126395. * @param name the name of the camera
  126396. * @param scene the scene to add the camera to
  126397. * @param _xrSessionManager a constructed xr session manager
  126398. */
  126399. constructor(name: string, scene: Scene, _xrSessionManager: WebXRSessionManager);
  126400. /**
  126401. * Return the user's height, unrelated to the current ground.
  126402. * This will be the y position of this camera, when ground level is 0.
  126403. */
  126404. get realWorldHeight(): number;
  126405. /** @hidden */
  126406. _updateForDualEyeDebugging(): void;
  126407. /**
  126408. * Sets this camera's transformation based on a non-vr camera
  126409. * @param otherCamera the non-vr camera to copy the transformation from
  126410. * @param resetToBaseReferenceSpace should XR reset to the base reference space
  126411. */
  126412. setTransformationFromNonVRCamera(otherCamera?: Camera, resetToBaseReferenceSpace?: boolean): void;
  126413. /**
  126414. * Gets the current instance class name ("WebXRCamera").
  126415. * @returns the class name
  126416. */
  126417. getClassName(): string;
  126418. private _rotate180;
  126419. private _updateFromXRSession;
  126420. private _updateNumberOfRigCameras;
  126421. private _updateReferenceSpace;
  126422. private _updateReferenceSpaceOffset;
  126423. }
  126424. }
  126425. declare module BABYLON {
  126426. /**
  126427. * Defining the interface required for a (webxr) feature
  126428. */
  126429. export interface IWebXRFeature extends IDisposable {
  126430. /**
  126431. * Is this feature attached
  126432. */
  126433. attached: boolean;
  126434. /**
  126435. * Should auto-attach be disabled?
  126436. */
  126437. disableAutoAttach: boolean;
  126438. /**
  126439. * Attach the feature to the session
  126440. * Will usually be called by the features manager
  126441. *
  126442. * @param force should attachment be forced (even when already attached)
  126443. * @returns true if successful.
  126444. */
  126445. attach(force?: boolean): boolean;
  126446. /**
  126447. * Detach the feature from the session
  126448. * Will usually be called by the features manager
  126449. *
  126450. * @returns true if successful.
  126451. */
  126452. detach(): boolean;
  126453. /**
  126454. * This function will be executed during before enabling the feature and can be used to not-allow enabling it.
  126455. * Note that at this point the session has NOT started, so this is purely checking if the browser supports it
  126456. *
  126457. * @returns whether or not the feature is compatible in this environment
  126458. */
  126459. isCompatible(): boolean;
  126460. /**
  126461. * The name of the native xr feature name, if applicable (like anchor, hit-test, or hand-tracking)
  126462. */
  126463. xrNativeFeatureName?: string;
  126464. }
  126465. /**
  126466. * A list of the currently available features without referencing them
  126467. */
  126468. export class WebXRFeatureName {
  126469. /**
  126470. * The name of the anchor system feature
  126471. */
  126472. static readonly ANCHOR_SYSTEM: string;
  126473. /**
  126474. * The name of the background remover feature
  126475. */
  126476. static readonly BACKGROUND_REMOVER: string;
  126477. /**
  126478. * The name of the hit test feature
  126479. */
  126480. static readonly HIT_TEST: string;
  126481. /**
  126482. * physics impostors for xr controllers feature
  126483. */
  126484. static readonly PHYSICS_CONTROLLERS: string;
  126485. /**
  126486. * The name of the plane detection feature
  126487. */
  126488. static readonly PLANE_DETECTION: string;
  126489. /**
  126490. * The name of the pointer selection feature
  126491. */
  126492. static readonly POINTER_SELECTION: string;
  126493. /**
  126494. * The name of the teleportation feature
  126495. */
  126496. static readonly TELEPORTATION: string;
  126497. /**
  126498. * The name of the feature points feature.
  126499. */
  126500. static readonly FEATURE_POINTS: string;
  126501. }
  126502. /**
  126503. * Defining the constructor of a feature. Used to register the modules.
  126504. */
  126505. export type WebXRFeatureConstructor = (xrSessionManager: WebXRSessionManager, options?: any) => () => IWebXRFeature;
  126506. /**
  126507. * The WebXR features manager is responsible of enabling or disabling features required for the current XR session.
  126508. * It is mainly used in AR sessions.
  126509. *
  126510. * A feature can have a version that is defined by Babylon (and does not correspond with the webxr version).
  126511. */
  126512. export class WebXRFeaturesManager implements IDisposable {
  126513. private _xrSessionManager;
  126514. private static readonly _AvailableFeatures;
  126515. private _features;
  126516. /**
  126517. * constructs a new features manages.
  126518. *
  126519. * @param _xrSessionManager an instance of WebXRSessionManager
  126520. */
  126521. constructor(_xrSessionManager: WebXRSessionManager);
  126522. /**
  126523. * Used to register a module. After calling this function a developer can use this feature in the scene.
  126524. * Mainly used internally.
  126525. *
  126526. * @param featureName the name of the feature to register
  126527. * @param constructorFunction the function used to construct the module
  126528. * @param version the (babylon) version of the module
  126529. * @param stable is that a stable version of this module
  126530. */
  126531. static AddWebXRFeature(featureName: string, constructorFunction: WebXRFeatureConstructor, version?: number, stable?: boolean): void;
  126532. /**
  126533. * Returns a constructor of a specific feature.
  126534. *
  126535. * @param featureName the name of the feature to construct
  126536. * @param version the version of the feature to load
  126537. * @param xrSessionManager the xrSessionManager. Used to construct the module
  126538. * @param options optional options provided to the module.
  126539. * @returns a function that, when called, will return a new instance of this feature
  126540. */
  126541. static ConstructFeature(featureName: string, version: number | undefined, xrSessionManager: WebXRSessionManager, options?: any): () => IWebXRFeature;
  126542. /**
  126543. * Can be used to return the list of features currently registered
  126544. *
  126545. * @returns an Array of available features
  126546. */
  126547. static GetAvailableFeatures(): string[];
  126548. /**
  126549. * Gets the versions available for a specific feature
  126550. * @param featureName the name of the feature
  126551. * @returns an array with the available versions
  126552. */
  126553. static GetAvailableVersions(featureName: string): string[];
  126554. /**
  126555. * Return the latest unstable version of this feature
  126556. * @param featureName the name of the feature to search
  126557. * @returns the version number. if not found will return -1
  126558. */
  126559. static GetLatestVersionOfFeature(featureName: string): number;
  126560. /**
  126561. * Return the latest stable version of this feature
  126562. * @param featureName the name of the feature to search
  126563. * @returns the version number. if not found will return -1
  126564. */
  126565. static GetStableVersionOfFeature(featureName: string): number;
  126566. /**
  126567. * Attach a feature to the current session. Mainly used when session started to start the feature effect.
  126568. * Can be used during a session to start a feature
  126569. * @param featureName the name of feature to attach
  126570. */
  126571. attachFeature(featureName: string): void;
  126572. /**
  126573. * Can be used inside a session or when the session ends to detach a specific feature
  126574. * @param featureName the name of the feature to detach
  126575. */
  126576. detachFeature(featureName: string): void;
  126577. /**
  126578. * Used to disable an already-enabled feature
  126579. * The feature will be disposed and will be recreated once enabled.
  126580. * @param featureName the feature to disable
  126581. * @returns true if disable was successful
  126582. */
  126583. disableFeature(featureName: string | {
  126584. Name: string;
  126585. }): boolean;
  126586. /**
  126587. * dispose this features manager
  126588. */
  126589. dispose(): void;
  126590. /**
  126591. * 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.
  126592. * 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.
  126593. *
  126594. * @param featureName the name of the feature to load or the class of the feature
  126595. * @param version optional version to load. if not provided the latest version will be enabled
  126596. * @param moduleOptions options provided to the module. Ses the module documentation / constructor
  126597. * @param attachIfPossible if set to true (default) the feature will be automatically attached, if it is currently possible
  126598. * @param required is this feature required to the app. If set to true the session init will fail if the feature is not available.
  126599. * @returns a new constructed feature or throws an error if feature not found.
  126600. */
  126601. enableFeature(featureName: string | {
  126602. Name: string;
  126603. }, version?: number | string, moduleOptions?: any, attachIfPossible?: boolean, required?: boolean): IWebXRFeature;
  126604. /**
  126605. * get the implementation of an enabled feature.
  126606. * @param featureName the name of the feature to load
  126607. * @returns the feature class, if found
  126608. */
  126609. getEnabledFeature(featureName: string): IWebXRFeature;
  126610. /**
  126611. * Get the list of enabled features
  126612. * @returns an array of enabled features
  126613. */
  126614. getEnabledFeatures(): string[];
  126615. /**
  126616. * This function will exten the session creation configuration object with enabled features.
  126617. * If, for example, the anchors feature is enabled, it will be automatically added to the optional or required features list,
  126618. * according to the defined "required" variable, provided during enableFeature call
  126619. * @param xrSessionInit the xr Session init object to extend
  126620. *
  126621. * @returns an extended XRSessionInit object
  126622. */
  126623. extendXRSessionInitObject(xrSessionInit: XRSessionInit): XRSessionInit;
  126624. }
  126625. }
  126626. declare module BABYLON {
  126627. /**
  126628. * Base set of functionality needed to create an XR experience (WebXRSessionManager, Camera, StateManagement, etc.)
  126629. * @see https://doc.babylonjs.com/how_to/webxr_experience_helpers
  126630. */
  126631. export class WebXRExperienceHelper implements IDisposable {
  126632. private scene;
  126633. private _nonVRCamera;
  126634. private _originalSceneAutoClear;
  126635. private _supported;
  126636. /**
  126637. * Camera used to render xr content
  126638. */
  126639. camera: WebXRCamera;
  126640. /** A features manager for this xr session */
  126641. featuresManager: WebXRFeaturesManager;
  126642. /**
  126643. * Observers registered here will be triggered after the camera's initial transformation is set
  126644. * This can be used to set a different ground level or an extra rotation.
  126645. *
  126646. * Note that ground level is considered to be at 0. The height defined by the XR camera will be added
  126647. * to the position set after this observable is done executing.
  126648. */
  126649. onInitialXRPoseSetObservable: Observable<WebXRCamera>;
  126650. /**
  126651. * Fires when the state of the experience helper has changed
  126652. */
  126653. onStateChangedObservable: Observable<WebXRState>;
  126654. /** Session manager used to keep track of xr session */
  126655. sessionManager: WebXRSessionManager;
  126656. /**
  126657. * The current state of the XR experience (eg. transitioning, in XR or not in XR)
  126658. */
  126659. state: WebXRState;
  126660. /**
  126661. * Creates a WebXRExperienceHelper
  126662. * @param scene The scene the helper should be created in
  126663. */
  126664. private constructor();
  126665. /**
  126666. * Creates the experience helper
  126667. * @param scene the scene to attach the experience helper to
  126668. * @returns a promise for the experience helper
  126669. */
  126670. static CreateAsync(scene: Scene): Promise<WebXRExperienceHelper>;
  126671. /**
  126672. * Disposes of the experience helper
  126673. */
  126674. dispose(): void;
  126675. /**
  126676. * Enters XR mode (This must be done within a user interaction in most browsers eg. button click)
  126677. * @param sessionMode options for the XR session
  126678. * @param referenceSpaceType frame of reference of the XR session
  126679. * @param renderTarget the output canvas that will be used to enter XR mode
  126680. * @param sessionCreationOptions optional XRSessionInit object to init the session with
  126681. * @returns promise that resolves after xr mode has entered
  126682. */
  126683. enterXRAsync(sessionMode: XRSessionMode, referenceSpaceType: XRReferenceSpaceType, renderTarget?: WebXRRenderTarget, sessionCreationOptions?: XRSessionInit): Promise<WebXRSessionManager>;
  126684. /**
  126685. * Exits XR mode and returns the scene to its original state
  126686. * @returns promise that resolves after xr mode has exited
  126687. */
  126688. exitXRAsync(): Promise<void>;
  126689. private _nonXRToXRCamera;
  126690. private _setState;
  126691. }
  126692. }
  126693. declare module BABYLON {
  126694. /**
  126695. * X-Y values for axes in WebXR
  126696. */
  126697. export interface IWebXRMotionControllerAxesValue {
  126698. /**
  126699. * The value of the x axis
  126700. */
  126701. x: number;
  126702. /**
  126703. * The value of the y-axis
  126704. */
  126705. y: number;
  126706. }
  126707. /**
  126708. * changed / previous values for the values of this component
  126709. */
  126710. export interface IWebXRMotionControllerComponentChangesValues<T> {
  126711. /**
  126712. * current (this frame) value
  126713. */
  126714. current: T;
  126715. /**
  126716. * previous (last change) value
  126717. */
  126718. previous: T;
  126719. }
  126720. /**
  126721. * Represents changes in the component between current frame and last values recorded
  126722. */
  126723. export interface IWebXRMotionControllerComponentChanges {
  126724. /**
  126725. * will be populated with previous and current values if axes changed
  126726. */
  126727. axes?: IWebXRMotionControllerComponentChangesValues<IWebXRMotionControllerAxesValue>;
  126728. /**
  126729. * will be populated with previous and current values if pressed changed
  126730. */
  126731. pressed?: IWebXRMotionControllerComponentChangesValues<boolean>;
  126732. /**
  126733. * will be populated with previous and current values if touched changed
  126734. */
  126735. touched?: IWebXRMotionControllerComponentChangesValues<boolean>;
  126736. /**
  126737. * will be populated with previous and current values if value changed
  126738. */
  126739. value?: IWebXRMotionControllerComponentChangesValues<number>;
  126740. }
  126741. /**
  126742. * This class represents a single component (for example button or thumbstick) of a motion controller
  126743. */
  126744. export class WebXRControllerComponent implements IDisposable {
  126745. /**
  126746. * the id of this component
  126747. */
  126748. id: string;
  126749. /**
  126750. * the type of the component
  126751. */
  126752. type: MotionControllerComponentType;
  126753. private _buttonIndex;
  126754. private _axesIndices;
  126755. private _axes;
  126756. private _changes;
  126757. private _currentValue;
  126758. private _hasChanges;
  126759. private _pressed;
  126760. private _touched;
  126761. /**
  126762. * button component type
  126763. */
  126764. static BUTTON_TYPE: MotionControllerComponentType;
  126765. /**
  126766. * squeeze component type
  126767. */
  126768. static SQUEEZE_TYPE: MotionControllerComponentType;
  126769. /**
  126770. * Thumbstick component type
  126771. */
  126772. static THUMBSTICK_TYPE: MotionControllerComponentType;
  126773. /**
  126774. * Touchpad component type
  126775. */
  126776. static TOUCHPAD_TYPE: MotionControllerComponentType;
  126777. /**
  126778. * trigger component type
  126779. */
  126780. static TRIGGER_TYPE: MotionControllerComponentType;
  126781. /**
  126782. * If axes are available for this component (like a touchpad or thumbstick) the observers will be notified when
  126783. * the axes data changes
  126784. */
  126785. onAxisValueChangedObservable: Observable<{
  126786. x: number;
  126787. y: number;
  126788. }>;
  126789. /**
  126790. * Observers registered here will be triggered when the state of a button changes
  126791. * State change is either pressed / touched / value
  126792. */
  126793. onButtonStateChangedObservable: Observable<WebXRControllerComponent>;
  126794. /**
  126795. * Creates a new component for a motion controller.
  126796. * It is created by the motion controller itself
  126797. *
  126798. * @param id the id of this component
  126799. * @param type the type of the component
  126800. * @param _buttonIndex index in the buttons array of the gamepad
  126801. * @param _axesIndices indices of the values in the axes array of the gamepad
  126802. */
  126803. constructor(
  126804. /**
  126805. * the id of this component
  126806. */
  126807. id: string,
  126808. /**
  126809. * the type of the component
  126810. */
  126811. type: MotionControllerComponentType, _buttonIndex?: number, _axesIndices?: number[]);
  126812. /**
  126813. * The current axes data. If this component has no axes it will still return an object { x: 0, y: 0 }
  126814. */
  126815. get axes(): IWebXRMotionControllerAxesValue;
  126816. /**
  126817. * Get the changes. Elements will be populated only if they changed with their previous and current value
  126818. */
  126819. get changes(): IWebXRMotionControllerComponentChanges;
  126820. /**
  126821. * Return whether or not the component changed the last frame
  126822. */
  126823. get hasChanges(): boolean;
  126824. /**
  126825. * is the button currently pressed
  126826. */
  126827. get pressed(): boolean;
  126828. /**
  126829. * is the button currently touched
  126830. */
  126831. get touched(): boolean;
  126832. /**
  126833. * Get the current value of this component
  126834. */
  126835. get value(): number;
  126836. /**
  126837. * Dispose this component
  126838. */
  126839. dispose(): void;
  126840. /**
  126841. * Are there axes correlating to this component
  126842. * @return true is axes data is available
  126843. */
  126844. isAxes(): boolean;
  126845. /**
  126846. * Is this component a button (hence - pressable)
  126847. * @returns true if can be pressed
  126848. */
  126849. isButton(): boolean;
  126850. /**
  126851. * update this component using the gamepad object it is in. Called on every frame
  126852. * @param nativeController the native gamepad controller object
  126853. */
  126854. update(nativeController: IMinimalMotionControllerObject): void;
  126855. }
  126856. }
  126857. declare module BABYLON {
  126858. /**
  126859. * Interface used to represent data loading progression
  126860. */
  126861. export interface ISceneLoaderProgressEvent {
  126862. /**
  126863. * Defines if data length to load can be evaluated
  126864. */
  126865. readonly lengthComputable: boolean;
  126866. /**
  126867. * Defines the loaded data length
  126868. */
  126869. readonly loaded: number;
  126870. /**
  126871. * Defines the data length to load
  126872. */
  126873. readonly total: number;
  126874. }
  126875. /**
  126876. * Interface used by SceneLoader plugins to define supported file extensions
  126877. */
  126878. export interface ISceneLoaderPluginExtensions {
  126879. /**
  126880. * Defines the list of supported extensions
  126881. */
  126882. [extension: string]: {
  126883. isBinary: boolean;
  126884. };
  126885. }
  126886. /**
  126887. * Interface used by SceneLoader plugin factory
  126888. */
  126889. export interface ISceneLoaderPluginFactory {
  126890. /**
  126891. * Defines the name of the factory
  126892. */
  126893. name: string;
  126894. /**
  126895. * Function called to create a new plugin
  126896. * @return the new plugin
  126897. */
  126898. createPlugin(): ISceneLoaderPlugin | ISceneLoaderPluginAsync;
  126899. /**
  126900. * The callback that returns true if the data can be directly loaded.
  126901. * @param data string containing the file data
  126902. * @returns if the data can be loaded directly
  126903. */
  126904. canDirectLoad?(data: string): boolean;
  126905. }
  126906. /**
  126907. * Interface used to define the base of ISceneLoaderPlugin and ISceneLoaderPluginAsync
  126908. */
  126909. export interface ISceneLoaderPluginBase {
  126910. /**
  126911. * The friendly name of this plugin.
  126912. */
  126913. name: string;
  126914. /**
  126915. * The file extensions supported by this plugin.
  126916. */
  126917. extensions: string | ISceneLoaderPluginExtensions;
  126918. /**
  126919. * The callback called when loading from a url.
  126920. * @param scene scene loading this url
  126921. * @param url url to load
  126922. * @param onSuccess callback called when the file successfully loads
  126923. * @param onProgress callback called while file is loading (if the server supports this mode)
  126924. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  126925. * @param onError callback called when the file fails to load
  126926. * @returns a file request object
  126927. */
  126928. requestFile?(scene: Scene, url: string, onSuccess: (data: any, request?: WebRequest) => void, onProgress?: (ev: ISceneLoaderProgressEvent) => void, useArrayBuffer?: boolean, onError?: (error: any) => void): IFileRequest;
  126929. /**
  126930. * The callback called when loading from a file object.
  126931. * @param scene scene loading this file
  126932. * @param file defines the file to load
  126933. * @param onSuccess defines the callback to call when data is loaded
  126934. * @param onProgress defines the callback to call during loading process
  126935. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  126936. * @param onError defines the callback to call when an error occurs
  126937. * @returns a file request object
  126938. */
  126939. readFile?(scene: Scene, file: File, onSuccess: (data: any) => void, onProgress?: (ev: ISceneLoaderProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: any) => void): IFileRequest;
  126940. /**
  126941. * The callback that returns true if the data can be directly loaded.
  126942. * @param data string containing the file data
  126943. * @returns if the data can be loaded directly
  126944. */
  126945. canDirectLoad?(data: string): boolean;
  126946. /**
  126947. * The callback that returns the data to pass to the plugin if the data can be directly loaded.
  126948. * @param scene scene loading this data
  126949. * @param data string containing the data
  126950. * @returns data to pass to the plugin
  126951. */
  126952. directLoad?(scene: Scene, data: string): any;
  126953. /**
  126954. * The callback that allows custom handling of the root url based on the response url.
  126955. * @param rootUrl the original root url
  126956. * @param responseURL the response url if available
  126957. * @returns the new root url
  126958. */
  126959. rewriteRootURL?(rootUrl: string, responseURL?: string): string;
  126960. }
  126961. /**
  126962. * Interface used to define a SceneLoader plugin
  126963. */
  126964. export interface ISceneLoaderPlugin extends ISceneLoaderPluginBase {
  126965. /**
  126966. * Import meshes into a scene.
  126967. * @param meshesNames An array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  126968. * @param scene The scene to import into
  126969. * @param data The data to import
  126970. * @param rootUrl The root url for scene and resources
  126971. * @param meshes The meshes array to import into
  126972. * @param particleSystems The particle systems array to import into
  126973. * @param skeletons The skeletons array to import into
  126974. * @param onError The callback when import fails
  126975. * @returns True if successful or false otherwise
  126976. */
  126977. importMesh(meshesNames: any, scene: Scene, data: any, rootUrl: string, meshes: AbstractMesh[], particleSystems: IParticleSystem[], skeletons: Skeleton[], onError?: (message: string, exception?: any) => void): boolean;
  126978. /**
  126979. * Load into a scene.
  126980. * @param scene The scene to load into
  126981. * @param data The data to import
  126982. * @param rootUrl The root url for scene and resources
  126983. * @param onError The callback when import fails
  126984. * @returns True if successful or false otherwise
  126985. */
  126986. load(scene: Scene, data: any, rootUrl: string, onError?: (message: string, exception?: any) => void): boolean;
  126987. /**
  126988. * Load into an asset container.
  126989. * @param scene The scene to load into
  126990. * @param data The data to import
  126991. * @param rootUrl The root url for scene and resources
  126992. * @param onError The callback when import fails
  126993. * @returns The loaded asset container
  126994. */
  126995. loadAssetContainer(scene: Scene, data: any, rootUrl: string, onError?: (message: string, exception?: any) => void): AssetContainer;
  126996. }
  126997. /**
  126998. * Interface used to define an async SceneLoader plugin
  126999. */
  127000. export interface ISceneLoaderPluginAsync extends ISceneLoaderPluginBase {
  127001. /**
  127002. * Import meshes into a scene.
  127003. * @param meshesNames An array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  127004. * @param scene The scene to import into
  127005. * @param data The data to import
  127006. * @param rootUrl The root url for scene and resources
  127007. * @param onProgress The callback when the load progresses
  127008. * @param fileName Defines the name of the file to load
  127009. * @returns The loaded meshes, particle systems, skeletons, and animation groups
  127010. */
  127011. importMeshAsync(meshesNames: any, scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<{
  127012. meshes: AbstractMesh[];
  127013. particleSystems: IParticleSystem[];
  127014. skeletons: Skeleton[];
  127015. animationGroups: AnimationGroup[];
  127016. }>;
  127017. /**
  127018. * Load into a scene.
  127019. * @param scene The scene to load into
  127020. * @param data The data to import
  127021. * @param rootUrl The root url for scene and resources
  127022. * @param onProgress The callback when the load progresses
  127023. * @param fileName Defines the name of the file to load
  127024. * @returns Nothing
  127025. */
  127026. loadAsync(scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<void>;
  127027. /**
  127028. * Load into an asset container.
  127029. * @param scene The scene to load into
  127030. * @param data The data to import
  127031. * @param rootUrl The root url for scene and resources
  127032. * @param onProgress The callback when the load progresses
  127033. * @param fileName Defines the name of the file to load
  127034. * @returns The loaded asset container
  127035. */
  127036. loadAssetContainerAsync(scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<AssetContainer>;
  127037. }
  127038. /**
  127039. * Mode that determines how to handle old animation groups before loading new ones.
  127040. */
  127041. export enum SceneLoaderAnimationGroupLoadingMode {
  127042. /**
  127043. * Reset all old animations to initial state then dispose them.
  127044. */
  127045. Clean = 0,
  127046. /**
  127047. * Stop all old animations.
  127048. */
  127049. Stop = 1,
  127050. /**
  127051. * Restart old animations from first frame.
  127052. */
  127053. Sync = 2,
  127054. /**
  127055. * Old animations remains untouched.
  127056. */
  127057. NoSync = 3
  127058. }
  127059. /**
  127060. * Defines a plugin registered by the SceneLoader
  127061. */
  127062. interface IRegisteredPlugin {
  127063. /**
  127064. * Defines the plugin to use
  127065. */
  127066. plugin: ISceneLoaderPlugin | ISceneLoaderPluginAsync | ISceneLoaderPluginFactory;
  127067. /**
  127068. * Defines if the plugin supports binary data
  127069. */
  127070. isBinary: boolean;
  127071. }
  127072. /**
  127073. * Class used to load scene from various file formats using registered plugins
  127074. * @see https://doc.babylonjs.com/how_to/load_from_any_file_type
  127075. */
  127076. export class SceneLoader {
  127077. /**
  127078. * No logging while loading
  127079. */
  127080. static readonly NO_LOGGING: number;
  127081. /**
  127082. * Minimal logging while loading
  127083. */
  127084. static readonly MINIMAL_LOGGING: number;
  127085. /**
  127086. * Summary logging while loading
  127087. */
  127088. static readonly SUMMARY_LOGGING: number;
  127089. /**
  127090. * Detailled logging while loading
  127091. */
  127092. static readonly DETAILED_LOGGING: number;
  127093. /**
  127094. * Gets or sets a boolean indicating if entire scene must be loaded even if scene contains incremental data
  127095. */
  127096. static get ForceFullSceneLoadingForIncremental(): boolean;
  127097. static set ForceFullSceneLoadingForIncremental(value: boolean);
  127098. /**
  127099. * Gets or sets a boolean indicating if loading screen must be displayed while loading a scene
  127100. */
  127101. static get ShowLoadingScreen(): boolean;
  127102. static set ShowLoadingScreen(value: boolean);
  127103. /**
  127104. * Defines the current logging level (while loading the scene)
  127105. * @ignorenaming
  127106. */
  127107. static get loggingLevel(): number;
  127108. static set loggingLevel(value: number);
  127109. /**
  127110. * Gets or set a boolean indicating if matrix weights must be cleaned upon loading
  127111. */
  127112. static get CleanBoneMatrixWeights(): boolean;
  127113. static set CleanBoneMatrixWeights(value: boolean);
  127114. /**
  127115. * Event raised when a plugin is used to load a scene
  127116. */
  127117. static OnPluginActivatedObservable: Observable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
  127118. private static _registeredPlugins;
  127119. private static _showingLoadingScreen;
  127120. /**
  127121. * Gets the default plugin (used to load Babylon files)
  127122. * @returns the .babylon plugin
  127123. */
  127124. static GetDefaultPlugin(): IRegisteredPlugin;
  127125. private static _GetPluginForExtension;
  127126. private static _GetPluginForDirectLoad;
  127127. private static _GetPluginForFilename;
  127128. private static _GetDirectLoad;
  127129. private static _LoadData;
  127130. private static _GetFileInfo;
  127131. /**
  127132. * Gets a plugin that can load the given extension
  127133. * @param extension defines the extension to load
  127134. * @returns a plugin or null if none works
  127135. */
  127136. static GetPluginForExtension(extension: string): ISceneLoaderPlugin | ISceneLoaderPluginAsync | ISceneLoaderPluginFactory;
  127137. /**
  127138. * Gets a boolean indicating that the given extension can be loaded
  127139. * @param extension defines the extension to load
  127140. * @returns true if the extension is supported
  127141. */
  127142. static IsPluginForExtensionAvailable(extension: string): boolean;
  127143. /**
  127144. * Adds a new plugin to the list of registered plugins
  127145. * @param plugin defines the plugin to add
  127146. */
  127147. static RegisterPlugin(plugin: ISceneLoaderPlugin | ISceneLoaderPluginAsync): void;
  127148. /**
  127149. * Import meshes into a scene
  127150. * @param meshNames an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  127151. * @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)
  127152. * @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)
  127153. * @param scene the instance of BABYLON.Scene to append to
  127154. * @param onSuccess a callback with a list of imported meshes, particleSystems, and skeletons when import succeeds
  127155. * @param onProgress a callback with a progress event for each file being loaded
  127156. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  127157. * @param pluginExtension the extension used to determine the plugin
  127158. * @returns The loaded plugin
  127159. */
  127160. 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>;
  127161. /**
  127162. * Import meshes into a scene
  127163. * @param meshNames an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  127164. * @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)
  127165. * @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)
  127166. * @param scene the instance of BABYLON.Scene to append to
  127167. * @param onProgress a callback with a progress event for each file being loaded
  127168. * @param pluginExtension the extension used to determine the plugin
  127169. * @returns The loaded list of imported meshes, particle systems, skeletons, and animation groups
  127170. */
  127171. static ImportMeshAsync(meshNames: any, rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<{
  127172. meshes: AbstractMesh[];
  127173. particleSystems: IParticleSystem[];
  127174. skeletons: Skeleton[];
  127175. animationGroups: AnimationGroup[];
  127176. }>;
  127177. /**
  127178. * Load a scene
  127179. * @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)
  127180. * @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)
  127181. * @param engine is the instance of BABYLON.Engine to use to create the scene
  127182. * @param onSuccess a callback with the scene when import succeeds
  127183. * @param onProgress a callback with a progress event for each file being loaded
  127184. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  127185. * @param pluginExtension the extension used to determine the plugin
  127186. * @returns The loaded plugin
  127187. */
  127188. 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>;
  127189. /**
  127190. * Load a scene
  127191. * @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)
  127192. * @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)
  127193. * @param engine is the instance of BABYLON.Engine to use to create the scene
  127194. * @param onProgress a callback with a progress event for each file being loaded
  127195. * @param pluginExtension the extension used to determine the plugin
  127196. * @returns The loaded scene
  127197. */
  127198. static LoadAsync(rootUrl: string, sceneFilename?: string | File, engine?: Nullable<Engine>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<Scene>;
  127199. /**
  127200. * Append a scene
  127201. * @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)
  127202. * @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)
  127203. * @param scene is the instance of BABYLON.Scene to append to
  127204. * @param onSuccess a callback with the scene when import succeeds
  127205. * @param onProgress a callback with a progress event for each file being loaded
  127206. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  127207. * @param pluginExtension the extension used to determine the plugin
  127208. * @returns The loaded plugin
  127209. */
  127210. 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>;
  127211. /**
  127212. * Append a scene
  127213. * @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)
  127214. * @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)
  127215. * @param scene is the instance of BABYLON.Scene to append to
  127216. * @param onProgress a callback with a progress event for each file being loaded
  127217. * @param pluginExtension the extension used to determine the plugin
  127218. * @returns The given scene
  127219. */
  127220. static AppendAsync(rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<Scene>;
  127221. /**
  127222. * Load a scene into an asset container
  127223. * @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)
  127224. * @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)
  127225. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  127226. * @param onSuccess a callback with the scene when import succeeds
  127227. * @param onProgress a callback with a progress event for each file being loaded
  127228. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  127229. * @param pluginExtension the extension used to determine the plugin
  127230. * @returns The loaded plugin
  127231. */
  127232. 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>;
  127233. /**
  127234. * Load a scene into an asset container
  127235. * @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)
  127236. * @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)
  127237. * @param scene is the instance of Scene to append to
  127238. * @param onProgress a callback with a progress event for each file being loaded
  127239. * @param pluginExtension the extension used to determine the plugin
  127240. * @returns The loaded asset container
  127241. */
  127242. static LoadAssetContainerAsync(rootUrl: string, sceneFilename?: string, scene?: Nullable<Scene>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<AssetContainer>;
  127243. /**
  127244. * Import animations from a file into a scene
  127245. * @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)
  127246. * @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)
  127247. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  127248. * @param overwriteAnimations when true, animations are cleaned before importing new ones. Animations are appended otherwise
  127249. * @param animationGroupLoadingMode defines how to handle old animations groups before importing new ones
  127250. * @param targetConverter defines a function used to convert animation targets from loaded scene to current scene (default: search node by name)
  127251. * @param onSuccess a callback with the scene when import succeeds
  127252. * @param onProgress a callback with a progress event for each file being loaded
  127253. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  127254. * @param pluginExtension the extension used to determine the plugin
  127255. */
  127256. 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;
  127257. /**
  127258. * Import animations from a file into a scene
  127259. * @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)
  127260. * @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)
  127261. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  127262. * @param overwriteAnimations when true, animations are cleaned before importing new ones. Animations are appended otherwise
  127263. * @param animationGroupLoadingMode defines how to handle old animations groups before importing new ones
  127264. * @param targetConverter defines a function used to convert animation targets from loaded scene to current scene (default: search node by name)
  127265. * @param onSuccess a callback with the scene when import succeeds
  127266. * @param onProgress a callback with a progress event for each file being loaded
  127267. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  127268. * @param pluginExtension the extension used to determine the plugin
  127269. * @returns the updated scene with imported animations
  127270. */
  127271. 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>;
  127272. }
  127273. }
  127274. declare module BABYLON {
  127275. /**
  127276. * Handedness type in xrInput profiles. These can be used to define layouts in the Layout Map.
  127277. */
  127278. export type MotionControllerHandedness = "none" | "left" | "right";
  127279. /**
  127280. * The type of components available in motion controllers.
  127281. * This is not the name of the component.
  127282. */
  127283. export type MotionControllerComponentType = "trigger" | "squeeze" | "touchpad" | "thumbstick" | "button";
  127284. /**
  127285. * The state of a controller component
  127286. */
  127287. export type MotionControllerComponentStateType = "default" | "touched" | "pressed";
  127288. /**
  127289. * The schema of motion controller layout.
  127290. * No object will be initialized using this interface
  127291. * This is used just to define the profile.
  127292. */
  127293. export interface IMotionControllerLayout {
  127294. /**
  127295. * Path to load the assets. Usually relative to the base path
  127296. */
  127297. assetPath: string;
  127298. /**
  127299. * Available components (unsorted)
  127300. */
  127301. components: {
  127302. /**
  127303. * A map of component Ids
  127304. */
  127305. [componentId: string]: {
  127306. /**
  127307. * The type of input the component outputs
  127308. */
  127309. type: MotionControllerComponentType;
  127310. /**
  127311. * The indices of this component in the gamepad object
  127312. */
  127313. gamepadIndices: {
  127314. /**
  127315. * Index of button
  127316. */
  127317. button?: number;
  127318. /**
  127319. * If available, index of x-axis
  127320. */
  127321. xAxis?: number;
  127322. /**
  127323. * If available, index of y-axis
  127324. */
  127325. yAxis?: number;
  127326. };
  127327. /**
  127328. * The mesh's root node name
  127329. */
  127330. rootNodeName: string;
  127331. /**
  127332. * Animation definitions for this model
  127333. */
  127334. visualResponses: {
  127335. [stateKey: string]: {
  127336. /**
  127337. * What property will be animated
  127338. */
  127339. componentProperty: "xAxis" | "yAxis" | "button" | "state";
  127340. /**
  127341. * What states influence this visual response
  127342. */
  127343. states: MotionControllerComponentStateType[];
  127344. /**
  127345. * Type of animation - movement or visibility
  127346. */
  127347. valueNodeProperty: "transform" | "visibility";
  127348. /**
  127349. * Base node name to move. Its position will be calculated according to the min and max nodes
  127350. */
  127351. valueNodeName?: string;
  127352. /**
  127353. * Minimum movement node
  127354. */
  127355. minNodeName?: string;
  127356. /**
  127357. * Max movement node
  127358. */
  127359. maxNodeName?: string;
  127360. };
  127361. };
  127362. /**
  127363. * If touch enabled, what is the name of node to display user feedback
  127364. */
  127365. touchPointNodeName?: string;
  127366. };
  127367. };
  127368. /**
  127369. * Is it xr standard mapping or not
  127370. */
  127371. gamepadMapping: "" | "xr-standard";
  127372. /**
  127373. * Base root node of this entire model
  127374. */
  127375. rootNodeName: string;
  127376. /**
  127377. * Defines the main button component id
  127378. */
  127379. selectComponentId: string;
  127380. }
  127381. /**
  127382. * A definition for the layout map in the input profile
  127383. */
  127384. export interface IMotionControllerLayoutMap {
  127385. /**
  127386. * Layouts with handedness type as a key
  127387. */
  127388. [handedness: string]: IMotionControllerLayout;
  127389. }
  127390. /**
  127391. * The XR Input profile schema
  127392. * Profiles can be found here:
  127393. * https://github.com/immersive-web/webxr-input-profiles/tree/master/packages/registry/profiles
  127394. */
  127395. export interface IMotionControllerProfile {
  127396. /**
  127397. * fallback profiles for this profileId
  127398. */
  127399. fallbackProfileIds: string[];
  127400. /**
  127401. * The layout map, with handedness as key
  127402. */
  127403. layouts: IMotionControllerLayoutMap;
  127404. /**
  127405. * The id of this profile
  127406. * correlates to the profile(s) in the xrInput.profiles array
  127407. */
  127408. profileId: string;
  127409. }
  127410. /**
  127411. * A helper-interface for the 3 meshes needed for controller button animation
  127412. * The meshes are provided to the _lerpButtonTransform function to calculate the current position of the value mesh
  127413. */
  127414. export interface IMotionControllerButtonMeshMap {
  127415. /**
  127416. * the mesh that defines the pressed value mesh position.
  127417. * This is used to find the max-position of this button
  127418. */
  127419. pressedMesh: AbstractMesh;
  127420. /**
  127421. * the mesh that defines the unpressed value mesh position.
  127422. * This is used to find the min (or initial) position of this button
  127423. */
  127424. unpressedMesh: AbstractMesh;
  127425. /**
  127426. * The mesh that will be changed when value changes
  127427. */
  127428. valueMesh: AbstractMesh;
  127429. }
  127430. /**
  127431. * A helper-interface for the 3 meshes needed for controller axis animation.
  127432. * This will be expanded when touchpad animations are fully supported
  127433. * The meshes are provided to the _lerpAxisTransform function to calculate the current position of the value mesh
  127434. */
  127435. export interface IMotionControllerMeshMap {
  127436. /**
  127437. * the mesh that defines the maximum value mesh position.
  127438. */
  127439. maxMesh?: AbstractMesh;
  127440. /**
  127441. * the mesh that defines the minimum value mesh position.
  127442. */
  127443. minMesh?: AbstractMesh;
  127444. /**
  127445. * The mesh that will be changed when axis value changes
  127446. */
  127447. valueMesh: AbstractMesh;
  127448. }
  127449. /**
  127450. * The elements needed for change-detection of the gamepad objects in motion controllers
  127451. */
  127452. export interface IMinimalMotionControllerObject {
  127453. /**
  127454. * Available axes of this controller
  127455. */
  127456. axes: number[];
  127457. /**
  127458. * An array of available buttons
  127459. */
  127460. buttons: Array<{
  127461. /**
  127462. * Value of the button/trigger
  127463. */
  127464. value: number;
  127465. /**
  127466. * If the button/trigger is currently touched
  127467. */
  127468. touched: boolean;
  127469. /**
  127470. * If the button/trigger is currently pressed
  127471. */
  127472. pressed: boolean;
  127473. }>;
  127474. /**
  127475. * EXPERIMENTAL haptic support.
  127476. */
  127477. hapticActuators?: Array<{
  127478. pulse: (value: number, duration: number) => Promise<boolean>;
  127479. }>;
  127480. }
  127481. /**
  127482. * An Abstract Motion controller
  127483. * This class receives an xrInput and a profile layout and uses those to initialize the components
  127484. * Each component has an observable to check for changes in value and state
  127485. */
  127486. export abstract class WebXRAbstractMotionController implements IDisposable {
  127487. protected scene: Scene;
  127488. protected layout: IMotionControllerLayout;
  127489. /**
  127490. * The gamepad object correlating to this controller
  127491. */
  127492. gamepadObject: IMinimalMotionControllerObject;
  127493. /**
  127494. * handedness (left/right/none) of this controller
  127495. */
  127496. handedness: MotionControllerHandedness;
  127497. private _initComponent;
  127498. private _modelReady;
  127499. /**
  127500. * A map of components (WebXRControllerComponent) in this motion controller
  127501. * Components have a ComponentType and can also have both button and axis definitions
  127502. */
  127503. readonly components: {
  127504. [id: string]: WebXRControllerComponent;
  127505. };
  127506. /**
  127507. * Disable the model's animation. Can be set at any time.
  127508. */
  127509. disableAnimation: boolean;
  127510. /**
  127511. * Observers registered here will be triggered when the model of this controller is done loading
  127512. */
  127513. onModelLoadedObservable: Observable<WebXRAbstractMotionController>;
  127514. /**
  127515. * The profile id of this motion controller
  127516. */
  127517. abstract profileId: string;
  127518. /**
  127519. * The root mesh of the model. It is null if the model was not yet initialized
  127520. */
  127521. rootMesh: Nullable<AbstractMesh>;
  127522. /**
  127523. * constructs a new abstract motion controller
  127524. * @param scene the scene to which the model of the controller will be added
  127525. * @param layout The profile layout to load
  127526. * @param gamepadObject The gamepad object correlating to this controller
  127527. * @param handedness handedness (left/right/none) of this controller
  127528. * @param _doNotLoadControllerMesh set this flag to ignore the mesh loading
  127529. */
  127530. constructor(scene: Scene, layout: IMotionControllerLayout,
  127531. /**
  127532. * The gamepad object correlating to this controller
  127533. */
  127534. gamepadObject: IMinimalMotionControllerObject,
  127535. /**
  127536. * handedness (left/right/none) of this controller
  127537. */
  127538. handedness: MotionControllerHandedness, _doNotLoadControllerMesh?: boolean);
  127539. /**
  127540. * Dispose this controller, the model mesh and all its components
  127541. */
  127542. dispose(): void;
  127543. /**
  127544. * Returns all components of specific type
  127545. * @param type the type to search for
  127546. * @return an array of components with this type
  127547. */
  127548. getAllComponentsOfType(type: MotionControllerComponentType): WebXRControllerComponent[];
  127549. /**
  127550. * get a component based an its component id as defined in layout.components
  127551. * @param id the id of the component
  127552. * @returns the component correlates to the id or undefined if not found
  127553. */
  127554. getComponent(id: string): WebXRControllerComponent;
  127555. /**
  127556. * Get the list of components available in this motion controller
  127557. * @returns an array of strings correlating to available components
  127558. */
  127559. getComponentIds(): string[];
  127560. /**
  127561. * Get the first component of specific type
  127562. * @param type type of component to find
  127563. * @return a controller component or null if not found
  127564. */
  127565. getComponentOfType(type: MotionControllerComponentType): Nullable<WebXRControllerComponent>;
  127566. /**
  127567. * Get the main (Select) component of this controller as defined in the layout
  127568. * @returns the main component of this controller
  127569. */
  127570. getMainComponent(): WebXRControllerComponent;
  127571. /**
  127572. * Loads the model correlating to this controller
  127573. * When the mesh is loaded, the onModelLoadedObservable will be triggered
  127574. * @returns A promise fulfilled with the result of the model loading
  127575. */
  127576. loadModel(): Promise<boolean>;
  127577. /**
  127578. * Update this model using the current XRFrame
  127579. * @param xrFrame the current xr frame to use and update the model
  127580. */
  127581. updateFromXRFrame(xrFrame: XRFrame): void;
  127582. /**
  127583. * Backwards compatibility due to a deeply-integrated typo
  127584. */
  127585. get handness(): XREye;
  127586. /**
  127587. * Pulse (vibrate) this controller
  127588. * If the controller does not support pulses, this function will fail silently and return Promise<false> directly after called
  127589. * Consecutive calls to this function will cancel the last pulse call
  127590. *
  127591. * @param value the strength of the pulse in 0.0...1.0 range
  127592. * @param duration Duration of the pulse in milliseconds
  127593. * @param hapticActuatorIndex optional index of actuator (will usually be 0)
  127594. * @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
  127595. */
  127596. pulse(value: number, duration: number, hapticActuatorIndex?: number): Promise<boolean>;
  127597. protected _getChildByName(node: AbstractMesh, name: string): AbstractMesh;
  127598. protected _getImmediateChildByName(node: AbstractMesh, name: string): AbstractMesh;
  127599. /**
  127600. * Moves the axis on the controller mesh based on its current state
  127601. * @param axis the index of the axis
  127602. * @param axisValue the value of the axis which determines the meshes new position
  127603. * @hidden
  127604. */
  127605. protected _lerpTransform(axisMap: IMotionControllerMeshMap, axisValue: number, fixValueCoordinates?: boolean): void;
  127606. /**
  127607. * Update the model itself with the current frame data
  127608. * @param xrFrame the frame to use for updating the model mesh
  127609. */
  127610. protected updateModel(xrFrame: XRFrame): void;
  127611. /**
  127612. * Get the filename and path for this controller's model
  127613. * @returns a map of filename and path
  127614. */
  127615. protected abstract _getFilenameAndPath(): {
  127616. filename: string;
  127617. path: string;
  127618. };
  127619. /**
  127620. * This function is called before the mesh is loaded. It checks for loading constraints.
  127621. * For example, this function can check if the GLB loader is available
  127622. * If this function returns false, the generic controller will be loaded instead
  127623. * @returns Is the client ready to load the mesh
  127624. */
  127625. protected abstract _getModelLoadingConstraints(): boolean;
  127626. /**
  127627. * This function will be called after the model was successfully loaded and can be used
  127628. * for mesh transformations before it is available for the user
  127629. * @param meshes the loaded meshes
  127630. */
  127631. protected abstract _processLoadedModel(meshes: AbstractMesh[]): void;
  127632. /**
  127633. * Set the root mesh for this controller. Important for the WebXR controller class
  127634. * @param meshes the loaded meshes
  127635. */
  127636. protected abstract _setRootMesh(meshes: AbstractMesh[]): void;
  127637. /**
  127638. * A function executed each frame that updates the mesh (if needed)
  127639. * @param xrFrame the current xrFrame
  127640. */
  127641. protected abstract _updateModel(xrFrame: XRFrame): void;
  127642. private _getGenericFilenameAndPath;
  127643. private _getGenericParentMesh;
  127644. }
  127645. }
  127646. declare module BABYLON {
  127647. /**
  127648. * A generic trigger-only motion controller for WebXR
  127649. */
  127650. export class WebXRGenericTriggerMotionController extends WebXRAbstractMotionController {
  127651. /**
  127652. * Static version of the profile id of this controller
  127653. */
  127654. static ProfileId: string;
  127655. profileId: string;
  127656. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  127657. protected _getFilenameAndPath(): {
  127658. filename: string;
  127659. path: string;
  127660. };
  127661. protected _getModelLoadingConstraints(): boolean;
  127662. protected _processLoadedModel(meshes: AbstractMesh[]): void;
  127663. protected _setRootMesh(meshes: AbstractMesh[]): void;
  127664. protected _updateModel(): void;
  127665. }
  127666. }
  127667. declare module BABYLON {
  127668. /**
  127669. * Class containing static functions to help procedurally build meshes
  127670. */
  127671. export class SphereBuilder {
  127672. /**
  127673. * Creates a sphere mesh
  127674. * * The parameter `diameter` sets the diameter size (float) of the sphere (default 1)
  127675. * * 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`)
  127676. * * The parameter `segments` sets the sphere number of horizontal stripes (positive integer, default 32)
  127677. * * 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
  127678. * * 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)
  127679. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  127680. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  127681. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  127682. * @param name defines the name of the mesh
  127683. * @param options defines the options used to create the mesh
  127684. * @param scene defines the hosting scene
  127685. * @returns the sphere mesh
  127686. * @see https://doc.babylonjs.com/how_to/set_shapes#sphere
  127687. */
  127688. static CreateSphere(name: string, options: {
  127689. segments?: number;
  127690. diameter?: number;
  127691. diameterX?: number;
  127692. diameterY?: number;
  127693. diameterZ?: number;
  127694. arc?: number;
  127695. slice?: number;
  127696. sideOrientation?: number;
  127697. frontUVs?: Vector4;
  127698. backUVs?: Vector4;
  127699. updatable?: boolean;
  127700. }, scene?: Nullable<Scene>): Mesh;
  127701. }
  127702. }
  127703. declare module BABYLON {
  127704. /**
  127705. * A profiled motion controller has its profile loaded from an online repository.
  127706. * The class is responsible of loading the model, mapping the keys and enabling model-animations
  127707. */
  127708. export class WebXRProfiledMotionController extends WebXRAbstractMotionController {
  127709. private _repositoryUrl;
  127710. private _buttonMeshMapping;
  127711. private _touchDots;
  127712. /**
  127713. * The profile ID of this controller. Will be populated when the controller initializes.
  127714. */
  127715. profileId: string;
  127716. constructor(scene: Scene, xrInput: XRInputSource, _profile: IMotionControllerProfile, _repositoryUrl: string);
  127717. dispose(): void;
  127718. protected _getFilenameAndPath(): {
  127719. filename: string;
  127720. path: string;
  127721. };
  127722. protected _getModelLoadingConstraints(): boolean;
  127723. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  127724. protected _setRootMesh(meshes: AbstractMesh[]): void;
  127725. protected _updateModel(_xrFrame: XRFrame): void;
  127726. }
  127727. }
  127728. declare module BABYLON {
  127729. /**
  127730. * A construction function type to create a new controller based on an xrInput object
  127731. */
  127732. export type MotionControllerConstructor = (xrInput: XRInputSource, scene: Scene) => WebXRAbstractMotionController;
  127733. /**
  127734. * The MotionController Manager manages all registered motion controllers and loads the right one when needed.
  127735. *
  127736. * When this repository is complete: https://github.com/immersive-web/webxr-input-profiles/tree/master/packages/assets
  127737. * it should be replaced with auto-loaded controllers.
  127738. *
  127739. * When using a model try to stay as generic as possible. Eventually there will be no need in any of the controller classes
  127740. */
  127741. export class WebXRMotionControllerManager {
  127742. private static _AvailableControllers;
  127743. private static _Fallbacks;
  127744. private static _ProfileLoadingPromises;
  127745. private static _ProfilesList;
  127746. /**
  127747. * The base URL of the online controller repository. Can be changed at any time.
  127748. */
  127749. static BaseRepositoryUrl: string;
  127750. /**
  127751. * Which repository gets priority - local or online
  127752. */
  127753. static PrioritizeOnlineRepository: boolean;
  127754. /**
  127755. * Use the online repository, or use only locally-defined controllers
  127756. */
  127757. static UseOnlineRepository: boolean;
  127758. /**
  127759. * Clear the cache used for profile loading and reload when requested again
  127760. */
  127761. static ClearProfilesCache(): void;
  127762. /**
  127763. * Register the default fallbacks.
  127764. * This function is called automatically when this file is imported.
  127765. */
  127766. static DefaultFallbacks(): void;
  127767. /**
  127768. * Find a fallback profile if the profile was not found. There are a few predefined generic profiles.
  127769. * @param profileId the profile to which a fallback needs to be found
  127770. * @return an array with corresponding fallback profiles
  127771. */
  127772. static FindFallbackWithProfileId(profileId: string): string[];
  127773. /**
  127774. * When acquiring a new xrInput object (usually by the WebXRInput class), match it with the correct profile.
  127775. * The order of search:
  127776. *
  127777. * 1) Iterate the profiles array of the xr input and try finding a corresponding motion controller
  127778. * 2) (If not found) search in the gamepad id and try using it (legacy versions only)
  127779. * 3) search for registered fallbacks (should be redundant, nonetheless it makes sense to check)
  127780. * 4) return the generic trigger controller if none were found
  127781. *
  127782. * @param xrInput the xrInput to which a new controller is initialized
  127783. * @param scene the scene to which the model will be added
  127784. * @param forceProfile force a certain profile for this controller
  127785. * @return A promise that fulfils with the motion controller class for this profile id or the generic standard class if none was found
  127786. */
  127787. static GetMotionControllerWithXRInput(xrInput: XRInputSource, scene: Scene, forceProfile?: string): Promise<WebXRAbstractMotionController>;
  127788. /**
  127789. * Register a new controller based on its profile. This function will be called by the controller classes themselves.
  127790. *
  127791. * If you are missing a profile, make sure it is imported in your source, otherwise it will not register.
  127792. *
  127793. * @param type the profile type to register
  127794. * @param constructFunction the function to be called when loading this profile
  127795. */
  127796. static RegisterController(type: string, constructFunction: MotionControllerConstructor): void;
  127797. /**
  127798. * Register a fallback to a specific profile.
  127799. * @param profileId the profileId that will receive the fallbacks
  127800. * @param fallbacks A list of fallback profiles
  127801. */
  127802. static RegisterFallbacksForProfileId(profileId: string, fallbacks: string[]): void;
  127803. /**
  127804. * Will update the list of profiles available in the repository
  127805. * @return a promise that resolves to a map of profiles available online
  127806. */
  127807. static UpdateProfilesList(): Promise<{
  127808. [profile: string]: string;
  127809. }>;
  127810. private static _LoadProfileFromRepository;
  127811. private static _LoadProfilesFromAvailableControllers;
  127812. }
  127813. }
  127814. declare module BABYLON {
  127815. /**
  127816. * Configuration options for the WebXR controller creation
  127817. */
  127818. export interface IWebXRControllerOptions {
  127819. /**
  127820. * Should the controller mesh be animated when a user interacts with it
  127821. * The pressed buttons / thumbstick and touchpad animations will be disabled
  127822. */
  127823. disableMotionControllerAnimation?: boolean;
  127824. /**
  127825. * Do not load the controller mesh, in case a different mesh needs to be loaded.
  127826. */
  127827. doNotLoadControllerMesh?: boolean;
  127828. /**
  127829. * Force a specific controller type for this controller.
  127830. * This can be used when creating your own profile or when testing different controllers
  127831. */
  127832. forceControllerProfile?: string;
  127833. /**
  127834. * Defines a rendering group ID for meshes that will be loaded.
  127835. * This is for the default controllers only.
  127836. */
  127837. renderingGroupId?: number;
  127838. }
  127839. /**
  127840. * Represents an XR controller
  127841. */
  127842. export class WebXRInputSource {
  127843. private _scene;
  127844. /** The underlying input source for the controller */
  127845. inputSource: XRInputSource;
  127846. private _options;
  127847. private _tmpVector;
  127848. private _uniqueId;
  127849. /**
  127850. * 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
  127851. */
  127852. grip?: AbstractMesh;
  127853. /**
  127854. * If available, this is the gamepad object related to this controller.
  127855. * Using this object it is possible to get click events and trackpad changes of the
  127856. * webxr controller that is currently being used.
  127857. */
  127858. motionController?: WebXRAbstractMotionController;
  127859. /**
  127860. * Event that fires when the controller is removed/disposed.
  127861. * The object provided as event data is this controller, after associated assets were disposed.
  127862. * uniqueId is still available.
  127863. */
  127864. onDisposeObservable: Observable<WebXRInputSource>;
  127865. /**
  127866. * Will be triggered when the mesh associated with the motion controller is done loading.
  127867. * It is also possible that this will never trigger (!) if no mesh was loaded, or if the developer decides to load a different mesh
  127868. * A shortened version of controller -> motion controller -> on mesh loaded.
  127869. */
  127870. onMeshLoadedObservable: Observable<AbstractMesh>;
  127871. /**
  127872. * Observers registered here will trigger when a motion controller profile was assigned to this xr controller
  127873. */
  127874. onMotionControllerInitObservable: Observable<WebXRAbstractMotionController>;
  127875. /**
  127876. * Pointer which can be used to select objects or attach a visible laser to
  127877. */
  127878. pointer: AbstractMesh;
  127879. /**
  127880. * Creates the input source object
  127881. * @see https://doc.babylonjs.com/how_to/webxr_controllers_support
  127882. * @param _scene the scene which the controller should be associated to
  127883. * @param inputSource the underlying input source for the controller
  127884. * @param _options options for this controller creation
  127885. */
  127886. constructor(_scene: Scene,
  127887. /** The underlying input source for the controller */
  127888. inputSource: XRInputSource, _options?: IWebXRControllerOptions);
  127889. /**
  127890. * Get this controllers unique id
  127891. */
  127892. get uniqueId(): string;
  127893. /**
  127894. * Disposes of the object
  127895. */
  127896. dispose(): void;
  127897. /**
  127898. * Gets a world space ray coming from the pointer or grip
  127899. * @param result the resulting ray
  127900. * @param gripIfAvailable use the grip mesh instead of the pointer, if available
  127901. */
  127902. getWorldPointerRayToRef(result: Ray, gripIfAvailable?: boolean): void;
  127903. /**
  127904. * Updates the controller pose based on the given XRFrame
  127905. * @param xrFrame xr frame to update the pose with
  127906. * @param referenceSpace reference space to use
  127907. */
  127908. updateFromXRFrame(xrFrame: XRFrame, referenceSpace: XRReferenceSpace): void;
  127909. }
  127910. }
  127911. declare module BABYLON {
  127912. /**
  127913. * The schema for initialization options of the XR Input class
  127914. */
  127915. export interface IWebXRInputOptions {
  127916. /**
  127917. * If set to true no model will be automatically loaded
  127918. */
  127919. doNotLoadControllerMeshes?: boolean;
  127920. /**
  127921. * If set, this profile will be used for all controllers loaded (for example "microsoft-mixed-reality")
  127922. * If not found, the xr input profile data will be used.
  127923. * Profiles are defined here - https://github.com/immersive-web/webxr-input-profiles/
  127924. */
  127925. forceInputProfile?: string;
  127926. /**
  127927. * Do not send a request to the controller repository to load the profile.
  127928. *
  127929. * Instead, use the controllers available in babylon itself.
  127930. */
  127931. disableOnlineControllerRepository?: boolean;
  127932. /**
  127933. * A custom URL for the controllers repository
  127934. */
  127935. customControllersRepositoryURL?: string;
  127936. /**
  127937. * Should the controller model's components not move according to the user input
  127938. */
  127939. disableControllerAnimation?: boolean;
  127940. /**
  127941. * Optional options to pass to the controller. Will be overridden by the Input options where applicable
  127942. */
  127943. controllerOptions?: IWebXRControllerOptions;
  127944. }
  127945. /**
  127946. * XR input used to track XR inputs such as controllers/rays
  127947. */
  127948. export class WebXRInput implements IDisposable {
  127949. /**
  127950. * the xr session manager for this session
  127951. */
  127952. xrSessionManager: WebXRSessionManager;
  127953. /**
  127954. * the WebXR camera for this session. Mainly used for teleportation
  127955. */
  127956. xrCamera: WebXRCamera;
  127957. private readonly options;
  127958. /**
  127959. * XR controllers being tracked
  127960. */
  127961. controllers: Array<WebXRInputSource>;
  127962. private _frameObserver;
  127963. private _sessionEndedObserver;
  127964. private _sessionInitObserver;
  127965. /**
  127966. * Event when a controller has been connected/added
  127967. */
  127968. onControllerAddedObservable: Observable<WebXRInputSource>;
  127969. /**
  127970. * Event when a controller has been removed/disconnected
  127971. */
  127972. onControllerRemovedObservable: Observable<WebXRInputSource>;
  127973. /**
  127974. * Initializes the WebXRInput
  127975. * @param xrSessionManager the xr session manager for this session
  127976. * @param xrCamera the WebXR camera for this session. Mainly used for teleportation
  127977. * @param options = initialization options for this xr input
  127978. */
  127979. constructor(
  127980. /**
  127981. * the xr session manager for this session
  127982. */
  127983. xrSessionManager: WebXRSessionManager,
  127984. /**
  127985. * the WebXR camera for this session. Mainly used for teleportation
  127986. */
  127987. xrCamera: WebXRCamera, options?: IWebXRInputOptions);
  127988. private _onInputSourcesChange;
  127989. private _addAndRemoveControllers;
  127990. /**
  127991. * Disposes of the object
  127992. */
  127993. dispose(): void;
  127994. }
  127995. }
  127996. declare module BABYLON {
  127997. /**
  127998. * This is the base class for all WebXR features.
  127999. * Since most features require almost the same resources and callbacks, this class can be used to simplify the development
  128000. * Note that since the features manager is using the `IWebXRFeature` you are in no way obligated to use this class
  128001. */
  128002. export abstract class WebXRAbstractFeature implements IWebXRFeature {
  128003. protected _xrSessionManager: WebXRSessionManager;
  128004. private _attached;
  128005. private _removeOnDetach;
  128006. /**
  128007. * Should auto-attach be disabled?
  128008. */
  128009. disableAutoAttach: boolean;
  128010. /**
  128011. * The name of the native xr feature name (like anchor, hit-test, or hand-tracking)
  128012. */
  128013. xrNativeFeatureName: string;
  128014. /**
  128015. * Construct a new (abstract) WebXR feature
  128016. * @param _xrSessionManager the xr session manager for this feature
  128017. */
  128018. constructor(_xrSessionManager: WebXRSessionManager);
  128019. /**
  128020. * Is this feature attached
  128021. */
  128022. get attached(): boolean;
  128023. /**
  128024. * attach this feature
  128025. *
  128026. * @param force should attachment be forced (even when already attached)
  128027. * @returns true if successful, false is failed or already attached
  128028. */
  128029. attach(force?: boolean): boolean;
  128030. /**
  128031. * detach this feature.
  128032. *
  128033. * @returns true if successful, false if failed or already detached
  128034. */
  128035. detach(): boolean;
  128036. /**
  128037. * Dispose this feature and all of the resources attached
  128038. */
  128039. dispose(): void;
  128040. /**
  128041. * This function will be executed during before enabling the feature and can be used to not-allow enabling it.
  128042. * Note that at this point the session has NOT started, so this is purely checking if the browser supports it
  128043. *
  128044. * @returns whether or not the feature is compatible in this environment
  128045. */
  128046. isCompatible(): boolean;
  128047. /**
  128048. * This is used to register callbacks that will automatically be removed when detach is called.
  128049. * @param observable the observable to which the observer will be attached
  128050. * @param callback the callback to register
  128051. */
  128052. protected _addNewAttachObserver<T>(observable: Observable<T>, callback: (eventData: T, eventState: EventState) => void): void;
  128053. /**
  128054. * Code in this function will be executed on each xrFrame received from the browser.
  128055. * This function will not execute after the feature is detached.
  128056. * @param _xrFrame the current frame
  128057. */
  128058. protected abstract _onXRFrame(_xrFrame: XRFrame): void;
  128059. }
  128060. }
  128061. declare module BABYLON {
  128062. /**
  128063. * Renders a layer on top of an existing scene
  128064. */
  128065. export class UtilityLayerRenderer implements IDisposable {
  128066. /** the original scene that will be rendered on top of */
  128067. originalScene: Scene;
  128068. private _pointerCaptures;
  128069. private _lastPointerEvents;
  128070. private static _DefaultUtilityLayer;
  128071. private static _DefaultKeepDepthUtilityLayer;
  128072. private _sharedGizmoLight;
  128073. private _renderCamera;
  128074. /**
  128075. * Gets the camera that is used to render the utility layer (when not set, this will be the last active camera)
  128076. * @param getRigParentIfPossible if the current active camera is a rig camera, should its parent camera be returned
  128077. * @returns the camera that is used when rendering the utility layer
  128078. */
  128079. getRenderCamera(getRigParentIfPossible?: boolean): Camera;
  128080. /**
  128081. * Sets the camera that should be used when rendering the utility layer (If set to null the last active camera will be used)
  128082. * @param cam the camera that should be used when rendering the utility layer
  128083. */
  128084. setRenderCamera(cam: Nullable<Camera>): void;
  128085. /**
  128086. * @hidden
  128087. * Light which used by gizmos to get light shading
  128088. */
  128089. _getSharedGizmoLight(): HemisphericLight;
  128090. /**
  128091. * If the picking should be done on the utility layer prior to the actual scene (Default: true)
  128092. */
  128093. pickUtilitySceneFirst: boolean;
  128094. /**
  128095. * 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)
  128096. */
  128097. static get DefaultUtilityLayer(): UtilityLayerRenderer;
  128098. /**
  128099. * 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)
  128100. */
  128101. static get DefaultKeepDepthUtilityLayer(): UtilityLayerRenderer;
  128102. /**
  128103. * The scene that is rendered on top of the original scene
  128104. */
  128105. utilityLayerScene: Scene;
  128106. /**
  128107. * If the utility layer should automatically be rendered on top of existing scene
  128108. */
  128109. shouldRender: boolean;
  128110. /**
  128111. * If set to true, only pointer down onPointerObservable events will be blocked when picking is occluded by original scene
  128112. */
  128113. onlyCheckPointerDownEvents: boolean;
  128114. /**
  128115. * If set to false, only pointerUp, pointerDown and pointerMove will be sent to the utilityLayerScene (false by default)
  128116. */
  128117. processAllEvents: boolean;
  128118. /**
  128119. * Observable raised when the pointer move from the utility layer scene to the main scene
  128120. */
  128121. onPointerOutObservable: Observable<number>;
  128122. /** Gets or sets a predicate that will be used to indicate utility meshes present in the main scene */
  128123. mainSceneTrackerPredicate: (mesh: Nullable<AbstractMesh>) => boolean;
  128124. private _afterRenderObserver;
  128125. private _sceneDisposeObserver;
  128126. private _originalPointerObserver;
  128127. /**
  128128. * Instantiates a UtilityLayerRenderer
  128129. * @param originalScene the original scene that will be rendered on top of
  128130. * @param handleEvents boolean indicating if the utility layer should handle events
  128131. */
  128132. constructor(
  128133. /** the original scene that will be rendered on top of */
  128134. originalScene: Scene, handleEvents?: boolean);
  128135. private _notifyObservers;
  128136. /**
  128137. * Renders the utility layers scene on top of the original scene
  128138. */
  128139. render(): void;
  128140. /**
  128141. * Disposes of the renderer
  128142. */
  128143. dispose(): void;
  128144. private _updateCamera;
  128145. }
  128146. }
  128147. declare module BABYLON {
  128148. /**
  128149. * Options interface for the pointer selection module
  128150. */
  128151. export interface IWebXRControllerPointerSelectionOptions {
  128152. /**
  128153. * if provided, this scene will be used to render meshes.
  128154. */
  128155. customUtilityLayerScene?: Scene;
  128156. /**
  128157. * 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)
  128158. * If not disabled, the last picked point will be used to execute a pointer up event
  128159. * If disabled, pointer up event will be triggered right after the pointer down event.
  128160. * Used in screen and gaze target ray mode only
  128161. */
  128162. disablePointerUpOnTouchOut: boolean;
  128163. /**
  128164. * For gaze mode for tracked-pointer / controllers (time to select instead of button press)
  128165. */
  128166. forceGazeMode: boolean;
  128167. /**
  128168. * 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
  128169. * to start a new countdown to the pointer down event.
  128170. * Defaults to 1.
  128171. */
  128172. gazeModePointerMovedFactor?: number;
  128173. /**
  128174. * Different button type to use instead of the main component
  128175. */
  128176. overrideButtonId?: string;
  128177. /**
  128178. * use this rendering group id for the meshes (optional)
  128179. */
  128180. renderingGroupId?: number;
  128181. /**
  128182. * The amount of time in milliseconds it takes between pick found something to a pointer down event.
  128183. * Used in gaze modes. Tracked pointer uses the trigger, screen uses touch events
  128184. * 3000 means 3 seconds between pointing at something and selecting it
  128185. */
  128186. timeToSelect?: number;
  128187. /**
  128188. * Should meshes created here be added to a utility layer or the main scene
  128189. */
  128190. useUtilityLayer?: boolean;
  128191. /**
  128192. * Optional WebXR camera to be used for gaze selection
  128193. */
  128194. gazeCamera?: WebXRCamera;
  128195. /**
  128196. * the xr input to use with this pointer selection
  128197. */
  128198. xrInput: WebXRInput;
  128199. }
  128200. /**
  128201. * A module that will enable pointer selection for motion controllers of XR Input Sources
  128202. */
  128203. export class WebXRControllerPointerSelection extends WebXRAbstractFeature {
  128204. private readonly _options;
  128205. private static _idCounter;
  128206. private _attachController;
  128207. private _controllers;
  128208. private _scene;
  128209. private _tmpVectorForPickCompare;
  128210. /**
  128211. * The module's name
  128212. */
  128213. static readonly Name: string;
  128214. /**
  128215. * The (Babylon) version of this module.
  128216. * This is an integer representing the implementation version.
  128217. * This number does not correspond to the WebXR specs version
  128218. */
  128219. static readonly Version: number;
  128220. /**
  128221. * Disable lighting on the laser pointer (so it will always be visible)
  128222. */
  128223. disablePointerLighting: boolean;
  128224. /**
  128225. * Disable lighting on the selection mesh (so it will always be visible)
  128226. */
  128227. disableSelectionMeshLighting: boolean;
  128228. /**
  128229. * Should the laser pointer be displayed
  128230. */
  128231. displayLaserPointer: boolean;
  128232. /**
  128233. * Should the selection mesh be displayed (The ring at the end of the laser pointer)
  128234. */
  128235. displaySelectionMesh: boolean;
  128236. /**
  128237. * This color will be set to the laser pointer when selection is triggered
  128238. */
  128239. laserPointerPickedColor: Color3;
  128240. /**
  128241. * Default color of the laser pointer
  128242. */
  128243. laserPointerDefaultColor: Color3;
  128244. /**
  128245. * default color of the selection ring
  128246. */
  128247. selectionMeshDefaultColor: Color3;
  128248. /**
  128249. * This color will be applied to the selection ring when selection is triggered
  128250. */
  128251. selectionMeshPickedColor: Color3;
  128252. /**
  128253. * Optional filter to be used for ray selection. This predicate shares behavior with
  128254. * scene.pointerMovePredicate which takes priority if it is also assigned.
  128255. */
  128256. raySelectionPredicate: (mesh: AbstractMesh) => boolean;
  128257. /**
  128258. * constructs a new background remover module
  128259. * @param _xrSessionManager the session manager for this module
  128260. * @param _options read-only options to be used in this module
  128261. */
  128262. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRControllerPointerSelectionOptions);
  128263. /**
  128264. * attach this feature
  128265. * Will usually be called by the features manager
  128266. *
  128267. * @returns true if successful.
  128268. */
  128269. attach(): boolean;
  128270. /**
  128271. * detach this feature.
  128272. * Will usually be called by the features manager
  128273. *
  128274. * @returns true if successful.
  128275. */
  128276. detach(): boolean;
  128277. /**
  128278. * Will get the mesh under a specific pointer.
  128279. * `scene.meshUnderPointer` will only return one mesh - either left or right.
  128280. * @param controllerId the controllerId to check
  128281. * @returns The mesh under pointer or null if no mesh is under the pointer
  128282. */
  128283. getMeshUnderPointer(controllerId: string): Nullable<AbstractMesh>;
  128284. /**
  128285. * Get the xr controller that correlates to the pointer id in the pointer event
  128286. *
  128287. * @param id the pointer id to search for
  128288. * @returns the controller that correlates to this id or null if not found
  128289. */
  128290. getXRControllerByPointerId(id: number): Nullable<WebXRInputSource>;
  128291. protected _onXRFrame(_xrFrame: XRFrame): void;
  128292. private _attachGazeMode;
  128293. private _attachScreenRayMode;
  128294. private _attachTrackedPointerRayMode;
  128295. private _convertNormalToDirectionOfRay;
  128296. private _detachController;
  128297. private _generateNewMeshPair;
  128298. private _pickingMoved;
  128299. private _updatePointerDistance;
  128300. /** @hidden */
  128301. get lasterPointerDefaultColor(): Color3;
  128302. }
  128303. }
  128304. declare module BABYLON {
  128305. /**
  128306. * Button which can be used to enter a different mode of XR
  128307. */
  128308. export class WebXREnterExitUIButton {
  128309. /** button element */
  128310. element: HTMLElement;
  128311. /** XR initialization options for the button */
  128312. sessionMode: XRSessionMode;
  128313. /** Reference space type */
  128314. referenceSpaceType: XRReferenceSpaceType;
  128315. /**
  128316. * Creates a WebXREnterExitUIButton
  128317. * @param element button element
  128318. * @param sessionMode XR initialization session mode
  128319. * @param referenceSpaceType the type of reference space to be used
  128320. */
  128321. constructor(
  128322. /** button element */
  128323. element: HTMLElement,
  128324. /** XR initialization options for the button */
  128325. sessionMode: XRSessionMode,
  128326. /** Reference space type */
  128327. referenceSpaceType: XRReferenceSpaceType);
  128328. /**
  128329. * Extendable function which can be used to update the button's visuals when the state changes
  128330. * @param activeButton the current active button in the UI
  128331. */
  128332. update(activeButton: Nullable<WebXREnterExitUIButton>): void;
  128333. }
  128334. /**
  128335. * Options to create the webXR UI
  128336. */
  128337. export class WebXREnterExitUIOptions {
  128338. /**
  128339. * User provided buttons to enable/disable WebXR. The system will provide default if not set
  128340. */
  128341. customButtons?: Array<WebXREnterExitUIButton>;
  128342. /**
  128343. * A reference space type to use when creating the default button.
  128344. * Default is local-floor
  128345. */
  128346. referenceSpaceType?: XRReferenceSpaceType;
  128347. /**
  128348. * Context to enter xr with
  128349. */
  128350. renderTarget?: Nullable<WebXRRenderTarget>;
  128351. /**
  128352. * A session mode to use when creating the default button.
  128353. * Default is immersive-vr
  128354. */
  128355. sessionMode?: XRSessionMode;
  128356. /**
  128357. * A list of optional features to init the session with
  128358. */
  128359. optionalFeatures?: string[];
  128360. /**
  128361. * A list of optional features to init the session with
  128362. */
  128363. requiredFeatures?: string[];
  128364. }
  128365. /**
  128366. * UI to allow the user to enter/exit XR mode
  128367. */
  128368. export class WebXREnterExitUI implements IDisposable {
  128369. private scene;
  128370. /** version of the options passed to this UI */
  128371. options: WebXREnterExitUIOptions;
  128372. private _activeButton;
  128373. private _buttons;
  128374. private _overlay;
  128375. /**
  128376. * Fired every time the active button is changed.
  128377. *
  128378. * When xr is entered via a button that launches xr that button will be the callback parameter
  128379. *
  128380. * When exiting xr the callback parameter will be null)
  128381. */
  128382. activeButtonChangedObservable: Observable<Nullable<WebXREnterExitUIButton>>;
  128383. /**
  128384. *
  128385. * @param scene babylon scene object to use
  128386. * @param options (read-only) version of the options passed to this UI
  128387. */
  128388. private constructor();
  128389. /**
  128390. * Creates UI to allow the user to enter/exit XR mode
  128391. * @param scene the scene to add the ui to
  128392. * @param helper the xr experience helper to enter/exit xr with
  128393. * @param options options to configure the UI
  128394. * @returns the created ui
  128395. */
  128396. static CreateAsync(scene: Scene, helper: WebXRExperienceHelper, options: WebXREnterExitUIOptions): Promise<WebXREnterExitUI>;
  128397. /**
  128398. * Disposes of the XR UI component
  128399. */
  128400. dispose(): void;
  128401. private _updateButtons;
  128402. }
  128403. }
  128404. declare module BABYLON {
  128405. /**
  128406. * Class containing static functions to help procedurally build meshes
  128407. */
  128408. export class LinesBuilder {
  128409. /**
  128410. * Creates a line system mesh. A line system is a pool of many lines gathered in a single mesh
  128411. * * 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
  128412. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineSystem to this static function
  128413. * * The parameter `lines` is an array of lines, each line being an array of successive Vector3
  128414. * * The optional parameter `instance` is an instance of an existing LineSystem object to be updated with the passed `lines` parameter
  128415. * * The optional parameter `colors` is an array of line colors, each line colors being an array of successive Color4, one per line point
  128416. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  128417. * * 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
  128418. * * When updating an instance, remember that only line point positions can change, not the number of points, neither the number of lines
  128419. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  128420. * @see https://doc.babylonjs.com/how_to/parametric_shapes#line-system
  128421. * @param name defines the name of the new line system
  128422. * @param options defines the options used to create the line system
  128423. * @param scene defines the hosting scene
  128424. * @returns a new line system mesh
  128425. */
  128426. static CreateLineSystem(name: string, options: {
  128427. lines: Vector3[][];
  128428. updatable?: boolean;
  128429. instance?: Nullable<LinesMesh>;
  128430. colors?: Nullable<Color4[][]>;
  128431. useVertexAlpha?: boolean;
  128432. }, scene: Nullable<Scene>): LinesMesh;
  128433. /**
  128434. * Creates a line mesh
  128435. * 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
  128436. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  128437. * * The parameter `points` is an array successive Vector3
  128438. * * 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
  128439. * * The optional parameter `colors` is an array of successive Color4, one per line point
  128440. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need alpha blending (faster)
  128441. * * When updating an instance, remember that only point positions can change, not the number of points
  128442. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  128443. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lines
  128444. * @param name defines the name of the new line system
  128445. * @param options defines the options used to create the line system
  128446. * @param scene defines the hosting scene
  128447. * @returns a new line mesh
  128448. */
  128449. static CreateLines(name: string, options: {
  128450. points: Vector3[];
  128451. updatable?: boolean;
  128452. instance?: Nullable<LinesMesh>;
  128453. colors?: Color4[];
  128454. useVertexAlpha?: boolean;
  128455. }, scene?: Nullable<Scene>): LinesMesh;
  128456. /**
  128457. * Creates a dashed line mesh
  128458. * * 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
  128459. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  128460. * * The parameter `points` is an array successive Vector3
  128461. * * The parameter `dashNb` is the intended total number of dashes (positive integer, default 200)
  128462. * * The parameter `dashSize` is the size of the dashes relatively the dash number (positive float, default 3)
  128463. * * The parameter `gapSize` is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  128464. * * 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
  128465. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  128466. * * When updating an instance, remember that only point positions can change, not the number of points
  128467. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  128468. * @param name defines the name of the mesh
  128469. * @param options defines the options used to create the mesh
  128470. * @param scene defines the hosting scene
  128471. * @returns the dashed line mesh
  128472. * @see https://doc.babylonjs.com/how_to/parametric_shapes#dashed-lines
  128473. */
  128474. static CreateDashedLines(name: string, options: {
  128475. points: Vector3[];
  128476. dashSize?: number;
  128477. gapSize?: number;
  128478. dashNb?: number;
  128479. updatable?: boolean;
  128480. instance?: LinesMesh;
  128481. useVertexAlpha?: boolean;
  128482. }, scene?: Nullable<Scene>): LinesMesh;
  128483. }
  128484. }
  128485. declare module BABYLON {
  128486. /**
  128487. * Construction options for a timer
  128488. */
  128489. export interface ITimerOptions<T> {
  128490. /**
  128491. * Time-to-end
  128492. */
  128493. timeout: number;
  128494. /**
  128495. * The context observable is used to calculate time deltas and provides the context of the timer's callbacks. Will usually be OnBeforeRenderObservable.
  128496. * Countdown calculation is done ONLY when the observable is notifying its observers, meaning that if
  128497. * you choose an observable that doesn't trigger too often, the wait time might extend further than the requested max time
  128498. */
  128499. contextObservable: Observable<T>;
  128500. /**
  128501. * Optional parameters when adding an observer to the observable
  128502. */
  128503. observableParameters?: {
  128504. mask?: number;
  128505. insertFirst?: boolean;
  128506. scope?: any;
  128507. };
  128508. /**
  128509. * An optional break condition that will stop the times prematurely. In this case onEnded will not be triggered!
  128510. */
  128511. breakCondition?: (data?: ITimerData<T>) => boolean;
  128512. /**
  128513. * Will be triggered when the time condition has met
  128514. */
  128515. onEnded?: (data: ITimerData<any>) => void;
  128516. /**
  128517. * Will be triggered when the break condition has met (prematurely ended)
  128518. */
  128519. onAborted?: (data: ITimerData<any>) => void;
  128520. /**
  128521. * Optional function to execute on each tick (or count)
  128522. */
  128523. onTick?: (data: ITimerData<any>) => void;
  128524. }
  128525. /**
  128526. * An interface defining the data sent by the timer
  128527. */
  128528. export interface ITimerData<T> {
  128529. /**
  128530. * When did it start
  128531. */
  128532. startTime: number;
  128533. /**
  128534. * Time now
  128535. */
  128536. currentTime: number;
  128537. /**
  128538. * Time passed since started
  128539. */
  128540. deltaTime: number;
  128541. /**
  128542. * How much is completed, in [0.0...1.0].
  128543. * Note that this CAN be higher than 1 due to the fact that we don't actually measure time but delta between observable calls
  128544. */
  128545. completeRate: number;
  128546. /**
  128547. * What the registered observable sent in the last count
  128548. */
  128549. payload: T;
  128550. }
  128551. /**
  128552. * The current state of the timer
  128553. */
  128554. export enum TimerState {
  128555. /**
  128556. * Timer initialized, not yet started
  128557. */
  128558. INIT = 0,
  128559. /**
  128560. * Timer started and counting
  128561. */
  128562. STARTED = 1,
  128563. /**
  128564. * Timer ended (whether aborted or time reached)
  128565. */
  128566. ENDED = 2
  128567. }
  128568. /**
  128569. * A simple version of the timer. Will take options and start the timer immediately after calling it
  128570. *
  128571. * @param options options with which to initialize this timer
  128572. */
  128573. export function setAndStartTimer(options: ITimerOptions<any>): Nullable<Observer<any>>;
  128574. /**
  128575. * An advanced implementation of a timer class
  128576. */
  128577. export class AdvancedTimer<T = any> implements IDisposable {
  128578. /**
  128579. * Will notify each time the timer calculates the remaining time
  128580. */
  128581. onEachCountObservable: Observable<ITimerData<T>>;
  128582. /**
  128583. * Will trigger when the timer was aborted due to the break condition
  128584. */
  128585. onTimerAbortedObservable: Observable<ITimerData<T>>;
  128586. /**
  128587. * Will trigger when the timer ended successfully
  128588. */
  128589. onTimerEndedObservable: Observable<ITimerData<T>>;
  128590. /**
  128591. * Will trigger when the timer state has changed
  128592. */
  128593. onStateChangedObservable: Observable<TimerState>;
  128594. private _observer;
  128595. private _contextObservable;
  128596. private _observableParameters;
  128597. private _startTime;
  128598. private _timer;
  128599. private _state;
  128600. private _breakCondition;
  128601. private _timeToEnd;
  128602. private _breakOnNextTick;
  128603. /**
  128604. * Will construct a new advanced timer based on the options provided. Timer will not start until start() is called.
  128605. * @param options construction options for this advanced timer
  128606. */
  128607. constructor(options: ITimerOptions<T>);
  128608. /**
  128609. * set a breaking condition for this timer. Default is to never break during count
  128610. * @param predicate the new break condition. Returns true to break, false otherwise
  128611. */
  128612. set breakCondition(predicate: (data: ITimerData<T>) => boolean);
  128613. /**
  128614. * Reset ALL associated observables in this advanced timer
  128615. */
  128616. clearObservables(): void;
  128617. /**
  128618. * Will start a new iteration of this timer. Only one instance of this timer can run at a time.
  128619. *
  128620. * @param timeToEnd how much time to measure until timer ended
  128621. */
  128622. start(timeToEnd?: number): void;
  128623. /**
  128624. * Will force a stop on the next tick.
  128625. */
  128626. stop(): void;
  128627. /**
  128628. * Dispose this timer, clearing all resources
  128629. */
  128630. dispose(): void;
  128631. private _setState;
  128632. private _tick;
  128633. private _stop;
  128634. }
  128635. }
  128636. declare module BABYLON {
  128637. /**
  128638. * The options container for the teleportation module
  128639. */
  128640. export interface IWebXRTeleportationOptions {
  128641. /**
  128642. * if provided, this scene will be used to render meshes.
  128643. */
  128644. customUtilityLayerScene?: Scene;
  128645. /**
  128646. * Values to configure the default target mesh
  128647. */
  128648. defaultTargetMeshOptions?: {
  128649. /**
  128650. * Fill color of the teleportation area
  128651. */
  128652. teleportationFillColor?: string;
  128653. /**
  128654. * Border color for the teleportation area
  128655. */
  128656. teleportationBorderColor?: string;
  128657. /**
  128658. * Disable the mesh's animation sequence
  128659. */
  128660. disableAnimation?: boolean;
  128661. /**
  128662. * Disable lighting on the material or the ring and arrow
  128663. */
  128664. disableLighting?: boolean;
  128665. /**
  128666. * Override the default material of the torus and arrow
  128667. */
  128668. torusArrowMaterial?: Material;
  128669. };
  128670. /**
  128671. * A list of meshes to use as floor meshes.
  128672. * Meshes can be added and removed after initializing the feature using the
  128673. * addFloorMesh and removeFloorMesh functions
  128674. * If empty, rotation will still work
  128675. */
  128676. floorMeshes?: AbstractMesh[];
  128677. /**
  128678. * use this rendering group id for the meshes (optional)
  128679. */
  128680. renderingGroupId?: number;
  128681. /**
  128682. * Should teleportation move only to snap points
  128683. */
  128684. snapPointsOnly?: boolean;
  128685. /**
  128686. * An array of points to which the teleportation will snap to.
  128687. * If the teleportation ray is in the proximity of one of those points, it will be corrected to this point.
  128688. */
  128689. snapPositions?: Vector3[];
  128690. /**
  128691. * How close should the teleportation ray be in order to snap to position.
  128692. * Default to 0.8 units (meters)
  128693. */
  128694. snapToPositionRadius?: number;
  128695. /**
  128696. * Provide your own teleportation mesh instead of babylon's wonderful doughnut.
  128697. * If you want to support rotation, make sure your mesh has a direction indicator.
  128698. *
  128699. * When left untouched, the default mesh will be initialized.
  128700. */
  128701. teleportationTargetMesh?: AbstractMesh;
  128702. /**
  128703. * If main component is used (no thumbstick), how long should the "long press" take before teleport
  128704. */
  128705. timeToTeleport?: number;
  128706. /**
  128707. * Disable using the thumbstick and use the main component (usually trigger) on long press.
  128708. * This will be automatically true if the controller doesn't have a thumbstick or touchpad.
  128709. */
  128710. useMainComponentOnly?: boolean;
  128711. /**
  128712. * Should meshes created here be added to a utility layer or the main scene
  128713. */
  128714. useUtilityLayer?: boolean;
  128715. /**
  128716. * Babylon XR Input class for controller
  128717. */
  128718. xrInput: WebXRInput;
  128719. }
  128720. /**
  128721. * This is a teleportation feature to be used with WebXR-enabled motion controllers.
  128722. * When enabled and attached, the feature will allow a user to move around and rotate in the scene using
  128723. * the input of the attached controllers.
  128724. */
  128725. export class WebXRMotionControllerTeleportation extends WebXRAbstractFeature {
  128726. private _options;
  128727. private _controllers;
  128728. private _currentTeleportationControllerId;
  128729. private _floorMeshes;
  128730. private _quadraticBezierCurve;
  128731. private _selectionFeature;
  128732. private _snapToPositions;
  128733. private _snappedToPoint;
  128734. private _teleportationRingMaterial?;
  128735. private _tmpRay;
  128736. private _tmpVector;
  128737. /**
  128738. * The module's name
  128739. */
  128740. static readonly Name: string;
  128741. /**
  128742. * The (Babylon) version of this module.
  128743. * This is an integer representing the implementation version.
  128744. * This number does not correspond to the webxr specs version
  128745. */
  128746. static readonly Version: number;
  128747. /**
  128748. * Is movement backwards enabled
  128749. */
  128750. backwardsMovementEnabled: boolean;
  128751. /**
  128752. * Distance to travel when moving backwards
  128753. */
  128754. backwardsTeleportationDistance: number;
  128755. /**
  128756. * The distance from the user to the inspection point in the direction of the controller
  128757. * A higher number will allow the user to move further
  128758. * defaults to 5 (meters, in xr units)
  128759. */
  128760. parabolicCheckRadius: number;
  128761. /**
  128762. * Should the module support parabolic ray on top of direct ray
  128763. * If enabled, the user will be able to point "at the sky" and move according to predefined radius distance
  128764. * Very helpful when moving between floors / different heights
  128765. */
  128766. parabolicRayEnabled: boolean;
  128767. /**
  128768. * How much rotation should be applied when rotating right and left
  128769. */
  128770. rotationAngle: number;
  128771. /**
  128772. * Is rotation enabled when moving forward?
  128773. * Disabling this feature will prevent the user from deciding the direction when teleporting
  128774. */
  128775. rotationEnabled: boolean;
  128776. /**
  128777. * constructs a new anchor system
  128778. * @param _xrSessionManager an instance of WebXRSessionManager
  128779. * @param _options configuration object for this feature
  128780. */
  128781. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRTeleportationOptions);
  128782. /**
  128783. * Get the snapPointsOnly flag
  128784. */
  128785. get snapPointsOnly(): boolean;
  128786. /**
  128787. * Sets the snapPointsOnly flag
  128788. * @param snapToPoints should teleportation be exclusively to snap points
  128789. */
  128790. set snapPointsOnly(snapToPoints: boolean);
  128791. /**
  128792. * Add a new mesh to the floor meshes array
  128793. * @param mesh the mesh to use as floor mesh
  128794. */
  128795. addFloorMesh(mesh: AbstractMesh): void;
  128796. /**
  128797. * Add a new snap-to point to fix teleportation to this position
  128798. * @param newSnapPoint The new Snap-To point
  128799. */
  128800. addSnapPoint(newSnapPoint: Vector3): void;
  128801. attach(): boolean;
  128802. detach(): boolean;
  128803. dispose(): void;
  128804. /**
  128805. * Remove a mesh from the floor meshes array
  128806. * @param mesh the mesh to remove
  128807. */
  128808. removeFloorMesh(mesh: AbstractMesh): void;
  128809. /**
  128810. * Remove a mesh from the floor meshes array using its name
  128811. * @param name the mesh name to remove
  128812. */
  128813. removeFloorMeshByName(name: string): void;
  128814. /**
  128815. * 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
  128816. * @param snapPointToRemove the point (or a clone of it) to be removed from the array
  128817. * @returns was the point found and removed or not
  128818. */
  128819. removeSnapPoint(snapPointToRemove: Vector3): boolean;
  128820. /**
  128821. * This function sets a selection feature that will be disabled when
  128822. * the forward ray is shown and will be reattached when hidden.
  128823. * This is used to remove the selection rays when moving.
  128824. * @param selectionFeature the feature to disable when forward movement is enabled
  128825. */
  128826. setSelectionFeature(selectionFeature: IWebXRFeature): void;
  128827. protected _onXRFrame(_xrFrame: XRFrame): void;
  128828. private _attachController;
  128829. private _createDefaultTargetMesh;
  128830. private _detachController;
  128831. private _findClosestSnapPointWithRadius;
  128832. private _setTargetMeshPosition;
  128833. private _setTargetMeshVisibility;
  128834. private _showParabolicPath;
  128835. private _teleportForward;
  128836. }
  128837. }
  128838. declare module BABYLON {
  128839. /**
  128840. * Options for the default xr helper
  128841. */
  128842. export class WebXRDefaultExperienceOptions {
  128843. /**
  128844. * Enable or disable default UI to enter XR
  128845. */
  128846. disableDefaultUI?: boolean;
  128847. /**
  128848. * Should teleportation not initialize. defaults to false.
  128849. */
  128850. disableTeleportation?: boolean;
  128851. /**
  128852. * Floor meshes that will be used for teleport
  128853. */
  128854. floorMeshes?: Array<AbstractMesh>;
  128855. /**
  128856. * If set to true, the first frame will not be used to reset position
  128857. * The first frame is mainly used when copying transformation from the old camera
  128858. * Mainly used in AR
  128859. */
  128860. ignoreNativeCameraTransformation?: boolean;
  128861. /**
  128862. * Disable the controller mesh-loading. Can be used if you want to load your own meshes
  128863. */
  128864. inputOptions?: IWebXRInputOptions;
  128865. /**
  128866. * optional configuration for the output canvas
  128867. */
  128868. outputCanvasOptions?: WebXRManagedOutputCanvasOptions;
  128869. /**
  128870. * optional UI options. This can be used among other to change session mode and reference space type
  128871. */
  128872. uiOptions?: WebXREnterExitUIOptions;
  128873. /**
  128874. * When loading teleportation and pointer select, use stable versions instead of latest.
  128875. */
  128876. useStablePlugins?: boolean;
  128877. /**
  128878. * An optional rendering group id that will be set globally for teleportation, pointer selection and default controller meshes
  128879. */
  128880. renderingGroupId?: number;
  128881. /**
  128882. * A list of optional features to init the session with
  128883. * If set to true, all features we support will be added
  128884. */
  128885. optionalFeatures?: boolean | string[];
  128886. }
  128887. /**
  128888. * Default experience which provides a similar setup to the previous webVRExperience
  128889. */
  128890. export class WebXRDefaultExperience {
  128891. /**
  128892. * Base experience
  128893. */
  128894. baseExperience: WebXRExperienceHelper;
  128895. /**
  128896. * Enables ui for entering/exiting xr
  128897. */
  128898. enterExitUI: WebXREnterExitUI;
  128899. /**
  128900. * Input experience extension
  128901. */
  128902. input: WebXRInput;
  128903. /**
  128904. * Enables laser pointer and selection
  128905. */
  128906. pointerSelection: WebXRControllerPointerSelection;
  128907. /**
  128908. * Default target xr should render to
  128909. */
  128910. renderTarget: WebXRRenderTarget;
  128911. /**
  128912. * Enables teleportation
  128913. */
  128914. teleportation: WebXRMotionControllerTeleportation;
  128915. private constructor();
  128916. /**
  128917. * Creates the default xr experience
  128918. * @param scene scene
  128919. * @param options options for basic configuration
  128920. * @returns resulting WebXRDefaultExperience
  128921. */
  128922. static CreateAsync(scene: Scene, options?: WebXRDefaultExperienceOptions): Promise<WebXRDefaultExperience>;
  128923. /**
  128924. * DIsposes of the experience helper
  128925. */
  128926. dispose(): void;
  128927. }
  128928. }
  128929. declare module BABYLON {
  128930. /**
  128931. * Options to modify the vr teleportation behavior.
  128932. */
  128933. export interface VRTeleportationOptions {
  128934. /**
  128935. * The name of the mesh which should be used as the teleportation floor. (default: null)
  128936. */
  128937. floorMeshName?: string;
  128938. /**
  128939. * A list of meshes to be used as the teleportation floor. (default: empty)
  128940. */
  128941. floorMeshes?: Mesh[];
  128942. /**
  128943. * The teleportation mode. (default: TELEPORTATIONMODE_CONSTANTTIME)
  128944. */
  128945. teleportationMode?: number;
  128946. /**
  128947. * The duration of the animation in ms, apply when animationMode is TELEPORTATIONMODE_CONSTANTTIME. (default 122ms)
  128948. */
  128949. teleportationTime?: number;
  128950. /**
  128951. * The speed of the animation in distance/sec, apply when animationMode is TELEPORTATIONMODE_CONSTANTSPEED. (default 20 units / sec)
  128952. */
  128953. teleportationSpeed?: number;
  128954. /**
  128955. * The easing function used in the animation or null for Linear. (default CircleEase)
  128956. */
  128957. easingFunction?: EasingFunction;
  128958. }
  128959. /**
  128960. * Options to modify the vr experience helper's behavior.
  128961. */
  128962. export interface VRExperienceHelperOptions extends WebVROptions {
  128963. /**
  128964. * Create a DeviceOrientationCamera to be used as your out of vr camera. (default: true)
  128965. */
  128966. createDeviceOrientationCamera?: boolean;
  128967. /**
  128968. * Create a VRDeviceOrientationFreeCamera to be used for VR when no external HMD is found. (default: true)
  128969. */
  128970. createFallbackVRDeviceOrientationFreeCamera?: boolean;
  128971. /**
  128972. * Uses the main button on the controller to toggle the laser casted. (default: true)
  128973. */
  128974. laserToggle?: boolean;
  128975. /**
  128976. * A list of meshes to be used as the teleportation floor. If specified, teleportation will be enabled (default: undefined)
  128977. */
  128978. floorMeshes?: Mesh[];
  128979. /**
  128980. * Distortion metrics for the fallback vrDeviceOrientationCamera (default: VRCameraMetrics.Default)
  128981. */
  128982. vrDeviceOrientationCameraMetrics?: VRCameraMetrics;
  128983. /**
  128984. * Defines if WebXR should be used instead of WebVR (if available)
  128985. */
  128986. useXR?: boolean;
  128987. }
  128988. /**
  128989. * Event containing information after VR has been entered
  128990. */
  128991. export class OnAfterEnteringVRObservableEvent {
  128992. /**
  128993. * If entering vr was successful
  128994. */
  128995. success: boolean;
  128996. }
  128997. /**
  128998. * Helps to quickly add VR support to an existing scene.
  128999. * See https://doc.babylonjs.com/how_to/webvr_helper
  129000. */
  129001. export class VRExperienceHelper {
  129002. /** Options to modify the vr experience helper's behavior. */
  129003. webVROptions: VRExperienceHelperOptions;
  129004. private _scene;
  129005. private _position;
  129006. private _btnVR;
  129007. private _btnVRDisplayed;
  129008. private _webVRsupported;
  129009. private _webVRready;
  129010. private _webVRrequesting;
  129011. private _webVRpresenting;
  129012. private _hasEnteredVR;
  129013. private _fullscreenVRpresenting;
  129014. private _inputElement;
  129015. private _webVRCamera;
  129016. private _vrDeviceOrientationCamera;
  129017. private _deviceOrientationCamera;
  129018. private _existingCamera;
  129019. private _onKeyDown;
  129020. private _onVrDisplayPresentChange;
  129021. private _onVRDisplayChanged;
  129022. private _onVRRequestPresentStart;
  129023. private _onVRRequestPresentComplete;
  129024. /**
  129025. * 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)
  129026. */
  129027. enableGazeEvenWhenNoPointerLock: boolean;
  129028. /**
  129029. * Gets or sets a boolean indicating that the VREXperienceHelper will exit VR if double tap is detected
  129030. */
  129031. exitVROnDoubleTap: boolean;
  129032. /**
  129033. * Observable raised right before entering VR.
  129034. */
  129035. onEnteringVRObservable: Observable<VRExperienceHelper>;
  129036. /**
  129037. * Observable raised when entering VR has completed.
  129038. */
  129039. onAfterEnteringVRObservable: Observable<OnAfterEnteringVRObservableEvent>;
  129040. /**
  129041. * Observable raised when exiting VR.
  129042. */
  129043. onExitingVRObservable: Observable<VRExperienceHelper>;
  129044. /**
  129045. * Observable raised when controller mesh is loaded.
  129046. */
  129047. onControllerMeshLoadedObservable: Observable<WebVRController>;
  129048. /** Return this.onEnteringVRObservable
  129049. * Note: This one is for backward compatibility. Please use onEnteringVRObservable directly
  129050. */
  129051. get onEnteringVR(): Observable<VRExperienceHelper>;
  129052. /** Return this.onExitingVRObservable
  129053. * Note: This one is for backward compatibility. Please use onExitingVRObservable directly
  129054. */
  129055. get onExitingVR(): Observable<VRExperienceHelper>;
  129056. /** Return this.onControllerMeshLoadedObservable
  129057. * Note: This one is for backward compatibility. Please use onControllerMeshLoadedObservable directly
  129058. */
  129059. get onControllerMeshLoaded(): Observable<WebVRController>;
  129060. private _rayLength;
  129061. private _useCustomVRButton;
  129062. private _teleportationRequested;
  129063. private _teleportActive;
  129064. private _floorMeshName;
  129065. private _floorMeshesCollection;
  129066. private _teleportationMode;
  129067. private _teleportationTime;
  129068. private _teleportationSpeed;
  129069. private _teleportationEasing;
  129070. private _rotationAllowed;
  129071. private _teleportBackwardsVector;
  129072. private _teleportationTarget;
  129073. private _isDefaultTeleportationTarget;
  129074. private _postProcessMove;
  129075. private _teleportationFillColor;
  129076. private _teleportationBorderColor;
  129077. private _rotationAngle;
  129078. private _haloCenter;
  129079. private _cameraGazer;
  129080. private _padSensibilityUp;
  129081. private _padSensibilityDown;
  129082. private _leftController;
  129083. private _rightController;
  129084. private _gazeColor;
  129085. private _laserColor;
  129086. private _pickedLaserColor;
  129087. private _pickedGazeColor;
  129088. /**
  129089. * Observable raised when a new mesh is selected based on meshSelectionPredicate
  129090. */
  129091. onNewMeshSelected: Observable<AbstractMesh>;
  129092. /**
  129093. * Observable raised when a new mesh is selected based on meshSelectionPredicate.
  129094. * This observable will provide the mesh and the controller used to select the mesh
  129095. */
  129096. onMeshSelectedWithController: Observable<{
  129097. mesh: AbstractMesh;
  129098. controller: WebVRController;
  129099. }>;
  129100. /**
  129101. * Observable raised when a new mesh is picked based on meshSelectionPredicate
  129102. */
  129103. onNewMeshPicked: Observable<PickingInfo>;
  129104. private _circleEase;
  129105. /**
  129106. * Observable raised before camera teleportation
  129107. */
  129108. onBeforeCameraTeleport: Observable<Vector3>;
  129109. /**
  129110. * Observable raised after camera teleportation
  129111. */
  129112. onAfterCameraTeleport: Observable<Vector3>;
  129113. /**
  129114. * Observable raised when current selected mesh gets unselected
  129115. */
  129116. onSelectedMeshUnselected: Observable<AbstractMesh>;
  129117. private _raySelectionPredicate;
  129118. /**
  129119. * To be optionaly changed by user to define custom ray selection
  129120. */
  129121. raySelectionPredicate: (mesh: AbstractMesh) => boolean;
  129122. /**
  129123. * To be optionaly changed by user to define custom selection logic (after ray selection)
  129124. */
  129125. meshSelectionPredicate: (mesh: AbstractMesh) => boolean;
  129126. /**
  129127. * Set teleportation enabled. If set to false camera teleportation will be disabled but camera rotation will be kept.
  129128. */
  129129. teleportationEnabled: boolean;
  129130. private _defaultHeight;
  129131. private _teleportationInitialized;
  129132. private _interactionsEnabled;
  129133. private _interactionsRequested;
  129134. private _displayGaze;
  129135. private _displayLaserPointer;
  129136. /**
  129137. * The mesh used to display where the user is going to teleport.
  129138. */
  129139. get teleportationTarget(): Mesh;
  129140. /**
  129141. * Sets the mesh to be used to display where the user is going to teleport.
  129142. */
  129143. set teleportationTarget(value: Mesh);
  129144. /**
  129145. * 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
  129146. * when set bakeCurrentTransformIntoVertices will be called on the mesh.
  129147. * See https://doc.babylonjs.com/resources/baking_transformations
  129148. */
  129149. get gazeTrackerMesh(): Mesh;
  129150. set gazeTrackerMesh(value: Mesh);
  129151. /**
  129152. * If the gaze trackers scale should be updated to be constant size when pointing at near/far meshes
  129153. */
  129154. updateGazeTrackerScale: boolean;
  129155. /**
  129156. * If the gaze trackers color should be updated when selecting meshes
  129157. */
  129158. updateGazeTrackerColor: boolean;
  129159. /**
  129160. * If the controller laser color should be updated when selecting meshes
  129161. */
  129162. updateControllerLaserColor: boolean;
  129163. /**
  129164. * The gaze tracking mesh corresponding to the left controller
  129165. */
  129166. get leftControllerGazeTrackerMesh(): Nullable<Mesh>;
  129167. /**
  129168. * The gaze tracking mesh corresponding to the right controller
  129169. */
  129170. get rightControllerGazeTrackerMesh(): Nullable<Mesh>;
  129171. /**
  129172. * If the ray of the gaze should be displayed.
  129173. */
  129174. get displayGaze(): boolean;
  129175. /**
  129176. * Sets if the ray of the gaze should be displayed.
  129177. */
  129178. set displayGaze(value: boolean);
  129179. /**
  129180. * If the ray of the LaserPointer should be displayed.
  129181. */
  129182. get displayLaserPointer(): boolean;
  129183. /**
  129184. * Sets if the ray of the LaserPointer should be displayed.
  129185. */
  129186. set displayLaserPointer(value: boolean);
  129187. /**
  129188. * The deviceOrientationCamera used as the camera when not in VR.
  129189. */
  129190. get deviceOrientationCamera(): Nullable<DeviceOrientationCamera>;
  129191. /**
  129192. * Based on the current WebVR support, returns the current VR camera used.
  129193. */
  129194. get currentVRCamera(): Nullable<Camera>;
  129195. /**
  129196. * The webVRCamera which is used when in VR.
  129197. */
  129198. get webVRCamera(): WebVRFreeCamera;
  129199. /**
  129200. * The deviceOrientationCamera that is used as a fallback when vr device is not connected.
  129201. */
  129202. get vrDeviceOrientationCamera(): Nullable<VRDeviceOrientationFreeCamera>;
  129203. /**
  129204. * The html button that is used to trigger entering into VR.
  129205. */
  129206. get vrButton(): Nullable<HTMLButtonElement>;
  129207. private get _teleportationRequestInitiated();
  129208. /**
  129209. * Defines whether or not Pointer lock should be requested when switching to
  129210. * full screen.
  129211. */
  129212. requestPointerLockOnFullScreen: boolean;
  129213. /**
  129214. * If asking to force XR, this will be populated with the default xr experience
  129215. */
  129216. xr: WebXRDefaultExperience;
  129217. /**
  129218. * Was the XR test done already. If this is true AND this.xr exists, xr is initialized.
  129219. * If this is true and no this.xr, xr exists but is not supported, using WebVR.
  129220. */
  129221. xrTestDone: boolean;
  129222. /**
  129223. * Instantiates a VRExperienceHelper.
  129224. * Helps to quickly add VR support to an existing scene.
  129225. * @param scene The scene the VRExperienceHelper belongs to.
  129226. * @param webVROptions Options to modify the vr experience helper's behavior.
  129227. */
  129228. constructor(scene: Scene,
  129229. /** Options to modify the vr experience helper's behavior. */
  129230. webVROptions?: VRExperienceHelperOptions);
  129231. private completeVRInit;
  129232. private _onDefaultMeshLoaded;
  129233. private _onResize;
  129234. private _onFullscreenChange;
  129235. /**
  129236. * Gets a value indicating if we are currently in VR mode.
  129237. */
  129238. get isInVRMode(): boolean;
  129239. private onVrDisplayPresentChange;
  129240. private onVRDisplayChanged;
  129241. private moveButtonToBottomRight;
  129242. private displayVRButton;
  129243. private updateButtonVisibility;
  129244. private _cachedAngularSensibility;
  129245. /**
  129246. * Attempt to enter VR. If a headset is connected and ready, will request present on that.
  129247. * Otherwise, will use the fullscreen API.
  129248. */
  129249. enterVR(): void;
  129250. /**
  129251. * Attempt to exit VR, or fullscreen.
  129252. */
  129253. exitVR(): void;
  129254. /**
  129255. * The position of the vr experience helper.
  129256. */
  129257. get position(): Vector3;
  129258. /**
  129259. * Sets the position of the vr experience helper.
  129260. */
  129261. set position(value: Vector3);
  129262. /**
  129263. * Enables controllers and user interactions such as selecting and object or clicking on an object.
  129264. */
  129265. enableInteractions(): void;
  129266. private get _noControllerIsActive();
  129267. private beforeRender;
  129268. private _isTeleportationFloor;
  129269. /**
  129270. * Adds a floor mesh to be used for teleportation.
  129271. * @param floorMesh the mesh to be used for teleportation.
  129272. */
  129273. addFloorMesh(floorMesh: Mesh): void;
  129274. /**
  129275. * Removes a floor mesh from being used for teleportation.
  129276. * @param floorMesh the mesh to be removed.
  129277. */
  129278. removeFloorMesh(floorMesh: Mesh): void;
  129279. /**
  129280. * Enables interactions and teleportation using the VR controllers and gaze.
  129281. * @param vrTeleportationOptions options to modify teleportation behavior.
  129282. */
  129283. enableTeleportation(vrTeleportationOptions?: VRTeleportationOptions): void;
  129284. private _onNewGamepadConnected;
  129285. private _tryEnableInteractionOnController;
  129286. private _onNewGamepadDisconnected;
  129287. private _enableInteractionOnController;
  129288. private _checkTeleportWithRay;
  129289. private _checkRotate;
  129290. private _checkTeleportBackwards;
  129291. private _enableTeleportationOnController;
  129292. private _createTeleportationCircles;
  129293. private _displayTeleportationTarget;
  129294. private _hideTeleportationTarget;
  129295. private _rotateCamera;
  129296. private _moveTeleportationSelectorTo;
  129297. private _workingVector;
  129298. private _workingQuaternion;
  129299. private _workingMatrix;
  129300. /**
  129301. * Time Constant Teleportation Mode
  129302. */
  129303. static readonly TELEPORTATIONMODE_CONSTANTTIME: number;
  129304. /**
  129305. * Speed Constant Teleportation Mode
  129306. */
  129307. static readonly TELEPORTATIONMODE_CONSTANTSPEED: number;
  129308. /**
  129309. * Teleports the users feet to the desired location
  129310. * @param location The location where the user's feet should be placed
  129311. */
  129312. teleportCamera(location: Vector3): void;
  129313. private _convertNormalToDirectionOfRay;
  129314. private _castRayAndSelectObject;
  129315. private _notifySelectedMeshUnselected;
  129316. /**
  129317. * Permanently set new colors for the laser pointer
  129318. * @param color the new laser color
  129319. * @param pickedColor the new laser color when picked mesh detected
  129320. */
  129321. setLaserColor(color: Color3, pickedColor?: Color3): void;
  129322. /**
  129323. * Set lighting enabled / disabled on the laser pointer of both controllers
  129324. * @param enabled should the lighting be enabled on the laser pointer
  129325. */
  129326. setLaserLightingState(enabled?: boolean): void;
  129327. /**
  129328. * Permanently set new colors for the gaze pointer
  129329. * @param color the new gaze color
  129330. * @param pickedColor the new gaze color when picked mesh detected
  129331. */
  129332. setGazeColor(color: Color3, pickedColor?: Color3): void;
  129333. /**
  129334. * Sets the color of the laser ray from the vr controllers.
  129335. * @param color new color for the ray.
  129336. */
  129337. changeLaserColor(color: Color3): void;
  129338. /**
  129339. * Sets the color of the ray from the vr headsets gaze.
  129340. * @param color new color for the ray.
  129341. */
  129342. changeGazeColor(color: Color3): void;
  129343. /**
  129344. * Exits VR and disposes of the vr experience helper
  129345. */
  129346. dispose(): void;
  129347. /**
  129348. * Gets the name of the VRExperienceHelper class
  129349. * @returns "VRExperienceHelper"
  129350. */
  129351. getClassName(): string;
  129352. }
  129353. }
  129354. declare module BABYLON {
  129355. /**
  129356. * Contains an array of blocks representing the octree
  129357. */
  129358. export interface IOctreeContainer<T> {
  129359. /**
  129360. * Blocks within the octree
  129361. */
  129362. blocks: Array<OctreeBlock<T>>;
  129363. }
  129364. /**
  129365. * Class used to store a cell in an octree
  129366. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  129367. */
  129368. export class OctreeBlock<T> {
  129369. /**
  129370. * Gets the content of the current block
  129371. */
  129372. entries: T[];
  129373. /**
  129374. * Gets the list of block children
  129375. */
  129376. blocks: Array<OctreeBlock<T>>;
  129377. private _depth;
  129378. private _maxDepth;
  129379. private _capacity;
  129380. private _minPoint;
  129381. private _maxPoint;
  129382. private _boundingVectors;
  129383. private _creationFunc;
  129384. /**
  129385. * Creates a new block
  129386. * @param minPoint defines the minimum vector (in world space) of the block's bounding box
  129387. * @param maxPoint defines the maximum vector (in world space) of the block's bounding box
  129388. * @param capacity defines the maximum capacity of this block (if capacity is reached the block will be split into sub blocks)
  129389. * @param depth defines the current depth of this block in the octree
  129390. * @param maxDepth defines the maximal depth allowed (beyond this value, the capacity is ignored)
  129391. * @param creationFunc defines a callback to call when an element is added to the block
  129392. */
  129393. constructor(minPoint: Vector3, maxPoint: Vector3, capacity: number, depth: number, maxDepth: number, creationFunc: (entry: T, block: OctreeBlock<T>) => void);
  129394. /**
  129395. * Gets the maximum capacity of this block (if capacity is reached the block will be split into sub blocks)
  129396. */
  129397. get capacity(): number;
  129398. /**
  129399. * Gets the minimum vector (in world space) of the block's bounding box
  129400. */
  129401. get minPoint(): Vector3;
  129402. /**
  129403. * Gets the maximum vector (in world space) of the block's bounding box
  129404. */
  129405. get maxPoint(): Vector3;
  129406. /**
  129407. * Add a new element to this block
  129408. * @param entry defines the element to add
  129409. */
  129410. addEntry(entry: T): void;
  129411. /**
  129412. * Remove an element from this block
  129413. * @param entry defines the element to remove
  129414. */
  129415. removeEntry(entry: T): void;
  129416. /**
  129417. * Add an array of elements to this block
  129418. * @param entries defines the array of elements to add
  129419. */
  129420. addEntries(entries: T[]): void;
  129421. /**
  129422. * Test if the current block intersects the furstum planes and if yes, then add its content to the selection array
  129423. * @param frustumPlanes defines the frustum planes to test
  129424. * @param selection defines the array to store current content if selection is positive
  129425. * @param allowDuplicate defines if the selection array can contains duplicated entries
  129426. */
  129427. select(frustumPlanes: Plane[], selection: SmartArrayNoDuplicate<T>, allowDuplicate?: boolean): void;
  129428. /**
  129429. * Test if the current block intersect with the given bounding sphere and if yes, then add its content to the selection array
  129430. * @param sphereCenter defines the bounding sphere center
  129431. * @param sphereRadius defines the bounding sphere radius
  129432. * @param selection defines the array to store current content if selection is positive
  129433. * @param allowDuplicate defines if the selection array can contains duplicated entries
  129434. */
  129435. intersects(sphereCenter: Vector3, sphereRadius: number, selection: SmartArrayNoDuplicate<T>, allowDuplicate?: boolean): void;
  129436. /**
  129437. * Test if the current block intersect with the given ray and if yes, then add its content to the selection array
  129438. * @param ray defines the ray to test with
  129439. * @param selection defines the array to store current content if selection is positive
  129440. */
  129441. intersectsRay(ray: Ray, selection: SmartArrayNoDuplicate<T>): void;
  129442. /**
  129443. * Subdivide the content into child blocks (this block will then be empty)
  129444. */
  129445. createInnerBlocks(): void;
  129446. /**
  129447. * @hidden
  129448. */
  129449. 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;
  129450. }
  129451. }
  129452. declare module BABYLON {
  129453. /**
  129454. * Octrees are a really powerful data structure that can quickly select entities based on space coordinates.
  129455. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  129456. */
  129457. export class Octree<T> {
  129458. /** 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.) */
  129459. maxDepth: number;
  129460. /**
  129461. * Blocks within the octree containing objects
  129462. */
  129463. blocks: Array<OctreeBlock<T>>;
  129464. /**
  129465. * Content stored in the octree
  129466. */
  129467. dynamicContent: T[];
  129468. private _maxBlockCapacity;
  129469. private _selectionContent;
  129470. private _creationFunc;
  129471. /**
  129472. * Creates a octree
  129473. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  129474. * @param creationFunc function to be used to instatiate the octree
  129475. * @param maxBlockCapacity defines the maximum number of meshes you want on your octree's leaves (default: 64)
  129476. * @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.)
  129477. */
  129478. constructor(creationFunc: (entry: T, block: OctreeBlock<T>) => void, maxBlockCapacity?: number,
  129479. /** 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.) */
  129480. maxDepth?: number);
  129481. /**
  129482. * Updates the octree by adding blocks for the passed in meshes within the min and max world parameters
  129483. * @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);
  129484. * @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);
  129485. * @param entries meshes to be added to the octree blocks
  129486. */
  129487. update(worldMin: Vector3, worldMax: Vector3, entries: T[]): void;
  129488. /**
  129489. * Adds a mesh to the octree
  129490. * @param entry Mesh to add to the octree
  129491. */
  129492. addMesh(entry: T): void;
  129493. /**
  129494. * Remove an element from the octree
  129495. * @param entry defines the element to remove
  129496. */
  129497. removeMesh(entry: T): void;
  129498. /**
  129499. * Selects an array of meshes within the frustum
  129500. * @param frustumPlanes The frustum planes to use which will select all meshes within it
  129501. * @param allowDuplicate If duplicate objects are allowed in the resulting object array
  129502. * @returns array of meshes within the frustum
  129503. */
  129504. select(frustumPlanes: Plane[], allowDuplicate?: boolean): SmartArray<T>;
  129505. /**
  129506. * Test if the octree intersect with the given bounding sphere and if yes, then add its content to the selection array
  129507. * @param sphereCenter defines the bounding sphere center
  129508. * @param sphereRadius defines the bounding sphere radius
  129509. * @param allowDuplicate defines if the selection array can contains duplicated entries
  129510. * @returns an array of objects that intersect the sphere
  129511. */
  129512. intersects(sphereCenter: Vector3, sphereRadius: number, allowDuplicate?: boolean): SmartArray<T>;
  129513. /**
  129514. * Test if the octree intersect with the given ray and if yes, then add its content to resulting array
  129515. * @param ray defines the ray to test with
  129516. * @returns array of intersected objects
  129517. */
  129518. intersectsRay(ray: Ray): SmartArray<T>;
  129519. /**
  129520. * Adds a mesh into the octree block if it intersects the block
  129521. */
  129522. static CreationFuncForMeshes: (entry: AbstractMesh, block: OctreeBlock<AbstractMesh>) => void;
  129523. /**
  129524. * Adds a submesh into the octree block if it intersects the block
  129525. */
  129526. static CreationFuncForSubMeshes: (entry: SubMesh, block: OctreeBlock<SubMesh>) => void;
  129527. }
  129528. }
  129529. declare module BABYLON {
  129530. interface Scene {
  129531. /**
  129532. * @hidden
  129533. * Backing Filed
  129534. */
  129535. _selectionOctree: Octree<AbstractMesh>;
  129536. /**
  129537. * Gets the octree used to boost mesh selection (picking)
  129538. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  129539. */
  129540. selectionOctree: Octree<AbstractMesh>;
  129541. /**
  129542. * Creates or updates the octree used to boost selection (picking)
  129543. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  129544. * @param maxCapacity defines the maximum capacity per leaf
  129545. * @param maxDepth defines the maximum depth of the octree
  129546. * @returns an octree of AbstractMesh
  129547. */
  129548. createOrUpdateSelectionOctree(maxCapacity?: number, maxDepth?: number): Octree<AbstractMesh>;
  129549. }
  129550. interface AbstractMesh {
  129551. /**
  129552. * @hidden
  129553. * Backing Field
  129554. */
  129555. _submeshesOctree: Octree<SubMesh>;
  129556. /**
  129557. * This function will create an octree to help to select the right submeshes for rendering, picking and collision computations.
  129558. * Please note that you must have a decent number of submeshes to get performance improvements when using an octree
  129559. * @param maxCapacity defines the maximum size of each block (64 by default)
  129560. * @param maxDepth defines the maximum depth to use (no more than 2 levels by default)
  129561. * @returns the new octree
  129562. * @see https://www.babylonjs-playground.com/#NA4OQ#12
  129563. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  129564. */
  129565. createOrUpdateSubmeshesOctree(maxCapacity?: number, maxDepth?: number): Octree<SubMesh>;
  129566. }
  129567. /**
  129568. * Defines the octree scene component responsible to manage any octrees
  129569. * in a given scene.
  129570. */
  129571. export class OctreeSceneComponent {
  129572. /**
  129573. * The component name help to identify the component in the list of scene components.
  129574. */
  129575. readonly name: string;
  129576. /**
  129577. * The scene the component belongs to.
  129578. */
  129579. scene: Scene;
  129580. /**
  129581. * Indicates if the meshes have been checked to make sure they are isEnabled()
  129582. */
  129583. readonly checksIsEnabled: boolean;
  129584. /**
  129585. * Creates a new instance of the component for the given scene
  129586. * @param scene Defines the scene to register the component in
  129587. */
  129588. constructor(scene: Scene);
  129589. /**
  129590. * Registers the component in a given scene
  129591. */
  129592. register(): void;
  129593. /**
  129594. * Return the list of active meshes
  129595. * @returns the list of active meshes
  129596. */
  129597. getActiveMeshCandidates(): ISmartArrayLike<AbstractMesh>;
  129598. /**
  129599. * Return the list of active sub meshes
  129600. * @param mesh The mesh to get the candidates sub meshes from
  129601. * @returns the list of active sub meshes
  129602. */
  129603. getActiveSubMeshCandidates(mesh: AbstractMesh): ISmartArrayLike<SubMesh>;
  129604. private _tempRay;
  129605. /**
  129606. * Return the list of sub meshes intersecting with a given local ray
  129607. * @param mesh defines the mesh to find the submesh for
  129608. * @param localRay defines the ray in local space
  129609. * @returns the list of intersecting sub meshes
  129610. */
  129611. getIntersectingSubMeshCandidates(mesh: AbstractMesh, localRay: Ray): ISmartArrayLike<SubMesh>;
  129612. /**
  129613. * Return the list of sub meshes colliding with a collider
  129614. * @param mesh defines the mesh to find the submesh for
  129615. * @param collider defines the collider to evaluate the collision against
  129616. * @returns the list of colliding sub meshes
  129617. */
  129618. getCollidingSubMeshCandidates(mesh: AbstractMesh, collider: Collider): ISmartArrayLike<SubMesh>;
  129619. /**
  129620. * Rebuilds the elements related to this component in case of
  129621. * context lost for instance.
  129622. */
  129623. rebuild(): void;
  129624. /**
  129625. * Disposes the component and the associated ressources.
  129626. */
  129627. dispose(): void;
  129628. }
  129629. }
  129630. declare module BABYLON {
  129631. /**
  129632. * Renders gizmos on top of an existing scene which provide controls for position, rotation, etc.
  129633. */
  129634. export class Gizmo implements IDisposable {
  129635. /** The utility layer the gizmo will be added to */
  129636. gizmoLayer: UtilityLayerRenderer;
  129637. /**
  129638. * The root mesh of the gizmo
  129639. */
  129640. _rootMesh: Mesh;
  129641. private _attachedMesh;
  129642. private _attachedNode;
  129643. /**
  129644. * Ratio for the scale of the gizmo (Default: 1)
  129645. */
  129646. scaleRatio: number;
  129647. /**
  129648. * If a custom mesh has been set (Default: false)
  129649. */
  129650. protected _customMeshSet: boolean;
  129651. /**
  129652. * Mesh that the gizmo will be attached to. (eg. on a drag gizmo the mesh that will be dragged)
  129653. * * When set, interactions will be enabled
  129654. */
  129655. get attachedMesh(): Nullable<AbstractMesh>;
  129656. set attachedMesh(value: Nullable<AbstractMesh>);
  129657. /**
  129658. * Node that the gizmo will be attached to. (eg. on a drag gizmo the mesh, bone or NodeTransform that will be dragged)
  129659. * * When set, interactions will be enabled
  129660. */
  129661. get attachedNode(): Nullable<Node>;
  129662. set attachedNode(value: Nullable<Node>);
  129663. /**
  129664. * Disposes and replaces the current meshes in the gizmo with the specified mesh
  129665. * @param mesh The mesh to replace the default mesh of the gizmo
  129666. */
  129667. setCustomMesh(mesh: Mesh): void;
  129668. /**
  129669. * If set the gizmo's rotation will be updated to match the attached mesh each frame (Default: true)
  129670. */
  129671. updateGizmoRotationToMatchAttachedMesh: boolean;
  129672. /**
  129673. * If set the gizmo's position will be updated to match the attached mesh each frame (Default: true)
  129674. */
  129675. updateGizmoPositionToMatchAttachedMesh: boolean;
  129676. /**
  129677. * When set, the gizmo will always appear the same size no matter where the camera is (default: true)
  129678. */
  129679. updateScale: boolean;
  129680. protected _interactionsEnabled: boolean;
  129681. protected _attachedNodeChanged(value: Nullable<Node>): void;
  129682. private _beforeRenderObserver;
  129683. private _tempQuaternion;
  129684. private _tempVector;
  129685. private _tempVector2;
  129686. /**
  129687. * Creates a gizmo
  129688. * @param gizmoLayer The utility layer the gizmo will be added to
  129689. */
  129690. constructor(
  129691. /** The utility layer the gizmo will be added to */
  129692. gizmoLayer?: UtilityLayerRenderer);
  129693. /**
  129694. * Updates the gizmo to match the attached mesh's position/rotation
  129695. */
  129696. protected _update(): void;
  129697. /**
  129698. * computes the rotation/scaling/position of the transform once the Node world matrix has changed.
  129699. * @param value Node, TransformNode or mesh
  129700. */
  129701. protected _matrixChanged(): void;
  129702. /**
  129703. * Disposes of the gizmo
  129704. */
  129705. dispose(): void;
  129706. }
  129707. }
  129708. declare module BABYLON {
  129709. /**
  129710. * Single plane drag gizmo
  129711. */
  129712. export class PlaneDragGizmo extends Gizmo {
  129713. /**
  129714. * Drag behavior responsible for the gizmos dragging interactions
  129715. */
  129716. dragBehavior: PointerDragBehavior;
  129717. private _pointerObserver;
  129718. /**
  129719. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  129720. */
  129721. snapDistance: number;
  129722. /**
  129723. * Event that fires each time the gizmo snaps to a new location.
  129724. * * snapDistance is the the change in distance
  129725. */
  129726. onSnapObservable: Observable<{
  129727. snapDistance: number;
  129728. }>;
  129729. private _plane;
  129730. private _coloredMaterial;
  129731. private _hoverMaterial;
  129732. private _isEnabled;
  129733. private _parent;
  129734. /** @hidden */
  129735. static _CreatePlane(scene: Scene, material: StandardMaterial): TransformNode;
  129736. /** @hidden */
  129737. static _CreateArrowInstance(scene: Scene, arrow: TransformNode): TransformNode;
  129738. /**
  129739. * Creates a PlaneDragGizmo
  129740. * @param gizmoLayer The utility layer the gizmo will be added to
  129741. * @param dragPlaneNormal The axis normal to which the gizmo will be able to drag on
  129742. * @param color The color of the gizmo
  129743. */
  129744. constructor(dragPlaneNormal: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<PositionGizmo>);
  129745. protected _attachedNodeChanged(value: Nullable<Node>): void;
  129746. /**
  129747. * If the gizmo is enabled
  129748. */
  129749. set isEnabled(value: boolean);
  129750. get isEnabled(): boolean;
  129751. /**
  129752. * Disposes of the gizmo
  129753. */
  129754. dispose(): void;
  129755. }
  129756. }
  129757. declare module BABYLON {
  129758. /**
  129759. * Gizmo that enables dragging a mesh along 3 axis
  129760. */
  129761. export class PositionGizmo extends Gizmo {
  129762. /**
  129763. * Internal gizmo used for interactions on the x axis
  129764. */
  129765. xGizmo: AxisDragGizmo;
  129766. /**
  129767. * Internal gizmo used for interactions on the y axis
  129768. */
  129769. yGizmo: AxisDragGizmo;
  129770. /**
  129771. * Internal gizmo used for interactions on the z axis
  129772. */
  129773. zGizmo: AxisDragGizmo;
  129774. /**
  129775. * Internal gizmo used for interactions on the yz plane
  129776. */
  129777. xPlaneGizmo: PlaneDragGizmo;
  129778. /**
  129779. * Internal gizmo used for interactions on the xz plane
  129780. */
  129781. yPlaneGizmo: PlaneDragGizmo;
  129782. /**
  129783. * Internal gizmo used for interactions on the xy plane
  129784. */
  129785. zPlaneGizmo: PlaneDragGizmo;
  129786. /**
  129787. * private variables
  129788. */
  129789. private _meshAttached;
  129790. private _nodeAttached;
  129791. private _updateGizmoRotationToMatchAttachedMesh;
  129792. private _snapDistance;
  129793. private _scaleRatio;
  129794. /** Fires an event when any of it's sub gizmos are dragged */
  129795. onDragStartObservable: Observable<unknown>;
  129796. /** Fires an event when any of it's sub gizmos are released from dragging */
  129797. onDragEndObservable: Observable<unknown>;
  129798. /**
  129799. * If set to true, planar drag is enabled
  129800. */
  129801. private _planarGizmoEnabled;
  129802. get attachedMesh(): Nullable<AbstractMesh>;
  129803. set attachedMesh(mesh: Nullable<AbstractMesh>);
  129804. get attachedNode(): Nullable<Node>;
  129805. set attachedNode(node: Nullable<Node>);
  129806. /**
  129807. * Creates a PositionGizmo
  129808. * @param gizmoLayer The utility layer the gizmo will be added to
  129809. @param thickness display gizmo axis thickness
  129810. */
  129811. constructor(gizmoLayer?: UtilityLayerRenderer, thickness?: number);
  129812. /**
  129813. * If the planar drag gizmo is enabled
  129814. * setting this will enable/disable XY, XZ and YZ planes regardless of individual gizmo settings.
  129815. */
  129816. set planarGizmoEnabled(value: boolean);
  129817. get planarGizmoEnabled(): boolean;
  129818. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  129819. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  129820. /**
  129821. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  129822. */
  129823. set snapDistance(value: number);
  129824. get snapDistance(): number;
  129825. /**
  129826. * Ratio for the scale of the gizmo (Default: 1)
  129827. */
  129828. set scaleRatio(value: number);
  129829. get scaleRatio(): number;
  129830. /**
  129831. * Disposes of the gizmo
  129832. */
  129833. dispose(): void;
  129834. /**
  129835. * CustomMeshes are not supported by this gizmo
  129836. * @param mesh The mesh to replace the default mesh of the gizmo
  129837. */
  129838. setCustomMesh(mesh: Mesh): void;
  129839. }
  129840. }
  129841. declare module BABYLON {
  129842. /**
  129843. * Single axis drag gizmo
  129844. */
  129845. export class AxisDragGizmo extends Gizmo {
  129846. /**
  129847. * Drag behavior responsible for the gizmos dragging interactions
  129848. */
  129849. dragBehavior: PointerDragBehavior;
  129850. private _pointerObserver;
  129851. /**
  129852. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  129853. */
  129854. snapDistance: number;
  129855. /**
  129856. * Event that fires each time the gizmo snaps to a new location.
  129857. * * snapDistance is the the change in distance
  129858. */
  129859. onSnapObservable: Observable<{
  129860. snapDistance: number;
  129861. }>;
  129862. private _isEnabled;
  129863. private _parent;
  129864. private _arrow;
  129865. private _coloredMaterial;
  129866. private _hoverMaterial;
  129867. /** @hidden */
  129868. static _CreateArrow(scene: Scene, material: StandardMaterial, thickness?: number): TransformNode;
  129869. /** @hidden */
  129870. static _CreateArrowInstance(scene: Scene, arrow: TransformNode): TransformNode;
  129871. /**
  129872. * Creates an AxisDragGizmo
  129873. * @param gizmoLayer The utility layer the gizmo will be added to
  129874. * @param dragAxis The axis which the gizmo will be able to drag on
  129875. * @param color The color of the gizmo
  129876. * @param thickness display gizmo axis thickness
  129877. */
  129878. constructor(dragAxis: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<PositionGizmo>, thickness?: number);
  129879. protected _attachedNodeChanged(value: Nullable<Node>): void;
  129880. /**
  129881. * If the gizmo is enabled
  129882. */
  129883. set isEnabled(value: boolean);
  129884. get isEnabled(): boolean;
  129885. /**
  129886. * Disposes of the gizmo
  129887. */
  129888. dispose(): void;
  129889. }
  129890. }
  129891. declare module BABYLON.Debug {
  129892. /**
  129893. * The Axes viewer will show 3 axes in a specific point in space
  129894. */
  129895. export class AxesViewer {
  129896. private _xAxis;
  129897. private _yAxis;
  129898. private _zAxis;
  129899. private _scaleLinesFactor;
  129900. private _instanced;
  129901. /**
  129902. * Gets the hosting scene
  129903. */
  129904. scene: Scene;
  129905. /**
  129906. * Gets or sets a number used to scale line length
  129907. */
  129908. scaleLines: number;
  129909. /** Gets the node hierarchy used to render x-axis */
  129910. get xAxis(): TransformNode;
  129911. /** Gets the node hierarchy used to render y-axis */
  129912. get yAxis(): TransformNode;
  129913. /** Gets the node hierarchy used to render z-axis */
  129914. get zAxis(): TransformNode;
  129915. /**
  129916. * Creates a new AxesViewer
  129917. * @param scene defines the hosting scene
  129918. * @param scaleLines defines a number used to scale line length (1 by default)
  129919. * @param renderingGroupId defines a number used to set the renderingGroupId of the meshes (2 by default)
  129920. * @param xAxis defines the node hierarchy used to render the x-axis
  129921. * @param yAxis defines the node hierarchy used to render the y-axis
  129922. * @param zAxis defines the node hierarchy used to render the z-axis
  129923. */
  129924. constructor(scene: Scene, scaleLines?: number, renderingGroupId?: Nullable<number>, xAxis?: TransformNode, yAxis?: TransformNode, zAxis?: TransformNode);
  129925. /**
  129926. * Force the viewer to update
  129927. * @param position defines the position of the viewer
  129928. * @param xaxis defines the x axis of the viewer
  129929. * @param yaxis defines the y axis of the viewer
  129930. * @param zaxis defines the z axis of the viewer
  129931. */
  129932. update(position: Vector3, xaxis: Vector3, yaxis: Vector3, zaxis: Vector3): void;
  129933. /**
  129934. * Creates an instance of this axes viewer.
  129935. * @returns a new axes viewer with instanced meshes
  129936. */
  129937. createInstance(): AxesViewer;
  129938. /** Releases resources */
  129939. dispose(): void;
  129940. private static _SetRenderingGroupId;
  129941. }
  129942. }
  129943. declare module BABYLON.Debug {
  129944. /**
  129945. * The BoneAxesViewer will attach 3 axes to a specific bone of a specific mesh
  129946. * @see demo here: https://www.babylonjs-playground.com/#0DE8F4#8
  129947. */
  129948. export class BoneAxesViewer extends AxesViewer {
  129949. /**
  129950. * Gets or sets the target mesh where to display the axes viewer
  129951. */
  129952. mesh: Nullable<Mesh>;
  129953. /**
  129954. * Gets or sets the target bone where to display the axes viewer
  129955. */
  129956. bone: Nullable<Bone>;
  129957. /** Gets current position */
  129958. pos: Vector3;
  129959. /** Gets direction of X axis */
  129960. xaxis: Vector3;
  129961. /** Gets direction of Y axis */
  129962. yaxis: Vector3;
  129963. /** Gets direction of Z axis */
  129964. zaxis: Vector3;
  129965. /**
  129966. * Creates a new BoneAxesViewer
  129967. * @param scene defines the hosting scene
  129968. * @param bone defines the target bone
  129969. * @param mesh defines the target mesh
  129970. * @param scaleLines defines a scaling factor for line length (1 by default)
  129971. */
  129972. constructor(scene: Scene, bone: Bone, mesh: Mesh, scaleLines?: number);
  129973. /**
  129974. * Force the viewer to update
  129975. */
  129976. update(): void;
  129977. /** Releases resources */
  129978. dispose(): void;
  129979. }
  129980. }
  129981. declare module BABYLON {
  129982. /**
  129983. * Interface used to define scene explorer extensibility option
  129984. */
  129985. export interface IExplorerExtensibilityOption {
  129986. /**
  129987. * Define the option label
  129988. */
  129989. label: string;
  129990. /**
  129991. * Defines the action to execute on click
  129992. */
  129993. action: (entity: any) => void;
  129994. }
  129995. /**
  129996. * Defines a group of actions associated with a predicate to use when extending the Inspector scene explorer
  129997. */
  129998. export interface IExplorerExtensibilityGroup {
  129999. /**
  130000. * Defines a predicate to test if a given type mut be extended
  130001. */
  130002. predicate: (entity: any) => boolean;
  130003. /**
  130004. * Gets the list of options added to a type
  130005. */
  130006. entries: IExplorerExtensibilityOption[];
  130007. }
  130008. /**
  130009. * Interface used to define the options to use to create the Inspector
  130010. */
  130011. export interface IInspectorOptions {
  130012. /**
  130013. * Display in overlay mode (default: false)
  130014. */
  130015. overlay?: boolean;
  130016. /**
  130017. * HTML element to use as root (the parent of the rendering canvas will be used as default value)
  130018. */
  130019. globalRoot?: HTMLElement;
  130020. /**
  130021. * Display the Scene explorer
  130022. */
  130023. showExplorer?: boolean;
  130024. /**
  130025. * Display the property inspector
  130026. */
  130027. showInspector?: boolean;
  130028. /**
  130029. * Display in embed mode (both panes on the right)
  130030. */
  130031. embedMode?: boolean;
  130032. /**
  130033. * let the Inspector handles resize of the canvas when panes are resized (default to true)
  130034. */
  130035. handleResize?: boolean;
  130036. /**
  130037. * Allow the panes to popup (default: true)
  130038. */
  130039. enablePopup?: boolean;
  130040. /**
  130041. * Allow the panes to be closed by users (default: true)
  130042. */
  130043. enableClose?: boolean;
  130044. /**
  130045. * Optional list of extensibility entries
  130046. */
  130047. explorerExtensibility?: IExplorerExtensibilityGroup[];
  130048. /**
  130049. * Optional URL to get the inspector script from (by default it uses the babylonjs CDN).
  130050. */
  130051. inspectorURL?: string;
  130052. /**
  130053. * Optional initial tab (default to DebugLayerTab.Properties)
  130054. */
  130055. initialTab?: DebugLayerTab;
  130056. }
  130057. interface Scene {
  130058. /**
  130059. * @hidden
  130060. * Backing field
  130061. */
  130062. _debugLayer: DebugLayer;
  130063. /**
  130064. * Gets the debug layer (aka Inspector) associated with the scene
  130065. * @see https://doc.babylonjs.com/features/playground_debuglayer
  130066. */
  130067. debugLayer: DebugLayer;
  130068. }
  130069. /**
  130070. * Enum of inspector action tab
  130071. */
  130072. export enum DebugLayerTab {
  130073. /**
  130074. * Properties tag (default)
  130075. */
  130076. Properties = 0,
  130077. /**
  130078. * Debug tab
  130079. */
  130080. Debug = 1,
  130081. /**
  130082. * Statistics tab
  130083. */
  130084. Statistics = 2,
  130085. /**
  130086. * Tools tab
  130087. */
  130088. Tools = 3,
  130089. /**
  130090. * Settings tab
  130091. */
  130092. Settings = 4
  130093. }
  130094. /**
  130095. * The debug layer (aka Inspector) is the go to tool in order to better understand
  130096. * what is happening in your scene
  130097. * @see https://doc.babylonjs.com/features/playground_debuglayer
  130098. */
  130099. export class DebugLayer {
  130100. /**
  130101. * Define the url to get the inspector script from.
  130102. * By default it uses the babylonjs CDN.
  130103. * @ignoreNaming
  130104. */
  130105. static InspectorURL: string;
  130106. private _scene;
  130107. private BJSINSPECTOR;
  130108. private _onPropertyChangedObservable?;
  130109. /**
  130110. * Observable triggered when a property is changed through the inspector.
  130111. */
  130112. get onPropertyChangedObservable(): any;
  130113. /**
  130114. * Instantiates a new debug layer.
  130115. * The debug layer (aka Inspector) is the go to tool in order to better understand
  130116. * what is happening in your scene
  130117. * @see https://doc.babylonjs.com/features/playground_debuglayer
  130118. * @param scene Defines the scene to inspect
  130119. */
  130120. constructor(scene: Scene);
  130121. /** Creates the inspector window. */
  130122. private _createInspector;
  130123. /**
  130124. * Select a specific entity in the scene explorer and highlight a specific block in that entity property grid
  130125. * @param entity defines the entity to select
  130126. * @param lineContainerTitles defines the specific blocks to highlight (could be a string or an array of strings)
  130127. */
  130128. select(entity: any, lineContainerTitles?: string | string[]): void;
  130129. /** Get the inspector from bundle or global */
  130130. private _getGlobalInspector;
  130131. /**
  130132. * Get if the inspector is visible or not.
  130133. * @returns true if visible otherwise, false
  130134. */
  130135. isVisible(): boolean;
  130136. /**
  130137. * Hide the inspector and close its window.
  130138. */
  130139. hide(): void;
  130140. /**
  130141. * Update the scene in the inspector
  130142. */
  130143. setAsActiveScene(): void;
  130144. /**
  130145. * Launch the debugLayer.
  130146. * @param config Define the configuration of the inspector
  130147. * @return a promise fulfilled when the debug layer is visible
  130148. */
  130149. show(config?: IInspectorOptions): Promise<DebugLayer>;
  130150. }
  130151. }
  130152. declare module BABYLON {
  130153. /**
  130154. * Class containing static functions to help procedurally build meshes
  130155. */
  130156. export class BoxBuilder {
  130157. /**
  130158. * Creates a box mesh
  130159. * * The parameter `size` sets the size (float) of each box side (default 1)
  130160. * * You can set some different box dimensions by using the parameters `width`, `height` and `depth` (all by default have the same value of `size`)
  130161. * * 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)
  130162. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  130163. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  130164. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  130165. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  130166. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  130167. * @param name defines the name of the mesh
  130168. * @param options defines the options used to create the mesh
  130169. * @param scene defines the hosting scene
  130170. * @returns the box mesh
  130171. */
  130172. static CreateBox(name: string, options: {
  130173. size?: number;
  130174. width?: number;
  130175. height?: number;
  130176. depth?: number;
  130177. faceUV?: Vector4[];
  130178. faceColors?: Color4[];
  130179. sideOrientation?: number;
  130180. frontUVs?: Vector4;
  130181. backUVs?: Vector4;
  130182. wrap?: boolean;
  130183. topBaseAt?: number;
  130184. bottomBaseAt?: number;
  130185. updatable?: boolean;
  130186. }, scene?: Nullable<Scene>): Mesh;
  130187. }
  130188. }
  130189. declare module BABYLON.Debug {
  130190. /**
  130191. * Used to show the physics impostor around the specific mesh
  130192. */
  130193. export class PhysicsViewer {
  130194. /** @hidden */
  130195. protected _impostors: Array<Nullable<PhysicsImpostor>>;
  130196. /** @hidden */
  130197. protected _meshes: Array<Nullable<AbstractMesh>>;
  130198. /** @hidden */
  130199. protected _scene: Nullable<Scene>;
  130200. /** @hidden */
  130201. protected _numMeshes: number;
  130202. /** @hidden */
  130203. protected _physicsEnginePlugin: Nullable<IPhysicsEnginePlugin>;
  130204. private _renderFunction;
  130205. private _utilityLayer;
  130206. private _debugBoxMesh;
  130207. private _debugSphereMesh;
  130208. private _debugCylinderMesh;
  130209. private _debugMaterial;
  130210. private _debugMeshMeshes;
  130211. /**
  130212. * Creates a new PhysicsViewer
  130213. * @param scene defines the hosting scene
  130214. */
  130215. constructor(scene: Scene);
  130216. /** @hidden */
  130217. protected _updateDebugMeshes(): void;
  130218. /**
  130219. * Renders a specified physic impostor
  130220. * @param impostor defines the impostor to render
  130221. * @param targetMesh defines the mesh represented by the impostor
  130222. * @returns the new debug mesh used to render the impostor
  130223. */
  130224. showImpostor(impostor: PhysicsImpostor, targetMesh?: Mesh): Nullable<AbstractMesh>;
  130225. /**
  130226. * Hides a specified physic impostor
  130227. * @param impostor defines the impostor to hide
  130228. */
  130229. hideImpostor(impostor: Nullable<PhysicsImpostor>): void;
  130230. private _getDebugMaterial;
  130231. private _getDebugBoxMesh;
  130232. private _getDebugSphereMesh;
  130233. private _getDebugCylinderMesh;
  130234. private _getDebugMeshMesh;
  130235. private _getDebugMesh;
  130236. /** Releases all resources */
  130237. dispose(): void;
  130238. }
  130239. }
  130240. declare module BABYLON {
  130241. /**
  130242. * As raycast might be hard to debug, the RayHelper can help rendering the different rays
  130243. * in order to better appreciate the issue one might have.
  130244. * @see https://doc.babylonjs.com/babylon101/raycasts#debugging
  130245. */
  130246. export class RayHelper {
  130247. /**
  130248. * Defines the ray we are currently tryin to visualize.
  130249. */
  130250. ray: Nullable<Ray>;
  130251. private _renderPoints;
  130252. private _renderLine;
  130253. private _renderFunction;
  130254. private _scene;
  130255. private _onAfterRenderObserver;
  130256. private _onAfterStepObserver;
  130257. private _attachedToMesh;
  130258. private _meshSpaceDirection;
  130259. private _meshSpaceOrigin;
  130260. /**
  130261. * Helper function to create a colored helper in a scene in one line.
  130262. * @param ray Defines the ray we are currently tryin to visualize
  130263. * @param scene Defines the scene the ray is used in
  130264. * @param color Defines the color we want to see the ray in
  130265. * @returns The newly created ray helper.
  130266. */
  130267. static CreateAndShow(ray: Ray, scene: Scene, color: Color3): RayHelper;
  130268. /**
  130269. * Instantiate a new ray helper.
  130270. * As raycast might be hard to debug, the RayHelper can help rendering the different rays
  130271. * in order to better appreciate the issue one might have.
  130272. * @see https://doc.babylonjs.com/babylon101/raycasts#debugging
  130273. * @param ray Defines the ray we are currently tryin to visualize
  130274. */
  130275. constructor(ray: Ray);
  130276. /**
  130277. * Shows the ray we are willing to debug.
  130278. * @param scene Defines the scene the ray needs to be rendered in
  130279. * @param color Defines the color the ray needs to be rendered in
  130280. */
  130281. show(scene: Scene, color?: Color3): void;
  130282. /**
  130283. * Hides the ray we are debugging.
  130284. */
  130285. hide(): void;
  130286. private _render;
  130287. /**
  130288. * Attach a ray helper to a mesh so that we can easily see its orientation for instance or information like its normals.
  130289. * @param mesh Defines the mesh we want the helper attached to
  130290. * @param meshSpaceDirection Defines the direction of the Ray in mesh space (local space of the mesh node)
  130291. * @param meshSpaceOrigin Defines the origin of the Ray in mesh space (local space of the mesh node)
  130292. * @param length Defines the length of the ray
  130293. */
  130294. attachToMesh(mesh: AbstractMesh, meshSpaceDirection?: Vector3, meshSpaceOrigin?: Vector3, length?: number): void;
  130295. /**
  130296. * Detach the ray helper from the mesh it has previously been attached to.
  130297. */
  130298. detachFromMesh(): void;
  130299. private _updateToMesh;
  130300. /**
  130301. * Dispose the helper and release its associated resources.
  130302. */
  130303. dispose(): void;
  130304. }
  130305. }
  130306. declare module BABYLON {
  130307. /**
  130308. * Defines the options associated with the creation of a SkeletonViewer.
  130309. */
  130310. export interface ISkeletonViewerOptions {
  130311. /** Should the system pause animations before building the Viewer? */
  130312. pauseAnimations: boolean;
  130313. /** Should the system return the skeleton to rest before building? */
  130314. returnToRest: boolean;
  130315. /** public Display Mode of the Viewer */
  130316. displayMode: number;
  130317. /** Flag to toggle if the Viewer should use the CPU for animations or not? */
  130318. displayOptions: ISkeletonViewerDisplayOptions;
  130319. /** Flag to toggle if the Viewer should use the CPU for animations or not? */
  130320. computeBonesUsingShaders: boolean;
  130321. }
  130322. /**
  130323. * Defines how to display the various bone meshes for the viewer.
  130324. */
  130325. export interface ISkeletonViewerDisplayOptions {
  130326. /** How far down to start tapering the bone spurs */
  130327. midStep?: number;
  130328. /** How big is the midStep? */
  130329. midStepFactor?: number;
  130330. /** Base for the Sphere Size */
  130331. sphereBaseSize?: number;
  130332. /** The ratio of the sphere to the longest bone in units */
  130333. sphereScaleUnit?: number;
  130334. /** Ratio for the Sphere Size */
  130335. sphereFactor?: number;
  130336. }
  130337. }
  130338. declare module BABYLON {
  130339. /**
  130340. * Class containing static functions to help procedurally build meshes
  130341. */
  130342. export class RibbonBuilder {
  130343. /**
  130344. * Creates a ribbon mesh. The ribbon is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  130345. * * The parameter `pathArray` is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry
  130346. * * The parameter `closeArray` (boolean, default false) creates a seam between the first and the last paths of the path array
  130347. * * The parameter `closePath` (boolean, default false) creates a seam between the first and the last points of each path of the path array
  130348. * * 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
  130349. * * 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
  130350. * * 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
  130351. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  130352. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  130353. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  130354. * * 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
  130355. * * The parameters `colors` is an optional flat array of `Color4` to set/update each ribbon vertex with its own custom color values
  130356. * * 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
  130357. * * Moreover, you can use the parameter `color` with `instance` (to update the ribbon), only if you previously used it at creation time
  130358. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  130359. * @param name defines the name of the mesh
  130360. * @param options defines the options used to create the mesh
  130361. * @param scene defines the hosting scene
  130362. * @returns the ribbon mesh
  130363. * @see https://doc.babylonjs.com/how_to/ribbon_tutorial
  130364. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  130365. */
  130366. static CreateRibbon(name: string, options: {
  130367. pathArray: Vector3[][];
  130368. closeArray?: boolean;
  130369. closePath?: boolean;
  130370. offset?: number;
  130371. updatable?: boolean;
  130372. sideOrientation?: number;
  130373. frontUVs?: Vector4;
  130374. backUVs?: Vector4;
  130375. instance?: Mesh;
  130376. invertUV?: boolean;
  130377. uvs?: Vector2[];
  130378. colors?: Color4[];
  130379. }, scene?: Nullable<Scene>): Mesh;
  130380. }
  130381. }
  130382. declare module BABYLON {
  130383. /**
  130384. * Class containing static functions to help procedurally build meshes
  130385. */
  130386. export class ShapeBuilder {
  130387. /**
  130388. * 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.
  130389. * * 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.
  130390. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  130391. * * 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.
  130392. * * The parameter `scale` (float, default 1) is the value to scale the shape.
  130393. * * 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
  130394. * * 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
  130395. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape.
  130396. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  130397. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  130398. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture.
  130399. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  130400. * @param name defines the name of the mesh
  130401. * @param options defines the options used to create the mesh
  130402. * @param scene defines the hosting scene
  130403. * @returns the extruded shape mesh
  130404. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  130405. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  130406. */
  130407. static ExtrudeShape(name: string, options: {
  130408. shape: Vector3[];
  130409. path: Vector3[];
  130410. scale?: number;
  130411. rotation?: number;
  130412. cap?: number;
  130413. updatable?: boolean;
  130414. sideOrientation?: number;
  130415. frontUVs?: Vector4;
  130416. backUVs?: Vector4;
  130417. instance?: Mesh;
  130418. invertUV?: boolean;
  130419. }, scene?: Nullable<Scene>): Mesh;
  130420. /**
  130421. * Creates an custom extruded shape mesh.
  130422. * The custom extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  130423. * * 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.
  130424. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  130425. * * 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
  130426. * * It must returns a float value that will be the rotation in radians applied to the shape on each path point.
  130427. * * 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
  130428. * * It must returns a float value that will be the scale value applied to the shape on each path point
  130429. * * The parameter `ribbonClosePath` (boolean, default false) forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  130430. * * The parameter `ribbonCloseArray` (boolean, default false) forces the extrusion underlying ribbon to close its `pathArray`
  130431. * * 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
  130432. * * 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
  130433. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape
  130434. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  130435. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  130436. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  130437. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  130438. * @param name defines the name of the mesh
  130439. * @param options defines the options used to create the mesh
  130440. * @param scene defines the hosting scene
  130441. * @returns the custom extruded shape mesh
  130442. * @see https://doc.babylonjs.com/how_to/parametric_shapes#custom-extruded-shapes
  130443. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  130444. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  130445. */
  130446. static ExtrudeShapeCustom(name: string, options: {
  130447. shape: Vector3[];
  130448. path: Vector3[];
  130449. scaleFunction?: any;
  130450. rotationFunction?: any;
  130451. ribbonCloseArray?: boolean;
  130452. ribbonClosePath?: boolean;
  130453. cap?: number;
  130454. updatable?: boolean;
  130455. sideOrientation?: number;
  130456. frontUVs?: Vector4;
  130457. backUVs?: Vector4;
  130458. instance?: Mesh;
  130459. invertUV?: boolean;
  130460. }, scene?: Nullable<Scene>): Mesh;
  130461. private static _ExtrudeShapeGeneric;
  130462. }
  130463. }
  130464. declare module BABYLON.Debug {
  130465. /**
  130466. * Class used to render a debug view of a given skeleton
  130467. * @see http://www.babylonjs-playground.com/#1BZJVJ#8
  130468. */
  130469. export class SkeletonViewer {
  130470. /** defines the skeleton to render */
  130471. skeleton: Skeleton;
  130472. /** defines the mesh attached to the skeleton */
  130473. mesh: AbstractMesh;
  130474. /** defines a boolean indicating if bones matrices must be forced to update before rendering (true by default) */
  130475. autoUpdateBonesMatrices: boolean;
  130476. /** defines the rendering group id to use with the viewer */
  130477. renderingGroupId: number;
  130478. /** is the options for the viewer */
  130479. options: Partial<ISkeletonViewerOptions>;
  130480. /** public Display constants BABYLON.SkeletonViewer.DISPLAY_LINES */
  130481. static readonly DISPLAY_LINES: number;
  130482. /** public Display constants BABYLON.SkeletonViewer.DISPLAY_SPHERES */
  130483. static readonly DISPLAY_SPHERES: number;
  130484. /** public Display constants BABYLON.SkeletonViewer.DISPLAY_SPHERE_AND_SPURS */
  130485. static readonly DISPLAY_SPHERE_AND_SPURS: number;
  130486. /** If SkeletonViewer scene scope. */
  130487. private _scene;
  130488. /** Gets or sets the color used to render the skeleton */
  130489. color: Color3;
  130490. /** Array of the points of the skeleton fo the line view. */
  130491. private _debugLines;
  130492. /** The SkeletonViewers Mesh. */
  130493. private _debugMesh;
  130494. /** If SkeletonViewer is enabled. */
  130495. private _isEnabled;
  130496. /** If SkeletonViewer is ready. */
  130497. private _ready;
  130498. /** SkeletonViewer render observable. */
  130499. private _obs;
  130500. /** The Utility Layer to render the gizmos in. */
  130501. private _utilityLayer;
  130502. private _boneIndices;
  130503. /** Gets the Scene. */
  130504. get scene(): Scene;
  130505. /** Gets the utilityLayer. */
  130506. get utilityLayer(): Nullable<UtilityLayerRenderer>;
  130507. /** Checks Ready Status. */
  130508. get isReady(): Boolean;
  130509. /** Sets Ready Status. */
  130510. set ready(value: boolean);
  130511. /** Gets the debugMesh */
  130512. get debugMesh(): Nullable<AbstractMesh> | Nullable<LinesMesh>;
  130513. /** Sets the debugMesh */
  130514. set debugMesh(value: Nullable<AbstractMesh> | Nullable<LinesMesh>);
  130515. /** Gets the material */
  130516. get material(): StandardMaterial;
  130517. /** Sets the material */
  130518. set material(value: StandardMaterial);
  130519. /** Gets the material */
  130520. get displayMode(): number;
  130521. /** Sets the material */
  130522. set displayMode(value: number);
  130523. /**
  130524. * Creates a new SkeletonViewer
  130525. * @param skeleton defines the skeleton to render
  130526. * @param mesh defines the mesh attached to the skeleton
  130527. * @param scene defines the hosting scene
  130528. * @param autoUpdateBonesMatrices defines a boolean indicating if bones matrices must be forced to update before rendering (true by default)
  130529. * @param renderingGroupId defines the rendering group id to use with the viewer
  130530. * @param options All of the extra constructor options for the SkeletonViewer
  130531. */
  130532. constructor(
  130533. /** defines the skeleton to render */
  130534. skeleton: Skeleton,
  130535. /** defines the mesh attached to the skeleton */
  130536. mesh: AbstractMesh,
  130537. /** The Scene scope*/
  130538. scene: Scene,
  130539. /** defines a boolean indicating if bones matrices must be forced to update before rendering (true by default) */
  130540. autoUpdateBonesMatrices?: boolean,
  130541. /** defines the rendering group id to use with the viewer */
  130542. renderingGroupId?: number,
  130543. /** is the options for the viewer */
  130544. options?: Partial<ISkeletonViewerOptions>);
  130545. /** The Dynamic bindings for the update functions */
  130546. private _bindObs;
  130547. /** Update the viewer to sync with current skeleton state, only used to manually update. */
  130548. update(): void;
  130549. /** Gets or sets a boolean indicating if the viewer is enabled */
  130550. set isEnabled(value: boolean);
  130551. get isEnabled(): boolean;
  130552. private _getBonePosition;
  130553. private _getLinesForBonesWithLength;
  130554. private _getLinesForBonesNoLength;
  130555. /** function to revert the mesh and scene back to the initial state. */
  130556. private _revert;
  130557. /** function to build and bind sphere joint points and spur bone representations. */
  130558. private _buildSpheresAndSpurs;
  130559. /** Update the viewer to sync with current skeleton state, only used for the line display. */
  130560. private _displayLinesUpdate;
  130561. /** Changes the displayMode of the skeleton viewer
  130562. * @param mode The displayMode numerical value
  130563. */
  130564. changeDisplayMode(mode: number): void;
  130565. /** Changes the displayMode of the skeleton viewer
  130566. * @param option String of the option name
  130567. * @param value The numerical option value
  130568. */
  130569. changeDisplayOptions(option: string, value: number): void;
  130570. /** Release associated resources */
  130571. dispose(): void;
  130572. }
  130573. }
  130574. declare module BABYLON {
  130575. /**
  130576. * Enum for Device Types
  130577. */
  130578. export enum DeviceType {
  130579. /** Generic */
  130580. Generic = 0,
  130581. /** Keyboard */
  130582. Keyboard = 1,
  130583. /** Mouse */
  130584. Mouse = 2,
  130585. /** Touch Pointers */
  130586. Touch = 3,
  130587. /** PS4 Dual Shock */
  130588. DualShock = 4,
  130589. /** Xbox */
  130590. Xbox = 5,
  130591. /** Switch Controller */
  130592. Switch = 6
  130593. }
  130594. /**
  130595. * Enum for All Pointers (Touch/Mouse)
  130596. */
  130597. export enum PointerInput {
  130598. /** Horizontal Axis */
  130599. Horizontal = 0,
  130600. /** Vertical Axis */
  130601. Vertical = 1,
  130602. /** Left Click or Touch */
  130603. LeftClick = 2,
  130604. /** Middle Click */
  130605. MiddleClick = 3,
  130606. /** Right Click */
  130607. RightClick = 4,
  130608. /** Browser Back */
  130609. BrowserBack = 5,
  130610. /** Browser Forward */
  130611. BrowserForward = 6
  130612. }
  130613. /**
  130614. * Enum for Dual Shock Gamepad
  130615. */
  130616. export enum DualShockInput {
  130617. /** Cross */
  130618. Cross = 0,
  130619. /** Circle */
  130620. Circle = 1,
  130621. /** Square */
  130622. Square = 2,
  130623. /** Triangle */
  130624. Triangle = 3,
  130625. /** L1 */
  130626. L1 = 4,
  130627. /** R1 */
  130628. R1 = 5,
  130629. /** L2 */
  130630. L2 = 6,
  130631. /** R2 */
  130632. R2 = 7,
  130633. /** Share */
  130634. Share = 8,
  130635. /** Options */
  130636. Options = 9,
  130637. /** L3 */
  130638. L3 = 10,
  130639. /** R3 */
  130640. R3 = 11,
  130641. /** DPadUp */
  130642. DPadUp = 12,
  130643. /** DPadDown */
  130644. DPadDown = 13,
  130645. /** DPadLeft */
  130646. DPadLeft = 14,
  130647. /** DRight */
  130648. DPadRight = 15,
  130649. /** Home */
  130650. Home = 16,
  130651. /** TouchPad */
  130652. TouchPad = 17,
  130653. /** LStickXAxis */
  130654. LStickXAxis = 18,
  130655. /** LStickYAxis */
  130656. LStickYAxis = 19,
  130657. /** RStickXAxis */
  130658. RStickXAxis = 20,
  130659. /** RStickYAxis */
  130660. RStickYAxis = 21
  130661. }
  130662. /**
  130663. * Enum for Xbox Gamepad
  130664. */
  130665. export enum XboxInput {
  130666. /** A */
  130667. A = 0,
  130668. /** B */
  130669. B = 1,
  130670. /** X */
  130671. X = 2,
  130672. /** Y */
  130673. Y = 3,
  130674. /** LB */
  130675. LB = 4,
  130676. /** RB */
  130677. RB = 5,
  130678. /** LT */
  130679. LT = 6,
  130680. /** RT */
  130681. RT = 7,
  130682. /** Back */
  130683. Back = 8,
  130684. /** Start */
  130685. Start = 9,
  130686. /** LS */
  130687. LS = 10,
  130688. /** RS */
  130689. RS = 11,
  130690. /** DPadUp */
  130691. DPadUp = 12,
  130692. /** DPadDown */
  130693. DPadDown = 13,
  130694. /** DPadLeft */
  130695. DPadLeft = 14,
  130696. /** DRight */
  130697. DPadRight = 15,
  130698. /** Home */
  130699. Home = 16,
  130700. /** LStickXAxis */
  130701. LStickXAxis = 17,
  130702. /** LStickYAxis */
  130703. LStickYAxis = 18,
  130704. /** RStickXAxis */
  130705. RStickXAxis = 19,
  130706. /** RStickYAxis */
  130707. RStickYAxis = 20
  130708. }
  130709. /**
  130710. * Enum for Switch (Pro/JoyCon L+R) Gamepad
  130711. */
  130712. export enum SwitchInput {
  130713. /** B */
  130714. B = 0,
  130715. /** A */
  130716. A = 1,
  130717. /** Y */
  130718. Y = 2,
  130719. /** X */
  130720. X = 3,
  130721. /** L */
  130722. L = 4,
  130723. /** R */
  130724. R = 5,
  130725. /** ZL */
  130726. ZL = 6,
  130727. /** ZR */
  130728. ZR = 7,
  130729. /** Minus */
  130730. Minus = 8,
  130731. /** Plus */
  130732. Plus = 9,
  130733. /** LS */
  130734. LS = 10,
  130735. /** RS */
  130736. RS = 11,
  130737. /** DPadUp */
  130738. DPadUp = 12,
  130739. /** DPadDown */
  130740. DPadDown = 13,
  130741. /** DPadLeft */
  130742. DPadLeft = 14,
  130743. /** DRight */
  130744. DPadRight = 15,
  130745. /** Home */
  130746. Home = 16,
  130747. /** Capture */
  130748. Capture = 17,
  130749. /** LStickXAxis */
  130750. LStickXAxis = 18,
  130751. /** LStickYAxis */
  130752. LStickYAxis = 19,
  130753. /** RStickXAxis */
  130754. RStickXAxis = 20,
  130755. /** RStickYAxis */
  130756. RStickYAxis = 21
  130757. }
  130758. }
  130759. declare module BABYLON {
  130760. /**
  130761. * This class will take all inputs from Keyboard, Pointer, and
  130762. * any Gamepads and provide a polling system that all devices
  130763. * will use. This class assumes that there will only be one
  130764. * pointer device and one keyboard.
  130765. */
  130766. export class DeviceInputSystem implements IDisposable {
  130767. /**
  130768. * Callback to be triggered when a device is connected
  130769. */
  130770. onDeviceConnected: (deviceType: DeviceType, deviceSlot: number) => void;
  130771. /**
  130772. * Callback to be triggered when a device is disconnected
  130773. */
  130774. onDeviceDisconnected: (deviceType: DeviceType, deviceSlot: number) => void;
  130775. /**
  130776. * Callback to be triggered when event driven input is updated
  130777. */
  130778. onInputChanged: (deviceType: DeviceType, deviceSlot: number, inputIndex: number, previousState: Nullable<number>, currentState: Nullable<number>) => void;
  130779. private _inputs;
  130780. private _gamepads;
  130781. private _keyboardActive;
  130782. private _pointerActive;
  130783. private _elementToAttachTo;
  130784. private _keyboardDownEvent;
  130785. private _keyboardUpEvent;
  130786. private _pointerMoveEvent;
  130787. private _pointerDownEvent;
  130788. private _pointerUpEvent;
  130789. private _gamepadConnectedEvent;
  130790. private _gamepadDisconnectedEvent;
  130791. private static _MAX_KEYCODES;
  130792. private static _MAX_POINTER_INPUTS;
  130793. private constructor();
  130794. /**
  130795. * Creates a new DeviceInputSystem instance
  130796. * @param engine Engine to pull input element from
  130797. * @returns The new instance
  130798. */
  130799. static Create(engine: Engine): DeviceInputSystem;
  130800. /**
  130801. * Checks for current device input value, given an id and input index
  130802. * @param deviceName Id of connected device
  130803. * @param inputIndex Index of device input
  130804. * @returns Current value of input
  130805. */
  130806. /**
  130807. * Checks for current device input value, given an id and input index. Throws exception if requested device not initialized.
  130808. * @param deviceType Enum specifiying device type
  130809. * @param deviceSlot "Slot" or index that device is referenced in
  130810. * @param inputIndex Id of input to be checked
  130811. * @returns Current value of input
  130812. */
  130813. pollInput(deviceType: DeviceType, deviceSlot: number, inputIndex: number): number;
  130814. /**
  130815. * Dispose of all the eventlisteners
  130816. */
  130817. dispose(): void;
  130818. /**
  130819. * Add device and inputs to device array
  130820. * @param deviceType Enum specifiying device type
  130821. * @param deviceSlot "Slot" or index that device is referenced in
  130822. * @param numberOfInputs Number of input entries to create for given device
  130823. */
  130824. private _registerDevice;
  130825. /**
  130826. * Given a specific device name, remove that device from the device map
  130827. * @param deviceType Enum specifiying device type
  130828. * @param deviceSlot "Slot" or index that device is referenced in
  130829. */
  130830. private _unregisterDevice;
  130831. /**
  130832. * Handle all actions that come from keyboard interaction
  130833. */
  130834. private _handleKeyActions;
  130835. /**
  130836. * Handle all actions that come from pointer interaction
  130837. */
  130838. private _handlePointerActions;
  130839. /**
  130840. * Handle all actions that come from gamepad interaction
  130841. */
  130842. private _handleGamepadActions;
  130843. /**
  130844. * Update all non-event based devices with each frame
  130845. * @param deviceType Enum specifiying device type
  130846. * @param deviceSlot "Slot" or index that device is referenced in
  130847. * @param inputIndex Id of input to be checked
  130848. */
  130849. private _updateDevice;
  130850. /**
  130851. * Gets DeviceType from the device name
  130852. * @param deviceName Name of Device from DeviceInputSystem
  130853. * @returns DeviceType enum value
  130854. */
  130855. private _getGamepadDeviceType;
  130856. }
  130857. }
  130858. declare module BABYLON {
  130859. /**
  130860. * Type to handle enforcement of inputs
  130861. */
  130862. 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;
  130863. }
  130864. declare module BABYLON {
  130865. /**
  130866. * Class that handles all input for a specific device
  130867. */
  130868. export class DeviceSource<T extends DeviceType> {
  130869. /** Type of device */
  130870. readonly deviceType: DeviceType;
  130871. /** "Slot" or index that device is referenced in */
  130872. readonly deviceSlot: number;
  130873. /**
  130874. * Observable to handle device input changes per device
  130875. */
  130876. readonly onInputChangedObservable: Observable<{
  130877. inputIndex: DeviceInput<T>;
  130878. previousState: Nullable<number>;
  130879. currentState: Nullable<number>;
  130880. }>;
  130881. private readonly _deviceInputSystem;
  130882. /**
  130883. * Default Constructor
  130884. * @param deviceInputSystem Reference to DeviceInputSystem
  130885. * @param deviceType Type of device
  130886. * @param deviceSlot "Slot" or index that device is referenced in
  130887. */
  130888. constructor(deviceInputSystem: DeviceInputSystem,
  130889. /** Type of device */
  130890. deviceType: DeviceType,
  130891. /** "Slot" or index that device is referenced in */
  130892. deviceSlot?: number);
  130893. /**
  130894. * Get input for specific input
  130895. * @param inputIndex index of specific input on device
  130896. * @returns Input value from DeviceInputSystem
  130897. */
  130898. getInput(inputIndex: DeviceInput<T>): Nullable<number>;
  130899. }
  130900. /**
  130901. * Class to keep track of devices
  130902. */
  130903. export class DeviceSourceManager implements IDisposable {
  130904. /**
  130905. * Observable to be triggered when before a device is connected
  130906. */
  130907. readonly onBeforeDeviceConnectedObservable: Observable<{
  130908. deviceType: DeviceType;
  130909. deviceSlot: number;
  130910. }>;
  130911. /**
  130912. * Observable to be triggered when before a device is disconnected
  130913. */
  130914. readonly onBeforeDeviceDisconnectedObservable: Observable<{
  130915. deviceType: DeviceType;
  130916. deviceSlot: number;
  130917. }>;
  130918. /**
  130919. * Observable to be triggered when after a device is connected
  130920. */
  130921. readonly onAfterDeviceConnectedObservable: Observable<{
  130922. deviceType: DeviceType;
  130923. deviceSlot: number;
  130924. }>;
  130925. /**
  130926. * Observable to be triggered when after a device is disconnected
  130927. */
  130928. readonly onAfterDeviceDisconnectedObservable: Observable<{
  130929. deviceType: DeviceType;
  130930. deviceSlot: number;
  130931. }>;
  130932. private readonly _devices;
  130933. private readonly _firstDevice;
  130934. private readonly _deviceInputSystem;
  130935. /**
  130936. * Default Constructor
  130937. * @param engine engine to pull input element from
  130938. */
  130939. constructor(engine: Engine);
  130940. /**
  130941. * Gets a DeviceSource, given a type and slot
  130942. * @param deviceType Enum specifying device type
  130943. * @param deviceSlot "Slot" or index that device is referenced in
  130944. * @returns DeviceSource object
  130945. */
  130946. getDeviceSource<T extends DeviceType>(deviceType: T, deviceSlot?: number): Nullable<DeviceSource<T>>;
  130947. /**
  130948. * Gets an array of DeviceSource objects for a given device type
  130949. * @param deviceType Enum specifying device type
  130950. * @returns Array of DeviceSource objects
  130951. */
  130952. getDeviceSources<T extends DeviceType>(deviceType: T): ReadonlyArray<DeviceSource<T>>;
  130953. /**
  130954. * Dispose of DeviceInputSystem and other parts
  130955. */
  130956. dispose(): void;
  130957. /**
  130958. * Function to add device name to device list
  130959. * @param deviceType Enum specifying device type
  130960. * @param deviceSlot "Slot" or index that device is referenced in
  130961. */
  130962. private _addDevice;
  130963. /**
  130964. * Function to remove device name to device list
  130965. * @param deviceType Enum specifying device type
  130966. * @param deviceSlot "Slot" or index that device is referenced in
  130967. */
  130968. private _removeDevice;
  130969. /**
  130970. * Updates array storing first connected device of each type
  130971. * @param type Type of Device
  130972. */
  130973. private _updateFirstDevices;
  130974. }
  130975. }
  130976. declare module BABYLON {
  130977. /**
  130978. * Options to create the null engine
  130979. */
  130980. export class NullEngineOptions {
  130981. /**
  130982. * Render width (Default: 512)
  130983. */
  130984. renderWidth: number;
  130985. /**
  130986. * Render height (Default: 256)
  130987. */
  130988. renderHeight: number;
  130989. /**
  130990. * Texture size (Default: 512)
  130991. */
  130992. textureSize: number;
  130993. /**
  130994. * If delta time between frames should be constant
  130995. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  130996. */
  130997. deterministicLockstep: boolean;
  130998. /**
  130999. * Maximum about of steps between frames (Default: 4)
  131000. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  131001. */
  131002. lockstepMaxSteps: number;
  131003. /**
  131004. * Make the matrix computations to be performed in 64 bits instead of 32 bits. False by default
  131005. */
  131006. useHighPrecisionMatrix?: boolean;
  131007. }
  131008. /**
  131009. * The null engine class provides support for headless version of babylon.js.
  131010. * This can be used in server side scenario or for testing purposes
  131011. */
  131012. export class NullEngine extends Engine {
  131013. private _options;
  131014. /**
  131015. * Gets a boolean indicating that the engine is running in deterministic lock step mode
  131016. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  131017. * @returns true if engine is in deterministic lock step mode
  131018. */
  131019. isDeterministicLockStep(): boolean;
  131020. /**
  131021. * Gets the max steps when engine is running in deterministic lock step
  131022. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  131023. * @returns the max steps
  131024. */
  131025. getLockstepMaxSteps(): number;
  131026. /**
  131027. * Gets the current hardware scaling level.
  131028. * By default the hardware scaling level is computed from the window device ratio.
  131029. * 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.
  131030. * @returns a number indicating the current hardware scaling level
  131031. */
  131032. getHardwareScalingLevel(): number;
  131033. constructor(options?: NullEngineOptions);
  131034. /**
  131035. * Creates a vertex buffer
  131036. * @param vertices the data for the vertex buffer
  131037. * @returns the new WebGL static buffer
  131038. */
  131039. createVertexBuffer(vertices: FloatArray): DataBuffer;
  131040. /**
  131041. * Creates a new index buffer
  131042. * @param indices defines the content of the index buffer
  131043. * @param updatable defines if the index buffer must be updatable
  131044. * @returns a new webGL buffer
  131045. */
  131046. createIndexBuffer(indices: IndicesArray): DataBuffer;
  131047. /**
  131048. * Clear the current render buffer or the current render target (if any is set up)
  131049. * @param color defines the color to use
  131050. * @param backBuffer defines if the back buffer must be cleared
  131051. * @param depth defines if the depth buffer must be cleared
  131052. * @param stencil defines if the stencil buffer must be cleared
  131053. */
  131054. clear(color: IColor4Like, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  131055. /**
  131056. * Gets the current render width
  131057. * @param useScreen defines if screen size must be used (or the current render target if any)
  131058. * @returns a number defining the current render width
  131059. */
  131060. getRenderWidth(useScreen?: boolean): number;
  131061. /**
  131062. * Gets the current render height
  131063. * @param useScreen defines if screen size must be used (or the current render target if any)
  131064. * @returns a number defining the current render height
  131065. */
  131066. getRenderHeight(useScreen?: boolean): number;
  131067. /**
  131068. * Set the WebGL's viewport
  131069. * @param viewport defines the viewport element to be used
  131070. * @param requiredWidth defines the width required for rendering. If not provided the rendering canvas' width is used
  131071. * @param requiredHeight defines the height required for rendering. If not provided the rendering canvas' height is used
  131072. */
  131073. setViewport(viewport: IViewportLike, requiredWidth?: number, requiredHeight?: number): void;
  131074. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: string, context?: WebGLRenderingContext): WebGLProgram;
  131075. /**
  131076. * Gets the list of webGL uniform locations associated with a specific program based on a list of uniform names
  131077. * @param pipelineContext defines the pipeline context to use
  131078. * @param uniformsNames defines the list of uniform names
  131079. * @returns an array of webGL uniform locations
  131080. */
  131081. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): Nullable<WebGLUniformLocation>[];
  131082. /**
  131083. * Gets the lsit of active attributes for a given webGL program
  131084. * @param pipelineContext defines the pipeline context to use
  131085. * @param attributesNames defines the list of attribute names to get
  131086. * @returns an array of indices indicating the offset of each attribute
  131087. */
  131088. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  131089. /**
  131090. * Binds an effect to the webGL context
  131091. * @param effect defines the effect to bind
  131092. */
  131093. bindSamplers(effect: Effect): void;
  131094. /**
  131095. * Activates an effect, mkaing it the current one (ie. the one used for rendering)
  131096. * @param effect defines the effect to activate
  131097. */
  131098. enableEffect(effect: Effect): void;
  131099. /**
  131100. * Set various states to the webGL context
  131101. * @param culling defines backface culling state
  131102. * @param zOffset defines the value to apply to zOffset (0 by default)
  131103. * @param force defines if states must be applied even if cache is up to date
  131104. * @param reverseSide defines if culling must be reversed (CCW instead of CW and CW instead of CCW)
  131105. */
  131106. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  131107. /**
  131108. * Set the value of an uniform to an array of int32
  131109. * @param uniform defines the webGL uniform location where to store the value
  131110. * @param array defines the array of int32 to store
  131111. */
  131112. setIntArray(uniform: WebGLUniformLocation, array: Int32Array): void;
  131113. /**
  131114. * Set the value of an uniform to an array of int32 (stored as vec2)
  131115. * @param uniform defines the webGL uniform location where to store the value
  131116. * @param array defines the array of int32 to store
  131117. */
  131118. setIntArray2(uniform: WebGLUniformLocation, array: Int32Array): void;
  131119. /**
  131120. * Set the value of an uniform to an array of int32 (stored as vec3)
  131121. * @param uniform defines the webGL uniform location where to store the value
  131122. * @param array defines the array of int32 to store
  131123. */
  131124. setIntArray3(uniform: WebGLUniformLocation, array: Int32Array): void;
  131125. /**
  131126. * Set the value of an uniform to an array of int32 (stored as vec4)
  131127. * @param uniform defines the webGL uniform location where to store the value
  131128. * @param array defines the array of int32 to store
  131129. */
  131130. setIntArray4(uniform: WebGLUniformLocation, array: Int32Array): void;
  131131. /**
  131132. * Set the value of an uniform to an array of float32
  131133. * @param uniform defines the webGL uniform location where to store the value
  131134. * @param array defines the array of float32 to store
  131135. */
  131136. setFloatArray(uniform: WebGLUniformLocation, array: Float32Array): void;
  131137. /**
  131138. * Set the value of an uniform to an array of float32 (stored as vec2)
  131139. * @param uniform defines the webGL uniform location where to store the value
  131140. * @param array defines the array of float32 to store
  131141. */
  131142. setFloatArray2(uniform: WebGLUniformLocation, array: Float32Array): void;
  131143. /**
  131144. * Set the value of an uniform to an array of float32 (stored as vec3)
  131145. * @param uniform defines the webGL uniform location where to store the value
  131146. * @param array defines the array of float32 to store
  131147. */
  131148. setFloatArray3(uniform: WebGLUniformLocation, array: Float32Array): void;
  131149. /**
  131150. * Set the value of an uniform to an array of float32 (stored as vec4)
  131151. * @param uniform defines the webGL uniform location where to store the value
  131152. * @param array defines the array of float32 to store
  131153. */
  131154. setFloatArray4(uniform: WebGLUniformLocation, array: Float32Array): void;
  131155. /**
  131156. * Set the value of an uniform to an array of number
  131157. * @param uniform defines the webGL uniform location where to store the value
  131158. * @param array defines the array of number to store
  131159. */
  131160. setArray(uniform: WebGLUniformLocation, array: number[]): void;
  131161. /**
  131162. * Set the value of an uniform to an array of number (stored as vec2)
  131163. * @param uniform defines the webGL uniform location where to store the value
  131164. * @param array defines the array of number to store
  131165. */
  131166. setArray2(uniform: WebGLUniformLocation, array: number[]): void;
  131167. /**
  131168. * Set the value of an uniform to an array of number (stored as vec3)
  131169. * @param uniform defines the webGL uniform location where to store the value
  131170. * @param array defines the array of number to store
  131171. */
  131172. setArray3(uniform: WebGLUniformLocation, array: number[]): void;
  131173. /**
  131174. * Set the value of an uniform to an array of number (stored as vec4)
  131175. * @param uniform defines the webGL uniform location where to store the value
  131176. * @param array defines the array of number to store
  131177. */
  131178. setArray4(uniform: WebGLUniformLocation, array: number[]): void;
  131179. /**
  131180. * Set the value of an uniform to an array of float32 (stored as matrices)
  131181. * @param uniform defines the webGL uniform location where to store the value
  131182. * @param matrices defines the array of float32 to store
  131183. */
  131184. setMatrices(uniform: WebGLUniformLocation, matrices: Float32Array): void;
  131185. /**
  131186. * Set the value of an uniform to a matrix (3x3)
  131187. * @param uniform defines the webGL uniform location where to store the value
  131188. * @param matrix defines the Float32Array representing the 3x3 matrix to store
  131189. */
  131190. setMatrix3x3(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  131191. /**
  131192. * Set the value of an uniform to a matrix (2x2)
  131193. * @param uniform defines the webGL uniform location where to store the value
  131194. * @param matrix defines the Float32Array representing the 2x2 matrix to store
  131195. */
  131196. setMatrix2x2(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  131197. /**
  131198. * Set the value of an uniform to a number (float)
  131199. * @param uniform defines the webGL uniform location where to store the value
  131200. * @param value defines the float number to store
  131201. */
  131202. setFloat(uniform: WebGLUniformLocation, value: number): void;
  131203. /**
  131204. * Set the value of an uniform to a vec2
  131205. * @param uniform defines the webGL uniform location where to store the value
  131206. * @param x defines the 1st component of the value
  131207. * @param y defines the 2nd component of the value
  131208. */
  131209. setFloat2(uniform: WebGLUniformLocation, x: number, y: number): void;
  131210. /**
  131211. * Set the value of an uniform to a vec3
  131212. * @param uniform defines the webGL uniform location where to store the value
  131213. * @param x defines the 1st component of the value
  131214. * @param y defines the 2nd component of the value
  131215. * @param z defines the 3rd component of the value
  131216. */
  131217. setFloat3(uniform: WebGLUniformLocation, x: number, y: number, z: number): void;
  131218. /**
  131219. * Set the value of an uniform to a boolean
  131220. * @param uniform defines the webGL uniform location where to store the value
  131221. * @param bool defines the boolean to store
  131222. */
  131223. setBool(uniform: WebGLUniformLocation, bool: number): void;
  131224. /**
  131225. * Set the value of an uniform to a vec4
  131226. * @param uniform defines the webGL uniform location where to store the value
  131227. * @param x defines the 1st component of the value
  131228. * @param y defines the 2nd component of the value
  131229. * @param z defines the 3rd component of the value
  131230. * @param w defines the 4th component of the value
  131231. */
  131232. setFloat4(uniform: WebGLUniformLocation, x: number, y: number, z: number, w: number): void;
  131233. /**
  131234. * Sets the current alpha mode
  131235. * @param mode defines the mode to use (one of the Engine.ALPHA_XXX)
  131236. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  131237. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  131238. */
  131239. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  131240. /**
  131241. * Bind webGl buffers directly to the webGL context
  131242. * @param vertexBuffers defines the vertex buffer to bind
  131243. * @param indexBuffer defines the index buffer to bind
  131244. * @param vertexDeclaration defines the vertex declaration to use with the vertex buffer
  131245. * @param vertexStrideSize defines the vertex stride of the vertex buffer
  131246. * @param effect defines the effect associated with the vertex buffer
  131247. */
  131248. bindBuffers(vertexBuffers: {
  131249. [key: string]: VertexBuffer;
  131250. }, indexBuffer: DataBuffer, effect: Effect): void;
  131251. /**
  131252. * Force the entire cache to be cleared
  131253. * You should not have to use this function unless your engine needs to share the webGL context with another engine
  131254. * @param bruteForce defines a boolean to force clearing ALL caches (including stencil, detoh and alpha states)
  131255. */
  131256. wipeCaches(bruteForce?: boolean): void;
  131257. /**
  131258. * Send a draw order
  131259. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  131260. * @param indexStart defines the starting index
  131261. * @param indexCount defines the number of index to draw
  131262. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  131263. */
  131264. draw(useTriangles: boolean, indexStart: number, indexCount: number, instancesCount?: number): void;
  131265. /**
  131266. * Draw a list of indexed primitives
  131267. * @param fillMode defines the primitive to use
  131268. * @param indexStart defines the starting index
  131269. * @param indexCount defines the number of index to draw
  131270. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  131271. */
  131272. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  131273. /**
  131274. * Draw a list of unindexed primitives
  131275. * @param fillMode defines the primitive to use
  131276. * @param verticesStart defines the index of first vertex to draw
  131277. * @param verticesCount defines the count of vertices to draw
  131278. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  131279. */
  131280. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  131281. /** @hidden */
  131282. _createTexture(): WebGLTexture;
  131283. /** @hidden */
  131284. _releaseTexture(texture: InternalTexture): void;
  131285. /**
  131286. * Usually called from Texture.ts.
  131287. * Passed information to create a WebGLTexture
  131288. * @param urlArg defines a value which contains one of the following:
  131289. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  131290. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  131291. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  131292. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  131293. * @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)
  131294. * @param scene needed for loading to the correct scene
  131295. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  131296. * @param onLoad optional callback to be called upon successful completion
  131297. * @param onError optional callback to be called upon failure
  131298. * @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
  131299. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  131300. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  131301. * @param forcedExtension defines the extension to use to pick the right loader
  131302. * @param mimeType defines an optional mime type
  131303. * @returns a InternalTexture for assignment back into BABYLON.Texture
  131304. */
  131305. 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;
  131306. /**
  131307. * Creates a new render target texture
  131308. * @param size defines the size of the texture
  131309. * @param options defines the options used to create the texture
  131310. * @returns a new render target texture stored in an InternalTexture
  131311. */
  131312. createRenderTargetTexture(size: any, options: boolean | RenderTargetCreationOptions): InternalTexture;
  131313. /**
  131314. * Update the sampling mode of a given texture
  131315. * @param samplingMode defines the required sampling mode
  131316. * @param texture defines the texture to update
  131317. */
  131318. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  131319. /**
  131320. * Binds the frame buffer to the specified texture.
  131321. * @param texture The texture to render to or null for the default canvas
  131322. * @param faceIndex The face of the texture to render to in case of cube texture
  131323. * @param requiredWidth The width of the target to render to
  131324. * @param requiredHeight The height of the target to render to
  131325. * @param forceFullscreenViewport Forces the viewport to be the entire texture/screen if true
  131326. * @param lodLevel defines le lod level to bind to the frame buffer
  131327. */
  131328. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean): void;
  131329. /**
  131330. * Unbind the current render target texture from the webGL context
  131331. * @param texture defines the render target texture to unbind
  131332. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  131333. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  131334. */
  131335. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  131336. /**
  131337. * Creates a dynamic vertex buffer
  131338. * @param vertices the data for the dynamic vertex buffer
  131339. * @returns the new WebGL dynamic buffer
  131340. */
  131341. createDynamicVertexBuffer(vertices: FloatArray): DataBuffer;
  131342. /**
  131343. * Update the content of a dynamic texture
  131344. * @param texture defines the texture to update
  131345. * @param canvas defines the canvas containing the source
  131346. * @param invertY defines if data must be stored with Y axis inverted
  131347. * @param premulAlpha defines if alpha is stored as premultiplied
  131348. * @param format defines the format of the data
  131349. * @param forceBindTexture if the texture should be forced to be bound eg. after a graphics context loss (Default: false)
  131350. */
  131351. updateDynamicTexture(texture: Nullable<InternalTexture>, canvas: HTMLCanvasElement, invertY: boolean, premulAlpha?: boolean, format?: number): void;
  131352. /**
  131353. * Gets a boolean indicating if all created effects are ready
  131354. * @returns true if all effects are ready
  131355. */
  131356. areAllEffectsReady(): boolean;
  131357. /**
  131358. * @hidden
  131359. * Get the current error code of the webGL context
  131360. * @returns the error code
  131361. * @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getError
  131362. */
  131363. getError(): number;
  131364. /** @hidden */
  131365. _getUnpackAlignement(): number;
  131366. /** @hidden */
  131367. _unpackFlipY(value: boolean): void;
  131368. /**
  131369. * Update a dynamic index buffer
  131370. * @param indexBuffer defines the target index buffer
  131371. * @param indices defines the data to update
  131372. * @param offset defines the offset in the target index buffer where update should start
  131373. */
  131374. updateDynamicIndexBuffer(indexBuffer: WebGLBuffer, indices: IndicesArray, offset?: number): void;
  131375. /**
  131376. * Updates a dynamic vertex buffer.
  131377. * @param vertexBuffer the vertex buffer to update
  131378. * @param vertices the data used to update the vertex buffer
  131379. * @param byteOffset the byte offset of the data (optional)
  131380. * @param byteLength the byte length of the data (optional)
  131381. */
  131382. updateDynamicVertexBuffer(vertexBuffer: WebGLBuffer, vertices: FloatArray, byteOffset?: number, byteLength?: number): void;
  131383. /** @hidden */
  131384. _bindTextureDirectly(target: number, texture: InternalTexture): boolean;
  131385. /** @hidden */
  131386. _bindTexture(channel: number, texture: InternalTexture): void;
  131387. protected _deleteBuffer(buffer: WebGLBuffer): void;
  131388. /**
  131389. * 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
  131390. */
  131391. releaseEffects(): void;
  131392. displayLoadingUI(): void;
  131393. hideLoadingUI(): void;
  131394. /** @hidden */
  131395. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  131396. /** @hidden */
  131397. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  131398. /** @hidden */
  131399. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  131400. /** @hidden */
  131401. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement, faceIndex?: number, lod?: number): void;
  131402. }
  131403. }
  131404. declare module BABYLON {
  131405. /**
  131406. * @hidden
  131407. **/
  131408. export class _TimeToken {
  131409. _startTimeQuery: Nullable<WebGLQuery>;
  131410. _endTimeQuery: Nullable<WebGLQuery>;
  131411. _timeElapsedQuery: Nullable<WebGLQuery>;
  131412. _timeElapsedQueryEnded: boolean;
  131413. }
  131414. }
  131415. declare module BABYLON {
  131416. /** @hidden */
  131417. export class _OcclusionDataStorage {
  131418. /** @hidden */
  131419. occlusionInternalRetryCounter: number;
  131420. /** @hidden */
  131421. isOcclusionQueryInProgress: boolean;
  131422. /** @hidden */
  131423. isOccluded: boolean;
  131424. /** @hidden */
  131425. occlusionRetryCount: number;
  131426. /** @hidden */
  131427. occlusionType: number;
  131428. /** @hidden */
  131429. occlusionQueryAlgorithmType: number;
  131430. }
  131431. interface Engine {
  131432. /**
  131433. * Create a new webGL query (you must be sure that queries are supported by checking getCaps() function)
  131434. * @return the new query
  131435. */
  131436. createQuery(): WebGLQuery;
  131437. /**
  131438. * Delete and release a webGL query
  131439. * @param query defines the query to delete
  131440. * @return the current engine
  131441. */
  131442. deleteQuery(query: WebGLQuery): Engine;
  131443. /**
  131444. * Check if a given query has resolved and got its value
  131445. * @param query defines the query to check
  131446. * @returns true if the query got its value
  131447. */
  131448. isQueryResultAvailable(query: WebGLQuery): boolean;
  131449. /**
  131450. * Gets the value of a given query
  131451. * @param query defines the query to check
  131452. * @returns the value of the query
  131453. */
  131454. getQueryResult(query: WebGLQuery): number;
  131455. /**
  131456. * Initiates an occlusion query
  131457. * @param algorithmType defines the algorithm to use
  131458. * @param query defines the query to use
  131459. * @returns the current engine
  131460. * @see https://doc.babylonjs.com/features/occlusionquery
  131461. */
  131462. beginOcclusionQuery(algorithmType: number, query: WebGLQuery): Engine;
  131463. /**
  131464. * Ends an occlusion query
  131465. * @see https://doc.babylonjs.com/features/occlusionquery
  131466. * @param algorithmType defines the algorithm to use
  131467. * @returns the current engine
  131468. */
  131469. endOcclusionQuery(algorithmType: number): Engine;
  131470. /**
  131471. * Starts a time query (used to measure time spent by the GPU on a specific frame)
  131472. * Please note that only one query can be issued at a time
  131473. * @returns a time token used to track the time span
  131474. */
  131475. startTimeQuery(): Nullable<_TimeToken>;
  131476. /**
  131477. * Ends a time query
  131478. * @param token defines the token used to measure the time span
  131479. * @returns the time spent (in ns)
  131480. */
  131481. endTimeQuery(token: _TimeToken): int;
  131482. /** @hidden */
  131483. _currentNonTimestampToken: Nullable<_TimeToken>;
  131484. /** @hidden */
  131485. _createTimeQuery(): WebGLQuery;
  131486. /** @hidden */
  131487. _deleteTimeQuery(query: WebGLQuery): void;
  131488. /** @hidden */
  131489. _getGlAlgorithmType(algorithmType: number): number;
  131490. /** @hidden */
  131491. _getTimeQueryResult(query: WebGLQuery): any;
  131492. /** @hidden */
  131493. _getTimeQueryAvailability(query: WebGLQuery): any;
  131494. }
  131495. interface AbstractMesh {
  131496. /**
  131497. * Backing filed
  131498. * @hidden
  131499. */
  131500. __occlusionDataStorage: _OcclusionDataStorage;
  131501. /**
  131502. * Access property
  131503. * @hidden
  131504. */
  131505. _occlusionDataStorage: _OcclusionDataStorage;
  131506. /**
  131507. * 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.
  131508. * The default value is -1 which means don't break the query and wait till the result
  131509. * @see https://doc.babylonjs.com/features/occlusionquery
  131510. */
  131511. occlusionRetryCount: number;
  131512. /**
  131513. * 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:
  131514. * * OCCLUSION_TYPE_NONE (Default Value): this option means no occlusion query whith the Mesh.
  131515. * * OCCLUSION_TYPE_OPTIMISTIC: this option is means use occlusion query and if occlusionRetryCount is reached and the query is broken show the mesh.
  131516. * * 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.
  131517. * @see https://doc.babylonjs.com/features/occlusionquery
  131518. */
  131519. occlusionType: number;
  131520. /**
  131521. * This property determines the type of occlusion query algorithm to run in WebGl, you can use:
  131522. * * AbstractMesh.OCCLUSION_ALGORITHM_TYPE_ACCURATE which is mapped to GL_ANY_SAMPLES_PASSED.
  131523. * * 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.
  131524. * @see https://doc.babylonjs.com/features/occlusionquery
  131525. */
  131526. occlusionQueryAlgorithmType: number;
  131527. /**
  131528. * 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
  131529. * @see https://doc.babylonjs.com/features/occlusionquery
  131530. */
  131531. isOccluded: boolean;
  131532. /**
  131533. * Flag to check the progress status of the query
  131534. * @see https://doc.babylonjs.com/features/occlusionquery
  131535. */
  131536. isOcclusionQueryInProgress: boolean;
  131537. }
  131538. }
  131539. declare module BABYLON {
  131540. /** @hidden */
  131541. export var _forceTransformFeedbackToBundle: boolean;
  131542. interface Engine {
  131543. /**
  131544. * Creates a webGL transform feedback object
  131545. * Please makes sure to check webGLVersion property to check if you are running webGL 2+
  131546. * @returns the webGL transform feedback object
  131547. */
  131548. createTransformFeedback(): WebGLTransformFeedback;
  131549. /**
  131550. * Delete a webGL transform feedback object
  131551. * @param value defines the webGL transform feedback object to delete
  131552. */
  131553. deleteTransformFeedback(value: WebGLTransformFeedback): void;
  131554. /**
  131555. * Bind a webGL transform feedback object to the webgl context
  131556. * @param value defines the webGL transform feedback object to bind
  131557. */
  131558. bindTransformFeedback(value: Nullable<WebGLTransformFeedback>): void;
  131559. /**
  131560. * Begins a transform feedback operation
  131561. * @param usePoints defines if points or triangles must be used
  131562. */
  131563. beginTransformFeedback(usePoints: boolean): void;
  131564. /**
  131565. * Ends a transform feedback operation
  131566. */
  131567. endTransformFeedback(): void;
  131568. /**
  131569. * Specify the varyings to use with transform feedback
  131570. * @param program defines the associated webGL program
  131571. * @param value defines the list of strings representing the varying names
  131572. */
  131573. setTranformFeedbackVaryings(program: WebGLProgram, value: string[]): void;
  131574. /**
  131575. * Bind a webGL buffer for a transform feedback operation
  131576. * @param value defines the webGL buffer to bind
  131577. */
  131578. bindTransformFeedbackBuffer(value: Nullable<DataBuffer>): void;
  131579. }
  131580. }
  131581. declare module BABYLON {
  131582. /**
  131583. * Class used to define an additional view for the engine
  131584. * @see https://doc.babylonjs.com/how_to/multi_canvases
  131585. */
  131586. export class EngineView {
  131587. /** Defines the canvas where to render the view */
  131588. target: HTMLCanvasElement;
  131589. /** Defines an optional camera used to render the view (will use active camera else) */
  131590. camera?: Camera;
  131591. }
  131592. interface Engine {
  131593. /**
  131594. * Gets or sets the HTML element to use for attaching events
  131595. */
  131596. inputElement: Nullable<HTMLElement>;
  131597. /**
  131598. * Gets the current engine view
  131599. * @see https://doc.babylonjs.com/how_to/multi_canvases
  131600. */
  131601. activeView: Nullable<EngineView>;
  131602. /** Gets or sets the list of views */
  131603. views: EngineView[];
  131604. /**
  131605. * Register a new child canvas
  131606. * @param canvas defines the canvas to register
  131607. * @param camera defines an optional camera to use with this canvas (it will overwrite the scene.camera for this view)
  131608. * @returns the associated view
  131609. */
  131610. registerView(canvas: HTMLCanvasElement, camera?: Camera): EngineView;
  131611. /**
  131612. * Remove a registered child canvas
  131613. * @param canvas defines the canvas to remove
  131614. * @returns the current engine
  131615. */
  131616. unRegisterView(canvas: HTMLCanvasElement): Engine;
  131617. }
  131618. }
  131619. declare module BABYLON {
  131620. interface Engine {
  131621. /** @hidden */
  131622. _excludedCompressedTextures: string[];
  131623. /** @hidden */
  131624. _textureFormatInUse: string;
  131625. /**
  131626. * Gets the list of texture formats supported
  131627. */
  131628. readonly texturesSupported: Array<string>;
  131629. /**
  131630. * Gets the texture format in use
  131631. */
  131632. readonly textureFormatInUse: Nullable<string>;
  131633. /**
  131634. * Set the compressed texture extensions or file names to skip.
  131635. *
  131636. * @param skippedFiles defines the list of those texture files you want to skip
  131637. * Example: [".dds", ".env", "myfile.png"]
  131638. */
  131639. setCompressedTextureExclusions(skippedFiles: Array<string>): void;
  131640. /**
  131641. * Set the compressed texture format to use, based on the formats you have, and the formats
  131642. * supported by the hardware / browser.
  131643. *
  131644. * Khronos Texture Container (.ktx) files are used to support this. This format has the
  131645. * advantage of being specifically designed for OpenGL. Header elements directly correspond
  131646. * to API arguments needed to compressed textures. This puts the burden on the container
  131647. * generator to house the arcane code for determining these for current & future formats.
  131648. *
  131649. * for description see https://www.khronos.org/opengles/sdk/tools/KTX/
  131650. * for file layout see https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/
  131651. *
  131652. * Note: The result of this call is not taken into account when a texture is base64.
  131653. *
  131654. * @param formatsAvailable defines the list of those format families you have created
  131655. * on your server. Syntax: '-' + format family + '.ktx'. (Case and order do not matter.)
  131656. *
  131657. * Current families are astc, dxt, pvrtc, etc2, & etc1.
  131658. * @returns The extension selected.
  131659. */
  131660. setTextureFormatToUse(formatsAvailable: Array<string>): Nullable<string>;
  131661. }
  131662. }
  131663. declare module BABYLON {
  131664. /**
  131665. * CubeMap information grouping all the data for each faces as well as the cubemap size.
  131666. */
  131667. export interface CubeMapInfo {
  131668. /**
  131669. * The pixel array for the front face.
  131670. * This is stored in format, left to right, up to down format.
  131671. */
  131672. front: Nullable<ArrayBufferView>;
  131673. /**
  131674. * The pixel array for the back face.
  131675. * This is stored in format, left to right, up to down format.
  131676. */
  131677. back: Nullable<ArrayBufferView>;
  131678. /**
  131679. * The pixel array for the left face.
  131680. * This is stored in format, left to right, up to down format.
  131681. */
  131682. left: Nullable<ArrayBufferView>;
  131683. /**
  131684. * The pixel array for the right face.
  131685. * This is stored in format, left to right, up to down format.
  131686. */
  131687. right: Nullable<ArrayBufferView>;
  131688. /**
  131689. * The pixel array for the up face.
  131690. * This is stored in format, left to right, up to down format.
  131691. */
  131692. up: Nullable<ArrayBufferView>;
  131693. /**
  131694. * The pixel array for the down face.
  131695. * This is stored in format, left to right, up to down format.
  131696. */
  131697. down: Nullable<ArrayBufferView>;
  131698. /**
  131699. * The size of the cubemap stored.
  131700. *
  131701. * Each faces will be size * size pixels.
  131702. */
  131703. size: number;
  131704. /**
  131705. * The format of the texture.
  131706. *
  131707. * RGBA, RGB.
  131708. */
  131709. format: number;
  131710. /**
  131711. * The type of the texture data.
  131712. *
  131713. * UNSIGNED_INT, FLOAT.
  131714. */
  131715. type: number;
  131716. /**
  131717. * Specifies whether the texture is in gamma space.
  131718. */
  131719. gammaSpace: boolean;
  131720. }
  131721. /**
  131722. * Helper class useful to convert panorama picture to their cubemap representation in 6 faces.
  131723. */
  131724. export class PanoramaToCubeMapTools {
  131725. private static FACE_LEFT;
  131726. private static FACE_RIGHT;
  131727. private static FACE_FRONT;
  131728. private static FACE_BACK;
  131729. private static FACE_DOWN;
  131730. private static FACE_UP;
  131731. /**
  131732. * Converts a panorma stored in RGB right to left up to down format into a cubemap (6 faces).
  131733. *
  131734. * @param float32Array The source data.
  131735. * @param inputWidth The width of the input panorama.
  131736. * @param inputHeight The height of the input panorama.
  131737. * @param size The willing size of the generated cubemap (each faces will be size * size pixels)
  131738. * @return The cubemap data
  131739. */
  131740. static ConvertPanoramaToCubemap(float32Array: Float32Array, inputWidth: number, inputHeight: number, size: number): CubeMapInfo;
  131741. private static CreateCubemapTexture;
  131742. private static CalcProjectionSpherical;
  131743. }
  131744. }
  131745. declare module BABYLON {
  131746. /**
  131747. * Helper class dealing with the extraction of spherical polynomial dataArray
  131748. * from a cube map.
  131749. */
  131750. export class CubeMapToSphericalPolynomialTools {
  131751. private static FileFaces;
  131752. /**
  131753. * Converts a texture to the according Spherical Polynomial data.
  131754. * This extracts the first 3 orders only as they are the only one used in the lighting.
  131755. *
  131756. * @param texture The texture to extract the information from.
  131757. * @return The Spherical Polynomial data.
  131758. */
  131759. static ConvertCubeMapTextureToSphericalPolynomial(texture: BaseTexture): Nullable<SphericalPolynomial>;
  131760. /**
  131761. * Converts a cubemap to the according Spherical Polynomial data.
  131762. * This extracts the first 3 orders only as they are the only one used in the lighting.
  131763. *
  131764. * @param cubeInfo The Cube map to extract the information from.
  131765. * @return The Spherical Polynomial data.
  131766. */
  131767. static ConvertCubeMapToSphericalPolynomial(cubeInfo: CubeMapInfo): SphericalPolynomial;
  131768. }
  131769. }
  131770. declare module BABYLON {
  131771. interface BaseTexture {
  131772. /**
  131773. * Get the polynomial representation of the texture data.
  131774. * This is mainly use as a fast way to recover IBL Diffuse irradiance data.
  131775. * @see https://learnopengl.com/PBR/IBL/Diffuse-irradiance
  131776. */
  131777. sphericalPolynomial: Nullable<SphericalPolynomial>;
  131778. }
  131779. }
  131780. declare module BABYLON {
  131781. /** @hidden */
  131782. export var rgbdEncodePixelShader: {
  131783. name: string;
  131784. shader: string;
  131785. };
  131786. }
  131787. declare module BABYLON {
  131788. /** @hidden */
  131789. export var rgbdDecodePixelShader: {
  131790. name: string;
  131791. shader: string;
  131792. };
  131793. }
  131794. declare module BABYLON {
  131795. /**
  131796. * Raw texture data and descriptor sufficient for WebGL texture upload
  131797. */
  131798. export interface EnvironmentTextureInfo {
  131799. /**
  131800. * Version of the environment map
  131801. */
  131802. version: number;
  131803. /**
  131804. * Width of image
  131805. */
  131806. width: number;
  131807. /**
  131808. * Irradiance information stored in the file.
  131809. */
  131810. irradiance: any;
  131811. /**
  131812. * Specular information stored in the file.
  131813. */
  131814. specular: any;
  131815. }
  131816. /**
  131817. * Defines One Image in the file. It requires only the position in the file
  131818. * as well as the length.
  131819. */
  131820. interface BufferImageData {
  131821. /**
  131822. * Length of the image data.
  131823. */
  131824. length: number;
  131825. /**
  131826. * Position of the data from the null terminator delimiting the end of the JSON.
  131827. */
  131828. position: number;
  131829. }
  131830. /**
  131831. * Defines the specular data enclosed in the file.
  131832. * This corresponds to the version 1 of the data.
  131833. */
  131834. export interface EnvironmentTextureSpecularInfoV1 {
  131835. /**
  131836. * Defines where the specular Payload is located. It is a runtime value only not stored in the file.
  131837. */
  131838. specularDataPosition?: number;
  131839. /**
  131840. * This contains all the images data needed to reconstruct the cubemap.
  131841. */
  131842. mipmaps: Array<BufferImageData>;
  131843. /**
  131844. * Defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness.
  131845. */
  131846. lodGenerationScale: number;
  131847. }
  131848. /**
  131849. * Sets of helpers addressing the serialization and deserialization of environment texture
  131850. * stored in a BabylonJS env file.
  131851. * Those files are usually stored as .env files.
  131852. */
  131853. export class EnvironmentTextureTools {
  131854. /**
  131855. * Magic number identifying the env file.
  131856. */
  131857. private static _MagicBytes;
  131858. /**
  131859. * Gets the environment info from an env file.
  131860. * @param data The array buffer containing the .env bytes.
  131861. * @returns the environment file info (the json header) if successfully parsed.
  131862. */
  131863. static GetEnvInfo(data: ArrayBufferView): Nullable<EnvironmentTextureInfo>;
  131864. /**
  131865. * Creates an environment texture from a loaded cube texture.
  131866. * @param texture defines the cube texture to convert in env file
  131867. * @return a promise containing the environment data if succesfull.
  131868. */
  131869. static CreateEnvTextureAsync(texture: BaseTexture): Promise<ArrayBuffer>;
  131870. /**
  131871. * Creates a JSON representation of the spherical data.
  131872. * @param texture defines the texture containing the polynomials
  131873. * @return the JSON representation of the spherical info
  131874. */
  131875. private static _CreateEnvTextureIrradiance;
  131876. /**
  131877. * Creates the ArrayBufferViews used for initializing environment texture image data.
  131878. * @param data the image data
  131879. * @param info parameters that determine what views will be created for accessing the underlying buffer
  131880. * @return the views described by info providing access to the underlying buffer
  131881. */
  131882. static CreateImageDataArrayBufferViews(data: ArrayBufferView, info: EnvironmentTextureInfo): Array<Array<ArrayBufferView>>;
  131883. /**
  131884. * Uploads the texture info contained in the env file to the GPU.
  131885. * @param texture defines the internal texture to upload to
  131886. * @param data defines the data to load
  131887. * @param info defines the texture info retrieved through the GetEnvInfo method
  131888. * @returns a promise
  131889. */
  131890. static UploadEnvLevelsAsync(texture: InternalTexture, data: ArrayBufferView, info: EnvironmentTextureInfo): Promise<void>;
  131891. private static _OnImageReadyAsync;
  131892. /**
  131893. * Uploads the levels of image data to the GPU.
  131894. * @param texture defines the internal texture to upload to
  131895. * @param imageData defines the array buffer views of image data [mipmap][face]
  131896. * @returns a promise
  131897. */
  131898. static UploadLevelsAsync(texture: InternalTexture, imageData: ArrayBufferView[][]): Promise<void>;
  131899. /**
  131900. * Uploads spherical polynomials information to the texture.
  131901. * @param texture defines the texture we are trying to upload the information to
  131902. * @param info defines the environment texture info retrieved through the GetEnvInfo method
  131903. */
  131904. static UploadEnvSpherical(texture: InternalTexture, info: EnvironmentTextureInfo): void;
  131905. /** @hidden */
  131906. static _UpdateRGBDAsync(internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number): Promise<void>;
  131907. }
  131908. }
  131909. declare module BABYLON {
  131910. /**
  131911. * Class used to inline functions in shader code
  131912. */
  131913. export class ShaderCodeInliner {
  131914. private static readonly _RegexpFindFunctionNameAndType;
  131915. private _sourceCode;
  131916. private _functionDescr;
  131917. private _numMaxIterations;
  131918. /** Gets or sets the token used to mark the functions to inline */
  131919. inlineToken: string;
  131920. /** Gets or sets the debug mode */
  131921. debug: boolean;
  131922. /** Gets the code after the inlining process */
  131923. get code(): string;
  131924. /**
  131925. * Initializes the inliner
  131926. * @param sourceCode shader code source to inline
  131927. * @param numMaxIterations maximum number of iterations (used to detect recursive calls)
  131928. */
  131929. constructor(sourceCode: string, numMaxIterations?: number);
  131930. /**
  131931. * Start the processing of the shader code
  131932. */
  131933. processCode(): void;
  131934. private _collectFunctions;
  131935. private _processInlining;
  131936. private _extractBetweenMarkers;
  131937. private _skipWhitespaces;
  131938. private _removeComments;
  131939. private _replaceFunctionCallsByCode;
  131940. private _findBackward;
  131941. private _escapeRegExp;
  131942. private _replaceNames;
  131943. }
  131944. }
  131945. declare module BABYLON {
  131946. /**
  131947. * Container for accessors for natively-stored mesh data buffers.
  131948. */
  131949. class NativeDataBuffer extends DataBuffer {
  131950. /**
  131951. * Accessor value used to identify/retrieve a natively-stored index buffer.
  131952. */
  131953. nativeIndexBuffer?: any;
  131954. /**
  131955. * Accessor value used to identify/retrieve a natively-stored vertex buffer.
  131956. */
  131957. nativeVertexBuffer?: any;
  131958. }
  131959. /** @hidden */
  131960. class NativeTexture extends InternalTexture {
  131961. getInternalTexture(): InternalTexture;
  131962. getViewCount(): number;
  131963. }
  131964. /** @hidden */
  131965. export class NativeEngine extends Engine {
  131966. private readonly _native;
  131967. /** Defines the invalid handle returned by bgfx when resource creation goes wrong */
  131968. private readonly INVALID_HANDLE;
  131969. private _boundBuffersVertexArray;
  131970. getHardwareScalingLevel(): number;
  131971. constructor();
  131972. dispose(): void;
  131973. /**
  131974. * Can be used to override the current requestAnimationFrame requester.
  131975. * @hidden
  131976. */
  131977. protected _queueNewFrame(bindedRenderFunction: any, requester?: any): number;
  131978. /**
  131979. * Override default engine behavior.
  131980. * @param color
  131981. * @param backBuffer
  131982. * @param depth
  131983. * @param stencil
  131984. */
  131985. _bindUnboundFramebuffer(framebuffer: Nullable<WebGLFramebuffer>): void;
  131986. /**
  131987. * Gets host document
  131988. * @returns the host document object
  131989. */
  131990. getHostDocument(): Nullable<Document>;
  131991. clear(color: Nullable<IColor4Like>, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  131992. createIndexBuffer(indices: IndicesArray, updateable?: boolean): NativeDataBuffer;
  131993. createVertexBuffer(data: DataArray, updateable?: boolean): NativeDataBuffer;
  131994. protected _recordVertexArrayObject(vertexArray: any, vertexBuffers: {
  131995. [key: string]: VertexBuffer;
  131996. }, indexBuffer: Nullable<NativeDataBuffer>, effect: Effect): void;
  131997. bindBuffers(vertexBuffers: {
  131998. [key: string]: VertexBuffer;
  131999. }, indexBuffer: Nullable<NativeDataBuffer>, effect: Effect): void;
  132000. recordVertexArrayObject(vertexBuffers: {
  132001. [key: string]: VertexBuffer;
  132002. }, indexBuffer: Nullable<NativeDataBuffer>, effect: Effect): WebGLVertexArrayObject;
  132003. bindVertexArrayObject(vertexArray: WebGLVertexArrayObject): void;
  132004. releaseVertexArrayObject(vertexArray: WebGLVertexArrayObject): void;
  132005. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  132006. /**
  132007. * Draw a list of indexed primitives
  132008. * @param fillMode defines the primitive to use
  132009. * @param indexStart defines the starting index
  132010. * @param indexCount defines the number of index to draw
  132011. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  132012. */
  132013. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  132014. /**
  132015. * Draw a list of unindexed primitives
  132016. * @param fillMode defines the primitive to use
  132017. * @param verticesStart defines the index of first vertex to draw
  132018. * @param verticesCount defines the count of vertices to draw
  132019. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  132020. */
  132021. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  132022. createPipelineContext(): IPipelineContext;
  132023. _preparePipelineContext(pipelineContext: IPipelineContext, vertexSourceCode: string, fragmentSourceCode: string, createAsRaw: boolean, rebuildRebind: any, defines: Nullable<string>, transformFeedbackVaryings: Nullable<string[]>): void;
  132024. /** @hidden */
  132025. _isRenderingStateCompiled(pipelineContext: IPipelineContext): boolean;
  132026. /** @hidden */
  132027. _executeWhenRenderingStateIsCompiled(pipelineContext: IPipelineContext, action: () => void): void;
  132028. createRawShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): any;
  132029. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): any;
  132030. protected _setProgram(program: WebGLProgram): void;
  132031. _releaseEffect(effect: Effect): void;
  132032. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  132033. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): WebGLUniformLocation[];
  132034. bindUniformBlock(pipelineContext: IPipelineContext, blockName: string, index: number): void;
  132035. bindSamplers(effect: Effect): void;
  132036. setMatrix(uniform: WebGLUniformLocation, matrix: Matrix): void;
  132037. getRenderWidth(useScreen?: boolean): number;
  132038. getRenderHeight(useScreen?: boolean): number;
  132039. setViewport(viewport: Viewport, requiredWidth?: number, requiredHeight?: number): void;
  132040. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  132041. /**
  132042. * Set the z offset to apply to current rendering
  132043. * @param value defines the offset to apply
  132044. */
  132045. setZOffset(value: number): void;
  132046. /**
  132047. * Gets the current value of the zOffset
  132048. * @returns the current zOffset state
  132049. */
  132050. getZOffset(): number;
  132051. /**
  132052. * Enable or disable depth buffering
  132053. * @param enable defines the state to set
  132054. */
  132055. setDepthBuffer(enable: boolean): void;
  132056. /**
  132057. * Gets a boolean indicating if depth writing is enabled
  132058. * @returns the current depth writing state
  132059. */
  132060. getDepthWrite(): boolean;
  132061. /**
  132062. * Enable or disable depth writing
  132063. * @param enable defines the state to set
  132064. */
  132065. setDepthWrite(enable: boolean): void;
  132066. /**
  132067. * Enable or disable color writing
  132068. * @param enable defines the state to set
  132069. */
  132070. setColorWrite(enable: boolean): void;
  132071. /**
  132072. * Gets a boolean indicating if color writing is enabled
  132073. * @returns the current color writing state
  132074. */
  132075. getColorWrite(): boolean;
  132076. /**
  132077. * Sets alpha constants used by some alpha blending modes
  132078. * @param r defines the red component
  132079. * @param g defines the green component
  132080. * @param b defines the blue component
  132081. * @param a defines the alpha component
  132082. */
  132083. setAlphaConstants(r: number, g: number, b: number, a: number): void;
  132084. /**
  132085. * Sets the current alpha mode
  132086. * @param mode defines the mode to use (one of the BABYLON.Constants.ALPHA_XXX)
  132087. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  132088. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  132089. */
  132090. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  132091. /**
  132092. * Gets the current alpha mode
  132093. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  132094. * @returns the current alpha mode
  132095. */
  132096. getAlphaMode(): number;
  132097. setInt(uniform: WebGLUniformLocation, int: number): void;
  132098. setIntArray(uniform: WebGLUniformLocation, array: Int32Array): void;
  132099. setIntArray2(uniform: WebGLUniformLocation, array: Int32Array): void;
  132100. setIntArray3(uniform: WebGLUniformLocation, array: Int32Array): void;
  132101. setIntArray4(uniform: WebGLUniformLocation, array: Int32Array): void;
  132102. setFloatArray(uniform: WebGLUniformLocation, array: Float32Array): void;
  132103. setFloatArray2(uniform: WebGLUniformLocation, array: Float32Array): void;
  132104. setFloatArray3(uniform: WebGLUniformLocation, array: Float32Array): void;
  132105. setFloatArray4(uniform: WebGLUniformLocation, array: Float32Array): void;
  132106. setArray(uniform: WebGLUniformLocation, array: number[]): void;
  132107. setArray2(uniform: WebGLUniformLocation, array: number[]): void;
  132108. setArray3(uniform: WebGLUniformLocation, array: number[]): void;
  132109. setArray4(uniform: WebGLUniformLocation, array: number[]): void;
  132110. setMatrices(uniform: WebGLUniformLocation, matrices: Float32Array): void;
  132111. setMatrix3x3(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  132112. setMatrix2x2(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  132113. setFloat(uniform: WebGLUniformLocation, value: number): void;
  132114. setFloat2(uniform: WebGLUniformLocation, x: number, y: number): void;
  132115. setFloat3(uniform: WebGLUniformLocation, x: number, y: number, z: number): void;
  132116. setFloat4(uniform: WebGLUniformLocation, x: number, y: number, z: number, w: number): void;
  132117. setColor3(uniform: WebGLUniformLocation, color3: Color3): void;
  132118. setColor4(uniform: WebGLUniformLocation, color3: Color3, alpha: number): void;
  132119. wipeCaches(bruteForce?: boolean): void;
  132120. _createTexture(): WebGLTexture;
  132121. protected _deleteTexture(texture: Nullable<WebGLTexture>): void;
  132122. /**
  132123. * Usually called from Texture.ts.
  132124. * Passed information to create a WebGLTexture
  132125. * @param url defines a value which contains one of the following:
  132126. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  132127. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  132128. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  132129. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  132130. * @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)
  132131. * @param scene needed for loading to the correct scene
  132132. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  132133. * @param onLoad optional callback to be called upon successful completion
  132134. * @param onError optional callback to be called upon failure
  132135. * @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
  132136. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  132137. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  132138. * @param forcedExtension defines the extension to use to pick the right loader
  132139. * @param mimeType defines an optional mime type
  132140. * @returns a InternalTexture for assignment back into BABYLON.Texture
  132141. */
  132142. 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;
  132143. /**
  132144. * Creates a cube texture
  132145. * @param rootUrl defines the url where the files to load is located
  132146. * @param scene defines the current scene
  132147. * @param files defines the list of files to load (1 per face)
  132148. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  132149. * @param onLoad defines an optional callback raised when the texture is loaded
  132150. * @param onError defines an optional callback raised if there is an issue to load the texture
  132151. * @param format defines the format of the data
  132152. * @param forcedExtension defines the extension to use to pick the right loader
  132153. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  132154. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  132155. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  132156. * @param fallback defines texture to use while falling back when (compressed) texture file not found.
  132157. * @returns the cube texture as an InternalTexture
  132158. */
  132159. 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;
  132160. private _getSamplingFilter;
  132161. private static _GetNativeTextureFormat;
  132162. createRenderTargetTexture(size: number | {
  132163. width: number;
  132164. height: number;
  132165. }, options: boolean | RenderTargetCreationOptions): NativeTexture;
  132166. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  132167. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean): void;
  132168. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  132169. createDynamicVertexBuffer(data: DataArray): DataBuffer;
  132170. updateDynamicIndexBuffer(indexBuffer: DataBuffer, indices: IndicesArray, offset?: number): void;
  132171. /**
  132172. * Updates a dynamic vertex buffer.
  132173. * @param vertexBuffer the vertex buffer to update
  132174. * @param data the data used to update the vertex buffer
  132175. * @param byteOffset the byte offset of the data (optional)
  132176. * @param byteLength the byte length of the data (optional)
  132177. */
  132178. updateDynamicVertexBuffer(vertexBuffer: DataBuffer, data: DataArray, byteOffset?: number, byteLength?: number): void;
  132179. protected _setTexture(channel: number, texture: Nullable<BaseTexture>, isPartOfTextureArray?: boolean, depthStencilTexture?: boolean): boolean;
  132180. private _updateAnisotropicLevel;
  132181. private _getAddressMode;
  132182. /** @hidden */
  132183. _bindTexture(channel: number, texture: InternalTexture): void;
  132184. protected _deleteBuffer(buffer: NativeDataBuffer): void;
  132185. releaseEffects(): void;
  132186. /** @hidden */
  132187. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  132188. /** @hidden */
  132189. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  132190. /** @hidden */
  132191. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  132192. /** @hidden */
  132193. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement, faceIndex?: number, lod?: number): void;
  132194. }
  132195. }
  132196. declare module BABYLON {
  132197. /**
  132198. * Gather the list of clipboard event types as constants.
  132199. */
  132200. export class ClipboardEventTypes {
  132201. /**
  132202. * The clipboard event is fired when a copy command is active (pressed).
  132203. */
  132204. static readonly COPY: number;
  132205. /**
  132206. * The clipboard event is fired when a cut command is active (pressed).
  132207. */
  132208. static readonly CUT: number;
  132209. /**
  132210. * The clipboard event is fired when a paste command is active (pressed).
  132211. */
  132212. static readonly PASTE: number;
  132213. }
  132214. /**
  132215. * This class is used to store clipboard related info for the onClipboardObservable event.
  132216. */
  132217. export class ClipboardInfo {
  132218. /**
  132219. * Defines the type of event (BABYLON.ClipboardEventTypes)
  132220. */
  132221. type: number;
  132222. /**
  132223. * Defines the related dom event
  132224. */
  132225. event: ClipboardEvent;
  132226. /**
  132227. *Creates an instance of ClipboardInfo.
  132228. * @param type Defines the type of event (BABYLON.ClipboardEventTypes)
  132229. * @param event Defines the related dom event
  132230. */
  132231. constructor(
  132232. /**
  132233. * Defines the type of event (BABYLON.ClipboardEventTypes)
  132234. */
  132235. type: number,
  132236. /**
  132237. * Defines the related dom event
  132238. */
  132239. event: ClipboardEvent);
  132240. /**
  132241. * Get the clipboard event's type from the keycode.
  132242. * @param keyCode Defines the keyCode for the current keyboard event.
  132243. * @return {number}
  132244. */
  132245. static GetTypeFromCharacter(keyCode: number): number;
  132246. }
  132247. }
  132248. declare module BABYLON {
  132249. /**
  132250. * Google Daydream controller
  132251. */
  132252. export class DaydreamController extends WebVRController {
  132253. /**
  132254. * Base Url for the controller model.
  132255. */
  132256. static MODEL_BASE_URL: string;
  132257. /**
  132258. * File name for the controller model.
  132259. */
  132260. static MODEL_FILENAME: string;
  132261. /**
  132262. * Gamepad Id prefix used to identify Daydream Controller.
  132263. */
  132264. static readonly GAMEPAD_ID_PREFIX: string;
  132265. /**
  132266. * Creates a new DaydreamController from a gamepad
  132267. * @param vrGamepad the gamepad that the controller should be created from
  132268. */
  132269. constructor(vrGamepad: any);
  132270. /**
  132271. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  132272. * @param scene scene in which to add meshes
  132273. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  132274. */
  132275. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  132276. /**
  132277. * Called once for each button that changed state since the last frame
  132278. * @param buttonIdx Which button index changed
  132279. * @param state New state of the button
  132280. * @param changes Which properties on the state changed since last frame
  132281. */
  132282. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  132283. }
  132284. }
  132285. declare module BABYLON {
  132286. /**
  132287. * Gear VR Controller
  132288. */
  132289. export class GearVRController extends WebVRController {
  132290. /**
  132291. * Base Url for the controller model.
  132292. */
  132293. static MODEL_BASE_URL: string;
  132294. /**
  132295. * File name for the controller model.
  132296. */
  132297. static MODEL_FILENAME: string;
  132298. /**
  132299. * Gamepad Id prefix used to identify this controller.
  132300. */
  132301. static readonly GAMEPAD_ID_PREFIX: string;
  132302. private readonly _buttonIndexToObservableNameMap;
  132303. /**
  132304. * Creates a new GearVRController from a gamepad
  132305. * @param vrGamepad the gamepad that the controller should be created from
  132306. */
  132307. constructor(vrGamepad: any);
  132308. /**
  132309. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  132310. * @param scene scene in which to add meshes
  132311. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  132312. */
  132313. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  132314. /**
  132315. * Called once for each button that changed state since the last frame
  132316. * @param buttonIdx Which button index changed
  132317. * @param state New state of the button
  132318. * @param changes Which properties on the state changed since last frame
  132319. */
  132320. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  132321. }
  132322. }
  132323. declare module BABYLON {
  132324. /**
  132325. * Generic Controller
  132326. */
  132327. export class GenericController extends WebVRController {
  132328. /**
  132329. * Base Url for the controller model.
  132330. */
  132331. static readonly MODEL_BASE_URL: string;
  132332. /**
  132333. * File name for the controller model.
  132334. */
  132335. static readonly MODEL_FILENAME: string;
  132336. /**
  132337. * Creates a new GenericController from a gamepad
  132338. * @param vrGamepad the gamepad that the controller should be created from
  132339. */
  132340. constructor(vrGamepad: any);
  132341. /**
  132342. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  132343. * @param scene scene in which to add meshes
  132344. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  132345. */
  132346. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  132347. /**
  132348. * Called once for each button that changed state since the last frame
  132349. * @param buttonIdx Which button index changed
  132350. * @param state New state of the button
  132351. * @param changes Which properties on the state changed since last frame
  132352. */
  132353. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  132354. }
  132355. }
  132356. declare module BABYLON {
  132357. /**
  132358. * Oculus Touch Controller
  132359. */
  132360. export class OculusTouchController extends WebVRController {
  132361. /**
  132362. * Base Url for the controller model.
  132363. */
  132364. static MODEL_BASE_URL: string;
  132365. /**
  132366. * File name for the left controller model.
  132367. */
  132368. static MODEL_LEFT_FILENAME: string;
  132369. /**
  132370. * File name for the right controller model.
  132371. */
  132372. static MODEL_RIGHT_FILENAME: string;
  132373. /**
  132374. * Base Url for the Quest controller model.
  132375. */
  132376. static QUEST_MODEL_BASE_URL: string;
  132377. /**
  132378. * @hidden
  132379. * If the controllers are running on a device that needs the updated Quest controller models
  132380. */
  132381. static _IsQuest: boolean;
  132382. /**
  132383. * Fired when the secondary trigger on this controller is modified
  132384. */
  132385. onSecondaryTriggerStateChangedObservable: Observable<ExtendedGamepadButton>;
  132386. /**
  132387. * Fired when the thumb rest on this controller is modified
  132388. */
  132389. onThumbRestChangedObservable: Observable<ExtendedGamepadButton>;
  132390. /**
  132391. * Creates a new OculusTouchController from a gamepad
  132392. * @param vrGamepad the gamepad that the controller should be created from
  132393. */
  132394. constructor(vrGamepad: any);
  132395. /**
  132396. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  132397. * @param scene scene in which to add meshes
  132398. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  132399. */
  132400. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  132401. /**
  132402. * Fired when the A button on this controller is modified
  132403. */
  132404. get onAButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132405. /**
  132406. * Fired when the B button on this controller is modified
  132407. */
  132408. get onBButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132409. /**
  132410. * Fired when the X button on this controller is modified
  132411. */
  132412. get onXButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132413. /**
  132414. * Fired when the Y button on this controller is modified
  132415. */
  132416. get onYButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132417. /**
  132418. * Called once for each button that changed state since the last frame
  132419. * 0) thumb stick (touch, press, value = pressed (0,1)). value is in this.leftStick
  132420. * 1) index trigger (touch (?), press (only when value > 0.1), value 0 to 1)
  132421. * 2) secondary trigger (same)
  132422. * 3) A (right) X (left), touch, pressed = value
  132423. * 4) B / Y
  132424. * 5) thumb rest
  132425. * @param buttonIdx Which button index changed
  132426. * @param state New state of the button
  132427. * @param changes Which properties on the state changed since last frame
  132428. */
  132429. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  132430. }
  132431. }
  132432. declare module BABYLON {
  132433. /**
  132434. * Vive Controller
  132435. */
  132436. export class ViveController extends WebVRController {
  132437. /**
  132438. * Base Url for the controller model.
  132439. */
  132440. static MODEL_BASE_URL: string;
  132441. /**
  132442. * File name for the controller model.
  132443. */
  132444. static MODEL_FILENAME: string;
  132445. /**
  132446. * Creates a new ViveController from a gamepad
  132447. * @param vrGamepad the gamepad that the controller should be created from
  132448. */
  132449. constructor(vrGamepad: any);
  132450. /**
  132451. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  132452. * @param scene scene in which to add meshes
  132453. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  132454. */
  132455. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  132456. /**
  132457. * Fired when the left button on this controller is modified
  132458. */
  132459. get onLeftButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132460. /**
  132461. * Fired when the right button on this controller is modified
  132462. */
  132463. get onRightButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132464. /**
  132465. * Fired when the menu button on this controller is modified
  132466. */
  132467. get onMenuButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132468. /**
  132469. * Called once for each button that changed state since the last frame
  132470. * Vive mapping:
  132471. * 0: touchpad
  132472. * 1: trigger
  132473. * 2: left AND right buttons
  132474. * 3: menu button
  132475. * @param buttonIdx Which button index changed
  132476. * @param state New state of the button
  132477. * @param changes Which properties on the state changed since last frame
  132478. */
  132479. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  132480. }
  132481. }
  132482. declare module BABYLON {
  132483. /**
  132484. * Defines the WindowsMotionController object that the state of the windows motion controller
  132485. */
  132486. export class WindowsMotionController extends WebVRController {
  132487. /**
  132488. * The base url used to load the left and right controller models
  132489. */
  132490. static MODEL_BASE_URL: string;
  132491. /**
  132492. * The name of the left controller model file
  132493. */
  132494. static MODEL_LEFT_FILENAME: string;
  132495. /**
  132496. * The name of the right controller model file
  132497. */
  132498. static MODEL_RIGHT_FILENAME: string;
  132499. /**
  132500. * The controller name prefix for this controller type
  132501. */
  132502. static readonly GAMEPAD_ID_PREFIX: string;
  132503. /**
  132504. * The controller id pattern for this controller type
  132505. */
  132506. private static readonly GAMEPAD_ID_PATTERN;
  132507. private _loadedMeshInfo;
  132508. protected readonly _mapping: {
  132509. buttons: string[];
  132510. buttonMeshNames: {
  132511. trigger: string;
  132512. menu: string;
  132513. grip: string;
  132514. thumbstick: string;
  132515. trackpad: string;
  132516. };
  132517. buttonObservableNames: {
  132518. trigger: string;
  132519. menu: string;
  132520. grip: string;
  132521. thumbstick: string;
  132522. trackpad: string;
  132523. };
  132524. axisMeshNames: string[];
  132525. pointingPoseMeshName: string;
  132526. };
  132527. /**
  132528. * Fired when the trackpad on this controller is clicked
  132529. */
  132530. onTrackpadChangedObservable: Observable<ExtendedGamepadButton>;
  132531. /**
  132532. * Fired when the trackpad on this controller is modified
  132533. */
  132534. onTrackpadValuesChangedObservable: Observable<StickValues>;
  132535. /**
  132536. * The current x and y values of this controller's trackpad
  132537. */
  132538. trackpad: StickValues;
  132539. /**
  132540. * Creates a new WindowsMotionController from a gamepad
  132541. * @param vrGamepad the gamepad that the controller should be created from
  132542. */
  132543. constructor(vrGamepad: any);
  132544. /**
  132545. * Fired when the trigger on this controller is modified
  132546. */
  132547. get onTriggerButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132548. /**
  132549. * Fired when the menu button on this controller is modified
  132550. */
  132551. get onMenuButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132552. /**
  132553. * Fired when the grip button on this controller is modified
  132554. */
  132555. get onGripButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132556. /**
  132557. * Fired when the thumbstick button on this controller is modified
  132558. */
  132559. get onThumbstickButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132560. /**
  132561. * Fired when the touchpad button on this controller is modified
  132562. */
  132563. get onTouchpadButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132564. /**
  132565. * Fired when the touchpad values on this controller are modified
  132566. */
  132567. get onTouchpadValuesChangedObservable(): Observable<StickValues>;
  132568. protected _updateTrackpad(): void;
  132569. /**
  132570. * Called once per frame by the engine.
  132571. */
  132572. update(): void;
  132573. /**
  132574. * Called once for each button that changed state since the last frame
  132575. * @param buttonIdx Which button index changed
  132576. * @param state New state of the button
  132577. * @param changes Which properties on the state changed since last frame
  132578. */
  132579. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  132580. /**
  132581. * Moves the buttons on the controller mesh based on their current state
  132582. * @param buttonName the name of the button to move
  132583. * @param buttonValue the value of the button which determines the buttons new position
  132584. */
  132585. protected _lerpButtonTransform(buttonName: string, buttonValue: number): void;
  132586. /**
  132587. * Moves the axis on the controller mesh based on its current state
  132588. * @param axis the index of the axis
  132589. * @param axisValue the value of the axis which determines the meshes new position
  132590. * @hidden
  132591. */
  132592. protected _lerpAxisTransform(axis: number, axisValue: number): void;
  132593. /**
  132594. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  132595. * @param scene scene in which to add meshes
  132596. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  132597. */
  132598. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void, forceDefault?: boolean): void;
  132599. /**
  132600. * Takes a list of meshes (as loaded from the glTF file) and finds the root node, as well as nodes that
  132601. * can be transformed by button presses and axes values, based on this._mapping.
  132602. *
  132603. * @param scene scene in which the meshes exist
  132604. * @param meshes list of meshes that make up the controller model to process
  132605. * @return structured view of the given meshes, with mapping of buttons and axes to meshes that can be transformed.
  132606. */
  132607. private processModel;
  132608. private createMeshInfo;
  132609. /**
  132610. * Gets the ray of the controller in the direction the controller is pointing
  132611. * @param length the length the resulting ray should be
  132612. * @returns a ray in the direction the controller is pointing
  132613. */
  132614. getForwardRay(length?: number): Ray;
  132615. /**
  132616. * Disposes of the controller
  132617. */
  132618. dispose(): void;
  132619. }
  132620. /**
  132621. * This class represents a new windows motion controller in XR.
  132622. */
  132623. export class XRWindowsMotionController extends WindowsMotionController {
  132624. /**
  132625. * Changing the original WIndowsMotionController mapping to fir the new mapping
  132626. */
  132627. protected readonly _mapping: {
  132628. buttons: string[];
  132629. buttonMeshNames: {
  132630. trigger: string;
  132631. menu: string;
  132632. grip: string;
  132633. thumbstick: string;
  132634. trackpad: string;
  132635. };
  132636. buttonObservableNames: {
  132637. trigger: string;
  132638. menu: string;
  132639. grip: string;
  132640. thumbstick: string;
  132641. trackpad: string;
  132642. };
  132643. axisMeshNames: string[];
  132644. pointingPoseMeshName: string;
  132645. };
  132646. /**
  132647. * Construct a new XR-Based windows motion controller
  132648. *
  132649. * @param gamepadInfo the gamepad object from the browser
  132650. */
  132651. constructor(gamepadInfo: any);
  132652. /**
  132653. * holds the thumbstick values (X,Y)
  132654. */
  132655. thumbstickValues: StickValues;
  132656. /**
  132657. * Fired when the thumbstick on this controller is clicked
  132658. */
  132659. onThumbstickStateChangedObservable: Observable<ExtendedGamepadButton>;
  132660. /**
  132661. * Fired when the thumbstick on this controller is modified
  132662. */
  132663. onThumbstickValuesChangedObservable: Observable<StickValues>;
  132664. /**
  132665. * Fired when the touchpad button on this controller is modified
  132666. */
  132667. onTrackpadChangedObservable: Observable<ExtendedGamepadButton>;
  132668. /**
  132669. * Fired when the touchpad values on this controller are modified
  132670. */
  132671. onTrackpadValuesChangedObservable: Observable<StickValues>;
  132672. /**
  132673. * Fired when the thumbstick button on this controller is modified
  132674. * here to prevent breaking changes
  132675. */
  132676. get onThumbstickButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132677. /**
  132678. * updating the thumbstick(!) and not the trackpad.
  132679. * This is named this way due to the difference between WebVR and XR and to avoid
  132680. * changing the parent class.
  132681. */
  132682. protected _updateTrackpad(): void;
  132683. /**
  132684. * Disposes the class with joy
  132685. */
  132686. dispose(): void;
  132687. }
  132688. }
  132689. declare module BABYLON {
  132690. /**
  132691. * Class containing static functions to help procedurally build meshes
  132692. */
  132693. export class PolyhedronBuilder {
  132694. /**
  132695. * Creates a polyhedron mesh
  132696. * * 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
  132697. * * The parameter `size` (positive float, default 1) sets the polygon size
  132698. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  132699. * * 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`
  132700. * * 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
  132701. * * 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)`)
  132702. * * 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
  132703. * * 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
  132704. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  132705. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  132706. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  132707. * @param name defines the name of the mesh
  132708. * @param options defines the options used to create the mesh
  132709. * @param scene defines the hosting scene
  132710. * @returns the polyhedron mesh
  132711. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes
  132712. */
  132713. static CreatePolyhedron(name: string, options: {
  132714. type?: number;
  132715. size?: number;
  132716. sizeX?: number;
  132717. sizeY?: number;
  132718. sizeZ?: number;
  132719. custom?: any;
  132720. faceUV?: Vector4[];
  132721. faceColors?: Color4[];
  132722. flat?: boolean;
  132723. updatable?: boolean;
  132724. sideOrientation?: number;
  132725. frontUVs?: Vector4;
  132726. backUVs?: Vector4;
  132727. }, scene?: Nullable<Scene>): Mesh;
  132728. }
  132729. }
  132730. declare module BABYLON {
  132731. /**
  132732. * Gizmo that enables scaling a mesh along 3 axis
  132733. */
  132734. export class ScaleGizmo extends Gizmo {
  132735. /**
  132736. * Internal gizmo used for interactions on the x axis
  132737. */
  132738. xGizmo: AxisScaleGizmo;
  132739. /**
  132740. * Internal gizmo used for interactions on the y axis
  132741. */
  132742. yGizmo: AxisScaleGizmo;
  132743. /**
  132744. * Internal gizmo used for interactions on the z axis
  132745. */
  132746. zGizmo: AxisScaleGizmo;
  132747. /**
  132748. * Internal gizmo used to scale all axis equally
  132749. */
  132750. uniformScaleGizmo: AxisScaleGizmo;
  132751. private _meshAttached;
  132752. private _nodeAttached;
  132753. private _updateGizmoRotationToMatchAttachedMesh;
  132754. private _snapDistance;
  132755. private _scaleRatio;
  132756. private _uniformScalingMesh;
  132757. private _octahedron;
  132758. private _sensitivity;
  132759. /** Fires an event when any of it's sub gizmos are dragged */
  132760. onDragStartObservable: Observable<unknown>;
  132761. /** Fires an event when any of it's sub gizmos are released from dragging */
  132762. onDragEndObservable: Observable<unknown>;
  132763. get attachedMesh(): Nullable<AbstractMesh>;
  132764. set attachedMesh(mesh: Nullable<AbstractMesh>);
  132765. get attachedNode(): Nullable<Node>;
  132766. set attachedNode(node: Nullable<Node>);
  132767. /**
  132768. * Creates a ScaleGizmo
  132769. * @param gizmoLayer The utility layer the gizmo will be added to
  132770. * @param thickness display gizmo axis thickness
  132771. */
  132772. constructor(gizmoLayer?: UtilityLayerRenderer, thickness?: number);
  132773. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  132774. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  132775. /**
  132776. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  132777. */
  132778. set snapDistance(value: number);
  132779. get snapDistance(): number;
  132780. /**
  132781. * Ratio for the scale of the gizmo (Default: 1)
  132782. */
  132783. set scaleRatio(value: number);
  132784. get scaleRatio(): number;
  132785. /**
  132786. * Sensitivity factor for dragging (Default: 1)
  132787. */
  132788. set sensitivity(value: number);
  132789. get sensitivity(): number;
  132790. /**
  132791. * Disposes of the gizmo
  132792. */
  132793. dispose(): void;
  132794. }
  132795. }
  132796. declare module BABYLON {
  132797. /**
  132798. * Single axis scale gizmo
  132799. */
  132800. export class AxisScaleGizmo extends Gizmo {
  132801. /**
  132802. * Drag behavior responsible for the gizmos dragging interactions
  132803. */
  132804. dragBehavior: PointerDragBehavior;
  132805. private _pointerObserver;
  132806. /**
  132807. * Scale distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  132808. */
  132809. snapDistance: number;
  132810. /**
  132811. * Event that fires each time the gizmo snaps to a new location.
  132812. * * snapDistance is the the change in distance
  132813. */
  132814. onSnapObservable: Observable<{
  132815. snapDistance: number;
  132816. }>;
  132817. /**
  132818. * If the scaling operation should be done on all axis (default: false)
  132819. */
  132820. uniformScaling: boolean;
  132821. /**
  132822. * Custom sensitivity value for the drag strength
  132823. */
  132824. sensitivity: number;
  132825. private _isEnabled;
  132826. private _parent;
  132827. private _arrow;
  132828. private _coloredMaterial;
  132829. private _hoverMaterial;
  132830. /**
  132831. * Creates an AxisScaleGizmo
  132832. * @param gizmoLayer The utility layer the gizmo will be added to
  132833. * @param dragAxis The axis which the gizmo will be able to scale on
  132834. * @param color The color of the gizmo
  132835. * @param thickness display gizmo axis thickness
  132836. */
  132837. constructor(dragAxis: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<ScaleGizmo>, thickness?: number);
  132838. protected _attachedNodeChanged(value: Nullable<Node>): void;
  132839. /**
  132840. * If the gizmo is enabled
  132841. */
  132842. set isEnabled(value: boolean);
  132843. get isEnabled(): boolean;
  132844. /**
  132845. * Disposes of the gizmo
  132846. */
  132847. dispose(): void;
  132848. /**
  132849. * Disposes and replaces the current meshes in the gizmo with the specified mesh
  132850. * @param mesh The mesh to replace the default mesh of the gizmo
  132851. * @param useGizmoMaterial If the gizmo's default material should be used (default: false)
  132852. */
  132853. setCustomMesh(mesh: Mesh, useGizmoMaterial?: boolean): void;
  132854. }
  132855. }
  132856. declare module BABYLON {
  132857. /**
  132858. * Bounding box gizmo
  132859. */
  132860. export class BoundingBoxGizmo extends Gizmo {
  132861. private _lineBoundingBox;
  132862. private _rotateSpheresParent;
  132863. private _scaleBoxesParent;
  132864. private _boundingDimensions;
  132865. private _renderObserver;
  132866. private _pointerObserver;
  132867. private _scaleDragSpeed;
  132868. private _tmpQuaternion;
  132869. private _tmpVector;
  132870. private _tmpRotationMatrix;
  132871. /**
  132872. * 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)
  132873. */
  132874. ignoreChildren: boolean;
  132875. /**
  132876. * 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)
  132877. */
  132878. includeChildPredicate: Nullable<(abstractMesh: AbstractMesh) => boolean>;
  132879. /**
  132880. * The size of the rotation spheres attached to the bounding box (Default: 0.1)
  132881. */
  132882. rotationSphereSize: number;
  132883. /**
  132884. * The size of the scale boxes attached to the bounding box (Default: 0.1)
  132885. */
  132886. scaleBoxSize: number;
  132887. /**
  132888. * 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)
  132889. */
  132890. fixedDragMeshScreenSize: boolean;
  132891. /**
  132892. * The distance away from the object which the draggable meshes should appear world sized when fixedDragMeshScreenSize is set to true (default: 10)
  132893. */
  132894. fixedDragMeshScreenSizeDistanceFactor: number;
  132895. /**
  132896. * Fired when a rotation sphere or scale box is dragged
  132897. */
  132898. onDragStartObservable: Observable<{}>;
  132899. /**
  132900. * Fired when a scale box is dragged
  132901. */
  132902. onScaleBoxDragObservable: Observable<{}>;
  132903. /**
  132904. * Fired when a scale box drag is ended
  132905. */
  132906. onScaleBoxDragEndObservable: Observable<{}>;
  132907. /**
  132908. * Fired when a rotation sphere is dragged
  132909. */
  132910. onRotationSphereDragObservable: Observable<{}>;
  132911. /**
  132912. * Fired when a rotation sphere drag is ended
  132913. */
  132914. onRotationSphereDragEndObservable: Observable<{}>;
  132915. /**
  132916. * 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)
  132917. */
  132918. scalePivot: Nullable<Vector3>;
  132919. /**
  132920. * Mesh used as a pivot to rotate the attached node
  132921. */
  132922. private _anchorMesh;
  132923. private _existingMeshScale;
  132924. private _dragMesh;
  132925. private pointerDragBehavior;
  132926. private coloredMaterial;
  132927. private hoverColoredMaterial;
  132928. /**
  132929. * Sets the color of the bounding box gizmo
  132930. * @param color the color to set
  132931. */
  132932. setColor(color: Color3): void;
  132933. /**
  132934. * Creates an BoundingBoxGizmo
  132935. * @param gizmoLayer The utility layer the gizmo will be added to
  132936. * @param color The color of the gizmo
  132937. */
  132938. constructor(color?: Color3, gizmoLayer?: UtilityLayerRenderer);
  132939. protected _attachedNodeChanged(value: Nullable<AbstractMesh>): void;
  132940. private _selectNode;
  132941. /**
  132942. * Updates the bounding box information for the Gizmo
  132943. */
  132944. updateBoundingBox(): void;
  132945. private _updateRotationSpheres;
  132946. private _updateScaleBoxes;
  132947. /**
  132948. * Enables rotation on the specified axis and disables rotation on the others
  132949. * @param axis The list of axis that should be enabled (eg. "xy" or "xyz")
  132950. */
  132951. setEnabledRotationAxis(axis: string): void;
  132952. /**
  132953. * Enables/disables scaling
  132954. * @param enable if scaling should be enabled
  132955. * @param homogeneousScaling defines if scaling should only be homogeneous
  132956. */
  132957. setEnabledScaling(enable: boolean, homogeneousScaling?: boolean): void;
  132958. private _updateDummy;
  132959. /**
  132960. * Enables a pointer drag behavior on the bounding box of the gizmo
  132961. */
  132962. enableDragBehavior(): void;
  132963. /**
  132964. * Disposes of the gizmo
  132965. */
  132966. dispose(): void;
  132967. /**
  132968. * 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)
  132969. * @param mesh the mesh to wrap in the bounding box mesh and make not pickable
  132970. * @returns the bounding box mesh with the passed in mesh as a child
  132971. */
  132972. static MakeNotPickableAndWrapInBoundingBox(mesh: Mesh): Mesh;
  132973. /**
  132974. * CustomMeshes are not supported by this gizmo
  132975. * @param mesh The mesh to replace the default mesh of the gizmo
  132976. */
  132977. setCustomMesh(mesh: Mesh): void;
  132978. }
  132979. }
  132980. declare module BABYLON {
  132981. /**
  132982. * Single plane rotation gizmo
  132983. */
  132984. export class PlaneRotationGizmo extends Gizmo {
  132985. /**
  132986. * Drag behavior responsible for the gizmos dragging interactions
  132987. */
  132988. dragBehavior: PointerDragBehavior;
  132989. private _pointerObserver;
  132990. /**
  132991. * Rotation distance in radians that the gizmo will snap to (Default: 0)
  132992. */
  132993. snapDistance: number;
  132994. /**
  132995. * Event that fires each time the gizmo snaps to a new location.
  132996. * * snapDistance is the the change in distance
  132997. */
  132998. onSnapObservable: Observable<{
  132999. snapDistance: number;
  133000. }>;
  133001. private _isEnabled;
  133002. private _parent;
  133003. /**
  133004. * Creates a PlaneRotationGizmo
  133005. * @param gizmoLayer The utility layer the gizmo will be added to
  133006. * @param planeNormal The normal of the plane which the gizmo will be able to rotate on
  133007. * @param color The color of the gizmo
  133008. * @param tessellation Amount of tessellation to be used when creating rotation circles
  133009. * @param useEulerRotation Use and update Euler angle instead of quaternion
  133010. * @param thickness display gizmo axis thickness
  133011. */
  133012. constructor(planeNormal: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, tessellation?: number, parent?: Nullable<RotationGizmo>, useEulerRotation?: boolean, thickness?: number);
  133013. protected _attachedNodeChanged(value: Nullable<Node>): void;
  133014. /**
  133015. * If the gizmo is enabled
  133016. */
  133017. set isEnabled(value: boolean);
  133018. get isEnabled(): boolean;
  133019. /**
  133020. * Disposes of the gizmo
  133021. */
  133022. dispose(): void;
  133023. }
  133024. }
  133025. declare module BABYLON {
  133026. /**
  133027. * Gizmo that enables rotating a mesh along 3 axis
  133028. */
  133029. export class RotationGizmo extends Gizmo {
  133030. /**
  133031. * Internal gizmo used for interactions on the x axis
  133032. */
  133033. xGizmo: PlaneRotationGizmo;
  133034. /**
  133035. * Internal gizmo used for interactions on the y axis
  133036. */
  133037. yGizmo: PlaneRotationGizmo;
  133038. /**
  133039. * Internal gizmo used for interactions on the z axis
  133040. */
  133041. zGizmo: PlaneRotationGizmo;
  133042. /** Fires an event when any of it's sub gizmos are dragged */
  133043. onDragStartObservable: Observable<unknown>;
  133044. /** Fires an event when any of it's sub gizmos are released from dragging */
  133045. onDragEndObservable: Observable<unknown>;
  133046. private _meshAttached;
  133047. private _nodeAttached;
  133048. get attachedMesh(): Nullable<AbstractMesh>;
  133049. set attachedMesh(mesh: Nullable<AbstractMesh>);
  133050. get attachedNode(): Nullable<Node>;
  133051. set attachedNode(node: Nullable<Node>);
  133052. /**
  133053. * Creates a RotationGizmo
  133054. * @param gizmoLayer The utility layer the gizmo will be added to
  133055. * @param tessellation Amount of tessellation to be used when creating rotation circles
  133056. * @param useEulerRotation Use and update Euler angle instead of quaternion
  133057. * @param thickness display gizmo axis thickness
  133058. */
  133059. constructor(gizmoLayer?: UtilityLayerRenderer, tessellation?: number, useEulerRotation?: boolean, thickness?: number);
  133060. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  133061. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  133062. /**
  133063. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  133064. */
  133065. set snapDistance(value: number);
  133066. get snapDistance(): number;
  133067. /**
  133068. * Ratio for the scale of the gizmo (Default: 1)
  133069. */
  133070. set scaleRatio(value: number);
  133071. get scaleRatio(): number;
  133072. /**
  133073. * Disposes of the gizmo
  133074. */
  133075. dispose(): void;
  133076. /**
  133077. * CustomMeshes are not supported by this gizmo
  133078. * @param mesh The mesh to replace the default mesh of the gizmo
  133079. */
  133080. setCustomMesh(mesh: Mesh): void;
  133081. }
  133082. }
  133083. declare module BABYLON {
  133084. /**
  133085. * Helps setup gizmo's in the scene to rotate/scale/position nodes
  133086. */
  133087. export class GizmoManager implements IDisposable {
  133088. private scene;
  133089. /**
  133090. * Gizmo's created by the gizmo manager, gizmo will be null until gizmo has been enabled for the first time
  133091. */
  133092. gizmos: {
  133093. positionGizmo: Nullable<PositionGizmo>;
  133094. rotationGizmo: Nullable<RotationGizmo>;
  133095. scaleGizmo: Nullable<ScaleGizmo>;
  133096. boundingBoxGizmo: Nullable<BoundingBoxGizmo>;
  133097. };
  133098. /** When true, the gizmo will be detached from the current object when a pointer down occurs with an empty picked mesh */
  133099. clearGizmoOnEmptyPointerEvent: boolean;
  133100. /** Fires an event when the manager is attached to a mesh */
  133101. onAttachedToMeshObservable: Observable<Nullable<AbstractMesh>>;
  133102. /** Fires an event when the manager is attached to a node */
  133103. onAttachedToNodeObservable: Observable<Nullable<Node>>;
  133104. private _gizmosEnabled;
  133105. private _pointerObserver;
  133106. private _attachedMesh;
  133107. private _attachedNode;
  133108. private _boundingBoxColor;
  133109. private _defaultUtilityLayer;
  133110. private _defaultKeepDepthUtilityLayer;
  133111. private _thickness;
  133112. /**
  133113. * When bounding box gizmo is enabled, this can be used to track drag/end events
  133114. */
  133115. boundingBoxDragBehavior: SixDofDragBehavior;
  133116. /**
  133117. * Array of meshes which will have the gizmo attached when a pointer selected them. If null, all meshes are attachable. (Default: null)
  133118. */
  133119. attachableMeshes: Nullable<Array<AbstractMesh>>;
  133120. /**
  133121. * Array of nodes which will have the gizmo attached when a pointer selected them. If null, all nodes are attachable. (Default: null)
  133122. */
  133123. attachableNodes: Nullable<Array<Node>>;
  133124. /**
  133125. * If pointer events should perform attaching/detaching a gizmo, if false this can be done manually via attachToMesh/attachToNode. (Default: true)
  133126. */
  133127. usePointerToAttachGizmos: boolean;
  133128. /**
  133129. * Utility layer that the bounding box gizmo belongs to
  133130. */
  133131. get keepDepthUtilityLayer(): UtilityLayerRenderer;
  133132. /**
  133133. * Utility layer that all gizmos besides bounding box belong to
  133134. */
  133135. get utilityLayer(): UtilityLayerRenderer;
  133136. /**
  133137. * Instatiates a gizmo manager
  133138. * @param scene the scene to overlay the gizmos on top of
  133139. * @param thickness display gizmo axis thickness
  133140. */
  133141. constructor(scene: Scene, thickness?: number);
  133142. /**
  133143. * Attaches a set of gizmos to the specified mesh
  133144. * @param mesh The mesh the gizmo's should be attached to
  133145. */
  133146. attachToMesh(mesh: Nullable<AbstractMesh>): void;
  133147. /**
  133148. * Attaches a set of gizmos to the specified node
  133149. * @param node The node the gizmo's should be attached to
  133150. */
  133151. attachToNode(node: Nullable<Node>): void;
  133152. /**
  133153. * If the position gizmo is enabled
  133154. */
  133155. set positionGizmoEnabled(value: boolean);
  133156. get positionGizmoEnabled(): boolean;
  133157. /**
  133158. * If the rotation gizmo is enabled
  133159. */
  133160. set rotationGizmoEnabled(value: boolean);
  133161. get rotationGizmoEnabled(): boolean;
  133162. /**
  133163. * If the scale gizmo is enabled
  133164. */
  133165. set scaleGizmoEnabled(value: boolean);
  133166. get scaleGizmoEnabled(): boolean;
  133167. /**
  133168. * If the boundingBox gizmo is enabled
  133169. */
  133170. set boundingBoxGizmoEnabled(value: boolean);
  133171. get boundingBoxGizmoEnabled(): boolean;
  133172. /**
  133173. * Disposes of the gizmo manager
  133174. */
  133175. dispose(): void;
  133176. }
  133177. }
  133178. declare module BABYLON {
  133179. /**
  133180. * A directional light is defined by a direction (what a surprise!).
  133181. * The light is emitted from everywhere in the specified direction, and has an infinite range.
  133182. * 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.
  133183. * Documentation: https://doc.babylonjs.com/babylon101/lights
  133184. */
  133185. export class DirectionalLight extends ShadowLight {
  133186. private _shadowFrustumSize;
  133187. /**
  133188. * Fix frustum size for the shadow generation. This is disabled if the value is 0.
  133189. */
  133190. get shadowFrustumSize(): number;
  133191. /**
  133192. * Specifies a fix frustum size for the shadow generation.
  133193. */
  133194. set shadowFrustumSize(value: number);
  133195. private _shadowOrthoScale;
  133196. /**
  133197. * Gets the shadow projection scale against the optimal computed one.
  133198. * 0.1 by default which means that the projection window is increase by 10% from the optimal size.
  133199. * This does not impact in fixed frustum size (shadowFrustumSize being set)
  133200. */
  133201. get shadowOrthoScale(): number;
  133202. /**
  133203. * Sets the shadow projection scale against the optimal computed one.
  133204. * 0.1 by default which means that the projection window is increase by 10% from the optimal size.
  133205. * This does not impact in fixed frustum size (shadowFrustumSize being set)
  133206. */
  133207. set shadowOrthoScale(value: number);
  133208. /**
  133209. * Automatically compute the projection matrix to best fit (including all the casters)
  133210. * on each frame.
  133211. */
  133212. autoUpdateExtends: boolean;
  133213. /**
  133214. * Automatically compute the shadowMinZ and shadowMaxZ for the projection matrix to best fit (including all the casters)
  133215. * on each frame. autoUpdateExtends must be set to true for this to work
  133216. */
  133217. autoCalcShadowZBounds: boolean;
  133218. private _orthoLeft;
  133219. private _orthoRight;
  133220. private _orthoTop;
  133221. private _orthoBottom;
  133222. /**
  133223. * Creates a DirectionalLight object in the scene, oriented towards the passed direction (Vector3).
  133224. * The directional light is emitted from everywhere in the given direction.
  133225. * It can cast shadows.
  133226. * Documentation : https://doc.babylonjs.com/babylon101/lights
  133227. * @param name The friendly name of the light
  133228. * @param direction The direction of the light
  133229. * @param scene The scene the light belongs to
  133230. */
  133231. constructor(name: string, direction: Vector3, scene: Scene);
  133232. /**
  133233. * Returns the string "DirectionalLight".
  133234. * @return The class name
  133235. */
  133236. getClassName(): string;
  133237. /**
  133238. * Returns the integer 1.
  133239. * @return The light Type id as a constant defines in Light.LIGHTTYPEID_x
  133240. */
  133241. getTypeID(): number;
  133242. /**
  133243. * Sets the passed matrix "matrix" as projection matrix for the shadows cast by the light according to the passed view matrix.
  133244. * Returns the DirectionalLight Shadow projection matrix.
  133245. */
  133246. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  133247. /**
  133248. * Sets the passed matrix "matrix" as fixed frustum projection matrix for the shadows cast by the light according to the passed view matrix.
  133249. * Returns the DirectionalLight Shadow projection matrix.
  133250. */
  133251. protected _setDefaultFixedFrustumShadowProjectionMatrix(matrix: Matrix): void;
  133252. /**
  133253. * Sets the passed matrix "matrix" as auto extend projection matrix for the shadows cast by the light according to the passed view matrix.
  133254. * Returns the DirectionalLight Shadow projection matrix.
  133255. */
  133256. protected _setDefaultAutoExtendShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  133257. protected _buildUniformLayout(): void;
  133258. /**
  133259. * Sets the passed Effect object with the DirectionalLight transformed position (or position if not parented) and the passed name.
  133260. * @param effect The effect to update
  133261. * @param lightIndex The index of the light in the effect to update
  133262. * @returns The directional light
  133263. */
  133264. transferToEffect(effect: Effect, lightIndex: string): DirectionalLight;
  133265. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): Light;
  133266. /**
  133267. * Gets the minZ used for shadow according to both the scene and the light.
  133268. *
  133269. * Values are fixed on directional lights as it relies on an ortho projection hence the need to convert being
  133270. * -1 and 1 to 0 and 1 doing (depth + min) / (min + max) -> (depth + 1) / (1 + 1) -> (depth * 0.5) + 0.5.
  133271. * @param activeCamera The camera we are returning the min for
  133272. * @returns the depth min z
  133273. */
  133274. getDepthMinZ(activeCamera: Camera): number;
  133275. /**
  133276. * Gets the maxZ used for shadow according to both the scene and the light.
  133277. *
  133278. * Values are fixed on directional lights as it relies on an ortho projection hence the need to convert being
  133279. * -1 and 1 to 0 and 1 doing (depth + min) / (min + max) -> (depth + 1) / (1 + 1) -> (depth * 0.5) + 0.5.
  133280. * @param activeCamera The camera we are returning the max for
  133281. * @returns the depth max z
  133282. */
  133283. getDepthMaxZ(activeCamera: Camera): number;
  133284. /**
  133285. * Prepares the list of defines specific to the light type.
  133286. * @param defines the list of defines
  133287. * @param lightIndex defines the index of the light for the effect
  133288. */
  133289. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  133290. }
  133291. }
  133292. declare module BABYLON {
  133293. /**
  133294. * Class containing static functions to help procedurally build meshes
  133295. */
  133296. export class HemisphereBuilder {
  133297. /**
  133298. * Creates a hemisphere mesh
  133299. * @param name defines the name of the mesh
  133300. * @param options defines the options used to create the mesh
  133301. * @param scene defines the hosting scene
  133302. * @returns the hemisphere mesh
  133303. */
  133304. static CreateHemisphere(name: string, options: {
  133305. segments?: number;
  133306. diameter?: number;
  133307. sideOrientation?: number;
  133308. }, scene: any): Mesh;
  133309. }
  133310. }
  133311. declare module BABYLON {
  133312. /**
  133313. * A spot light is defined by a position, a direction, an angle, and an exponent.
  133314. * These values define a cone of light starting from the position, emitting toward the direction.
  133315. * The angle, in radians, defines the size (field of illumination) of the spotlight's conical beam,
  133316. * and the exponent defines the speed of the decay of the light with distance (reach).
  133317. * Documentation: https://doc.babylonjs.com/babylon101/lights
  133318. */
  133319. export class SpotLight extends ShadowLight {
  133320. private _angle;
  133321. private _innerAngle;
  133322. private _cosHalfAngle;
  133323. private _lightAngleScale;
  133324. private _lightAngleOffset;
  133325. /**
  133326. * Gets the cone angle of the spot light in Radians.
  133327. */
  133328. get angle(): number;
  133329. /**
  133330. * Sets the cone angle of the spot light in Radians.
  133331. */
  133332. set angle(value: number);
  133333. /**
  133334. * Only used in gltf falloff mode, this defines the angle where
  133335. * the directional falloff will start before cutting at angle which could be seen
  133336. * as outer angle.
  133337. */
  133338. get innerAngle(): number;
  133339. /**
  133340. * Only used in gltf falloff mode, this defines the angle where
  133341. * the directional falloff will start before cutting at angle which could be seen
  133342. * as outer angle.
  133343. */
  133344. set innerAngle(value: number);
  133345. private _shadowAngleScale;
  133346. /**
  133347. * Allows scaling the angle of the light for shadow generation only.
  133348. */
  133349. get shadowAngleScale(): number;
  133350. /**
  133351. * Allows scaling the angle of the light for shadow generation only.
  133352. */
  133353. set shadowAngleScale(value: number);
  133354. /**
  133355. * The light decay speed with the distance from the emission spot.
  133356. */
  133357. exponent: number;
  133358. private _projectionTextureMatrix;
  133359. /**
  133360. * Allows reading the projecton texture
  133361. */
  133362. get projectionTextureMatrix(): Matrix;
  133363. protected _projectionTextureLightNear: number;
  133364. /**
  133365. * Gets the near clip of the Spotlight for texture projection.
  133366. */
  133367. get projectionTextureLightNear(): number;
  133368. /**
  133369. * Sets the near clip of the Spotlight for texture projection.
  133370. */
  133371. set projectionTextureLightNear(value: number);
  133372. protected _projectionTextureLightFar: number;
  133373. /**
  133374. * Gets the far clip of the Spotlight for texture projection.
  133375. */
  133376. get projectionTextureLightFar(): number;
  133377. /**
  133378. * Sets the far clip of the Spotlight for texture projection.
  133379. */
  133380. set projectionTextureLightFar(value: number);
  133381. protected _projectionTextureUpDirection: Vector3;
  133382. /**
  133383. * Gets the Up vector of the Spotlight for texture projection.
  133384. */
  133385. get projectionTextureUpDirection(): Vector3;
  133386. /**
  133387. * Sets the Up vector of the Spotlight for texture projection.
  133388. */
  133389. set projectionTextureUpDirection(value: Vector3);
  133390. private _projectionTexture;
  133391. /**
  133392. * Gets the projection texture of the light.
  133393. */
  133394. get projectionTexture(): Nullable<BaseTexture>;
  133395. /**
  133396. * Sets the projection texture of the light.
  133397. */
  133398. set projectionTexture(value: Nullable<BaseTexture>);
  133399. private _projectionTextureViewLightDirty;
  133400. private _projectionTextureProjectionLightDirty;
  133401. private _projectionTextureDirty;
  133402. private _projectionTextureViewTargetVector;
  133403. private _projectionTextureViewLightMatrix;
  133404. private _projectionTextureProjectionLightMatrix;
  133405. private _projectionTextureScalingMatrix;
  133406. /**
  133407. * Creates a SpotLight object in the scene. A spot light is a simply light oriented cone.
  133408. * It can cast shadows.
  133409. * Documentation : https://doc.babylonjs.com/babylon101/lights
  133410. * @param name The light friendly name
  133411. * @param position The position of the spot light in the scene
  133412. * @param direction The direction of the light in the scene
  133413. * @param angle The cone angle of the light in Radians
  133414. * @param exponent The light decay speed with the distance from the emission spot
  133415. * @param scene The scene the lights belongs to
  133416. */
  133417. constructor(name: string, position: Vector3, direction: Vector3, angle: number, exponent: number, scene: Scene);
  133418. /**
  133419. * Returns the string "SpotLight".
  133420. * @returns the class name
  133421. */
  133422. getClassName(): string;
  133423. /**
  133424. * Returns the integer 2.
  133425. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  133426. */
  133427. getTypeID(): number;
  133428. /**
  133429. * Overrides the direction setter to recompute the projection texture view light Matrix.
  133430. */
  133431. protected _setDirection(value: Vector3): void;
  133432. /**
  133433. * Overrides the position setter to recompute the projection texture view light Matrix.
  133434. */
  133435. protected _setPosition(value: Vector3): void;
  133436. /**
  133437. * 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.
  133438. * Returns the SpotLight.
  133439. */
  133440. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  133441. protected _computeProjectionTextureViewLightMatrix(): void;
  133442. protected _computeProjectionTextureProjectionLightMatrix(): void;
  133443. /**
  133444. * Main function for light texture projection matrix computing.
  133445. */
  133446. protected _computeProjectionTextureMatrix(): void;
  133447. protected _buildUniformLayout(): void;
  133448. private _computeAngleValues;
  133449. /**
  133450. * Sets the passed Effect "effect" with the Light textures.
  133451. * @param effect The effect to update
  133452. * @param lightIndex The index of the light in the effect to update
  133453. * @returns The light
  133454. */
  133455. transferTexturesToEffect(effect: Effect, lightIndex: string): Light;
  133456. /**
  133457. * Sets the passed Effect object with the SpotLight transfomed position (or position if not parented) and normalized direction.
  133458. * @param effect The effect to update
  133459. * @param lightIndex The index of the light in the effect to update
  133460. * @returns The spot light
  133461. */
  133462. transferToEffect(effect: Effect, lightIndex: string): SpotLight;
  133463. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  133464. /**
  133465. * Disposes the light and the associated resources.
  133466. */
  133467. dispose(): void;
  133468. /**
  133469. * Prepares the list of defines specific to the light type.
  133470. * @param defines the list of defines
  133471. * @param lightIndex defines the index of the light for the effect
  133472. */
  133473. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  133474. }
  133475. }
  133476. declare module BABYLON {
  133477. /**
  133478. * Gizmo that enables viewing a light
  133479. */
  133480. export class LightGizmo extends Gizmo {
  133481. private _lightMesh;
  133482. private _material;
  133483. private _cachedPosition;
  133484. private _cachedForward;
  133485. private _attachedMeshParent;
  133486. /**
  133487. * Creates a LightGizmo
  133488. * @param gizmoLayer The utility layer the gizmo will be added to
  133489. */
  133490. constructor(gizmoLayer?: UtilityLayerRenderer);
  133491. private _light;
  133492. /**
  133493. * The light that the gizmo is attached to
  133494. */
  133495. set light(light: Nullable<Light>);
  133496. get light(): Nullable<Light>;
  133497. /**
  133498. * Gets the material used to render the light gizmo
  133499. */
  133500. get material(): StandardMaterial;
  133501. /**
  133502. * @hidden
  133503. * Updates the gizmo to match the attached mesh's position/rotation
  133504. */
  133505. protected _update(): void;
  133506. private static _Scale;
  133507. /**
  133508. * Creates the lines for a light mesh
  133509. */
  133510. private static _CreateLightLines;
  133511. /**
  133512. * Disposes of the light gizmo
  133513. */
  133514. dispose(): void;
  133515. private static _CreateHemisphericLightMesh;
  133516. private static _CreatePointLightMesh;
  133517. private static _CreateSpotLightMesh;
  133518. private static _CreateDirectionalLightMesh;
  133519. }
  133520. }
  133521. declare module BABYLON {
  133522. /**
  133523. * Gizmo that enables viewing a camera
  133524. */
  133525. export class CameraGizmo extends Gizmo {
  133526. private _cameraMesh;
  133527. private _cameraLinesMesh;
  133528. private _material;
  133529. /**
  133530. * Creates a CameraGizmo
  133531. * @param gizmoLayer The utility layer the gizmo will be added to
  133532. */
  133533. constructor(gizmoLayer?: UtilityLayerRenderer);
  133534. private _camera;
  133535. /** Gets or sets a boolean indicating if frustum lines must be rendered (true by default)) */
  133536. get displayFrustum(): boolean;
  133537. set displayFrustum(value: boolean);
  133538. /**
  133539. * The camera that the gizmo is attached to
  133540. */
  133541. set camera(camera: Nullable<Camera>);
  133542. get camera(): Nullable<Camera>;
  133543. /**
  133544. * Gets the material used to render the camera gizmo
  133545. */
  133546. get material(): StandardMaterial;
  133547. /**
  133548. * @hidden
  133549. * Updates the gizmo to match the attached mesh's position/rotation
  133550. */
  133551. protected _update(): void;
  133552. private static _Scale;
  133553. private _invProjection;
  133554. /**
  133555. * Disposes of the camera gizmo
  133556. */
  133557. dispose(): void;
  133558. private static _CreateCameraMesh;
  133559. private static _CreateCameraFrustum;
  133560. }
  133561. }
  133562. declare module BABYLON {
  133563. /** @hidden */
  133564. export var backgroundFragmentDeclaration: {
  133565. name: string;
  133566. shader: string;
  133567. };
  133568. }
  133569. declare module BABYLON {
  133570. /** @hidden */
  133571. export var backgroundUboDeclaration: {
  133572. name: string;
  133573. shader: string;
  133574. };
  133575. }
  133576. declare module BABYLON {
  133577. /** @hidden */
  133578. export var backgroundPixelShader: {
  133579. name: string;
  133580. shader: string;
  133581. };
  133582. }
  133583. declare module BABYLON {
  133584. /** @hidden */
  133585. export var backgroundVertexDeclaration: {
  133586. name: string;
  133587. shader: string;
  133588. };
  133589. }
  133590. declare module BABYLON {
  133591. /** @hidden */
  133592. export var backgroundVertexShader: {
  133593. name: string;
  133594. shader: string;
  133595. };
  133596. }
  133597. declare module BABYLON {
  133598. /**
  133599. * Background material used to create an efficient environement around your scene.
  133600. */
  133601. export class BackgroundMaterial extends PushMaterial {
  133602. /**
  133603. * Standard reflectance value at parallel view angle.
  133604. */
  133605. static StandardReflectance0: number;
  133606. /**
  133607. * Standard reflectance value at grazing angle.
  133608. */
  133609. static StandardReflectance90: number;
  133610. protected _primaryColor: Color3;
  133611. /**
  133612. * Key light Color (multiply against the environement texture)
  133613. */
  133614. primaryColor: Color3;
  133615. protected __perceptualColor: Nullable<Color3>;
  133616. /**
  133617. * Experimental Internal Use Only.
  133618. *
  133619. * Key light Color in "perceptual value" meaning the color you would like to see on screen.
  133620. * This acts as a helper to set the primary color to a more "human friendly" value.
  133621. * Conversion to linear space as well as exposure and tone mapping correction will be applied to keep the
  133622. * output color as close as possible from the chosen value.
  133623. * (This does not account for contrast color grading and color curves as they are considered post effect and not directly
  133624. * part of lighting setup.)
  133625. */
  133626. get _perceptualColor(): Nullable<Color3>;
  133627. set _perceptualColor(value: Nullable<Color3>);
  133628. protected _primaryColorShadowLevel: float;
  133629. /**
  133630. * Defines the level of the shadows (dark area of the reflection map) in order to help scaling the colors.
  133631. * The color opposite to the primary color is used at the level chosen to define what the black area would look.
  133632. */
  133633. get primaryColorShadowLevel(): float;
  133634. set primaryColorShadowLevel(value: float);
  133635. protected _primaryColorHighlightLevel: float;
  133636. /**
  133637. * Defines the level of the highliights (highlight area of the reflection map) in order to help scaling the colors.
  133638. * The primary color is used at the level chosen to define what the white area would look.
  133639. */
  133640. get primaryColorHighlightLevel(): float;
  133641. set primaryColorHighlightLevel(value: float);
  133642. protected _reflectionTexture: Nullable<BaseTexture>;
  133643. /**
  133644. * Reflection Texture used in the material.
  133645. * Should be author in a specific way for the best result (refer to the documentation).
  133646. */
  133647. reflectionTexture: Nullable<BaseTexture>;
  133648. protected _reflectionBlur: float;
  133649. /**
  133650. * Reflection Texture level of blur.
  133651. *
  133652. * Can be use to reuse an existing HDR Texture and target a specific LOD to prevent authoring the
  133653. * texture twice.
  133654. */
  133655. reflectionBlur: float;
  133656. protected _diffuseTexture: Nullable<BaseTexture>;
  133657. /**
  133658. * Diffuse Texture used in the material.
  133659. * Should be author in a specific way for the best result (refer to the documentation).
  133660. */
  133661. diffuseTexture: Nullable<BaseTexture>;
  133662. protected _shadowLights: Nullable<IShadowLight[]>;
  133663. /**
  133664. * Specify the list of lights casting shadow on the material.
  133665. * All scene shadow lights will be included if null.
  133666. */
  133667. shadowLights: Nullable<IShadowLight[]>;
  133668. protected _shadowLevel: float;
  133669. /**
  133670. * Helps adjusting the shadow to a softer level if required.
  133671. * 0 means black shadows and 1 means no shadows.
  133672. */
  133673. shadowLevel: float;
  133674. protected _sceneCenter: Vector3;
  133675. /**
  133676. * In case of opacity Fresnel or reflection falloff, this is use as a scene center.
  133677. * It is usually zero but might be interesting to modify according to your setup.
  133678. */
  133679. sceneCenter: Vector3;
  133680. protected _opacityFresnel: boolean;
  133681. /**
  133682. * This helps specifying that the material is falling off to the sky box at grazing angle.
  133683. * This helps ensuring a nice transition when the camera goes under the ground.
  133684. */
  133685. opacityFresnel: boolean;
  133686. protected _reflectionFresnel: boolean;
  133687. /**
  133688. * This helps specifying that the material is falling off from diffuse to the reflection texture at grazing angle.
  133689. * This helps adding a mirror texture on the ground.
  133690. */
  133691. reflectionFresnel: boolean;
  133692. protected _reflectionFalloffDistance: number;
  133693. /**
  133694. * This helps specifying the falloff radius off the reflection texture from the sceneCenter.
  133695. * This helps adding a nice falloff effect to the reflection if used as a mirror for instance.
  133696. */
  133697. reflectionFalloffDistance: number;
  133698. protected _reflectionAmount: number;
  133699. /**
  133700. * This specifies the weight of the reflection against the background in case of reflection Fresnel.
  133701. */
  133702. reflectionAmount: number;
  133703. protected _reflectionReflectance0: number;
  133704. /**
  133705. * This specifies the weight of the reflection at grazing angle.
  133706. */
  133707. reflectionReflectance0: number;
  133708. protected _reflectionReflectance90: number;
  133709. /**
  133710. * This specifies the weight of the reflection at a perpendicular point of view.
  133711. */
  133712. reflectionReflectance90: number;
  133713. /**
  133714. * Sets the reflection reflectance fresnel values according to the default standard
  133715. * empirically know to work well :-)
  133716. */
  133717. set reflectionStandardFresnelWeight(value: number);
  133718. protected _useRGBColor: boolean;
  133719. /**
  133720. * Helps to directly use the maps channels instead of their level.
  133721. */
  133722. useRGBColor: boolean;
  133723. protected _enableNoise: boolean;
  133724. /**
  133725. * This helps reducing the banding effect that could occur on the background.
  133726. */
  133727. enableNoise: boolean;
  133728. /**
  133729. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  133730. * Best used when trying to implement visual zoom effects like fish-eye or binoculars while not adjusting camera fov.
  133731. * Recommended to be keep at 1.0 except for special cases.
  133732. */
  133733. get fovMultiplier(): number;
  133734. set fovMultiplier(value: number);
  133735. private _fovMultiplier;
  133736. /**
  133737. * Enable the FOV adjustment feature controlled by fovMultiplier.
  133738. */
  133739. useEquirectangularFOV: boolean;
  133740. private _maxSimultaneousLights;
  133741. /**
  133742. * Number of Simultaneous lights allowed on the material.
  133743. */
  133744. maxSimultaneousLights: int;
  133745. private _shadowOnly;
  133746. /**
  133747. * Make the material only render shadows
  133748. */
  133749. shadowOnly: boolean;
  133750. /**
  133751. * Default configuration related to image processing available in the Background Material.
  133752. */
  133753. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  133754. /**
  133755. * Keep track of the image processing observer to allow dispose and replace.
  133756. */
  133757. private _imageProcessingObserver;
  133758. /**
  133759. * Attaches a new image processing configuration to the PBR Material.
  133760. * @param configuration (if null the scene configuration will be use)
  133761. */
  133762. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  133763. /**
  133764. * Gets the image processing configuration used either in this material.
  133765. */
  133766. get imageProcessingConfiguration(): Nullable<ImageProcessingConfiguration>;
  133767. /**
  133768. * Sets the Default image processing configuration used either in the this material.
  133769. *
  133770. * If sets to null, the scene one is in use.
  133771. */
  133772. set imageProcessingConfiguration(value: Nullable<ImageProcessingConfiguration>);
  133773. /**
  133774. * Gets wether the color curves effect is enabled.
  133775. */
  133776. get cameraColorCurvesEnabled(): boolean;
  133777. /**
  133778. * Sets wether the color curves effect is enabled.
  133779. */
  133780. set cameraColorCurvesEnabled(value: boolean);
  133781. /**
  133782. * Gets wether the color grading effect is enabled.
  133783. */
  133784. get cameraColorGradingEnabled(): boolean;
  133785. /**
  133786. * Gets wether the color grading effect is enabled.
  133787. */
  133788. set cameraColorGradingEnabled(value: boolean);
  133789. /**
  133790. * Gets wether tonemapping is enabled or not.
  133791. */
  133792. get cameraToneMappingEnabled(): boolean;
  133793. /**
  133794. * Sets wether tonemapping is enabled or not
  133795. */
  133796. set cameraToneMappingEnabled(value: boolean);
  133797. /**
  133798. * The camera exposure used on this material.
  133799. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  133800. * This corresponds to a photographic exposure.
  133801. */
  133802. get cameraExposure(): float;
  133803. /**
  133804. * The camera exposure used on this material.
  133805. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  133806. * This corresponds to a photographic exposure.
  133807. */
  133808. set cameraExposure(value: float);
  133809. /**
  133810. * Gets The camera contrast used on this material.
  133811. */
  133812. get cameraContrast(): float;
  133813. /**
  133814. * Sets The camera contrast used on this material.
  133815. */
  133816. set cameraContrast(value: float);
  133817. /**
  133818. * Gets the Color Grading 2D Lookup Texture.
  133819. */
  133820. get cameraColorGradingTexture(): Nullable<BaseTexture>;
  133821. /**
  133822. * Sets the Color Grading 2D Lookup Texture.
  133823. */
  133824. set cameraColorGradingTexture(value: Nullable<BaseTexture>);
  133825. /**
  133826. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  133827. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  133828. * 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;
  133829. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  133830. */
  133831. get cameraColorCurves(): Nullable<ColorCurves>;
  133832. /**
  133833. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  133834. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  133835. * 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;
  133836. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  133837. */
  133838. set cameraColorCurves(value: Nullable<ColorCurves>);
  133839. /**
  133840. * Due to a bug in iOS10, video tags (which are using the background material) are in BGR and not RGB.
  133841. * Setting this flag to true (not done automatically!) will convert it back to RGB.
  133842. */
  133843. switchToBGR: boolean;
  133844. private _renderTargets;
  133845. private _reflectionControls;
  133846. private _white;
  133847. private _primaryShadowColor;
  133848. private _primaryHighlightColor;
  133849. /**
  133850. * Instantiates a Background Material in the given scene
  133851. * @param name The friendly name of the material
  133852. * @param scene The scene to add the material to
  133853. */
  133854. constructor(name: string, scene: Scene);
  133855. /**
  133856. * Gets a boolean indicating that current material needs to register RTT
  133857. */
  133858. get hasRenderTargetTextures(): boolean;
  133859. /**
  133860. * The entire material has been created in order to prevent overdraw.
  133861. * @returns false
  133862. */
  133863. needAlphaTesting(): boolean;
  133864. /**
  133865. * The entire material has been created in order to prevent overdraw.
  133866. * @returns true if blending is enable
  133867. */
  133868. needAlphaBlending(): boolean;
  133869. /**
  133870. * Checks wether the material is ready to be rendered for a given mesh.
  133871. * @param mesh The mesh to render
  133872. * @param subMesh The submesh to check against
  133873. * @param useInstances Specify wether or not the material is used with instances
  133874. * @returns true if all the dependencies are ready (Textures, Effects...)
  133875. */
  133876. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  133877. /**
  133878. * Compute the primary color according to the chosen perceptual color.
  133879. */
  133880. private _computePrimaryColorFromPerceptualColor;
  133881. /**
  133882. * Compute the highlights and shadow colors according to their chosen levels.
  133883. */
  133884. private _computePrimaryColors;
  133885. /**
  133886. * Build the uniform buffer used in the material.
  133887. */
  133888. buildUniformLayout(): void;
  133889. /**
  133890. * Unbind the material.
  133891. */
  133892. unbind(): void;
  133893. /**
  133894. * Bind only the world matrix to the material.
  133895. * @param world The world matrix to bind.
  133896. */
  133897. bindOnlyWorldMatrix(world: Matrix): void;
  133898. /**
  133899. * Bind the material for a dedicated submeh (every used meshes will be considered opaque).
  133900. * @param world The world matrix to bind.
  133901. * @param subMesh The submesh to bind for.
  133902. */
  133903. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  133904. /**
  133905. * Checks to see if a texture is used in the material.
  133906. * @param texture - Base texture to use.
  133907. * @returns - Boolean specifying if a texture is used in the material.
  133908. */
  133909. hasTexture(texture: BaseTexture): boolean;
  133910. /**
  133911. * Dispose the material.
  133912. * @param forceDisposeEffect Force disposal of the associated effect.
  133913. * @param forceDisposeTextures Force disposal of the associated textures.
  133914. */
  133915. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  133916. /**
  133917. * Clones the material.
  133918. * @param name The cloned name.
  133919. * @returns The cloned material.
  133920. */
  133921. clone(name: string): BackgroundMaterial;
  133922. /**
  133923. * Serializes the current material to its JSON representation.
  133924. * @returns The JSON representation.
  133925. */
  133926. serialize(): any;
  133927. /**
  133928. * Gets the class name of the material
  133929. * @returns "BackgroundMaterial"
  133930. */
  133931. getClassName(): string;
  133932. /**
  133933. * Parse a JSON input to create back a background material.
  133934. * @param source The JSON data to parse
  133935. * @param scene The scene to create the parsed material in
  133936. * @param rootUrl The root url of the assets the material depends upon
  133937. * @returns the instantiated BackgroundMaterial.
  133938. */
  133939. static Parse(source: any, scene: Scene, rootUrl: string): BackgroundMaterial;
  133940. }
  133941. }
  133942. declare module BABYLON {
  133943. /**
  133944. * Represents the different options available during the creation of
  133945. * a Environment helper.
  133946. *
  133947. * This can control the default ground, skybox and image processing setup of your scene.
  133948. */
  133949. export interface IEnvironmentHelperOptions {
  133950. /**
  133951. * Specifies whether or not to create a ground.
  133952. * True by default.
  133953. */
  133954. createGround: boolean;
  133955. /**
  133956. * Specifies the ground size.
  133957. * 15 by default.
  133958. */
  133959. groundSize: number;
  133960. /**
  133961. * The texture used on the ground for the main color.
  133962. * Comes from the BabylonJS CDN by default.
  133963. *
  133964. * Remarks: Can be either a texture or a url.
  133965. */
  133966. groundTexture: string | BaseTexture;
  133967. /**
  133968. * The color mixed in the ground texture by default.
  133969. * BabylonJS clearColor by default.
  133970. */
  133971. groundColor: Color3;
  133972. /**
  133973. * Specifies the ground opacity.
  133974. * 1 by default.
  133975. */
  133976. groundOpacity: number;
  133977. /**
  133978. * Enables the ground to receive shadows.
  133979. * True by default.
  133980. */
  133981. enableGroundShadow: boolean;
  133982. /**
  133983. * Helps preventing the shadow to be fully black on the ground.
  133984. * 0.5 by default.
  133985. */
  133986. groundShadowLevel: number;
  133987. /**
  133988. * Creates a mirror texture attach to the ground.
  133989. * false by default.
  133990. */
  133991. enableGroundMirror: boolean;
  133992. /**
  133993. * Specifies the ground mirror size ratio.
  133994. * 0.3 by default as the default kernel is 64.
  133995. */
  133996. groundMirrorSizeRatio: number;
  133997. /**
  133998. * Specifies the ground mirror blur kernel size.
  133999. * 64 by default.
  134000. */
  134001. groundMirrorBlurKernel: number;
  134002. /**
  134003. * Specifies the ground mirror visibility amount.
  134004. * 1 by default
  134005. */
  134006. groundMirrorAmount: number;
  134007. /**
  134008. * Specifies the ground mirror reflectance weight.
  134009. * This uses the standard weight of the background material to setup the fresnel effect
  134010. * of the mirror.
  134011. * 1 by default.
  134012. */
  134013. groundMirrorFresnelWeight: number;
  134014. /**
  134015. * Specifies the ground mirror Falloff distance.
  134016. * This can helps reducing the size of the reflection.
  134017. * 0 by Default.
  134018. */
  134019. groundMirrorFallOffDistance: number;
  134020. /**
  134021. * Specifies the ground mirror texture type.
  134022. * Unsigned Int by Default.
  134023. */
  134024. groundMirrorTextureType: number;
  134025. /**
  134026. * Specifies a bias applied to the ground vertical position to prevent z-fighting with
  134027. * the shown objects.
  134028. */
  134029. groundYBias: number;
  134030. /**
  134031. * Specifies whether or not to create a skybox.
  134032. * True by default.
  134033. */
  134034. createSkybox: boolean;
  134035. /**
  134036. * Specifies the skybox size.
  134037. * 20 by default.
  134038. */
  134039. skyboxSize: number;
  134040. /**
  134041. * The texture used on the skybox for the main color.
  134042. * Comes from the BabylonJS CDN by default.
  134043. *
  134044. * Remarks: Can be either a texture or a url.
  134045. */
  134046. skyboxTexture: string | BaseTexture;
  134047. /**
  134048. * The color mixed in the skybox texture by default.
  134049. * BabylonJS clearColor by default.
  134050. */
  134051. skyboxColor: Color3;
  134052. /**
  134053. * The background rotation around the Y axis of the scene.
  134054. * This helps aligning the key lights of your scene with the background.
  134055. * 0 by default.
  134056. */
  134057. backgroundYRotation: number;
  134058. /**
  134059. * Compute automatically the size of the elements to best fit with the scene.
  134060. */
  134061. sizeAuto: boolean;
  134062. /**
  134063. * Default position of the rootMesh if autoSize is not true.
  134064. */
  134065. rootPosition: Vector3;
  134066. /**
  134067. * Sets up the image processing in the scene.
  134068. * true by default.
  134069. */
  134070. setupImageProcessing: boolean;
  134071. /**
  134072. * The texture used as your environment texture in the scene.
  134073. * Comes from the BabylonJS CDN by default and in use if setupImageProcessing is true.
  134074. *
  134075. * Remarks: Can be either a texture or a url.
  134076. */
  134077. environmentTexture: string | BaseTexture;
  134078. /**
  134079. * The value of the exposure to apply to the scene.
  134080. * 0.6 by default if setupImageProcessing is true.
  134081. */
  134082. cameraExposure: number;
  134083. /**
  134084. * The value of the contrast to apply to the scene.
  134085. * 1.6 by default if setupImageProcessing is true.
  134086. */
  134087. cameraContrast: number;
  134088. /**
  134089. * Specifies whether or not tonemapping should be enabled in the scene.
  134090. * true by default if setupImageProcessing is true.
  134091. */
  134092. toneMappingEnabled: boolean;
  134093. }
  134094. /**
  134095. * The Environment helper class can be used to add a fully featuread none expensive background to your scene.
  134096. * It includes by default a skybox and a ground relying on the BackgroundMaterial.
  134097. * It also helps with the default setup of your imageProcessing configuration.
  134098. */
  134099. export class EnvironmentHelper {
  134100. /**
  134101. * Default ground texture URL.
  134102. */
  134103. private static _groundTextureCDNUrl;
  134104. /**
  134105. * Default skybox texture URL.
  134106. */
  134107. private static _skyboxTextureCDNUrl;
  134108. /**
  134109. * Default environment texture URL.
  134110. */
  134111. private static _environmentTextureCDNUrl;
  134112. /**
  134113. * Creates the default options for the helper.
  134114. */
  134115. private static _getDefaultOptions;
  134116. private _rootMesh;
  134117. /**
  134118. * Gets the root mesh created by the helper.
  134119. */
  134120. get rootMesh(): Mesh;
  134121. private _skybox;
  134122. /**
  134123. * Gets the skybox created by the helper.
  134124. */
  134125. get skybox(): Nullable<Mesh>;
  134126. private _skyboxTexture;
  134127. /**
  134128. * Gets the skybox texture created by the helper.
  134129. */
  134130. get skyboxTexture(): Nullable<BaseTexture>;
  134131. private _skyboxMaterial;
  134132. /**
  134133. * Gets the skybox material created by the helper.
  134134. */
  134135. get skyboxMaterial(): Nullable<BackgroundMaterial>;
  134136. private _ground;
  134137. /**
  134138. * Gets the ground mesh created by the helper.
  134139. */
  134140. get ground(): Nullable<Mesh>;
  134141. private _groundTexture;
  134142. /**
  134143. * Gets the ground texture created by the helper.
  134144. */
  134145. get groundTexture(): Nullable<BaseTexture>;
  134146. private _groundMirror;
  134147. /**
  134148. * Gets the ground mirror created by the helper.
  134149. */
  134150. get groundMirror(): Nullable<MirrorTexture>;
  134151. /**
  134152. * Gets the ground mirror render list to helps pushing the meshes
  134153. * you wish in the ground reflection.
  134154. */
  134155. get groundMirrorRenderList(): Nullable<AbstractMesh[]>;
  134156. private _groundMaterial;
  134157. /**
  134158. * Gets the ground material created by the helper.
  134159. */
  134160. get groundMaterial(): Nullable<BackgroundMaterial>;
  134161. /**
  134162. * Stores the creation options.
  134163. */
  134164. private readonly _scene;
  134165. private _options;
  134166. /**
  134167. * This observable will be notified with any error during the creation of the environment,
  134168. * mainly texture creation errors.
  134169. */
  134170. onErrorObservable: Observable<{
  134171. message?: string;
  134172. exception?: any;
  134173. }>;
  134174. /**
  134175. * constructor
  134176. * @param options Defines the options we want to customize the helper
  134177. * @param scene The scene to add the material to
  134178. */
  134179. constructor(options: Partial<IEnvironmentHelperOptions>, scene: Scene);
  134180. /**
  134181. * Updates the background according to the new options
  134182. * @param options
  134183. */
  134184. updateOptions(options: Partial<IEnvironmentHelperOptions>): void;
  134185. /**
  134186. * Sets the primary color of all the available elements.
  134187. * @param color the main color to affect to the ground and the background
  134188. */
  134189. setMainColor(color: Color3): void;
  134190. /**
  134191. * Setup the image processing according to the specified options.
  134192. */
  134193. private _setupImageProcessing;
  134194. /**
  134195. * Setup the environment texture according to the specified options.
  134196. */
  134197. private _setupEnvironmentTexture;
  134198. /**
  134199. * Setup the background according to the specified options.
  134200. */
  134201. private _setupBackground;
  134202. /**
  134203. * Get the scene sizes according to the setup.
  134204. */
  134205. private _getSceneSize;
  134206. /**
  134207. * Setup the ground according to the specified options.
  134208. */
  134209. private _setupGround;
  134210. /**
  134211. * Setup the ground material according to the specified options.
  134212. */
  134213. private _setupGroundMaterial;
  134214. /**
  134215. * Setup the ground diffuse texture according to the specified options.
  134216. */
  134217. private _setupGroundDiffuseTexture;
  134218. /**
  134219. * Setup the ground mirror texture according to the specified options.
  134220. */
  134221. private _setupGroundMirrorTexture;
  134222. /**
  134223. * Setup the ground to receive the mirror texture.
  134224. */
  134225. private _setupMirrorInGroundMaterial;
  134226. /**
  134227. * Setup the skybox according to the specified options.
  134228. */
  134229. private _setupSkybox;
  134230. /**
  134231. * Setup the skybox material according to the specified options.
  134232. */
  134233. private _setupSkyboxMaterial;
  134234. /**
  134235. * Setup the skybox reflection texture according to the specified options.
  134236. */
  134237. private _setupSkyboxReflectionTexture;
  134238. private _errorHandler;
  134239. /**
  134240. * Dispose all the elements created by the Helper.
  134241. */
  134242. dispose(): void;
  134243. }
  134244. }
  134245. declare module BABYLON {
  134246. /**
  134247. * Display a 360 degree photo on an approximately spherical surface, useful for VR applications or skyboxes.
  134248. * As a subclass of TransformNode, this allow parenting to the camera with different locations in the scene.
  134249. * This class achieves its effect with a Texture and a correctly configured BackgroundMaterial on an inverted sphere.
  134250. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  134251. */
  134252. export class PhotoDome extends TransformNode {
  134253. /**
  134254. * Define the image as a Monoscopic panoramic 360 image.
  134255. */
  134256. static readonly MODE_MONOSCOPIC: number;
  134257. /**
  134258. * Define the image as a Stereoscopic TopBottom/OverUnder panoramic 360 image.
  134259. */
  134260. static readonly MODE_TOPBOTTOM: number;
  134261. /**
  134262. * Define the image as a Stereoscopic Side by Side panoramic 360 image.
  134263. */
  134264. static readonly MODE_SIDEBYSIDE: number;
  134265. private _useDirectMapping;
  134266. /**
  134267. * The texture being displayed on the sphere
  134268. */
  134269. protected _photoTexture: Texture;
  134270. /**
  134271. * Gets or sets the texture being displayed on the sphere
  134272. */
  134273. get photoTexture(): Texture;
  134274. set photoTexture(value: Texture);
  134275. /**
  134276. * Observable raised when an error occured while loading the 360 image
  134277. */
  134278. onLoadErrorObservable: Observable<string>;
  134279. /**
  134280. * The skybox material
  134281. */
  134282. protected _material: BackgroundMaterial;
  134283. /**
  134284. * The surface used for the skybox
  134285. */
  134286. protected _mesh: Mesh;
  134287. /**
  134288. * Gets the mesh used for the skybox.
  134289. */
  134290. get mesh(): Mesh;
  134291. /**
  134292. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  134293. * Also see the options.resolution property.
  134294. */
  134295. get fovMultiplier(): number;
  134296. set fovMultiplier(value: number);
  134297. private _imageMode;
  134298. /**
  134299. * Gets or set the current video mode for the video. It can be:
  134300. * * PhotoDome.MODE_MONOSCOPIC : Define the image as a Monoscopic panoramic 360 image.
  134301. * * PhotoDome.MODE_TOPBOTTOM : Define the image as a Stereoscopic TopBottom/OverUnder panoramic 360 image.
  134302. * * PhotoDome.MODE_SIDEBYSIDE : Define the image as a Stereoscopic Side by Side panoramic 360 image.
  134303. */
  134304. get imageMode(): number;
  134305. set imageMode(value: number);
  134306. /**
  134307. * Create an instance of this class and pass through the parameters to the relevant classes, Texture, StandardMaterial, and Mesh.
  134308. * @param name Element's name, child elements will append suffixes for their own names.
  134309. * @param urlsOfPhoto defines the url of the photo to display
  134310. * @param options defines an object containing optional or exposed sub element properties
  134311. * @param onError defines a callback called when an error occured while loading the texture
  134312. */
  134313. constructor(name: string, urlOfPhoto: string, options: {
  134314. resolution?: number;
  134315. size?: number;
  134316. useDirectMapping?: boolean;
  134317. faceForward?: boolean;
  134318. }, scene: Scene, onError?: Nullable<(message?: string, exception?: any) => void>);
  134319. private _onBeforeCameraRenderObserver;
  134320. private _changeImageMode;
  134321. /**
  134322. * Releases resources associated with this node.
  134323. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  134324. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  134325. */
  134326. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  134327. }
  134328. }
  134329. declare module BABYLON {
  134330. /**
  134331. * Class used to host RGBD texture specific utilities
  134332. */
  134333. export class RGBDTextureTools {
  134334. /**
  134335. * Expand the RGBD Texture from RGBD to Half Float if possible.
  134336. * @param texture the texture to expand.
  134337. */
  134338. static ExpandRGBDTexture(texture: Texture): void;
  134339. }
  134340. }
  134341. declare module BABYLON {
  134342. /**
  134343. * Class used to host texture specific utilities
  134344. */
  134345. export class BRDFTextureTools {
  134346. /**
  134347. * Prevents texture cache collision
  134348. */
  134349. private static _instanceNumber;
  134350. /**
  134351. * Gets a default environment BRDF for MS-BRDF Height Correlated BRDF
  134352. * @param scene defines the hosting scene
  134353. * @returns the environment BRDF texture
  134354. */
  134355. static GetEnvironmentBRDFTexture(scene: Scene): BaseTexture;
  134356. private static _environmentBRDFBase64Texture;
  134357. }
  134358. }
  134359. declare module BABYLON {
  134360. /**
  134361. * @hidden
  134362. */
  134363. export interface IMaterialClearCoatDefines {
  134364. CLEARCOAT: boolean;
  134365. CLEARCOAT_DEFAULTIOR: boolean;
  134366. CLEARCOAT_TEXTURE: boolean;
  134367. CLEARCOAT_TEXTUREDIRECTUV: number;
  134368. CLEARCOAT_BUMP: boolean;
  134369. CLEARCOAT_BUMPDIRECTUV: number;
  134370. CLEARCOAT_TINT: boolean;
  134371. CLEARCOAT_TINT_TEXTURE: boolean;
  134372. CLEARCOAT_TINT_TEXTUREDIRECTUV: number;
  134373. /** @hidden */
  134374. _areTexturesDirty: boolean;
  134375. }
  134376. /**
  134377. * Define the code related to the clear coat parameters of the pbr material.
  134378. */
  134379. export class PBRClearCoatConfiguration {
  134380. /**
  134381. * This defaults to 1.5 corresponding to a 0.04 f0 or a 4% reflectance at normal incidence
  134382. * The default fits with a polyurethane material.
  134383. */
  134384. private static readonly _DefaultIndexOfRefraction;
  134385. private _isEnabled;
  134386. /**
  134387. * Defines if the clear coat is enabled in the material.
  134388. */
  134389. isEnabled: boolean;
  134390. /**
  134391. * Defines the clear coat layer strength (between 0 and 1) it defaults to 1.
  134392. */
  134393. intensity: number;
  134394. /**
  134395. * Defines the clear coat layer roughness.
  134396. */
  134397. roughness: number;
  134398. private _indexOfRefraction;
  134399. /**
  134400. * Defines the index of refraction of the clear coat.
  134401. * This defaults to 1.5 corresponding to a 0.04 f0 or a 4% reflectance at normal incidence
  134402. * The default fits with a polyurethane material.
  134403. * Changing the default value is more performance intensive.
  134404. */
  134405. indexOfRefraction: number;
  134406. private _texture;
  134407. /**
  134408. * Stores the clear coat values in a texture.
  134409. */
  134410. texture: Nullable<BaseTexture>;
  134411. private _bumpTexture;
  134412. /**
  134413. * Define the clear coat specific bump texture.
  134414. */
  134415. bumpTexture: Nullable<BaseTexture>;
  134416. private _isTintEnabled;
  134417. /**
  134418. * Defines if the clear coat tint is enabled in the material.
  134419. */
  134420. isTintEnabled: boolean;
  134421. /**
  134422. * Defines the clear coat tint of the material.
  134423. * This is only use if tint is enabled
  134424. */
  134425. tintColor: Color3;
  134426. /**
  134427. * Defines the distance at which the tint color should be found in the
  134428. * clear coat media.
  134429. * This is only use if tint is enabled
  134430. */
  134431. tintColorAtDistance: number;
  134432. /**
  134433. * Defines the clear coat layer thickness.
  134434. * This is only use if tint is enabled
  134435. */
  134436. tintThickness: number;
  134437. private _tintTexture;
  134438. /**
  134439. * Stores the clear tint values in a texture.
  134440. * rgb is tint
  134441. * a is a thickness factor
  134442. */
  134443. tintTexture: Nullable<BaseTexture>;
  134444. /** @hidden */
  134445. private _internalMarkAllSubMeshesAsTexturesDirty;
  134446. /** @hidden */
  134447. _markAllSubMeshesAsTexturesDirty(): void;
  134448. /**
  134449. * Instantiate a new istance of clear coat configuration.
  134450. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  134451. */
  134452. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  134453. /**
  134454. * Gets wehter the submesh is ready to be used or not.
  134455. * @param defines the list of "defines" to update.
  134456. * @param scene defines the scene the material belongs to.
  134457. * @param engine defines the engine the material belongs to.
  134458. * @param disableBumpMap defines wether the material disables bump or not.
  134459. * @returns - boolean indicating that the submesh is ready or not.
  134460. */
  134461. isReadyForSubMesh(defines: IMaterialClearCoatDefines, scene: Scene, engine: Engine, disableBumpMap: boolean): boolean;
  134462. /**
  134463. * Checks to see if a texture is used in the material.
  134464. * @param defines the list of "defines" to update.
  134465. * @param scene defines the scene to the material belongs to.
  134466. */
  134467. prepareDefines(defines: IMaterialClearCoatDefines, scene: Scene): void;
  134468. /**
  134469. * Binds the material data.
  134470. * @param uniformBuffer defines the Uniform buffer to fill in.
  134471. * @param scene defines the scene the material belongs to.
  134472. * @param engine defines the engine the material belongs to.
  134473. * @param disableBumpMap defines wether the material disables bump or not.
  134474. * @param isFrozen defines wether the material is frozen or not.
  134475. * @param invertNormalMapX If sets to true, x component of normal map value will be inverted (x = 1.0 - x).
  134476. * @param invertNormalMapY If sets to true, y component of normal map value will be inverted (y = 1.0 - y).
  134477. */
  134478. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, engine: Engine, disableBumpMap: boolean, isFrozen: boolean, invertNormalMapX: boolean, invertNormalMapY: boolean): void;
  134479. /**
  134480. * Checks to see if a texture is used in the material.
  134481. * @param texture - Base texture to use.
  134482. * @returns - Boolean specifying if a texture is used in the material.
  134483. */
  134484. hasTexture(texture: BaseTexture): boolean;
  134485. /**
  134486. * Returns an array of the actively used textures.
  134487. * @param activeTextures Array of BaseTextures
  134488. */
  134489. getActiveTextures(activeTextures: BaseTexture[]): void;
  134490. /**
  134491. * Returns the animatable textures.
  134492. * @param animatables Array of animatable textures.
  134493. */
  134494. getAnimatables(animatables: IAnimatable[]): void;
  134495. /**
  134496. * Disposes the resources of the material.
  134497. * @param forceDisposeTextures - Forces the disposal of all textures.
  134498. */
  134499. dispose(forceDisposeTextures?: boolean): void;
  134500. /**
  134501. * Get the current class name of the texture useful for serialization or dynamic coding.
  134502. * @returns "PBRClearCoatConfiguration"
  134503. */
  134504. getClassName(): string;
  134505. /**
  134506. * Add fallbacks to the effect fallbacks list.
  134507. * @param defines defines the Base texture to use.
  134508. * @param fallbacks defines the current fallback list.
  134509. * @param currentRank defines the current fallback rank.
  134510. * @returns the new fallback rank.
  134511. */
  134512. static AddFallbacks(defines: IMaterialClearCoatDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  134513. /**
  134514. * Add the required uniforms to the current list.
  134515. * @param uniforms defines the current uniform list.
  134516. */
  134517. static AddUniforms(uniforms: string[]): void;
  134518. /**
  134519. * Add the required samplers to the current list.
  134520. * @param samplers defines the current sampler list.
  134521. */
  134522. static AddSamplers(samplers: string[]): void;
  134523. /**
  134524. * Add the required uniforms to the current buffer.
  134525. * @param uniformBuffer defines the current uniform buffer.
  134526. */
  134527. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  134528. /**
  134529. * Makes a duplicate of the current configuration into another one.
  134530. * @param clearCoatConfiguration define the config where to copy the info
  134531. */
  134532. copyTo(clearCoatConfiguration: PBRClearCoatConfiguration): void;
  134533. /**
  134534. * Serializes this clear coat configuration.
  134535. * @returns - An object with the serialized config.
  134536. */
  134537. serialize(): any;
  134538. /**
  134539. * Parses a anisotropy Configuration from a serialized object.
  134540. * @param source - Serialized object.
  134541. * @param scene Defines the scene we are parsing for
  134542. * @param rootUrl Defines the rootUrl to load from
  134543. */
  134544. parse(source: any, scene: Scene, rootUrl: string): void;
  134545. }
  134546. }
  134547. declare module BABYLON {
  134548. /**
  134549. * @hidden
  134550. */
  134551. export interface IMaterialAnisotropicDefines {
  134552. ANISOTROPIC: boolean;
  134553. ANISOTROPIC_TEXTURE: boolean;
  134554. ANISOTROPIC_TEXTUREDIRECTUV: number;
  134555. MAINUV1: boolean;
  134556. _areTexturesDirty: boolean;
  134557. _needUVs: boolean;
  134558. }
  134559. /**
  134560. * Define the code related to the anisotropic parameters of the pbr material.
  134561. */
  134562. export class PBRAnisotropicConfiguration {
  134563. private _isEnabled;
  134564. /**
  134565. * Defines if the anisotropy is enabled in the material.
  134566. */
  134567. isEnabled: boolean;
  134568. /**
  134569. * Defines the anisotropy strength (between 0 and 1) it defaults to 1.
  134570. */
  134571. intensity: number;
  134572. /**
  134573. * Defines if the effect is along the tangents, bitangents or in between.
  134574. * By default, the effect is "strectching" the highlights along the tangents.
  134575. */
  134576. direction: Vector2;
  134577. private _texture;
  134578. /**
  134579. * Stores the anisotropy values in a texture.
  134580. * rg is direction (like normal from -1 to 1)
  134581. * b is a intensity
  134582. */
  134583. texture: Nullable<BaseTexture>;
  134584. /** @hidden */
  134585. private _internalMarkAllSubMeshesAsTexturesDirty;
  134586. /** @hidden */
  134587. _markAllSubMeshesAsTexturesDirty(): void;
  134588. /**
  134589. * Instantiate a new istance of anisotropy configuration.
  134590. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  134591. */
  134592. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  134593. /**
  134594. * Specifies that the submesh is ready to be used.
  134595. * @param defines the list of "defines" to update.
  134596. * @param scene defines the scene the material belongs to.
  134597. * @returns - boolean indicating that the submesh is ready or not.
  134598. */
  134599. isReadyForSubMesh(defines: IMaterialAnisotropicDefines, scene: Scene): boolean;
  134600. /**
  134601. * Checks to see if a texture is used in the material.
  134602. * @param defines the list of "defines" to update.
  134603. * @param mesh the mesh we are preparing the defines for.
  134604. * @param scene defines the scene the material belongs to.
  134605. */
  134606. prepareDefines(defines: IMaterialAnisotropicDefines, mesh: AbstractMesh, scene: Scene): void;
  134607. /**
  134608. * Binds the material data.
  134609. * @param uniformBuffer defines the Uniform buffer to fill in.
  134610. * @param scene defines the scene the material belongs to.
  134611. * @param isFrozen defines wether the material is frozen or not.
  134612. */
  134613. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  134614. /**
  134615. * Checks to see if a texture is used in the material.
  134616. * @param texture - Base texture to use.
  134617. * @returns - Boolean specifying if a texture is used in the material.
  134618. */
  134619. hasTexture(texture: BaseTexture): boolean;
  134620. /**
  134621. * Returns an array of the actively used textures.
  134622. * @param activeTextures Array of BaseTextures
  134623. */
  134624. getActiveTextures(activeTextures: BaseTexture[]): void;
  134625. /**
  134626. * Returns the animatable textures.
  134627. * @param animatables Array of animatable textures.
  134628. */
  134629. getAnimatables(animatables: IAnimatable[]): void;
  134630. /**
  134631. * Disposes the resources of the material.
  134632. * @param forceDisposeTextures - Forces the disposal of all textures.
  134633. */
  134634. dispose(forceDisposeTextures?: boolean): void;
  134635. /**
  134636. * Get the current class name of the texture useful for serialization or dynamic coding.
  134637. * @returns "PBRAnisotropicConfiguration"
  134638. */
  134639. getClassName(): string;
  134640. /**
  134641. * Add fallbacks to the effect fallbacks list.
  134642. * @param defines defines the Base texture to use.
  134643. * @param fallbacks defines the current fallback list.
  134644. * @param currentRank defines the current fallback rank.
  134645. * @returns the new fallback rank.
  134646. */
  134647. static AddFallbacks(defines: IMaterialAnisotropicDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  134648. /**
  134649. * Add the required uniforms to the current list.
  134650. * @param uniforms defines the current uniform list.
  134651. */
  134652. static AddUniforms(uniforms: string[]): void;
  134653. /**
  134654. * Add the required uniforms to the current buffer.
  134655. * @param uniformBuffer defines the current uniform buffer.
  134656. */
  134657. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  134658. /**
  134659. * Add the required samplers to the current list.
  134660. * @param samplers defines the current sampler list.
  134661. */
  134662. static AddSamplers(samplers: string[]): void;
  134663. /**
  134664. * Makes a duplicate of the current configuration into another one.
  134665. * @param anisotropicConfiguration define the config where to copy the info
  134666. */
  134667. copyTo(anisotropicConfiguration: PBRAnisotropicConfiguration): void;
  134668. /**
  134669. * Serializes this anisotropy configuration.
  134670. * @returns - An object with the serialized config.
  134671. */
  134672. serialize(): any;
  134673. /**
  134674. * Parses a anisotropy Configuration from a serialized object.
  134675. * @param source - Serialized object.
  134676. * @param scene Defines the scene we are parsing for
  134677. * @param rootUrl Defines the rootUrl to load from
  134678. */
  134679. parse(source: any, scene: Scene, rootUrl: string): void;
  134680. }
  134681. }
  134682. declare module BABYLON {
  134683. /**
  134684. * @hidden
  134685. */
  134686. export interface IMaterialBRDFDefines {
  134687. BRDF_V_HEIGHT_CORRELATED: boolean;
  134688. MS_BRDF_ENERGY_CONSERVATION: boolean;
  134689. SPHERICAL_HARMONICS: boolean;
  134690. SPECULAR_GLOSSINESS_ENERGY_CONSERVATION: boolean;
  134691. /** @hidden */
  134692. _areMiscDirty: boolean;
  134693. }
  134694. /**
  134695. * Define the code related to the BRDF parameters of the pbr material.
  134696. */
  134697. export class PBRBRDFConfiguration {
  134698. /**
  134699. * Default value used for the energy conservation.
  134700. * This should only be changed to adapt to the type of texture in scene.environmentBRDFTexture.
  134701. */
  134702. static DEFAULT_USE_ENERGY_CONSERVATION: boolean;
  134703. /**
  134704. * Default value used for the Smith Visibility Height Correlated mode.
  134705. * This should only be changed to adapt to the type of texture in scene.environmentBRDFTexture.
  134706. */
  134707. static DEFAULT_USE_SMITH_VISIBILITY_HEIGHT_CORRELATED: boolean;
  134708. /**
  134709. * Default value used for the IBL diffuse part.
  134710. * This can help switching back to the polynomials mode globally which is a tiny bit
  134711. * less GPU intensive at the drawback of a lower quality.
  134712. */
  134713. static DEFAULT_USE_SPHERICAL_HARMONICS: boolean;
  134714. /**
  134715. * Default value used for activating energy conservation for the specular workflow.
  134716. * If activated, the albedo color is multiplied with (1. - maxChannel(specular color)).
  134717. * If deactivated, a material is only physically plausible, when (albedo color + specular color) < 1.
  134718. */
  134719. static DEFAULT_USE_SPECULAR_GLOSSINESS_INPUT_ENERGY_CONSERVATION: boolean;
  134720. private _useEnergyConservation;
  134721. /**
  134722. * Defines if the material uses energy conservation.
  134723. */
  134724. useEnergyConservation: boolean;
  134725. private _useSmithVisibilityHeightCorrelated;
  134726. /**
  134727. * LEGACY Mode set to false
  134728. * Defines if the material uses height smith correlated visibility term.
  134729. * If you intent to not use our default BRDF, you need to load a separate BRDF Texture for the PBR
  134730. * You can either load https://assets.babylonjs.com/environments/uncorrelatedBRDF.png
  134731. * or https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds to have more precision
  134732. * Not relying on height correlated will also disable energy conservation.
  134733. */
  134734. useSmithVisibilityHeightCorrelated: boolean;
  134735. private _useSphericalHarmonics;
  134736. /**
  134737. * LEGACY Mode set to false
  134738. * Defines if the material uses spherical harmonics vs spherical polynomials for the
  134739. * diffuse part of the IBL.
  134740. * The harmonics despite a tiny bigger cost has been proven to provide closer results
  134741. * to the ground truth.
  134742. */
  134743. useSphericalHarmonics: boolean;
  134744. private _useSpecularGlossinessInputEnergyConservation;
  134745. /**
  134746. * Defines if the material uses energy conservation, when the specular workflow is active.
  134747. * If activated, the albedo color is multiplied with (1. - maxChannel(specular color)).
  134748. * If deactivated, a material is only physically plausible, when (albedo color + specular color) < 1.
  134749. * In the deactivated case, the material author has to ensure energy conservation, for a physically plausible rendering.
  134750. */
  134751. useSpecularGlossinessInputEnergyConservation: boolean;
  134752. /** @hidden */
  134753. private _internalMarkAllSubMeshesAsMiscDirty;
  134754. /** @hidden */
  134755. _markAllSubMeshesAsMiscDirty(): void;
  134756. /**
  134757. * Instantiate a new istance of clear coat configuration.
  134758. * @param markAllSubMeshesAsMiscDirty Callback to flag the material to dirty
  134759. */
  134760. constructor(markAllSubMeshesAsMiscDirty: () => void);
  134761. /**
  134762. * Checks to see if a texture is used in the material.
  134763. * @param defines the list of "defines" to update.
  134764. */
  134765. prepareDefines(defines: IMaterialBRDFDefines): void;
  134766. /**
  134767. * Get the current class name of the texture useful for serialization or dynamic coding.
  134768. * @returns "PBRClearCoatConfiguration"
  134769. */
  134770. getClassName(): string;
  134771. /**
  134772. * Makes a duplicate of the current configuration into another one.
  134773. * @param brdfConfiguration define the config where to copy the info
  134774. */
  134775. copyTo(brdfConfiguration: PBRBRDFConfiguration): void;
  134776. /**
  134777. * Serializes this BRDF configuration.
  134778. * @returns - An object with the serialized config.
  134779. */
  134780. serialize(): any;
  134781. /**
  134782. * Parses a anisotropy Configuration from a serialized object.
  134783. * @param source - Serialized object.
  134784. * @param scene Defines the scene we are parsing for
  134785. * @param rootUrl Defines the rootUrl to load from
  134786. */
  134787. parse(source: any, scene: Scene, rootUrl: string): void;
  134788. }
  134789. }
  134790. declare module BABYLON {
  134791. /**
  134792. * @hidden
  134793. */
  134794. export interface IMaterialSheenDefines {
  134795. SHEEN: boolean;
  134796. SHEEN_TEXTURE: boolean;
  134797. SHEEN_TEXTUREDIRECTUV: number;
  134798. SHEEN_LINKWITHALBEDO: boolean;
  134799. SHEEN_ROUGHNESS: boolean;
  134800. SHEEN_ALBEDOSCALING: boolean;
  134801. /** @hidden */
  134802. _areTexturesDirty: boolean;
  134803. }
  134804. /**
  134805. * Define the code related to the Sheen parameters of the pbr material.
  134806. */
  134807. export class PBRSheenConfiguration {
  134808. private _isEnabled;
  134809. /**
  134810. * Defines if the material uses sheen.
  134811. */
  134812. isEnabled: boolean;
  134813. private _linkSheenWithAlbedo;
  134814. /**
  134815. * Defines if the sheen is linked to the sheen color.
  134816. */
  134817. linkSheenWithAlbedo: boolean;
  134818. /**
  134819. * Defines the sheen intensity.
  134820. */
  134821. intensity: number;
  134822. /**
  134823. * Defines the sheen color.
  134824. */
  134825. color: Color3;
  134826. private _texture;
  134827. /**
  134828. * Stores the sheen tint values in a texture.
  134829. * rgb is tint
  134830. * a is a intensity or roughness if roughness has been defined
  134831. */
  134832. texture: Nullable<BaseTexture>;
  134833. private _roughness;
  134834. /**
  134835. * Defines the sheen roughness.
  134836. * It is not taken into account if linkSheenWithAlbedo is true.
  134837. * To stay backward compatible, material roughness is used instead if sheen roughness = null
  134838. */
  134839. roughness: Nullable<number>;
  134840. private _albedoScaling;
  134841. /**
  134842. * If true, the sheen effect is layered above the base BRDF with the albedo-scaling technique.
  134843. * It allows the strength of the sheen effect to not depend on the base color of the material,
  134844. * making it easier to setup and tweak the effect
  134845. */
  134846. albedoScaling: boolean;
  134847. /** @hidden */
  134848. private _internalMarkAllSubMeshesAsTexturesDirty;
  134849. /** @hidden */
  134850. _markAllSubMeshesAsTexturesDirty(): void;
  134851. /**
  134852. * Instantiate a new istance of clear coat configuration.
  134853. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  134854. */
  134855. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  134856. /**
  134857. * Specifies that the submesh is ready to be used.
  134858. * @param defines the list of "defines" to update.
  134859. * @param scene defines the scene the material belongs to.
  134860. * @returns - boolean indicating that the submesh is ready or not.
  134861. */
  134862. isReadyForSubMesh(defines: IMaterialSheenDefines, scene: Scene): boolean;
  134863. /**
  134864. * Checks to see if a texture is used in the material.
  134865. * @param defines the list of "defines" to update.
  134866. * @param scene defines the scene the material belongs to.
  134867. */
  134868. prepareDefines(defines: IMaterialSheenDefines, scene: Scene): void;
  134869. /**
  134870. * Binds the material data.
  134871. * @param uniformBuffer defines the Uniform buffer to fill in.
  134872. * @param scene defines the scene the material belongs to.
  134873. * @param isFrozen defines wether the material is frozen or not.
  134874. */
  134875. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  134876. /**
  134877. * Checks to see if a texture is used in the material.
  134878. * @param texture - Base texture to use.
  134879. * @returns - Boolean specifying if a texture is used in the material.
  134880. */
  134881. hasTexture(texture: BaseTexture): boolean;
  134882. /**
  134883. * Returns an array of the actively used textures.
  134884. * @param activeTextures Array of BaseTextures
  134885. */
  134886. getActiveTextures(activeTextures: BaseTexture[]): void;
  134887. /**
  134888. * Returns the animatable textures.
  134889. * @param animatables Array of animatable textures.
  134890. */
  134891. getAnimatables(animatables: IAnimatable[]): void;
  134892. /**
  134893. * Disposes the resources of the material.
  134894. * @param forceDisposeTextures - Forces the disposal of all textures.
  134895. */
  134896. dispose(forceDisposeTextures?: boolean): void;
  134897. /**
  134898. * Get the current class name of the texture useful for serialization or dynamic coding.
  134899. * @returns "PBRSheenConfiguration"
  134900. */
  134901. getClassName(): string;
  134902. /**
  134903. * Add fallbacks to the effect fallbacks list.
  134904. * @param defines defines the Base texture to use.
  134905. * @param fallbacks defines the current fallback list.
  134906. * @param currentRank defines the current fallback rank.
  134907. * @returns the new fallback rank.
  134908. */
  134909. static AddFallbacks(defines: IMaterialSheenDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  134910. /**
  134911. * Add the required uniforms to the current list.
  134912. * @param uniforms defines the current uniform list.
  134913. */
  134914. static AddUniforms(uniforms: string[]): void;
  134915. /**
  134916. * Add the required uniforms to the current buffer.
  134917. * @param uniformBuffer defines the current uniform buffer.
  134918. */
  134919. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  134920. /**
  134921. * Add the required samplers to the current list.
  134922. * @param samplers defines the current sampler list.
  134923. */
  134924. static AddSamplers(samplers: string[]): void;
  134925. /**
  134926. * Makes a duplicate of the current configuration into another one.
  134927. * @param sheenConfiguration define the config where to copy the info
  134928. */
  134929. copyTo(sheenConfiguration: PBRSheenConfiguration): void;
  134930. /**
  134931. * Serializes this BRDF configuration.
  134932. * @returns - An object with the serialized config.
  134933. */
  134934. serialize(): any;
  134935. /**
  134936. * Parses a anisotropy Configuration from a serialized object.
  134937. * @param source - Serialized object.
  134938. * @param scene Defines the scene we are parsing for
  134939. * @param rootUrl Defines the rootUrl to load from
  134940. */
  134941. parse(source: any, scene: Scene, rootUrl: string): void;
  134942. }
  134943. }
  134944. declare module BABYLON {
  134945. /**
  134946. * @hidden
  134947. */
  134948. export interface IMaterialSubSurfaceDefines {
  134949. SUBSURFACE: boolean;
  134950. SS_REFRACTION: boolean;
  134951. SS_TRANSLUCENCY: boolean;
  134952. SS_SCATTERING: boolean;
  134953. SS_THICKNESSANDMASK_TEXTURE: boolean;
  134954. SS_THICKNESSANDMASK_TEXTUREDIRECTUV: number;
  134955. SS_REFRACTIONMAP_3D: boolean;
  134956. SS_REFRACTIONMAP_OPPOSITEZ: boolean;
  134957. SS_LODINREFRACTIONALPHA: boolean;
  134958. SS_GAMMAREFRACTION: boolean;
  134959. SS_RGBDREFRACTION: boolean;
  134960. SS_LINEARSPECULARREFRACTION: boolean;
  134961. SS_LINKREFRACTIONTOTRANSPARENCY: boolean;
  134962. SS_ALBEDOFORREFRACTIONTINT: boolean;
  134963. SS_MASK_FROM_THICKNESS_TEXTURE: boolean;
  134964. /** @hidden */
  134965. _areTexturesDirty: boolean;
  134966. }
  134967. /**
  134968. * Define the code related to the sub surface parameters of the pbr material.
  134969. */
  134970. export class PBRSubSurfaceConfiguration {
  134971. private _isRefractionEnabled;
  134972. /**
  134973. * Defines if the refraction is enabled in the material.
  134974. */
  134975. isRefractionEnabled: boolean;
  134976. private _isTranslucencyEnabled;
  134977. /**
  134978. * Defines if the translucency is enabled in the material.
  134979. */
  134980. isTranslucencyEnabled: boolean;
  134981. private _isScatteringEnabled;
  134982. /**
  134983. * Defines if the sub surface scattering is enabled in the material.
  134984. */
  134985. isScatteringEnabled: boolean;
  134986. private _scatteringDiffusionProfileIndex;
  134987. /**
  134988. * Diffusion profile for subsurface scattering.
  134989. * Useful for better scattering in the skins or foliages.
  134990. */
  134991. get scatteringDiffusionProfile(): Nullable<Color3>;
  134992. set scatteringDiffusionProfile(c: Nullable<Color3>);
  134993. /**
  134994. * Defines the refraction intensity of the material.
  134995. * The refraction when enabled replaces the Diffuse part of the material.
  134996. * The intensity helps transitionning between diffuse and refraction.
  134997. */
  134998. refractionIntensity: number;
  134999. /**
  135000. * Defines the translucency intensity of the material.
  135001. * When translucency has been enabled, this defines how much of the "translucency"
  135002. * is addded to the diffuse part of the material.
  135003. */
  135004. translucencyIntensity: number;
  135005. /**
  135006. * When enabled, transparent surfaces will be tinted with the albedo colour (independent of thickness)
  135007. */
  135008. useAlbedoToTintRefraction: boolean;
  135009. private _thicknessTexture;
  135010. /**
  135011. * Stores the average thickness of a mesh in a texture (The texture is holding the values linearly).
  135012. * The red channel of the texture should contain the thickness remapped between 0 and 1.
  135013. * 0 would mean minimumThickness
  135014. * 1 would mean maximumThickness
  135015. * The other channels might be use as a mask to vary the different effects intensity.
  135016. */
  135017. thicknessTexture: Nullable<BaseTexture>;
  135018. private _refractionTexture;
  135019. /**
  135020. * Defines the texture to use for refraction.
  135021. */
  135022. refractionTexture: Nullable<BaseTexture>;
  135023. private _indexOfRefraction;
  135024. /**
  135025. * Index of refraction of the material base layer.
  135026. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  135027. *
  135028. * This does not only impact refraction but also the Base F0 of Dielectric Materials.
  135029. *
  135030. * From dielectric fresnel rules: F0 = square((iorT - iorI) / (iorT + iorI))
  135031. */
  135032. indexOfRefraction: number;
  135033. private _volumeIndexOfRefraction;
  135034. /**
  135035. * Index of refraction of the material's volume.
  135036. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  135037. *
  135038. * This ONLY impacts refraction. If not provided or given a non-valid value,
  135039. * the volume will use the same IOR as the surface.
  135040. */
  135041. get volumeIndexOfRefraction(): number;
  135042. set volumeIndexOfRefraction(value: number);
  135043. private _invertRefractionY;
  135044. /**
  135045. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  135046. */
  135047. invertRefractionY: boolean;
  135048. private _linkRefractionWithTransparency;
  135049. /**
  135050. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  135051. * Materials half opaque for instance using refraction could benefit from this control.
  135052. */
  135053. linkRefractionWithTransparency: boolean;
  135054. /**
  135055. * Defines the minimum thickness stored in the thickness map.
  135056. * If no thickness map is defined, this value will be used to simulate thickness.
  135057. */
  135058. minimumThickness: number;
  135059. /**
  135060. * Defines the maximum thickness stored in the thickness map.
  135061. */
  135062. maximumThickness: number;
  135063. /**
  135064. * Defines the volume tint of the material.
  135065. * This is used for both translucency and scattering.
  135066. */
  135067. tintColor: Color3;
  135068. /**
  135069. * Defines the distance at which the tint color should be found in the media.
  135070. * This is used for refraction only.
  135071. */
  135072. tintColorAtDistance: number;
  135073. /**
  135074. * Defines how far each channel transmit through the media.
  135075. * It is defined as a color to simplify it selection.
  135076. */
  135077. diffusionDistance: Color3;
  135078. private _useMaskFromThicknessTexture;
  135079. /**
  135080. * Stores the intensity of the different subsurface effects in the thickness texture.
  135081. * * the green channel is the translucency intensity.
  135082. * * the blue channel is the scattering intensity.
  135083. * * the alpha channel is the refraction intensity.
  135084. */
  135085. useMaskFromThicknessTexture: boolean;
  135086. private _scene;
  135087. /** @hidden */
  135088. private _internalMarkAllSubMeshesAsTexturesDirty;
  135089. private _internalMarkScenePrePassDirty;
  135090. /** @hidden */
  135091. _markAllSubMeshesAsTexturesDirty(): void;
  135092. /** @hidden */
  135093. _markScenePrePassDirty(): void;
  135094. /**
  135095. * Instantiate a new istance of sub surface configuration.
  135096. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  135097. * @param markScenePrePassDirty Callback to flag the scene as prepass dirty
  135098. * @param scene The scene
  135099. */
  135100. constructor(markAllSubMeshesAsTexturesDirty: () => void, markScenePrePassDirty: () => void, scene: Scene);
  135101. /**
  135102. * Gets wehter the submesh is ready to be used or not.
  135103. * @param defines the list of "defines" to update.
  135104. * @param scene defines the scene the material belongs to.
  135105. * @returns - boolean indicating that the submesh is ready or not.
  135106. */
  135107. isReadyForSubMesh(defines: IMaterialSubSurfaceDefines, scene: Scene): boolean;
  135108. /**
  135109. * Checks to see if a texture is used in the material.
  135110. * @param defines the list of "defines" to update.
  135111. * @param scene defines the scene to the material belongs to.
  135112. */
  135113. prepareDefines(defines: IMaterialSubSurfaceDefines, scene: Scene): void;
  135114. /**
  135115. * Binds the material data.
  135116. * @param uniformBuffer defines the Uniform buffer to fill in.
  135117. * @param scene defines the scene the material belongs to.
  135118. * @param engine defines the engine the material belongs to.
  135119. * @param isFrozen defines whether the material is frozen or not.
  135120. * @param lodBasedMicrosurface defines whether the material relies on lod based microsurface or not.
  135121. * @param realTimeFiltering defines whether the textures should be filtered on the fly.
  135122. */
  135123. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, engine: Engine, isFrozen: boolean, lodBasedMicrosurface: boolean, realTimeFiltering: boolean): void;
  135124. /**
  135125. * Unbinds the material from the mesh.
  135126. * @param activeEffect defines the effect that should be unbound from.
  135127. * @returns true if unbound, otherwise false
  135128. */
  135129. unbind(activeEffect: Effect): boolean;
  135130. /**
  135131. * Returns the texture used for refraction or null if none is used.
  135132. * @param scene defines the scene the material belongs to.
  135133. * @returns - Refraction texture if present. If no refraction texture and refraction
  135134. * is linked with transparency, returns environment texture. Otherwise, returns null.
  135135. */
  135136. private _getRefractionTexture;
  135137. /**
  135138. * Returns true if alpha blending should be disabled.
  135139. */
  135140. get disableAlphaBlending(): boolean;
  135141. /**
  135142. * Fills the list of render target textures.
  135143. * @param renderTargets the list of render targets to update
  135144. */
  135145. fillRenderTargetTextures(renderTargets: SmartArray<RenderTargetTexture>): void;
  135146. /**
  135147. * Checks to see if a texture is used in the material.
  135148. * @param texture - Base texture to use.
  135149. * @returns - Boolean specifying if a texture is used in the material.
  135150. */
  135151. hasTexture(texture: BaseTexture): boolean;
  135152. /**
  135153. * Gets a boolean indicating that current material needs to register RTT
  135154. * @returns true if this uses a render target otherwise false.
  135155. */
  135156. hasRenderTargetTextures(): boolean;
  135157. /**
  135158. * Returns an array of the actively used textures.
  135159. * @param activeTextures Array of BaseTextures
  135160. */
  135161. getActiveTextures(activeTextures: BaseTexture[]): void;
  135162. /**
  135163. * Returns the animatable textures.
  135164. * @param animatables Array of animatable textures.
  135165. */
  135166. getAnimatables(animatables: IAnimatable[]): void;
  135167. /**
  135168. * Disposes the resources of the material.
  135169. * @param forceDisposeTextures - Forces the disposal of all textures.
  135170. */
  135171. dispose(forceDisposeTextures?: boolean): void;
  135172. /**
  135173. * Get the current class name of the texture useful for serialization or dynamic coding.
  135174. * @returns "PBRSubSurfaceConfiguration"
  135175. */
  135176. getClassName(): string;
  135177. /**
  135178. * Add fallbacks to the effect fallbacks list.
  135179. * @param defines defines the Base texture to use.
  135180. * @param fallbacks defines the current fallback list.
  135181. * @param currentRank defines the current fallback rank.
  135182. * @returns the new fallback rank.
  135183. */
  135184. static AddFallbacks(defines: IMaterialSubSurfaceDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  135185. /**
  135186. * Add the required uniforms to the current list.
  135187. * @param uniforms defines the current uniform list.
  135188. */
  135189. static AddUniforms(uniforms: string[]): void;
  135190. /**
  135191. * Add the required samplers to the current list.
  135192. * @param samplers defines the current sampler list.
  135193. */
  135194. static AddSamplers(samplers: string[]): void;
  135195. /**
  135196. * Add the required uniforms to the current buffer.
  135197. * @param uniformBuffer defines the current uniform buffer.
  135198. */
  135199. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  135200. /**
  135201. * Makes a duplicate of the current configuration into another one.
  135202. * @param configuration define the config where to copy the info
  135203. */
  135204. copyTo(configuration: PBRSubSurfaceConfiguration): void;
  135205. /**
  135206. * Serializes this Sub Surface configuration.
  135207. * @returns - An object with the serialized config.
  135208. */
  135209. serialize(): any;
  135210. /**
  135211. * Parses a anisotropy Configuration from a serialized object.
  135212. * @param source - Serialized object.
  135213. * @param scene Defines the scene we are parsing for
  135214. * @param rootUrl Defines the rootUrl to load from
  135215. */
  135216. parse(source: any, scene: Scene, rootUrl: string): void;
  135217. }
  135218. }
  135219. declare module BABYLON {
  135220. /** @hidden */
  135221. export var pbrFragmentDeclaration: {
  135222. name: string;
  135223. shader: string;
  135224. };
  135225. }
  135226. declare module BABYLON {
  135227. /** @hidden */
  135228. export var pbrUboDeclaration: {
  135229. name: string;
  135230. shader: string;
  135231. };
  135232. }
  135233. declare module BABYLON {
  135234. /** @hidden */
  135235. export var pbrFragmentExtraDeclaration: {
  135236. name: string;
  135237. shader: string;
  135238. };
  135239. }
  135240. declare module BABYLON {
  135241. /** @hidden */
  135242. export var pbrFragmentSamplersDeclaration: {
  135243. name: string;
  135244. shader: string;
  135245. };
  135246. }
  135247. declare module BABYLON {
  135248. /** @hidden */
  135249. export var importanceSampling: {
  135250. name: string;
  135251. shader: string;
  135252. };
  135253. }
  135254. declare module BABYLON {
  135255. /** @hidden */
  135256. export var pbrHelperFunctions: {
  135257. name: string;
  135258. shader: string;
  135259. };
  135260. }
  135261. declare module BABYLON {
  135262. /** @hidden */
  135263. export var harmonicsFunctions: {
  135264. name: string;
  135265. shader: string;
  135266. };
  135267. }
  135268. declare module BABYLON {
  135269. /** @hidden */
  135270. export var pbrDirectLightingSetupFunctions: {
  135271. name: string;
  135272. shader: string;
  135273. };
  135274. }
  135275. declare module BABYLON {
  135276. /** @hidden */
  135277. export var pbrDirectLightingFalloffFunctions: {
  135278. name: string;
  135279. shader: string;
  135280. };
  135281. }
  135282. declare module BABYLON {
  135283. /** @hidden */
  135284. export var pbrBRDFFunctions: {
  135285. name: string;
  135286. shader: string;
  135287. };
  135288. }
  135289. declare module BABYLON {
  135290. /** @hidden */
  135291. export var hdrFilteringFunctions: {
  135292. name: string;
  135293. shader: string;
  135294. };
  135295. }
  135296. declare module BABYLON {
  135297. /** @hidden */
  135298. export var pbrDirectLightingFunctions: {
  135299. name: string;
  135300. shader: string;
  135301. };
  135302. }
  135303. declare module BABYLON {
  135304. /** @hidden */
  135305. export var pbrIBLFunctions: {
  135306. name: string;
  135307. shader: string;
  135308. };
  135309. }
  135310. declare module BABYLON {
  135311. /** @hidden */
  135312. export var pbrBlockAlbedoOpacity: {
  135313. name: string;
  135314. shader: string;
  135315. };
  135316. }
  135317. declare module BABYLON {
  135318. /** @hidden */
  135319. export var pbrBlockReflectivity: {
  135320. name: string;
  135321. shader: string;
  135322. };
  135323. }
  135324. declare module BABYLON {
  135325. /** @hidden */
  135326. export var pbrBlockAmbientOcclusion: {
  135327. name: string;
  135328. shader: string;
  135329. };
  135330. }
  135331. declare module BABYLON {
  135332. /** @hidden */
  135333. export var pbrBlockAlphaFresnel: {
  135334. name: string;
  135335. shader: string;
  135336. };
  135337. }
  135338. declare module BABYLON {
  135339. /** @hidden */
  135340. export var pbrBlockAnisotropic: {
  135341. name: string;
  135342. shader: string;
  135343. };
  135344. }
  135345. declare module BABYLON {
  135346. /** @hidden */
  135347. export var pbrBlockReflection: {
  135348. name: string;
  135349. shader: string;
  135350. };
  135351. }
  135352. declare module BABYLON {
  135353. /** @hidden */
  135354. export var pbrBlockSheen: {
  135355. name: string;
  135356. shader: string;
  135357. };
  135358. }
  135359. declare module BABYLON {
  135360. /** @hidden */
  135361. export var pbrBlockClearcoat: {
  135362. name: string;
  135363. shader: string;
  135364. };
  135365. }
  135366. declare module BABYLON {
  135367. /** @hidden */
  135368. export var pbrBlockSubSurface: {
  135369. name: string;
  135370. shader: string;
  135371. };
  135372. }
  135373. declare module BABYLON {
  135374. /** @hidden */
  135375. export var pbrBlockNormalGeometric: {
  135376. name: string;
  135377. shader: string;
  135378. };
  135379. }
  135380. declare module BABYLON {
  135381. /** @hidden */
  135382. export var pbrBlockNormalFinal: {
  135383. name: string;
  135384. shader: string;
  135385. };
  135386. }
  135387. declare module BABYLON {
  135388. /** @hidden */
  135389. export var pbrBlockLightmapInit: {
  135390. name: string;
  135391. shader: string;
  135392. };
  135393. }
  135394. declare module BABYLON {
  135395. /** @hidden */
  135396. export var pbrBlockGeometryInfo: {
  135397. name: string;
  135398. shader: string;
  135399. };
  135400. }
  135401. declare module BABYLON {
  135402. /** @hidden */
  135403. export var pbrBlockReflectance0: {
  135404. name: string;
  135405. shader: string;
  135406. };
  135407. }
  135408. declare module BABYLON {
  135409. /** @hidden */
  135410. export var pbrBlockReflectance: {
  135411. name: string;
  135412. shader: string;
  135413. };
  135414. }
  135415. declare module BABYLON {
  135416. /** @hidden */
  135417. export var pbrBlockDirectLighting: {
  135418. name: string;
  135419. shader: string;
  135420. };
  135421. }
  135422. declare module BABYLON {
  135423. /** @hidden */
  135424. export var pbrBlockFinalLitComponents: {
  135425. name: string;
  135426. shader: string;
  135427. };
  135428. }
  135429. declare module BABYLON {
  135430. /** @hidden */
  135431. export var pbrBlockFinalUnlitComponents: {
  135432. name: string;
  135433. shader: string;
  135434. };
  135435. }
  135436. declare module BABYLON {
  135437. /** @hidden */
  135438. export var pbrBlockFinalColorComposition: {
  135439. name: string;
  135440. shader: string;
  135441. };
  135442. }
  135443. declare module BABYLON {
  135444. /** @hidden */
  135445. export var pbrBlockImageProcessing: {
  135446. name: string;
  135447. shader: string;
  135448. };
  135449. }
  135450. declare module BABYLON {
  135451. /** @hidden */
  135452. export var pbrDebug: {
  135453. name: string;
  135454. shader: string;
  135455. };
  135456. }
  135457. declare module BABYLON {
  135458. /** @hidden */
  135459. export var pbrPixelShader: {
  135460. name: string;
  135461. shader: string;
  135462. };
  135463. }
  135464. declare module BABYLON {
  135465. /** @hidden */
  135466. export var pbrVertexDeclaration: {
  135467. name: string;
  135468. shader: string;
  135469. };
  135470. }
  135471. declare module BABYLON {
  135472. /** @hidden */
  135473. export var pbrVertexShader: {
  135474. name: string;
  135475. shader: string;
  135476. };
  135477. }
  135478. declare module BABYLON {
  135479. /**
  135480. * Manages the defines for the PBR Material.
  135481. * @hidden
  135482. */
  135483. export class PBRMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines, IMaterialClearCoatDefines, IMaterialAnisotropicDefines, IMaterialBRDFDefines, IMaterialSheenDefines, IMaterialSubSurfaceDefines, IMaterialDetailMapDefines {
  135484. PBR: boolean;
  135485. NUM_SAMPLES: string;
  135486. REALTIME_FILTERING: boolean;
  135487. MAINUV1: boolean;
  135488. MAINUV2: boolean;
  135489. UV1: boolean;
  135490. UV2: boolean;
  135491. ALBEDO: boolean;
  135492. GAMMAALBEDO: boolean;
  135493. ALBEDODIRECTUV: number;
  135494. VERTEXCOLOR: boolean;
  135495. DETAIL: boolean;
  135496. DETAILDIRECTUV: number;
  135497. DETAIL_NORMALBLENDMETHOD: number;
  135498. AMBIENT: boolean;
  135499. AMBIENTDIRECTUV: number;
  135500. AMBIENTINGRAYSCALE: boolean;
  135501. OPACITY: boolean;
  135502. VERTEXALPHA: boolean;
  135503. OPACITYDIRECTUV: number;
  135504. OPACITYRGB: boolean;
  135505. ALPHATEST: boolean;
  135506. DEPTHPREPASS: boolean;
  135507. ALPHABLEND: boolean;
  135508. ALPHAFROMALBEDO: boolean;
  135509. ALPHATESTVALUE: string;
  135510. SPECULAROVERALPHA: boolean;
  135511. RADIANCEOVERALPHA: boolean;
  135512. ALPHAFRESNEL: boolean;
  135513. LINEARALPHAFRESNEL: boolean;
  135514. PREMULTIPLYALPHA: boolean;
  135515. EMISSIVE: boolean;
  135516. EMISSIVEDIRECTUV: number;
  135517. REFLECTIVITY: boolean;
  135518. REFLECTIVITYDIRECTUV: number;
  135519. SPECULARTERM: boolean;
  135520. MICROSURFACEFROMREFLECTIVITYMAP: boolean;
  135521. MICROSURFACEAUTOMATIC: boolean;
  135522. LODBASEDMICROSFURACE: boolean;
  135523. MICROSURFACEMAP: boolean;
  135524. MICROSURFACEMAPDIRECTUV: number;
  135525. METALLICWORKFLOW: boolean;
  135526. ROUGHNESSSTOREINMETALMAPALPHA: boolean;
  135527. ROUGHNESSSTOREINMETALMAPGREEN: boolean;
  135528. METALLNESSSTOREINMETALMAPBLUE: boolean;
  135529. AOSTOREINMETALMAPRED: boolean;
  135530. METALLIC_REFLECTANCE: boolean;
  135531. METALLIC_REFLECTANCEDIRECTUV: number;
  135532. ENVIRONMENTBRDF: boolean;
  135533. ENVIRONMENTBRDF_RGBD: boolean;
  135534. NORMAL: boolean;
  135535. TANGENT: boolean;
  135536. BUMP: boolean;
  135537. BUMPDIRECTUV: number;
  135538. OBJECTSPACE_NORMALMAP: boolean;
  135539. PARALLAX: boolean;
  135540. PARALLAXOCCLUSION: boolean;
  135541. NORMALXYSCALE: boolean;
  135542. LIGHTMAP: boolean;
  135543. LIGHTMAPDIRECTUV: number;
  135544. USELIGHTMAPASSHADOWMAP: boolean;
  135545. GAMMALIGHTMAP: boolean;
  135546. RGBDLIGHTMAP: boolean;
  135547. REFLECTION: boolean;
  135548. REFLECTIONMAP_3D: boolean;
  135549. REFLECTIONMAP_SPHERICAL: boolean;
  135550. REFLECTIONMAP_PLANAR: boolean;
  135551. REFLECTIONMAP_CUBIC: boolean;
  135552. USE_LOCAL_REFLECTIONMAP_CUBIC: boolean;
  135553. REFLECTIONMAP_PROJECTION: boolean;
  135554. REFLECTIONMAP_SKYBOX: boolean;
  135555. REFLECTIONMAP_EXPLICIT: boolean;
  135556. REFLECTIONMAP_EQUIRECTANGULAR: boolean;
  135557. REFLECTIONMAP_EQUIRECTANGULAR_FIXED: boolean;
  135558. REFLECTIONMAP_MIRROREDEQUIRECTANGULAR_FIXED: boolean;
  135559. INVERTCUBICMAP: boolean;
  135560. USESPHERICALFROMREFLECTIONMAP: boolean;
  135561. USEIRRADIANCEMAP: boolean;
  135562. SPHERICAL_HARMONICS: boolean;
  135563. USESPHERICALINVERTEX: boolean;
  135564. REFLECTIONMAP_OPPOSITEZ: boolean;
  135565. LODINREFLECTIONALPHA: boolean;
  135566. GAMMAREFLECTION: boolean;
  135567. RGBDREFLECTION: boolean;
  135568. LINEARSPECULARREFLECTION: boolean;
  135569. RADIANCEOCCLUSION: boolean;
  135570. HORIZONOCCLUSION: boolean;
  135571. INSTANCES: boolean;
  135572. THIN_INSTANCES: boolean;
  135573. PREPASS: boolean;
  135574. SCENE_MRT_COUNT: number;
  135575. NUM_BONE_INFLUENCERS: number;
  135576. BonesPerMesh: number;
  135577. BONETEXTURE: boolean;
  135578. NONUNIFORMSCALING: boolean;
  135579. MORPHTARGETS: boolean;
  135580. MORPHTARGETS_NORMAL: boolean;
  135581. MORPHTARGETS_TANGENT: boolean;
  135582. MORPHTARGETS_UV: boolean;
  135583. NUM_MORPH_INFLUENCERS: number;
  135584. IMAGEPROCESSING: boolean;
  135585. VIGNETTE: boolean;
  135586. VIGNETTEBLENDMODEMULTIPLY: boolean;
  135587. VIGNETTEBLENDMODEOPAQUE: boolean;
  135588. TONEMAPPING: boolean;
  135589. TONEMAPPING_ACES: boolean;
  135590. CONTRAST: boolean;
  135591. COLORCURVES: boolean;
  135592. COLORGRADING: boolean;
  135593. COLORGRADING3D: boolean;
  135594. SAMPLER3DGREENDEPTH: boolean;
  135595. SAMPLER3DBGRMAP: boolean;
  135596. IMAGEPROCESSINGPOSTPROCESS: boolean;
  135597. EXPOSURE: boolean;
  135598. MULTIVIEW: boolean;
  135599. USEPHYSICALLIGHTFALLOFF: boolean;
  135600. USEGLTFLIGHTFALLOFF: boolean;
  135601. TWOSIDEDLIGHTING: boolean;
  135602. SHADOWFLOAT: boolean;
  135603. CLIPPLANE: boolean;
  135604. CLIPPLANE2: boolean;
  135605. CLIPPLANE3: boolean;
  135606. CLIPPLANE4: boolean;
  135607. CLIPPLANE5: boolean;
  135608. CLIPPLANE6: boolean;
  135609. POINTSIZE: boolean;
  135610. FOG: boolean;
  135611. LOGARITHMICDEPTH: boolean;
  135612. FORCENORMALFORWARD: boolean;
  135613. SPECULARAA: boolean;
  135614. CLEARCOAT: boolean;
  135615. CLEARCOAT_DEFAULTIOR: boolean;
  135616. CLEARCOAT_TEXTURE: boolean;
  135617. CLEARCOAT_TEXTUREDIRECTUV: number;
  135618. CLEARCOAT_BUMP: boolean;
  135619. CLEARCOAT_BUMPDIRECTUV: number;
  135620. CLEARCOAT_TINT: boolean;
  135621. CLEARCOAT_TINT_TEXTURE: boolean;
  135622. CLEARCOAT_TINT_TEXTUREDIRECTUV: number;
  135623. ANISOTROPIC: boolean;
  135624. ANISOTROPIC_TEXTURE: boolean;
  135625. ANISOTROPIC_TEXTUREDIRECTUV: number;
  135626. BRDF_V_HEIGHT_CORRELATED: boolean;
  135627. MS_BRDF_ENERGY_CONSERVATION: boolean;
  135628. SPECULAR_GLOSSINESS_ENERGY_CONSERVATION: boolean;
  135629. SHEEN: boolean;
  135630. SHEEN_TEXTURE: boolean;
  135631. SHEEN_TEXTUREDIRECTUV: number;
  135632. SHEEN_LINKWITHALBEDO: boolean;
  135633. SHEEN_ROUGHNESS: boolean;
  135634. SHEEN_ALBEDOSCALING: boolean;
  135635. SUBSURFACE: boolean;
  135636. SS_REFRACTION: boolean;
  135637. SS_TRANSLUCENCY: boolean;
  135638. SS_SCATTERING: boolean;
  135639. SS_THICKNESSANDMASK_TEXTURE: boolean;
  135640. SS_THICKNESSANDMASK_TEXTUREDIRECTUV: number;
  135641. SS_REFRACTIONMAP_3D: boolean;
  135642. SS_REFRACTIONMAP_OPPOSITEZ: boolean;
  135643. SS_LODINREFRACTIONALPHA: boolean;
  135644. SS_GAMMAREFRACTION: boolean;
  135645. SS_RGBDREFRACTION: boolean;
  135646. SS_LINEARSPECULARREFRACTION: boolean;
  135647. SS_LINKREFRACTIONTOTRANSPARENCY: boolean;
  135648. SS_ALBEDOFORREFRACTIONTINT: boolean;
  135649. SS_MASK_FROM_THICKNESS_TEXTURE: boolean;
  135650. UNLIT: boolean;
  135651. DEBUGMODE: number;
  135652. /**
  135653. * Initializes the PBR Material defines.
  135654. */
  135655. constructor();
  135656. /**
  135657. * Resets the PBR Material defines.
  135658. */
  135659. reset(): void;
  135660. }
  135661. /**
  135662. * The Physically based material base class of BJS.
  135663. *
  135664. * This offers the main features of a standard PBR material.
  135665. * For more information, please refer to the documentation :
  135666. * https://doc.babylonjs.com/how_to/physically_based_rendering
  135667. */
  135668. export abstract class PBRBaseMaterial extends PushMaterial {
  135669. /**
  135670. * PBRMaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  135671. */
  135672. static readonly PBRMATERIAL_OPAQUE: number;
  135673. /**
  135674. * PBRMaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  135675. */
  135676. static readonly PBRMATERIAL_ALPHATEST: number;
  135677. /**
  135678. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  135679. */
  135680. static readonly PBRMATERIAL_ALPHABLEND: number;
  135681. /**
  135682. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  135683. * They are also discarded below the alpha cutoff threshold to improve performances.
  135684. */
  135685. static readonly PBRMATERIAL_ALPHATESTANDBLEND: number;
  135686. /**
  135687. * Defines the default value of how much AO map is occluding the analytical lights
  135688. * (point spot...).
  135689. */
  135690. static DEFAULT_AO_ON_ANALYTICAL_LIGHTS: number;
  135691. /**
  135692. * PBRMaterialLightFalloff Physical: light is falling off following the inverse squared distance law.
  135693. */
  135694. static readonly LIGHTFALLOFF_PHYSICAL: number;
  135695. /**
  135696. * PBRMaterialLightFalloff gltf: light is falling off as described in the gltf moving to PBR document
  135697. * to enhance interoperability with other engines.
  135698. */
  135699. static readonly LIGHTFALLOFF_GLTF: number;
  135700. /**
  135701. * PBRMaterialLightFalloff Standard: light is falling off like in the standard material
  135702. * to enhance interoperability with other materials.
  135703. */
  135704. static readonly LIGHTFALLOFF_STANDARD: number;
  135705. /**
  135706. * Intensity of the direct lights e.g. the four lights available in your scene.
  135707. * This impacts both the direct diffuse and specular highlights.
  135708. */
  135709. protected _directIntensity: number;
  135710. /**
  135711. * Intensity of the emissive part of the material.
  135712. * This helps controlling the emissive effect without modifying the emissive color.
  135713. */
  135714. protected _emissiveIntensity: number;
  135715. /**
  135716. * Intensity of the environment e.g. how much the environment will light the object
  135717. * either through harmonics for rough material or through the refelction for shiny ones.
  135718. */
  135719. protected _environmentIntensity: number;
  135720. /**
  135721. * This is a special control allowing the reduction of the specular highlights coming from the
  135722. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  135723. */
  135724. protected _specularIntensity: number;
  135725. /**
  135726. * This stores the direct, emissive, environment, and specular light intensities into a Vector4.
  135727. */
  135728. private _lightingInfos;
  135729. /**
  135730. * Debug Control allowing disabling the bump map on this material.
  135731. */
  135732. protected _disableBumpMap: boolean;
  135733. /**
  135734. * AKA Diffuse Texture in standard nomenclature.
  135735. */
  135736. protected _albedoTexture: Nullable<BaseTexture>;
  135737. /**
  135738. * AKA Occlusion Texture in other nomenclature.
  135739. */
  135740. protected _ambientTexture: Nullable<BaseTexture>;
  135741. /**
  135742. * AKA Occlusion Texture Intensity in other nomenclature.
  135743. */
  135744. protected _ambientTextureStrength: number;
  135745. /**
  135746. * Defines how much the AO map is occluding the analytical lights (point spot...).
  135747. * 1 means it completely occludes it
  135748. * 0 mean it has no impact
  135749. */
  135750. protected _ambientTextureImpactOnAnalyticalLights: number;
  135751. /**
  135752. * Stores the alpha values in a texture.
  135753. */
  135754. protected _opacityTexture: Nullable<BaseTexture>;
  135755. /**
  135756. * Stores the reflection values in a texture.
  135757. */
  135758. protected _reflectionTexture: Nullable<BaseTexture>;
  135759. /**
  135760. * Stores the emissive values in a texture.
  135761. */
  135762. protected _emissiveTexture: Nullable<BaseTexture>;
  135763. /**
  135764. * AKA Specular texture in other nomenclature.
  135765. */
  135766. protected _reflectivityTexture: Nullable<BaseTexture>;
  135767. /**
  135768. * Used to switch from specular/glossiness to metallic/roughness workflow.
  135769. */
  135770. protected _metallicTexture: Nullable<BaseTexture>;
  135771. /**
  135772. * Specifies the metallic scalar of the metallic/roughness workflow.
  135773. * Can also be used to scale the metalness values of the metallic texture.
  135774. */
  135775. protected _metallic: Nullable<number>;
  135776. /**
  135777. * Specifies the roughness scalar of the metallic/roughness workflow.
  135778. * Can also be used to scale the roughness values of the metallic texture.
  135779. */
  135780. protected _roughness: Nullable<number>;
  135781. /**
  135782. * In metallic workflow, specifies an F0 factor to help configuring the material F0.
  135783. * By default the indexOfrefraction is used to compute F0;
  135784. *
  135785. * This is used as a factor against the default reflectance at normal incidence to tweak it.
  135786. *
  135787. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor;
  135788. * F90 = metallicReflectanceColor;
  135789. */
  135790. protected _metallicF0Factor: number;
  135791. /**
  135792. * In metallic workflow, specifies an F90 color to help configuring the material F90.
  135793. * By default the F90 is always 1;
  135794. *
  135795. * Please note that this factor is also used as a factor against the default reflectance at normal incidence.
  135796. *
  135797. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor
  135798. * F90 = metallicReflectanceColor;
  135799. */
  135800. protected _metallicReflectanceColor: Color3;
  135801. /**
  135802. * Defines to store metallicReflectanceColor in RGB and metallicF0Factor in A
  135803. * This is multiply against the scalar values defined in the material.
  135804. */
  135805. protected _metallicReflectanceTexture: Nullable<BaseTexture>;
  135806. /**
  135807. * Used to enable roughness/glossiness fetch from a separate channel depending on the current mode.
  135808. * Gray Scale represents roughness in metallic mode and glossiness in specular mode.
  135809. */
  135810. protected _microSurfaceTexture: Nullable<BaseTexture>;
  135811. /**
  135812. * Stores surface normal data used to displace a mesh in a texture.
  135813. */
  135814. protected _bumpTexture: Nullable<BaseTexture>;
  135815. /**
  135816. * Stores the pre-calculated light information of a mesh in a texture.
  135817. */
  135818. protected _lightmapTexture: Nullable<BaseTexture>;
  135819. /**
  135820. * The color of a material in ambient lighting.
  135821. */
  135822. protected _ambientColor: Color3;
  135823. /**
  135824. * AKA Diffuse Color in other nomenclature.
  135825. */
  135826. protected _albedoColor: Color3;
  135827. /**
  135828. * AKA Specular Color in other nomenclature.
  135829. */
  135830. protected _reflectivityColor: Color3;
  135831. /**
  135832. * The color applied when light is reflected from a material.
  135833. */
  135834. protected _reflectionColor: Color3;
  135835. /**
  135836. * The color applied when light is emitted from a material.
  135837. */
  135838. protected _emissiveColor: Color3;
  135839. /**
  135840. * AKA Glossiness in other nomenclature.
  135841. */
  135842. protected _microSurface: number;
  135843. /**
  135844. * Specifies that the material will use the light map as a show map.
  135845. */
  135846. protected _useLightmapAsShadowmap: boolean;
  135847. /**
  135848. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  135849. * makes the reflect vector face the model (under horizon).
  135850. */
  135851. protected _useHorizonOcclusion: boolean;
  135852. /**
  135853. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  135854. * too much the area relying on ambient texture to define their ambient occlusion.
  135855. */
  135856. protected _useRadianceOcclusion: boolean;
  135857. /**
  135858. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  135859. */
  135860. protected _useAlphaFromAlbedoTexture: boolean;
  135861. /**
  135862. * Specifies that the material will keeps the specular highlights over a transparent surface (only the most limunous ones).
  135863. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  135864. */
  135865. protected _useSpecularOverAlpha: boolean;
  135866. /**
  135867. * Specifies if the reflectivity texture contains the glossiness information in its alpha channel.
  135868. */
  135869. protected _useMicroSurfaceFromReflectivityMapAlpha: boolean;
  135870. /**
  135871. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  135872. */
  135873. protected _useRoughnessFromMetallicTextureAlpha: boolean;
  135874. /**
  135875. * Specifies if the metallic texture contains the roughness information in its green channel.
  135876. */
  135877. protected _useRoughnessFromMetallicTextureGreen: boolean;
  135878. /**
  135879. * Specifies if the metallic texture contains the metallness information in its blue channel.
  135880. */
  135881. protected _useMetallnessFromMetallicTextureBlue: boolean;
  135882. /**
  135883. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  135884. */
  135885. protected _useAmbientOcclusionFromMetallicTextureRed: boolean;
  135886. /**
  135887. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  135888. */
  135889. protected _useAmbientInGrayScale: boolean;
  135890. /**
  135891. * In case the reflectivity map does not contain the microsurface information in its alpha channel,
  135892. * The material will try to infer what glossiness each pixel should be.
  135893. */
  135894. protected _useAutoMicroSurfaceFromReflectivityMap: boolean;
  135895. /**
  135896. * Defines the falloff type used in this material.
  135897. * It by default is Physical.
  135898. */
  135899. protected _lightFalloff: number;
  135900. /**
  135901. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  135902. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  135903. */
  135904. protected _useRadianceOverAlpha: boolean;
  135905. /**
  135906. * Allows using an object space normal map (instead of tangent space).
  135907. */
  135908. protected _useObjectSpaceNormalMap: boolean;
  135909. /**
  135910. * Allows using the bump map in parallax mode.
  135911. */
  135912. protected _useParallax: boolean;
  135913. /**
  135914. * Allows using the bump map in parallax occlusion mode.
  135915. */
  135916. protected _useParallaxOcclusion: boolean;
  135917. /**
  135918. * Controls the scale bias of the parallax mode.
  135919. */
  135920. protected _parallaxScaleBias: number;
  135921. /**
  135922. * If sets to true, disables all the lights affecting the material.
  135923. */
  135924. protected _disableLighting: boolean;
  135925. /**
  135926. * Number of Simultaneous lights allowed on the material.
  135927. */
  135928. protected _maxSimultaneousLights: number;
  135929. /**
  135930. * If sets to true, x component of normal map value will be inverted (x = 1.0 - x).
  135931. */
  135932. protected _invertNormalMapX: boolean;
  135933. /**
  135934. * If sets to true, y component of normal map value will be inverted (y = 1.0 - y).
  135935. */
  135936. protected _invertNormalMapY: boolean;
  135937. /**
  135938. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  135939. */
  135940. protected _twoSidedLighting: boolean;
  135941. /**
  135942. * Defines the alpha limits in alpha test mode.
  135943. */
  135944. protected _alphaCutOff: number;
  135945. /**
  135946. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  135947. */
  135948. protected _forceAlphaTest: boolean;
  135949. /**
  135950. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  135951. * And/Or occlude the blended part. (alpha is converted to gamma to compute the fresnel)
  135952. */
  135953. protected _useAlphaFresnel: boolean;
  135954. /**
  135955. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  135956. * And/Or occlude the blended part. (alpha stays linear to compute the fresnel)
  135957. */
  135958. protected _useLinearAlphaFresnel: boolean;
  135959. /**
  135960. * Specifies the environment BRDF texture used to comput the scale and offset roughness values
  135961. * from cos thetav and roughness:
  135962. * http://blog.selfshadow.com/publications/s2013-shading-course/karis/s2013_pbs_epic_notes_v2.pdf
  135963. */
  135964. protected _environmentBRDFTexture: Nullable<BaseTexture>;
  135965. /**
  135966. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  135967. */
  135968. protected _forceIrradianceInFragment: boolean;
  135969. private _realTimeFiltering;
  135970. /**
  135971. * Enables realtime filtering on the texture.
  135972. */
  135973. get realTimeFiltering(): boolean;
  135974. set realTimeFiltering(b: boolean);
  135975. private _realTimeFilteringQuality;
  135976. /**
  135977. * Quality switch for realtime filtering
  135978. */
  135979. get realTimeFilteringQuality(): number;
  135980. set realTimeFilteringQuality(n: number);
  135981. /**
  135982. * Can this material render to several textures at once
  135983. */
  135984. get canRenderToMRT(): boolean;
  135985. /**
  135986. * Force normal to face away from face.
  135987. */
  135988. protected _forceNormalForward: boolean;
  135989. /**
  135990. * Enables specular anti aliasing in the PBR shader.
  135991. * It will both interacts on the Geometry for analytical and IBL lighting.
  135992. * It also prefilter the roughness map based on the bump values.
  135993. */
  135994. protected _enableSpecularAntiAliasing: boolean;
  135995. /**
  135996. * Default configuration related to image processing available in the PBR Material.
  135997. */
  135998. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  135999. /**
  136000. * Keep track of the image processing observer to allow dispose and replace.
  136001. */
  136002. private _imageProcessingObserver;
  136003. /**
  136004. * Attaches a new image processing configuration to the PBR Material.
  136005. * @param configuration
  136006. */
  136007. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  136008. /**
  136009. * Stores the available render targets.
  136010. */
  136011. private _renderTargets;
  136012. /**
  136013. * Sets the global ambient color for the material used in lighting calculations.
  136014. */
  136015. private _globalAmbientColor;
  136016. /**
  136017. * Enables the use of logarithmic depth buffers, which is good for wide depth buffers.
  136018. */
  136019. private _useLogarithmicDepth;
  136020. /**
  136021. * If set to true, no lighting calculations will be applied.
  136022. */
  136023. private _unlit;
  136024. private _debugMode;
  136025. /**
  136026. * @hidden
  136027. * This is reserved for the inspector.
  136028. * Defines the material debug mode.
  136029. * It helps seeing only some components of the material while troubleshooting.
  136030. */
  136031. debugMode: number;
  136032. /**
  136033. * @hidden
  136034. * This is reserved for the inspector.
  136035. * Specify from where on screen the debug mode should start.
  136036. * The value goes from -1 (full screen) to 1 (not visible)
  136037. * It helps with side by side comparison against the final render
  136038. * This defaults to -1
  136039. */
  136040. private debugLimit;
  136041. /**
  136042. * @hidden
  136043. * This is reserved for the inspector.
  136044. * As the default viewing range might not be enough (if the ambient is really small for instance)
  136045. * You can use the factor to better multiply the final value.
  136046. */
  136047. private debugFactor;
  136048. /**
  136049. * Defines the clear coat layer parameters for the material.
  136050. */
  136051. readonly clearCoat: PBRClearCoatConfiguration;
  136052. /**
  136053. * Defines the anisotropic parameters for the material.
  136054. */
  136055. readonly anisotropy: PBRAnisotropicConfiguration;
  136056. /**
  136057. * Defines the BRDF parameters for the material.
  136058. */
  136059. readonly brdf: PBRBRDFConfiguration;
  136060. /**
  136061. * Defines the Sheen parameters for the material.
  136062. */
  136063. readonly sheen: PBRSheenConfiguration;
  136064. /**
  136065. * Defines the SubSurface parameters for the material.
  136066. */
  136067. readonly subSurface: PBRSubSurfaceConfiguration;
  136068. /**
  136069. * Defines the detail map parameters for the material.
  136070. */
  136071. readonly detailMap: DetailMapConfiguration;
  136072. protected _rebuildInParallel: boolean;
  136073. /**
  136074. * Instantiates a new PBRMaterial instance.
  136075. *
  136076. * @param name The material name
  136077. * @param scene The scene the material will be use in.
  136078. */
  136079. constructor(name: string, scene: Scene);
  136080. /**
  136081. * Gets a boolean indicating that current material needs to register RTT
  136082. */
  136083. get hasRenderTargetTextures(): boolean;
  136084. /**
  136085. * Gets the name of the material class.
  136086. */
  136087. getClassName(): string;
  136088. /**
  136089. * Enabled the use of logarithmic depth buffers, which is good for wide depth buffers.
  136090. */
  136091. get useLogarithmicDepth(): boolean;
  136092. /**
  136093. * Enabled the use of logarithmic depth buffers, which is good for wide depth buffers.
  136094. */
  136095. set useLogarithmicDepth(value: boolean);
  136096. /**
  136097. * Returns true if alpha blending should be disabled.
  136098. */
  136099. protected get _disableAlphaBlending(): boolean;
  136100. /**
  136101. * Specifies whether or not this material should be rendered in alpha blend mode.
  136102. */
  136103. needAlphaBlending(): boolean;
  136104. /**
  136105. * Specifies whether or not this material should be rendered in alpha test mode.
  136106. */
  136107. needAlphaTesting(): boolean;
  136108. /**
  136109. * Specifies whether or not the alpha value of the albedo texture should be used for alpha blending.
  136110. */
  136111. protected _shouldUseAlphaFromAlbedoTexture(): boolean;
  136112. /**
  136113. * Gets the texture used for the alpha test.
  136114. */
  136115. getAlphaTestTexture(): Nullable<BaseTexture>;
  136116. /**
  136117. * Specifies that the submesh is ready to be used.
  136118. * @param mesh - BJS mesh.
  136119. * @param subMesh - A submesh of the BJS mesh. Used to check if it is ready.
  136120. * @param useInstances - Specifies that instances should be used.
  136121. * @returns - boolean indicating that the submesh is ready or not.
  136122. */
  136123. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  136124. /**
  136125. * Specifies if the material uses metallic roughness workflow.
  136126. * @returns boolean specifiying if the material uses metallic roughness workflow.
  136127. */
  136128. isMetallicWorkflow(): boolean;
  136129. private _prepareEffect;
  136130. private _prepareDefines;
  136131. /**
  136132. * Force shader compilation
  136133. */
  136134. forceCompilation(mesh: AbstractMesh, onCompiled?: (material: Material) => void, options?: Partial<IMaterialCompilationOptions>): void;
  136135. /**
  136136. * Initializes the uniform buffer layout for the shader.
  136137. */
  136138. buildUniformLayout(): void;
  136139. /**
  136140. * Unbinds the material from the mesh
  136141. */
  136142. unbind(): void;
  136143. /**
  136144. * Binds the submesh data.
  136145. * @param world - The world matrix.
  136146. * @param mesh - The BJS mesh.
  136147. * @param subMesh - A submesh of the BJS mesh.
  136148. */
  136149. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  136150. /**
  136151. * Returns the animatable textures.
  136152. * @returns - Array of animatable textures.
  136153. */
  136154. getAnimatables(): IAnimatable[];
  136155. /**
  136156. * Returns the texture used for reflections.
  136157. * @returns - Reflection texture if present. Otherwise, returns the environment texture.
  136158. */
  136159. private _getReflectionTexture;
  136160. /**
  136161. * Returns an array of the actively used textures.
  136162. * @returns - Array of BaseTextures
  136163. */
  136164. getActiveTextures(): BaseTexture[];
  136165. /**
  136166. * Checks to see if a texture is used in the material.
  136167. * @param texture - Base texture to use.
  136168. * @returns - Boolean specifying if a texture is used in the material.
  136169. */
  136170. hasTexture(texture: BaseTexture): boolean;
  136171. /**
  136172. * Sets the required values to the prepass renderer.
  136173. * @param prePassRenderer defines the prepass renderer to setup
  136174. */
  136175. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  136176. /**
  136177. * Disposes the resources of the material.
  136178. * @param forceDisposeEffect - Forces the disposal of effects.
  136179. * @param forceDisposeTextures - Forces the disposal of all textures.
  136180. */
  136181. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  136182. }
  136183. }
  136184. declare module BABYLON {
  136185. /**
  136186. * The Physically based material of BJS.
  136187. *
  136188. * This offers the main features of a standard PBR material.
  136189. * For more information, please refer to the documentation :
  136190. * https://doc.babylonjs.com/how_to/physically_based_rendering
  136191. */
  136192. export class PBRMaterial extends PBRBaseMaterial {
  136193. /**
  136194. * PBRMaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  136195. */
  136196. static readonly PBRMATERIAL_OPAQUE: number;
  136197. /**
  136198. * PBRMaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  136199. */
  136200. static readonly PBRMATERIAL_ALPHATEST: number;
  136201. /**
  136202. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  136203. */
  136204. static readonly PBRMATERIAL_ALPHABLEND: number;
  136205. /**
  136206. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  136207. * They are also discarded below the alpha cutoff threshold to improve performances.
  136208. */
  136209. static readonly PBRMATERIAL_ALPHATESTANDBLEND: number;
  136210. /**
  136211. * Defines the default value of how much AO map is occluding the analytical lights
  136212. * (point spot...).
  136213. */
  136214. static DEFAULT_AO_ON_ANALYTICAL_LIGHTS: number;
  136215. /**
  136216. * Intensity of the direct lights e.g. the four lights available in your scene.
  136217. * This impacts both the direct diffuse and specular highlights.
  136218. */
  136219. directIntensity: number;
  136220. /**
  136221. * Intensity of the emissive part of the material.
  136222. * This helps controlling the emissive effect without modifying the emissive color.
  136223. */
  136224. emissiveIntensity: number;
  136225. /**
  136226. * Intensity of the environment e.g. how much the environment will light the object
  136227. * either through harmonics for rough material or through the refelction for shiny ones.
  136228. */
  136229. environmentIntensity: number;
  136230. /**
  136231. * This is a special control allowing the reduction of the specular highlights coming from the
  136232. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  136233. */
  136234. specularIntensity: number;
  136235. /**
  136236. * Debug Control allowing disabling the bump map on this material.
  136237. */
  136238. disableBumpMap: boolean;
  136239. /**
  136240. * AKA Diffuse Texture in standard nomenclature.
  136241. */
  136242. albedoTexture: BaseTexture;
  136243. /**
  136244. * AKA Occlusion Texture in other nomenclature.
  136245. */
  136246. ambientTexture: BaseTexture;
  136247. /**
  136248. * AKA Occlusion Texture Intensity in other nomenclature.
  136249. */
  136250. ambientTextureStrength: number;
  136251. /**
  136252. * Defines how much the AO map is occluding the analytical lights (point spot...).
  136253. * 1 means it completely occludes it
  136254. * 0 mean it has no impact
  136255. */
  136256. ambientTextureImpactOnAnalyticalLights: number;
  136257. /**
  136258. * Stores the alpha values in a texture. Use luminance if texture.getAlphaFromRGB is true.
  136259. */
  136260. opacityTexture: BaseTexture;
  136261. /**
  136262. * Stores the reflection values in a texture.
  136263. */
  136264. reflectionTexture: Nullable<BaseTexture>;
  136265. /**
  136266. * Stores the emissive values in a texture.
  136267. */
  136268. emissiveTexture: BaseTexture;
  136269. /**
  136270. * AKA Specular texture in other nomenclature.
  136271. */
  136272. reflectivityTexture: BaseTexture;
  136273. /**
  136274. * Used to switch from specular/glossiness to metallic/roughness workflow.
  136275. */
  136276. metallicTexture: BaseTexture;
  136277. /**
  136278. * Specifies the metallic scalar of the metallic/roughness workflow.
  136279. * Can also be used to scale the metalness values of the metallic texture.
  136280. */
  136281. metallic: Nullable<number>;
  136282. /**
  136283. * Specifies the roughness scalar of the metallic/roughness workflow.
  136284. * Can also be used to scale the roughness values of the metallic texture.
  136285. */
  136286. roughness: Nullable<number>;
  136287. /**
  136288. * In metallic workflow, specifies an F0 factor to help configuring the material F0.
  136289. * By default the indexOfrefraction is used to compute F0;
  136290. *
  136291. * This is used as a factor against the default reflectance at normal incidence to tweak it.
  136292. *
  136293. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor;
  136294. * F90 = metallicReflectanceColor;
  136295. */
  136296. metallicF0Factor: number;
  136297. /**
  136298. * In metallic workflow, specifies an F90 color to help configuring the material F90.
  136299. * By default the F90 is always 1;
  136300. *
  136301. * Please note that this factor is also used as a factor against the default reflectance at normal incidence.
  136302. *
  136303. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor
  136304. * F90 = metallicReflectanceColor;
  136305. */
  136306. metallicReflectanceColor: Color3;
  136307. /**
  136308. * Defines to store metallicReflectanceColor in RGB and metallicF0Factor in A
  136309. * This is multiply against the scalar values defined in the material.
  136310. */
  136311. metallicReflectanceTexture: Nullable<BaseTexture>;
  136312. /**
  136313. * Used to enable roughness/glossiness fetch from a separate channel depending on the current mode.
  136314. * Gray Scale represents roughness in metallic mode and glossiness in specular mode.
  136315. */
  136316. microSurfaceTexture: BaseTexture;
  136317. /**
  136318. * Stores surface normal data used to displace a mesh in a texture.
  136319. */
  136320. bumpTexture: BaseTexture;
  136321. /**
  136322. * Stores the pre-calculated light information of a mesh in a texture.
  136323. */
  136324. lightmapTexture: BaseTexture;
  136325. /**
  136326. * Stores the refracted light information in a texture.
  136327. */
  136328. get refractionTexture(): Nullable<BaseTexture>;
  136329. set refractionTexture(value: Nullable<BaseTexture>);
  136330. /**
  136331. * The color of a material in ambient lighting.
  136332. */
  136333. ambientColor: Color3;
  136334. /**
  136335. * AKA Diffuse Color in other nomenclature.
  136336. */
  136337. albedoColor: Color3;
  136338. /**
  136339. * AKA Specular Color in other nomenclature.
  136340. */
  136341. reflectivityColor: Color3;
  136342. /**
  136343. * The color reflected from the material.
  136344. */
  136345. reflectionColor: Color3;
  136346. /**
  136347. * The color emitted from the material.
  136348. */
  136349. emissiveColor: Color3;
  136350. /**
  136351. * AKA Glossiness in other nomenclature.
  136352. */
  136353. microSurface: number;
  136354. /**
  136355. * Index of refraction of the material base layer.
  136356. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  136357. *
  136358. * This does not only impact refraction but also the Base F0 of Dielectric Materials.
  136359. *
  136360. * From dielectric fresnel rules: F0 = square((iorT - iorI) / (iorT + iorI))
  136361. */
  136362. get indexOfRefraction(): number;
  136363. set indexOfRefraction(value: number);
  136364. /**
  136365. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  136366. */
  136367. get invertRefractionY(): boolean;
  136368. set invertRefractionY(value: boolean);
  136369. /**
  136370. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  136371. * Materials half opaque for instance using refraction could benefit from this control.
  136372. */
  136373. get linkRefractionWithTransparency(): boolean;
  136374. set linkRefractionWithTransparency(value: boolean);
  136375. /**
  136376. * If true, the light map contains occlusion information instead of lighting info.
  136377. */
  136378. useLightmapAsShadowmap: boolean;
  136379. /**
  136380. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  136381. */
  136382. useAlphaFromAlbedoTexture: boolean;
  136383. /**
  136384. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  136385. */
  136386. forceAlphaTest: boolean;
  136387. /**
  136388. * Defines the alpha limits in alpha test mode.
  136389. */
  136390. alphaCutOff: number;
  136391. /**
  136392. * Specifies that the material will keep the specular highlights over a transparent surface (only the most limunous ones).
  136393. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  136394. */
  136395. useSpecularOverAlpha: boolean;
  136396. /**
  136397. * Specifies if the reflectivity texture contains the glossiness information in its alpha channel.
  136398. */
  136399. useMicroSurfaceFromReflectivityMapAlpha: boolean;
  136400. /**
  136401. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  136402. */
  136403. useRoughnessFromMetallicTextureAlpha: boolean;
  136404. /**
  136405. * Specifies if the metallic texture contains the roughness information in its green channel.
  136406. */
  136407. useRoughnessFromMetallicTextureGreen: boolean;
  136408. /**
  136409. * Specifies if the metallic texture contains the metallness information in its blue channel.
  136410. */
  136411. useMetallnessFromMetallicTextureBlue: boolean;
  136412. /**
  136413. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  136414. */
  136415. useAmbientOcclusionFromMetallicTextureRed: boolean;
  136416. /**
  136417. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  136418. */
  136419. useAmbientInGrayScale: boolean;
  136420. /**
  136421. * In case the reflectivity map does not contain the microsurface information in its alpha channel,
  136422. * The material will try to infer what glossiness each pixel should be.
  136423. */
  136424. useAutoMicroSurfaceFromReflectivityMap: boolean;
  136425. /**
  136426. * BJS is using an harcoded light falloff based on a manually sets up range.
  136427. * In PBR, one way to represents the fallof is to use the inverse squared root algorythm.
  136428. * This parameter can help you switch back to the BJS mode in order to create scenes using both materials.
  136429. */
  136430. get usePhysicalLightFalloff(): boolean;
  136431. /**
  136432. * BJS is using an harcoded light falloff based on a manually sets up range.
  136433. * In PBR, one way to represents the fallof is to use the inverse squared root algorythm.
  136434. * This parameter can help you switch back to the BJS mode in order to create scenes using both materials.
  136435. */
  136436. set usePhysicalLightFalloff(value: boolean);
  136437. /**
  136438. * In order to support the falloff compatibility with gltf, a special mode has been added
  136439. * to reproduce the gltf light falloff.
  136440. */
  136441. get useGLTFLightFalloff(): boolean;
  136442. /**
  136443. * In order to support the falloff compatibility with gltf, a special mode has been added
  136444. * to reproduce the gltf light falloff.
  136445. */
  136446. set useGLTFLightFalloff(value: boolean);
  136447. /**
  136448. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  136449. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  136450. */
  136451. useRadianceOverAlpha: boolean;
  136452. /**
  136453. * Allows using an object space normal map (instead of tangent space).
  136454. */
  136455. useObjectSpaceNormalMap: boolean;
  136456. /**
  136457. * Allows using the bump map in parallax mode.
  136458. */
  136459. useParallax: boolean;
  136460. /**
  136461. * Allows using the bump map in parallax occlusion mode.
  136462. */
  136463. useParallaxOcclusion: boolean;
  136464. /**
  136465. * Controls the scale bias of the parallax mode.
  136466. */
  136467. parallaxScaleBias: number;
  136468. /**
  136469. * If sets to true, disables all the lights affecting the material.
  136470. */
  136471. disableLighting: boolean;
  136472. /**
  136473. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  136474. */
  136475. forceIrradianceInFragment: boolean;
  136476. /**
  136477. * Number of Simultaneous lights allowed on the material.
  136478. */
  136479. maxSimultaneousLights: number;
  136480. /**
  136481. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  136482. */
  136483. invertNormalMapX: boolean;
  136484. /**
  136485. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  136486. */
  136487. invertNormalMapY: boolean;
  136488. /**
  136489. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  136490. */
  136491. twoSidedLighting: boolean;
  136492. /**
  136493. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  136494. * And/Or occlude the blended part. (alpha is converted to gamma to compute the fresnel)
  136495. */
  136496. useAlphaFresnel: boolean;
  136497. /**
  136498. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  136499. * And/Or occlude the blended part. (alpha stays linear to compute the fresnel)
  136500. */
  136501. useLinearAlphaFresnel: boolean;
  136502. /**
  136503. * Let user defines the brdf lookup texture used for IBL.
  136504. * A default 8bit version is embedded but you could point at :
  136505. * * Default texture: https://assets.babylonjs.com/environments/correlatedMSBRDF_RGBD.png
  136506. * * Default 16bit pixel depth texture: https://assets.babylonjs.com/environments/correlatedMSBRDF.dds
  136507. * * LEGACY Default None correlated https://assets.babylonjs.com/environments/uncorrelatedBRDF_RGBD.png
  136508. * * LEGACY Default None correlated 16bit pixel depth https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds
  136509. */
  136510. environmentBRDFTexture: Nullable<BaseTexture>;
  136511. /**
  136512. * Force normal to face away from face.
  136513. */
  136514. forceNormalForward: boolean;
  136515. /**
  136516. * Enables specular anti aliasing in the PBR shader.
  136517. * It will both interacts on the Geometry for analytical and IBL lighting.
  136518. * It also prefilter the roughness map based on the bump values.
  136519. */
  136520. enableSpecularAntiAliasing: boolean;
  136521. /**
  136522. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  136523. * makes the reflect vector face the model (under horizon).
  136524. */
  136525. useHorizonOcclusion: boolean;
  136526. /**
  136527. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  136528. * too much the area relying on ambient texture to define their ambient occlusion.
  136529. */
  136530. useRadianceOcclusion: boolean;
  136531. /**
  136532. * If set to true, no lighting calculations will be applied.
  136533. */
  136534. unlit: boolean;
  136535. /**
  136536. * Gets the image processing configuration used either in this material.
  136537. */
  136538. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  136539. /**
  136540. * Sets the Default image processing configuration used either in the this material.
  136541. *
  136542. * If sets to null, the scene one is in use.
  136543. */
  136544. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  136545. /**
  136546. * Gets wether the color curves effect is enabled.
  136547. */
  136548. get cameraColorCurvesEnabled(): boolean;
  136549. /**
  136550. * Sets wether the color curves effect is enabled.
  136551. */
  136552. set cameraColorCurvesEnabled(value: boolean);
  136553. /**
  136554. * Gets wether the color grading effect is enabled.
  136555. */
  136556. get cameraColorGradingEnabled(): boolean;
  136557. /**
  136558. * Gets wether the color grading effect is enabled.
  136559. */
  136560. set cameraColorGradingEnabled(value: boolean);
  136561. /**
  136562. * Gets wether tonemapping is enabled or not.
  136563. */
  136564. get cameraToneMappingEnabled(): boolean;
  136565. /**
  136566. * Sets wether tonemapping is enabled or not
  136567. */
  136568. set cameraToneMappingEnabled(value: boolean);
  136569. /**
  136570. * The camera exposure used on this material.
  136571. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  136572. * This corresponds to a photographic exposure.
  136573. */
  136574. get cameraExposure(): number;
  136575. /**
  136576. * The camera exposure used on this material.
  136577. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  136578. * This corresponds to a photographic exposure.
  136579. */
  136580. set cameraExposure(value: number);
  136581. /**
  136582. * Gets The camera contrast used on this material.
  136583. */
  136584. get cameraContrast(): number;
  136585. /**
  136586. * Sets The camera contrast used on this material.
  136587. */
  136588. set cameraContrast(value: number);
  136589. /**
  136590. * Gets the Color Grading 2D Lookup Texture.
  136591. */
  136592. get cameraColorGradingTexture(): Nullable<BaseTexture>;
  136593. /**
  136594. * Sets the Color Grading 2D Lookup Texture.
  136595. */
  136596. set cameraColorGradingTexture(value: Nullable<BaseTexture>);
  136597. /**
  136598. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  136599. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  136600. * 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;
  136601. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  136602. */
  136603. get cameraColorCurves(): Nullable<ColorCurves>;
  136604. /**
  136605. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  136606. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  136607. * 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;
  136608. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  136609. */
  136610. set cameraColorCurves(value: Nullable<ColorCurves>);
  136611. /**
  136612. * Instantiates a new PBRMaterial instance.
  136613. *
  136614. * @param name The material name
  136615. * @param scene The scene the material will be use in.
  136616. */
  136617. constructor(name: string, scene: Scene);
  136618. /**
  136619. * Returns the name of this material class.
  136620. */
  136621. getClassName(): string;
  136622. /**
  136623. * Makes a duplicate of the current material.
  136624. * @param name - name to use for the new material.
  136625. */
  136626. clone(name: string): PBRMaterial;
  136627. /**
  136628. * Serializes this PBR Material.
  136629. * @returns - An object with the serialized material.
  136630. */
  136631. serialize(): any;
  136632. /**
  136633. * Parses a PBR Material from a serialized object.
  136634. * @param source - Serialized object.
  136635. * @param scene - BJS scene instance.
  136636. * @param rootUrl - url for the scene object
  136637. * @returns - PBRMaterial
  136638. */
  136639. static Parse(source: any, scene: Scene, rootUrl: string): PBRMaterial;
  136640. }
  136641. }
  136642. declare module BABYLON {
  136643. /**
  136644. * Direct draw surface info
  136645. * @see https://docs.microsoft.com/en-us/windows/desktop/direct3ddds/dx-graphics-dds-pguide
  136646. */
  136647. export interface DDSInfo {
  136648. /**
  136649. * Width of the texture
  136650. */
  136651. width: number;
  136652. /**
  136653. * Width of the texture
  136654. */
  136655. height: number;
  136656. /**
  136657. * Number of Mipmaps for the texture
  136658. * @see https://en.wikipedia.org/wiki/Mipmap
  136659. */
  136660. mipmapCount: number;
  136661. /**
  136662. * If the textures format is a known fourCC format
  136663. * @see https://www.fourcc.org/
  136664. */
  136665. isFourCC: boolean;
  136666. /**
  136667. * If the texture is an RGB format eg. DXGI_FORMAT_B8G8R8X8_UNORM format
  136668. */
  136669. isRGB: boolean;
  136670. /**
  136671. * If the texture is a lumincance format
  136672. */
  136673. isLuminance: boolean;
  136674. /**
  136675. * If this is a cube texture
  136676. * @see https://docs.microsoft.com/en-us/windows/desktop/direct3ddds/dds-file-layout-for-cubic-environment-maps
  136677. */
  136678. isCube: boolean;
  136679. /**
  136680. * If the texture is a compressed format eg. FOURCC_DXT1
  136681. */
  136682. isCompressed: boolean;
  136683. /**
  136684. * The dxgiFormat of the texture
  136685. * @see https://docs.microsoft.com/en-us/windows/desktop/api/dxgiformat/ne-dxgiformat-dxgi_format
  136686. */
  136687. dxgiFormat: number;
  136688. /**
  136689. * Texture type eg. Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT
  136690. */
  136691. textureType: number;
  136692. /**
  136693. * Sphericle polynomial created for the dds texture
  136694. */
  136695. sphericalPolynomial?: SphericalPolynomial;
  136696. }
  136697. /**
  136698. * Class used to provide DDS decompression tools
  136699. */
  136700. export class DDSTools {
  136701. /**
  136702. * Gets or sets a boolean indicating that LOD info is stored in alpha channel (false by default)
  136703. */
  136704. static StoreLODInAlphaChannel: boolean;
  136705. /**
  136706. * Gets DDS information from an array buffer
  136707. * @param data defines the array buffer view to read data from
  136708. * @returns the DDS information
  136709. */
  136710. static GetDDSInfo(data: ArrayBufferView): DDSInfo;
  136711. private static _FloatView;
  136712. private static _Int32View;
  136713. private static _ToHalfFloat;
  136714. private static _FromHalfFloat;
  136715. private static _GetHalfFloatAsFloatRGBAArrayBuffer;
  136716. private static _GetHalfFloatRGBAArrayBuffer;
  136717. private static _GetFloatRGBAArrayBuffer;
  136718. private static _GetFloatAsUIntRGBAArrayBuffer;
  136719. private static _GetHalfFloatAsUIntRGBAArrayBuffer;
  136720. private static _GetRGBAArrayBuffer;
  136721. private static _ExtractLongWordOrder;
  136722. private static _GetRGBArrayBuffer;
  136723. private static _GetLuminanceArrayBuffer;
  136724. /**
  136725. * Uploads DDS Levels to a Babylon Texture
  136726. * @hidden
  136727. */
  136728. static UploadDDSLevels(engine: ThinEngine, texture: InternalTexture, data: ArrayBufferView, info: DDSInfo, loadMipmaps: boolean, faces: number, lodIndex?: number, currentFace?: number): void;
  136729. }
  136730. interface ThinEngine {
  136731. /**
  136732. * Create a cube texture from prefiltered data (ie. the mipmaps contain ready to use data for PBR reflection)
  136733. * @param rootUrl defines the url where the file to load is located
  136734. * @param scene defines the current scene
  136735. * @param lodScale defines scale to apply to the mip map selection
  136736. * @param lodOffset defines offset to apply to the mip map selection
  136737. * @param onLoad defines an optional callback raised when the texture is loaded
  136738. * @param onError defines an optional callback raised if there is an issue to load the texture
  136739. * @param format defines the format of the data
  136740. * @param forcedExtension defines the extension to use to pick the right loader
  136741. * @param createPolynomials defines wheter or not to create polynomails harmonics for the texture
  136742. * @returns the cube texture as an InternalTexture
  136743. */
  136744. 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;
  136745. }
  136746. }
  136747. declare module BABYLON {
  136748. /**
  136749. * Implementation of the DDS Texture Loader.
  136750. * @hidden
  136751. */
  136752. export class _DDSTextureLoader implements IInternalTextureLoader {
  136753. /**
  136754. * Defines wether the loader supports cascade loading the different faces.
  136755. */
  136756. readonly supportCascades: boolean;
  136757. /**
  136758. * This returns if the loader support the current file information.
  136759. * @param extension defines the file extension of the file being loaded
  136760. * @returns true if the loader can load the specified file
  136761. */
  136762. canLoad(extension: string): boolean;
  136763. /**
  136764. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  136765. * @param data contains the texture data
  136766. * @param texture defines the BabylonJS internal texture
  136767. * @param createPolynomials will be true if polynomials have been requested
  136768. * @param onLoad defines the callback to trigger once the texture is ready
  136769. * @param onError defines the callback to trigger in case of error
  136770. */
  136771. loadCubeData(imgs: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  136772. /**
  136773. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  136774. * @param data contains the texture data
  136775. * @param texture defines the BabylonJS internal texture
  136776. * @param callback defines the method to call once ready to upload
  136777. */
  136778. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  136779. }
  136780. }
  136781. declare module BABYLON {
  136782. /**
  136783. * Implementation of the ENV Texture Loader.
  136784. * @hidden
  136785. */
  136786. export class _ENVTextureLoader implements IInternalTextureLoader {
  136787. /**
  136788. * Defines wether the loader supports cascade loading the different faces.
  136789. */
  136790. readonly supportCascades: boolean;
  136791. /**
  136792. * This returns if the loader support the current file information.
  136793. * @param extension defines the file extension of the file being loaded
  136794. * @returns true if the loader can load the specified file
  136795. */
  136796. canLoad(extension: string): boolean;
  136797. /**
  136798. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  136799. * @param data contains the texture data
  136800. * @param texture defines the BabylonJS internal texture
  136801. * @param createPolynomials will be true if polynomials have been requested
  136802. * @param onLoad defines the callback to trigger once the texture is ready
  136803. * @param onError defines the callback to trigger in case of error
  136804. */
  136805. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  136806. /**
  136807. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  136808. * @param data contains the texture data
  136809. * @param texture defines the BabylonJS internal texture
  136810. * @param callback defines the method to call once ready to upload
  136811. */
  136812. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  136813. }
  136814. }
  136815. declare module BABYLON {
  136816. /**
  136817. * for description see https://www.khronos.org/opengles/sdk/tools/KTX/
  136818. * for file layout see https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/
  136819. */
  136820. export class KhronosTextureContainer {
  136821. /** contents of the KTX container file */
  136822. data: ArrayBufferView;
  136823. private static HEADER_LEN;
  136824. private static COMPRESSED_2D;
  136825. private static COMPRESSED_3D;
  136826. private static TEX_2D;
  136827. private static TEX_3D;
  136828. /**
  136829. * Gets the openGL type
  136830. */
  136831. glType: number;
  136832. /**
  136833. * Gets the openGL type size
  136834. */
  136835. glTypeSize: number;
  136836. /**
  136837. * Gets the openGL format
  136838. */
  136839. glFormat: number;
  136840. /**
  136841. * Gets the openGL internal format
  136842. */
  136843. glInternalFormat: number;
  136844. /**
  136845. * Gets the base internal format
  136846. */
  136847. glBaseInternalFormat: number;
  136848. /**
  136849. * Gets image width in pixel
  136850. */
  136851. pixelWidth: number;
  136852. /**
  136853. * Gets image height in pixel
  136854. */
  136855. pixelHeight: number;
  136856. /**
  136857. * Gets image depth in pixels
  136858. */
  136859. pixelDepth: number;
  136860. /**
  136861. * Gets the number of array elements
  136862. */
  136863. numberOfArrayElements: number;
  136864. /**
  136865. * Gets the number of faces
  136866. */
  136867. numberOfFaces: number;
  136868. /**
  136869. * Gets the number of mipmap levels
  136870. */
  136871. numberOfMipmapLevels: number;
  136872. /**
  136873. * Gets the bytes of key value data
  136874. */
  136875. bytesOfKeyValueData: number;
  136876. /**
  136877. * Gets the load type
  136878. */
  136879. loadType: number;
  136880. /**
  136881. * If the container has been made invalid (eg. constructor failed to correctly load array buffer)
  136882. */
  136883. isInvalid: boolean;
  136884. /**
  136885. * Creates a new KhronosTextureContainer
  136886. * @param data contents of the KTX container file
  136887. * @param facesExpected should be either 1 or 6, based whether a cube texture or or
  136888. * @param threeDExpected provision for indicating that data should be a 3D texture, not implemented
  136889. * @param textureArrayExpected provision for indicating that data should be a texture array, not implemented
  136890. */
  136891. constructor(
  136892. /** contents of the KTX container file */
  136893. data: ArrayBufferView, facesExpected: number, threeDExpected?: boolean, textureArrayExpected?: boolean);
  136894. /**
  136895. * Uploads KTX content to a Babylon Texture.
  136896. * It is assumed that the texture has already been created & is currently bound
  136897. * @hidden
  136898. */
  136899. uploadLevels(texture: InternalTexture, loadMipmaps: boolean): void;
  136900. private _upload2DCompressedLevels;
  136901. /**
  136902. * Checks if the given data starts with a KTX file identifier.
  136903. * @param data the data to check
  136904. * @returns true if the data is a KTX file or false otherwise
  136905. */
  136906. static IsValid(data: ArrayBufferView): boolean;
  136907. }
  136908. }
  136909. declare module BABYLON {
  136910. /**
  136911. * Class for loading KTX2 files
  136912. * !!! Experimental Extension Subject to Changes !!!
  136913. * @hidden
  136914. */
  136915. export class KhronosTextureContainer2 {
  136916. private static _ModulePromise;
  136917. private static _TranscodeFormat;
  136918. constructor(engine: ThinEngine);
  136919. uploadAsync(data: ArrayBufferView, internalTexture: InternalTexture): Promise<void>;
  136920. private _determineTranscodeFormat;
  136921. /**
  136922. * Checks if the given data starts with a KTX2 file identifier.
  136923. * @param data the data to check
  136924. * @returns true if the data is a KTX2 file or false otherwise
  136925. */
  136926. static IsValid(data: ArrayBufferView): boolean;
  136927. }
  136928. }
  136929. declare module BABYLON {
  136930. /**
  136931. * Implementation of the KTX Texture Loader.
  136932. * @hidden
  136933. */
  136934. export class _KTXTextureLoader implements IInternalTextureLoader {
  136935. /**
  136936. * Defines wether the loader supports cascade loading the different faces.
  136937. */
  136938. readonly supportCascades: boolean;
  136939. /**
  136940. * This returns if the loader support the current file information.
  136941. * @param extension defines the file extension of the file being loaded
  136942. * @param mimeType defines the optional mime type of the file being loaded
  136943. * @returns true if the loader can load the specified file
  136944. */
  136945. canLoad(extension: string, mimeType?: string): boolean;
  136946. /**
  136947. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  136948. * @param data contains the texture data
  136949. * @param texture defines the BabylonJS internal texture
  136950. * @param createPolynomials will be true if polynomials have been requested
  136951. * @param onLoad defines the callback to trigger once the texture is ready
  136952. * @param onError defines the callback to trigger in case of error
  136953. */
  136954. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  136955. /**
  136956. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  136957. * @param data contains the texture data
  136958. * @param texture defines the BabylonJS internal texture
  136959. * @param callback defines the method to call once ready to upload
  136960. */
  136961. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void, loadFailed: boolean) => void): void;
  136962. }
  136963. }
  136964. declare module BABYLON {
  136965. /** @hidden */
  136966. export var _forceSceneHelpersToBundle: boolean;
  136967. interface Scene {
  136968. /**
  136969. * Creates a default light for the scene.
  136970. * @see https://doc.babylonjs.com/How_To/Fast_Build#create-default-light
  136971. * @param replace has the default false, when true replaces the existing lights in the scene with a hemispheric light
  136972. */
  136973. createDefaultLight(replace?: boolean): void;
  136974. /**
  136975. * Creates a default camera for the scene.
  136976. * @see https://doc.babylonjs.com/How_To/Fast_Build#create-default-camera
  136977. * @param createArcRotateCamera has the default false which creates a free camera, when true creates an arc rotate camera
  136978. * @param replace has default false, when true replaces the active camera in the scene
  136979. * @param attachCameraControls has default false, when true attaches camera controls to the canvas.
  136980. */
  136981. createDefaultCamera(createArcRotateCamera?: boolean, replace?: boolean, attachCameraControls?: boolean): void;
  136982. /**
  136983. * Creates a default camera and a default light.
  136984. * @see https://doc.babylonjs.com/how_to/Fast_Build#create-default-camera-or-light
  136985. * @param createArcRotateCamera has the default false which creates a free camera, when true creates an arc rotate camera
  136986. * @param replace has the default false, when true replaces the active camera/light in the scene
  136987. * @param attachCameraControls has the default false, when true attaches camera controls to the canvas.
  136988. */
  136989. createDefaultCameraOrLight(createArcRotateCamera?: boolean, replace?: boolean, attachCameraControls?: boolean): void;
  136990. /**
  136991. * Creates a new sky box
  136992. * @see https://doc.babylonjs.com/how_to/Fast_Build#create-default-skybox
  136993. * @param environmentTexture defines the texture to use as environment texture
  136994. * @param pbr has default false which requires the StandardMaterial to be used, when true PBRMaterial must be used
  136995. * @param scale defines the overall scale of the skybox
  136996. * @param blur is only available when pbr is true, default is 0, no blur, maximum value is 1
  136997. * @param setGlobalEnvTexture has default true indicating that scene.environmentTexture must match the current skybox texture
  136998. * @returns a new mesh holding the sky box
  136999. */
  137000. createDefaultSkybox(environmentTexture?: BaseTexture, pbr?: boolean, scale?: number, blur?: number, setGlobalEnvTexture?: boolean): Nullable<Mesh>;
  137001. /**
  137002. * Creates a new environment
  137003. * @see https://doc.babylonjs.com/How_To/Fast_Build#create-default-environment
  137004. * @param options defines the options you can use to configure the environment
  137005. * @returns the new EnvironmentHelper
  137006. */
  137007. createDefaultEnvironment(options?: Partial<IEnvironmentHelperOptions>): Nullable<EnvironmentHelper>;
  137008. /**
  137009. * Creates a new VREXperienceHelper
  137010. * @see https://doc.babylonjs.com/how_to/webvr_helper
  137011. * @param webVROptions defines the options used to create the new VREXperienceHelper
  137012. * @returns a new VREXperienceHelper
  137013. */
  137014. createDefaultVRExperience(webVROptions?: VRExperienceHelperOptions): VRExperienceHelper;
  137015. /**
  137016. * Creates a new WebXRDefaultExperience
  137017. * @see https://doc.babylonjs.com/how_to/introduction_to_webxr
  137018. * @param options experience options
  137019. * @returns a promise for a new WebXRDefaultExperience
  137020. */
  137021. createDefaultXRExperienceAsync(options: WebXRDefaultExperienceOptions): Promise<WebXRDefaultExperience>;
  137022. }
  137023. }
  137024. declare module BABYLON {
  137025. /**
  137026. * Display a 360/180 degree video on an approximately spherical surface, useful for VR applications or skyboxes.
  137027. * As a subclass of TransformNode, this allow parenting to the camera or multiple videos with different locations in the scene.
  137028. * This class achieves its effect with a VideoTexture and a correctly configured BackgroundMaterial on an inverted sphere.
  137029. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  137030. */
  137031. export class VideoDome extends TransformNode {
  137032. /**
  137033. * Define the video source as a Monoscopic panoramic 360 video.
  137034. */
  137035. static readonly MODE_MONOSCOPIC: number;
  137036. /**
  137037. * Define the video source as a Stereoscopic TopBottom/OverUnder panoramic 360 video.
  137038. */
  137039. static readonly MODE_TOPBOTTOM: number;
  137040. /**
  137041. * Define the video source as a Stereoscopic Side by Side panoramic 360 video.
  137042. */
  137043. static readonly MODE_SIDEBYSIDE: number;
  137044. private _halfDome;
  137045. private _useDirectMapping;
  137046. /**
  137047. * The video texture being displayed on the sphere
  137048. */
  137049. protected _videoTexture: VideoTexture;
  137050. /**
  137051. * Gets the video texture being displayed on the sphere
  137052. */
  137053. get videoTexture(): VideoTexture;
  137054. /**
  137055. * The skybox material
  137056. */
  137057. protected _material: BackgroundMaterial;
  137058. /**
  137059. * The surface used for the video dome
  137060. */
  137061. protected _mesh: Mesh;
  137062. /**
  137063. * Gets the mesh used for the video dome.
  137064. */
  137065. get mesh(): Mesh;
  137066. /**
  137067. * A mesh that will be used to mask the back of the video dome in case it is a 180 degree movie.
  137068. */
  137069. private _halfDomeMask;
  137070. /**
  137071. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  137072. * Also see the options.resolution property.
  137073. */
  137074. get fovMultiplier(): number;
  137075. set fovMultiplier(value: number);
  137076. private _videoMode;
  137077. /**
  137078. * Gets or set the current video mode for the video. It can be:
  137079. * * VideoDome.MODE_MONOSCOPIC : Define the video source as a Monoscopic panoramic 360 video.
  137080. * * VideoDome.MODE_TOPBOTTOM : Define the video source as a Stereoscopic TopBottom/OverUnder panoramic 360 video.
  137081. * * VideoDome.MODE_SIDEBYSIDE : Define the video source as a Stereoscopic Side by Side panoramic 360 video.
  137082. */
  137083. get videoMode(): number;
  137084. set videoMode(value: number);
  137085. /**
  137086. * Is the video a 180 degrees video (half dome) or 360 video (full dome)
  137087. *
  137088. */
  137089. get halfDome(): boolean;
  137090. /**
  137091. * Set the halfDome mode. If set, only the front (180 degrees) will be displayed and the back will be blacked out.
  137092. */
  137093. set halfDome(enabled: boolean);
  137094. /**
  137095. * Oberserver used in Stereoscopic VR Mode.
  137096. */
  137097. private _onBeforeCameraRenderObserver;
  137098. /**
  137099. * Create an instance of this class and pass through the parameters to the relevant classes, VideoTexture, StandardMaterial, and Mesh.
  137100. * @param name Element's name, child elements will append suffixes for their own names.
  137101. * @param urlsOrVideo defines the url(s) or the video element to use
  137102. * @param options An object containing optional or exposed sub element properties
  137103. */
  137104. constructor(name: string, urlsOrVideo: string | string[] | HTMLVideoElement, options: {
  137105. resolution?: number;
  137106. clickToPlay?: boolean;
  137107. autoPlay?: boolean;
  137108. loop?: boolean;
  137109. size?: number;
  137110. poster?: string;
  137111. faceForward?: boolean;
  137112. useDirectMapping?: boolean;
  137113. halfDomeMode?: boolean;
  137114. }, scene: Scene);
  137115. private _changeVideoMode;
  137116. /**
  137117. * Releases resources associated with this node.
  137118. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  137119. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  137120. */
  137121. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  137122. }
  137123. }
  137124. declare module BABYLON {
  137125. /**
  137126. * This class can be used to get instrumentation data from a Babylon engine
  137127. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  137128. */
  137129. export class EngineInstrumentation implements IDisposable {
  137130. /**
  137131. * Define the instrumented engine.
  137132. */
  137133. engine: Engine;
  137134. private _captureGPUFrameTime;
  137135. private _gpuFrameTimeToken;
  137136. private _gpuFrameTime;
  137137. private _captureShaderCompilationTime;
  137138. private _shaderCompilationTime;
  137139. private _onBeginFrameObserver;
  137140. private _onEndFrameObserver;
  137141. private _onBeforeShaderCompilationObserver;
  137142. private _onAfterShaderCompilationObserver;
  137143. /**
  137144. * Gets the perf counter used for GPU frame time
  137145. */
  137146. get gpuFrameTimeCounter(): PerfCounter;
  137147. /**
  137148. * Gets the GPU frame time capture status
  137149. */
  137150. get captureGPUFrameTime(): boolean;
  137151. /**
  137152. * Enable or disable the GPU frame time capture
  137153. */
  137154. set captureGPUFrameTime(value: boolean);
  137155. /**
  137156. * Gets the perf counter used for shader compilation time
  137157. */
  137158. get shaderCompilationTimeCounter(): PerfCounter;
  137159. /**
  137160. * Gets the shader compilation time capture status
  137161. */
  137162. get captureShaderCompilationTime(): boolean;
  137163. /**
  137164. * Enable or disable the shader compilation time capture
  137165. */
  137166. set captureShaderCompilationTime(value: boolean);
  137167. /**
  137168. * Instantiates a new engine instrumentation.
  137169. * This class can be used to get instrumentation data from a Babylon engine
  137170. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  137171. * @param engine Defines the engine to instrument
  137172. */
  137173. constructor(
  137174. /**
  137175. * Define the instrumented engine.
  137176. */
  137177. engine: Engine);
  137178. /**
  137179. * Dispose and release associated resources.
  137180. */
  137181. dispose(): void;
  137182. }
  137183. }
  137184. declare module BABYLON {
  137185. /**
  137186. * This class can be used to get instrumentation data from a Babylon engine
  137187. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#sceneinstrumentation
  137188. */
  137189. export class SceneInstrumentation implements IDisposable {
  137190. /**
  137191. * Defines the scene to instrument
  137192. */
  137193. scene: Scene;
  137194. private _captureActiveMeshesEvaluationTime;
  137195. private _activeMeshesEvaluationTime;
  137196. private _captureRenderTargetsRenderTime;
  137197. private _renderTargetsRenderTime;
  137198. private _captureFrameTime;
  137199. private _frameTime;
  137200. private _captureRenderTime;
  137201. private _renderTime;
  137202. private _captureInterFrameTime;
  137203. private _interFrameTime;
  137204. private _captureParticlesRenderTime;
  137205. private _particlesRenderTime;
  137206. private _captureSpritesRenderTime;
  137207. private _spritesRenderTime;
  137208. private _capturePhysicsTime;
  137209. private _physicsTime;
  137210. private _captureAnimationsTime;
  137211. private _animationsTime;
  137212. private _captureCameraRenderTime;
  137213. private _cameraRenderTime;
  137214. private _onBeforeActiveMeshesEvaluationObserver;
  137215. private _onAfterActiveMeshesEvaluationObserver;
  137216. private _onBeforeRenderTargetsRenderObserver;
  137217. private _onAfterRenderTargetsRenderObserver;
  137218. private _onAfterRenderObserver;
  137219. private _onBeforeDrawPhaseObserver;
  137220. private _onAfterDrawPhaseObserver;
  137221. private _onBeforeAnimationsObserver;
  137222. private _onBeforeParticlesRenderingObserver;
  137223. private _onAfterParticlesRenderingObserver;
  137224. private _onBeforeSpritesRenderingObserver;
  137225. private _onAfterSpritesRenderingObserver;
  137226. private _onBeforePhysicsObserver;
  137227. private _onAfterPhysicsObserver;
  137228. private _onAfterAnimationsObserver;
  137229. private _onBeforeCameraRenderObserver;
  137230. private _onAfterCameraRenderObserver;
  137231. /**
  137232. * Gets the perf counter used for active meshes evaluation time
  137233. */
  137234. get activeMeshesEvaluationTimeCounter(): PerfCounter;
  137235. /**
  137236. * Gets the active meshes evaluation time capture status
  137237. */
  137238. get captureActiveMeshesEvaluationTime(): boolean;
  137239. /**
  137240. * Enable or disable the active meshes evaluation time capture
  137241. */
  137242. set captureActiveMeshesEvaluationTime(value: boolean);
  137243. /**
  137244. * Gets the perf counter used for render targets render time
  137245. */
  137246. get renderTargetsRenderTimeCounter(): PerfCounter;
  137247. /**
  137248. * Gets the render targets render time capture status
  137249. */
  137250. get captureRenderTargetsRenderTime(): boolean;
  137251. /**
  137252. * Enable or disable the render targets render time capture
  137253. */
  137254. set captureRenderTargetsRenderTime(value: boolean);
  137255. /**
  137256. * Gets the perf counter used for particles render time
  137257. */
  137258. get particlesRenderTimeCounter(): PerfCounter;
  137259. /**
  137260. * Gets the particles render time capture status
  137261. */
  137262. get captureParticlesRenderTime(): boolean;
  137263. /**
  137264. * Enable or disable the particles render time capture
  137265. */
  137266. set captureParticlesRenderTime(value: boolean);
  137267. /**
  137268. * Gets the perf counter used for sprites render time
  137269. */
  137270. get spritesRenderTimeCounter(): PerfCounter;
  137271. /**
  137272. * Gets the sprites render time capture status
  137273. */
  137274. get captureSpritesRenderTime(): boolean;
  137275. /**
  137276. * Enable or disable the sprites render time capture
  137277. */
  137278. set captureSpritesRenderTime(value: boolean);
  137279. /**
  137280. * Gets the perf counter used for physics time
  137281. */
  137282. get physicsTimeCounter(): PerfCounter;
  137283. /**
  137284. * Gets the physics time capture status
  137285. */
  137286. get capturePhysicsTime(): boolean;
  137287. /**
  137288. * Enable or disable the physics time capture
  137289. */
  137290. set capturePhysicsTime(value: boolean);
  137291. /**
  137292. * Gets the perf counter used for animations time
  137293. */
  137294. get animationsTimeCounter(): PerfCounter;
  137295. /**
  137296. * Gets the animations time capture status
  137297. */
  137298. get captureAnimationsTime(): boolean;
  137299. /**
  137300. * Enable or disable the animations time capture
  137301. */
  137302. set captureAnimationsTime(value: boolean);
  137303. /**
  137304. * Gets the perf counter used for frame time capture
  137305. */
  137306. get frameTimeCounter(): PerfCounter;
  137307. /**
  137308. * Gets the frame time capture status
  137309. */
  137310. get captureFrameTime(): boolean;
  137311. /**
  137312. * Enable or disable the frame time capture
  137313. */
  137314. set captureFrameTime(value: boolean);
  137315. /**
  137316. * Gets the perf counter used for inter-frames time capture
  137317. */
  137318. get interFrameTimeCounter(): PerfCounter;
  137319. /**
  137320. * Gets the inter-frames time capture status
  137321. */
  137322. get captureInterFrameTime(): boolean;
  137323. /**
  137324. * Enable or disable the inter-frames time capture
  137325. */
  137326. set captureInterFrameTime(value: boolean);
  137327. /**
  137328. * Gets the perf counter used for render time capture
  137329. */
  137330. get renderTimeCounter(): PerfCounter;
  137331. /**
  137332. * Gets the render time capture status
  137333. */
  137334. get captureRenderTime(): boolean;
  137335. /**
  137336. * Enable or disable the render time capture
  137337. */
  137338. set captureRenderTime(value: boolean);
  137339. /**
  137340. * Gets the perf counter used for camera render time capture
  137341. */
  137342. get cameraRenderTimeCounter(): PerfCounter;
  137343. /**
  137344. * Gets the camera render time capture status
  137345. */
  137346. get captureCameraRenderTime(): boolean;
  137347. /**
  137348. * Enable or disable the camera render time capture
  137349. */
  137350. set captureCameraRenderTime(value: boolean);
  137351. /**
  137352. * Gets the perf counter used for draw calls
  137353. */
  137354. get drawCallsCounter(): PerfCounter;
  137355. /**
  137356. * Instantiates a new scene instrumentation.
  137357. * This class can be used to get instrumentation data from a Babylon engine
  137358. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#sceneinstrumentation
  137359. * @param scene Defines the scene to instrument
  137360. */
  137361. constructor(
  137362. /**
  137363. * Defines the scene to instrument
  137364. */
  137365. scene: Scene);
  137366. /**
  137367. * Dispose and release associated resources.
  137368. */
  137369. dispose(): void;
  137370. }
  137371. }
  137372. declare module BABYLON {
  137373. /** @hidden */
  137374. export var glowMapGenerationPixelShader: {
  137375. name: string;
  137376. shader: string;
  137377. };
  137378. }
  137379. declare module BABYLON {
  137380. /** @hidden */
  137381. export var glowMapGenerationVertexShader: {
  137382. name: string;
  137383. shader: string;
  137384. };
  137385. }
  137386. declare module BABYLON {
  137387. /**
  137388. * Effect layer options. This helps customizing the behaviour
  137389. * of the effect layer.
  137390. */
  137391. export interface IEffectLayerOptions {
  137392. /**
  137393. * Multiplication factor apply to the canvas size to compute the render target size
  137394. * used to generated the objects (the smaller the faster).
  137395. */
  137396. mainTextureRatio: number;
  137397. /**
  137398. * Enforces a fixed size texture to ensure effect stability across devices.
  137399. */
  137400. mainTextureFixedSize?: number;
  137401. /**
  137402. * Alpha blending mode used to apply the blur. Default depends of the implementation.
  137403. */
  137404. alphaBlendingMode: number;
  137405. /**
  137406. * The camera attached to the layer.
  137407. */
  137408. camera: Nullable<Camera>;
  137409. /**
  137410. * The rendering group to draw the layer in.
  137411. */
  137412. renderingGroupId: number;
  137413. }
  137414. /**
  137415. * The effect layer Helps adding post process effect blended with the main pass.
  137416. *
  137417. * This can be for instance use to generate glow or higlight effects on the scene.
  137418. *
  137419. * The effect layer class can not be used directly and is intented to inherited from to be
  137420. * customized per effects.
  137421. */
  137422. export abstract class EffectLayer {
  137423. private _vertexBuffers;
  137424. private _indexBuffer;
  137425. private _cachedDefines;
  137426. private _effectLayerMapGenerationEffect;
  137427. private _effectLayerOptions;
  137428. private _mergeEffect;
  137429. protected _scene: Scene;
  137430. protected _engine: Engine;
  137431. protected _maxSize: number;
  137432. protected _mainTextureDesiredSize: ISize;
  137433. protected _mainTexture: RenderTargetTexture;
  137434. protected _shouldRender: boolean;
  137435. protected _postProcesses: PostProcess[];
  137436. protected _textures: BaseTexture[];
  137437. protected _emissiveTextureAndColor: {
  137438. texture: Nullable<BaseTexture>;
  137439. color: Color4;
  137440. };
  137441. /**
  137442. * The name of the layer
  137443. */
  137444. name: string;
  137445. /**
  137446. * The clear color of the texture used to generate the glow map.
  137447. */
  137448. neutralColor: Color4;
  137449. /**
  137450. * Specifies whether the highlight layer is enabled or not.
  137451. */
  137452. isEnabled: boolean;
  137453. /**
  137454. * Gets the camera attached to the layer.
  137455. */
  137456. get camera(): Nullable<Camera>;
  137457. /**
  137458. * Gets the rendering group id the layer should render in.
  137459. */
  137460. get renderingGroupId(): number;
  137461. set renderingGroupId(renderingGroupId: number);
  137462. /**
  137463. * An event triggered when the effect layer has been disposed.
  137464. */
  137465. onDisposeObservable: Observable<EffectLayer>;
  137466. /**
  137467. * An event triggered when the effect layer is about rendering the main texture with the glowy parts.
  137468. */
  137469. onBeforeRenderMainTextureObservable: Observable<EffectLayer>;
  137470. /**
  137471. * An event triggered when the generated texture is being merged in the scene.
  137472. */
  137473. onBeforeComposeObservable: Observable<EffectLayer>;
  137474. /**
  137475. * An event triggered when the mesh is rendered into the effect render target.
  137476. */
  137477. onBeforeRenderMeshToEffect: Observable<AbstractMesh>;
  137478. /**
  137479. * An event triggered after the mesh has been rendered into the effect render target.
  137480. */
  137481. onAfterRenderMeshToEffect: Observable<AbstractMesh>;
  137482. /**
  137483. * An event triggered when the generated texture has been merged in the scene.
  137484. */
  137485. onAfterComposeObservable: Observable<EffectLayer>;
  137486. /**
  137487. * An event triggered when the efffect layer changes its size.
  137488. */
  137489. onSizeChangedObservable: Observable<EffectLayer>;
  137490. /** @hidden */
  137491. static _SceneComponentInitialization: (scene: Scene) => void;
  137492. /**
  137493. * Instantiates a new effect Layer and references it in the scene.
  137494. * @param name The name of the layer
  137495. * @param scene The scene to use the layer in
  137496. */
  137497. constructor(
  137498. /** The Friendly of the effect in the scene */
  137499. name: string, scene: Scene);
  137500. /**
  137501. * Get the effect name of the layer.
  137502. * @return The effect name
  137503. */
  137504. abstract getEffectName(): string;
  137505. /**
  137506. * Checks for the readiness of the element composing the layer.
  137507. * @param subMesh the mesh to check for
  137508. * @param useInstances specify whether or not to use instances to render the mesh
  137509. * @return true if ready otherwise, false
  137510. */
  137511. abstract isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  137512. /**
  137513. * Returns whether or nood the layer needs stencil enabled during the mesh rendering.
  137514. * @returns true if the effect requires stencil during the main canvas render pass.
  137515. */
  137516. abstract needStencil(): boolean;
  137517. /**
  137518. * Create the merge effect. This is the shader use to blit the information back
  137519. * to the main canvas at the end of the scene rendering.
  137520. * @returns The effect containing the shader used to merge the effect on the main canvas
  137521. */
  137522. protected abstract _createMergeEffect(): Effect;
  137523. /**
  137524. * Creates the render target textures and post processes used in the effect layer.
  137525. */
  137526. protected abstract _createTextureAndPostProcesses(): void;
  137527. /**
  137528. * Implementation specific of rendering the generating effect on the main canvas.
  137529. * @param effect The effect used to render through
  137530. */
  137531. protected abstract _internalRender(effect: Effect): void;
  137532. /**
  137533. * Sets the required values for both the emissive texture and and the main color.
  137534. */
  137535. protected abstract _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  137536. /**
  137537. * Free any resources and references associated to a mesh.
  137538. * Internal use
  137539. * @param mesh The mesh to free.
  137540. */
  137541. abstract _disposeMesh(mesh: Mesh): void;
  137542. /**
  137543. * Serializes this layer (Glow or Highlight for example)
  137544. * @returns a serialized layer object
  137545. */
  137546. abstract serialize?(): any;
  137547. /**
  137548. * Initializes the effect layer with the required options.
  137549. * @param options Sets of none mandatory options to use with the layer (see IEffectLayerOptions for more information)
  137550. */
  137551. protected _init(options: Partial<IEffectLayerOptions>): void;
  137552. /**
  137553. * Generates the index buffer of the full screen quad blending to the main canvas.
  137554. */
  137555. private _generateIndexBuffer;
  137556. /**
  137557. * Generates the vertex buffer of the full screen quad blending to the main canvas.
  137558. */
  137559. private _generateVertexBuffer;
  137560. /**
  137561. * Sets the main texture desired size which is the closest power of two
  137562. * of the engine canvas size.
  137563. */
  137564. private _setMainTextureSize;
  137565. /**
  137566. * Creates the main texture for the effect layer.
  137567. */
  137568. protected _createMainTexture(): void;
  137569. /**
  137570. * Adds specific effects defines.
  137571. * @param defines The defines to add specifics to.
  137572. */
  137573. protected _addCustomEffectDefines(defines: string[]): void;
  137574. /**
  137575. * Checks for the readiness of the element composing the layer.
  137576. * @param subMesh the mesh to check for
  137577. * @param useInstances specify whether or not to use instances to render the mesh
  137578. * @param emissiveTexture the associated emissive texture used to generate the glow
  137579. * @return true if ready otherwise, false
  137580. */
  137581. protected _isReady(subMesh: SubMesh, useInstances: boolean, emissiveTexture: Nullable<BaseTexture>): boolean;
  137582. /**
  137583. * Renders the glowing part of the scene by blending the blurred glowing meshes on top of the rendered scene.
  137584. */
  137585. render(): void;
  137586. /**
  137587. * Determine if a given mesh will be used in the current effect.
  137588. * @param mesh mesh to test
  137589. * @returns true if the mesh will be used
  137590. */
  137591. hasMesh(mesh: AbstractMesh): boolean;
  137592. /**
  137593. * Returns true if the layer contains information to display, otherwise false.
  137594. * @returns true if the glow layer should be rendered
  137595. */
  137596. shouldRender(): boolean;
  137597. /**
  137598. * Returns true if the mesh should render, otherwise false.
  137599. * @param mesh The mesh to render
  137600. * @returns true if it should render otherwise false
  137601. */
  137602. protected _shouldRenderMesh(mesh: AbstractMesh): boolean;
  137603. /**
  137604. * Returns true if the mesh can be rendered, otherwise false.
  137605. * @param mesh The mesh to render
  137606. * @param material The material used on the mesh
  137607. * @returns true if it can be rendered otherwise false
  137608. */
  137609. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  137610. /**
  137611. * Returns true if the mesh should render, otherwise false.
  137612. * @param mesh The mesh to render
  137613. * @returns true if it should render otherwise false
  137614. */
  137615. protected _shouldRenderEmissiveTextureForMesh(): boolean;
  137616. /**
  137617. * Renders the submesh passed in parameter to the generation map.
  137618. */
  137619. protected _renderSubMesh(subMesh: SubMesh, enableAlphaMode?: boolean): void;
  137620. /**
  137621. * Defines whether the current material of the mesh should be use to render the effect.
  137622. * @param mesh defines the current mesh to render
  137623. */
  137624. protected _useMeshMaterial(mesh: AbstractMesh): boolean;
  137625. /**
  137626. * Rebuild the required buffers.
  137627. * @hidden Internal use only.
  137628. */
  137629. _rebuild(): void;
  137630. /**
  137631. * Dispose only the render target textures and post process.
  137632. */
  137633. private _disposeTextureAndPostProcesses;
  137634. /**
  137635. * Dispose the highlight layer and free resources.
  137636. */
  137637. dispose(): void;
  137638. /**
  137639. * Gets the class name of the effect layer
  137640. * @returns the string with the class name of the effect layer
  137641. */
  137642. getClassName(): string;
  137643. /**
  137644. * Creates an effect layer from parsed effect layer data
  137645. * @param parsedEffectLayer defines effect layer data
  137646. * @param scene defines the current scene
  137647. * @param rootUrl defines the root URL containing the effect layer information
  137648. * @returns a parsed effect Layer
  137649. */
  137650. static Parse(parsedEffectLayer: any, scene: Scene, rootUrl: string): EffectLayer;
  137651. }
  137652. }
  137653. declare module BABYLON {
  137654. interface AbstractScene {
  137655. /**
  137656. * The list of effect layers (highlights/glow) added to the scene
  137657. * @see https://doc.babylonjs.com/how_to/highlight_layer
  137658. * @see https://doc.babylonjs.com/how_to/glow_layer
  137659. */
  137660. effectLayers: Array<EffectLayer>;
  137661. /**
  137662. * Removes the given effect layer from this scene.
  137663. * @param toRemove defines the effect layer to remove
  137664. * @returns the index of the removed effect layer
  137665. */
  137666. removeEffectLayer(toRemove: EffectLayer): number;
  137667. /**
  137668. * Adds the given effect layer to this scene
  137669. * @param newEffectLayer defines the effect layer to add
  137670. */
  137671. addEffectLayer(newEffectLayer: EffectLayer): void;
  137672. }
  137673. /**
  137674. * Defines the layer scene component responsible to manage any effect layers
  137675. * in a given scene.
  137676. */
  137677. export class EffectLayerSceneComponent implements ISceneSerializableComponent {
  137678. /**
  137679. * The component name helpfull to identify the component in the list of scene components.
  137680. */
  137681. readonly name: string;
  137682. /**
  137683. * The scene the component belongs to.
  137684. */
  137685. scene: Scene;
  137686. private _engine;
  137687. private _renderEffects;
  137688. private _needStencil;
  137689. private _previousStencilState;
  137690. /**
  137691. * Creates a new instance of the component for the given scene
  137692. * @param scene Defines the scene to register the component in
  137693. */
  137694. constructor(scene: Scene);
  137695. /**
  137696. * Registers the component in a given scene
  137697. */
  137698. register(): void;
  137699. /**
  137700. * Rebuilds the elements related to this component in case of
  137701. * context lost for instance.
  137702. */
  137703. rebuild(): void;
  137704. /**
  137705. * Serializes the component data to the specified json object
  137706. * @param serializationObject The object to serialize to
  137707. */
  137708. serialize(serializationObject: any): void;
  137709. /**
  137710. * Adds all the elements from the container to the scene
  137711. * @param container the container holding the elements
  137712. */
  137713. addFromContainer(container: AbstractScene): void;
  137714. /**
  137715. * Removes all the elements in the container from the scene
  137716. * @param container contains the elements to remove
  137717. * @param dispose if the removed element should be disposed (default: false)
  137718. */
  137719. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  137720. /**
  137721. * Disposes the component and the associated ressources.
  137722. */
  137723. dispose(): void;
  137724. private _isReadyForMesh;
  137725. private _renderMainTexture;
  137726. private _setStencil;
  137727. private _setStencilBack;
  137728. private _draw;
  137729. private _drawCamera;
  137730. private _drawRenderingGroup;
  137731. }
  137732. }
  137733. declare module BABYLON {
  137734. /** @hidden */
  137735. export var glowMapMergePixelShader: {
  137736. name: string;
  137737. shader: string;
  137738. };
  137739. }
  137740. declare module BABYLON {
  137741. /** @hidden */
  137742. export var glowMapMergeVertexShader: {
  137743. name: string;
  137744. shader: string;
  137745. };
  137746. }
  137747. declare module BABYLON {
  137748. interface AbstractScene {
  137749. /**
  137750. * Return a the first highlight layer of the scene with a given name.
  137751. * @param name The name of the highlight layer to look for.
  137752. * @return The highlight layer if found otherwise null.
  137753. */
  137754. getGlowLayerByName(name: string): Nullable<GlowLayer>;
  137755. }
  137756. /**
  137757. * Glow layer options. This helps customizing the behaviour
  137758. * of the glow layer.
  137759. */
  137760. export interface IGlowLayerOptions {
  137761. /**
  137762. * Multiplication factor apply to the canvas size to compute the render target size
  137763. * used to generated the glowing objects (the smaller the faster).
  137764. */
  137765. mainTextureRatio: number;
  137766. /**
  137767. * Enforces a fixed size texture to ensure resize independant blur.
  137768. */
  137769. mainTextureFixedSize?: number;
  137770. /**
  137771. * How big is the kernel of the blur texture.
  137772. */
  137773. blurKernelSize: number;
  137774. /**
  137775. * The camera attached to the layer.
  137776. */
  137777. camera: Nullable<Camera>;
  137778. /**
  137779. * Enable MSAA by chosing the number of samples.
  137780. */
  137781. mainTextureSamples?: number;
  137782. /**
  137783. * The rendering group to draw the layer in.
  137784. */
  137785. renderingGroupId: number;
  137786. }
  137787. /**
  137788. * The glow layer Helps adding a glow effect around the emissive parts of a mesh.
  137789. *
  137790. * Once instantiated in a scene, by default, all the emissive meshes will glow.
  137791. *
  137792. * Documentation: https://doc.babylonjs.com/how_to/glow_layer
  137793. */
  137794. export class GlowLayer extends EffectLayer {
  137795. /**
  137796. * Effect Name of the layer.
  137797. */
  137798. static readonly EffectName: string;
  137799. /**
  137800. * The default blur kernel size used for the glow.
  137801. */
  137802. static DefaultBlurKernelSize: number;
  137803. /**
  137804. * The default texture size ratio used for the glow.
  137805. */
  137806. static DefaultTextureRatio: number;
  137807. /**
  137808. * Sets the kernel size of the blur.
  137809. */
  137810. set blurKernelSize(value: number);
  137811. /**
  137812. * Gets the kernel size of the blur.
  137813. */
  137814. get blurKernelSize(): number;
  137815. /**
  137816. * Sets the glow intensity.
  137817. */
  137818. set intensity(value: number);
  137819. /**
  137820. * Gets the glow intensity.
  137821. */
  137822. get intensity(): number;
  137823. private _options;
  137824. private _intensity;
  137825. private _horizontalBlurPostprocess1;
  137826. private _verticalBlurPostprocess1;
  137827. private _horizontalBlurPostprocess2;
  137828. private _verticalBlurPostprocess2;
  137829. private _blurTexture1;
  137830. private _blurTexture2;
  137831. private _postProcesses1;
  137832. private _postProcesses2;
  137833. private _includedOnlyMeshes;
  137834. private _excludedMeshes;
  137835. private _meshesUsingTheirOwnMaterials;
  137836. /**
  137837. * Callback used to let the user override the color selection on a per mesh basis
  137838. */
  137839. customEmissiveColorSelector: (mesh: Mesh, subMesh: SubMesh, material: Material, result: Color4) => void;
  137840. /**
  137841. * Callback used to let the user override the texture selection on a per mesh basis
  137842. */
  137843. customEmissiveTextureSelector: (mesh: Mesh, subMesh: SubMesh, material: Material) => Texture;
  137844. /**
  137845. * Instantiates a new glow Layer and references it to the scene.
  137846. * @param name The name of the layer
  137847. * @param scene The scene to use the layer in
  137848. * @param options Sets of none mandatory options to use with the layer (see IGlowLayerOptions for more information)
  137849. */
  137850. constructor(name: string, scene: Scene, options?: Partial<IGlowLayerOptions>);
  137851. /**
  137852. * Get the effect name of the layer.
  137853. * @return The effect name
  137854. */
  137855. getEffectName(): string;
  137856. /**
  137857. * Create the merge effect. This is the shader use to blit the information back
  137858. * to the main canvas at the end of the scene rendering.
  137859. */
  137860. protected _createMergeEffect(): Effect;
  137861. /**
  137862. * Creates the render target textures and post processes used in the glow layer.
  137863. */
  137864. protected _createTextureAndPostProcesses(): void;
  137865. /**
  137866. * Checks for the readiness of the element composing the layer.
  137867. * @param subMesh the mesh to check for
  137868. * @param useInstances specify wether or not to use instances to render the mesh
  137869. * @param emissiveTexture the associated emissive texture used to generate the glow
  137870. * @return true if ready otherwise, false
  137871. */
  137872. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  137873. /**
  137874. * Returns whether or nood the layer needs stencil enabled during the mesh rendering.
  137875. */
  137876. needStencil(): boolean;
  137877. /**
  137878. * Returns true if the mesh can be rendered, otherwise false.
  137879. * @param mesh The mesh to render
  137880. * @param material The material used on the mesh
  137881. * @returns true if it can be rendered otherwise false
  137882. */
  137883. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  137884. /**
  137885. * Implementation specific of rendering the generating effect on the main canvas.
  137886. * @param effect The effect used to render through
  137887. */
  137888. protected _internalRender(effect: Effect): void;
  137889. /**
  137890. * Sets the required values for both the emissive texture and and the main color.
  137891. */
  137892. protected _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  137893. /**
  137894. * Returns true if the mesh should render, otherwise false.
  137895. * @param mesh The mesh to render
  137896. * @returns true if it should render otherwise false
  137897. */
  137898. protected _shouldRenderMesh(mesh: Mesh): boolean;
  137899. /**
  137900. * Adds specific effects defines.
  137901. * @param defines The defines to add specifics to.
  137902. */
  137903. protected _addCustomEffectDefines(defines: string[]): void;
  137904. /**
  137905. * Add a mesh in the exclusion list to prevent it to impact or being impacted by the glow layer.
  137906. * @param mesh The mesh to exclude from the glow layer
  137907. */
  137908. addExcludedMesh(mesh: Mesh): void;
  137909. /**
  137910. * Remove a mesh from the exclusion list to let it impact or being impacted by the glow layer.
  137911. * @param mesh The mesh to remove
  137912. */
  137913. removeExcludedMesh(mesh: Mesh): void;
  137914. /**
  137915. * Add a mesh in the inclusion list to impact or being impacted by the glow layer.
  137916. * @param mesh The mesh to include in the glow layer
  137917. */
  137918. addIncludedOnlyMesh(mesh: Mesh): void;
  137919. /**
  137920. * Remove a mesh from the Inclusion list to prevent it to impact or being impacted by the glow layer.
  137921. * @param mesh The mesh to remove
  137922. */
  137923. removeIncludedOnlyMesh(mesh: Mesh): void;
  137924. /**
  137925. * Determine if a given mesh will be used in the glow layer
  137926. * @param mesh The mesh to test
  137927. * @returns true if the mesh will be highlighted by the current glow layer
  137928. */
  137929. hasMesh(mesh: AbstractMesh): boolean;
  137930. /**
  137931. * Defines whether the current material of the mesh should be use to render the effect.
  137932. * @param mesh defines the current mesh to render
  137933. */
  137934. protected _useMeshMaterial(mesh: AbstractMesh): boolean;
  137935. /**
  137936. * Add a mesh to be rendered through its own material and not with emissive only.
  137937. * @param mesh The mesh for which we need to use its material
  137938. */
  137939. referenceMeshToUseItsOwnMaterial(mesh: AbstractMesh): void;
  137940. /**
  137941. * Remove a mesh from being rendered through its own material and not with emissive only.
  137942. * @param mesh The mesh for which we need to not use its material
  137943. */
  137944. unReferenceMeshFromUsingItsOwnMaterial(mesh: AbstractMesh): void;
  137945. /**
  137946. * Free any resources and references associated to a mesh.
  137947. * Internal use
  137948. * @param mesh The mesh to free.
  137949. * @hidden
  137950. */
  137951. _disposeMesh(mesh: Mesh): void;
  137952. /**
  137953. * Gets the class name of the effect layer
  137954. * @returns the string with the class name of the effect layer
  137955. */
  137956. getClassName(): string;
  137957. /**
  137958. * Serializes this glow layer
  137959. * @returns a serialized glow layer object
  137960. */
  137961. serialize(): any;
  137962. /**
  137963. * Creates a Glow Layer from parsed glow layer data
  137964. * @param parsedGlowLayer defines glow layer data
  137965. * @param scene defines the current scene
  137966. * @param rootUrl defines the root URL containing the glow layer information
  137967. * @returns a parsed Glow Layer
  137968. */
  137969. static Parse(parsedGlowLayer: any, scene: Scene, rootUrl: string): GlowLayer;
  137970. }
  137971. }
  137972. declare module BABYLON {
  137973. /** @hidden */
  137974. export var glowBlurPostProcessPixelShader: {
  137975. name: string;
  137976. shader: string;
  137977. };
  137978. }
  137979. declare module BABYLON {
  137980. interface AbstractScene {
  137981. /**
  137982. * Return a the first highlight layer of the scene with a given name.
  137983. * @param name The name of the highlight layer to look for.
  137984. * @return The highlight layer if found otherwise null.
  137985. */
  137986. getHighlightLayerByName(name: string): Nullable<HighlightLayer>;
  137987. }
  137988. /**
  137989. * Highlight layer options. This helps customizing the behaviour
  137990. * of the highlight layer.
  137991. */
  137992. export interface IHighlightLayerOptions {
  137993. /**
  137994. * Multiplication factor apply to the canvas size to compute the render target size
  137995. * used to generated the glowing objects (the smaller the faster).
  137996. */
  137997. mainTextureRatio: number;
  137998. /**
  137999. * Enforces a fixed size texture to ensure resize independant blur.
  138000. */
  138001. mainTextureFixedSize?: number;
  138002. /**
  138003. * Multiplication factor apply to the main texture size in the first step of the blur to reduce the size
  138004. * of the picture to blur (the smaller the faster).
  138005. */
  138006. blurTextureSizeRatio: number;
  138007. /**
  138008. * How big in texel of the blur texture is the vertical blur.
  138009. */
  138010. blurVerticalSize: number;
  138011. /**
  138012. * How big in texel of the blur texture is the horizontal blur.
  138013. */
  138014. blurHorizontalSize: number;
  138015. /**
  138016. * Alpha blending mode used to apply the blur. Default is combine.
  138017. */
  138018. alphaBlendingMode: number;
  138019. /**
  138020. * The camera attached to the layer.
  138021. */
  138022. camera: Nullable<Camera>;
  138023. /**
  138024. * Should we display highlight as a solid stroke?
  138025. */
  138026. isStroke?: boolean;
  138027. /**
  138028. * The rendering group to draw the layer in.
  138029. */
  138030. renderingGroupId: number;
  138031. }
  138032. /**
  138033. * The highlight layer Helps adding a glow effect around a mesh.
  138034. *
  138035. * Once instantiated in a scene, simply use the addMesh or removeMesh method to add or remove
  138036. * glowy meshes to your scene.
  138037. *
  138038. * !!! THIS REQUIRES AN ACTIVE STENCIL BUFFER ON THE CANVAS !!!
  138039. */
  138040. export class HighlightLayer extends EffectLayer {
  138041. name: string;
  138042. /**
  138043. * Effect Name of the highlight layer.
  138044. */
  138045. static readonly EffectName: string;
  138046. /**
  138047. * The neutral color used during the preparation of the glow effect.
  138048. * This is black by default as the blend operation is a blend operation.
  138049. */
  138050. static NeutralColor: Color4;
  138051. /**
  138052. * Stencil value used for glowing meshes.
  138053. */
  138054. static GlowingMeshStencilReference: number;
  138055. /**
  138056. * Stencil value used for the other meshes in the scene.
  138057. */
  138058. static NormalMeshStencilReference: number;
  138059. /**
  138060. * Specifies whether or not the inner glow is ACTIVE in the layer.
  138061. */
  138062. innerGlow: boolean;
  138063. /**
  138064. * Specifies whether or not the outer glow is ACTIVE in the layer.
  138065. */
  138066. outerGlow: boolean;
  138067. /**
  138068. * Specifies the horizontal size of the blur.
  138069. */
  138070. set blurHorizontalSize(value: number);
  138071. /**
  138072. * Specifies the vertical size of the blur.
  138073. */
  138074. set blurVerticalSize(value: number);
  138075. /**
  138076. * Gets the horizontal size of the blur.
  138077. */
  138078. get blurHorizontalSize(): number;
  138079. /**
  138080. * Gets the vertical size of the blur.
  138081. */
  138082. get blurVerticalSize(): number;
  138083. /**
  138084. * An event triggered when the highlight layer is being blurred.
  138085. */
  138086. onBeforeBlurObservable: Observable<HighlightLayer>;
  138087. /**
  138088. * An event triggered when the highlight layer has been blurred.
  138089. */
  138090. onAfterBlurObservable: Observable<HighlightLayer>;
  138091. private _instanceGlowingMeshStencilReference;
  138092. private _options;
  138093. private _downSamplePostprocess;
  138094. private _horizontalBlurPostprocess;
  138095. private _verticalBlurPostprocess;
  138096. private _blurTexture;
  138097. private _meshes;
  138098. private _excludedMeshes;
  138099. /**
  138100. * Instantiates a new highlight Layer and references it to the scene..
  138101. * @param name The name of the layer
  138102. * @param scene The scene to use the layer in
  138103. * @param options Sets of none mandatory options to use with the layer (see IHighlightLayerOptions for more information)
  138104. */
  138105. constructor(name: string, scene: Scene, options?: Partial<IHighlightLayerOptions>);
  138106. /**
  138107. * Get the effect name of the layer.
  138108. * @return The effect name
  138109. */
  138110. getEffectName(): string;
  138111. /**
  138112. * Create the merge effect. This is the shader use to blit the information back
  138113. * to the main canvas at the end of the scene rendering.
  138114. */
  138115. protected _createMergeEffect(): Effect;
  138116. /**
  138117. * Creates the render target textures and post processes used in the highlight layer.
  138118. */
  138119. protected _createTextureAndPostProcesses(): void;
  138120. /**
  138121. * Returns wether or nood the layer needs stencil enabled during the mesh rendering.
  138122. */
  138123. needStencil(): boolean;
  138124. /**
  138125. * Checks for the readiness of the element composing the layer.
  138126. * @param subMesh the mesh to check for
  138127. * @param useInstances specify wether or not to use instances to render the mesh
  138128. * @param emissiveTexture the associated emissive texture used to generate the glow
  138129. * @return true if ready otherwise, false
  138130. */
  138131. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  138132. /**
  138133. * Implementation specific of rendering the generating effect on the main canvas.
  138134. * @param effect The effect used to render through
  138135. */
  138136. protected _internalRender(effect: Effect): void;
  138137. /**
  138138. * Returns true if the layer contains information to display, otherwise false.
  138139. */
  138140. shouldRender(): boolean;
  138141. /**
  138142. * Returns true if the mesh should render, otherwise false.
  138143. * @param mesh The mesh to render
  138144. * @returns true if it should render otherwise false
  138145. */
  138146. protected _shouldRenderMesh(mesh: Mesh): boolean;
  138147. /**
  138148. * Returns true if the mesh can be rendered, otherwise false.
  138149. * @param mesh The mesh to render
  138150. * @param material The material used on the mesh
  138151. * @returns true if it can be rendered otherwise false
  138152. */
  138153. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  138154. /**
  138155. * Adds specific effects defines.
  138156. * @param defines The defines to add specifics to.
  138157. */
  138158. protected _addCustomEffectDefines(defines: string[]): void;
  138159. /**
  138160. * Sets the required values for both the emissive texture and and the main color.
  138161. */
  138162. protected _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  138163. /**
  138164. * Add a mesh in the exclusion list to prevent it to impact or being impacted by the highlight layer.
  138165. * @param mesh The mesh to exclude from the highlight layer
  138166. */
  138167. addExcludedMesh(mesh: Mesh): void;
  138168. /**
  138169. * Remove a mesh from the exclusion list to let it impact or being impacted by the highlight layer.
  138170. * @param mesh The mesh to highlight
  138171. */
  138172. removeExcludedMesh(mesh: Mesh): void;
  138173. /**
  138174. * Determine if a given mesh will be highlighted by the current HighlightLayer
  138175. * @param mesh mesh to test
  138176. * @returns true if the mesh will be highlighted by the current HighlightLayer
  138177. */
  138178. hasMesh(mesh: AbstractMesh): boolean;
  138179. /**
  138180. * Add a mesh in the highlight layer in order to make it glow with the chosen color.
  138181. * @param mesh The mesh to highlight
  138182. * @param color The color of the highlight
  138183. * @param glowEmissiveOnly Extract the glow from the emissive texture
  138184. */
  138185. addMesh(mesh: Mesh, color: Color3, glowEmissiveOnly?: boolean): void;
  138186. /**
  138187. * Remove a mesh from the highlight layer in order to make it stop glowing.
  138188. * @param mesh The mesh to highlight
  138189. */
  138190. removeMesh(mesh: Mesh): void;
  138191. /**
  138192. * Remove all the meshes currently referenced in the highlight layer
  138193. */
  138194. removeAllMeshes(): void;
  138195. /**
  138196. * Force the stencil to the normal expected value for none glowing parts
  138197. */
  138198. private _defaultStencilReference;
  138199. /**
  138200. * Free any resources and references associated to a mesh.
  138201. * Internal use
  138202. * @param mesh The mesh to free.
  138203. * @hidden
  138204. */
  138205. _disposeMesh(mesh: Mesh): void;
  138206. /**
  138207. * Dispose the highlight layer and free resources.
  138208. */
  138209. dispose(): void;
  138210. /**
  138211. * Gets the class name of the effect layer
  138212. * @returns the string with the class name of the effect layer
  138213. */
  138214. getClassName(): string;
  138215. /**
  138216. * Serializes this Highlight layer
  138217. * @returns a serialized Highlight layer object
  138218. */
  138219. serialize(): any;
  138220. /**
  138221. * Creates a Highlight layer from parsed Highlight layer data
  138222. * @param parsedHightlightLayer defines the Highlight layer data
  138223. * @param scene defines the current scene
  138224. * @param rootUrl defines the root URL containing the Highlight layer information
  138225. * @returns a parsed Highlight layer
  138226. */
  138227. static Parse(parsedHightlightLayer: any, scene: Scene, rootUrl: string): HighlightLayer;
  138228. }
  138229. }
  138230. declare module BABYLON {
  138231. interface AbstractScene {
  138232. /**
  138233. * The list of layers (background and foreground) of the scene
  138234. */
  138235. layers: Array<Layer>;
  138236. }
  138237. /**
  138238. * Defines the layer scene component responsible to manage any layers
  138239. * in a given scene.
  138240. */
  138241. export class LayerSceneComponent implements ISceneComponent {
  138242. /**
  138243. * The component name helpfull to identify the component in the list of scene components.
  138244. */
  138245. readonly name: string;
  138246. /**
  138247. * The scene the component belongs to.
  138248. */
  138249. scene: Scene;
  138250. private _engine;
  138251. /**
  138252. * Creates a new instance of the component for the given scene
  138253. * @param scene Defines the scene to register the component in
  138254. */
  138255. constructor(scene: Scene);
  138256. /**
  138257. * Registers the component in a given scene
  138258. */
  138259. register(): void;
  138260. /**
  138261. * Rebuilds the elements related to this component in case of
  138262. * context lost for instance.
  138263. */
  138264. rebuild(): void;
  138265. /**
  138266. * Disposes the component and the associated ressources.
  138267. */
  138268. dispose(): void;
  138269. private _draw;
  138270. private _drawCameraPredicate;
  138271. private _drawCameraBackground;
  138272. private _drawCameraForeground;
  138273. private _drawRenderTargetPredicate;
  138274. private _drawRenderTargetBackground;
  138275. private _drawRenderTargetForeground;
  138276. /**
  138277. * Adds all the elements from the container to the scene
  138278. * @param container the container holding the elements
  138279. */
  138280. addFromContainer(container: AbstractScene): void;
  138281. /**
  138282. * Removes all the elements in the container from the scene
  138283. * @param container contains the elements to remove
  138284. * @param dispose if the removed element should be disposed (default: false)
  138285. */
  138286. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  138287. }
  138288. }
  138289. declare module BABYLON {
  138290. /** @hidden */
  138291. export var layerPixelShader: {
  138292. name: string;
  138293. shader: string;
  138294. };
  138295. }
  138296. declare module BABYLON {
  138297. /** @hidden */
  138298. export var layerVertexShader: {
  138299. name: string;
  138300. shader: string;
  138301. };
  138302. }
  138303. declare module BABYLON {
  138304. /**
  138305. * This represents a full screen 2d layer.
  138306. * This can be useful to display a picture in the background of your scene for instance.
  138307. * @see https://www.babylonjs-playground.com/#08A2BS#1
  138308. */
  138309. export class Layer {
  138310. /**
  138311. * Define the name of the layer.
  138312. */
  138313. name: string;
  138314. /**
  138315. * Define the texture the layer should display.
  138316. */
  138317. texture: Nullable<Texture>;
  138318. /**
  138319. * Is the layer in background or foreground.
  138320. */
  138321. isBackground: boolean;
  138322. /**
  138323. * Define the color of the layer (instead of texture).
  138324. */
  138325. color: Color4;
  138326. /**
  138327. * Define the scale of the layer in order to zoom in out of the texture.
  138328. */
  138329. scale: Vector2;
  138330. /**
  138331. * Define an offset for the layer in order to shift the texture.
  138332. */
  138333. offset: Vector2;
  138334. /**
  138335. * Define the alpha blending mode used in the layer in case the texture or color has an alpha.
  138336. */
  138337. alphaBlendingMode: number;
  138338. /**
  138339. * Define if the layer should alpha test or alpha blend with the rest of the scene.
  138340. * Alpha test will not mix with the background color in case of transparency.
  138341. * It will either use the texture color or the background depending on the alpha value of the current pixel.
  138342. */
  138343. alphaTest: boolean;
  138344. /**
  138345. * Define a mask to restrict the layer to only some of the scene cameras.
  138346. */
  138347. layerMask: number;
  138348. /**
  138349. * Define the list of render target the layer is visible into.
  138350. */
  138351. renderTargetTextures: RenderTargetTexture[];
  138352. /**
  138353. * Define if the layer is only used in renderTarget or if it also
  138354. * renders in the main frame buffer of the canvas.
  138355. */
  138356. renderOnlyInRenderTargetTextures: boolean;
  138357. private _scene;
  138358. private _vertexBuffers;
  138359. private _indexBuffer;
  138360. private _effect;
  138361. private _previousDefines;
  138362. /**
  138363. * An event triggered when the layer is disposed.
  138364. */
  138365. onDisposeObservable: Observable<Layer>;
  138366. private _onDisposeObserver;
  138367. /**
  138368. * Back compatibility with callback before the onDisposeObservable existed.
  138369. * The set callback will be triggered when the layer has been disposed.
  138370. */
  138371. set onDispose(callback: () => void);
  138372. /**
  138373. * An event triggered before rendering the scene
  138374. */
  138375. onBeforeRenderObservable: Observable<Layer>;
  138376. private _onBeforeRenderObserver;
  138377. /**
  138378. * Back compatibility with callback before the onBeforeRenderObservable existed.
  138379. * The set callback will be triggered just before rendering the layer.
  138380. */
  138381. set onBeforeRender(callback: () => void);
  138382. /**
  138383. * An event triggered after rendering the scene
  138384. */
  138385. onAfterRenderObservable: Observable<Layer>;
  138386. private _onAfterRenderObserver;
  138387. /**
  138388. * Back compatibility with callback before the onAfterRenderObservable existed.
  138389. * The set callback will be triggered just after rendering the layer.
  138390. */
  138391. set onAfterRender(callback: () => void);
  138392. /**
  138393. * Instantiates a new layer.
  138394. * This represents a full screen 2d layer.
  138395. * This can be useful to display a picture in the background of your scene for instance.
  138396. * @see https://www.babylonjs-playground.com/#08A2BS#1
  138397. * @param name Define the name of the layer in the scene
  138398. * @param imgUrl Define the url of the texture to display in the layer
  138399. * @param scene Define the scene the layer belongs to
  138400. * @param isBackground Defines whether the layer is displayed in front or behind the scene
  138401. * @param color Defines a color for the layer
  138402. */
  138403. constructor(
  138404. /**
  138405. * Define the name of the layer.
  138406. */
  138407. name: string, imgUrl: Nullable<string>, scene: Nullable<Scene>, isBackground?: boolean, color?: Color4);
  138408. private _createIndexBuffer;
  138409. /** @hidden */
  138410. _rebuild(): void;
  138411. /**
  138412. * Renders the layer in the scene.
  138413. */
  138414. render(): void;
  138415. /**
  138416. * Disposes and releases the associated ressources.
  138417. */
  138418. dispose(): void;
  138419. }
  138420. }
  138421. declare module BABYLON {
  138422. /** @hidden */
  138423. export var lensFlarePixelShader: {
  138424. name: string;
  138425. shader: string;
  138426. };
  138427. }
  138428. declare module BABYLON {
  138429. /** @hidden */
  138430. export var lensFlareVertexShader: {
  138431. name: string;
  138432. shader: string;
  138433. };
  138434. }
  138435. declare module BABYLON {
  138436. /**
  138437. * This represents a Lens Flare System or the shiny effect created by the light reflection on the camera lenses.
  138438. * It is usually composed of several `lensFlare`.
  138439. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  138440. */
  138441. export class LensFlareSystem {
  138442. /**
  138443. * Define the name of the lens flare system
  138444. */
  138445. name: string;
  138446. /**
  138447. * List of lens flares used in this system.
  138448. */
  138449. lensFlares: LensFlare[];
  138450. /**
  138451. * Define a limit from the border the lens flare can be visible.
  138452. */
  138453. borderLimit: number;
  138454. /**
  138455. * Define a viewport border we do not want to see the lens flare in.
  138456. */
  138457. viewportBorder: number;
  138458. /**
  138459. * Define a predicate which could limit the list of meshes able to occlude the effect.
  138460. */
  138461. meshesSelectionPredicate: (mesh: AbstractMesh) => boolean;
  138462. /**
  138463. * Restricts the rendering of the effect to only the camera rendering this layer mask.
  138464. */
  138465. layerMask: number;
  138466. /**
  138467. * Define the id of the lens flare system in the scene.
  138468. * (equal to name by default)
  138469. */
  138470. id: string;
  138471. private _scene;
  138472. private _emitter;
  138473. private _vertexBuffers;
  138474. private _indexBuffer;
  138475. private _effect;
  138476. private _positionX;
  138477. private _positionY;
  138478. private _isEnabled;
  138479. /** @hidden */
  138480. static _SceneComponentInitialization: (scene: Scene) => void;
  138481. /**
  138482. * Instantiates a lens flare system.
  138483. * This represents a Lens Flare System or the shiny effect created by the light reflection on the camera lenses.
  138484. * It is usually composed of several `lensFlare`.
  138485. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  138486. * @param name Define the name of the lens flare system in the scene
  138487. * @param emitter Define the source (the emitter) of the lens flares (it can be a camera, a light or a mesh).
  138488. * @param scene Define the scene the lens flare system belongs to
  138489. */
  138490. constructor(
  138491. /**
  138492. * Define the name of the lens flare system
  138493. */
  138494. name: string, emitter: any, scene: Scene);
  138495. /**
  138496. * Define if the lens flare system is enabled.
  138497. */
  138498. get isEnabled(): boolean;
  138499. set isEnabled(value: boolean);
  138500. /**
  138501. * Get the scene the effects belongs to.
  138502. * @returns the scene holding the lens flare system
  138503. */
  138504. getScene(): Scene;
  138505. /**
  138506. * Get the emitter of the lens flare system.
  138507. * It defines the source of the lens flares (it can be a camera, a light or a mesh).
  138508. * @returns the emitter of the lens flare system
  138509. */
  138510. getEmitter(): any;
  138511. /**
  138512. * Set the emitter of the lens flare system.
  138513. * It defines the source of the lens flares (it can be a camera, a light or a mesh).
  138514. * @param newEmitter Define the new emitter of the system
  138515. */
  138516. setEmitter(newEmitter: any): void;
  138517. /**
  138518. * Get the lens flare system emitter position.
  138519. * The emitter defines the source of the lens flares (it can be a camera, a light or a mesh).
  138520. * @returns the position
  138521. */
  138522. getEmitterPosition(): Vector3;
  138523. /**
  138524. * @hidden
  138525. */
  138526. computeEffectivePosition(globalViewport: Viewport): boolean;
  138527. /** @hidden */
  138528. _isVisible(): boolean;
  138529. /**
  138530. * @hidden
  138531. */
  138532. render(): boolean;
  138533. /**
  138534. * Dispose and release the lens flare with its associated resources.
  138535. */
  138536. dispose(): void;
  138537. /**
  138538. * Parse a lens flare system from a JSON repressentation
  138539. * @param parsedLensFlareSystem Define the JSON to parse
  138540. * @param scene Define the scene the parsed system should be instantiated in
  138541. * @param rootUrl Define the rootUrl of the load sequence to easily find a load relative dependencies such as textures
  138542. * @returns the parsed system
  138543. */
  138544. static Parse(parsedLensFlareSystem: any, scene: Scene, rootUrl: string): LensFlareSystem;
  138545. /**
  138546. * Serialize the current Lens Flare System into a JSON representation.
  138547. * @returns the serialized JSON
  138548. */
  138549. serialize(): any;
  138550. }
  138551. }
  138552. declare module BABYLON {
  138553. /**
  138554. * This represents one of the lens effect in a `lensFlareSystem`.
  138555. * It controls one of the indiviual texture used in the effect.
  138556. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  138557. */
  138558. export class LensFlare {
  138559. /**
  138560. * Define the size of the lens flare in the system (a floating value between 0 and 1)
  138561. */
  138562. size: number;
  138563. /**
  138564. * 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.
  138565. */
  138566. position: number;
  138567. /**
  138568. * Define the lens color.
  138569. */
  138570. color: Color3;
  138571. /**
  138572. * Define the lens texture.
  138573. */
  138574. texture: Nullable<Texture>;
  138575. /**
  138576. * Define the alpha mode to render this particular lens.
  138577. */
  138578. alphaMode: number;
  138579. private _system;
  138580. /**
  138581. * Creates a new Lens Flare.
  138582. * This represents one of the lens effect in a `lensFlareSystem`.
  138583. * It controls one of the indiviual texture used in the effect.
  138584. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  138585. * @param size Define the size of the lens flare (a floating value between 0 and 1)
  138586. * @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.
  138587. * @param color Define the lens color
  138588. * @param imgUrl Define the lens texture url
  138589. * @param system Define the `lensFlareSystem` this flare is part of
  138590. * @returns The newly created Lens Flare
  138591. */
  138592. static AddFlare(size: number, position: number, color: Color3, imgUrl: string, system: LensFlareSystem): LensFlare;
  138593. /**
  138594. * Instantiates a new Lens Flare.
  138595. * This represents one of the lens effect in a `lensFlareSystem`.
  138596. * It controls one of the indiviual texture used in the effect.
  138597. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  138598. * @param size Define the size of the lens flare in the system (a floating value between 0 and 1)
  138599. * @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.
  138600. * @param color Define the lens color
  138601. * @param imgUrl Define the lens texture url
  138602. * @param system Define the `lensFlareSystem` this flare is part of
  138603. */
  138604. constructor(
  138605. /**
  138606. * Define the size of the lens flare in the system (a floating value between 0 and 1)
  138607. */
  138608. size: number,
  138609. /**
  138610. * 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.
  138611. */
  138612. position: number, color: Color3, imgUrl: string, system: LensFlareSystem);
  138613. /**
  138614. * Dispose and release the lens flare with its associated resources.
  138615. */
  138616. dispose(): void;
  138617. }
  138618. }
  138619. declare module BABYLON {
  138620. interface AbstractScene {
  138621. /**
  138622. * The list of lens flare system added to the scene
  138623. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  138624. */
  138625. lensFlareSystems: Array<LensFlareSystem>;
  138626. /**
  138627. * Removes the given lens flare system from this scene.
  138628. * @param toRemove The lens flare system to remove
  138629. * @returns The index of the removed lens flare system
  138630. */
  138631. removeLensFlareSystem(toRemove: LensFlareSystem): number;
  138632. /**
  138633. * Adds the given lens flare system to this scene
  138634. * @param newLensFlareSystem The lens flare system to add
  138635. */
  138636. addLensFlareSystem(newLensFlareSystem: LensFlareSystem): void;
  138637. /**
  138638. * Gets a lens flare system using its name
  138639. * @param name defines the name to look for
  138640. * @returns the lens flare system or null if not found
  138641. */
  138642. getLensFlareSystemByName(name: string): Nullable<LensFlareSystem>;
  138643. /**
  138644. * Gets a lens flare system using its id
  138645. * @param id defines the id to look for
  138646. * @returns the lens flare system or null if not found
  138647. */
  138648. getLensFlareSystemByID(id: string): Nullable<LensFlareSystem>;
  138649. }
  138650. /**
  138651. * Defines the lens flare scene component responsible to manage any lens flares
  138652. * in a given scene.
  138653. */
  138654. export class LensFlareSystemSceneComponent implements ISceneSerializableComponent {
  138655. /**
  138656. * The component name helpfull to identify the component in the list of scene components.
  138657. */
  138658. readonly name: string;
  138659. /**
  138660. * The scene the component belongs to.
  138661. */
  138662. scene: Scene;
  138663. /**
  138664. * Creates a new instance of the component for the given scene
  138665. * @param scene Defines the scene to register the component in
  138666. */
  138667. constructor(scene: Scene);
  138668. /**
  138669. * Registers the component in a given scene
  138670. */
  138671. register(): void;
  138672. /**
  138673. * Rebuilds the elements related to this component in case of
  138674. * context lost for instance.
  138675. */
  138676. rebuild(): void;
  138677. /**
  138678. * Adds all the elements from the container to the scene
  138679. * @param container the container holding the elements
  138680. */
  138681. addFromContainer(container: AbstractScene): void;
  138682. /**
  138683. * Removes all the elements in the container from the scene
  138684. * @param container contains the elements to remove
  138685. * @param dispose if the removed element should be disposed (default: false)
  138686. */
  138687. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  138688. /**
  138689. * Serializes the component data to the specified json object
  138690. * @param serializationObject The object to serialize to
  138691. */
  138692. serialize(serializationObject: any): void;
  138693. /**
  138694. * Disposes the component and the associated ressources.
  138695. */
  138696. dispose(): void;
  138697. private _draw;
  138698. }
  138699. }
  138700. declare module BABYLON {
  138701. /** @hidden */
  138702. export var depthPixelShader: {
  138703. name: string;
  138704. shader: string;
  138705. };
  138706. }
  138707. declare module BABYLON {
  138708. /** @hidden */
  138709. export var depthVertexShader: {
  138710. name: string;
  138711. shader: string;
  138712. };
  138713. }
  138714. declare module BABYLON {
  138715. /**
  138716. * This represents a depth renderer in Babylon.
  138717. * A depth renderer will render to it's depth map every frame which can be displayed or used in post processing
  138718. */
  138719. export class DepthRenderer {
  138720. private _scene;
  138721. private _depthMap;
  138722. private _effect;
  138723. private readonly _storeNonLinearDepth;
  138724. private readonly _clearColor;
  138725. /** Get if the depth renderer is using packed depth or not */
  138726. readonly isPacked: boolean;
  138727. private _cachedDefines;
  138728. private _camera;
  138729. /** Enable or disable the depth renderer. When disabled, the depth texture is not updated */
  138730. enabled: boolean;
  138731. /**
  138732. * Specifiess that the depth renderer will only be used within
  138733. * the camera it is created for.
  138734. * This can help forcing its rendering during the camera processing.
  138735. */
  138736. useOnlyInActiveCamera: boolean;
  138737. /** @hidden */
  138738. static _SceneComponentInitialization: (scene: Scene) => void;
  138739. /**
  138740. * Instantiates a depth renderer
  138741. * @param scene The scene the renderer belongs to
  138742. * @param type The texture type of the depth map (default: Engine.TEXTURETYPE_FLOAT)
  138743. * @param camera The camera to be used to render the depth map (default: scene's active camera)
  138744. * @param storeNonLinearDepth Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z
  138745. */
  138746. constructor(scene: Scene, type?: number, camera?: Nullable<Camera>, storeNonLinearDepth?: boolean);
  138747. /**
  138748. * Creates the depth rendering effect and checks if the effect is ready.
  138749. * @param subMesh The submesh to be used to render the depth map of
  138750. * @param useInstances If multiple world instances should be used
  138751. * @returns if the depth renderer is ready to render the depth map
  138752. */
  138753. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  138754. /**
  138755. * Gets the texture which the depth map will be written to.
  138756. * @returns The depth map texture
  138757. */
  138758. getDepthMap(): RenderTargetTexture;
  138759. /**
  138760. * Disposes of the depth renderer.
  138761. */
  138762. dispose(): void;
  138763. }
  138764. }
  138765. declare module BABYLON {
  138766. /** @hidden */
  138767. export var minmaxReduxPixelShader: {
  138768. name: string;
  138769. shader: string;
  138770. };
  138771. }
  138772. declare module BABYLON {
  138773. /**
  138774. * This class computes a min/max reduction from a texture: it means it computes the minimum
  138775. * and maximum values from all values of the texture.
  138776. * It is performed on the GPU for better performances, thanks to a succession of post processes.
  138777. * The source values are read from the red channel of the texture.
  138778. */
  138779. export class MinMaxReducer {
  138780. /**
  138781. * Observable triggered when the computation has been performed
  138782. */
  138783. onAfterReductionPerformed: Observable<{
  138784. min: number;
  138785. max: number;
  138786. }>;
  138787. protected _camera: Camera;
  138788. protected _sourceTexture: Nullable<RenderTargetTexture>;
  138789. protected _reductionSteps: Nullable<Array<PostProcess>>;
  138790. protected _postProcessManager: PostProcessManager;
  138791. protected _onAfterUnbindObserver: Nullable<Observer<RenderTargetTexture>>;
  138792. protected _forceFullscreenViewport: boolean;
  138793. /**
  138794. * Creates a min/max reducer
  138795. * @param camera The camera to use for the post processes
  138796. */
  138797. constructor(camera: Camera);
  138798. /**
  138799. * Gets the texture used to read the values from.
  138800. */
  138801. get sourceTexture(): Nullable<RenderTargetTexture>;
  138802. /**
  138803. * Sets the source texture to read the values from.
  138804. * One must indicate if the texture is a depth texture or not through the depthRedux parameter
  138805. * because in such textures '1' value must not be taken into account to compute the maximum
  138806. * as this value is used to clear the texture.
  138807. * Note that the computation is not activated by calling this function, you must call activate() for that!
  138808. * @param sourceTexture The texture to read the values from. The values should be in the red channel.
  138809. * @param depthRedux Indicates if the texture is a depth texture or not
  138810. * @param type The type of the textures created for the reduction (defaults to TEXTURETYPE_HALF_FLOAT)
  138811. * @param forceFullscreenViewport Forces the post processes used for the reduction to be applied without taking into account viewport (defaults to true)
  138812. */
  138813. setSourceTexture(sourceTexture: RenderTargetTexture, depthRedux: boolean, type?: number, forceFullscreenViewport?: boolean): void;
  138814. /**
  138815. * Defines the refresh rate of the computation.
  138816. * Use 0 to compute just once, 1 to compute on every frame, 2 to compute every two frames and so on...
  138817. */
  138818. get refreshRate(): number;
  138819. set refreshRate(value: number);
  138820. protected _activated: boolean;
  138821. /**
  138822. * Gets the activation status of the reducer
  138823. */
  138824. get activated(): boolean;
  138825. /**
  138826. * Activates the reduction computation.
  138827. * When activated, the observers registered in onAfterReductionPerformed are
  138828. * called after the compuation is performed
  138829. */
  138830. activate(): void;
  138831. /**
  138832. * Deactivates the reduction computation.
  138833. */
  138834. deactivate(): void;
  138835. /**
  138836. * Disposes the min/max reducer
  138837. * @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.
  138838. */
  138839. dispose(disposeAll?: boolean): void;
  138840. }
  138841. }
  138842. declare module BABYLON {
  138843. /**
  138844. * This class is a small wrapper around the MinMaxReducer class to compute the min/max values of a depth texture
  138845. */
  138846. export class DepthReducer extends MinMaxReducer {
  138847. private _depthRenderer;
  138848. private _depthRendererId;
  138849. /**
  138850. * Gets the depth renderer used for the computation.
  138851. * Note that the result is null if you provide your own renderer when calling setDepthRenderer.
  138852. */
  138853. get depthRenderer(): Nullable<DepthRenderer>;
  138854. /**
  138855. * Creates a depth reducer
  138856. * @param camera The camera used to render the depth texture
  138857. */
  138858. constructor(camera: Camera);
  138859. /**
  138860. * Sets the depth renderer to use to generate the depth map
  138861. * @param depthRenderer The depth renderer to use. If not provided, a new one will be created automatically
  138862. * @param type The texture type of the depth map (default: TEXTURETYPE_HALF_FLOAT)
  138863. * @param forceFullscreenViewport Forces the post processes used for the reduction to be applied without taking into account viewport (defaults to true)
  138864. */
  138865. setDepthRenderer(depthRenderer?: Nullable<DepthRenderer>, type?: number, forceFullscreenViewport?: boolean): void;
  138866. /** @hidden */
  138867. setSourceTexture(sourceTexture: RenderTargetTexture, depthRedux: boolean, type?: number, forceFullscreenViewport?: boolean): void;
  138868. /**
  138869. * Activates the reduction computation.
  138870. * When activated, the observers registered in onAfterReductionPerformed are
  138871. * called after the compuation is performed
  138872. */
  138873. activate(): void;
  138874. /**
  138875. * Deactivates the reduction computation.
  138876. */
  138877. deactivate(): void;
  138878. /**
  138879. * Disposes the depth reducer
  138880. * @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.
  138881. */
  138882. dispose(disposeAll?: boolean): void;
  138883. }
  138884. }
  138885. declare module BABYLON {
  138886. /**
  138887. * A CSM implementation allowing casting shadows on large scenes.
  138888. * Documentation : https://doc.babylonjs.com/babylon101/cascadedShadows
  138889. * Based on: https://github.com/TheRealMJP/Shadows and https://johanmedestrom.wordpress.com/2016/03/18/opengl-cascaded-shadow-maps/
  138890. */
  138891. export class CascadedShadowGenerator extends ShadowGenerator {
  138892. private static readonly frustumCornersNDCSpace;
  138893. /**
  138894. * Name of the CSM class
  138895. */
  138896. static CLASSNAME: string;
  138897. /**
  138898. * Defines the default number of cascades used by the CSM.
  138899. */
  138900. static readonly DEFAULT_CASCADES_COUNT: number;
  138901. /**
  138902. * Defines the minimum number of cascades used by the CSM.
  138903. */
  138904. static readonly MIN_CASCADES_COUNT: number;
  138905. /**
  138906. * Defines the maximum number of cascades used by the CSM.
  138907. */
  138908. static readonly MAX_CASCADES_COUNT: number;
  138909. protected _validateFilter(filter: number): number;
  138910. /**
  138911. * Gets or sets the actual darkness of the soft shadows while using PCSS filtering (value between 0. and 1.)
  138912. */
  138913. penumbraDarkness: number;
  138914. private _numCascades;
  138915. /**
  138916. * Gets or set the number of cascades used by the CSM.
  138917. */
  138918. get numCascades(): number;
  138919. set numCascades(value: number);
  138920. /**
  138921. * Sets this to true if you want that the edges of the shadows don't "swimm" / "shimmer" when rotating the camera.
  138922. * The trade off is that you lose some precision in the shadow rendering when enabling this setting.
  138923. */
  138924. stabilizeCascades: boolean;
  138925. private _freezeShadowCastersBoundingInfo;
  138926. private _freezeShadowCastersBoundingInfoObservable;
  138927. /**
  138928. * Enables or disables the shadow casters bounding info computation.
  138929. * If your shadow casters don't move, you can disable this feature.
  138930. * If it is enabled, the bounding box computation is done every frame.
  138931. */
  138932. get freezeShadowCastersBoundingInfo(): boolean;
  138933. set freezeShadowCastersBoundingInfo(freeze: boolean);
  138934. private _scbiMin;
  138935. private _scbiMax;
  138936. protected _computeShadowCastersBoundingInfo(): void;
  138937. protected _shadowCastersBoundingInfo: BoundingInfo;
  138938. /**
  138939. * Gets or sets the shadow casters bounding info.
  138940. * If you provide your own shadow casters bounding info, first enable freezeShadowCastersBoundingInfo
  138941. * so that the system won't overwrite the bounds you provide
  138942. */
  138943. get shadowCastersBoundingInfo(): BoundingInfo;
  138944. set shadowCastersBoundingInfo(boundingInfo: BoundingInfo);
  138945. protected _breaksAreDirty: boolean;
  138946. protected _minDistance: number;
  138947. protected _maxDistance: number;
  138948. /**
  138949. * Sets the minimal and maximal distances to use when computing the cascade breaks.
  138950. *
  138951. * The values of min / max are typically the depth zmin and zmax values of your scene, for a given frame.
  138952. * If you don't know these values, simply leave them to their defaults and don't call this function.
  138953. * @param min minimal distance for the breaks (default to 0.)
  138954. * @param max maximal distance for the breaks (default to 1.)
  138955. */
  138956. setMinMaxDistance(min: number, max: number): void;
  138957. /** Gets the minimal distance used in the cascade break computation */
  138958. get minDistance(): number;
  138959. /** Gets the maximal distance used in the cascade break computation */
  138960. get maxDistance(): number;
  138961. /**
  138962. * Gets the class name of that object
  138963. * @returns "CascadedShadowGenerator"
  138964. */
  138965. getClassName(): string;
  138966. private _cascadeMinExtents;
  138967. private _cascadeMaxExtents;
  138968. /**
  138969. * Gets a cascade minimum extents
  138970. * @param cascadeIndex index of the cascade
  138971. * @returns the minimum cascade extents
  138972. */
  138973. getCascadeMinExtents(cascadeIndex: number): Nullable<Vector3>;
  138974. /**
  138975. * Gets a cascade maximum extents
  138976. * @param cascadeIndex index of the cascade
  138977. * @returns the maximum cascade extents
  138978. */
  138979. getCascadeMaxExtents(cascadeIndex: number): Nullable<Vector3>;
  138980. private _cascades;
  138981. private _currentLayer;
  138982. private _viewSpaceFrustumsZ;
  138983. private _viewMatrices;
  138984. private _projectionMatrices;
  138985. private _transformMatrices;
  138986. private _transformMatricesAsArray;
  138987. private _frustumLengths;
  138988. private _lightSizeUVCorrection;
  138989. private _depthCorrection;
  138990. private _frustumCornersWorldSpace;
  138991. private _frustumCenter;
  138992. private _shadowCameraPos;
  138993. private _shadowMaxZ;
  138994. /**
  138995. * Gets the shadow max z distance. It's the limit beyond which shadows are not displayed.
  138996. * It defaults to camera.maxZ
  138997. */
  138998. get shadowMaxZ(): number;
  138999. /**
  139000. * Sets the shadow max z distance.
  139001. */
  139002. set shadowMaxZ(value: number);
  139003. protected _debug: boolean;
  139004. /**
  139005. * Gets or sets the debug flag.
  139006. * When enabled, the cascades are materialized by different colors on the screen.
  139007. */
  139008. get debug(): boolean;
  139009. set debug(dbg: boolean);
  139010. private _depthClamp;
  139011. /**
  139012. * Gets or sets the depth clamping value.
  139013. *
  139014. * When enabled, it improves the shadow quality because the near z plane of the light frustum don't need to be adjusted
  139015. * to account for the shadow casters far away.
  139016. *
  139017. * Note that this property is incompatible with PCSS filtering, so it won't be used in that case.
  139018. */
  139019. get depthClamp(): boolean;
  139020. set depthClamp(value: boolean);
  139021. private _cascadeBlendPercentage;
  139022. /**
  139023. * Gets or sets the percentage of blending between two cascades (value between 0. and 1.).
  139024. * It defaults to 0.1 (10% blending).
  139025. */
  139026. get cascadeBlendPercentage(): number;
  139027. set cascadeBlendPercentage(value: number);
  139028. private _lambda;
  139029. /**
  139030. * Gets or set the lambda parameter.
  139031. * This parameter is used to split the camera frustum and create the cascades.
  139032. * 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.
  139033. * For all values in-between, it's a linear combination of the uniform and logarithm split algorithm.
  139034. */
  139035. get lambda(): number;
  139036. set lambda(value: number);
  139037. /**
  139038. * Gets the view matrix corresponding to a given cascade
  139039. * @param cascadeNum cascade to retrieve the view matrix from
  139040. * @returns the cascade view matrix
  139041. */
  139042. getCascadeViewMatrix(cascadeNum: number): Nullable<Matrix>;
  139043. /**
  139044. * Gets the projection matrix corresponding to a given cascade
  139045. * @param cascadeNum cascade to retrieve the projection matrix from
  139046. * @returns the cascade projection matrix
  139047. */
  139048. getCascadeProjectionMatrix(cascadeNum: number): Nullable<Matrix>;
  139049. /**
  139050. * Gets the transformation matrix corresponding to a given cascade
  139051. * @param cascadeNum cascade to retrieve the transformation matrix from
  139052. * @returns the cascade transformation matrix
  139053. */
  139054. getCascadeTransformMatrix(cascadeNum: number): Nullable<Matrix>;
  139055. private _depthRenderer;
  139056. /**
  139057. * Sets the depth renderer to use when autoCalcDepthBounds is enabled.
  139058. *
  139059. * Note that if no depth renderer is set, a new one will be automatically created internally when necessary.
  139060. *
  139061. * You should call this function if you already have a depth renderer enabled in your scene, to avoid
  139062. * doing multiple depth rendering each frame. If you provide your own depth renderer, make sure it stores linear depth!
  139063. * @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
  139064. */
  139065. setDepthRenderer(depthRenderer: Nullable<DepthRenderer>): void;
  139066. private _depthReducer;
  139067. private _autoCalcDepthBounds;
  139068. /**
  139069. * Gets or sets the autoCalcDepthBounds property.
  139070. *
  139071. * When enabled, a depth rendering pass is first performed (with an internally created depth renderer or with the one
  139072. * you provide by calling setDepthRenderer). Then, a min/max reducing is applied on the depth map to compute the
  139073. * minimal and maximal depth of the map and those values are used as inputs for the setMinMaxDistance() function.
  139074. * It can greatly enhance the shadow quality, at the expense of more GPU works.
  139075. * When using this option, you should increase the value of the lambda parameter, and even set it to 1 for best results.
  139076. */
  139077. get autoCalcDepthBounds(): boolean;
  139078. set autoCalcDepthBounds(value: boolean);
  139079. /**
  139080. * Defines the refresh rate of the min/max computation used when autoCalcDepthBounds is set to true
  139081. * Use 0 to compute just once, 1 to compute on every frame, 2 to compute every two frames and so on...
  139082. * Note that if you provided your own depth renderer through a call to setDepthRenderer, you are responsible
  139083. * for setting the refresh rate on the renderer yourself!
  139084. */
  139085. get autoCalcDepthBoundsRefreshRate(): number;
  139086. set autoCalcDepthBoundsRefreshRate(value: number);
  139087. /**
  139088. * Create the cascade breaks according to the lambda, shadowMaxZ and min/max distance properties, as well as the camera near and far planes.
  139089. * This function is automatically called when updating lambda, shadowMaxZ and min/max distances, however you should call it yourself if
  139090. * you change the camera near/far planes!
  139091. */
  139092. splitFrustum(): void;
  139093. private _splitFrustum;
  139094. private _computeMatrices;
  139095. private _computeFrustumInWorldSpace;
  139096. private _computeCascadeFrustum;
  139097. /**
  139098. * Support test.
  139099. */
  139100. static get IsSupported(): boolean;
  139101. /** @hidden */
  139102. static _SceneComponentInitialization: (scene: Scene) => void;
  139103. /**
  139104. * Creates a Cascaded Shadow Generator object.
  139105. * A ShadowGenerator is the required tool to use the shadows.
  139106. * Each directional light casting shadows needs to use its own ShadowGenerator.
  139107. * Documentation : https://doc.babylonjs.com/babylon101/cascadedShadows
  139108. * @param mapSize The size of the texture what stores the shadows. Example : 1024.
  139109. * @param light The directional light object generating the shadows.
  139110. * @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.
  139111. */
  139112. constructor(mapSize: number, light: DirectionalLight, usefulFloatFirst?: boolean);
  139113. protected _initializeGenerator(): void;
  139114. protected _createTargetRenderTexture(): void;
  139115. protected _initializeShadowMap(): void;
  139116. protected _bindCustomEffectForRenderSubMeshForShadowMap(subMesh: SubMesh, effect: Effect, matriceNames: any, mesh: AbstractMesh): void;
  139117. protected _isReadyCustomDefines(defines: any, subMesh: SubMesh, useInstances: boolean): void;
  139118. /**
  139119. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  139120. * @param defines Defines of the material we want to update
  139121. * @param lightIndex Index of the light in the enabled light list of the material
  139122. */
  139123. prepareDefines(defines: any, lightIndex: number): void;
  139124. /**
  139125. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  139126. * defined in the generator but impacting the effect).
  139127. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  139128. * @param effect The effect we are binfing the information for
  139129. */
  139130. bindShadowLight(lightIndex: string, effect: Effect): void;
  139131. /**
  139132. * Gets the transformation matrix of the first cascade used to project the meshes into the map from the light point of view.
  139133. * (eq to view projection * shadow projection matrices)
  139134. * @returns The transform matrix used to create the shadow map
  139135. */
  139136. getTransformMatrix(): Matrix;
  139137. /**
  139138. * Disposes the ShadowGenerator.
  139139. * Returns nothing.
  139140. */
  139141. dispose(): void;
  139142. /**
  139143. * Serializes the shadow generator setup to a json object.
  139144. * @returns The serialized JSON object
  139145. */
  139146. serialize(): any;
  139147. /**
  139148. * Parses a serialized ShadowGenerator and returns a new ShadowGenerator.
  139149. * @param parsedShadowGenerator The JSON object to parse
  139150. * @param scene The scene to create the shadow map for
  139151. * @returns The parsed shadow generator
  139152. */
  139153. static Parse(parsedShadowGenerator: any, scene: Scene): ShadowGenerator;
  139154. }
  139155. }
  139156. declare module BABYLON {
  139157. /**
  139158. * Defines the shadow generator component responsible to manage any shadow generators
  139159. * in a given scene.
  139160. */
  139161. export class ShadowGeneratorSceneComponent implements ISceneSerializableComponent {
  139162. /**
  139163. * The component name helpfull to identify the component in the list of scene components.
  139164. */
  139165. readonly name: string;
  139166. /**
  139167. * The scene the component belongs to.
  139168. */
  139169. scene: Scene;
  139170. /**
  139171. * Creates a new instance of the component for the given scene
  139172. * @param scene Defines the scene to register the component in
  139173. */
  139174. constructor(scene: Scene);
  139175. /**
  139176. * Registers the component in a given scene
  139177. */
  139178. register(): void;
  139179. /**
  139180. * Rebuilds the elements related to this component in case of
  139181. * context lost for instance.
  139182. */
  139183. rebuild(): void;
  139184. /**
  139185. * Serializes the component data to the specified json object
  139186. * @param serializationObject The object to serialize to
  139187. */
  139188. serialize(serializationObject: any): void;
  139189. /**
  139190. * Adds all the elements from the container to the scene
  139191. * @param container the container holding the elements
  139192. */
  139193. addFromContainer(container: AbstractScene): void;
  139194. /**
  139195. * Removes all the elements in the container from the scene
  139196. * @param container contains the elements to remove
  139197. * @param dispose if the removed element should be disposed (default: false)
  139198. */
  139199. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  139200. /**
  139201. * Rebuilds the elements related to this component in case of
  139202. * context lost for instance.
  139203. */
  139204. dispose(): void;
  139205. private _gatherRenderTargets;
  139206. }
  139207. }
  139208. declare module BABYLON {
  139209. /**
  139210. * A point light is a light defined by an unique point in world space.
  139211. * The light is emitted in every direction from this point.
  139212. * A good example of a point light is a standard light bulb.
  139213. * Documentation: https://doc.babylonjs.com/babylon101/lights
  139214. */
  139215. export class PointLight extends ShadowLight {
  139216. private _shadowAngle;
  139217. /**
  139218. * Getter: In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  139219. * This specifies what angle the shadow will use to be created.
  139220. *
  139221. * It default to 90 degrees to work nicely with the cube texture generation for point lights shadow maps.
  139222. */
  139223. get shadowAngle(): number;
  139224. /**
  139225. * Setter: In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  139226. * This specifies what angle the shadow will use to be created.
  139227. *
  139228. * It default to 90 degrees to work nicely with the cube texture generation for point lights shadow maps.
  139229. */
  139230. set shadowAngle(value: number);
  139231. /**
  139232. * Gets the direction if it has been set.
  139233. * In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  139234. */
  139235. get direction(): Vector3;
  139236. /**
  139237. * In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  139238. */
  139239. set direction(value: Vector3);
  139240. /**
  139241. * Creates a PointLight object from the passed name and position (Vector3) and adds it in the scene.
  139242. * A PointLight emits the light in every direction.
  139243. * It can cast shadows.
  139244. * If the scene camera is already defined and you want to set your PointLight at the camera position, just set it :
  139245. * ```javascript
  139246. * var pointLight = new PointLight("pl", camera.position, scene);
  139247. * ```
  139248. * Documentation : https://doc.babylonjs.com/babylon101/lights
  139249. * @param name The light friendly name
  139250. * @param position The position of the point light in the scene
  139251. * @param scene The scene the lights belongs to
  139252. */
  139253. constructor(name: string, position: Vector3, scene: Scene);
  139254. /**
  139255. * Returns the string "PointLight"
  139256. * @returns the class name
  139257. */
  139258. getClassName(): string;
  139259. /**
  139260. * Returns the integer 0.
  139261. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  139262. */
  139263. getTypeID(): number;
  139264. /**
  139265. * Specifies wether or not the shadowmap should be a cube texture.
  139266. * @returns true if the shadowmap needs to be a cube texture.
  139267. */
  139268. needCube(): boolean;
  139269. /**
  139270. * Returns a new Vector3 aligned with the PointLight cube system according to the passed cube face index (integer).
  139271. * @param faceIndex The index of the face we are computed the direction to generate shadow
  139272. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  139273. */
  139274. getShadowDirection(faceIndex?: number): Vector3;
  139275. /**
  139276. * Sets the passed matrix "matrix" as a left-handed perspective projection matrix with the following settings :
  139277. * - fov = PI / 2
  139278. * - aspect ratio : 1.0
  139279. * - z-near and far equal to the active camera minZ and maxZ.
  139280. * Returns the PointLight.
  139281. */
  139282. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  139283. protected _buildUniformLayout(): void;
  139284. /**
  139285. * Sets the passed Effect "effect" with the PointLight transformed position (or position, if none) and passed name (string).
  139286. * @param effect The effect to update
  139287. * @param lightIndex The index of the light in the effect to update
  139288. * @returns The point light
  139289. */
  139290. transferToEffect(effect: Effect, lightIndex: string): PointLight;
  139291. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  139292. /**
  139293. * Prepares the list of defines specific to the light type.
  139294. * @param defines the list of defines
  139295. * @param lightIndex defines the index of the light for the effect
  139296. */
  139297. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  139298. }
  139299. }
  139300. declare module BABYLON {
  139301. /**
  139302. * Header information of HDR texture files.
  139303. */
  139304. export interface HDRInfo {
  139305. /**
  139306. * The height of the texture in pixels.
  139307. */
  139308. height: number;
  139309. /**
  139310. * The width of the texture in pixels.
  139311. */
  139312. width: number;
  139313. /**
  139314. * The index of the beginning of the data in the binary file.
  139315. */
  139316. dataPosition: number;
  139317. }
  139318. /**
  139319. * This groups tools to convert HDR texture to native colors array.
  139320. */
  139321. export class HDRTools {
  139322. private static Ldexp;
  139323. private static Rgbe2float;
  139324. private static readStringLine;
  139325. /**
  139326. * Reads header information from an RGBE texture stored in a native array.
  139327. * More information on this format are available here:
  139328. * https://en.wikipedia.org/wiki/RGBE_image_format
  139329. *
  139330. * @param uint8array The binary file stored in native array.
  139331. * @return The header information.
  139332. */
  139333. static RGBE_ReadHeader(uint8array: Uint8Array): HDRInfo;
  139334. /**
  139335. * Returns the cubemap information (each faces texture data) extracted from an RGBE texture.
  139336. * This RGBE texture needs to store the information as a panorama.
  139337. *
  139338. * More information on this format are available here:
  139339. * https://en.wikipedia.org/wiki/RGBE_image_format
  139340. *
  139341. * @param buffer The binary file stored in an array buffer.
  139342. * @param size The expected size of the extracted cubemap.
  139343. * @return The Cube Map information.
  139344. */
  139345. static GetCubeMapTextureData(buffer: ArrayBuffer, size: number): CubeMapInfo;
  139346. /**
  139347. * Returns the pixels data extracted from an RGBE texture.
  139348. * This pixels will be stored left to right up to down in the R G B order in one array.
  139349. *
  139350. * More information on this format are available here:
  139351. * https://en.wikipedia.org/wiki/RGBE_image_format
  139352. *
  139353. * @param uint8array The binary file stored in an array buffer.
  139354. * @param hdrInfo The header information of the file.
  139355. * @return The pixels data in RGB right to left up to down order.
  139356. */
  139357. static RGBE_ReadPixels(uint8array: Uint8Array, hdrInfo: HDRInfo): Float32Array;
  139358. private static RGBE_ReadPixels_RLE;
  139359. private static RGBE_ReadPixels_NOT_RLE;
  139360. }
  139361. }
  139362. declare module BABYLON {
  139363. /**
  139364. * Effect Render Options
  139365. */
  139366. export interface IEffectRendererOptions {
  139367. /**
  139368. * Defines the vertices positions.
  139369. */
  139370. positions?: number[];
  139371. /**
  139372. * Defines the indices.
  139373. */
  139374. indices?: number[];
  139375. }
  139376. /**
  139377. * Helper class to render one or more effects.
  139378. * You can access the previous rendering in your shader by declaring a sampler named textureSampler
  139379. */
  139380. export class EffectRenderer {
  139381. private engine;
  139382. private static _DefaultOptions;
  139383. private _vertexBuffers;
  139384. private _indexBuffer;
  139385. private _fullscreenViewport;
  139386. /**
  139387. * Creates an effect renderer
  139388. * @param engine the engine to use for rendering
  139389. * @param options defines the options of the effect renderer
  139390. */
  139391. constructor(engine: ThinEngine, options?: IEffectRendererOptions);
  139392. /**
  139393. * Sets the current viewport in normalized coordinates 0-1
  139394. * @param viewport Defines the viewport to set (defaults to 0 0 1 1)
  139395. */
  139396. setViewport(viewport?: Viewport): void;
  139397. /**
  139398. * Binds the embedded attributes buffer to the effect.
  139399. * @param effect Defines the effect to bind the attributes for
  139400. */
  139401. bindBuffers(effect: Effect): void;
  139402. /**
  139403. * Sets the current effect wrapper to use during draw.
  139404. * The effect needs to be ready before calling this api.
  139405. * This also sets the default full screen position attribute.
  139406. * @param effectWrapper Defines the effect to draw with
  139407. */
  139408. applyEffectWrapper(effectWrapper: EffectWrapper): void;
  139409. /**
  139410. * Restores engine states
  139411. */
  139412. restoreStates(): void;
  139413. /**
  139414. * Draws a full screen quad.
  139415. */
  139416. draw(): void;
  139417. private isRenderTargetTexture;
  139418. /**
  139419. * renders one or more effects to a specified texture
  139420. * @param effectWrapper the effect to renderer
  139421. * @param outputTexture texture to draw to, if null it will render to the screen.
  139422. */
  139423. render(effectWrapper: EffectWrapper, outputTexture?: Nullable<InternalTexture | RenderTargetTexture>): void;
  139424. /**
  139425. * Disposes of the effect renderer
  139426. */
  139427. dispose(): void;
  139428. }
  139429. /**
  139430. * Options to create an EffectWrapper
  139431. */
  139432. interface EffectWrapperCreationOptions {
  139433. /**
  139434. * Engine to use to create the effect
  139435. */
  139436. engine: ThinEngine;
  139437. /**
  139438. * Fragment shader for the effect
  139439. */
  139440. fragmentShader: string;
  139441. /**
  139442. * Use the shader store instead of direct source code
  139443. */
  139444. useShaderStore?: boolean;
  139445. /**
  139446. * Vertex shader for the effect
  139447. */
  139448. vertexShader?: string;
  139449. /**
  139450. * Attributes to use in the shader
  139451. */
  139452. attributeNames?: Array<string>;
  139453. /**
  139454. * Uniforms to use in the shader
  139455. */
  139456. uniformNames?: Array<string>;
  139457. /**
  139458. * Texture sampler names to use in the shader
  139459. */
  139460. samplerNames?: Array<string>;
  139461. /**
  139462. * Defines to use in the shader
  139463. */
  139464. defines?: Array<string>;
  139465. /**
  139466. * Callback when effect is compiled
  139467. */
  139468. onCompiled?: Nullable<(effect: Effect) => void>;
  139469. /**
  139470. * The friendly name of the effect displayed in Spector.
  139471. */
  139472. name?: string;
  139473. }
  139474. /**
  139475. * Wraps an effect to be used for rendering
  139476. */
  139477. export class EffectWrapper {
  139478. /**
  139479. * Event that is fired right before the effect is drawn (should be used to update uniforms)
  139480. */
  139481. onApplyObservable: Observable<{}>;
  139482. /**
  139483. * The underlying effect
  139484. */
  139485. effect: Effect;
  139486. /**
  139487. * Creates an effect to be renderer
  139488. * @param creationOptions options to create the effect
  139489. */
  139490. constructor(creationOptions: EffectWrapperCreationOptions);
  139491. /**
  139492. * Disposes of the effect wrapper
  139493. */
  139494. dispose(): void;
  139495. }
  139496. }
  139497. declare module BABYLON {
  139498. /** @hidden */
  139499. export var hdrFilteringVertexShader: {
  139500. name: string;
  139501. shader: string;
  139502. };
  139503. }
  139504. declare module BABYLON {
  139505. /** @hidden */
  139506. export var hdrFilteringPixelShader: {
  139507. name: string;
  139508. shader: string;
  139509. };
  139510. }
  139511. declare module BABYLON {
  139512. /**
  139513. * Options for texture filtering
  139514. */
  139515. interface IHDRFilteringOptions {
  139516. /**
  139517. * Scales pixel intensity for the input HDR map.
  139518. */
  139519. hdrScale?: number;
  139520. /**
  139521. * Quality of the filter. Should be `Constants.TEXTURE_FILTERING_QUALITY_OFFLINE` for prefiltering
  139522. */
  139523. quality?: number;
  139524. }
  139525. /**
  139526. * Filters HDR maps to get correct renderings of PBR reflections
  139527. */
  139528. export class HDRFiltering {
  139529. private _engine;
  139530. private _effectRenderer;
  139531. private _effectWrapper;
  139532. private _lodGenerationOffset;
  139533. private _lodGenerationScale;
  139534. /**
  139535. * Quality switch for prefiltering. Should be set to `Constants.TEXTURE_FILTERING_QUALITY_OFFLINE` unless
  139536. * you care about baking speed.
  139537. */
  139538. quality: number;
  139539. /**
  139540. * Scales pixel intensity for the input HDR map.
  139541. */
  139542. hdrScale: number;
  139543. /**
  139544. * Instantiates HDR filter for reflection maps
  139545. *
  139546. * @param engine Thin engine
  139547. * @param options Options
  139548. */
  139549. constructor(engine: ThinEngine, options?: IHDRFilteringOptions);
  139550. private _createRenderTarget;
  139551. private _prefilterInternal;
  139552. private _createEffect;
  139553. /**
  139554. * Get a value indicating if the filter is ready to be used
  139555. * @param texture Texture to filter
  139556. * @returns true if the filter is ready
  139557. */
  139558. isReady(texture: BaseTexture): boolean;
  139559. /**
  139560. * Prefilters a cube texture to have mipmap levels representing roughness values.
  139561. * Prefiltering will be invoked at the end of next rendering pass.
  139562. * This has to be done once the map is loaded, and has not been prefiltered by a third party software.
  139563. * See http://blog.selfshadow.com/publications/s2013-shading-course/karis/s2013_pbs_epic_notes_v2.pdf for more information
  139564. * @param texture Texture to filter
  139565. * @param onFinished Callback when filtering is done
  139566. * @return Promise called when prefiltering is done
  139567. */
  139568. prefilter(texture: BaseTexture, onFinished?: Nullable<() => void>): Promise<unknown> | undefined;
  139569. }
  139570. }
  139571. declare module BABYLON {
  139572. /**
  139573. * This represents a texture coming from an HDR input.
  139574. *
  139575. * The only supported format is currently panorama picture stored in RGBE format.
  139576. * Example of such files can be found on HDRLib: http://hdrlib.com/
  139577. */
  139578. export class HDRCubeTexture extends BaseTexture {
  139579. private static _facesMapping;
  139580. private _generateHarmonics;
  139581. private _noMipmap;
  139582. private _prefilterOnLoad;
  139583. private _textureMatrix;
  139584. private _size;
  139585. private _onLoad;
  139586. private _onError;
  139587. /**
  139588. * The texture URL.
  139589. */
  139590. url: string;
  139591. /**
  139592. * The texture coordinates mode. As this texture is stored in a cube format, please modify carefully.
  139593. */
  139594. coordinatesMode: number;
  139595. protected _isBlocking: boolean;
  139596. /**
  139597. * Sets wether or not the texture is blocking during loading.
  139598. */
  139599. set isBlocking(value: boolean);
  139600. /**
  139601. * Gets wether or not the texture is blocking during loading.
  139602. */
  139603. get isBlocking(): boolean;
  139604. protected _rotationY: number;
  139605. /**
  139606. * Sets texture matrix rotation angle around Y axis in radians.
  139607. */
  139608. set rotationY(value: number);
  139609. /**
  139610. * Gets texture matrix rotation angle around Y axis radians.
  139611. */
  139612. get rotationY(): number;
  139613. /**
  139614. * Gets or sets the center of the bounding box associated with the cube texture
  139615. * It must define where the camera used to render the texture was set
  139616. */
  139617. boundingBoxPosition: Vector3;
  139618. private _boundingBoxSize;
  139619. /**
  139620. * Gets or sets the size of the bounding box associated with the cube texture
  139621. * When defined, the cubemap will switch to local mode
  139622. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  139623. * @example https://www.babylonjs-playground.com/#RNASML
  139624. */
  139625. set boundingBoxSize(value: Vector3);
  139626. get boundingBoxSize(): Vector3;
  139627. /**
  139628. * Instantiates an HDRTexture from the following parameters.
  139629. *
  139630. * @param url The location of the HDR raw data (Panorama stored in RGBE format)
  139631. * @param sceneOrEngine The scene or engine the texture will be used in
  139632. * @param size The cubemap desired size (the more it increases the longer the generation will be)
  139633. * @param noMipmap Forces to not generate the mipmap if true
  139634. * @param generateHarmonics Specifies whether you want to extract the polynomial harmonics during the generation process
  139635. * @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)
  139636. * @param prefilterOnLoad Prefilters HDR texture to allow use of this texture as a PBR reflection texture.
  139637. */
  139638. 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>);
  139639. /**
  139640. * Get the current class name of the texture useful for serialization or dynamic coding.
  139641. * @returns "HDRCubeTexture"
  139642. */
  139643. getClassName(): string;
  139644. /**
  139645. * Occurs when the file is raw .hdr file.
  139646. */
  139647. private loadTexture;
  139648. clone(): HDRCubeTexture;
  139649. delayLoad(): void;
  139650. /**
  139651. * Get the texture reflection matrix used to rotate/transform the reflection.
  139652. * @returns the reflection matrix
  139653. */
  139654. getReflectionTextureMatrix(): Matrix;
  139655. /**
  139656. * Set the texture reflection matrix used to rotate/transform the reflection.
  139657. * @param value Define the reflection matrix to set
  139658. */
  139659. setReflectionTextureMatrix(value: Matrix): void;
  139660. /**
  139661. * Parses a JSON representation of an HDR Texture in order to create the texture
  139662. * @param parsedTexture Define the JSON representation
  139663. * @param scene Define the scene the texture should be created in
  139664. * @param rootUrl Define the root url in case we need to load relative dependencies
  139665. * @returns the newly created texture after parsing
  139666. */
  139667. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): Nullable<HDRCubeTexture>;
  139668. serialize(): any;
  139669. }
  139670. }
  139671. declare module BABYLON {
  139672. /**
  139673. * Class used to control physics engine
  139674. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  139675. */
  139676. export class PhysicsEngine implements IPhysicsEngine {
  139677. private _physicsPlugin;
  139678. /**
  139679. * Global value used to control the smallest number supported by the simulation
  139680. */
  139681. static Epsilon: number;
  139682. private _impostors;
  139683. private _joints;
  139684. private _subTimeStep;
  139685. /**
  139686. * Gets the gravity vector used by the simulation
  139687. */
  139688. gravity: Vector3;
  139689. /**
  139690. * Factory used to create the default physics plugin.
  139691. * @returns The default physics plugin
  139692. */
  139693. static DefaultPluginFactory(): IPhysicsEnginePlugin;
  139694. /**
  139695. * Creates a new Physics Engine
  139696. * @param gravity defines the gravity vector used by the simulation
  139697. * @param _physicsPlugin defines the plugin to use (CannonJS by default)
  139698. */
  139699. constructor(gravity: Nullable<Vector3>, _physicsPlugin?: IPhysicsEnginePlugin);
  139700. /**
  139701. * Sets the gravity vector used by the simulation
  139702. * @param gravity defines the gravity vector to use
  139703. */
  139704. setGravity(gravity: Vector3): void;
  139705. /**
  139706. * Set the time step of the physics engine.
  139707. * Default is 1/60.
  139708. * To slow it down, enter 1/600 for example.
  139709. * To speed it up, 1/30
  139710. * @param newTimeStep defines the new timestep to apply to this world.
  139711. */
  139712. setTimeStep(newTimeStep?: number): void;
  139713. /**
  139714. * Get the time step of the physics engine.
  139715. * @returns the current time step
  139716. */
  139717. getTimeStep(): number;
  139718. /**
  139719. * Set the sub time step of the physics engine.
  139720. * Default is 0 meaning there is no sub steps
  139721. * To increase physics resolution precision, set a small value (like 1 ms)
  139722. * @param subTimeStep defines the new sub timestep used for physics resolution.
  139723. */
  139724. setSubTimeStep(subTimeStep?: number): void;
  139725. /**
  139726. * Get the sub time step of the physics engine.
  139727. * @returns the current sub time step
  139728. */
  139729. getSubTimeStep(): number;
  139730. /**
  139731. * Release all resources
  139732. */
  139733. dispose(): void;
  139734. /**
  139735. * Gets the name of the current physics plugin
  139736. * @returns the name of the plugin
  139737. */
  139738. getPhysicsPluginName(): string;
  139739. /**
  139740. * Adding a new impostor for the impostor tracking.
  139741. * This will be done by the impostor itself.
  139742. * @param impostor the impostor to add
  139743. */
  139744. addImpostor(impostor: PhysicsImpostor): void;
  139745. /**
  139746. * Remove an impostor from the engine.
  139747. * This impostor and its mesh will not longer be updated by the physics engine.
  139748. * @param impostor the impostor to remove
  139749. */
  139750. removeImpostor(impostor: PhysicsImpostor): void;
  139751. /**
  139752. * Add a joint to the physics engine
  139753. * @param mainImpostor defines the main impostor to which the joint is added.
  139754. * @param connectedImpostor defines the impostor that is connected to the main impostor using this joint
  139755. * @param joint defines the joint that will connect both impostors.
  139756. */
  139757. addJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  139758. /**
  139759. * Removes a joint from the simulation
  139760. * @param mainImpostor defines the impostor used with the joint
  139761. * @param connectedImpostor defines the other impostor connected to the main one by the joint
  139762. * @param joint defines the joint to remove
  139763. */
  139764. removeJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  139765. /**
  139766. * Called by the scene. No need to call it.
  139767. * @param delta defines the timespam between frames
  139768. */
  139769. _step(delta: number): void;
  139770. /**
  139771. * Gets the current plugin used to run the simulation
  139772. * @returns current plugin
  139773. */
  139774. getPhysicsPlugin(): IPhysicsEnginePlugin;
  139775. /**
  139776. * Gets the list of physic impostors
  139777. * @returns an array of PhysicsImpostor
  139778. */
  139779. getImpostors(): Array<PhysicsImpostor>;
  139780. /**
  139781. * Gets the impostor for a physics enabled object
  139782. * @param object defines the object impersonated by the impostor
  139783. * @returns the PhysicsImpostor or null if not found
  139784. */
  139785. getImpostorForPhysicsObject(object: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  139786. /**
  139787. * Gets the impostor for a physics body object
  139788. * @param body defines physics body used by the impostor
  139789. * @returns the PhysicsImpostor or null if not found
  139790. */
  139791. getImpostorWithPhysicsBody(body: any): Nullable<PhysicsImpostor>;
  139792. /**
  139793. * Does a raycast in the physics world
  139794. * @param from when should the ray start?
  139795. * @param to when should the ray end?
  139796. * @returns PhysicsRaycastResult
  139797. */
  139798. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  139799. }
  139800. }
  139801. declare module BABYLON {
  139802. /** @hidden */
  139803. export class CannonJSPlugin implements IPhysicsEnginePlugin {
  139804. private _useDeltaForWorldStep;
  139805. world: any;
  139806. name: string;
  139807. private _physicsMaterials;
  139808. private _fixedTimeStep;
  139809. private _cannonRaycastResult;
  139810. private _raycastResult;
  139811. private _physicsBodysToRemoveAfterStep;
  139812. private _firstFrame;
  139813. BJSCANNON: any;
  139814. constructor(_useDeltaForWorldStep?: boolean, iterations?: number, cannonInjection?: any);
  139815. setGravity(gravity: Vector3): void;
  139816. setTimeStep(timeStep: number): void;
  139817. getTimeStep(): number;
  139818. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  139819. private _removeMarkedPhysicsBodiesFromWorld;
  139820. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  139821. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  139822. generatePhysicsBody(impostor: PhysicsImpostor): void;
  139823. private _processChildMeshes;
  139824. removePhysicsBody(impostor: PhysicsImpostor): void;
  139825. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  139826. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  139827. private _addMaterial;
  139828. private _checkWithEpsilon;
  139829. private _createShape;
  139830. private _createHeightmap;
  139831. private _minus90X;
  139832. private _plus90X;
  139833. private _tmpPosition;
  139834. private _tmpDeltaPosition;
  139835. private _tmpUnityRotation;
  139836. private _updatePhysicsBodyTransformation;
  139837. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  139838. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  139839. isSupported(): boolean;
  139840. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  139841. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  139842. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  139843. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  139844. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  139845. getBodyMass(impostor: PhysicsImpostor): number;
  139846. getBodyFriction(impostor: PhysicsImpostor): number;
  139847. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  139848. getBodyRestitution(impostor: PhysicsImpostor): number;
  139849. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  139850. sleepBody(impostor: PhysicsImpostor): void;
  139851. wakeUpBody(impostor: PhysicsImpostor): void;
  139852. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number): void;
  139853. setMotor(joint: IMotorEnabledJoint, speed?: number, maxForce?: number, motorIndex?: number): void;
  139854. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number): void;
  139855. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  139856. getRadius(impostor: PhysicsImpostor): number;
  139857. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  139858. dispose(): void;
  139859. private _extendNamespace;
  139860. /**
  139861. * Does a raycast in the physics world
  139862. * @param from when should the ray start?
  139863. * @param to when should the ray end?
  139864. * @returns PhysicsRaycastResult
  139865. */
  139866. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  139867. }
  139868. }
  139869. declare module BABYLON {
  139870. /** @hidden */
  139871. export class OimoJSPlugin implements IPhysicsEnginePlugin {
  139872. private _useDeltaForWorldStep;
  139873. world: any;
  139874. name: string;
  139875. BJSOIMO: any;
  139876. private _raycastResult;
  139877. private _fixedTimeStep;
  139878. constructor(_useDeltaForWorldStep?: boolean, iterations?: number, oimoInjection?: any);
  139879. setGravity(gravity: Vector3): void;
  139880. setTimeStep(timeStep: number): void;
  139881. getTimeStep(): number;
  139882. private _tmpImpostorsArray;
  139883. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  139884. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  139885. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  139886. generatePhysicsBody(impostor: PhysicsImpostor): void;
  139887. private _tmpPositionVector;
  139888. removePhysicsBody(impostor: PhysicsImpostor): void;
  139889. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  139890. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  139891. isSupported(): boolean;
  139892. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  139893. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  139894. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  139895. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  139896. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  139897. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  139898. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  139899. getBodyMass(impostor: PhysicsImpostor): number;
  139900. getBodyFriction(impostor: PhysicsImpostor): number;
  139901. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  139902. getBodyRestitution(impostor: PhysicsImpostor): number;
  139903. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  139904. sleepBody(impostor: PhysicsImpostor): void;
  139905. wakeUpBody(impostor: PhysicsImpostor): void;
  139906. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  139907. setMotor(joint: IMotorEnabledJoint, speed: number, force?: number, motorIndex?: number): void;
  139908. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  139909. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  139910. getRadius(impostor: PhysicsImpostor): number;
  139911. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  139912. dispose(): void;
  139913. /**
  139914. * Does a raycast in the physics world
  139915. * @param from when should the ray start?
  139916. * @param to when should the ray end?
  139917. * @returns PhysicsRaycastResult
  139918. */
  139919. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  139920. }
  139921. }
  139922. declare module BABYLON {
  139923. /**
  139924. * AmmoJS Physics plugin
  139925. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  139926. * @see https://github.com/kripken/ammo.js/
  139927. */
  139928. export class AmmoJSPlugin implements IPhysicsEnginePlugin {
  139929. private _useDeltaForWorldStep;
  139930. /**
  139931. * Reference to the Ammo library
  139932. */
  139933. bjsAMMO: any;
  139934. /**
  139935. * Created ammoJS world which physics bodies are added to
  139936. */
  139937. world: any;
  139938. /**
  139939. * Name of the plugin
  139940. */
  139941. name: string;
  139942. private _timeStep;
  139943. private _fixedTimeStep;
  139944. private _maxSteps;
  139945. private _tmpQuaternion;
  139946. private _tmpAmmoTransform;
  139947. private _tmpAmmoQuaternion;
  139948. private _tmpAmmoConcreteContactResultCallback;
  139949. private _collisionConfiguration;
  139950. private _dispatcher;
  139951. private _overlappingPairCache;
  139952. private _solver;
  139953. private _softBodySolver;
  139954. private _tmpAmmoVectorA;
  139955. private _tmpAmmoVectorB;
  139956. private _tmpAmmoVectorC;
  139957. private _tmpAmmoVectorD;
  139958. private _tmpContactCallbackResult;
  139959. private _tmpAmmoVectorRCA;
  139960. private _tmpAmmoVectorRCB;
  139961. private _raycastResult;
  139962. private static readonly DISABLE_COLLISION_FLAG;
  139963. private static readonly KINEMATIC_FLAG;
  139964. private static readonly DISABLE_DEACTIVATION_FLAG;
  139965. /**
  139966. * Initializes the ammoJS plugin
  139967. * @param _useDeltaForWorldStep if the time between frames should be used when calculating physics steps (Default: true)
  139968. * @param ammoInjection can be used to inject your own ammo reference
  139969. * @param overlappingPairCache can be used to specify your own overlapping pair cache
  139970. */
  139971. constructor(_useDeltaForWorldStep?: boolean, ammoInjection?: any, overlappingPairCache?: any);
  139972. /**
  139973. * Sets the gravity of the physics world (m/(s^2))
  139974. * @param gravity Gravity to set
  139975. */
  139976. setGravity(gravity: Vector3): void;
  139977. /**
  139978. * Amount of time to step forward on each frame (only used if useDeltaForWorldStep is false in the constructor)
  139979. * @param timeStep timestep to use in seconds
  139980. */
  139981. setTimeStep(timeStep: number): void;
  139982. /**
  139983. * 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)
  139984. * @param fixedTimeStep fixedTimeStep to use in seconds
  139985. */
  139986. setFixedTimeStep(fixedTimeStep: number): void;
  139987. /**
  139988. * Sets the maximum number of steps by the physics engine per frame (Default: 5)
  139989. * @param maxSteps the maximum number of steps by the physics engine per frame
  139990. */
  139991. setMaxSteps(maxSteps: number): void;
  139992. /**
  139993. * Gets the current timestep (only used if useDeltaForWorldStep is false in the constructor)
  139994. * @returns the current timestep in seconds
  139995. */
  139996. getTimeStep(): number;
  139997. /**
  139998. * The create custom shape handler function to be called when using BABYLON.PhysicsImposter.CustomImpostor
  139999. */
  140000. onCreateCustomShape: (impostor: PhysicsImpostor) => any;
  140001. private _isImpostorInContact;
  140002. private _isImpostorPairInContact;
  140003. private _stepSimulation;
  140004. /**
  140005. * Moves the physics simulation forward delta seconds and updates the given physics imposters
  140006. * Prior to the step the imposters physics location is set to the position of the babylon meshes
  140007. * After the step the babylon meshes are set to the position of the physics imposters
  140008. * @param delta amount of time to step forward
  140009. * @param impostors array of imposters to update before/after the step
  140010. */
  140011. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  140012. /**
  140013. * Update babylon mesh to match physics world object
  140014. * @param impostor imposter to match
  140015. */
  140016. private _afterSoftStep;
  140017. /**
  140018. * Update babylon mesh vertices vertices to match physics world softbody or cloth
  140019. * @param impostor imposter to match
  140020. */
  140021. private _ropeStep;
  140022. /**
  140023. * Update babylon mesh vertices vertices to match physics world softbody or cloth
  140024. * @param impostor imposter to match
  140025. */
  140026. private _softbodyOrClothStep;
  140027. private _tmpMatrix;
  140028. /**
  140029. * Applies an impulse on the imposter
  140030. * @param impostor imposter to apply impulse to
  140031. * @param force amount of force to be applied to the imposter
  140032. * @param contactPoint the location to apply the impulse on the imposter
  140033. */
  140034. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  140035. /**
  140036. * Applies a force on the imposter
  140037. * @param impostor imposter to apply force
  140038. * @param force amount of force to be applied to the imposter
  140039. * @param contactPoint the location to apply the force on the imposter
  140040. */
  140041. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  140042. /**
  140043. * Creates a physics body using the plugin
  140044. * @param impostor the imposter to create the physics body on
  140045. */
  140046. generatePhysicsBody(impostor: PhysicsImpostor): void;
  140047. /**
  140048. * Removes the physics body from the imposter and disposes of the body's memory
  140049. * @param impostor imposter to remove the physics body from
  140050. */
  140051. removePhysicsBody(impostor: PhysicsImpostor): void;
  140052. /**
  140053. * Generates a joint
  140054. * @param impostorJoint the imposter joint to create the joint with
  140055. */
  140056. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  140057. /**
  140058. * Removes a joint
  140059. * @param impostorJoint the imposter joint to remove the joint from
  140060. */
  140061. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  140062. private _addMeshVerts;
  140063. /**
  140064. * Initialise the soft body vertices to match its object's (mesh) vertices
  140065. * Softbody vertices (nodes) are in world space and to match this
  140066. * The object's position and rotation is set to zero and so its vertices are also then set in world space
  140067. * @param impostor to create the softbody for
  140068. */
  140069. private _softVertexData;
  140070. /**
  140071. * Create an impostor's soft body
  140072. * @param impostor to create the softbody for
  140073. */
  140074. private _createSoftbody;
  140075. /**
  140076. * Create cloth for an impostor
  140077. * @param impostor to create the softbody for
  140078. */
  140079. private _createCloth;
  140080. /**
  140081. * Create rope for an impostor
  140082. * @param impostor to create the softbody for
  140083. */
  140084. private _createRope;
  140085. /**
  140086. * Create a custom physics impostor shape using the plugin's onCreateCustomShape handler
  140087. * @param impostor to create the custom physics shape for
  140088. */
  140089. private _createCustom;
  140090. private _addHullVerts;
  140091. private _createShape;
  140092. /**
  140093. * Sets the physics body position/rotation from the babylon mesh's position/rotation
  140094. * @param impostor imposter containing the physics body and babylon object
  140095. */
  140096. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  140097. /**
  140098. * Sets the babylon object's position/rotation from the physics body's position/rotation
  140099. * @param impostor imposter containing the physics body and babylon object
  140100. * @param newPosition new position
  140101. * @param newRotation new rotation
  140102. */
  140103. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  140104. /**
  140105. * If this plugin is supported
  140106. * @returns true if its supported
  140107. */
  140108. isSupported(): boolean;
  140109. /**
  140110. * Sets the linear velocity of the physics body
  140111. * @param impostor imposter to set the velocity on
  140112. * @param velocity velocity to set
  140113. */
  140114. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  140115. /**
  140116. * Sets the angular velocity of the physics body
  140117. * @param impostor imposter to set the velocity on
  140118. * @param velocity velocity to set
  140119. */
  140120. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  140121. /**
  140122. * gets the linear velocity
  140123. * @param impostor imposter to get linear velocity from
  140124. * @returns linear velocity
  140125. */
  140126. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  140127. /**
  140128. * gets the angular velocity
  140129. * @param impostor imposter to get angular velocity from
  140130. * @returns angular velocity
  140131. */
  140132. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  140133. /**
  140134. * Sets the mass of physics body
  140135. * @param impostor imposter to set the mass on
  140136. * @param mass mass to set
  140137. */
  140138. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  140139. /**
  140140. * Gets the mass of the physics body
  140141. * @param impostor imposter to get the mass from
  140142. * @returns mass
  140143. */
  140144. getBodyMass(impostor: PhysicsImpostor): number;
  140145. /**
  140146. * Gets friction of the impostor
  140147. * @param impostor impostor to get friction from
  140148. * @returns friction value
  140149. */
  140150. getBodyFriction(impostor: PhysicsImpostor): number;
  140151. /**
  140152. * Sets friction of the impostor
  140153. * @param impostor impostor to set friction on
  140154. * @param friction friction value
  140155. */
  140156. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  140157. /**
  140158. * Gets restitution of the impostor
  140159. * @param impostor impostor to get restitution from
  140160. * @returns restitution value
  140161. */
  140162. getBodyRestitution(impostor: PhysicsImpostor): number;
  140163. /**
  140164. * Sets resitution of the impostor
  140165. * @param impostor impostor to set resitution on
  140166. * @param restitution resitution value
  140167. */
  140168. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  140169. /**
  140170. * Gets pressure inside the impostor
  140171. * @param impostor impostor to get pressure from
  140172. * @returns pressure value
  140173. */
  140174. getBodyPressure(impostor: PhysicsImpostor): number;
  140175. /**
  140176. * Sets pressure inside a soft body impostor
  140177. * Cloth and rope must remain 0 pressure
  140178. * @param impostor impostor to set pressure on
  140179. * @param pressure pressure value
  140180. */
  140181. setBodyPressure(impostor: PhysicsImpostor, pressure: number): void;
  140182. /**
  140183. * Gets stiffness of the impostor
  140184. * @param impostor impostor to get stiffness from
  140185. * @returns pressure value
  140186. */
  140187. getBodyStiffness(impostor: PhysicsImpostor): number;
  140188. /**
  140189. * Sets stiffness of the impostor
  140190. * @param impostor impostor to set stiffness on
  140191. * @param stiffness stiffness value from 0 to 1
  140192. */
  140193. setBodyStiffness(impostor: PhysicsImpostor, stiffness: number): void;
  140194. /**
  140195. * Gets velocityIterations of the impostor
  140196. * @param impostor impostor to get velocity iterations from
  140197. * @returns velocityIterations value
  140198. */
  140199. getBodyVelocityIterations(impostor: PhysicsImpostor): number;
  140200. /**
  140201. * Sets velocityIterations of the impostor
  140202. * @param impostor impostor to set velocity iterations on
  140203. * @param velocityIterations velocityIterations value
  140204. */
  140205. setBodyVelocityIterations(impostor: PhysicsImpostor, velocityIterations: number): void;
  140206. /**
  140207. * Gets positionIterations of the impostor
  140208. * @param impostor impostor to get position iterations from
  140209. * @returns positionIterations value
  140210. */
  140211. getBodyPositionIterations(impostor: PhysicsImpostor): number;
  140212. /**
  140213. * Sets positionIterations of the impostor
  140214. * @param impostor impostor to set position on
  140215. * @param positionIterations positionIterations value
  140216. */
  140217. setBodyPositionIterations(impostor: PhysicsImpostor, positionIterations: number): void;
  140218. /**
  140219. * Append an anchor to a cloth object
  140220. * @param impostor is the cloth impostor to add anchor to
  140221. * @param otherImpostor is the rigid impostor to anchor to
  140222. * @param width ratio across width from 0 to 1
  140223. * @param height ratio up height from 0 to 1
  140224. * @param influence the elasticity between cloth impostor and anchor from 0, very stretchy to 1, little strech
  140225. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  140226. */
  140227. appendAnchor(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, width: number, height: number, influence?: number, noCollisionBetweenLinkedBodies?: boolean): void;
  140228. /**
  140229. * Append an hook to a rope object
  140230. * @param impostor is the rope impostor to add hook to
  140231. * @param otherImpostor is the rigid impostor to hook to
  140232. * @param length ratio along the rope from 0 to 1
  140233. * @param influence the elasticity between soft impostor and anchor from 0, very stretchy to 1, little strech
  140234. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  140235. */
  140236. appendHook(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, length: number, influence?: number, noCollisionBetweenLinkedBodies?: boolean): void;
  140237. /**
  140238. * Sleeps the physics body and stops it from being active
  140239. * @param impostor impostor to sleep
  140240. */
  140241. sleepBody(impostor: PhysicsImpostor): void;
  140242. /**
  140243. * Activates the physics body
  140244. * @param impostor impostor to activate
  140245. */
  140246. wakeUpBody(impostor: PhysicsImpostor): void;
  140247. /**
  140248. * Updates the distance parameters of the joint
  140249. * @param joint joint to update
  140250. * @param maxDistance maximum distance of the joint
  140251. * @param minDistance minimum distance of the joint
  140252. */
  140253. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  140254. /**
  140255. * Sets a motor on the joint
  140256. * @param joint joint to set motor on
  140257. * @param speed speed of the motor
  140258. * @param maxForce maximum force of the motor
  140259. * @param motorIndex index of the motor
  140260. */
  140261. setMotor(joint: IMotorEnabledJoint, speed?: number, maxForce?: number, motorIndex?: number): void;
  140262. /**
  140263. * Sets the motors limit
  140264. * @param joint joint to set limit on
  140265. * @param upperLimit upper limit
  140266. * @param lowerLimit lower limit
  140267. */
  140268. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number): void;
  140269. /**
  140270. * Syncs the position and rotation of a mesh with the impostor
  140271. * @param mesh mesh to sync
  140272. * @param impostor impostor to update the mesh with
  140273. */
  140274. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  140275. /**
  140276. * Gets the radius of the impostor
  140277. * @param impostor impostor to get radius from
  140278. * @returns the radius
  140279. */
  140280. getRadius(impostor: PhysicsImpostor): number;
  140281. /**
  140282. * Gets the box size of the impostor
  140283. * @param impostor impostor to get box size from
  140284. * @param result the resulting box size
  140285. */
  140286. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  140287. /**
  140288. * Disposes of the impostor
  140289. */
  140290. dispose(): void;
  140291. /**
  140292. * Does a raycast in the physics world
  140293. * @param from when should the ray start?
  140294. * @param to when should the ray end?
  140295. * @returns PhysicsRaycastResult
  140296. */
  140297. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  140298. }
  140299. }
  140300. declare module BABYLON {
  140301. interface AbstractScene {
  140302. /**
  140303. * The list of reflection probes added to the scene
  140304. * @see https://doc.babylonjs.com/how_to/how_to_use_reflection_probes
  140305. */
  140306. reflectionProbes: Array<ReflectionProbe>;
  140307. /**
  140308. * Removes the given reflection probe from this scene.
  140309. * @param toRemove The reflection probe to remove
  140310. * @returns The index of the removed reflection probe
  140311. */
  140312. removeReflectionProbe(toRemove: ReflectionProbe): number;
  140313. /**
  140314. * Adds the given reflection probe to this scene.
  140315. * @param newReflectionProbe The reflection probe to add
  140316. */
  140317. addReflectionProbe(newReflectionProbe: ReflectionProbe): void;
  140318. }
  140319. /**
  140320. * Class used to generate realtime reflection / refraction cube textures
  140321. * @see https://doc.babylonjs.com/how_to/how_to_use_reflection_probes
  140322. */
  140323. export class ReflectionProbe {
  140324. /** defines the name of the probe */
  140325. name: string;
  140326. private _scene;
  140327. private _renderTargetTexture;
  140328. private _projectionMatrix;
  140329. private _viewMatrix;
  140330. private _target;
  140331. private _add;
  140332. private _attachedMesh;
  140333. private _invertYAxis;
  140334. /** Gets or sets probe position (center of the cube map) */
  140335. position: Vector3;
  140336. /**
  140337. * Creates a new reflection probe
  140338. * @param name defines the name of the probe
  140339. * @param size defines the texture resolution (for each face)
  140340. * @param scene defines the hosting scene
  140341. * @param generateMipMaps defines if mip maps should be generated automatically (true by default)
  140342. * @param useFloat defines if HDR data (flaot data) should be used to store colors (false by default)
  140343. */
  140344. constructor(
  140345. /** defines the name of the probe */
  140346. name: string, size: number, scene: Scene, generateMipMaps?: boolean, useFloat?: boolean);
  140347. /** Gets or sets the number of samples to use for multi-sampling (0 by default). Required WebGL2 */
  140348. get samples(): number;
  140349. set samples(value: number);
  140350. /** Gets or sets the refresh rate to use (on every frame by default) */
  140351. get refreshRate(): number;
  140352. set refreshRate(value: number);
  140353. /**
  140354. * Gets the hosting scene
  140355. * @returns a Scene
  140356. */
  140357. getScene(): Scene;
  140358. /** Gets the internal CubeTexture used to render to */
  140359. get cubeTexture(): RenderTargetTexture;
  140360. /** Gets the list of meshes to render */
  140361. get renderList(): Nullable<AbstractMesh[]>;
  140362. /**
  140363. * Attach the probe to a specific mesh (Rendering will be done from attached mesh's position)
  140364. * @param mesh defines the mesh to attach to
  140365. */
  140366. attachToMesh(mesh: Nullable<AbstractMesh>): void;
  140367. /**
  140368. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups
  140369. * @param renderingGroupId The rendering group id corresponding to its index
  140370. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  140371. */
  140372. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean): void;
  140373. /**
  140374. * Clean all associated resources
  140375. */
  140376. dispose(): void;
  140377. /**
  140378. * Converts the reflection probe information to a readable string for debug purpose.
  140379. * @param fullDetails Supports for multiple levels of logging within scene loading
  140380. * @returns the human readable reflection probe info
  140381. */
  140382. toString(fullDetails?: boolean): string;
  140383. /**
  140384. * Get the class name of the relfection probe.
  140385. * @returns "ReflectionProbe"
  140386. */
  140387. getClassName(): string;
  140388. /**
  140389. * Serialize the reflection probe to a JSON representation we can easily use in the resepective Parse function.
  140390. * @returns The JSON representation of the texture
  140391. */
  140392. serialize(): any;
  140393. /**
  140394. * Parse the JSON representation of a reflection probe in order to recreate the reflection probe in the given scene.
  140395. * @param parsedReflectionProbe Define the JSON representation of the reflection probe
  140396. * @param scene Define the scene the parsed reflection probe should be instantiated in
  140397. * @param rootUrl Define the root url of the parsing sequence in the case of relative dependencies
  140398. * @returns The parsed reflection probe if successful
  140399. */
  140400. static Parse(parsedReflectionProbe: any, scene: Scene, rootUrl: string): Nullable<ReflectionProbe>;
  140401. }
  140402. }
  140403. declare module BABYLON {
  140404. /** @hidden */
  140405. export var _BabylonLoaderRegistered: boolean;
  140406. /**
  140407. * Helps setting up some configuration for the babylon file loader.
  140408. */
  140409. export class BabylonFileLoaderConfiguration {
  140410. /**
  140411. * The loader does not allow injecting custom physix engine into the plugins.
  140412. * Unfortunately in ES6, we need to manually inject them into the plugin.
  140413. * So you could set this variable to your engine import to make it work.
  140414. */
  140415. static LoaderInjectedPhysicsEngine: any;
  140416. }
  140417. }
  140418. declare module BABYLON {
  140419. /**
  140420. * The Physically based simple base material of BJS.
  140421. *
  140422. * This enables better naming and convention enforcements on top of the pbrMaterial.
  140423. * It is used as the base class for both the specGloss and metalRough conventions.
  140424. */
  140425. export abstract class PBRBaseSimpleMaterial extends PBRBaseMaterial {
  140426. /**
  140427. * Number of Simultaneous lights allowed on the material.
  140428. */
  140429. maxSimultaneousLights: number;
  140430. /**
  140431. * If sets to true, disables all the lights affecting the material.
  140432. */
  140433. disableLighting: boolean;
  140434. /**
  140435. * Environment Texture used in the material (this is use for both reflection and environment lighting).
  140436. */
  140437. environmentTexture: BaseTexture;
  140438. /**
  140439. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  140440. */
  140441. invertNormalMapX: boolean;
  140442. /**
  140443. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  140444. */
  140445. invertNormalMapY: boolean;
  140446. /**
  140447. * Normal map used in the model.
  140448. */
  140449. normalTexture: BaseTexture;
  140450. /**
  140451. * Emissivie color used to self-illuminate the model.
  140452. */
  140453. emissiveColor: Color3;
  140454. /**
  140455. * Emissivie texture used to self-illuminate the model.
  140456. */
  140457. emissiveTexture: BaseTexture;
  140458. /**
  140459. * Occlusion Channel Strenght.
  140460. */
  140461. occlusionStrength: number;
  140462. /**
  140463. * Occlusion Texture of the material (adding extra occlusion effects).
  140464. */
  140465. occlusionTexture: BaseTexture;
  140466. /**
  140467. * Defines the alpha limits in alpha test mode.
  140468. */
  140469. alphaCutOff: number;
  140470. /**
  140471. * Gets the current double sided mode.
  140472. */
  140473. get doubleSided(): boolean;
  140474. /**
  140475. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  140476. */
  140477. set doubleSided(value: boolean);
  140478. /**
  140479. * Stores the pre-calculated light information of a mesh in a texture.
  140480. */
  140481. lightmapTexture: BaseTexture;
  140482. /**
  140483. * If true, the light map contains occlusion information instead of lighting info.
  140484. */
  140485. useLightmapAsShadowmap: boolean;
  140486. /**
  140487. * Instantiates a new PBRMaterial instance.
  140488. *
  140489. * @param name The material name
  140490. * @param scene The scene the material will be use in.
  140491. */
  140492. constructor(name: string, scene: Scene);
  140493. getClassName(): string;
  140494. }
  140495. }
  140496. declare module BABYLON {
  140497. /**
  140498. * The PBR material of BJS following the metal roughness convention.
  140499. *
  140500. * This fits to the PBR convention in the GLTF definition:
  140501. * https://github.com/KhronosGroup/glTF/tree/2.0/specification/2.0
  140502. */
  140503. export class PBRMetallicRoughnessMaterial extends PBRBaseSimpleMaterial {
  140504. /**
  140505. * The base color has two different interpretations depending on the value of metalness.
  140506. * When the material is a metal, the base color is the specific measured reflectance value
  140507. * at normal incidence (F0). For a non-metal the base color represents the reflected diffuse color
  140508. * of the material.
  140509. */
  140510. baseColor: Color3;
  140511. /**
  140512. * Base texture of the metallic workflow. It contains both the baseColor information in RGB as
  140513. * well as opacity information in the alpha channel.
  140514. */
  140515. baseTexture: BaseTexture;
  140516. /**
  140517. * Specifies the metallic scalar value of the material.
  140518. * Can also be used to scale the metalness values of the metallic texture.
  140519. */
  140520. metallic: number;
  140521. /**
  140522. * Specifies the roughness scalar value of the material.
  140523. * Can also be used to scale the roughness values of the metallic texture.
  140524. */
  140525. roughness: number;
  140526. /**
  140527. * Texture containing both the metallic value in the B channel and the
  140528. * roughness value in the G channel to keep better precision.
  140529. */
  140530. metallicRoughnessTexture: BaseTexture;
  140531. /**
  140532. * Instantiates a new PBRMetalRoughnessMaterial instance.
  140533. *
  140534. * @param name The material name
  140535. * @param scene The scene the material will be use in.
  140536. */
  140537. constructor(name: string, scene: Scene);
  140538. /**
  140539. * Return the currrent class name of the material.
  140540. */
  140541. getClassName(): string;
  140542. /**
  140543. * Makes a duplicate of the current material.
  140544. * @param name - name to use for the new material.
  140545. */
  140546. clone(name: string): PBRMetallicRoughnessMaterial;
  140547. /**
  140548. * Serialize the material to a parsable JSON object.
  140549. */
  140550. serialize(): any;
  140551. /**
  140552. * Parses a JSON object correponding to the serialize function.
  140553. */
  140554. static Parse(source: any, scene: Scene, rootUrl: string): PBRMetallicRoughnessMaterial;
  140555. }
  140556. }
  140557. declare module BABYLON {
  140558. /**
  140559. * The PBR material of BJS following the specular glossiness convention.
  140560. *
  140561. * This fits to the PBR convention in the GLTF definition:
  140562. * https://github.com/KhronosGroup/glTF/tree/2.0/extensions/Khronos/KHR_materials_pbrSpecularGlossiness
  140563. */
  140564. export class PBRSpecularGlossinessMaterial extends PBRBaseSimpleMaterial {
  140565. /**
  140566. * Specifies the diffuse color of the material.
  140567. */
  140568. diffuseColor: Color3;
  140569. /**
  140570. * Specifies the diffuse texture of the material. This can also contains the opcity value in its alpha
  140571. * channel.
  140572. */
  140573. diffuseTexture: BaseTexture;
  140574. /**
  140575. * Specifies the specular color of the material. This indicates how reflective is the material (none to mirror).
  140576. */
  140577. specularColor: Color3;
  140578. /**
  140579. * Specifies the glossiness of the material. This indicates "how sharp is the reflection".
  140580. */
  140581. glossiness: number;
  140582. /**
  140583. * Specifies both the specular color RGB and the glossiness A of the material per pixels.
  140584. */
  140585. specularGlossinessTexture: BaseTexture;
  140586. /**
  140587. * Instantiates a new PBRSpecularGlossinessMaterial instance.
  140588. *
  140589. * @param name The material name
  140590. * @param scene The scene the material will be use in.
  140591. */
  140592. constructor(name: string, scene: Scene);
  140593. /**
  140594. * Return the currrent class name of the material.
  140595. */
  140596. getClassName(): string;
  140597. /**
  140598. * Makes a duplicate of the current material.
  140599. * @param name - name to use for the new material.
  140600. */
  140601. clone(name: string): PBRSpecularGlossinessMaterial;
  140602. /**
  140603. * Serialize the material to a parsable JSON object.
  140604. */
  140605. serialize(): any;
  140606. /**
  140607. * Parses a JSON object correponding to the serialize function.
  140608. */
  140609. static Parse(source: any, scene: Scene, rootUrl: string): PBRSpecularGlossinessMaterial;
  140610. }
  140611. }
  140612. declare module BABYLON {
  140613. /**
  140614. * This represents a color grading texture. This acts as a lookup table LUT, useful during post process
  140615. * It can help converting any input color in a desired output one. This can then be used to create effects
  140616. * from sepia, black and white to sixties or futuristic rendering...
  140617. *
  140618. * The only supported format is currently 3dl.
  140619. * More information on LUT: https://en.wikipedia.org/wiki/3D_lookup_table
  140620. */
  140621. export class ColorGradingTexture extends BaseTexture {
  140622. /**
  140623. * The texture URL.
  140624. */
  140625. url: string;
  140626. /**
  140627. * Empty line regex stored for GC.
  140628. */
  140629. private static _noneEmptyLineRegex;
  140630. private _textureMatrix;
  140631. private _onLoad;
  140632. /**
  140633. * Instantiates a ColorGradingTexture from the following parameters.
  140634. *
  140635. * @param url The location of the color gradind data (currently only supporting 3dl)
  140636. * @param sceneOrEngine The scene or engine the texture will be used in
  140637. * @param onLoad defines a callback triggered when the texture has been loaded
  140638. */
  140639. constructor(url: string, sceneOrEngine: Scene | ThinEngine, onLoad?: Nullable<() => void>);
  140640. /**
  140641. * Fires the onload event from the constructor if requested.
  140642. */
  140643. private _triggerOnLoad;
  140644. /**
  140645. * Returns the texture matrix used in most of the material.
  140646. * This is not used in color grading but keep for troubleshooting purpose (easily swap diffuse by colorgrading to look in).
  140647. */
  140648. getTextureMatrix(): Matrix;
  140649. /**
  140650. * Occurs when the file being loaded is a .3dl LUT file.
  140651. */
  140652. private load3dlTexture;
  140653. /**
  140654. * Starts the loading process of the texture.
  140655. */
  140656. private loadTexture;
  140657. /**
  140658. * Clones the color gradind texture.
  140659. */
  140660. clone(): ColorGradingTexture;
  140661. /**
  140662. * Called during delayed load for textures.
  140663. */
  140664. delayLoad(): void;
  140665. /**
  140666. * Parses a color grading texture serialized by Babylon.
  140667. * @param parsedTexture The texture information being parsedTexture
  140668. * @param scene The scene to load the texture in
  140669. * @param rootUrl The root url of the data assets to load
  140670. * @return A color gradind texture
  140671. */
  140672. static Parse(parsedTexture: any, scene: Scene): Nullable<ColorGradingTexture>;
  140673. /**
  140674. * Serializes the LUT texture to json format.
  140675. */
  140676. serialize(): any;
  140677. }
  140678. }
  140679. declare module BABYLON {
  140680. /**
  140681. * This represents a texture coming from an equirectangular image supported by the web browser canvas.
  140682. */
  140683. export class EquiRectangularCubeTexture extends BaseTexture {
  140684. /** The six faces of the cube. */
  140685. private static _FacesMapping;
  140686. private _noMipmap;
  140687. private _onLoad;
  140688. private _onError;
  140689. /** The size of the cubemap. */
  140690. private _size;
  140691. /** The buffer of the image. */
  140692. private _buffer;
  140693. /** The width of the input image. */
  140694. private _width;
  140695. /** The height of the input image. */
  140696. private _height;
  140697. /** The URL to the image. */
  140698. url: string;
  140699. /** The texture coordinates mode. As this texture is stored in a cube format, please modify carefully. */
  140700. coordinatesMode: number;
  140701. /**
  140702. * Instantiates an EquiRectangularCubeTexture from the following parameters.
  140703. * @param url The location of the image
  140704. * @param scene The scene the texture will be used in
  140705. * @param size The cubemap desired size (the more it increases the longer the generation will be)
  140706. * @param noMipmap Forces to not generate the mipmap if true
  140707. * @param gammaSpace Specifies if the texture will be used in gamma or linear space
  140708. * (the PBR material requires those textures in linear space, but the standard material would require them in Gamma space)
  140709. * @param onLoad — defines a callback called when texture is loaded
  140710. * @param onError — defines a callback called if there is an error
  140711. */
  140712. constructor(url: string, scene: Scene, size: number, noMipmap?: boolean, gammaSpace?: boolean, onLoad?: Nullable<() => void>, onError?: Nullable<(message?: string, exception?: any) => void>);
  140713. /**
  140714. * Load the image data, by putting the image on a canvas and extracting its buffer.
  140715. */
  140716. private loadImage;
  140717. /**
  140718. * Convert the image buffer into a cubemap and create a CubeTexture.
  140719. */
  140720. private loadTexture;
  140721. /**
  140722. * Convert the ArrayBuffer into a Float32Array and drop the transparency channel.
  140723. * @param buffer The ArrayBuffer that should be converted.
  140724. * @returns The buffer as Float32Array.
  140725. */
  140726. private getFloat32ArrayFromArrayBuffer;
  140727. /**
  140728. * Get the current class name of the texture useful for serialization or dynamic coding.
  140729. * @returns "EquiRectangularCubeTexture"
  140730. */
  140731. getClassName(): string;
  140732. /**
  140733. * Create a clone of the current EquiRectangularCubeTexture and return it.
  140734. * @returns A clone of the current EquiRectangularCubeTexture.
  140735. */
  140736. clone(): EquiRectangularCubeTexture;
  140737. }
  140738. }
  140739. declare module BABYLON {
  140740. /**
  140741. * Defines the options related to the creation of an HtmlElementTexture
  140742. */
  140743. export interface IHtmlElementTextureOptions {
  140744. /**
  140745. * Defines wether mip maps should be created or not.
  140746. */
  140747. generateMipMaps?: boolean;
  140748. /**
  140749. * Defines the sampling mode of the texture.
  140750. */
  140751. samplingMode?: number;
  140752. /**
  140753. * Defines the engine instance to use the texture with. It is not mandatory if you define a scene.
  140754. */
  140755. engine: Nullable<ThinEngine>;
  140756. /**
  140757. * Defines the scene the texture belongs to. It is not mandatory if you define an engine.
  140758. */
  140759. scene: Nullable<Scene>;
  140760. }
  140761. /**
  140762. * This represents the smallest workload to use an already existing element (Canvas or Video) as a texture.
  140763. * To be as efficient as possible depending on your constraints nothing aside the first upload
  140764. * is automatically managed.
  140765. * It is a cheap VideoTexture or DynamicTexture if you prefer to keep full control of the elements
  140766. * in your application.
  140767. *
  140768. * As the update is not automatic, you need to call them manually.
  140769. */
  140770. export class HtmlElementTexture extends BaseTexture {
  140771. /**
  140772. * The texture URL.
  140773. */
  140774. element: HTMLVideoElement | HTMLCanvasElement;
  140775. private static readonly DefaultOptions;
  140776. private _textureMatrix;
  140777. private _isVideo;
  140778. private _generateMipMaps;
  140779. private _samplingMode;
  140780. /**
  140781. * Instantiates a HtmlElementTexture from the following parameters.
  140782. *
  140783. * @param name Defines the name of the texture
  140784. * @param element Defines the video or canvas the texture is filled with
  140785. * @param options Defines the other none mandatory texture creation options
  140786. */
  140787. constructor(name: string, element: HTMLVideoElement | HTMLCanvasElement, options: IHtmlElementTextureOptions);
  140788. private _createInternalTexture;
  140789. /**
  140790. * Returns the texture matrix used in most of the material.
  140791. */
  140792. getTextureMatrix(): Matrix;
  140793. /**
  140794. * Updates the content of the texture.
  140795. * @param invertY Defines wether the texture should be inverted on Y (false by default on video and true on canvas)
  140796. */
  140797. update(invertY?: Nullable<boolean>): void;
  140798. }
  140799. }
  140800. declare module BABYLON {
  140801. /**
  140802. * Based on jsTGALoader - Javascript loader for TGA file
  140803. * By Vincent Thibault
  140804. * @see http://blog.robrowser.com/javascript-tga-loader.html
  140805. */
  140806. export class TGATools {
  140807. private static _TYPE_INDEXED;
  140808. private static _TYPE_RGB;
  140809. private static _TYPE_GREY;
  140810. private static _TYPE_RLE_INDEXED;
  140811. private static _TYPE_RLE_RGB;
  140812. private static _TYPE_RLE_GREY;
  140813. private static _ORIGIN_MASK;
  140814. private static _ORIGIN_SHIFT;
  140815. private static _ORIGIN_BL;
  140816. private static _ORIGIN_BR;
  140817. private static _ORIGIN_UL;
  140818. private static _ORIGIN_UR;
  140819. /**
  140820. * Gets the header of a TGA file
  140821. * @param data defines the TGA data
  140822. * @returns the header
  140823. */
  140824. static GetTGAHeader(data: Uint8Array): any;
  140825. /**
  140826. * Uploads TGA content to a Babylon Texture
  140827. * @hidden
  140828. */
  140829. static UploadContent(texture: InternalTexture, data: Uint8Array): void;
  140830. /** @hidden */
  140831. 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;
  140832. /** @hidden */
  140833. 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;
  140834. /** @hidden */
  140835. 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;
  140836. /** @hidden */
  140837. 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;
  140838. /** @hidden */
  140839. 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;
  140840. /** @hidden */
  140841. 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;
  140842. }
  140843. }
  140844. declare module BABYLON {
  140845. /**
  140846. * Implementation of the TGA Texture Loader.
  140847. * @hidden
  140848. */
  140849. export class _TGATextureLoader implements IInternalTextureLoader {
  140850. /**
  140851. * Defines wether the loader supports cascade loading the different faces.
  140852. */
  140853. readonly supportCascades: boolean;
  140854. /**
  140855. * This returns if the loader support the current file information.
  140856. * @param extension defines the file extension of the file being loaded
  140857. * @returns true if the loader can load the specified file
  140858. */
  140859. canLoad(extension: string): boolean;
  140860. /**
  140861. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  140862. * @param data contains the texture data
  140863. * @param texture defines the BabylonJS internal texture
  140864. * @param createPolynomials will be true if polynomials have been requested
  140865. * @param onLoad defines the callback to trigger once the texture is ready
  140866. * @param onError defines the callback to trigger in case of error
  140867. */
  140868. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  140869. /**
  140870. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  140871. * @param data contains the texture data
  140872. * @param texture defines the BabylonJS internal texture
  140873. * @param callback defines the method to call once ready to upload
  140874. */
  140875. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  140876. }
  140877. }
  140878. declare module BABYLON {
  140879. /**
  140880. * Info about the .basis files
  140881. */
  140882. class BasisFileInfo {
  140883. /**
  140884. * If the file has alpha
  140885. */
  140886. hasAlpha: boolean;
  140887. /**
  140888. * Info about each image of the basis file
  140889. */
  140890. images: Array<{
  140891. levels: Array<{
  140892. width: number;
  140893. height: number;
  140894. transcodedPixels: ArrayBufferView;
  140895. }>;
  140896. }>;
  140897. }
  140898. /**
  140899. * Result of transcoding a basis file
  140900. */
  140901. class TranscodeResult {
  140902. /**
  140903. * Info about the .basis file
  140904. */
  140905. fileInfo: BasisFileInfo;
  140906. /**
  140907. * Format to use when loading the file
  140908. */
  140909. format: number;
  140910. }
  140911. /**
  140912. * Configuration options for the Basis transcoder
  140913. */
  140914. export class BasisTranscodeConfiguration {
  140915. /**
  140916. * Supported compression formats used to determine the supported output format of the transcoder
  140917. */
  140918. supportedCompressionFormats?: {
  140919. /**
  140920. * etc1 compression format
  140921. */
  140922. etc1?: boolean;
  140923. /**
  140924. * s3tc compression format
  140925. */
  140926. s3tc?: boolean;
  140927. /**
  140928. * pvrtc compression format
  140929. */
  140930. pvrtc?: boolean;
  140931. /**
  140932. * etc2 compression format
  140933. */
  140934. etc2?: boolean;
  140935. };
  140936. /**
  140937. * If mipmap levels should be loaded for transcoded images (Default: true)
  140938. */
  140939. loadMipmapLevels?: boolean;
  140940. /**
  140941. * Index of a single image to load (Default: all images)
  140942. */
  140943. loadSingleImage?: number;
  140944. }
  140945. /**
  140946. * Used to load .Basis files
  140947. * See https://github.com/BinomialLLC/basis_universal/tree/master/webgl
  140948. */
  140949. export class BasisTools {
  140950. private static _IgnoreSupportedFormats;
  140951. /**
  140952. * URL to use when loading the basis transcoder
  140953. */
  140954. static JSModuleURL: string;
  140955. /**
  140956. * URL to use when loading the wasm module for the transcoder
  140957. */
  140958. static WasmModuleURL: string;
  140959. /**
  140960. * Get the internal format to be passed to texImage2D corresponding to the .basis format value
  140961. * @param basisFormat format chosen from GetSupportedTranscodeFormat
  140962. * @returns internal format corresponding to the Basis format
  140963. */
  140964. static GetInternalFormatFromBasisFormat(basisFormat: number): number;
  140965. private static _WorkerPromise;
  140966. private static _Worker;
  140967. private static _actionId;
  140968. private static _CreateWorkerAsync;
  140969. /**
  140970. * Transcodes a loaded image file to compressed pixel data
  140971. * @param data image data to transcode
  140972. * @param config configuration options for the transcoding
  140973. * @returns a promise resulting in the transcoded image
  140974. */
  140975. static TranscodeAsync(data: ArrayBuffer | ArrayBufferView, config: BasisTranscodeConfiguration): Promise<TranscodeResult>;
  140976. /**
  140977. * Loads a texture from the transcode result
  140978. * @param texture texture load to
  140979. * @param transcodeResult the result of transcoding the basis file to load from
  140980. */
  140981. static LoadTextureFromTranscodeResult(texture: InternalTexture, transcodeResult: TranscodeResult): void;
  140982. }
  140983. }
  140984. declare module BABYLON {
  140985. /**
  140986. * Loader for .basis file format
  140987. */
  140988. export class _BasisTextureLoader implements IInternalTextureLoader {
  140989. /**
  140990. * Defines whether the loader supports cascade loading the different faces.
  140991. */
  140992. readonly supportCascades: boolean;
  140993. /**
  140994. * This returns if the loader support the current file information.
  140995. * @param extension defines the file extension of the file being loaded
  140996. * @returns true if the loader can load the specified file
  140997. */
  140998. canLoad(extension: string): boolean;
  140999. /**
  141000. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  141001. * @param data contains the texture data
  141002. * @param texture defines the BabylonJS internal texture
  141003. * @param createPolynomials will be true if polynomials have been requested
  141004. * @param onLoad defines the callback to trigger once the texture is ready
  141005. * @param onError defines the callback to trigger in case of error
  141006. */
  141007. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  141008. /**
  141009. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  141010. * @param data contains the texture data
  141011. * @param texture defines the BabylonJS internal texture
  141012. * @param callback defines the method to call once ready to upload
  141013. */
  141014. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  141015. }
  141016. }
  141017. declare module BABYLON {
  141018. /**
  141019. * Defines the basic options interface of a TexturePacker Frame
  141020. */
  141021. export interface ITexturePackerFrame {
  141022. /**
  141023. * The frame ID
  141024. */
  141025. id: number;
  141026. /**
  141027. * The frames Scale
  141028. */
  141029. scale: Vector2;
  141030. /**
  141031. * The Frames offset
  141032. */
  141033. offset: Vector2;
  141034. }
  141035. /**
  141036. * This is a support class for frame Data on texture packer sets.
  141037. */
  141038. export class TexturePackerFrame implements ITexturePackerFrame {
  141039. /**
  141040. * The frame ID
  141041. */
  141042. id: number;
  141043. /**
  141044. * The frames Scale
  141045. */
  141046. scale: Vector2;
  141047. /**
  141048. * The Frames offset
  141049. */
  141050. offset: Vector2;
  141051. /**
  141052. * Initializes a texture package frame.
  141053. * @param id The numerical frame identifier
  141054. * @param scale Scalar Vector2 for UV frame
  141055. * @param offset Vector2 for the frame position in UV units.
  141056. * @returns TexturePackerFrame
  141057. */
  141058. constructor(id: number, scale: Vector2, offset: Vector2);
  141059. }
  141060. }
  141061. declare module BABYLON {
  141062. /**
  141063. * Defines the basic options interface of a TexturePacker
  141064. */
  141065. export interface ITexturePackerOptions {
  141066. /**
  141067. * Custom targets for the channels of a texture packer. Default is all the channels of the Standard Material
  141068. */
  141069. map?: string[];
  141070. /**
  141071. * the UV input targets, as a single value for all meshes. Defaults to VertexBuffer.UVKind
  141072. */
  141073. uvsIn?: string;
  141074. /**
  141075. * the UV output targets, as a single value for all meshes. Defaults to VertexBuffer.UVKind
  141076. */
  141077. uvsOut?: string;
  141078. /**
  141079. * number representing the layout style. Defaults to LAYOUT_STRIP
  141080. */
  141081. layout?: number;
  141082. /**
  141083. * number of columns if using custom column count layout(2). This defaults to 4.
  141084. */
  141085. colnum?: number;
  141086. /**
  141087. * flag to update the input meshes to the new packed texture after compilation. Defaults to true.
  141088. */
  141089. updateInputMeshes?: boolean;
  141090. /**
  141091. * boolean flag to dispose all the source textures. Defaults to true.
  141092. */
  141093. disposeSources?: boolean;
  141094. /**
  141095. * Fills the blank cells in a set to the customFillColor. Defaults to true.
  141096. */
  141097. fillBlanks?: boolean;
  141098. /**
  141099. * string value representing the context fill style color. Defaults to 'black'.
  141100. */
  141101. customFillColor?: string;
  141102. /**
  141103. * Width and Height Value of each Frame in the TexturePacker Sets
  141104. */
  141105. frameSize?: number;
  141106. /**
  141107. * Ratio of the value to add padding wise to each cell. Defaults to 0.0115
  141108. */
  141109. paddingRatio?: number;
  141110. /**
  141111. * Number that declares the fill method for the padding gutter.
  141112. */
  141113. paddingMode?: number;
  141114. /**
  141115. * If in SUBUV_COLOR padding mode what color to use.
  141116. */
  141117. paddingColor?: Color3 | Color4;
  141118. }
  141119. /**
  141120. * Defines the basic interface of a TexturePacker JSON File
  141121. */
  141122. export interface ITexturePackerJSON {
  141123. /**
  141124. * The frame ID
  141125. */
  141126. name: string;
  141127. /**
  141128. * The base64 channel data
  141129. */
  141130. sets: any;
  141131. /**
  141132. * The options of the Packer
  141133. */
  141134. options: ITexturePackerOptions;
  141135. /**
  141136. * The frame data of the Packer
  141137. */
  141138. frames: Array<number>;
  141139. }
  141140. /**
  141141. * This is a support class that generates a series of packed texture sets.
  141142. * @see https://doc.babylonjs.com/babylon101/materials
  141143. */
  141144. export class TexturePacker {
  141145. /** Packer Layout Constant 0 */
  141146. static readonly LAYOUT_STRIP: number;
  141147. /** Packer Layout Constant 1 */
  141148. static readonly LAYOUT_POWER2: number;
  141149. /** Packer Layout Constant 2 */
  141150. static readonly LAYOUT_COLNUM: number;
  141151. /** Packer Layout Constant 0 */
  141152. static readonly SUBUV_WRAP: number;
  141153. /** Packer Layout Constant 1 */
  141154. static readonly SUBUV_EXTEND: number;
  141155. /** Packer Layout Constant 2 */
  141156. static readonly SUBUV_COLOR: number;
  141157. /** The Name of the Texture Package */
  141158. name: string;
  141159. /** The scene scope of the TexturePacker */
  141160. scene: Scene;
  141161. /** The Meshes to target */
  141162. meshes: AbstractMesh[];
  141163. /** Arguments passed with the Constructor */
  141164. options: ITexturePackerOptions;
  141165. /** The promise that is started upon initialization */
  141166. promise: Nullable<Promise<TexturePacker | string>>;
  141167. /** The Container object for the channel sets that are generated */
  141168. sets: object;
  141169. /** The Container array for the frames that are generated */
  141170. frames: TexturePackerFrame[];
  141171. /** The expected number of textures the system is parsing. */
  141172. private _expecting;
  141173. /** The padding value from Math.ceil(frameSize * paddingRatio) */
  141174. private _paddingValue;
  141175. /**
  141176. * Initializes a texture package series from an array of meshes or a single mesh.
  141177. * @param name The name of the package
  141178. * @param meshes The target meshes to compose the package from
  141179. * @param options The arguments that texture packer should follow while building.
  141180. * @param scene The scene which the textures are scoped to.
  141181. * @returns TexturePacker
  141182. */
  141183. constructor(name: string, meshes: AbstractMesh[], options: ITexturePackerOptions, scene: Scene);
  141184. /**
  141185. * Starts the package process
  141186. * @param resolve The promises resolution function
  141187. * @returns TexturePacker
  141188. */
  141189. private _createFrames;
  141190. /**
  141191. * Calculates the Size of the Channel Sets
  141192. * @returns Vector2
  141193. */
  141194. private _calculateSize;
  141195. /**
  141196. * Calculates the UV data for the frames.
  141197. * @param baseSize the base frameSize
  141198. * @param padding the base frame padding
  141199. * @param dtSize size of the Dynamic Texture for that channel
  141200. * @param dtUnits is 1/dtSize
  141201. * @param update flag to update the input meshes
  141202. */
  141203. private _calculateMeshUVFrames;
  141204. /**
  141205. * Calculates the frames Offset.
  141206. * @param index of the frame
  141207. * @returns Vector2
  141208. */
  141209. private _getFrameOffset;
  141210. /**
  141211. * Updates a Mesh to the frame data
  141212. * @param mesh that is the target
  141213. * @param frameID or the frame index
  141214. */
  141215. private _updateMeshUV;
  141216. /**
  141217. * Updates a Meshes materials to use the texture packer channels
  141218. * @param m is the mesh to target
  141219. * @param force all channels on the packer to be set.
  141220. */
  141221. private _updateTextureReferences;
  141222. /**
  141223. * Public method to set a Mesh to a frame
  141224. * @param m that is the target
  141225. * @param frameID or the frame index
  141226. * @param updateMaterial trigger for if the Meshes attached Material be updated?
  141227. */
  141228. setMeshToFrame(m: AbstractMesh, frameID: number, updateMaterial?: boolean): void;
  141229. /**
  141230. * Starts the async promise to compile the texture packer.
  141231. * @returns Promise<void>
  141232. */
  141233. processAsync(): Promise<void>;
  141234. /**
  141235. * Disposes all textures associated with this packer
  141236. */
  141237. dispose(): void;
  141238. /**
  141239. * Starts the download process for all the channels converting them to base64 data and embedding it all in a JSON file.
  141240. * @param imageType is the image type to use.
  141241. * @param quality of the image if downloading as jpeg, Ranges from >0 to 1.
  141242. */
  141243. download(imageType?: string, quality?: number): void;
  141244. /**
  141245. * Public method to load a texturePacker JSON file.
  141246. * @param data of the JSON file in string format.
  141247. */
  141248. updateFromJSON(data: string): void;
  141249. }
  141250. }
  141251. declare module BABYLON {
  141252. /**
  141253. * 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.
  141254. * Custom Procedural textures are the easiest way to create your own procedural in your application.
  141255. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures#creating-custom-procedural-textures
  141256. */
  141257. export class CustomProceduralTexture extends ProceduralTexture {
  141258. private _animate;
  141259. private _time;
  141260. private _config;
  141261. private _texturePath;
  141262. /**
  141263. * Instantiates a new Custom Procedural Texture.
  141264. * 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.
  141265. * Custom Procedural textures are the easiest way to create your own procedural in your application.
  141266. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures#creating-custom-procedural-textures
  141267. * @param name Define the name of the texture
  141268. * @param texturePath Define the folder path containing all the cutom texture related files (config, shaders...)
  141269. * @param size Define the size of the texture to create
  141270. * @param scene Define the scene the texture belongs to
  141271. * @param fallbackTexture Define a fallback texture in case there were issues to create the custom texture
  141272. * @param generateMipMaps Define if the texture should creates mip maps or not
  141273. */
  141274. constructor(name: string, texturePath: string, size: number, scene: Scene, fallbackTexture?: Texture, generateMipMaps?: boolean);
  141275. private _loadJson;
  141276. /**
  141277. * Is the texture ready to be used ? (rendered at least once)
  141278. * @returns true if ready, otherwise, false.
  141279. */
  141280. isReady(): boolean;
  141281. /**
  141282. * Render the texture to its associated render target.
  141283. * @param useCameraPostProcess Define if camera post process should be applied to the texture
  141284. */
  141285. render(useCameraPostProcess?: boolean): void;
  141286. /**
  141287. * Update the list of dependant textures samplers in the shader.
  141288. */
  141289. updateTextures(): void;
  141290. /**
  141291. * Update the uniform values of the procedural texture in the shader.
  141292. */
  141293. updateShaderUniforms(): void;
  141294. /**
  141295. * Define if the texture animates or not.
  141296. */
  141297. get animate(): boolean;
  141298. set animate(value: boolean);
  141299. }
  141300. }
  141301. declare module BABYLON {
  141302. /** @hidden */
  141303. export var noisePixelShader: {
  141304. name: string;
  141305. shader: string;
  141306. };
  141307. }
  141308. declare module BABYLON {
  141309. /**
  141310. * Class used to generate noise procedural textures
  141311. */
  141312. export class NoiseProceduralTexture extends ProceduralTexture {
  141313. private _time;
  141314. /** Gets or sets a value between 0 and 1 indicating the overall brightness of the texture (default is 0.2) */
  141315. brightness: number;
  141316. /** Defines the number of octaves to process */
  141317. octaves: number;
  141318. /** Defines the level of persistence (0.8 by default) */
  141319. persistence: number;
  141320. /** Gets or sets animation speed factor (default is 1) */
  141321. animationSpeedFactor: number;
  141322. /**
  141323. * Creates a new NoiseProceduralTexture
  141324. * @param name defines the name fo the texture
  141325. * @param size defines the size of the texture (default is 256)
  141326. * @param scene defines the hosting scene
  141327. * @param fallbackTexture defines the texture to use if the NoiseProceduralTexture can't be created
  141328. * @param generateMipMaps defines if mipmaps must be generated (true by default)
  141329. */
  141330. constructor(name: string, size?: number, scene?: Nullable<Scene>, fallbackTexture?: Texture, generateMipMaps?: boolean);
  141331. private _updateShaderUniforms;
  141332. protected _getDefines(): string;
  141333. /** Generate the current state of the procedural texture */
  141334. render(useCameraPostProcess?: boolean): void;
  141335. /**
  141336. * Serializes this noise procedural texture
  141337. * @returns a serialized noise procedural texture object
  141338. */
  141339. serialize(): any;
  141340. /**
  141341. * Clone the texture.
  141342. * @returns the cloned texture
  141343. */
  141344. clone(): NoiseProceduralTexture;
  141345. /**
  141346. * Creates a NoiseProceduralTexture from parsed noise procedural texture data
  141347. * @param parsedTexture defines parsed texture data
  141348. * @param scene defines the current scene
  141349. * @param rootUrl defines the root URL containing noise procedural texture information
  141350. * @returns a parsed NoiseProceduralTexture
  141351. */
  141352. static Parse(parsedTexture: any, scene: Scene): NoiseProceduralTexture;
  141353. }
  141354. }
  141355. declare module BABYLON {
  141356. /**
  141357. * Raw cube texture where the raw buffers are passed in
  141358. */
  141359. export class RawCubeTexture extends CubeTexture {
  141360. /**
  141361. * Creates a cube texture where the raw buffers are passed in.
  141362. * @param scene defines the scene the texture is attached to
  141363. * @param data defines the array of data to use to create each face
  141364. * @param size defines the size of the textures
  141365. * @param format defines the format of the data
  141366. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  141367. * @param generateMipMaps defines if the engine should generate the mip levels
  141368. * @param invertY defines if data must be stored with Y axis inverted
  141369. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  141370. * @param compression defines the compression used (null by default)
  141371. */
  141372. constructor(scene: Scene, data: Nullable<ArrayBufferView[]>, size: number, format?: number, type?: number, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, compression?: Nullable<string>);
  141373. /**
  141374. * Updates the raw cube texture.
  141375. * @param data defines the data to store
  141376. * @param format defines the data format
  141377. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  141378. * @param invertY defines if data must be stored with Y axis inverted
  141379. * @param compression defines the compression used (null by default)
  141380. * @param level defines which level of the texture to update
  141381. */
  141382. update(data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression?: Nullable<string>): void;
  141383. /**
  141384. * Updates a raw cube texture with RGBD encoded data.
  141385. * @param data defines the array of data [mipmap][face] to use to create each face
  141386. * @param sphericalPolynomial defines the spherical polynomial for irradiance
  141387. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  141388. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  141389. * @returns a promsie that resolves when the operation is complete
  141390. */
  141391. updateRGBDAsync(data: ArrayBufferView[][], sphericalPolynomial?: Nullable<SphericalPolynomial>, lodScale?: number, lodOffset?: number): Promise<void>;
  141392. /**
  141393. * Clones the raw cube texture.
  141394. * @return a new cube texture
  141395. */
  141396. clone(): CubeTexture;
  141397. /** @hidden */
  141398. static _UpdateRGBDAsync(internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number): Promise<void>;
  141399. }
  141400. }
  141401. declare module BABYLON {
  141402. /**
  141403. * Class used to store 2D array textures containing user data
  141404. */
  141405. export class RawTexture2DArray extends Texture {
  141406. /** Gets or sets the texture format to use */
  141407. format: number;
  141408. /**
  141409. * Create a new RawTexture2DArray
  141410. * @param data defines the data of the texture
  141411. * @param width defines the width of the texture
  141412. * @param height defines the height of the texture
  141413. * @param depth defines the number of layers of the texture
  141414. * @param format defines the texture format to use
  141415. * @param scene defines the hosting scene
  141416. * @param generateMipMaps defines a boolean indicating if mip levels should be generated (true by default)
  141417. * @param invertY defines if texture must be stored with Y axis inverted
  141418. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  141419. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  141420. */
  141421. constructor(data: ArrayBufferView, width: number, height: number, depth: number,
  141422. /** Gets or sets the texture format to use */
  141423. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, textureType?: number);
  141424. /**
  141425. * Update the texture with new data
  141426. * @param data defines the data to store in the texture
  141427. */
  141428. update(data: ArrayBufferView): void;
  141429. }
  141430. }
  141431. declare module BABYLON {
  141432. /**
  141433. * Class used to store 3D textures containing user data
  141434. */
  141435. export class RawTexture3D extends Texture {
  141436. /** Gets or sets the texture format to use */
  141437. format: number;
  141438. /**
  141439. * Create a new RawTexture3D
  141440. * @param data defines the data of the texture
  141441. * @param width defines the width of the texture
  141442. * @param height defines the height of the texture
  141443. * @param depth defines the depth of the texture
  141444. * @param format defines the texture format to use
  141445. * @param scene defines the hosting scene
  141446. * @param generateMipMaps defines a boolean indicating if mip levels should be generated (true by default)
  141447. * @param invertY defines if texture must be stored with Y axis inverted
  141448. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  141449. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  141450. */
  141451. constructor(data: ArrayBufferView, width: number, height: number, depth: number,
  141452. /** Gets or sets the texture format to use */
  141453. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, textureType?: number);
  141454. /**
  141455. * Update the texture with new data
  141456. * @param data defines the data to store in the texture
  141457. */
  141458. update(data: ArrayBufferView): void;
  141459. }
  141460. }
  141461. declare module BABYLON {
  141462. /**
  141463. * Creates a refraction texture used by refraction channel of the standard material.
  141464. * It is like a mirror but to see through a material.
  141465. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  141466. */
  141467. export class RefractionTexture extends RenderTargetTexture {
  141468. /**
  141469. * Define the reflection plane we want to use. The refractionPlane is usually set to the constructed refractor.
  141470. * 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.
  141471. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  141472. */
  141473. refractionPlane: Plane;
  141474. /**
  141475. * Define how deep under the surface we should see.
  141476. */
  141477. depth: number;
  141478. /**
  141479. * Creates a refraction texture used by refraction channel of the standard material.
  141480. * It is like a mirror but to see through a material.
  141481. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  141482. * @param name Define the texture name
  141483. * @param size Define the size of the underlying texture
  141484. * @param scene Define the scene the refraction belongs to
  141485. * @param generateMipMaps Define if we need to generate mips level for the refraction
  141486. */
  141487. constructor(name: string, size: number, scene: Scene, generateMipMaps?: boolean);
  141488. /**
  141489. * Clone the refraction texture.
  141490. * @returns the cloned texture
  141491. */
  141492. clone(): RefractionTexture;
  141493. /**
  141494. * Serialize the texture to a JSON representation you could use in Parse later on
  141495. * @returns the serialized JSON representation
  141496. */
  141497. serialize(): any;
  141498. }
  141499. }
  141500. declare module BABYLON {
  141501. /**
  141502. * Block used to add support for vertex skinning (bones)
  141503. */
  141504. export class BonesBlock extends NodeMaterialBlock {
  141505. /**
  141506. * Creates a new BonesBlock
  141507. * @param name defines the block name
  141508. */
  141509. constructor(name: string);
  141510. /**
  141511. * Initialize the block and prepare the context for build
  141512. * @param state defines the state that will be used for the build
  141513. */
  141514. initialize(state: NodeMaterialBuildState): void;
  141515. /**
  141516. * Gets the current class name
  141517. * @returns the class name
  141518. */
  141519. getClassName(): string;
  141520. /**
  141521. * Gets the matrix indices input component
  141522. */
  141523. get matricesIndices(): NodeMaterialConnectionPoint;
  141524. /**
  141525. * Gets the matrix weights input component
  141526. */
  141527. get matricesWeights(): NodeMaterialConnectionPoint;
  141528. /**
  141529. * Gets the extra matrix indices input component
  141530. */
  141531. get matricesIndicesExtra(): NodeMaterialConnectionPoint;
  141532. /**
  141533. * Gets the extra matrix weights input component
  141534. */
  141535. get matricesWeightsExtra(): NodeMaterialConnectionPoint;
  141536. /**
  141537. * Gets the world input component
  141538. */
  141539. get world(): NodeMaterialConnectionPoint;
  141540. /**
  141541. * Gets the output component
  141542. */
  141543. get output(): NodeMaterialConnectionPoint;
  141544. autoConfigure(material: NodeMaterial): void;
  141545. provideFallbacks(mesh: AbstractMesh, fallbacks: EffectFallbacks): void;
  141546. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  141547. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  141548. protected _buildBlock(state: NodeMaterialBuildState): this;
  141549. }
  141550. }
  141551. declare module BABYLON {
  141552. /**
  141553. * Block used to add support for instances
  141554. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  141555. */
  141556. export class InstancesBlock extends NodeMaterialBlock {
  141557. /**
  141558. * Creates a new InstancesBlock
  141559. * @param name defines the block name
  141560. */
  141561. constructor(name: string);
  141562. /**
  141563. * Gets the current class name
  141564. * @returns the class name
  141565. */
  141566. getClassName(): string;
  141567. /**
  141568. * Gets the first world row input component
  141569. */
  141570. get world0(): NodeMaterialConnectionPoint;
  141571. /**
  141572. * Gets the second world row input component
  141573. */
  141574. get world1(): NodeMaterialConnectionPoint;
  141575. /**
  141576. * Gets the third world row input component
  141577. */
  141578. get world2(): NodeMaterialConnectionPoint;
  141579. /**
  141580. * Gets the forth world row input component
  141581. */
  141582. get world3(): NodeMaterialConnectionPoint;
  141583. /**
  141584. * Gets the world input component
  141585. */
  141586. get world(): NodeMaterialConnectionPoint;
  141587. /**
  141588. * Gets the output component
  141589. */
  141590. get output(): NodeMaterialConnectionPoint;
  141591. /**
  141592. * Gets the isntanceID component
  141593. */
  141594. get instanceID(): NodeMaterialConnectionPoint;
  141595. autoConfigure(material: NodeMaterial): void;
  141596. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  141597. protected _buildBlock(state: NodeMaterialBuildState): this;
  141598. }
  141599. }
  141600. declare module BABYLON {
  141601. /**
  141602. * Block used to add morph targets support to vertex shader
  141603. */
  141604. export class MorphTargetsBlock extends NodeMaterialBlock {
  141605. private _repeatableContentAnchor;
  141606. /**
  141607. * Create a new MorphTargetsBlock
  141608. * @param name defines the block name
  141609. */
  141610. constructor(name: string);
  141611. /**
  141612. * Gets the current class name
  141613. * @returns the class name
  141614. */
  141615. getClassName(): string;
  141616. /**
  141617. * Gets the position input component
  141618. */
  141619. get position(): NodeMaterialConnectionPoint;
  141620. /**
  141621. * Gets the normal input component
  141622. */
  141623. get normal(): NodeMaterialConnectionPoint;
  141624. /**
  141625. * Gets the tangent input component
  141626. */
  141627. get tangent(): NodeMaterialConnectionPoint;
  141628. /**
  141629. * Gets the tangent input component
  141630. */
  141631. get uv(): NodeMaterialConnectionPoint;
  141632. /**
  141633. * Gets the position output component
  141634. */
  141635. get positionOutput(): NodeMaterialConnectionPoint;
  141636. /**
  141637. * Gets the normal output component
  141638. */
  141639. get normalOutput(): NodeMaterialConnectionPoint;
  141640. /**
  141641. * Gets the tangent output component
  141642. */
  141643. get tangentOutput(): NodeMaterialConnectionPoint;
  141644. /**
  141645. * Gets the tangent output component
  141646. */
  141647. get uvOutput(): NodeMaterialConnectionPoint;
  141648. initialize(state: NodeMaterialBuildState): void;
  141649. autoConfigure(material: NodeMaterial): void;
  141650. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  141651. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  141652. replaceRepeatableContent(vertexShaderState: NodeMaterialBuildState, fragmentShaderState: NodeMaterialBuildState, mesh: AbstractMesh, defines: NodeMaterialDefines): void;
  141653. protected _buildBlock(state: NodeMaterialBuildState): this;
  141654. }
  141655. }
  141656. declare module BABYLON {
  141657. /**
  141658. * Block used to get data information from a light
  141659. */
  141660. export class LightInformationBlock extends NodeMaterialBlock {
  141661. private _lightDataUniformName;
  141662. private _lightColorUniformName;
  141663. private _lightTypeDefineName;
  141664. /**
  141665. * Gets or sets the light associated with this block
  141666. */
  141667. light: Nullable<Light>;
  141668. /**
  141669. * Creates a new LightInformationBlock
  141670. * @param name defines the block name
  141671. */
  141672. constructor(name: string);
  141673. /**
  141674. * Gets the current class name
  141675. * @returns the class name
  141676. */
  141677. getClassName(): string;
  141678. /**
  141679. * Gets the world position input component
  141680. */
  141681. get worldPosition(): NodeMaterialConnectionPoint;
  141682. /**
  141683. * Gets the direction output component
  141684. */
  141685. get direction(): NodeMaterialConnectionPoint;
  141686. /**
  141687. * Gets the direction output component
  141688. */
  141689. get color(): NodeMaterialConnectionPoint;
  141690. /**
  141691. * Gets the direction output component
  141692. */
  141693. get intensity(): NodeMaterialConnectionPoint;
  141694. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  141695. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  141696. protected _buildBlock(state: NodeMaterialBuildState): this;
  141697. serialize(): any;
  141698. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  141699. }
  141700. }
  141701. declare module BABYLON {
  141702. /**
  141703. * Block used to add image processing support to fragment shader
  141704. */
  141705. export class ImageProcessingBlock extends NodeMaterialBlock {
  141706. /**
  141707. * Create a new ImageProcessingBlock
  141708. * @param name defines the block name
  141709. */
  141710. constructor(name: string);
  141711. /**
  141712. * Gets the current class name
  141713. * @returns the class name
  141714. */
  141715. getClassName(): string;
  141716. /**
  141717. * Gets the color input component
  141718. */
  141719. get color(): NodeMaterialConnectionPoint;
  141720. /**
  141721. * Gets the output component
  141722. */
  141723. get output(): NodeMaterialConnectionPoint;
  141724. /**
  141725. * Initialize the block and prepare the context for build
  141726. * @param state defines the state that will be used for the build
  141727. */
  141728. initialize(state: NodeMaterialBuildState): void;
  141729. isReady(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): boolean;
  141730. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  141731. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  141732. protected _buildBlock(state: NodeMaterialBuildState): this;
  141733. }
  141734. }
  141735. declare module BABYLON {
  141736. /**
  141737. * Block used to pertub normals based on a normal map
  141738. */
  141739. export class PerturbNormalBlock extends NodeMaterialBlock {
  141740. private _tangentSpaceParameterName;
  141741. /** Gets or sets a boolean indicating that normal should be inverted on X axis */
  141742. invertX: boolean;
  141743. /** Gets or sets a boolean indicating that normal should be inverted on Y axis */
  141744. invertY: boolean;
  141745. /**
  141746. * Create a new PerturbNormalBlock
  141747. * @param name defines the block name
  141748. */
  141749. constructor(name: string);
  141750. /**
  141751. * Gets the current class name
  141752. * @returns the class name
  141753. */
  141754. getClassName(): string;
  141755. /**
  141756. * Gets the world position input component
  141757. */
  141758. get worldPosition(): NodeMaterialConnectionPoint;
  141759. /**
  141760. * Gets the world normal input component
  141761. */
  141762. get worldNormal(): NodeMaterialConnectionPoint;
  141763. /**
  141764. * Gets the world tangent input component
  141765. */
  141766. get worldTangent(): NodeMaterialConnectionPoint;
  141767. /**
  141768. * Gets the uv input component
  141769. */
  141770. get uv(): NodeMaterialConnectionPoint;
  141771. /**
  141772. * Gets the normal map color input component
  141773. */
  141774. get normalMapColor(): NodeMaterialConnectionPoint;
  141775. /**
  141776. * Gets the strength input component
  141777. */
  141778. get strength(): NodeMaterialConnectionPoint;
  141779. /**
  141780. * Gets the output component
  141781. */
  141782. get output(): NodeMaterialConnectionPoint;
  141783. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  141784. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  141785. autoConfigure(material: NodeMaterial): void;
  141786. protected _buildBlock(state: NodeMaterialBuildState): this;
  141787. protected _dumpPropertiesCode(): string;
  141788. serialize(): any;
  141789. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  141790. }
  141791. }
  141792. declare module BABYLON {
  141793. /**
  141794. * Block used to discard a pixel if a value is smaller than a cutoff
  141795. */
  141796. export class DiscardBlock extends NodeMaterialBlock {
  141797. /**
  141798. * Create a new DiscardBlock
  141799. * @param name defines the block name
  141800. */
  141801. constructor(name: string);
  141802. /**
  141803. * Gets the current class name
  141804. * @returns the class name
  141805. */
  141806. getClassName(): string;
  141807. /**
  141808. * Gets the color input component
  141809. */
  141810. get value(): NodeMaterialConnectionPoint;
  141811. /**
  141812. * Gets the cutoff input component
  141813. */
  141814. get cutoff(): NodeMaterialConnectionPoint;
  141815. protected _buildBlock(state: NodeMaterialBuildState): this;
  141816. }
  141817. }
  141818. declare module BABYLON {
  141819. /**
  141820. * Block used to test if the fragment shader is front facing
  141821. */
  141822. export class FrontFacingBlock extends NodeMaterialBlock {
  141823. /**
  141824. * Creates a new FrontFacingBlock
  141825. * @param name defines the block name
  141826. */
  141827. constructor(name: string);
  141828. /**
  141829. * Gets the current class name
  141830. * @returns the class name
  141831. */
  141832. getClassName(): string;
  141833. /**
  141834. * Gets the output component
  141835. */
  141836. get output(): NodeMaterialConnectionPoint;
  141837. protected _buildBlock(state: NodeMaterialBuildState): this;
  141838. }
  141839. }
  141840. declare module BABYLON {
  141841. /**
  141842. * Block used to get the derivative value on x and y of a given input
  141843. */
  141844. export class DerivativeBlock extends NodeMaterialBlock {
  141845. /**
  141846. * Create a new DerivativeBlock
  141847. * @param name defines the block name
  141848. */
  141849. constructor(name: string);
  141850. /**
  141851. * Gets the current class name
  141852. * @returns the class name
  141853. */
  141854. getClassName(): string;
  141855. /**
  141856. * Gets the input component
  141857. */
  141858. get input(): NodeMaterialConnectionPoint;
  141859. /**
  141860. * Gets the derivative output on x
  141861. */
  141862. get dx(): NodeMaterialConnectionPoint;
  141863. /**
  141864. * Gets the derivative output on y
  141865. */
  141866. get dy(): NodeMaterialConnectionPoint;
  141867. protected _buildBlock(state: NodeMaterialBuildState): this;
  141868. }
  141869. }
  141870. declare module BABYLON {
  141871. /**
  141872. * Block used to make gl_FragCoord available
  141873. */
  141874. export class FragCoordBlock extends NodeMaterialBlock {
  141875. /**
  141876. * Creates a new FragCoordBlock
  141877. * @param name defines the block name
  141878. */
  141879. constructor(name: string);
  141880. /**
  141881. * Gets the current class name
  141882. * @returns the class name
  141883. */
  141884. getClassName(): string;
  141885. /**
  141886. * Gets the xy component
  141887. */
  141888. get xy(): NodeMaterialConnectionPoint;
  141889. /**
  141890. * Gets the xyz component
  141891. */
  141892. get xyz(): NodeMaterialConnectionPoint;
  141893. /**
  141894. * Gets the xyzw component
  141895. */
  141896. get xyzw(): NodeMaterialConnectionPoint;
  141897. /**
  141898. * Gets the x component
  141899. */
  141900. get x(): NodeMaterialConnectionPoint;
  141901. /**
  141902. * Gets the y component
  141903. */
  141904. get y(): NodeMaterialConnectionPoint;
  141905. /**
  141906. * Gets the z component
  141907. */
  141908. get z(): NodeMaterialConnectionPoint;
  141909. /**
  141910. * Gets the w component
  141911. */
  141912. get output(): NodeMaterialConnectionPoint;
  141913. protected writeOutputs(state: NodeMaterialBuildState): string;
  141914. protected _buildBlock(state: NodeMaterialBuildState): this;
  141915. }
  141916. }
  141917. declare module BABYLON {
  141918. /**
  141919. * Block used to get the screen sizes
  141920. */
  141921. export class ScreenSizeBlock extends NodeMaterialBlock {
  141922. private _varName;
  141923. private _scene;
  141924. /**
  141925. * Creates a new ScreenSizeBlock
  141926. * @param name defines the block name
  141927. */
  141928. constructor(name: string);
  141929. /**
  141930. * Gets the current class name
  141931. * @returns the class name
  141932. */
  141933. getClassName(): string;
  141934. /**
  141935. * Gets the xy component
  141936. */
  141937. get xy(): NodeMaterialConnectionPoint;
  141938. /**
  141939. * Gets the x component
  141940. */
  141941. get x(): NodeMaterialConnectionPoint;
  141942. /**
  141943. * Gets the y component
  141944. */
  141945. get y(): NodeMaterialConnectionPoint;
  141946. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  141947. protected writeOutputs(state: NodeMaterialBuildState, varName: string): string;
  141948. protected _buildBlock(state: NodeMaterialBuildState): this;
  141949. }
  141950. }
  141951. declare module BABYLON {
  141952. /**
  141953. * Block used to add support for scene fog
  141954. */
  141955. export class FogBlock extends NodeMaterialBlock {
  141956. private _fogDistanceName;
  141957. private _fogParameters;
  141958. /**
  141959. * Create a new FogBlock
  141960. * @param name defines the block name
  141961. */
  141962. constructor(name: string);
  141963. /**
  141964. * Gets the current class name
  141965. * @returns the class name
  141966. */
  141967. getClassName(): string;
  141968. /**
  141969. * Gets the world position input component
  141970. */
  141971. get worldPosition(): NodeMaterialConnectionPoint;
  141972. /**
  141973. * Gets the view input component
  141974. */
  141975. get view(): NodeMaterialConnectionPoint;
  141976. /**
  141977. * Gets the color input component
  141978. */
  141979. get input(): NodeMaterialConnectionPoint;
  141980. /**
  141981. * Gets the fog color input component
  141982. */
  141983. get fogColor(): NodeMaterialConnectionPoint;
  141984. /**
  141985. * Gets the output component
  141986. */
  141987. get output(): NodeMaterialConnectionPoint;
  141988. autoConfigure(material: NodeMaterial): void;
  141989. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  141990. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  141991. protected _buildBlock(state: NodeMaterialBuildState): this;
  141992. }
  141993. }
  141994. declare module BABYLON {
  141995. /**
  141996. * Block used to add light in the fragment shader
  141997. */
  141998. export class LightBlock extends NodeMaterialBlock {
  141999. private _lightId;
  142000. /**
  142001. * Gets or sets the light associated with this block
  142002. */
  142003. light: Nullable<Light>;
  142004. /**
  142005. * Create a new LightBlock
  142006. * @param name defines the block name
  142007. */
  142008. constructor(name: string);
  142009. /**
  142010. * Gets the current class name
  142011. * @returns the class name
  142012. */
  142013. getClassName(): string;
  142014. /**
  142015. * Gets the world position input component
  142016. */
  142017. get worldPosition(): NodeMaterialConnectionPoint;
  142018. /**
  142019. * Gets the world normal input component
  142020. */
  142021. get worldNormal(): NodeMaterialConnectionPoint;
  142022. /**
  142023. * Gets the camera (or eye) position component
  142024. */
  142025. get cameraPosition(): NodeMaterialConnectionPoint;
  142026. /**
  142027. * Gets the glossiness component
  142028. */
  142029. get glossiness(): NodeMaterialConnectionPoint;
  142030. /**
  142031. * Gets the glossinness power component
  142032. */
  142033. get glossPower(): NodeMaterialConnectionPoint;
  142034. /**
  142035. * Gets the diffuse color component
  142036. */
  142037. get diffuseColor(): NodeMaterialConnectionPoint;
  142038. /**
  142039. * Gets the specular color component
  142040. */
  142041. get specularColor(): NodeMaterialConnectionPoint;
  142042. /**
  142043. * Gets the diffuse output component
  142044. */
  142045. get diffuseOutput(): NodeMaterialConnectionPoint;
  142046. /**
  142047. * Gets the specular output component
  142048. */
  142049. get specularOutput(): NodeMaterialConnectionPoint;
  142050. /**
  142051. * Gets the shadow output component
  142052. */
  142053. get shadow(): NodeMaterialConnectionPoint;
  142054. autoConfigure(material: NodeMaterial): void;
  142055. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  142056. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  142057. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  142058. private _injectVertexCode;
  142059. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  142060. serialize(): any;
  142061. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  142062. }
  142063. }
  142064. declare module BABYLON {
  142065. /**
  142066. * Block used to read a reflection texture from a sampler
  142067. */
  142068. export class ReflectionTextureBlock extends ReflectionTextureBaseBlock {
  142069. /**
  142070. * Create a new ReflectionTextureBlock
  142071. * @param name defines the block name
  142072. */
  142073. constructor(name: string);
  142074. /**
  142075. * Gets the current class name
  142076. * @returns the class name
  142077. */
  142078. getClassName(): string;
  142079. /**
  142080. * Gets the world position input component
  142081. */
  142082. get position(): NodeMaterialConnectionPoint;
  142083. /**
  142084. * Gets the world position input component
  142085. */
  142086. get worldPosition(): NodeMaterialConnectionPoint;
  142087. /**
  142088. * Gets the world normal input component
  142089. */
  142090. get worldNormal(): NodeMaterialConnectionPoint;
  142091. /**
  142092. * Gets the world input component
  142093. */
  142094. get world(): NodeMaterialConnectionPoint;
  142095. /**
  142096. * Gets the camera (or eye) position component
  142097. */
  142098. get cameraPosition(): NodeMaterialConnectionPoint;
  142099. /**
  142100. * Gets the view input component
  142101. */
  142102. get view(): NodeMaterialConnectionPoint;
  142103. /**
  142104. * Gets the rgb output component
  142105. */
  142106. get rgb(): NodeMaterialConnectionPoint;
  142107. /**
  142108. * Gets the rgba output component
  142109. */
  142110. get rgba(): NodeMaterialConnectionPoint;
  142111. /**
  142112. * Gets the r output component
  142113. */
  142114. get r(): NodeMaterialConnectionPoint;
  142115. /**
  142116. * Gets the g output component
  142117. */
  142118. get g(): NodeMaterialConnectionPoint;
  142119. /**
  142120. * Gets the b output component
  142121. */
  142122. get b(): NodeMaterialConnectionPoint;
  142123. /**
  142124. * Gets the a output component
  142125. */
  142126. get a(): NodeMaterialConnectionPoint;
  142127. autoConfigure(material: NodeMaterial): void;
  142128. protected _buildBlock(state: NodeMaterialBuildState): this;
  142129. }
  142130. }
  142131. declare module BABYLON {
  142132. /**
  142133. * Block used to add 2 vectors
  142134. */
  142135. export class AddBlock extends NodeMaterialBlock {
  142136. /**
  142137. * Creates a new AddBlock
  142138. * @param name defines the block name
  142139. */
  142140. constructor(name: string);
  142141. /**
  142142. * Gets the current class name
  142143. * @returns the class name
  142144. */
  142145. getClassName(): string;
  142146. /**
  142147. * Gets the left operand input component
  142148. */
  142149. get left(): NodeMaterialConnectionPoint;
  142150. /**
  142151. * Gets the right operand input component
  142152. */
  142153. get right(): NodeMaterialConnectionPoint;
  142154. /**
  142155. * Gets the output component
  142156. */
  142157. get output(): NodeMaterialConnectionPoint;
  142158. protected _buildBlock(state: NodeMaterialBuildState): this;
  142159. }
  142160. }
  142161. declare module BABYLON {
  142162. /**
  142163. * Block used to scale a vector by a float
  142164. */
  142165. export class ScaleBlock extends NodeMaterialBlock {
  142166. /**
  142167. * Creates a new ScaleBlock
  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 input component
  142178. */
  142179. get input(): NodeMaterialConnectionPoint;
  142180. /**
  142181. * Gets the factor input component
  142182. */
  142183. get factor(): NodeMaterialConnectionPoint;
  142184. /**
  142185. * Gets the output component
  142186. */
  142187. get output(): NodeMaterialConnectionPoint;
  142188. protected _buildBlock(state: NodeMaterialBuildState): this;
  142189. }
  142190. }
  142191. declare module BABYLON {
  142192. /**
  142193. * Block used to clamp a float
  142194. */
  142195. export class ClampBlock extends NodeMaterialBlock {
  142196. /** Gets or sets the minimum range */
  142197. minimum: number;
  142198. /** Gets or sets the maximum range */
  142199. maximum: number;
  142200. /**
  142201. * Creates a new ClampBlock
  142202. * @param name defines the block name
  142203. */
  142204. constructor(name: string);
  142205. /**
  142206. * Gets the current class name
  142207. * @returns the class name
  142208. */
  142209. getClassName(): string;
  142210. /**
  142211. * Gets the value input component
  142212. */
  142213. get value(): NodeMaterialConnectionPoint;
  142214. /**
  142215. * Gets the output component
  142216. */
  142217. get output(): NodeMaterialConnectionPoint;
  142218. protected _buildBlock(state: NodeMaterialBuildState): this;
  142219. protected _dumpPropertiesCode(): string;
  142220. serialize(): any;
  142221. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  142222. }
  142223. }
  142224. declare module BABYLON {
  142225. /**
  142226. * Block used to apply a cross product between 2 vectors
  142227. */
  142228. export class CrossBlock extends NodeMaterialBlock {
  142229. /**
  142230. * Creates a new CrossBlock
  142231. * @param name defines the block name
  142232. */
  142233. constructor(name: string);
  142234. /**
  142235. * Gets the current class name
  142236. * @returns the class name
  142237. */
  142238. getClassName(): string;
  142239. /**
  142240. * Gets the left operand input component
  142241. */
  142242. get left(): NodeMaterialConnectionPoint;
  142243. /**
  142244. * Gets the right operand input component
  142245. */
  142246. get right(): NodeMaterialConnectionPoint;
  142247. /**
  142248. * Gets the output component
  142249. */
  142250. get output(): NodeMaterialConnectionPoint;
  142251. protected _buildBlock(state: NodeMaterialBuildState): this;
  142252. }
  142253. }
  142254. declare module BABYLON {
  142255. /**
  142256. * Block used to apply a dot product between 2 vectors
  142257. */
  142258. export class DotBlock extends NodeMaterialBlock {
  142259. /**
  142260. * Creates a new DotBlock
  142261. * @param name defines the block name
  142262. */
  142263. constructor(name: string);
  142264. /**
  142265. * Gets the current class name
  142266. * @returns the class name
  142267. */
  142268. getClassName(): string;
  142269. /**
  142270. * Gets the left operand input component
  142271. */
  142272. get left(): NodeMaterialConnectionPoint;
  142273. /**
  142274. * Gets the right operand input component
  142275. */
  142276. get right(): NodeMaterialConnectionPoint;
  142277. /**
  142278. * Gets the output component
  142279. */
  142280. get output(): NodeMaterialConnectionPoint;
  142281. protected _buildBlock(state: NodeMaterialBuildState): this;
  142282. }
  142283. }
  142284. declare module BABYLON {
  142285. /**
  142286. * Block used to normalize a vector
  142287. */
  142288. export class NormalizeBlock extends NodeMaterialBlock {
  142289. /**
  142290. * Creates a new NormalizeBlock
  142291. * @param name defines the block name
  142292. */
  142293. constructor(name: string);
  142294. /**
  142295. * Gets the current class name
  142296. * @returns the class name
  142297. */
  142298. getClassName(): string;
  142299. /**
  142300. * Gets the input component
  142301. */
  142302. get input(): NodeMaterialConnectionPoint;
  142303. /**
  142304. * Gets the output component
  142305. */
  142306. get output(): NodeMaterialConnectionPoint;
  142307. protected _buildBlock(state: NodeMaterialBuildState): this;
  142308. }
  142309. }
  142310. declare module BABYLON {
  142311. /**
  142312. * Operations supported by the Trigonometry block
  142313. */
  142314. export enum TrigonometryBlockOperations {
  142315. /** Cos */
  142316. Cos = 0,
  142317. /** Sin */
  142318. Sin = 1,
  142319. /** Abs */
  142320. Abs = 2,
  142321. /** Exp */
  142322. Exp = 3,
  142323. /** Exp2 */
  142324. Exp2 = 4,
  142325. /** Round */
  142326. Round = 5,
  142327. /** Floor */
  142328. Floor = 6,
  142329. /** Ceiling */
  142330. Ceiling = 7,
  142331. /** Square root */
  142332. Sqrt = 8,
  142333. /** Log */
  142334. Log = 9,
  142335. /** Tangent */
  142336. Tan = 10,
  142337. /** Arc tangent */
  142338. ArcTan = 11,
  142339. /** Arc cosinus */
  142340. ArcCos = 12,
  142341. /** Arc sinus */
  142342. ArcSin = 13,
  142343. /** Fraction */
  142344. Fract = 14,
  142345. /** Sign */
  142346. Sign = 15,
  142347. /** To radians (from degrees) */
  142348. Radians = 16,
  142349. /** To degrees (from radians) */
  142350. Degrees = 17
  142351. }
  142352. /**
  142353. * Block used to apply trigonometry operation to floats
  142354. */
  142355. export class TrigonometryBlock extends NodeMaterialBlock {
  142356. /**
  142357. * Gets or sets the operation applied by the block
  142358. */
  142359. operation: TrigonometryBlockOperations;
  142360. /**
  142361. * Creates a new TrigonometryBlock
  142362. * @param name defines the block name
  142363. */
  142364. constructor(name: string);
  142365. /**
  142366. * Gets the current class name
  142367. * @returns the class name
  142368. */
  142369. getClassName(): string;
  142370. /**
  142371. * Gets the input component
  142372. */
  142373. get input(): NodeMaterialConnectionPoint;
  142374. /**
  142375. * Gets the output component
  142376. */
  142377. get output(): NodeMaterialConnectionPoint;
  142378. protected _buildBlock(state: NodeMaterialBuildState): this;
  142379. serialize(): any;
  142380. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  142381. protected _dumpPropertiesCode(): string;
  142382. }
  142383. }
  142384. declare module BABYLON {
  142385. /**
  142386. * Block used to create a Color3/4 out of individual inputs (one for each component)
  142387. */
  142388. export class ColorMergerBlock extends NodeMaterialBlock {
  142389. /**
  142390. * Create a new ColorMergerBlock
  142391. * @param name defines the block name
  142392. */
  142393. constructor(name: string);
  142394. /**
  142395. * Gets the current class name
  142396. * @returns the class name
  142397. */
  142398. getClassName(): string;
  142399. /**
  142400. * Gets the rgb component (input)
  142401. */
  142402. get rgbIn(): NodeMaterialConnectionPoint;
  142403. /**
  142404. * Gets the r component (input)
  142405. */
  142406. get r(): NodeMaterialConnectionPoint;
  142407. /**
  142408. * Gets the g component (input)
  142409. */
  142410. get g(): NodeMaterialConnectionPoint;
  142411. /**
  142412. * Gets the b component (input)
  142413. */
  142414. get b(): NodeMaterialConnectionPoint;
  142415. /**
  142416. * Gets the a component (input)
  142417. */
  142418. get a(): NodeMaterialConnectionPoint;
  142419. /**
  142420. * Gets the rgba component (output)
  142421. */
  142422. get rgba(): NodeMaterialConnectionPoint;
  142423. /**
  142424. * Gets the rgb component (output)
  142425. */
  142426. get rgbOut(): NodeMaterialConnectionPoint;
  142427. /**
  142428. * Gets the rgb component (output)
  142429. * @deprecated Please use rgbOut instead.
  142430. */
  142431. get rgb(): NodeMaterialConnectionPoint;
  142432. protected _buildBlock(state: NodeMaterialBuildState): this;
  142433. }
  142434. }
  142435. declare module BABYLON {
  142436. /**
  142437. * Block used to expand a Vector3/4 into 4 outputs (one for each component)
  142438. */
  142439. export class VectorSplitterBlock extends NodeMaterialBlock {
  142440. /**
  142441. * Create a new VectorSplitterBlock
  142442. * @param name defines the block name
  142443. */
  142444. constructor(name: string);
  142445. /**
  142446. * Gets the current class name
  142447. * @returns the class name
  142448. */
  142449. getClassName(): string;
  142450. /**
  142451. * Gets the xyzw component (input)
  142452. */
  142453. get xyzw(): NodeMaterialConnectionPoint;
  142454. /**
  142455. * Gets the xyz component (input)
  142456. */
  142457. get xyzIn(): NodeMaterialConnectionPoint;
  142458. /**
  142459. * Gets the xy component (input)
  142460. */
  142461. get xyIn(): NodeMaterialConnectionPoint;
  142462. /**
  142463. * Gets the xyz component (output)
  142464. */
  142465. get xyzOut(): NodeMaterialConnectionPoint;
  142466. /**
  142467. * Gets the xy component (output)
  142468. */
  142469. get xyOut(): NodeMaterialConnectionPoint;
  142470. /**
  142471. * Gets the x component (output)
  142472. */
  142473. get x(): NodeMaterialConnectionPoint;
  142474. /**
  142475. * Gets the y component (output)
  142476. */
  142477. get y(): NodeMaterialConnectionPoint;
  142478. /**
  142479. * Gets the z component (output)
  142480. */
  142481. get z(): NodeMaterialConnectionPoint;
  142482. /**
  142483. * Gets the w component (output)
  142484. */
  142485. get w(): NodeMaterialConnectionPoint;
  142486. protected _inputRename(name: string): string;
  142487. protected _outputRename(name: string): string;
  142488. protected _buildBlock(state: NodeMaterialBuildState): this;
  142489. }
  142490. }
  142491. declare module BABYLON {
  142492. /**
  142493. * Block used to lerp between 2 values
  142494. */
  142495. export class LerpBlock extends NodeMaterialBlock {
  142496. /**
  142497. * Creates a new LerpBlock
  142498. * @param name defines the block name
  142499. */
  142500. constructor(name: string);
  142501. /**
  142502. * Gets the current class name
  142503. * @returns the class name
  142504. */
  142505. getClassName(): string;
  142506. /**
  142507. * Gets the left operand input component
  142508. */
  142509. get left(): NodeMaterialConnectionPoint;
  142510. /**
  142511. * Gets the right operand input component
  142512. */
  142513. get right(): NodeMaterialConnectionPoint;
  142514. /**
  142515. * Gets the gradient operand input component
  142516. */
  142517. get gradient(): NodeMaterialConnectionPoint;
  142518. /**
  142519. * Gets the output component
  142520. */
  142521. get output(): NodeMaterialConnectionPoint;
  142522. protected _buildBlock(state: NodeMaterialBuildState): this;
  142523. }
  142524. }
  142525. declare module BABYLON {
  142526. /**
  142527. * Block used to divide 2 vectors
  142528. */
  142529. export class DivideBlock extends NodeMaterialBlock {
  142530. /**
  142531. * Creates a new DivideBlock
  142532. * @param name defines the block name
  142533. */
  142534. constructor(name: string);
  142535. /**
  142536. * Gets the current class name
  142537. * @returns the class name
  142538. */
  142539. getClassName(): string;
  142540. /**
  142541. * Gets the left operand input component
  142542. */
  142543. get left(): NodeMaterialConnectionPoint;
  142544. /**
  142545. * Gets the right operand input component
  142546. */
  142547. get right(): NodeMaterialConnectionPoint;
  142548. /**
  142549. * Gets the output component
  142550. */
  142551. get output(): NodeMaterialConnectionPoint;
  142552. protected _buildBlock(state: NodeMaterialBuildState): this;
  142553. }
  142554. }
  142555. declare module BABYLON {
  142556. /**
  142557. * Block used to subtract 2 vectors
  142558. */
  142559. export class SubtractBlock extends NodeMaterialBlock {
  142560. /**
  142561. * Creates a new SubtractBlock
  142562. * @param name defines the block name
  142563. */
  142564. constructor(name: string);
  142565. /**
  142566. * Gets the current class name
  142567. * @returns the class name
  142568. */
  142569. getClassName(): string;
  142570. /**
  142571. * Gets the left operand input component
  142572. */
  142573. get left(): NodeMaterialConnectionPoint;
  142574. /**
  142575. * Gets the right operand input component
  142576. */
  142577. get right(): NodeMaterialConnectionPoint;
  142578. /**
  142579. * Gets the output component
  142580. */
  142581. get output(): NodeMaterialConnectionPoint;
  142582. protected _buildBlock(state: NodeMaterialBuildState): this;
  142583. }
  142584. }
  142585. declare module BABYLON {
  142586. /**
  142587. * Block used to step a value
  142588. */
  142589. export class StepBlock extends NodeMaterialBlock {
  142590. /**
  142591. * Creates a new StepBlock
  142592. * @param name defines the block name
  142593. */
  142594. constructor(name: string);
  142595. /**
  142596. * Gets the current class name
  142597. * @returns the class name
  142598. */
  142599. getClassName(): string;
  142600. /**
  142601. * Gets the value operand input component
  142602. */
  142603. get value(): NodeMaterialConnectionPoint;
  142604. /**
  142605. * Gets the edge operand input component
  142606. */
  142607. get edge(): NodeMaterialConnectionPoint;
  142608. /**
  142609. * Gets the output component
  142610. */
  142611. get output(): NodeMaterialConnectionPoint;
  142612. protected _buildBlock(state: NodeMaterialBuildState): this;
  142613. }
  142614. }
  142615. declare module BABYLON {
  142616. /**
  142617. * Block used to get the opposite (1 - x) of a value
  142618. */
  142619. export class OneMinusBlock extends NodeMaterialBlock {
  142620. /**
  142621. * Creates a new OneMinusBlock
  142622. * @param name defines the block name
  142623. */
  142624. constructor(name: string);
  142625. /**
  142626. * Gets the current class name
  142627. * @returns the class name
  142628. */
  142629. getClassName(): string;
  142630. /**
  142631. * Gets the input component
  142632. */
  142633. get input(): NodeMaterialConnectionPoint;
  142634. /**
  142635. * Gets the output component
  142636. */
  142637. get output(): NodeMaterialConnectionPoint;
  142638. protected _buildBlock(state: NodeMaterialBuildState): this;
  142639. }
  142640. }
  142641. declare module BABYLON {
  142642. /**
  142643. * Block used to get the view direction
  142644. */
  142645. export class ViewDirectionBlock extends NodeMaterialBlock {
  142646. /**
  142647. * Creates a new ViewDirectionBlock
  142648. * @param name defines the block name
  142649. */
  142650. constructor(name: string);
  142651. /**
  142652. * Gets the current class name
  142653. * @returns the class name
  142654. */
  142655. getClassName(): string;
  142656. /**
  142657. * Gets the world position component
  142658. */
  142659. get worldPosition(): NodeMaterialConnectionPoint;
  142660. /**
  142661. * Gets the camera position component
  142662. */
  142663. get cameraPosition(): NodeMaterialConnectionPoint;
  142664. /**
  142665. * Gets the output component
  142666. */
  142667. get output(): NodeMaterialConnectionPoint;
  142668. autoConfigure(material: NodeMaterial): void;
  142669. protected _buildBlock(state: NodeMaterialBuildState): this;
  142670. }
  142671. }
  142672. declare module BABYLON {
  142673. /**
  142674. * Block used to compute fresnel value
  142675. */
  142676. export class FresnelBlock extends NodeMaterialBlock {
  142677. /**
  142678. * Create a new FresnelBlock
  142679. * @param name defines the block name
  142680. */
  142681. constructor(name: string);
  142682. /**
  142683. * Gets the current class name
  142684. * @returns the class name
  142685. */
  142686. getClassName(): string;
  142687. /**
  142688. * Gets the world normal input component
  142689. */
  142690. get worldNormal(): NodeMaterialConnectionPoint;
  142691. /**
  142692. * Gets the view direction input component
  142693. */
  142694. get viewDirection(): NodeMaterialConnectionPoint;
  142695. /**
  142696. * Gets the bias input component
  142697. */
  142698. get bias(): NodeMaterialConnectionPoint;
  142699. /**
  142700. * Gets the camera (or eye) position component
  142701. */
  142702. get power(): NodeMaterialConnectionPoint;
  142703. /**
  142704. * Gets the fresnel output component
  142705. */
  142706. get fresnel(): NodeMaterialConnectionPoint;
  142707. autoConfigure(material: NodeMaterial): void;
  142708. protected _buildBlock(state: NodeMaterialBuildState): this;
  142709. }
  142710. }
  142711. declare module BABYLON {
  142712. /**
  142713. * Block used to get the max of 2 values
  142714. */
  142715. export class MaxBlock extends NodeMaterialBlock {
  142716. /**
  142717. * Creates a new MaxBlock
  142718. * @param name defines the block name
  142719. */
  142720. constructor(name: string);
  142721. /**
  142722. * Gets the current class name
  142723. * @returns the class name
  142724. */
  142725. getClassName(): string;
  142726. /**
  142727. * Gets the left operand input component
  142728. */
  142729. get left(): NodeMaterialConnectionPoint;
  142730. /**
  142731. * Gets the right operand input component
  142732. */
  142733. get right(): NodeMaterialConnectionPoint;
  142734. /**
  142735. * Gets the output component
  142736. */
  142737. get output(): NodeMaterialConnectionPoint;
  142738. protected _buildBlock(state: NodeMaterialBuildState): this;
  142739. }
  142740. }
  142741. declare module BABYLON {
  142742. /**
  142743. * Block used to get the min of 2 values
  142744. */
  142745. export class MinBlock extends NodeMaterialBlock {
  142746. /**
  142747. * Creates a new MinBlock
  142748. * @param name defines the block name
  142749. */
  142750. constructor(name: string);
  142751. /**
  142752. * Gets the current class name
  142753. * @returns the class name
  142754. */
  142755. getClassName(): string;
  142756. /**
  142757. * Gets the left operand input component
  142758. */
  142759. get left(): NodeMaterialConnectionPoint;
  142760. /**
  142761. * Gets the right operand input component
  142762. */
  142763. get right(): NodeMaterialConnectionPoint;
  142764. /**
  142765. * Gets the output component
  142766. */
  142767. get output(): NodeMaterialConnectionPoint;
  142768. protected _buildBlock(state: NodeMaterialBuildState): this;
  142769. }
  142770. }
  142771. declare module BABYLON {
  142772. /**
  142773. * Block used to get the distance between 2 values
  142774. */
  142775. export class DistanceBlock extends NodeMaterialBlock {
  142776. /**
  142777. * Creates a new DistanceBlock
  142778. * @param name defines the block name
  142779. */
  142780. constructor(name: string);
  142781. /**
  142782. * Gets the current class name
  142783. * @returns the class name
  142784. */
  142785. getClassName(): string;
  142786. /**
  142787. * Gets the left operand input component
  142788. */
  142789. get left(): NodeMaterialConnectionPoint;
  142790. /**
  142791. * Gets the right operand input component
  142792. */
  142793. get right(): NodeMaterialConnectionPoint;
  142794. /**
  142795. * Gets the output component
  142796. */
  142797. get output(): NodeMaterialConnectionPoint;
  142798. protected _buildBlock(state: NodeMaterialBuildState): this;
  142799. }
  142800. }
  142801. declare module BABYLON {
  142802. /**
  142803. * Block used to get the length of a vector
  142804. */
  142805. export class LengthBlock extends NodeMaterialBlock {
  142806. /**
  142807. * Creates a new LengthBlock
  142808. * @param name defines the block name
  142809. */
  142810. constructor(name: string);
  142811. /**
  142812. * Gets the current class name
  142813. * @returns the class name
  142814. */
  142815. getClassName(): string;
  142816. /**
  142817. * Gets the value input component
  142818. */
  142819. get value(): NodeMaterialConnectionPoint;
  142820. /**
  142821. * Gets the output component
  142822. */
  142823. get output(): NodeMaterialConnectionPoint;
  142824. protected _buildBlock(state: NodeMaterialBuildState): this;
  142825. }
  142826. }
  142827. declare module BABYLON {
  142828. /**
  142829. * Block used to get negative version of a value (i.e. x * -1)
  142830. */
  142831. export class NegateBlock extends NodeMaterialBlock {
  142832. /**
  142833. * Creates a new NegateBlock
  142834. * @param name defines the block name
  142835. */
  142836. constructor(name: string);
  142837. /**
  142838. * Gets the current class name
  142839. * @returns the class name
  142840. */
  142841. getClassName(): string;
  142842. /**
  142843. * Gets the value input component
  142844. */
  142845. get value(): NodeMaterialConnectionPoint;
  142846. /**
  142847. * Gets the output component
  142848. */
  142849. get output(): NodeMaterialConnectionPoint;
  142850. protected _buildBlock(state: NodeMaterialBuildState): this;
  142851. }
  142852. }
  142853. declare module BABYLON {
  142854. /**
  142855. * Block used to get the value of the first parameter raised to the power of the second
  142856. */
  142857. export class PowBlock extends NodeMaterialBlock {
  142858. /**
  142859. * Creates a new PowBlock
  142860. * @param name defines the block name
  142861. */
  142862. constructor(name: string);
  142863. /**
  142864. * Gets the current class name
  142865. * @returns the class name
  142866. */
  142867. getClassName(): string;
  142868. /**
  142869. * Gets the value operand input component
  142870. */
  142871. get value(): NodeMaterialConnectionPoint;
  142872. /**
  142873. * Gets the power operand input component
  142874. */
  142875. get power(): NodeMaterialConnectionPoint;
  142876. /**
  142877. * Gets the output component
  142878. */
  142879. get output(): NodeMaterialConnectionPoint;
  142880. protected _buildBlock(state: NodeMaterialBuildState): this;
  142881. }
  142882. }
  142883. declare module BABYLON {
  142884. /**
  142885. * Block used to get a random number
  142886. */
  142887. export class RandomNumberBlock extends NodeMaterialBlock {
  142888. /**
  142889. * Creates a new RandomNumberBlock
  142890. * @param name defines the block name
  142891. */
  142892. constructor(name: string);
  142893. /**
  142894. * Gets the current class name
  142895. * @returns the class name
  142896. */
  142897. getClassName(): string;
  142898. /**
  142899. * Gets the seed input component
  142900. */
  142901. get seed(): NodeMaterialConnectionPoint;
  142902. /**
  142903. * Gets the output component
  142904. */
  142905. get output(): NodeMaterialConnectionPoint;
  142906. protected _buildBlock(state: NodeMaterialBuildState): this;
  142907. }
  142908. }
  142909. declare module BABYLON {
  142910. /**
  142911. * Block used to compute arc tangent of 2 values
  142912. */
  142913. export class ArcTan2Block extends NodeMaterialBlock {
  142914. /**
  142915. * Creates a new ArcTan2Block
  142916. * @param name defines the block name
  142917. */
  142918. constructor(name: string);
  142919. /**
  142920. * Gets the current class name
  142921. * @returns the class name
  142922. */
  142923. getClassName(): string;
  142924. /**
  142925. * Gets the x operand input component
  142926. */
  142927. get x(): NodeMaterialConnectionPoint;
  142928. /**
  142929. * Gets the y operand input component
  142930. */
  142931. get y(): NodeMaterialConnectionPoint;
  142932. /**
  142933. * Gets the output component
  142934. */
  142935. get output(): NodeMaterialConnectionPoint;
  142936. protected _buildBlock(state: NodeMaterialBuildState): this;
  142937. }
  142938. }
  142939. declare module BABYLON {
  142940. /**
  142941. * Block used to smooth step a value
  142942. */
  142943. export class SmoothStepBlock extends NodeMaterialBlock {
  142944. /**
  142945. * Creates a new SmoothStepBlock
  142946. * @param name defines the block name
  142947. */
  142948. constructor(name: string);
  142949. /**
  142950. * Gets the current class name
  142951. * @returns the class name
  142952. */
  142953. getClassName(): string;
  142954. /**
  142955. * Gets the value operand input component
  142956. */
  142957. get value(): NodeMaterialConnectionPoint;
  142958. /**
  142959. * Gets the first edge operand input component
  142960. */
  142961. get edge0(): NodeMaterialConnectionPoint;
  142962. /**
  142963. * Gets the second edge operand input component
  142964. */
  142965. get edge1(): NodeMaterialConnectionPoint;
  142966. /**
  142967. * Gets the output component
  142968. */
  142969. get output(): NodeMaterialConnectionPoint;
  142970. protected _buildBlock(state: NodeMaterialBuildState): this;
  142971. }
  142972. }
  142973. declare module BABYLON {
  142974. /**
  142975. * Block used to get the reciprocal (1 / x) of a value
  142976. */
  142977. export class ReciprocalBlock extends NodeMaterialBlock {
  142978. /**
  142979. * Creates a new ReciprocalBlock
  142980. * @param name defines the block name
  142981. */
  142982. constructor(name: string);
  142983. /**
  142984. * Gets the current class name
  142985. * @returns the class name
  142986. */
  142987. getClassName(): string;
  142988. /**
  142989. * Gets the input component
  142990. */
  142991. get input(): NodeMaterialConnectionPoint;
  142992. /**
  142993. * Gets the output component
  142994. */
  142995. get output(): NodeMaterialConnectionPoint;
  142996. protected _buildBlock(state: NodeMaterialBuildState): this;
  142997. }
  142998. }
  142999. declare module BABYLON {
  143000. /**
  143001. * Block used to replace a color by another one
  143002. */
  143003. export class ReplaceColorBlock extends NodeMaterialBlock {
  143004. /**
  143005. * Creates a new ReplaceColorBlock
  143006. * @param name defines the block name
  143007. */
  143008. constructor(name: string);
  143009. /**
  143010. * Gets the current class name
  143011. * @returns the class name
  143012. */
  143013. getClassName(): string;
  143014. /**
  143015. * Gets the value input component
  143016. */
  143017. get value(): NodeMaterialConnectionPoint;
  143018. /**
  143019. * Gets the reference input component
  143020. */
  143021. get reference(): NodeMaterialConnectionPoint;
  143022. /**
  143023. * Gets the distance input component
  143024. */
  143025. get distance(): NodeMaterialConnectionPoint;
  143026. /**
  143027. * Gets the replacement input component
  143028. */
  143029. get replacement(): NodeMaterialConnectionPoint;
  143030. /**
  143031. * Gets the output component
  143032. */
  143033. get output(): NodeMaterialConnectionPoint;
  143034. protected _buildBlock(state: NodeMaterialBuildState): this;
  143035. }
  143036. }
  143037. declare module BABYLON {
  143038. /**
  143039. * Block used to posterize a value
  143040. * @see https://en.wikipedia.org/wiki/Posterization
  143041. */
  143042. export class PosterizeBlock extends NodeMaterialBlock {
  143043. /**
  143044. * Creates a new PosterizeBlock
  143045. * @param name defines the block name
  143046. */
  143047. constructor(name: string);
  143048. /**
  143049. * Gets the current class name
  143050. * @returns the class name
  143051. */
  143052. getClassName(): string;
  143053. /**
  143054. * Gets the value input component
  143055. */
  143056. get value(): NodeMaterialConnectionPoint;
  143057. /**
  143058. * Gets the steps input component
  143059. */
  143060. get steps(): NodeMaterialConnectionPoint;
  143061. /**
  143062. * Gets the output component
  143063. */
  143064. get output(): NodeMaterialConnectionPoint;
  143065. protected _buildBlock(state: NodeMaterialBuildState): this;
  143066. }
  143067. }
  143068. declare module BABYLON {
  143069. /**
  143070. * Operations supported by the Wave block
  143071. */
  143072. export enum WaveBlockKind {
  143073. /** SawTooth */
  143074. SawTooth = 0,
  143075. /** Square */
  143076. Square = 1,
  143077. /** Triangle */
  143078. Triangle = 2
  143079. }
  143080. /**
  143081. * Block used to apply wave operation to floats
  143082. */
  143083. export class WaveBlock extends NodeMaterialBlock {
  143084. /**
  143085. * Gets or sets the kibnd of wave to be applied by the block
  143086. */
  143087. kind: WaveBlockKind;
  143088. /**
  143089. * Creates a new WaveBlock
  143090. * @param name defines the block name
  143091. */
  143092. constructor(name: string);
  143093. /**
  143094. * Gets the current class name
  143095. * @returns the class name
  143096. */
  143097. getClassName(): string;
  143098. /**
  143099. * Gets the input component
  143100. */
  143101. get input(): NodeMaterialConnectionPoint;
  143102. /**
  143103. * Gets the output component
  143104. */
  143105. get output(): NodeMaterialConnectionPoint;
  143106. protected _buildBlock(state: NodeMaterialBuildState): this;
  143107. serialize(): any;
  143108. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  143109. }
  143110. }
  143111. declare module BABYLON {
  143112. /**
  143113. * Class used to store a color step for the GradientBlock
  143114. */
  143115. export class GradientBlockColorStep {
  143116. /**
  143117. * Gets or sets a value indicating which step this color is associated with (between 0 and 1)
  143118. */
  143119. step: number;
  143120. /**
  143121. * Gets or sets the color associated with this step
  143122. */
  143123. color: Color3;
  143124. /**
  143125. * Creates a new GradientBlockColorStep
  143126. * @param step defines a value indicating which step this color is associated with (between 0 and 1)
  143127. * @param color defines the color associated with this step
  143128. */
  143129. constructor(
  143130. /**
  143131. * Gets or sets a value indicating which step this color is associated with (between 0 and 1)
  143132. */
  143133. step: number,
  143134. /**
  143135. * Gets or sets the color associated with this step
  143136. */
  143137. color: Color3);
  143138. }
  143139. /**
  143140. * Block used to return a color from a gradient based on an input value between 0 and 1
  143141. */
  143142. export class GradientBlock extends NodeMaterialBlock {
  143143. /**
  143144. * Gets or sets the list of color steps
  143145. */
  143146. colorSteps: GradientBlockColorStep[];
  143147. /**
  143148. * Creates a new GradientBlock
  143149. * @param name defines the block name
  143150. */
  143151. constructor(name: string);
  143152. /**
  143153. * Gets the current class name
  143154. * @returns the class name
  143155. */
  143156. getClassName(): string;
  143157. /**
  143158. * Gets the gradient input component
  143159. */
  143160. get gradient(): NodeMaterialConnectionPoint;
  143161. /**
  143162. * Gets the output component
  143163. */
  143164. get output(): NodeMaterialConnectionPoint;
  143165. private _writeColorConstant;
  143166. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  143167. serialize(): any;
  143168. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  143169. protected _dumpPropertiesCode(): string;
  143170. }
  143171. }
  143172. declare module BABYLON {
  143173. /**
  143174. * Block used to normalize lerp between 2 values
  143175. */
  143176. export class NLerpBlock extends NodeMaterialBlock {
  143177. /**
  143178. * Creates a new NLerpBlock
  143179. * @param name defines the block name
  143180. */
  143181. constructor(name: string);
  143182. /**
  143183. * Gets the current class name
  143184. * @returns the class name
  143185. */
  143186. getClassName(): string;
  143187. /**
  143188. * Gets the left operand input component
  143189. */
  143190. get left(): NodeMaterialConnectionPoint;
  143191. /**
  143192. * Gets the right operand input component
  143193. */
  143194. get right(): NodeMaterialConnectionPoint;
  143195. /**
  143196. * Gets the gradient operand input component
  143197. */
  143198. get gradient(): NodeMaterialConnectionPoint;
  143199. /**
  143200. * Gets the output component
  143201. */
  143202. get output(): NodeMaterialConnectionPoint;
  143203. protected _buildBlock(state: NodeMaterialBuildState): this;
  143204. }
  143205. }
  143206. declare module BABYLON {
  143207. /**
  143208. * block used to Generate a Worley Noise 3D Noise Pattern
  143209. */
  143210. export class WorleyNoise3DBlock extends NodeMaterialBlock {
  143211. /** Gets or sets a boolean indicating that normal should be inverted on X axis */
  143212. manhattanDistance: boolean;
  143213. /**
  143214. * Creates a new WorleyNoise3DBlock
  143215. * @param name defines the block name
  143216. */
  143217. constructor(name: string);
  143218. /**
  143219. * Gets the current class name
  143220. * @returns the class name
  143221. */
  143222. getClassName(): string;
  143223. /**
  143224. * Gets the seed input component
  143225. */
  143226. get seed(): NodeMaterialConnectionPoint;
  143227. /**
  143228. * Gets the jitter input component
  143229. */
  143230. get jitter(): NodeMaterialConnectionPoint;
  143231. /**
  143232. * Gets the output component
  143233. */
  143234. get output(): NodeMaterialConnectionPoint;
  143235. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  143236. /**
  143237. * Exposes the properties to the UI?
  143238. */
  143239. protected _dumpPropertiesCode(): string;
  143240. /**
  143241. * Exposes the properties to the Seralize?
  143242. */
  143243. serialize(): any;
  143244. /**
  143245. * Exposes the properties to the deseralize?
  143246. */
  143247. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  143248. }
  143249. }
  143250. declare module BABYLON {
  143251. /**
  143252. * block used to Generate a Simplex Perlin 3d Noise Pattern
  143253. */
  143254. export class SimplexPerlin3DBlock extends NodeMaterialBlock {
  143255. /**
  143256. * Creates a new SimplexPerlin3DBlock
  143257. * @param name defines the block name
  143258. */
  143259. constructor(name: string);
  143260. /**
  143261. * Gets the current class name
  143262. * @returns the class name
  143263. */
  143264. getClassName(): string;
  143265. /**
  143266. * Gets the seed operand input component
  143267. */
  143268. get seed(): NodeMaterialConnectionPoint;
  143269. /**
  143270. * Gets the output component
  143271. */
  143272. get output(): NodeMaterialConnectionPoint;
  143273. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  143274. }
  143275. }
  143276. declare module BABYLON {
  143277. /**
  143278. * Block used to blend normals
  143279. */
  143280. export class NormalBlendBlock extends NodeMaterialBlock {
  143281. /**
  143282. * Creates a new NormalBlendBlock
  143283. * @param name defines the block name
  143284. */
  143285. constructor(name: string);
  143286. /**
  143287. * Gets the current class name
  143288. * @returns the class name
  143289. */
  143290. getClassName(): string;
  143291. /**
  143292. * Gets the first input component
  143293. */
  143294. get normalMap0(): NodeMaterialConnectionPoint;
  143295. /**
  143296. * Gets the second input component
  143297. */
  143298. get normalMap1(): NodeMaterialConnectionPoint;
  143299. /**
  143300. * Gets the output component
  143301. */
  143302. get output(): NodeMaterialConnectionPoint;
  143303. protected _buildBlock(state: NodeMaterialBuildState): this;
  143304. }
  143305. }
  143306. declare module BABYLON {
  143307. /**
  143308. * Block used to rotate a 2d vector by a given angle
  143309. */
  143310. export class Rotate2dBlock extends NodeMaterialBlock {
  143311. /**
  143312. * Creates a new Rotate2dBlock
  143313. * @param name defines the block name
  143314. */
  143315. constructor(name: string);
  143316. /**
  143317. * Gets the current class name
  143318. * @returns the class name
  143319. */
  143320. getClassName(): string;
  143321. /**
  143322. * Gets the input vector
  143323. */
  143324. get input(): NodeMaterialConnectionPoint;
  143325. /**
  143326. * Gets the input angle
  143327. */
  143328. get angle(): NodeMaterialConnectionPoint;
  143329. /**
  143330. * Gets the output component
  143331. */
  143332. get output(): NodeMaterialConnectionPoint;
  143333. autoConfigure(material: NodeMaterial): void;
  143334. protected _buildBlock(state: NodeMaterialBuildState): this;
  143335. }
  143336. }
  143337. declare module BABYLON {
  143338. /**
  143339. * Block used to get the reflected vector from a direction and a normal
  143340. */
  143341. export class ReflectBlock extends NodeMaterialBlock {
  143342. /**
  143343. * Creates a new ReflectBlock
  143344. * @param name defines the block name
  143345. */
  143346. constructor(name: string);
  143347. /**
  143348. * Gets the current class name
  143349. * @returns the class name
  143350. */
  143351. getClassName(): string;
  143352. /**
  143353. * Gets the incident component
  143354. */
  143355. get incident(): NodeMaterialConnectionPoint;
  143356. /**
  143357. * Gets the normal component
  143358. */
  143359. get normal(): NodeMaterialConnectionPoint;
  143360. /**
  143361. * Gets the output component
  143362. */
  143363. get output(): NodeMaterialConnectionPoint;
  143364. protected _buildBlock(state: NodeMaterialBuildState): this;
  143365. }
  143366. }
  143367. declare module BABYLON {
  143368. /**
  143369. * Block used to get the refracted vector from a direction and a normal
  143370. */
  143371. export class RefractBlock extends NodeMaterialBlock {
  143372. /**
  143373. * Creates a new RefractBlock
  143374. * @param name defines the block name
  143375. */
  143376. constructor(name: string);
  143377. /**
  143378. * Gets the current class name
  143379. * @returns the class name
  143380. */
  143381. getClassName(): string;
  143382. /**
  143383. * Gets the incident component
  143384. */
  143385. get incident(): NodeMaterialConnectionPoint;
  143386. /**
  143387. * Gets the normal component
  143388. */
  143389. get normal(): NodeMaterialConnectionPoint;
  143390. /**
  143391. * Gets the index of refraction component
  143392. */
  143393. get ior(): NodeMaterialConnectionPoint;
  143394. /**
  143395. * Gets the output component
  143396. */
  143397. get output(): NodeMaterialConnectionPoint;
  143398. protected _buildBlock(state: NodeMaterialBuildState): this;
  143399. }
  143400. }
  143401. declare module BABYLON {
  143402. /**
  143403. * Block used to desaturate a color
  143404. */
  143405. export class DesaturateBlock extends NodeMaterialBlock {
  143406. /**
  143407. * Creates a new DesaturateBlock
  143408. * @param name defines the block name
  143409. */
  143410. constructor(name: string);
  143411. /**
  143412. * Gets the current class name
  143413. * @returns the class name
  143414. */
  143415. getClassName(): string;
  143416. /**
  143417. * Gets the color operand input component
  143418. */
  143419. get color(): NodeMaterialConnectionPoint;
  143420. /**
  143421. * Gets the level operand input component
  143422. */
  143423. get level(): NodeMaterialConnectionPoint;
  143424. /**
  143425. * Gets the output component
  143426. */
  143427. get output(): NodeMaterialConnectionPoint;
  143428. protected _buildBlock(state: NodeMaterialBuildState): this;
  143429. }
  143430. }
  143431. declare module BABYLON {
  143432. /**
  143433. * Block used to implement the ambient occlusion module of the PBR material
  143434. */
  143435. export class AmbientOcclusionBlock extends NodeMaterialBlock {
  143436. /**
  143437. * Create a new AmbientOcclusionBlock
  143438. * @param name defines the block name
  143439. */
  143440. constructor(name: string);
  143441. /**
  143442. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  143443. */
  143444. useAmbientInGrayScale: boolean;
  143445. /**
  143446. * Initialize the block and prepare the context for build
  143447. * @param state defines the state that will be used for the build
  143448. */
  143449. initialize(state: NodeMaterialBuildState): void;
  143450. /**
  143451. * Gets the current class name
  143452. * @returns the class name
  143453. */
  143454. getClassName(): string;
  143455. /**
  143456. * Gets the texture input component
  143457. */
  143458. get texture(): NodeMaterialConnectionPoint;
  143459. /**
  143460. * Gets the texture intensity component
  143461. */
  143462. get intensity(): NodeMaterialConnectionPoint;
  143463. /**
  143464. * Gets the direct light intensity input component
  143465. */
  143466. get directLightIntensity(): NodeMaterialConnectionPoint;
  143467. /**
  143468. * Gets the ambient occlusion object output component
  143469. */
  143470. get ambientOcclusion(): NodeMaterialConnectionPoint;
  143471. /**
  143472. * Gets the main code of the block (fragment side)
  143473. * @param block instance of an AmbientOcclusionBlock or null if the code must be generated without an active ambient occlusion module
  143474. * @returns the shader code
  143475. */
  143476. static GetCode(block: Nullable<AmbientOcclusionBlock>): string;
  143477. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  143478. protected _buildBlock(state: NodeMaterialBuildState): this;
  143479. protected _dumpPropertiesCode(): string;
  143480. serialize(): any;
  143481. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  143482. }
  143483. }
  143484. declare module BABYLON {
  143485. /**
  143486. * Block used to implement the reflection module of the PBR material
  143487. */
  143488. export class ReflectionBlock extends ReflectionTextureBaseBlock {
  143489. /** @hidden */
  143490. _defineLODReflectionAlpha: string;
  143491. /** @hidden */
  143492. _defineLinearSpecularReflection: string;
  143493. private _vEnvironmentIrradianceName;
  143494. /** @hidden */
  143495. _vReflectionMicrosurfaceInfosName: string;
  143496. /** @hidden */
  143497. _vReflectionInfosName: string;
  143498. /** @hidden */
  143499. _vReflectionFilteringInfoName: string;
  143500. private _scene;
  143501. /**
  143502. * The three properties below are set by the main PBR block prior to calling methods of this class.
  143503. * This is to avoid having to add them as inputs here whereas they are already inputs of the main block, so already known.
  143504. * It's less burden on the user side in the editor part.
  143505. */
  143506. /** @hidden */
  143507. worldPositionConnectionPoint: NodeMaterialConnectionPoint;
  143508. /** @hidden */
  143509. worldNormalConnectionPoint: NodeMaterialConnectionPoint;
  143510. /** @hidden */
  143511. cameraPositionConnectionPoint: NodeMaterialConnectionPoint;
  143512. /**
  143513. * Defines if the material uses spherical harmonics vs spherical polynomials for the
  143514. * diffuse part of the IBL.
  143515. */
  143516. useSphericalHarmonics: boolean;
  143517. /**
  143518. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  143519. */
  143520. forceIrradianceInFragment: boolean;
  143521. /**
  143522. * Create a new ReflectionBlock
  143523. * @param name defines the block name
  143524. */
  143525. constructor(name: string);
  143526. /**
  143527. * Gets the current class name
  143528. * @returns the class name
  143529. */
  143530. getClassName(): string;
  143531. /**
  143532. * Gets the position input component
  143533. */
  143534. get position(): NodeMaterialConnectionPoint;
  143535. /**
  143536. * Gets the world position input component
  143537. */
  143538. get worldPosition(): NodeMaterialConnectionPoint;
  143539. /**
  143540. * Gets the world normal input component
  143541. */
  143542. get worldNormal(): NodeMaterialConnectionPoint;
  143543. /**
  143544. * Gets the world input component
  143545. */
  143546. get world(): NodeMaterialConnectionPoint;
  143547. /**
  143548. * Gets the camera (or eye) position component
  143549. */
  143550. get cameraPosition(): NodeMaterialConnectionPoint;
  143551. /**
  143552. * Gets the view input component
  143553. */
  143554. get view(): NodeMaterialConnectionPoint;
  143555. /**
  143556. * Gets the color input component
  143557. */
  143558. get color(): NodeMaterialConnectionPoint;
  143559. /**
  143560. * Gets the reflection object output component
  143561. */
  143562. get reflection(): NodeMaterialConnectionPoint;
  143563. /**
  143564. * Returns true if the block has a texture (either its own texture or the environment texture from the scene, if set)
  143565. */
  143566. get hasTexture(): boolean;
  143567. /**
  143568. * Gets the reflection color (either the name of the variable if the color input is connected, else a default value)
  143569. */
  143570. get reflectionColor(): string;
  143571. protected _getTexture(): Nullable<BaseTexture>;
  143572. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  143573. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  143574. /**
  143575. * Gets the code to inject in the vertex shader
  143576. * @param state current state of the node material building
  143577. * @returns the shader code
  143578. */
  143579. handleVertexSide(state: NodeMaterialBuildState): string;
  143580. /**
  143581. * Gets the main code of the block (fragment side)
  143582. * @param state current state of the node material building
  143583. * @param normalVarName name of the existing variable corresponding to the normal
  143584. * @returns the shader code
  143585. */
  143586. getCode(state: NodeMaterialBuildState, normalVarName: string): string;
  143587. protected _buildBlock(state: NodeMaterialBuildState): this;
  143588. protected _dumpPropertiesCode(): string;
  143589. serialize(): any;
  143590. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  143591. }
  143592. }
  143593. declare module BABYLON {
  143594. /**
  143595. * Block used to implement the sheen module of the PBR material
  143596. */
  143597. export class SheenBlock extends NodeMaterialBlock {
  143598. /**
  143599. * Create a new SheenBlock
  143600. * @param name defines the block name
  143601. */
  143602. constructor(name: string);
  143603. /**
  143604. * If true, the sheen effect is layered above the base BRDF with the albedo-scaling technique.
  143605. * It allows the strength of the sheen effect to not depend on the base color of the material,
  143606. * making it easier to setup and tweak the effect
  143607. */
  143608. albedoScaling: boolean;
  143609. /**
  143610. * Defines if the sheen is linked to the sheen color.
  143611. */
  143612. linkSheenWithAlbedo: boolean;
  143613. /**
  143614. * Initialize the block and prepare the context for build
  143615. * @param state defines the state that will be used for the build
  143616. */
  143617. initialize(state: NodeMaterialBuildState): void;
  143618. /**
  143619. * Gets the current class name
  143620. * @returns the class name
  143621. */
  143622. getClassName(): string;
  143623. /**
  143624. * Gets the intensity input component
  143625. */
  143626. get intensity(): NodeMaterialConnectionPoint;
  143627. /**
  143628. * Gets the color input component
  143629. */
  143630. get color(): NodeMaterialConnectionPoint;
  143631. /**
  143632. * Gets the roughness input component
  143633. */
  143634. get roughness(): NodeMaterialConnectionPoint;
  143635. /**
  143636. * Gets the sheen object output component
  143637. */
  143638. get sheen(): NodeMaterialConnectionPoint;
  143639. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  143640. /**
  143641. * Gets the main code of the block (fragment side)
  143642. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  143643. * @returns the shader code
  143644. */
  143645. getCode(reflectionBlock: Nullable<ReflectionBlock>): string;
  143646. protected _buildBlock(state: NodeMaterialBuildState): this;
  143647. protected _dumpPropertiesCode(): string;
  143648. serialize(): any;
  143649. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  143650. }
  143651. }
  143652. declare module BABYLON {
  143653. /**
  143654. * Block used to implement the reflectivity module of the PBR material
  143655. */
  143656. export class ReflectivityBlock extends NodeMaterialBlock {
  143657. private _metallicReflectanceColor;
  143658. private _metallicF0Factor;
  143659. /** @hidden */
  143660. _vMetallicReflectanceFactorsName: string;
  143661. /**
  143662. * The property below is set by the main PBR block prior to calling methods of this class.
  143663. */
  143664. /** @hidden */
  143665. indexOfRefractionConnectionPoint: Nullable<NodeMaterialConnectionPoint>;
  143666. /**
  143667. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  143668. */
  143669. useAmbientOcclusionFromMetallicTextureRed: boolean;
  143670. /**
  143671. * Specifies if the metallic texture contains the metallness information in its blue channel.
  143672. */
  143673. useMetallnessFromMetallicTextureBlue: boolean;
  143674. /**
  143675. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  143676. */
  143677. useRoughnessFromMetallicTextureAlpha: boolean;
  143678. /**
  143679. * Specifies if the metallic texture contains the roughness information in its green channel.
  143680. */
  143681. useRoughnessFromMetallicTextureGreen: boolean;
  143682. /**
  143683. * Create a new ReflectivityBlock
  143684. * @param name defines the block name
  143685. */
  143686. constructor(name: string);
  143687. /**
  143688. * Initialize the block and prepare the context for build
  143689. * @param state defines the state that will be used for the build
  143690. */
  143691. initialize(state: NodeMaterialBuildState): void;
  143692. /**
  143693. * Gets the current class name
  143694. * @returns the class name
  143695. */
  143696. getClassName(): string;
  143697. /**
  143698. * Gets the metallic input component
  143699. */
  143700. get metallic(): NodeMaterialConnectionPoint;
  143701. /**
  143702. * Gets the roughness input component
  143703. */
  143704. get roughness(): NodeMaterialConnectionPoint;
  143705. /**
  143706. * Gets the texture input component
  143707. */
  143708. get texture(): NodeMaterialConnectionPoint;
  143709. /**
  143710. * Gets the reflectivity object output component
  143711. */
  143712. get reflectivity(): NodeMaterialConnectionPoint;
  143713. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  143714. /**
  143715. * Gets the main code of the block (fragment side)
  143716. * @param state current state of the node material building
  143717. * @param aoIntensityVarName name of the variable with the ambient occlusion intensity
  143718. * @returns the shader code
  143719. */
  143720. getCode(state: NodeMaterialBuildState, aoIntensityVarName: string): string;
  143721. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  143722. protected _buildBlock(state: NodeMaterialBuildState): this;
  143723. protected _dumpPropertiesCode(): string;
  143724. serialize(): any;
  143725. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  143726. }
  143727. }
  143728. declare module BABYLON {
  143729. /**
  143730. * Block used to implement the anisotropy module of the PBR material
  143731. */
  143732. export class AnisotropyBlock extends NodeMaterialBlock {
  143733. /**
  143734. * The two properties below are set by the main PBR block prior to calling methods of this class.
  143735. * This is to avoid having to add them as inputs here whereas they are already inputs of the main block, so already known.
  143736. * It's less burden on the user side in the editor part.
  143737. */
  143738. /** @hidden */
  143739. worldPositionConnectionPoint: NodeMaterialConnectionPoint;
  143740. /** @hidden */
  143741. worldNormalConnectionPoint: NodeMaterialConnectionPoint;
  143742. /**
  143743. * Create a new AnisotropyBlock
  143744. * @param name defines the block name
  143745. */
  143746. constructor(name: string);
  143747. /**
  143748. * Initialize the block and prepare the context for build
  143749. * @param state defines the state that will be used for the build
  143750. */
  143751. initialize(state: NodeMaterialBuildState): void;
  143752. /**
  143753. * Gets the current class name
  143754. * @returns the class name
  143755. */
  143756. getClassName(): string;
  143757. /**
  143758. * Gets the intensity input component
  143759. */
  143760. get intensity(): NodeMaterialConnectionPoint;
  143761. /**
  143762. * Gets the direction input component
  143763. */
  143764. get direction(): NodeMaterialConnectionPoint;
  143765. /**
  143766. * Gets the texture input component
  143767. */
  143768. get texture(): NodeMaterialConnectionPoint;
  143769. /**
  143770. * Gets the uv input component
  143771. */
  143772. get uv(): NodeMaterialConnectionPoint;
  143773. /**
  143774. * Gets the worldTangent input component
  143775. */
  143776. get worldTangent(): NodeMaterialConnectionPoint;
  143777. /**
  143778. * Gets the anisotropy object output component
  143779. */
  143780. get anisotropy(): NodeMaterialConnectionPoint;
  143781. private _generateTBNSpace;
  143782. /**
  143783. * Gets the main code of the block (fragment side)
  143784. * @param state current state of the node material building
  143785. * @param generateTBNSpace if true, the code needed to create the TBN coordinate space is generated
  143786. * @returns the shader code
  143787. */
  143788. getCode(state: NodeMaterialBuildState, generateTBNSpace?: boolean): string;
  143789. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  143790. protected _buildBlock(state: NodeMaterialBuildState): this;
  143791. }
  143792. }
  143793. declare module BABYLON {
  143794. /**
  143795. * Block used to implement the clear coat module of the PBR material
  143796. */
  143797. export class ClearCoatBlock extends NodeMaterialBlock {
  143798. private _scene;
  143799. /**
  143800. * Create a new ClearCoatBlock
  143801. * @param name defines the block name
  143802. */
  143803. constructor(name: string);
  143804. /**
  143805. * Initialize the block and prepare the context for build
  143806. * @param state defines the state that will be used for the build
  143807. */
  143808. initialize(state: NodeMaterialBuildState): void;
  143809. /**
  143810. * Gets the current class name
  143811. * @returns the class name
  143812. */
  143813. getClassName(): string;
  143814. /**
  143815. * Gets the intensity input component
  143816. */
  143817. get intensity(): NodeMaterialConnectionPoint;
  143818. /**
  143819. * Gets the roughness input component
  143820. */
  143821. get roughness(): NodeMaterialConnectionPoint;
  143822. /**
  143823. * Gets the ior input component
  143824. */
  143825. get ior(): NodeMaterialConnectionPoint;
  143826. /**
  143827. * Gets the texture input component
  143828. */
  143829. get texture(): NodeMaterialConnectionPoint;
  143830. /**
  143831. * Gets the bump texture input component
  143832. */
  143833. get bumpTexture(): NodeMaterialConnectionPoint;
  143834. /**
  143835. * Gets the uv input component
  143836. */
  143837. get uv(): NodeMaterialConnectionPoint;
  143838. /**
  143839. * Gets the tint color input component
  143840. */
  143841. get tintColor(): NodeMaterialConnectionPoint;
  143842. /**
  143843. * Gets the tint "at distance" input component
  143844. */
  143845. get tintAtDistance(): NodeMaterialConnectionPoint;
  143846. /**
  143847. * Gets the tint thickness input component
  143848. */
  143849. get tintThickness(): NodeMaterialConnectionPoint;
  143850. /**
  143851. * Gets the world tangent input component
  143852. */
  143853. get worldTangent(): NodeMaterialConnectionPoint;
  143854. /**
  143855. * Gets the clear coat object output component
  143856. */
  143857. get clearcoat(): NodeMaterialConnectionPoint;
  143858. autoConfigure(material: NodeMaterial): void;
  143859. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  143860. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  143861. private _generateTBNSpace;
  143862. /**
  143863. * Gets the main code of the block (fragment side)
  143864. * @param state current state of the node material building
  143865. * @param ccBlock instance of a ClearCoatBlock or null if the code must be generated without an active clear coat module
  143866. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  143867. * @param worldPosVarName name of the variable holding the world position
  143868. * @param generateTBNSpace if true, the code needed to create the TBN coordinate space is generated
  143869. * @param vTBNAvailable indicate that the vTBN variable is already existing because it has already been generated by another block (PerturbNormal or Anisotropy)
  143870. * @param worldNormalVarName name of the variable holding the world normal
  143871. * @returns the shader code
  143872. */
  143873. static GetCode(state: NodeMaterialBuildState, ccBlock: Nullable<ClearCoatBlock>, reflectionBlock: Nullable<ReflectionBlock>, worldPosVarName: string, generateTBNSpace: boolean, vTBNAvailable: boolean, worldNormalVarName: string): string;
  143874. protected _buildBlock(state: NodeMaterialBuildState): this;
  143875. }
  143876. }
  143877. declare module BABYLON {
  143878. /**
  143879. * Block used to implement the sub surface module of the PBR material
  143880. */
  143881. export class SubSurfaceBlock extends NodeMaterialBlock {
  143882. /**
  143883. * Create a new SubSurfaceBlock
  143884. * @param name defines the block name
  143885. */
  143886. constructor(name: string);
  143887. /**
  143888. * Stores the intensity of the different subsurface effects in the thickness texture.
  143889. * * the green channel is the translucency intensity.
  143890. * * the blue channel is the scattering intensity.
  143891. * * the alpha channel is the refraction intensity.
  143892. */
  143893. useMaskFromThicknessTexture: boolean;
  143894. /**
  143895. * Initialize the block and prepare the context for build
  143896. * @param state defines the state that will be used for the build
  143897. */
  143898. initialize(state: NodeMaterialBuildState): void;
  143899. /**
  143900. * Gets the current class name
  143901. * @returns the class name
  143902. */
  143903. getClassName(): string;
  143904. /**
  143905. * Gets the min thickness input component
  143906. */
  143907. get minThickness(): NodeMaterialConnectionPoint;
  143908. /**
  143909. * Gets the max thickness input component
  143910. */
  143911. get maxThickness(): NodeMaterialConnectionPoint;
  143912. /**
  143913. * Gets the thickness texture component
  143914. */
  143915. get thicknessTexture(): NodeMaterialConnectionPoint;
  143916. /**
  143917. * Gets the tint color input component
  143918. */
  143919. get tintColor(): NodeMaterialConnectionPoint;
  143920. /**
  143921. * Gets the translucency intensity input component
  143922. */
  143923. get translucencyIntensity(): NodeMaterialConnectionPoint;
  143924. /**
  143925. * Gets the translucency diffusion distance input component
  143926. */
  143927. get translucencyDiffusionDistance(): NodeMaterialConnectionPoint;
  143928. /**
  143929. * Gets the refraction object parameters
  143930. */
  143931. get refraction(): NodeMaterialConnectionPoint;
  143932. /**
  143933. * Gets the sub surface object output component
  143934. */
  143935. get subsurface(): NodeMaterialConnectionPoint;
  143936. autoConfigure(material: NodeMaterial): void;
  143937. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  143938. /**
  143939. * Gets the main code of the block (fragment side)
  143940. * @param state current state of the node material building
  143941. * @param ssBlock instance of a SubSurfaceBlock or null if the code must be generated without an active sub surface module
  143942. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  143943. * @param worldPosVarName name of the variable holding the world position
  143944. * @returns the shader code
  143945. */
  143946. static GetCode(state: NodeMaterialBuildState, ssBlock: Nullable<SubSurfaceBlock>, reflectionBlock: Nullable<ReflectionBlock>, worldPosVarName: string): string;
  143947. protected _buildBlock(state: NodeMaterialBuildState): this;
  143948. }
  143949. }
  143950. declare module BABYLON {
  143951. /**
  143952. * Block used to implement the PBR metallic/roughness model
  143953. */
  143954. export class PBRMetallicRoughnessBlock extends NodeMaterialBlock {
  143955. /**
  143956. * Gets or sets the light associated with this block
  143957. */
  143958. light: Nullable<Light>;
  143959. private _lightId;
  143960. private _scene;
  143961. private _environmentBRDFTexture;
  143962. private _environmentBrdfSamplerName;
  143963. private _vNormalWName;
  143964. private _invertNormalName;
  143965. /**
  143966. * Create a new ReflectionBlock
  143967. * @param name defines the block name
  143968. */
  143969. constructor(name: string);
  143970. /**
  143971. * Intensity of the direct lights e.g. the four lights available in your scene.
  143972. * This impacts both the direct diffuse and specular highlights.
  143973. */
  143974. directIntensity: number;
  143975. /**
  143976. * Intensity of the environment e.g. how much the environment will light the object
  143977. * either through harmonics for rough material or through the refelction for shiny ones.
  143978. */
  143979. environmentIntensity: number;
  143980. /**
  143981. * This is a special control allowing the reduction of the specular highlights coming from the
  143982. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  143983. */
  143984. specularIntensity: number;
  143985. /**
  143986. * Defines the falloff type used in this material.
  143987. * It by default is Physical.
  143988. */
  143989. lightFalloff: number;
  143990. /**
  143991. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  143992. */
  143993. useAlphaFromAlbedoTexture: boolean;
  143994. /**
  143995. * Specifies that alpha test should be used
  143996. */
  143997. useAlphaTest: boolean;
  143998. /**
  143999. * Defines the alpha limits in alpha test mode.
  144000. */
  144001. alphaTestCutoff: number;
  144002. /**
  144003. * Specifies that alpha blending should be used
  144004. */
  144005. useAlphaBlending: boolean;
  144006. /**
  144007. * Defines if the alpha value should be determined via the rgb values.
  144008. * If true the luminance of the pixel might be used to find the corresponding alpha value.
  144009. */
  144010. opacityRGB: boolean;
  144011. /**
  144012. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most luminous ones).
  144013. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  144014. */
  144015. useRadianceOverAlpha: boolean;
  144016. /**
  144017. * Specifies that the material will keeps the specular highlights over a transparent surface (only the most luminous ones).
  144018. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  144019. */
  144020. useSpecularOverAlpha: boolean;
  144021. /**
  144022. * Enables specular anti aliasing in the PBR shader.
  144023. * It will both interacts on the Geometry for analytical and IBL lighting.
  144024. * It also prefilter the roughness map based on the bump values.
  144025. */
  144026. enableSpecularAntiAliasing: boolean;
  144027. /**
  144028. * Enables realtime filtering on the texture.
  144029. */
  144030. realTimeFiltering: boolean;
  144031. /**
  144032. * Quality switch for realtime filtering
  144033. */
  144034. realTimeFilteringQuality: number;
  144035. /**
  144036. * Defines if the material uses energy conservation.
  144037. */
  144038. useEnergyConservation: boolean;
  144039. /**
  144040. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  144041. * too much the area relying on ambient texture to define their ambient occlusion.
  144042. */
  144043. useRadianceOcclusion: boolean;
  144044. /**
  144045. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  144046. * makes the reflect vector face the model (under horizon).
  144047. */
  144048. useHorizonOcclusion: boolean;
  144049. /**
  144050. * If set to true, no lighting calculations will be applied.
  144051. */
  144052. unlit: boolean;
  144053. /**
  144054. * Force normal to face away from face.
  144055. */
  144056. forceNormalForward: boolean;
  144057. /**
  144058. * Defines the material debug mode.
  144059. * It helps seeing only some components of the material while troubleshooting.
  144060. */
  144061. debugMode: number;
  144062. /**
  144063. * Specify from where on screen the debug mode should start.
  144064. * The value goes from -1 (full screen) to 1 (not visible)
  144065. * It helps with side by side comparison against the final render
  144066. * This defaults to 0
  144067. */
  144068. debugLimit: number;
  144069. /**
  144070. * As the default viewing range might not be enough (if the ambient is really small for instance)
  144071. * You can use the factor to better multiply the final value.
  144072. */
  144073. debugFactor: number;
  144074. /**
  144075. * Initialize the block and prepare the context for build
  144076. * @param state defines the state that will be used for the build
  144077. */
  144078. initialize(state: NodeMaterialBuildState): void;
  144079. /**
  144080. * Gets the current class name
  144081. * @returns the class name
  144082. */
  144083. getClassName(): string;
  144084. /**
  144085. * Gets the world position input component
  144086. */
  144087. get worldPosition(): NodeMaterialConnectionPoint;
  144088. /**
  144089. * Gets the world normal input component
  144090. */
  144091. get worldNormal(): NodeMaterialConnectionPoint;
  144092. /**
  144093. * Gets the perturbed normal input component
  144094. */
  144095. get perturbedNormal(): NodeMaterialConnectionPoint;
  144096. /**
  144097. * Gets the camera position input component
  144098. */
  144099. get cameraPosition(): NodeMaterialConnectionPoint;
  144100. /**
  144101. * Gets the base color input component
  144102. */
  144103. get baseColor(): NodeMaterialConnectionPoint;
  144104. /**
  144105. * Gets the opacity texture input component
  144106. */
  144107. get opacityTexture(): NodeMaterialConnectionPoint;
  144108. /**
  144109. * Gets the ambient color input component
  144110. */
  144111. get ambientColor(): NodeMaterialConnectionPoint;
  144112. /**
  144113. * Gets the reflectivity object parameters
  144114. */
  144115. get reflectivity(): NodeMaterialConnectionPoint;
  144116. /**
  144117. * Gets the ambient occlusion object parameters
  144118. */
  144119. get ambientOcclusion(): NodeMaterialConnectionPoint;
  144120. /**
  144121. * Gets the reflection object parameters
  144122. */
  144123. get reflection(): NodeMaterialConnectionPoint;
  144124. /**
  144125. * Gets the sheen object parameters
  144126. */
  144127. get sheen(): NodeMaterialConnectionPoint;
  144128. /**
  144129. * Gets the clear coat object parameters
  144130. */
  144131. get clearcoat(): NodeMaterialConnectionPoint;
  144132. /**
  144133. * Gets the sub surface object parameters
  144134. */
  144135. get subsurface(): NodeMaterialConnectionPoint;
  144136. /**
  144137. * Gets the anisotropy object parameters
  144138. */
  144139. get anisotropy(): NodeMaterialConnectionPoint;
  144140. /**
  144141. * Gets the ambient output component
  144142. */
  144143. get ambient(): NodeMaterialConnectionPoint;
  144144. /**
  144145. * Gets the diffuse output component
  144146. */
  144147. get diffuse(): NodeMaterialConnectionPoint;
  144148. /**
  144149. * Gets the specular output component
  144150. */
  144151. get specular(): NodeMaterialConnectionPoint;
  144152. /**
  144153. * Gets the sheen output component
  144154. */
  144155. get sheenDir(): NodeMaterialConnectionPoint;
  144156. /**
  144157. * Gets the clear coat output component
  144158. */
  144159. get clearcoatDir(): NodeMaterialConnectionPoint;
  144160. /**
  144161. * Gets the indirect diffuse output component
  144162. */
  144163. get diffuseIndirect(): NodeMaterialConnectionPoint;
  144164. /**
  144165. * Gets the indirect specular output component
  144166. */
  144167. get specularIndirect(): NodeMaterialConnectionPoint;
  144168. /**
  144169. * Gets the indirect sheen output component
  144170. */
  144171. get sheenIndirect(): NodeMaterialConnectionPoint;
  144172. /**
  144173. * Gets the indirect clear coat output component
  144174. */
  144175. get clearcoatIndirect(): NodeMaterialConnectionPoint;
  144176. /**
  144177. * Gets the refraction output component
  144178. */
  144179. get refraction(): NodeMaterialConnectionPoint;
  144180. /**
  144181. * Gets the global lighting output component
  144182. */
  144183. get lighting(): NodeMaterialConnectionPoint;
  144184. /**
  144185. * Gets the shadow output component
  144186. */
  144187. get shadow(): NodeMaterialConnectionPoint;
  144188. /**
  144189. * Gets the alpha output component
  144190. */
  144191. get alpha(): NodeMaterialConnectionPoint;
  144192. autoConfigure(material: NodeMaterial): void;
  144193. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  144194. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  144195. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  144196. private _injectVertexCode;
  144197. /**
  144198. * Gets the code corresponding to the albedo/opacity module
  144199. * @returns the shader code
  144200. */
  144201. getAlbedoOpacityCode(): string;
  144202. protected _buildBlock(state: NodeMaterialBuildState): this;
  144203. protected _dumpPropertiesCode(): string;
  144204. serialize(): any;
  144205. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  144206. }
  144207. }
  144208. declare module BABYLON {
  144209. /**
  144210. * Block used to compute value of one parameter modulo another
  144211. */
  144212. export class ModBlock extends NodeMaterialBlock {
  144213. /**
  144214. * Creates a new ModBlock
  144215. * @param name defines the block name
  144216. */
  144217. constructor(name: string);
  144218. /**
  144219. * Gets the current class name
  144220. * @returns the class name
  144221. */
  144222. getClassName(): string;
  144223. /**
  144224. * Gets the left operand input component
  144225. */
  144226. get left(): NodeMaterialConnectionPoint;
  144227. /**
  144228. * Gets the right operand input component
  144229. */
  144230. get right(): NodeMaterialConnectionPoint;
  144231. /**
  144232. * Gets the output component
  144233. */
  144234. get output(): NodeMaterialConnectionPoint;
  144235. protected _buildBlock(state: NodeMaterialBuildState): this;
  144236. }
  144237. }
  144238. declare module BABYLON {
  144239. /**
  144240. * Helper class to push actions to a pool of workers.
  144241. */
  144242. export class WorkerPool implements IDisposable {
  144243. private _workerInfos;
  144244. private _pendingActions;
  144245. /**
  144246. * Constructor
  144247. * @param workers Array of workers to use for actions
  144248. */
  144249. constructor(workers: Array<Worker>);
  144250. /**
  144251. * Terminates all workers and clears any pending actions.
  144252. */
  144253. dispose(): void;
  144254. /**
  144255. * Pushes an action to the worker pool. If all the workers are active, the action will be
  144256. * pended until a worker has completed its action.
  144257. * @param action The action to perform. Call onComplete when the action is complete.
  144258. */
  144259. push(action: (worker: Worker, onComplete: () => void) => void): void;
  144260. private _execute;
  144261. }
  144262. }
  144263. declare module BABYLON {
  144264. /**
  144265. * Configuration for Draco compression
  144266. */
  144267. export interface IDracoCompressionConfiguration {
  144268. /**
  144269. * Configuration for the decoder.
  144270. */
  144271. decoder: {
  144272. /**
  144273. * The url to the WebAssembly module.
  144274. */
  144275. wasmUrl?: string;
  144276. /**
  144277. * The url to the WebAssembly binary.
  144278. */
  144279. wasmBinaryUrl?: string;
  144280. /**
  144281. * The url to the fallback JavaScript module.
  144282. */
  144283. fallbackUrl?: string;
  144284. };
  144285. }
  144286. /**
  144287. * Draco compression (https://google.github.io/draco/)
  144288. *
  144289. * This class wraps the Draco module.
  144290. *
  144291. * **Encoder**
  144292. *
  144293. * The encoder is not currently implemented.
  144294. *
  144295. * **Decoder**
  144296. *
  144297. * 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.
  144298. *
  144299. * To update the configuration, use the following code:
  144300. * ```javascript
  144301. * DracoCompression.Configuration = {
  144302. * decoder: {
  144303. * wasmUrl: "<url to the WebAssembly library>",
  144304. * wasmBinaryUrl: "<url to the WebAssembly binary>",
  144305. * fallbackUrl: "<url to the fallback JavaScript library>",
  144306. * }
  144307. * };
  144308. * ```
  144309. *
  144310. * 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.
  144311. * Decoding will automatically fallback to the JavaScript version if WebAssembly version is not configured or if WebAssembly is not supported by the browser.
  144312. * Use `DracoCompression.DecoderAvailable` to determine if the decoder configuration is available for the current context.
  144313. *
  144314. * To decode Draco compressed data, get the default DracoCompression object and call decodeMeshAsync:
  144315. * ```javascript
  144316. * var vertexData = await DracoCompression.Default.decodeMeshAsync(data);
  144317. * ```
  144318. *
  144319. * @see https://www.babylonjs-playground.com/#N3EK4B#0
  144320. */
  144321. export class DracoCompression implements IDisposable {
  144322. private _workerPoolPromise?;
  144323. private _decoderModulePromise?;
  144324. /**
  144325. * The configuration. Defaults to the following urls:
  144326. * - wasmUrl: "https://preview.babylonjs.com/draco_wasm_wrapper_gltf.js"
  144327. * - wasmBinaryUrl: "https://preview.babylonjs.com/draco_decoder_gltf.wasm"
  144328. * - fallbackUrl: "https://preview.babylonjs.com/draco_decoder_gltf.js"
  144329. */
  144330. static Configuration: IDracoCompressionConfiguration;
  144331. /**
  144332. * Returns true if the decoder configuration is available.
  144333. */
  144334. static get DecoderAvailable(): boolean;
  144335. /**
  144336. * Default number of workers to create when creating the draco compression object.
  144337. */
  144338. static DefaultNumWorkers: number;
  144339. private static GetDefaultNumWorkers;
  144340. private static _Default;
  144341. /**
  144342. * Default instance for the draco compression object.
  144343. */
  144344. static get Default(): DracoCompression;
  144345. /**
  144346. * Constructor
  144347. * @param numWorkers The number of workers for async operations. Specify `0` to disable web workers and run synchronously in the current context.
  144348. */
  144349. constructor(numWorkers?: number);
  144350. /**
  144351. * Stop all async operations and release resources.
  144352. */
  144353. dispose(): void;
  144354. /**
  144355. * Returns a promise that resolves when ready. Call this manually to ensure draco compression is ready before use.
  144356. * @returns a promise that resolves when ready
  144357. */
  144358. whenReadyAsync(): Promise<void>;
  144359. /**
  144360. * Decode Draco compressed mesh data to vertex data.
  144361. * @param data The ArrayBuffer or ArrayBufferView for the Draco compression data
  144362. * @param attributes A map of attributes from vertex buffer kinds to Draco unique ids
  144363. * @returns A promise that resolves with the decoded vertex data
  144364. */
  144365. decodeMeshAsync(data: ArrayBuffer | ArrayBufferView, attributes?: {
  144366. [kind: string]: number;
  144367. }): Promise<VertexData>;
  144368. }
  144369. }
  144370. declare module BABYLON {
  144371. /**
  144372. * Class for building Constructive Solid Geometry
  144373. */
  144374. export class CSG {
  144375. private polygons;
  144376. /**
  144377. * The world matrix
  144378. */
  144379. matrix: Matrix;
  144380. /**
  144381. * Stores the position
  144382. */
  144383. position: Vector3;
  144384. /**
  144385. * Stores the rotation
  144386. */
  144387. rotation: Vector3;
  144388. /**
  144389. * Stores the rotation quaternion
  144390. */
  144391. rotationQuaternion: Nullable<Quaternion>;
  144392. /**
  144393. * Stores the scaling vector
  144394. */
  144395. scaling: Vector3;
  144396. /**
  144397. * Convert the Mesh to CSG
  144398. * @param mesh The Mesh to convert to CSG
  144399. * @returns A new CSG from the Mesh
  144400. */
  144401. static FromMesh(mesh: Mesh): CSG;
  144402. /**
  144403. * Construct a CSG solid from a list of `CSG.Polygon` instances.
  144404. * @param polygons Polygons used to construct a CSG solid
  144405. */
  144406. private static FromPolygons;
  144407. /**
  144408. * Clones, or makes a deep copy, of the CSG
  144409. * @returns A new CSG
  144410. */
  144411. clone(): CSG;
  144412. /**
  144413. * Unions this CSG with another CSG
  144414. * @param csg The CSG to union against this CSG
  144415. * @returns The unioned CSG
  144416. */
  144417. union(csg: CSG): CSG;
  144418. /**
  144419. * Unions this CSG with another CSG in place
  144420. * @param csg The CSG to union against this CSG
  144421. */
  144422. unionInPlace(csg: CSG): void;
  144423. /**
  144424. * Subtracts this CSG with another CSG
  144425. * @param csg The CSG to subtract against this CSG
  144426. * @returns A new CSG
  144427. */
  144428. subtract(csg: CSG): CSG;
  144429. /**
  144430. * Subtracts this CSG with another CSG in place
  144431. * @param csg The CSG to subtact against this CSG
  144432. */
  144433. subtractInPlace(csg: CSG): void;
  144434. /**
  144435. * Intersect this CSG with another CSG
  144436. * @param csg The CSG to intersect against this CSG
  144437. * @returns A new CSG
  144438. */
  144439. intersect(csg: CSG): CSG;
  144440. /**
  144441. * Intersects this CSG with another CSG in place
  144442. * @param csg The CSG to intersect against this CSG
  144443. */
  144444. intersectInPlace(csg: CSG): void;
  144445. /**
  144446. * Return a new CSG solid with solid and empty space switched. This solid is
  144447. * not modified.
  144448. * @returns A new CSG solid with solid and empty space switched
  144449. */
  144450. inverse(): CSG;
  144451. /**
  144452. * Inverses the CSG in place
  144453. */
  144454. inverseInPlace(): void;
  144455. /**
  144456. * This is used to keep meshes transformations so they can be restored
  144457. * when we build back a Babylon Mesh
  144458. * NB : All CSG operations are performed in world coordinates
  144459. * @param csg The CSG to copy the transform attributes from
  144460. * @returns This CSG
  144461. */
  144462. copyTransformAttributes(csg: CSG): CSG;
  144463. /**
  144464. * Build Raw mesh from CSG
  144465. * Coordinates here are in world space
  144466. * @param name The name of the mesh geometry
  144467. * @param scene The Scene
  144468. * @param keepSubMeshes Specifies if the submeshes should be kept
  144469. * @returns A new Mesh
  144470. */
  144471. buildMeshGeometry(name: string, scene?: Scene, keepSubMeshes?: boolean): Mesh;
  144472. /**
  144473. * Build Mesh from CSG taking material and transforms into account
  144474. * @param name The name of the Mesh
  144475. * @param material The material of the Mesh
  144476. * @param scene The Scene
  144477. * @param keepSubMeshes Specifies if submeshes should be kept
  144478. * @returns The new Mesh
  144479. */
  144480. toMesh(name: string, material?: Nullable<Material>, scene?: Scene, keepSubMeshes?: boolean): Mesh;
  144481. }
  144482. }
  144483. declare module BABYLON {
  144484. /**
  144485. * Class used to create a trail following a mesh
  144486. */
  144487. export class TrailMesh extends Mesh {
  144488. private _generator;
  144489. private _autoStart;
  144490. private _running;
  144491. private _diameter;
  144492. private _length;
  144493. private _sectionPolygonPointsCount;
  144494. private _sectionVectors;
  144495. private _sectionNormalVectors;
  144496. private _beforeRenderObserver;
  144497. /**
  144498. * @constructor
  144499. * @param name The value used by scene.getMeshByName() to do a lookup.
  144500. * @param generator The mesh or transform node to generate a trail.
  144501. * @param scene The scene to add this mesh to.
  144502. * @param diameter Diameter of trailing mesh. Default is 1.
  144503. * @param length Length of trailing mesh. Default is 60.
  144504. * @param autoStart Automatically start trailing mesh. Default true.
  144505. */
  144506. constructor(name: string, generator: TransformNode, scene: Scene, diameter?: number, length?: number, autoStart?: boolean);
  144507. /**
  144508. * "TrailMesh"
  144509. * @returns "TrailMesh"
  144510. */
  144511. getClassName(): string;
  144512. private _createMesh;
  144513. /**
  144514. * Start trailing mesh.
  144515. */
  144516. start(): void;
  144517. /**
  144518. * Stop trailing mesh.
  144519. */
  144520. stop(): void;
  144521. /**
  144522. * Update trailing mesh geometry.
  144523. */
  144524. update(): void;
  144525. /**
  144526. * Returns a new TrailMesh object.
  144527. * @param name is a string, the name given to the new mesh
  144528. * @param newGenerator use new generator object for cloned trail mesh
  144529. * @returns a new mesh
  144530. */
  144531. clone(name: string | undefined, newGenerator: TransformNode): TrailMesh;
  144532. /**
  144533. * Serializes this trail mesh
  144534. * @param serializationObject object to write serialization to
  144535. */
  144536. serialize(serializationObject: any): void;
  144537. /**
  144538. * Parses a serialized trail mesh
  144539. * @param parsedMesh the serialized mesh
  144540. * @param scene the scene to create the trail mesh in
  144541. * @returns the created trail mesh
  144542. */
  144543. static Parse(parsedMesh: any, scene: Scene): TrailMesh;
  144544. }
  144545. }
  144546. declare module BABYLON {
  144547. /**
  144548. * Class containing static functions to help procedurally build meshes
  144549. */
  144550. export class TiledBoxBuilder {
  144551. /**
  144552. * Creates a box mesh
  144553. * 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)
  144554. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  144555. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  144556. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  144557. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  144558. * @param name defines the name of the mesh
  144559. * @param options defines the options used to create the mesh
  144560. * @param scene defines the hosting scene
  144561. * @returns the box mesh
  144562. */
  144563. static CreateTiledBox(name: string, options: {
  144564. pattern?: number;
  144565. width?: number;
  144566. height?: number;
  144567. depth?: number;
  144568. tileSize?: number;
  144569. tileWidth?: number;
  144570. tileHeight?: number;
  144571. alignHorizontal?: number;
  144572. alignVertical?: number;
  144573. faceUV?: Vector4[];
  144574. faceColors?: Color4[];
  144575. sideOrientation?: number;
  144576. updatable?: boolean;
  144577. }, scene?: Nullable<Scene>): Mesh;
  144578. }
  144579. }
  144580. declare module BABYLON {
  144581. /**
  144582. * Class containing static functions to help procedurally build meshes
  144583. */
  144584. export class TorusKnotBuilder {
  144585. /**
  144586. * Creates a torus knot mesh
  144587. * * The parameter `radius` sets the global radius size (float) of the torus knot (default 2)
  144588. * * The parameter `radialSegments` sets the number of sides on each tube segments (positive integer, default 32)
  144589. * * The parameter `tubularSegments` sets the number of tubes to decompose the knot into (positive integer, default 32)
  144590. * * The parameters `p` and `q` are the number of windings on each axis (positive integers, default 2 and 3)
  144591. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  144592. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  144593. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  144594. * @param name defines the name of the mesh
  144595. * @param options defines the options used to create the mesh
  144596. * @param scene defines the hosting scene
  144597. * @returns the torus knot mesh
  144598. * @see https://doc.babylonjs.com/how_to/set_shapes#torus-knot
  144599. */
  144600. static CreateTorusKnot(name: string, options: {
  144601. radius?: number;
  144602. tube?: number;
  144603. radialSegments?: number;
  144604. tubularSegments?: number;
  144605. p?: number;
  144606. q?: number;
  144607. updatable?: boolean;
  144608. sideOrientation?: number;
  144609. frontUVs?: Vector4;
  144610. backUVs?: Vector4;
  144611. }, scene: any): Mesh;
  144612. }
  144613. }
  144614. declare module BABYLON {
  144615. /**
  144616. * Polygon
  144617. * @see https://doc.babylonjs.com/how_to/parametric_shapes#non-regular-polygon
  144618. */
  144619. export class Polygon {
  144620. /**
  144621. * Creates a rectangle
  144622. * @param xmin bottom X coord
  144623. * @param ymin bottom Y coord
  144624. * @param xmax top X coord
  144625. * @param ymax top Y coord
  144626. * @returns points that make the resulting rectation
  144627. */
  144628. static Rectangle(xmin: number, ymin: number, xmax: number, ymax: number): Vector2[];
  144629. /**
  144630. * Creates a circle
  144631. * @param radius radius of circle
  144632. * @param cx scale in x
  144633. * @param cy scale in y
  144634. * @param numberOfSides number of sides that make up the circle
  144635. * @returns points that make the resulting circle
  144636. */
  144637. static Circle(radius: number, cx?: number, cy?: number, numberOfSides?: number): Vector2[];
  144638. /**
  144639. * Creates a polygon from input string
  144640. * @param input Input polygon data
  144641. * @returns the parsed points
  144642. */
  144643. static Parse(input: string): Vector2[];
  144644. /**
  144645. * Starts building a polygon from x and y coordinates
  144646. * @param x x coordinate
  144647. * @param y y coordinate
  144648. * @returns the started path2
  144649. */
  144650. static StartingAt(x: number, y: number): Path2;
  144651. }
  144652. /**
  144653. * Builds a polygon
  144654. * @see https://doc.babylonjs.com/how_to/polygonmeshbuilder
  144655. */
  144656. export class PolygonMeshBuilder {
  144657. private _points;
  144658. private _outlinepoints;
  144659. private _holes;
  144660. private _name;
  144661. private _scene;
  144662. private _epoints;
  144663. private _eholes;
  144664. private _addToepoint;
  144665. /**
  144666. * Babylon reference to the earcut plugin.
  144667. */
  144668. bjsEarcut: any;
  144669. /**
  144670. * Creates a PolygonMeshBuilder
  144671. * @param name name of the builder
  144672. * @param contours Path of the polygon
  144673. * @param scene scene to add to when creating the mesh
  144674. * @param earcutInjection can be used to inject your own earcut reference
  144675. */
  144676. constructor(name: string, contours: Path2 | Vector2[] | any, scene?: Scene, earcutInjection?: any);
  144677. /**
  144678. * Adds a whole within the polygon
  144679. * @param hole Array of points defining the hole
  144680. * @returns this
  144681. */
  144682. addHole(hole: Vector2[]): PolygonMeshBuilder;
  144683. /**
  144684. * Creates the polygon
  144685. * @param updatable If the mesh should be updatable
  144686. * @param depth The depth of the mesh created
  144687. * @returns the created mesh
  144688. */
  144689. build(updatable?: boolean, depth?: number): Mesh;
  144690. /**
  144691. * Creates the polygon
  144692. * @param depth The depth of the mesh created
  144693. * @returns the created VertexData
  144694. */
  144695. buildVertexData(depth?: number): VertexData;
  144696. /**
  144697. * Adds a side to the polygon
  144698. * @param positions points that make the polygon
  144699. * @param normals normals of the polygon
  144700. * @param uvs uvs of the polygon
  144701. * @param indices indices of the polygon
  144702. * @param bounds bounds of the polygon
  144703. * @param points points of the polygon
  144704. * @param depth depth of the polygon
  144705. * @param flip flip of the polygon
  144706. */
  144707. private addSide;
  144708. }
  144709. }
  144710. declare module BABYLON {
  144711. /**
  144712. * Class containing static functions to help procedurally build meshes
  144713. */
  144714. export class PolygonBuilder {
  144715. /**
  144716. * Creates a polygon mesh
  144717. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh
  144718. * * 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
  144719. * * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  144720. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  144721. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4)
  144722. * * Remember you can only change the shape positions, not their number when updating a polygon
  144723. * @param name defines the name of the mesh
  144724. * @param options defines the options used to create the mesh
  144725. * @param scene defines the hosting scene
  144726. * @param earcutInjection can be used to inject your own earcut reference
  144727. * @returns the polygon mesh
  144728. */
  144729. static CreatePolygon(name: string, options: {
  144730. shape: Vector3[];
  144731. holes?: Vector3[][];
  144732. depth?: number;
  144733. faceUV?: Vector4[];
  144734. faceColors?: Color4[];
  144735. updatable?: boolean;
  144736. sideOrientation?: number;
  144737. frontUVs?: Vector4;
  144738. backUVs?: Vector4;
  144739. wrap?: boolean;
  144740. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  144741. /**
  144742. * Creates an extruded polygon mesh, with depth in the Y direction.
  144743. * * 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)
  144744. * @see https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  144745. * @param name defines the name of the mesh
  144746. * @param options defines the options used to create the mesh
  144747. * @param scene defines the hosting scene
  144748. * @param earcutInjection can be used to inject your own earcut reference
  144749. * @returns the polygon mesh
  144750. */
  144751. static ExtrudePolygon(name: string, options: {
  144752. shape: Vector3[];
  144753. holes?: Vector3[][];
  144754. depth?: number;
  144755. faceUV?: Vector4[];
  144756. faceColors?: Color4[];
  144757. updatable?: boolean;
  144758. sideOrientation?: number;
  144759. frontUVs?: Vector4;
  144760. backUVs?: Vector4;
  144761. wrap?: boolean;
  144762. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  144763. }
  144764. }
  144765. declare module BABYLON {
  144766. /**
  144767. * Class containing static functions to help procedurally build meshes
  144768. */
  144769. export class LatheBuilder {
  144770. /**
  144771. * Creates lathe mesh.
  144772. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe
  144773. * * 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
  144774. * * The parameter `radius` (positive float, default 1) is the radius value of the lathe
  144775. * * The parameter `tessellation` (positive integer, default 64) is the side number of the lathe
  144776. * * The parameter `clip` (positive integer, default 0) is the number of sides to not create without effecting the general shape of the sides
  144777. * * 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
  144778. * * The parameter `closed` (boolean, default true) opens/closes the lathe circumference. This should be set to false when used with the parameter "arc"
  144779. * * 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
  144780. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  144781. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  144782. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  144783. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  144784. * @param name defines the name of the mesh
  144785. * @param options defines the options used to create the mesh
  144786. * @param scene defines the hosting scene
  144787. * @returns the lathe mesh
  144788. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lathe
  144789. */
  144790. static CreateLathe(name: string, options: {
  144791. shape: Vector3[];
  144792. radius?: number;
  144793. tessellation?: number;
  144794. clip?: number;
  144795. arc?: number;
  144796. closed?: boolean;
  144797. updatable?: boolean;
  144798. sideOrientation?: number;
  144799. frontUVs?: Vector4;
  144800. backUVs?: Vector4;
  144801. cap?: number;
  144802. invertUV?: boolean;
  144803. }, scene?: Nullable<Scene>): Mesh;
  144804. }
  144805. }
  144806. declare module BABYLON {
  144807. /**
  144808. * Class containing static functions to help procedurally build meshes
  144809. */
  144810. export class TiledPlaneBuilder {
  144811. /**
  144812. * Creates a tiled plane mesh
  144813. * * The parameter `pattern` will, depending on value, do nothing or
  144814. * * * flip (reflect about central vertical) alternate tiles across and up
  144815. * * * flip every tile on alternate rows
  144816. * * * rotate (180 degs) alternate tiles across and up
  144817. * * * rotate every tile on alternate rows
  144818. * * * flip and rotate alternate tiles across and up
  144819. * * * flip and rotate every tile on alternate rows
  144820. * * The parameter `tileSize` sets the size (float) of each tile side (default 1)
  144821. * * You can set some different tile dimensions by using the parameters `tileWidth` and `tileHeight` (both by default have the same value of `tileSize`)
  144822. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  144823. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  144824. * * 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)
  144825. * * 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)
  144826. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  144827. * @param name defines the name of the mesh
  144828. * @param options defines the options used to create the mesh
  144829. * @param scene defines the hosting scene
  144830. * @returns the box mesh
  144831. */
  144832. static CreateTiledPlane(name: string, options: {
  144833. pattern?: number;
  144834. tileSize?: number;
  144835. tileWidth?: number;
  144836. tileHeight?: number;
  144837. size?: number;
  144838. width?: number;
  144839. height?: number;
  144840. alignHorizontal?: number;
  144841. alignVertical?: number;
  144842. sideOrientation?: number;
  144843. frontUVs?: Vector4;
  144844. backUVs?: Vector4;
  144845. updatable?: boolean;
  144846. }, scene?: Nullable<Scene>): Mesh;
  144847. }
  144848. }
  144849. declare module BABYLON {
  144850. /**
  144851. * Class containing static functions to help procedurally build meshes
  144852. */
  144853. export class TubeBuilder {
  144854. /**
  144855. * Creates a tube mesh.
  144856. * The tube is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  144857. * * The parameter `path` is a required array of successive Vector3. It is the curve used as the axis of the tube
  144858. * * The parameter `radius` (positive float, default 1) sets the tube radius size
  144859. * * The parameter `tessellation` (positive float, default 64) is the number of sides on the tubular surface
  144860. * * The parameter `radiusFunction` (javascript function, default null) is a vanilla javascript function. If it is not null, it overwrittes the parameter `radius`
  144861. * * 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)
  144862. * * The parameter `arc` (positive float, maximum 1, default 1) is the ratio to apply to the tube circumference : 2 x PI x arc
  144863. * * 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
  144864. * * 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
  144865. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  144866. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  144867. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  144868. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  144869. * @param name defines the name of the mesh
  144870. * @param options defines the options used to create the mesh
  144871. * @param scene defines the hosting scene
  144872. * @returns the tube mesh
  144873. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  144874. * @see https://doc.babylonjs.com/how_to/set_shapes#tube
  144875. */
  144876. static CreateTube(name: string, options: {
  144877. path: Vector3[];
  144878. radius?: number;
  144879. tessellation?: number;
  144880. radiusFunction?: {
  144881. (i: number, distance: number): number;
  144882. };
  144883. cap?: number;
  144884. arc?: number;
  144885. updatable?: boolean;
  144886. sideOrientation?: number;
  144887. frontUVs?: Vector4;
  144888. backUVs?: Vector4;
  144889. instance?: Mesh;
  144890. invertUV?: boolean;
  144891. }, scene?: Nullable<Scene>): Mesh;
  144892. }
  144893. }
  144894. declare module BABYLON {
  144895. /**
  144896. * Class containing static functions to help procedurally build meshes
  144897. */
  144898. export class IcoSphereBuilder {
  144899. /**
  144900. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  144901. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  144902. * * 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`)
  144903. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  144904. * * 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
  144905. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  144906. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  144907. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  144908. * @param name defines the name of the mesh
  144909. * @param options defines the options used to create the mesh
  144910. * @param scene defines the hosting scene
  144911. * @returns the icosahedron mesh
  144912. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  144913. */
  144914. static CreateIcoSphere(name: string, options: {
  144915. radius?: number;
  144916. radiusX?: number;
  144917. radiusY?: number;
  144918. radiusZ?: number;
  144919. flat?: boolean;
  144920. subdivisions?: number;
  144921. sideOrientation?: number;
  144922. frontUVs?: Vector4;
  144923. backUVs?: Vector4;
  144924. updatable?: boolean;
  144925. }, scene?: Nullable<Scene>): Mesh;
  144926. }
  144927. }
  144928. declare module BABYLON {
  144929. /**
  144930. * Class containing static functions to help procedurally build meshes
  144931. */
  144932. export class DecalBuilder {
  144933. /**
  144934. * Creates a decal mesh.
  144935. * 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
  144936. * * The parameter `position` (Vector3, default `(0, 0, 0)`) sets the position of the decal in World coordinates
  144937. * * The parameter `normal` (Vector3, default `Vector3.Up`) sets the normal of the mesh where the decal is applied onto in World coordinates
  144938. * * The parameter `size` (Vector3, default `(1, 1, 1)`) sets the decal scaling
  144939. * * The parameter `angle` (float in radian, default 0) sets the angle to rotate the decal
  144940. * @param name defines the name of the mesh
  144941. * @param sourceMesh defines the mesh where the decal must be applied
  144942. * @param options defines the options used to create the mesh
  144943. * @param scene defines the hosting scene
  144944. * @returns the decal mesh
  144945. * @see https://doc.babylonjs.com/how_to/decals
  144946. */
  144947. static CreateDecal(name: string, sourceMesh: AbstractMesh, options: {
  144948. position?: Vector3;
  144949. normal?: Vector3;
  144950. size?: Vector3;
  144951. angle?: number;
  144952. }): Mesh;
  144953. }
  144954. }
  144955. declare module BABYLON {
  144956. /**
  144957. * Class containing static functions to help procedurally build meshes
  144958. */
  144959. export class MeshBuilder {
  144960. /**
  144961. * Creates a box mesh
  144962. * * The parameter `size` sets the size (float) of each box side (default 1)
  144963. * * You can set some different box dimensions by using the parameters `width`, `height` and `depth` (all by default have the same value of `size`)
  144964. * * 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)
  144965. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  144966. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  144967. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  144968. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  144969. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  144970. * @param name defines the name of the mesh
  144971. * @param options defines the options used to create the mesh
  144972. * @param scene defines the hosting scene
  144973. * @returns the box mesh
  144974. */
  144975. static CreateBox(name: string, options: {
  144976. size?: number;
  144977. width?: number;
  144978. height?: number;
  144979. depth?: number;
  144980. faceUV?: Vector4[];
  144981. faceColors?: Color4[];
  144982. sideOrientation?: number;
  144983. frontUVs?: Vector4;
  144984. backUVs?: Vector4;
  144985. wrap?: boolean;
  144986. topBaseAt?: number;
  144987. bottomBaseAt?: number;
  144988. updatable?: boolean;
  144989. }, scene?: Nullable<Scene>): Mesh;
  144990. /**
  144991. * Creates a tiled box mesh
  144992. * * faceTiles sets the pattern, tile size and number of tiles for a face
  144993. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  144994. * @param name defines the name of the mesh
  144995. * @param options defines the options used to create the mesh
  144996. * @param scene defines the hosting scene
  144997. * @returns the tiled box mesh
  144998. */
  144999. static CreateTiledBox(name: string, options: {
  145000. pattern?: number;
  145001. size?: number;
  145002. width?: number;
  145003. height?: number;
  145004. depth: number;
  145005. tileSize?: number;
  145006. tileWidth?: number;
  145007. tileHeight?: number;
  145008. faceUV?: Vector4[];
  145009. faceColors?: Color4[];
  145010. alignHorizontal?: number;
  145011. alignVertical?: number;
  145012. sideOrientation?: number;
  145013. updatable?: boolean;
  145014. }, scene?: Nullable<Scene>): Mesh;
  145015. /**
  145016. * Creates a sphere mesh
  145017. * * The parameter `diameter` sets the diameter size (float) of the sphere (default 1)
  145018. * * 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`)
  145019. * * The parameter `segments` sets the sphere number of horizontal stripes (positive integer, default 32)
  145020. * * 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
  145021. * * 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)
  145022. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145023. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145024. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145025. * @param name defines the name of the mesh
  145026. * @param options defines the options used to create the mesh
  145027. * @param scene defines the hosting scene
  145028. * @returns the sphere mesh
  145029. * @see https://doc.babylonjs.com/how_to/set_shapes#sphere
  145030. */
  145031. static CreateSphere(name: string, options: {
  145032. segments?: number;
  145033. diameter?: number;
  145034. diameterX?: number;
  145035. diameterY?: number;
  145036. diameterZ?: number;
  145037. arc?: number;
  145038. slice?: number;
  145039. sideOrientation?: number;
  145040. frontUVs?: Vector4;
  145041. backUVs?: Vector4;
  145042. updatable?: boolean;
  145043. }, scene?: Nullable<Scene>): Mesh;
  145044. /**
  145045. * Creates a plane polygonal mesh. By default, this is a disc
  145046. * * The parameter `radius` sets the radius size (float) of the polygon (default 0.5)
  145047. * * 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
  145048. * * 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
  145049. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145050. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145051. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145052. * @param name defines the name of the mesh
  145053. * @param options defines the options used to create the mesh
  145054. * @param scene defines the hosting scene
  145055. * @returns the plane polygonal mesh
  145056. * @see https://doc.babylonjs.com/how_to/set_shapes#disc-or-regular-polygon
  145057. */
  145058. static CreateDisc(name: string, options: {
  145059. radius?: number;
  145060. tessellation?: number;
  145061. arc?: number;
  145062. updatable?: boolean;
  145063. sideOrientation?: number;
  145064. frontUVs?: Vector4;
  145065. backUVs?: Vector4;
  145066. }, scene?: Nullable<Scene>): Mesh;
  145067. /**
  145068. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  145069. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  145070. * * 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`)
  145071. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  145072. * * 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
  145073. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145074. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145075. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145076. * @param name defines the name of the mesh
  145077. * @param options defines the options used to create the mesh
  145078. * @param scene defines the hosting scene
  145079. * @returns the icosahedron mesh
  145080. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  145081. */
  145082. static CreateIcoSphere(name: string, options: {
  145083. radius?: number;
  145084. radiusX?: number;
  145085. radiusY?: number;
  145086. radiusZ?: number;
  145087. flat?: boolean;
  145088. subdivisions?: number;
  145089. sideOrientation?: number;
  145090. frontUVs?: Vector4;
  145091. backUVs?: Vector4;
  145092. updatable?: boolean;
  145093. }, scene?: Nullable<Scene>): Mesh;
  145094. /**
  145095. * Creates a ribbon mesh. The ribbon is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  145096. * * The parameter `pathArray` is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry
  145097. * * The parameter `closeArray` (boolean, default false) creates a seam between the first and the last paths of the path array
  145098. * * The parameter `closePath` (boolean, default false) creates a seam between the first and the last points of each path of the path array
  145099. * * 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
  145100. * * 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
  145101. * * 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
  145102. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145103. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145104. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  145105. * * 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
  145106. * * The parameters `colors` is an optional flat array of `Color4` to set/update each ribbon vertex with its own custom color values
  145107. * * 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
  145108. * * Moreover, you can use the parameter `color` with `instance` (to update the ribbon), only if you previously used it at creation time
  145109. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145110. * @param name defines the name of the mesh
  145111. * @param options defines the options used to create the mesh
  145112. * @param scene defines the hosting scene
  145113. * @returns the ribbon mesh
  145114. * @see https://doc.babylonjs.com/how_to/ribbon_tutorial
  145115. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  145116. */
  145117. static CreateRibbon(name: string, options: {
  145118. pathArray: Vector3[][];
  145119. closeArray?: boolean;
  145120. closePath?: boolean;
  145121. offset?: number;
  145122. updatable?: boolean;
  145123. sideOrientation?: number;
  145124. frontUVs?: Vector4;
  145125. backUVs?: Vector4;
  145126. instance?: Mesh;
  145127. invertUV?: boolean;
  145128. uvs?: Vector2[];
  145129. colors?: Color4[];
  145130. }, scene?: Nullable<Scene>): Mesh;
  145131. /**
  145132. * Creates a cylinder or a cone mesh
  145133. * * The parameter `height` sets the height size (float) of the cylinder/cone (float, default 2).
  145134. * * The parameter `diameter` sets the diameter of the top and bottom cap at once (float, default 1).
  145135. * * 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.
  145136. * * The parameter `tessellation` sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance.
  145137. * * The parameter `subdivisions` sets the number of rings along the cylinder height (positive integer, default 1).
  145138. * * The parameter `hasRings` (boolean, default false) makes the subdivisions independent from each other, so they become different faces.
  145139. * * The parameter `enclose` (boolean, default false) adds two extra faces per subdivision to a sliced cylinder to close it around its height axis.
  145140. * * 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).
  145141. * * The parameter `arc` (float, default 1) is the ratio (max 1) to apply to the circumference to slice the cylinder.
  145142. * * 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).
  145143. * * 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
  145144. * * Now, if the cylinder has 5 independent subdivisions (hasRings = true), n equals : top face + 5 stripe surfaces + bottom face = 2 + 5 = 7
  145145. * * 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
  145146. * * 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.
  145147. * * If `enclose` is false, a ring surface is one element.
  145148. * * If `enclose` is true, a ring surface is 3 successive elements in the array : the tubular surface, then the two closing faces.
  145149. * * 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
  145150. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145151. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145152. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  145153. * @param name defines the name of the mesh
  145154. * @param options defines the options used to create the mesh
  145155. * @param scene defines the hosting scene
  145156. * @returns the cylinder mesh
  145157. * @see https://doc.babylonjs.com/how_to/set_shapes#cylinder-or-cone
  145158. */
  145159. static CreateCylinder(name: string, options: {
  145160. height?: number;
  145161. diameterTop?: number;
  145162. diameterBottom?: number;
  145163. diameter?: number;
  145164. tessellation?: number;
  145165. subdivisions?: number;
  145166. arc?: number;
  145167. faceColors?: Color4[];
  145168. faceUV?: Vector4[];
  145169. updatable?: boolean;
  145170. hasRings?: boolean;
  145171. enclose?: boolean;
  145172. cap?: number;
  145173. sideOrientation?: number;
  145174. frontUVs?: Vector4;
  145175. backUVs?: Vector4;
  145176. }, scene?: Nullable<Scene>): Mesh;
  145177. /**
  145178. * Creates a torus mesh
  145179. * * The parameter `diameter` sets the diameter size (float) of the torus (default 1)
  145180. * * The parameter `thickness` sets the diameter size of the tube of the torus (float, default 0.5)
  145181. * * The parameter `tessellation` sets the number of torus sides (postive integer, default 16)
  145182. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145183. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145184. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  145185. * @param name defines the name of the mesh
  145186. * @param options defines the options used to create the mesh
  145187. * @param scene defines the hosting scene
  145188. * @returns the torus mesh
  145189. * @see https://doc.babylonjs.com/how_to/set_shapes#torus
  145190. */
  145191. static CreateTorus(name: string, options: {
  145192. diameter?: number;
  145193. thickness?: number;
  145194. tessellation?: number;
  145195. updatable?: boolean;
  145196. sideOrientation?: number;
  145197. frontUVs?: Vector4;
  145198. backUVs?: Vector4;
  145199. }, scene?: Nullable<Scene>): Mesh;
  145200. /**
  145201. * Creates a torus knot mesh
  145202. * * The parameter `radius` sets the global radius size (float) of the torus knot (default 2)
  145203. * * The parameter `radialSegments` sets the number of sides on each tube segments (positive integer, default 32)
  145204. * * The parameter `tubularSegments` sets the number of tubes to decompose the knot into (positive integer, default 32)
  145205. * * The parameters `p` and `q` are the number of windings on each axis (positive integers, default 2 and 3)
  145206. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145207. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145208. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  145209. * @param name defines the name of the mesh
  145210. * @param options defines the options used to create the mesh
  145211. * @param scene defines the hosting scene
  145212. * @returns the torus knot mesh
  145213. * @see https://doc.babylonjs.com/how_to/set_shapes#torus-knot
  145214. */
  145215. static CreateTorusKnot(name: string, options: {
  145216. radius?: number;
  145217. tube?: number;
  145218. radialSegments?: number;
  145219. tubularSegments?: number;
  145220. p?: number;
  145221. q?: number;
  145222. updatable?: boolean;
  145223. sideOrientation?: number;
  145224. frontUVs?: Vector4;
  145225. backUVs?: Vector4;
  145226. }, scene?: Nullable<Scene>): Mesh;
  145227. /**
  145228. * Creates a line system mesh. A line system is a pool of many lines gathered in a single mesh
  145229. * * 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
  145230. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineSystem to this static function
  145231. * * The parameter `lines` is an array of lines, each line being an array of successive Vector3
  145232. * * The optional parameter `instance` is an instance of an existing LineSystem object to be updated with the passed `lines` parameter
  145233. * * The optional parameter `colors` is an array of line colors, each line colors being an array of successive Color4, one per line point
  145234. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  145235. * * 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
  145236. * * When updating an instance, remember that only line point positions can change, not the number of points, neither the number of lines
  145237. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145238. * @see https://doc.babylonjs.com/how_to/parametric_shapes#line-system
  145239. * @param name defines the name of the new line system
  145240. * @param options defines the options used to create the line system
  145241. * @param scene defines the hosting scene
  145242. * @returns a new line system mesh
  145243. */
  145244. static CreateLineSystem(name: string, options: {
  145245. lines: Vector3[][];
  145246. updatable?: boolean;
  145247. instance?: Nullable<LinesMesh>;
  145248. colors?: Nullable<Color4[][]>;
  145249. useVertexAlpha?: boolean;
  145250. }, scene: Nullable<Scene>): LinesMesh;
  145251. /**
  145252. * Creates a line mesh
  145253. * 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
  145254. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  145255. * * The parameter `points` is an array successive Vector3
  145256. * * 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
  145257. * * The optional parameter `colors` is an array of successive Color4, one per line point
  145258. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need alpha blending (faster)
  145259. * * When updating an instance, remember that only point positions can change, not the number of points
  145260. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145261. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lines
  145262. * @param name defines the name of the new line system
  145263. * @param options defines the options used to create the line system
  145264. * @param scene defines the hosting scene
  145265. * @returns a new line mesh
  145266. */
  145267. static CreateLines(name: string, options: {
  145268. points: Vector3[];
  145269. updatable?: boolean;
  145270. instance?: Nullable<LinesMesh>;
  145271. colors?: Color4[];
  145272. useVertexAlpha?: boolean;
  145273. }, scene?: Nullable<Scene>): LinesMesh;
  145274. /**
  145275. * Creates a dashed line mesh
  145276. * * 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
  145277. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  145278. * * The parameter `points` is an array successive Vector3
  145279. * * The parameter `dashNb` is the intended total number of dashes (positive integer, default 200)
  145280. * * The parameter `dashSize` is the size of the dashes relatively the dash number (positive float, default 3)
  145281. * * The parameter `gapSize` is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  145282. * * 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
  145283. * * When updating an instance, remember that only point positions can change, not the number of points
  145284. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145285. * @param name defines the name of the mesh
  145286. * @param options defines the options used to create the mesh
  145287. * @param scene defines the hosting scene
  145288. * @returns the dashed line mesh
  145289. * @see https://doc.babylonjs.com/how_to/parametric_shapes#dashed-lines
  145290. */
  145291. static CreateDashedLines(name: string, options: {
  145292. points: Vector3[];
  145293. dashSize?: number;
  145294. gapSize?: number;
  145295. dashNb?: number;
  145296. updatable?: boolean;
  145297. instance?: LinesMesh;
  145298. }, scene?: Nullable<Scene>): LinesMesh;
  145299. /**
  145300. * 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.
  145301. * * 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.
  145302. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  145303. * * 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.
  145304. * * The parameter `scale` (float, default 1) is the value to scale the shape.
  145305. * * 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
  145306. * * 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
  145307. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape.
  145308. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145309. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145310. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture.
  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. * @param name defines the name of the mesh
  145313. * @param options defines the options used to create the mesh
  145314. * @param scene defines the hosting scene
  145315. * @returns the extruded shape mesh
  145316. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  145317. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  145318. */
  145319. static ExtrudeShape(name: string, options: {
  145320. shape: Vector3[];
  145321. path: Vector3[];
  145322. scale?: number;
  145323. rotation?: number;
  145324. cap?: number;
  145325. updatable?: boolean;
  145326. sideOrientation?: number;
  145327. frontUVs?: Vector4;
  145328. backUVs?: Vector4;
  145329. instance?: Mesh;
  145330. invertUV?: boolean;
  145331. }, scene?: Nullable<Scene>): Mesh;
  145332. /**
  145333. * Creates an custom extruded shape mesh.
  145334. * The custom extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  145335. * * 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.
  145336. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  145337. * * 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
  145338. * * It must returns a float value that will be the rotation in radians applied to the shape on each path point.
  145339. * * 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
  145340. * * It must returns a float value that will be the scale value applied to the shape on each path point
  145341. * * The parameter `ribbonClosePath` (boolean, default false) forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  145342. * * The parameter `ribbonCloseArray` (boolean, default false) forces the extrusion underlying ribbon to close its `pathArray`
  145343. * * 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
  145344. * * 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
  145345. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape
  145346. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145347. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145348. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  145349. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145350. * @param name defines the name of the mesh
  145351. * @param options defines the options used to create the mesh
  145352. * @param scene defines the hosting scene
  145353. * @returns the custom extruded shape mesh
  145354. * @see https://doc.babylonjs.com/how_to/parametric_shapes#custom-extruded-shapes
  145355. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  145356. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  145357. */
  145358. static ExtrudeShapeCustom(name: string, options: {
  145359. shape: Vector3[];
  145360. path: Vector3[];
  145361. scaleFunction?: any;
  145362. rotationFunction?: any;
  145363. ribbonCloseArray?: boolean;
  145364. ribbonClosePath?: boolean;
  145365. cap?: number;
  145366. updatable?: boolean;
  145367. sideOrientation?: number;
  145368. frontUVs?: Vector4;
  145369. backUVs?: Vector4;
  145370. instance?: Mesh;
  145371. invertUV?: boolean;
  145372. }, scene?: Nullable<Scene>): Mesh;
  145373. /**
  145374. * Creates lathe mesh.
  145375. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe
  145376. * * 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
  145377. * * The parameter `radius` (positive float, default 1) is the radius value of the lathe
  145378. * * The parameter `tessellation` (positive integer, default 64) is the side number of the lathe
  145379. * * The parameter `clip` (positive integer, default 0) is the number of sides to not create without effecting the general shape of the sides
  145380. * * 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
  145381. * * The parameter `closed` (boolean, default true) opens/closes the lathe circumference. This should be set to false when used with the parameter "arc"
  145382. * * 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
  145383. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145384. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145385. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  145386. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145387. * @param name defines the name of the mesh
  145388. * @param options defines the options used to create the mesh
  145389. * @param scene defines the hosting scene
  145390. * @returns the lathe mesh
  145391. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lathe
  145392. */
  145393. static CreateLathe(name: string, options: {
  145394. shape: Vector3[];
  145395. radius?: number;
  145396. tessellation?: number;
  145397. clip?: number;
  145398. arc?: number;
  145399. closed?: boolean;
  145400. updatable?: boolean;
  145401. sideOrientation?: number;
  145402. frontUVs?: Vector4;
  145403. backUVs?: Vector4;
  145404. cap?: number;
  145405. invertUV?: boolean;
  145406. }, scene?: Nullable<Scene>): Mesh;
  145407. /**
  145408. * Creates a tiled plane mesh
  145409. * * You can set a limited pattern arrangement with the tiles
  145410. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145411. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145412. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145413. * @param name defines the name of the mesh
  145414. * @param options defines the options used to create the mesh
  145415. * @param scene defines the hosting scene
  145416. * @returns the plane mesh
  145417. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  145418. */
  145419. static CreateTiledPlane(name: string, options: {
  145420. pattern?: number;
  145421. tileSize?: number;
  145422. tileWidth?: number;
  145423. tileHeight?: number;
  145424. size?: number;
  145425. width?: number;
  145426. height?: number;
  145427. alignHorizontal?: number;
  145428. alignVertical?: number;
  145429. sideOrientation?: number;
  145430. frontUVs?: Vector4;
  145431. backUVs?: Vector4;
  145432. updatable?: boolean;
  145433. }, scene?: Nullable<Scene>): Mesh;
  145434. /**
  145435. * Creates a plane mesh
  145436. * * The parameter `size` sets the size (float) of both sides of the plane at once (default 1)
  145437. * * You can set some different plane dimensions by using the parameters `width` and `height` (both by default have the same value of `size`)
  145438. * * The parameter `sourcePlane` is a Plane instance. It builds a mesh plane from a Math plane
  145439. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145440. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145441. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145442. * @param name defines the name of the mesh
  145443. * @param options defines the options used to create the mesh
  145444. * @param scene defines the hosting scene
  145445. * @returns the plane mesh
  145446. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  145447. */
  145448. static CreatePlane(name: string, options: {
  145449. size?: number;
  145450. width?: number;
  145451. height?: number;
  145452. sideOrientation?: number;
  145453. frontUVs?: Vector4;
  145454. backUVs?: Vector4;
  145455. updatable?: boolean;
  145456. sourcePlane?: Plane;
  145457. }, scene?: Nullable<Scene>): Mesh;
  145458. /**
  145459. * Creates a ground mesh
  145460. * * The parameters `width` and `height` (floats, default 1) set the width and height sizes of the ground
  145461. * * The parameter `subdivisions` (positive integer) sets the number of subdivisions per side
  145462. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145463. * @param name defines the name of the mesh
  145464. * @param options defines the options used to create the mesh
  145465. * @param scene defines the hosting scene
  145466. * @returns the ground mesh
  145467. * @see https://doc.babylonjs.com/how_to/set_shapes#ground
  145468. */
  145469. static CreateGround(name: string, options: {
  145470. width?: number;
  145471. height?: number;
  145472. subdivisions?: number;
  145473. subdivisionsX?: number;
  145474. subdivisionsY?: number;
  145475. updatable?: boolean;
  145476. }, scene?: Nullable<Scene>): Mesh;
  145477. /**
  145478. * Creates a tiled ground mesh
  145479. * * The parameters `xmin` and `xmax` (floats, default -1 and 1) set the ground minimum and maximum X coordinates
  145480. * * The parameters `zmin` and `zmax` (floats, default -1 and 1) set the ground minimum and maximum Z coordinates
  145481. * * 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
  145482. * * 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
  145483. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  145484. * @param name defines the name of the mesh
  145485. * @param options defines the options used to create the mesh
  145486. * @param scene defines the hosting scene
  145487. * @returns the tiled ground mesh
  145488. * @see https://doc.babylonjs.com/how_to/set_shapes#tiled-ground
  145489. */
  145490. static CreateTiledGround(name: string, options: {
  145491. xmin: number;
  145492. zmin: number;
  145493. xmax: number;
  145494. zmax: number;
  145495. subdivisions?: {
  145496. w: number;
  145497. h: number;
  145498. };
  145499. precision?: {
  145500. w: number;
  145501. h: number;
  145502. };
  145503. updatable?: boolean;
  145504. }, scene?: Nullable<Scene>): Mesh;
  145505. /**
  145506. * Creates a ground mesh from a height map
  145507. * * The parameter `url` sets the URL of the height map image resource.
  145508. * * The parameters `width` and `height` (positive floats, default 10) set the ground width and height sizes.
  145509. * * The parameter `subdivisions` (positive integer, default 1) sets the number of subdivision per side.
  145510. * * The parameter `minHeight` (float, default 0) is the minimum altitude on the ground.
  145511. * * The parameter `maxHeight` (float, default 1) is the maximum altitude on the ground.
  145512. * * 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.
  145513. * * 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).
  145514. * * The parameter `alphaFilter` will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  145515. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  145516. * @param name defines the name of the mesh
  145517. * @param url defines the url to the height map
  145518. * @param options defines the options used to create the mesh
  145519. * @param scene defines the hosting scene
  145520. * @returns the ground mesh
  145521. * @see https://doc.babylonjs.com/babylon101/height_map
  145522. * @see https://doc.babylonjs.com/how_to/set_shapes#ground-from-a-height-map
  145523. */
  145524. static CreateGroundFromHeightMap(name: string, url: string, options: {
  145525. width?: number;
  145526. height?: number;
  145527. subdivisions?: number;
  145528. minHeight?: number;
  145529. maxHeight?: number;
  145530. colorFilter?: Color3;
  145531. alphaFilter?: number;
  145532. updatable?: boolean;
  145533. onReady?: (mesh: GroundMesh) => void;
  145534. }, scene?: Nullable<Scene>): GroundMesh;
  145535. /**
  145536. * Creates a polygon mesh
  145537. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh
  145538. * * 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
  145539. * * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  145540. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145541. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4)
  145542. * * Remember you can only change the shape positions, not their number when updating a polygon
  145543. * @param name defines the name of the mesh
  145544. * @param options defines the options used to create the mesh
  145545. * @param scene defines the hosting scene
  145546. * @param earcutInjection can be used to inject your own earcut reference
  145547. * @returns the polygon mesh
  145548. */
  145549. static CreatePolygon(name: string, options: {
  145550. shape: Vector3[];
  145551. holes?: Vector3[][];
  145552. depth?: number;
  145553. faceUV?: Vector4[];
  145554. faceColors?: Color4[];
  145555. updatable?: boolean;
  145556. sideOrientation?: number;
  145557. frontUVs?: Vector4;
  145558. backUVs?: Vector4;
  145559. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  145560. /**
  145561. * Creates an extruded polygon mesh, with depth in the Y direction.
  145562. * * 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)
  145563. * @see https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  145564. * @param name defines the name of the mesh
  145565. * @param options defines the options used to create the mesh
  145566. * @param scene defines the hosting scene
  145567. * @param earcutInjection can be used to inject your own earcut reference
  145568. * @returns the polygon mesh
  145569. */
  145570. static ExtrudePolygon(name: string, options: {
  145571. shape: Vector3[];
  145572. holes?: Vector3[][];
  145573. depth?: number;
  145574. faceUV?: Vector4[];
  145575. faceColors?: Color4[];
  145576. updatable?: boolean;
  145577. sideOrientation?: number;
  145578. frontUVs?: Vector4;
  145579. backUVs?: Vector4;
  145580. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  145581. /**
  145582. * Creates a tube mesh.
  145583. * The tube is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  145584. * * The parameter `path` is a required array of successive Vector3. It is the curve used as the axis of the tube
  145585. * * The parameter `radius` (positive float, default 1) sets the tube radius size
  145586. * * The parameter `tessellation` (positive float, default 64) is the number of sides on the tubular surface
  145587. * * The parameter `radiusFunction` (javascript function, default null) is a vanilla javascript function. If it is not null, it overwrittes the parameter `radius`
  145588. * * 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)
  145589. * * The parameter `arc` (positive float, maximum 1, default 1) is the ratio to apply to the tube circumference : 2 x PI x arc
  145590. * * 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
  145591. * * 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
  145592. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145593. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145594. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  145595. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145596. * @param name defines the name of the mesh
  145597. * @param options defines the options used to create the mesh
  145598. * @param scene defines the hosting scene
  145599. * @returns the tube mesh
  145600. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  145601. * @see https://doc.babylonjs.com/how_to/set_shapes#tube
  145602. */
  145603. static CreateTube(name: string, options: {
  145604. path: Vector3[];
  145605. radius?: number;
  145606. tessellation?: number;
  145607. radiusFunction?: {
  145608. (i: number, distance: number): number;
  145609. };
  145610. cap?: number;
  145611. arc?: number;
  145612. updatable?: boolean;
  145613. sideOrientation?: number;
  145614. frontUVs?: Vector4;
  145615. backUVs?: Vector4;
  145616. instance?: Mesh;
  145617. invertUV?: boolean;
  145618. }, scene?: Nullable<Scene>): Mesh;
  145619. /**
  145620. * Creates a polyhedron mesh
  145621. * * 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
  145622. * * The parameter `size` (positive float, default 1) sets the polygon size
  145623. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  145624. * * 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`
  145625. * * 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
  145626. * * 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)`)
  145627. * * 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
  145628. * * 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
  145629. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145630. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145631. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145632. * @param name defines the name of the mesh
  145633. * @param options defines the options used to create the mesh
  145634. * @param scene defines the hosting scene
  145635. * @returns the polyhedron mesh
  145636. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes
  145637. */
  145638. static CreatePolyhedron(name: string, options: {
  145639. type?: number;
  145640. size?: number;
  145641. sizeX?: number;
  145642. sizeY?: number;
  145643. sizeZ?: number;
  145644. custom?: any;
  145645. faceUV?: Vector4[];
  145646. faceColors?: Color4[];
  145647. flat?: boolean;
  145648. updatable?: boolean;
  145649. sideOrientation?: number;
  145650. frontUVs?: Vector4;
  145651. backUVs?: Vector4;
  145652. }, scene?: Nullable<Scene>): Mesh;
  145653. /**
  145654. * Creates a decal mesh.
  145655. * 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
  145656. * * The parameter `position` (Vector3, default `(0, 0, 0)`) sets the position of the decal in World coordinates
  145657. * * The parameter `normal` (Vector3, default `Vector3.Up`) sets the normal of the mesh where the decal is applied onto in World coordinates
  145658. * * The parameter `size` (Vector3, default `(1, 1, 1)`) sets the decal scaling
  145659. * * The parameter `angle` (float in radian, default 0) sets the angle to rotate the decal
  145660. * @param name defines the name of the mesh
  145661. * @param sourceMesh defines the mesh where the decal must be applied
  145662. * @param options defines the options used to create the mesh
  145663. * @param scene defines the hosting scene
  145664. * @returns the decal mesh
  145665. * @see https://doc.babylonjs.com/how_to/decals
  145666. */
  145667. static CreateDecal(name: string, sourceMesh: AbstractMesh, options: {
  145668. position?: Vector3;
  145669. normal?: Vector3;
  145670. size?: Vector3;
  145671. angle?: number;
  145672. }): Mesh;
  145673. }
  145674. }
  145675. declare module BABYLON {
  145676. /**
  145677. * A simplifier interface for future simplification implementations
  145678. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  145679. */
  145680. export interface ISimplifier {
  145681. /**
  145682. * Simplification of a given mesh according to the given settings.
  145683. * Since this requires computation, it is assumed that the function runs async.
  145684. * @param settings The settings of the simplification, including quality and distance
  145685. * @param successCallback A callback that will be called after the mesh was simplified.
  145686. * @param errorCallback in case of an error, this callback will be called. optional.
  145687. */
  145688. simplify(settings: ISimplificationSettings, successCallback: (simplifiedMeshes: Mesh) => void, errorCallback?: () => void): void;
  145689. }
  145690. /**
  145691. * Expected simplification settings.
  145692. * Quality should be between 0 and 1 (1 being 100%, 0 being 0%)
  145693. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  145694. */
  145695. export interface ISimplificationSettings {
  145696. /**
  145697. * Gets or sets the expected quality
  145698. */
  145699. quality: number;
  145700. /**
  145701. * Gets or sets the distance when this optimized version should be used
  145702. */
  145703. distance: number;
  145704. /**
  145705. * Gets an already optimized mesh
  145706. */
  145707. optimizeMesh?: boolean;
  145708. }
  145709. /**
  145710. * Class used to specify simplification options
  145711. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  145712. */
  145713. export class SimplificationSettings implements ISimplificationSettings {
  145714. /** expected quality */
  145715. quality: number;
  145716. /** distance when this optimized version should be used */
  145717. distance: number;
  145718. /** already optimized mesh */
  145719. optimizeMesh?: boolean | undefined;
  145720. /**
  145721. * Creates a SimplificationSettings
  145722. * @param quality expected quality
  145723. * @param distance distance when this optimized version should be used
  145724. * @param optimizeMesh already optimized mesh
  145725. */
  145726. constructor(
  145727. /** expected quality */
  145728. quality: number,
  145729. /** distance when this optimized version should be used */
  145730. distance: number,
  145731. /** already optimized mesh */
  145732. optimizeMesh?: boolean | undefined);
  145733. }
  145734. /**
  145735. * Interface used to define a simplification task
  145736. */
  145737. export interface ISimplificationTask {
  145738. /**
  145739. * Array of settings
  145740. */
  145741. settings: Array<ISimplificationSettings>;
  145742. /**
  145743. * Simplification type
  145744. */
  145745. simplificationType: SimplificationType;
  145746. /**
  145747. * Mesh to simplify
  145748. */
  145749. mesh: Mesh;
  145750. /**
  145751. * Callback called on success
  145752. */
  145753. successCallback?: () => void;
  145754. /**
  145755. * Defines if parallel processing can be used
  145756. */
  145757. parallelProcessing: boolean;
  145758. }
  145759. /**
  145760. * Queue used to order the simplification tasks
  145761. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  145762. */
  145763. export class SimplificationQueue {
  145764. private _simplificationArray;
  145765. /**
  145766. * Gets a boolean indicating that the process is still running
  145767. */
  145768. running: boolean;
  145769. /**
  145770. * Creates a new queue
  145771. */
  145772. constructor();
  145773. /**
  145774. * Adds a new simplification task
  145775. * @param task defines a task to add
  145776. */
  145777. addTask(task: ISimplificationTask): void;
  145778. /**
  145779. * Execute next task
  145780. */
  145781. executeNext(): void;
  145782. /**
  145783. * Execute a simplification task
  145784. * @param task defines the task to run
  145785. */
  145786. runSimplification(task: ISimplificationTask): void;
  145787. private getSimplifier;
  145788. }
  145789. /**
  145790. * The implemented types of simplification
  145791. * At the moment only Quadratic Error Decimation is implemented
  145792. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  145793. */
  145794. export enum SimplificationType {
  145795. /** Quadratic error decimation */
  145796. QUADRATIC = 0
  145797. }
  145798. /**
  145799. * An implementation of the Quadratic Error simplification algorithm.
  145800. * Original paper : http://www1.cs.columbia.edu/~cs4162/html05s/garland97.pdf
  145801. * Ported mostly from QSlim and http://voxels.blogspot.de/2014/05/quadric-mesh-simplification-with-source.html to babylon JS
  145802. * @author RaananW
  145803. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  145804. */
  145805. export class QuadraticErrorSimplification implements ISimplifier {
  145806. private _mesh;
  145807. private triangles;
  145808. private vertices;
  145809. private references;
  145810. private _reconstructedMesh;
  145811. /** Gets or sets the number pf sync interations */
  145812. syncIterations: number;
  145813. /** Gets or sets the aggressiveness of the simplifier */
  145814. aggressiveness: number;
  145815. /** Gets or sets the number of allowed iterations for decimation */
  145816. decimationIterations: number;
  145817. /** Gets or sets the espilon to use for bounding box computation */
  145818. boundingBoxEpsilon: number;
  145819. /**
  145820. * Creates a new QuadraticErrorSimplification
  145821. * @param _mesh defines the target mesh
  145822. */
  145823. constructor(_mesh: Mesh);
  145824. /**
  145825. * Simplification of a given mesh according to the given settings.
  145826. * Since this requires computation, it is assumed that the function runs async.
  145827. * @param settings The settings of the simplification, including quality and distance
  145828. * @param successCallback A callback that will be called after the mesh was simplified.
  145829. */
  145830. simplify(settings: ISimplificationSettings, successCallback: (simplifiedMesh: Mesh) => void): void;
  145831. private runDecimation;
  145832. private initWithMesh;
  145833. private init;
  145834. private reconstructMesh;
  145835. private initDecimatedMesh;
  145836. private isFlipped;
  145837. private updateTriangles;
  145838. private identifyBorder;
  145839. private updateMesh;
  145840. private vertexError;
  145841. private calculateError;
  145842. }
  145843. }
  145844. declare module BABYLON {
  145845. interface Scene {
  145846. /** @hidden (Backing field) */
  145847. _simplificationQueue: SimplificationQueue;
  145848. /**
  145849. * Gets or sets the simplification queue attached to the scene
  145850. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  145851. */
  145852. simplificationQueue: SimplificationQueue;
  145853. }
  145854. interface Mesh {
  145855. /**
  145856. * Simplify the mesh according to the given array of settings.
  145857. * Function will return immediately and will simplify async
  145858. * @param settings a collection of simplification settings
  145859. * @param parallelProcessing should all levels calculate parallel or one after the other
  145860. * @param simplificationType the type of simplification to run
  145861. * @param successCallback optional success callback to be called after the simplification finished processing all settings
  145862. * @returns the current mesh
  145863. */
  145864. simplify(settings: Array<ISimplificationSettings>, parallelProcessing?: boolean, simplificationType?: SimplificationType, successCallback?: (mesh?: Mesh, submeshIndex?: number) => void): Mesh;
  145865. }
  145866. /**
  145867. * Defines the simplification queue scene component responsible to help scheduling the various simplification task
  145868. * created in a scene
  145869. */
  145870. export class SimplicationQueueSceneComponent implements ISceneComponent {
  145871. /**
  145872. * The component name helpfull to identify the component in the list of scene components.
  145873. */
  145874. readonly name: string;
  145875. /**
  145876. * The scene the component belongs to.
  145877. */
  145878. scene: Scene;
  145879. /**
  145880. * Creates a new instance of the component for the given scene
  145881. * @param scene Defines the scene to register the component in
  145882. */
  145883. constructor(scene: Scene);
  145884. /**
  145885. * Registers the component in a given scene
  145886. */
  145887. register(): void;
  145888. /**
  145889. * Rebuilds the elements related to this component in case of
  145890. * context lost for instance.
  145891. */
  145892. rebuild(): void;
  145893. /**
  145894. * Disposes the component and the associated ressources
  145895. */
  145896. dispose(): void;
  145897. private _beforeCameraUpdate;
  145898. }
  145899. }
  145900. declare module BABYLON {
  145901. interface Mesh {
  145902. /**
  145903. * Gets or sets a boolean defining if we want picking to pick thin instances as well
  145904. */
  145905. thinInstanceEnablePicking: boolean;
  145906. /**
  145907. * Creates a new thin instance
  145908. * @param matrix the matrix or array of matrices (position, rotation, scale) of the thin instance(s) to create
  145909. * @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
  145910. * @returns the thin instance index number. If you pass an array of matrices, other instance indexes are index+1, index+2, etc
  145911. */
  145912. thinInstanceAdd(matrix: DeepImmutableObject<Matrix> | Array<DeepImmutableObject<Matrix>>, refresh: boolean): number;
  145913. /**
  145914. * Adds the transformation (matrix) of the current mesh as a thin instance
  145915. * @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
  145916. * @returns the thin instance index number
  145917. */
  145918. thinInstanceAddSelf(refresh: boolean): number;
  145919. /**
  145920. * Registers a custom attribute to be used with thin instances
  145921. * @param kind name of the attribute
  145922. * @param stride size in floats of the attribute
  145923. */
  145924. thinInstanceRegisterAttribute(kind: string, stride: number): void;
  145925. /**
  145926. * Sets the matrix of a thin instance
  145927. * @param index index of the thin instance
  145928. * @param matrix matrix to set
  145929. * @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
  145930. */
  145931. thinInstanceSetMatrixAt(index: number, matrix: DeepImmutableObject<Matrix>, refresh: boolean): void;
  145932. /**
  145933. * Sets the value of a custom attribute for a thin instance
  145934. * @param kind name of the attribute
  145935. * @param index index of the thin instance
  145936. * @param value value to set
  145937. * @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
  145938. */
  145939. thinInstanceSetAttributeAt(kind: string, index: number, value: Array<number>, refresh: boolean): void;
  145940. /**
  145941. * 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.
  145942. */
  145943. thinInstanceCount: number;
  145944. /**
  145945. * Sets a buffer to be used with thin instances. This method is a faster way to setup multiple instances than calling thinInstanceAdd repeatedly
  145946. * @param kind name of the attribute. Use "matrix" to setup the buffer of matrices
  145947. * @param buffer buffer to set
  145948. * @param stride size in floats of each value of the buffer
  145949. * @param staticBuffer indicates that the buffer is static, so that you won't change it after it is set (better performances - false by default)
  145950. */
  145951. thinInstanceSetBuffer(kind: string, buffer: Nullable<Float32Array>, stride: number, staticBuffer: boolean): void;
  145952. /**
  145953. * Gets the list of world matrices
  145954. * @return an array containing all the world matrices from the thin instances
  145955. */
  145956. thinInstanceGetWorldMatrices(): Matrix[];
  145957. /**
  145958. * Synchronize the gpu buffers with a thin instance buffer. Call this method if you update later on the buffers passed to thinInstanceSetBuffer
  145959. * @param kind name of the attribute to update. Use "matrix" to update the buffer of matrices
  145960. */
  145961. thinInstanceBufferUpdated(kind: string): void;
  145962. /**
  145963. * Refreshes the bounding info, taking into account all the thin instances defined
  145964. * @param forceRefreshParentInfo true to force recomputing the mesh bounding info and use it to compute the aggregated bounding info
  145965. */
  145966. thinInstanceRefreshBoundingInfo(forceRefreshParentInfo: boolean): void;
  145967. /** @hidden */
  145968. _thinInstanceInitializeUserStorage(): void;
  145969. /** @hidden */
  145970. _thinInstanceUpdateBufferSize(kind: string, numInstances: number): void;
  145971. /** @hidden */
  145972. _userThinInstanceBuffersStorage: {
  145973. data: {
  145974. [key: string]: Float32Array;
  145975. };
  145976. sizes: {
  145977. [key: string]: number;
  145978. };
  145979. vertexBuffers: {
  145980. [key: string]: Nullable<VertexBuffer>;
  145981. };
  145982. strides: {
  145983. [key: string]: number;
  145984. };
  145985. };
  145986. }
  145987. }
  145988. declare module BABYLON {
  145989. /**
  145990. * Navigation plugin interface to add navigation constrained by a navigation mesh
  145991. */
  145992. export interface INavigationEnginePlugin {
  145993. /**
  145994. * plugin name
  145995. */
  145996. name: string;
  145997. /**
  145998. * Creates a navigation mesh
  145999. * @param meshes array of all the geometry used to compute the navigatio mesh
  146000. * @param parameters bunch of parameters used to filter geometry
  146001. */
  146002. createNavMesh(meshes: Array<Mesh>, parameters: INavMeshParameters): void;
  146003. /**
  146004. * Create a navigation mesh debug mesh
  146005. * @param scene is where the mesh will be added
  146006. * @returns debug display mesh
  146007. */
  146008. createDebugNavMesh(scene: Scene): Mesh;
  146009. /**
  146010. * Get a navigation mesh constrained position, closest to the parameter position
  146011. * @param position world position
  146012. * @returns the closest point to position constrained by the navigation mesh
  146013. */
  146014. getClosestPoint(position: Vector3): Vector3;
  146015. /**
  146016. * Get a navigation mesh constrained position, closest to the parameter position
  146017. * @param position world position
  146018. * @param result output the closest point to position constrained by the navigation mesh
  146019. */
  146020. getClosestPointToRef(position: Vector3, result: Vector3): void;
  146021. /**
  146022. * Get a navigation mesh constrained position, within a particular radius
  146023. * @param position world position
  146024. * @param maxRadius the maximum distance to the constrained world position
  146025. * @returns the closest point to position constrained by the navigation mesh
  146026. */
  146027. getRandomPointAround(position: Vector3, maxRadius: number): Vector3;
  146028. /**
  146029. * Get a navigation mesh constrained position, within a particular radius
  146030. * @param position world position
  146031. * @param maxRadius the maximum distance to the constrained world position
  146032. * @param result output the closest point to position constrained by the navigation mesh
  146033. */
  146034. getRandomPointAroundToRef(position: Vector3, maxRadius: number, result: Vector3): void;
  146035. /**
  146036. * Compute the final position from a segment made of destination-position
  146037. * @param position world position
  146038. * @param destination world position
  146039. * @returns the resulting point along the navmesh
  146040. */
  146041. moveAlong(position: Vector3, destination: Vector3): Vector3;
  146042. /**
  146043. * Compute the final position from a segment made of destination-position
  146044. * @param position world position
  146045. * @param destination world position
  146046. * @param result output the resulting point along the navmesh
  146047. */
  146048. moveAlongToRef(position: Vector3, destination: Vector3, result: Vector3): void;
  146049. /**
  146050. * Compute a navigation path from start to end. Returns an empty array if no path can be computed
  146051. * @param start world position
  146052. * @param end world position
  146053. * @returns array containing world position composing the path
  146054. */
  146055. computePath(start: Vector3, end: Vector3): Vector3[];
  146056. /**
  146057. * If this plugin is supported
  146058. * @returns true if plugin is supported
  146059. */
  146060. isSupported(): boolean;
  146061. /**
  146062. * Create a new Crowd so you can add agents
  146063. * @param maxAgents the maximum agent count in the crowd
  146064. * @param maxAgentRadius the maximum radius an agent can have
  146065. * @param scene to attach the crowd to
  146066. * @returns the crowd you can add agents to
  146067. */
  146068. createCrowd(maxAgents: number, maxAgentRadius: number, scene: Scene): ICrowd;
  146069. /**
  146070. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  146071. * The queries will try to find a solution within those bounds
  146072. * default is (1,1,1)
  146073. * @param extent x,y,z value that define the extent around the queries point of reference
  146074. */
  146075. setDefaultQueryExtent(extent: Vector3): void;
  146076. /**
  146077. * Get the Bounding box extent specified by setDefaultQueryExtent
  146078. * @returns the box extent values
  146079. */
  146080. getDefaultQueryExtent(): Vector3;
  146081. /**
  146082. * build the navmesh from a previously saved state using getNavmeshData
  146083. * @param data the Uint8Array returned by getNavmeshData
  146084. */
  146085. buildFromNavmeshData(data: Uint8Array): void;
  146086. /**
  146087. * returns the navmesh data that can be used later. The navmesh must be built before retrieving the data
  146088. * @returns data the Uint8Array that can be saved and reused
  146089. */
  146090. getNavmeshData(): Uint8Array;
  146091. /**
  146092. * Get the Bounding box extent result specified by setDefaultQueryExtent
  146093. * @param result output the box extent values
  146094. */
  146095. getDefaultQueryExtentToRef(result: Vector3): void;
  146096. /**
  146097. * Release all resources
  146098. */
  146099. dispose(): void;
  146100. }
  146101. /**
  146102. * Crowd Interface. A Crowd is a collection of moving agents constrained by a navigation mesh
  146103. */
  146104. export interface ICrowd {
  146105. /**
  146106. * Add a new agent to the crowd with the specified parameter a corresponding transformNode.
  146107. * You can attach anything to that node. The node position is updated in the scene update tick.
  146108. * @param pos world position that will be constrained by the navigation mesh
  146109. * @param parameters agent parameters
  146110. * @param transform hooked to the agent that will be update by the scene
  146111. * @returns agent index
  146112. */
  146113. addAgent(pos: Vector3, parameters: IAgentParameters, transform: TransformNode): number;
  146114. /**
  146115. * Returns the agent position in world space
  146116. * @param index agent index returned by addAgent
  146117. * @returns world space position
  146118. */
  146119. getAgentPosition(index: number): Vector3;
  146120. /**
  146121. * Gets the agent position result in world space
  146122. * @param index agent index returned by addAgent
  146123. * @param result output world space position
  146124. */
  146125. getAgentPositionToRef(index: number, result: Vector3): void;
  146126. /**
  146127. * Gets the agent velocity in world space
  146128. * @param index agent index returned by addAgent
  146129. * @returns world space velocity
  146130. */
  146131. getAgentVelocity(index: number): Vector3;
  146132. /**
  146133. * Gets the agent velocity result in world space
  146134. * @param index agent index returned by addAgent
  146135. * @param result output world space velocity
  146136. */
  146137. getAgentVelocityToRef(index: number, result: Vector3): void;
  146138. /**
  146139. * remove a particular agent previously created
  146140. * @param index agent index returned by addAgent
  146141. */
  146142. removeAgent(index: number): void;
  146143. /**
  146144. * get the list of all agents attached to this crowd
  146145. * @returns list of agent indices
  146146. */
  146147. getAgents(): number[];
  146148. /**
  146149. * Tick update done by the Scene. Agent position/velocity/acceleration is updated by this function
  146150. * @param deltaTime in seconds
  146151. */
  146152. update(deltaTime: number): void;
  146153. /**
  146154. * Asks a particular agent to go to a destination. That destination is constrained by the navigation mesh
  146155. * @param index agent index returned by addAgent
  146156. * @param destination targeted world position
  146157. */
  146158. agentGoto(index: number, destination: Vector3): void;
  146159. /**
  146160. * Teleport the agent to a new position
  146161. * @param index agent index returned by addAgent
  146162. * @param destination targeted world position
  146163. */
  146164. agentTeleport(index: number, destination: Vector3): void;
  146165. /**
  146166. * Update agent parameters
  146167. * @param index agent index returned by addAgent
  146168. * @param parameters agent parameters
  146169. */
  146170. updateAgentParameters(index: number, parameters: IAgentParameters): void;
  146171. /**
  146172. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  146173. * The queries will try to find a solution within those bounds
  146174. * default is (1,1,1)
  146175. * @param extent x,y,z value that define the extent around the queries point of reference
  146176. */
  146177. setDefaultQueryExtent(extent: Vector3): void;
  146178. /**
  146179. * Get the Bounding box extent specified by setDefaultQueryExtent
  146180. * @returns the box extent values
  146181. */
  146182. getDefaultQueryExtent(): Vector3;
  146183. /**
  146184. * Get the Bounding box extent result specified by setDefaultQueryExtent
  146185. * @param result output the box extent values
  146186. */
  146187. getDefaultQueryExtentToRef(result: Vector3): void;
  146188. /**
  146189. * Release all resources
  146190. */
  146191. dispose(): void;
  146192. }
  146193. /**
  146194. * Configures an agent
  146195. */
  146196. export interface IAgentParameters {
  146197. /**
  146198. * Agent radius. [Limit: >= 0]
  146199. */
  146200. radius: number;
  146201. /**
  146202. * Agent height. [Limit: > 0]
  146203. */
  146204. height: number;
  146205. /**
  146206. * Maximum allowed acceleration. [Limit: >= 0]
  146207. */
  146208. maxAcceleration: number;
  146209. /**
  146210. * Maximum allowed speed. [Limit: >= 0]
  146211. */
  146212. maxSpeed: number;
  146213. /**
  146214. * Defines how close a collision element must be before it is considered for steering behaviors. [Limits: > 0]
  146215. */
  146216. collisionQueryRange: number;
  146217. /**
  146218. * The path visibility optimization range. [Limit: > 0]
  146219. */
  146220. pathOptimizationRange: number;
  146221. /**
  146222. * How aggresive the agent manager should be at avoiding collisions with this agent. [Limit: >= 0]
  146223. */
  146224. separationWeight: number;
  146225. }
  146226. /**
  146227. * Configures the navigation mesh creation
  146228. */
  146229. export interface INavMeshParameters {
  146230. /**
  146231. * The xz-plane cell size to use for fields. [Limit: > 0] [Units: wu]
  146232. */
  146233. cs: number;
  146234. /**
  146235. * The y-axis cell size to use for fields. [Limit: > 0] [Units: wu]
  146236. */
  146237. ch: number;
  146238. /**
  146239. * The maximum slope that is considered walkable. [Limits: 0 <= value < 90] [Units: Degrees]
  146240. */
  146241. walkableSlopeAngle: number;
  146242. /**
  146243. * Minimum floor to 'ceiling' height that will still allow the floor area to
  146244. * be considered walkable. [Limit: >= 3] [Units: vx]
  146245. */
  146246. walkableHeight: number;
  146247. /**
  146248. * Maximum ledge height that is considered to still be traversable. [Limit: >=0] [Units: vx]
  146249. */
  146250. walkableClimb: number;
  146251. /**
  146252. * The distance to erode/shrink the walkable area of the heightfield away from
  146253. * obstructions. [Limit: >=0] [Units: vx]
  146254. */
  146255. walkableRadius: number;
  146256. /**
  146257. * The maximum allowed length for contour edges along the border of the mesh. [Limit: >=0] [Units: vx]
  146258. */
  146259. maxEdgeLen: number;
  146260. /**
  146261. * The maximum distance a simplfied contour's border edges should deviate
  146262. * the original raw contour. [Limit: >=0] [Units: vx]
  146263. */
  146264. maxSimplificationError: number;
  146265. /**
  146266. * The minimum number of cells allowed to form isolated island areas. [Limit: >=0] [Units: vx]
  146267. */
  146268. minRegionArea: number;
  146269. /**
  146270. * Any regions with a span count smaller than this value will, if possible,
  146271. * be merged with larger regions. [Limit: >=0] [Units: vx]
  146272. */
  146273. mergeRegionArea: number;
  146274. /**
  146275. * The maximum number of vertices allowed for polygons generated during the
  146276. * contour to polygon conversion process. [Limit: >= 3]
  146277. */
  146278. maxVertsPerPoly: number;
  146279. /**
  146280. * Sets the sampling distance to use when generating the detail mesh.
  146281. * (For height detail only.) [Limits: 0 or >= 0.9] [Units: wu]
  146282. */
  146283. detailSampleDist: number;
  146284. /**
  146285. * The maximum distance the detail mesh surface should deviate from heightfield
  146286. * data. (For height detail only.) [Limit: >=0] [Units: wu]
  146287. */
  146288. detailSampleMaxError: number;
  146289. }
  146290. }
  146291. declare module BABYLON {
  146292. /**
  146293. * RecastJS navigation plugin
  146294. */
  146295. export class RecastJSPlugin implements INavigationEnginePlugin {
  146296. /**
  146297. * Reference to the Recast library
  146298. */
  146299. bjsRECAST: any;
  146300. /**
  146301. * plugin name
  146302. */
  146303. name: string;
  146304. /**
  146305. * the first navmesh created. We might extend this to support multiple navmeshes
  146306. */
  146307. navMesh: any;
  146308. /**
  146309. * Initializes the recastJS plugin
  146310. * @param recastInjection can be used to inject your own recast reference
  146311. */
  146312. constructor(recastInjection?: any);
  146313. /**
  146314. * Creates a navigation mesh
  146315. * @param meshes array of all the geometry used to compute the navigatio mesh
  146316. * @param parameters bunch of parameters used to filter geometry
  146317. */
  146318. createNavMesh(meshes: Array<Mesh>, parameters: INavMeshParameters): void;
  146319. /**
  146320. * Create a navigation mesh debug mesh
  146321. * @param scene is where the mesh will be added
  146322. * @returns debug display mesh
  146323. */
  146324. createDebugNavMesh(scene: Scene): Mesh;
  146325. /**
  146326. * Get a navigation mesh constrained position, closest to the parameter position
  146327. * @param position world position
  146328. * @returns the closest point to position constrained by the navigation mesh
  146329. */
  146330. getClosestPoint(position: Vector3): Vector3;
  146331. /**
  146332. * Get a navigation mesh constrained position, closest to the parameter position
  146333. * @param position world position
  146334. * @param result output the closest point to position constrained by the navigation mesh
  146335. */
  146336. getClosestPointToRef(position: Vector3, result: Vector3): void;
  146337. /**
  146338. * Get a navigation mesh constrained position, within a particular radius
  146339. * @param position world position
  146340. * @param maxRadius the maximum distance to the constrained world position
  146341. * @returns the closest point to position constrained by the navigation mesh
  146342. */
  146343. getRandomPointAround(position: Vector3, maxRadius: number): Vector3;
  146344. /**
  146345. * Get a navigation mesh constrained position, within a particular radius
  146346. * @param position world position
  146347. * @param maxRadius the maximum distance to the constrained world position
  146348. * @param result output the closest point to position constrained by the navigation mesh
  146349. */
  146350. getRandomPointAroundToRef(position: Vector3, maxRadius: number, result: Vector3): void;
  146351. /**
  146352. * Compute the final position from a segment made of destination-position
  146353. * @param position world position
  146354. * @param destination world position
  146355. * @returns the resulting point along the navmesh
  146356. */
  146357. moveAlong(position: Vector3, destination: Vector3): Vector3;
  146358. /**
  146359. * Compute the final position from a segment made of destination-position
  146360. * @param position world position
  146361. * @param destination world position
  146362. * @param result output the resulting point along the navmesh
  146363. */
  146364. moveAlongToRef(position: Vector3, destination: Vector3, result: Vector3): void;
  146365. /**
  146366. * Compute a navigation path from start to end. Returns an empty array if no path can be computed
  146367. * @param start world position
  146368. * @param end world position
  146369. * @returns array containing world position composing the path
  146370. */
  146371. computePath(start: Vector3, end: Vector3): Vector3[];
  146372. /**
  146373. * Create a new Crowd so you can add agents
  146374. * @param maxAgents the maximum agent count in the crowd
  146375. * @param maxAgentRadius the maximum radius an agent can have
  146376. * @param scene to attach the crowd to
  146377. * @returns the crowd you can add agents to
  146378. */
  146379. createCrowd(maxAgents: number, maxAgentRadius: number, scene: Scene): ICrowd;
  146380. /**
  146381. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  146382. * The queries will try to find a solution within those bounds
  146383. * default is (1,1,1)
  146384. * @param extent x,y,z value that define the extent around the queries point of reference
  146385. */
  146386. setDefaultQueryExtent(extent: Vector3): void;
  146387. /**
  146388. * Get the Bounding box extent specified by setDefaultQueryExtent
  146389. * @returns the box extent values
  146390. */
  146391. getDefaultQueryExtent(): Vector3;
  146392. /**
  146393. * build the navmesh from a previously saved state using getNavmeshData
  146394. * @param data the Uint8Array returned by getNavmeshData
  146395. */
  146396. buildFromNavmeshData(data: Uint8Array): void;
  146397. /**
  146398. * returns the navmesh data that can be used later. The navmesh must be built before retrieving the data
  146399. * @returns data the Uint8Array that can be saved and reused
  146400. */
  146401. getNavmeshData(): Uint8Array;
  146402. /**
  146403. * Get the Bounding box extent result specified by setDefaultQueryExtent
  146404. * @param result output the box extent values
  146405. */
  146406. getDefaultQueryExtentToRef(result: Vector3): void;
  146407. /**
  146408. * Disposes
  146409. */
  146410. dispose(): void;
  146411. /**
  146412. * If this plugin is supported
  146413. * @returns true if plugin is supported
  146414. */
  146415. isSupported(): boolean;
  146416. }
  146417. /**
  146418. * Recast detour crowd implementation
  146419. */
  146420. export class RecastJSCrowd implements ICrowd {
  146421. /**
  146422. * Recast/detour plugin
  146423. */
  146424. bjsRECASTPlugin: RecastJSPlugin;
  146425. /**
  146426. * Link to the detour crowd
  146427. */
  146428. recastCrowd: any;
  146429. /**
  146430. * One transform per agent
  146431. */
  146432. transforms: TransformNode[];
  146433. /**
  146434. * All agents created
  146435. */
  146436. agents: number[];
  146437. /**
  146438. * Link to the scene is kept to unregister the crowd from the scene
  146439. */
  146440. private _scene;
  146441. /**
  146442. * Observer for crowd updates
  146443. */
  146444. private _onBeforeAnimationsObserver;
  146445. /**
  146446. * Constructor
  146447. * @param plugin recastJS plugin
  146448. * @param maxAgents the maximum agent count in the crowd
  146449. * @param maxAgentRadius the maximum radius an agent can have
  146450. * @param scene to attach the crowd to
  146451. * @returns the crowd you can add agents to
  146452. */
  146453. constructor(plugin: RecastJSPlugin, maxAgents: number, maxAgentRadius: number, scene: Scene);
  146454. /**
  146455. * Add a new agent to the crowd with the specified parameter a corresponding transformNode.
  146456. * You can attach anything to that node. The node position is updated in the scene update tick.
  146457. * @param pos world position that will be constrained by the navigation mesh
  146458. * @param parameters agent parameters
  146459. * @param transform hooked to the agent that will be update by the scene
  146460. * @returns agent index
  146461. */
  146462. addAgent(pos: Vector3, parameters: IAgentParameters, transform: TransformNode): number;
  146463. /**
  146464. * Returns the agent position in world space
  146465. * @param index agent index returned by addAgent
  146466. * @returns world space position
  146467. */
  146468. getAgentPosition(index: number): Vector3;
  146469. /**
  146470. * Returns the agent position result in world space
  146471. * @param index agent index returned by addAgent
  146472. * @param result output world space position
  146473. */
  146474. getAgentPositionToRef(index: number, result: Vector3): void;
  146475. /**
  146476. * Returns the agent velocity in world space
  146477. * @param index agent index returned by addAgent
  146478. * @returns world space velocity
  146479. */
  146480. getAgentVelocity(index: number): Vector3;
  146481. /**
  146482. * Returns the agent velocity result in world space
  146483. * @param index agent index returned by addAgent
  146484. * @param result output world space velocity
  146485. */
  146486. getAgentVelocityToRef(index: number, result: Vector3): void;
  146487. /**
  146488. * Asks a particular agent to go to a destination. That destination is constrained by the navigation mesh
  146489. * @param index agent index returned by addAgent
  146490. * @param destination targeted world position
  146491. */
  146492. agentGoto(index: number, destination: Vector3): void;
  146493. /**
  146494. * Teleport the agent to a new position
  146495. * @param index agent index returned by addAgent
  146496. * @param destination targeted world position
  146497. */
  146498. agentTeleport(index: number, destination: Vector3): void;
  146499. /**
  146500. * Update agent parameters
  146501. * @param index agent index returned by addAgent
  146502. * @param parameters agent parameters
  146503. */
  146504. updateAgentParameters(index: number, parameters: IAgentParameters): void;
  146505. /**
  146506. * remove a particular agent previously created
  146507. * @param index agent index returned by addAgent
  146508. */
  146509. removeAgent(index: number): void;
  146510. /**
  146511. * get the list of all agents attached to this crowd
  146512. * @returns list of agent indices
  146513. */
  146514. getAgents(): number[];
  146515. /**
  146516. * Tick update done by the Scene. Agent position/velocity/acceleration is updated by this function
  146517. * @param deltaTime in seconds
  146518. */
  146519. update(deltaTime: number): void;
  146520. /**
  146521. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  146522. * The queries will try to find a solution within those bounds
  146523. * default is (1,1,1)
  146524. * @param extent x,y,z value that define the extent around the queries point of reference
  146525. */
  146526. setDefaultQueryExtent(extent: Vector3): void;
  146527. /**
  146528. * Get the Bounding box extent specified by setDefaultQueryExtent
  146529. * @returns the box extent values
  146530. */
  146531. getDefaultQueryExtent(): Vector3;
  146532. /**
  146533. * Get the Bounding box extent result specified by setDefaultQueryExtent
  146534. * @param result output the box extent values
  146535. */
  146536. getDefaultQueryExtentToRef(result: Vector3): void;
  146537. /**
  146538. * Release all resources
  146539. */
  146540. dispose(): void;
  146541. }
  146542. }
  146543. declare module BABYLON {
  146544. /**
  146545. * Class used to enable access to IndexedDB
  146546. * @see https://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  146547. */
  146548. export class Database implements IOfflineProvider {
  146549. private _callbackManifestChecked;
  146550. private _currentSceneUrl;
  146551. private _db;
  146552. private _enableSceneOffline;
  146553. private _enableTexturesOffline;
  146554. private _manifestVersionFound;
  146555. private _mustUpdateRessources;
  146556. private _hasReachedQuota;
  146557. private _isSupported;
  146558. private _idbFactory;
  146559. /** Gets a boolean indicating if the user agent supports blob storage (this value will be updated after creating the first Database object) */
  146560. private static IsUASupportingBlobStorage;
  146561. /**
  146562. * Gets a boolean indicating if Database storate is enabled (off by default)
  146563. */
  146564. static IDBStorageEnabled: boolean;
  146565. /**
  146566. * Gets a boolean indicating if scene must be saved in the database
  146567. */
  146568. get enableSceneOffline(): boolean;
  146569. /**
  146570. * Gets a boolean indicating if textures must be saved in the database
  146571. */
  146572. get enableTexturesOffline(): boolean;
  146573. /**
  146574. * Creates a new Database
  146575. * @param urlToScene defines the url to load the scene
  146576. * @param callbackManifestChecked defines the callback to use when manifest is checked
  146577. * @param disableManifestCheck defines a boolean indicating that we want to skip the manifest validation (it will be considered validated and up to date)
  146578. */
  146579. constructor(urlToScene: string, callbackManifestChecked: (checked: boolean) => any, disableManifestCheck?: boolean);
  146580. private static _ParseURL;
  146581. private static _ReturnFullUrlLocation;
  146582. private _checkManifestFile;
  146583. /**
  146584. * Open the database and make it available
  146585. * @param successCallback defines the callback to call on success
  146586. * @param errorCallback defines the callback to call on error
  146587. */
  146588. open(successCallback: () => void, errorCallback: () => void): void;
  146589. /**
  146590. * Loads an image from the database
  146591. * @param url defines the url to load from
  146592. * @param image defines the target DOM image
  146593. */
  146594. loadImage(url: string, image: HTMLImageElement): void;
  146595. private _loadImageFromDBAsync;
  146596. private _saveImageIntoDBAsync;
  146597. private _checkVersionFromDB;
  146598. private _loadVersionFromDBAsync;
  146599. private _saveVersionIntoDBAsync;
  146600. /**
  146601. * Loads a file from database
  146602. * @param url defines the URL to load from
  146603. * @param sceneLoaded defines a callback to call on success
  146604. * @param progressCallBack defines a callback to call when progress changed
  146605. * @param errorCallback defines a callback to call on error
  146606. * @param useArrayBuffer defines a boolean to use array buffer instead of text string
  146607. */
  146608. loadFile(url: string, sceneLoaded: (data: any) => void, progressCallBack?: (data: any) => void, errorCallback?: () => void, useArrayBuffer?: boolean): void;
  146609. private _loadFileAsync;
  146610. private _saveFileAsync;
  146611. /**
  146612. * Validates if xhr data is correct
  146613. * @param xhr defines the request to validate
  146614. * @param dataType defines the expected data type
  146615. * @returns true if data is correct
  146616. */
  146617. private static _ValidateXHRData;
  146618. }
  146619. }
  146620. declare module BABYLON {
  146621. /** @hidden */
  146622. export var gpuUpdateParticlesPixelShader: {
  146623. name: string;
  146624. shader: string;
  146625. };
  146626. }
  146627. declare module BABYLON {
  146628. /** @hidden */
  146629. export var gpuUpdateParticlesVertexShader: {
  146630. name: string;
  146631. shader: string;
  146632. };
  146633. }
  146634. declare module BABYLON {
  146635. /** @hidden */
  146636. export var clipPlaneFragmentDeclaration2: {
  146637. name: string;
  146638. shader: string;
  146639. };
  146640. }
  146641. declare module BABYLON {
  146642. /** @hidden */
  146643. export var gpuRenderParticlesPixelShader: {
  146644. name: string;
  146645. shader: string;
  146646. };
  146647. }
  146648. declare module BABYLON {
  146649. /** @hidden */
  146650. export var clipPlaneVertexDeclaration2: {
  146651. name: string;
  146652. shader: string;
  146653. };
  146654. }
  146655. declare module BABYLON {
  146656. /** @hidden */
  146657. export var gpuRenderParticlesVertexShader: {
  146658. name: string;
  146659. shader: string;
  146660. };
  146661. }
  146662. declare module BABYLON {
  146663. /**
  146664. * This represents a GPU particle system in Babylon
  146665. * This is the fastest particle system in Babylon as it uses the GPU to update the individual particle data
  146666. * @see https://www.babylonjs-playground.com/#PU4WYI#4
  146667. */
  146668. export class GPUParticleSystem extends BaseParticleSystem implements IDisposable, IParticleSystem, IAnimatable {
  146669. /**
  146670. * The layer mask we are rendering the particles through.
  146671. */
  146672. layerMask: number;
  146673. private _capacity;
  146674. private _activeCount;
  146675. private _currentActiveCount;
  146676. private _accumulatedCount;
  146677. private _renderEffect;
  146678. private _updateEffect;
  146679. private _buffer0;
  146680. private _buffer1;
  146681. private _spriteBuffer;
  146682. private _updateVAO;
  146683. private _renderVAO;
  146684. private _targetIndex;
  146685. private _sourceBuffer;
  146686. private _targetBuffer;
  146687. private _currentRenderId;
  146688. private _started;
  146689. private _stopped;
  146690. private _timeDelta;
  146691. private _randomTexture;
  146692. private _randomTexture2;
  146693. private _attributesStrideSize;
  146694. private _updateEffectOptions;
  146695. private _randomTextureSize;
  146696. private _actualFrame;
  146697. private _customEffect;
  146698. private readonly _rawTextureWidth;
  146699. /**
  146700. * Gets a boolean indicating if the GPU particles can be rendered on current browser
  146701. */
  146702. static get IsSupported(): boolean;
  146703. /**
  146704. * An event triggered when the system is disposed.
  146705. */
  146706. onDisposeObservable: Observable<IParticleSystem>;
  146707. /**
  146708. * Gets the maximum number of particles active at the same time.
  146709. * @returns The max number of active particles.
  146710. */
  146711. getCapacity(): number;
  146712. /**
  146713. * Forces the particle to write their depth information to the depth buffer. This can help preventing other draw calls
  146714. * to override the particles.
  146715. */
  146716. forceDepthWrite: boolean;
  146717. /**
  146718. * Gets or set the number of active particles
  146719. */
  146720. get activeParticleCount(): number;
  146721. set activeParticleCount(value: number);
  146722. private _preWarmDone;
  146723. /**
  146724. * Specifies if the particles are updated in emitter local space or world space.
  146725. */
  146726. isLocal: boolean;
  146727. /** Gets or sets a matrix to use to compute projection */
  146728. defaultProjectionMatrix: Matrix;
  146729. /**
  146730. * Is this system ready to be used/rendered
  146731. * @return true if the system is ready
  146732. */
  146733. isReady(): boolean;
  146734. /**
  146735. * Gets if the system has been started. (Note: this will still be true after stop is called)
  146736. * @returns True if it has been started, otherwise false.
  146737. */
  146738. isStarted(): boolean;
  146739. /**
  146740. * Gets if the system has been stopped. (Note: rendering is still happening but the system is frozen)
  146741. * @returns True if it has been stopped, otherwise false.
  146742. */
  146743. isStopped(): boolean;
  146744. /**
  146745. * Gets a boolean indicating that the system is stopping
  146746. * @returns true if the system is currently stopping
  146747. */
  146748. isStopping(): boolean;
  146749. /**
  146750. * Gets the number of particles active at the same time.
  146751. * @returns The number of active particles.
  146752. */
  146753. getActiveCount(): number;
  146754. /**
  146755. * Starts the particle system and begins to emit
  146756. * @param delay defines the delay in milliseconds before starting the system (this.startDelay by default)
  146757. */
  146758. start(delay?: number): void;
  146759. /**
  146760. * Stops the particle system.
  146761. */
  146762. stop(): void;
  146763. /**
  146764. * Remove all active particles
  146765. */
  146766. reset(): void;
  146767. /**
  146768. * Returns the string "GPUParticleSystem"
  146769. * @returns a string containing the class name
  146770. */
  146771. getClassName(): string;
  146772. /**
  146773. * Gets the custom effect used to render the particles
  146774. * @param blendMode Blend mode for which the effect should be retrieved
  146775. * @returns The effect
  146776. */
  146777. getCustomEffect(blendMode?: number): Nullable<Effect>;
  146778. /**
  146779. * Sets the custom effect used to render the particles
  146780. * @param effect The effect to set
  146781. * @param blendMode Blend mode for which the effect should be set
  146782. */
  146783. setCustomEffect(effect: Nullable<Effect>, blendMode?: number): void;
  146784. /** @hidden */
  146785. protected _onBeforeDrawParticlesObservable: Nullable<Observable<Nullable<Effect>>>;
  146786. /**
  146787. * Observable that will be called just before the particles are drawn
  146788. */
  146789. get onBeforeDrawParticlesObservable(): Observable<Nullable<Effect>>;
  146790. /**
  146791. * Gets the name of the particle vertex shader
  146792. */
  146793. get vertexShaderName(): string;
  146794. private _colorGradientsTexture;
  146795. protected _removeGradientAndTexture(gradient: number, gradients: Nullable<IValueGradient[]>, texture: RawTexture): BaseParticleSystem;
  146796. /**
  146797. * Adds a new color gradient
  146798. * @param gradient defines the gradient to use (between 0 and 1)
  146799. * @param color1 defines the color to affect to the specified gradient
  146800. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  146801. * @returns the current particle system
  146802. */
  146803. addColorGradient(gradient: number, color1: Color4, color2?: Color4): GPUParticleSystem;
  146804. private _refreshColorGradient;
  146805. /** Force the system to rebuild all gradients that need to be resync */
  146806. forceRefreshGradients(): void;
  146807. /**
  146808. * Remove a specific color gradient
  146809. * @param gradient defines the gradient to remove
  146810. * @returns the current particle system
  146811. */
  146812. removeColorGradient(gradient: number): GPUParticleSystem;
  146813. private _angularSpeedGradientsTexture;
  146814. private _sizeGradientsTexture;
  146815. private _velocityGradientsTexture;
  146816. private _limitVelocityGradientsTexture;
  146817. private _dragGradientsTexture;
  146818. private _addFactorGradient;
  146819. /**
  146820. * Adds a new size gradient
  146821. * @param gradient defines the gradient to use (between 0 and 1)
  146822. * @param factor defines the size factor to affect to the specified gradient
  146823. * @returns the current particle system
  146824. */
  146825. addSizeGradient(gradient: number, factor: number): GPUParticleSystem;
  146826. /**
  146827. * Remove a specific size gradient
  146828. * @param gradient defines the gradient to remove
  146829. * @returns the current particle system
  146830. */
  146831. removeSizeGradient(gradient: number): GPUParticleSystem;
  146832. private _refreshFactorGradient;
  146833. /**
  146834. * Adds a new angular speed gradient
  146835. * @param gradient defines the gradient to use (between 0 and 1)
  146836. * @param factor defines the angular speed to affect to the specified gradient
  146837. * @returns the current particle system
  146838. */
  146839. addAngularSpeedGradient(gradient: number, factor: number): GPUParticleSystem;
  146840. /**
  146841. * Remove a specific angular speed gradient
  146842. * @param gradient defines the gradient to remove
  146843. * @returns the current particle system
  146844. */
  146845. removeAngularSpeedGradient(gradient: number): GPUParticleSystem;
  146846. /**
  146847. * Adds a new velocity gradient
  146848. * @param gradient defines the gradient to use (between 0 and 1)
  146849. * @param factor defines the velocity to affect to the specified gradient
  146850. * @returns the current particle system
  146851. */
  146852. addVelocityGradient(gradient: number, factor: number): GPUParticleSystem;
  146853. /**
  146854. * Remove a specific velocity gradient
  146855. * @param gradient defines the gradient to remove
  146856. * @returns the current particle system
  146857. */
  146858. removeVelocityGradient(gradient: number): GPUParticleSystem;
  146859. /**
  146860. * Adds a new limit velocity gradient
  146861. * @param gradient defines the gradient to use (between 0 and 1)
  146862. * @param factor defines the limit velocity value to affect to the specified gradient
  146863. * @returns the current particle system
  146864. */
  146865. addLimitVelocityGradient(gradient: number, factor: number): GPUParticleSystem;
  146866. /**
  146867. * Remove a specific limit velocity gradient
  146868. * @param gradient defines the gradient to remove
  146869. * @returns the current particle system
  146870. */
  146871. removeLimitVelocityGradient(gradient: number): GPUParticleSystem;
  146872. /**
  146873. * Adds a new drag gradient
  146874. * @param gradient defines the gradient to use (between 0 and 1)
  146875. * @param factor defines the drag value to affect to the specified gradient
  146876. * @returns the current particle system
  146877. */
  146878. addDragGradient(gradient: number, factor: number): GPUParticleSystem;
  146879. /**
  146880. * Remove a specific drag gradient
  146881. * @param gradient defines the gradient to remove
  146882. * @returns the current particle system
  146883. */
  146884. removeDragGradient(gradient: number): GPUParticleSystem;
  146885. /**
  146886. * Not supported by GPUParticleSystem
  146887. * @param gradient defines the gradient to use (between 0 and 1)
  146888. * @param factor defines the emit rate value to affect to the specified gradient
  146889. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  146890. * @returns the current particle system
  146891. */
  146892. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  146893. /**
  146894. * Not supported by GPUParticleSystem
  146895. * @param gradient defines the gradient to remove
  146896. * @returns the current particle system
  146897. */
  146898. removeEmitRateGradient(gradient: number): IParticleSystem;
  146899. /**
  146900. * Not supported by GPUParticleSystem
  146901. * @param gradient defines the gradient to use (between 0 and 1)
  146902. * @param factor defines the start size value to affect to the specified gradient
  146903. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  146904. * @returns the current particle system
  146905. */
  146906. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  146907. /**
  146908. * Not supported by GPUParticleSystem
  146909. * @param gradient defines the gradient to remove
  146910. * @returns the current particle system
  146911. */
  146912. removeStartSizeGradient(gradient: number): IParticleSystem;
  146913. /**
  146914. * Not supported by GPUParticleSystem
  146915. * @param gradient defines the gradient to use (between 0 and 1)
  146916. * @param min defines the color remap minimal range
  146917. * @param max defines the color remap maximal range
  146918. * @returns the current particle system
  146919. */
  146920. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  146921. /**
  146922. * Not supported by GPUParticleSystem
  146923. * @param gradient defines the gradient to remove
  146924. * @returns the current particle system
  146925. */
  146926. removeColorRemapGradient(): IParticleSystem;
  146927. /**
  146928. * Not supported by GPUParticleSystem
  146929. * @param gradient defines the gradient to use (between 0 and 1)
  146930. * @param min defines the alpha remap minimal range
  146931. * @param max defines the alpha remap maximal range
  146932. * @returns the current particle system
  146933. */
  146934. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  146935. /**
  146936. * Not supported by GPUParticleSystem
  146937. * @param gradient defines the gradient to remove
  146938. * @returns the current particle system
  146939. */
  146940. removeAlphaRemapGradient(): IParticleSystem;
  146941. /**
  146942. * Not supported by GPUParticleSystem
  146943. * @param gradient defines the gradient to use (between 0 and 1)
  146944. * @param color defines the color to affect to the specified gradient
  146945. * @returns the current particle system
  146946. */
  146947. addRampGradient(gradient: number, color: Color3): IParticleSystem;
  146948. /**
  146949. * Not supported by GPUParticleSystem
  146950. * @param gradient defines the gradient to remove
  146951. * @returns the current particle system
  146952. */
  146953. removeRampGradient(): IParticleSystem;
  146954. /**
  146955. * Not supported by GPUParticleSystem
  146956. * @returns the list of ramp gradients
  146957. */
  146958. getRampGradients(): Nullable<Array<Color3Gradient>>;
  146959. /**
  146960. * Not supported by GPUParticleSystem
  146961. * Gets or sets a boolean indicating that ramp gradients must be used
  146962. * @see https://doc.babylonjs.com/babylon101/particles#ramp-gradients
  146963. */
  146964. get useRampGradients(): boolean;
  146965. set useRampGradients(value: boolean);
  146966. /**
  146967. * Not supported by GPUParticleSystem
  146968. * @param gradient defines the gradient to use (between 0 and 1)
  146969. * @param factor defines the life time factor to affect to the specified gradient
  146970. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  146971. * @returns the current particle system
  146972. */
  146973. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  146974. /**
  146975. * Not supported by GPUParticleSystem
  146976. * @param gradient defines the gradient to remove
  146977. * @returns the current particle system
  146978. */
  146979. removeLifeTimeGradient(gradient: number): IParticleSystem;
  146980. /**
  146981. * Instantiates a GPU particle system.
  146982. * 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.
  146983. * @param name The name of the particle system
  146984. * @param options The options used to create the system
  146985. * @param sceneOrEngine The scene the particle system belongs to or the engine to use if no scene
  146986. * @param isAnimationSheetEnabled Must be true if using a spritesheet to animate the particles texture
  146987. * @param customEffect a custom effect used to change the way particles are rendered by default
  146988. */
  146989. constructor(name: string, options: Partial<{
  146990. capacity: number;
  146991. randomTextureSize: number;
  146992. }>, sceneOrEngine: Scene | ThinEngine, isAnimationSheetEnabled?: boolean, customEffect?: Nullable<Effect>);
  146993. protected _reset(): void;
  146994. private _createUpdateVAO;
  146995. private _createRenderVAO;
  146996. private _initialize;
  146997. /** @hidden */
  146998. _recreateUpdateEffect(): void;
  146999. private _getEffect;
  147000. /**
  147001. * Fill the defines array according to the current settings of the particle system
  147002. * @param defines Array to be updated
  147003. * @param blendMode blend mode to take into account when updating the array
  147004. */
  147005. fillDefines(defines: Array<string>, blendMode?: number): void;
  147006. /**
  147007. * Fill the uniforms, attributes and samplers arrays according to the current settings of the particle system
  147008. * @param uniforms Uniforms array to fill
  147009. * @param attributes Attributes array to fill
  147010. * @param samplers Samplers array to fill
  147011. */
  147012. fillUniformsAttributesAndSamplerNames(uniforms: Array<string>, attributes: Array<string>, samplers: Array<string>): void;
  147013. /** @hidden */
  147014. _recreateRenderEffect(): Effect;
  147015. /**
  147016. * Animates the particle system for the current frame by emitting new particles and or animating the living ones.
  147017. * @param preWarm defines if we are in the pre-warmimg phase
  147018. */
  147019. animate(preWarm?: boolean): void;
  147020. private _createFactorGradientTexture;
  147021. private _createSizeGradientTexture;
  147022. private _createAngularSpeedGradientTexture;
  147023. private _createVelocityGradientTexture;
  147024. private _createLimitVelocityGradientTexture;
  147025. private _createDragGradientTexture;
  147026. private _createColorGradientTexture;
  147027. /**
  147028. * Renders the particle system in its current state
  147029. * @param preWarm defines if the system should only update the particles but not render them
  147030. * @returns the current number of particles
  147031. */
  147032. render(preWarm?: boolean): number;
  147033. /**
  147034. * Rebuilds the particle system
  147035. */
  147036. rebuild(): void;
  147037. private _releaseBuffers;
  147038. private _releaseVAOs;
  147039. /**
  147040. * Disposes the particle system and free the associated resources
  147041. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  147042. */
  147043. dispose(disposeTexture?: boolean): void;
  147044. /**
  147045. * Clones the particle system.
  147046. * @param name The name of the cloned object
  147047. * @param newEmitter The new emitter to use
  147048. * @returns the cloned particle system
  147049. */
  147050. clone(name: string, newEmitter: any): GPUParticleSystem;
  147051. /**
  147052. * Serializes the particle system to a JSON object
  147053. * @param serializeTexture defines if the texture must be serialized as well
  147054. * @returns the JSON object
  147055. */
  147056. serialize(serializeTexture?: boolean): any;
  147057. /**
  147058. * Parses a JSON object to create a GPU particle system.
  147059. * @param parsedParticleSystem The JSON object to parse
  147060. * @param sceneOrEngine The scene or the engine to create the particle system in
  147061. * @param rootUrl The root url to use to load external dependencies like texture
  147062. * @param doNotStart Ignore the preventAutoStart attribute and does not start
  147063. * @returns the parsed GPU particle system
  147064. */
  147065. static Parse(parsedParticleSystem: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string, doNotStart?: boolean): GPUParticleSystem;
  147066. }
  147067. }
  147068. declare module BABYLON {
  147069. /**
  147070. * Represents a set of particle systems working together to create a specific effect
  147071. */
  147072. export class ParticleSystemSet implements IDisposable {
  147073. /**
  147074. * Gets or sets base Assets URL
  147075. */
  147076. static BaseAssetsUrl: string;
  147077. private _emitterCreationOptions;
  147078. private _emitterNode;
  147079. /**
  147080. * Gets the particle system list
  147081. */
  147082. systems: IParticleSystem[];
  147083. /**
  147084. * Gets the emitter node used with this set
  147085. */
  147086. get emitterNode(): Nullable<TransformNode>;
  147087. /**
  147088. * Creates a new emitter mesh as a sphere
  147089. * @param options defines the options used to create the sphere
  147090. * @param renderingGroupId defines the renderingGroupId to use for the sphere
  147091. * @param scene defines the hosting scene
  147092. */
  147093. setEmitterAsSphere(options: {
  147094. diameter: number;
  147095. segments: number;
  147096. color: Color3;
  147097. }, renderingGroupId: number, scene: Scene): void;
  147098. /**
  147099. * Starts all particle systems of the set
  147100. * @param emitter defines an optional mesh to use as emitter for the particle systems
  147101. */
  147102. start(emitter?: AbstractMesh): void;
  147103. /**
  147104. * Release all associated resources
  147105. */
  147106. dispose(): void;
  147107. /**
  147108. * Serialize the set into a JSON compatible object
  147109. * @param serializeTexture defines if the texture must be serialized as well
  147110. * @returns a JSON compatible representation of the set
  147111. */
  147112. serialize(serializeTexture?: boolean): any;
  147113. /**
  147114. * Parse a new ParticleSystemSet from a serialized source
  147115. * @param data defines a JSON compatible representation of the set
  147116. * @param scene defines the hosting scene
  147117. * @param gpu defines if we want GPU particles or CPU particles
  147118. * @returns a new ParticleSystemSet
  147119. */
  147120. static Parse(data: any, scene: Scene, gpu?: boolean): ParticleSystemSet;
  147121. }
  147122. }
  147123. declare module BABYLON {
  147124. /**
  147125. * This class is made for on one-liner static method to help creating particle system set.
  147126. */
  147127. export class ParticleHelper {
  147128. /**
  147129. * Gets or sets base Assets URL
  147130. */
  147131. static BaseAssetsUrl: string;
  147132. /** Define the Url to load snippets */
  147133. static SnippetUrl: string;
  147134. /**
  147135. * Create a default particle system that you can tweak
  147136. * @param emitter defines the emitter to use
  147137. * @param capacity defines the system capacity (default is 500 particles)
  147138. * @param scene defines the hosting scene
  147139. * @param useGPU defines if a GPUParticleSystem must be created (default is false)
  147140. * @returns the new Particle system
  147141. */
  147142. static CreateDefault(emitter: Nullable<AbstractMesh | Vector3>, capacity?: number, scene?: Scene, useGPU?: boolean): IParticleSystem;
  147143. /**
  147144. * This is the main static method (one-liner) of this helper to create different particle systems
  147145. * @param type This string represents the type to the particle system to create
  147146. * @param scene The scene where the particle system should live
  147147. * @param gpu If the system will use gpu
  147148. * @returns the ParticleSystemSet created
  147149. */
  147150. static CreateAsync(type: string, scene: Nullable<Scene>, gpu?: boolean): Promise<ParticleSystemSet>;
  147151. /**
  147152. * Static function used to export a particle system to a ParticleSystemSet variable.
  147153. * Please note that the emitter shape is not exported
  147154. * @param systems defines the particle systems to export
  147155. * @returns the created particle system set
  147156. */
  147157. static ExportSet(systems: IParticleSystem[]): ParticleSystemSet;
  147158. /**
  147159. * Creates a particle system from a snippet saved in a remote file
  147160. * @param name defines the name of the particle system to create (can be null or empty to use the one from the json data)
  147161. * @param url defines the url to load from
  147162. * @param scene defines the hosting scene
  147163. * @param gpu If the system will use gpu
  147164. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  147165. * @returns a promise that will resolve to the new particle system
  147166. */
  147167. static ParseFromFileAsync(name: Nullable<string>, url: string, scene: Scene, gpu?: boolean, rootUrl?: string): Promise<IParticleSystem>;
  147168. /**
  147169. * Creates a particle system from a snippet saved by the particle system editor
  147170. * @param snippetId defines the snippet to load (can be set to _BLANK to create a default one)
  147171. * @param scene defines the hosting scene
  147172. * @param gpu If the system will use gpu
  147173. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  147174. * @returns a promise that will resolve to the new particle system
  147175. */
  147176. static CreateFromSnippetAsync(snippetId: string, scene: Scene, gpu?: boolean, rootUrl?: string): Promise<IParticleSystem>;
  147177. }
  147178. }
  147179. declare module BABYLON {
  147180. interface Engine {
  147181. /**
  147182. * Create an effect to use with particle systems.
  147183. * Please note that some parameters like animation sheets or not being billboard are not supported in this configuration, except if you pass
  147184. * the particle system for which you want to create a custom effect in the last parameter
  147185. * @param fragmentName defines the base name of the effect (The name of file without .fragment.fx)
  147186. * @param uniformsNames defines a list of attribute names
  147187. * @param samplers defines an array of string used to represent textures
  147188. * @param defines defines the string containing the defines to use to compile the shaders
  147189. * @param fallbacks defines the list of potential fallbacks to use if shader conmpilation fails
  147190. * @param onCompiled defines a function to call when the effect creation is successful
  147191. * @param onError defines a function to call when the effect creation has failed
  147192. * @param particleSystem the particle system you want to create the effect for
  147193. * @returns the new Effect
  147194. */
  147195. createEffectForParticles(fragmentName: string, uniformsNames: string[], samplers: string[], defines: string, fallbacks?: EffectFallbacks, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void, particleSystem?: IParticleSystem): Effect;
  147196. }
  147197. interface Mesh {
  147198. /**
  147199. * Returns an array populated with IParticleSystem objects whose the mesh is the emitter
  147200. * @returns an array of IParticleSystem
  147201. */
  147202. getEmittedParticleSystems(): IParticleSystem[];
  147203. /**
  147204. * Returns an array populated with IParticleSystem objects whose the mesh or its children are the emitter
  147205. * @returns an array of IParticleSystem
  147206. */
  147207. getHierarchyEmittedParticleSystems(): IParticleSystem[];
  147208. }
  147209. }
  147210. declare module BABYLON {
  147211. /** Defines the 4 color options */
  147212. export enum PointColor {
  147213. /** color value */
  147214. Color = 2,
  147215. /** uv value */
  147216. UV = 1,
  147217. /** random value */
  147218. Random = 0,
  147219. /** stated value */
  147220. Stated = 3
  147221. }
  147222. /**
  147223. * The PointCloudSystem (PCS) is a single updatable mesh. The points corresponding to the vertices of this big mesh.
  147224. * 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.
  147225. * The PointCloudSytem is also a particle system, with each point being a particle. It provides some methods to manage the particles.
  147226. * However it is behavior agnostic. This means it has no emitter, no particle physics, no particle recycler. You have to implement your own behavior.
  147227. *
  147228. * Full documentation here : TO BE ENTERED
  147229. */
  147230. export class PointsCloudSystem implements IDisposable {
  147231. /**
  147232. * The PCS array of cloud point objects. Just access each particle as with any classic array.
  147233. * Example : var p = SPS.particles[i];
  147234. */
  147235. particles: CloudPoint[];
  147236. /**
  147237. * The PCS total number of particles. Read only. Use PCS.counter instead if you need to set your own value.
  147238. */
  147239. nbParticles: number;
  147240. /**
  147241. * This a counter for your own usage. It's not set by any SPS functions.
  147242. */
  147243. counter: number;
  147244. /**
  147245. * The PCS name. This name is also given to the underlying mesh.
  147246. */
  147247. name: string;
  147248. /**
  147249. * The PCS mesh. It's a standard BJS Mesh, so all the methods from the Mesh class are avalaible.
  147250. */
  147251. mesh: Mesh;
  147252. /**
  147253. * This empty object is intended to store some PCS specific or temporary values in order to lower the Garbage Collector activity.
  147254. * Please read :
  147255. */
  147256. vars: any;
  147257. /**
  147258. * @hidden
  147259. */
  147260. _size: number;
  147261. private _scene;
  147262. private _promises;
  147263. private _positions;
  147264. private _indices;
  147265. private _normals;
  147266. private _colors;
  147267. private _uvs;
  147268. private _indices32;
  147269. private _positions32;
  147270. private _colors32;
  147271. private _uvs32;
  147272. private _updatable;
  147273. private _isVisibilityBoxLocked;
  147274. private _alwaysVisible;
  147275. private _groups;
  147276. private _groupCounter;
  147277. private _computeParticleColor;
  147278. private _computeParticleTexture;
  147279. private _computeParticleRotation;
  147280. private _computeBoundingBox;
  147281. private _isReady;
  147282. /**
  147283. * Creates a PCS (Points Cloud System) object
  147284. * @param name (String) is the PCS name, this will be the underlying mesh name
  147285. * @param pointSize (number) is the size for each point
  147286. * @param scene (Scene) is the scene in which the PCS is added
  147287. * @param options defines the options of the PCS e.g.
  147288. * * updatable (optional boolean, default true) : if the PCS must be updatable or immutable
  147289. */
  147290. constructor(name: string, pointSize: number, scene: Scene, options?: {
  147291. updatable?: boolean;
  147292. });
  147293. /**
  147294. * Builds the PCS underlying mesh. Returns a standard Mesh.
  147295. * If no points were added to the PCS, the returned mesh is just a single point.
  147296. * @returns a promise for the created mesh
  147297. */
  147298. buildMeshAsync(): Promise<Mesh>;
  147299. /**
  147300. * @hidden
  147301. */
  147302. private _buildMesh;
  147303. private _addParticle;
  147304. private _randomUnitVector;
  147305. private _getColorIndicesForCoord;
  147306. private _setPointsColorOrUV;
  147307. private _colorFromTexture;
  147308. private _calculateDensity;
  147309. /**
  147310. * Adds points to the PCS in random positions within a unit sphere
  147311. * @param nb (positive integer) the number of particles to be created from this model
  147312. * @param pointFunction is an optional javascript function to be called for each particle on PCS creation
  147313. * @returns the number of groups in the system
  147314. */
  147315. addPoints(nb: number, pointFunction?: any): number;
  147316. /**
  147317. * Adds points to the PCS from the surface of the model shape
  147318. * @param mesh is any Mesh object that will be used as a surface model for the points
  147319. * @param nb (positive integer) the number of particles to be created from this model
  147320. * @param colorWith determines whether a point is colored using color (default), uv, random, stated or none (invisible)
  147321. * @param color (color4) to be used when colorWith is stated or color (number) when used to specify texture position
  147322. * @param range (number from 0 to 1) to determine the variation in shape and tone for a stated color
  147323. * @returns the number of groups in the system
  147324. */
  147325. addSurfacePoints(mesh: Mesh, nb: number, colorWith?: number, color?: Color4 | number, range?: number): number;
  147326. /**
  147327. * Adds points to the PCS inside the model shape
  147328. * @param mesh is any Mesh object that will be used as a surface model for the points
  147329. * @param nb (positive integer) the number of particles to be created from this model
  147330. * @param colorWith determines whether a point is colored using color (default), uv, random, stated or none (invisible)
  147331. * @param color (color4) to be used when colorWith is stated or color (number) when used to specify texture position
  147332. * @param range (number from 0 to 1) to determine the variation in shape and tone for a stated color
  147333. * @returns the number of groups in the system
  147334. */
  147335. addVolumePoints(mesh: Mesh, nb: number, colorWith?: number, color?: Color4 | number, range?: number): number;
  147336. /**
  147337. * Sets all the particles : this method actually really updates the mesh according to the particle positions, rotations, colors, textures, etc.
  147338. * This method calls `updateParticle()` for each particle of the SPS.
  147339. * For an animated SPS, it is usually called within the render loop.
  147340. * @param start The particle index in the particle array where to start to compute the particle property values _(default 0)_
  147341. * @param end The particle index in the particle array where to stop to compute the particle property values _(default nbParticle - 1)_
  147342. * @param update If the mesh must be finally updated on this call after all the particle computations _(default true)_
  147343. * @returns the PCS.
  147344. */
  147345. setParticles(start?: number, end?: number, update?: boolean): PointsCloudSystem;
  147346. /**
  147347. * Disposes the PCS.
  147348. */
  147349. dispose(): void;
  147350. /**
  147351. * Visibilty helper : Recomputes the visible size according to the mesh bounding box
  147352. * doc :
  147353. * @returns the PCS.
  147354. */
  147355. refreshVisibleSize(): PointsCloudSystem;
  147356. /**
  147357. * Visibility helper : Sets the size of a visibility box, this sets the underlying mesh bounding box.
  147358. * @param size the size (float) of the visibility box
  147359. * note : this doesn't lock the PCS mesh bounding box.
  147360. * doc :
  147361. */
  147362. setVisibilityBox(size: number): void;
  147363. /**
  147364. * Gets whether the PCS is always visible or not
  147365. * doc :
  147366. */
  147367. get isAlwaysVisible(): boolean;
  147368. /**
  147369. * Sets the PCS as always visible or not
  147370. * doc :
  147371. */
  147372. set isAlwaysVisible(val: boolean);
  147373. /**
  147374. * Tells to `setParticles()` to compute the particle rotations or not
  147375. * Default value : false. The PCS is faster when it's set to false
  147376. * Note : particle rotations are only applied to parent particles
  147377. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate
  147378. */
  147379. set computeParticleRotation(val: boolean);
  147380. /**
  147381. * Tells to `setParticles()` to compute the particle colors or not.
  147382. * Default value : true. The PCS is faster when it's set to false.
  147383. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  147384. */
  147385. set computeParticleColor(val: boolean);
  147386. set computeParticleTexture(val: boolean);
  147387. /**
  147388. * Gets if `setParticles()` computes the particle colors or not.
  147389. * Default value : false. The PCS is faster when it's set to false.
  147390. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  147391. */
  147392. get computeParticleColor(): boolean;
  147393. /**
  147394. * Gets if `setParticles()` computes the particle textures or not.
  147395. * Default value : false. The PCS is faster when it's set to false.
  147396. * Note : the particle textures are stored values, so setting `computeParticleTexture` to false will keep yet the last colors set.
  147397. */
  147398. get computeParticleTexture(): boolean;
  147399. /**
  147400. * Tells to `setParticles()` to compute or not the mesh bounding box when computing the particle positions.
  147401. */
  147402. set computeBoundingBox(val: boolean);
  147403. /**
  147404. * Gets if `setParticles()` computes or not the mesh bounding box when computing the particle positions.
  147405. */
  147406. get computeBoundingBox(): boolean;
  147407. /**
  147408. * This function does nothing. It may be overwritten to set all the particle first values.
  147409. * The PCS doesn't call this function, you may have to call it by your own.
  147410. * doc :
  147411. */
  147412. initParticles(): void;
  147413. /**
  147414. * This function does nothing. It may be overwritten to recycle a particle
  147415. * The PCS doesn't call this function, you can to call it
  147416. * doc :
  147417. * @param particle The particle to recycle
  147418. * @returns the recycled particle
  147419. */
  147420. recycleParticle(particle: CloudPoint): CloudPoint;
  147421. /**
  147422. * Updates a particle : this function should be overwritten by the user.
  147423. * It is called on each particle by `setParticles()`. This is the place to code each particle behavior.
  147424. * doc :
  147425. * @example : just set a particle position or velocity and recycle conditions
  147426. * @param particle The particle to update
  147427. * @returns the updated particle
  147428. */
  147429. updateParticle(particle: CloudPoint): CloudPoint;
  147430. /**
  147431. * This will be called before any other treatment by `setParticles()` and will be passed three parameters.
  147432. * This does nothing and may be overwritten by the user.
  147433. * @param start the particle index in the particle array where to start to iterate, same than the value passed to setParticle()
  147434. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  147435. * @param update the boolean update value actually passed to setParticles()
  147436. */
  147437. beforeUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  147438. /**
  147439. * This will be called by `setParticles()` after all the other treatments and just before the actual mesh update.
  147440. * This will be passed three parameters.
  147441. * This does nothing and may be overwritten by the user.
  147442. * @param start the particle index in the particle array where to start to iterate, same than the value passed to setParticle()
  147443. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  147444. * @param update the boolean update value actually passed to setParticles()
  147445. */
  147446. afterUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  147447. }
  147448. }
  147449. declare module BABYLON {
  147450. /**
  147451. * Represents one particle of a points cloud system.
  147452. */
  147453. export class CloudPoint {
  147454. /**
  147455. * particle global index
  147456. */
  147457. idx: number;
  147458. /**
  147459. * The color of the particle
  147460. */
  147461. color: Nullable<Color4>;
  147462. /**
  147463. * The world space position of the particle.
  147464. */
  147465. position: Vector3;
  147466. /**
  147467. * The world space rotation of the particle. (Not use if rotationQuaternion is set)
  147468. */
  147469. rotation: Vector3;
  147470. /**
  147471. * The world space rotation quaternion of the particle.
  147472. */
  147473. rotationQuaternion: Nullable<Quaternion>;
  147474. /**
  147475. * The uv of the particle.
  147476. */
  147477. uv: Nullable<Vector2>;
  147478. /**
  147479. * The current speed of the particle.
  147480. */
  147481. velocity: Vector3;
  147482. /**
  147483. * The pivot point in the particle local space.
  147484. */
  147485. pivot: Vector3;
  147486. /**
  147487. * Must the particle be translated from its pivot point in its local space ?
  147488. * In this case, the pivot point is set at the origin of the particle local space and the particle is translated.
  147489. * Default : false
  147490. */
  147491. translateFromPivot: boolean;
  147492. /**
  147493. * Index of this particle in the global "positions" array (Internal use)
  147494. * @hidden
  147495. */
  147496. _pos: number;
  147497. /**
  147498. * @hidden Index of this particle in the global "indices" array (Internal use)
  147499. */
  147500. _ind: number;
  147501. /**
  147502. * Group this particle belongs to
  147503. */
  147504. _group: PointsGroup;
  147505. /**
  147506. * Group id of this particle
  147507. */
  147508. groupId: number;
  147509. /**
  147510. * Index of the particle in its group id (Internal use)
  147511. */
  147512. idxInGroup: number;
  147513. /**
  147514. * @hidden Particle BoundingInfo object (Internal use)
  147515. */
  147516. _boundingInfo: BoundingInfo;
  147517. /**
  147518. * @hidden Reference to the PCS that the particle belongs to (Internal use)
  147519. */
  147520. _pcs: PointsCloudSystem;
  147521. /**
  147522. * @hidden Still set as invisible in order to skip useless computations (Internal use)
  147523. */
  147524. _stillInvisible: boolean;
  147525. /**
  147526. * @hidden Last computed particle rotation matrix
  147527. */
  147528. _rotationMatrix: number[];
  147529. /**
  147530. * Parent particle Id, if any.
  147531. * Default null.
  147532. */
  147533. parentId: Nullable<number>;
  147534. /**
  147535. * @hidden Internal global position in the PCS.
  147536. */
  147537. _globalPosition: Vector3;
  147538. /**
  147539. * Creates a Point Cloud object.
  147540. * Don't create particles manually, use instead the PCS internal tools like _addParticle()
  147541. * @param particleIndex (integer) is the particle index in the PCS pool. It's also the particle identifier.
  147542. * @param group (PointsGroup) is the group the particle belongs to
  147543. * @param groupId (integer) is the group identifier in the PCS.
  147544. * @param idxInGroup (integer) is the index of the particle in the current point group (ex: the 10th point of addPoints(30))
  147545. * @param pcs defines the PCS it is associated to
  147546. */
  147547. constructor(particleIndex: number, group: PointsGroup, groupId: number, idxInGroup: number, pcs: PointsCloudSystem);
  147548. /**
  147549. * get point size
  147550. */
  147551. get size(): Vector3;
  147552. /**
  147553. * Set point size
  147554. */
  147555. set size(scale: Vector3);
  147556. /**
  147557. * Legacy support, changed quaternion to rotationQuaternion
  147558. */
  147559. get quaternion(): Nullable<Quaternion>;
  147560. /**
  147561. * Legacy support, changed quaternion to rotationQuaternion
  147562. */
  147563. set quaternion(q: Nullable<Quaternion>);
  147564. /**
  147565. * Returns a boolean. True if the particle intersects a mesh, else false
  147566. * The intersection is computed on the particle position and Axis Aligned Bounding Box (AABB) or Sphere
  147567. * @param target is the object (point or mesh) what the intersection is computed against
  147568. * @param isSphere is boolean flag when false (default) bounding box of mesh is used, when true the bouding sphere is used
  147569. * @returns true if it intersects
  147570. */
  147571. intersectsMesh(target: Mesh, isSphere: boolean): boolean;
  147572. /**
  147573. * get the rotation matrix of the particle
  147574. * @hidden
  147575. */
  147576. getRotationMatrix(m: Matrix): void;
  147577. }
  147578. /**
  147579. * Represents a group of points in a points cloud system
  147580. * * PCS internal tool, don't use it manually.
  147581. */
  147582. export class PointsGroup {
  147583. /**
  147584. * The group id
  147585. * @hidden
  147586. */
  147587. groupID: number;
  147588. /**
  147589. * image data for group (internal use)
  147590. * @hidden
  147591. */
  147592. _groupImageData: Nullable<ArrayBufferView>;
  147593. /**
  147594. * Image Width (internal use)
  147595. * @hidden
  147596. */
  147597. _groupImgWidth: number;
  147598. /**
  147599. * Image Height (internal use)
  147600. * @hidden
  147601. */
  147602. _groupImgHeight: number;
  147603. /**
  147604. * Custom position function (internal use)
  147605. * @hidden
  147606. */
  147607. _positionFunction: Nullable<(particle: CloudPoint, i?: number, s?: number) => void>;
  147608. /**
  147609. * density per facet for surface points
  147610. * @hidden
  147611. */
  147612. _groupDensity: number[];
  147613. /**
  147614. * Only when points are colored by texture carries pointer to texture list array
  147615. * @hidden
  147616. */
  147617. _textureNb: number;
  147618. /**
  147619. * Creates a points group object. This is an internal reference to produce particles for the PCS.
  147620. * PCS internal tool, don't use it manually.
  147621. * @hidden
  147622. */
  147623. constructor(id: number, posFunction: Nullable<(particle: CloudPoint, i?: number, s?: number) => void>);
  147624. }
  147625. }
  147626. declare module BABYLON {
  147627. interface Scene {
  147628. /** @hidden (Backing field) */
  147629. _physicsEngine: Nullable<IPhysicsEngine>;
  147630. /** @hidden */
  147631. _physicsTimeAccumulator: number;
  147632. /**
  147633. * Gets the current physics engine
  147634. * @returns a IPhysicsEngine or null if none attached
  147635. */
  147636. getPhysicsEngine(): Nullable<IPhysicsEngine>;
  147637. /**
  147638. * Enables physics to the current scene
  147639. * @param gravity defines the scene's gravity for the physics engine
  147640. * @param plugin defines the physics engine to be used. defaults to OimoJS.
  147641. * @return a boolean indicating if the physics engine was initialized
  147642. */
  147643. enablePhysics(gravity: Nullable<Vector3>, plugin?: IPhysicsEnginePlugin): boolean;
  147644. /**
  147645. * Disables and disposes the physics engine associated with the scene
  147646. */
  147647. disablePhysicsEngine(): void;
  147648. /**
  147649. * Gets a boolean indicating if there is an active physics engine
  147650. * @returns a boolean indicating if there is an active physics engine
  147651. */
  147652. isPhysicsEnabled(): boolean;
  147653. /**
  147654. * Deletes a physics compound impostor
  147655. * @param compound defines the compound to delete
  147656. */
  147657. deleteCompoundImpostor(compound: any): void;
  147658. /**
  147659. * An event triggered when physic simulation is about to be run
  147660. */
  147661. onBeforePhysicsObservable: Observable<Scene>;
  147662. /**
  147663. * An event triggered when physic simulation has been done
  147664. */
  147665. onAfterPhysicsObservable: Observable<Scene>;
  147666. }
  147667. interface AbstractMesh {
  147668. /** @hidden */
  147669. _physicsImpostor: Nullable<PhysicsImpostor>;
  147670. /**
  147671. * Gets or sets impostor used for physic simulation
  147672. * @see https://doc.babylonjs.com/features/physics_engine
  147673. */
  147674. physicsImpostor: Nullable<PhysicsImpostor>;
  147675. /**
  147676. * Gets the current physics impostor
  147677. * @see https://doc.babylonjs.com/features/physics_engine
  147678. * @returns a physics impostor or null
  147679. */
  147680. getPhysicsImpostor(): Nullable<PhysicsImpostor>;
  147681. /** Apply a physic impulse to the mesh
  147682. * @param force defines the force to apply
  147683. * @param contactPoint defines where to apply the force
  147684. * @returns the current mesh
  147685. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  147686. */
  147687. applyImpulse(force: Vector3, contactPoint: Vector3): AbstractMesh;
  147688. /**
  147689. * Creates a physic joint between two meshes
  147690. * @param otherMesh defines the other mesh to use
  147691. * @param pivot1 defines the pivot to use on this mesh
  147692. * @param pivot2 defines the pivot to use on the other mesh
  147693. * @param options defines additional options (can be plugin dependent)
  147694. * @returns the current mesh
  147695. * @see https://www.babylonjs-playground.com/#0BS5U0#0
  147696. */
  147697. setPhysicsLinkWith(otherMesh: Mesh, pivot1: Vector3, pivot2: Vector3, options?: any): AbstractMesh;
  147698. /** @hidden */
  147699. _disposePhysicsObserver: Nullable<Observer<Node>>;
  147700. }
  147701. /**
  147702. * Defines the physics engine scene component responsible to manage a physics engine
  147703. */
  147704. export class PhysicsEngineSceneComponent implements ISceneComponent {
  147705. /**
  147706. * The component name helpful to identify the component in the list of scene components.
  147707. */
  147708. readonly name: string;
  147709. /**
  147710. * The scene the component belongs to.
  147711. */
  147712. scene: Scene;
  147713. /**
  147714. * Creates a new instance of the component for the given scene
  147715. * @param scene Defines the scene to register the component in
  147716. */
  147717. constructor(scene: Scene);
  147718. /**
  147719. * Registers the component in a given scene
  147720. */
  147721. register(): void;
  147722. /**
  147723. * Rebuilds the elements related to this component in case of
  147724. * context lost for instance.
  147725. */
  147726. rebuild(): void;
  147727. /**
  147728. * Disposes the component and the associated ressources
  147729. */
  147730. dispose(): void;
  147731. }
  147732. }
  147733. declare module BABYLON {
  147734. /**
  147735. * A helper for physics simulations
  147736. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  147737. */
  147738. export class PhysicsHelper {
  147739. private _scene;
  147740. private _physicsEngine;
  147741. /**
  147742. * Initializes the Physics helper
  147743. * @param scene Babylon.js scene
  147744. */
  147745. constructor(scene: Scene);
  147746. /**
  147747. * Applies a radial explosion impulse
  147748. * @param origin the origin of the explosion
  147749. * @param radiusOrEventOptions the radius or the options of radial explosion
  147750. * @param strength the explosion strength
  147751. * @param falloff possible options: Constant & Linear. Defaults to Constant
  147752. * @returns A physics radial explosion event, or null
  147753. */
  147754. applyRadialExplosionImpulse(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsRadialExplosionEvent>;
  147755. /**
  147756. * Applies a radial explosion force
  147757. * @param origin the origin of the explosion
  147758. * @param radiusOrEventOptions the radius or the options of radial explosion
  147759. * @param strength the explosion strength
  147760. * @param falloff possible options: Constant & Linear. Defaults to Constant
  147761. * @returns A physics radial explosion event, or null
  147762. */
  147763. applyRadialExplosionForce(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsRadialExplosionEvent>;
  147764. /**
  147765. * Creates a gravitational field
  147766. * @param origin the origin of the explosion
  147767. * @param radiusOrEventOptions the radius or the options of radial explosion
  147768. * @param strength the explosion strength
  147769. * @param falloff possible options: Constant & Linear. Defaults to Constant
  147770. * @returns A physics gravitational field event, or null
  147771. */
  147772. gravitationalField(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsGravitationalFieldEvent>;
  147773. /**
  147774. * Creates a physics updraft event
  147775. * @param origin the origin of the updraft
  147776. * @param radiusOrEventOptions the radius or the options of the updraft
  147777. * @param strength the strength of the updraft
  147778. * @param height the height of the updraft
  147779. * @param updraftMode possible options: Center & Perpendicular. Defaults to Center
  147780. * @returns A physics updraft event, or null
  147781. */
  147782. updraft(origin: Vector3, radiusOrEventOptions: number | PhysicsUpdraftEventOptions, strength?: number, height?: number, updraftMode?: PhysicsUpdraftMode): Nullable<PhysicsUpdraftEvent>;
  147783. /**
  147784. * Creates a physics vortex event
  147785. * @param origin the of the vortex
  147786. * @param radiusOrEventOptions the radius or the options of the vortex
  147787. * @param strength the strength of the vortex
  147788. * @param height the height of the vortex
  147789. * @returns a Physics vortex event, or null
  147790. * A physics vortex event or null
  147791. */
  147792. vortex(origin: Vector3, radiusOrEventOptions: number | PhysicsVortexEventOptions, strength?: number, height?: number): Nullable<PhysicsVortexEvent>;
  147793. }
  147794. /**
  147795. * Represents a physics radial explosion event
  147796. */
  147797. class PhysicsRadialExplosionEvent {
  147798. private _scene;
  147799. private _options;
  147800. private _sphere;
  147801. private _dataFetched;
  147802. /**
  147803. * Initializes a radial explosioin event
  147804. * @param _scene BabylonJS scene
  147805. * @param _options The options for the vortex event
  147806. */
  147807. constructor(_scene: Scene, _options: PhysicsRadialExplosionEventOptions);
  147808. /**
  147809. * Returns the data related to the radial explosion event (sphere).
  147810. * @returns The radial explosion event data
  147811. */
  147812. getData(): PhysicsRadialExplosionEventData;
  147813. /**
  147814. * Returns the force and contact point of the impostor or false, if the impostor is not affected by the force/impulse.
  147815. * @param impostor A physics imposter
  147816. * @param origin the origin of the explosion
  147817. * @returns {Nullable<PhysicsHitData>} A physics force and contact point, or null
  147818. */
  147819. getImpostorHitData(impostor: PhysicsImpostor, origin: Vector3): Nullable<PhysicsHitData>;
  147820. /**
  147821. * Triggers affecterd impostors callbacks
  147822. * @param affectedImpostorsWithData defines the list of affected impostors (including associated data)
  147823. */
  147824. triggerAffectedImpostorsCallback(affectedImpostorsWithData: Array<PhysicsAffectedImpostorWithData>): void;
  147825. /**
  147826. * Disposes the sphere.
  147827. * @param force Specifies if the sphere should be disposed by force
  147828. */
  147829. dispose(force?: boolean): void;
  147830. /*** Helpers ***/
  147831. private _prepareSphere;
  147832. private _intersectsWithSphere;
  147833. }
  147834. /**
  147835. * Represents a gravitational field event
  147836. */
  147837. class PhysicsGravitationalFieldEvent {
  147838. private _physicsHelper;
  147839. private _scene;
  147840. private _origin;
  147841. private _options;
  147842. private _tickCallback;
  147843. private _sphere;
  147844. private _dataFetched;
  147845. /**
  147846. * Initializes the physics gravitational field event
  147847. * @param _physicsHelper A physics helper
  147848. * @param _scene BabylonJS scene
  147849. * @param _origin The origin position of the gravitational field event
  147850. * @param _options The options for the vortex event
  147851. */
  147852. constructor(_physicsHelper: PhysicsHelper, _scene: Scene, _origin: Vector3, _options: PhysicsRadialExplosionEventOptions);
  147853. /**
  147854. * Returns the data related to the gravitational field event (sphere).
  147855. * @returns A gravitational field event
  147856. */
  147857. getData(): PhysicsGravitationalFieldEventData;
  147858. /**
  147859. * Enables the gravitational field.
  147860. */
  147861. enable(): void;
  147862. /**
  147863. * Disables the gravitational field.
  147864. */
  147865. disable(): void;
  147866. /**
  147867. * Disposes the sphere.
  147868. * @param force The force to dispose from the gravitational field event
  147869. */
  147870. dispose(force?: boolean): void;
  147871. private _tick;
  147872. }
  147873. /**
  147874. * Represents a physics updraft event
  147875. */
  147876. class PhysicsUpdraftEvent {
  147877. private _scene;
  147878. private _origin;
  147879. private _options;
  147880. private _physicsEngine;
  147881. private _originTop;
  147882. private _originDirection;
  147883. private _tickCallback;
  147884. private _cylinder;
  147885. private _cylinderPosition;
  147886. private _dataFetched;
  147887. /**
  147888. * Initializes the physics updraft event
  147889. * @param _scene BabylonJS scene
  147890. * @param _origin The origin position of the updraft
  147891. * @param _options The options for the updraft event
  147892. */
  147893. constructor(_scene: Scene, _origin: Vector3, _options: PhysicsUpdraftEventOptions);
  147894. /**
  147895. * Returns the data related to the updraft event (cylinder).
  147896. * @returns A physics updraft event
  147897. */
  147898. getData(): PhysicsUpdraftEventData;
  147899. /**
  147900. * Enables the updraft.
  147901. */
  147902. enable(): void;
  147903. /**
  147904. * Disables the updraft.
  147905. */
  147906. disable(): void;
  147907. /**
  147908. * Disposes the cylinder.
  147909. * @param force Specifies if the updraft should be disposed by force
  147910. */
  147911. dispose(force?: boolean): void;
  147912. private getImpostorHitData;
  147913. private _tick;
  147914. /*** Helpers ***/
  147915. private _prepareCylinder;
  147916. private _intersectsWithCylinder;
  147917. }
  147918. /**
  147919. * Represents a physics vortex event
  147920. */
  147921. class PhysicsVortexEvent {
  147922. private _scene;
  147923. private _origin;
  147924. private _options;
  147925. private _physicsEngine;
  147926. private _originTop;
  147927. private _tickCallback;
  147928. private _cylinder;
  147929. private _cylinderPosition;
  147930. private _dataFetched;
  147931. /**
  147932. * Initializes the physics vortex event
  147933. * @param _scene The BabylonJS scene
  147934. * @param _origin The origin position of the vortex
  147935. * @param _options The options for the vortex event
  147936. */
  147937. constructor(_scene: Scene, _origin: Vector3, _options: PhysicsVortexEventOptions);
  147938. /**
  147939. * Returns the data related to the vortex event (cylinder).
  147940. * @returns The physics vortex event data
  147941. */
  147942. getData(): PhysicsVortexEventData;
  147943. /**
  147944. * Enables the vortex.
  147945. */
  147946. enable(): void;
  147947. /**
  147948. * Disables the cortex.
  147949. */
  147950. disable(): void;
  147951. /**
  147952. * Disposes the sphere.
  147953. * @param force
  147954. */
  147955. dispose(force?: boolean): void;
  147956. private getImpostorHitData;
  147957. private _tick;
  147958. /*** Helpers ***/
  147959. private _prepareCylinder;
  147960. private _intersectsWithCylinder;
  147961. }
  147962. /**
  147963. * Options fot the radial explosion event
  147964. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  147965. */
  147966. export class PhysicsRadialExplosionEventOptions {
  147967. /**
  147968. * The radius of the sphere for the radial explosion.
  147969. */
  147970. radius: number;
  147971. /**
  147972. * The strenth of the explosion.
  147973. */
  147974. strength: number;
  147975. /**
  147976. * The strenght of the force in correspondence to the distance of the affected object
  147977. */
  147978. falloff: PhysicsRadialImpulseFalloff;
  147979. /**
  147980. * Sphere options for the radial explosion.
  147981. */
  147982. sphere: {
  147983. segments: number;
  147984. diameter: number;
  147985. };
  147986. /**
  147987. * Sphere options for the radial explosion.
  147988. */
  147989. affectedImpostorsCallback: (affectedImpostorsWithData: Array<PhysicsAffectedImpostorWithData>) => void;
  147990. }
  147991. /**
  147992. * Options fot the updraft event
  147993. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  147994. */
  147995. export class PhysicsUpdraftEventOptions {
  147996. /**
  147997. * The radius of the cylinder for the vortex
  147998. */
  147999. radius: number;
  148000. /**
  148001. * The strenth of the updraft.
  148002. */
  148003. strength: number;
  148004. /**
  148005. * The height of the cylinder for the updraft.
  148006. */
  148007. height: number;
  148008. /**
  148009. * The mode for the the updraft.
  148010. */
  148011. updraftMode: PhysicsUpdraftMode;
  148012. }
  148013. /**
  148014. * Options fot the vortex event
  148015. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148016. */
  148017. export class PhysicsVortexEventOptions {
  148018. /**
  148019. * The radius of the cylinder for the vortex
  148020. */
  148021. radius: number;
  148022. /**
  148023. * The strenth of the vortex.
  148024. */
  148025. strength: number;
  148026. /**
  148027. * The height of the cylinder for the vortex.
  148028. */
  148029. height: number;
  148030. /**
  148031. * At which distance, relative to the radius the centripetal forces should kick in? Range: 0-1
  148032. */
  148033. centripetalForceThreshold: number;
  148034. /**
  148035. * This multiplier determines with how much force the objects will be pushed sideways/around the vortex, when below the treshold.
  148036. */
  148037. centripetalForceMultiplier: number;
  148038. /**
  148039. * This multiplier determines with how much force the objects will be pushed sideways/around the vortex, when above the treshold.
  148040. */
  148041. centrifugalForceMultiplier: number;
  148042. /**
  148043. * This multiplier determines with how much force the objects will be pushed upwards, when in the vortex.
  148044. */
  148045. updraftForceMultiplier: number;
  148046. }
  148047. /**
  148048. * The strenght of the force in correspondence to the distance of the affected object
  148049. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148050. */
  148051. export enum PhysicsRadialImpulseFalloff {
  148052. /** Defines that impulse is constant in strength across it's whole radius */
  148053. Constant = 0,
  148054. /** Defines that impulse gets weaker if it's further from the origin */
  148055. Linear = 1
  148056. }
  148057. /**
  148058. * The strength of the force in correspondence to the distance of the affected object
  148059. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148060. */
  148061. export enum PhysicsUpdraftMode {
  148062. /** Defines that the upstream forces will pull towards the top center of the cylinder */
  148063. Center = 0,
  148064. /** Defines that once a impostor is inside the cylinder, it will shoot out perpendicular from the ground of the cylinder */
  148065. Perpendicular = 1
  148066. }
  148067. /**
  148068. * Interface for a physics hit data
  148069. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148070. */
  148071. export interface PhysicsHitData {
  148072. /**
  148073. * The force applied at the contact point
  148074. */
  148075. force: Vector3;
  148076. /**
  148077. * The contact point
  148078. */
  148079. contactPoint: Vector3;
  148080. /**
  148081. * The distance from the origin to the contact point
  148082. */
  148083. distanceFromOrigin: number;
  148084. }
  148085. /**
  148086. * Interface for radial explosion event data
  148087. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148088. */
  148089. export interface PhysicsRadialExplosionEventData {
  148090. /**
  148091. * A sphere used for the radial explosion event
  148092. */
  148093. sphere: Mesh;
  148094. }
  148095. /**
  148096. * Interface for gravitational field event data
  148097. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148098. */
  148099. export interface PhysicsGravitationalFieldEventData {
  148100. /**
  148101. * A sphere mesh used for the gravitational field event
  148102. */
  148103. sphere: Mesh;
  148104. }
  148105. /**
  148106. * Interface for updraft event data
  148107. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148108. */
  148109. export interface PhysicsUpdraftEventData {
  148110. /**
  148111. * A cylinder used for the updraft event
  148112. */
  148113. cylinder: Mesh;
  148114. }
  148115. /**
  148116. * Interface for vortex event data
  148117. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148118. */
  148119. export interface PhysicsVortexEventData {
  148120. /**
  148121. * A cylinder used for the vortex event
  148122. */
  148123. cylinder: Mesh;
  148124. }
  148125. /**
  148126. * Interface for an affected physics impostor
  148127. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148128. */
  148129. export interface PhysicsAffectedImpostorWithData {
  148130. /**
  148131. * The impostor affected by the effect
  148132. */
  148133. impostor: PhysicsImpostor;
  148134. /**
  148135. * The data about the hit/horce from the explosion
  148136. */
  148137. hitData: PhysicsHitData;
  148138. }
  148139. }
  148140. declare module BABYLON {
  148141. /** @hidden */
  148142. export var blackAndWhitePixelShader: {
  148143. name: string;
  148144. shader: string;
  148145. };
  148146. }
  148147. declare module BABYLON {
  148148. /**
  148149. * Post process used to render in black and white
  148150. */
  148151. export class BlackAndWhitePostProcess extends PostProcess {
  148152. /**
  148153. * Linear about to convert he result to black and white (default: 1)
  148154. */
  148155. degree: number;
  148156. /**
  148157. * Gets a string identifying the name of the class
  148158. * @returns "BlackAndWhitePostProcess" string
  148159. */
  148160. getClassName(): string;
  148161. /**
  148162. * Creates a black and white post process
  148163. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#black-and-white
  148164. * @param name The name of the effect.
  148165. * @param options The required width/height ratio to downsize to before computing the render pass.
  148166. * @param camera The camera to apply the render pass to.
  148167. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  148168. * @param engine The engine which the post process will be applied. (default: current engine)
  148169. * @param reusable If the post process can be reused on the same frame. (default: false)
  148170. */
  148171. constructor(name: string, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  148172. /** @hidden */
  148173. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<BlackAndWhitePostProcess>;
  148174. }
  148175. }
  148176. declare module BABYLON {
  148177. /**
  148178. * This represents a set of one or more post processes in Babylon.
  148179. * A post process can be used to apply a shader to a texture after it is rendered.
  148180. * @example https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  148181. */
  148182. export class PostProcessRenderEffect {
  148183. private _postProcesses;
  148184. private _getPostProcesses;
  148185. private _singleInstance;
  148186. private _cameras;
  148187. private _indicesForCamera;
  148188. /**
  148189. * Name of the effect
  148190. * @hidden
  148191. */
  148192. _name: string;
  148193. /**
  148194. * Instantiates a post process render effect.
  148195. * A post process can be used to apply a shader to a texture after it is rendered.
  148196. * @param engine The engine the effect is tied to
  148197. * @param name The name of the effect
  148198. * @param getPostProcesses A function that returns a set of post processes which the effect will run in order to be run.
  148199. * @param singleInstance False if this post process can be run on multiple cameras. (default: true)
  148200. */
  148201. constructor(engine: Engine, name: string, getPostProcesses: () => Nullable<PostProcess | Array<PostProcess>>, singleInstance?: boolean);
  148202. /**
  148203. * Checks if all the post processes in the effect are supported.
  148204. */
  148205. get isSupported(): boolean;
  148206. /**
  148207. * Updates the current state of the effect
  148208. * @hidden
  148209. */
  148210. _update(): void;
  148211. /**
  148212. * Attaches the effect on cameras
  148213. * @param cameras The camera to attach to.
  148214. * @hidden
  148215. */
  148216. _attachCameras(cameras: Camera): void;
  148217. /**
  148218. * Attaches the effect on cameras
  148219. * @param cameras The camera to attach to.
  148220. * @hidden
  148221. */
  148222. _attachCameras(cameras: Camera[]): void;
  148223. /**
  148224. * Detaches the effect on cameras
  148225. * @param cameras The camera to detatch from.
  148226. * @hidden
  148227. */
  148228. _detachCameras(cameras: Camera): void;
  148229. /**
  148230. * Detatches the effect on cameras
  148231. * @param cameras The camera to detatch from.
  148232. * @hidden
  148233. */
  148234. _detachCameras(cameras: Camera[]): void;
  148235. /**
  148236. * Enables the effect on given cameras
  148237. * @param cameras The camera to enable.
  148238. * @hidden
  148239. */
  148240. _enable(cameras: Camera): void;
  148241. /**
  148242. * Enables the effect on given cameras
  148243. * @param cameras The camera to enable.
  148244. * @hidden
  148245. */
  148246. _enable(cameras: Nullable<Camera[]>): void;
  148247. /**
  148248. * Disables the effect on the given cameras
  148249. * @param cameras The camera to disable.
  148250. * @hidden
  148251. */
  148252. _disable(cameras: Camera): void;
  148253. /**
  148254. * Disables the effect on the given cameras
  148255. * @param cameras The camera to disable.
  148256. * @hidden
  148257. */
  148258. _disable(cameras: Nullable<Camera[]>): void;
  148259. /**
  148260. * Gets a list of the post processes contained in the effect.
  148261. * @param camera The camera to get the post processes on.
  148262. * @returns The list of the post processes in the effect.
  148263. */
  148264. getPostProcesses(camera?: Camera): Nullable<Array<PostProcess>>;
  148265. }
  148266. }
  148267. declare module BABYLON {
  148268. /** @hidden */
  148269. export var extractHighlightsPixelShader: {
  148270. name: string;
  148271. shader: string;
  148272. };
  148273. }
  148274. declare module BABYLON {
  148275. /**
  148276. * 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.
  148277. */
  148278. export class ExtractHighlightsPostProcess extends PostProcess {
  148279. /**
  148280. * The luminance threshold, pixels below this value will be set to black.
  148281. */
  148282. threshold: number;
  148283. /** @hidden */
  148284. _exposure: number;
  148285. /**
  148286. * Post process which has the input texture to be used when performing highlight extraction
  148287. * @hidden
  148288. */
  148289. _inputPostProcess: Nullable<PostProcess>;
  148290. /**
  148291. * Gets a string identifying the name of the class
  148292. * @returns "ExtractHighlightsPostProcess" string
  148293. */
  148294. getClassName(): string;
  148295. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  148296. }
  148297. }
  148298. declare module BABYLON {
  148299. /** @hidden */
  148300. export var bloomMergePixelShader: {
  148301. name: string;
  148302. shader: string;
  148303. };
  148304. }
  148305. declare module BABYLON {
  148306. /**
  148307. * The BloomMergePostProcess merges blurred images with the original based on the values of the circle of confusion.
  148308. */
  148309. export class BloomMergePostProcess extends PostProcess {
  148310. /** Weight of the bloom to be added to the original input. */
  148311. weight: number;
  148312. /**
  148313. * Gets a string identifying the name of the class
  148314. * @returns "BloomMergePostProcess" string
  148315. */
  148316. getClassName(): string;
  148317. /**
  148318. * Creates a new instance of @see BloomMergePostProcess
  148319. * @param name The name of the effect.
  148320. * @param originalFromInput Post process which's input will be used for the merge.
  148321. * @param blurred Blurred highlights post process which's output will be used.
  148322. * @param weight Weight of the bloom to be added to the original input.
  148323. * @param options The required width/height ratio to downsize to before computing the render pass.
  148324. * @param camera The camera to apply the render pass to.
  148325. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  148326. * @param engine The engine which the post process will be applied. (default: current engine)
  148327. * @param reusable If the post process can be reused on the same frame. (default: false)
  148328. * @param textureType Type of textures used when performing the post process. (default: 0)
  148329. * @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)
  148330. */
  148331. constructor(name: string, originalFromInput: PostProcess, blurred: PostProcess,
  148332. /** Weight of the bloom to be added to the original input. */
  148333. weight: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  148334. }
  148335. }
  148336. declare module BABYLON {
  148337. /**
  148338. * The bloom effect spreads bright areas of an image to simulate artifacts seen in cameras
  148339. */
  148340. export class BloomEffect extends PostProcessRenderEffect {
  148341. private bloomScale;
  148342. /**
  148343. * @hidden Internal
  148344. */
  148345. _effects: Array<PostProcess>;
  148346. /**
  148347. * @hidden Internal
  148348. */
  148349. _downscale: ExtractHighlightsPostProcess;
  148350. private _blurX;
  148351. private _blurY;
  148352. private _merge;
  148353. /**
  148354. * The luminance threshold to find bright areas of the image to bloom.
  148355. */
  148356. get threshold(): number;
  148357. set threshold(value: number);
  148358. /**
  148359. * The strength of the bloom.
  148360. */
  148361. get weight(): number;
  148362. set weight(value: number);
  148363. /**
  148364. * Specifies the size of the bloom blur kernel, relative to the final output size
  148365. */
  148366. get kernel(): number;
  148367. set kernel(value: number);
  148368. /**
  148369. * Creates a new instance of @see BloomEffect
  148370. * @param scene The scene the effect belongs to.
  148371. * @param bloomScale The ratio of the blur texture to the input texture that should be used to compute the bloom.
  148372. * @param bloomKernel The size of the kernel to be used when applying the blur.
  148373. * @param bloomWeight The the strength of bloom.
  148374. * @param pipelineTextureType The type of texture to be used when performing the post processing.
  148375. * @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)
  148376. */
  148377. constructor(scene: Scene, bloomScale: number, bloomWeight: number, bloomKernel: number, pipelineTextureType?: number, blockCompilation?: boolean);
  148378. /**
  148379. * Disposes each of the internal effects for a given camera.
  148380. * @param camera The camera to dispose the effect on.
  148381. */
  148382. disposeEffects(camera: Camera): void;
  148383. /**
  148384. * @hidden Internal
  148385. */
  148386. _updateEffects(): void;
  148387. /**
  148388. * Internal
  148389. * @returns if all the contained post processes are ready.
  148390. * @hidden
  148391. */
  148392. _isReady(): boolean;
  148393. }
  148394. }
  148395. declare module BABYLON {
  148396. /** @hidden */
  148397. export var chromaticAberrationPixelShader: {
  148398. name: string;
  148399. shader: string;
  148400. };
  148401. }
  148402. declare module BABYLON {
  148403. /**
  148404. * The ChromaticAberrationPostProcess separates the rgb channels in an image to produce chromatic distortion around the edges of the screen
  148405. */
  148406. export class ChromaticAberrationPostProcess extends PostProcess {
  148407. /**
  148408. * The amount of seperation of rgb channels (default: 30)
  148409. */
  148410. aberrationAmount: number;
  148411. /**
  148412. * The amount the effect will increase for pixels closer to the edge of the screen. (default: 0)
  148413. */
  148414. radialIntensity: number;
  148415. /**
  148416. * 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))
  148417. */
  148418. direction: Vector2;
  148419. /**
  148420. * 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))
  148421. */
  148422. centerPosition: Vector2;
  148423. /** The width of the screen to apply the effect on */
  148424. screenWidth: number;
  148425. /** The height of the screen to apply the effect on */
  148426. screenHeight: number;
  148427. /**
  148428. * Gets a string identifying the name of the class
  148429. * @returns "ChromaticAberrationPostProcess" string
  148430. */
  148431. getClassName(): string;
  148432. /**
  148433. * Creates a new instance ChromaticAberrationPostProcess
  148434. * @param name The name of the effect.
  148435. * @param screenWidth The width of the screen to apply the effect on.
  148436. * @param screenHeight The height of the screen to apply the effect on.
  148437. * @param options The required width/height ratio to downsize to before computing the render pass.
  148438. * @param camera The camera to apply the render pass to.
  148439. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  148440. * @param engine The engine which the post process will be applied. (default: current engine)
  148441. * @param reusable If the post process can be reused on the same frame. (default: false)
  148442. * @param textureType Type of textures used when performing the post process. (default: 0)
  148443. * @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)
  148444. */
  148445. constructor(name: string, screenWidth: number, screenHeight: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  148446. /** @hidden */
  148447. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<ChromaticAberrationPostProcess>;
  148448. }
  148449. }
  148450. declare module BABYLON {
  148451. /** @hidden */
  148452. export var circleOfConfusionPixelShader: {
  148453. name: string;
  148454. shader: string;
  148455. };
  148456. }
  148457. declare module BABYLON {
  148458. /**
  148459. * The CircleOfConfusionPostProcess computes the circle of confusion value for each pixel given required lens parameters. See https://en.wikipedia.org/wiki/Circle_of_confusion
  148460. */
  148461. export class CircleOfConfusionPostProcess extends PostProcess {
  148462. /**
  148463. * 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.
  148464. */
  148465. lensSize: number;
  148466. /**
  148467. * F-Stop of the effect's camera. The diamater of the resulting aperture can be computed by lensSize/fStop. (default: 1.4)
  148468. */
  148469. fStop: number;
  148470. /**
  148471. * Distance away from the camera to focus on in scene units/1000 (eg. millimeter). (default: 2000)
  148472. */
  148473. focusDistance: number;
  148474. /**
  148475. * Focal length of the effect's camera in scene units/1000 (eg. millimeter). (default: 50)
  148476. */
  148477. focalLength: number;
  148478. /**
  148479. * Gets a string identifying the name of the class
  148480. * @returns "CircleOfConfusionPostProcess" string
  148481. */
  148482. getClassName(): string;
  148483. private _depthTexture;
  148484. /**
  148485. * Creates a new instance CircleOfConfusionPostProcess
  148486. * @param name The name of the effect.
  148487. * @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.
  148488. * @param options The required width/height ratio to downsize to before computing the render pass.
  148489. * @param camera The camera to apply the render pass to.
  148490. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  148491. * @param engine The engine which the post process will be applied. (default: current engine)
  148492. * @param reusable If the post process can be reused on the same frame. (default: false)
  148493. * @param textureType Type of textures used when performing the post process. (default: 0)
  148494. * @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)
  148495. */
  148496. constructor(name: string, depthTexture: Nullable<RenderTargetTexture>, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  148497. /**
  148498. * 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.
  148499. */
  148500. set depthTexture(value: RenderTargetTexture);
  148501. }
  148502. }
  148503. declare module BABYLON {
  148504. /** @hidden */
  148505. export var colorCorrectionPixelShader: {
  148506. name: string;
  148507. shader: string;
  148508. };
  148509. }
  148510. declare module BABYLON {
  148511. /**
  148512. *
  148513. * This post-process allows the modification of rendered colors by using
  148514. * a 'look-up table' (LUT). This effect is also called Color Grading.
  148515. *
  148516. * The object needs to be provided an url to a texture containing the color
  148517. * look-up table: the texture must be 256 pixels wide and 16 pixels high.
  148518. * Use an image editing software to tweak the LUT to match your needs.
  148519. *
  148520. * For an example of a color LUT, see here:
  148521. * @see http://udn.epicgames.com/Three/rsrc/Three/ColorGrading/RGBTable16x1.png
  148522. * For explanations on color grading, see here:
  148523. * @see http://udn.epicgames.com/Three/ColorGrading.html
  148524. *
  148525. */
  148526. export class ColorCorrectionPostProcess extends PostProcess {
  148527. private _colorTableTexture;
  148528. /**
  148529. * Gets the color table url used to create the LUT texture
  148530. */
  148531. colorTableUrl: string;
  148532. /**
  148533. * Gets a string identifying the name of the class
  148534. * @returns "ColorCorrectionPostProcess" string
  148535. */
  148536. getClassName(): string;
  148537. constructor(name: string, colorTableUrl: string, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  148538. /** @hidden */
  148539. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<ColorCorrectionPostProcess>;
  148540. }
  148541. }
  148542. declare module BABYLON {
  148543. /** @hidden */
  148544. export var convolutionPixelShader: {
  148545. name: string;
  148546. shader: string;
  148547. };
  148548. }
  148549. declare module BABYLON {
  148550. /**
  148551. * The ConvolutionPostProcess applies a 3x3 kernel to every pixel of the
  148552. * input texture to perform effects such as edge detection or sharpening
  148553. * See http://en.wikipedia.org/wiki/Kernel_(image_processing)
  148554. */
  148555. export class ConvolutionPostProcess extends PostProcess {
  148556. /** Array of 9 values corresponding to the 3x3 kernel to be applied */
  148557. kernel: number[];
  148558. /**
  148559. * Gets a string identifying the name of the class
  148560. * @returns "ConvolutionPostProcess" string
  148561. */
  148562. getClassName(): string;
  148563. /**
  148564. * Creates a new instance ConvolutionPostProcess
  148565. * @param name The name of the effect.
  148566. * @param kernel Array of 9 values corresponding to the 3x3 kernel to be applied
  148567. * @param options The required width/height ratio to downsize to before computing the render pass.
  148568. * @param camera The camera to apply the render pass to.
  148569. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  148570. * @param engine The engine which the post process will be applied. (default: current engine)
  148571. * @param reusable If the post process can be reused on the same frame. (default: false)
  148572. * @param textureType Type of textures used when performing the post process. (default: 0)
  148573. */
  148574. constructor(name: string, kernel: number[], options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  148575. /** @hidden */
  148576. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<ConvolutionPostProcess>;
  148577. /**
  148578. * Edge detection 0 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  148579. */
  148580. static EdgeDetect0Kernel: number[];
  148581. /**
  148582. * Edge detection 1 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  148583. */
  148584. static EdgeDetect1Kernel: number[];
  148585. /**
  148586. * Edge detection 2 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  148587. */
  148588. static EdgeDetect2Kernel: number[];
  148589. /**
  148590. * Kernel to sharpen an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  148591. */
  148592. static SharpenKernel: number[];
  148593. /**
  148594. * Kernel to emboss an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  148595. */
  148596. static EmbossKernel: number[];
  148597. /**
  148598. * Kernel to blur an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  148599. */
  148600. static GaussianKernel: number[];
  148601. }
  148602. }
  148603. declare module BABYLON {
  148604. /**
  148605. * The DepthOfFieldBlurPostProcess applied a blur in a give direction.
  148606. * This blur differs from the standard BlurPostProcess as it attempts to avoid blurring pixels
  148607. * based on samples that have a large difference in distance than the center pixel.
  148608. * See section 2.6.2 http://fileadmin.cs.lth.se/cs/education/edan35/lectures/12dof.pdf
  148609. */
  148610. export class DepthOfFieldBlurPostProcess extends BlurPostProcess {
  148611. /**
  148612. * The direction the blur should be applied
  148613. */
  148614. direction: Vector2;
  148615. /**
  148616. * Gets a string identifying the name of the class
  148617. * @returns "DepthOfFieldBlurPostProcess" string
  148618. */
  148619. getClassName(): string;
  148620. /**
  148621. * Creates a new instance CircleOfConfusionPostProcess
  148622. * @param name The name of the effect.
  148623. * @param scene The scene the effect belongs to.
  148624. * @param direction The direction the blur should be applied.
  148625. * @param kernel The size of the kernel used to blur.
  148626. * @param options The required width/height ratio to downsize to before computing the render pass.
  148627. * @param camera The camera to apply the render pass to.
  148628. * @param circleOfConfusion The circle of confusion + depth map to be used to avoid blurring accross edges
  148629. * @param imageToBlur The image to apply the blur to (default: Current rendered frame)
  148630. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  148631. * @param engine The engine which the post process will be applied. (default: current engine)
  148632. * @param reusable If the post process can be reused on the same frame. (default: false)
  148633. * @param textureType Type of textures used when performing the post process. (default: 0)
  148634. * @param blockCompilation If compilation of the shader should not be done in the constructor. The updateEffect method can be used to compile the shader at a later time. (default: false)
  148635. */
  148636. constructor(name: string, 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);
  148637. }
  148638. }
  148639. declare module BABYLON {
  148640. /** @hidden */
  148641. export var depthOfFieldMergePixelShader: {
  148642. name: string;
  148643. shader: string;
  148644. };
  148645. }
  148646. declare module BABYLON {
  148647. /**
  148648. * Options to be set when merging outputs from the default pipeline.
  148649. */
  148650. export class DepthOfFieldMergePostProcessOptions {
  148651. /**
  148652. * The original image to merge on top of
  148653. */
  148654. originalFromInput: PostProcess;
  148655. /**
  148656. * Parameters to perform the merge of the depth of field effect
  148657. */
  148658. depthOfField?: {
  148659. circleOfConfusion: PostProcess;
  148660. blurSteps: Array<PostProcess>;
  148661. };
  148662. /**
  148663. * Parameters to perform the merge of bloom effect
  148664. */
  148665. bloom?: {
  148666. blurred: PostProcess;
  148667. weight: number;
  148668. };
  148669. }
  148670. /**
  148671. * The DepthOfFieldMergePostProcess merges blurred images with the original based on the values of the circle of confusion.
  148672. */
  148673. export class DepthOfFieldMergePostProcess extends PostProcess {
  148674. private blurSteps;
  148675. /**
  148676. * Gets a string identifying the name of the class
  148677. * @returns "DepthOfFieldMergePostProcess" string
  148678. */
  148679. getClassName(): string;
  148680. /**
  148681. * Creates a new instance of DepthOfFieldMergePostProcess
  148682. * @param name The name of the effect.
  148683. * @param originalFromInput Post process which's input will be used for the merge.
  148684. * @param circleOfConfusion Circle of confusion post process which's output will be used to blur each pixel.
  148685. * @param blurSteps Blur post processes from low to high which will be mixed with the original image.
  148686. * @param options The required width/height ratio to downsize to before computing the render pass.
  148687. * @param camera The camera to apply the render pass to.
  148688. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  148689. * @param engine The engine which the post process will be applied. (default: current engine)
  148690. * @param reusable If the post process can be reused on the same frame. (default: false)
  148691. * @param textureType Type of textures used when performing the post process. (default: 0)
  148692. * @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)
  148693. */
  148694. 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);
  148695. /**
  148696. * Updates the effect with the current post process compile time values and recompiles the shader.
  148697. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  148698. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  148699. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  148700. * @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
  148701. * @param onCompiled Called when the shader has been compiled.
  148702. * @param onError Called if there is an error when compiling a shader.
  148703. */
  148704. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  148705. }
  148706. }
  148707. declare module BABYLON {
  148708. /**
  148709. * Specifies the level of max blur that should be applied when using the depth of field effect
  148710. */
  148711. export enum DepthOfFieldEffectBlurLevel {
  148712. /**
  148713. * Subtle blur
  148714. */
  148715. Low = 0,
  148716. /**
  148717. * Medium blur
  148718. */
  148719. Medium = 1,
  148720. /**
  148721. * Large blur
  148722. */
  148723. High = 2
  148724. }
  148725. /**
  148726. * The depth of field effect applies a blur to objects that are closer or further from where the camera is focusing.
  148727. */
  148728. export class DepthOfFieldEffect extends PostProcessRenderEffect {
  148729. private _circleOfConfusion;
  148730. /**
  148731. * @hidden Internal, blurs from high to low
  148732. */
  148733. _depthOfFieldBlurX: Array<DepthOfFieldBlurPostProcess>;
  148734. private _depthOfFieldBlurY;
  148735. private _dofMerge;
  148736. /**
  148737. * @hidden Internal post processes in depth of field effect
  148738. */
  148739. _effects: Array<PostProcess>;
  148740. /**
  148741. * The focal the length of the camera used in the effect in scene units/1000 (eg. millimeter)
  148742. */
  148743. set focalLength(value: number);
  148744. get focalLength(): number;
  148745. /**
  148746. * F-Stop of the effect's camera. The diameter of the resulting aperture can be computed by lensSize/fStop. (default: 1.4)
  148747. */
  148748. set fStop(value: number);
  148749. get fStop(): number;
  148750. /**
  148751. * Distance away from the camera to focus on in scene units/1000 (eg. millimeter). (default: 2000)
  148752. */
  148753. set focusDistance(value: number);
  148754. get focusDistance(): number;
  148755. /**
  148756. * 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.
  148757. */
  148758. set lensSize(value: number);
  148759. get lensSize(): number;
  148760. /**
  148761. * Creates a new instance DepthOfFieldEffect
  148762. * @param scene The scene the effect belongs to.
  148763. * @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.
  148764. * @param pipelineTextureType The type of texture to be used when performing the post processing.
  148765. * @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)
  148766. */
  148767. constructor(scene: Scene, depthTexture: Nullable<RenderTargetTexture>, blurLevel?: DepthOfFieldEffectBlurLevel, pipelineTextureType?: number, blockCompilation?: boolean);
  148768. /**
  148769. * Get the current class name of the current effet
  148770. * @returns "DepthOfFieldEffect"
  148771. */
  148772. getClassName(): string;
  148773. /**
  148774. * 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.
  148775. */
  148776. set depthTexture(value: RenderTargetTexture);
  148777. /**
  148778. * Disposes each of the internal effects for a given camera.
  148779. * @param camera The camera to dispose the effect on.
  148780. */
  148781. disposeEffects(camera: Camera): void;
  148782. /**
  148783. * @hidden Internal
  148784. */
  148785. _updateEffects(): void;
  148786. /**
  148787. * Internal
  148788. * @returns if all the contained post processes are ready.
  148789. * @hidden
  148790. */
  148791. _isReady(): boolean;
  148792. }
  148793. }
  148794. declare module BABYLON {
  148795. /** @hidden */
  148796. export var displayPassPixelShader: {
  148797. name: string;
  148798. shader: string;
  148799. };
  148800. }
  148801. declare module BABYLON {
  148802. /**
  148803. * DisplayPassPostProcess which produces an output the same as it's input
  148804. */
  148805. export class DisplayPassPostProcess extends PostProcess {
  148806. /**
  148807. * Gets a string identifying the name of the class
  148808. * @returns "DisplayPassPostProcess" string
  148809. */
  148810. getClassName(): string;
  148811. /**
  148812. * Creates the DisplayPassPostProcess
  148813. * @param name The name of the effect.
  148814. * @param options The required width/height ratio to downsize to before computing the render pass.
  148815. * @param camera The camera to apply the render pass to.
  148816. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  148817. * @param engine The engine which the post process will be applied. (default: current engine)
  148818. * @param reusable If the post process can be reused on the same frame. (default: false)
  148819. */
  148820. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean);
  148821. /** @hidden */
  148822. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<DisplayPassPostProcess>;
  148823. }
  148824. }
  148825. declare module BABYLON {
  148826. /** @hidden */
  148827. export var filterPixelShader: {
  148828. name: string;
  148829. shader: string;
  148830. };
  148831. }
  148832. declare module BABYLON {
  148833. /**
  148834. * Applies a kernel filter to the image
  148835. */
  148836. export class FilterPostProcess extends PostProcess {
  148837. /** The matrix to be applied to the image */
  148838. kernelMatrix: Matrix;
  148839. /**
  148840. * Gets a string identifying the name of the class
  148841. * @returns "FilterPostProcess" string
  148842. */
  148843. getClassName(): string;
  148844. /**
  148845. *
  148846. * @param name The name of the effect.
  148847. * @param kernelMatrix The matrix to be applied to the image
  148848. * @param options The required width/height ratio to downsize to before computing the render pass.
  148849. * @param camera The camera to apply the render pass to.
  148850. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  148851. * @param engine The engine which the post process will be applied. (default: current engine)
  148852. * @param reusable If the post process can be reused on the same frame. (default: false)
  148853. */
  148854. constructor(name: string, kernelMatrix: Matrix, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean);
  148855. /** @hidden */
  148856. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<FilterPostProcess>;
  148857. }
  148858. }
  148859. declare module BABYLON {
  148860. /** @hidden */
  148861. export var fxaaPixelShader: {
  148862. name: string;
  148863. shader: string;
  148864. };
  148865. }
  148866. declare module BABYLON {
  148867. /** @hidden */
  148868. export var fxaaVertexShader: {
  148869. name: string;
  148870. shader: string;
  148871. };
  148872. }
  148873. declare module BABYLON {
  148874. /**
  148875. * Fxaa post process
  148876. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#fxaa
  148877. */
  148878. export class FxaaPostProcess extends PostProcess {
  148879. /**
  148880. * Gets a string identifying the name of the class
  148881. * @returns "FxaaPostProcess" string
  148882. */
  148883. getClassName(): string;
  148884. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  148885. private _getDefines;
  148886. /** @hidden */
  148887. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): FxaaPostProcess;
  148888. }
  148889. }
  148890. declare module BABYLON {
  148891. /** @hidden */
  148892. export var grainPixelShader: {
  148893. name: string;
  148894. shader: string;
  148895. };
  148896. }
  148897. declare module BABYLON {
  148898. /**
  148899. * The GrainPostProcess adds noise to the image at mid luminance levels
  148900. */
  148901. export class GrainPostProcess extends PostProcess {
  148902. /**
  148903. * The intensity of the grain added (default: 30)
  148904. */
  148905. intensity: number;
  148906. /**
  148907. * If the grain should be randomized on every frame
  148908. */
  148909. animated: boolean;
  148910. /**
  148911. * Gets a string identifying the name of the class
  148912. * @returns "GrainPostProcess" string
  148913. */
  148914. getClassName(): string;
  148915. /**
  148916. * Creates a new instance of @see GrainPostProcess
  148917. * @param name The name of the effect.
  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. * @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)
  148925. */
  148926. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  148927. /** @hidden */
  148928. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): GrainPostProcess;
  148929. }
  148930. }
  148931. declare module BABYLON {
  148932. /** @hidden */
  148933. export var highlightsPixelShader: {
  148934. name: string;
  148935. shader: string;
  148936. };
  148937. }
  148938. declare module BABYLON {
  148939. /**
  148940. * Extracts highlights from the image
  148941. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  148942. */
  148943. export class HighlightsPostProcess extends PostProcess {
  148944. /**
  148945. * Gets a string identifying the name of the class
  148946. * @returns "HighlightsPostProcess" string
  148947. */
  148948. getClassName(): string;
  148949. /**
  148950. * Extracts highlights from the image
  148951. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  148952. * @param name The name of the effect.
  148953. * @param options The required width/height ratio to downsize to before computing the render pass.
  148954. * @param camera The camera to apply the render pass to.
  148955. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  148956. * @param engine The engine which the post process will be applied. (default: current engine)
  148957. * @param reusable If the post process can be reused on the same frame. (default: false)
  148958. * @param textureType Type of texture for the post process (default: Engine.TEXTURETYPE_UNSIGNED_INT)
  148959. */
  148960. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  148961. }
  148962. }
  148963. declare module BABYLON {
  148964. /** @hidden */
  148965. export var mrtFragmentDeclaration: {
  148966. name: string;
  148967. shader: string;
  148968. };
  148969. }
  148970. declare module BABYLON {
  148971. /** @hidden */
  148972. export var geometryPixelShader: {
  148973. name: string;
  148974. shader: string;
  148975. };
  148976. }
  148977. declare module BABYLON {
  148978. /** @hidden */
  148979. export var geometryVertexShader: {
  148980. name: string;
  148981. shader: string;
  148982. };
  148983. }
  148984. declare module BABYLON {
  148985. /** @hidden */
  148986. interface ISavedTransformationMatrix {
  148987. world: Matrix;
  148988. viewProjection: Matrix;
  148989. }
  148990. /**
  148991. * This renderer is helpfull to fill one of the render target with a geometry buffer.
  148992. */
  148993. export class GeometryBufferRenderer {
  148994. /**
  148995. * Constant used to retrieve the position texture index in the G-Buffer textures array
  148996. * using getIndex(GeometryBufferRenderer.POSITION_TEXTURE_INDEX)
  148997. */
  148998. static readonly POSITION_TEXTURE_TYPE: number;
  148999. /**
  149000. * Constant used to retrieve the velocity texture index in the G-Buffer textures array
  149001. * using getIndex(GeometryBufferRenderer.VELOCITY_TEXTURE_INDEX)
  149002. */
  149003. static readonly VELOCITY_TEXTURE_TYPE: number;
  149004. /**
  149005. * Constant used to retrieve the reflectivity texture index in the G-Buffer textures array
  149006. * using the getIndex(GeometryBufferRenderer.REFLECTIVITY_TEXTURE_TYPE)
  149007. */
  149008. static readonly REFLECTIVITY_TEXTURE_TYPE: number;
  149009. /**
  149010. * Dictionary used to store the previous transformation matrices of each rendered mesh
  149011. * in order to compute objects velocities when enableVelocity is set to "true"
  149012. * @hidden
  149013. */
  149014. _previousTransformationMatrices: {
  149015. [index: number]: ISavedTransformationMatrix;
  149016. };
  149017. /**
  149018. * Dictionary used to store the previous bones transformation matrices of each rendered mesh
  149019. * in order to compute objects velocities when enableVelocity is set to "true"
  149020. * @hidden
  149021. */
  149022. _previousBonesTransformationMatrices: {
  149023. [index: number]: Float32Array;
  149024. };
  149025. /**
  149026. * Array used to store the ignored skinned meshes while computing velocity map (typically used by the motion blur post-process).
  149027. * Avoids computing bones velocities and computes only mesh's velocity itself (position, rotation, scaling).
  149028. */
  149029. excludedSkinnedMeshesFromVelocity: AbstractMesh[];
  149030. /** Gets or sets a boolean indicating if transparent meshes should be rendered */
  149031. renderTransparentMeshes: boolean;
  149032. private _scene;
  149033. private _resizeObserver;
  149034. private _multiRenderTarget;
  149035. private _ratio;
  149036. private _enablePosition;
  149037. private _enableVelocity;
  149038. private _enableReflectivity;
  149039. private _positionIndex;
  149040. private _velocityIndex;
  149041. private _reflectivityIndex;
  149042. protected _effect: Effect;
  149043. protected _cachedDefines: string;
  149044. /**
  149045. * Set the render list (meshes to be rendered) used in the G buffer.
  149046. */
  149047. set renderList(meshes: Mesh[]);
  149048. /**
  149049. * Gets wether or not G buffer are supported by the running hardware.
  149050. * This requires draw buffer supports
  149051. */
  149052. get isSupported(): boolean;
  149053. /**
  149054. * Returns the index of the given texture type in the G-Buffer textures array
  149055. * @param textureType The texture type constant. For example GeometryBufferRenderer.POSITION_TEXTURE_INDEX
  149056. * @returns the index of the given texture type in the G-Buffer textures array
  149057. */
  149058. getTextureIndex(textureType: number): number;
  149059. /**
  149060. * Gets a boolean indicating if objects positions are enabled for the G buffer.
  149061. */
  149062. get enablePosition(): boolean;
  149063. /**
  149064. * Sets whether or not objects positions are enabled for the G buffer.
  149065. */
  149066. set enablePosition(enable: boolean);
  149067. /**
  149068. * Gets a boolean indicating if objects velocities are enabled for the G buffer.
  149069. */
  149070. get enableVelocity(): boolean;
  149071. /**
  149072. * Sets wether or not objects velocities are enabled for the G buffer.
  149073. */
  149074. set enableVelocity(enable: boolean);
  149075. /**
  149076. * Gets a boolean indicating if objects roughness are enabled in the G buffer.
  149077. */
  149078. get enableReflectivity(): boolean;
  149079. /**
  149080. * Sets wether or not objects roughness are enabled for the G buffer.
  149081. */
  149082. set enableReflectivity(enable: boolean);
  149083. /**
  149084. * Gets the scene associated with the buffer.
  149085. */
  149086. get scene(): Scene;
  149087. /**
  149088. * Gets the ratio used by the buffer during its creation.
  149089. * How big is the buffer related to the main canvas.
  149090. */
  149091. get ratio(): number;
  149092. /** @hidden */
  149093. static _SceneComponentInitialization: (scene: Scene) => void;
  149094. /**
  149095. * Creates a new G Buffer for the scene
  149096. * @param scene The scene the buffer belongs to
  149097. * @param ratio How big is the buffer related to the main canvas.
  149098. */
  149099. constructor(scene: Scene, ratio?: number);
  149100. /**
  149101. * Checks wether everything is ready to render a submesh to the G buffer.
  149102. * @param subMesh the submesh to check readiness for
  149103. * @param useInstances is the mesh drawn using instance or not
  149104. * @returns true if ready otherwise false
  149105. */
  149106. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  149107. /**
  149108. * Gets the current underlying G Buffer.
  149109. * @returns the buffer
  149110. */
  149111. getGBuffer(): MultiRenderTarget;
  149112. /**
  149113. * Gets the number of samples used to render the buffer (anti aliasing).
  149114. */
  149115. get samples(): number;
  149116. /**
  149117. * Sets the number of samples used to render the buffer (anti aliasing).
  149118. */
  149119. set samples(value: number);
  149120. /**
  149121. * Disposes the renderer and frees up associated resources.
  149122. */
  149123. dispose(): void;
  149124. protected _createRenderTargets(): void;
  149125. private _copyBonesTransformationMatrices;
  149126. }
  149127. }
  149128. declare module BABYLON {
  149129. interface Scene {
  149130. /** @hidden (Backing field) */
  149131. _geometryBufferRenderer: Nullable<GeometryBufferRenderer>;
  149132. /**
  149133. * Gets or Sets the current geometry buffer associated to the scene.
  149134. */
  149135. geometryBufferRenderer: Nullable<GeometryBufferRenderer>;
  149136. /**
  149137. * Enables a GeometryBufferRender and associates it with the scene
  149138. * @param ratio defines the scaling ratio to apply to the renderer (1 by default which means same resolution)
  149139. * @returns the GeometryBufferRenderer
  149140. */
  149141. enableGeometryBufferRenderer(ratio?: number): Nullable<GeometryBufferRenderer>;
  149142. /**
  149143. * Disables the GeometryBufferRender associated with the scene
  149144. */
  149145. disableGeometryBufferRenderer(): void;
  149146. }
  149147. /**
  149148. * Defines the Geometry Buffer scene component responsible to manage a G-Buffer useful
  149149. * in several rendering techniques.
  149150. */
  149151. export class GeometryBufferRendererSceneComponent implements ISceneComponent {
  149152. /**
  149153. * The component name helpful to identify the component in the list of scene components.
  149154. */
  149155. readonly name: string;
  149156. /**
  149157. * The scene the component belongs to.
  149158. */
  149159. scene: Scene;
  149160. /**
  149161. * Creates a new instance of the component for the given scene
  149162. * @param scene Defines the scene to register the component in
  149163. */
  149164. constructor(scene: Scene);
  149165. /**
  149166. * Registers the component in a given scene
  149167. */
  149168. register(): void;
  149169. /**
  149170. * Rebuilds the elements related to this component in case of
  149171. * context lost for instance.
  149172. */
  149173. rebuild(): void;
  149174. /**
  149175. * Disposes the component and the associated ressources
  149176. */
  149177. dispose(): void;
  149178. private _gatherRenderTargets;
  149179. }
  149180. }
  149181. declare module BABYLON {
  149182. /** @hidden */
  149183. export var motionBlurPixelShader: {
  149184. name: string;
  149185. shader: string;
  149186. };
  149187. }
  149188. declare module BABYLON {
  149189. /**
  149190. * The Motion Blur Post Process which blurs an image based on the objects velocity in scene.
  149191. * Velocity can be affected by each object's rotation, position and scale depending on the transformation speed.
  149192. * As an example, all you have to do is to create the post-process:
  149193. * var mb = new BABYLON.MotionBlurPostProcess(
  149194. * 'mb', // The name of the effect.
  149195. * scene, // The scene containing the objects to blur according to their velocity.
  149196. * 1.0, // The required width/height ratio to downsize to before computing the render pass.
  149197. * camera // The camera to apply the render pass to.
  149198. * );
  149199. * Then, all objects moving, rotating and/or scaling will be blurred depending on the transformation speed.
  149200. */
  149201. export class MotionBlurPostProcess extends PostProcess {
  149202. /**
  149203. * Defines how much the image is blurred by the movement. Default value is equal to 1
  149204. */
  149205. motionStrength: number;
  149206. /**
  149207. * Gets the number of iterations are used for motion blur quality. Default value is equal to 32
  149208. */
  149209. get motionBlurSamples(): number;
  149210. /**
  149211. * Sets the number of iterations to be used for motion blur quality
  149212. */
  149213. set motionBlurSamples(samples: number);
  149214. private _motionBlurSamples;
  149215. private _geometryBufferRenderer;
  149216. /**
  149217. * Gets a string identifying the name of the class
  149218. * @returns "MotionBlurPostProcess" string
  149219. */
  149220. getClassName(): string;
  149221. /**
  149222. * Creates a new instance MotionBlurPostProcess
  149223. * @param name The name of the effect.
  149224. * @param scene The scene containing the objects to blur according to their velocity.
  149225. * @param options The required width/height ratio to downsize to before computing the render pass.
  149226. * @param camera The camera to apply the render pass to.
  149227. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  149228. * @param engine The engine which the post process will be applied. (default: current engine)
  149229. * @param reusable If the post process can be reused on the same frame. (default: false)
  149230. * @param textureType Type of textures used when performing the post process. (default: 0)
  149231. * @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)
  149232. */
  149233. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  149234. /**
  149235. * Excludes the given skinned mesh from computing bones velocities.
  149236. * 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.
  149237. * @param skinnedMesh The mesh containing the skeleton to ignore when computing the velocity map.
  149238. */
  149239. excludeSkinnedMesh(skinnedMesh: AbstractMesh): void;
  149240. /**
  149241. * Removes the given skinned mesh from the excluded meshes to integrate bones velocities while rendering the velocity map.
  149242. * @param skinnedMesh The mesh containing the skeleton that has been ignored previously.
  149243. * @see excludeSkinnedMesh to exclude a skinned mesh from bones velocity computation.
  149244. */
  149245. removeExcludedSkinnedMesh(skinnedMesh: AbstractMesh): void;
  149246. /**
  149247. * Disposes the post process.
  149248. * @param camera The camera to dispose the post process on.
  149249. */
  149250. dispose(camera?: Camera): void;
  149251. /** @hidden */
  149252. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<MotionBlurPostProcess>;
  149253. }
  149254. }
  149255. declare module BABYLON {
  149256. /** @hidden */
  149257. export var refractionPixelShader: {
  149258. name: string;
  149259. shader: string;
  149260. };
  149261. }
  149262. declare module BABYLON {
  149263. /**
  149264. * Post process which applies a refractin texture
  149265. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#refraction
  149266. */
  149267. export class RefractionPostProcess extends PostProcess {
  149268. private _refTexture;
  149269. private _ownRefractionTexture;
  149270. /** the base color of the refraction (used to taint the rendering) */
  149271. color: Color3;
  149272. /** simulated refraction depth */
  149273. depth: number;
  149274. /** the coefficient of the base color (0 to remove base color tainting) */
  149275. colorLevel: number;
  149276. /** Gets the url used to load the refraction texture */
  149277. refractionTextureUrl: string;
  149278. /**
  149279. * Gets or sets the refraction texture
  149280. * Please note that you are responsible for disposing the texture if you set it manually
  149281. */
  149282. get refractionTexture(): Texture;
  149283. set refractionTexture(value: Texture);
  149284. /**
  149285. * Gets a string identifying the name of the class
  149286. * @returns "RefractionPostProcess" string
  149287. */
  149288. getClassName(): string;
  149289. /**
  149290. * Initializes the RefractionPostProcess
  149291. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#refraction
  149292. * @param name The name of the effect.
  149293. * @param refractionTextureUrl Url of the refraction texture to use
  149294. * @param color the base color of the refraction (used to taint the rendering)
  149295. * @param depth simulated refraction depth
  149296. * @param colorLevel the coefficient of the base color (0 to remove base color tainting)
  149297. * @param camera The camera to apply the render pass to.
  149298. * @param options The required width/height ratio to downsize to before computing the render pass.
  149299. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  149300. * @param engine The engine which the post process will be applied. (default: current engine)
  149301. * @param reusable If the post process can be reused on the same frame. (default: false)
  149302. */
  149303. constructor(name: string, refractionTextureUrl: string, color: Color3, depth: number, colorLevel: number, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  149304. /**
  149305. * Disposes of the post process
  149306. * @param camera Camera to dispose post process on
  149307. */
  149308. dispose(camera: Camera): void;
  149309. /** @hidden */
  149310. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): RefractionPostProcess;
  149311. }
  149312. }
  149313. declare module BABYLON {
  149314. /** @hidden */
  149315. export var sharpenPixelShader: {
  149316. name: string;
  149317. shader: string;
  149318. };
  149319. }
  149320. declare module BABYLON {
  149321. /**
  149322. * The SharpenPostProcess applies a sharpen kernel to every pixel
  149323. * See http://en.wikipedia.org/wiki/Kernel_(image_processing)
  149324. */
  149325. export class SharpenPostProcess extends PostProcess {
  149326. /**
  149327. * How much of the original color should be applied. Setting this to 0 will display edge detection. (default: 1)
  149328. */
  149329. colorAmount: number;
  149330. /**
  149331. * How much sharpness should be applied (default: 0.3)
  149332. */
  149333. edgeAmount: number;
  149334. /**
  149335. * Gets a string identifying the name of the class
  149336. * @returns "SharpenPostProcess" string
  149337. */
  149338. getClassName(): string;
  149339. /**
  149340. * Creates a new instance ConvolutionPostProcess
  149341. * @param name The name of the effect.
  149342. * @param options The required width/height ratio to downsize to before computing the render pass.
  149343. * @param camera The camera to apply the render pass to.
  149344. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  149345. * @param engine The engine which the post process will be applied. (default: current engine)
  149346. * @param reusable If the post process can be reused on the same frame. (default: false)
  149347. * @param textureType Type of textures used when performing the post process. (default: 0)
  149348. * @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)
  149349. */
  149350. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  149351. /** @hidden */
  149352. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): SharpenPostProcess;
  149353. }
  149354. }
  149355. declare module BABYLON {
  149356. /**
  149357. * PostProcessRenderPipeline
  149358. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  149359. */
  149360. export class PostProcessRenderPipeline {
  149361. private engine;
  149362. private _renderEffects;
  149363. private _renderEffectsForIsolatedPass;
  149364. /**
  149365. * List of inspectable custom properties (used by the Inspector)
  149366. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  149367. */
  149368. inspectableCustomProperties: IInspectable[];
  149369. /**
  149370. * @hidden
  149371. */
  149372. protected _cameras: Camera[];
  149373. /** @hidden */
  149374. _name: string;
  149375. /**
  149376. * Gets pipeline name
  149377. */
  149378. get name(): string;
  149379. /** Gets the list of attached cameras */
  149380. get cameras(): Camera[];
  149381. /**
  149382. * Initializes a PostProcessRenderPipeline
  149383. * @param engine engine to add the pipeline to
  149384. * @param name name of the pipeline
  149385. */
  149386. constructor(engine: Engine, name: string);
  149387. /**
  149388. * Gets the class name
  149389. * @returns "PostProcessRenderPipeline"
  149390. */
  149391. getClassName(): string;
  149392. /**
  149393. * If all the render effects in the pipeline are supported
  149394. */
  149395. get isSupported(): boolean;
  149396. /**
  149397. * Adds an effect to the pipeline
  149398. * @param renderEffect the effect to add
  149399. */
  149400. addEffect(renderEffect: PostProcessRenderEffect): void;
  149401. /** @hidden */
  149402. _rebuild(): void;
  149403. /** @hidden */
  149404. _enableEffect(renderEffectName: string, cameras: Camera): void;
  149405. /** @hidden */
  149406. _enableEffect(renderEffectName: string, cameras: Camera[]): void;
  149407. /** @hidden */
  149408. _disableEffect(renderEffectName: string, cameras: Nullable<Camera[]>): void;
  149409. /** @hidden */
  149410. _disableEffect(renderEffectName: string, cameras: Nullable<Camera[]>): void;
  149411. /** @hidden */
  149412. _attachCameras(cameras: Camera, unique: boolean): void;
  149413. /** @hidden */
  149414. _attachCameras(cameras: Camera[], unique: boolean): void;
  149415. /** @hidden */
  149416. _detachCameras(cameras: Camera): void;
  149417. /** @hidden */
  149418. _detachCameras(cameras: Nullable<Camera[]>): void;
  149419. /** @hidden */
  149420. _update(): void;
  149421. /** @hidden */
  149422. _reset(): void;
  149423. protected _enableMSAAOnFirstPostProcess(sampleCount: number): boolean;
  149424. /**
  149425. * Sets the required values to the prepass renderer.
  149426. * @param prePassRenderer defines the prepass renderer to setup.
  149427. * @returns true if the pre pass is needed.
  149428. */
  149429. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  149430. /**
  149431. * Disposes of the pipeline
  149432. */
  149433. dispose(): void;
  149434. }
  149435. }
  149436. declare module BABYLON {
  149437. /**
  149438. * PostProcessRenderPipelineManager class
  149439. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  149440. */
  149441. export class PostProcessRenderPipelineManager {
  149442. private _renderPipelines;
  149443. /**
  149444. * Initializes a PostProcessRenderPipelineManager
  149445. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  149446. */
  149447. constructor();
  149448. /**
  149449. * Gets the list of supported render pipelines
  149450. */
  149451. get supportedPipelines(): PostProcessRenderPipeline[];
  149452. /**
  149453. * Adds a pipeline to the manager
  149454. * @param renderPipeline The pipeline to add
  149455. */
  149456. addPipeline(renderPipeline: PostProcessRenderPipeline): void;
  149457. /**
  149458. * Attaches a camera to the pipeline
  149459. * @param renderPipelineName The name of the pipeline to attach to
  149460. * @param cameras the camera to attach
  149461. * @param unique if the camera can be attached multiple times to the pipeline
  149462. */
  149463. attachCamerasToRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera, unique?: boolean): void;
  149464. /**
  149465. * Detaches a camera from the pipeline
  149466. * @param renderPipelineName The name of the pipeline to detach from
  149467. * @param cameras the camera to detach
  149468. */
  149469. detachCamerasFromRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera): void;
  149470. /**
  149471. * Enables an effect by name on a pipeline
  149472. * @param renderPipelineName the name of the pipeline to enable the effect in
  149473. * @param renderEffectName the name of the effect to enable
  149474. * @param cameras the cameras that the effect should be enabled on
  149475. */
  149476. enableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void;
  149477. /**
  149478. * Disables an effect by name on a pipeline
  149479. * @param renderPipelineName the name of the pipeline to disable the effect in
  149480. * @param renderEffectName the name of the effect to disable
  149481. * @param cameras the cameras that the effect should be disabled on
  149482. */
  149483. disableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void;
  149484. /**
  149485. * Updates the state of all contained render pipelines and disposes of any non supported pipelines
  149486. */
  149487. update(): void;
  149488. /** @hidden */
  149489. _rebuild(): void;
  149490. /**
  149491. * Disposes of the manager and pipelines
  149492. */
  149493. dispose(): void;
  149494. }
  149495. }
  149496. declare module BABYLON {
  149497. interface Scene {
  149498. /** @hidden (Backing field) */
  149499. _postProcessRenderPipelineManager: PostProcessRenderPipelineManager;
  149500. /**
  149501. * Gets the postprocess render pipeline manager
  149502. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  149503. * @see https://doc.babylonjs.com/how_to/using_default_rendering_pipeline
  149504. */
  149505. readonly postProcessRenderPipelineManager: PostProcessRenderPipelineManager;
  149506. }
  149507. /**
  149508. * Defines the Render Pipeline scene component responsible to rendering pipelines
  149509. */
  149510. export class PostProcessRenderPipelineManagerSceneComponent implements ISceneComponent {
  149511. /**
  149512. * The component name helpfull to identify the component in the list of scene components.
  149513. */
  149514. readonly name: string;
  149515. /**
  149516. * The scene the component belongs to.
  149517. */
  149518. scene: Scene;
  149519. /**
  149520. * Creates a new instance of the component for the given scene
  149521. * @param scene Defines the scene to register the component in
  149522. */
  149523. constructor(scene: Scene);
  149524. /**
  149525. * Registers the component in a given scene
  149526. */
  149527. register(): void;
  149528. /**
  149529. * Rebuilds the elements related to this component in case of
  149530. * context lost for instance.
  149531. */
  149532. rebuild(): void;
  149533. /**
  149534. * Disposes the component and the associated ressources
  149535. */
  149536. dispose(): void;
  149537. private _gatherRenderTargets;
  149538. }
  149539. }
  149540. declare module BABYLON {
  149541. /**
  149542. * The default rendering pipeline can be added to a scene to apply common post processing effects such as anti-aliasing or depth of field.
  149543. * See https://doc.babylonjs.com/how_to/using_default_rendering_pipeline
  149544. */
  149545. export class DefaultRenderingPipeline extends PostProcessRenderPipeline implements IDisposable, IAnimatable {
  149546. private _scene;
  149547. private _camerasToBeAttached;
  149548. /**
  149549. * ID of the sharpen post process,
  149550. */
  149551. private readonly SharpenPostProcessId;
  149552. /**
  149553. * @ignore
  149554. * ID of the image processing post process;
  149555. */
  149556. readonly ImageProcessingPostProcessId: string;
  149557. /**
  149558. * @ignore
  149559. * ID of the Fast Approximate Anti-Aliasing post process;
  149560. */
  149561. readonly FxaaPostProcessId: string;
  149562. /**
  149563. * ID of the chromatic aberration post process,
  149564. */
  149565. private readonly ChromaticAberrationPostProcessId;
  149566. /**
  149567. * ID of the grain post process
  149568. */
  149569. private readonly GrainPostProcessId;
  149570. /**
  149571. * Sharpen post process which will apply a sharpen convolution to enhance edges
  149572. */
  149573. sharpen: SharpenPostProcess;
  149574. private _sharpenEffect;
  149575. private bloom;
  149576. /**
  149577. * Depth of field effect, applies a blur based on how far away objects are from the focus distance.
  149578. */
  149579. depthOfField: DepthOfFieldEffect;
  149580. /**
  149581. * The Fast Approximate Anti-Aliasing post process which attemps to remove aliasing from an image.
  149582. */
  149583. fxaa: FxaaPostProcess;
  149584. /**
  149585. * Image post processing pass used to perform operations such as tone mapping or color grading.
  149586. */
  149587. imageProcessing: ImageProcessingPostProcess;
  149588. /**
  149589. * Chromatic aberration post process which will shift rgb colors in the image
  149590. */
  149591. chromaticAberration: ChromaticAberrationPostProcess;
  149592. private _chromaticAberrationEffect;
  149593. /**
  149594. * Grain post process which add noise to the image
  149595. */
  149596. grain: GrainPostProcess;
  149597. private _grainEffect;
  149598. /**
  149599. * Glow post process which adds a glow to emissive areas of the image
  149600. */
  149601. private _glowLayer;
  149602. /**
  149603. * Animations which can be used to tweak settings over a period of time
  149604. */
  149605. animations: Animation[];
  149606. private _imageProcessingConfigurationObserver;
  149607. private _sharpenEnabled;
  149608. private _bloomEnabled;
  149609. private _depthOfFieldEnabled;
  149610. private _depthOfFieldBlurLevel;
  149611. private _fxaaEnabled;
  149612. private _imageProcessingEnabled;
  149613. private _defaultPipelineTextureType;
  149614. private _bloomScale;
  149615. private _chromaticAberrationEnabled;
  149616. private _grainEnabled;
  149617. private _buildAllowed;
  149618. /**
  149619. * Gets active scene
  149620. */
  149621. get scene(): Scene;
  149622. /**
  149623. * Enable or disable the sharpen process from the pipeline
  149624. */
  149625. set sharpenEnabled(enabled: boolean);
  149626. get sharpenEnabled(): boolean;
  149627. private _resizeObserver;
  149628. private _hardwareScaleLevel;
  149629. private _bloomKernel;
  149630. /**
  149631. * Specifies the size of the bloom blur kernel, relative to the final output size
  149632. */
  149633. get bloomKernel(): number;
  149634. set bloomKernel(value: number);
  149635. /**
  149636. * Specifies the weight of the bloom in the final rendering
  149637. */
  149638. private _bloomWeight;
  149639. /**
  149640. * Specifies the luma threshold for the area that will be blurred by the bloom
  149641. */
  149642. private _bloomThreshold;
  149643. private _hdr;
  149644. /**
  149645. * The strength of the bloom.
  149646. */
  149647. set bloomWeight(value: number);
  149648. get bloomWeight(): number;
  149649. /**
  149650. * The strength of the bloom.
  149651. */
  149652. set bloomThreshold(value: number);
  149653. get bloomThreshold(): number;
  149654. /**
  149655. * The scale of the bloom, lower value will provide better performance.
  149656. */
  149657. set bloomScale(value: number);
  149658. get bloomScale(): number;
  149659. /**
  149660. * Enable or disable the bloom from the pipeline
  149661. */
  149662. set bloomEnabled(enabled: boolean);
  149663. get bloomEnabled(): boolean;
  149664. private _rebuildBloom;
  149665. /**
  149666. * If the depth of field is enabled.
  149667. */
  149668. get depthOfFieldEnabled(): boolean;
  149669. set depthOfFieldEnabled(enabled: boolean);
  149670. /**
  149671. * Blur level of the depth of field effect. (Higher blur will effect performance)
  149672. */
  149673. get depthOfFieldBlurLevel(): DepthOfFieldEffectBlurLevel;
  149674. set depthOfFieldBlurLevel(value: DepthOfFieldEffectBlurLevel);
  149675. /**
  149676. * If the anti aliasing is enabled.
  149677. */
  149678. set fxaaEnabled(enabled: boolean);
  149679. get fxaaEnabled(): boolean;
  149680. private _samples;
  149681. /**
  149682. * MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
  149683. */
  149684. set samples(sampleCount: number);
  149685. get samples(): number;
  149686. /**
  149687. * If image processing is enabled.
  149688. */
  149689. set imageProcessingEnabled(enabled: boolean);
  149690. get imageProcessingEnabled(): boolean;
  149691. /**
  149692. * If glow layer is enabled. (Adds a glow effect to emmissive materials)
  149693. */
  149694. set glowLayerEnabled(enabled: boolean);
  149695. get glowLayerEnabled(): boolean;
  149696. /**
  149697. * Gets the glow layer (or null if not defined)
  149698. */
  149699. get glowLayer(): Nullable<GlowLayer>;
  149700. /**
  149701. * Enable or disable the chromaticAberration process from the pipeline
  149702. */
  149703. set chromaticAberrationEnabled(enabled: boolean);
  149704. get chromaticAberrationEnabled(): boolean;
  149705. /**
  149706. * Enable or disable the grain process from the pipeline
  149707. */
  149708. set grainEnabled(enabled: boolean);
  149709. get grainEnabled(): boolean;
  149710. /**
  149711. * @constructor
  149712. * @param name - The rendering pipeline name (default: "")
  149713. * @param hdr - If high dynamic range textures should be used (default: true)
  149714. * @param scene - The scene linked to this pipeline (default: the last created scene)
  149715. * @param cameras - The array of cameras that the rendering pipeline will be attached to (default: scene.cameras)
  149716. * @param automaticBuild - if false, you will have to manually call prepare() to update the pipeline (default: true)
  149717. */
  149718. constructor(name?: string, hdr?: boolean, scene?: Scene, cameras?: Camera[], automaticBuild?: boolean);
  149719. /**
  149720. * Get the class name
  149721. * @returns "DefaultRenderingPipeline"
  149722. */
  149723. getClassName(): string;
  149724. /**
  149725. * Force the compilation of the entire pipeline.
  149726. */
  149727. prepare(): void;
  149728. private _hasCleared;
  149729. private _prevPostProcess;
  149730. private _prevPrevPostProcess;
  149731. private _setAutoClearAndTextureSharing;
  149732. private _depthOfFieldSceneObserver;
  149733. private _buildPipeline;
  149734. private _disposePostProcesses;
  149735. /**
  149736. * Adds a camera to the pipeline
  149737. * @param camera the camera to be added
  149738. */
  149739. addCamera(camera: Camera): void;
  149740. /**
  149741. * Removes a camera from the pipeline
  149742. * @param camera the camera to remove
  149743. */
  149744. removeCamera(camera: Camera): void;
  149745. /**
  149746. * Dispose of the pipeline and stop all post processes
  149747. */
  149748. dispose(): void;
  149749. /**
  149750. * Serialize the rendering pipeline (Used when exporting)
  149751. * @returns the serialized object
  149752. */
  149753. serialize(): any;
  149754. /**
  149755. * Parse the serialized pipeline
  149756. * @param source Source pipeline.
  149757. * @param scene The scene to load the pipeline to.
  149758. * @param rootUrl The URL of the serialized pipeline.
  149759. * @returns An instantiated pipeline from the serialized object.
  149760. */
  149761. static Parse(source: any, scene: Scene, rootUrl: string): DefaultRenderingPipeline;
  149762. }
  149763. }
  149764. declare module BABYLON {
  149765. /** @hidden */
  149766. export var lensHighlightsPixelShader: {
  149767. name: string;
  149768. shader: string;
  149769. };
  149770. }
  149771. declare module BABYLON {
  149772. /** @hidden */
  149773. export var depthOfFieldPixelShader: {
  149774. name: string;
  149775. shader: string;
  149776. };
  149777. }
  149778. declare module BABYLON {
  149779. /**
  149780. * BABYLON.JS Chromatic Aberration GLSL Shader
  149781. * Author: Olivier Guyot
  149782. * Separates very slightly R, G and B colors on the edges of the screen
  149783. * Inspired by Francois Tarlier & Martins Upitis
  149784. */
  149785. export class LensRenderingPipeline extends PostProcessRenderPipeline {
  149786. /**
  149787. * @ignore
  149788. * The chromatic aberration PostProcess id in the pipeline
  149789. */
  149790. LensChromaticAberrationEffect: string;
  149791. /**
  149792. * @ignore
  149793. * The highlights enhancing PostProcess id in the pipeline
  149794. */
  149795. HighlightsEnhancingEffect: string;
  149796. /**
  149797. * @ignore
  149798. * The depth-of-field PostProcess id in the pipeline
  149799. */
  149800. LensDepthOfFieldEffect: string;
  149801. private _scene;
  149802. private _depthTexture;
  149803. private _grainTexture;
  149804. private _chromaticAberrationPostProcess;
  149805. private _highlightsPostProcess;
  149806. private _depthOfFieldPostProcess;
  149807. private _edgeBlur;
  149808. private _grainAmount;
  149809. private _chromaticAberration;
  149810. private _distortion;
  149811. private _highlightsGain;
  149812. private _highlightsThreshold;
  149813. private _dofDistance;
  149814. private _dofAperture;
  149815. private _dofDarken;
  149816. private _dofPentagon;
  149817. private _blurNoise;
  149818. /**
  149819. * @constructor
  149820. *
  149821. * Effect parameters are as follow:
  149822. * {
  149823. * chromatic_aberration: number; // from 0 to x (1 for realism)
  149824. * edge_blur: number; // from 0 to x (1 for realism)
  149825. * distortion: number; // from 0 to x (1 for realism)
  149826. * grain_amount: number; // from 0 to 1
  149827. * grain_texture: BABYLON.Texture; // texture to use for grain effect; if unset, use random B&W noise
  149828. * dof_focus_distance: number; // depth-of-field: focus distance; unset to disable (disabled by default)
  149829. * dof_aperture: number; // depth-of-field: focus blur bias (default: 1)
  149830. * dof_darken: number; // depth-of-field: darken that which is out of focus (from 0 to 1, disabled by default)
  149831. * dof_pentagon: boolean; // depth-of-field: makes a pentagon-like "bokeh" effect
  149832. * dof_gain: number; // depth-of-field: highlights gain; unset to disable (disabled by default)
  149833. * dof_threshold: number; // depth-of-field: highlights threshold (default: 1)
  149834. * blur_noise: boolean; // add a little bit of noise to the blur (default: true)
  149835. * }
  149836. * Note: if an effect parameter is unset, effect is disabled
  149837. *
  149838. * @param name The rendering pipeline name
  149839. * @param parameters - An object containing all parameters (see above)
  149840. * @param scene The scene linked to this pipeline
  149841. * @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)
  149842. * @param cameras The array of cameras that the rendering pipeline will be attached to
  149843. */
  149844. constructor(name: string, parameters: any, scene: Scene, ratio?: number, cameras?: Camera[]);
  149845. /**
  149846. * Get the class name
  149847. * @returns "LensRenderingPipeline"
  149848. */
  149849. getClassName(): string;
  149850. /**
  149851. * Gets associated scene
  149852. */
  149853. get scene(): Scene;
  149854. /**
  149855. * Gets or sets the edge blur
  149856. */
  149857. get edgeBlur(): number;
  149858. set edgeBlur(value: number);
  149859. /**
  149860. * Gets or sets the grain amount
  149861. */
  149862. get grainAmount(): number;
  149863. set grainAmount(value: number);
  149864. /**
  149865. * Gets or sets the chromatic aberration amount
  149866. */
  149867. get chromaticAberration(): number;
  149868. set chromaticAberration(value: number);
  149869. /**
  149870. * Gets or sets the depth of field aperture
  149871. */
  149872. get dofAperture(): number;
  149873. set dofAperture(value: number);
  149874. /**
  149875. * Gets or sets the edge distortion
  149876. */
  149877. get edgeDistortion(): number;
  149878. set edgeDistortion(value: number);
  149879. /**
  149880. * Gets or sets the depth of field distortion
  149881. */
  149882. get dofDistortion(): number;
  149883. set dofDistortion(value: number);
  149884. /**
  149885. * Gets or sets the darken out of focus amount
  149886. */
  149887. get darkenOutOfFocus(): number;
  149888. set darkenOutOfFocus(value: number);
  149889. /**
  149890. * Gets or sets a boolean indicating if blur noise is enabled
  149891. */
  149892. get blurNoise(): boolean;
  149893. set blurNoise(value: boolean);
  149894. /**
  149895. * Gets or sets a boolean indicating if pentagon bokeh is enabled
  149896. */
  149897. get pentagonBokeh(): boolean;
  149898. set pentagonBokeh(value: boolean);
  149899. /**
  149900. * Gets or sets the highlight grain amount
  149901. */
  149902. get highlightsGain(): number;
  149903. set highlightsGain(value: number);
  149904. /**
  149905. * Gets or sets the highlight threshold
  149906. */
  149907. get highlightsThreshold(): number;
  149908. set highlightsThreshold(value: number);
  149909. /**
  149910. * Sets the amount of blur at the edges
  149911. * @param amount blur amount
  149912. */
  149913. setEdgeBlur(amount: number): void;
  149914. /**
  149915. * Sets edge blur to 0
  149916. */
  149917. disableEdgeBlur(): void;
  149918. /**
  149919. * Sets the amout of grain
  149920. * @param amount Amount of grain
  149921. */
  149922. setGrainAmount(amount: number): void;
  149923. /**
  149924. * Set grain amount to 0
  149925. */
  149926. disableGrain(): void;
  149927. /**
  149928. * Sets the chromatic aberration amount
  149929. * @param amount amount of chromatic aberration
  149930. */
  149931. setChromaticAberration(amount: number): void;
  149932. /**
  149933. * Sets chromatic aberration amount to 0
  149934. */
  149935. disableChromaticAberration(): void;
  149936. /**
  149937. * Sets the EdgeDistortion amount
  149938. * @param amount amount of EdgeDistortion
  149939. */
  149940. setEdgeDistortion(amount: number): void;
  149941. /**
  149942. * Sets edge distortion to 0
  149943. */
  149944. disableEdgeDistortion(): void;
  149945. /**
  149946. * Sets the FocusDistance amount
  149947. * @param amount amount of FocusDistance
  149948. */
  149949. setFocusDistance(amount: number): void;
  149950. /**
  149951. * Disables depth of field
  149952. */
  149953. disableDepthOfField(): void;
  149954. /**
  149955. * Sets the Aperture amount
  149956. * @param amount amount of Aperture
  149957. */
  149958. setAperture(amount: number): void;
  149959. /**
  149960. * Sets the DarkenOutOfFocus amount
  149961. * @param amount amount of DarkenOutOfFocus
  149962. */
  149963. setDarkenOutOfFocus(amount: number): void;
  149964. private _pentagonBokehIsEnabled;
  149965. /**
  149966. * Creates a pentagon bokeh effect
  149967. */
  149968. enablePentagonBokeh(): void;
  149969. /**
  149970. * Disables the pentagon bokeh effect
  149971. */
  149972. disablePentagonBokeh(): void;
  149973. /**
  149974. * Enables noise blur
  149975. */
  149976. enableNoiseBlur(): void;
  149977. /**
  149978. * Disables noise blur
  149979. */
  149980. disableNoiseBlur(): void;
  149981. /**
  149982. * Sets the HighlightsGain amount
  149983. * @param amount amount of HighlightsGain
  149984. */
  149985. setHighlightsGain(amount: number): void;
  149986. /**
  149987. * Sets the HighlightsThreshold amount
  149988. * @param amount amount of HighlightsThreshold
  149989. */
  149990. setHighlightsThreshold(amount: number): void;
  149991. /**
  149992. * Disables highlights
  149993. */
  149994. disableHighlights(): void;
  149995. /**
  149996. * Removes the internal pipeline assets and detaches the pipeline from the scene cameras
  149997. * @param disableDepthRender If the scens depth rendering should be disabled (default: false)
  149998. */
  149999. dispose(disableDepthRender?: boolean): void;
  150000. private _createChromaticAberrationPostProcess;
  150001. private _createHighlightsPostProcess;
  150002. private _createDepthOfFieldPostProcess;
  150003. private _createGrainTexture;
  150004. }
  150005. }
  150006. declare module BABYLON {
  150007. /** @hidden */
  150008. export var ssao2PixelShader: {
  150009. name: string;
  150010. shader: string;
  150011. };
  150012. }
  150013. declare module BABYLON {
  150014. /** @hidden */
  150015. export var ssaoCombinePixelShader: {
  150016. name: string;
  150017. shader: string;
  150018. };
  150019. }
  150020. declare module BABYLON {
  150021. /**
  150022. * Render pipeline to produce ssao effect
  150023. */
  150024. export class SSAO2RenderingPipeline extends PostProcessRenderPipeline {
  150025. /**
  150026. * @ignore
  150027. * The PassPostProcess id in the pipeline that contains the original scene color
  150028. */
  150029. SSAOOriginalSceneColorEffect: string;
  150030. /**
  150031. * @ignore
  150032. * The SSAO PostProcess id in the pipeline
  150033. */
  150034. SSAORenderEffect: string;
  150035. /**
  150036. * @ignore
  150037. * The horizontal blur PostProcess id in the pipeline
  150038. */
  150039. SSAOBlurHRenderEffect: string;
  150040. /**
  150041. * @ignore
  150042. * The vertical blur PostProcess id in the pipeline
  150043. */
  150044. SSAOBlurVRenderEffect: string;
  150045. /**
  150046. * @ignore
  150047. * The PostProcess id in the pipeline that combines the SSAO-Blur output with the original scene color (SSAOOriginalSceneColorEffect)
  150048. */
  150049. SSAOCombineRenderEffect: string;
  150050. /**
  150051. * The output strength of the SSAO post-process. Default value is 1.0.
  150052. */
  150053. totalStrength: number;
  150054. /**
  150055. * Maximum depth value to still render AO. A smooth falloff makes the dimming more natural, so there will be no abrupt shading change.
  150056. */
  150057. maxZ: number;
  150058. /**
  150059. * In order to save performances, SSAO radius is clamped on close geometry. This ratio changes by how much
  150060. */
  150061. minZAspect: number;
  150062. private _samples;
  150063. /**
  150064. * Number of samples used for the SSAO calculations. Default value is 8
  150065. */
  150066. set samples(n: number);
  150067. get samples(): number;
  150068. private _textureSamples;
  150069. /**
  150070. * Number of samples to use for antialiasing
  150071. */
  150072. set textureSamples(n: number);
  150073. get textureSamples(): number;
  150074. /**
  150075. * Force rendering the geometry through geometry buffer
  150076. */
  150077. private _forceGeometryBuffer;
  150078. /**
  150079. * Ratio object used for SSAO ratio and blur ratio
  150080. */
  150081. private _ratio;
  150082. /**
  150083. * Dynamically generated sphere sampler.
  150084. */
  150085. private _sampleSphere;
  150086. /**
  150087. * Blur filter offsets
  150088. */
  150089. private _samplerOffsets;
  150090. private _expensiveBlur;
  150091. /**
  150092. * If bilateral blur should be used
  150093. */
  150094. set expensiveBlur(b: boolean);
  150095. get expensiveBlur(): boolean;
  150096. /**
  150097. * The radius around the analyzed pixel used by the SSAO post-process. Default value is 2.0
  150098. */
  150099. radius: number;
  150100. /**
  150101. * The base color of the SSAO post-process
  150102. * The final result is "base + ssao" between [0, 1]
  150103. */
  150104. base: number;
  150105. /**
  150106. * Support test.
  150107. */
  150108. static get IsSupported(): boolean;
  150109. private _scene;
  150110. private _randomTexture;
  150111. private _originalColorPostProcess;
  150112. private _ssaoPostProcess;
  150113. private _blurHPostProcess;
  150114. private _blurVPostProcess;
  150115. private _ssaoCombinePostProcess;
  150116. private _prePassRenderer;
  150117. /**
  150118. * Gets active scene
  150119. */
  150120. get scene(): Scene;
  150121. /**
  150122. * @constructor
  150123. * @param name The rendering pipeline name
  150124. * @param scene The scene linked to this pipeline
  150125. * @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 }
  150126. * @param cameras The array of cameras that the rendering pipeline will be attached to
  150127. * @param forceGeometryBuffer Set to true if you want to use the legacy geometry buffer renderer
  150128. */
  150129. constructor(name: string, scene: Scene, ratio: any, cameras?: Camera[], forceGeometryBuffer?: boolean);
  150130. /**
  150131. * Get the class name
  150132. * @returns "SSAO2RenderingPipeline"
  150133. */
  150134. getClassName(): string;
  150135. /**
  150136. * Removes the internal pipeline assets and detatches the pipeline from the scene cameras
  150137. */
  150138. dispose(disableGeometryBufferRenderer?: boolean): void;
  150139. private _createBlurPostProcess;
  150140. /** @hidden */
  150141. _rebuild(): void;
  150142. private _bits;
  150143. private _radicalInverse_VdC;
  150144. private _hammersley;
  150145. private _hemisphereSample_uniform;
  150146. private _generateHemisphere;
  150147. private _getDefinesForSSAO;
  150148. private _createSSAOPostProcess;
  150149. private _createSSAOCombinePostProcess;
  150150. private _createRandomTexture;
  150151. /**
  150152. * Serialize the rendering pipeline (Used when exporting)
  150153. * @returns the serialized object
  150154. */
  150155. serialize(): any;
  150156. /**
  150157. * Parse the serialized pipeline
  150158. * @param source Source pipeline.
  150159. * @param scene The scene to load the pipeline to.
  150160. * @param rootUrl The URL of the serialized pipeline.
  150161. * @returns An instantiated pipeline from the serialized object.
  150162. */
  150163. static Parse(source: any, scene: Scene, rootUrl: string): SSAO2RenderingPipeline;
  150164. /**
  150165. * Sets the required values to the prepass renderer.
  150166. * @param prePassRenderer defines the prepass renderer to setup
  150167. * @returns true if the pre pass is needed.
  150168. */
  150169. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  150170. }
  150171. }
  150172. declare module BABYLON {
  150173. /** @hidden */
  150174. export var ssaoPixelShader: {
  150175. name: string;
  150176. shader: string;
  150177. };
  150178. }
  150179. declare module BABYLON {
  150180. /**
  150181. * Render pipeline to produce ssao effect
  150182. */
  150183. export class SSAORenderingPipeline extends PostProcessRenderPipeline {
  150184. /**
  150185. * @ignore
  150186. * The PassPostProcess id in the pipeline that contains the original scene color
  150187. */
  150188. SSAOOriginalSceneColorEffect: string;
  150189. /**
  150190. * @ignore
  150191. * The SSAO PostProcess id in the pipeline
  150192. */
  150193. SSAORenderEffect: string;
  150194. /**
  150195. * @ignore
  150196. * The horizontal blur PostProcess id in the pipeline
  150197. */
  150198. SSAOBlurHRenderEffect: string;
  150199. /**
  150200. * @ignore
  150201. * The vertical blur PostProcess id in the pipeline
  150202. */
  150203. SSAOBlurVRenderEffect: string;
  150204. /**
  150205. * @ignore
  150206. * The PostProcess id in the pipeline that combines the SSAO-Blur output with the original scene color (SSAOOriginalSceneColorEffect)
  150207. */
  150208. SSAOCombineRenderEffect: string;
  150209. /**
  150210. * The output strength of the SSAO post-process. Default value is 1.0.
  150211. */
  150212. totalStrength: number;
  150213. /**
  150214. * The radius around the analyzed pixel used by the SSAO post-process. Default value is 0.0006
  150215. */
  150216. radius: number;
  150217. /**
  150218. * Related to fallOff, used to interpolate SSAO samples (first interpolate function input) based on the occlusion difference of each pixel
  150219. * Must not be equal to fallOff and superior to fallOff.
  150220. * Default value is 0.0075
  150221. */
  150222. area: number;
  150223. /**
  150224. * Related to area, used to interpolate SSAO samples (second interpolate function input) based on the occlusion difference of each pixel
  150225. * Must not be equal to area and inferior to area.
  150226. * Default value is 0.000001
  150227. */
  150228. fallOff: number;
  150229. /**
  150230. * The base color of the SSAO post-process
  150231. * The final result is "base + ssao" between [0, 1]
  150232. */
  150233. base: number;
  150234. private _scene;
  150235. private _depthTexture;
  150236. private _randomTexture;
  150237. private _originalColorPostProcess;
  150238. private _ssaoPostProcess;
  150239. private _blurHPostProcess;
  150240. private _blurVPostProcess;
  150241. private _ssaoCombinePostProcess;
  150242. private _firstUpdate;
  150243. /**
  150244. * Gets active scene
  150245. */
  150246. get scene(): Scene;
  150247. /**
  150248. * @constructor
  150249. * @param name - The rendering pipeline name
  150250. * @param scene - The scene linked to this pipeline
  150251. * @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 }
  150252. * @param cameras - The array of cameras that the rendering pipeline will be attached to
  150253. */
  150254. constructor(name: string, scene: Scene, ratio: any, cameras?: Camera[]);
  150255. /**
  150256. * Get the class name
  150257. * @returns "SSAORenderingPipeline"
  150258. */
  150259. getClassName(): string;
  150260. /**
  150261. * Removes the internal pipeline assets and detatches the pipeline from the scene cameras
  150262. */
  150263. dispose(disableDepthRender?: boolean): void;
  150264. private _createBlurPostProcess;
  150265. /** @hidden */
  150266. _rebuild(): void;
  150267. private _createSSAOPostProcess;
  150268. private _createSSAOCombinePostProcess;
  150269. private _createRandomTexture;
  150270. }
  150271. }
  150272. declare module BABYLON {
  150273. /** @hidden */
  150274. export var screenSpaceReflectionPixelShader: {
  150275. name: string;
  150276. shader: string;
  150277. };
  150278. }
  150279. declare module BABYLON {
  150280. /**
  150281. * The ScreenSpaceReflectionPostProcess performs realtime reflections using only and only the available informations on the screen (positions and normals).
  150282. * Basically, the screen space reflection post-process will compute reflections according the material's reflectivity.
  150283. */
  150284. export class ScreenSpaceReflectionPostProcess extends PostProcess {
  150285. /**
  150286. * Gets or sets a reflection threshold mainly used to adjust the reflection's height.
  150287. */
  150288. threshold: number;
  150289. /**
  150290. * Gets or sets the current reflection strength. 1.0 is an ideal value but can be increased/decreased for particular results.
  150291. */
  150292. strength: number;
  150293. /**
  150294. * Gets or sets the falloff exponent used while computing fresnel. More the exponent is high, more the reflections will be discrete.
  150295. */
  150296. reflectionSpecularFalloffExponent: number;
  150297. /**
  150298. * 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]
  150299. */
  150300. step: number;
  150301. /**
  150302. * Gets or sets the factor applied when computing roughness. Default value is 0.2.
  150303. */
  150304. roughnessFactor: number;
  150305. private _geometryBufferRenderer;
  150306. private _enableSmoothReflections;
  150307. private _reflectionSamples;
  150308. private _smoothSteps;
  150309. /**
  150310. * Gets a string identifying the name of the class
  150311. * @returns "ScreenSpaceReflectionPostProcess" string
  150312. */
  150313. getClassName(): string;
  150314. /**
  150315. * Creates a new instance of ScreenSpaceReflectionPostProcess.
  150316. * @param name The name of the effect.
  150317. * @param scene The scene containing the objects to calculate reflections.
  150318. * @param options The required width/height ratio to downsize to before computing the render pass.
  150319. * @param camera The camera to apply the render pass to.
  150320. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  150321. * @param engine The engine which the post process will be applied. (default: current engine)
  150322. * @param reusable If the post process can be reused on the same frame. (default: false)
  150323. * @param textureType Type of textures used when performing the post process. (default: 0)
  150324. * @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)
  150325. */
  150326. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  150327. /**
  150328. * Gets wether or not smoothing reflections is enabled.
  150329. * Enabling smoothing will require more GPU power and can generate a drop in FPS.
  150330. */
  150331. get enableSmoothReflections(): boolean;
  150332. /**
  150333. * Sets wether or not smoothing reflections is enabled.
  150334. * Enabling smoothing will require more GPU power and can generate a drop in FPS.
  150335. */
  150336. set enableSmoothReflections(enabled: boolean);
  150337. /**
  150338. * Gets the number of samples taken while computing reflections. More samples count is high,
  150339. * more the post-process wil require GPU power and can generate a drop in FPS. Basically in interval [25, 100].
  150340. */
  150341. get reflectionSamples(): number;
  150342. /**
  150343. * Sets the number of samples taken while computing reflections. More samples count is high,
  150344. * more the post-process wil require GPU power and can generate a drop in FPS. Basically in interval [25, 100].
  150345. */
  150346. set reflectionSamples(samples: number);
  150347. /**
  150348. * Gets the number of samples taken while smoothing reflections. More samples count is high,
  150349. * more the post-process will require GPU power and can generate a drop in FPS.
  150350. * Default value (5.0) work pretty well in all cases but can be adjusted.
  150351. */
  150352. get smoothSteps(): number;
  150353. set smoothSteps(steps: number);
  150354. private _updateEffectDefines;
  150355. /** @hidden */
  150356. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): ScreenSpaceReflectionPostProcess;
  150357. }
  150358. }
  150359. declare module BABYLON {
  150360. /** @hidden */
  150361. export var standardPixelShader: {
  150362. name: string;
  150363. shader: string;
  150364. };
  150365. }
  150366. declare module BABYLON {
  150367. /**
  150368. * Standard rendering pipeline
  150369. * Default pipeline should be used going forward but the standard pipeline will be kept for backwards compatibility.
  150370. * @see https://doc.babylonjs.com/how_to/using_standard_rendering_pipeline
  150371. */
  150372. export class StandardRenderingPipeline extends PostProcessRenderPipeline implements IDisposable, IAnimatable {
  150373. /**
  150374. * Public members
  150375. */
  150376. /**
  150377. * Post-process which contains the original scene color before the pipeline applies all the effects
  150378. */
  150379. originalPostProcess: Nullable<PostProcess>;
  150380. /**
  150381. * Post-process used to down scale an image x4
  150382. */
  150383. downSampleX4PostProcess: Nullable<PostProcess>;
  150384. /**
  150385. * Post-process used to calculate the illuminated surfaces controlled by a threshold
  150386. */
  150387. brightPassPostProcess: Nullable<PostProcess>;
  150388. /**
  150389. * Post-process array storing all the horizontal blur post-processes used by the pipeline
  150390. */
  150391. blurHPostProcesses: PostProcess[];
  150392. /**
  150393. * Post-process array storing all the vertical blur post-processes used by the pipeline
  150394. */
  150395. blurVPostProcesses: PostProcess[];
  150396. /**
  150397. * Post-process used to add colors of 2 textures (typically brightness + real scene color)
  150398. */
  150399. textureAdderPostProcess: Nullable<PostProcess>;
  150400. /**
  150401. * Post-process used to create volumetric lighting effect
  150402. */
  150403. volumetricLightPostProcess: Nullable<PostProcess>;
  150404. /**
  150405. * Post-process used to smooth the previous volumetric light post-process on the X axis
  150406. */
  150407. volumetricLightSmoothXPostProcess: Nullable<BlurPostProcess>;
  150408. /**
  150409. * Post-process used to smooth the previous volumetric light post-process on the Y axis
  150410. */
  150411. volumetricLightSmoothYPostProcess: Nullable<BlurPostProcess>;
  150412. /**
  150413. * Post-process used to merge the volumetric light effect and the real scene color
  150414. */
  150415. volumetricLightMergePostProces: Nullable<PostProcess>;
  150416. /**
  150417. * Post-process used to store the final volumetric light post-process (attach/detach for debug purpose)
  150418. */
  150419. volumetricLightFinalPostProcess: Nullable<PostProcess>;
  150420. /**
  150421. * Base post-process used to calculate the average luminance of the final image for HDR
  150422. */
  150423. luminancePostProcess: Nullable<PostProcess>;
  150424. /**
  150425. * Post-processes used to create down sample post-processes in order to get
  150426. * the average luminance of the final image for HDR
  150427. * Array of length "StandardRenderingPipeline.LuminanceSteps"
  150428. */
  150429. luminanceDownSamplePostProcesses: PostProcess[];
  150430. /**
  150431. * Post-process used to create a HDR effect (light adaptation)
  150432. */
  150433. hdrPostProcess: Nullable<PostProcess>;
  150434. /**
  150435. * Post-process used to store the final texture adder post-process (attach/detach for debug purpose)
  150436. */
  150437. textureAdderFinalPostProcess: Nullable<PostProcess>;
  150438. /**
  150439. * Post-process used to store the final lens flare post-process (attach/detach for debug purpose)
  150440. */
  150441. lensFlareFinalPostProcess: Nullable<PostProcess>;
  150442. /**
  150443. * Post-process used to merge the final HDR post-process and the real scene color
  150444. */
  150445. hdrFinalPostProcess: Nullable<PostProcess>;
  150446. /**
  150447. * Post-process used to create a lens flare effect
  150448. */
  150449. lensFlarePostProcess: Nullable<PostProcess>;
  150450. /**
  150451. * Post-process that merges the result of the lens flare post-process and the real scene color
  150452. */
  150453. lensFlareComposePostProcess: Nullable<PostProcess>;
  150454. /**
  150455. * Post-process used to create a motion blur effect
  150456. */
  150457. motionBlurPostProcess: Nullable<PostProcess>;
  150458. /**
  150459. * Post-process used to create a depth of field effect
  150460. */
  150461. depthOfFieldPostProcess: Nullable<PostProcess>;
  150462. /**
  150463. * The Fast Approximate Anti-Aliasing post process which attemps to remove aliasing from an image.
  150464. */
  150465. fxaaPostProcess: Nullable<FxaaPostProcess>;
  150466. /**
  150467. * Post-process used to simulate realtime reflections using the screen space and geometry renderer.
  150468. */
  150469. screenSpaceReflectionPostProcess: Nullable<ScreenSpaceReflectionPostProcess>;
  150470. /**
  150471. * Represents the brightness threshold in order to configure the illuminated surfaces
  150472. */
  150473. brightThreshold: number;
  150474. /**
  150475. * Configures the blur intensity used for surexposed surfaces are highlighted surfaces (light halo)
  150476. */
  150477. blurWidth: number;
  150478. /**
  150479. * Sets if the blur for highlighted surfaces must be only horizontal
  150480. */
  150481. horizontalBlur: boolean;
  150482. /**
  150483. * Gets the overall exposure used by the pipeline
  150484. */
  150485. get exposure(): number;
  150486. /**
  150487. * Sets the overall exposure used by the pipeline
  150488. */
  150489. set exposure(value: number);
  150490. /**
  150491. * Texture used typically to simulate "dirty" on camera lens
  150492. */
  150493. lensTexture: Nullable<Texture>;
  150494. /**
  150495. * Represents the offset coefficient based on Rayleigh principle. Typically in interval [-0.2, 0.2]
  150496. */
  150497. volumetricLightCoefficient: number;
  150498. /**
  150499. * The overall power of volumetric lights, typically in interval [0, 10] maximum
  150500. */
  150501. volumetricLightPower: number;
  150502. /**
  150503. * Used the set the blur intensity to smooth the volumetric lights
  150504. */
  150505. volumetricLightBlurScale: number;
  150506. /**
  150507. * Light (spot or directional) used to generate the volumetric lights rays
  150508. * The source light must have a shadow generate so the pipeline can get its
  150509. * depth map
  150510. */
  150511. sourceLight: Nullable<SpotLight | DirectionalLight>;
  150512. /**
  150513. * For eye adaptation, represents the minimum luminance the eye can see
  150514. */
  150515. hdrMinimumLuminance: number;
  150516. /**
  150517. * For eye adaptation, represents the decrease luminance speed
  150518. */
  150519. hdrDecreaseRate: number;
  150520. /**
  150521. * For eye adaptation, represents the increase luminance speed
  150522. */
  150523. hdrIncreaseRate: number;
  150524. /**
  150525. * Gets wether or not the exposure of the overall pipeline should be automatically adjusted by the HDR post-process
  150526. */
  150527. get hdrAutoExposure(): boolean;
  150528. /**
  150529. * Sets wether or not the exposure of the overall pipeline should be automatically adjusted by the HDR post-process
  150530. */
  150531. set hdrAutoExposure(value: boolean);
  150532. /**
  150533. * Lens color texture used by the lens flare effect. Mandatory if lens flare effect enabled
  150534. */
  150535. lensColorTexture: Nullable<Texture>;
  150536. /**
  150537. * The overall strengh for the lens flare effect
  150538. */
  150539. lensFlareStrength: number;
  150540. /**
  150541. * Dispersion coefficient for lens flare ghosts
  150542. */
  150543. lensFlareGhostDispersal: number;
  150544. /**
  150545. * Main lens flare halo width
  150546. */
  150547. lensFlareHaloWidth: number;
  150548. /**
  150549. * Based on the lens distortion effect, defines how much the lens flare result
  150550. * is distorted
  150551. */
  150552. lensFlareDistortionStrength: number;
  150553. /**
  150554. * Configures the blur intensity used for for lens flare (halo)
  150555. */
  150556. lensFlareBlurWidth: number;
  150557. /**
  150558. * Lens star texture must be used to simulate rays on the flares and is available
  150559. * in the documentation
  150560. */
  150561. lensStarTexture: Nullable<Texture>;
  150562. /**
  150563. * As the "lensTexture" (can be the same texture or different), it is used to apply the lens
  150564. * flare effect by taking account of the dirt texture
  150565. */
  150566. lensFlareDirtTexture: Nullable<Texture>;
  150567. /**
  150568. * Represents the focal length for the depth of field effect
  150569. */
  150570. depthOfFieldDistance: number;
  150571. /**
  150572. * Represents the blur intensity for the blurred part of the depth of field effect
  150573. */
  150574. depthOfFieldBlurWidth: number;
  150575. /**
  150576. * Gets how much the image is blurred by the movement while using the motion blur post-process
  150577. */
  150578. get motionStrength(): number;
  150579. /**
  150580. * Sets how much the image is blurred by the movement while using the motion blur post-process
  150581. */
  150582. set motionStrength(strength: number);
  150583. /**
  150584. * Gets wether or not the motion blur post-process is object based or screen based.
  150585. */
  150586. get objectBasedMotionBlur(): boolean;
  150587. /**
  150588. * Sets wether or not the motion blur post-process should be object based or screen based
  150589. */
  150590. set objectBasedMotionBlur(value: boolean);
  150591. /**
  150592. * List of animations for the pipeline (IAnimatable implementation)
  150593. */
  150594. animations: Animation[];
  150595. /**
  150596. * Private members
  150597. */
  150598. private _scene;
  150599. private _currentDepthOfFieldSource;
  150600. private _basePostProcess;
  150601. private _fixedExposure;
  150602. private _currentExposure;
  150603. private _hdrAutoExposure;
  150604. private _hdrCurrentLuminance;
  150605. private _motionStrength;
  150606. private _isObjectBasedMotionBlur;
  150607. private _floatTextureType;
  150608. private _camerasToBeAttached;
  150609. private _ratio;
  150610. private _bloomEnabled;
  150611. private _depthOfFieldEnabled;
  150612. private _vlsEnabled;
  150613. private _lensFlareEnabled;
  150614. private _hdrEnabled;
  150615. private _motionBlurEnabled;
  150616. private _fxaaEnabled;
  150617. private _screenSpaceReflectionsEnabled;
  150618. private _motionBlurSamples;
  150619. private _volumetricLightStepsCount;
  150620. private _samples;
  150621. /**
  150622. * @ignore
  150623. * Specifies if the bloom pipeline is enabled
  150624. */
  150625. get BloomEnabled(): boolean;
  150626. set BloomEnabled(enabled: boolean);
  150627. /**
  150628. * @ignore
  150629. * Specifies if the depth of field pipeline is enabed
  150630. */
  150631. get DepthOfFieldEnabled(): boolean;
  150632. set DepthOfFieldEnabled(enabled: boolean);
  150633. /**
  150634. * @ignore
  150635. * Specifies if the lens flare pipeline is enabed
  150636. */
  150637. get LensFlareEnabled(): boolean;
  150638. set LensFlareEnabled(enabled: boolean);
  150639. /**
  150640. * @ignore
  150641. * Specifies if the HDR pipeline is enabled
  150642. */
  150643. get HDREnabled(): boolean;
  150644. set HDREnabled(enabled: boolean);
  150645. /**
  150646. * @ignore
  150647. * Specifies if the volumetric lights scattering effect is enabled
  150648. */
  150649. get VLSEnabled(): boolean;
  150650. set VLSEnabled(enabled: boolean);
  150651. /**
  150652. * @ignore
  150653. * Specifies if the motion blur effect is enabled
  150654. */
  150655. get MotionBlurEnabled(): boolean;
  150656. set MotionBlurEnabled(enabled: boolean);
  150657. /**
  150658. * Specifies if anti-aliasing is enabled
  150659. */
  150660. get fxaaEnabled(): boolean;
  150661. set fxaaEnabled(enabled: boolean);
  150662. /**
  150663. * Specifies if screen space reflections are enabled.
  150664. */
  150665. get screenSpaceReflectionsEnabled(): boolean;
  150666. set screenSpaceReflectionsEnabled(enabled: boolean);
  150667. /**
  150668. * Specifies the number of steps used to calculate the volumetric lights
  150669. * Typically in interval [50, 200]
  150670. */
  150671. get volumetricLightStepsCount(): number;
  150672. set volumetricLightStepsCount(count: number);
  150673. /**
  150674. * Specifies the number of samples used for the motion blur effect
  150675. * Typically in interval [16, 64]
  150676. */
  150677. get motionBlurSamples(): number;
  150678. set motionBlurSamples(samples: number);
  150679. /**
  150680. * Specifies MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
  150681. */
  150682. get samples(): number;
  150683. set samples(sampleCount: number);
  150684. /**
  150685. * Default pipeline should be used going forward but the standard pipeline will be kept for backwards compatibility.
  150686. * @constructor
  150687. * @param name The rendering pipeline name
  150688. * @param scene The scene linked to this pipeline
  150689. * @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)
  150690. * @param originalPostProcess the custom original color post-process. Must be "reusable". Can be null.
  150691. * @param cameras The array of cameras that the rendering pipeline will be attached to
  150692. */
  150693. constructor(name: string, scene: Scene, ratio: number, originalPostProcess?: Nullable<PostProcess>, cameras?: Camera[]);
  150694. private _buildPipeline;
  150695. private _createDownSampleX4PostProcess;
  150696. private _createBrightPassPostProcess;
  150697. private _createBlurPostProcesses;
  150698. private _createTextureAdderPostProcess;
  150699. private _createVolumetricLightPostProcess;
  150700. private _createLuminancePostProcesses;
  150701. private _createHdrPostProcess;
  150702. private _createLensFlarePostProcess;
  150703. private _createDepthOfFieldPostProcess;
  150704. private _createMotionBlurPostProcess;
  150705. private _getDepthTexture;
  150706. private _disposePostProcesses;
  150707. /**
  150708. * Dispose of the pipeline and stop all post processes
  150709. */
  150710. dispose(): void;
  150711. /**
  150712. * Serialize the rendering pipeline (Used when exporting)
  150713. * @returns the serialized object
  150714. */
  150715. serialize(): any;
  150716. /**
  150717. * Parse the serialized pipeline
  150718. * @param source Source pipeline.
  150719. * @param scene The scene to load the pipeline to.
  150720. * @param rootUrl The URL of the serialized pipeline.
  150721. * @returns An instantiated pipeline from the serialized object.
  150722. */
  150723. static Parse(source: any, scene: Scene, rootUrl: string): StandardRenderingPipeline;
  150724. /**
  150725. * Luminance steps
  150726. */
  150727. static LuminanceSteps: number;
  150728. }
  150729. }
  150730. declare module BABYLON {
  150731. /** @hidden */
  150732. export var stereoscopicInterlacePixelShader: {
  150733. name: string;
  150734. shader: string;
  150735. };
  150736. }
  150737. declare module BABYLON {
  150738. /**
  150739. * StereoscopicInterlacePostProcessI used to render stereo views from a rigged camera with support for alternate line interlacing
  150740. */
  150741. export class StereoscopicInterlacePostProcessI extends PostProcess {
  150742. private _stepSize;
  150743. private _passedProcess;
  150744. /**
  150745. * Gets a string identifying the name of the class
  150746. * @returns "StereoscopicInterlacePostProcessI" string
  150747. */
  150748. getClassName(): string;
  150749. /**
  150750. * Initializes a StereoscopicInterlacePostProcessI
  150751. * @param name The name of the effect.
  150752. * @param rigCameras The rig cameras to be appled to the post process
  150753. * @param isStereoscopicHoriz If the rendered results are horizontal or vertical
  150754. * @param isStereoscopicInterlaced If the rendered results are alternate line interlaced
  150755. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  150756. * @param engine The engine which the post process will be applied. (default: current engine)
  150757. * @param reusable If the post process can be reused on the same frame. (default: false)
  150758. */
  150759. constructor(name: string, rigCameras: Camera[], isStereoscopicHoriz: boolean, isStereoscopicInterlaced: boolean, samplingMode?: number, engine?: Engine, reusable?: boolean);
  150760. }
  150761. /**
  150762. * StereoscopicInterlacePostProcess used to render stereo views from a rigged camera
  150763. */
  150764. export class StereoscopicInterlacePostProcess extends PostProcess {
  150765. private _stepSize;
  150766. private _passedProcess;
  150767. /**
  150768. * Gets a string identifying the name of the class
  150769. * @returns "StereoscopicInterlacePostProcess" string
  150770. */
  150771. getClassName(): string;
  150772. /**
  150773. * Initializes a StereoscopicInterlacePostProcess
  150774. * @param name The name of the effect.
  150775. * @param rigCameras The rig cameras to be appled to the post process
  150776. * @param isStereoscopicHoriz If the rendered results are horizontal or verticle
  150777. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  150778. * @param engine The engine which the post process will be applied. (default: current engine)
  150779. * @param reusable If the post process can be reused on the same frame. (default: false)
  150780. */
  150781. constructor(name: string, rigCameras: Camera[], isStereoscopicHoriz: boolean, samplingMode?: number, engine?: Engine, reusable?: boolean);
  150782. }
  150783. }
  150784. declare module BABYLON {
  150785. /** @hidden */
  150786. export var tonemapPixelShader: {
  150787. name: string;
  150788. shader: string;
  150789. };
  150790. }
  150791. declare module BABYLON {
  150792. /** Defines operator used for tonemapping */
  150793. export enum TonemappingOperator {
  150794. /** Hable */
  150795. Hable = 0,
  150796. /** Reinhard */
  150797. Reinhard = 1,
  150798. /** HejiDawson */
  150799. HejiDawson = 2,
  150800. /** Photographic */
  150801. Photographic = 3
  150802. }
  150803. /**
  150804. * Defines a post process to apply tone mapping
  150805. */
  150806. export class TonemapPostProcess extends PostProcess {
  150807. private _operator;
  150808. /** Defines the required exposure adjustement */
  150809. exposureAdjustment: number;
  150810. /**
  150811. * Gets a string identifying the name of the class
  150812. * @returns "TonemapPostProcess" string
  150813. */
  150814. getClassName(): string;
  150815. /**
  150816. * Creates a new TonemapPostProcess
  150817. * @param name defines the name of the postprocess
  150818. * @param _operator defines the operator to use
  150819. * @param exposureAdjustment defines the required exposure adjustement
  150820. * @param camera defines the camera to use (can be null)
  150821. * @param samplingMode defines the required sampling mode (BABYLON.Texture.BILINEAR_SAMPLINGMODE by default)
  150822. * @param engine defines the hosting engine (can be ignore if camera is set)
  150823. * @param textureFormat defines the texture format to use (BABYLON.Engine.TEXTURETYPE_UNSIGNED_INT by default)
  150824. */
  150825. constructor(name: string, _operator: TonemappingOperator,
  150826. /** Defines the required exposure adjustement */
  150827. exposureAdjustment: number, camera: Camera, samplingMode?: number, engine?: Engine, textureFormat?: number);
  150828. }
  150829. }
  150830. declare module BABYLON {
  150831. /** @hidden */
  150832. export var volumetricLightScatteringPixelShader: {
  150833. name: string;
  150834. shader: string;
  150835. };
  150836. }
  150837. declare module BABYLON {
  150838. /** @hidden */
  150839. export var volumetricLightScatteringPassVertexShader: {
  150840. name: string;
  150841. shader: string;
  150842. };
  150843. }
  150844. declare module BABYLON {
  150845. /** @hidden */
  150846. export var volumetricLightScatteringPassPixelShader: {
  150847. name: string;
  150848. shader: string;
  150849. };
  150850. }
  150851. declare module BABYLON {
  150852. /**
  150853. * Inspired by http://http.developer.nvidia.com/GPUGems3/gpugems3_ch13.html
  150854. */
  150855. export class VolumetricLightScatteringPostProcess extends PostProcess {
  150856. private _volumetricLightScatteringPass;
  150857. private _volumetricLightScatteringRTT;
  150858. private _viewPort;
  150859. private _screenCoordinates;
  150860. private _cachedDefines;
  150861. /**
  150862. * If not undefined, the mesh position is computed from the attached node position
  150863. */
  150864. attachedNode: {
  150865. position: Vector3;
  150866. };
  150867. /**
  150868. * Custom position of the mesh. Used if "useCustomMeshPosition" is set to "true"
  150869. */
  150870. customMeshPosition: Vector3;
  150871. /**
  150872. * Set if the post-process should use a custom position for the light source (true) or the internal mesh position (false)
  150873. */
  150874. useCustomMeshPosition: boolean;
  150875. /**
  150876. * If the post-process should inverse the light scattering direction
  150877. */
  150878. invert: boolean;
  150879. /**
  150880. * The internal mesh used by the post-process
  150881. */
  150882. mesh: Mesh;
  150883. /**
  150884. * @hidden
  150885. * VolumetricLightScatteringPostProcess.useDiffuseColor is no longer used, use the mesh material directly instead
  150886. */
  150887. get useDiffuseColor(): boolean;
  150888. set useDiffuseColor(useDiffuseColor: boolean);
  150889. /**
  150890. * Array containing the excluded meshes not rendered in the internal pass
  150891. */
  150892. excludedMeshes: AbstractMesh[];
  150893. /**
  150894. * Controls the overall intensity of the post-process
  150895. */
  150896. exposure: number;
  150897. /**
  150898. * Dissipates each sample's contribution in range [0, 1]
  150899. */
  150900. decay: number;
  150901. /**
  150902. * Controls the overall intensity of each sample
  150903. */
  150904. weight: number;
  150905. /**
  150906. * Controls the density of each sample
  150907. */
  150908. density: number;
  150909. /**
  150910. * @constructor
  150911. * @param name The post-process name
  150912. * @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)
  150913. * @param camera The camera that the post-process will be attached to
  150914. * @param mesh The mesh used to create the light scattering
  150915. * @param samples The post-process quality, default 100
  150916. * @param samplingModeThe post-process filtering mode
  150917. * @param engine The babylon engine
  150918. * @param reusable If the post-process is reusable
  150919. * @param scene The constructor needs a scene reference to initialize internal components. If "camera" is null a "scene" must be provided
  150920. */
  150921. constructor(name: string, ratio: any, camera: Camera, mesh?: Mesh, samples?: number, samplingMode?: number, engine?: Engine, reusable?: boolean, scene?: Scene);
  150922. /**
  150923. * Returns the string "VolumetricLightScatteringPostProcess"
  150924. * @returns "VolumetricLightScatteringPostProcess"
  150925. */
  150926. getClassName(): string;
  150927. private _isReady;
  150928. /**
  150929. * Sets the new light position for light scattering effect
  150930. * @param position The new custom light position
  150931. */
  150932. setCustomMeshPosition(position: Vector3): void;
  150933. /**
  150934. * Returns the light position for light scattering effect
  150935. * @return Vector3 The custom light position
  150936. */
  150937. getCustomMeshPosition(): Vector3;
  150938. /**
  150939. * Disposes the internal assets and detaches the post-process from the camera
  150940. */
  150941. dispose(camera: Camera): void;
  150942. /**
  150943. * Returns the render target texture used by the post-process
  150944. * @return the render target texture used by the post-process
  150945. */
  150946. getPass(): RenderTargetTexture;
  150947. private _meshExcluded;
  150948. private _createPass;
  150949. private _updateMeshScreenCoordinates;
  150950. /**
  150951. * Creates a default mesh for the Volumeric Light Scattering post-process
  150952. * @param name The mesh name
  150953. * @param scene The scene where to create the mesh
  150954. * @return the default mesh
  150955. */
  150956. static CreateDefaultMesh(name: string, scene: Scene): Mesh;
  150957. }
  150958. }
  150959. declare module BABYLON {
  150960. /** @hidden */
  150961. export var screenSpaceCurvaturePixelShader: {
  150962. name: string;
  150963. shader: string;
  150964. };
  150965. }
  150966. declare module BABYLON {
  150967. /**
  150968. * The Screen Space curvature effect can help highlighting ridge and valley of a model.
  150969. */
  150970. export class ScreenSpaceCurvaturePostProcess extends PostProcess {
  150971. /**
  150972. * Defines how much ridge the curvature effect displays.
  150973. */
  150974. ridge: number;
  150975. /**
  150976. * Defines how much valley the curvature effect displays.
  150977. */
  150978. valley: number;
  150979. private _geometryBufferRenderer;
  150980. /**
  150981. * Gets a string identifying the name of the class
  150982. * @returns "ScreenSpaceCurvaturePostProcess" string
  150983. */
  150984. getClassName(): string;
  150985. /**
  150986. * Creates a new instance ScreenSpaceCurvaturePostProcess
  150987. * @param name The name of the effect.
  150988. * @param scene The scene containing the objects to blur according to their velocity.
  150989. * @param options The required width/height ratio to downsize to before computing the render pass.
  150990. * @param camera The camera to apply the render pass to.
  150991. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  150992. * @param engine The engine which the post process will be applied. (default: current engine)
  150993. * @param reusable If the post process can be reused on the same frame. (default: false)
  150994. * @param textureType Type of textures used when performing the post process. (default: 0)
  150995. * @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)
  150996. */
  150997. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  150998. /**
  150999. * Support test.
  151000. */
  151001. static get IsSupported(): boolean;
  151002. /** @hidden */
  151003. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): ScreenSpaceCurvaturePostProcess;
  151004. }
  151005. }
  151006. declare module BABYLON {
  151007. interface Scene {
  151008. /** @hidden (Backing field) */
  151009. _boundingBoxRenderer: BoundingBoxRenderer;
  151010. /** @hidden (Backing field) */
  151011. _forceShowBoundingBoxes: boolean;
  151012. /**
  151013. * Gets or sets a boolean indicating if all bounding boxes must be rendered
  151014. */
  151015. forceShowBoundingBoxes: boolean;
  151016. /**
  151017. * Gets the bounding box renderer associated with the scene
  151018. * @returns a BoundingBoxRenderer
  151019. */
  151020. getBoundingBoxRenderer(): BoundingBoxRenderer;
  151021. }
  151022. interface AbstractMesh {
  151023. /** @hidden (Backing field) */
  151024. _showBoundingBox: boolean;
  151025. /**
  151026. * Gets or sets a boolean indicating if the bounding box must be rendered as well (false by default)
  151027. */
  151028. showBoundingBox: boolean;
  151029. }
  151030. /**
  151031. * Component responsible of rendering the bounding box of the meshes in a scene.
  151032. * This is usually used through the mesh.showBoundingBox or the scene.forceShowBoundingBoxes properties
  151033. */
  151034. export class BoundingBoxRenderer implements ISceneComponent {
  151035. /**
  151036. * The component name helpfull to identify the component in the list of scene components.
  151037. */
  151038. readonly name: string;
  151039. /**
  151040. * The scene the component belongs to.
  151041. */
  151042. scene: Scene;
  151043. /**
  151044. * Color of the bounding box lines placed in front of an object
  151045. */
  151046. frontColor: Color3;
  151047. /**
  151048. * Color of the bounding box lines placed behind an object
  151049. */
  151050. backColor: Color3;
  151051. /**
  151052. * Defines if the renderer should show the back lines or not
  151053. */
  151054. showBackLines: boolean;
  151055. /**
  151056. * Observable raised before rendering a bounding box
  151057. */
  151058. onBeforeBoxRenderingObservable: Observable<BoundingBox>;
  151059. /**
  151060. * Observable raised after rendering a bounding box
  151061. */
  151062. onAfterBoxRenderingObservable: Observable<BoundingBox>;
  151063. /**
  151064. * @hidden
  151065. */
  151066. renderList: SmartArray<BoundingBox>;
  151067. private _colorShader;
  151068. private _vertexBuffers;
  151069. private _indexBuffer;
  151070. private _fillIndexBuffer;
  151071. private _fillIndexData;
  151072. /**
  151073. * Instantiates a new bounding box renderer in a scene.
  151074. * @param scene the scene the renderer renders in
  151075. */
  151076. constructor(scene: Scene);
  151077. /**
  151078. * Registers the component in a given scene
  151079. */
  151080. register(): void;
  151081. private _evaluateSubMesh;
  151082. private _activeMesh;
  151083. private _prepareRessources;
  151084. private _createIndexBuffer;
  151085. /**
  151086. * Rebuilds the elements related to this component in case of
  151087. * context lost for instance.
  151088. */
  151089. rebuild(): void;
  151090. /**
  151091. * @hidden
  151092. */
  151093. reset(): void;
  151094. /**
  151095. * Render the bounding boxes of a specific rendering group
  151096. * @param renderingGroupId defines the rendering group to render
  151097. */
  151098. render(renderingGroupId: number): void;
  151099. /**
  151100. * In case of occlusion queries, we can render the occlusion bounding box through this method
  151101. * @param mesh Define the mesh to render the occlusion bounding box for
  151102. */
  151103. renderOcclusionBoundingBox(mesh: AbstractMesh): void;
  151104. /**
  151105. * Dispose and release the resources attached to this renderer.
  151106. */
  151107. dispose(): void;
  151108. }
  151109. }
  151110. declare module BABYLON {
  151111. interface Scene {
  151112. /** @hidden (Backing field) */
  151113. _depthRenderer: {
  151114. [id: string]: DepthRenderer;
  151115. };
  151116. /**
  151117. * Creates a depth renderer a given camera which contains a depth map which can be used for post processing.
  151118. * @param camera The camera to create the depth renderer on (default: scene's active camera)
  151119. * @param storeNonLinearDepth Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z
  151120. * @returns the created depth renderer
  151121. */
  151122. enableDepthRenderer(camera?: Nullable<Camera>, storeNonLinearDepth?: boolean): DepthRenderer;
  151123. /**
  151124. * Disables a depth renderer for a given camera
  151125. * @param camera The camera to disable the depth renderer on (default: scene's active camera)
  151126. */
  151127. disableDepthRenderer(camera?: Nullable<Camera>): void;
  151128. }
  151129. /**
  151130. * Defines the Depth Renderer scene component responsible to manage a depth buffer useful
  151131. * in several rendering techniques.
  151132. */
  151133. export class DepthRendererSceneComponent implements ISceneComponent {
  151134. /**
  151135. * The component name helpfull to identify the component in the list of scene components.
  151136. */
  151137. readonly name: string;
  151138. /**
  151139. * The scene the component belongs to.
  151140. */
  151141. scene: Scene;
  151142. /**
  151143. * Creates a new instance of the component for the given scene
  151144. * @param scene Defines the scene to register the component in
  151145. */
  151146. constructor(scene: Scene);
  151147. /**
  151148. * Registers the component in a given scene
  151149. */
  151150. register(): void;
  151151. /**
  151152. * Rebuilds the elements related to this component in case of
  151153. * context lost for instance.
  151154. */
  151155. rebuild(): void;
  151156. /**
  151157. * Disposes the component and the associated ressources
  151158. */
  151159. dispose(): void;
  151160. private _gatherRenderTargets;
  151161. private _gatherActiveCameraRenderTargets;
  151162. }
  151163. }
  151164. declare module BABYLON {
  151165. interface AbstractScene {
  151166. /** @hidden (Backing field) */
  151167. _prePassRenderer: Nullable<PrePassRenderer>;
  151168. /**
  151169. * Gets or Sets the current prepass renderer associated to the scene.
  151170. */
  151171. prePassRenderer: Nullable<PrePassRenderer>;
  151172. /**
  151173. * Enables the prepass and associates it with the scene
  151174. * @returns the PrePassRenderer
  151175. */
  151176. enablePrePassRenderer(): Nullable<PrePassRenderer>;
  151177. /**
  151178. * Disables the prepass associated with the scene
  151179. */
  151180. disablePrePassRenderer(): void;
  151181. }
  151182. /**
  151183. * Defines the Geometry Buffer scene component responsible to manage a G-Buffer useful
  151184. * in several rendering techniques.
  151185. */
  151186. export class PrePassRendererSceneComponent implements ISceneSerializableComponent {
  151187. /**
  151188. * The component name helpful to identify the component in the list of scene components.
  151189. */
  151190. readonly name: string;
  151191. /**
  151192. * The scene the component belongs to.
  151193. */
  151194. scene: Scene;
  151195. /**
  151196. * Creates a new instance of the component for the given scene
  151197. * @param scene Defines the scene to register the component in
  151198. */
  151199. constructor(scene: Scene);
  151200. /**
  151201. * Registers the component in a given scene
  151202. */
  151203. register(): void;
  151204. private _beforeCameraDraw;
  151205. private _afterCameraDraw;
  151206. private _beforeClearStage;
  151207. /**
  151208. * Serializes the component data to the specified json object
  151209. * @param serializationObject The object to serialize to
  151210. */
  151211. serialize(serializationObject: any): void;
  151212. /**
  151213. * Adds all the elements from the container to the scene
  151214. * @param container the container holding the elements
  151215. */
  151216. addFromContainer(container: AbstractScene): void;
  151217. /**
  151218. * Removes all the elements in the container from the scene
  151219. * @param container contains the elements to remove
  151220. * @param dispose if the removed element should be disposed (default: false)
  151221. */
  151222. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  151223. /**
  151224. * Rebuilds the elements related to this component in case of
  151225. * context lost for instance.
  151226. */
  151227. rebuild(): void;
  151228. /**
  151229. * Disposes the component and the associated ressources
  151230. */
  151231. dispose(): void;
  151232. }
  151233. }
  151234. declare module BABYLON {
  151235. /** @hidden */
  151236. export var outlinePixelShader: {
  151237. name: string;
  151238. shader: string;
  151239. };
  151240. }
  151241. declare module BABYLON {
  151242. /** @hidden */
  151243. export var outlineVertexShader: {
  151244. name: string;
  151245. shader: string;
  151246. };
  151247. }
  151248. declare module BABYLON {
  151249. interface Scene {
  151250. /** @hidden */
  151251. _outlineRenderer: OutlineRenderer;
  151252. /**
  151253. * Gets the outline renderer associated with the scene
  151254. * @returns a OutlineRenderer
  151255. */
  151256. getOutlineRenderer(): OutlineRenderer;
  151257. }
  151258. interface AbstractMesh {
  151259. /** @hidden (Backing field) */
  151260. _renderOutline: boolean;
  151261. /**
  151262. * Gets or sets a boolean indicating if the outline must be rendered as well
  151263. * @see https://www.babylonjs-playground.com/#10WJ5S#3
  151264. */
  151265. renderOutline: boolean;
  151266. /** @hidden (Backing field) */
  151267. _renderOverlay: boolean;
  151268. /**
  151269. * Gets or sets a boolean indicating if the overlay must be rendered as well
  151270. * @see https://www.babylonjs-playground.com/#10WJ5S#2
  151271. */
  151272. renderOverlay: boolean;
  151273. }
  151274. /**
  151275. * This class is responsible to draw bothe outline/overlay of meshes.
  151276. * It should not be used directly but through the available method on mesh.
  151277. */
  151278. export class OutlineRenderer implements ISceneComponent {
  151279. /**
  151280. * Stencil value used to avoid outline being seen within the mesh when the mesh is transparent
  151281. */
  151282. private static _StencilReference;
  151283. /**
  151284. * The name of the component. Each component must have a unique name.
  151285. */
  151286. name: string;
  151287. /**
  151288. * The scene the component belongs to.
  151289. */
  151290. scene: Scene;
  151291. /**
  151292. * Defines a zOffset to prevent zFighting between the overlay and the mesh.
  151293. */
  151294. zOffset: number;
  151295. private _engine;
  151296. private _effect;
  151297. private _cachedDefines;
  151298. private _savedDepthWrite;
  151299. /**
  151300. * Instantiates a new outline renderer. (There could be only one per scene).
  151301. * @param scene Defines the scene it belongs to
  151302. */
  151303. constructor(scene: Scene);
  151304. /**
  151305. * Register the component to one instance of a scene.
  151306. */
  151307. register(): void;
  151308. /**
  151309. * Rebuilds the elements related to this component in case of
  151310. * context lost for instance.
  151311. */
  151312. rebuild(): void;
  151313. /**
  151314. * Disposes the component and the associated ressources.
  151315. */
  151316. dispose(): void;
  151317. /**
  151318. * Renders the outline in the canvas.
  151319. * @param subMesh Defines the sumesh to render
  151320. * @param batch Defines the batch of meshes in case of instances
  151321. * @param useOverlay Defines if the rendering is for the overlay or the outline
  151322. */
  151323. render(subMesh: SubMesh, batch: _InstancesBatch, useOverlay?: boolean): void;
  151324. /**
  151325. * Returns whether or not the outline renderer is ready for a given submesh.
  151326. * All the dependencies e.g. submeshes, texture, effect... mus be ready
  151327. * @param subMesh Defines the submesh to check readyness for
  151328. * @param useInstances Defines wheter wee are trying to render instances or not
  151329. * @returns true if ready otherwise false
  151330. */
  151331. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  151332. private _beforeRenderingMesh;
  151333. private _afterRenderingMesh;
  151334. }
  151335. }
  151336. declare module BABYLON {
  151337. /**
  151338. * Defines the basic options interface of a Sprite Frame Source Size.
  151339. */
  151340. export interface ISpriteJSONSpriteSourceSize {
  151341. /**
  151342. * number of the original width of the Frame
  151343. */
  151344. w: number;
  151345. /**
  151346. * number of the original height of the Frame
  151347. */
  151348. h: number;
  151349. }
  151350. /**
  151351. * Defines the basic options interface of a Sprite Frame Data.
  151352. */
  151353. export interface ISpriteJSONSpriteFrameData {
  151354. /**
  151355. * number of the x offset of the Frame
  151356. */
  151357. x: number;
  151358. /**
  151359. * number of the y offset of the Frame
  151360. */
  151361. y: number;
  151362. /**
  151363. * number of the width of the Frame
  151364. */
  151365. w: number;
  151366. /**
  151367. * number of the height of the Frame
  151368. */
  151369. h: number;
  151370. }
  151371. /**
  151372. * Defines the basic options interface of a JSON Sprite.
  151373. */
  151374. export interface ISpriteJSONSprite {
  151375. /**
  151376. * string name of the Frame
  151377. */
  151378. filename: string;
  151379. /**
  151380. * ISpriteJSONSpriteFrame basic object of the frame data
  151381. */
  151382. frame: ISpriteJSONSpriteFrameData;
  151383. /**
  151384. * boolean to flag is the frame was rotated.
  151385. */
  151386. rotated: boolean;
  151387. /**
  151388. * boolean to flag is the frame was trimmed.
  151389. */
  151390. trimmed: boolean;
  151391. /**
  151392. * ISpriteJSONSpriteFrame basic object of the source data
  151393. */
  151394. spriteSourceSize: ISpriteJSONSpriteFrameData;
  151395. /**
  151396. * ISpriteJSONSpriteFrame basic object of the source data
  151397. */
  151398. sourceSize: ISpriteJSONSpriteSourceSize;
  151399. }
  151400. /**
  151401. * Defines the basic options interface of a JSON atlas.
  151402. */
  151403. export interface ISpriteJSONAtlas {
  151404. /**
  151405. * Array of objects that contain the frame data.
  151406. */
  151407. frames: Array<ISpriteJSONSprite>;
  151408. /**
  151409. * object basic object containing the sprite meta data.
  151410. */
  151411. meta?: object;
  151412. }
  151413. }
  151414. declare module BABYLON {
  151415. /** @hidden */
  151416. export var spriteMapPixelShader: {
  151417. name: string;
  151418. shader: string;
  151419. };
  151420. }
  151421. declare module BABYLON {
  151422. /** @hidden */
  151423. export var spriteMapVertexShader: {
  151424. name: string;
  151425. shader: string;
  151426. };
  151427. }
  151428. declare module BABYLON {
  151429. /**
  151430. * Defines the basic options interface of a SpriteMap
  151431. */
  151432. export interface ISpriteMapOptions {
  151433. /**
  151434. * Vector2 of the number of cells in the grid.
  151435. */
  151436. stageSize?: Vector2;
  151437. /**
  151438. * Vector2 of the size of the output plane in World Units.
  151439. */
  151440. outputSize?: Vector2;
  151441. /**
  151442. * Vector3 of the position of the output plane in World Units.
  151443. */
  151444. outputPosition?: Vector3;
  151445. /**
  151446. * Vector3 of the rotation of the output plane.
  151447. */
  151448. outputRotation?: Vector3;
  151449. /**
  151450. * number of layers that the system will reserve in resources.
  151451. */
  151452. layerCount?: number;
  151453. /**
  151454. * number of max animation frames a single cell will reserve in resources.
  151455. */
  151456. maxAnimationFrames?: number;
  151457. /**
  151458. * number cell index of the base tile when the system compiles.
  151459. */
  151460. baseTile?: number;
  151461. /**
  151462. * boolean flip the sprite after its been repositioned by the framing data.
  151463. */
  151464. flipU?: boolean;
  151465. /**
  151466. * Vector3 scalar of the global RGB values of the SpriteMap.
  151467. */
  151468. colorMultiply?: Vector3;
  151469. }
  151470. /**
  151471. * Defines the IDisposable interface in order to be cleanable from resources.
  151472. */
  151473. export interface ISpriteMap extends IDisposable {
  151474. /**
  151475. * String name of the SpriteMap.
  151476. */
  151477. name: string;
  151478. /**
  151479. * The JSON Array file from a https://www.codeandweb.com/texturepacker export. Or similar structure.
  151480. */
  151481. atlasJSON: ISpriteJSONAtlas;
  151482. /**
  151483. * Texture of the SpriteMap.
  151484. */
  151485. spriteSheet: Texture;
  151486. /**
  151487. * The parameters to initialize the SpriteMap with.
  151488. */
  151489. options: ISpriteMapOptions;
  151490. }
  151491. /**
  151492. * Class used to manage a grid restricted sprite deployment on an Output plane.
  151493. */
  151494. export class SpriteMap implements ISpriteMap {
  151495. /** The Name of the spriteMap */
  151496. name: string;
  151497. /** The JSON file with the frame and meta data */
  151498. atlasJSON: ISpriteJSONAtlas;
  151499. /** The systems Sprite Sheet Texture */
  151500. spriteSheet: Texture;
  151501. /** Arguments passed with the Constructor */
  151502. options: ISpriteMapOptions;
  151503. /** Public Sprite Storage array, parsed from atlasJSON */
  151504. sprites: Array<ISpriteJSONSprite>;
  151505. /** Returns the Number of Sprites in the System */
  151506. get spriteCount(): number;
  151507. /** Returns the Position of Output Plane*/
  151508. get position(): Vector3;
  151509. /** Returns the Position of Output Plane*/
  151510. set position(v: Vector3);
  151511. /** Returns the Rotation of Output Plane*/
  151512. get rotation(): Vector3;
  151513. /** Returns the Rotation of Output Plane*/
  151514. set rotation(v: Vector3);
  151515. /** Sets the AnimationMap*/
  151516. get animationMap(): RawTexture;
  151517. /** Sets the AnimationMap*/
  151518. set animationMap(v: RawTexture);
  151519. /** Scene that the SpriteMap was created in */
  151520. private _scene;
  151521. /** Texture Buffer of Float32 that holds tile frame data*/
  151522. private _frameMap;
  151523. /** Texture Buffers of Float32 that holds tileMap data*/
  151524. private _tileMaps;
  151525. /** Texture Buffer of Float32 that holds Animation Data*/
  151526. private _animationMap;
  151527. /** Custom ShaderMaterial Central to the System*/
  151528. private _material;
  151529. /** Custom ShaderMaterial Central to the System*/
  151530. private _output;
  151531. /** Systems Time Ticker*/
  151532. private _time;
  151533. /**
  151534. * Creates a new SpriteMap
  151535. * @param name defines the SpriteMaps Name
  151536. * @param atlasJSON is the JSON file that controls the Sprites Frames and Meta
  151537. * @param spriteSheet is the Texture that the Sprites are on.
  151538. * @param options a basic deployment configuration
  151539. * @param scene The Scene that the map is deployed on
  151540. */
  151541. constructor(name: string, atlasJSON: ISpriteJSONAtlas, spriteSheet: Texture, options: ISpriteMapOptions, scene: Scene);
  151542. /**
  151543. * Returns tileID location
  151544. * @returns Vector2 the cell position ID
  151545. */
  151546. getTileID(): Vector2;
  151547. /**
  151548. * Gets the UV location of the mouse over the SpriteMap.
  151549. * @returns Vector2 the UV position of the mouse interaction
  151550. */
  151551. getMousePosition(): Vector2;
  151552. /**
  151553. * Creates the "frame" texture Buffer
  151554. * -------------------------------------
  151555. * Structure of frames
  151556. * "filename": "Falling-Water-2.png",
  151557. * "frame": {"x":69,"y":103,"w":24,"h":32},
  151558. * "rotated": true,
  151559. * "trimmed": true,
  151560. * "spriteSourceSize": {"x":4,"y":0,"w":24,"h":32},
  151561. * "sourceSize": {"w":32,"h":32}
  151562. * @returns RawTexture of the frameMap
  151563. */
  151564. private _createFrameBuffer;
  151565. /**
  151566. * Creates the tileMap texture Buffer
  151567. * @param buffer normally and array of numbers, or a false to generate from scratch
  151568. * @param _layer indicates what layer for a logic trigger dealing with the baseTile. The system uses this
  151569. * @returns RawTexture of the tileMap
  151570. */
  151571. private _createTileBuffer;
  151572. /**
  151573. * Modifies the data of the tileMaps
  151574. * @param _layer is the ID of the layer you want to edit on the SpriteMap
  151575. * @param pos is the iVector2 Coordinates of the Tile
  151576. * @param tile The SpriteIndex of the new Tile
  151577. */
  151578. changeTiles(_layer: number | undefined, pos: Vector2 | Vector2[], tile?: number): void;
  151579. /**
  151580. * Creates the animationMap texture Buffer
  151581. * @param buffer normally and array of numbers, or a false to generate from scratch
  151582. * @returns RawTexture of the animationMap
  151583. */
  151584. private _createTileAnimationBuffer;
  151585. /**
  151586. * Modifies the data of the animationMap
  151587. * @param cellID is the Index of the Sprite
  151588. * @param _frame is the target Animation frame
  151589. * @param toCell is the Target Index of the next frame of the animation
  151590. * @param time is a value between 0-1 that is the trigger for when the frame should change tiles
  151591. * @param speed is a global scalar of the time variable on the map.
  151592. */
  151593. addAnimationToTile(cellID?: number, _frame?: number, toCell?: number, time?: number, speed?: number): void;
  151594. /**
  151595. * Exports the .tilemaps file
  151596. */
  151597. saveTileMaps(): void;
  151598. /**
  151599. * Imports the .tilemaps file
  151600. * @param url of the .tilemaps file
  151601. */
  151602. loadTileMaps(url: string): void;
  151603. /**
  151604. * Release associated resources
  151605. */
  151606. dispose(): void;
  151607. }
  151608. }
  151609. declare module BABYLON {
  151610. /**
  151611. * Class used to manage multiple sprites of different sizes on the same spritesheet
  151612. * @see https://doc.babylonjs.com/babylon101/sprites
  151613. */
  151614. export class SpritePackedManager extends SpriteManager {
  151615. /** defines the packed manager's name */
  151616. name: string;
  151617. /**
  151618. * Creates a new sprite manager from a packed sprite sheet
  151619. * @param name defines the manager's name
  151620. * @param imgUrl defines the sprite sheet url
  151621. * @param capacity defines the maximum allowed number of sprites
  151622. * @param scene defines the hosting scene
  151623. * @param spriteJSON null otherwise a JSON object defining sprite sheet data
  151624. * @param epsilon defines the epsilon value to align texture (0.01 by default)
  151625. * @param samplingMode defines the smapling mode to use with spritesheet
  151626. * @param fromPacked set to true; do not alter
  151627. */
  151628. constructor(
  151629. /** defines the packed manager's name */
  151630. name: string, imgUrl: string, capacity: number, scene: Scene, spriteJSON?: string | null, epsilon?: number, samplingMode?: number);
  151631. }
  151632. }
  151633. declare module BABYLON {
  151634. /**
  151635. * Defines the list of states available for a task inside a AssetsManager
  151636. */
  151637. export enum AssetTaskState {
  151638. /**
  151639. * Initialization
  151640. */
  151641. INIT = 0,
  151642. /**
  151643. * Running
  151644. */
  151645. RUNNING = 1,
  151646. /**
  151647. * Done
  151648. */
  151649. DONE = 2,
  151650. /**
  151651. * Error
  151652. */
  151653. ERROR = 3
  151654. }
  151655. /**
  151656. * Define an abstract asset task used with a AssetsManager class to load assets into a scene
  151657. */
  151658. export abstract class AbstractAssetTask {
  151659. /**
  151660. * Task name
  151661. */ name: string;
  151662. /**
  151663. * Callback called when the task is successful
  151664. */
  151665. onSuccess: (task: any) => void;
  151666. /**
  151667. * Callback called when the task is not successful
  151668. */
  151669. onError: (task: any, message?: string, exception?: any) => void;
  151670. /**
  151671. * Creates a new AssetsManager
  151672. * @param name defines the name of the task
  151673. */
  151674. constructor(
  151675. /**
  151676. * Task name
  151677. */ name: string);
  151678. private _isCompleted;
  151679. private _taskState;
  151680. private _errorObject;
  151681. /**
  151682. * Get if the task is completed
  151683. */
  151684. get isCompleted(): boolean;
  151685. /**
  151686. * Gets the current state of the task
  151687. */
  151688. get taskState(): AssetTaskState;
  151689. /**
  151690. * Gets the current error object (if task is in error)
  151691. */
  151692. get errorObject(): {
  151693. message?: string;
  151694. exception?: any;
  151695. };
  151696. /**
  151697. * Internal only
  151698. * @hidden
  151699. */
  151700. _setErrorObject(message?: string, exception?: any): void;
  151701. /**
  151702. * Execute the current task
  151703. * @param scene defines the scene where you want your assets to be loaded
  151704. * @param onSuccess is a callback called when the task is successfully executed
  151705. * @param onError is a callback called if an error occurs
  151706. */
  151707. run(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  151708. /**
  151709. * Execute the current task
  151710. * @param scene defines the scene where you want your assets to be loaded
  151711. * @param onSuccess is a callback called when the task is successfully executed
  151712. * @param onError is a callback called if an error occurs
  151713. */
  151714. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  151715. /**
  151716. * Reset will set the task state back to INIT, so the next load call of the assets manager will execute this task again.
  151717. * This can be used with failed tasks that have the reason for failure fixed.
  151718. */
  151719. reset(): void;
  151720. private onErrorCallback;
  151721. private onDoneCallback;
  151722. }
  151723. /**
  151724. * Define the interface used by progress events raised during assets loading
  151725. */
  151726. export interface IAssetsProgressEvent {
  151727. /**
  151728. * Defines the number of remaining tasks to process
  151729. */
  151730. remainingCount: number;
  151731. /**
  151732. * Defines the total number of tasks
  151733. */
  151734. totalCount: number;
  151735. /**
  151736. * Defines the task that was just processed
  151737. */
  151738. task: AbstractAssetTask;
  151739. }
  151740. /**
  151741. * Class used to share progress information about assets loading
  151742. */
  151743. export class AssetsProgressEvent implements IAssetsProgressEvent {
  151744. /**
  151745. * Defines the number of remaining tasks to process
  151746. */
  151747. remainingCount: number;
  151748. /**
  151749. * Defines the total number of tasks
  151750. */
  151751. totalCount: number;
  151752. /**
  151753. * Defines the task that was just processed
  151754. */
  151755. task: AbstractAssetTask;
  151756. /**
  151757. * Creates a AssetsProgressEvent
  151758. * @param remainingCount defines the number of remaining tasks to process
  151759. * @param totalCount defines the total number of tasks
  151760. * @param task defines the task that was just processed
  151761. */
  151762. constructor(remainingCount: number, totalCount: number, task: AbstractAssetTask);
  151763. }
  151764. /**
  151765. * Define a task used by AssetsManager to load assets into a container
  151766. */
  151767. export class ContainerAssetTask extends AbstractAssetTask {
  151768. /**
  151769. * Defines the name of the task
  151770. */
  151771. name: string;
  151772. /**
  151773. * Defines the list of mesh's names you want to load
  151774. */
  151775. meshesNames: any;
  151776. /**
  151777. * Defines the root url to use as a base to load your meshes and associated resources
  151778. */
  151779. rootUrl: string;
  151780. /**
  151781. * Defines the filename or File of the scene to load from
  151782. */
  151783. sceneFilename: string | File;
  151784. /**
  151785. * Get the loaded asset container
  151786. */
  151787. loadedContainer: AssetContainer;
  151788. /**
  151789. * Gets the list of loaded meshes
  151790. */
  151791. loadedMeshes: Array<AbstractMesh>;
  151792. /**
  151793. * Gets the list of loaded particle systems
  151794. */
  151795. loadedParticleSystems: Array<IParticleSystem>;
  151796. /**
  151797. * Gets the list of loaded skeletons
  151798. */
  151799. loadedSkeletons: Array<Skeleton>;
  151800. /**
  151801. * Gets the list of loaded animation groups
  151802. */
  151803. loadedAnimationGroups: Array<AnimationGroup>;
  151804. /**
  151805. * Callback called when the task is successful
  151806. */
  151807. onSuccess: (task: ContainerAssetTask) => void;
  151808. /**
  151809. * Callback called when the task is successful
  151810. */
  151811. onError: (task: ContainerAssetTask, message?: string, exception?: any) => void;
  151812. /**
  151813. * Creates a new ContainerAssetTask
  151814. * @param name defines the name of the task
  151815. * @param meshesNames defines the list of mesh's names you want to load
  151816. * @param rootUrl defines the root url to use as a base to load your meshes and associated resources
  151817. * @param sceneFilename defines the filename or File of the scene to load from
  151818. */
  151819. constructor(
  151820. /**
  151821. * Defines the name of the task
  151822. */
  151823. name: string,
  151824. /**
  151825. * Defines the list of mesh's names you want to load
  151826. */
  151827. meshesNames: any,
  151828. /**
  151829. * Defines the root url to use as a base to load your meshes and associated resources
  151830. */
  151831. rootUrl: string,
  151832. /**
  151833. * Defines the filename or File of the scene to load from
  151834. */
  151835. sceneFilename: string | File);
  151836. /**
  151837. * Execute the current task
  151838. * @param scene defines the scene where you want your assets to be loaded
  151839. * @param onSuccess is a callback called when the task is successfully executed
  151840. * @param onError is a callback called if an error occurs
  151841. */
  151842. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  151843. }
  151844. /**
  151845. * Define a task used by AssetsManager to load meshes
  151846. */
  151847. export class MeshAssetTask extends AbstractAssetTask {
  151848. /**
  151849. * Defines the name of the task
  151850. */
  151851. name: string;
  151852. /**
  151853. * Defines the list of mesh's names you want to load
  151854. */
  151855. meshesNames: any;
  151856. /**
  151857. * Defines the root url to use as a base to load your meshes and associated resources
  151858. */
  151859. rootUrl: string;
  151860. /**
  151861. * Defines the filename or File of the scene to load from
  151862. */
  151863. sceneFilename: string | File;
  151864. /**
  151865. * Gets the list of loaded meshes
  151866. */
  151867. loadedMeshes: Array<AbstractMesh>;
  151868. /**
  151869. * Gets the list of loaded particle systems
  151870. */
  151871. loadedParticleSystems: Array<IParticleSystem>;
  151872. /**
  151873. * Gets the list of loaded skeletons
  151874. */
  151875. loadedSkeletons: Array<Skeleton>;
  151876. /**
  151877. * Gets the list of loaded animation groups
  151878. */
  151879. loadedAnimationGroups: Array<AnimationGroup>;
  151880. /**
  151881. * Callback called when the task is successful
  151882. */
  151883. onSuccess: (task: MeshAssetTask) => void;
  151884. /**
  151885. * Callback called when the task is successful
  151886. */
  151887. onError: (task: MeshAssetTask, message?: string, exception?: any) => void;
  151888. /**
  151889. * Creates a new MeshAssetTask
  151890. * @param name defines the name of the task
  151891. * @param meshesNames defines the list of mesh's names you want to load
  151892. * @param rootUrl defines the root url to use as a base to load your meshes and associated resources
  151893. * @param sceneFilename defines the filename or File of the scene to load from
  151894. */
  151895. constructor(
  151896. /**
  151897. * Defines the name of the task
  151898. */
  151899. name: string,
  151900. /**
  151901. * Defines the list of mesh's names you want to load
  151902. */
  151903. meshesNames: any,
  151904. /**
  151905. * Defines the root url to use as a base to load your meshes and associated resources
  151906. */
  151907. rootUrl: string,
  151908. /**
  151909. * Defines the filename or File of the scene to load from
  151910. */
  151911. sceneFilename: string | File);
  151912. /**
  151913. * Execute the current task
  151914. * @param scene defines the scene where you want your assets to be loaded
  151915. * @param onSuccess is a callback called when the task is successfully executed
  151916. * @param onError is a callback called if an error occurs
  151917. */
  151918. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  151919. }
  151920. /**
  151921. * Define a task used by AssetsManager to load text content
  151922. */
  151923. export class TextFileAssetTask extends AbstractAssetTask {
  151924. /**
  151925. * Defines the name of the task
  151926. */
  151927. name: string;
  151928. /**
  151929. * Defines the location of the file to load
  151930. */
  151931. url: string;
  151932. /**
  151933. * Gets the loaded text string
  151934. */
  151935. text: string;
  151936. /**
  151937. * Callback called when the task is successful
  151938. */
  151939. onSuccess: (task: TextFileAssetTask) => void;
  151940. /**
  151941. * Callback called when the task is successful
  151942. */
  151943. onError: (task: TextFileAssetTask, message?: string, exception?: any) => void;
  151944. /**
  151945. * Creates a new TextFileAssetTask object
  151946. * @param name defines the name of the task
  151947. * @param url defines the location of the file to load
  151948. */
  151949. constructor(
  151950. /**
  151951. * Defines the name of the task
  151952. */
  151953. name: string,
  151954. /**
  151955. * Defines the location of the file to load
  151956. */
  151957. url: string);
  151958. /**
  151959. * Execute the current task
  151960. * @param scene defines the scene where you want your assets to be loaded
  151961. * @param onSuccess is a callback called when the task is successfully executed
  151962. * @param onError is a callback called if an error occurs
  151963. */
  151964. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  151965. }
  151966. /**
  151967. * Define a task used by AssetsManager to load binary data
  151968. */
  151969. export class BinaryFileAssetTask extends AbstractAssetTask {
  151970. /**
  151971. * Defines the name of the task
  151972. */
  151973. name: string;
  151974. /**
  151975. * Defines the location of the file to load
  151976. */
  151977. url: string;
  151978. /**
  151979. * Gets the lodaded data (as an array buffer)
  151980. */
  151981. data: ArrayBuffer;
  151982. /**
  151983. * Callback called when the task is successful
  151984. */
  151985. onSuccess: (task: BinaryFileAssetTask) => void;
  151986. /**
  151987. * Callback called when the task is successful
  151988. */
  151989. onError: (task: BinaryFileAssetTask, message?: string, exception?: any) => void;
  151990. /**
  151991. * Creates a new BinaryFileAssetTask object
  151992. * @param name defines the name of the new task
  151993. * @param url defines the location of the file to load
  151994. */
  151995. constructor(
  151996. /**
  151997. * Defines the name of the task
  151998. */
  151999. name: string,
  152000. /**
  152001. * Defines the location of the file to load
  152002. */
  152003. url: string);
  152004. /**
  152005. * Execute the current task
  152006. * @param scene defines the scene where you want your assets to be loaded
  152007. * @param onSuccess is a callback called when the task is successfully executed
  152008. * @param onError is a callback called if an error occurs
  152009. */
  152010. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  152011. }
  152012. /**
  152013. * Define a task used by AssetsManager to load images
  152014. */
  152015. export class ImageAssetTask extends AbstractAssetTask {
  152016. /**
  152017. * Defines the name of the task
  152018. */
  152019. name: string;
  152020. /**
  152021. * Defines the location of the image to load
  152022. */
  152023. url: string;
  152024. /**
  152025. * Gets the loaded images
  152026. */
  152027. image: HTMLImageElement;
  152028. /**
  152029. * Callback called when the task is successful
  152030. */
  152031. onSuccess: (task: ImageAssetTask) => void;
  152032. /**
  152033. * Callback called when the task is successful
  152034. */
  152035. onError: (task: ImageAssetTask, message?: string, exception?: any) => void;
  152036. /**
  152037. * Creates a new ImageAssetTask
  152038. * @param name defines the name of the task
  152039. * @param url defines the location of the image to load
  152040. */
  152041. constructor(
  152042. /**
  152043. * Defines the name of the task
  152044. */
  152045. name: string,
  152046. /**
  152047. * Defines the location of the image to load
  152048. */
  152049. url: string);
  152050. /**
  152051. * Execute the current task
  152052. * @param scene defines the scene where you want your assets to be loaded
  152053. * @param onSuccess is a callback called when the task is successfully executed
  152054. * @param onError is a callback called if an error occurs
  152055. */
  152056. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  152057. }
  152058. /**
  152059. * Defines the interface used by texture loading tasks
  152060. */
  152061. export interface ITextureAssetTask<TEX extends BaseTexture> {
  152062. /**
  152063. * Gets the loaded texture
  152064. */
  152065. texture: TEX;
  152066. }
  152067. /**
  152068. * Define a task used by AssetsManager to load 2D textures
  152069. */
  152070. export class TextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<Texture> {
  152071. /**
  152072. * Defines the name of the task
  152073. */
  152074. name: string;
  152075. /**
  152076. * Defines the location of the file to load
  152077. */
  152078. url: string;
  152079. /**
  152080. * Defines if mipmap should not be generated (default is false)
  152081. */
  152082. noMipmap?: boolean | undefined;
  152083. /**
  152084. * Defines if texture must be inverted on Y axis (default is true)
  152085. */
  152086. invertY: boolean;
  152087. /**
  152088. * Defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  152089. */
  152090. samplingMode: number;
  152091. /**
  152092. * Gets the loaded texture
  152093. */
  152094. texture: Texture;
  152095. /**
  152096. * Callback called when the task is successful
  152097. */
  152098. onSuccess: (task: TextureAssetTask) => void;
  152099. /**
  152100. * Callback called when the task is successful
  152101. */
  152102. onError: (task: TextureAssetTask, message?: string, exception?: any) => void;
  152103. /**
  152104. * Creates a new TextureAssetTask object
  152105. * @param name defines the name of the task
  152106. * @param url defines the location of the file to load
  152107. * @param noMipmap defines if mipmap should not be generated (default is false)
  152108. * @param invertY defines if texture must be inverted on Y axis (default is true)
  152109. * @param samplingMode defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  152110. */
  152111. constructor(
  152112. /**
  152113. * Defines the name of the task
  152114. */
  152115. name: string,
  152116. /**
  152117. * Defines the location of the file to load
  152118. */
  152119. url: string,
  152120. /**
  152121. * Defines if mipmap should not be generated (default is false)
  152122. */
  152123. noMipmap?: boolean | undefined,
  152124. /**
  152125. * Defines if texture must be inverted on Y axis (default is true)
  152126. */
  152127. invertY?: boolean,
  152128. /**
  152129. * Defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  152130. */
  152131. samplingMode?: number);
  152132. /**
  152133. * Execute the current task
  152134. * @param scene defines the scene where you want your assets to be loaded
  152135. * @param onSuccess is a callback called when the task is successfully executed
  152136. * @param onError is a callback called if an error occurs
  152137. */
  152138. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  152139. }
  152140. /**
  152141. * Define a task used by AssetsManager to load cube textures
  152142. */
  152143. export class CubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<CubeTexture> {
  152144. /**
  152145. * Defines the name of the task
  152146. */
  152147. name: string;
  152148. /**
  152149. * Defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  152150. */
  152151. url: string;
  152152. /**
  152153. * Defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  152154. */
  152155. extensions?: string[] | undefined;
  152156. /**
  152157. * Defines if mipmaps should not be generated (default is false)
  152158. */
  152159. noMipmap?: boolean | undefined;
  152160. /**
  152161. * Defines the explicit list of files (undefined by default)
  152162. */
  152163. files?: string[] | undefined;
  152164. /**
  152165. * Gets the loaded texture
  152166. */
  152167. texture: CubeTexture;
  152168. /**
  152169. * Callback called when the task is successful
  152170. */
  152171. onSuccess: (task: CubeTextureAssetTask) => void;
  152172. /**
  152173. * Callback called when the task is successful
  152174. */
  152175. onError: (task: CubeTextureAssetTask, message?: string, exception?: any) => void;
  152176. /**
  152177. * Creates a new CubeTextureAssetTask
  152178. * @param name defines the name of the task
  152179. * @param url defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  152180. * @param extensions defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  152181. * @param noMipmap defines if mipmaps should not be generated (default is false)
  152182. * @param files defines the explicit list of files (undefined by default)
  152183. */
  152184. constructor(
  152185. /**
  152186. * Defines the name of the task
  152187. */
  152188. name: string,
  152189. /**
  152190. * Defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  152191. */
  152192. url: string,
  152193. /**
  152194. * Defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  152195. */
  152196. extensions?: string[] | undefined,
  152197. /**
  152198. * Defines if mipmaps should not be generated (default is false)
  152199. */
  152200. noMipmap?: boolean | undefined,
  152201. /**
  152202. * Defines the explicit list of files (undefined by default)
  152203. */
  152204. files?: string[] | undefined);
  152205. /**
  152206. * Execute the current task
  152207. * @param scene defines the scene where you want your assets to be loaded
  152208. * @param onSuccess is a callback called when the task is successfully executed
  152209. * @param onError is a callback called if an error occurs
  152210. */
  152211. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  152212. }
  152213. /**
  152214. * Define a task used by AssetsManager to load HDR cube textures
  152215. */
  152216. export class HDRCubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<HDRCubeTexture> {
  152217. /**
  152218. * Defines the name of the task
  152219. */
  152220. name: string;
  152221. /**
  152222. * Defines the location of the file to load
  152223. */
  152224. url: string;
  152225. /**
  152226. * Defines the desired size (the more it increases the longer the generation will be)
  152227. */
  152228. size: number;
  152229. /**
  152230. * Defines if mipmaps should not be generated (default is false)
  152231. */
  152232. noMipmap: boolean;
  152233. /**
  152234. * Specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  152235. */
  152236. generateHarmonics: boolean;
  152237. /**
  152238. * 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)
  152239. */
  152240. gammaSpace: boolean;
  152241. /**
  152242. * Internal Use Only
  152243. */
  152244. reserved: boolean;
  152245. /**
  152246. * Gets the loaded texture
  152247. */
  152248. texture: HDRCubeTexture;
  152249. /**
  152250. * Callback called when the task is successful
  152251. */
  152252. onSuccess: (task: HDRCubeTextureAssetTask) => void;
  152253. /**
  152254. * Callback called when the task is successful
  152255. */
  152256. onError: (task: HDRCubeTextureAssetTask, message?: string, exception?: any) => void;
  152257. /**
  152258. * Creates a new HDRCubeTextureAssetTask object
  152259. * @param name defines the name of the task
  152260. * @param url defines the location of the file to load
  152261. * @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.
  152262. * @param noMipmap defines if mipmaps should not be generated (default is false)
  152263. * @param generateHarmonics specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  152264. * @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)
  152265. * @param reserved Internal use only
  152266. */
  152267. constructor(
  152268. /**
  152269. * Defines the name of the task
  152270. */
  152271. name: string,
  152272. /**
  152273. * Defines the location of the file to load
  152274. */
  152275. url: string,
  152276. /**
  152277. * Defines the desired size (the more it increases the longer the generation will be)
  152278. */
  152279. size: number,
  152280. /**
  152281. * Defines if mipmaps should not be generated (default is false)
  152282. */
  152283. noMipmap?: boolean,
  152284. /**
  152285. * Specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  152286. */
  152287. generateHarmonics?: boolean,
  152288. /**
  152289. * 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)
  152290. */
  152291. gammaSpace?: boolean,
  152292. /**
  152293. * Internal Use Only
  152294. */
  152295. reserved?: boolean);
  152296. /**
  152297. * Execute the current task
  152298. * @param scene defines the scene where you want your assets to be loaded
  152299. * @param onSuccess is a callback called when the task is successfully executed
  152300. * @param onError is a callback called if an error occurs
  152301. */
  152302. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  152303. }
  152304. /**
  152305. * Define a task used by AssetsManager to load Equirectangular cube textures
  152306. */
  152307. export class EquiRectangularCubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<EquiRectangularCubeTexture> {
  152308. /**
  152309. * Defines the name of the task
  152310. */
  152311. name: string;
  152312. /**
  152313. * Defines the location of the file to load
  152314. */
  152315. url: string;
  152316. /**
  152317. * Defines the desired size (the more it increases the longer the generation will be)
  152318. */
  152319. size: number;
  152320. /**
  152321. * Defines if mipmaps should not be generated (default is false)
  152322. */
  152323. noMipmap: boolean;
  152324. /**
  152325. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space,
  152326. * but the standard material would require them in Gamma space) (default is true)
  152327. */
  152328. gammaSpace: boolean;
  152329. /**
  152330. * Gets the loaded texture
  152331. */
  152332. texture: EquiRectangularCubeTexture;
  152333. /**
  152334. * Callback called when the task is successful
  152335. */
  152336. onSuccess: (task: EquiRectangularCubeTextureAssetTask) => void;
  152337. /**
  152338. * Callback called when the task is successful
  152339. */
  152340. onError: (task: EquiRectangularCubeTextureAssetTask, message?: string, exception?: any) => void;
  152341. /**
  152342. * Creates a new EquiRectangularCubeTextureAssetTask object
  152343. * @param name defines the name of the task
  152344. * @param url defines the location of the file to load
  152345. * @param size defines the desired size (the more it increases the longer the generation will be)
  152346. * If the size is omitted this implies you are using a preprocessed cubemap.
  152347. * @param noMipmap defines if mipmaps should not be generated (default is false)
  152348. * @param gammaSpace specifies if the texture will be used in gamma or linear space
  152349. * (the PBR material requires those texture in linear space, but the standard material would require them in Gamma space)
  152350. * (default is true)
  152351. */
  152352. constructor(
  152353. /**
  152354. * Defines the name of the task
  152355. */
  152356. name: string,
  152357. /**
  152358. * Defines the location of the file to load
  152359. */
  152360. url: string,
  152361. /**
  152362. * Defines the desired size (the more it increases the longer the generation will be)
  152363. */
  152364. size: number,
  152365. /**
  152366. * Defines if mipmaps should not be generated (default is false)
  152367. */
  152368. noMipmap?: boolean,
  152369. /**
  152370. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space,
  152371. * but the standard material would require them in Gamma space) (default is true)
  152372. */
  152373. gammaSpace?: boolean);
  152374. /**
  152375. * Execute the current task
  152376. * @param scene defines the scene where you want your assets to be loaded
  152377. * @param onSuccess is a callback called when the task is successfully executed
  152378. * @param onError is a callback called if an error occurs
  152379. */
  152380. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  152381. }
  152382. /**
  152383. * This class can be used to easily import assets into a scene
  152384. * @see https://doc.babylonjs.com/how_to/how_to_use_assetsmanager
  152385. */
  152386. export class AssetsManager {
  152387. private _scene;
  152388. private _isLoading;
  152389. protected _tasks: AbstractAssetTask[];
  152390. protected _waitingTasksCount: number;
  152391. protected _totalTasksCount: number;
  152392. /**
  152393. * Callback called when all tasks are processed
  152394. */
  152395. onFinish: (tasks: AbstractAssetTask[]) => void;
  152396. /**
  152397. * Callback called when a task is successful
  152398. */
  152399. onTaskSuccess: (task: AbstractAssetTask) => void;
  152400. /**
  152401. * Callback called when a task had an error
  152402. */
  152403. onTaskError: (task: AbstractAssetTask) => void;
  152404. /**
  152405. * Callback called when a task is done (whatever the result is)
  152406. */
  152407. onProgress: (remainingCount: number, totalCount: number, task: AbstractAssetTask) => void;
  152408. /**
  152409. * Observable called when all tasks are processed
  152410. */
  152411. onTaskSuccessObservable: Observable<AbstractAssetTask>;
  152412. /**
  152413. * Observable called when a task had an error
  152414. */
  152415. onTaskErrorObservable: Observable<AbstractAssetTask>;
  152416. /**
  152417. * Observable called when all tasks were executed
  152418. */
  152419. onTasksDoneObservable: Observable<AbstractAssetTask[]>;
  152420. /**
  152421. * Observable called when a task is done (whatever the result is)
  152422. */
  152423. onProgressObservable: Observable<IAssetsProgressEvent>;
  152424. /**
  152425. * Gets or sets a boolean defining if the AssetsManager should use the default loading screen
  152426. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  152427. */
  152428. useDefaultLoadingScreen: boolean;
  152429. /**
  152430. * Gets or sets a boolean defining if the AssetsManager should automatically hide the loading screen
  152431. * when all assets have been downloaded.
  152432. * If set to false, you need to manually call in hideLoadingUI() once your scene is ready.
  152433. */
  152434. autoHideLoadingUI: boolean;
  152435. /**
  152436. * Creates a new AssetsManager
  152437. * @param scene defines the scene to work on
  152438. */
  152439. constructor(scene: Scene);
  152440. /**
  152441. * Add a ContainerAssetTask to the list of active tasks
  152442. * @param taskName defines the name of the new task
  152443. * @param meshesNames defines the name of meshes to load
  152444. * @param rootUrl defines the root url to use to locate files
  152445. * @param sceneFilename defines the filename of the scene file
  152446. * @returns a new ContainerAssetTask object
  152447. */
  152448. addContainerTask(taskName: string, meshesNames: any, rootUrl: string, sceneFilename: string): ContainerAssetTask;
  152449. /**
  152450. * Add a MeshAssetTask to the list of active tasks
  152451. * @param taskName defines the name of the new task
  152452. * @param meshesNames defines the name of meshes to load
  152453. * @param rootUrl defines the root url to use to locate files
  152454. * @param sceneFilename defines the filename of the scene file
  152455. * @returns a new MeshAssetTask object
  152456. */
  152457. addMeshTask(taskName: string, meshesNames: any, rootUrl: string, sceneFilename: string): MeshAssetTask;
  152458. /**
  152459. * Add a TextFileAssetTask to the list of active tasks
  152460. * @param taskName defines the name of the new task
  152461. * @param url defines the url of the file to load
  152462. * @returns a new TextFileAssetTask object
  152463. */
  152464. addTextFileTask(taskName: string, url: string): TextFileAssetTask;
  152465. /**
  152466. * Add a BinaryFileAssetTask to the list of active tasks
  152467. * @param taskName defines the name of the new task
  152468. * @param url defines the url of the file to load
  152469. * @returns a new BinaryFileAssetTask object
  152470. */
  152471. addBinaryFileTask(taskName: string, url: string): BinaryFileAssetTask;
  152472. /**
  152473. * Add a ImageAssetTask to the list of active tasks
  152474. * @param taskName defines the name of the new task
  152475. * @param url defines the url of the file to load
  152476. * @returns a new ImageAssetTask object
  152477. */
  152478. addImageTask(taskName: string, url: string): ImageAssetTask;
  152479. /**
  152480. * Add a TextureAssetTask to the list of active tasks
  152481. * @param taskName defines the name of the new task
  152482. * @param url defines the url of the file to load
  152483. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  152484. * @param invertY defines if you want to invert Y axis of the loaded texture (false by default)
  152485. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  152486. * @returns a new TextureAssetTask object
  152487. */
  152488. addTextureTask(taskName: string, url: string, noMipmap?: boolean, invertY?: boolean, samplingMode?: number): TextureAssetTask;
  152489. /**
  152490. * Add a CubeTextureAssetTask to the list of active tasks
  152491. * @param taskName defines the name of the new task
  152492. * @param url defines the url of the file to load
  152493. * @param extensions defines the extension to use to load the cube map (can be null)
  152494. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  152495. * @param files defines the list of files to load (can be null)
  152496. * @returns a new CubeTextureAssetTask object
  152497. */
  152498. addCubeTextureTask(taskName: string, url: string, extensions?: string[], noMipmap?: boolean, files?: string[]): CubeTextureAssetTask;
  152499. /**
  152500. *
  152501. * Add a HDRCubeTextureAssetTask to the list of active tasks
  152502. * @param taskName defines the name of the new task
  152503. * @param url defines the url of the file to load
  152504. * @param size defines the size you want for the cubemap (can be null)
  152505. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  152506. * @param generateHarmonics defines if you want to automatically generate (true by default)
  152507. * @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)
  152508. * @param reserved Internal use only
  152509. * @returns a new HDRCubeTextureAssetTask object
  152510. */
  152511. addHDRCubeTextureTask(taskName: string, url: string, size: number, noMipmap?: boolean, generateHarmonics?: boolean, gammaSpace?: boolean, reserved?: boolean): HDRCubeTextureAssetTask;
  152512. /**
  152513. *
  152514. * Add a EquiRectangularCubeTextureAssetTask to the list of active tasks
  152515. * @param taskName defines the name of the new task
  152516. * @param url defines the url of the file to load
  152517. * @param size defines the size you want for the cubemap (can be null)
  152518. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  152519. * @param gammaSpace Specifies if the texture will be used in gamma or linear space
  152520. * (the PBR material requires those textures in linear space, but the standard material would require them in Gamma space)
  152521. * @returns a new EquiRectangularCubeTextureAssetTask object
  152522. */
  152523. addEquiRectangularCubeTextureAssetTask(taskName: string, url: string, size: number, noMipmap?: boolean, gammaSpace?: boolean): EquiRectangularCubeTextureAssetTask;
  152524. /**
  152525. * Remove a task from the assets manager.
  152526. * @param task the task to remove
  152527. */
  152528. removeTask(task: AbstractAssetTask): void;
  152529. private _decreaseWaitingTasksCount;
  152530. private _runTask;
  152531. /**
  152532. * Reset the AssetsManager and remove all tasks
  152533. * @return the current instance of the AssetsManager
  152534. */
  152535. reset(): AssetsManager;
  152536. /**
  152537. * Start the loading process
  152538. * @return the current instance of the AssetsManager
  152539. */
  152540. load(): AssetsManager;
  152541. /**
  152542. * Start the loading process as an async operation
  152543. * @return a promise returning the list of failed tasks
  152544. */
  152545. loadAsync(): Promise<void>;
  152546. }
  152547. }
  152548. declare module BABYLON {
  152549. /**
  152550. * Wrapper class for promise with external resolve and reject.
  152551. */
  152552. export class Deferred<T> {
  152553. /**
  152554. * The promise associated with this deferred object.
  152555. */
  152556. readonly promise: Promise<T>;
  152557. private _resolve;
  152558. private _reject;
  152559. /**
  152560. * The resolve method of the promise associated with this deferred object.
  152561. */
  152562. get resolve(): (value?: T | PromiseLike<T> | undefined) => void;
  152563. /**
  152564. * The reject method of the promise associated with this deferred object.
  152565. */
  152566. get reject(): (reason?: any) => void;
  152567. /**
  152568. * Constructor for this deferred object.
  152569. */
  152570. constructor();
  152571. }
  152572. }
  152573. declare module BABYLON {
  152574. /**
  152575. * Class used to explode meshes (ie. to have a center and move them away from that center to better see the overall organization)
  152576. */
  152577. export class MeshExploder {
  152578. private _centerMesh;
  152579. private _meshes;
  152580. private _meshesOrigins;
  152581. private _toCenterVectors;
  152582. private _scaledDirection;
  152583. private _newPosition;
  152584. private _centerPosition;
  152585. /**
  152586. * Explodes meshes from a center mesh.
  152587. * @param meshes The meshes to explode.
  152588. * @param centerMesh The mesh to be center of explosion.
  152589. */
  152590. constructor(meshes: Array<Mesh>, centerMesh?: Mesh);
  152591. private _setCenterMesh;
  152592. /**
  152593. * Get class name
  152594. * @returns "MeshExploder"
  152595. */
  152596. getClassName(): string;
  152597. /**
  152598. * "Exploded meshes"
  152599. * @returns Array of meshes with the centerMesh at index 0.
  152600. */
  152601. getMeshes(): Array<Mesh>;
  152602. /**
  152603. * Explodes meshes giving a specific direction
  152604. * @param direction Number to multiply distance of each mesh's origin from center. Use a negative number to implode, or zero to reset.
  152605. */
  152606. explode(direction?: number): void;
  152607. }
  152608. }
  152609. declare module BABYLON {
  152610. /**
  152611. * Class used to help managing file picking and drag'n'drop
  152612. */
  152613. export class FilesInput {
  152614. /**
  152615. * List of files ready to be loaded
  152616. */
  152617. static get FilesToLoad(): {
  152618. [key: string]: File;
  152619. };
  152620. /**
  152621. * Callback called when a file is processed
  152622. */
  152623. onProcessFileCallback: (file: File, name: string, extension: string) => boolean;
  152624. private _engine;
  152625. private _currentScene;
  152626. private _sceneLoadedCallback;
  152627. private _progressCallback;
  152628. private _additionalRenderLoopLogicCallback;
  152629. private _textureLoadingCallback;
  152630. private _startingProcessingFilesCallback;
  152631. private _onReloadCallback;
  152632. private _errorCallback;
  152633. private _elementToMonitor;
  152634. private _sceneFileToLoad;
  152635. private _filesToLoad;
  152636. /**
  152637. * Creates a new FilesInput
  152638. * @param engine defines the rendering engine
  152639. * @param scene defines the hosting scene
  152640. * @param sceneLoadedCallback callback called when scene is loaded
  152641. * @param progressCallback callback called to track progress
  152642. * @param additionalRenderLoopLogicCallback callback called to add user logic to the rendering loop
  152643. * @param textureLoadingCallback callback called when a texture is loading
  152644. * @param startingProcessingFilesCallback callback called when the system is about to process all files
  152645. * @param onReloadCallback callback called when a reload is requested
  152646. * @param errorCallback callback call if an error occurs
  152647. */
  152648. 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>);
  152649. private _dragEnterHandler;
  152650. private _dragOverHandler;
  152651. private _dropHandler;
  152652. /**
  152653. * Calls this function to listen to drag'n'drop events on a specific DOM element
  152654. * @param elementToMonitor defines the DOM element to track
  152655. */
  152656. monitorElementForDragNDrop(elementToMonitor: HTMLElement): void;
  152657. /** Gets the current list of files to load */
  152658. get filesToLoad(): File[];
  152659. /**
  152660. * Release all associated resources
  152661. */
  152662. dispose(): void;
  152663. private renderFunction;
  152664. private drag;
  152665. private drop;
  152666. private _traverseFolder;
  152667. private _processFiles;
  152668. /**
  152669. * Load files from a drop event
  152670. * @param event defines the drop event to use as source
  152671. */
  152672. loadFiles(event: any): void;
  152673. private _processReload;
  152674. /**
  152675. * Reload the current scene from the loaded files
  152676. */
  152677. reload(): void;
  152678. }
  152679. }
  152680. declare module BABYLON {
  152681. /**
  152682. * Defines the root class used to create scene optimization to use with SceneOptimizer
  152683. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  152684. */
  152685. export class SceneOptimization {
  152686. /**
  152687. * Defines the priority of this optimization (0 by default which means first in the list)
  152688. */
  152689. priority: number;
  152690. /**
  152691. * Gets a string describing the action executed by the current optimization
  152692. * @returns description string
  152693. */
  152694. getDescription(): string;
  152695. /**
  152696. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  152697. * @param scene defines the current scene where to apply this optimization
  152698. * @param optimizer defines the current optimizer
  152699. * @returns true if everything that can be done was applied
  152700. */
  152701. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  152702. /**
  152703. * Creates the SceneOptimization object
  152704. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  152705. * @param desc defines the description associated with the optimization
  152706. */
  152707. constructor(
  152708. /**
  152709. * Defines the priority of this optimization (0 by default which means first in the list)
  152710. */
  152711. priority?: number);
  152712. }
  152713. /**
  152714. * Defines an optimization used to reduce the size of render target textures
  152715. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  152716. */
  152717. export class TextureOptimization extends SceneOptimization {
  152718. /**
  152719. * Defines the priority of this optimization (0 by default which means first in the list)
  152720. */
  152721. priority: number;
  152722. /**
  152723. * 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
  152724. */
  152725. maximumSize: number;
  152726. /**
  152727. * Defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  152728. */
  152729. step: number;
  152730. /**
  152731. * Gets a string describing the action executed by the current optimization
  152732. * @returns description string
  152733. */
  152734. getDescription(): string;
  152735. /**
  152736. * Creates the TextureOptimization object
  152737. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  152738. * @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
  152739. * @param step defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  152740. */
  152741. constructor(
  152742. /**
  152743. * Defines the priority of this optimization (0 by default which means first in the list)
  152744. */
  152745. priority?: number,
  152746. /**
  152747. * 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
  152748. */
  152749. maximumSize?: number,
  152750. /**
  152751. * Defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  152752. */
  152753. step?: number);
  152754. /**
  152755. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  152756. * @param scene defines the current scene where to apply this optimization
  152757. * @param optimizer defines the current optimizer
  152758. * @returns true if everything that can be done was applied
  152759. */
  152760. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  152761. }
  152762. /**
  152763. * Defines an optimization used to increase or decrease the rendering resolution
  152764. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  152765. */
  152766. export class HardwareScalingOptimization extends SceneOptimization {
  152767. /**
  152768. * Defines the priority of this optimization (0 by default which means first in the list)
  152769. */
  152770. priority: number;
  152771. /**
  152772. * Defines the maximum scale to use (2 by default)
  152773. */
  152774. maximumScale: number;
  152775. /**
  152776. * Defines the step to use between two passes (0.5 by default)
  152777. */
  152778. step: number;
  152779. private _currentScale;
  152780. private _directionOffset;
  152781. /**
  152782. * Gets a string describing the action executed by the current optimization
  152783. * @return description string
  152784. */
  152785. getDescription(): string;
  152786. /**
  152787. * Creates the HardwareScalingOptimization object
  152788. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  152789. * @param maximumScale defines the maximum scale to use (2 by default)
  152790. * @param step defines the step to use between two passes (0.5 by default)
  152791. */
  152792. constructor(
  152793. /**
  152794. * Defines the priority of this optimization (0 by default which means first in the list)
  152795. */
  152796. priority?: number,
  152797. /**
  152798. * Defines the maximum scale to use (2 by default)
  152799. */
  152800. maximumScale?: number,
  152801. /**
  152802. * Defines the step to use between two passes (0.5 by default)
  152803. */
  152804. step?: number);
  152805. /**
  152806. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  152807. * @param scene defines the current scene where to apply this optimization
  152808. * @param optimizer defines the current optimizer
  152809. * @returns true if everything that can be done was applied
  152810. */
  152811. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  152812. }
  152813. /**
  152814. * Defines an optimization used to remove shadows
  152815. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  152816. */
  152817. export class ShadowsOptimization extends SceneOptimization {
  152818. /**
  152819. * Gets a string describing the action executed by the current optimization
  152820. * @return description string
  152821. */
  152822. getDescription(): string;
  152823. /**
  152824. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  152825. * @param scene defines the current scene where to apply this optimization
  152826. * @param optimizer defines the current optimizer
  152827. * @returns true if everything that can be done was applied
  152828. */
  152829. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  152830. }
  152831. /**
  152832. * Defines an optimization used to turn post-processes off
  152833. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  152834. */
  152835. export class PostProcessesOptimization extends SceneOptimization {
  152836. /**
  152837. * Gets a string describing the action executed by the current optimization
  152838. * @return description string
  152839. */
  152840. getDescription(): string;
  152841. /**
  152842. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  152843. * @param scene defines the current scene where to apply this optimization
  152844. * @param optimizer defines the current optimizer
  152845. * @returns true if everything that can be done was applied
  152846. */
  152847. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  152848. }
  152849. /**
  152850. * Defines an optimization used to turn lens flares off
  152851. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  152852. */
  152853. export class LensFlaresOptimization extends SceneOptimization {
  152854. /**
  152855. * Gets a string describing the action executed by the current optimization
  152856. * @return description string
  152857. */
  152858. getDescription(): string;
  152859. /**
  152860. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  152861. * @param scene defines the current scene where to apply this optimization
  152862. * @param optimizer defines the current optimizer
  152863. * @returns true if everything that can be done was applied
  152864. */
  152865. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  152866. }
  152867. /**
  152868. * Defines an optimization based on user defined callback.
  152869. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  152870. */
  152871. export class CustomOptimization extends SceneOptimization {
  152872. /**
  152873. * Callback called to apply the custom optimization.
  152874. */
  152875. onApply: (scene: Scene, optimizer: SceneOptimizer) => boolean;
  152876. /**
  152877. * Callback called to get custom description
  152878. */
  152879. onGetDescription: () => string;
  152880. /**
  152881. * Gets a string describing the action executed by the current optimization
  152882. * @returns description string
  152883. */
  152884. getDescription(): string;
  152885. /**
  152886. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  152887. * @param scene defines the current scene where to apply this optimization
  152888. * @param optimizer defines the current optimizer
  152889. * @returns true if everything that can be done was applied
  152890. */
  152891. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  152892. }
  152893. /**
  152894. * Defines an optimization used to turn particles off
  152895. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  152896. */
  152897. export class ParticlesOptimization extends SceneOptimization {
  152898. /**
  152899. * Gets a string describing the action executed by the current optimization
  152900. * @return description string
  152901. */
  152902. getDescription(): string;
  152903. /**
  152904. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  152905. * @param scene defines the current scene where to apply this optimization
  152906. * @param optimizer defines the current optimizer
  152907. * @returns true if everything that can be done was applied
  152908. */
  152909. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  152910. }
  152911. /**
  152912. * Defines an optimization used to turn render targets off
  152913. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  152914. */
  152915. export class RenderTargetsOptimization extends SceneOptimization {
  152916. /**
  152917. * Gets a string describing the action executed by the current optimization
  152918. * @return description string
  152919. */
  152920. getDescription(): string;
  152921. /**
  152922. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  152923. * @param scene defines the current scene where to apply this optimization
  152924. * @param optimizer defines the current optimizer
  152925. * @returns true if everything that can be done was applied
  152926. */
  152927. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  152928. }
  152929. /**
  152930. * Defines an optimization used to merge meshes with compatible materials
  152931. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  152932. */
  152933. export class MergeMeshesOptimization extends SceneOptimization {
  152934. private static _UpdateSelectionTree;
  152935. /**
  152936. * Gets or sets a boolean which defines if optimization octree has to be updated
  152937. */
  152938. static get UpdateSelectionTree(): boolean;
  152939. /**
  152940. * Gets or sets a boolean which defines if optimization octree has to be updated
  152941. */
  152942. static set UpdateSelectionTree(value: boolean);
  152943. /**
  152944. * Gets a string describing the action executed by the current optimization
  152945. * @return description string
  152946. */
  152947. getDescription(): string;
  152948. private _canBeMerged;
  152949. /**
  152950. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  152951. * @param scene defines the current scene where to apply this optimization
  152952. * @param optimizer defines the current optimizer
  152953. * @param updateSelectionTree defines that the selection octree has to be updated (false by default)
  152954. * @returns true if everything that can be done was applied
  152955. */
  152956. apply(scene: Scene, optimizer: SceneOptimizer, updateSelectionTree?: boolean): boolean;
  152957. }
  152958. /**
  152959. * Defines a list of options used by SceneOptimizer
  152960. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  152961. */
  152962. export class SceneOptimizerOptions {
  152963. /**
  152964. * Defines the target frame rate to reach (60 by default)
  152965. */
  152966. targetFrameRate: number;
  152967. /**
  152968. * Defines the interval between two checkes (2000ms by default)
  152969. */
  152970. trackerDuration: number;
  152971. /**
  152972. * Gets the list of optimizations to apply
  152973. */
  152974. optimizations: SceneOptimization[];
  152975. /**
  152976. * Creates a new list of options used by SceneOptimizer
  152977. * @param targetFrameRate defines the target frame rate to reach (60 by default)
  152978. * @param trackerDuration defines the interval between two checkes (2000ms by default)
  152979. */
  152980. constructor(
  152981. /**
  152982. * Defines the target frame rate to reach (60 by default)
  152983. */
  152984. targetFrameRate?: number,
  152985. /**
  152986. * Defines the interval between two checkes (2000ms by default)
  152987. */
  152988. trackerDuration?: number);
  152989. /**
  152990. * Add a new optimization
  152991. * @param optimization defines the SceneOptimization to add to the list of active optimizations
  152992. * @returns the current SceneOptimizerOptions
  152993. */
  152994. addOptimization(optimization: SceneOptimization): SceneOptimizerOptions;
  152995. /**
  152996. * Add a new custom optimization
  152997. * @param onApply defines the callback called to apply the custom optimization (true if everything that can be done was applied)
  152998. * @param onGetDescription defines the callback called to get the description attached with the optimization.
  152999. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  153000. * @returns the current SceneOptimizerOptions
  153001. */
  153002. addCustomOptimization(onApply: (scene: Scene) => boolean, onGetDescription: () => string, priority?: number): SceneOptimizerOptions;
  153003. /**
  153004. * Creates a list of pre-defined optimizations aimed to reduce the visual impact on the scene
  153005. * @param targetFrameRate defines the target frame rate (60 by default)
  153006. * @returns a SceneOptimizerOptions object
  153007. */
  153008. static LowDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  153009. /**
  153010. * Creates a list of pre-defined optimizations aimed to have a moderate impact on the scene visual
  153011. * @param targetFrameRate defines the target frame rate (60 by default)
  153012. * @returns a SceneOptimizerOptions object
  153013. */
  153014. static ModerateDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  153015. /**
  153016. * Creates a list of pre-defined optimizations aimed to have a big impact on the scene visual
  153017. * @param targetFrameRate defines the target frame rate (60 by default)
  153018. * @returns a SceneOptimizerOptions object
  153019. */
  153020. static HighDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  153021. }
  153022. /**
  153023. * Class used to run optimizations in order to reach a target frame rate
  153024. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  153025. */
  153026. export class SceneOptimizer implements IDisposable {
  153027. private _isRunning;
  153028. private _options;
  153029. private _scene;
  153030. private _currentPriorityLevel;
  153031. private _targetFrameRate;
  153032. private _trackerDuration;
  153033. private _currentFrameRate;
  153034. private _sceneDisposeObserver;
  153035. private _improvementMode;
  153036. /**
  153037. * Defines an observable called when the optimizer reaches the target frame rate
  153038. */
  153039. onSuccessObservable: Observable<SceneOptimizer>;
  153040. /**
  153041. * Defines an observable called when the optimizer enables an optimization
  153042. */
  153043. onNewOptimizationAppliedObservable: Observable<SceneOptimization>;
  153044. /**
  153045. * Defines an observable called when the optimizer is not able to reach the target frame rate
  153046. */
  153047. onFailureObservable: Observable<SceneOptimizer>;
  153048. /**
  153049. * Gets a boolean indicating if the optimizer is in improvement mode
  153050. */
  153051. get isInImprovementMode(): boolean;
  153052. /**
  153053. * Gets the current priority level (0 at start)
  153054. */
  153055. get currentPriorityLevel(): number;
  153056. /**
  153057. * Gets the current frame rate checked by the SceneOptimizer
  153058. */
  153059. get currentFrameRate(): number;
  153060. /**
  153061. * Gets or sets the current target frame rate (60 by default)
  153062. */
  153063. get targetFrameRate(): number;
  153064. /**
  153065. * Gets or sets the current target frame rate (60 by default)
  153066. */
  153067. set targetFrameRate(value: number);
  153068. /**
  153069. * Gets or sets the current interval between two checks (every 2000ms by default)
  153070. */
  153071. get trackerDuration(): number;
  153072. /**
  153073. * Gets or sets the current interval between two checks (every 2000ms by default)
  153074. */
  153075. set trackerDuration(value: number);
  153076. /**
  153077. * Gets the list of active optimizations
  153078. */
  153079. get optimizations(): SceneOptimization[];
  153080. /**
  153081. * Creates a new SceneOptimizer
  153082. * @param scene defines the scene to work on
  153083. * @param options defines the options to use with the SceneOptimizer
  153084. * @param autoGeneratePriorities defines if priorities must be generated and not read from SceneOptimization property (true by default)
  153085. * @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)
  153086. */
  153087. constructor(scene: Scene, options?: SceneOptimizerOptions, autoGeneratePriorities?: boolean, improvementMode?: boolean);
  153088. /**
  153089. * Stops the current optimizer
  153090. */
  153091. stop(): void;
  153092. /**
  153093. * Reset the optimizer to initial step (current priority level = 0)
  153094. */
  153095. reset(): void;
  153096. /**
  153097. * Start the optimizer. By default it will try to reach a specific framerate
  153098. * but if the optimizer is set with improvementMode === true then it will run all optimiatiation while frame rate is above the target frame rate
  153099. */
  153100. start(): void;
  153101. private _checkCurrentState;
  153102. /**
  153103. * Release all resources
  153104. */
  153105. dispose(): void;
  153106. /**
  153107. * Helper function to create a SceneOptimizer with one single line of code
  153108. * @param scene defines the scene to work on
  153109. * @param options defines the options to use with the SceneOptimizer
  153110. * @param onSuccess defines a callback to call on success
  153111. * @param onFailure defines a callback to call on failure
  153112. * @returns the new SceneOptimizer object
  153113. */
  153114. static OptimizeAsync(scene: Scene, options?: SceneOptimizerOptions, onSuccess?: () => void, onFailure?: () => void): SceneOptimizer;
  153115. }
  153116. }
  153117. declare module BABYLON {
  153118. /**
  153119. * Class used to serialize a scene into a string
  153120. */
  153121. export class SceneSerializer {
  153122. /**
  153123. * Clear cache used by a previous serialization
  153124. */
  153125. static ClearCache(): void;
  153126. /**
  153127. * Serialize a scene into a JSON compatible object
  153128. * @param scene defines the scene to serialize
  153129. * @returns a JSON compatible object
  153130. */
  153131. static Serialize(scene: Scene): any;
  153132. /**
  153133. * Serialize a mesh into a JSON compatible object
  153134. * @param toSerialize defines the mesh to serialize
  153135. * @param withParents defines if parents must be serialized as well
  153136. * @param withChildren defines if children must be serialized as well
  153137. * @returns a JSON compatible object
  153138. */
  153139. static SerializeMesh(toSerialize: any, withParents?: boolean, withChildren?: boolean): any;
  153140. }
  153141. }
  153142. declare module BABYLON {
  153143. /**
  153144. * Class used to host texture specific utilities
  153145. */
  153146. export class TextureTools {
  153147. /**
  153148. * Uses the GPU to create a copy texture rescaled at a given size
  153149. * @param texture Texture to copy from
  153150. * @param width defines the desired width
  153151. * @param height defines the desired height
  153152. * @param useBilinearMode defines if bilinear mode has to be used
  153153. * @return the generated texture
  153154. */
  153155. static CreateResizedCopy(texture: Texture, width: number, height: number, useBilinearMode?: boolean): Texture;
  153156. }
  153157. }
  153158. declare module BABYLON {
  153159. /**
  153160. * This represents the different options available for the video capture.
  153161. */
  153162. export interface VideoRecorderOptions {
  153163. /** Defines the mime type of the video. */
  153164. mimeType: string;
  153165. /** Defines the FPS the video should be recorded at. */
  153166. fps: number;
  153167. /** Defines the chunk size for the recording data. */
  153168. recordChunckSize: number;
  153169. /** The audio tracks to attach to the recording. */
  153170. audioTracks?: MediaStreamTrack[];
  153171. }
  153172. /**
  153173. * This can help with recording videos from BabylonJS.
  153174. * This is based on the available WebRTC functionalities of the browser.
  153175. *
  153176. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_video
  153177. */
  153178. export class VideoRecorder {
  153179. private static readonly _defaultOptions;
  153180. /**
  153181. * Returns whether or not the VideoRecorder is available in your browser.
  153182. * @param engine Defines the Babylon Engine.
  153183. * @returns true if supported otherwise false.
  153184. */
  153185. static IsSupported(engine: Engine): boolean;
  153186. private readonly _options;
  153187. private _canvas;
  153188. private _mediaRecorder;
  153189. private _recordedChunks;
  153190. private _fileName;
  153191. private _resolve;
  153192. private _reject;
  153193. /**
  153194. * True when a recording is already in progress.
  153195. */
  153196. get isRecording(): boolean;
  153197. /**
  153198. * Create a new VideoCapture object which can help converting what you see in Babylon to a video file.
  153199. * @param engine Defines the BabylonJS Engine you wish to record.
  153200. * @param options Defines options that can be used to customize the capture.
  153201. */
  153202. constructor(engine: Engine, options?: Nullable<VideoRecorderOptions>);
  153203. /**
  153204. * Stops the current recording before the default capture timeout passed in the startRecording function.
  153205. */
  153206. stopRecording(): void;
  153207. /**
  153208. * Starts recording the canvas for a max duration specified in parameters.
  153209. * @param fileName Defines the name of the file to be downloaded when the recording stop.
  153210. * If null no automatic download will start and you can rely on the promise to get the data back.
  153211. * @param maxDuration Defines the maximum recording time in seconds.
  153212. * It defaults to 7 seconds. A value of zero will not stop automatically, you would need to call stopRecording manually.
  153213. * @return A promise callback at the end of the recording with the video data in Blob.
  153214. */
  153215. startRecording(fileName?: Nullable<string>, maxDuration?: number): Promise<Blob>;
  153216. /**
  153217. * Releases internal resources used during the recording.
  153218. */
  153219. dispose(): void;
  153220. private _handleDataAvailable;
  153221. private _handleError;
  153222. private _handleStop;
  153223. }
  153224. }
  153225. declare module BABYLON {
  153226. /**
  153227. * Class containing a set of static utilities functions for screenshots
  153228. */
  153229. export class ScreenshotTools {
  153230. /**
  153231. * Captures a screenshot of the current rendering
  153232. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  153233. * @param engine defines the rendering engine
  153234. * @param camera defines the source camera
  153235. * @param size This parameter can be set to a single number or to an object with the
  153236. * following (optional) properties: precision, width, height. If a single number is passed,
  153237. * it will be used for both width and height. If an object is passed, the screenshot size
  153238. * will be derived from the parameters. The precision property is a multiplier allowing
  153239. * rendering at a higher or lower resolution
  153240. * @param successCallback defines the callback receives a single parameter which contains the
  153241. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  153242. * src parameter of an <img> to display it
  153243. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  153244. * Check your browser for supported MIME types
  153245. */
  153246. static CreateScreenshot(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string): void;
  153247. /**
  153248. * Captures a screenshot of the current rendering
  153249. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  153250. * @param engine defines the rendering engine
  153251. * @param camera defines the source camera
  153252. * @param size This parameter can be set to a single number or to an object with the
  153253. * following (optional) properties: precision, width, height. If a single number is passed,
  153254. * it will be used for both width and height. If an object is passed, the screenshot size
  153255. * will be derived from the parameters. The precision property is a multiplier allowing
  153256. * rendering at a higher or lower resolution
  153257. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  153258. * Check your browser for supported MIME types
  153259. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  153260. * to the src parameter of an <img> to display it
  153261. */
  153262. static CreateScreenshotAsync(engine: Engine, camera: Camera, size: any, mimeType?: string): Promise<string>;
  153263. /**
  153264. * Generates an image screenshot from the specified camera.
  153265. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  153266. * @param engine The engine to use for rendering
  153267. * @param camera The camera to use for rendering
  153268. * @param size This parameter can be set to a single number or to an object with the
  153269. * following (optional) properties: precision, width, height. If a single number is passed,
  153270. * it will be used for both width and height. If an object is passed, the screenshot size
  153271. * will be derived from the parameters. The precision property is a multiplier allowing
  153272. * rendering at a higher or lower resolution
  153273. * @param successCallback The callback receives a single parameter which contains the
  153274. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  153275. * src parameter of an <img> to display it
  153276. * @param mimeType The MIME type of the screenshot image (default: image/png).
  153277. * Check your browser for supported MIME types
  153278. * @param samples Texture samples (default: 1)
  153279. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  153280. * @param fileName A name for for the downloaded file.
  153281. * @param renderSprites Whether the sprites should be rendered or not (default: false)
  153282. * @param enableStencilBuffer Whether the stencil buffer should be enabled or not (default: false)
  153283. */
  153284. 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;
  153285. /**
  153286. * Generates an image screenshot from the specified camera.
  153287. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  153288. * @param engine The engine to use for rendering
  153289. * @param camera The camera to use for rendering
  153290. * @param size This parameter can be set to a single number or to an object with the
  153291. * following (optional) properties: precision, width, height. If a single number is passed,
  153292. * it will be used for both width and height. If an object is passed, the screenshot size
  153293. * will be derived from the parameters. The precision property is a multiplier allowing
  153294. * rendering at a higher or lower resolution
  153295. * @param mimeType The MIME type of the screenshot image (default: image/png).
  153296. * Check your browser for supported MIME types
  153297. * @param samples Texture samples (default: 1)
  153298. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  153299. * @param fileName A name for for the downloaded file.
  153300. * @param renderSprites Whether the sprites should be rendered or not (default: false)
  153301. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  153302. * to the src parameter of an <img> to display it
  153303. */
  153304. static CreateScreenshotUsingRenderTargetAsync(engine: Engine, camera: Camera, size: any, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string, renderSprites?: boolean): Promise<string>;
  153305. /**
  153306. * Gets height and width for screenshot size
  153307. * @private
  153308. */
  153309. private static _getScreenshotSize;
  153310. }
  153311. }
  153312. declare module BABYLON {
  153313. /**
  153314. * Interface for a data buffer
  153315. */
  153316. export interface IDataBuffer {
  153317. /**
  153318. * Reads bytes from the data buffer.
  153319. * @param byteOffset The byte offset to read
  153320. * @param byteLength The byte length to read
  153321. * @returns A promise that resolves when the bytes are read
  153322. */
  153323. readAsync(byteOffset: number, byteLength: number): Promise<ArrayBufferView>;
  153324. /**
  153325. * The byte length of the buffer.
  153326. */
  153327. readonly byteLength: number;
  153328. }
  153329. /**
  153330. * Utility class for reading from a data buffer
  153331. */
  153332. export class DataReader {
  153333. /**
  153334. * The data buffer associated with this data reader.
  153335. */
  153336. readonly buffer: IDataBuffer;
  153337. /**
  153338. * The current byte offset from the beginning of the data buffer.
  153339. */
  153340. byteOffset: number;
  153341. private _dataView;
  153342. private _dataByteOffset;
  153343. /**
  153344. * Constructor
  153345. * @param buffer The buffer to read
  153346. */
  153347. constructor(buffer: IDataBuffer);
  153348. /**
  153349. * Loads the given byte length.
  153350. * @param byteLength The byte length to load
  153351. * @returns A promise that resolves when the load is complete
  153352. */
  153353. loadAsync(byteLength: number): Promise<void>;
  153354. /**
  153355. * Read a unsigned 32-bit integer from the currently loaded data range.
  153356. * @returns The 32-bit integer read
  153357. */
  153358. readUint32(): number;
  153359. /**
  153360. * Read a byte array from the currently loaded data range.
  153361. * @param byteLength The byte length to read
  153362. * @returns The byte array read
  153363. */
  153364. readUint8Array(byteLength: number): Uint8Array;
  153365. /**
  153366. * Read a string from the currently loaded data range.
  153367. * @param byteLength The byte length to read
  153368. * @returns The string read
  153369. */
  153370. readString(byteLength: number): string;
  153371. /**
  153372. * Skips the given byte length the currently loaded data range.
  153373. * @param byteLength The byte length to skip
  153374. */
  153375. skipBytes(byteLength: number): void;
  153376. }
  153377. }
  153378. declare module BABYLON {
  153379. /**
  153380. * Class for storing data to local storage if available or in-memory storage otherwise
  153381. */
  153382. export class DataStorage {
  153383. private static _Storage;
  153384. private static _GetStorage;
  153385. /**
  153386. * Reads a string from the data storage
  153387. * @param key The key to read
  153388. * @param defaultValue The value if the key doesn't exist
  153389. * @returns The string value
  153390. */
  153391. static ReadString(key: string, defaultValue: string): string;
  153392. /**
  153393. * Writes a string to the data storage
  153394. * @param key The key to write
  153395. * @param value The value to write
  153396. */
  153397. static WriteString(key: string, value: string): void;
  153398. /**
  153399. * Reads a boolean from the data storage
  153400. * @param key The key to read
  153401. * @param defaultValue The value if the key doesn't exist
  153402. * @returns The boolean value
  153403. */
  153404. static ReadBoolean(key: string, defaultValue: boolean): boolean;
  153405. /**
  153406. * Writes a boolean to the data storage
  153407. * @param key The key to write
  153408. * @param value The value to write
  153409. */
  153410. static WriteBoolean(key: string, value: boolean): void;
  153411. /**
  153412. * Reads a number from the data storage
  153413. * @param key The key to read
  153414. * @param defaultValue The value if the key doesn't exist
  153415. * @returns The number value
  153416. */
  153417. static ReadNumber(key: string, defaultValue: number): number;
  153418. /**
  153419. * Writes a number to the data storage
  153420. * @param key The key to write
  153421. * @param value The value to write
  153422. */
  153423. static WriteNumber(key: string, value: number): void;
  153424. }
  153425. }
  153426. declare module BABYLON {
  153427. /**
  153428. * Class used to record delta files between 2 scene states
  153429. */
  153430. export class SceneRecorder {
  153431. private _trackedScene;
  153432. private _savedJSON;
  153433. /**
  153434. * Track a given scene. This means the current scene state will be considered the original state
  153435. * @param scene defines the scene to track
  153436. */
  153437. track(scene: Scene): void;
  153438. /**
  153439. * Get the delta between current state and original state
  153440. * @returns a string containing the delta
  153441. */
  153442. getDelta(): any;
  153443. private _compareArray;
  153444. private _compareObjects;
  153445. private _compareCollections;
  153446. private static GetShadowGeneratorById;
  153447. /**
  153448. * Apply a given delta to a given scene
  153449. * @param deltaJSON defines the JSON containing the delta
  153450. * @param scene defines the scene to apply the delta to
  153451. */
  153452. static ApplyDelta(deltaJSON: any | string, scene: Scene): void;
  153453. private static _ApplyPropertiesToEntity;
  153454. private static _ApplyDeltaForEntity;
  153455. }
  153456. }
  153457. declare module BABYLON {
  153458. /**
  153459. * An interface for all Hit test features
  153460. */
  153461. export interface IWebXRHitTestFeature<T extends IWebXRLegacyHitResult> extends IWebXRFeature {
  153462. /**
  153463. * Triggered when new babylon (transformed) hit test results are available
  153464. */
  153465. onHitTestResultObservable: Observable<T[]>;
  153466. }
  153467. /**
  153468. * Options used for hit testing
  153469. */
  153470. export interface IWebXRLegacyHitTestOptions {
  153471. /**
  153472. * Only test when user interacted with the scene. Default - hit test every frame
  153473. */
  153474. testOnPointerDownOnly?: boolean;
  153475. /**
  153476. * The node to use to transform the local results to world coordinates
  153477. */
  153478. worldParentNode?: TransformNode;
  153479. }
  153480. /**
  153481. * Interface defining the babylon result of raycasting/hit-test
  153482. */
  153483. export interface IWebXRLegacyHitResult {
  153484. /**
  153485. * Transformation matrix that can be applied to a node that will put it in the hit point location
  153486. */
  153487. transformationMatrix: Matrix;
  153488. /**
  153489. * The native hit test result
  153490. */
  153491. xrHitResult: XRHitResult | XRHitTestResult;
  153492. }
  153493. /**
  153494. * The currently-working hit-test module.
  153495. * Hit test (or Ray-casting) is used to interact with the real world.
  153496. * For further information read here - https://github.com/immersive-web/hit-test
  153497. */
  153498. export class WebXRHitTestLegacy extends WebXRAbstractFeature implements IWebXRHitTestFeature<IWebXRLegacyHitResult> {
  153499. /**
  153500. * options to use when constructing this feature
  153501. */
  153502. readonly options: IWebXRLegacyHitTestOptions;
  153503. private _direction;
  153504. private _mat;
  153505. private _onSelectEnabled;
  153506. private _origin;
  153507. /**
  153508. * The module's name
  153509. */
  153510. static readonly Name: string;
  153511. /**
  153512. * The (Babylon) version of this module.
  153513. * This is an integer representing the implementation version.
  153514. * This number does not correspond to the WebXR specs version
  153515. */
  153516. static readonly Version: number;
  153517. /**
  153518. * Populated with the last native XR Hit Results
  153519. */
  153520. lastNativeXRHitResults: XRHitResult[];
  153521. /**
  153522. * Triggered when new babylon (transformed) hit test results are available
  153523. */
  153524. onHitTestResultObservable: Observable<IWebXRLegacyHitResult[]>;
  153525. /**
  153526. * Creates a new instance of the (legacy version) hit test feature
  153527. * @param _xrSessionManager an instance of WebXRSessionManager
  153528. * @param options options to use when constructing this feature
  153529. */
  153530. constructor(_xrSessionManager: WebXRSessionManager,
  153531. /**
  153532. * options to use when constructing this feature
  153533. */
  153534. options?: IWebXRLegacyHitTestOptions);
  153535. /**
  153536. * execute a hit test with an XR Ray
  153537. *
  153538. * @param xrSession a native xrSession that will execute this hit test
  153539. * @param xrRay the ray (position and direction) to use for ray-casting
  153540. * @param referenceSpace native XR reference space to use for the hit-test
  153541. * @param filter filter function that will filter the results
  153542. * @returns a promise that resolves with an array of native XR hit result in xr coordinates system
  153543. */
  153544. static XRHitTestWithRay(xrSession: XRSession, xrRay: XRRay, referenceSpace: XRReferenceSpace, filter?: (result: XRHitResult) => boolean): Promise<XRHitResult[]>;
  153545. /**
  153546. * Execute a hit test on the current running session using a select event returned from a transient input (such as touch)
  153547. * @param event the (select) event to use to select with
  153548. * @param referenceSpace the reference space to use for this hit test
  153549. * @returns a promise that resolves with an array of native XR hit result in xr coordinates system
  153550. */
  153551. static XRHitTestWithSelectEvent(event: XRInputSourceEvent, referenceSpace: XRReferenceSpace): Promise<XRHitResult[]>;
  153552. /**
  153553. * attach this feature
  153554. * Will usually be called by the features manager
  153555. *
  153556. * @returns true if successful.
  153557. */
  153558. attach(): boolean;
  153559. /**
  153560. * detach this feature.
  153561. * Will usually be called by the features manager
  153562. *
  153563. * @returns true if successful.
  153564. */
  153565. detach(): boolean;
  153566. /**
  153567. * Dispose this feature and all of the resources attached
  153568. */
  153569. dispose(): void;
  153570. protected _onXRFrame(frame: XRFrame): void;
  153571. private _onHitTestResults;
  153572. private _onSelect;
  153573. }
  153574. }
  153575. declare module BABYLON {
  153576. /**
  153577. * Options used for hit testing (version 2)
  153578. */
  153579. export interface IWebXRHitTestOptions extends IWebXRLegacyHitTestOptions {
  153580. /**
  153581. * Do not create a permanent hit test. Will usually be used when only
  153582. * transient inputs are needed.
  153583. */
  153584. disablePermanentHitTest?: boolean;
  153585. /**
  153586. * Enable transient (for example touch-based) hit test inspections
  153587. */
  153588. enableTransientHitTest?: boolean;
  153589. /**
  153590. * Offset ray for the permanent hit test
  153591. */
  153592. offsetRay?: Vector3;
  153593. /**
  153594. * Offset ray for the transient hit test
  153595. */
  153596. transientOffsetRay?: Vector3;
  153597. /**
  153598. * Instead of using viewer space for hit tests, use the reference space defined in the session manager
  153599. */
  153600. useReferenceSpace?: boolean;
  153601. /**
  153602. * Override the default entity type(s) of the hit-test result
  153603. */
  153604. entityTypes?: XRHitTestTrackableType[];
  153605. }
  153606. /**
  153607. * Interface defining the babylon result of hit-test
  153608. */
  153609. export interface IWebXRHitResult extends IWebXRLegacyHitResult {
  153610. /**
  153611. * The input source that generated this hit test (if transient)
  153612. */
  153613. inputSource?: XRInputSource;
  153614. /**
  153615. * Is this a transient hit test
  153616. */
  153617. isTransient?: boolean;
  153618. /**
  153619. * Position of the hit test result
  153620. */
  153621. position: Vector3;
  153622. /**
  153623. * Rotation of the hit test result
  153624. */
  153625. rotationQuaternion: Quaternion;
  153626. /**
  153627. * The native hit test result
  153628. */
  153629. xrHitResult: XRHitTestResult;
  153630. }
  153631. /**
  153632. * The currently-working hit-test module.
  153633. * Hit test (or Ray-casting) is used to interact with the real world.
  153634. * For further information read here - https://github.com/immersive-web/hit-test
  153635. *
  153636. * Tested on chrome (mobile) 80.
  153637. */
  153638. export class WebXRHitTest extends WebXRAbstractFeature implements IWebXRHitTestFeature<IWebXRHitResult> {
  153639. /**
  153640. * options to use when constructing this feature
  153641. */
  153642. readonly options: IWebXRHitTestOptions;
  153643. private _tmpMat;
  153644. private _tmpPos;
  153645. private _tmpQuat;
  153646. private _transientXrHitTestSource;
  153647. private _xrHitTestSource;
  153648. private initHitTestSource;
  153649. /**
  153650. * The module's name
  153651. */
  153652. static readonly Name: string;
  153653. /**
  153654. * The (Babylon) version of this module.
  153655. * This is an integer representing the implementation version.
  153656. * This number does not correspond to the WebXR specs version
  153657. */
  153658. static readonly Version: number;
  153659. /**
  153660. * When set to true, each hit test will have its own position/rotation objects
  153661. * When set to false, position and rotation objects will be reused for each hit test. It is expected that
  153662. * the developers will clone them or copy them as they see fit.
  153663. */
  153664. autoCloneTransformation: boolean;
  153665. /**
  153666. * Triggered when new babylon (transformed) hit test results are available
  153667. */
  153668. onHitTestResultObservable: Observable<IWebXRHitResult[]>;
  153669. /**
  153670. * Use this to temporarily pause hit test checks.
  153671. */
  153672. paused: boolean;
  153673. /**
  153674. * Creates a new instance of the hit test feature
  153675. * @param _xrSessionManager an instance of WebXRSessionManager
  153676. * @param options options to use when constructing this feature
  153677. */
  153678. constructor(_xrSessionManager: WebXRSessionManager,
  153679. /**
  153680. * options to use when constructing this feature
  153681. */
  153682. options?: IWebXRHitTestOptions);
  153683. /**
  153684. * attach this feature
  153685. * Will usually be called by the features manager
  153686. *
  153687. * @returns true if successful.
  153688. */
  153689. attach(): boolean;
  153690. /**
  153691. * detach this feature.
  153692. * Will usually be called by the features manager
  153693. *
  153694. * @returns true if successful.
  153695. */
  153696. detach(): boolean;
  153697. /**
  153698. * Dispose this feature and all of the resources attached
  153699. */
  153700. dispose(): void;
  153701. protected _onXRFrame(frame: XRFrame): void;
  153702. private _processWebXRHitTestResult;
  153703. }
  153704. }
  153705. declare module BABYLON {
  153706. /**
  153707. * Configuration options of the anchor system
  153708. */
  153709. export interface IWebXRAnchorSystemOptions {
  153710. /**
  153711. * a node that will be used to convert local to world coordinates
  153712. */
  153713. worldParentNode?: TransformNode;
  153714. /**
  153715. * If set to true a reference of the created anchors will be kept until the next session starts
  153716. * If not defined, anchors will be removed from the array when the feature is detached or the session ended.
  153717. */
  153718. doNotRemoveAnchorsOnSessionEnded?: boolean;
  153719. }
  153720. /**
  153721. * A babylon container for an XR Anchor
  153722. */
  153723. export interface IWebXRAnchor {
  153724. /**
  153725. * A babylon-assigned ID for this anchor
  153726. */
  153727. id: number;
  153728. /**
  153729. * Transformation matrix to apply to an object attached to this anchor
  153730. */
  153731. transformationMatrix: Matrix;
  153732. /**
  153733. * The native anchor object
  153734. */
  153735. xrAnchor: XRAnchor;
  153736. /**
  153737. * if defined, this object will be constantly updated by the anchor's position and rotation
  153738. */
  153739. attachedNode?: TransformNode;
  153740. }
  153741. /**
  153742. * An implementation of the anchor system for WebXR.
  153743. * For further information see https://github.com/immersive-web/anchors/
  153744. */
  153745. export class WebXRAnchorSystem extends WebXRAbstractFeature {
  153746. private _options;
  153747. private _lastFrameDetected;
  153748. private _trackedAnchors;
  153749. private _referenceSpaceForFrameAnchors;
  153750. private _futureAnchors;
  153751. /**
  153752. * The module's name
  153753. */
  153754. static readonly Name: string;
  153755. /**
  153756. * The (Babylon) version of this module.
  153757. * This is an integer representing the implementation version.
  153758. * This number does not correspond to the WebXR specs version
  153759. */
  153760. static readonly Version: number;
  153761. /**
  153762. * Observers registered here will be executed when a new anchor was added to the session
  153763. */
  153764. onAnchorAddedObservable: Observable<IWebXRAnchor>;
  153765. /**
  153766. * Observers registered here will be executed when an anchor was removed from the session
  153767. */
  153768. onAnchorRemovedObservable: Observable<IWebXRAnchor>;
  153769. /**
  153770. * Observers registered here will be executed when an existing anchor updates
  153771. * This can execute N times every frame
  153772. */
  153773. onAnchorUpdatedObservable: Observable<IWebXRAnchor>;
  153774. /**
  153775. * Set the reference space to use for anchor creation, when not using a hit test.
  153776. * Will default to the session's reference space if not defined
  153777. */
  153778. set referenceSpaceForFrameAnchors(referenceSpace: XRReferenceSpace);
  153779. /**
  153780. * constructs a new anchor system
  153781. * @param _xrSessionManager an instance of WebXRSessionManager
  153782. * @param _options configuration object for this feature
  153783. */
  153784. constructor(_xrSessionManager: WebXRSessionManager, _options?: IWebXRAnchorSystemOptions);
  153785. private _tmpVector;
  153786. private _tmpQuaternion;
  153787. private _populateTmpTransformation;
  153788. /**
  153789. * Create a new anchor point using a hit test result at a specific point in the scene
  153790. * An anchor is tracked only after it is added to the trackerAnchors in xrFrame. The promise returned here does not yet guaranty that.
  153791. * Use onAnchorAddedObservable to get newly added anchors if you require tracking guaranty.
  153792. *
  153793. * @param hitTestResult The hit test result to use for this anchor creation
  153794. * @param position an optional position offset for this anchor
  153795. * @param rotationQuaternion an optional rotation offset for this anchor
  153796. * @returns A promise that fulfills when the XR anchor was registered in the system (but not necessarily added to the tracked anchors)
  153797. */
  153798. addAnchorPointUsingHitTestResultAsync(hitTestResult: IWebXRHitResult, position?: Vector3, rotationQuaternion?: Quaternion): Promise<XRAnchor>;
  153799. /**
  153800. * Add a new anchor at a specific position and rotation
  153801. * This function will add a new anchor per default in the next available frame. Unless forced, the createAnchor function
  153802. * will be called in the next xrFrame loop to make sure that the anchor can be created correctly.
  153803. * An anchor is tracked only after it is added to the trackerAnchors in xrFrame. The promise returned here does not yet guaranty that.
  153804. * Use onAnchorAddedObservable to get newly added anchors if you require tracking guaranty.
  153805. *
  153806. * @param position the position in which to add an anchor
  153807. * @param rotationQuaternion an optional rotation for the anchor transformation
  153808. * @param forceCreateInCurrentFrame force the creation of this anchor in the current frame. Must be called inside xrFrame loop!
  153809. * @returns A promise that fulfills when the XR anchor was registered in the system (but not necessarily added to the tracked anchors)
  153810. */
  153811. addAnchorAtPositionAndRotationAsync(position: Vector3, rotationQuaternion?: Quaternion, forceCreateInCurrentFrame?: boolean): Promise<XRAnchor>;
  153812. /**
  153813. * detach this feature.
  153814. * Will usually be called by the features manager
  153815. *
  153816. * @returns true if successful.
  153817. */
  153818. detach(): boolean;
  153819. /**
  153820. * Dispose this feature and all of the resources attached
  153821. */
  153822. dispose(): void;
  153823. protected _onXRFrame(frame: XRFrame): void;
  153824. /**
  153825. * avoiding using Array.find for global support.
  153826. * @param xrAnchor the plane to find in the array
  153827. */
  153828. private _findIndexInAnchorArray;
  153829. private _updateAnchorWithXRFrame;
  153830. private _createAnchorAtTransformation;
  153831. }
  153832. }
  153833. declare module BABYLON {
  153834. /**
  153835. * Options used in the plane detector module
  153836. */
  153837. export interface IWebXRPlaneDetectorOptions {
  153838. /**
  153839. * The node to use to transform the local results to world coordinates
  153840. */
  153841. worldParentNode?: TransformNode;
  153842. /**
  153843. * If set to true a reference of the created planes will be kept until the next session starts
  153844. * If not defined, planes will be removed from the array when the feature is detached or the session ended.
  153845. */
  153846. doNotRemovePlanesOnSessionEnded?: boolean;
  153847. }
  153848. /**
  153849. * A babylon interface for a WebXR plane.
  153850. * A Plane is actually a polygon, built from N points in space
  153851. *
  153852. * Supported in chrome 79, not supported in canary 81 ATM
  153853. */
  153854. export interface IWebXRPlane {
  153855. /**
  153856. * a babylon-assigned ID for this polygon
  153857. */
  153858. id: number;
  153859. /**
  153860. * an array of vector3 points in babylon space. right/left hand system is taken into account.
  153861. */
  153862. polygonDefinition: Array<Vector3>;
  153863. /**
  153864. * A transformation matrix to apply on the mesh that will be built using the polygonDefinition
  153865. * Local vs. World are decided if worldParentNode was provided or not in the options when constructing the module
  153866. */
  153867. transformationMatrix: Matrix;
  153868. /**
  153869. * the native xr-plane object
  153870. */
  153871. xrPlane: XRPlane;
  153872. }
  153873. /**
  153874. * The plane detector is used to detect planes in the real world when in AR
  153875. * For more information see https://github.com/immersive-web/real-world-geometry/
  153876. */
  153877. export class WebXRPlaneDetector extends WebXRAbstractFeature {
  153878. private _options;
  153879. private _detectedPlanes;
  153880. private _enabled;
  153881. private _lastFrameDetected;
  153882. /**
  153883. * The module's name
  153884. */
  153885. static readonly Name: string;
  153886. /**
  153887. * The (Babylon) version of this module.
  153888. * This is an integer representing the implementation version.
  153889. * This number does not correspond to the WebXR specs version
  153890. */
  153891. static readonly Version: number;
  153892. /**
  153893. * Observers registered here will be executed when a new plane was added to the session
  153894. */
  153895. onPlaneAddedObservable: Observable<IWebXRPlane>;
  153896. /**
  153897. * Observers registered here will be executed when a plane is no longer detected in the session
  153898. */
  153899. onPlaneRemovedObservable: Observable<IWebXRPlane>;
  153900. /**
  153901. * Observers registered here will be executed when an existing plane updates (for example - expanded)
  153902. * This can execute N times every frame
  153903. */
  153904. onPlaneUpdatedObservable: Observable<IWebXRPlane>;
  153905. /**
  153906. * construct a new Plane Detector
  153907. * @param _xrSessionManager an instance of xr Session manager
  153908. * @param _options configuration to use when constructing this feature
  153909. */
  153910. constructor(_xrSessionManager: WebXRSessionManager, _options?: IWebXRPlaneDetectorOptions);
  153911. /**
  153912. * detach this feature.
  153913. * Will usually be called by the features manager
  153914. *
  153915. * @returns true if successful.
  153916. */
  153917. detach(): boolean;
  153918. /**
  153919. * Dispose this feature and all of the resources attached
  153920. */
  153921. dispose(): void;
  153922. protected _onXRFrame(frame: XRFrame): void;
  153923. private _init;
  153924. private _updatePlaneWithXRPlane;
  153925. /**
  153926. * avoiding using Array.find for global support.
  153927. * @param xrPlane the plane to find in the array
  153928. */
  153929. private findIndexInPlaneArray;
  153930. }
  153931. }
  153932. declare module BABYLON {
  153933. /**
  153934. * Options interface for the background remover plugin
  153935. */
  153936. export interface IWebXRBackgroundRemoverOptions {
  153937. /**
  153938. * Further background meshes to disable when entering AR
  153939. */
  153940. backgroundMeshes?: AbstractMesh[];
  153941. /**
  153942. * flags to configure the removal of the environment helper.
  153943. * If not set, the entire background will be removed. If set, flags should be set as well.
  153944. */
  153945. environmentHelperRemovalFlags?: {
  153946. /**
  153947. * Should the skybox be removed (default false)
  153948. */
  153949. skyBox?: boolean;
  153950. /**
  153951. * Should the ground be removed (default false)
  153952. */
  153953. ground?: boolean;
  153954. };
  153955. /**
  153956. * don't disable the environment helper
  153957. */
  153958. ignoreEnvironmentHelper?: boolean;
  153959. }
  153960. /**
  153961. * A module that will automatically disable background meshes when entering AR and will enable them when leaving AR.
  153962. */
  153963. export class WebXRBackgroundRemover extends WebXRAbstractFeature {
  153964. /**
  153965. * read-only options to be used in this module
  153966. */
  153967. readonly options: IWebXRBackgroundRemoverOptions;
  153968. /**
  153969. * The module's name
  153970. */
  153971. static readonly Name: string;
  153972. /**
  153973. * The (Babylon) version of this module.
  153974. * This is an integer representing the implementation version.
  153975. * This number does not correspond to the WebXR specs version
  153976. */
  153977. static readonly Version: number;
  153978. /**
  153979. * registered observers will be triggered when the background state changes
  153980. */
  153981. onBackgroundStateChangedObservable: Observable<boolean>;
  153982. /**
  153983. * constructs a new background remover module
  153984. * @param _xrSessionManager the session manager for this module
  153985. * @param options read-only options to be used in this module
  153986. */
  153987. constructor(_xrSessionManager: WebXRSessionManager,
  153988. /**
  153989. * read-only options to be used in this module
  153990. */
  153991. options?: IWebXRBackgroundRemoverOptions);
  153992. /**
  153993. * attach this feature
  153994. * Will usually be called by the features manager
  153995. *
  153996. * @returns true if successful.
  153997. */
  153998. attach(): boolean;
  153999. /**
  154000. * detach this feature.
  154001. * Will usually be called by the features manager
  154002. *
  154003. * @returns true if successful.
  154004. */
  154005. detach(): boolean;
  154006. /**
  154007. * Dispose this feature and all of the resources attached
  154008. */
  154009. dispose(): void;
  154010. protected _onXRFrame(_xrFrame: XRFrame): void;
  154011. private _setBackgroundState;
  154012. }
  154013. }
  154014. declare module BABYLON {
  154015. /**
  154016. * Options for the controller physics feature
  154017. */
  154018. export class IWebXRControllerPhysicsOptions {
  154019. /**
  154020. * Should the headset get its own impostor
  154021. */
  154022. enableHeadsetImpostor?: boolean;
  154023. /**
  154024. * Optional parameters for the headset impostor
  154025. */
  154026. headsetImpostorParams?: {
  154027. /**
  154028. * The type of impostor to create. Default is sphere
  154029. */
  154030. impostorType: number;
  154031. /**
  154032. * the size of the impostor. Defaults to 10cm
  154033. */
  154034. impostorSize?: number | {
  154035. width: number;
  154036. height: number;
  154037. depth: number;
  154038. };
  154039. /**
  154040. * Friction definitions
  154041. */
  154042. friction?: number;
  154043. /**
  154044. * Restitution
  154045. */
  154046. restitution?: number;
  154047. };
  154048. /**
  154049. * The physics properties of the future impostors
  154050. */
  154051. physicsProperties?: {
  154052. /**
  154053. * If set to true, a mesh impostor will be created when the controller mesh was loaded
  154054. * Note that this requires a physics engine that supports mesh impostors!
  154055. */
  154056. useControllerMesh?: boolean;
  154057. /**
  154058. * The type of impostor to create. Default is sphere
  154059. */
  154060. impostorType?: number;
  154061. /**
  154062. * the size of the impostor. Defaults to 10cm
  154063. */
  154064. impostorSize?: number | {
  154065. width: number;
  154066. height: number;
  154067. depth: number;
  154068. };
  154069. /**
  154070. * Friction definitions
  154071. */
  154072. friction?: number;
  154073. /**
  154074. * Restitution
  154075. */
  154076. restitution?: number;
  154077. };
  154078. /**
  154079. * the xr input to use with this pointer selection
  154080. */
  154081. xrInput: WebXRInput;
  154082. }
  154083. /**
  154084. * Add physics impostor to your webxr controllers,
  154085. * including naive calculation of their linear and angular velocity
  154086. */
  154087. export class WebXRControllerPhysics extends WebXRAbstractFeature {
  154088. private readonly _options;
  154089. private _attachController;
  154090. private _controllers;
  154091. private _debugMode;
  154092. private _delta;
  154093. private _headsetImpostor?;
  154094. private _headsetMesh?;
  154095. private _lastTimestamp;
  154096. private _tmpQuaternion;
  154097. private _tmpVector;
  154098. /**
  154099. * The module's name
  154100. */
  154101. static readonly Name: string;
  154102. /**
  154103. * The (Babylon) version of this module.
  154104. * This is an integer representing the implementation version.
  154105. * This number does not correspond to the webxr specs version
  154106. */
  154107. static readonly Version: number;
  154108. /**
  154109. * Construct a new Controller Physics Feature
  154110. * @param _xrSessionManager the corresponding xr session manager
  154111. * @param _options options to create this feature with
  154112. */
  154113. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRControllerPhysicsOptions);
  154114. /**
  154115. * @hidden
  154116. * enable debugging - will show console outputs and the impostor mesh
  154117. */
  154118. _enablePhysicsDebug(): void;
  154119. /**
  154120. * Manually add a controller (if no xrInput was provided or physics engine was not enabled)
  154121. * @param xrController the controller to add
  154122. */
  154123. addController(xrController: WebXRInputSource): void;
  154124. /**
  154125. * attach this feature
  154126. * Will usually be called by the features manager
  154127. *
  154128. * @returns true if successful.
  154129. */
  154130. attach(): boolean;
  154131. /**
  154132. * detach this feature.
  154133. * Will usually be called by the features manager
  154134. *
  154135. * @returns true if successful.
  154136. */
  154137. detach(): boolean;
  154138. /**
  154139. * Get the headset impostor, if enabled
  154140. * @returns the impostor
  154141. */
  154142. getHeadsetImpostor(): PhysicsImpostor | undefined;
  154143. /**
  154144. * Get the physics impostor of a specific controller.
  154145. * The impostor is not attached to a mesh because a mesh for each controller is not obligatory
  154146. * @param controller the controller or the controller id of which to get the impostor
  154147. * @returns the impostor or null
  154148. */
  154149. getImpostorForController(controller: WebXRInputSource | string): Nullable<PhysicsImpostor>;
  154150. /**
  154151. * Update the physics properties provided in the constructor
  154152. * @param newProperties the new properties object
  154153. */
  154154. setPhysicsProperties(newProperties: {
  154155. impostorType?: number;
  154156. impostorSize?: number | {
  154157. width: number;
  154158. height: number;
  154159. depth: number;
  154160. };
  154161. friction?: number;
  154162. restitution?: number;
  154163. }): void;
  154164. protected _onXRFrame(_xrFrame: any): void;
  154165. private _detachController;
  154166. }
  154167. }
  154168. declare module BABYLON {
  154169. /**
  154170. * A babylon interface for a "WebXR" feature point.
  154171. * Represents the position and confidence value of a given feature point.
  154172. */
  154173. export interface IWebXRFeaturePoint {
  154174. /**
  154175. * Represents the position of the feature point in world space.
  154176. */
  154177. position: Vector3;
  154178. /**
  154179. * Represents the confidence value of the feature point in world space. 0 being least confident, and 1 being most confident.
  154180. */
  154181. confidenceValue: number;
  154182. }
  154183. /**
  154184. * The feature point system is used to detect feature points from real world geometry.
  154185. * This feature is currently experimental and only supported on BabylonNative, and should not be used in the browser.
  154186. * The newly introduced API can be seen in webxr.nativeextensions.d.ts and described in FeaturePoints.md.
  154187. */
  154188. export class WebXRFeaturePointSystem extends WebXRAbstractFeature {
  154189. private _enabled;
  154190. private _featurePointCloud;
  154191. /**
  154192. * The module's name
  154193. */
  154194. static readonly Name: string;
  154195. /**
  154196. * The (Babylon) version of this module.
  154197. * This is an integer representing the implementation version.
  154198. * This number does not correspond to the WebXR specs version
  154199. */
  154200. static readonly Version: number;
  154201. /**
  154202. * Observers registered here will be executed whenever new feature points are added (on XRFrame while the session is tracking).
  154203. * Will notify the observers about which feature points have been added.
  154204. */
  154205. readonly onFeaturePointsAddedObservable: Observable<number[]>;
  154206. /**
  154207. * Observers registered here will be executed whenever a feature point has been updated (on XRFrame while the session is tracking).
  154208. * Will notify the observers about which feature points have been updated.
  154209. */
  154210. readonly onFeaturePointsUpdatedObservable: Observable<number[]>;
  154211. /**
  154212. * The current feature point cloud maintained across frames.
  154213. */
  154214. get featurePointCloud(): Array<IWebXRFeaturePoint>;
  154215. /**
  154216. * construct the feature point system
  154217. * @param _xrSessionManager an instance of xr Session manager
  154218. */
  154219. constructor(_xrSessionManager: WebXRSessionManager);
  154220. /**
  154221. * Detach this feature.
  154222. * Will usually be called by the features manager
  154223. *
  154224. * @returns true if successful.
  154225. */
  154226. detach(): boolean;
  154227. /**
  154228. * Dispose this feature and all of the resources attached
  154229. */
  154230. dispose(): void;
  154231. /**
  154232. * On receiving a new XR frame if this feature is attached notify observers new feature point data is available.
  154233. */
  154234. protected _onXRFrame(frame: XRFrame): void;
  154235. /**
  154236. * Initializes the feature. If the feature point feature is not available for this environment do not mark the feature as enabled.
  154237. */
  154238. private _init;
  154239. }
  154240. }
  154241. declare module BABYLON {
  154242. /**
  154243. * The motion controller class for all microsoft mixed reality controllers
  154244. */
  154245. export class WebXRMicrosoftMixedRealityController extends WebXRAbstractMotionController {
  154246. protected readonly _mapping: {
  154247. defaultButton: {
  154248. valueNodeName: string;
  154249. unpressedNodeName: string;
  154250. pressedNodeName: string;
  154251. };
  154252. defaultAxis: {
  154253. valueNodeName: string;
  154254. minNodeName: string;
  154255. maxNodeName: string;
  154256. };
  154257. buttons: {
  154258. "xr-standard-trigger": {
  154259. rootNodeName: string;
  154260. componentProperty: string;
  154261. states: string[];
  154262. };
  154263. "xr-standard-squeeze": {
  154264. rootNodeName: string;
  154265. componentProperty: string;
  154266. states: string[];
  154267. };
  154268. "xr-standard-touchpad": {
  154269. rootNodeName: string;
  154270. labelAnchorNodeName: string;
  154271. touchPointNodeName: string;
  154272. };
  154273. "xr-standard-thumbstick": {
  154274. rootNodeName: string;
  154275. componentProperty: string;
  154276. states: string[];
  154277. };
  154278. };
  154279. axes: {
  154280. "xr-standard-touchpad": {
  154281. "x-axis": {
  154282. rootNodeName: string;
  154283. };
  154284. "y-axis": {
  154285. rootNodeName: string;
  154286. };
  154287. };
  154288. "xr-standard-thumbstick": {
  154289. "x-axis": {
  154290. rootNodeName: string;
  154291. };
  154292. "y-axis": {
  154293. rootNodeName: string;
  154294. };
  154295. };
  154296. };
  154297. };
  154298. /**
  154299. * The base url used to load the left and right controller models
  154300. */
  154301. static MODEL_BASE_URL: string;
  154302. /**
  154303. * The name of the left controller model file
  154304. */
  154305. static MODEL_LEFT_FILENAME: string;
  154306. /**
  154307. * The name of the right controller model file
  154308. */
  154309. static MODEL_RIGHT_FILENAME: string;
  154310. profileId: string;
  154311. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  154312. protected _getFilenameAndPath(): {
  154313. filename: string;
  154314. path: string;
  154315. };
  154316. protected _getModelLoadingConstraints(): boolean;
  154317. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  154318. protected _setRootMesh(meshes: AbstractMesh[]): void;
  154319. protected _updateModel(): void;
  154320. }
  154321. }
  154322. declare module BABYLON {
  154323. /**
  154324. * The motion controller class for oculus touch (quest, rift).
  154325. * This class supports legacy mapping as well the standard xr mapping
  154326. */
  154327. export class WebXROculusTouchMotionController extends WebXRAbstractMotionController {
  154328. private _forceLegacyControllers;
  154329. private _modelRootNode;
  154330. /**
  154331. * The base url used to load the left and right controller models
  154332. */
  154333. static MODEL_BASE_URL: string;
  154334. /**
  154335. * The name of the left controller model file
  154336. */
  154337. static MODEL_LEFT_FILENAME: string;
  154338. /**
  154339. * The name of the right controller model file
  154340. */
  154341. static MODEL_RIGHT_FILENAME: string;
  154342. /**
  154343. * Base Url for the Quest controller model.
  154344. */
  154345. static QUEST_MODEL_BASE_URL: string;
  154346. profileId: string;
  154347. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness, legacyMapping?: boolean, _forceLegacyControllers?: boolean);
  154348. protected _getFilenameAndPath(): {
  154349. filename: string;
  154350. path: string;
  154351. };
  154352. protected _getModelLoadingConstraints(): boolean;
  154353. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  154354. protected _setRootMesh(meshes: AbstractMesh[]): void;
  154355. protected _updateModel(): void;
  154356. /**
  154357. * Is this the new type of oculus touch. At the moment both have the same profile and it is impossible to differentiate
  154358. * between the touch and touch 2.
  154359. */
  154360. private _isQuest;
  154361. }
  154362. }
  154363. declare module BABYLON {
  154364. /**
  154365. * The motion controller class for the standard HTC-Vive controllers
  154366. */
  154367. export class WebXRHTCViveMotionController extends WebXRAbstractMotionController {
  154368. private _modelRootNode;
  154369. /**
  154370. * The base url used to load the left and right controller models
  154371. */
  154372. static MODEL_BASE_URL: string;
  154373. /**
  154374. * File name for the controller model.
  154375. */
  154376. static MODEL_FILENAME: string;
  154377. profileId: string;
  154378. /**
  154379. * Create a new Vive motion controller object
  154380. * @param scene the scene to use to create this controller
  154381. * @param gamepadObject the corresponding gamepad object
  154382. * @param handedness the handedness of the controller
  154383. */
  154384. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  154385. protected _getFilenameAndPath(): {
  154386. filename: string;
  154387. path: string;
  154388. };
  154389. protected _getModelLoadingConstraints(): boolean;
  154390. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  154391. protected _setRootMesh(meshes: AbstractMesh[]): void;
  154392. protected _updateModel(): void;
  154393. }
  154394. }
  154395. declare module BABYLON {
  154396. /**
  154397. * A cursor which tracks a point on a path
  154398. */
  154399. export class PathCursor {
  154400. private path;
  154401. /**
  154402. * Stores path cursor callbacks for when an onchange event is triggered
  154403. */
  154404. private _onchange;
  154405. /**
  154406. * The value of the path cursor
  154407. */
  154408. value: number;
  154409. /**
  154410. * The animation array of the path cursor
  154411. */
  154412. animations: Animation[];
  154413. /**
  154414. * Initializes the path cursor
  154415. * @param path The path to track
  154416. */
  154417. constructor(path: Path2);
  154418. /**
  154419. * Gets the cursor point on the path
  154420. * @returns A point on the path cursor at the cursor location
  154421. */
  154422. getPoint(): Vector3;
  154423. /**
  154424. * Moves the cursor ahead by the step amount
  154425. * @param step The amount to move the cursor forward
  154426. * @returns This path cursor
  154427. */
  154428. moveAhead(step?: number): PathCursor;
  154429. /**
  154430. * Moves the cursor behind by the step amount
  154431. * @param step The amount to move the cursor back
  154432. * @returns This path cursor
  154433. */
  154434. moveBack(step?: number): PathCursor;
  154435. /**
  154436. * Moves the cursor by the step amount
  154437. * If the step amount is greater than one, an exception is thrown
  154438. * @param step The amount to move the cursor
  154439. * @returns This path cursor
  154440. */
  154441. move(step: number): PathCursor;
  154442. /**
  154443. * Ensures that the value is limited between zero and one
  154444. * @returns This path cursor
  154445. */
  154446. private ensureLimits;
  154447. /**
  154448. * Runs onchange callbacks on change (used by the animation engine)
  154449. * @returns This path cursor
  154450. */
  154451. private raiseOnChange;
  154452. /**
  154453. * Executes a function on change
  154454. * @param f A path cursor onchange callback
  154455. * @returns This path cursor
  154456. */
  154457. onchange(f: (cursor: PathCursor) => void): PathCursor;
  154458. }
  154459. }
  154460. declare module BABYLON {
  154461. /** @hidden */
  154462. export var blurPixelShader: {
  154463. name: string;
  154464. shader: string;
  154465. };
  154466. }
  154467. declare module BABYLON {
  154468. /** @hidden */
  154469. export var pointCloudVertexDeclaration: {
  154470. name: string;
  154471. shader: string;
  154472. };
  154473. }
  154474. // Mixins
  154475. interface Window {
  154476. mozIndexedDB: IDBFactory;
  154477. webkitIndexedDB: IDBFactory;
  154478. msIndexedDB: IDBFactory;
  154479. webkitURL: typeof URL;
  154480. mozRequestAnimationFrame(callback: FrameRequestCallback): number;
  154481. oRequestAnimationFrame(callback: FrameRequestCallback): number;
  154482. WebGLRenderingContext: WebGLRenderingContext;
  154483. MSGesture: MSGesture;
  154484. CANNON: any;
  154485. AudioContext: AudioContext;
  154486. webkitAudioContext: AudioContext;
  154487. PointerEvent: any;
  154488. Math: Math;
  154489. Uint8Array: Uint8ArrayConstructor;
  154490. Float32Array: Float32ArrayConstructor;
  154491. mozURL: typeof URL;
  154492. msURL: typeof URL;
  154493. VRFrameData: any; // WebVR, from specs 1.1
  154494. DracoDecoderModule: any;
  154495. setImmediate(handler: (...args: any[]) => void): number;
  154496. }
  154497. interface HTMLCanvasElement {
  154498. requestPointerLock(): void;
  154499. msRequestPointerLock?(): void;
  154500. mozRequestPointerLock?(): void;
  154501. webkitRequestPointerLock?(): void;
  154502. /** Track wether a record is in progress */
  154503. isRecording: boolean;
  154504. /** Capture Stream method defined by some browsers */
  154505. captureStream(fps?: number): MediaStream;
  154506. }
  154507. interface CanvasRenderingContext2D {
  154508. msImageSmoothingEnabled: boolean;
  154509. }
  154510. interface MouseEvent {
  154511. mozMovementX: number;
  154512. mozMovementY: number;
  154513. webkitMovementX: number;
  154514. webkitMovementY: number;
  154515. msMovementX: number;
  154516. msMovementY: number;
  154517. }
  154518. interface Navigator {
  154519. mozGetVRDevices: (any: any) => any;
  154520. webkitGetUserMedia(constraints: MediaStreamConstraints, successCallback: NavigatorUserMediaSuccessCallback, errorCallback: NavigatorUserMediaErrorCallback): void;
  154521. mozGetUserMedia(constraints: MediaStreamConstraints, successCallback: NavigatorUserMediaSuccessCallback, errorCallback: NavigatorUserMediaErrorCallback): void;
  154522. msGetUserMedia(constraints: MediaStreamConstraints, successCallback: NavigatorUserMediaSuccessCallback, errorCallback: NavigatorUserMediaErrorCallback): void;
  154523. webkitGetGamepads(): Gamepad[];
  154524. msGetGamepads(): Gamepad[];
  154525. webkitGamepads(): Gamepad[];
  154526. }
  154527. interface HTMLVideoElement {
  154528. mozSrcObject: any;
  154529. }
  154530. interface Math {
  154531. fround(x: number): number;
  154532. imul(a: number, b: number): number;
  154533. }
  154534. interface WebGLRenderingContext {
  154535. drawArraysInstanced(mode: number, first: number, count: number, primcount: number): void;
  154536. drawElementsInstanced(mode: number, count: number, type: number, offset: number, primcount: number): void;
  154537. vertexAttribDivisor(index: number, divisor: number): void;
  154538. createVertexArray(): any;
  154539. bindVertexArray(vao?: WebGLVertexArrayObject | null): void;
  154540. deleteVertexArray(vao: WebGLVertexArrayObject): void;
  154541. blitFramebuffer(srcX0: number, srcY0: number, srcX1: number, srcY1: number, dstX0: number, dstY0: number, dstX1: number, dstY1: number, mask: number, filter: number): void;
  154542. renderbufferStorageMultisample?(target: number, samples: number, internalformat: number, width: number, height: number): void;
  154543. bindBufferBase(target: number, index: number, buffer: WebGLBuffer | null): void;
  154544. getUniformBlockIndex(program: WebGLProgram, uniformBlockName: string): number;
  154545. uniformBlockBinding(program: WebGLProgram, uniformBlockIndex: number, uniformBlockBinding: number): void;
  154546. // Queries
  154547. createQuery(): WebGLQuery;
  154548. deleteQuery(query: WebGLQuery): void;
  154549. beginQuery(target: number, query: WebGLQuery): void;
  154550. endQuery(target: number): void;
  154551. getQueryParameter(query: WebGLQuery, pname: number): any;
  154552. getQuery(target: number, pname: number): any;
  154553. MAX_SAMPLES: number;
  154554. RGBA8: number;
  154555. READ_FRAMEBUFFER: number;
  154556. DRAW_FRAMEBUFFER: number;
  154557. UNIFORM_BUFFER: number;
  154558. HALF_FLOAT_OES: number;
  154559. RGBA16F: number;
  154560. RGBA32F: number;
  154561. R32F: number;
  154562. RG32F: number;
  154563. RGB32F: number;
  154564. R16F: number;
  154565. RG16F: number;
  154566. RGB16F: number;
  154567. RED: number;
  154568. RG: number;
  154569. R8: number;
  154570. RG8: number;
  154571. UNSIGNED_INT_24_8: number;
  154572. DEPTH24_STENCIL8: number;
  154573. MIN: number;
  154574. MAX: number;
  154575. /* Multiple Render Targets */
  154576. drawBuffers(buffers: number[]): void;
  154577. readBuffer(src: number): void;
  154578. readonly COLOR_ATTACHMENT0: number; // 0x8CE1
  154579. readonly COLOR_ATTACHMENT1: number; // 0x8CE2
  154580. readonly COLOR_ATTACHMENT2: number; // 0x8CE3
  154581. readonly COLOR_ATTACHMENT3: number; // 0x8CE4
  154582. // Occlusion Query
  154583. ANY_SAMPLES_PASSED_CONSERVATIVE: number;
  154584. ANY_SAMPLES_PASSED: number;
  154585. QUERY_RESULT_AVAILABLE: number;
  154586. QUERY_RESULT: number;
  154587. }
  154588. interface WebGLProgram {
  154589. __SPECTOR_rebuildProgram?: ((vertexSourceCode: string, fragmentSourceCode: string, onCompiled: (program: WebGLProgram) => void, onError: (message: string) => void) => void) | null;
  154590. }
  154591. interface EXT_disjoint_timer_query {
  154592. QUERY_COUNTER_BITS_EXT: number;
  154593. TIME_ELAPSED_EXT: number;
  154594. TIMESTAMP_EXT: number;
  154595. GPU_DISJOINT_EXT: number;
  154596. QUERY_RESULT_EXT: number;
  154597. QUERY_RESULT_AVAILABLE_EXT: number;
  154598. queryCounterEXT(query: WebGLQuery, target: number): void;
  154599. createQueryEXT(): WebGLQuery;
  154600. beginQueryEXT(target: number, query: WebGLQuery): void;
  154601. endQueryEXT(target: number): void;
  154602. getQueryObjectEXT(query: WebGLQuery, target: number): any;
  154603. deleteQueryEXT(query: WebGLQuery): void;
  154604. }
  154605. interface WebGLUniformLocation {
  154606. _currentState: any;
  154607. }
  154608. // Type definitions for WebGL 2, Editor's Draft Fri Feb 24 16:10:18 2017 -0800
  154609. // Project: https://www.khronos.org/registry/webgl/specs/latest/2.0/
  154610. // Definitions by: Nico Kemnitz <https://github.com/nkemnitz/>
  154611. // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
  154612. interface WebGLRenderingContext {
  154613. readonly RASTERIZER_DISCARD: number;
  154614. readonly DEPTH_COMPONENT24: number;
  154615. readonly TEXTURE_3D: number;
  154616. readonly TEXTURE_2D_ARRAY: number;
  154617. readonly TEXTURE_COMPARE_FUNC: number;
  154618. readonly TEXTURE_COMPARE_MODE: number;
  154619. readonly COMPARE_REF_TO_TEXTURE: number;
  154620. readonly TEXTURE_WRAP_R: number;
  154621. readonly HALF_FLOAT: number;
  154622. readonly RGB8: number;
  154623. readonly RED_INTEGER: number;
  154624. readonly RG_INTEGER: number;
  154625. readonly RGB_INTEGER: number;
  154626. readonly RGBA_INTEGER: number;
  154627. readonly R8_SNORM: number;
  154628. readonly RG8_SNORM: number;
  154629. readonly RGB8_SNORM: number;
  154630. readonly RGBA8_SNORM: number;
  154631. readonly R8I: number;
  154632. readonly RG8I: number;
  154633. readonly RGB8I: number;
  154634. readonly RGBA8I: number;
  154635. readonly R8UI: number;
  154636. readonly RG8UI: number;
  154637. readonly RGB8UI: number;
  154638. readonly RGBA8UI: number;
  154639. readonly R16I: number;
  154640. readonly RG16I: number;
  154641. readonly RGB16I: number;
  154642. readonly RGBA16I: number;
  154643. readonly R16UI: number;
  154644. readonly RG16UI: number;
  154645. readonly RGB16UI: number;
  154646. readonly RGBA16UI: number;
  154647. readonly R32I: number;
  154648. readonly RG32I: number;
  154649. readonly RGB32I: number;
  154650. readonly RGBA32I: number;
  154651. readonly R32UI: number;
  154652. readonly RG32UI: number;
  154653. readonly RGB32UI: number;
  154654. readonly RGBA32UI: number;
  154655. readonly RGB10_A2UI: number;
  154656. readonly R11F_G11F_B10F: number;
  154657. readonly RGB9_E5: number;
  154658. readonly RGB10_A2: number;
  154659. readonly UNSIGNED_INT_2_10_10_10_REV: number;
  154660. readonly UNSIGNED_INT_10F_11F_11F_REV: number;
  154661. readonly UNSIGNED_INT_5_9_9_9_REV: number;
  154662. readonly FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  154663. readonly DEPTH_COMPONENT32F: number;
  154664. texImage3D(target: number, level: number, internalformat: number, width: number, height: number, depth: number, border: number, format: number, type: number, pixels: ArrayBufferView | null): void;
  154665. texImage3D(target: number, level: number, internalformat: number, width: number, height: number, depth: number, border: number, format: number, type: number, pixels: ArrayBufferView, offset: number): void;
  154666. 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;
  154667. framebufferTextureLayer(target: number, attachment: number, texture: WebGLTexture | null, level: number, layer: number): void;
  154668. compressedTexImage3D(target: number, level: number, internalformat: number, width: number, height: number, depth: number, border: number, data: ArrayBufferView, offset?: number, length?: number): void;
  154669. readonly TRANSFORM_FEEDBACK: number;
  154670. readonly INTERLEAVED_ATTRIBS: number;
  154671. readonly TRANSFORM_FEEDBACK_BUFFER: number;
  154672. createTransformFeedback(): WebGLTransformFeedback;
  154673. deleteTransformFeedback(transformFeedbac: WebGLTransformFeedback): void;
  154674. bindTransformFeedback(target: number, transformFeedback: WebGLTransformFeedback | null): void;
  154675. beginTransformFeedback(primitiveMode: number): void;
  154676. endTransformFeedback(): void;
  154677. transformFeedbackVaryings(program: WebGLProgram, varyings: string[], bufferMode: number): void;
  154678. clearBufferfv(buffer: number, drawbuffer: number, values: ArrayBufferView, srcOffset: number | null): void;
  154679. clearBufferiv(buffer: number, drawbuffer: number, values: ArrayBufferView, srcOffset: number | null): void;
  154680. clearBufferuiv(buffer: number, drawbuffer: number, values: ArrayBufferView, srcOffset: number | null): void;
  154681. clearBufferfi(buffer: number, drawbuffer: number, depth: number, stencil: number): void;
  154682. }
  154683. interface ImageBitmap {
  154684. readonly width: number;
  154685. readonly height: number;
  154686. close(): void;
  154687. }
  154688. interface WebGLQuery extends WebGLObject {
  154689. }
  154690. declare var WebGLQuery: {
  154691. prototype: WebGLQuery;
  154692. new(): WebGLQuery;
  154693. };
  154694. interface WebGLSampler extends WebGLObject {
  154695. }
  154696. declare var WebGLSampler: {
  154697. prototype: WebGLSampler;
  154698. new(): WebGLSampler;
  154699. };
  154700. interface WebGLSync extends WebGLObject {
  154701. }
  154702. declare var WebGLSync: {
  154703. prototype: WebGLSync;
  154704. new(): WebGLSync;
  154705. };
  154706. interface WebGLTransformFeedback extends WebGLObject {
  154707. }
  154708. declare var WebGLTransformFeedback: {
  154709. prototype: WebGLTransformFeedback;
  154710. new(): WebGLTransformFeedback;
  154711. };
  154712. interface WebGLVertexArrayObject extends WebGLObject {
  154713. }
  154714. declare var WebGLVertexArrayObject: {
  154715. prototype: WebGLVertexArrayObject;
  154716. new(): WebGLVertexArrayObject;
  154717. };
  154718. // Type definitions for WebVR API
  154719. // Project: https://w3c.github.io/webvr/
  154720. // Definitions by: six a <https://github.com/lostfictions>
  154721. // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
  154722. interface VRDisplay extends EventTarget {
  154723. /**
  154724. * Dictionary of capabilities describing the VRDisplay.
  154725. */
  154726. readonly capabilities: VRDisplayCapabilities;
  154727. /**
  154728. * z-depth defining the far plane of the eye view frustum
  154729. * enables mapping of values in the render target depth
  154730. * attachment to scene coordinates. Initially set to 10000.0.
  154731. */
  154732. depthFar: number;
  154733. /**
  154734. * z-depth defining the near plane of the eye view frustum
  154735. * enables mapping of values in the render target depth
  154736. * attachment to scene coordinates. Initially set to 0.01.
  154737. */
  154738. depthNear: number;
  154739. /**
  154740. * An identifier for this distinct VRDisplay. Used as an
  154741. * association point in the Gamepad API.
  154742. */
  154743. readonly displayId: number;
  154744. /**
  154745. * A display name, a user-readable name identifying it.
  154746. */
  154747. readonly displayName: string;
  154748. readonly isConnected: boolean;
  154749. readonly isPresenting: boolean;
  154750. /**
  154751. * If this VRDisplay supports room-scale experiences, the optional
  154752. * stage attribute contains details on the room-scale parameters.
  154753. */
  154754. readonly stageParameters: VRStageParameters | null;
  154755. /**
  154756. * Passing the value returned by `requestAnimationFrame` to
  154757. * `cancelAnimationFrame` will unregister the callback.
  154758. * @param handle Define the hanle of the request to cancel
  154759. */
  154760. cancelAnimationFrame(handle: number): void;
  154761. /**
  154762. * Stops presenting to the VRDisplay.
  154763. * @returns a promise to know when it stopped
  154764. */
  154765. exitPresent(): Promise<void>;
  154766. /**
  154767. * Return the current VREyeParameters for the given eye.
  154768. * @param whichEye Define the eye we want the parameter for
  154769. * @returns the eye parameters
  154770. */
  154771. getEyeParameters(whichEye: string): VREyeParameters;
  154772. /**
  154773. * Populates the passed VRFrameData with the information required to render
  154774. * the current frame.
  154775. * @param frameData Define the data structure to populate
  154776. * @returns true if ok otherwise false
  154777. */
  154778. getFrameData(frameData: VRFrameData): boolean;
  154779. /**
  154780. * Get the layers currently being presented.
  154781. * @returns the list of VR layers
  154782. */
  154783. getLayers(): VRLayer[];
  154784. /**
  154785. * Return a VRPose containing the future predicted pose of the VRDisplay
  154786. * when the current frame will be presented. The value returned will not
  154787. * change until JavaScript has returned control to the browser.
  154788. *
  154789. * The VRPose will contain the position, orientation, velocity,
  154790. * and acceleration of each of these properties.
  154791. * @returns the pose object
  154792. */
  154793. getPose(): VRPose;
  154794. /**
  154795. * Return the current instantaneous pose of the VRDisplay, with no
  154796. * prediction applied.
  154797. * @returns the current instantaneous pose
  154798. */
  154799. getImmediatePose(): VRPose;
  154800. /**
  154801. * The callback passed to `requestAnimationFrame` will be called
  154802. * any time a new frame should be rendered. When the VRDisplay is
  154803. * presenting the callback will be called at the native refresh
  154804. * rate of the HMD. When not presenting this function acts
  154805. * identically to how window.requestAnimationFrame acts. Content should
  154806. * make no assumptions of frame rate or vsync behavior as the HMD runs
  154807. * asynchronously from other displays and at differing refresh rates.
  154808. * @param callback Define the eaction to run next frame
  154809. * @returns the request handle it
  154810. */
  154811. requestAnimationFrame(callback: FrameRequestCallback): number;
  154812. /**
  154813. * Begin presenting to the VRDisplay. Must be called in response to a user gesture.
  154814. * Repeat calls while already presenting will update the VRLayers being displayed.
  154815. * @param layers Define the list of layer to present
  154816. * @returns a promise to know when the request has been fulfilled
  154817. */
  154818. requestPresent(layers: VRLayer[]): Promise<void>;
  154819. /**
  154820. * Reset the pose for this display, treating its current position and
  154821. * orientation as the "origin/zero" values. VRPose.position,
  154822. * VRPose.orientation, and VRStageParameters.sittingToStandingTransform may be
  154823. * updated when calling resetPose(). This should be called in only
  154824. * sitting-space experiences.
  154825. */
  154826. resetPose(): void;
  154827. /**
  154828. * The VRLayer provided to the VRDisplay will be captured and presented
  154829. * in the HMD. Calling this function has the same effect on the source
  154830. * canvas as any other operation that uses its source image, and canvases
  154831. * created without preserveDrawingBuffer set to true will be cleared.
  154832. * @param pose Define the pose to submit
  154833. */
  154834. submitFrame(pose?: VRPose): void;
  154835. }
  154836. declare var VRDisplay: {
  154837. prototype: VRDisplay;
  154838. new(): VRDisplay;
  154839. };
  154840. interface VRLayer {
  154841. leftBounds?: number[] | Float32Array | null;
  154842. rightBounds?: number[] | Float32Array | null;
  154843. source?: HTMLCanvasElement | null;
  154844. }
  154845. interface VRDisplayCapabilities {
  154846. readonly canPresent: boolean;
  154847. readonly hasExternalDisplay: boolean;
  154848. readonly hasOrientation: boolean;
  154849. readonly hasPosition: boolean;
  154850. readonly maxLayers: number;
  154851. }
  154852. interface VREyeParameters {
  154853. /** @deprecated */
  154854. readonly fieldOfView: VRFieldOfView;
  154855. readonly offset: Float32Array;
  154856. readonly renderHeight: number;
  154857. readonly renderWidth: number;
  154858. }
  154859. interface VRFieldOfView {
  154860. readonly downDegrees: number;
  154861. readonly leftDegrees: number;
  154862. readonly rightDegrees: number;
  154863. readonly upDegrees: number;
  154864. }
  154865. interface VRFrameData {
  154866. readonly leftProjectionMatrix: Float32Array;
  154867. readonly leftViewMatrix: Float32Array;
  154868. readonly pose: VRPose;
  154869. readonly rightProjectionMatrix: Float32Array;
  154870. readonly rightViewMatrix: Float32Array;
  154871. readonly timestamp: number;
  154872. }
  154873. interface VRPose {
  154874. readonly angularAcceleration: Float32Array | null;
  154875. readonly angularVelocity: Float32Array | null;
  154876. readonly linearAcceleration: Float32Array | null;
  154877. readonly linearVelocity: Float32Array | null;
  154878. readonly orientation: Float32Array | null;
  154879. readonly position: Float32Array | null;
  154880. readonly timestamp: number;
  154881. }
  154882. interface VRStageParameters {
  154883. sittingToStandingTransform?: Float32Array;
  154884. sizeX?: number;
  154885. sizeY?: number;
  154886. }
  154887. interface Navigator {
  154888. getVRDisplays(): Promise<VRDisplay[]>;
  154889. readonly activeVRDisplays: ReadonlyArray<VRDisplay>;
  154890. }
  154891. interface Window {
  154892. onvrdisplayconnected: ((this: Window, ev: Event) => any) | null;
  154893. onvrdisplaydisconnected: ((this: Window, ev: Event) => any) | null;
  154894. onvrdisplaypresentchange: ((this: Window, ev: Event) => any) | null;
  154895. addEventListener(type: "vrdisplayconnected", listener: (ev: Event) => any, useCapture?: boolean): void;
  154896. addEventListener(type: "vrdisplaydisconnected", listener: (ev: Event) => any, useCapture?: boolean): void;
  154897. addEventListener(type: "vrdisplaypresentchange", listener: (ev: Event) => any, useCapture?: boolean): void;
  154898. }
  154899. interface Gamepad {
  154900. readonly displayId: number;
  154901. }
  154902. type XRSessionMode =
  154903. | "inline"
  154904. | "immersive-vr"
  154905. | "immersive-ar";
  154906. type XRReferenceSpaceType =
  154907. | "viewer"
  154908. | "local"
  154909. | "local-floor"
  154910. | "bounded-floor"
  154911. | "unbounded";
  154912. type XREnvironmentBlendMode =
  154913. | "opaque"
  154914. | "additive"
  154915. | "alpha-blend";
  154916. type XRVisibilityState =
  154917. | "visible"
  154918. | "visible-blurred"
  154919. | "hidden";
  154920. type XRHandedness =
  154921. | "none"
  154922. | "left"
  154923. | "right";
  154924. type XRTargetRayMode =
  154925. | "gaze"
  154926. | "tracked-pointer"
  154927. | "screen";
  154928. type XREye =
  154929. | "none"
  154930. | "left"
  154931. | "right";
  154932. type XREventType =
  154933. | "devicechange"
  154934. | "visibilitychange"
  154935. | "end"
  154936. | "inputsourceschange"
  154937. | "select"
  154938. | "selectstart"
  154939. | "selectend"
  154940. | "squeeze"
  154941. | "squeezestart"
  154942. | "squeezeend"
  154943. | "reset";
  154944. interface XRSpace extends EventTarget {
  154945. }
  154946. interface XRRenderState {
  154947. depthNear?: number;
  154948. depthFar?: number;
  154949. inlineVerticalFieldOfView?: number;
  154950. baseLayer?: XRWebGLLayer;
  154951. }
  154952. interface XRInputSource {
  154953. handedness: XRHandedness;
  154954. targetRayMode: XRTargetRayMode;
  154955. targetRaySpace: XRSpace;
  154956. gripSpace: XRSpace | undefined;
  154957. gamepad: Gamepad | undefined;
  154958. profiles: Array<string>;
  154959. }
  154960. interface XRSessionInit {
  154961. optionalFeatures?: string[];
  154962. requiredFeatures?: string[];
  154963. }
  154964. interface XRSession {
  154965. addEventListener: Function;
  154966. removeEventListener: Function;
  154967. requestReferenceSpace(type: XRReferenceSpaceType): Promise<XRReferenceSpace>;
  154968. updateRenderState(XRRenderStateInit: XRRenderState): Promise<void>;
  154969. requestAnimationFrame: Function;
  154970. end(): Promise<void>;
  154971. renderState: XRRenderState;
  154972. inputSources: Array<XRInputSource>;
  154973. // hit test
  154974. requestHitTestSource(options: XRHitTestOptionsInit): Promise<XRHitTestSource>;
  154975. requestHitTestSourceForTransientInput(options: XRTransientInputHitTestOptionsInit): Promise<XRTransientInputHitTestSource>;
  154976. // legacy AR hit test
  154977. requestHitTest(ray: XRRay, referenceSpace: XRReferenceSpace): Promise<XRHitResult[]>;
  154978. // legacy plane detection
  154979. updateWorldTrackingState(options: {
  154980. planeDetectionState?: { enabled: boolean; }
  154981. }): void;
  154982. }
  154983. interface XRReferenceSpace extends XRSpace {
  154984. getOffsetReferenceSpace(originOffset: XRRigidTransform): XRReferenceSpace;
  154985. onreset: any;
  154986. }
  154987. type XRPlaneSet = Set<XRPlane>;
  154988. type XRAnchorSet = Set<XRAnchor>;
  154989. interface XRFrame {
  154990. session: XRSession;
  154991. getViewerPose(referenceSpace: XRReferenceSpace): XRViewerPose | undefined;
  154992. getPose(space: XRSpace, baseSpace: XRSpace): XRPose | undefined;
  154993. // AR
  154994. getHitTestResults(hitTestSource: XRHitTestSource): Array<XRHitTestResult> ;
  154995. getHitTestResultsForTransientInput(hitTestSource: XRTransientInputHitTestSource): Array<XRTransientInputHitTestResult>;
  154996. // Anchors
  154997. trackedAnchors?: XRAnchorSet;
  154998. createAnchor(pose: XRRigidTransform, space: XRSpace): Promise<XRAnchor>;
  154999. // Planes
  155000. worldInformation: {
  155001. detectedPlanes?: XRPlaneSet;
  155002. };
  155003. }
  155004. interface XRViewerPose extends XRPose {
  155005. views: Array<XRView>;
  155006. }
  155007. interface XRPose {
  155008. transform: XRRigidTransform;
  155009. emulatedPosition: boolean;
  155010. }
  155011. interface XRWebGLLayerOptions {
  155012. antialias?: boolean;
  155013. depth?: boolean;
  155014. stencil?: boolean;
  155015. alpha?: boolean;
  155016. multiview?: boolean;
  155017. framebufferScaleFactor?: number;
  155018. }
  155019. declare var XRWebGLLayer: {
  155020. prototype: XRWebGLLayer;
  155021. new(session: XRSession, context: WebGLRenderingContext | undefined, options?: XRWebGLLayerOptions): XRWebGLLayer;
  155022. };
  155023. interface XRWebGLLayer {
  155024. framebuffer: WebGLFramebuffer;
  155025. framebufferWidth: number;
  155026. framebufferHeight: number;
  155027. getViewport: Function;
  155028. }
  155029. declare class XRRigidTransform {
  155030. constructor(matrix: Float32Array | DOMPointInit, direction?: DOMPointInit);
  155031. position: DOMPointReadOnly;
  155032. orientation: DOMPointReadOnly;
  155033. matrix: Float32Array;
  155034. inverse: XRRigidTransform;
  155035. }
  155036. interface XRView {
  155037. eye: XREye;
  155038. projectionMatrix: Float32Array;
  155039. transform: XRRigidTransform;
  155040. }
  155041. interface XRInputSourceChangeEvent {
  155042. session: XRSession;
  155043. removed: Array<XRInputSource>;
  155044. added: Array<XRInputSource>;
  155045. }
  155046. interface XRInputSourceEvent extends Event {
  155047. readonly frame: XRFrame;
  155048. readonly inputSource: XRInputSource;
  155049. }
  155050. // Experimental(er) features
  155051. declare class XRRay {
  155052. constructor(transformOrOrigin: XRRigidTransform | DOMPointInit, direction?: DOMPointInit);
  155053. origin: DOMPointReadOnly;
  155054. direction: DOMPointReadOnly;
  155055. matrix: Float32Array;
  155056. }
  155057. declare enum XRHitTestTrackableType {
  155058. "point",
  155059. "plane",
  155060. "mesh"
  155061. }
  155062. interface XRHitResult {
  155063. hitMatrix: Float32Array;
  155064. }
  155065. interface XRTransientInputHitTestResult {
  155066. readonly inputSource: XRInputSource;
  155067. readonly results: Array<XRHitTestResult>;
  155068. }
  155069. interface XRHitTestResult {
  155070. getPose(baseSpace: XRSpace): XRPose | undefined;
  155071. // When anchor system is enabled
  155072. createAnchor?(pose: XRRigidTransform): Promise<XRAnchor>;
  155073. }
  155074. interface XRHitTestSource {
  155075. cancel(): void;
  155076. }
  155077. interface XRTransientInputHitTestSource {
  155078. cancel(): void;
  155079. }
  155080. interface XRHitTestOptionsInit {
  155081. space: XRSpace;
  155082. entityTypes?: Array<XRHitTestTrackableType>;
  155083. offsetRay?: XRRay;
  155084. }
  155085. interface XRTransientInputHitTestOptionsInit {
  155086. profile: string;
  155087. entityTypes?: Array<XRHitTestTrackableType>;
  155088. offsetRay?: XRRay;
  155089. }
  155090. interface XRAnchor {
  155091. anchorSpace: XRSpace;
  155092. delete(): void;
  155093. }
  155094. interface XRPlane {
  155095. orientation: "Horizontal" | "Vertical";
  155096. planeSpace: XRSpace;
  155097. polygon: Array<DOMPointReadOnly>;
  155098. lastChangedTime: number;
  155099. }
  155100. // This file contains native only extensions for WebXR These APIs are not supported in the browser yet.
  155101. // They are intended for use with either Babylon Native https://github.com/BabylonJS/BabylonNative or
  155102. // Babylon React Native: https://github.com/BabylonJS/BabylonReactNative
  155103. interface XRSession {
  155104. trySetFeaturePointCloudEnabled(enabled: boolean): boolean;
  155105. }
  155106. interface XRFrame {
  155107. featurePointCloud? : Array<number>;
  155108. }